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 An item like @code{(banner . @var{regexp})} causes any part of an article
3041 that matches the regular expression @var{regexp} to be stripped. Instead of
3042 @var{regexp}, you can also use the symbol @code{signature} which strips the
3043 last signature or any of the elements of the alist
3044 @code{gnus-article-banner-alist}.
3048 This parameter contains a Sieve test that should match incoming mail
3049 that should be placed in this group. From this group parameter, a
3050 Sieve @samp{IF} control structure is generated, having the test as the
3051 condition and @samp{fileinto "group.name";} as the body.
3053 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
3054 address "sender" "sieve-admin@@extundo.com")} group parameter, when
3055 translating the group parameter into a Sieve script (@pxref{Sieve
3056 Commands}) the following Sieve code is generated:
3059 if address "sender" "sieve-admin@@extundo.com" @{
3060 fileinto "INBOX.list.sieve";
3064 To generate tests for multiple email-addresses use a group parameter
3065 like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}.
3066 When generating a sieve script (@pxref{Sieve Commands}) Sieve code
3067 like the following is generated:
3070 if address "sender" ["name@@one.org", "else@@two.org"] @{
3071 fileinto "INBOX.list.sieve";
3075 See @pxref{Sieve Commands} for commands and variables that might be of
3076 interest in relation to the sieve parameter.
3078 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3079 Top, sieve, Emacs Sieve}.
3081 @item (agent parameters)
3082 If the agent has been enabled, you can set any of the its parameters
3083 to control the behavior of the agent in individual groups. See Agent
3084 Parameters in @ref{Category Syntax}. Most users will choose to set
3085 agent parameters in either an agent category or group topic to
3086 minimize the configuration effort.
3088 @item (@var{variable} @var{form})
3089 You can use the group parameters to set variables local to the group you
3090 are entering. If you want to turn threading off in @samp{news.answers},
3091 you could put @code{(gnus-show-threads nil)} in the group parameters of
3092 that group. @code{gnus-show-threads} will be made into a local variable
3093 in the summary buffer you enter, and the form @code{nil} will be
3094 @code{eval}ed there.
3096 Note that this feature sets the variable locally to the summary buffer.
3097 But some variables are evaluated in the article buffer, or in the
3098 message buffer (of a reply or followup or otherwise newly created
3099 message). As a workaround, it might help to add the variable in
3100 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3101 Stuff}. So if you want to set @code{message-from-style} via the group
3102 parameters, then you may need the following statement elsewhere in your
3103 @file{~/.gnus} file:
3106 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3109 @vindex gnus-list-identifiers
3110 A use for this feature is to remove a mailing list identifier tag in
3111 the subject fields of articles. E.g. if the news group
3114 nntp+news.gnus.org:gmane.text.docbook.apps
3117 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3118 tag can be removed from the article subjects in the summary buffer for
3119 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3120 into the group parameters for the group.
3122 This can also be used as a group-specific hook function. If you want to
3123 hear a beep when you enter a group, you could put something like
3124 @code{(dummy-variable (ding))} in the parameters of that group.
3125 @code{dummy-variable} will be set to the (meaningless) result of the
3128 Alternatively, since the VARIABLE becomes local to the group, this
3129 pattern can be used to temporarily change a hook. For example, if the
3130 following is added to a group parameter
3133 (gnus-summary-prepared-hook
3134 '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3137 when the group is entered, the 'd' key will not mark the article as
3142 @vindex gnus-parameters
3143 Group parameters can be set via the @code{gnus-parameters} variable too.
3144 But some variables, such as @code{visible}, have no effect (For this
3145 case see @code{gnus-permanently-visible-groups} as an alternative.).
3149 (setq gnus-parameters
3151 (gnus-show-threads nil)
3152 (gnus-use-scoring nil)
3153 (gnus-summary-line-format
3154 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3158 ("^nnimap:\\(foo.bar\\)$"
3162 (gnus-use-scoring t))
3166 (broken-reply-to . t))))
3169 String value of parameters will be subjected to regexp substitution, as
3170 the @code{to-group} example shows.
3172 @vindex gnus-parameters-case-fold-search
3173 By default, whether comparing the group name and one of those regexps
3174 specified in @code{gnus-parameters} is done in a case-sensitive manner
3175 or a case-insensitive manner depends on the value of
3176 @code{case-fold-search} at the time when the comparison is done. The
3177 value of @code{case-fold-search} is typically @code{t}; it means, for
3178 example, the element @code{("INBOX\\.FOO" (total-expire . t))} might be
3179 applied to both the @samp{INBOX.FOO} group and the @samp{INBOX.foo}
3180 group. If you want to make those regexps always case-sensitive, set the
3181 value of the @code{gnus-parameters-case-fold-search} variable to
3182 @code{nil}. Otherwise, set it to @code{t} if you want to compare them
3183 always in a case-insensitive manner.
3185 You can define different sorting to different groups via
3186 @code{gnus-parameters}. Here is an example to sort an @acronym{NNTP}
3187 group by reverse date to see the latest news at the top and an
3188 @acronym{RSS} group by subject. In this example, the first group is the
3189 Debian daily news group @code{gmane.linux.debian.user.news} from
3190 news.gmane.org. The @acronym{RSS} group corresponds to the Debian
3191 weekly news RSS feed
3192 @url{http://packages.debian.org/unstable/newpkg_main.en.rdf},
3198 '(("nntp.*gmane\\.debian\\.user\\.news"
3199 (gnus-show-threads nil)
3200 (gnus-article-sort-functions '((not gnus-article-sort-by-date)))
3201 (gnus-use-adaptive-scoring nil)
3202 (gnus-use-scoring nil))
3204 (gnus-show-threads nil)
3205 (gnus-article-sort-functions 'gnus-article-sort-by-subject)
3206 (gnus-use-adaptive-scoring nil)
3207 (gnus-use-scoring t)
3208 (gnus-score-find-score-files-function 'gnus-score-find-single)
3209 (gnus-summary-line-format "%U%R%z%d %I%(%[ %s %]%)\n"))))
3213 @node Listing Groups
3214 @section Listing Groups
3215 @cindex group listing
3217 These commands all list various slices of the groups available.
3225 @findex gnus-group-list-groups
3226 List all groups that have unread articles
3227 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3228 command will list only groups of level ARG and lower. By default, it
3229 only lists groups of level five (i.e.,
3230 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3237 @findex gnus-group-list-all-groups
3238 List all groups, whether they have unread articles or not
3239 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3240 this command will list only groups of level ARG and lower. By default,
3241 it lists groups of level seven or lower (i.e., just subscribed and
3242 unsubscribed groups).
3246 @findex gnus-group-list-level
3247 List all unread groups on a specific level
3248 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3249 with no unread articles.
3253 @findex gnus-group-list-killed
3254 List all killed groups (@code{gnus-group-list-killed}). If given a
3255 prefix argument, really list all groups that are available, but aren't
3256 currently (un)subscribed. This could entail reading the active file
3261 @findex gnus-group-list-zombies
3262 List all zombie groups (@code{gnus-group-list-zombies}).
3266 @findex gnus-group-list-matching
3267 List all unread, subscribed groups with names that match a regexp
3268 (@code{gnus-group-list-matching}).
3272 @findex gnus-group-list-all-matching
3273 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3277 @findex gnus-group-list-active
3278 List absolutely all groups in the active file(s) of the
3279 server(s) you are connected to (@code{gnus-group-list-active}). This
3280 might very well take quite a while. It might actually be a better idea
3281 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3282 thing to match on. Also note that this command may list groups that
3283 don't exist (yet)---these will be listed as if they were killed groups.
3284 Take the output with some grains of salt.
3288 @findex gnus-group-apropos
3289 List all groups that have names that match a regexp
3290 (@code{gnus-group-apropos}).
3294 @findex gnus-group-description-apropos
3295 List all groups that have names or descriptions that match a regexp
3296 (@code{gnus-group-description-apropos}).
3300 @findex gnus-group-list-cached
3301 List all groups with cached articles (@code{gnus-group-list-cached}).
3305 @findex gnus-group-list-dormant
3306 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3310 @findex gnus-group-list-limit
3311 List groups limited within the current selection
3312 (@code{gnus-group-list-limit}).
3316 @findex gnus-group-list-flush
3317 Flush groups from the current selection (@code{gnus-group-list-flush}).
3321 @findex gnus-group-list-plus
3322 List groups plus the current selection (@code{gnus-group-list-plus}).
3326 @vindex gnus-permanently-visible-groups
3327 @cindex visible group parameter
3328 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3329 always be shown, whether they have unread articles or not. You can also
3330 add the @code{visible} element to the group parameters in question to
3331 get the same effect.
3333 @vindex gnus-list-groups-with-ticked-articles
3334 Groups that have just ticked articles in it are normally listed in the
3335 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3336 @code{nil}, these groups will be treated just like totally empty
3337 groups. It is @code{t} by default.
3340 @node Sorting Groups
3341 @section Sorting Groups
3342 @cindex sorting groups
3344 @kindex C-c C-s (Group)
3345 @findex gnus-group-sort-groups
3346 @vindex gnus-group-sort-function
3347 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3348 group buffer according to the function(s) given by the
3349 @code{gnus-group-sort-function} variable. Available sorting functions
3354 @item gnus-group-sort-by-alphabet
3355 @findex gnus-group-sort-by-alphabet
3356 Sort the group names alphabetically. This is the default.
3358 @item gnus-group-sort-by-real-name
3359 @findex gnus-group-sort-by-real-name
3360 Sort the group alphabetically on the real (unprefixed) group names.
3362 @item gnus-group-sort-by-level
3363 @findex gnus-group-sort-by-level
3364 Sort by group level.
3366 @item gnus-group-sort-by-score
3367 @findex gnus-group-sort-by-score
3368 Sort by group score. @xref{Group Score}.
3370 @item gnus-group-sort-by-rank
3371 @findex gnus-group-sort-by-rank
3372 Sort by group score and then the group level. The level and the score
3373 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3375 @item gnus-group-sort-by-unread
3376 @findex gnus-group-sort-by-unread
3377 Sort by number of unread articles.
3379 @item gnus-group-sort-by-method
3380 @findex gnus-group-sort-by-method
3381 Sort alphabetically on the select method.
3383 @item gnus-group-sort-by-server
3384 @findex gnus-group-sort-by-server
3385 Sort alphabetically on the Gnus server name.
3390 @code{gnus-group-sort-function} can also be a list of sorting
3391 functions. In that case, the most significant sort key function must be
3395 There are also a number of commands for sorting directly according to
3396 some sorting criteria:
3400 @kindex G S a (Group)
3401 @findex gnus-group-sort-groups-by-alphabet
3402 Sort the group buffer alphabetically by group name
3403 (@code{gnus-group-sort-groups-by-alphabet}).
3406 @kindex G S u (Group)
3407 @findex gnus-group-sort-groups-by-unread
3408 Sort the group buffer by the number of unread articles
3409 (@code{gnus-group-sort-groups-by-unread}).
3412 @kindex G S l (Group)
3413 @findex gnus-group-sort-groups-by-level
3414 Sort the group buffer by group level
3415 (@code{gnus-group-sort-groups-by-level}).
3418 @kindex G S v (Group)
3419 @findex gnus-group-sort-groups-by-score
3420 Sort the group buffer by group score
3421 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3424 @kindex G S r (Group)
3425 @findex gnus-group-sort-groups-by-rank
3426 Sort the group buffer by group rank
3427 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3430 @kindex G S m (Group)
3431 @findex gnus-group-sort-groups-by-method
3432 Sort the group buffer alphabetically by back end name@*
3433 (@code{gnus-group-sort-groups-by-method}).
3436 @kindex G S n (Group)
3437 @findex gnus-group-sort-groups-by-real-name
3438 Sort the group buffer alphabetically by real (unprefixed) group name
3439 (@code{gnus-group-sort-groups-by-real-name}).
3443 All the commands below obey the process/prefix convention
3444 (@pxref{Process/Prefix}).
3446 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3447 commands will sort in reverse order.
3449 You can also sort a subset of the groups:
3453 @kindex G P a (Group)
3454 @findex gnus-group-sort-selected-groups-by-alphabet
3455 Sort the groups alphabetically by group name
3456 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3459 @kindex G P u (Group)
3460 @findex gnus-group-sort-selected-groups-by-unread
3461 Sort the groups by the number of unread articles
3462 (@code{gnus-group-sort-selected-groups-by-unread}).
3465 @kindex G P l (Group)
3466 @findex gnus-group-sort-selected-groups-by-level
3467 Sort the groups by group level
3468 (@code{gnus-group-sort-selected-groups-by-level}).
3471 @kindex G P v (Group)
3472 @findex gnus-group-sort-selected-groups-by-score
3473 Sort the groups by group score
3474 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3477 @kindex G P r (Group)
3478 @findex gnus-group-sort-selected-groups-by-rank
3479 Sort the groups by group rank
3480 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3483 @kindex G P m (Group)
3484 @findex gnus-group-sort-selected-groups-by-method
3485 Sort the groups alphabetically by back end name@*
3486 (@code{gnus-group-sort-selected-groups-by-method}).
3489 @kindex G P n (Group)
3490 @findex gnus-group-sort-selected-groups-by-real-name
3491 Sort the groups alphabetically by real (unprefixed) group name
3492 (@code{gnus-group-sort-selected-groups-by-real-name}).
3495 @kindex G P s (Group)
3496 @findex gnus-group-sort-selected-groups
3497 Sort the groups according to @code{gnus-group-sort-function}.
3501 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3505 @node Group Maintenance
3506 @section Group Maintenance
3507 @cindex bogus groups
3512 @findex gnus-group-check-bogus-groups
3513 Find bogus groups and delete them
3514 (@code{gnus-group-check-bogus-groups}).
3518 @findex gnus-group-find-new-groups
3519 Find new groups and process them (@code{gnus-group-find-new-groups}).
3520 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3521 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3522 to query the server for new groups, and subscribe the new groups as
3526 @kindex C-c C-x (Group)
3527 @findex gnus-group-expire-articles
3528 @cindex expiring mail
3529 Run all expirable articles in the current group through the expiry
3530 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3531 all expirable articles in the group that have been around for a while.
3532 (@pxref{Expiring Mail}).
3535 @kindex C-c C-M-x (Group)
3536 @findex gnus-group-expire-all-groups
3537 @cindex expiring mail
3538 Run all expirable articles in all groups through the expiry process
3539 (@code{gnus-group-expire-all-groups}).
3544 @node Browse Foreign Server
3545 @section Browse Foreign Server
3546 @cindex foreign servers
3547 @cindex browsing servers
3552 @findex gnus-group-browse-foreign-server
3553 You will be queried for a select method and a server name. Gnus will
3554 then attempt to contact this server and let you browse the groups there
3555 (@code{gnus-group-browse-foreign-server}).
3558 @findex gnus-browse-mode
3559 A new buffer with a list of available groups will appear. This buffer
3560 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3561 a lot) like a normal group buffer.
3563 Here's a list of keystrokes available in the browse mode:
3568 @findex gnus-group-next-group
3569 Go to the next group (@code{gnus-group-next-group}).
3573 @findex gnus-group-prev-group
3574 Go to the previous group (@code{gnus-group-prev-group}).
3577 @kindex SPACE (Browse)
3578 @findex gnus-browse-read-group
3579 Enter the current group and display the first article
3580 (@code{gnus-browse-read-group}).
3583 @kindex RET (Browse)
3584 @findex gnus-browse-select-group
3585 Enter the current group (@code{gnus-browse-select-group}).
3589 @findex gnus-browse-unsubscribe-current-group
3590 Unsubscribe to the current group, or, as will be the case here,
3591 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3597 @findex gnus-browse-exit
3598 Exit browse mode (@code{gnus-browse-exit}).
3602 @findex gnus-browse-describe-group
3603 Describe the current group (@code{gnus-browse-describe-group}).
3607 @findex gnus-browse-describe-briefly
3608 Describe browse mode briefly (well, there's not much to describe, is
3609 there) (@code{gnus-browse-describe-briefly}).
3614 @section Exiting Gnus
3615 @cindex exiting Gnus
3617 Yes, Gnus is ex(c)iting.
3622 @findex gnus-group-suspend
3623 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3624 but it kills all buffers except the Group buffer. I'm not sure why this
3625 is a gain, but then who am I to judge?
3629 @findex gnus-group-exit
3630 @c @icon{gnus-group-exit}
3631 Quit Gnus (@code{gnus-group-exit}).
3635 @findex gnus-group-quit
3636 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3637 The dribble file will be saved, though (@pxref{Auto Save}).
3640 @vindex gnus-exit-gnus-hook
3641 @vindex gnus-suspend-gnus-hook
3642 @vindex gnus-after-exiting-gnus-hook
3643 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3644 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3645 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3651 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3652 numbly heavy and herself fall into a hazy trance as the boy sitting
3653 behind her drew repeated lines with his pencil across the back of her
3659 @section Group Topics
3662 If you read lots and lots of groups, it might be convenient to group
3663 them hierarchically according to topics. You put your Emacs groups over
3664 here, your sex groups over there, and the rest (what, two groups or so?)
3665 you put in some misc section that you never bother with anyway. You can
3666 even group the Emacs sex groups as a sub-topic to either the Emacs
3667 groups or the sex groups---or both! Go wild!
3671 \gnusfigure{Group Topics}{400}{
3672 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3683 2: alt.religion.emacs
3686 0: comp.talk.emacs.recovery
3688 8: comp.binaries.fractals
3689 13: comp.sources.unix
3692 @findex gnus-topic-mode
3694 To get this @emph{fab} functionality you simply turn on (ooh!) the
3695 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3696 is a toggling command.)
3698 Go ahead, just try it. I'll still be here when you get back. La de
3699 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3700 Yes, and now press @kbd{l}. There. All your groups are now listed
3701 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3704 If you want this permanently enabled, you should add that minor mode to
3705 the hook for the group mode. Put the following line in your
3706 @file{~/.gnus.el} file:
3709 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3713 * Topic Commands:: Interactive E-Z commands.
3714 * Topic Variables:: How to customize the topics the Lisp Way.
3715 * Topic Sorting:: Sorting each topic individually.
3716 * Topic Topology:: A map of the world.
3717 * Topic Parameters:: Parameters that apply to all groups in a topic.
3721 @node Topic Commands
3722 @subsection Topic Commands
3723 @cindex topic commands
3725 When the topic minor mode is turned on, a new @kbd{T} submap will be
3726 available. In addition, a few of the standard keys change their
3727 definitions slightly.
3729 In general, the following kinds of operations are possible on topics.
3730 First of all, you want to create topics. Secondly, you want to put
3731 groups in topics and to move them around until you have an order you
3732 like. The third kind of operation is to show/hide parts of the whole
3733 shebang. You might want to hide a topic including its subtopics and
3734 groups, to get a better overview of the other groups.
3736 Here is a list of the basic keys that you might need to set up topics
3743 @findex gnus-topic-create-topic
3744 Prompt for a new topic name and create it
3745 (@code{gnus-topic-create-topic}).
3749 @kindex T TAB (Topic)
3751 @findex gnus-topic-indent
3752 ``Indent'' the current topic so that it becomes a sub-topic of the
3753 previous topic (@code{gnus-topic-indent}). If given a prefix,
3754 ``un-indent'' the topic instead.
3757 @kindex M-TAB (Topic)
3758 @findex gnus-topic-unindent
3759 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3760 parent of its current parent (@code{gnus-topic-unindent}).
3764 The following two keys can be used to move groups and topics around.
3765 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3766 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3767 kill and yank rather than cut and paste.
3773 @findex gnus-topic-kill-group
3774 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3775 topic will be removed along with the topic.
3779 @findex gnus-topic-yank-group
3780 Yank the previously killed group or topic
3781 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3784 So, to move a topic to the beginning of the list of topics, just hit
3785 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3786 move the cursor to the beginning of the buffer (just below the ``Gnus''
3787 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3788 paste. Like I said -- E-Z.
3790 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3791 you can move topics around as well as groups.
3795 After setting up the topics the way you like them, you might wish to
3796 hide a topic, or to show it again. That's why we have the following
3803 @findex gnus-topic-select-group
3805 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3806 When you perform this command on a group, you'll enter the group, as
3807 usual. When done on a topic line, the topic will be folded (if it was
3808 visible) or unfolded (if it was folded already). So it's basically a
3809 toggling command on topics. In addition, if you give a numerical
3810 prefix, group on that level (and lower) will be displayed.
3814 Now for a list of other commands, in no particular order.
3820 @findex gnus-topic-move-group
3821 Move the current group to some other topic
3822 (@code{gnus-topic-move-group}). This command uses the process/prefix
3823 convention (@pxref{Process/Prefix}).
3827 @findex gnus-topic-jump-to-topic
3828 Go to a topic (@code{gnus-topic-jump-to-topic}).
3832 @findex gnus-topic-copy-group
3833 Copy the current group to some other topic
3834 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3835 convention (@pxref{Process/Prefix}).
3839 @findex gnus-topic-hide-topic
3840 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3841 a prefix, hide the topic permanently.
3845 @findex gnus-topic-show-topic
3846 Show the current topic (@code{gnus-topic-show-topic}). If given
3847 a prefix, show the topic permanently.
3851 @findex gnus-topic-remove-group
3852 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3853 This command is mainly useful if you have the same group in several
3854 topics and wish to remove it from one of the topics. You may also
3855 remove a group from all topics, but in that case, Gnus will add it to
3856 the root topic the next time you start Gnus. In fact, all new groups
3857 (which, naturally, don't belong to any topic) will show up in the root
3860 This command uses the process/prefix convention
3861 (@pxref{Process/Prefix}).
3865 @findex gnus-topic-move-matching
3866 Move all groups that match some regular expression to a topic
3867 (@code{gnus-topic-move-matching}).
3871 @findex gnus-topic-copy-matching
3872 Copy all groups that match some regular expression to a topic
3873 (@code{gnus-topic-copy-matching}).
3877 @findex gnus-topic-toggle-display-empty-topics
3878 Toggle hiding empty topics
3879 (@code{gnus-topic-toggle-display-empty-topics}).
3883 @findex gnus-topic-mark-topic
3884 Mark all groups in the current topic with the process mark
3885 (@code{gnus-topic-mark-topic}). This command works recursively on
3886 sub-topics unless given a prefix.
3889 @kindex T M-# (Topic)
3890 @findex gnus-topic-unmark-topic
3891 Remove the process mark from all groups in the current topic
3892 (@code{gnus-topic-unmark-topic}). This command works recursively on
3893 sub-topics unless given a prefix.
3896 @kindex C-c C-x (Topic)
3897 @findex gnus-topic-expire-articles
3898 @cindex expiring mail
3899 Run all expirable articles in the current group or topic through the
3900 expiry process (if any)
3901 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3905 @findex gnus-topic-rename
3906 Rename a topic (@code{gnus-topic-rename}).
3909 @kindex T DEL (Topic)
3910 @findex gnus-topic-delete
3911 Delete an empty topic (@code{gnus-topic-delete}).
3915 @findex gnus-topic-list-active
3916 List all groups that Gnus knows about in a topics-ified way
3917 (@code{gnus-topic-list-active}).
3920 @kindex T M-n (Topic)
3921 @findex gnus-topic-goto-next-topic
3922 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3925 @kindex T M-p (Topic)
3926 @findex gnus-topic-goto-previous-topic
3927 Go to the previous topic (@code{gnus-topic-goto-previous-topic}).
3931 @findex gnus-topic-edit-parameters
3932 @cindex group parameters
3933 @cindex topic parameters
3935 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3936 @xref{Topic Parameters}.
3941 @node Topic Variables
3942 @subsection Topic Variables
3943 @cindex topic variables
3945 The previous section told you how to tell Gnus which topics to display.
3946 This section explains how to tell Gnus what to display about each topic.
3948 @vindex gnus-topic-line-format
3949 The topic lines themselves are created according to the
3950 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3963 Number of groups in the topic.
3965 Number of unread articles in the topic.
3967 Number of unread articles in the topic and all its subtopics.
3970 @vindex gnus-topic-indent-level
3971 Each sub-topic (and the groups in the sub-topics) will be indented with
3972 @code{gnus-topic-indent-level} times the topic level number of spaces.
3975 @vindex gnus-topic-mode-hook
3976 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3978 @vindex gnus-topic-display-empty-topics
3979 The @code{gnus-topic-display-empty-topics} says whether to display even
3980 topics that have no unread articles in them. The default is @code{t}.
3984 @subsection Topic Sorting
3985 @cindex topic sorting
3987 You can sort the groups in each topic individually with the following
3993 @kindex T S a (Topic)
3994 @findex gnus-topic-sort-groups-by-alphabet
3995 Sort the current topic alphabetically by group name
3996 (@code{gnus-topic-sort-groups-by-alphabet}).
3999 @kindex T S u (Topic)
4000 @findex gnus-topic-sort-groups-by-unread
4001 Sort the current topic by the number of unread articles
4002 (@code{gnus-topic-sort-groups-by-unread}).
4005 @kindex T S l (Topic)
4006 @findex gnus-topic-sort-groups-by-level
4007 Sort the current topic by group level
4008 (@code{gnus-topic-sort-groups-by-level}).
4011 @kindex T S v (Topic)
4012 @findex gnus-topic-sort-groups-by-score
4013 Sort the current topic by group score
4014 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
4017 @kindex T S r (Topic)
4018 @findex gnus-topic-sort-groups-by-rank
4019 Sort the current topic by group rank
4020 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
4023 @kindex T S m (Topic)
4024 @findex gnus-topic-sort-groups-by-method
4025 Sort the current topic alphabetically by back end name
4026 (@code{gnus-topic-sort-groups-by-method}).
4029 @kindex T S e (Topic)
4030 @findex gnus-topic-sort-groups-by-server
4031 Sort the current topic alphabetically by server name
4032 (@code{gnus-topic-sort-groups-by-server}).
4035 @kindex T S s (Topic)
4036 @findex gnus-topic-sort-groups
4037 Sort the current topic according to the function(s) given by the
4038 @code{gnus-group-sort-function} variable
4039 (@code{gnus-topic-sort-groups}).
4043 When given a prefix argument, all these commands will sort in reverse
4044 order. @xref{Sorting Groups}, for more information about group
4048 @node Topic Topology
4049 @subsection Topic Topology
4050 @cindex topic topology
4053 So, let's have a look at an example group buffer:
4060 2: alt.religion.emacs
4063 0: comp.talk.emacs.recovery
4065 8: comp.binaries.fractals
4066 13: comp.sources.unix
4070 So, here we have one top-level topic (@samp{Gnus}), two topics under
4071 that, and one sub-topic under one of the sub-topics. (There is always
4072 just one (1) top-level topic). This topology can be expressed as
4077 (("Emacs -- I wuw it!" visible)
4078 (("Naughty Emacs" visible)))
4082 @vindex gnus-topic-topology
4083 This is in fact how the variable @code{gnus-topic-topology} would look
4084 for the display above. That variable is saved in the @file{.newsrc.eld}
4085 file, and shouldn't be messed with manually---unless you really want
4086 to. Since this variable is read from the @file{.newsrc.eld} file,
4087 setting it in any other startup files will have no effect.
4089 This topology shows what topics are sub-topics of what topics (right),
4090 and which topics are visible. Two settings are currently
4091 allowed---@code{visible} and @code{invisible}.
4094 @node Topic Parameters
4095 @subsection Topic Parameters
4096 @cindex topic parameters
4098 All groups in a topic will inherit group parameters from the parent
4099 (and ancestor) topic parameters. All valid group parameters are valid
4100 topic parameters (@pxref{Group Parameters}). When the agent is
4101 enabled, all agent parameters (See Agent Parameters in @ref{Category
4102 Syntax}) are also valid topic parameters.
4104 In addition, the following parameters are only valid as topic
4109 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4110 @code{subscribe} topic parameter says what groups go in what topic. Its
4111 value should be a regexp to match the groups that should go in that
4114 @item subscribe-level
4115 When subscribing new groups by topic (see the @code{subscribe} parameter),
4116 the group will be subscribed with the level specified in the
4117 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4121 Group parameters (of course) override topic parameters, and topic
4122 parameters in sub-topics override topic parameters in super-topics. You
4123 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4124 verb, although you may feel free to disagree with me here.)
4131 2: alt.religion.emacs
4135 0: comp.talk.emacs.recovery
4137 8: comp.binaries.fractals
4138 13: comp.sources.unix
4143 The @samp{Emacs} topic has the topic parameter @code{(score-file
4144 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4145 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4146 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4147 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4148 . "religion.SCORE")}.
4150 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4151 will get the @file{relief.SCORE} home score file. If you enter the same
4152 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4153 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4154 get the @file{religion.SCORE} home score file.
4156 This seems rather simple and self-evident, doesn't it? Well, yes. But
4157 there are some problems, especially with the @code{total-expiry}
4158 parameter. Say you have a mail group in two topics; one with
4159 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4160 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4161 of these topics you mean to expire articles from, so anything may
4162 happen. In fact, I hereby declare that it is @dfn{undefined} what
4163 happens. You just have to be careful if you do stuff like that.
4166 @node Non-ASCII Group Names
4167 @section Accessing groups of non-English names
4168 @cindex non-ascii group names
4170 There are some news servers that provide groups of which the names are
4171 expressed with their native languages in the world. For instance, in a
4172 certain news server there are some newsgroups of which the names are
4173 spelled in Chinese, where people are talking in Chinese. You can, of
4174 course, subscribe to such news groups using Gnus. Currently Gnus
4175 supports non-@acronym{ASCII} group names not only with the @code{nntp}
4176 back end but also with the @code{nnml} back end and the @code{nnrss}
4179 Every such group name is encoded by a certain charset in the server
4180 side (in an @acronym{NNTP} server its administrator determines the
4181 charset, but for groups in the other back ends it is determined by you).
4182 Gnus has to display the decoded ones for you in the group buffer and the
4183 article buffer, and needs to use the encoded ones when communicating
4184 with servers. However, Gnus doesn't know what charset is used for each
4185 non-@acronym{ASCII} group name. The following two variables are just
4186 the ones for telling Gnus what charset should be used for each group:
4189 @item gnus-group-name-charset-method-alist
4190 @vindex gnus-group-name-charset-method-alist
4191 An alist of select methods and charsets. The default value is
4192 @code{nil}. The names of groups in the server specified by that select
4193 method are all supposed to use the corresponding charset. For example:
4196 (setq gnus-group-name-charset-method-alist
4197 '(((nntp "news.com.cn") . cn-gb-2312)))
4200 Charsets specified for groups with this variable are preferred to the
4201 ones specified for the same groups with the
4202 @code{gnus-group-name-charset-group-alist} variable (see below).
4204 A select method can be very long, like:
4208 (nntp-address "news.gmane.org")
4209 (nntp-end-of-line "\n")
4210 (nntp-open-connection-function
4211 nntp-open-via-rlogin-and-telnet)
4212 (nntp-via-rlogin-command "ssh")
4213 (nntp-via-rlogin-command-switches
4214 ("-C" "-t" "-e" "none"))
4215 (nntp-via-address @dots{}))
4218 In that case, you can truncate it into @code{(nntp "gmane")} in this
4219 variable. That is, it is enough to contain only the back end name and
4222 @item gnus-group-name-charset-group-alist
4223 @cindex UTF-8 group names
4224 @vindex gnus-group-name-charset-group-alist
4225 An alist of regexp of group name and the charset for group names.
4226 @code{((".*" . utf-8))} is the default value if UTF-8 is supported,
4227 otherwise the default is @code{nil}. For example:
4230 (setq gnus-group-name-charset-group-alist
4231 '(("\\.com\\.cn:" . cn-gb-2312)
4235 Note that this variable is ignored if the match is made with
4236 @code{gnus-group-name-charset-method-alist}.
4239 Those two variables are used also to determine the charset for encoding
4240 and decoding non-@acronym{ASCII} group names that are in the back ends
4241 other than @code{nntp}. It means that it is you who determine it. If
4242 you do nothing, the charset used for group names in those back ends will
4243 all be @code{utf-8} because of the last element of
4244 @code{gnus-group-name-charset-group-alist}.
4246 There is one more important variable for non-@acronym{ASCII} group
4247 names. @emph{XEmacs users must set this}. Emacs users necessarily need
4251 @item nnmail-pathname-coding-system
4252 The value of this variable should be a coding system or @code{nil}
4253 (which is the default). The @code{nnml} back end, the @code{nnrss} back
4254 end, the @acronym{NNTP} marks feature (@pxref{NNTP marks}), the agent,
4255 and the cache use non-@acronym{ASCII} group names in those files and
4256 directories. This variable overrides the value of
4257 @code{file-name-coding-system} which specifies the coding system used
4258 when encoding and decoding those file names and directory names.
4260 In XEmacs (with the @code{mule} feature), @code{file-name-coding-system}
4261 is the only means to specify the coding system used to encode and decode
4262 file names. Therefore, @emph{you, XEmacs users, have to set it} to the
4263 coding system that is suitable to encode and decode non-@acronym{ASCII}
4264 group names. On the other hand, Emacs uses the value of
4265 @code{default-file-name-coding-system} if @code{file-name-coding-system}
4266 is @code{nil}. Normally the value of
4267 @code{default-file-name-coding-system} is initialized according to the
4268 locale, so you will need to do nothing if the value is suitable to
4269 encode and decode non-@acronym{ASCII} group names.
4271 The value of this variable (or @code{default-file-name-coding-system})
4272 does not necessarily need to be the same value that is determined by
4273 @code{gnus-group-name-charset-method-alist} and
4274 @code{gnus-group-name-charset-group-alist}.
4276 If you want to subscribe to the groups spelled in Chinese but
4277 @code{default-file-name-coding-system} is initialized by default to
4278 @code{iso-latin-1} for example, that is the most typical case where you
4279 have to set @code{nnmail-pathname-coding-system} even if you are an
4280 Emacs user. The @code{utf-8} coding system is a good candidate for it.
4281 Otherwise, you may change the locale in your system so that
4282 @code{default-file-name-coding-system} may be initialized to an
4283 appropriate value, instead of specifying this variable.
4286 Note that when you copy or move articles from a non-@acronym{ASCII}
4287 group to another group, the charset used to encode and decode group
4288 names should be the same in both groups. Otherwise the Newsgroups
4289 header will be displayed incorrectly in the article buffer.
4292 @node Misc Group Stuff
4293 @section Misc Group Stuff
4296 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4297 * Group Information:: Information and help on groups and Gnus.
4298 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4299 * File Commands:: Reading and writing the Gnus files.
4300 * Sieve Commands:: Managing Sieve scripts.
4307 @cindex keys, reserved for users (Group)
4308 The key @kbd{v} is reserved for users. You can bind it to some
4309 command or better use it as a prefix key. For example:
4312 (define-key gnus-group-mode-map (kbd "v j d")
4315 (gnus-group-jump-to-group "nndraft:drafts")))
4318 On keys reserved for users in Emacs and on keybindings in general
4319 @xref{Keymaps, Keymaps, , emacs, The Emacs Editor}.
4323 @findex gnus-group-enter-server-mode
4324 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4325 @xref{Server Buffer}.
4329 @findex gnus-group-post-news
4330 Start composing a message (a news by default)
4331 (@code{gnus-group-post-news}). If given a prefix, post to the group
4332 under the point. If the prefix is 1, prompt for a group to post to.
4333 Contrary to what the name of this function suggests, the prepared
4334 article might be a mail instead of a news, if a mail group is specified
4335 with the prefix argument. @xref{Composing Messages}.
4339 @findex gnus-group-mail
4340 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4341 use the posting style of the group under the point. If the prefix is 1,
4342 prompt for a group name to find the posting style.
4343 @xref{Composing Messages}.
4347 @findex gnus-group-news
4348 Start composing a news (@code{gnus-group-news}). If given a prefix,
4349 post to the group under the point. If the prefix is 1, prompt
4350 for group to post to. @xref{Composing Messages}.
4352 This function actually prepares a news even when using mail groups.
4353 This is useful for ``posting'' messages to mail groups without actually
4354 sending them over the network: they're just saved directly to the group
4355 in question. The corresponding back end must have a request-post method
4356 for this to work though.
4360 @findex gnus-group-compact-group
4362 Compact the group under point (@code{gnus-group-compact-group}).
4363 Currently implemented only in nnml (@pxref{Mail Spool}). This removes
4364 gaps between article numbers, hence getting a correct total article
4369 Variables for the group buffer:
4373 @item gnus-group-mode-hook
4374 @vindex gnus-group-mode-hook
4375 is called after the group buffer has been
4378 @item gnus-group-prepare-hook
4379 @vindex gnus-group-prepare-hook
4380 is called after the group buffer is
4381 generated. It may be used to modify the buffer in some strange,
4384 @item gnus-group-prepared-hook
4385 @vindex gnus-group-prepare-hook
4386 is called as the very last thing after the group buffer has been
4387 generated. It may be used to move point around, for instance.
4389 @item gnus-permanently-visible-groups
4390 @vindex gnus-permanently-visible-groups
4391 Groups matching this regexp will always be listed in the group buffer,
4392 whether they are empty or not.
4396 @node Scanning New Messages
4397 @subsection Scanning New Messages
4398 @cindex new messages
4399 @cindex scanning new news
4405 @findex gnus-group-get-new-news
4406 @c @icon{gnus-group-get-new-news}
4407 Check the server(s) for new articles. If the numerical prefix is used,
4408 this command will check only groups of level @var{arg} and lower
4409 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4410 command will force a total re-reading of the active file(s) from the
4415 @findex gnus-group-get-new-news-this-group
4416 @vindex gnus-goto-next-group-when-activating
4417 @c @icon{gnus-group-get-new-news-this-group}
4418 Check whether new articles have arrived in the current group
4419 (@code{gnus-group-get-new-news-this-group}).
4420 @code{gnus-goto-next-group-when-activating} says whether this command is
4421 to move point to the next group or not. It is @code{t} by default.
4423 @findex gnus-activate-all-groups
4424 @cindex activating groups
4426 @kindex C-c M-g (Group)
4427 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4432 @findex gnus-group-restart
4433 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4434 file(s), closes the connection to all servers, clears up all run-time
4435 Gnus variables, and then starts Gnus all over again.
4439 @vindex gnus-get-new-news-hook
4440 @code{gnus-get-new-news-hook} is run just before checking for new news.
4442 @vindex gnus-after-getting-new-news-hook
4443 @code{gnus-after-getting-new-news-hook} is run after checking for new
4447 @node Group Information
4448 @subsection Group Information
4449 @cindex group information
4450 @cindex information on groups
4457 @findex gnus-group-fetch-faq
4458 @vindex gnus-group-faq-directory
4461 Try to fetch the @acronym{FAQ} for the current group
4462 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4463 from @code{gnus-group-faq-directory}, which is usually a directory on
4464 a remote machine. This variable can also be a list of directories.
4465 In that case, giving a prefix to this command will allow you to choose
4466 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4467 used for fetching the file.
4469 If fetching from the first site is unsuccessful, Gnus will attempt to go
4470 through @code{gnus-group-faq-directory} and try to open them one by one.
4474 @findex gnus-group-fetch-charter
4475 @vindex gnus-group-charter-alist
4477 Try to open the charter for the current group in a web browser
4478 (@code{gnus-group-fetch-charter}). Query for a group if given a
4481 Gnus will use @code{gnus-group-charter-alist} to find the location of
4482 the charter. If no location is known, Gnus will fetch the control
4483 messages for the group, which in some cases includes the charter.
4487 @findex gnus-group-fetch-control
4488 @vindex gnus-group-fetch-control-use-browse-url
4489 @cindex control message
4490 Fetch the control messages for the group from the archive at
4491 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4492 group if given a prefix argument.
4494 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4495 Gnus will open the control messages in a browser using
4496 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4497 and displayed in an ephemeral group.
4499 Note that the control messages are compressed. To use this command
4500 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4501 Files, ,Compressed Files, emacs, The Emacs Manual}).
4505 @c @icon{gnus-group-describe-group}
4507 @kindex C-c C-d (Group)
4508 @cindex describing groups
4509 @cindex group description
4510 @findex gnus-group-describe-group
4511 Describe the current group (@code{gnus-group-describe-group}). If given
4512 a prefix, force Gnus to re-read the description from the server.
4516 @findex gnus-group-describe-all-groups
4517 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4518 prefix, force Gnus to re-read the description file from the server.
4525 @findex gnus-version
4526 Display current Gnus version numbers (@code{gnus-version}).
4530 @findex gnus-group-describe-briefly
4531 Give a very short help message (@code{gnus-group-describe-briefly}).
4534 @kindex C-c C-i (Group)
4537 @findex gnus-info-find-node
4538 Go to the Gnus info node (@code{gnus-info-find-node}).
4542 @node Group Timestamp
4543 @subsection Group Timestamp
4545 @cindex group timestamps
4547 It can be convenient to let Gnus keep track of when you last read a
4548 group. To set the ball rolling, you should add
4549 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4552 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4555 After doing this, each time you enter a group, it'll be recorded.
4557 This information can be displayed in various ways---the easiest is to
4558 use the @samp{%d} spec in the group line format:
4561 (setq gnus-group-line-format
4562 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4565 This will result in lines looking like:
4568 * 0: mail.ding 19961002T012943
4569 0: custom 19961002T012713
4572 As you can see, the date is displayed in compact ISO 8601 format. This
4573 may be a bit too much, so to just display the date, you could say
4577 (setq gnus-group-line-format
4578 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4581 If you would like greater control of the time format, you can use a
4582 user-defined format spec. Something like the following should do the
4586 (setq gnus-group-line-format
4587 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4588 (defun gnus-user-format-function-d (headers)
4589 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4591 (format-time-string "%b %d %H:%M" time)
4597 @subsection File Commands
4598 @cindex file commands
4604 @findex gnus-group-read-init-file
4605 @vindex gnus-init-file
4606 @cindex reading init file
4607 Re-read the init file (@code{gnus-init-file}, which defaults to
4608 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4612 @findex gnus-group-save-newsrc
4613 @cindex saving .newsrc
4614 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4615 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4616 file(s) whether Gnus thinks it is necessary or not.
4619 @c @kindex Z (Group)
4620 @c @findex gnus-group-clear-dribble
4621 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4626 @node Sieve Commands
4627 @subsection Sieve Commands
4628 @cindex group sieve commands
4630 Sieve is a server-side mail filtering language. In Gnus you can use
4631 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4632 sieve rules that should apply to each group. Gnus provides two
4633 commands to translate all these group parameters into a proper Sieve
4634 script that can be transfered to the server somehow.
4636 @vindex gnus-sieve-file
4637 @vindex gnus-sieve-region-start
4638 @vindex gnus-sieve-region-end
4639 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4640 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4641 between two delimiters, @code{gnus-sieve-region-start} and
4642 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4643 outside these delimiters that will not be removed the next time you
4644 regenerate the Sieve script.
4646 @vindex gnus-sieve-crosspost
4647 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4648 is generated. If it is non-@code{nil} (the default) articles is
4649 placed in all groups that have matching rules, otherwise the article
4650 is only placed in the group with the first matching rule. For
4651 example, the group parameter @samp{(sieve address "sender"
4652 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4653 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4654 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4655 except that the line containing the call to @code{stop} is removed.)
4658 if address "sender" "owner-ding@@hpc.uh.edu" @{
4659 fileinto "INBOX.ding";
4664 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4670 @findex gnus-sieve-generate
4671 @vindex gnus-sieve-file
4672 @cindex generating sieve script
4673 Regenerate a Sieve script from the @code{sieve} group parameters and
4674 put you into the @code{gnus-sieve-file} without saving it.
4678 @findex gnus-sieve-update
4679 @vindex gnus-sieve-file
4680 @cindex updating sieve script
4681 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4682 @code{sieve} group parameters, save the file and upload it to the
4683 server using the @code{sieveshell} program.
4688 @node Summary Buffer
4689 @chapter Summary Buffer
4690 @cindex summary buffer
4692 A line for each article is displayed in the summary buffer. You can
4693 move around, read articles, post articles and reply to articles.
4695 The most common way to a summary buffer is to select a group from the
4696 group buffer (@pxref{Selecting a Group}).
4698 You can have as many summary buffers open as you wish.
4700 You can customize the Summary Mode tool bar, see @kbd{M-x
4701 customize-apropos RET gnus-summary-tool-bar}. This feature is only
4705 @cindex keys, reserved for users (Summary)
4706 The key @kbd{v} is reserved for users. You can bind it to some
4707 command or better use it as a prefix key. For example:
4709 (define-key gnus-summary-mode-map (kbd "v -") "LrS") ;; lower subthread
4713 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4714 * Summary Maneuvering:: Moving around the summary buffer.
4715 * Choosing Articles:: Reading articles.
4716 * Paging the Article:: Scrolling the current article.
4717 * Reply Followup and Post:: Posting articles.
4718 * Delayed Articles:: Send articles at a later time.
4719 * Marking Articles:: Marking articles as read, expirable, etc.
4720 * Limiting:: You can limit the summary buffer.
4721 * Threading:: How threads are made.
4722 * Sorting the Summary Buffer:: How articles and threads are sorted.
4723 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4724 * Article Caching:: You may store articles in a cache.
4725 * Persistent Articles:: Making articles expiry-resistant.
4726 * Sticky Articles:: Article buffers that are not reused.
4727 * Article Backlog:: Having already read articles hang around.
4728 * Saving Articles:: Ways of customizing article saving.
4729 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4730 * Article Treatment:: The article buffer can be mangled at will.
4731 * MIME Commands:: Doing MIMEy things with the articles.
4732 * Charsets:: Character set issues.
4733 * Article Commands:: Doing various things with the article buffer.
4734 * Summary Sorting:: Sorting the summary buffer in various ways.
4735 * Finding the Parent:: No child support? Get the parent.
4736 * Alternative Approaches:: Reading using non-default summaries.
4737 * Tree Display:: A more visual display of threads.
4738 * Mail Group Commands:: Some commands can only be used in mail groups.
4739 * Various Summary Stuff:: What didn't fit anywhere else.
4740 * Exiting the Summary Buffer:: Returning to the Group buffer,
4741 or reselecting the current group.
4742 * Crosspost Handling:: How crossposted articles are dealt with.
4743 * Duplicate Suppression:: An alternative when crosspost handling fails.
4744 * Security:: Decrypt and Verify.
4745 * Mailing List:: Mailing list minor mode.
4749 @node Summary Buffer Format
4750 @section Summary Buffer Format
4751 @cindex summary buffer format
4755 \gnusfigure{The Summary Buffer}{180}{
4756 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4757 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4763 * Summary Buffer Lines:: You can specify how summary lines should look.
4764 * To From Newsgroups:: How to not display your own name.
4765 * Summary Buffer Mode Line:: You can say how the mode line should look.
4766 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4769 @findex mail-extract-address-components
4770 @findex gnus-extract-address-components
4771 @vindex gnus-extract-address-components
4772 Gnus will use the value of the @code{gnus-extract-address-components}
4773 variable as a function for getting the name and address parts of a
4774 @code{From} header. Two pre-defined functions exist:
4775 @code{gnus-extract-address-components}, which is the default, quite
4776 fast, and too simplistic solution; and
4777 @code{mail-extract-address-components}, which works very nicely, but is
4778 slower. The default function will return the wrong answer in 5% of the
4779 cases. If this is unacceptable to you, use the other function instead:
4782 (setq gnus-extract-address-components
4783 'mail-extract-address-components)
4786 @vindex gnus-summary-same-subject
4787 @code{gnus-summary-same-subject} is a string indicating that the current
4788 article has the same subject as the previous. This string will be used
4789 with those specs that require it. The default is @code{""}.
4792 @node Summary Buffer Lines
4793 @subsection Summary Buffer Lines
4795 @vindex gnus-summary-line-format
4796 You can change the format of the lines in the summary buffer by changing
4797 the @code{gnus-summary-line-format} variable. It works along the same
4798 lines as a normal @code{format} string, with some extensions
4799 (@pxref{Formatting Variables}).
4801 There should always be a colon or a point position marker on the line;
4802 the cursor always moves to the point position marker or the colon after
4803 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4804 possible to change this. Just write a new function
4805 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4806 @xref{Positioning Point}.
4808 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4810 The following format specification characters and extended format
4811 specification(s) are understood:
4817 Subject string. List identifiers stripped,
4818 @code{gnus-list-identifiers}. @xref{Article Hiding}.
4820 Subject if the article is the root of the thread or the previous article
4821 had a different subject, @code{gnus-summary-same-subject} otherwise.
4822 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4824 Full @code{From} header.
4826 The name (from the @code{From} header).
4828 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4831 The name (from the @code{From} header). This differs from the @code{n}
4832 spec in that it uses the function designated by the
4833 @code{gnus-extract-address-components} variable, which is slower, but
4834 may be more thorough.
4836 The address (from the @code{From} header). This works the same way as
4839 Number of lines in the article.
4841 Number of characters in the article. This specifier is not supported
4842 in some methods (like nnfolder).
4844 Pretty-printed version of the number of characters in the article;
4845 for example, @samp{1.2k} or @samp{0.4M}.
4847 Indentation based on thread level (@pxref{Customizing Threading}).
4849 A complex trn-style thread tree, showing response-connecting trace
4850 lines. A thread could be drawn like this:
4863 You can customize the appearance with the following options. Note
4864 that it is possible to make the thread display look really neat by
4865 replacing the default @acronym{ASCII} characters with graphic
4866 line-drawing glyphs.
4868 @item gnus-sum-thread-tree-root
4869 @vindex gnus-sum-thread-tree-root
4870 Used for the root of a thread. If @code{nil}, use subject
4871 instead. The default is @samp{> }.
4873 @item gnus-sum-thread-tree-false-root
4874 @vindex gnus-sum-thread-tree-false-root
4875 Used for the false root of a thread (@pxref{Loose Threads}). If
4876 @code{nil}, use subject instead. The default is @samp{> }.
4878 @item gnus-sum-thread-tree-single-indent
4879 @vindex gnus-sum-thread-tree-single-indent
4880 Used for a thread with just one message. If @code{nil}, use subject
4881 instead. The default is @samp{}.
4883 @item gnus-sum-thread-tree-vertical
4884 @vindex gnus-sum-thread-tree-vertical
4885 Used for drawing a vertical line. The default is @samp{| }.
4887 @item gnus-sum-thread-tree-indent
4888 @vindex gnus-sum-thread-tree-indent
4889 Used for indenting. The default is @samp{ }.
4891 @item gnus-sum-thread-tree-leaf-with-other
4892 @vindex gnus-sum-thread-tree-leaf-with-other
4893 Used for a leaf with brothers. The default is @samp{+-> }.
4895 @item gnus-sum-thread-tree-single-leaf
4896 @vindex gnus-sum-thread-tree-single-leaf
4897 Used for a leaf without brothers. The default is @samp{\-> }
4902 Nothing if the article is a root and lots of spaces if it isn't (it
4903 pushes everything after it off the screen).
4905 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4906 for adopted articles (@pxref{Customizing Threading}).
4908 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4909 for adopted articles.
4911 One space for each thread level.
4913 Twenty minus thread level spaces.
4915 Unread. @xref{Read Articles}.
4918 This misleadingly named specifier is the @dfn{secondary mark}. This
4919 mark will say whether the article has been replied to, has been cached,
4920 or has been saved. @xref{Other Marks}.
4923 Score as a number (@pxref{Scoring}).
4925 @vindex gnus-summary-zcore-fuzz
4926 Zcore, @samp{+} if above the default level and @samp{-} if below the
4927 default level. If the difference between
4928 @code{gnus-summary-default-score} and the score is less than
4929 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4937 The @code{Date} in @code{DD-MMM} format.
4939 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4945 Number of articles in the current sub-thread. Using this spec will slow
4946 down summary buffer generation somewhat.
4948 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4949 article has any children.
4955 Desired cursor position (instead of after first colon).
4957 Age sensitive date format. Various date format is defined in
4958 @code{gnus-user-date-format-alist}.
4960 User defined specifier. The next character in the format string should
4961 be a letter. Gnus will call the function
4962 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4963 following @samp{%u}. The function will be passed the current header as
4964 argument. The function should return a string, which will be inserted
4965 into the summary just like information from any other summary specifier.
4968 Text between @samp{%(} and @samp{%)} will be highlighted with
4969 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4970 There can only be one such area.
4972 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4973 have to be handled with care. For reasons of efficiency, Gnus will
4974 compute what column these characters will end up in, and ``hard-code''
4975 that. This means that it is invalid to have these specs after a
4976 variable-length spec. Well, you might not be arrested, but your summary
4977 buffer will look strange, which is bad enough.
4979 The smart choice is to have these specs as far to the left as possible.
4980 (Isn't that the case with everything, though? But I digress.)
4982 This restriction may disappear in later versions of Gnus.
4985 @node To From Newsgroups
4986 @subsection To From Newsgroups
4990 In some groups (particularly in archive groups), the @code{From} header
4991 isn't very interesting, since all the articles there are written by
4992 you. To display the information in the @code{To} or @code{Newsgroups}
4993 headers instead, you need to decide three things: What information to
4994 gather; where to display it; and when to display it.
4998 @vindex gnus-extra-headers
4999 The reading of extra header information is controlled by the
5000 @code{gnus-extra-headers}. This is a list of header symbols. For
5004 (setq gnus-extra-headers
5005 '(To Newsgroups X-Newsreader))
5008 This will result in Gnus trying to obtain these three headers, and
5009 storing it in header structures for later easy retrieval.
5012 @findex gnus-extra-header
5013 The value of these extra headers can be accessed via the
5014 @code{gnus-extra-header} function. Here's a format line spec that will
5015 access the @code{X-Newsreader} header:
5018 "%~(form (gnus-extra-header 'X-Newsreader))@@"
5022 @vindex gnus-ignored-from-addresses
5023 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
5024 summary line spec returns the @code{To}, @code{Newsreader} or
5025 @code{From} header. If this regexp matches the contents of the
5026 @code{From} header, the value of the @code{To} or @code{Newsreader}
5027 headers are used instead.
5029 To distinguish regular articles from those where the @code{From} field
5030 has been swapped, a string is prefixed to the @code{To} or
5031 @code{Newsgroups} header in the summary line. By default the string is
5032 @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can
5033 customize these strings with @code{gnus-summary-to-prefix} and
5034 @code{gnus-summary-newsgroup-prefix}.
5038 @vindex nnmail-extra-headers
5039 A related variable is @code{nnmail-extra-headers}, which controls when
5040 to include extra headers when generating overview (@acronym{NOV}) files.
5041 If you have old overview files, you should regenerate them after
5042 changing this variable, by entering the server buffer using @kbd{^},
5043 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
5046 @vindex gnus-summary-line-format
5047 You also have to instruct Gnus to display the data by changing the
5048 @code{%n} spec to the @code{%f} spec in the
5049 @code{gnus-summary-line-format} variable.
5051 In summary, you'd typically put something like the following in
5055 (setq gnus-extra-headers
5057 (setq nnmail-extra-headers gnus-extra-headers)
5058 (setq gnus-summary-line-format
5059 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
5060 (setq gnus-ignored-from-addresses
5064 (The values listed above are the default values in Gnus. Alter them
5067 A note for news server administrators, or for users who wish to try to
5068 convince their news server administrator to provide some additional
5071 The above is mostly useful for mail groups, where you have control over
5072 the @acronym{NOV} files that are created. However, if you can persuade your
5073 nntp admin to add (in the usual implementation, notably INN):
5079 to the end of her @file{overview.fmt} file, then you can use that just
5080 as you would the extra headers from the mail groups.
5083 @node Summary Buffer Mode Line
5084 @subsection Summary Buffer Mode Line
5086 @vindex gnus-summary-mode-line-format
5087 You can also change the format of the summary mode bar (@pxref{Mode Line
5088 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
5089 like. The default is @samp{Gnus: %%b [%A] %Z}.
5091 Here are the elements you can play with:
5097 Unprefixed group name.
5099 Current article number.
5101 Current article score.
5105 Number of unread articles in this group.
5107 Number of unread articles in this group that aren't displayed in the
5110 A string with the number of unread and unselected articles represented
5111 either as @samp{<%U(+%e) more>} if there are both unread and unselected
5112 articles, and just as @samp{<%U more>} if there are just unread articles
5113 and no unselected ones.
5115 Shortish group name. For instance, @samp{rec.arts.anime} will be
5116 shortened to @samp{r.a.anime}.
5118 Subject of the current article.
5120 User-defined spec (@pxref{User-Defined Specs}).
5122 Name of the current score file (@pxref{Scoring}).
5124 Number of dormant articles (@pxref{Unread Articles}).
5126 Number of ticked articles (@pxref{Unread Articles}).
5128 Number of articles that have been marked as read in this session.
5130 Number of articles expunged by the score files.
5134 @node Summary Highlighting
5135 @subsection Summary Highlighting
5139 @item gnus-visual-mark-article-hook
5140 @vindex gnus-visual-mark-article-hook
5141 This hook is run after selecting an article. It is meant to be used for
5142 highlighting the article in some way. It is not run if
5143 @code{gnus-visual} is @code{nil}.
5145 @item gnus-summary-update-hook
5146 @vindex gnus-summary-update-hook
5147 This hook is called when a summary line is changed. It is not run if
5148 @code{gnus-visual} is @code{nil}.
5150 @item gnus-summary-selected-face
5151 @vindex gnus-summary-selected-face
5152 This is the face (or @dfn{font} as some people call it) used to
5153 highlight the current article in the summary buffer.
5155 @item gnus-summary-highlight
5156 @vindex gnus-summary-highlight
5157 Summary lines are highlighted according to this variable, which is a
5158 list where the elements are of the format @code{(@var{form}
5159 . @var{face})}. If you would, for instance, like ticked articles to be
5160 italic and high-scored articles to be bold, you could set this variable
5163 (((eq mark gnus-ticked-mark) . italic)
5164 ((> score default) . bold))
5166 As you may have guessed, if @var{form} returns a non-@code{nil} value,
5167 @var{face} will be applied to the line.
5171 @node Summary Maneuvering
5172 @section Summary Maneuvering
5173 @cindex summary movement
5175 All the straight movement commands understand the numeric prefix and
5176 behave pretty much as you'd expect.
5178 None of these commands select articles.
5183 @kindex M-n (Summary)
5184 @kindex G M-n (Summary)
5185 @findex gnus-summary-next-unread-subject
5186 Go to the next summary line of an unread article
5187 (@code{gnus-summary-next-unread-subject}).
5191 @kindex M-p (Summary)
5192 @kindex G M-p (Summary)
5193 @findex gnus-summary-prev-unread-subject
5194 Go to the previous summary line of an unread article
5195 (@code{gnus-summary-prev-unread-subject}).
5198 @kindex G g (Summary)
5199 @findex gnus-summary-goto-subject
5200 Ask for an article number and then go to the summary line of that article
5201 without displaying the article (@code{gnus-summary-goto-subject}).
5204 If Gnus asks you to press a key to confirm going to the next group, you
5205 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
5206 buffer, searching for the next group to read without actually returning
5207 to the group buffer.
5209 Variables related to summary movement:
5213 @vindex gnus-auto-select-next
5214 @item gnus-auto-select-next
5215 If you issue one of the movement commands (like @kbd{n}) and there are
5216 no more unread articles after the current one, Gnus will offer to go to
5217 the next group. If this variable is @code{t} and the next group is
5218 empty, Gnus will exit summary mode and return to the group buffer. If
5219 this variable is neither @code{t} nor @code{nil}, Gnus will select the
5220 next group with unread articles. As a special case, if this variable
5221 is @code{quietly}, Gnus will select the next group without asking for
5222 confirmation. If this variable is @code{almost-quietly}, the same
5223 will happen only if you are located on the last article in the group.
5224 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
5225 command will go to the next group without confirmation. Also
5226 @pxref{Group Levels}.
5228 @item gnus-auto-select-same
5229 @vindex gnus-auto-select-same
5230 If non-@code{nil}, all the movement commands will try to go to the next
5231 article with the same subject as the current. (@dfn{Same} here might
5232 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
5233 for details (@pxref{Customizing Threading}).) If there are no more
5234 articles with the same subject, go to the first unread article.
5236 This variable is not particularly useful if you use a threaded display.
5238 @item gnus-summary-check-current
5239 @vindex gnus-summary-check-current
5240 If non-@code{nil}, all the ``unread'' movement commands will not proceed
5241 to the next (or previous) article if the current article is unread.
5242 Instead, they will choose the current article.
5244 @item gnus-auto-center-summary
5245 @vindex gnus-auto-center-summary
5246 If non-@code{nil}, Gnus will keep the point in the summary buffer
5247 centered at all times. This makes things quite tidy, but if you have a
5248 slow network connection, or simply do not like this un-Emacsism, you can
5249 set this variable to @code{nil} to get the normal Emacs scrolling
5250 action. This will also inhibit horizontal re-centering of the summary
5251 buffer, which might make it more inconvenient to read extremely long
5254 This variable can also be a number. In that case, center the window at
5255 the given number of lines from the top.
5260 @node Choosing Articles
5261 @section Choosing Articles
5262 @cindex selecting articles
5265 * Choosing Commands:: Commands for choosing articles.
5266 * Choosing Variables:: Variables that influence these commands.
5270 @node Choosing Commands
5271 @subsection Choosing Commands
5273 None of the following movement commands understand the numeric prefix,
5274 and they all select and display an article.
5276 If you want to fetch new articles or redisplay the group, see
5277 @ref{Exiting the Summary Buffer}.
5281 @kindex SPACE (Summary)
5282 @findex gnus-summary-next-page
5283 Select the current article, or, if that one's read already, the next
5284 unread article (@code{gnus-summary-next-page}).
5286 If you have an article window open already and you press @kbd{SPACE}
5287 again, the article will be scrolled. This lets you conveniently
5288 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5293 @kindex G n (Summary)
5294 @findex gnus-summary-next-unread-article
5295 @c @icon{gnus-summary-next-unread}
5296 Go to next unread article (@code{gnus-summary-next-unread-article}).
5301 @findex gnus-summary-prev-unread-article
5302 @c @icon{gnus-summary-prev-unread}
5303 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5308 @kindex G N (Summary)
5309 @findex gnus-summary-next-article
5310 Go to the next article (@code{gnus-summary-next-article}).
5315 @kindex G P (Summary)
5316 @findex gnus-summary-prev-article
5317 Go to the previous article (@code{gnus-summary-prev-article}).
5320 @kindex G C-n (Summary)
5321 @findex gnus-summary-next-same-subject
5322 Go to the next article with the same subject
5323 (@code{gnus-summary-next-same-subject}).
5326 @kindex G C-p (Summary)
5327 @findex gnus-summary-prev-same-subject
5328 Go to the previous article with the same subject
5329 (@code{gnus-summary-prev-same-subject}).
5333 @kindex G f (Summary)
5335 @findex gnus-summary-first-unread-article
5336 Go to the first unread article
5337 (@code{gnus-summary-first-unread-article}).
5341 @kindex G b (Summary)
5343 @findex gnus-summary-best-unread-article
5344 Go to the unread article with the highest score
5345 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5346 go to the first unread article that has a score over the default score.
5351 @kindex G l (Summary)
5352 @findex gnus-summary-goto-last-article
5353 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5356 @kindex G o (Summary)
5357 @findex gnus-summary-pop-article
5359 @cindex article history
5360 Pop an article off the summary history and go to this article
5361 (@code{gnus-summary-pop-article}). This command differs from the
5362 command above in that you can pop as many previous articles off the
5363 history as you like, while @kbd{l} toggles the two last read articles.
5364 For a somewhat related issue (if you use these commands a lot),
5365 @pxref{Article Backlog}.
5370 @kindex G j (Summary)
5371 @findex gnus-summary-goto-article
5372 Ask for an article number or @code{Message-ID}, and then go to that
5373 article (@code{gnus-summary-goto-article}).
5378 @node Choosing Variables
5379 @subsection Choosing Variables
5381 Some variables relevant for moving and selecting articles:
5384 @item gnus-auto-extend-newsgroup
5385 @vindex gnus-auto-extend-newsgroup
5386 All the movement commands will try to go to the previous (or next)
5387 article, even if that article isn't displayed in the Summary buffer if
5388 this variable is non-@code{nil}. Gnus will then fetch the article from
5389 the server and display it in the article buffer.
5391 @item gnus-select-article-hook
5392 @vindex gnus-select-article-hook
5393 This hook is called whenever an article is selected. The default is
5394 @code{nil}. If you would like each article to be saved in the Agent as
5395 you read it, putting @code{gnus-agent-fetch-selected-article} on this
5398 @item gnus-mark-article-hook
5399 @vindex gnus-mark-article-hook
5400 @findex gnus-summary-mark-unread-as-read
5401 @findex gnus-summary-mark-read-and-unread-as-read
5402 @findex gnus-unread-mark
5403 This hook is called whenever an article is selected. It is intended to
5404 be used for marking articles as read. The default value is
5405 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5406 mark of almost any article you read to @code{gnus-read-mark}. The only
5407 articles not affected by this function are ticked, dormant, and
5408 expirable articles. If you'd instead like to just have unread articles
5409 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5410 instead. It will leave marks like @code{gnus-low-score-mark},
5411 @code{gnus-del-mark} (and so on) alone.
5416 @node Paging the Article
5417 @section Scrolling the Article
5418 @cindex article scrolling
5423 @kindex SPACE (Summary)
5424 @findex gnus-summary-next-page
5425 Pressing @kbd{SPACE} will scroll the current article forward one page,
5426 or, if you have come to the end of the current article, will choose the
5427 next article (@code{gnus-summary-next-page}).
5429 @vindex gnus-article-boring-faces
5430 @vindex gnus-article-skip-boring
5431 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5432 the article consists only of citations and signature, then it will be
5433 skipped; the next article will be shown instead. You can customize
5434 what is considered uninteresting with
5435 @code{gnus-article-boring-faces}. You can manually view the article's
5436 pages, no matter how boring, using @kbd{C-M-v}.
5439 @kindex DEL (Summary)
5440 @findex gnus-summary-prev-page
5441 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5444 @kindex RET (Summary)
5445 @findex gnus-summary-scroll-up
5446 Scroll the current article one line forward
5447 (@code{gnus-summary-scroll-up}).
5450 @kindex M-RET (Summary)
5451 @findex gnus-summary-scroll-down
5452 Scroll the current article one line backward
5453 (@code{gnus-summary-scroll-down}).
5457 @kindex A g (Summary)
5459 @findex gnus-summary-show-article
5460 @vindex gnus-summary-show-article-charset-alist
5461 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5462 given a prefix, fetch the current article, but don't run any of the
5463 article treatment functions. This will give you a ``raw'' article, just
5464 the way it came from the server.
5466 If given a numerical prefix, you can do semi-manual charset stuff.
5467 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5468 encoded in the @code{cn-gb-2312} charset. If you have
5471 (setq gnus-summary-show-article-charset-alist
5476 then you can say @kbd{C-u 1 g} to get the same effect.
5481 @kindex A < (Summary)
5482 @findex gnus-summary-beginning-of-article
5483 Scroll to the beginning of the article
5484 (@code{gnus-summary-beginning-of-article}).
5489 @kindex A > (Summary)
5490 @findex gnus-summary-end-of-article
5491 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5495 @kindex A s (Summary)
5497 @findex gnus-summary-isearch-article
5498 Perform an isearch in the article buffer
5499 (@code{gnus-summary-isearch-article}).
5503 @findex gnus-summary-select-article-buffer
5504 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5509 @node Reply Followup and Post
5510 @section Reply, Followup and Post
5513 * Summary Mail Commands:: Sending mail.
5514 * Summary Post Commands:: Sending news.
5515 * Summary Message Commands:: Other Message-related commands.
5516 * Canceling and Superseding::
5520 @node Summary Mail Commands
5521 @subsection Summary Mail Commands
5523 @cindex composing mail
5525 Commands for composing a mail message:
5531 @kindex S r (Summary)
5533 @findex gnus-summary-reply
5534 @c @icon{gnus-summary-mail-reply}
5535 @c @icon{gnus-summary-reply}
5536 Mail a reply to the author of the current article
5537 (@code{gnus-summary-reply}).
5542 @kindex S R (Summary)
5543 @findex gnus-summary-reply-with-original
5544 @c @icon{gnus-summary-reply-with-original}
5545 Mail a reply to the author of the current article and include the
5546 original message (@code{gnus-summary-reply-with-original}). This
5547 command uses the process/prefix convention.
5550 @kindex S w (Summary)
5551 @findex gnus-summary-wide-reply
5552 Mail a wide reply to the author of the current article
5553 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5554 goes out to all people listed in the @code{To}, @code{From} (or
5555 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5556 present, that's used instead.
5559 @kindex S W (Summary)
5560 @findex gnus-summary-wide-reply-with-original
5561 Mail a wide reply to the current article and include the original
5562 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5563 the process/prefix convention.
5566 @kindex S v (Summary)
5567 @findex gnus-summary-very-wide-reply
5568 Mail a very wide reply to the author of the current article
5569 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5570 that goes out to all people listed in the @code{To}, @code{From} (or
5571 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5572 articles. This command uses the process/prefix convention.
5575 @kindex S V (Summary)
5576 @findex gnus-summary-very-wide-reply-with-original
5577 Mail a very wide reply to the author of the current article and include the
5578 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5579 command uses the process/prefix convention.
5582 @kindex S B r (Summary)
5583 @findex gnus-summary-reply-broken-reply-to
5584 Mail a reply to the author of the current article but ignore the
5585 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5586 If you need this because a mailing list incorrectly sets a
5587 @code{Reply-To} header pointing to the list, you probably want to set
5588 the @code{broken-reply-to} group parameter instead, so things will work
5589 correctly. @xref{Group Parameters}.
5592 @kindex S B R (Summary)
5593 @findex gnus-summary-reply-broken-reply-to-with-original
5594 Mail a reply to the author of the current article and include the
5595 original message but ignore the @code{Reply-To} field
5596 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5600 @kindex S o m (Summary)
5601 @kindex C-c C-f (Summary)
5602 @findex gnus-summary-mail-forward
5603 @c @icon{gnus-summary-mail-forward}
5604 Forward the current article to some other person
5605 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
5606 is forwarded according to the value of (@code{message-forward-as-mime})
5607 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
5608 message and forward directly inline; if the prefix is 2, forward message
5609 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5610 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5611 directly inline; otherwise, the message is forwarded as no prefix given
5612 but use the flipped value of (@code{message-forward-as-mime}). By
5613 default, the message is decoded and forwarded as an rfc822 @acronym{MIME}
5619 @kindex S m (Summary)
5620 @findex gnus-summary-mail-other-window
5621 @c @icon{gnus-summary-mail-originate}
5622 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5623 the posting style of the current group. If given a prefix, disable that.
5624 If the prefix is 1, prompt for a group name to find the posting style.
5629 @kindex S i (Summary)
5630 @findex gnus-summary-news-other-window
5631 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5632 post to the current group. If given a prefix, disable that. If the
5633 prefix is 1, prompt for a group to post to.
5635 This function actually prepares a news even when using mail groups.
5636 This is useful for ``posting'' messages to mail groups without actually
5637 sending them over the network: they're just saved directly to the group
5638 in question. The corresponding back end must have a request-post method
5639 for this to work though.
5642 @kindex S D b (Summary)
5643 @findex gnus-summary-resend-bounced-mail
5644 @cindex bouncing mail
5645 If you have sent a mail, but the mail was bounced back to you for some
5646 reason (wrong address, transient failure), you can use this command to
5647 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5648 will be popped into a mail buffer where you can edit the headers before
5649 sending the mail off again. If you give a prefix to this command, and
5650 the bounced mail is a reply to some other mail, Gnus will try to fetch
5651 that mail and display it for easy perusal of its headers. This might
5652 very well fail, though.
5655 @kindex S D r (Summary)
5656 @findex gnus-summary-resend-message
5657 Not to be confused with the previous command,
5658 @code{gnus-summary-resend-message} will prompt you for an address to
5659 send the current message off to, and then send it to that place. The
5660 headers of the message won't be altered---but lots of headers that say
5661 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5662 means that you actually send a mail to someone that has a @code{To}
5663 header that (probably) points to yourself. This will confuse people.
5664 So, natcherly you'll only do that if you're really eVIl.
5666 This command is mainly used if you have several accounts and want to
5667 ship a mail to a different account of yours. (If you're both
5668 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5669 to the @code{root} account, you may want to resend it to
5670 @code{postmaster}. Ordnung muss sein!
5672 This command understands the process/prefix convention
5673 (@pxref{Process/Prefix}).
5676 @kindex S D e (Summary)
5677 @findex gnus-summary-resend-message-edit
5679 Like the previous command, but will allow you to edit the message as
5680 if it were a new message before resending.
5683 @kindex S O m (Summary)
5684 @findex gnus-uu-digest-mail-forward
5685 Digest the current series (@pxref{Decoding Articles}) and forward the
5686 result using mail (@code{gnus-uu-digest-mail-forward}). This command
5687 uses the process/prefix convention (@pxref{Process/Prefix}).
5690 @kindex S M-c (Summary)
5691 @findex gnus-summary-mail-crosspost-complaint
5692 @cindex crossposting
5693 @cindex excessive crossposting
5694 Send a complaint about excessive crossposting to the author of the
5695 current article (@code{gnus-summary-mail-crosspost-complaint}).
5697 @findex gnus-crosspost-complaint
5698 This command is provided as a way to fight back against the current
5699 crossposting pandemic that's sweeping Usenet. It will compose a reply
5700 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5701 command understands the process/prefix convention
5702 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5706 Also @xref{Header Commands, ,Header Commands, message, The Message
5707 Manual}, for more information.
5710 @node Summary Post Commands
5711 @subsection Summary Post Commands
5713 @cindex composing news
5715 Commands for posting a news article:
5721 @kindex S p (Summary)
5722 @findex gnus-summary-post-news
5723 @c @icon{gnus-summary-post-news}
5724 Prepare for posting an article (@code{gnus-summary-post-news}). By
5725 default, post to the current group. If given a prefix, disable that.
5726 If the prefix is 1, prompt for another group instead.
5731 @kindex S f (Summary)
5732 @findex gnus-summary-followup
5733 @c @icon{gnus-summary-followup}
5734 Post a followup to the current article (@code{gnus-summary-followup}).
5738 @kindex S F (Summary)
5740 @c @icon{gnus-summary-followup-with-original}
5741 @findex gnus-summary-followup-with-original
5742 Post a followup to the current article and include the original message
5743 (@code{gnus-summary-followup-with-original}). This command uses the
5744 process/prefix convention.
5747 @kindex S n (Summary)
5748 @findex gnus-summary-followup-to-mail
5749 Post a followup to the current article via news, even if you got the
5750 message through mail (@code{gnus-summary-followup-to-mail}).
5753 @kindex S N (Summary)
5754 @findex gnus-summary-followup-to-mail-with-original
5755 Post a followup to the current article via news, even if you got the
5756 message through mail and include the original message
5757 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5758 the process/prefix convention.
5761 @kindex S o p (Summary)
5762 @findex gnus-summary-post-forward
5763 Forward the current article to a newsgroup
5764 (@code{gnus-summary-post-forward}).
5765 If no prefix is given, the message is forwarded according to the value
5766 of (@code{message-forward-as-mime}) and
5767 (@code{message-forward-show-mml}); if the prefix is 1, decode the
5768 message and forward directly inline; if the prefix is 2, forward message
5769 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5770 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5771 directly inline; otherwise, the message is forwarded as no prefix given
5772 but use the flipped value of (@code{message-forward-as-mime}). By
5773 default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section.
5776 @kindex S O p (Summary)
5777 @findex gnus-uu-digest-post-forward
5779 @cindex making digests
5780 Digest the current series and forward the result to a newsgroup
5781 (@code{gnus-uu-digest-post-forward}). This command uses the
5782 process/prefix convention.
5785 @kindex S u (Summary)
5786 @findex gnus-uu-post-news
5787 @c @icon{gnus-uu-post-news}
5788 Uuencode a file, split it into parts, and post it as a series
5789 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5792 Also @xref{Header Commands, ,Header Commands, message, The Message
5793 Manual}, for more information.
5796 @node Summary Message Commands
5797 @subsection Summary Message Commands
5801 @kindex S y (Summary)
5802 @findex gnus-summary-yank-message
5803 Yank the current article into an already existing Message composition
5804 buffer (@code{gnus-summary-yank-message}). This command prompts for
5805 what message buffer you want to yank into, and understands the
5806 process/prefix convention (@pxref{Process/Prefix}).
5811 @node Canceling and Superseding
5812 @subsection Canceling Articles
5813 @cindex canceling articles
5814 @cindex superseding articles
5816 Have you ever written something, and then decided that you really,
5817 really, really wish you hadn't posted that?
5819 Well, you can't cancel mail, but you can cancel posts.
5821 @findex gnus-summary-cancel-article
5823 @c @icon{gnus-summary-cancel-article}
5824 Find the article you wish to cancel (you can only cancel your own
5825 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5826 c} (@code{gnus-summary-cancel-article}). Your article will be
5827 canceled---machines all over the world will be deleting your article.
5828 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5830 Be aware, however, that not all sites honor cancels, so your article may
5831 live on here and there, while most sites will delete the article in
5834 Gnus will use the ``current'' select method when canceling. If you
5835 want to use the standard posting method, use the @samp{a} symbolic
5836 prefix (@pxref{Symbolic Prefixes}).
5838 Gnus ensures that only you can cancel your own messages using a
5839 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5840 message, Message Manual}).
5842 If you discover that you have made some mistakes and want to do some
5843 corrections, you can post a @dfn{superseding} article that will replace
5844 your original article.
5846 @findex gnus-summary-supersede-article
5848 Go to the original article and press @kbd{S s}
5849 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5850 where you can edit the article all you want before sending it off the
5853 The same goes for superseding as for canceling, only more so: Some
5854 sites do not honor superseding. On those sites, it will appear that you
5855 have posted almost the same article twice.
5857 If you have just posted the article, and change your mind right away,
5858 there is a trick you can use to cancel/supersede the article without
5859 waiting for the article to appear on your site first. You simply return
5860 to the post buffer (which is called @code{*sent ...*}). There you will
5861 find the article you just posted, with all the headers intact. Change
5862 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5863 header by substituting one of those words for the word
5864 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5865 you would do normally. The previous article will be
5866 canceled/superseded.
5868 Just remember, kids: There is no 'c' in 'supersede'.
5870 @node Delayed Articles
5871 @section Delayed Articles
5872 @cindex delayed sending
5873 @cindex send delayed
5875 Sometimes, you might wish to delay the sending of a message. For
5876 example, you might wish to arrange for a message to turn up just in time
5877 to remind your about the birthday of your Significant Other. For this,
5878 there is the @code{gnus-delay} package. Setup is simple:
5881 (gnus-delay-initialize)
5884 @findex gnus-delay-article
5885 Normally, to send a message you use the @kbd{C-c C-c} command from
5886 Message mode. To delay a message, use @kbd{C-c C-j}
5887 (@code{gnus-delay-article}) instead. This will ask you for how long the
5888 message should be delayed. Possible answers are:
5892 A time span. Consists of an integer and a letter. For example,
5893 @code{42d} means to delay for 42 days. Available letters are @code{m}
5894 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5895 (months) and @code{Y} (years).
5898 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5899 delayed until that day, at a specific time (eight o'clock by default).
5900 See also @code{gnus-delay-default-hour}.
5903 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5904 stuff. The deadline will be at that time today, except if that time has
5905 already passed, then it's at the given time tomorrow. So if it's ten
5906 o'clock in the morning and you specify @code{11:15}, then the deadline
5907 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5908 that means a time tomorrow.
5911 The action of the @code{gnus-delay-article} command is influenced by a
5912 couple of variables:
5915 @item gnus-delay-default-hour
5916 @vindex gnus-delay-default-hour
5917 When you specify a specific date, the message will be due on that hour
5918 on the given date. Possible values are integers 0 through 23.
5920 @item gnus-delay-default-delay
5921 @vindex gnus-delay-default-delay
5922 This is a string and gives the default delay. It can be of any of the
5923 formats described above.
5925 @item gnus-delay-group
5926 @vindex gnus-delay-group
5927 Delayed articles will be kept in this group on the drafts server until
5928 they are due. You probably don't need to change this. The default
5929 value is @code{"delayed"}.
5931 @item gnus-delay-header
5932 @vindex gnus-delay-header
5933 The deadline for each article will be stored in a header. This variable
5934 is a string and gives the header name. You probably don't need to
5935 change this. The default value is @code{"X-Gnus-Delayed"}.
5938 The way delaying works is like this: when you use the
5939 @code{gnus-delay-article} command, you give a certain delay. Gnus
5940 calculates the deadline of the message and stores it in the
5941 @code{X-Gnus-Delayed} header and puts the message in the
5942 @code{nndraft:delayed} group.
5944 @findex gnus-delay-send-queue
5945 And whenever you get new news, Gnus looks through the group for articles
5946 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5947 function for this. By default, this function is added to the hook
5948 @code{gnus-get-new-news-hook}. But of course, you can change this.
5949 Maybe you want to use the demon to send drafts? Just tell the demon to
5950 execute the @code{gnus-delay-send-queue} function.
5953 @item gnus-delay-initialize
5954 @findex gnus-delay-initialize
5955 By default, this function installs @code{gnus-delay-send-queue} in
5956 @code{gnus-get-new-news-hook}. But it accepts the optional second
5957 argument @code{no-check}. If it is non-@code{nil},
5958 @code{gnus-get-new-news-hook} is not changed. The optional first
5959 argument is ignored.
5961 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5962 Presumably, you want to use the demon for sending due delayed articles.
5963 Just don't forget to set that up :-)
5967 @node Marking Articles
5968 @section Marking Articles
5969 @cindex article marking
5970 @cindex article ticking
5973 There are several marks you can set on an article.
5975 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5976 neologism ohoy!) of the article. Alphabetic marks generally mean
5977 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5979 In addition, you also have marks that do not affect readedness.
5982 There's a plethora of commands for manipulating these marks.
5986 * Unread Articles:: Marks for unread articles.
5987 * Read Articles:: Marks for read articles.
5988 * Other Marks:: Marks that do not affect readedness.
5989 * Setting Marks:: How to set and remove marks.
5990 * Generic Marking Commands:: How to customize the marking.
5991 * Setting Process Marks:: How to mark articles for later processing.
5995 @node Unread Articles
5996 @subsection Unread Articles
5998 The following marks mark articles as (kinda) unread, in one form or
6003 @vindex gnus-ticked-mark
6004 Marked as ticked (@code{gnus-ticked-mark}).
6006 @dfn{Ticked articles} are articles that will remain visible always. If
6007 you see an article that you find interesting, or you want to put off
6008 reading it, or replying to it, until sometime later, you'd typically
6009 tick it. However, articles can be expired (from news servers by the
6010 news server software, Gnus itself never expires ticked messages), so if
6011 you want to keep an article forever, you'll have to make it persistent
6012 (@pxref{Persistent Articles}).
6015 @vindex gnus-dormant-mark
6016 Marked as dormant (@code{gnus-dormant-mark}).
6018 @dfn{Dormant articles} will only appear in the summary buffer if there
6019 are followups to it. If you want to see them even if they don't have
6020 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
6021 Otherwise (except for the visibility issue), they are just like ticked
6025 @vindex gnus-unread-mark
6026 Marked as unread (@code{gnus-unread-mark}).
6028 @dfn{Unread articles} are articles that haven't been read at all yet.
6033 @subsection Read Articles
6034 @cindex expirable mark
6036 All the following marks mark articles as read.
6041 @vindex gnus-del-mark
6042 These are articles that the user has marked as read with the @kbd{d}
6043 command manually, more or less (@code{gnus-del-mark}).
6046 @vindex gnus-read-mark
6047 Articles that have actually been read (@code{gnus-read-mark}).
6050 @vindex gnus-ancient-mark
6051 Articles that were marked as read in previous sessions and are now
6052 @dfn{old} (@code{gnus-ancient-mark}).
6055 @vindex gnus-killed-mark
6056 Marked as killed (@code{gnus-killed-mark}).
6059 @vindex gnus-kill-file-mark
6060 Marked as killed by kill files (@code{gnus-kill-file-mark}).
6063 @vindex gnus-low-score-mark
6064 Marked as read by having too low a score (@code{gnus-low-score-mark}).
6067 @vindex gnus-catchup-mark
6068 Marked as read by a catchup (@code{gnus-catchup-mark}).
6071 @vindex gnus-canceled-mark
6072 Canceled article (@code{gnus-canceled-mark})
6075 @vindex gnus-souped-mark
6076 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
6079 @vindex gnus-sparse-mark
6080 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
6084 @vindex gnus-duplicate-mark
6085 Article marked as read by duplicate suppression
6086 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
6090 All these marks just mean that the article is marked as read, really.
6091 They are interpreted differently when doing adaptive scoring, though.
6093 One more special mark, though:
6097 @vindex gnus-expirable-mark
6098 Marked as expirable (@code{gnus-expirable-mark}).
6100 Marking articles as @dfn{expirable} (or have them marked as such
6101 automatically) doesn't make much sense in normal groups---a user doesn't
6102 control expiring of news articles, but in mail groups, for instance,
6103 articles marked as @dfn{expirable} can be deleted by Gnus at
6109 @subsection Other Marks
6110 @cindex process mark
6113 There are some marks that have nothing to do with whether the article is
6119 You can set a bookmark in the current article. Say you are reading a
6120 long thesis on cats' urinary tracts, and have to go home for dinner
6121 before you've finished reading the thesis. You can then set a bookmark
6122 in the article, and Gnus will jump to this bookmark the next time it
6123 encounters the article. @xref{Setting Marks}.
6126 @vindex gnus-replied-mark
6127 All articles that you have replied to or made a followup to (i.e., have
6128 answered) will be marked with an @samp{A} in the second column
6129 (@code{gnus-replied-mark}).
6132 @vindex gnus-forwarded-mark
6133 All articles that you have forwarded will be marked with an @samp{F} in
6134 the second column (@code{gnus-forwarded-mark}).
6137 @vindex gnus-cached-mark
6138 Articles stored in the article cache will be marked with an @samp{*} in
6139 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
6142 @vindex gnus-saved-mark
6143 Articles ``saved'' (in some manner or other; not necessarily
6144 religiously) are marked with an @samp{S} in the second column
6145 (@code{gnus-saved-mark}).
6148 @vindex gnus-recent-mark
6149 Articles that according to the server haven't been shown to the user
6150 before are marked with a @samp{N} in the second column
6151 (@code{gnus-recent-mark}). Note that not all servers support this
6152 mark, in which case it simply never appears. Compare with
6153 @code{gnus-unseen-mark}.
6156 @vindex gnus-unseen-mark
6157 Articles that haven't been seen before in Gnus by the user are marked
6158 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
6159 Compare with @code{gnus-recent-mark}.
6162 @vindex gnus-downloaded-mark
6163 When using the Gnus agent (@pxref{Agent Basics}), articles may be
6164 downloaded for unplugged (offline) viewing. If you are using the
6165 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
6166 (The variable @code{gnus-downloaded-mark} controls which character to
6170 @vindex gnus-undownloaded-mark
6171 When using the Gnus agent (@pxref{Agent Basics}), some articles might
6172 not have been downloaded. Such articles cannot be viewed while you
6173 are unplugged (offline). If you are using the @samp{%O} spec, these
6174 articles get the @samp{-} mark in that spec. (The variable
6175 @code{gnus-undownloaded-mark} controls which character to use.)
6178 @vindex gnus-downloadable-mark
6179 The Gnus agent (@pxref{Agent Basics}) downloads some articles
6180 automatically, but it is also possible to explicitly mark articles for
6181 download, even if they would not be downloaded automatically. Such
6182 explicitly-marked articles get the @samp{%} mark in the first column.
6183 (The variable @code{gnus-downloadable-mark} controls which character to
6187 @vindex gnus-not-empty-thread-mark
6188 @vindex gnus-empty-thread-mark
6189 If the @samp{%e} spec is used, the presence of threads or not will be
6190 marked with @code{gnus-not-empty-thread-mark} and
6191 @code{gnus-empty-thread-mark} in the third column, respectively.
6194 @vindex gnus-process-mark
6195 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
6196 variety of commands react to the presence of the process mark. For
6197 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
6198 all articles that have been marked with the process mark. Articles
6199 marked with the process mark have a @samp{#} in the second column.
6203 You might have noticed that most of these ``non-readedness'' marks
6204 appear in the second column by default. So if you have a cached, saved,
6205 replied article that you have process-marked, what will that look like?
6207 Nothing much. The precedence rules go as follows: process -> cache ->
6208 replied -> saved. So if the article is in the cache and is replied,
6209 you'll only see the cache mark and not the replied mark.
6213 @subsection Setting Marks
6214 @cindex setting marks
6216 All the marking commands understand the numeric prefix.
6221 @kindex M c (Summary)
6222 @kindex M-u (Summary)
6223 @findex gnus-summary-clear-mark-forward
6224 @cindex mark as unread
6225 Clear all readedness-marks from the current article
6226 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
6232 @kindex M t (Summary)
6233 @findex gnus-summary-tick-article-forward
6234 Tick the current article (@code{gnus-summary-tick-article-forward}).
6235 @xref{Article Caching}.
6240 @kindex M ? (Summary)
6241 @findex gnus-summary-mark-as-dormant
6242 Mark the current article as dormant
6243 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
6247 @kindex M d (Summary)
6249 @findex gnus-summary-mark-as-read-forward
6250 Mark the current article as read
6251 (@code{gnus-summary-mark-as-read-forward}).
6255 @findex gnus-summary-mark-as-read-backward
6256 Mark the current article as read and move point to the previous line
6257 (@code{gnus-summary-mark-as-read-backward}).
6262 @kindex M k (Summary)
6263 @findex gnus-summary-kill-same-subject-and-select
6264 Mark all articles that have the same subject as the current one as read,
6265 and then select the next unread article
6266 (@code{gnus-summary-kill-same-subject-and-select}).
6270 @kindex M K (Summary)
6271 @kindex C-k (Summary)
6272 @findex gnus-summary-kill-same-subject
6273 Mark all articles that have the same subject as the current one as read
6274 (@code{gnus-summary-kill-same-subject}).
6277 @kindex M C (Summary)
6278 @findex gnus-summary-catchup
6279 @c @icon{gnus-summary-catchup}
6280 Mark all unread articles as read (@code{gnus-summary-catchup}).
6283 @kindex M C-c (Summary)
6284 @findex gnus-summary-catchup-all
6285 Mark all articles in the group as read---even the ticked and dormant
6286 articles (@code{gnus-summary-catchup-all}).
6289 @kindex M H (Summary)
6290 @findex gnus-summary-catchup-to-here
6291 Catchup the current group to point (before the point)
6292 (@code{gnus-summary-catchup-to-here}).
6295 @kindex M h (Summary)
6296 @findex gnus-summary-catchup-from-here
6297 Catchup the current group from point (after the point)
6298 (@code{gnus-summary-catchup-from-here}).
6301 @kindex C-w (Summary)
6302 @findex gnus-summary-mark-region-as-read
6303 Mark all articles between point and mark as read
6304 (@code{gnus-summary-mark-region-as-read}).
6307 @kindex M V k (Summary)
6308 @findex gnus-summary-kill-below
6309 Kill all articles with scores below the default score (or below the
6310 numeric prefix) (@code{gnus-summary-kill-below}).
6314 @kindex M e (Summary)
6316 @findex gnus-summary-mark-as-expirable
6317 Mark the current article as expirable
6318 (@code{gnus-summary-mark-as-expirable}).
6321 @kindex M b (Summary)
6322 @findex gnus-summary-set-bookmark
6323 Set a bookmark in the current article
6324 (@code{gnus-summary-set-bookmark}).
6327 @kindex M B (Summary)
6328 @findex gnus-summary-remove-bookmark
6329 Remove the bookmark from the current article
6330 (@code{gnus-summary-remove-bookmark}).
6333 @kindex M V c (Summary)
6334 @findex gnus-summary-clear-above
6335 Clear all marks from articles with scores over the default score (or
6336 over the numeric prefix) (@code{gnus-summary-clear-above}).
6339 @kindex M V u (Summary)
6340 @findex gnus-summary-tick-above
6341 Tick all articles with scores over the default score (or over the
6342 numeric prefix) (@code{gnus-summary-tick-above}).
6345 @kindex M V m (Summary)
6346 @findex gnus-summary-mark-above
6347 Prompt for a mark, and mark all articles with scores over the default
6348 score (or over the numeric prefix) with this mark
6349 (@code{gnus-summary-clear-above}).
6352 @vindex gnus-summary-goto-unread
6353 The @code{gnus-summary-goto-unread} variable controls what action should
6354 be taken after setting a mark. If non-@code{nil}, point will move to
6355 the next/previous unread article. If @code{nil}, point will just move
6356 one line up or down. As a special case, if this variable is
6357 @code{never}, all the marking commands as well as other commands (like
6358 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6359 The default is @code{t}.
6362 @node Generic Marking Commands
6363 @subsection Generic Marking Commands
6365 Some people would like the command that ticks an article (@kbd{!}) go to
6366 the next article. Others would like it to go to the next unread
6367 article. Yet others would like it to stay on the current article. And
6368 even though I haven't heard of anybody wanting it to go to the
6369 previous (unread) article, I'm sure there are people that want that as
6372 Multiply these five behaviors with five different marking commands, and
6373 you get a potentially complex set of variable to control what each
6376 To sidestep that mess, Gnus provides commands that do all these
6377 different things. They can be found on the @kbd{M M} map in the summary
6378 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6379 to list in this manual.
6381 While you can use these commands directly, most users would prefer
6382 altering the summary mode keymap. For instance, if you would like the
6383 @kbd{!} command to go to the next article instead of the next unread
6384 article, you could say something like:
6388 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6389 (defun my-alter-summary-map ()
6390 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6398 (defun my-alter-summary-map ()
6399 (local-set-key "!" "MM!n"))
6403 @node Setting Process Marks
6404 @subsection Setting Process Marks
6405 @cindex setting process marks
6407 Process marks are displayed as @code{#} in the summary buffer, and are
6408 used for marking articles in such a way that other commands will
6409 process these articles. For instance, if you process mark four
6410 articles and then use the @kbd{*} command, Gnus will enter these four
6411 articles into the cache. For more information,
6412 @pxref{Process/Prefix}.
6419 @kindex M P p (Summary)
6420 @findex gnus-summary-mark-as-processable
6421 Mark the current article with the process mark
6422 (@code{gnus-summary-mark-as-processable}).
6423 @findex gnus-summary-unmark-as-processable
6427 @kindex M P u (Summary)
6428 @kindex M-# (Summary)
6429 Remove the process mark, if any, from the current article
6430 (@code{gnus-summary-unmark-as-processable}).
6433 @kindex M P U (Summary)
6434 @findex gnus-summary-unmark-all-processable
6435 Remove the process mark from all articles
6436 (@code{gnus-summary-unmark-all-processable}).
6439 @kindex M P i (Summary)
6440 @findex gnus-uu-invert-processable
6441 Invert the list of process marked articles
6442 (@code{gnus-uu-invert-processable}).
6445 @kindex M P R (Summary)
6446 @findex gnus-uu-mark-by-regexp
6447 Mark articles that have a @code{Subject} header that matches a regular
6448 expression (@code{gnus-uu-mark-by-regexp}).
6451 @kindex M P G (Summary)
6452 @findex gnus-uu-unmark-by-regexp
6453 Unmark articles that have a @code{Subject} header that matches a regular
6454 expression (@code{gnus-uu-unmark-by-regexp}).
6457 @kindex M P r (Summary)
6458 @findex gnus-uu-mark-region
6459 Mark articles in region (@code{gnus-uu-mark-region}).
6462 @kindex M P g (Summary)
6463 @findex gnus-uu-unmark-region
6464 Unmark articles in region (@code{gnus-uu-unmark-region}).
6467 @kindex M P t (Summary)
6468 @findex gnus-uu-mark-thread
6469 Mark all articles in the current (sub)thread
6470 (@code{gnus-uu-mark-thread}).
6473 @kindex M P T (Summary)
6474 @findex gnus-uu-unmark-thread
6475 Unmark all articles in the current (sub)thread
6476 (@code{gnus-uu-unmark-thread}).
6479 @kindex M P v (Summary)
6480 @findex gnus-uu-mark-over
6481 Mark all articles that have a score above the prefix argument
6482 (@code{gnus-uu-mark-over}).
6485 @kindex M P s (Summary)
6486 @findex gnus-uu-mark-series
6487 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6490 @kindex M P S (Summary)
6491 @findex gnus-uu-mark-sparse
6492 Mark all series that have already had some articles marked
6493 (@code{gnus-uu-mark-sparse}).
6496 @kindex M P a (Summary)
6497 @findex gnus-uu-mark-all
6498 Mark all articles in series order (@code{gnus-uu-mark-all}).
6501 @kindex M P b (Summary)
6502 @findex gnus-uu-mark-buffer
6503 Mark all articles in the buffer in the order they appear
6504 (@code{gnus-uu-mark-buffer}).
6507 @kindex M P k (Summary)
6508 @findex gnus-summary-kill-process-mark
6509 Push the current process mark set onto the stack and unmark all articles
6510 (@code{gnus-summary-kill-process-mark}).
6513 @kindex M P y (Summary)
6514 @findex gnus-summary-yank-process-mark
6515 Pop the previous process mark set from the stack and restore it
6516 (@code{gnus-summary-yank-process-mark}).
6519 @kindex M P w (Summary)
6520 @findex gnus-summary-save-process-mark
6521 Push the current process mark set onto the stack
6522 (@code{gnus-summary-save-process-mark}).
6526 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6527 set process marks based on article body contents.
6534 It can be convenient to limit the summary buffer to just show some
6535 subset of the articles currently in the group. The effect most limit
6536 commands have is to remove a few (or many) articles from the summary
6539 All limiting commands work on subsets of the articles already fetched
6540 from the servers. None of these commands query the server for
6541 additional articles.
6547 @kindex / / (Summary)
6548 @findex gnus-summary-limit-to-subject
6549 Limit the summary buffer to articles that match some subject
6550 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6554 @kindex / a (Summary)
6555 @findex gnus-summary-limit-to-author
6556 Limit the summary buffer to articles that match some author
6557 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6561 @kindex / R (Summary)
6562 @findex gnus-summary-limit-to-recipient
6563 Limit the summary buffer to articles that match some recipient
6564 (@code{gnus-summary-limit-to-recipient}). If given a prefix, exclude
6568 @kindex / A (Summary)
6569 @findex gnus-summary-limit-to-address
6570 Limit the summary buffer to articles in which contents of From, To or Cc
6571 header match a given address (@code{gnus-summary-limit-to-address}). If
6572 given a prefix, exclude matching articles.
6575 @kindex / S (Summary)
6576 @findex gnus-summary-limit-to-singletons
6577 Limit the summary buffer to articles that aren't part of any displayed
6578 threads (@code{gnus-summary-limit-to-singletons}). If given a prefix,
6579 limit to articles that are part of displayed threads.
6582 @kindex / x (Summary)
6583 @findex gnus-summary-limit-to-extra
6584 Limit the summary buffer to articles that match one of the ``extra''
6585 headers (@pxref{To From Newsgroups})
6586 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6591 @kindex / u (Summary)
6593 @findex gnus-summary-limit-to-unread
6594 Limit the summary buffer to articles not marked as read
6595 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6596 buffer to articles strictly unread. This means that ticked and
6597 dormant articles will also be excluded.
6600 @kindex / m (Summary)
6601 @findex gnus-summary-limit-to-marks
6602 Ask for a mark and then limit to all articles that have been marked
6603 with that mark (@code{gnus-summary-limit-to-marks}).
6606 @kindex / t (Summary)
6607 @findex gnus-summary-limit-to-age
6608 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6609 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6610 articles younger than that number of days.
6613 @kindex / n (Summary)
6614 @findex gnus-summary-limit-to-articles
6615 With prefix @samp{n}, limit the summary buffer to the next @samp{n}
6616 articles. If not given a prefix, use the process marked articles
6617 instead. (@code{gnus-summary-limit-to-articles}).
6620 @kindex / w (Summary)
6621 @findex gnus-summary-pop-limit
6622 Pop the previous limit off the stack and restore it
6623 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6627 @kindex / . (Summary)
6628 @findex gnus-summary-limit-to-unseen
6629 Limit the summary buffer to the unseen articles
6630 (@code{gnus-summary-limit-to-unseen}).
6633 @kindex / v (Summary)
6634 @findex gnus-summary-limit-to-score
6635 Limit the summary buffer to articles that have a score at or above some
6636 score (@code{gnus-summary-limit-to-score}).
6639 @kindex / p (Summary)
6640 @findex gnus-summary-limit-to-display-predicate
6641 Limit the summary buffer to articles that satisfy the @code{display}
6642 group parameter predicate
6643 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6644 Parameters}, for more on this predicate.
6647 @kindex / r (Summary)
6648 @findex gnus-summary-limit-to-replied
6649 Limit the summary buffer to replied articles
6650 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6655 @kindex M S (Summary)
6656 @kindex / E (Summary)
6657 @findex gnus-summary-limit-include-expunged
6658 Include all expunged articles in the limit
6659 (@code{gnus-summary-limit-include-expunged}).
6662 @kindex / D (Summary)
6663 @findex gnus-summary-limit-include-dormant
6664 Include all dormant articles in the limit
6665 (@code{gnus-summary-limit-include-dormant}).
6668 @kindex / * (Summary)
6669 @findex gnus-summary-limit-include-cached
6670 Include all cached articles in the limit
6671 (@code{gnus-summary-limit-include-cached}).
6674 @kindex / d (Summary)
6675 @findex gnus-summary-limit-exclude-dormant
6676 Exclude all dormant articles from the limit
6677 (@code{gnus-summary-limit-exclude-dormant}).
6680 @kindex / M (Summary)
6681 @findex gnus-summary-limit-exclude-marks
6682 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6685 @kindex / T (Summary)
6686 @findex gnus-summary-limit-include-thread
6687 Include all the articles in the current thread in the limit.
6690 @kindex / c (Summary)
6691 @findex gnus-summary-limit-exclude-childless-dormant
6692 Exclude all dormant articles that have no children from the limit@*
6693 (@code{gnus-summary-limit-exclude-childless-dormant}).
6696 @kindex / C (Summary)
6697 @findex gnus-summary-limit-mark-excluded-as-read
6698 Mark all excluded unread articles as read
6699 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6700 also mark excluded ticked and dormant articles as read.
6703 @kindex / N (Summary)
6704 @findex gnus-summary-insert-new-articles
6705 Insert all new articles in the summary buffer. It scans for new emails
6706 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6709 @kindex / o (Summary)
6710 @findex gnus-summary-insert-old-articles
6711 Insert all old articles in the summary buffer. If given a numbered
6712 prefix, fetch this number of articles.
6715 @kindex / b (Summary)
6716 @findex gnus-summary-limit-to-bodies
6717 Limit the summary buffer to articles that have bodies that match a
6718 certain regexp (@code{gnus-summary-limit-to-bodies}). If given a
6719 prefix, reverse the limit. This command is quite slow since it
6720 requires selecting each article to find the matches.
6723 @kindex / h (Summary)
6724 @findex gnus-summary-limit-to-headers
6725 Like the previous command, only limit to headers instead
6726 (@code{gnus-summary-limit-to-headers}).
6734 @cindex article threading
6736 Gnus threads articles by default. @dfn{To thread} is to put responses
6737 to articles directly after the articles they respond to---in a
6738 hierarchical fashion.
6740 Threading is done by looking at the @code{References} headers of the
6741 articles. In a perfect world, this would be enough to build pretty
6742 trees, but unfortunately, the @code{References} header is often broken
6743 or simply missing. Weird news propagation exacerbates the problem,
6744 so one has to employ other heuristics to get pleasing results. A
6745 plethora of approaches exists, as detailed in horrible detail in
6746 @ref{Customizing Threading}.
6748 First, a quick overview of the concepts:
6752 The top-most article in a thread; the first article in the thread.
6755 A tree-like article structure.
6758 A small(er) section of this tree-like structure.
6761 Threads often lose their roots due to article expiry, or due to the root
6762 already having been read in a previous session, and not displayed in the
6763 summary buffer. We then typically have many sub-threads that really
6764 belong to one thread, but are without connecting roots. These are
6765 called loose threads.
6767 @item thread gathering
6768 An attempt to gather loose threads into bigger threads.
6770 @item sparse threads
6771 A thread where the missing articles have been ``guessed'' at, and are
6772 displayed as empty lines in the summary buffer.
6778 * Customizing Threading:: Variables you can change to affect the threading.
6779 * Thread Commands:: Thread based commands in the summary buffer.
6783 @node Customizing Threading
6784 @subsection Customizing Threading
6785 @cindex customizing threading
6788 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6789 * Filling In Threads:: Making the threads displayed look fuller.
6790 * More Threading:: Even more variables for fiddling with threads.
6791 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6796 @subsubsection Loose Threads
6799 @cindex loose threads
6802 @item gnus-summary-make-false-root
6803 @vindex gnus-summary-make-false-root
6804 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
6805 and create a dummy root at the top. (Wait a minute. Root at the top?
6806 Yup.) Loose subtrees occur when the real root has expired, or you've
6807 read or killed the root in a previous session.
6809 When there is no real root of a thread, Gnus will have to fudge
6810 something. This variable says what fudging method Gnus should use.
6811 There are four possible values:
6815 \gnusfigure{The Summary Buffer}{390}{
6816 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6817 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6818 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6819 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6824 @cindex adopting articles
6829 Gnus will make the first of the orphaned articles the parent. This
6830 parent will adopt all the other articles. The adopted articles will be
6831 marked as such by pointy brackets (@samp{<>}) instead of the standard
6832 square brackets (@samp{[]}). This is the default method.
6835 @vindex gnus-summary-dummy-line-format
6836 @vindex gnus-summary-make-false-root-always
6837 Gnus will create a dummy summary line that will pretend to be the
6838 parent. This dummy line does not correspond to any real article, so
6839 selecting it will just select the first real article after the dummy
6840 article. @code{gnus-summary-dummy-line-format} is used to specify the
6841 format of the dummy roots. It accepts only one format spec: @samp{S},
6842 which is the subject of the article. @xref{Formatting Variables}.
6843 If you want all threads to have a dummy root, even the non-gathered
6844 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6847 Gnus won't actually make any article the parent, but simply leave the
6848 subject field of all orphans except the first empty. (Actually, it will
6849 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6853 Don't make any article parent at all. Just gather the threads and
6854 display them after one another.
6857 Don't gather loose threads.
6860 @item gnus-summary-gather-subject-limit
6861 @vindex gnus-summary-gather-subject-limit
6862 Loose threads are gathered by comparing subjects of articles. If this
6863 variable is @code{nil}, Gnus requires an exact match between the
6864 subjects of the loose threads before gathering them into one big
6865 super-thread. This might be too strict a requirement, what with the
6866 presence of stupid newsreaders that chop off long subject lines. If
6867 you think so, set this variable to, say, 20 to require that only the
6868 first 20 characters of the subjects have to match. If you set this
6869 variable to a really low number, you'll find that Gnus will gather
6870 everything in sight into one thread, which isn't very helpful.
6872 @cindex fuzzy article gathering
6873 If you set this variable to the special value @code{fuzzy}, Gnus will
6874 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6877 @item gnus-simplify-subject-fuzzy-regexp
6878 @vindex gnus-simplify-subject-fuzzy-regexp
6879 This can either be a regular expression or list of regular expressions
6880 that match strings that will be removed from subjects if fuzzy subject
6881 simplification is used.
6883 @item gnus-simplify-ignored-prefixes
6884 @vindex gnus-simplify-ignored-prefixes
6885 If you set @code{gnus-summary-gather-subject-limit} to something as low
6886 as 10, you might consider setting this variable to something sensible:
6888 @c Written by Michael Ernst <mernst@cs.rice.edu>
6890 (setq gnus-simplify-ignored-prefixes
6896 "wanted" "followup" "summary\\( of\\)?"
6897 "help" "query" "problem" "question"
6898 "answer" "reference" "announce"
6899 "How can I" "How to" "Comparison of"
6904 (mapconcat 'identity
6905 '("for" "for reference" "with" "about")
6907 "\\)?\\]?:?[ \t]*"))
6910 All words that match this regexp will be removed before comparing two
6913 @item gnus-simplify-subject-functions
6914 @vindex gnus-simplify-subject-functions
6915 If non-@code{nil}, this variable overrides
6916 @code{gnus-summary-gather-subject-limit}. This variable should be a
6917 list of functions to apply to the @code{Subject} string iteratively to
6918 arrive at the simplified version of the string.
6920 Useful functions to put in this list include:
6923 @item gnus-simplify-subject-re
6924 @findex gnus-simplify-subject-re
6925 Strip the leading @samp{Re:}.
6927 @item gnus-simplify-subject-fuzzy
6928 @findex gnus-simplify-subject-fuzzy
6931 @item gnus-simplify-whitespace
6932 @findex gnus-simplify-whitespace
6933 Remove excessive whitespace.
6935 @item gnus-simplify-all-whitespace
6936 @findex gnus-simplify-all-whitespace
6937 Remove all whitespace.
6940 You may also write your own functions, of course.
6943 @item gnus-summary-gather-exclude-subject
6944 @vindex gnus-summary-gather-exclude-subject
6945 Since loose thread gathering is done on subjects only, that might lead
6946 to many false hits, especially with certain common subjects like
6947 @samp{} and @samp{(none)}. To make the situation slightly better,
6948 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6949 what subjects should be excluded from the gathering process.@*
6950 The default is @samp{^ *$\\|^(none)$}.
6952 @item gnus-summary-thread-gathering-function
6953 @vindex gnus-summary-thread-gathering-function
6954 Gnus gathers threads by looking at @code{Subject} headers. This means
6955 that totally unrelated articles may end up in the same ``thread'', which
6956 is confusing. An alternate approach is to look at all the
6957 @code{Message-ID}s in all the @code{References} headers to find matches.
6958 This will ensure that no gathered threads ever include unrelated
6959 articles, but it also means that people who have posted with broken
6960 newsreaders won't be gathered properly. The choice is yours---plague or
6964 @item gnus-gather-threads-by-subject
6965 @findex gnus-gather-threads-by-subject
6966 This function is the default gathering function and looks at
6967 @code{Subject}s exclusively.
6969 @item gnus-gather-threads-by-references
6970 @findex gnus-gather-threads-by-references
6971 This function looks at @code{References} headers exclusively.
6974 If you want to test gathering by @code{References}, you could say
6978 (setq gnus-summary-thread-gathering-function
6979 'gnus-gather-threads-by-references)
6985 @node Filling In Threads
6986 @subsubsection Filling In Threads
6989 @item gnus-fetch-old-headers
6990 @vindex gnus-fetch-old-headers
6991 If non-@code{nil}, Gnus will attempt to build old threads by fetching
6992 more old headers---headers to articles marked as read. If you would
6993 like to display as few summary lines as possible, but still connect as
6994 many loose threads as possible, you should set this variable to
6995 @code{some} or a number. If you set it to a number, no more than that
6996 number of extra old headers will be fetched. In either case, fetching
6997 old headers only works if the back end you are using carries overview
6998 files---this would normally be @code{nntp}, @code{nnspool},
6999 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
7000 the thread has been expired by the server, there's not much Gnus can
7003 This variable can also be set to @code{invisible}. This won't have any
7004 visible effects, but is useful if you use the @kbd{A T} command a lot
7005 (@pxref{Finding the Parent}).
7007 @item gnus-fetch-old-ephemeral-headers
7008 @vindex gnus-fetch-old-ephemeral-headers
7009 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
7012 @item gnus-build-sparse-threads
7013 @vindex gnus-build-sparse-threads
7014 Fetching old headers can be slow. A low-rent similar effect can be
7015 gotten by setting this variable to @code{some}. Gnus will then look at
7016 the complete @code{References} headers of all articles and try to string
7017 together articles that belong in the same thread. This will leave
7018 @dfn{gaps} in the threading display where Gnus guesses that an article
7019 is missing from the thread. (These gaps appear like normal summary
7020 lines. If you select a gap, Gnus will try to fetch the article in
7021 question.) If this variable is @code{t}, Gnus will display all these
7022 ``gaps'' without regard for whether they are useful for completing the
7023 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
7024 off sparse leaf nodes that don't lead anywhere. This variable is
7025 @code{nil} by default.
7027 @item gnus-read-all-available-headers
7028 @vindex gnus-read-all-available-headers
7029 This is a rather obscure variable that few will find useful. It's
7030 intended for those non-news newsgroups where the back end has to fetch
7031 quite a lot to present the summary buffer, and where it's impossible to
7032 go back to parents of articles. This is mostly the case in the
7033 web-based groups, like the @code{nnultimate} groups.
7035 If you don't use those, then it's safe to leave this as the default
7036 @code{nil}. If you want to use this variable, it should be a regexp
7037 that matches the group name, or @code{t} for all groups.
7042 @node More Threading
7043 @subsubsection More Threading
7046 @item gnus-show-threads
7047 @vindex gnus-show-threads
7048 If this variable is @code{nil}, no threading will be done, and all of
7049 the rest of the variables here will have no effect. Turning threading
7050 off will speed group selection up a bit, but it is sure to make reading
7051 slower and more awkward.
7053 @item gnus-thread-hide-subtree
7054 @vindex gnus-thread-hide-subtree
7055 If non-@code{nil}, all threads will be hidden when the summary buffer is
7058 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
7059 Available predicates are @code{gnus-article-unread-p} and
7060 @code{gnus-article-unseen-p}.
7065 (setq gnus-thread-hide-subtree
7066 '(or gnus-article-unread-p
7067 gnus-article-unseen-p))
7070 (It's a pretty nonsensical example, since all unseen articles are also
7071 unread, but you get my drift.)
7074 @item gnus-thread-expunge-below
7075 @vindex gnus-thread-expunge-below
7076 All threads that have a total score (as defined by
7077 @code{gnus-thread-score-function}) less than this number will be
7078 expunged. This variable is @code{nil} by default, which means that no
7079 threads are expunged.
7081 @item gnus-thread-hide-killed
7082 @vindex gnus-thread-hide-killed
7083 if you kill a thread and this variable is non-@code{nil}, the subtree
7086 @item gnus-thread-ignore-subject
7087 @vindex gnus-thread-ignore-subject
7088 Sometimes somebody changes the subject in the middle of a thread. If
7089 this variable is non-@code{nil}, which is the default, the subject
7090 change is ignored. If it is @code{nil}, a change in the subject will
7091 result in a new thread.
7093 @item gnus-thread-indent-level
7094 @vindex gnus-thread-indent-level
7095 This is a number that says how much each sub-thread should be indented.
7098 @item gnus-sort-gathered-threads-function
7099 @vindex gnus-sort-gathered-threads-function
7100 Sometimes, particularly with mailing lists, the order in which mails
7101 arrive locally is not necessarily the same as the order in which they
7102 arrived on the mailing list. Consequently, when sorting sub-threads
7103 using the default @code{gnus-thread-sort-by-number}, responses can end
7104 up appearing before the article to which they are responding to.
7105 Setting this variable to an alternate value
7106 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
7107 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
7108 more logical sub-thread ordering in such instances.
7113 @node Low-Level Threading
7114 @subsubsection Low-Level Threading
7118 @item gnus-parse-headers-hook
7119 @vindex gnus-parse-headers-hook
7120 Hook run before parsing any headers.
7122 @item gnus-alter-header-function
7123 @vindex gnus-alter-header-function
7124 If non-@code{nil}, this function will be called to allow alteration of
7125 article header structures. The function is called with one parameter,
7126 the article header vector, which it may alter in any way. For instance,
7127 if you have a mail-to-news gateway which alters the @code{Message-ID}s
7128 in systematic ways (by adding prefixes and such), you can use this
7129 variable to un-scramble the @code{Message-ID}s so that they are more
7130 meaningful. Here's one example:
7133 (setq gnus-alter-header-function 'my-alter-message-id)
7135 (defun my-alter-message-id (header)
7136 (let ((id (mail-header-id header)))
7138 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
7140 (concat (match-string 1 id) "@@" (match-string 2 id))
7147 @node Thread Commands
7148 @subsection Thread Commands
7149 @cindex thread commands
7155 @kindex T k (Summary)
7156 @kindex C-M-k (Summary)
7157 @findex gnus-summary-kill-thread
7158 Mark all articles in the current (sub-)thread as read
7159 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
7160 remove all marks instead. If the prefix argument is negative, tick
7165 @kindex T l (Summary)
7166 @kindex C-M-l (Summary)
7167 @findex gnus-summary-lower-thread
7168 Lower the score of the current (sub-)thread
7169 (@code{gnus-summary-lower-thread}).
7172 @kindex T i (Summary)
7173 @findex gnus-summary-raise-thread
7174 Increase the score of the current (sub-)thread
7175 (@code{gnus-summary-raise-thread}).
7178 @kindex T # (Summary)
7179 @findex gnus-uu-mark-thread
7180 Set the process mark on the current (sub-)thread
7181 (@code{gnus-uu-mark-thread}).
7184 @kindex T M-# (Summary)
7185 @findex gnus-uu-unmark-thread
7186 Remove the process mark from the current (sub-)thread
7187 (@code{gnus-uu-unmark-thread}).
7190 @kindex T T (Summary)
7191 @findex gnus-summary-toggle-threads
7192 Toggle threading (@code{gnus-summary-toggle-threads}).
7195 @kindex T s (Summary)
7196 @findex gnus-summary-show-thread
7197 Expose the (sub-)thread hidden under the current article, if any@*
7198 (@code{gnus-summary-show-thread}).
7201 @kindex T h (Summary)
7202 @findex gnus-summary-hide-thread
7203 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
7206 @kindex T S (Summary)
7207 @findex gnus-summary-show-all-threads
7208 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
7211 @kindex T H (Summary)
7212 @findex gnus-summary-hide-all-threads
7213 Hide all threads (@code{gnus-summary-hide-all-threads}).
7216 @kindex T t (Summary)
7217 @findex gnus-summary-rethread-current
7218 Re-thread the current article's thread
7219 (@code{gnus-summary-rethread-current}). This works even when the
7220 summary buffer is otherwise unthreaded.
7223 @kindex T ^ (Summary)
7224 @findex gnus-summary-reparent-thread
7225 Make the current article the child of the marked (or previous) article
7226 (@code{gnus-summary-reparent-thread}).
7229 @kindex T M-^ (Summary)
7230 @findex gnus-summary-reparent-children
7231 Make the current article the parent of the marked articles
7232 (@code{gnus-summary-reparent-children}).
7236 The following commands are thread movement commands. They all
7237 understand the numeric prefix.
7242 @kindex T n (Summary)
7244 @kindex C-M-n (Summary)
7246 @kindex M-down (Summary)
7247 @findex gnus-summary-next-thread
7248 Go to the next thread (@code{gnus-summary-next-thread}).
7251 @kindex T p (Summary)
7253 @kindex C-M-p (Summary)
7255 @kindex M-up (Summary)
7256 @findex gnus-summary-prev-thread
7257 Go to the previous thread (@code{gnus-summary-prev-thread}).
7260 @kindex T d (Summary)
7261 @findex gnus-summary-down-thread
7262 Descend the thread (@code{gnus-summary-down-thread}).
7265 @kindex T u (Summary)
7266 @findex gnus-summary-up-thread
7267 Ascend the thread (@code{gnus-summary-up-thread}).
7270 @kindex T o (Summary)
7271 @findex gnus-summary-top-thread
7272 Go to the top of the thread (@code{gnus-summary-top-thread}).
7275 @vindex gnus-thread-operation-ignore-subject
7276 If you ignore subject while threading, you'll naturally end up with
7277 threads that have several different subjects in them. If you then issue
7278 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
7279 wish to kill the entire thread, but just those parts of the thread that
7280 have the same subject as the current article. If you like this idea,
7281 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
7282 is non-@code{nil} (which it is by default), subjects will be ignored
7283 when doing thread commands. If this variable is @code{nil}, articles in
7284 the same thread with different subjects will not be included in the
7285 operation in question. If this variable is @code{fuzzy}, only articles
7286 that have subjects fuzzily equal will be included (@pxref{Fuzzy
7290 @node Sorting the Summary Buffer
7291 @section Sorting the Summary Buffer
7293 @findex gnus-thread-sort-by-total-score
7294 @findex gnus-thread-sort-by-date
7295 @findex gnus-thread-sort-by-score
7296 @findex gnus-thread-sort-by-subject
7297 @findex gnus-thread-sort-by-author
7298 @findex gnus-thread-sort-by-recipient
7299 @findex gnus-thread-sort-by-number
7300 @findex gnus-thread-sort-by-random
7301 @vindex gnus-thread-sort-functions
7302 @findex gnus-thread-sort-by-most-recent-number
7303 @findex gnus-thread-sort-by-most-recent-date
7304 If you are using a threaded summary display, you can sort the threads by
7305 setting @code{gnus-thread-sort-functions}, which can be either a single
7306 function, a list of functions, or a list containing functions and
7307 @code{(not some-function)} elements.
7309 By default, sorting is done on article numbers. Ready-made sorting
7310 predicate functions include @code{gnus-thread-sort-by-number},
7311 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-recipient},
7312 @code{gnus-thread-sort-by-subject},
7313 @code{gnus-thread-sort-by-date},
7314 @code{gnus-thread-sort-by-score},
7315 @code{gnus-thread-sort-by-most-recent-number},
7316 @code{gnus-thread-sort-by-most-recent-date},
7317 @code{gnus-thread-sort-by-random} and
7318 @code{gnus-thread-sort-by-total-score}.
7320 Each function takes two threads and returns non-@code{nil} if the first
7321 thread should be sorted before the other. Note that sorting really is
7322 normally done by looking only at the roots of each thread.
7324 If you use more than one function, the primary sort key should be the
7325 last function in the list. You should probably always include
7326 @code{gnus-thread-sort-by-number} in the list of sorting
7327 functions---preferably first. This will ensure that threads that are
7328 equal with respect to the other sort criteria will be displayed in
7329 ascending article order.
7331 If you would like to sort by reverse score, then by subject, and finally
7332 by number, you could do something like:
7335 (setq gnus-thread-sort-functions
7336 '(gnus-thread-sort-by-number
7337 gnus-thread-sort-by-subject
7338 (not gnus-thread-sort-by-total-score)))
7341 The threads that have highest score will be displayed first in the
7342 summary buffer. When threads have the same score, they will be sorted
7343 alphabetically. The threads that have the same score and the same
7344 subject will be sorted by number, which is (normally) the sequence in
7345 which the articles arrived.
7347 If you want to sort by score and then reverse arrival order, you could
7351 (setq gnus-thread-sort-functions
7352 '((not gnus-thread-sort-by-number)
7353 gnus-thread-sort-by-score))
7356 @vindex gnus-thread-score-function
7357 The function in the @code{gnus-thread-score-function} variable (default
7358 @code{+}) is used for calculating the total score of a thread. Useful
7359 functions might be @code{max}, @code{min}, or squared means, or whatever
7362 @findex gnus-article-sort-functions
7363 @findex gnus-article-sort-by-date
7364 @findex gnus-article-sort-by-score
7365 @findex gnus-article-sort-by-subject
7366 @findex gnus-article-sort-by-author
7367 @findex gnus-article-sort-by-random
7368 @findex gnus-article-sort-by-number
7369 If you are using an unthreaded display for some strange reason or
7370 other, you have to fiddle with the @code{gnus-article-sort-functions}
7371 variable. It is very similar to the
7372 @code{gnus-thread-sort-functions}, except that it uses slightly
7373 different functions for article comparison. Available sorting
7374 predicate functions are @code{gnus-article-sort-by-number},
7375 @code{gnus-article-sort-by-author},
7376 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7377 @code{gnus-article-sort-by-random}, and
7378 @code{gnus-article-sort-by-score}.
7380 If you want to sort an unthreaded summary display by subject, you could
7384 (setq gnus-article-sort-functions
7385 '(gnus-article-sort-by-number
7386 gnus-article-sort-by-subject))
7389 You can define group specific sorting via @code{gnus-parameters},
7390 @xref{Group Parameters}.
7393 @node Asynchronous Fetching
7394 @section Asynchronous Article Fetching
7395 @cindex asynchronous article fetching
7396 @cindex article pre-fetch
7399 If you read your news from an @acronym{NNTP} server that's far away, the
7400 network latencies may make reading articles a chore. You have to wait
7401 for a while after pressing @kbd{n} to go to the next article before the
7402 article appears. Why can't Gnus just go ahead and fetch the article
7403 while you are reading the previous one? Why not, indeed.
7405 First, some caveats. There are some pitfalls to using asynchronous
7406 article fetching, especially the way Gnus does it.
7408 Let's say you are reading article 1, which is short, and article 2 is
7409 quite long, and you are not interested in reading that. Gnus does not
7410 know this, so it goes ahead and fetches article 2. You decide to read
7411 article 3, but since Gnus is in the process of fetching article 2, the
7412 connection is blocked.
7414 To avoid these situations, Gnus will open two (count 'em two)
7415 connections to the server. Some people may think this isn't a very nice
7416 thing to do, but I don't see any real alternatives. Setting up that
7417 extra connection takes some time, so Gnus startup will be slower.
7419 Gnus will fetch more articles than you will read. This will mean that
7420 the link between your machine and the @acronym{NNTP} server will become more
7421 loaded than if you didn't use article pre-fetch. The server itself will
7422 also become more loaded---both with the extra article requests, and the
7425 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7428 @vindex gnus-asynchronous
7429 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7430 happen automatically.
7432 @vindex gnus-use-article-prefetch
7433 You can control how many articles are to be pre-fetched by setting
7434 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7435 that when you read an article in the group, the back end will pre-fetch
7436 the next 30 articles. If this variable is @code{t}, the back end will
7437 pre-fetch all the articles it can without bound. If it is
7438 @code{nil}, no pre-fetching will be done.
7440 @vindex gnus-async-prefetch-article-p
7441 @findex gnus-async-unread-p
7442 There are probably some articles that you don't want to pre-fetch---read
7443 articles, for instance. The @code{gnus-async-prefetch-article-p}
7444 variable controls whether an article is to be pre-fetched. This
7445 function should return non-@code{nil} when the article in question is
7446 to be pre-fetched. The default is @code{gnus-async-unread-p}, which
7447 returns @code{nil} on read articles. The function is called with an
7448 article data structure as the only parameter.
7450 If, for instance, you wish to pre-fetch only unread articles shorter
7451 than 100 lines, you could say something like:
7454 (defun my-async-short-unread-p (data)
7455 "Return non-nil for short, unread articles."
7456 (and (gnus-data-unread-p data)
7457 (< (mail-header-lines (gnus-data-header data))
7460 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7463 These functions will be called many, many times, so they should
7464 preferably be short and sweet to avoid slowing down Gnus too much.
7465 It's probably a good idea to byte-compile things like this.
7467 @vindex gnus-prefetched-article-deletion-strategy
7468 Articles have to be removed from the asynch buffer sooner or later. The
7469 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7470 articles. This is a list that may contain the following elements:
7474 Remove articles when they are read.
7477 Remove articles when exiting the group.
7480 The default value is @code{(read exit)}.
7482 @c @vindex gnus-use-header-prefetch
7483 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7484 @c from the next group.
7487 @node Article Caching
7488 @section Article Caching
7489 @cindex article caching
7492 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7493 consider turning article caching on. Each article will then be stored
7494 locally under your home directory. As you may surmise, this could
7495 potentially use @emph{huge} amounts of disk space, as well as eat up all
7496 your inodes so fast it will make your head swim. In vodka.
7498 Used carefully, though, it could be just an easier way to save articles.
7500 @vindex gnus-use-long-file-name
7501 @vindex gnus-cache-directory
7502 @vindex gnus-use-cache
7503 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7504 all articles ticked or marked as dormant will then be copied
7505 over to your local cache (@code{gnus-cache-directory}). Whether this
7506 cache is flat or hierarchical is controlled by the
7507 @code{gnus-use-long-file-name} variable, as usual.
7509 When re-selecting a ticked or dormant article, it will be fetched from the
7510 cache instead of from the server. As articles in your cache will never
7511 expire, this might serve as a method of saving articles while still
7512 keeping them where they belong. Just mark all articles you want to save
7513 as dormant, and don't worry.
7515 When an article is marked as read, is it removed from the cache.
7517 @vindex gnus-cache-remove-articles
7518 @vindex gnus-cache-enter-articles
7519 The entering/removal of articles from the cache is controlled by the
7520 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7521 variables. Both are lists of symbols. The first is @code{(ticked
7522 dormant)} by default, meaning that ticked and dormant articles will be
7523 put in the cache. The latter is @code{(read)} by default, meaning that
7524 articles marked as read are removed from the cache. Possibly
7525 symbols in these two lists are @code{ticked}, @code{dormant},
7526 @code{unread} and @code{read}.
7528 @findex gnus-jog-cache
7529 So where does the massive article-fetching and storing come into the
7530 picture? The @code{gnus-jog-cache} command will go through all
7531 subscribed newsgroups, request all unread articles, score them, and
7532 store them in the cache. You should only ever, ever ever ever, use this
7533 command if 1) your connection to the @acronym{NNTP} server is really, really,
7534 really slow and 2) you have a really, really, really huge disk.
7535 Seriously. One way to cut down on the number of articles downloaded is
7536 to score unwanted articles down and have them marked as read. They will
7537 not then be downloaded by this command.
7539 @vindex gnus-uncacheable-groups
7540 @vindex gnus-cacheable-groups
7541 It is likely that you do not want caching on all groups. For instance,
7542 if your @code{nnml} mail is located under your home directory, it makes no
7543 sense to cache it somewhere else under your home directory. Unless you
7544 feel that it's neat to use twice as much space.
7546 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7547 regexp of groups to cache, @samp{^nntp} for instance, or set the
7548 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7549 Both variables are @code{nil} by default. If a group matches both
7550 variables, the group is not cached.
7552 @findex gnus-cache-generate-nov-databases
7553 @findex gnus-cache-generate-active
7554 @vindex gnus-cache-active-file
7555 The cache stores information on what articles it contains in its active
7556 file (@code{gnus-cache-active-file}). If this file (or any other parts
7557 of the cache) becomes all messed up for some reason or other, Gnus
7558 offers two functions that will try to set things right. @kbd{M-x
7559 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7560 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7563 @findex gnus-cache-move-cache
7564 @code{gnus-cache-move-cache} will move your whole
7565 @code{gnus-cache-directory} to some other location. You get asked to
7566 where, isn't that cool?
7568 @node Persistent Articles
7569 @section Persistent Articles
7570 @cindex persistent articles
7572 Closely related to article caching, we have @dfn{persistent articles}.
7573 In fact, it's just a different way of looking at caching, and much more
7574 useful in my opinion.
7576 Say you're reading a newsgroup, and you happen on to some valuable gem
7577 that you want to keep and treasure forever. You'd normally just save it
7578 (using one of the many saving commands) in some file. The problem with
7579 that is that it's just, well, yucky. Ideally you'd prefer just having
7580 the article remain in the group where you found it forever; untouched by
7581 the expiry going on at the news server.
7583 This is what a @dfn{persistent article} is---an article that just won't
7584 be deleted. It's implemented using the normal cache functions, but
7585 you use two explicit commands for managing persistent articles:
7591 @findex gnus-cache-enter-article
7592 Make the current article persistent (@code{gnus-cache-enter-article}).
7595 @kindex M-* (Summary)
7596 @findex gnus-cache-remove-article
7597 Remove the current article from the persistent articles
7598 (@code{gnus-cache-remove-article}). This will normally delete the
7602 Both these commands understand the process/prefix convention.
7604 To avoid having all ticked articles (and stuff) entered into the cache,
7605 you should set @code{gnus-use-cache} to @code{passive} if you're just
7606 interested in persistent articles:
7609 (setq gnus-use-cache 'passive)
7612 @node Sticky Articles
7613 @section Sticky Articles
7614 @cindex sticky articles
7616 When you select an article the current article buffer will be reused
7617 according to the value of the variable
7618 @code{gnus-single-article-buffer}. If its value is non-@code{nil} (the
7619 default) all articles reuse the same article buffer. Else each group
7620 has its own article buffer.
7622 This implies that it's not possible to have more than one article buffer
7623 in a group at a time. But sometimes you might want to display all the
7624 latest emails from your mother, your father, your aunt, your uncle and
7625 your 17 cousins to coordinate the next christmas party.
7627 That's where sticky articles come in handy. A sticky article buffer
7628 basically is a normal article buffer, but it won't be reused when you
7629 select another article. You can make an article sticky with:
7633 @kindex A S (Summary)
7634 @findex gnus-sticky-article
7635 Make the current article sticky. If a prefix arg is given, ask for a
7636 name for this sticky article buffer.
7639 To close a sticky article buffer you can use these commands:
7645 Puts this sticky article buffer at the end of the list of all buffers.
7649 @findex gnus-kill-sticky-article-buffer
7650 Kills this sticky article buffer.
7653 To kill all sticky article buffers you can use:
7655 @defun gnus-kill-sticky-article-buffers ARG
7656 Kill all sticky article buffers.
7657 If a prefix ARG is given, ask for confirmation.
7660 @node Article Backlog
7661 @section Article Backlog
7663 @cindex article backlog
7665 If you have a slow connection, but the idea of using caching seems
7666 unappealing to you (and it is, really), you can help the situation some
7667 by switching on the @dfn{backlog}. This is where Gnus will buffer
7668 already read articles so that it doesn't have to re-fetch articles
7669 you've already read. This only helps if you are in the habit of
7670 re-selecting articles you've recently read, of course. If you never do
7671 that, turning the backlog on will slow Gnus down a little bit, and
7672 increase memory usage some.
7674 @vindex gnus-keep-backlog
7675 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
7676 at most @var{n} old articles in a buffer for later re-fetching. If this
7677 variable is non-@code{nil} and is not a number, Gnus will store
7678 @emph{all} read articles, which means that your Emacs will grow without
7679 bound before exploding and taking your machine down with you. I put
7680 that in there just to keep y'all on your toes.
7682 The default value is 20.
7685 @node Saving Articles
7686 @section Saving Articles
7687 @cindex saving articles
7689 Gnus can save articles in a number of ways. Below is the documentation
7690 for saving articles in a fairly straight-forward fashion (i.e., little
7691 processing of the article is done before it is saved). For a different
7692 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7693 (@pxref{Decoding Articles}).
7695 For the commands listed here, the target is a file. If you want to
7696 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7697 command (@pxref{Mail Group Commands}).
7699 @vindex gnus-save-all-headers
7700 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
7701 unwanted headers before saving the article.
7703 @vindex gnus-saved-headers
7704 If the preceding variable is @code{nil}, all headers that match the
7705 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7706 deleted before saving.
7712 @kindex O o (Summary)
7714 @findex gnus-summary-save-article
7715 @c @icon{gnus-summary-save-article}
7716 Save the current article using the default article saver
7717 (@code{gnus-summary-save-article}).
7720 @kindex O m (Summary)
7721 @findex gnus-summary-save-article-mail
7722 Save the current article in a Unix mail box (mbox) file
7723 (@code{gnus-summary-save-article-mail}).
7726 @kindex O r (Summary)
7727 @findex gnus-summary-save-article-rmail
7728 Save the current article in Rmail format
7729 (@code{gnus-summary-save-article-rmail}).
7732 @kindex O f (Summary)
7733 @findex gnus-summary-save-article-file
7734 @c @icon{gnus-summary-save-article-file}
7735 Save the current article in plain file format
7736 (@code{gnus-summary-save-article-file}).
7739 @kindex O F (Summary)
7740 @findex gnus-summary-write-article-file
7741 Write the current article in plain file format, overwriting any previous
7742 file contents (@code{gnus-summary-write-article-file}).
7745 @kindex O b (Summary)
7746 @findex gnus-summary-save-article-body-file
7747 Save the current article body in plain file format
7748 (@code{gnus-summary-save-article-body-file}).
7751 @kindex O h (Summary)
7752 @findex gnus-summary-save-article-folder
7753 Save the current article in mh folder format
7754 (@code{gnus-summary-save-article-folder}).
7757 @kindex O v (Summary)
7758 @findex gnus-summary-save-article-vm
7759 Save the current article in a VM folder
7760 (@code{gnus-summary-save-article-vm}).
7764 @kindex O p (Summary)
7766 @findex gnus-summary-pipe-output
7767 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7768 the current article to a process (@code{gnus-summary-pipe-output}).
7769 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7770 complete headers in the piped output.
7773 @kindex O P (Summary)
7774 @findex gnus-summary-muttprint
7775 @vindex gnus-summary-muttprint-program
7776 Save the current article into muttprint. That is, print it using the
7777 external program @uref{http://muttprint.sourceforge.net/,
7778 Muttprint}. The program name and options to use is controlled by the
7779 variable @code{gnus-summary-muttprint-program}.
7780 (@code{gnus-summary-muttprint}).
7784 @vindex gnus-prompt-before-saving
7785 All these commands use the process/prefix convention
7786 (@pxref{Process/Prefix}). If you save bunches of articles using these
7787 functions, you might get tired of being prompted for files to save each
7788 and every article in. The prompting action is controlled by
7789 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7790 default, giving you that excessive prompting action you know and
7791 loathe. If you set this variable to @code{t} instead, you'll be prompted
7792 just once for each series of articles you save. If you like to really
7793 have Gnus do all your thinking for you, you can even set this variable
7794 to @code{nil}, which means that you will never be prompted for files to
7795 save articles in. Gnus will simply save all the articles in the default
7799 @vindex gnus-default-article-saver
7800 You can customize the @code{gnus-default-article-saver} variable to make
7801 Gnus do what you want it to. You can use any of the eight ready-made
7802 functions below, or you can create your own.
7806 @item gnus-summary-save-in-rmail
7807 @findex gnus-summary-save-in-rmail
7808 @vindex gnus-rmail-save-name
7809 @findex gnus-plain-save-name
7810 This is the default format, @dfn{Babyl}. Uses the function in the
7811 @code{gnus-rmail-save-name} variable to get a file name to save the
7812 article in. The default is @code{gnus-plain-save-name}.
7814 @item gnus-summary-save-in-mail
7815 @findex gnus-summary-save-in-mail
7816 @vindex gnus-mail-save-name
7817 Save in a Unix mail (mbox) file. Uses the function in the
7818 @code{gnus-mail-save-name} variable to get a file name to save the
7819 article in. The default is @code{gnus-plain-save-name}.
7821 @item gnus-summary-save-in-file
7822 @findex gnus-summary-save-in-file
7823 @vindex gnus-file-save-name
7824 @findex gnus-numeric-save-name
7825 Append the article straight to an ordinary file. Uses the function in
7826 the @code{gnus-file-save-name} variable to get a file name to save the
7827 article in. The default is @code{gnus-numeric-save-name}.
7829 @item gnus-summary-write-to-file
7830 @findex gnus-summary-write-to-file
7831 Write the article straight to an ordinary file. The file is
7832 overwritten if it exists. Uses the function in the
7833 @code{gnus-file-save-name} variable to get a file name to save the
7834 article in. The default is @code{gnus-numeric-save-name}.
7836 @item gnus-summary-save-body-in-file
7837 @findex gnus-summary-save-body-in-file
7838 Append the article body to an ordinary file. 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-write-body-to-file
7843 @findex gnus-summary-write-body-to-file
7844 Write the article body straight to an ordinary file. The file is
7845 overwritten if it exists. Uses the function in the
7846 @code{gnus-file-save-name} variable to get a file name to save the
7847 article in. The default is @code{gnus-numeric-save-name}.
7849 @item gnus-summary-save-in-folder
7850 @findex gnus-summary-save-in-folder
7851 @findex gnus-folder-save-name
7852 @findex gnus-Folder-save-name
7853 @vindex gnus-folder-save-name
7856 Save the article to an MH folder using @code{rcvstore} from the MH
7857 library. Uses the function in the @code{gnus-folder-save-name} variable
7858 to get a file name to save the article in. The default is
7859 @code{gnus-folder-save-name}, but you can also use
7860 @code{gnus-Folder-save-name}, which creates capitalized names.
7862 @item gnus-summary-save-in-vm
7863 @findex gnus-summary-save-in-vm
7864 Save the article in a VM folder. You have to have the VM mail
7865 reader to use this setting.
7868 The symbol of each function may have the following properties:
7872 The value non-@code{nil} means save decoded articles. This is
7873 meaningful only with @code{gnus-summary-save-in-file},
7874 @code{gnus-summary-save-body-in-file},
7875 @code{gnus-summary-write-to-file}, and
7876 @code{gnus-summary-write-body-to-file}.
7879 The value specifies an alternative function which appends, not
7880 overwrites, articles to a file. This implies that when saving many
7881 articles at a time, @code{gnus-prompt-before-saving} is bound to
7882 @code{t} and all articles are saved in a single file. This is
7883 meaningful only with @code{gnus-summary-write-to-file} and
7884 @code{gnus-summary-write-body-to-file}.
7887 The value specifies the symbol of a variable of which the value
7888 specifies headers to be saved. If it is omitted,
7889 @code{gnus-save-all-headers} and @code{gnus-saved-headers} control what
7890 headers should be saved.
7893 @vindex gnus-article-save-directory
7894 All of these functions, except for the last one, will save the article
7895 in the @code{gnus-article-save-directory}, which is initialized from the
7896 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7899 As you can see above, the functions use different functions to find a
7900 suitable name of a file to save the article in. Below is a list of
7901 available functions that generate names:
7905 @item gnus-Numeric-save-name
7906 @findex gnus-Numeric-save-name
7907 File names like @file{~/News/Alt.andrea-dworkin/45}.
7909 @item gnus-numeric-save-name
7910 @findex gnus-numeric-save-name
7911 File names like @file{~/News/alt.andrea-dworkin/45}.
7913 @item gnus-Plain-save-name
7914 @findex gnus-Plain-save-name
7915 File names like @file{~/News/Alt.andrea-dworkin}.
7917 @item gnus-plain-save-name
7918 @findex gnus-plain-save-name
7919 File names like @file{~/News/alt.andrea-dworkin}.
7921 @item gnus-sender-save-name
7922 @findex gnus-sender-save-name
7923 File names like @file{~/News/larsi}.
7926 @vindex gnus-split-methods
7927 You can have Gnus suggest where to save articles by plonking a regexp into
7928 the @code{gnus-split-methods} alist. For instance, if you would like to
7929 save articles related to Gnus in the file @file{gnus-stuff}, and articles
7930 related to VM in @file{vm-stuff}, you could set this variable to something
7934 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7935 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7936 (my-choosing-function "../other-dir/my-stuff")
7937 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7940 We see that this is a list where each element is a list that has two
7941 elements---the @dfn{match} and the @dfn{file}. The match can either be
7942 a string (in which case it is used as a regexp to match on the article
7943 head); it can be a symbol (which will be called as a function with the
7944 group name as a parameter); or it can be a list (which will be
7945 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7946 the @dfn{file} will be used as a default prompt. In addition, the
7947 result of the operation itself will be used if the function or form
7948 called returns a string or a list of strings.
7950 You basically end up with a list of file names that might be used when
7951 saving the current article. (All ``matches'' will be used.) You will
7952 then be prompted for what you really want to use as a name, with file
7953 name completion over the results from applying this variable.
7955 This variable is @code{((gnus-article-archive-name))} by default, which
7956 means that Gnus will look at the articles it saves for an
7957 @code{Archive-name} line and use that as a suggestion for the file
7960 Here's an example function to clean up file names somewhat. If you have
7961 lots of mail groups called things like
7962 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7963 these group names before creating the file name to save to. The
7964 following will do just that:
7967 (defun my-save-name (group)
7968 (when (string-match "^nnml:mail." group)
7969 (substring group (match-end 0))))
7971 (setq gnus-split-methods
7972 '((gnus-article-archive-name)
7977 @vindex gnus-use-long-file-name
7978 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7979 @code{nil}, all the preceding functions will replace all periods
7980 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7981 the functions will generate hierarchies of directories instead of having
7982 all the files in the top level directory
7983 (@file{~/News/alt/andrea-dworkin} instead of
7984 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7985 on most systems. However, for historical reasons, this is @code{nil} on
7986 Xenix and usg-unix-v machines by default.
7988 This function also affects kill and score file names. If this variable
7989 is a list, and the list contains the element @code{not-score}, long file
7990 names will not be used for score files, if it contains the element
7991 @code{not-save}, long file names will not be used for saving, and if it
7992 contains the element @code{not-kill}, long file names will not be used
7995 If you'd like to save articles in a hierarchy that looks something like
7999 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
8000 (setq gnus-default-article-saver
8001 'gnus-summary-save-in-file) ; @r{no encoding}
8004 Then just save with @kbd{o}. You'd then read this hierarchy with
8005 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
8006 the top level directory as the argument (@file{~/News/}). Then just walk
8007 around to the groups/directories with @code{nneething}.
8010 @node Decoding Articles
8011 @section Decoding Articles
8012 @cindex decoding articles
8014 Sometime users post articles (or series of articles) that have been
8015 encoded in some way or other. Gnus can decode them for you.
8018 * Uuencoded Articles:: Uudecode articles.
8019 * Shell Archives:: Unshar articles.
8020 * PostScript Files:: Split PostScript.
8021 * Other Files:: Plain save and binhex.
8022 * Decoding Variables:: Variables for a happy decoding.
8023 * Viewing Files:: You want to look at the result of the decoding?
8027 @cindex article series
8028 All these functions use the process/prefix convention
8029 (@pxref{Process/Prefix}) for finding out what articles to work on, with
8030 the extension that a ``single article'' means ``a single series''. Gnus
8031 can find out by itself what articles belong to a series, decode all the
8032 articles and unpack/view/save the resulting file(s).
8034 Gnus guesses what articles are in the series according to the following
8035 simplish rule: The subjects must be (nearly) identical, except for the
8036 last two numbers of the line. (Spaces are largely ignored, however.)
8038 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
8039 will find all the articles that match the regexp @samp{^cat.gif
8040 ([0-9]+/[0-9]+).*$}.
8042 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
8043 series}, will not be properly recognized by any of the automatic viewing
8044 commands, and you have to mark the articles manually with @kbd{#}.
8047 @node Uuencoded Articles
8048 @subsection Uuencoded Articles
8050 @cindex uuencoded articles
8055 @kindex X u (Summary)
8056 @findex gnus-uu-decode-uu
8057 @c @icon{gnus-uu-decode-uu}
8058 Uudecodes the current series (@code{gnus-uu-decode-uu}).
8061 @kindex X U (Summary)
8062 @findex gnus-uu-decode-uu-and-save
8063 Uudecodes and saves the current series
8064 (@code{gnus-uu-decode-uu-and-save}).
8067 @kindex X v u (Summary)
8068 @findex gnus-uu-decode-uu-view
8069 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
8072 @kindex X v U (Summary)
8073 @findex gnus-uu-decode-uu-and-save-view
8074 Uudecodes, views and saves the current series
8075 (@code{gnus-uu-decode-uu-and-save-view}).
8079 Remember that these all react to the presence of articles marked with
8080 the process mark. If, for instance, you'd like to decode and save an
8081 entire newsgroup, you'd typically do @kbd{M P a}
8082 (@code{gnus-uu-mark-all}) and then @kbd{X U}
8083 (@code{gnus-uu-decode-uu-and-save}).
8085 All this is very much different from how @code{gnus-uu} worked with
8086 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
8087 the sun. This version of @code{gnus-uu} generally assumes that you mark
8088 articles in some way (@pxref{Setting Process Marks}) and then press
8091 @vindex gnus-uu-notify-files
8092 Note: When trying to decode articles that have names matching
8093 @code{gnus-uu-notify-files}, which is hard-coded to
8094 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
8095 automatically post an article on @samp{comp.unix.wizards} saying that
8096 you have just viewed the file in question. This feature can't be turned
8100 @node Shell Archives
8101 @subsection Shell Archives
8103 @cindex shell archives
8104 @cindex shared articles
8106 Shell archives (``shar files'') used to be a popular way to distribute
8107 sources, but it isn't used all that much today. In any case, we have
8108 some commands to deal with these:
8113 @kindex X s (Summary)
8114 @findex gnus-uu-decode-unshar
8115 Unshars the current series (@code{gnus-uu-decode-unshar}).
8118 @kindex X S (Summary)
8119 @findex gnus-uu-decode-unshar-and-save
8120 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
8123 @kindex X v s (Summary)
8124 @findex gnus-uu-decode-unshar-view
8125 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
8128 @kindex X v S (Summary)
8129 @findex gnus-uu-decode-unshar-and-save-view
8130 Unshars, views and saves the current series
8131 (@code{gnus-uu-decode-unshar-and-save-view}).
8135 @node PostScript Files
8136 @subsection PostScript Files
8142 @kindex X p (Summary)
8143 @findex gnus-uu-decode-postscript
8144 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
8147 @kindex X P (Summary)
8148 @findex gnus-uu-decode-postscript-and-save
8149 Unpack and save the current PostScript series
8150 (@code{gnus-uu-decode-postscript-and-save}).
8153 @kindex X v p (Summary)
8154 @findex gnus-uu-decode-postscript-view
8155 View the current PostScript series
8156 (@code{gnus-uu-decode-postscript-view}).
8159 @kindex X v P (Summary)
8160 @findex gnus-uu-decode-postscript-and-save-view
8161 View and save the current PostScript series
8162 (@code{gnus-uu-decode-postscript-and-save-view}).
8167 @subsection Other Files
8171 @kindex X o (Summary)
8172 @findex gnus-uu-decode-save
8173 Save the current series
8174 (@code{gnus-uu-decode-save}).
8177 @kindex X b (Summary)
8178 @findex gnus-uu-decode-binhex
8179 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
8180 doesn't really work yet.
8183 @kindex X Y (Summary)
8184 @findex gnus-uu-decode-yenc
8185 yEnc-decode the current series and save it (@code{gnus-uu-decode-yenc}).
8189 @node Decoding Variables
8190 @subsection Decoding Variables
8192 Adjective, not verb.
8195 * Rule Variables:: Variables that say how a file is to be viewed.
8196 * Other Decode Variables:: Other decode variables.
8197 * Uuencoding and Posting:: Variables for customizing uuencoding.
8201 @node Rule Variables
8202 @subsubsection Rule Variables
8203 @cindex rule variables
8205 Gnus uses @dfn{rule variables} to decide how to view a file. All these
8206 variables are of the form
8209 (list '(regexp1 command2)
8216 @item gnus-uu-user-view-rules
8217 @vindex gnus-uu-user-view-rules
8219 This variable is consulted first when viewing files. If you wish to use,
8220 for instance, @code{sox} to convert an @file{.au} sound file, you could
8223 (setq gnus-uu-user-view-rules
8224 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
8227 @item gnus-uu-user-view-rules-end
8228 @vindex gnus-uu-user-view-rules-end
8229 This variable is consulted if Gnus couldn't make any matches from the
8230 user and default view rules.
8232 @item gnus-uu-user-archive-rules
8233 @vindex gnus-uu-user-archive-rules
8234 This variable can be used to say what commands should be used to unpack
8239 @node Other Decode Variables
8240 @subsubsection Other Decode Variables
8243 @vindex gnus-uu-grabbed-file-functions
8245 @item gnus-uu-grabbed-file-functions
8246 All functions in this list will be called right after each file has been
8247 successfully decoded---so that you can move or view files right away,
8248 and don't have to wait for all files to be decoded before you can do
8249 anything. Ready-made functions you can put in this list are:
8253 @item gnus-uu-grab-view
8254 @findex gnus-uu-grab-view
8257 @item gnus-uu-grab-move
8258 @findex gnus-uu-grab-move
8259 Move the file (if you're using a saving function.)
8262 @item gnus-uu-be-dangerous
8263 @vindex gnus-uu-be-dangerous
8264 Specifies what to do if unusual situations arise during decoding. If
8265 @code{nil}, be as conservative as possible. If @code{t}, ignore things
8266 that didn't work, and overwrite existing files. Otherwise, ask each
8269 @item gnus-uu-ignore-files-by-name
8270 @vindex gnus-uu-ignore-files-by-name
8271 Files with name matching this regular expression won't be viewed.
8273 @item gnus-uu-ignore-files-by-type
8274 @vindex gnus-uu-ignore-files-by-type
8275 Files with a @acronym{MIME} type matching this variable won't be viewed.
8276 Note that Gnus tries to guess what type the file is based on the name.
8277 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
8280 @item gnus-uu-tmp-dir
8281 @vindex gnus-uu-tmp-dir
8282 Where @code{gnus-uu} does its work.
8284 @item gnus-uu-do-not-unpack-archives
8285 @vindex gnus-uu-do-not-unpack-archives
8286 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
8287 looking for files to display.
8289 @item gnus-uu-view-and-save
8290 @vindex gnus-uu-view-and-save
8291 Non-@code{nil} means that the user will always be asked to save a file
8294 @item gnus-uu-ignore-default-view-rules
8295 @vindex gnus-uu-ignore-default-view-rules
8296 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
8299 @item gnus-uu-ignore-default-archive-rules
8300 @vindex gnus-uu-ignore-default-archive-rules
8301 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
8304 @item gnus-uu-kill-carriage-return
8305 @vindex gnus-uu-kill-carriage-return
8306 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
8309 @item gnus-uu-unmark-articles-not-decoded
8310 @vindex gnus-uu-unmark-articles-not-decoded
8311 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
8312 decoded articles as unread.
8314 @item gnus-uu-correct-stripped-uucode
8315 @vindex gnus-uu-correct-stripped-uucode
8316 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
8317 uuencoded files that have had trailing spaces deleted.
8319 @item gnus-uu-pre-uudecode-hook
8320 @vindex gnus-uu-pre-uudecode-hook
8321 Hook run before sending a message to @code{uudecode}.
8323 @item gnus-uu-view-with-metamail
8324 @vindex gnus-uu-view-with-metamail
8326 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
8327 commands defined by the rule variables and just fudge a @acronym{MIME}
8328 content type based on the file name. The result will be fed to
8329 @code{metamail} for viewing.
8331 @item gnus-uu-save-in-digest
8332 @vindex gnus-uu-save-in-digest
8333 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
8334 decoding, will save in digests. If this variable is @code{nil},
8335 @code{gnus-uu} will just save everything in a file without any
8336 embellishments. The digesting almost conforms to RFC 1153---no easy way
8337 to specify any meaningful volume and issue numbers were found, so I
8338 simply dropped them.
8343 @node Uuencoding and Posting
8344 @subsubsection Uuencoding and Posting
8348 @item gnus-uu-post-include-before-composing
8349 @vindex gnus-uu-post-include-before-composing
8350 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
8351 before you compose the article. If this variable is @code{t}, you can
8352 either include an encoded file with @kbd{C-c C-i} or have one included
8353 for you when you post the article.
8355 @item gnus-uu-post-length
8356 @vindex gnus-uu-post-length
8357 Maximum length of an article. The encoded file will be split into how
8358 many articles it takes to post the entire file.
8360 @item gnus-uu-post-threaded
8361 @vindex gnus-uu-post-threaded
8362 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
8363 thread. This may not be smart, as no other decoder I have seen is able
8364 to follow threads when collecting uuencoded articles. (Well, I have
8365 seen one package that does that---@code{gnus-uu}, but somehow, I don't
8366 think that counts@dots{}) Default is @code{nil}.
8368 @item gnus-uu-post-separate-description
8369 @vindex gnus-uu-post-separate-description
8370 Non-@code{nil} means that the description will be posted in a separate
8371 article. The first article will typically be numbered (0/x). If this
8372 variable is @code{nil}, the description the user enters will be included
8373 at the beginning of the first article, which will be numbered (1/x).
8374 Default is @code{t}.
8380 @subsection Viewing Files
8381 @cindex viewing files
8382 @cindex pseudo-articles
8384 After decoding, if the file is some sort of archive, Gnus will attempt
8385 to unpack the archive and see if any of the files in the archive can be
8386 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
8387 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
8388 uncompress and de-tar the main file, and then view the two pictures.
8389 This unpacking process is recursive, so if the archive contains archives
8390 of archives, it'll all be unpacked.
8392 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
8393 extracted file into the summary buffer. If you go to these
8394 ``articles'', you will be prompted for a command to run (usually Gnus
8395 will make a suggestion), and then the command will be run.
8397 @vindex gnus-view-pseudo-asynchronously
8398 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
8399 until the viewing is done before proceeding.
8401 @vindex gnus-view-pseudos
8402 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8403 the pseudo-articles into the summary buffer, but view them
8404 immediately. If this variable is @code{not-confirm}, the user won't even
8405 be asked for a confirmation before viewing is done.
8407 @vindex gnus-view-pseudos-separately
8408 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8409 pseudo-article will be created for each file to be viewed. If
8410 @code{nil}, all files that use the same viewing command will be given as
8411 a list of parameters to that command.
8413 @vindex gnus-insert-pseudo-articles
8414 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8415 pseudo-articles when decoding. It is @code{t} by default.
8417 So; there you are, reading your @emph{pseudo-articles} in your
8418 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8419 Why isn't anything real anymore? How did we get here?
8422 @node Article Treatment
8423 @section Article Treatment
8425 Reading through this huge manual, you may have quite forgotten that the
8426 object of newsreaders is to actually, like, read what people have
8427 written. Reading articles. Unfortunately, people are quite bad at
8428 writing, so there are tons of functions and variables to make reading
8429 these articles easier.
8432 * Article Highlighting:: You want to make the article look like fruit salad.
8433 * Article Fontisizing:: Making emphasized text look nice.
8434 * Article Hiding:: You also want to make certain info go away.
8435 * Article Washing:: Lots of way-neat functions to make life better.
8436 * Article Header:: Doing various header transformations.
8437 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8438 * Article Button Levels:: Controlling appearance of buttons.
8439 * Article Date:: Grumble, UT!
8440 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8441 * Article Signature:: What is a signature?
8442 * Article Miscellanea:: Various other stuff.
8446 @node Article Highlighting
8447 @subsection Article Highlighting
8448 @cindex highlighting
8450 Not only do you want your article buffer to look like fruit salad, but
8451 you want it to look like technicolor fruit salad.
8456 @kindex W H a (Summary)
8457 @findex gnus-article-highlight
8458 @findex gnus-article-maybe-highlight
8459 Do much highlighting of the current article
8460 (@code{gnus-article-highlight}). This function highlights header, cited
8461 text, the signature, and adds buttons to the body and the head.
8464 @kindex W H h (Summary)
8465 @findex gnus-article-highlight-headers
8466 @vindex gnus-header-face-alist
8467 Highlight the headers (@code{gnus-article-highlight-headers}). The
8468 highlighting will be done according to the @code{gnus-header-face-alist}
8469 variable, which is a list where each element has the form
8470 @code{(@var{regexp} @var{name} @var{content})}.
8471 @var{regexp} is a regular expression for matching the
8472 header, @var{name} is the face used for highlighting the header name
8473 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8474 the header value. The first match made will be used. Note that
8475 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8478 @kindex W H c (Summary)
8479 @findex gnus-article-highlight-citation
8480 Highlight cited text (@code{gnus-article-highlight-citation}).
8482 Some variables to customize the citation highlights:
8485 @vindex gnus-cite-parse-max-size
8487 @item gnus-cite-parse-max-size
8488 If the article size in bytes is bigger than this variable (which is
8489 25000 by default), no citation highlighting will be performed.
8491 @item gnus-cite-max-prefix
8492 @vindex gnus-cite-max-prefix
8493 Maximum possible length for a citation prefix (default 20).
8495 @item gnus-cite-face-list
8496 @vindex gnus-cite-face-list
8497 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8498 When there are citations from multiple articles in the same message,
8499 Gnus will try to give each citation from each article its own face.
8500 This should make it easier to see who wrote what.
8502 @item gnus-supercite-regexp
8503 @vindex gnus-supercite-regexp
8504 Regexp matching normal Supercite attribution lines.
8506 @item gnus-supercite-secondary-regexp
8507 @vindex gnus-supercite-secondary-regexp
8508 Regexp matching mangled Supercite attribution lines.
8510 @item gnus-cite-minimum-match-count
8511 @vindex gnus-cite-minimum-match-count
8512 Minimum number of identical prefixes we have to see before we believe
8513 that it's a citation.
8515 @item gnus-cite-attribution-prefix
8516 @vindex gnus-cite-attribution-prefix
8517 Regexp matching the beginning of an attribution line.
8519 @item gnus-cite-attribution-suffix
8520 @vindex gnus-cite-attribution-suffix
8521 Regexp matching the end of an attribution line.
8523 @item gnus-cite-attribution-face
8524 @vindex gnus-cite-attribution-face
8525 Face used for attribution lines. It is merged with the face for the
8526 cited text belonging to the attribution.
8528 @item gnus-cite-ignore-quoted-from
8529 @vindex gnus-cite-ignore-quoted-from
8530 If non-@code{nil}, no citation highlighting will be performed on lines
8531 beginning with @samp{>From }. Those lines may have been quoted by MTAs
8532 in order not to mix up with the envelope From line. The default value
8539 @kindex W H s (Summary)
8540 @vindex gnus-signature-separator
8541 @vindex gnus-signature-face
8542 @findex gnus-article-highlight-signature
8543 Highlight the signature (@code{gnus-article-highlight-signature}).
8544 Everything after @code{gnus-signature-separator} (@pxref{Article
8545 Signature}) in an article will be considered a signature and will be
8546 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8551 @xref{Customizing Articles}, for how to highlight articles automatically.
8554 @node Article Fontisizing
8555 @subsection Article Fontisizing
8557 @cindex article emphasis
8559 @findex gnus-article-emphasize
8560 @kindex W e (Summary)
8561 People commonly add emphasis to words in news articles by writing things
8562 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8563 this look nicer by running the article through the @kbd{W e}
8564 (@code{gnus-article-emphasize}) command.
8566 @vindex gnus-emphasis-alist
8567 How the emphasis is computed is controlled by the
8568 @code{gnus-emphasis-alist} variable. This is an alist where the first
8569 element is a regular expression to be matched. The second is a number
8570 that says what regular expression grouping is used to find the entire
8571 emphasized word. The third is a number that says what regexp grouping
8572 should be displayed and highlighted. (The text between these two
8573 groupings will be hidden.) The fourth is the face used for
8577 (setq gnus-emphasis-alist
8578 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8579 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8588 @vindex gnus-emphasis-underline
8589 @vindex gnus-emphasis-bold
8590 @vindex gnus-emphasis-italic
8591 @vindex gnus-emphasis-underline-bold
8592 @vindex gnus-emphasis-underline-italic
8593 @vindex gnus-emphasis-bold-italic
8594 @vindex gnus-emphasis-underline-bold-italic
8595 By default, there are seven rules, and they use the following faces:
8596 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8597 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8598 @code{gnus-emphasis-underline-italic},
8599 @code{gnus-emphasis-underline-bold}, and
8600 @code{gnus-emphasis-underline-bold-italic}.
8602 If you want to change these faces, you can either use @kbd{M-x
8603 customize}, or you can use @code{copy-face}. For instance, if you want
8604 to make @code{gnus-emphasis-italic} use a red face instead, you could
8608 (copy-face 'red 'gnus-emphasis-italic)
8611 @vindex gnus-group-highlight-words-alist
8613 If you want to highlight arbitrary words, you can use the
8614 @code{gnus-group-highlight-words-alist} variable, which uses the same
8615 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8616 parameter (@pxref{Group Parameters}) can also be used.
8618 @xref{Customizing Articles}, for how to fontize articles automatically.
8621 @node Article Hiding
8622 @subsection Article Hiding
8623 @cindex article hiding
8625 Or rather, hiding certain things in each article. There usually is much
8626 too much cruft in most articles.
8631 @kindex W W a (Summary)
8632 @findex gnus-article-hide
8633 Do quite a lot of hiding on the article buffer
8634 (@kbd{gnus-article-hide}). In particular, this function will hide
8635 headers, @acronym{PGP}, cited text and the signature.
8638 @kindex W W h (Summary)
8639 @findex gnus-article-hide-headers
8640 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8644 @kindex W W b (Summary)
8645 @findex gnus-article-hide-boring-headers
8646 Hide headers that aren't particularly interesting
8647 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8650 @kindex W W s (Summary)
8651 @findex gnus-article-hide-signature
8652 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8656 @kindex W W l (Summary)
8657 @findex gnus-article-hide-list-identifiers
8658 @vindex gnus-list-identifiers
8659 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8660 are strings some mailing list servers add to the beginning of all
8661 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8662 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8663 may not contain @code{\\(..\\)}.
8667 @item gnus-list-identifiers
8668 @vindex gnus-list-identifiers
8669 A regular expression that matches list identifiers to be removed from
8670 subject. This can also be a list of regular expressions.
8675 @kindex W W P (Summary)
8676 @findex gnus-article-hide-pem
8677 Hide @acronym{PEM} (privacy enhanced messages) cruft
8678 (@code{gnus-article-hide-pem}).
8681 @kindex W W B (Summary)
8682 @findex gnus-article-strip-banner
8683 @vindex gnus-article-banner-alist
8684 @vindex gnus-article-address-banner-alist
8687 @cindex stripping advertisements
8688 @cindex advertisements
8689 Strip the banner specified by the @code{banner} group parameter
8690 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8691 annoying banners and/or signatures that some mailing lists and moderated
8692 groups adds to all the messages. The way to use this function is to add
8693 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8694 group you want banners stripped from. The parameter either be a string,
8695 which will be interpreted as a regular expression matching text to be
8696 removed, or the symbol @code{signature}, meaning that the (last)
8697 signature should be removed, or other symbol, meaning that the
8698 corresponding regular expression in @code{gnus-article-banner-alist} is
8701 Regardless of a group, you can hide things like advertisements only when
8702 the sender of an article has a certain mail address specified in
8703 @code{gnus-article-address-banner-alist}.
8707 @item gnus-article-address-banner-alist
8708 @vindex gnus-article-address-banner-alist
8709 Alist of mail addresses and banners. Each element has the form
8710 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8711 matching a mail address in the From header, @var{banner} is one of a
8712 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8713 a regexp and @code{nil}. If @var{address} matches author's mail
8714 address, it will remove things like advertisements. For example, if a
8715 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8716 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8717 sends, you can use the following element to remove them:
8720 ("@@yoo-hoo\\.co\\.jp\\'" .
8721 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8727 @kindex W W c (Summary)
8728 @findex gnus-article-hide-citation
8729 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8730 customizing the hiding:
8734 @item gnus-cited-opened-text-button-line-format
8735 @itemx gnus-cited-closed-text-button-line-format
8736 @vindex gnus-cited-closed-text-button-line-format
8737 @vindex gnus-cited-opened-text-button-line-format
8738 Gnus adds buttons to show where the cited text has been hidden, and to
8739 allow toggle hiding the text. The format of the variable is specified
8740 by these format-like variable (@pxref{Formatting Variables}). These
8745 Starting point of the hidden text.
8747 Ending point of the hidden text.
8749 Number of characters in the hidden region.
8751 Number of lines of hidden text.
8754 @item gnus-cited-lines-visible
8755 @vindex gnus-cited-lines-visible
8756 The number of lines at the beginning of the cited text to leave
8757 shown. This can also be a cons cell with the number of lines at the top
8758 and bottom of the text, respectively, to remain visible.
8763 @kindex W W C-c (Summary)
8764 @findex gnus-article-hide-citation-maybe
8766 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8767 following two variables:
8770 @item gnus-cite-hide-percentage
8771 @vindex gnus-cite-hide-percentage
8772 If the cited text is of a bigger percentage than this variable (default
8773 50), hide the cited text.
8775 @item gnus-cite-hide-absolute
8776 @vindex gnus-cite-hide-absolute
8777 The cited text must have at least this length (default 10) before it
8782 @kindex W W C (Summary)
8783 @findex gnus-article-hide-citation-in-followups
8784 Hide cited text in articles that aren't roots
8785 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8786 useful as an interactive command, but might be a handy function to stick
8787 have happen automatically (@pxref{Customizing Articles}).
8791 All these ``hiding'' commands are toggles, but if you give a negative
8792 prefix to these commands, they will show what they have previously
8793 hidden. If you give a positive prefix, they will always hide.
8795 Also @pxref{Article Highlighting} for further variables for
8796 citation customization.
8798 @xref{Customizing Articles}, for how to hide article elements
8802 @node Article Washing
8803 @subsection Article Washing
8805 @cindex article washing
8807 We call this ``article washing'' for a really good reason. Namely, the
8808 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8810 @dfn{Washing} is defined by us as ``changing something from something to
8811 something else'', but normally results in something looking better.
8814 @xref{Customizing Articles}, if you want to change how Gnus displays
8815 articles by default.
8820 This is not really washing, it's sort of the opposite of washing. If
8821 you type this, you see the article exactly as it exists on disk or on
8825 Force redisplaying of the current article
8826 (@code{gnus-summary-show-article}). This is also not really washing.
8827 If you type this, you see the article without any previously applied
8828 interactive Washing functions but with all default treatments
8829 (@pxref{Customizing Articles}).
8832 @kindex W l (Summary)
8833 @findex gnus-summary-stop-page-breaking
8834 Remove page breaks from the current article
8835 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8839 @kindex W r (Summary)
8840 @findex gnus-summary-caesar-message
8841 @c @icon{gnus-summary-caesar-message}
8842 Do a Caesar rotate (rot13) on the article buffer
8843 (@code{gnus-summary-caesar-message}).
8844 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8845 (Typically offensive jokes and such.)
8847 It's commonly called ``rot13'' because each letter is rotated 13
8848 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8849 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8850 is rumored to have employed this form of, uh, somewhat weak encryption.
8853 @kindex W m (Summary)
8854 @findex gnus-summary-morse-message
8855 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8858 @kindex W i (Summary)
8859 @findex gnus-summary-idna-message
8860 Decode IDNA encoded domain names in the current articles. IDNA
8861 encoded domain names looks like @samp{xn--bar}. If a string remain
8862 unencoded after running invoking this, it is likely an invalid IDNA
8863 string (@samp{xn--bar} is invalid). You must have GNU Libidn
8864 (@url{http://www.gnu.org/software/libidn/}) installed for this command
8869 @kindex W t (Summary)
8871 @findex gnus-summary-toggle-header
8872 Toggle whether to display all headers in the article buffer
8873 (@code{gnus-summary-toggle-header}).
8876 @kindex W v (Summary)
8877 @findex gnus-summary-verbose-headers
8878 Toggle whether to display all headers in the article buffer permanently
8879 (@code{gnus-summary-verbose-headers}).
8882 @kindex W o (Summary)
8883 @findex gnus-article-treat-overstrike
8884 Treat overstrike (@code{gnus-article-treat-overstrike}).
8887 @kindex W d (Summary)
8888 @findex gnus-article-treat-dumbquotes
8889 @vindex gnus-article-dumbquotes-map
8891 @cindex M****s*** sm*rtq**t*s
8893 Treat M****s*** sm*rtq**t*s according to
8894 @code{gnus-article-dumbquotes-map}
8895 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8896 whether a character is a sm*rtq**t* or not, so it should only be used
8899 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8900 an attempt to provide more quoting characters. If you see something
8901 like @code{\222} or @code{\264} where you're expecting some kind of
8902 apostrophe or quotation mark, then try this wash.
8905 @kindex W Y f (Summary)
8906 @findex gnus-article-outlook-deuglify-article
8907 @cindex Outlook Express
8908 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8909 unwrap lines, repair attribution and rearrange citation.
8910 (@code{gnus-article-outlook-deuglify-article}).
8913 @kindex W Y u (Summary)
8914 @findex gnus-article-outlook-unwrap-lines
8915 @vindex gnus-outlook-deuglify-unwrap-min
8916 @vindex gnus-outlook-deuglify-unwrap-max
8917 Unwrap lines that appear to be wrapped citation lines. You can control
8918 what lines will be unwrapped by frobbing
8919 @code{gnus-outlook-deuglify-unwrap-min} and
8920 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8921 maximum length of an unwrapped citation line.
8922 (@code{gnus-article-outlook-unwrap-lines}).
8925 @kindex W Y a (Summary)
8926 @findex gnus-article-outlook-repair-attribution
8927 Repair a broken attribution line.@*
8928 (@code{gnus-article-outlook-repair-attribution}).
8931 @kindex W Y c (Summary)
8932 @findex gnus-article-outlook-rearrange-citation
8933 Repair broken citations by rearranging the text.
8934 (@code{gnus-article-outlook-rearrange-citation}).
8937 @kindex W w (Summary)
8938 @findex gnus-article-fill-cited-article
8939 Do word wrap (@code{gnus-article-fill-cited-article}).
8941 You can give the command a numerical prefix to specify the width to use
8945 @kindex W Q (Summary)
8946 @findex gnus-article-fill-long-lines
8947 Fill long lines (@code{gnus-article-fill-long-lines}).
8950 @kindex W C (Summary)
8951 @findex gnus-article-capitalize-sentences
8952 Capitalize the first word in each sentence
8953 (@code{gnus-article-capitalize-sentences}).
8956 @kindex W c (Summary)
8957 @findex gnus-article-remove-cr
8958 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8959 (this takes care of DOS line endings), and then translate any remaining
8960 CRs into LF (this takes care of Mac line endings)
8961 (@code{gnus-article-remove-cr}).
8964 @kindex W q (Summary)
8965 @findex gnus-article-de-quoted-unreadable
8966 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8967 Quoted-Printable is one common @acronym{MIME} encoding employed when
8968 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8969 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
8970 which doesn't look very readable to me. Note that this is usually
8971 done automatically by Gnus if the message in question has a
8972 @code{Content-Transfer-Encoding} header that says that this encoding
8973 has been done. If a prefix is given, a charset will be asked for.
8976 @kindex W 6 (Summary)
8977 @findex gnus-article-de-base64-unreadable
8978 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8979 one common @acronym{MIME} encoding employed when sending
8980 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8981 usually done automatically by Gnus if the message in question has a
8982 @code{Content-Transfer-Encoding} header that says that this encoding
8983 has been done. If a prefix is given, a charset will be asked for.
8986 @kindex W Z (Summary)
8987 @findex gnus-article-decode-HZ
8988 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8989 common encoding employed when sending Chinese articles. It typically
8990 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8993 @kindex W A (Summary)
8994 @findex gnus-article-treat-ansi-sequences
8995 @cindex @acronym{ANSI} control sequences
8996 Translate @acronym{ANSI} SGR control sequences into overlays or
8997 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
8998 sequences are used in some Chinese hierarchies for highlighting.
9001 @kindex W u (Summary)
9002 @findex gnus-article-unsplit-urls
9003 Remove newlines from within URLs. Some mailers insert newlines into
9004 outgoing email messages to keep lines short. This reformatting can
9005 split long URLs onto multiple lines. Repair those URLs by removing
9006 the newlines (@code{gnus-article-unsplit-urls}).
9009 @kindex W h (Summary)
9010 @findex gnus-article-wash-html
9011 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
9012 usually done automatically by Gnus if the message in question has a
9013 @code{Content-Type} header that says that the message is @acronym{HTML}.
9015 If a prefix is given, a charset will be asked for. If it is a number,
9016 the charset defined in @code{gnus-summary-show-article-charset-alist}
9017 (@pxref{Paging the Article}) will be used.
9019 @vindex gnus-article-wash-function
9020 The default is to use the function specified by
9021 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
9022 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
9023 @acronym{HTML}, but this is controlled by the
9024 @code{gnus-article-wash-function} variable. Pre-defined functions you
9032 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
9034 @item w3m-standalone
9035 Use @uref{http://w3m.sourceforge.net/, w3m}.
9038 Use @uref{http://links.sf.net/, Links}.
9041 Use @uref{http://lynx.isc.org/, Lynx}.
9044 Use html2text---a simple @acronym{HTML} converter included with Gnus.
9049 @kindex W b (Summary)
9050 @findex gnus-article-add-buttons
9051 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
9052 @xref{Article Buttons}.
9055 @kindex W B (Summary)
9056 @findex gnus-article-add-buttons-to-head
9057 Add clickable buttons to the article headers
9058 (@code{gnus-article-add-buttons-to-head}).
9061 @kindex W p (Summary)
9062 @findex gnus-article-verify-x-pgp-sig
9063 Verify a signed control message
9064 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
9065 @code{newgroup} and @code{checkgroups} are usually signed by the
9066 hierarchy maintainer. You need to add the @acronym{PGP} public key of
9067 the maintainer to your keyring to verify the
9068 message.@footnote{@acronym{PGP} keys for many hierarchies are
9069 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
9072 @kindex W s (Summary)
9073 @findex gnus-summary-force-verify-and-decrypt
9074 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
9075 @acronym{S/MIME}) message
9076 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
9079 @kindex W a (Summary)
9080 @findex gnus-article-strip-headers-in-body
9081 Strip headers like the @code{X-No-Archive} header from the beginning of
9082 article bodies (@code{gnus-article-strip-headers-in-body}).
9085 @kindex W E l (Summary)
9086 @findex gnus-article-strip-leading-blank-lines
9087 Remove all blank lines from the beginning of the article
9088 (@code{gnus-article-strip-leading-blank-lines}).
9091 @kindex W E m (Summary)
9092 @findex gnus-article-strip-multiple-blank-lines
9093 Replace all blank lines with empty lines and then all multiple empty
9094 lines with a single empty line.
9095 (@code{gnus-article-strip-multiple-blank-lines}).
9098 @kindex W E t (Summary)
9099 @findex gnus-article-remove-trailing-blank-lines
9100 Remove all blank lines at the end of the article
9101 (@code{gnus-article-remove-trailing-blank-lines}).
9104 @kindex W E a (Summary)
9105 @findex gnus-article-strip-blank-lines
9106 Do all the three commands above
9107 (@code{gnus-article-strip-blank-lines}).
9110 @kindex W E A (Summary)
9111 @findex gnus-article-strip-all-blank-lines
9112 Remove all blank lines
9113 (@code{gnus-article-strip-all-blank-lines}).
9116 @kindex W E s (Summary)
9117 @findex gnus-article-strip-leading-space
9118 Remove all white space from the beginning of all lines of the article
9119 body (@code{gnus-article-strip-leading-space}).
9122 @kindex W E e (Summary)
9123 @findex gnus-article-strip-trailing-space
9124 Remove all white space from the end of all lines of the article
9125 body (@code{gnus-article-strip-trailing-space}).
9129 @xref{Customizing Articles}, for how to wash articles automatically.
9132 @node Article Header
9133 @subsection Article Header
9135 These commands perform various transformations of article header.
9140 @kindex W G u (Summary)
9141 @findex gnus-article-treat-unfold-headers
9142 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
9145 @kindex W G n (Summary)
9146 @findex gnus-article-treat-fold-newsgroups
9147 Fold the @code{Newsgroups} and @code{Followup-To} headers
9148 (@code{gnus-article-treat-fold-newsgroups}).
9151 @kindex W G f (Summary)
9152 @findex gnus-article-treat-fold-headers
9153 Fold all the message headers
9154 (@code{gnus-article-treat-fold-headers}).
9157 @kindex W E w (Summary)
9158 @findex gnus-article-remove-leading-whitespace
9159 Remove excessive whitespace from all headers
9160 (@code{gnus-article-remove-leading-whitespace}).
9165 @node Article Buttons
9166 @subsection Article Buttons
9169 People often include references to other stuff in articles, and it would
9170 be nice if Gnus could just fetch whatever it is that people talk about
9171 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
9172 button on these references.
9174 @vindex gnus-button-man-handler
9175 Gnus adds @dfn{buttons} to certain standard references by default:
9176 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
9177 Emacs or Gnus related references. This is controlled by two variables,
9178 one that handles article bodies and one that handles article heads:
9182 @item gnus-button-alist
9183 @vindex gnus-button-alist
9184 This is an alist where each entry has this form:
9187 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9193 All text that match this regular expression (case insensitive) will be
9194 considered an external reference. Here's a typical regexp that matches
9195 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
9196 variable containing a regexp, useful variables to use include
9197 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
9200 Gnus has to know which parts of the matches is to be highlighted. This
9201 is a number that says what sub-expression of the regexp is to be
9202 highlighted. If you want it all highlighted, you use 0 here.
9205 This form will be @code{eval}ed, and if the result is non-@code{nil},
9206 this is considered a match. This is useful if you want extra sifting to
9207 avoid false matches. Often variables named
9208 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
9209 Levels}, but any other form may be used too.
9211 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
9214 This function will be called when you click on this button.
9217 As with @var{button-par}, this is a sub-expression number, but this one
9218 says which part of the match is to be sent as data to @var{function}.
9222 So the full entry for buttonizing URLs is then
9225 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
9228 @item gnus-header-button-alist
9229 @vindex gnus-header-button-alist
9230 This is just like the other alist, except that it is applied to the
9231 article head only, and that each entry has an additional element that is
9232 used to say what headers to apply the buttonize coding to:
9235 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9238 @var{header} is a regular expression.
9241 @subsubsection Related variables and functions
9244 @item gnus-button-@var{*}-level
9245 @xref{Article Button Levels}.
9247 @c Stuff related to gnus-button-browse-level
9249 @item gnus-button-url-regexp
9250 @vindex gnus-button-url-regexp
9251 A regular expression that matches embedded URLs. It is used in the
9252 default values of the variables above.
9254 @c Stuff related to gnus-button-man-level
9256 @item gnus-button-man-handler
9257 @vindex gnus-button-man-handler
9258 The function to use for displaying man pages. It must take at least one
9259 argument with a string naming the man page.
9261 @c Stuff related to gnus-button-message-level
9263 @item gnus-button-mid-or-mail-regexp
9264 @vindex gnus-button-mid-or-mail-regexp
9265 Regular expression that matches a message ID or a mail address.
9267 @item gnus-button-prefer-mid-or-mail
9268 @vindex gnus-button-prefer-mid-or-mail
9269 This variable determines what to do when the button on a string as
9270 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
9271 message ID or a mail address. If it is one of the symbols @code{mid} or
9272 @code{mail}, Gnus will always assume that the string is a message ID or
9273 a mail address, respectively. If this variable is set to the symbol
9274 @code{ask}, always query the user what to do. If it is a function, this
9275 function will be called with the string as its only argument. The
9276 function must return @code{mid}, @code{mail}, @code{invalid} or
9277 @code{ask}. The default value is the function
9278 @code{gnus-button-mid-or-mail-heuristic}.
9280 @item gnus-button-mid-or-mail-heuristic
9281 @findex gnus-button-mid-or-mail-heuristic
9282 Function that guesses whether its argument is a message ID or a mail
9283 address. Returns @code{mid} if it's a message IDs, @code{mail} if
9284 it's a mail address, @code{ask} if unsure and @code{invalid} if the
9287 @item gnus-button-mid-or-mail-heuristic-alist
9288 @vindex gnus-button-mid-or-mail-heuristic-alist
9289 An alist of @code{(RATE . REGEXP)} pairs used by the function
9290 @code{gnus-button-mid-or-mail-heuristic}.
9292 @c Stuff related to gnus-button-tex-level
9294 @item gnus-button-ctan-handler
9295 @findex gnus-button-ctan-handler
9296 The function to use for displaying CTAN links. It must take one
9297 argument, the string naming the URL.
9300 @vindex gnus-ctan-url
9301 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
9302 by @code{gnus-button-ctan-handler}.
9306 @item gnus-article-button-face
9307 @vindex gnus-article-button-face
9308 Face used on buttons.
9310 @item gnus-article-mouse-face
9311 @vindex gnus-article-mouse-face
9312 Face used when the mouse cursor is over a button.
9316 @xref{Customizing Articles}, for how to buttonize articles automatically.
9319 @node Article Button Levels
9320 @subsection Article button levels
9321 @cindex button levels
9322 The higher the value of the variables @code{gnus-button-@var{*}-level},
9323 the more buttons will appear. If the level is zero, no corresponding
9324 buttons are displayed. With the default value (which is 5) you should
9325 already see quite a lot of buttons. With higher levels, you will see
9326 more buttons, but you may also get more false positives. To avoid them,
9327 you can set the variables @code{gnus-button-@var{*}-level} local to
9328 specific groups (@pxref{Group Parameters}). Here's an example for the
9329 variable @code{gnus-parameters}:
9332 ;; @r{increase @code{gnus-button-*-level} in some groups:}
9333 (setq gnus-parameters
9334 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
9335 ("\\<unix\\>" (gnus-button-man-level 10))
9336 ("\\<tex\\>" (gnus-button-tex-level 10))))
9341 @item gnus-button-browse-level
9342 @vindex gnus-button-browse-level
9343 Controls the display of references to message IDs, mail addresses and
9344 news URLs. Related variables and functions include
9345 @code{gnus-button-url-regexp}, @code{browse-url}, and
9346 @code{browse-url-browser-function}.
9348 @item gnus-button-emacs-level
9349 @vindex gnus-button-emacs-level
9350 Controls the display of Emacs or Gnus references. Related functions are
9351 @code{gnus-button-handle-custom},
9352 @code{gnus-button-handle-describe-function},
9353 @code{gnus-button-handle-describe-variable},
9354 @code{gnus-button-handle-symbol},
9355 @code{gnus-button-handle-describe-key},
9356 @code{gnus-button-handle-apropos},
9357 @code{gnus-button-handle-apropos-command},
9358 @code{gnus-button-handle-apropos-variable},
9359 @code{gnus-button-handle-apropos-documentation}, and
9360 @code{gnus-button-handle-library}.
9362 @item gnus-button-man-level
9363 @vindex gnus-button-man-level
9364 Controls the display of references to (Unix) man pages.
9365 See @code{gnus-button-man-handler}.
9367 @item gnus-button-message-level
9368 @vindex gnus-button-message-level
9369 Controls the display of message IDs, mail addresses and news URLs.
9370 Related variables and functions include
9371 @code{gnus-button-mid-or-mail-regexp},
9372 @code{gnus-button-prefer-mid-or-mail},
9373 @code{gnus-button-mid-or-mail-heuristic}, and
9374 @code{gnus-button-mid-or-mail-heuristic-alist}.
9376 @item gnus-button-tex-level
9377 @vindex gnus-button-tex-level
9378 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
9379 URLs. See the variables @code{gnus-ctan-url},
9380 @code{gnus-button-ctan-handler},
9381 @code{gnus-button-ctan-directory-regexp}, and
9382 @code{gnus-button-handle-ctan-bogus-regexp}.
9388 @subsection Article Date
9390 The date is most likely generated in some obscure timezone you've never
9391 heard of, so it's quite nice to be able to find out what the time was
9392 when the article was sent.
9397 @kindex W T u (Summary)
9398 @findex gnus-article-date-ut
9399 Display the date in UT (aka. GMT, aka ZULU)
9400 (@code{gnus-article-date-ut}).
9403 @kindex W T i (Summary)
9404 @findex gnus-article-date-iso8601
9406 Display the date in international format, aka. ISO 8601
9407 (@code{gnus-article-date-iso8601}).
9410 @kindex W T l (Summary)
9411 @findex gnus-article-date-local
9412 Display the date in the local timezone (@code{gnus-article-date-local}).
9415 @kindex W T p (Summary)
9416 @findex gnus-article-date-english
9417 Display the date in a format that's easily pronounceable in English
9418 (@code{gnus-article-date-english}).
9421 @kindex W T s (Summary)
9422 @vindex gnus-article-time-format
9423 @findex gnus-article-date-user
9424 @findex format-time-string
9425 Display the date using a user-defined format
9426 (@code{gnus-article-date-user}). The format is specified by the
9427 @code{gnus-article-time-format} variable, and is a string that's passed
9428 to @code{format-time-string}. See the documentation of that variable
9429 for a list of possible format specs.
9432 @kindex W T e (Summary)
9433 @findex gnus-article-date-lapsed
9434 @findex gnus-start-date-timer
9435 @findex gnus-stop-date-timer
9436 Say how much time has elapsed between the article was posted and now
9437 (@code{gnus-article-date-lapsed}). It looks something like:
9440 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9443 @vindex gnus-article-date-lapsed-new-header
9444 The value of @code{gnus-article-date-lapsed-new-header} determines
9445 whether this header will just be added below the old Date one, or will
9448 An advantage of using Gnus to read mail is that it converts simple bugs
9449 into wonderful absurdities.
9451 If you want to have this line updated continually, you can put
9454 (gnus-start-date-timer)
9457 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9458 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9462 @kindex W T o (Summary)
9463 @findex gnus-article-date-original
9464 Display the original date (@code{gnus-article-date-original}). This can
9465 be useful if you normally use some other conversion function and are
9466 worried that it might be doing something totally wrong. Say, claiming
9467 that the article was posted in 1854. Although something like that is
9468 @emph{totally} impossible. Don't you trust me? *titter*
9472 @xref{Customizing Articles}, for how to display the date in your
9473 preferred format automatically.
9476 @node Article Display
9477 @subsection Article Display
9482 These commands add various frivolous display gimmicks to the article
9483 buffer in Emacs versions that support them.
9485 @code{X-Face} headers are small black-and-white images supplied by the
9486 message headers (@pxref{X-Face}).
9488 @code{Face} headers are small colored images supplied by the message
9489 headers (@pxref{Face}).
9491 Smileys are those little @samp{:-)} symbols that people like to litter
9492 their messages with (@pxref{Smileys}).
9494 Picons, on the other hand, reside on your own system, and Gnus will
9495 try to match the headers to what you have (@pxref{Picons}).
9497 All these functions are toggles---if the elements already exist,
9502 @kindex W D x (Summary)
9503 @findex gnus-article-display-x-face
9504 Display an @code{X-Face} in the @code{From} header.
9505 (@code{gnus-article-display-x-face}).
9508 @kindex W D d (Summary)
9509 @findex gnus-article-display-face
9510 Display a @code{Face} in the @code{From} header.
9511 (@code{gnus-article-display-face}).
9514 @kindex W D s (Summary)
9515 @findex gnus-treat-smiley
9516 Display smileys (@code{gnus-treat-smiley}).
9519 @kindex W D f (Summary)
9520 @findex gnus-treat-from-picon
9521 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9524 @kindex W D m (Summary)
9525 @findex gnus-treat-mail-picon
9526 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9527 (@code{gnus-treat-mail-picon}).
9530 @kindex W D n (Summary)
9531 @findex gnus-treat-newsgroups-picon
9532 Piconify all news headers (i. e., @code{Newsgroups} and
9533 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9536 @kindex W D D (Summary)
9537 @findex gnus-article-remove-images
9538 Remove all images from the article buffer
9539 (@code{gnus-article-remove-images}).
9545 @node Article Signature
9546 @subsection Article Signature
9548 @cindex article signature
9550 @vindex gnus-signature-separator
9551 Each article is divided into two parts---the head and the body. The
9552 body can be divided into a signature part and a text part. The variable
9553 that says what is to be considered a signature is
9554 @code{gnus-signature-separator}. This is normally the standard
9555 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9556 non-standard signature separators, so this variable can also be a list
9557 of regular expressions to be tested, one by one. (Searches are done
9558 from the end of the body towards the beginning.) One likely value is:
9561 (setq gnus-signature-separator
9562 '("^-- $" ; @r{The standard}
9563 "^-- *$" ; @r{A common mangling}
9564 "^-------*$" ; @r{Many people just use a looong}
9565 ; @r{line of dashes. Shame!}
9566 "^ *--------*$" ; @r{Double-shame!}
9567 "^________*$" ; @r{Underscores are also popular}
9568 "^========*$")) ; @r{Pervert!}
9571 The more permissive you are, the more likely it is that you'll get false
9574 @vindex gnus-signature-limit
9575 @code{gnus-signature-limit} provides a limit to what is considered a
9576 signature when displaying articles.
9580 If it is an integer, no signature may be longer (in characters) than
9583 If it is a floating point number, no signature may be longer (in lines)
9586 If it is a function, the function will be called without any parameters,
9587 and if it returns @code{nil}, there is no signature in the buffer.
9589 If it is a string, it will be used as a regexp. If it matches, the text
9590 in question is not a signature.
9593 This variable can also be a list where the elements may be of the types
9594 listed above. Here's an example:
9597 (setq gnus-signature-limit
9598 '(200.0 "^---*Forwarded article"))
9601 This means that if there are more than 200 lines after the signature
9602 separator, or the text after the signature separator is matched by
9603 the regular expression @samp{^---*Forwarded article}, then it isn't a
9604 signature after all.
9607 @node Article Miscellanea
9608 @subsection Article Miscellanea
9612 @kindex A t (Summary)
9613 @findex gnus-article-babel
9614 Translate the article from one language to another
9615 (@code{gnus-article-babel}).
9621 @section MIME Commands
9622 @cindex MIME decoding
9624 @cindex viewing attachments
9626 The following commands all understand the numerical prefix. For
9627 instance, @kbd{3 K v} means ``view the third @acronym{MIME} part''.
9633 @kindex K v (Summary)
9634 View the @acronym{MIME} part.
9637 @kindex K o (Summary)
9638 Save the @acronym{MIME} part.
9641 @kindex K O (Summary)
9642 Prompt for a file name, then save the @acronym{MIME} part and strip it
9643 from the article. The stripped @acronym{MIME} object will be referred
9644 via the message/external-body @acronym{MIME} type.
9647 @kindex K r (Summary)
9648 Replace the @acronym{MIME} part with an external body.
9651 @kindex K d (Summary)
9652 Delete the @acronym{MIME} part and add some information about the
9656 @kindex K c (Summary)
9657 Copy the @acronym{MIME} part.
9660 @kindex K e (Summary)
9661 View the @acronym{MIME} part externally.
9664 @kindex K i (Summary)
9665 View the @acronym{MIME} part internally.
9668 @kindex K | (Summary)
9669 Pipe the @acronym{MIME} part to an external command.
9672 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9677 @kindex K b (Summary)
9678 Make all the @acronym{MIME} parts have buttons in front of them. This is
9679 mostly useful if you wish to save (or perform other actions) on inlined
9683 @kindex K m (Summary)
9684 @findex gnus-summary-repair-multipart
9685 Some multipart messages are transmitted with missing or faulty headers.
9686 This command will attempt to ``repair'' these messages so that they can
9687 be viewed in a more pleasant manner
9688 (@code{gnus-summary-repair-multipart}).
9691 @kindex X m (Summary)
9692 @findex gnus-summary-save-parts
9693 Save all parts matching a @acronym{MIME} type to a directory
9694 (@code{gnus-summary-save-parts}). Understands the process/prefix
9695 convention (@pxref{Process/Prefix}).
9698 @kindex M-t (Summary)
9699 @findex gnus-summary-toggle-display-buttonized
9700 Toggle the buttonized display of the article buffer
9701 (@code{gnus-summary-toggle-display-buttonized}).
9704 @kindex W M w (Summary)
9705 @findex gnus-article-decode-mime-words
9706 Decode RFC 2047-encoded words in the article headers
9707 (@code{gnus-article-decode-mime-words}).
9710 @kindex W M c (Summary)
9711 @findex gnus-article-decode-charset
9712 Decode encoded article bodies as well as charsets
9713 (@code{gnus-article-decode-charset}).
9715 This command looks in the @code{Content-Type} header to determine the
9716 charset. If there is no such header in the article, you can give it a
9717 prefix, which will prompt for the charset to decode as. In regional
9718 groups where people post using some common encoding (but do not
9719 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9720 parameter to the required charset (@pxref{Group Parameters}).
9723 @kindex W M v (Summary)
9724 @findex gnus-mime-view-all-parts
9725 View all the @acronym{MIME} parts in the current article
9726 (@code{gnus-mime-view-all-parts}).
9733 @item gnus-ignored-mime-types
9734 @vindex gnus-ignored-mime-types
9735 This is a list of regexps. @acronym{MIME} types that match a regexp from
9736 this list will be completely ignored by Gnus. The default value is
9739 To have all Vcards be ignored, you'd say something like this:
9742 (setq gnus-ignored-mime-types
9746 @item gnus-article-loose-mime
9747 @vindex gnus-article-loose-mime
9748 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9749 before interpreting the message as a @acronym{MIME} message. This helps
9750 when reading messages from certain broken mail user agents. The
9751 default is @code{t}.
9753 @item gnus-article-emulate-mime
9754 @vindex gnus-article-emulate-mime
9757 There are other, non-@acronym{MIME} encoding methods used. The most common
9758 is @samp{uuencode}, but yEncode is also getting to be popular. If
9759 this variable is non-@code{nil}, Gnus will look in message bodies to
9760 see if it finds these encodings, and if so, it'll run them through the
9761 Gnus @acronym{MIME} machinery. The default is @code{t}. Only
9762 single-part yEnc encoded attachments can be decoded. There's no support
9763 for encoding in Gnus.
9765 @item gnus-unbuttonized-mime-types
9766 @vindex gnus-unbuttonized-mime-types
9767 This is a list of regexps. @acronym{MIME} types that match a regexp from
9768 this list won't have @acronym{MIME} buttons inserted unless they aren't
9769 displayed or this variable is overridden by
9770 @code{gnus-buttonized-mime-types}. The default value is
9771 @code{(".*/.*")}. This variable is only used when
9772 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9774 @item gnus-buttonized-mime-types
9775 @vindex gnus-buttonized-mime-types
9776 This is a list of regexps. @acronym{MIME} types that match a regexp from
9777 this list will have @acronym{MIME} buttons inserted unless they aren't
9778 displayed. This variable overrides
9779 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9780 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9783 To see e.g. security buttons but no other buttons, you could set this
9784 variable to @code{("multipart/signed")} and leave
9785 @code{gnus-unbuttonized-mime-types} at the default value.
9787 You could also add @code{"multipart/alternative"} to this list to
9788 display radio buttons that allow you to choose one of two media types
9789 those mails include. See also @code{mm-discouraged-alternatives}
9790 (@pxref{Display Customization, ,Display Customization, emacs-mime, The
9791 Emacs MIME Manual}).
9793 @item gnus-inhibit-mime-unbuttonizing
9794 @vindex gnus-inhibit-mime-unbuttonizing
9795 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9796 default value is @code{nil}.
9798 @item gnus-article-mime-part-function
9799 @vindex gnus-article-mime-part-function
9800 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9801 handle as the parameter. The function is meant to be used to allow
9802 users to gather information from the article (e. g., add Vcard info to
9803 the bbdb database) or to do actions based on parts (e. g., automatically
9804 save all jpegs into some directory).
9806 Here's an example function the does the latter:
9809 (defun my-save-all-jpeg-parts (handle)
9810 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9812 (insert (mm-get-part handle))
9813 (write-region (point-min) (point-max)
9814 (read-file-name "Save jpeg to: ")))))
9815 (setq gnus-article-mime-part-function
9816 'my-save-all-jpeg-parts)
9819 @vindex gnus-mime-multipart-functions
9820 @item gnus-mime-multipart-functions
9821 Alist of @acronym{MIME} multipart types and functions to handle them.
9823 @vindex gnus-mime-display-multipart-alternative-as-mixed
9824 @item gnus-mime-display-multipart-alternative-as-mixed
9825 Display "multipart/alternative" parts as "multipart/mixed".
9827 @vindex gnus-mime-display-multipart-related-as-mixed
9828 @item gnus-mime-display-multipart-related-as-mixed
9829 Display "multipart/related" parts as "multipart/mixed".
9831 If displaying "text/html" is discouraged, see
9832 @code{mm-discouraged-alternatives}, images or other material inside a
9833 "multipart/related" part might be overlooked when this variable is
9834 @code{nil}. @ref{Display Customization, Display Customization, ,
9835 emacs-mime, Emacs-Mime Manual}.
9837 @vindex gnus-mime-display-multipart-as-mixed
9838 @item gnus-mime-display-multipart-as-mixed
9839 Display "multipart" parts as "multipart/mixed". If @code{t}, it
9840 overrides @code{nil} values of
9841 @code{gnus-mime-display-multipart-alternative-as-mixed} and
9842 @code{gnus-mime-display-multipart-related-as-mixed}.
9844 @vindex mm-file-name-rewrite-functions
9845 @item mm-file-name-rewrite-functions
9846 List of functions used for rewriting file names of @acronym{MIME} parts.
9847 Each function takes a file name as input and returns a file name.
9849 Ready-made functions include@*
9850 @code{mm-file-name-delete-whitespace},
9851 @code{mm-file-name-trim-whitespace},
9852 @code{mm-file-name-collapse-whitespace}, and
9853 @code{mm-file-name-replace-whitespace}. The later uses the value of
9854 the variable @code{mm-file-name-replace-whitespace} to replace each
9855 whitespace character in a file name with that string; default value
9856 is @code{"_"} (a single underscore).
9857 @findex mm-file-name-delete-whitespace
9858 @findex mm-file-name-trim-whitespace
9859 @findex mm-file-name-collapse-whitespace
9860 @findex mm-file-name-replace-whitespace
9861 @vindex mm-file-name-replace-whitespace
9863 The standard functions @code{capitalize}, @code{downcase},
9864 @code{upcase}, and @code{upcase-initials} may be useful, too.
9866 Everybody knows that whitespace characters in file names are evil,
9867 except those who don't know. If you receive lots of attachments from
9868 such unenlightened users, you can make live easier by adding
9871 (setq mm-file-name-rewrite-functions
9872 '(mm-file-name-trim-whitespace
9873 mm-file-name-collapse-whitespace
9874 mm-file-name-replace-whitespace))
9878 to your @file{~/.gnus.el} file.
9887 People use different charsets, and we have @acronym{MIME} to let us know what
9888 charsets they use. Or rather, we wish we had. Many people use
9889 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9890 just send out messages without saying what character sets they use. To
9891 help a bit with this, some local news hierarchies have policies that say
9892 what character set is the default. For instance, the @samp{fj}
9893 hierarchy uses @code{iso-2022-jp}.
9895 @vindex gnus-group-charset-alist
9896 This knowledge is encoded in the @code{gnus-group-charset-alist}
9897 variable, which is an alist of regexps (use the first item to match full
9898 group names) and default charsets to be used when reading these groups.
9900 @vindex gnus-newsgroup-ignored-charsets
9901 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9902 aren't. These blithely mark messages as being in @code{iso-8859-1}
9903 even if they really are in @code{koi-8}. To help here, the
9904 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9905 charsets that are listed here will be ignored. The variable can be
9906 set on a group-by-group basis using the group parameters (@pxref{Group
9907 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9908 which includes values some agents insist on having in there.
9910 @vindex gnus-group-posting-charset-alist
9911 When posting, @code{gnus-group-posting-charset-alist} is used to
9912 determine which charsets should not be encoded using the @acronym{MIME}
9913 encodings. For instance, some hierarchies discourage using
9914 quoted-printable header encoding.
9916 This variable is an alist of regexps and permitted unencoded charsets
9917 for posting. Each element of the alist has the form @code{(}@var{test
9918 header body-list}@code{)}, where:
9922 is either a regular expression matching the newsgroup header or a
9925 is the charset which may be left unencoded in the header (@code{nil}
9926 means encode all charsets),
9928 is a list of charsets which may be encoded using 8bit content-transfer
9929 encoding in the body, or one of the special values @code{nil} (always
9930 encode using quoted-printable) or @code{t} (always use 8bit).
9937 @cindex coding system aliases
9938 @cindex preferred charset
9940 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
9941 The Emacs MIME Manual}, for additional variables that control which
9942 MIME charsets are used when sending messages.
9944 Other charset tricks that may be useful, although not Gnus-specific:
9946 If there are several @acronym{MIME} charsets that encode the same Emacs
9947 charset, you can choose what charset to use by saying the following:
9950 (put-charset-property 'cyrillic-iso8859-5
9951 'preferred-coding-system 'koi8-r)
9954 This means that Russian will be encoded using @code{koi8-r} instead of
9955 the default @code{iso-8859-5} @acronym{MIME} charset.
9957 If you want to read messages in @code{koi8-u}, you can cheat and say
9960 (define-coding-system-alias 'koi8-u 'koi8-r)
9963 This will almost do the right thing.
9965 And finally, to read charsets like @code{windows-1251}, you can say
9969 (codepage-setup 1251)
9970 (define-coding-system-alias 'windows-1251 'cp1251)
9974 @node Article Commands
9975 @section Article Commands
9982 @kindex A P (Summary)
9983 @vindex gnus-ps-print-hook
9984 @findex gnus-summary-print-article
9985 Generate and print a PostScript image of the article buffer
9986 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9987 be run just before printing the buffer. An alternative way to print
9988 article is to use Muttprint (@pxref{Saving Articles}).
9993 @node Summary Sorting
9994 @section Summary Sorting
9995 @cindex summary sorting
9997 You can have the summary buffer sorted in various ways, even though I
9998 can't really see why you'd want that.
10003 @kindex C-c C-s C-n (Summary)
10004 @findex gnus-summary-sort-by-number
10005 Sort by article number (@code{gnus-summary-sort-by-number}).
10008 @kindex C-c C-s C-a (Summary)
10009 @findex gnus-summary-sort-by-author
10010 Sort by author (@code{gnus-summary-sort-by-author}).
10013 @kindex C-c C-s C-t (Summary)
10014 @findex gnus-summary-sort-by-recipient
10015 Sort by recipient (@code{gnus-summary-sort-by-recipient}).
10018 @kindex C-c C-s C-s (Summary)
10019 @findex gnus-summary-sort-by-subject
10020 Sort by subject (@code{gnus-summary-sort-by-subject}).
10023 @kindex C-c C-s C-d (Summary)
10024 @findex gnus-summary-sort-by-date
10025 Sort by date (@code{gnus-summary-sort-by-date}).
10028 @kindex C-c C-s C-l (Summary)
10029 @findex gnus-summary-sort-by-lines
10030 Sort by lines (@code{gnus-summary-sort-by-lines}).
10033 @kindex C-c C-s C-c (Summary)
10034 @findex gnus-summary-sort-by-chars
10035 Sort by article length (@code{gnus-summary-sort-by-chars}).
10038 @kindex C-c C-s C-i (Summary)
10039 @findex gnus-summary-sort-by-score
10040 Sort by score (@code{gnus-summary-sort-by-score}).
10043 @kindex C-c C-s C-r (Summary)
10044 @findex gnus-summary-sort-by-random
10045 Randomize (@code{gnus-summary-sort-by-random}).
10048 @kindex C-c C-s C-o (Summary)
10049 @findex gnus-summary-sort-by-original
10050 Sort using the default sorting method
10051 (@code{gnus-summary-sort-by-original}).
10054 These functions will work both when you use threading and when you don't
10055 use threading. In the latter case, all summary lines will be sorted,
10056 line by line. In the former case, sorting will be done on a
10057 root-by-root basis, which might not be what you were looking for. To
10058 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
10062 @node Finding the Parent
10063 @section Finding the Parent
10064 @cindex parent articles
10065 @cindex referring articles
10069 @kindex ^ (Summary)
10070 @findex gnus-summary-refer-parent-article
10071 If you'd like to read the parent of the current article, and it is not
10072 displayed in the summary buffer, you might still be able to. That is,
10073 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
10074 and the @code{References} in the current article are not mangled, you
10075 can just press @kbd{^} or @kbd{A r}
10076 (@code{gnus-summary-refer-parent-article}). If everything goes well,
10077 you'll get the parent. If the parent is already displayed in the
10078 summary buffer, point will just move to this article.
10080 If given a positive numerical prefix, fetch that many articles back into
10081 the ancestry. If given a negative numerical prefix, fetch just that
10082 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
10083 grandparent and the grandgrandparent of the current article. If you say
10084 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
10087 @item A R (Summary)
10088 @findex gnus-summary-refer-references
10089 @kindex A R (Summary)
10090 Fetch all articles mentioned in the @code{References} header of the
10091 article (@code{gnus-summary-refer-references}).
10093 @item A T (Summary)
10094 @findex gnus-summary-refer-thread
10095 @kindex A T (Summary)
10096 Display the full thread where the current article appears
10097 (@code{gnus-summary-refer-thread}). This command has to fetch all the
10098 headers in the current group to work, so it usually takes a while. If
10099 you do it often, you may consider setting @code{gnus-fetch-old-headers}
10100 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
10101 visible effects normally, but it'll make this command work a whole lot
10102 faster. Of course, it'll make group entry somewhat slow.
10104 @vindex gnus-refer-thread-limit
10105 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
10106 articles before the first displayed in the current group) headers to
10107 fetch when doing this command. The default is 200. If @code{t}, all
10108 the available headers will be fetched. This variable can be overridden
10109 by giving the @kbd{A T} command a numerical prefix.
10111 @item M-^ (Summary)
10112 @findex gnus-summary-refer-article
10113 @kindex M-^ (Summary)
10115 @cindex fetching by Message-ID
10116 You can also ask Gnus for an arbitrary article, no matter what group it
10117 belongs to. @kbd{M-^} (@code{gnus-summary-refer-article}) will ask you
10118 for a @code{Message-ID}, which is one of those long, hard-to-read
10119 thingies that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.
10120 You have to get it all exactly right. No fuzzy searches, I'm afraid.
10122 Gnus looks for the @code{Message-ID} in the headers that have already
10123 been fetched, but also tries all the select methods specified by
10124 @code{gnus-refer-article-method} if it is not found.
10127 @vindex gnus-refer-article-method
10128 If the group you are reading is located on a back end that does not
10129 support fetching by @code{Message-ID} very well (like @code{nnspool}),
10130 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
10131 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
10132 updating the spool you are reading from, but that's not really
10135 It can also be a list of select methods, as well as the special symbol
10136 @code{current}, which means to use the current select method. If it
10137 is a list, Gnus will try all the methods in the list until it finds a
10140 Here's an example setting that will first try the current method, and
10141 then ask Google if that fails:
10144 (setq gnus-refer-article-method
10146 (nnweb "google" (nnweb-type google))))
10149 Most of the mail back ends support fetching by @code{Message-ID}, but
10150 do not do a particularly excellent job at it. That is, @code{nnmbox},
10151 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
10152 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
10153 only able to locate articles that have been posted to the current
10154 group. (Anything else would be too time consuming.) @code{nnmh} does
10155 not support this at all.
10158 @node Alternative Approaches
10159 @section Alternative Approaches
10161 Different people like to read news using different methods. This being
10162 Gnus, we offer a small selection of minor modes for the summary buffers.
10165 * Pick and Read:: First mark articles and then read them.
10166 * Binary Groups:: Auto-decode all articles.
10170 @node Pick and Read
10171 @subsection Pick and Read
10172 @cindex pick and read
10174 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
10175 a two-phased reading interface. The user first marks in a summary
10176 buffer the articles she wants to read. Then she starts reading the
10177 articles with just an article buffer displayed.
10179 @findex gnus-pick-mode
10180 @kindex M-x gnus-pick-mode
10181 Gnus provides a summary buffer minor mode that allows
10182 this---@code{gnus-pick-mode}. This basically means that a few process
10183 mark commands become one-keystroke commands to allow easy marking, and
10184 it provides one additional command for switching to the summary buffer.
10186 Here are the available keystrokes when using pick mode:
10191 @findex gnus-pick-article-or-thread
10192 Pick the article or thread on the current line
10193 (@code{gnus-pick-article-or-thread}). If the variable
10194 @code{gnus-thread-hide-subtree} is true, then this key selects the
10195 entire thread when used at the first article of the thread. Otherwise,
10196 it selects just the article. If given a numerical prefix, go to that
10197 thread or article and pick it. (The line number is normally displayed
10198 at the beginning of the summary pick lines.)
10201 @kindex SPACE (Pick)
10202 @findex gnus-pick-next-page
10203 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
10204 at the end of the buffer, start reading the picked articles.
10208 @findex gnus-pick-unmark-article-or-thread.
10209 Unpick the thread or article
10210 (@code{gnus-pick-unmark-article-or-thread}). If the variable
10211 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
10212 thread if used at the first article of the thread. Otherwise it unpicks
10213 just the article. You can give this key a numerical prefix to unpick
10214 the thread or article at that line.
10218 @findex gnus-pick-start-reading
10219 @vindex gnus-pick-display-summary
10220 Start reading the picked articles (@code{gnus-pick-start-reading}). If
10221 given a prefix, mark all unpicked articles as read first. If
10222 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
10223 will still be visible when you are reading.
10227 All the normal summary mode commands are still available in the
10228 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
10229 which is mapped to the same function
10230 @code{gnus-summary-tick-article-forward}.
10232 If this sounds like a good idea to you, you could say:
10235 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
10238 @vindex gnus-pick-mode-hook
10239 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
10241 @vindex gnus-mark-unpicked-articles-as-read
10242 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
10243 all unpicked articles as read. The default is @code{nil}.
10245 @vindex gnus-summary-pick-line-format
10246 The summary line format in pick mode is slightly different from the
10247 standard format. At the beginning of each line the line number is
10248 displayed. The pick mode line format is controlled by the
10249 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
10250 Variables}). It accepts the same format specs that
10251 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
10254 @node Binary Groups
10255 @subsection Binary Groups
10256 @cindex binary groups
10258 @findex gnus-binary-mode
10259 @kindex M-x gnus-binary-mode
10260 If you spend much time in binary groups, you may grow tired of hitting
10261 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
10262 is a minor mode for summary buffers that makes all ordinary Gnus article
10263 selection functions uudecode series of articles and display the result
10264 instead of just displaying the articles the normal way.
10267 @findex gnus-binary-show-article
10268 The only way, in fact, to see the actual articles is the @kbd{g}
10269 command, when you have turned on this mode
10270 (@code{gnus-binary-show-article}).
10272 @vindex gnus-binary-mode-hook
10273 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
10277 @section Tree Display
10280 @vindex gnus-use-trees
10281 If you don't like the normal Gnus summary display, you might try setting
10282 @code{gnus-use-trees} to @code{t}. This will create (by default) an
10283 additional @dfn{tree buffer}. You can execute all summary mode commands
10284 in the tree buffer.
10286 There are a few variables to customize the tree display, of course:
10289 @item gnus-tree-mode-hook
10290 @vindex gnus-tree-mode-hook
10291 A hook called in all tree mode buffers.
10293 @item gnus-tree-mode-line-format
10294 @vindex gnus-tree-mode-line-format
10295 A format string for the mode bar in the tree mode buffers (@pxref{Mode
10296 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
10297 of valid specs, @pxref{Summary Buffer Mode Line}.
10299 @item gnus-selected-tree-face
10300 @vindex gnus-selected-tree-face
10301 Face used for highlighting the selected article in the tree buffer. The
10302 default is @code{modeline}.
10304 @item gnus-tree-line-format
10305 @vindex gnus-tree-line-format
10306 A format string for the tree nodes. The name is a bit of a misnomer,
10307 though---it doesn't define a line, but just the node. The default value
10308 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
10309 the name of the poster. It is vital that all nodes are of the same
10310 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
10316 The name of the poster.
10318 The @code{From} header.
10320 The number of the article.
10322 The opening bracket.
10324 The closing bracket.
10329 @xref{Formatting Variables}.
10331 Variables related to the display are:
10334 @item gnus-tree-brackets
10335 @vindex gnus-tree-brackets
10336 This is used for differentiating between ``real'' articles and
10337 ``sparse'' articles. The format is
10339 ((@var{real-open} . @var{real-close})
10340 (@var{sparse-open} . @var{sparse-close})
10341 (@var{dummy-open} . @var{dummy-close}))
10343 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
10345 @item gnus-tree-parent-child-edges
10346 @vindex gnus-tree-parent-child-edges
10347 This is a list that contains the characters used for connecting parent
10348 nodes to their children. The default is @code{(?- ?\\ ?|)}.
10352 @item gnus-tree-minimize-window
10353 @vindex gnus-tree-minimize-window
10354 If this variable is non-@code{nil}, Gnus will try to keep the tree
10355 buffer as small as possible to allow more room for the other Gnus
10356 windows. If this variable is a number, the tree buffer will never be
10357 higher than that number. The default is @code{t}. Note that if you
10358 have several windows displayed side-by-side in a frame and the tree
10359 buffer is one of these, minimizing the tree window will also resize all
10360 other windows displayed next to it.
10362 You may also wish to add the following hook to keep the window minimized
10366 (add-hook 'gnus-configure-windows-hook
10367 'gnus-tree-perhaps-minimize)
10370 @item gnus-generate-tree-function
10371 @vindex gnus-generate-tree-function
10372 @findex gnus-generate-horizontal-tree
10373 @findex gnus-generate-vertical-tree
10374 The function that actually generates the thread tree. Two predefined
10375 functions are available: @code{gnus-generate-horizontal-tree} and
10376 @code{gnus-generate-vertical-tree} (which is the default).
10380 Here's an example from a horizontal tree buffer:
10383 @{***@}-(***)-[odd]-[Gun]
10393 Here's the same thread displayed in a vertical tree buffer:
10398 |--------------------------\-----\-----\
10399 (***) [Bjo] [Gun] [Gun]
10401 [odd] [Jan] [odd] (***) [Jor]
10403 [Gun] [Eri] [Eri] [odd]
10409 If you're using horizontal trees, it might be nice to display the trees
10410 side-by-side with the summary buffer. You could add something like the
10411 following to your @file{~/.gnus.el} file:
10414 (setq gnus-use-trees t
10415 gnus-generate-tree-function 'gnus-generate-horizontal-tree
10416 gnus-tree-minimize-window nil)
10417 (gnus-add-configuration
10421 (summary 0.75 point)
10426 @xref{Window Layout}.
10429 @node Mail Group Commands
10430 @section Mail Group Commands
10431 @cindex mail group commands
10433 Some commands only make sense in mail groups. If these commands are
10434 invalid in the current group, they will raise a hell and let you know.
10436 All these commands (except the expiry and edit commands) use the
10437 process/prefix convention (@pxref{Process/Prefix}).
10442 @kindex B e (Summary)
10443 @findex gnus-summary-expire-articles
10444 @cindex expiring mail
10445 Run all expirable articles in the current group through the expiry
10446 process (@code{gnus-summary-expire-articles}). That is, delete all
10447 expirable articles in the group that have been around for a while.
10448 (@pxref{Expiring Mail}).
10451 @kindex B C-M-e (Summary)
10452 @findex gnus-summary-expire-articles-now
10453 @cindex expiring mail
10454 Delete all the expirable articles in the group
10455 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
10456 articles eligible for expiry in the current group will
10457 disappear forever into that big @file{/dev/null} in the sky.
10460 @kindex B DEL (Summary)
10461 @findex gnus-summary-delete-article
10462 @c @icon{gnus-summary-mail-delete}
10463 Delete the mail article. This is ``delete'' as in ``delete it from your
10464 disk forever and ever, never to return again.'' Use with caution.
10465 (@code{gnus-summary-delete-article}).
10468 @kindex B m (Summary)
10470 @findex gnus-summary-move-article
10471 @vindex gnus-preserve-marks
10472 Move the article from one mail group to another
10473 (@code{gnus-summary-move-article}). Marks will be preserved if
10474 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10477 @kindex B c (Summary)
10479 @findex gnus-summary-copy-article
10480 @c @icon{gnus-summary-mail-copy}
10481 Copy the article from one group (mail group or not) to a mail group
10482 (@code{gnus-summary-copy-article}). Marks will be preserved if
10483 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10486 @kindex B B (Summary)
10487 @cindex crosspost mail
10488 @findex gnus-summary-crosspost-article
10489 Crosspost the current article to some other group
10490 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10491 the article in the other group, and the Xref headers of the article will
10492 be properly updated.
10495 @kindex B i (Summary)
10496 @findex gnus-summary-import-article
10497 Import an arbitrary file into the current mail newsgroup
10498 (@code{gnus-summary-import-article}). You will be prompted for a file
10499 name, a @code{From} header and a @code{Subject} header.
10502 @kindex B I (Summary)
10503 @findex gnus-summary-create-article
10504 Create an empty article in the current mail newsgroups
10505 (@code{gnus-summary-create-article}). You will be prompted for a
10506 @code{From} header and a @code{Subject} header.
10509 @kindex B r (Summary)
10510 @findex gnus-summary-respool-article
10511 @vindex gnus-summary-respool-default-method
10512 Respool the mail article (@code{gnus-summary-respool-article}).
10513 @code{gnus-summary-respool-default-method} will be used as the default
10514 select method when respooling. This variable is @code{nil} by default,
10515 which means that the current group select method will be used instead.
10516 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10517 (which is the default).
10521 @kindex B w (Summary)
10522 @kindex e (Summary)
10523 @findex gnus-summary-edit-article
10524 @kindex C-c C-c (Article)
10525 @findex gnus-summary-edit-article-done
10526 Edit the current article (@code{gnus-summary-edit-article}). To finish
10527 editing and make the changes permanent, type @kbd{C-c C-c}
10528 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10529 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
10532 @kindex B q (Summary)
10533 @findex gnus-summary-respool-query
10534 If you want to re-spool an article, you might be curious as to what group
10535 the article will end up in before you do the re-spooling. This command
10536 will tell you (@code{gnus-summary-respool-query}).
10539 @kindex B t (Summary)
10540 @findex gnus-summary-respool-trace
10541 Similarly, this command will display all fancy splitting patterns used
10542 when respooling, if any (@code{gnus-summary-respool-trace}).
10545 @kindex B p (Summary)
10546 @findex gnus-summary-article-posted-p
10547 Some people have a tendency to send you ``courtesy'' copies when they
10548 follow up to articles you have posted. These usually have a
10549 @code{Newsgroups} header in them, but not always. This command
10550 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10551 article from your news server (or rather, from
10552 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10553 report back whether it found the article or not. Even if it says that
10554 it didn't find the article, it may have been posted anyway---mail
10555 propagation is much faster than news propagation, and the news copy may
10556 just not have arrived yet.
10559 @kindex K E (Summary)
10560 @findex gnus-article-encrypt-body
10561 @vindex gnus-article-encrypt-protocol
10562 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10563 The body is encrypted with the encryption protocol specified by the
10564 variable @code{gnus-article-encrypt-protocol}.
10568 @vindex gnus-move-split-methods
10569 @cindex moving articles
10570 If you move (or copy) articles regularly, you might wish to have Gnus
10571 suggest where to put the articles. @code{gnus-move-split-methods} is a
10572 variable that uses the same syntax as @code{gnus-split-methods}
10573 (@pxref{Saving Articles}). You may customize that variable to create
10574 suggestions you find reasonable. (Note that
10575 @code{gnus-move-split-methods} uses group names where
10576 @code{gnus-split-methods} uses file names.)
10579 (setq gnus-move-split-methods
10580 '(("^From:.*Lars Magne" "nnml:junk")
10581 ("^Subject:.*gnus" "nnfolder:important")
10582 (".*" "nnml:misc")))
10586 @node Various Summary Stuff
10587 @section Various Summary Stuff
10590 * Summary Group Information:: Information oriented commands.
10591 * Searching for Articles:: Multiple article commands.
10592 * Summary Generation Commands::
10593 * Really Various Summary Commands:: Those pesky non-conformant commands.
10597 @vindex gnus-summary-display-while-building
10598 @item gnus-summary-display-while-building
10599 If non-@code{nil}, show and update the summary buffer as it's being
10600 built. If @code{t}, update the buffer after every line is inserted.
10601 If the value is an integer, @var{n}, update the display every @var{n}
10602 lines. The default is @code{nil}.
10604 @vindex gnus-summary-display-arrow
10605 @item gnus-summary-display-arrow
10606 If non-@code{nil}, display an arrow in the fringe to indicate the
10609 @vindex gnus-summary-mode-hook
10610 @item gnus-summary-mode-hook
10611 This hook is called when creating a summary mode buffer.
10613 @vindex gnus-summary-generate-hook
10614 @item gnus-summary-generate-hook
10615 This is called as the last thing before doing the threading and the
10616 generation of the summary buffer. It's quite convenient for customizing
10617 the threading variables based on what data the newsgroup has. This hook
10618 is called from the summary buffer after most summary buffer variables
10621 @vindex gnus-summary-prepare-hook
10622 @item gnus-summary-prepare-hook
10623 It is called after the summary buffer has been generated. You might use
10624 it to, for instance, highlight lines or modify the look of the buffer in
10625 some other ungodly manner. I don't care.
10627 @vindex gnus-summary-prepared-hook
10628 @item gnus-summary-prepared-hook
10629 A hook called as the very last thing after the summary buffer has been
10632 @vindex gnus-summary-ignore-duplicates
10633 @item gnus-summary-ignore-duplicates
10634 When Gnus discovers two articles that have the same @code{Message-ID},
10635 it has to do something drastic. No articles are allowed to have the
10636 same @code{Message-ID}, but this may happen when reading mail from some
10637 sources. Gnus allows you to customize what happens with this variable.
10638 If it is @code{nil} (which is the default), Gnus will rename the
10639 @code{Message-ID} (for display purposes only) and display the article as
10640 any other article. If this variable is @code{t}, it won't display the
10641 article---it'll be as if it never existed.
10643 @vindex gnus-alter-articles-to-read-function
10644 @item gnus-alter-articles-to-read-function
10645 This function, which takes two parameters (the group name and the list
10646 of articles to be selected), is called to allow the user to alter the
10647 list of articles to be selected.
10649 For instance, the following function adds the list of cached articles to
10650 the list in one particular group:
10653 (defun my-add-cached-articles (group articles)
10654 (if (string= group "some.group")
10655 (append gnus-newsgroup-cached articles)
10659 @vindex gnus-newsgroup-variables
10660 @item gnus-newsgroup-variables
10661 A list of newsgroup (summary buffer) local variables, or cons of
10662 variables and their default expressions to be evalled (when the default
10663 values are not @code{nil}), that should be made global while the summary
10666 Note: The default expressions will be evaluated (using function
10667 @code{eval}) before assignment to the local variable rather than just
10668 assigned to it. If the default expression is the symbol @code{global},
10669 that symbol will not be evaluated but the global value of the local
10670 variable will be used instead.
10672 These variables can be used to set variables in the group parameters
10673 while still allowing them to affect operations done in other
10674 buffers. For example:
10677 (setq gnus-newsgroup-variables
10678 '(message-use-followup-to
10679 (gnus-visible-headers .
10680 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10683 Also @pxref{Group Parameters}.
10687 @node Summary Group Information
10688 @subsection Summary Group Information
10693 @kindex H f (Summary)
10694 @findex gnus-summary-fetch-faq
10695 @vindex gnus-group-faq-directory
10696 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10697 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10698 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10699 is usually a directory on a remote machine. This variable can also be
10700 a list of directories. In that case, giving a prefix to this command
10701 will allow you to choose between the various sites. @code{ange-ftp}
10702 or @code{efs} will probably be used for fetching the file.
10705 @kindex H d (Summary)
10706 @findex gnus-summary-describe-group
10707 Give a brief description of the current group
10708 (@code{gnus-summary-describe-group}). If given a prefix, force
10709 rereading the description from the server.
10712 @kindex H h (Summary)
10713 @findex gnus-summary-describe-briefly
10714 Give an extremely brief description of the most important summary
10715 keystrokes (@code{gnus-summary-describe-briefly}).
10718 @kindex H i (Summary)
10719 @findex gnus-info-find-node
10720 Go to the Gnus info node (@code{gnus-info-find-node}).
10724 @node Searching for Articles
10725 @subsection Searching for Articles
10730 @kindex M-s (Summary)
10731 @findex gnus-summary-search-article-forward
10732 Search through all subsequent (raw) articles for a regexp
10733 (@code{gnus-summary-search-article-forward}).
10736 @kindex M-r (Summary)
10737 @findex gnus-summary-search-article-backward
10738 Search through all previous (raw) articles for a regexp
10739 (@code{gnus-summary-search-article-backward}).
10742 @kindex M-S (Summary)
10743 @findex gnus-summary-repeat-search-article-forward
10744 Repeat the previous search forwards
10745 (@code{gnus-summary-repeat-search-article-forward}).
10748 @kindex M-R (Summary)
10749 @findex gnus-summary-repeat-search-article-backward
10750 Repeat the previous search backwards
10751 (@code{gnus-summary-repeat-search-article-backward}).
10754 @kindex & (Summary)
10755 @findex gnus-summary-execute-command
10756 This command will prompt you for a header, a regular expression to match
10757 on this field, and a command to be executed if the match is made
10758 (@code{gnus-summary-execute-command}). If the header is an empty
10759 string, the match is done on the entire article. If given a prefix,
10760 search backward instead.
10762 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10763 all articles that have heads or bodies that match @samp{some.*string}.
10766 @kindex M-& (Summary)
10767 @findex gnus-summary-universal-argument
10768 Perform any operation on all articles that have been marked with
10769 the process mark (@code{gnus-summary-universal-argument}).
10772 @node Summary Generation Commands
10773 @subsection Summary Generation Commands
10778 @kindex Y g (Summary)
10779 @findex gnus-summary-prepare
10780 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10783 @kindex Y c (Summary)
10784 @findex gnus-summary-insert-cached-articles
10785 Pull all cached articles (for the current group) into the summary buffer
10786 (@code{gnus-summary-insert-cached-articles}).
10789 @kindex Y d (Summary)
10790 @findex gnus-summary-insert-dormant-articles
10791 Pull all dormant articles (for the current group) into the summary buffer
10792 (@code{gnus-summary-insert-dormant-articles}).
10795 @kindex Y t (Summary)
10796 @findex gnus-summary-insert-ticked-articles
10797 Pull all ticked articles (for the current group) into the summary buffer
10798 (@code{gnus-summary-insert-ticked-articles}).
10803 @node Really Various Summary Commands
10804 @subsection Really Various Summary Commands
10810 @kindex C-d (Summary)
10811 @kindex A D (Summary)
10812 @findex gnus-summary-enter-digest-group
10813 If the current article is a collection of other articles (for instance,
10814 a digest), you might use this command to enter a group based on the that
10815 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10816 guess what article type is currently displayed unless you give a prefix
10817 to this command, which forces a ``digest'' interpretation. Basically,
10818 whenever you see a message that is a collection of other messages of
10819 some format, you @kbd{C-d} and read these messages in a more convenient
10822 @vindex gnus-auto-select-on-ephemeral-exit
10823 The variable @code{gnus-auto-select-on-ephemeral-exit} controls what
10824 article should be selected after exiting a digest group. Valid values
10829 Select the next article.
10832 Select the next unread article.
10834 @item next-noselect
10835 Move the cursor to the next article. This is the default.
10837 @item next-unread-noselect
10838 Move the cursor to the next unread article.
10841 If it has any other value or there is no next (unread) article, the
10842 article selected before entering to the digest group will appear.
10845 @kindex C-M-d (Summary)
10846 @findex gnus-summary-read-document
10847 This command is very similar to the one above, but lets you gather
10848 several documents into one biiig group
10849 (@code{gnus-summary-read-document}). It does this by opening several
10850 @code{nndoc} groups for each document, and then opening an
10851 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10852 command understands the process/prefix convention
10853 (@pxref{Process/Prefix}).
10856 @kindex C-t (Summary)
10857 @findex gnus-summary-toggle-truncation
10858 Toggle truncation of summary lines
10859 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10860 line centering function in the summary buffer, so it's not a good idea
10861 to have truncation switched off while reading articles.
10864 @kindex = (Summary)
10865 @findex gnus-summary-expand-window
10866 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10867 If given a prefix, force an @code{article} window configuration.
10870 @kindex C-M-e (Summary)
10871 @findex gnus-summary-edit-parameters
10872 Edit the group parameters (@pxref{Group Parameters}) of the current
10873 group (@code{gnus-summary-edit-parameters}).
10876 @kindex C-M-a (Summary)
10877 @findex gnus-summary-customize-parameters
10878 Customize the group parameters (@pxref{Group Parameters}) of the current
10879 group (@code{gnus-summary-customize-parameters}).
10884 @node Exiting the Summary Buffer
10885 @section Exiting the Summary Buffer
10886 @cindex summary exit
10887 @cindex exiting groups
10889 Exiting from the summary buffer will normally update all info on the
10890 group and return you to the group buffer.
10897 @kindex Z Z (Summary)
10898 @kindex Z Q (Summary)
10899 @kindex q (Summary)
10900 @findex gnus-summary-exit
10901 @vindex gnus-summary-exit-hook
10902 @vindex gnus-summary-prepare-exit-hook
10903 @vindex gnus-group-no-more-groups-hook
10904 @c @icon{gnus-summary-exit}
10905 Exit the current group and update all information on the group
10906 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10907 called before doing much of the exiting, which calls
10908 @code{gnus-summary-expire-articles} by default.
10909 @code{gnus-summary-exit-hook} is called after finishing the exit
10910 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10911 group mode having no more (unread) groups.
10915 @kindex Z E (Summary)
10916 @kindex Q (Summary)
10917 @findex gnus-summary-exit-no-update
10918 Exit the current group without updating any information on the group
10919 (@code{gnus-summary-exit-no-update}).
10923 @kindex Z c (Summary)
10924 @kindex c (Summary)
10925 @findex gnus-summary-catchup-and-exit
10926 @c @icon{gnus-summary-catchup-and-exit}
10927 Mark all unticked articles in the group as read and then exit
10928 (@code{gnus-summary-catchup-and-exit}).
10931 @kindex Z C (Summary)
10932 @findex gnus-summary-catchup-all-and-exit
10933 Mark all articles, even the ticked ones, as read and then exit
10934 (@code{gnus-summary-catchup-all-and-exit}).
10937 @kindex Z n (Summary)
10938 @findex gnus-summary-catchup-and-goto-next-group
10939 Mark all articles as read and go to the next group
10940 (@code{gnus-summary-catchup-and-goto-next-group}).
10943 @kindex Z p (Summary)
10944 @findex gnus-summary-catchup-and-goto-prev-group
10945 Mark all articles as read and go to the previous group
10946 (@code{gnus-summary-catchup-and-goto-prev-group}).
10950 @kindex Z R (Summary)
10951 @kindex C-x C-s (Summary)
10952 @findex gnus-summary-reselect-current-group
10953 Exit this group, and then enter it again
10954 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10955 all articles, both read and unread.
10959 @kindex Z G (Summary)
10960 @kindex M-g (Summary)
10961 @findex gnus-summary-rescan-group
10962 @c @icon{gnus-summary-mail-get}
10963 Exit the group, check for new articles in the group, and select the
10964 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10965 articles, both read and unread.
10968 @kindex Z N (Summary)
10969 @findex gnus-summary-next-group
10970 Exit the group and go to the next group
10971 (@code{gnus-summary-next-group}).
10974 @kindex Z P (Summary)
10975 @findex gnus-summary-prev-group
10976 Exit the group and go to the previous group
10977 (@code{gnus-summary-prev-group}).
10980 @kindex Z s (Summary)
10981 @findex gnus-summary-save-newsrc
10982 Save the current number of read/marked articles in the dribble buffer
10983 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10984 given a prefix, also save the @file{.newsrc} file(s). Using this
10985 command will make exit without updating (the @kbd{Q} command) worthless.
10988 @vindex gnus-exit-group-hook
10989 @code{gnus-exit-group-hook} is called when you exit the current group
10990 with an ``updating'' exit. For instance @kbd{Q}
10991 (@code{gnus-summary-exit-no-update}) does not call this hook.
10993 @findex gnus-summary-wake-up-the-dead
10994 @findex gnus-dead-summary-mode
10995 @vindex gnus-kill-summary-on-exit
10996 If you're in the habit of exiting groups, and then changing your mind
10997 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10998 If you do that, Gnus won't kill the summary buffer when you exit it.
10999 (Quelle surprise!) Instead it will change the name of the buffer to
11000 something like @samp{*Dead Summary ... *} and install a minor mode
11001 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
11002 buffer, you'll find that all keys are mapped to a function called
11003 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
11004 summary buffer will result in a live, normal summary buffer.
11006 There will never be more than one dead summary buffer at any one time.
11008 @vindex gnus-use-cross-reference
11009 The data on the current group will be updated (which articles you have
11010 read, which articles you have replied to, etc.) when you exit the
11011 summary buffer. If the @code{gnus-use-cross-reference} variable is
11012 @code{t} (which is the default), articles that are cross-referenced to
11013 this group and are marked as read, will also be marked as read in the
11014 other subscribed groups they were cross-posted to. If this variable is
11015 neither @code{nil} nor @code{t}, the article will be marked as read in
11016 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
11019 @node Crosspost Handling
11020 @section Crosspost Handling
11024 Marking cross-posted articles as read ensures that you'll never have to
11025 read the same article more than once. Unless, of course, somebody has
11026 posted it to several groups separately. Posting the same article to
11027 several groups (not cross-posting) is called @dfn{spamming}, and you are
11028 by law required to send nasty-grams to anyone who perpetrates such a
11029 heinous crime. You may want to try NoCeM handling to filter out spam
11032 Remember: Cross-posting is kinda ok, but posting the same article
11033 separately to several groups is not. Massive cross-posting (aka.
11034 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
11035 @code{gnus-summary-mail-crosspost-complaint} command to complain about
11036 excessive crossposting (@pxref{Summary Mail Commands}).
11038 @cindex cross-posting
11040 @cindex @acronym{NOV}
11041 One thing that may cause Gnus to not do the cross-posting thing
11042 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
11043 (which is very nice, because it speeds things up considerably) which
11044 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
11045 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
11046 even with @sc{xover} by registering the @code{Xref} lines of all
11047 articles you actually read, but if you kill the articles, or just mark
11048 them as read without reading them, Gnus will not get a chance to snoop
11049 the @code{Xref} lines out of these articles, and will be unable to use
11050 the cross reference mechanism.
11052 @cindex LIST overview.fmt
11053 @cindex overview.fmt
11054 To check whether your @acronym{NNTP} server includes the @code{Xref} header
11055 in its overview files, try @samp{telnet your.nntp.server nntp},
11056 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
11057 overview.fmt}. This may not work, but if it does, and the last line you
11058 get does not read @samp{Xref:full}, then you should shout and whine at
11059 your news admin until she includes the @code{Xref} header in the
11062 If you want Gnus to get the @code{Xref}s right all the time, you have to
11063 set @code{nntp-nov-is-evil} to @code{t}, which slows things down
11064 considerably. Also @pxref{Slow/Expensive Connection}.
11068 For an alternative approach, @pxref{Duplicate Suppression}.
11071 @node Duplicate Suppression
11072 @section Duplicate Suppression
11074 By default, Gnus tries to make sure that you don't have to read the same
11075 article more than once by utilizing the crossposting mechanism
11076 (@pxref{Crosspost Handling}). However, that simple and efficient
11077 approach may not work satisfactory for some users for various
11082 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
11083 is evil and not very common.
11086 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
11087 @file{.overview} data bases. This is evil and all too common, alas.
11090 You may be reading the same group (or several related groups) from
11091 different @acronym{NNTP} servers.
11094 You may be getting mail that duplicates articles posted to groups.
11097 I'm sure there are other situations where @code{Xref} handling fails as
11098 well, but these four are the most common situations.
11100 If, and only if, @code{Xref} handling fails for you, then you may
11101 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
11102 will remember the @code{Message-ID}s of all articles you have read or
11103 otherwise marked as read, and then, as if by magic, mark them as read
11104 all subsequent times you see them---in @emph{all} groups. Using this
11105 mechanism is quite likely to be somewhat inefficient, but not overly
11106 so. It's certainly preferable to reading the same articles more than
11109 Duplicate suppression is not a very subtle instrument. It's more like a
11110 sledge hammer than anything else. It works in a very simple
11111 fashion---if you have marked an article as read, it adds this Message-ID
11112 to a cache. The next time it sees this Message-ID, it will mark the
11113 article as read with the @samp{M} mark. It doesn't care what group it
11114 saw the article in.
11117 @item gnus-suppress-duplicates
11118 @vindex gnus-suppress-duplicates
11119 If non-@code{nil}, suppress duplicates.
11121 @item gnus-save-duplicate-list
11122 @vindex gnus-save-duplicate-list
11123 If non-@code{nil}, save the list of duplicates to a file. This will
11124 make startup and shutdown take longer, so the default is @code{nil}.
11125 However, this means that only duplicate articles read in a single Gnus
11126 session are suppressed.
11128 @item gnus-duplicate-list-length
11129 @vindex gnus-duplicate-list-length
11130 This variable says how many @code{Message-ID}s to keep in the duplicate
11131 suppression list. The default is 10000.
11133 @item gnus-duplicate-file
11134 @vindex gnus-duplicate-file
11135 The name of the file to store the duplicate suppression list in. The
11136 default is @file{~/News/suppression}.
11139 If you have a tendency to stop and start Gnus often, setting
11140 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
11141 you leave Gnus running for weeks on end, you may have it @code{nil}. On
11142 the other hand, saving the list makes startup and shutdown much slower,
11143 so that means that if you stop and start Gnus often, you should set
11144 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
11145 to you to figure out, I think.
11150 Gnus is able to verify signed messages or decrypt encrypted messages.
11151 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
11152 and @acronym{S/MIME}, however you need some external programs to get
11157 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
11158 install an OpenPGP implementation such as GnuPG. The Lisp interface
11159 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
11160 Manual}), but Mailcrypt and gpg.el are also supported.
11163 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
11164 or newer is recommended.
11168 The variables that control security functionality on reading messages
11172 @item mm-verify-option
11173 @vindex mm-verify-option
11174 Option of verifying signed parts. @code{never}, not verify;
11175 @code{always}, always verify; @code{known}, only verify known
11176 protocols. Otherwise, ask user.
11178 @item mm-decrypt-option
11179 @vindex mm-decrypt-option
11180 Option of decrypting encrypted parts. @code{never}, no decryption;
11181 @code{always}, always decrypt; @code{known}, only decrypt known
11182 protocols. Otherwise, ask user.
11185 @vindex mml1991-use
11186 Symbol indicating elisp interface to OpenPGP implementation for
11187 @acronym{PGP} messages. The default is @code{pgg}, but
11188 @code{mailcrypt} and @code{gpg} are also supported although
11192 @vindex mml2015-use
11193 Symbol indicating elisp interface to OpenPGP implementation for
11194 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
11195 @code{mailcrypt} and @code{gpg} are also supported although
11200 By default the buttons that display security information are not
11201 shown, because they clutter reading the actual e-mail. You can type
11202 @kbd{K b} manually to display the information. Use the
11203 @code{gnus-buttonized-mime-types} and
11204 @code{gnus-unbuttonized-mime-types} variables to control this
11205 permanently. @ref{MIME Commands} for further details, and hints on
11206 how to customize these variables to always display security
11209 @cindex snarfing keys
11210 @cindex importing PGP keys
11211 @cindex PGP key ring import
11212 Snarfing OpenPGP keys (i.e., importing keys from articles into your
11213 key ring) is not supported explicitly through a menu item or command,
11214 rather Gnus do detect and label keys as @samp{application/pgp-keys},
11215 allowing you to specify whatever action you think is appropriate
11216 through the usual @acronym{MIME} infrastructure. You can use a
11217 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
11218 Emacs MIME Manual}) such as the following to import keys using GNU
11219 Privacy Guard when you click on the @acronym{MIME} button
11220 (@pxref{Using MIME}).
11223 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
11226 This happens to also be the default action defined in
11227 @code{mailcap-mime-data}.
11229 More information on how to set things for sending outgoing signed and
11230 encrypted messages up can be found in the message manual
11231 (@pxref{Security, ,Security, message, Message Manual}).
11234 @section Mailing List
11235 @cindex mailing list
11238 @kindex A M (summary)
11239 @findex gnus-mailing-list-insinuate
11240 Gnus understands some mailing list fields of RFC 2369. To enable it,
11241 add a @code{to-list} group parameter (@pxref{Group Parameters}),
11242 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
11245 That enables the following commands to the summary buffer:
11250 @kindex C-c C-n h (Summary)
11251 @findex gnus-mailing-list-help
11252 Send a message to fetch mailing list help, if List-Help field exists.
11255 @kindex C-c C-n s (Summary)
11256 @findex gnus-mailing-list-subscribe
11257 Send a message to subscribe the mailing list, if List-Subscribe field exists.
11260 @kindex C-c C-n u (Summary)
11261 @findex gnus-mailing-list-unsubscribe
11262 Send a message to unsubscribe the mailing list, if List-Unsubscribe
11266 @kindex C-c C-n p (Summary)
11267 @findex gnus-mailing-list-post
11268 Post to the mailing list, if List-Post field exists.
11271 @kindex C-c C-n o (Summary)
11272 @findex gnus-mailing-list-owner
11273 Send a message to the mailing list owner, if List-Owner field exists.
11276 @kindex C-c C-n a (Summary)
11277 @findex gnus-mailing-list-archive
11278 Browse the mailing list archive, if List-Archive field exists.
11283 @node Article Buffer
11284 @chapter Article Buffer
11285 @cindex article buffer
11287 The articles are displayed in the article buffer, of which there is only
11288 one. All the summary buffers share the same article buffer unless you
11289 tell Gnus otherwise.
11292 * Hiding Headers:: Deciding what headers should be displayed.
11293 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
11294 * Customizing Articles:: Tailoring the look of the articles.
11295 * Article Keymap:: Keystrokes available in the article buffer.
11296 * Misc Article:: Other stuff.
11300 @node Hiding Headers
11301 @section Hiding Headers
11302 @cindex hiding headers
11303 @cindex deleting headers
11305 The top section of each article is the @dfn{head}. (The rest is the
11306 @dfn{body}, but you may have guessed that already.)
11308 @vindex gnus-show-all-headers
11309 There is a lot of useful information in the head: the name of the person
11310 who wrote the article, the date it was written and the subject of the
11311 article. That's well and nice, but there's also lots of information
11312 most people do not want to see---what systems the article has passed
11313 through before reaching you, the @code{Message-ID}, the
11314 @code{References}, etc. ad nauseam---and you'll probably want to get rid
11315 of some of those lines. If you want to keep all those lines in the
11316 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
11318 Gnus provides you with two variables for sifting headers:
11322 @item gnus-visible-headers
11323 @vindex gnus-visible-headers
11324 If this variable is non-@code{nil}, it should be a regular expression
11325 that says what headers you wish to keep in the article buffer. All
11326 headers that do not match this variable will be hidden.
11328 For instance, if you only want to see the name of the person who wrote
11329 the article and the subject, you'd say:
11332 (setq gnus-visible-headers "^From:\\|^Subject:")
11335 This variable can also be a list of regexps to match headers to
11338 @item gnus-ignored-headers
11339 @vindex gnus-ignored-headers
11340 This variable is the reverse of @code{gnus-visible-headers}. If this
11341 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
11342 should be a regular expression that matches all lines that you want to
11343 hide. All lines that do not match this variable will remain visible.
11345 For instance, if you just want to get rid of the @code{References} line
11346 and the @code{Xref} line, you might say:
11349 (setq gnus-ignored-headers "^References:\\|^Xref:")
11352 This variable can also be a list of regexps to match headers to
11355 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
11356 variable will have no effect.
11360 @vindex gnus-sorted-header-list
11361 Gnus can also sort the headers for you. (It does this by default.) You
11362 can control the sorting by setting the @code{gnus-sorted-header-list}
11363 variable. It is a list of regular expressions that says in what order
11364 the headers are to be displayed.
11366 For instance, if you want the name of the author of the article first,
11367 and then the subject, you might say something like:
11370 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
11373 Any headers that are to remain visible, but are not listed in this
11374 variable, will be displayed in random order after all the headers listed in this variable.
11376 @findex gnus-article-hide-boring-headers
11377 @vindex gnus-boring-article-headers
11378 You can hide further boring headers by setting
11379 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
11380 does depends on the @code{gnus-boring-article-headers} variable. It's a
11381 list, but this list doesn't actually contain header names. Instead it
11382 lists various @dfn{boring conditions} that Gnus can check and remove
11385 These conditions are:
11388 Remove all empty headers.
11390 Remove the @code{Followup-To} header if it is identical to the
11391 @code{Newsgroups} header.
11393 Remove the @code{Reply-To} header if it lists the same addresses as
11394 the @code{From} header, or if the @code{broken-reply-to} group
11397 Remove the @code{Newsgroups} header if it only contains the current group
11400 Remove the @code{To} header if it only contains the address identical to
11401 the current group's @code{to-address} parameter.
11403 Remove the @code{To} header if it only contains the address identical to
11404 the current group's @code{to-list} parameter.
11406 Remove the @code{Cc} header if it only contains the address identical to
11407 the current group's @code{to-list} parameter.
11409 Remove the @code{Date} header if the article is less than three days
11412 Remove the @code{To} and/or @code{Cc} header if it is very long.
11414 Remove all @code{To} and/or @code{Cc} headers if there are more than one.
11417 To include these three elements, you could say something like:
11420 (setq gnus-boring-article-headers
11421 '(empty followup-to reply-to))
11424 This is also the default value for this variable.
11428 @section Using MIME
11429 @cindex @acronym{MIME}
11431 Mime is a standard for waving your hands through the air, aimlessly,
11432 while people stand around yawning.
11434 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
11435 while all newsreaders die of fear.
11437 @acronym{MIME} may specify what character set the article uses, the encoding
11438 of the characters, and it also makes it possible to embed pictures and
11439 other naughty stuff in innocent-looking articles.
11441 @vindex gnus-display-mime-function
11442 @findex gnus-display-mime
11443 Gnus pushes @acronym{MIME} articles through @code{gnus-display-mime-function}
11444 to display the @acronym{MIME} parts. This is @code{gnus-display-mime} by
11445 default, which creates a bundle of clickable buttons that can be used to
11446 display, save and manipulate the @acronym{MIME} objects.
11448 The following commands are available when you have placed point over a
11449 @acronym{MIME} button:
11452 @findex gnus-article-press-button
11453 @item RET (Article)
11454 @kindex RET (Article)
11455 @itemx BUTTON-2 (Article)
11456 Toggle displaying of the @acronym{MIME} object
11457 (@code{gnus-article-press-button}). If built-in viewers can not display
11458 the object, Gnus resorts to external viewers in the @file{mailcap}
11459 files. If a viewer has the @samp{copiousoutput} specification, the
11460 object is displayed inline.
11462 @findex gnus-mime-view-part
11463 @item M-RET (Article)
11464 @kindex M-RET (Article)
11466 Prompt for a method, and then view the @acronym{MIME} object using this
11467 method (@code{gnus-mime-view-part}).
11469 @findex gnus-mime-view-part-as-type
11471 @kindex t (Article)
11472 View the @acronym{MIME} object as if it were a different @acronym{MIME} media type
11473 (@code{gnus-mime-view-part-as-type}).
11475 @findex gnus-mime-view-part-as-charset
11477 @kindex C (Article)
11478 Prompt for a charset, and then view the @acronym{MIME} object using this
11479 charset (@code{gnus-mime-view-part-as-charset}).
11481 @findex gnus-mime-save-part
11483 @kindex o (Article)
11484 Prompt for a file name, and then save the @acronym{MIME} object
11485 (@code{gnus-mime-save-part}).
11487 @findex gnus-mime-save-part-and-strip
11488 @item C-o (Article)
11489 @kindex C-o (Article)
11490 Prompt for a file name, then save the @acronym{MIME} object and strip it from
11491 the article. Then proceed to article editing, where a reasonable
11492 suggestion is being made on how the altered article should look
11493 like. The stripped @acronym{MIME} object will be referred via the
11494 message/external-body @acronym{MIME} type.
11495 (@code{gnus-mime-save-part-and-strip}).
11497 @findex gnus-mime-replace-part
11499 @kindex r (Article)
11500 Prompt for a file name, replace the @acronym{MIME} object with an
11501 external body refering to the file via the message/external-body
11502 @acronym{MIME} type. (@code{gnus-mime-replace-part}).
11504 @findex gnus-mime-delete-part
11506 @kindex d (Article)
11507 Delete the @acronym{MIME} object from the article and replace it with some
11508 information about the removed @acronym{MIME} object
11509 (@code{gnus-mime-delete-part}).
11511 @c FIXME: gnus-auto-select-part should be documented here
11513 @findex gnus-mime-copy-part
11515 @kindex c (Article)
11516 Copy the @acronym{MIME} object to a fresh buffer and display this buffer
11517 (@code{gnus-mime-copy-part}). If given a prefix, copy the raw contents
11518 without decoding. If given a numerical prefix, you can do semi-manual
11519 charset stuff (see @code{gnus-summary-show-article-charset-alist} in
11520 @ref{Paging the Article}). Compressed files like @file{.gz} and
11521 @file{.bz2} are automatically decompressed if
11522 @code{auto-compression-mode} is enabled (@pxref{Compressed Files,,
11523 Accessing Compressed Files, emacs, The Emacs Editor}).
11525 @findex gnus-mime-print-part
11527 @kindex p (Article)
11528 Print the @acronym{MIME} object (@code{gnus-mime-print-part}). This
11529 command respects the @samp{print=} specifications in the
11530 @file{.mailcap} file.
11532 @findex gnus-mime-inline-part
11534 @kindex i (Article)
11535 Insert the contents of the @acronym{MIME} object into the buffer
11536 (@code{gnus-mime-inline-part}) as text/plain. If given a prefix, insert
11537 the raw contents without decoding. If given a numerical prefix, you can
11538 do semi-manual charset stuff (see
11539 @code{gnus-summary-show-article-charset-alist} in @ref{Paging the
11540 Article}). Compressed files like @file{.gz} and @file{.bz2} are
11541 automatically decompressed depending on @code{jka-compr} regardless of
11542 @code{auto-compression-mode} (@pxref{Compressed Files,, Accessing
11543 Compressed Files, emacs, The Emacs Editor}).
11545 @findex gnus-mime-view-part-internally
11547 @kindex E (Article)
11548 View the @acronym{MIME} object with an internal viewer. If no internal
11549 viewer is available, use an external viewer
11550 (@code{gnus-mime-view-part-internally}).
11552 @findex gnus-mime-view-part-externally
11554 @kindex e (Article)
11555 View the @acronym{MIME} object with an external viewer.
11556 (@code{gnus-mime-view-part-externally}).
11558 @findex gnus-mime-pipe-part
11560 @kindex | (Article)
11561 Output the @acronym{MIME} object to a process (@code{gnus-mime-pipe-part}).
11563 @findex gnus-mime-action-on-part
11565 @kindex . (Article)
11566 Interactively run an action on the @acronym{MIME} object
11567 (@code{gnus-mime-action-on-part}).
11571 Gnus will display some @acronym{MIME} objects automatically. The way Gnus
11572 determines which parts to do this with is described in the Emacs
11573 @acronym{MIME} manual.
11575 It might be best to just use the toggling functions from the article
11576 buffer to avoid getting nasty surprises. (For instance, you enter the
11577 group @samp{alt.sing-a-long} and, before you know it, @acronym{MIME} has
11578 decoded the sound file in the article and some horrible sing-a-long song
11579 comes screaming out your speakers, and you can't find the volume button,
11580 because there isn't one, and people are starting to look at you, and you
11581 try to stop the program, but you can't, and you can't find the program
11582 to control the volume, and everybody else in the room suddenly decides
11583 to look at you disdainfully, and you'll feel rather stupid.)
11585 Any similarity to real events and people is purely coincidental. Ahem.
11587 Also @pxref{MIME Commands}.
11590 @node Customizing Articles
11591 @section Customizing Articles
11592 @cindex article customization
11594 A slew of functions for customizing how the articles are to look like
11595 exist. You can call these functions interactively
11596 (@pxref{Article Washing}), or you can have them
11597 called automatically when you select the articles.
11599 To have them called automatically, you should set the corresponding
11600 ``treatment'' variable. For instance, to have headers hidden, you'd set
11601 @code{gnus-treat-hide-headers}. Below is a list of variables that can
11602 be set, but first we discuss the values these variables can have.
11604 Note: Some values, while valid, make little sense. Check the list below
11605 for sensible values.
11609 @code{nil}: Don't do this treatment.
11612 @code{t}: Do this treatment on all body parts.
11615 @code{head}: Do the treatment on the headers.
11618 @code{first}: Do this treatment on the first body part.
11621 @code{last}: Do this treatment on the last body part.
11624 An integer: Do this treatment on all body parts that have a length less
11628 A list of strings: Do this treatment on all body parts that are in
11629 articles that are read in groups that have names that match one of the
11630 regexps in the list.
11633 A list where the first element is not a string:
11635 The list is evaluated recursively. The first element of the list is a
11636 predicate. The following predicates are recognized: @code{or},
11637 @code{and}, @code{not} and @code{typep}. Here's an example:
11641 (typep "text/x-vcard"))
11646 You may have noticed that the word @dfn{part} is used here. This refers
11647 to the fact that some messages are @acronym{MIME} multipart articles that may
11648 be divided into several parts. Articles that are not multiparts are
11649 considered to contain just a single part.
11651 @vindex gnus-article-treat-types
11652 Are the treatments applied to all sorts of multipart parts? Yes, if you
11653 want to, but by default, only @samp{text/plain} parts are given the
11654 treatment. This is controlled by the @code{gnus-article-treat-types}
11655 variable, which is a list of regular expressions that are matched to the
11656 type of the part. This variable is ignored if the value of the
11657 controlling variable is a predicate list, as described above.
11660 @c Avoid sort of redundant entries in the same section for the printed
11661 @c manual, but add them in info to allow `i gnus-treat-foo-bar RET' or
11663 @vindex gnus-treat-buttonize
11664 @vindex gnus-treat-buttonize-head
11665 @vindex gnus-treat-capitalize-sentences
11666 @vindex gnus-treat-overstrike
11667 @vindex gnus-treat-strip-cr
11668 @vindex gnus-treat-strip-headers-in-body
11669 @vindex gnus-treat-strip-leading-blank-lines
11670 @vindex gnus-treat-strip-multiple-blank-lines
11671 @vindex gnus-treat-strip-pem
11672 @vindex gnus-treat-strip-trailing-blank-lines
11673 @vindex gnus-treat-unsplit-urls
11674 @vindex gnus-treat-wash-html
11675 @vindex gnus-treat-date-english
11676 @vindex gnus-treat-date-iso8601
11677 @vindex gnus-treat-date-lapsed
11678 @vindex gnus-treat-date-local
11679 @vindex gnus-treat-date-original
11680 @vindex gnus-treat-date-user-defined
11681 @vindex gnus-treat-date-ut
11682 @vindex gnus-treat-from-picon
11683 @vindex gnus-treat-mail-picon
11684 @vindex gnus-treat-newsgroups-picon
11685 @vindex gnus-treat-display-smileys
11686 @vindex gnus-treat-body-boundary
11687 @vindex gnus-treat-display-x-face
11688 @vindex gnus-treat-display-face
11689 @vindex gnus-treat-emphasize
11690 @vindex gnus-treat-fill-article
11691 @vindex gnus-treat-fill-long-lines
11692 @vindex gnus-treat-hide-boring-headers
11693 @vindex gnus-treat-hide-citation
11694 @vindex gnus-treat-hide-citation-maybe
11695 @vindex gnus-treat-hide-headers
11696 @vindex gnus-treat-hide-signature
11697 @vindex gnus-treat-strip-banner
11698 @vindex gnus-treat-strip-list-identifiers
11699 @vindex gnus-treat-highlight-citation
11700 @vindex gnus-treat-highlight-headers
11701 @vindex gnus-treat-highlight-signature
11702 @vindex gnus-treat-play-sounds
11703 @vindex gnus-treat-translate
11704 @vindex gnus-treat-x-pgp-sig
11705 @vindex gnus-treat-unfold-headers
11706 @vindex gnus-treat-fold-headers
11707 @vindex gnus-treat-fold-newsgroups
11708 @vindex gnus-treat-leading-whitespace
11711 The following treatment options are available. The easiest way to
11712 customize this is to examine the @code{gnus-article-treat} customization
11713 group. Values in parenthesis are suggested sensible values. Others are
11714 possible but those listed are probably sufficient for most people.
11717 @item gnus-treat-buttonize (t, integer)
11718 @item gnus-treat-buttonize-head (head)
11720 @xref{Article Buttons}.
11722 @item gnus-treat-capitalize-sentences (t, integer)
11723 @item gnus-treat-overstrike (t, integer)
11724 @item gnus-treat-strip-cr (t, integer)
11725 @item gnus-treat-strip-headers-in-body (t, integer)
11726 @item gnus-treat-strip-leading-blank-lines (t, first, integer)
11727 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11728 @item gnus-treat-strip-pem (t, last, integer)
11729 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11730 @item gnus-treat-unsplit-urls (t, integer)
11731 @item gnus-treat-wash-html (t, integer)
11733 @xref{Article Washing}.
11735 @item gnus-treat-date-english (head)
11736 @item gnus-treat-date-iso8601 (head)
11737 @item gnus-treat-date-lapsed (head)
11738 @item gnus-treat-date-local (head)
11739 @item gnus-treat-date-original (head)
11740 @item gnus-treat-date-user-defined (head)
11741 @item gnus-treat-date-ut (head)
11743 @xref{Article Date}.
11745 @item gnus-treat-from-picon (head)
11746 @item gnus-treat-mail-picon (head)
11747 @item gnus-treat-newsgroups-picon (head)
11751 @item gnus-treat-display-smileys (t, integer)
11753 @item gnus-treat-body-boundary (head)
11755 @vindex gnus-body-boundary-delimiter
11756 Adds a delimiter between header and body, the string used as delimiter
11757 is controlled by @code{gnus-body-boundary-delimiter}.
11761 @vindex gnus-treat-display-x-face
11762 @item gnus-treat-display-x-face (head)
11766 @vindex gnus-treat-display-face
11767 @item gnus-treat-display-face (head)
11771 @vindex gnus-treat-emphasize
11772 @item gnus-treat-emphasize (t, head, integer)
11773 @vindex gnus-treat-fill-article
11774 @item gnus-treat-fill-article (t, integer)
11775 @vindex gnus-treat-fill-long-lines
11776 @item gnus-treat-fill-long-lines (t, integer)
11777 @vindex gnus-treat-hide-boring-headers
11778 @item gnus-treat-hide-boring-headers (head)
11779 @vindex gnus-treat-hide-citation
11780 @item gnus-treat-hide-citation (t, integer)
11781 @vindex gnus-treat-hide-citation-maybe
11782 @item gnus-treat-hide-citation-maybe (t, integer)
11783 @vindex gnus-treat-hide-headers
11784 @item gnus-treat-hide-headers (head)
11785 @vindex gnus-treat-hide-signature
11786 @item gnus-treat-hide-signature (t, last)
11787 @vindex gnus-treat-strip-banner
11788 @item gnus-treat-strip-banner (t, last)
11789 @vindex gnus-treat-strip-list-identifiers
11790 @item gnus-treat-strip-list-identifiers (head)
11792 @xref{Article Hiding}.
11794 @vindex gnus-treat-highlight-citation
11795 @item gnus-treat-highlight-citation (t, integer)
11796 @vindex gnus-treat-highlight-headers
11797 @item gnus-treat-highlight-headers (head)
11798 @vindex gnus-treat-highlight-signature
11799 @item gnus-treat-highlight-signature (t, last, integer)
11801 @xref{Article Highlighting}.
11803 @vindex gnus-treat-play-sounds
11804 @item gnus-treat-play-sounds
11805 @vindex gnus-treat-translate
11806 @item gnus-treat-translate
11807 @item gnus-treat-ansi-sequences (t)
11808 @vindex gnus-treat-x-pgp-sig
11809 @item gnus-treat-x-pgp-sig (head)
11811 @vindex gnus-treat-unfold-headers
11812 @item gnus-treat-unfold-headers (head)
11813 @vindex gnus-treat-fold-headers
11814 @item gnus-treat-fold-headers (head)
11815 @vindex gnus-treat-fold-newsgroups
11816 @item gnus-treat-fold-newsgroups (head)
11817 @vindex gnus-treat-leading-whitespace
11818 @item gnus-treat-leading-whitespace (head)
11820 @xref{Article Header}.
11825 @vindex gnus-part-display-hook
11826 You can, of course, write your own functions to be called from
11827 @code{gnus-part-display-hook}. The functions are called narrowed to the
11828 part, and you can do anything you like, pretty much. There is no
11829 information that you have to keep in the buffer---you can change
11833 @node Article Keymap
11834 @section Article Keymap
11836 Most of the keystrokes in the summary buffer can also be used in the
11837 article buffer. They should behave as if you typed them in the summary
11838 buffer, which means that you don't actually have to have a summary
11839 buffer displayed while reading. You can do it all from the article
11842 @kindex v (Article)
11843 @cindex keys, reserved for users (Article)
11844 The key @kbd{v} is reserved for users. You can bind it to some
11845 command or better use it as a prefix key.
11847 A few additional keystrokes are available:
11852 @kindex SPACE (Article)
11853 @findex gnus-article-next-page
11854 Scroll forwards one page (@code{gnus-article-next-page}).
11855 This is exactly the same as @kbd{h SPACE h}.
11858 @kindex DEL (Article)
11859 @findex gnus-article-prev-page
11860 Scroll backwards one page (@code{gnus-article-prev-page}).
11861 This is exactly the same as @kbd{h DEL h}.
11864 @kindex C-c ^ (Article)
11865 @findex gnus-article-refer-article
11866 If point is in the neighborhood of a @code{Message-ID} and you press
11867 @kbd{C-c ^}, Gnus will try to get that article from the server
11868 (@code{gnus-article-refer-article}).
11871 @kindex C-c C-m (Article)
11872 @findex gnus-article-mail
11873 Send a reply to the address near point (@code{gnus-article-mail}). If
11874 given a prefix, include the mail.
11877 @kindex s (Article)
11878 @findex gnus-article-show-summary
11879 Reconfigure the buffers so that the summary buffer becomes visible
11880 (@code{gnus-article-show-summary}).
11883 @kindex ? (Article)
11884 @findex gnus-article-describe-briefly
11885 Give a very brief description of the available keystrokes
11886 (@code{gnus-article-describe-briefly}).
11889 @kindex TAB (Article)
11890 @findex gnus-article-next-button
11891 Go to the next button, if any (@code{gnus-article-next-button}). This
11892 only makes sense if you have buttonizing turned on.
11895 @kindex M-TAB (Article)
11896 @findex gnus-article-prev-button
11897 Go to the previous button, if any (@code{gnus-article-prev-button}).
11900 @kindex R (Article)
11901 @findex gnus-article-reply-with-original
11902 Send a reply to the current article and yank the current article
11903 (@code{gnus-article-reply-with-original}). If the region is active,
11904 only yank the text in the region.
11907 @kindex S W (Article)
11908 @findex gnus-article-wide-reply-with-original
11909 Send a wide reply to the current article and yank the current article
11910 (@code{gnus-article-wide-reply-with-original}). If the region is
11911 active, only yank the text in the region.
11914 @kindex F (Article)
11915 @findex gnus-article-followup-with-original
11916 Send a followup to the current article and yank the current article
11917 (@code{gnus-article-followup-with-original}). If the region is active,
11918 only yank the text in the region.
11925 @section Misc Article
11929 @item gnus-single-article-buffer
11930 @vindex gnus-single-article-buffer
11931 @cindex article buffers, several
11932 If non-@code{nil}, use the same article buffer for all the groups.
11933 (This is the default.) If @code{nil}, each group will have its own
11936 @vindex gnus-article-decode-hook
11937 @item gnus-article-decode-hook
11938 @cindex @acronym{MIME}
11939 Hook used to decode @acronym{MIME} articles. The default value is
11940 @code{(article-decode-charset article-decode-encoded-words)}
11942 @vindex gnus-article-prepare-hook
11943 @item gnus-article-prepare-hook
11944 This hook is called right after the article has been inserted into the
11945 article buffer. It is mainly intended for functions that do something
11946 depending on the contents; it should probably not be used for changing
11947 the contents of the article buffer.
11949 @item gnus-article-mode-hook
11950 @vindex gnus-article-mode-hook
11951 Hook called in article mode buffers.
11953 @item gnus-article-mode-syntax-table
11954 @vindex gnus-article-mode-syntax-table
11955 Syntax table used in article buffers. It is initialized from
11956 @code{text-mode-syntax-table}.
11958 @vindex gnus-article-over-scroll
11959 @item gnus-article-over-scroll
11960 If non-@code{nil}, allow scrolling the article buffer even when there
11961 no more new text to scroll in. The default is @code{nil}.
11963 @vindex gnus-article-mode-line-format
11964 @item gnus-article-mode-line-format
11965 This variable is a format string along the same lines as
11966 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
11967 Line}). It accepts the same format specifications as that variable,
11968 with two extensions:
11973 The @dfn{wash status} of the article. This is a short string with one
11974 character for each possible article wash operation that may have been
11975 performed. The characters and their meaning:
11980 Displayed when cited text may be hidden in the article buffer.
11983 Displayed when headers are hidden in the article buffer.
11986 Displayed when article is digitally signed or encrypted, and Gnus has
11987 hidden the security headers. (N.B. does not tell anything about
11988 security status, i.e. good or bad signature.)
11991 Displayed when the signature has been hidden in the Article buffer.
11994 Displayed when Gnus has treated overstrike characters in the article buffer.
11997 Displayed when Gnus has treated emphasised strings in the article buffer.
12002 The number of @acronym{MIME} parts in the article.
12006 @vindex gnus-break-pages
12008 @item gnus-break-pages
12009 Controls whether @dfn{page breaking} is to take place. If this variable
12010 is non-@code{nil}, the articles will be divided into pages whenever a
12011 page delimiter appears in the article. If this variable is @code{nil},
12012 paging will not be done.
12014 @item gnus-page-delimiter
12015 @vindex gnus-page-delimiter
12016 This is the delimiter mentioned above. By default, it is @samp{^L}
12020 @cindex internationalized domain names
12021 @vindex gnus-use-idna
12022 @item gnus-use-idna
12023 This variable controls whether Gnus performs IDNA decoding of
12024 internationalized domain names inside @samp{From}, @samp{To} and
12025 @samp{Cc} headers. @xref{IDNA, ,IDNA,message, The Message Manual},
12026 for how to compose such messages. This requires
12027 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
12028 variable is only enabled if you have installed it.
12033 @node Composing Messages
12034 @chapter Composing Messages
12035 @cindex composing messages
12038 @cindex sending mail
12043 @cindex using s/mime
12044 @cindex using smime
12046 @kindex C-c C-c (Post)
12047 All commands for posting and mailing will put you in a message buffer
12048 where you can edit the article all you like, before you send the
12049 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
12050 Message Manual}. Where the message will be posted/mailed to depends
12051 on your setup (@pxref{Posting Server}).
12054 * Mail:: Mailing and replying.
12055 * Posting Server:: What server should you post and mail via?
12056 * POP before SMTP:: You cannot send a mail unless you read a mail.
12057 * Mail and Post:: Mailing and posting at the same time.
12058 * Archived Messages:: Where Gnus stores the messages you've sent.
12059 * Posting Styles:: An easier way to specify who you are.
12060 * Drafts:: Postponing messages and rejected messages.
12061 * Rejected Articles:: What happens if the server doesn't like your article?
12062 * Signing and encrypting:: How to compose secure messages.
12065 Also @pxref{Canceling and Superseding} for information on how to
12066 remove articles you shouldn't have posted.
12072 Variables for customizing outgoing mail:
12075 @item gnus-uu-digest-headers
12076 @vindex gnus-uu-digest-headers
12077 List of regexps to match headers included in digested messages. The
12078 headers will be included in the sequence they are matched. If
12079 @code{nil} include all headers.
12081 @item gnus-add-to-list
12082 @vindex gnus-add-to-list
12083 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
12084 that have none when you do a @kbd{a}.
12086 @item gnus-confirm-mail-reply-to-news
12087 @vindex gnus-confirm-mail-reply-to-news
12088 If non-@code{nil}, Gnus will ask you for a confirmation when you are
12089 about to reply to news articles by mail. If it is @code{nil}, nothing
12090 interferes in what you want to do. This can also be a function
12091 receiving the group name as the only parameter which should return
12092 non-@code{nil} if a confirmation is needed, or a regular expression
12093 matching group names, where confirmation should be asked for.
12095 If you find yourself never wanting to reply to mail, but occasionally
12096 press @kbd{R} anyway, this variable might be for you.
12098 @item gnus-confirm-treat-mail-like-news
12099 @vindex gnus-confirm-treat-mail-like-news
12100 If non-@code{nil}, Gnus also requests confirmation according to
12101 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
12102 useful for treating mailing lists like newsgroups.
12107 @node Posting Server
12108 @section Posting Server
12110 When you press those magical @kbd{C-c C-c} keys to ship off your latest
12111 (extremely intelligent, of course) article, where does it go?
12113 Thank you for asking. I hate you.
12115 It can be quite complicated.
12117 @vindex gnus-post-method
12118 When posting news, Message usually invokes @code{message-send-news}
12119 (@pxref{News Variables, , News Variables, message, Message Manual}).
12120 Normally, Gnus will post using the same select method as you're
12121 reading from (which might be convenient if you're reading lots of
12122 groups from different private servers). However. If the server
12123 you're reading from doesn't allow posting, just reading, you probably
12124 want to use some other server to post your (extremely intelligent and
12125 fabulously interesting) articles. You can then set the
12126 @code{gnus-post-method} to some other method:
12129 (setq gnus-post-method '(nnspool ""))
12132 Now, if you've done this, and then this server rejects your article, or
12133 this server is down, what do you do then? To override this variable you
12134 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
12135 the ``current'' server, to get back the default behavior, for posting.
12137 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
12138 Gnus will prompt you for what method to use for posting.
12140 You can also set @code{gnus-post-method} to a list of select methods.
12141 If that's the case, Gnus will always prompt you for what method to use
12144 Finally, if you want to always post using the native select method,
12145 you can set this variable to @code{native}.
12147 @vindex message-send-mail-function
12148 When sending mail, Message invokes the function specified by the
12149 variable @code{message-send-mail-function}. Gnus tries to set it to a
12150 value suitable for your system.
12151 @xref{Mail Variables, ,Mail Variables,message,Message manual}, for more
12154 @node POP before SMTP
12155 @section POP before SMTP
12156 @cindex pop before smtp
12157 @findex message-smtpmail-send-it
12158 @findex mail-source-touch-pop
12160 Does your @acronym{ISP} require the @acronym{POP}-before-@acronym{SMTP}
12161 authentication? It is whether you need to connect to the @acronym{POP}
12162 mail server within a certain time before sending mails. If so, there is
12163 a convenient way. To do that, put the following lines in your
12164 @file{~/.gnus.el} file:
12167 (setq message-send-mail-function 'message-smtpmail-send-it)
12168 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
12172 It means to let Gnus connect to the @acronym{POP} mail server in advance
12173 whenever you send a mail. The @code{mail-source-touch-pop} function
12174 does only a @acronym{POP} authentication according to the value of
12175 @code{mail-sources} without fetching mails, just before sending a mail.
12176 Note that you have to use @code{message-smtpmail-send-it} which runs
12177 @code{message-send-mail-hook} rather than @code{smtpmail-send-it} and
12178 set the value of @code{mail-sources} for a @acronym{POP} connection
12179 correctly. @xref{Mail Sources}.
12181 If you have two or more @acronym{POP} mail servers set in
12182 @code{mail-sources}, you may want to specify one of them to
12183 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
12184 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
12185 is your primary @acronym{POP} mail server (i.e., you are fetching mails
12186 mainly from that server), you can set it permanently as follows:
12189 (setq mail-source-primary-source
12190 '(pop :server "pop3.mail.server"
12191 :password "secret"))
12195 Otherwise, bind it dynamically only when performing the
12196 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
12199 (add-hook 'message-send-mail-hook
12201 (let ((mail-source-primary-source
12202 '(pop :server "pop3.mail.server"
12203 :password "secret")))
12204 (mail-source-touch-pop))))
12207 @node Mail and Post
12208 @section Mail and Post
12210 Here's a list of variables relevant to both mailing and
12214 @item gnus-mailing-list-groups
12215 @findex gnus-mailing-list-groups
12216 @cindex mailing lists
12218 If your news server offers groups that are really mailing lists
12219 gatewayed to the @acronym{NNTP} server, you can read those groups without
12220 problems, but you can't post/followup to them without some difficulty.
12221 One solution is to add a @code{to-address} to the group parameters
12222 (@pxref{Group Parameters}). An easier thing to do is set the
12223 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
12224 really are mailing lists. Then, at least, followups to the mailing
12225 lists will work most of the time. Posting to these groups (@kbd{a}) is
12226 still a pain, though.
12228 @item gnus-user-agent
12229 @vindex gnus-user-agent
12232 This variable controls which information should be exposed in the
12233 User-Agent header. It can be a list of symbols or a string. Valid
12234 symbols are @code{gnus} (show Gnus version) and @code{emacs} (show Emacs
12235 version). In addition to the Emacs version, you can add @code{codename}
12236 (show (S)XEmacs codename) or either @code{config} (show system
12237 configuration) or @code{type} (show system type). If you set it to a
12238 string, be sure to use a valid format, see RFC 2616.
12242 You may want to do spell-checking on messages that you send out. Or, if
12243 you don't want to spell-check by hand, you could add automatic
12244 spell-checking via the @code{ispell} package:
12247 @findex ispell-message
12249 (add-hook 'message-send-hook 'ispell-message)
12252 If you want to change the @code{ispell} dictionary based on what group
12253 you're in, you could say something like the following:
12256 (add-hook 'gnus-select-group-hook
12260 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
12261 (ispell-change-dictionary "deutsch"))
12263 (ispell-change-dictionary "english")))))
12266 Modify to suit your needs.
12268 @vindex gnus-message-highlight-citation
12269 If @code{gnus-message-highlight-citation} is t, different levels of
12270 citations are highlighted like in Gnus article buffers also in message
12273 @node Archived Messages
12274 @section Archived Messages
12275 @cindex archived messages
12276 @cindex sent messages
12278 Gnus provides a few different methods for storing the mail and news you
12279 send. The default method is to use the @dfn{archive virtual server} to
12280 store the messages. If you want to disable this completely, the
12281 @code{gnus-message-archive-group} variable should be @code{nil}, which
12284 For archiving interesting messages in a group you read, see the
12285 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
12288 @vindex gnus-message-archive-method
12289 @code{gnus-message-archive-method} says what virtual server Gnus is to
12290 use to store sent messages. The default is @code{"archive"}, and when
12291 actually being used it is expanded into:
12294 (nnfolder "archive"
12295 (nnfolder-directory "~/Mail/archive")
12296 (nnfolder-active-file "~/Mail/archive/active")
12297 (nnfolder-get-new-mail nil)
12298 (nnfolder-inhibit-expiry t))
12302 @vindex gnus-update-message-archive-method
12303 Note: a server like this is saved in the @file{~/.newsrc.eld} file first
12304 so that it may be used as a real method of the server which is named
12305 @code{"archive"} (that is, for the case where
12306 @code{gnus-message-archive-method} is set to @code{"archive"}) ever
12307 since. If it once has been saved, it will never be updated by default
12308 even if you change the value of @code{gnus-message-archive-method}
12309 afterward. Therefore, the server @code{"archive"} doesn't necessarily
12310 mean the @code{nnfolder} server like this at all times. If you want the
12311 saved method to reflect always the value of
12312 @code{gnus-message-archive-method}, set the
12313 @code{gnus-update-message-archive-method} variable to a non-@code{nil}
12314 value. The default value of this variable is @code{nil}.
12317 You can, however, use any mail select method (@code{nnml},
12318 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
12319 for doing this sort of thing, though. If you don't like the default
12320 directory chosen, you could say something like:
12323 (setq gnus-message-archive-method
12324 '(nnfolder "archive"
12325 (nnfolder-inhibit-expiry t)
12326 (nnfolder-active-file "~/News/sent-mail/active")
12327 (nnfolder-directory "~/News/sent-mail/")))
12330 @vindex gnus-message-archive-group
12332 Gnus will insert @code{Gcc} headers in all outgoing messages that point
12333 to one or more group(s) on that server. Which group to use is
12334 determined by the @code{gnus-message-archive-group} variable.
12336 This variable can be used to do the following:
12340 Messages will be saved in that group.
12342 Note that you can include a select method in the group name, then the
12343 message will not be stored in the select method given by
12344 @code{gnus-message-archive-method}, but in the select method specified
12345 by the group name, instead. Suppose @code{gnus-message-archive-method}
12346 has the default value shown above. Then setting
12347 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
12348 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
12349 value @code{"nnml:foo"}, then outgoing messages will be stored in
12352 @item a list of strings
12353 Messages will be saved in all those groups.
12355 @item an alist of regexps, functions and forms
12356 When a key ``matches'', the result is used.
12359 No message archiving will take place. This is the default.
12364 Just saving to a single group called @samp{MisK}:
12366 (setq gnus-message-archive-group "MisK")
12369 Saving to two groups, @samp{MisK} and @samp{safe}:
12371 (setq gnus-message-archive-group '("MisK" "safe"))
12374 Save to different groups based on what group you are in:
12376 (setq gnus-message-archive-group
12377 '(("^alt" "sent-to-alt")
12378 ("mail" "sent-to-mail")
12379 (".*" "sent-to-misc")))
12382 More complex stuff:
12384 (setq gnus-message-archive-group
12385 '((if (message-news-p)
12390 How about storing all news messages in one file, but storing all mail
12391 messages in one file per month:
12394 (setq gnus-message-archive-group
12395 '((if (message-news-p)
12397 (concat "mail." (format-time-string "%Y-%m")))))
12400 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
12401 @c use a different value for @code{gnus-message-archive-group} there.)
12403 Now, when you send a message off, it will be stored in the appropriate
12404 group. (If you want to disable storing for just one particular message,
12405 you can just remove the @code{Gcc} header that has been inserted.) The
12406 archive group will appear in the group buffer the next time you start
12407 Gnus, or the next time you press @kbd{F} in the group buffer. You can
12408 enter it and read the articles in it just like you'd read any other
12409 group. If the group gets really big and annoying, you can simply rename
12410 if (using @kbd{G r} in the group buffer) to something
12411 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
12412 continue to be stored in the old (now empty) group.
12414 That's the default method of archiving sent messages. Gnus offers a
12415 different way for the people who don't like the default method. In that
12416 case you should set @code{gnus-message-archive-group} to @code{nil};
12417 this will disable archiving.
12420 @item gnus-outgoing-message-group
12421 @vindex gnus-outgoing-message-group
12422 All outgoing messages will be put in this group. If you want to store
12423 all your outgoing mail and articles in the group @samp{nnml:archive},
12424 you set this variable to that value. This variable can also be a list of
12427 If you want to have greater control over what group to put each
12428 message in, you can set this variable to a function that checks the
12429 current newsgroup name and then returns a suitable group name (or list
12432 This variable can be used instead of @code{gnus-message-archive-group},
12433 but the latter is the preferred method.
12435 @item gnus-gcc-mark-as-read
12436 @vindex gnus-gcc-mark-as-read
12437 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
12439 @item gnus-gcc-externalize-attachments
12440 @vindex gnus-gcc-externalize-attachments
12441 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
12442 and matches the Gcc group name, attach files as external parts; if it is
12443 @code{all}, attach local files as external parts; if it is other
12444 non-@code{nil}, the behavior is the same as @code{all}, but it may be
12445 changed in the future.
12450 @node Posting Styles
12451 @section Posting Styles
12452 @cindex posting styles
12455 All them variables, they make my head swim.
12457 So what if you want a different @code{Organization} and signature based
12458 on what groups you post to? And you post both from your home machine
12459 and your work machine, and you want different @code{From} lines, and so
12462 @vindex gnus-posting-styles
12463 One way to do stuff like that is to write clever hooks that change the
12464 variables you need to have changed. That's a bit boring, so somebody
12465 came up with the bright idea of letting the user specify these things in
12466 a handy alist. Here's an example of a @code{gnus-posting-styles}
12471 (signature "Peace and happiness")
12472 (organization "What me?"))
12474 (signature "Death to everybody"))
12475 ("comp.emacs.i-love-it"
12476 (organization "Emacs is it")))
12479 As you might surmise from this example, this alist consists of several
12480 @dfn{styles}. Each style will be applicable if the first element
12481 ``matches'', in some form or other. The entire alist will be iterated
12482 over, from the beginning towards the end, and each match will be
12483 applied, which means that attributes in later styles that match override
12484 the same attributes in earlier matching styles. So
12485 @samp{comp.programming.literate} will have the @samp{Death to everybody}
12486 signature and the @samp{What me?} @code{Organization} header.
12488 The first element in each style is called the @code{match}. If it's a
12489 string, then Gnus will try to regexp match it against the group name.
12490 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
12491 will look in the original article for a header whose name is
12492 @var{match} and compare that @var{regexp}. @var{match} and
12493 @var{regexp} are strings. (The original article is the one you are
12494 replying or following up to. If you are not composing a reply or a
12495 followup, then there is nothing to match against.) If the
12496 @code{match} is a function symbol, that function will be called with
12497 no arguments. If it's a variable symbol, then the variable will be
12498 referenced. If it's a list, then that list will be @code{eval}ed. In
12499 any case, if this returns a non-@code{nil} value, then the style is
12500 said to @dfn{match}.
12502 Each style may contain an arbitrary amount of @dfn{attributes}. Each
12503 attribute consists of a @code{(@var{name} @var{value})} pair. In
12504 addition, you can also use the @code{(@var{name} :file @var{value})}
12505 form or the @code{(@var{name} :value @var{value})} form. Where
12506 @code{:file} signifies @var{value} represents a file name and its
12507 contents should be used as the attribute value, @code{:value} signifies
12508 @var{value} does not represent a file name explicitly. The attribute
12509 name can be one of:
12512 @item @code{signature}
12513 @item @code{signature-file}
12514 @item @code{x-face-file}
12515 @item @code{address}, overriding @code{user-mail-address}
12516 @item @code{name}, overriding @code{(user-full-name)}
12520 Note that the @code{signature-file} attribute honors the variable
12521 @code{message-signature-directory}.
12523 The attribute name can also be a string or a symbol. In that case,
12524 this will be used as a header name, and the value will be inserted in
12525 the headers of the article; if the value is @code{nil}, the header
12526 name will be removed. If the attribute name is @code{eval}, the form
12527 is evaluated, and the result is thrown away.
12529 The attribute value can be a string (used verbatim), a function with
12530 zero arguments (the return value will be used), a variable (its value
12531 will be used) or a list (it will be @code{eval}ed and the return value
12532 will be used). The functions and sexps are called/@code{eval}ed in the
12533 message buffer that is being set up. The headers of the current article
12534 are available through the @code{message-reply-headers} variable, which
12535 is a vector of the following headers: number subject from date id
12536 references chars lines xref extra.
12538 @vindex message-reply-headers
12540 If you wish to check whether the message you are about to compose is
12541 meant to be a news article or a mail message, you can check the values
12542 of the @code{message-news-p} and @code{message-mail-p} functions.
12544 @findex message-mail-p
12545 @findex message-news-p
12547 So here's a new example:
12550 (setq gnus-posting-styles
12552 (signature-file "~/.signature")
12554 (x-face-file "~/.xface")
12555 (x-url (getenv "WWW_HOME"))
12556 (organization "People's Front Against MWM"))
12558 (signature my-funny-signature-randomizer))
12559 ((equal (system-name) "gnarly") ;; @r{A form}
12560 (signature my-quote-randomizer))
12561 (message-news-p ;; @r{A function symbol}
12562 (signature my-news-signature))
12563 (window-system ;; @r{A value symbol}
12564 ("X-Window-System" (format "%s" window-system)))
12565 ;; @r{If I'm replying to Larsi, set the Organization header.}
12566 ((header "from" "larsi.*org")
12567 (Organization "Somewhere, Inc."))
12568 ((posting-from-work-p) ;; @r{A user defined function}
12569 (signature-file "~/.work-signature")
12570 (address "user@@bar.foo")
12571 (body "You are fired.\n\nSincerely, your boss.")
12572 (organization "Important Work, Inc"))
12574 (From (save-excursion
12575 (set-buffer gnus-article-buffer)
12576 (message-fetch-field "to"))))
12578 (signature-file "~/.mail-signature"))))
12581 The @samp{nnml:.*} rule means that you use the @code{To} address as the
12582 @code{From} address in all your outgoing replies, which might be handy
12583 if you fill many roles.
12584 You may also use @code{message-alternative-emails} instead.
12585 @xref{Message Headers, ,Message Headers, message, Message Manual}.
12591 If you are writing a message (mail or news) and suddenly remember that
12592 you have a steak in the oven (or some pesto in the food processor, you
12593 craaazy vegetarians), you'll probably wish there was a method to save
12594 the message you are writing so that you can continue editing it some
12595 other day, and send it when you feel its finished.
12597 Well, don't worry about it. Whenever you start composing a message of
12598 some sort using the Gnus mail and post commands, the buffer you get will
12599 automatically associate to an article in a special @dfn{draft} group.
12600 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
12601 article will be saved there. (Auto-save files also go to the draft
12605 @vindex nndraft-directory
12606 The draft group is a special group (which is implemented as an
12607 @code{nndraft} group, if you absolutely have to know) called
12608 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
12609 @code{nndraft} is to store its files. What makes this group special is
12610 that you can't tick any articles in it or mark any articles as
12611 read---all articles in the group are permanently unread.
12613 If the group doesn't exist, it will be created and you'll be subscribed
12614 to it. The only way to make it disappear from the Group buffer is to
12615 unsubscribe it. The special properties of the draft group comes from
12616 a group property (@pxref{Group Parameters}), and if lost the group
12617 behaves like any other group. This means the commands below will not
12618 be available. To restore the special properties of the group, the
12619 simplest way is to kill the group, using @kbd{C-k}, and restart
12620 Gnus. The group is automatically created again with the
12621 correct parameters. The content of the group is not lost.
12623 @c @findex gnus-dissociate-buffer-from-draft
12624 @c @kindex C-c M-d (Mail)
12625 @c @kindex C-c M-d (Post)
12626 @c @findex gnus-associate-buffer-with-draft
12627 @c @kindex C-c C-d (Mail)
12628 @c @kindex C-c C-d (Post)
12629 @c If you're writing some super-secret message that you later want to
12630 @c encode with PGP before sending, you may wish to turn the auto-saving
12631 @c (and association with the draft group) off. You never know who might be
12632 @c interested in reading all your extremely valuable and terribly horrible
12633 @c and interesting secrets. The @kbd{C-c M-d}
12634 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
12635 @c If you change your mind and want to turn the auto-saving back on again,
12636 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
12638 @c @vindex gnus-use-draft
12639 @c To leave association with the draft group off by default, set
12640 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
12642 @findex gnus-draft-edit-message
12643 @kindex D e (Draft)
12644 When you want to continue editing the article, you simply enter the
12645 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
12646 that. You will be placed in a buffer where you left off.
12648 Rejected articles will also be put in this draft group (@pxref{Rejected
12651 @findex gnus-draft-send-all-messages
12652 @kindex D s (Draft)
12653 @findex gnus-draft-send-message
12654 @kindex D S (Draft)
12655 If you have lots of rejected messages you want to post (or mail) without
12656 doing further editing, you can use the @kbd{D s} command
12657 (@code{gnus-draft-send-message}). This command understands the
12658 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
12659 command (@code{gnus-draft-send-all-messages}) will ship off all messages
12662 @findex gnus-draft-toggle-sending
12663 @kindex D t (Draft)
12664 If you have some messages that you wish not to send, you can use the
12665 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
12666 as unsendable. This is a toggling command.
12669 @node Rejected Articles
12670 @section Rejected Articles
12671 @cindex rejected articles
12673 Sometimes a news server will reject an article. Perhaps the server
12674 doesn't like your face. Perhaps it just feels miserable. Perhaps
12675 @emph{there be demons}. Perhaps you have included too much cited text.
12676 Perhaps the disk is full. Perhaps the server is down.
12678 These situations are, of course, totally beyond the control of Gnus.
12679 (Gnus, of course, loves the way you look, always feels great, has angels
12680 fluttering around inside of it, doesn't care about how much cited text
12681 you include, never runs full and never goes down.) So Gnus saves these
12682 articles until some later time when the server feels better.
12684 The rejected articles will automatically be put in a special draft group
12685 (@pxref{Drafts}). When the server comes back up again, you'd then
12686 typically enter that group and send all the articles off.
12688 @node Signing and encrypting
12689 @section Signing and encrypting
12691 @cindex using s/mime
12692 @cindex using smime
12694 Gnus can digitally sign and encrypt your messages, using vanilla
12695 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
12696 decoding such messages, see the @code{mm-verify-option} and
12697 @code{mm-decrypt-option} options (@pxref{Security}).
12699 @vindex gnus-message-replysign
12700 @vindex gnus-message-replyencrypt
12701 @vindex gnus-message-replysignencrypted
12702 Often, you would like to sign replies to people who send you signed
12703 messages. Even more often, you might want to encrypt messages which
12704 are in reply to encrypted messages. Gnus offers
12705 @code{gnus-message-replysign} to enable the former, and
12706 @code{gnus-message-replyencrypt} for the latter. In addition, setting
12707 @code{gnus-message-replysignencrypted} (on by default) will sign
12708 automatically encrypted messages.
12710 Instructing @acronym{MML} to perform security operations on a
12711 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
12712 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
12717 @kindex C-c C-m s s (Message)
12718 @findex mml-secure-message-sign-smime
12720 Digitally sign current message using @acronym{S/MIME}.
12723 @kindex C-c C-m s o (Message)
12724 @findex mml-secure-message-sign-pgp
12726 Digitally sign current message using @acronym{PGP}.
12729 @kindex C-c C-m s p (Message)
12730 @findex mml-secure-message-sign-pgp
12732 Digitally sign current message using @acronym{PGP/MIME}.
12735 @kindex C-c C-m c s (Message)
12736 @findex mml-secure-message-encrypt-smime
12738 Digitally encrypt current message using @acronym{S/MIME}.
12741 @kindex C-c C-m c o (Message)
12742 @findex mml-secure-message-encrypt-pgp
12744 Digitally encrypt current message using @acronym{PGP}.
12747 @kindex C-c C-m c p (Message)
12748 @findex mml-secure-message-encrypt-pgpmime
12750 Digitally encrypt current message using @acronym{PGP/MIME}.
12753 @kindex C-c C-m C-n (Message)
12754 @findex mml-unsecure-message
12755 Remove security related @acronym{MML} tags from message.
12759 @xref{Security, ,Security, message, Message Manual}, for more information.
12761 @node Select Methods
12762 @chapter Select Methods
12763 @cindex foreign groups
12764 @cindex select methods
12766 A @dfn{foreign group} is a group not read by the usual (or
12767 default) means. It could be, for instance, a group from a different
12768 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12769 personal mail group.
12771 A foreign group (or any group, really) is specified by a @dfn{name} and
12772 a @dfn{select method}. To take the latter first, a select method is a
12773 list where the first element says what back end to use (e.g. @code{nntp},
12774 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12775 name}. There may be additional elements in the select method, where the
12776 value may have special meaning for the back end in question.
12778 One could say that a select method defines a @dfn{virtual server}---so
12779 we do just that (@pxref{Server Buffer}).
12781 The @dfn{name} of the group is the name the back end will recognize the
12784 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12785 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12786 method @code{(nntp "some.where.edu")}. Gnus will call this group
12787 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12788 back end just knows this group as @samp{soc.motss}.
12790 The different methods all have their peculiarities, of course.
12793 * Server Buffer:: Making and editing virtual servers.
12794 * Getting News:: Reading USENET news with Gnus.
12795 * Getting Mail:: Reading your personal mail with Gnus.
12796 * Browsing the Web:: Getting messages from a plethora of Web sources.
12797 * IMAP:: Using Gnus as a @acronym{IMAP} client.
12798 * Other Sources:: Reading directories, files, SOUP packets.
12799 * Combined Groups:: Combining groups into one group.
12800 * Email Based Diary:: Using mails to manage diary events in Gnus.
12801 * Gnus Unplugged:: Reading news and mail offline.
12805 @node Server Buffer
12806 @section Server Buffer
12808 Traditionally, a @dfn{server} is a machine or a piece of software that
12809 one connects to, and then requests information from. Gnus does not
12810 connect directly to any real servers, but does all transactions through
12811 one back end or other. But that's just putting one layer more between
12812 the actual media and Gnus, so we might just as well say that each
12813 back end represents a virtual server.
12815 For instance, the @code{nntp} back end may be used to connect to several
12816 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12817 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12818 use, and what parameters to set by specifying a @dfn{select method}.
12820 These select method specifications can sometimes become quite
12821 complicated---say, for instance, that you want to read from the
12822 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12823 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12824 Anyway, if you had to specify that for each group that used this
12825 server, that would be too much work, so Gnus offers a way of naming
12826 select methods, which is what you do in the server buffer.
12828 To enter the server buffer, use the @kbd{^}
12829 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12832 * Server Buffer Format:: You can customize the look of this buffer.
12833 * Server Commands:: Commands to manipulate servers.
12834 * Example Methods:: Examples server specifications.
12835 * Creating a Virtual Server:: An example session.
12836 * Server Variables:: Which variables to set.
12837 * Servers and Methods:: You can use server names as select methods.
12838 * Unavailable Servers:: Some servers you try to contact may be down.
12841 @vindex gnus-server-mode-hook
12842 @code{gnus-server-mode-hook} is run when creating the server buffer.
12845 @node Server Buffer Format
12846 @subsection Server Buffer Format
12847 @cindex server buffer format
12849 @vindex gnus-server-line-format
12850 You can change the look of the server buffer lines by changing the
12851 @code{gnus-server-line-format} variable. This is a @code{format}-like
12852 variable, with some simple extensions:
12857 How the news is fetched---the back end name.
12860 The name of this server.
12863 Where the news is to be fetched from---the address.
12866 The opened/closed/denied status of the server.
12869 Whether this server is agentized.
12872 @vindex gnus-server-mode-line-format
12873 The mode line can also be customized by using the
12874 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12875 Formatting}). The following specs are understood:
12885 Also @pxref{Formatting Variables}.
12888 @node Server Commands
12889 @subsection Server Commands
12890 @cindex server commands
12896 @cindex keys, reserved for users (Server)
12897 The key @kbd{v} is reserved for users. You can bind it to some
12898 command or better use it as a prefix key.
12902 @findex gnus-server-add-server
12903 Add a new server (@code{gnus-server-add-server}).
12907 @findex gnus-server-edit-server
12908 Edit a server (@code{gnus-server-edit-server}).
12911 @kindex SPACE (Server)
12912 @findex gnus-server-read-server
12913 Browse the current server (@code{gnus-server-read-server}).
12917 @findex gnus-server-exit
12918 Return to the group buffer (@code{gnus-server-exit}).
12922 @findex gnus-server-kill-server
12923 Kill the current server (@code{gnus-server-kill-server}).
12927 @findex gnus-server-yank-server
12928 Yank the previously killed server (@code{gnus-server-yank-server}).
12932 @findex gnus-server-copy-server
12933 Copy the current server (@code{gnus-server-copy-server}).
12937 @findex gnus-server-list-servers
12938 List all servers (@code{gnus-server-list-servers}).
12942 @findex gnus-server-scan-server
12943 Request that the server scan its sources for new articles
12944 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12949 @findex gnus-server-regenerate-server
12950 Request that the server regenerate all its data structures
12951 (@code{gnus-server-regenerate-server}). This can be useful if you have
12952 a mail back end that has gotten out of sync.
12956 @findex gnus-server-compact-server
12958 Compact all groups in the server under point
12959 (@code{gnus-server-compact-server}). Currently implemented only in
12960 nnml (@pxref{Mail Spool}). This removes gaps between article numbers,
12961 hence getting a correct total article count.
12966 @node Example Methods
12967 @subsection Example Methods
12969 Most select methods are pretty simple and self-explanatory:
12972 (nntp "news.funet.fi")
12975 Reading directly from the spool is even simpler:
12981 As you can see, the first element in a select method is the name of the
12982 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12985 After these two elements, there may be an arbitrary number of
12986 @code{(@var{variable} @var{form})} pairs.
12988 To go back to the first example---imagine that you want to read from
12989 port 15 on that machine. This is what the select method should
12993 (nntp "news.funet.fi" (nntp-port-number 15))
12996 You should read the documentation to each back end to find out what
12997 variables are relevant, but here's an @code{nnmh} example:
12999 @code{nnmh} is a mail back end that reads a spool-like structure. Say
13000 you have two structures that you wish to access: One is your private
13001 mail spool, and the other is a public one. Here's the possible spec for
13005 (nnmh "private" (nnmh-directory "~/private/mail/"))
13008 (This server is then called @samp{private}, but you may have guessed
13011 Here's the method for a public spool:
13015 (nnmh-directory "/usr/information/spool/")
13016 (nnmh-get-new-mail nil))
13022 If you are behind a firewall and only have access to the @acronym{NNTP}
13023 server from the firewall machine, you can instruct Gnus to @code{rlogin}
13024 on the firewall machine and telnet from there to the @acronym{NNTP} server.
13025 Doing this can be rather fiddly, but your virtual server definition
13026 should probably look something like this:
13030 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
13031 (nntp-via-address "the.firewall.machine")
13032 (nntp-address "the.real.nntp.host")
13033 (nntp-end-of-line "\n"))
13036 If you want to use the wonderful @code{ssh} program to provide a
13037 compressed connection over the modem line, you could add the following
13038 configuration to the example above:
13041 (nntp-via-rlogin-command "ssh")
13044 See also @code{nntp-via-rlogin-command-switches}. Here's an example for
13045 an indirect connection:
13047 (setq gnus-select-method
13049 (nntp-address "news.server.example")
13050 (nntp-via-user-name "intermediate_user_name")
13051 (nntp-via-address "intermediate.host.example")
13052 (nntp-via-rlogin-command "ssh")
13053 (nntp-end-of-line "\n")
13054 (nntp-via-rlogin-command-switches ("-C" "-t" "-e" "none"))
13055 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)))
13058 If you're behind a firewall, but have direct access to the outside world
13059 through a wrapper command like "runsocks", you could open a socksified
13060 telnet connection to the news server as follows:
13064 (nntp-pre-command "runsocks")
13065 (nntp-open-connection-function nntp-open-via-telnet)
13066 (nntp-address "the.news.server")
13067 (nntp-end-of-line "\n"))
13070 This means that you have to have set up @code{ssh-agent} correctly to
13071 provide automatic authorization, of course. And to get a compressed
13072 connection, you have to have the @samp{Compression} option in the
13073 @code{ssh} @file{config} file.
13076 @node Creating a Virtual Server
13077 @subsection Creating a Virtual Server
13079 If you're saving lots of articles in the cache by using persistent
13080 articles, you may want to create a virtual server to read the cache.
13082 First you need to add a new server. The @kbd{a} command does that. It
13083 would probably be best to use @code{nnml} to read the cache. You
13084 could also use @code{nnspool} or @code{nnmh}, though.
13086 Type @kbd{a nnml RET cache RET}.
13088 You should now have a brand new @code{nnml} virtual server called
13089 @samp{cache}. You now need to edit it to have the right definitions.
13090 Type @kbd{e} to edit the server. You'll be entered into a buffer that
13091 will contain the following:
13101 (nnml-directory "~/News/cache/")
13102 (nnml-active-file "~/News/cache/active"))
13105 Type @kbd{C-c C-c} to return to the server buffer. If you now press
13106 @kbd{RET} over this virtual server, you should be entered into a browse
13107 buffer, and you should be able to enter any of the groups displayed.
13110 @node Server Variables
13111 @subsection Server Variables
13112 @cindex server variables
13113 @cindex server parameters
13115 One sticky point when defining variables (both on back ends and in Emacs
13116 in general) is that some variables are typically initialized from other
13117 variables when the definition of the variables is being loaded. If you
13118 change the ``base'' variable after the variables have been loaded, you
13119 won't change the ``derived'' variables.
13121 This typically affects directory and file variables. For instance,
13122 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
13123 directory variables are initialized from that variable, so
13124 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
13125 new virtual @code{nnml} server, it will @emph{not} suffice to set just
13126 @code{nnml-directory}---you have to explicitly set all the file
13127 variables to be what you want them to be. For a complete list of
13128 variables for each back end, see each back end's section later in this
13129 manual, but here's an example @code{nnml} definition:
13133 (nnml-directory "~/my-mail/")
13134 (nnml-active-file "~/my-mail/active")
13135 (nnml-newsgroups-file "~/my-mail/newsgroups"))
13138 Server variables are often called @dfn{server parameters}.
13140 @node Servers and Methods
13141 @subsection Servers and Methods
13143 Wherever you would normally use a select method
13144 (e.g. @code{gnus-secondary-select-method}, in the group select method,
13145 when browsing a foreign server) you can use a virtual server name
13146 instead. This could potentially save lots of typing. And it's nice all
13150 @node Unavailable Servers
13151 @subsection Unavailable Servers
13153 If a server seems to be unreachable, Gnus will mark that server as
13154 @code{denied}. That means that any subsequent attempt to make contact
13155 with that server will just be ignored. ``It can't be opened,'' Gnus
13156 will tell you, without making the least effort to see whether that is
13157 actually the case or not.
13159 That might seem quite naughty, but it does make sense most of the time.
13160 Let's say you have 10 groups subscribed to on server
13161 @samp{nephelococcygia.com}. This server is located somewhere quite far
13162 away from you and the machine is quite slow, so it takes 1 minute just
13163 to find out that it refuses connection to you today. If Gnus were to
13164 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
13165 attempt to do that. Once it has gotten a single ``connection refused'',
13166 it will regard that server as ``down''.
13168 So, what happens if the machine was only feeling unwell temporarily?
13169 How do you test to see whether the machine has come up again?
13171 You jump to the server buffer (@pxref{Server Buffer}) and poke it
13172 with the following commands:
13178 @findex gnus-server-open-server
13179 Try to establish connection to the server on the current line
13180 (@code{gnus-server-open-server}).
13184 @findex gnus-server-close-server
13185 Close the connection (if any) to the server
13186 (@code{gnus-server-close-server}).
13190 @findex gnus-server-deny-server
13191 Mark the current server as unreachable
13192 (@code{gnus-server-deny-server}).
13195 @kindex M-o (Server)
13196 @findex gnus-server-open-all-servers
13197 Open the connections to all servers in the buffer
13198 (@code{gnus-server-open-all-servers}).
13201 @kindex M-c (Server)
13202 @findex gnus-server-close-all-servers
13203 Close the connections to all servers in the buffer
13204 (@code{gnus-server-close-all-servers}).
13208 @findex gnus-server-remove-denials
13209 Remove all marks to whether Gnus was denied connection from any servers
13210 (@code{gnus-server-remove-denials}).
13214 @findex gnus-server-offline-server
13215 Set server status to offline (@code{gnus-server-offline-server}).
13221 @section Getting News
13222 @cindex reading news
13223 @cindex news back ends
13225 A newsreader is normally used for reading news. Gnus currently provides
13226 only two methods of getting news---it can read from an @acronym{NNTP} server,
13227 or it can read from a local spool.
13230 * NNTP:: Reading news from an @acronym{NNTP} server.
13231 * News Spool:: Reading news from the local spool.
13239 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
13240 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
13241 server as the, uhm, address.
13243 If the @acronym{NNTP} server is located at a non-standard port, setting the
13244 third element of the select method to this port number should allow you
13245 to connect to the right port. You'll have to edit the group info for
13246 that (@pxref{Foreign Groups}).
13248 The name of the foreign group can be the same as a native group. In
13249 fact, you can subscribe to the same group from as many different servers
13250 you feel like. There will be no name collisions.
13252 The following variables can be used to create a virtual @code{nntp}
13257 @item nntp-server-opened-hook
13258 @vindex nntp-server-opened-hook
13259 @cindex @sc{mode reader}
13261 @cindex authentication
13262 @cindex nntp authentication
13263 @findex nntp-send-authinfo
13264 @findex nntp-send-mode-reader
13265 is run after a connection has been made. It can be used to send
13266 commands to the @acronym{NNTP} server after it has been contacted. By
13267 default it sends the command @code{MODE READER} to the server with the
13268 @code{nntp-send-mode-reader} function. This function should always be
13269 present in this hook.
13271 @item nntp-authinfo-function
13272 @vindex nntp-authinfo-function
13273 @findex nntp-send-authinfo
13274 @vindex nntp-authinfo-file
13275 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
13276 server. The default function is @code{nntp-send-authinfo}, which looks
13277 through your @file{~/.authinfo} (or whatever you've set the
13278 @code{nntp-authinfo-file} variable to) for applicable entries. If none
13279 are found, it will prompt you for a login name and a password. The
13280 format of the @file{~/.authinfo} file is (almost) the same as the
13281 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
13282 manual page, but here are the salient facts:
13286 The file contains one or more line, each of which define one server.
13289 Each line may contain an arbitrary number of token/value pairs.
13291 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
13292 @samp{default}. In addition Gnus introduces two new tokens, not present
13293 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
13294 @samp{force}. (This is the only way the @file{.authinfo} file format
13295 deviates from the @file{.netrc} file format.) @samp{port} is used to
13296 indicate what port on the server the credentials apply to and
13297 @samp{force} is explained below.
13301 Here's an example file:
13304 machine news.uio.no login larsi password geheimnis
13305 machine nntp.ifi.uio.no login larsi force yes
13308 The token/value pairs may appear in any order; @samp{machine} doesn't
13309 have to be first, for instance.
13311 In this example, both login name and password have been supplied for the
13312 former server, while the latter has only the login name listed, and the
13313 user will be prompted for the password. The latter also has the
13314 @samp{force} tag, which means that the authinfo will be sent to the
13315 @var{nntp} server upon connection; the default (i.e., when there is not
13316 @samp{force} tag) is to not send authinfo to the @var{nntp} server
13317 until the @var{nntp} server asks for it.
13319 You can also add @samp{default} lines that will apply to all servers
13320 that don't have matching @samp{machine} lines.
13326 This will force sending @samp{AUTHINFO} commands to all servers not
13327 previously mentioned.
13329 Remember to not leave the @file{~/.authinfo} file world-readable.
13331 @item nntp-server-action-alist
13332 @vindex nntp-server-action-alist
13333 This is a list of regexps to match on server types and actions to be
13334 taken when matches are made. For instance, if you want Gnus to beep
13335 every time you connect to innd, you could say something like:
13338 (setq nntp-server-action-alist
13339 '(("innd" (ding))))
13342 You probably don't want to do that, though.
13344 The default value is
13347 '(("nntpd 1\\.5\\.11t"
13348 (remove-hook 'nntp-server-opened-hook
13349 'nntp-send-mode-reader)))
13352 This ensures that Gnus doesn't send the @code{MODE READER} command to
13353 nntpd 1.5.11t, since that command chokes that server, I've been told.
13355 @item nntp-maximum-request
13356 @vindex nntp-maximum-request
13357 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
13358 will collect headers by sending a series of @code{head} commands. To
13359 speed things up, the back end sends lots of these commands without
13360 waiting for reply, and then reads all the replies. This is controlled
13361 by the @code{nntp-maximum-request} variable, and is 400 by default. If
13362 your network is buggy, you should set this to 1.
13364 @item nntp-connection-timeout
13365 @vindex nntp-connection-timeout
13366 If you have lots of foreign @code{nntp} groups that you connect to
13367 regularly, you're sure to have problems with @acronym{NNTP} servers not
13368 responding properly, or being too loaded to reply within reasonable
13369 time. This is can lead to awkward problems, which can be helped
13370 somewhat by setting @code{nntp-connection-timeout}. This is an integer
13371 that says how many seconds the @code{nntp} back end should wait for a
13372 connection before giving up. If it is @code{nil}, which is the default,
13373 no timeouts are done.
13375 @item nntp-nov-is-evil
13376 @vindex nntp-nov-is-evil
13377 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
13378 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
13381 @item nntp-xover-commands
13382 @vindex nntp-xover-commands
13383 @cindex @acronym{NOV}
13385 List of strings used as commands to fetch @acronym{NOV} lines from a
13386 server. The default value of this variable is @code{("XOVER"
13390 @vindex nntp-nov-gap
13391 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
13392 the server. The server responds with one huge list of lines. However,
13393 if you have read articles 2-5000 in the group, and only want to read
13394 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
13395 lines that you will not need. This variable says how
13396 big a gap between two consecutive articles is allowed to be before the
13397 @code{XOVER} request is split into several request. Note that if your
13398 network is fast, setting this variable to a really small number means
13399 that fetching will probably be slower. If this variable is @code{nil},
13400 @code{nntp} will never split requests. The default is 5.
13402 @item nntp-xref-number-is-evil
13403 @vindex nntp-xref-number-is-evil
13404 When Gnus refers to an article having the @code{Message-ID} that a user
13405 specifies or having the @code{Message-ID} of the parent article of the
13406 current one (@pxref{Finding the Parent}), Gnus sends a @code{HEAD}
13407 command to the @acronym{NNTP} server to know where it is, and the server
13408 returns the data containing the pairs of a group and an article number
13409 in the @code{Xref} header. Gnus normally uses the article number to
13410 refer to the article if the data shows that that article is in the
13411 current group, while it uses the @code{Message-ID} otherwise. However,
13412 some news servers, e.g., ones running Diablo, run multiple engines
13413 having the same articles but article numbers are not kept synchronized
13414 between them. In that case, the article number that appears in the
13415 @code{Xref} header varies by which engine is chosen, so you cannot refer
13416 to the parent article that is in the current group, for instance. If
13417 you connect to such a server, set this variable to a non-@code{nil}
13418 value, and Gnus never uses article numbers. For example:
13421 (setq gnus-select-method
13423 (nntp-address "newszilla.example.com")
13424 (nntp-xref-number-is-evil t)
13428 The default value of this server variable is @code{nil}.
13430 @item nntp-prepare-server-hook
13431 @vindex nntp-prepare-server-hook
13432 A hook run before attempting to connect to an @acronym{NNTP} server.
13434 @item nntp-record-commands
13435 @vindex nntp-record-commands
13436 If non-@code{nil}, @code{nntp} will log all commands it sends to the
13437 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
13438 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
13439 that doesn't seem to work.
13441 @item nntp-open-connection-function
13442 @vindex nntp-open-connection-function
13443 It is possible to customize how the connection to the nntp server will
13444 be opened. If you specify an @code{nntp-open-connection-function}
13445 parameter, Gnus will use that function to establish the connection.
13446 Seven pre-made functions are supplied. These functions can be grouped
13447 in two categories: direct connection functions (four pre-made), and
13448 indirect ones (three pre-made).
13450 @item nntp-never-echoes-commands
13451 @vindex nntp-never-echoes-commands
13452 Non-@code{nil} means the nntp server never echoes commands. It is
13453 reported that some nntps server doesn't echo commands. So, you may want
13454 to set this to non-@code{nil} in the method for such a server setting
13455 @code{nntp-open-connection-function} to @code{nntp-open-ssl-stream} for
13456 example. The default value is @code{nil}. Note that the
13457 @code{nntp-open-connection-functions-never-echo-commands} variable
13458 overrides the @code{nil} value of this variable.
13460 @item nntp-open-connection-functions-never-echo-commands
13461 @vindex nntp-open-connection-functions-never-echo-commands
13462 List of functions that never echo commands. Add or set a function which
13463 you set to @code{nntp-open-connection-function} to this list if it does
13464 not echo commands. Note that a non-@code{nil} value of the
13465 @code{nntp-never-echoes-commands} variable overrides this variable. The
13466 default value is @code{(nntp-open-network-stream)}.
13468 @item nntp-prepare-post-hook
13469 @vindex nntp-prepare-post-hook
13470 A hook run just before posting an article. If there is no
13471 @code{Message-ID} header in the article and the news server provides the
13472 recommended ID, it will be added to the article before running this
13473 hook. It is useful to make @code{Cancel-Lock} headers even if you
13474 inhibit Gnus to add a @code{Message-ID} header, you could say:
13477 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
13480 Note that not all servers support the recommended ID. This works for
13481 INN versions 2.3.0 and later, for instance.
13486 * Direct Functions:: Connecting directly to the server.
13487 * Indirect Functions:: Connecting indirectly to the server.
13488 * Common Variables:: Understood by several connection functions.
13489 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
13493 @node Direct Functions
13494 @subsubsection Direct Functions
13495 @cindex direct connection functions
13497 These functions are called direct because they open a direct connection
13498 between your machine and the @acronym{NNTP} server. The behavior of these
13499 functions is also affected by commonly understood variables
13500 (@pxref{Common Variables}).
13503 @findex nntp-open-network-stream
13504 @item nntp-open-network-stream
13505 This is the default, and simply connects to some port or other on the
13508 @findex nntp-open-tls-stream
13509 @item nntp-open-tls-stream
13510 Opens a connection to a server over a @dfn{secure} channel. To use
13511 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
13512 installed. You then define a server as follows:
13515 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
13516 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
13518 (nntp "snews.bar.com"
13519 (nntp-open-connection-function nntp-open-tls-stream)
13520 (nntp-port-number )
13521 (nntp-address "snews.bar.com"))
13524 @findex nntp-open-ssl-stream
13525 @item nntp-open-ssl-stream
13526 Opens a connection to a server over a @dfn{secure} channel. To use
13527 this you must have @uref{http://www.openssl.org, OpenSSL} or
13528 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
13529 then define a server as follows:
13532 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
13533 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
13535 (nntp "snews.bar.com"
13536 (nntp-open-connection-function nntp-open-ssl-stream)
13537 (nntp-port-number 563)
13538 (nntp-address "snews.bar.com"))
13541 @findex nntp-open-telnet-stream
13542 @item nntp-open-telnet-stream
13543 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
13544 it. You might wonder why this function exists, since we have the
13545 default @code{nntp-open-network-stream} which would do the job. (One
13546 of) the reason(s) is that if you are behind a firewall but have direct
13547 connections to the outside world thanks to a command wrapper like
13548 @code{runsocks}, you can use it like this:
13552 (nntp-pre-command "runsocks")
13553 (nntp-open-connection-function nntp-open-telnet-stream)
13554 (nntp-address "the.news.server"))
13557 With the default method, you would need to wrap your whole Emacs
13558 session, which is not a good idea.
13562 @node Indirect Functions
13563 @subsubsection Indirect Functions
13564 @cindex indirect connection functions
13566 These functions are called indirect because they connect to an
13567 intermediate host before actually connecting to the @acronym{NNTP} server.
13568 All of these functions and related variables are also said to belong to
13569 the ``via'' family of connection: they're all prefixed with ``via'' to make
13570 things cleaner. The behavior of these functions is also affected by
13571 commonly understood variables (@pxref{Common Variables}).
13574 @item nntp-open-via-rlogin-and-telnet
13575 @findex nntp-open-via-rlogin-and-telnet
13576 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
13577 to the real @acronym{NNTP} server from there. This is useful for instance if
13578 you need to connect to a firewall machine first.
13580 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
13583 @item nntp-via-rlogin-command
13584 @vindex nntp-via-rlogin-command
13585 Command used to log in on the intermediate host. The default is
13586 @samp{rsh}, but @samp{ssh} is a popular alternative.
13588 @item nntp-via-rlogin-command-switches
13589 @vindex nntp-via-rlogin-command-switches
13590 List of strings to be used as the switches to
13591 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
13592 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
13593 @samp{("-C")} in order to compress all data connections, otherwise set
13594 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
13595 the telnet command requires a pseudo-tty allocation on an intermediate
13599 Note that you may want to change the value for @code{nntp-end-of-line}
13600 to @samp{\n} (@pxref{Common Variables}).
13602 @item nntp-open-via-rlogin-and-netcat
13603 @findex nntp-open-via-rlogin-and-netcat
13604 Does essentially the same, but uses
13605 @uref{http://netcat.sourceforge.net/, netcat} instead of @samp{telnet}
13606 to connect to the real @acronym{NNTP} server from the intermediate host.
13608 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
13611 @item nntp-via-netcat-command
13612 @vindex nntp-via-netcat-command
13613 Command used to connect to the real @acronym{NNTP} server from the
13614 intermediate host. The default is @samp{nc}. You can also use other
13615 programs like @uref{http://www.imasy.or.jp/~gotoh/ssh/connect.html,
13618 @item nntp-via-netcat-switches
13619 @vindex nntp-via-netcat-switches
13620 List of strings to be used as the switches to the
13621 @code{nntp-via-telnet-command} command. The default is @code{nil}.
13623 @item nntp-via-rlogin-command
13624 @vindex nntp-via-rlogin-command
13625 Command used to log in on the intermediate host. The default is
13626 @samp{rsh}, but @samp{ssh} is a popular alternative.
13628 @item nntp-via-rlogin-command-switches
13629 @vindex nntp-via-rlogin-command-switches
13630 List of strings to be used as the switches to
13631 @code{nntp-via-rlogin-command}. The default is @code{nil}.
13634 @item nntp-open-via-telnet-and-telnet
13635 @findex nntp-open-via-telnet-and-telnet
13636 Does essentially the same, but uses @samp{telnet} instead of
13637 @samp{rlogin} to connect to the intermediate host.
13639 @code{nntp-open-via-telnet-and-telnet}-specific variables:
13642 @item nntp-via-telnet-command
13643 @vindex nntp-via-telnet-command
13644 Command used to @code{telnet} the intermediate host. The default is
13647 @item nntp-via-telnet-switches
13648 @vindex nntp-via-telnet-switches
13649 List of strings to be used as the switches to the
13650 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
13652 @item nntp-via-user-password
13653 @vindex nntp-via-user-password
13654 Password to use when logging in on the intermediate host.
13656 @item nntp-via-envuser
13657 @vindex nntp-via-envuser
13658 If non-@code{nil}, the intermediate @code{telnet} session (client and
13659 server both) will support the @code{ENVIRON} option and not prompt for
13660 login name. This works for Solaris @code{telnet}, for instance.
13662 @item nntp-via-shell-prompt
13663 @vindex nntp-via-shell-prompt
13664 Regexp matching the shell prompt on the intermediate host. The default
13665 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
13669 Note that you may want to change the value for @code{nntp-end-of-line}
13670 to @samp{\n} (@pxref{Common Variables}).
13674 Here are some additional variables that are understood by all the above
13679 @item nntp-via-user-name
13680 @vindex nntp-via-user-name
13681 User name to use when connecting to the intermediate host.
13683 @item nntp-via-address
13684 @vindex nntp-via-address
13685 Address of the intermediate host to connect to.
13690 @node Common Variables
13691 @subsubsection Common Variables
13693 The following variables affect the behavior of all, or several of the
13694 pre-made connection functions. When not specified, all functions are
13695 affected (the values of the following variables will be used as the
13696 default if each virtual @code{nntp} server doesn't specify those server
13697 variables individually).
13701 @item nntp-pre-command
13702 @vindex nntp-pre-command
13703 A command wrapper to use when connecting through a non native
13704 connection function (all except @code{nntp-open-network-stream},
13705 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}). This is
13706 where you would put a @samp{SOCKS} wrapper for instance.
13709 @vindex nntp-address
13710 The address of the @acronym{NNTP} server.
13712 @item nntp-port-number
13713 @vindex nntp-port-number
13714 Port number to connect to the @acronym{NNTP} server. The default is
13715 @samp{nntp}. If you use @acronym{NNTP} over
13716 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
13717 than named ports (i.e, use @samp{563} instead of @samp{snews} or
13718 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
13719 not work with named ports.
13721 @item nntp-end-of-line
13722 @vindex nntp-end-of-line
13723 String to use as end-of-line marker when talking to the @acronym{NNTP}
13724 server. This is @samp{\r\n} by default, but should be @samp{\n} when
13725 using a non native telnet connection function.
13727 @item nntp-telnet-command
13728 @vindex nntp-telnet-command
13729 Command to use when connecting to the @acronym{NNTP} server through
13730 @samp{telnet}. This is @emph{not} for an intermediate host. This is
13731 just for the real @acronym{NNTP} server. The default is
13734 @item nntp-telnet-switches
13735 @vindex nntp-telnet-switches
13736 A list of switches to pass to @code{nntp-telnet-command}. The default
13742 @subsubsection NNTP marks
13743 @cindex storing NNTP marks
13745 Gnus stores marks (@pxref{Marking Articles}) for @acronym{NNTP}
13746 servers in marks files. A marks file records what marks you have set
13747 in a group and each file is specific to the corresponding server.
13748 Marks files are stored in @file{~/News/marks}
13749 (@code{nntp-marks-directory}) under a classic hierarchy resembling
13750 that of a news server, for example marks for the group
13751 @samp{gmane.discuss} on the news.gmane.org server will be stored in
13752 the file @file{~/News/marks/news.gmane.org/gmane/discuss/.marks}.
13754 Marks files are useful because you can copy the @file{~/News/marks}
13755 directory (using rsync, scp or whatever) to another Gnus installation,
13756 and it will realize what articles you have read and marked. The data
13757 in @file{~/News/marks} has priority over the same data in
13758 @file{~/.newsrc.eld}.
13760 Note that marks files are very much server-specific: Gnus remembers
13761 the article numbers so if you don't use the same servers on both
13762 installations things are most likely to break (most @acronym{NNTP}
13763 servers do not use the same article numbers as any other server).
13764 However, if you use servers A, B, C on one installation and servers A,
13765 D, E on the other, you can sync the marks files for A and then you'll
13766 get synchronization for that server between the two installations.
13768 Using @acronym{NNTP} marks can possibly incur a performance penalty so
13769 if Gnus feels sluggish, try setting the @code{nntp-marks-is-evil}
13770 variable to @code{t}. Marks will then be stored in @file{~/.newsrc.eld}.
13776 @item nntp-marks-is-evil
13777 @vindex nntp-marks-is-evil
13778 If non-@code{nil}, this back end will ignore any marks files. The
13779 default is @code{nil}.
13781 @item nntp-marks-directory
13782 @vindex nntp-marks-directory
13783 The directory where marks for nntp groups will be stored.
13789 @subsection News Spool
13793 Subscribing to a foreign group from the local spool is extremely easy,
13794 and might be useful, for instance, to speed up reading groups that
13795 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
13798 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
13799 anything else) as the address.
13801 If you have access to a local spool, you should probably use that as the
13802 native select method (@pxref{Finding the News}). It is normally faster
13803 than using an @code{nntp} select method, but might not be. It depends.
13804 You just have to try to find out what's best at your site.
13808 @item nnspool-inews-program
13809 @vindex nnspool-inews-program
13810 Program used to post an article.
13812 @item nnspool-inews-switches
13813 @vindex nnspool-inews-switches
13814 Parameters given to the inews program when posting an article.
13816 @item nnspool-spool-directory
13817 @vindex nnspool-spool-directory
13818 Where @code{nnspool} looks for the articles. This is normally
13819 @file{/usr/spool/news/}.
13821 @item nnspool-nov-directory
13822 @vindex nnspool-nov-directory
13823 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
13824 @file{/usr/spool/news/over.view/}.
13826 @item nnspool-lib-dir
13827 @vindex nnspool-lib-dir
13828 Where the news lib dir is (@file{/usr/lib/news/} by default).
13830 @item nnspool-active-file
13831 @vindex nnspool-active-file
13832 The name of the active file.
13834 @item nnspool-newsgroups-file
13835 @vindex nnspool-newsgroups-file
13836 The name of the group descriptions file.
13838 @item nnspool-history-file
13839 @vindex nnspool-history-file
13840 The name of the news history file.
13842 @item nnspool-active-times-file
13843 @vindex nnspool-active-times-file
13844 The name of the active date file.
13846 @item nnspool-nov-is-evil
13847 @vindex nnspool-nov-is-evil
13848 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13851 @item nnspool-sift-nov-with-sed
13852 @vindex nnspool-sift-nov-with-sed
13854 If non-@code{nil}, which is the default, use @code{sed} to get the
13855 relevant portion from the overview file. If @code{nil},
13856 @code{nnspool} will load the entire file into a buffer and process it
13863 @section Getting Mail
13864 @cindex reading mail
13867 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13871 * Mail in a Newsreader:: Important introductory notes.
13872 * Getting Started Reading Mail:: A simple cookbook example.
13873 * Splitting Mail:: How to create mail groups.
13874 * Mail Sources:: How to tell Gnus where to get mail from.
13875 * Mail Back End Variables:: Variables for customizing mail handling.
13876 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
13877 * Group Mail Splitting:: Use group customize to drive mail splitting.
13878 * Incorporating Old Mail:: What about the old mail you have?
13879 * Expiring Mail:: Getting rid of unwanted mail.
13880 * Washing Mail:: Removing cruft from the mail you get.
13881 * Duplicates:: Dealing with duplicated mail.
13882 * Not Reading Mail:: Using mail back ends for reading other files.
13883 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
13887 @node Mail in a Newsreader
13888 @subsection Mail in a Newsreader
13890 If you are used to traditional mail readers, but have decided to switch
13891 to reading mail with Gnus, you may find yourself experiencing something
13892 of a culture shock.
13894 Gnus does not behave like traditional mail readers. If you want to make
13895 it behave that way, you can, but it's an uphill battle.
13897 Gnus, by default, handles all its groups using the same approach. This
13898 approach is very newsreaderly---you enter a group, see the new/unread
13899 messages, and when you read the messages, they get marked as read, and
13900 you don't see them any more. (Unless you explicitly ask for them.)
13902 In particular, you do not do anything explicitly to delete messages.
13904 Does this mean that all the messages that have been marked as read are
13905 deleted? How awful!
13907 But, no, it means that old messages are @dfn{expired} according to some
13908 scheme or other. For news messages, the expire process is controlled by
13909 the news administrator; for mail, the expire process is controlled by
13910 you. The expire process for mail is covered in depth in @ref{Expiring
13913 What many Gnus users find, after using it a while for both news and
13914 mail, is that the transport mechanism has very little to do with how
13915 they want to treat a message.
13917 Many people subscribe to several mailing lists. These are transported
13918 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13919 answering, or even reading these messages very carefully. We may not
13920 need to save them because if we should need to read one again, they are
13921 archived somewhere else.
13923 Some people have local news groups which have only a handful of readers.
13924 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13925 to read and answer a large fraction of the messages very carefully in
13926 order to do our work. And there may not be an archive, so we may need
13927 to save the interesting messages the same way we would personal mail.
13929 The important distinction turns out to be not the transport mechanism,
13930 but other factors such as how interested we are in the subject matter,
13931 or how easy it is to retrieve the message if we need to read it again.
13933 Gnus provides many options for sorting mail into ``groups'' which behave
13934 like newsgroups, and for treating each group (whether mail or news)
13937 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13938 that Gnus should grow up and be a male, er, mail reader. It is possible
13939 to whip Gnus into a more mailreaderly being, but, as said before, it's
13940 not easy. People who prefer proper mail readers should try @sc{vm}
13941 instead, which is an excellent, and proper, mail reader.
13943 I don't mean to scare anybody off, but I want to make it clear that you
13944 may be required to learn a new way of thinking about messages. After
13945 you've been subjected to The Gnus Way, you will come to love it. I can
13946 guarantee it. (At least the guy who sold me the Emacs Subliminal
13947 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13948 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13952 @node Getting Started Reading Mail
13953 @subsection Getting Started Reading Mail
13955 It's quite easy to use Gnus to read your new mail. You just plonk the
13956 mail back end of your choice into @code{gnus-secondary-select-methods},
13957 and things will happen automatically.
13959 For instance, if you want to use @code{nnml} (which is a ``one file per
13960 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13963 (setq gnus-secondary-select-methods '((nnml "")))
13966 Now, the next time you start Gnus, this back end will be queried for new
13967 articles, and it will move all the messages in your spool file to its
13968 directory, which is @file{~/Mail/} by default. The new group that will
13969 be created (@samp{mail.misc}) will be subscribed, and you can read it
13970 like any other group.
13972 You will probably want to split the mail into several groups, though:
13975 (setq nnmail-split-methods
13976 '(("junk" "^From:.*Lars Ingebrigtsen")
13977 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13981 This will result in three new @code{nnml} mail groups being created:
13982 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
13983 mail that doesn't fit into the first two groups will be placed in the
13986 This should be sufficient for reading mail with Gnus. You might want to
13987 give the other sections in this part of the manual a perusal, though.
13988 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13991 @node Splitting Mail
13992 @subsection Splitting Mail
13993 @cindex splitting mail
13994 @cindex mail splitting
13995 @cindex mail filtering (splitting)
13997 @vindex nnmail-split-methods
13998 The @code{nnmail-split-methods} variable says how the incoming mail is
13999 to be split into groups.
14002 (setq nnmail-split-methods
14003 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
14004 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
14005 ("mail.other" "")))
14008 This variable is a list of lists, where the first element of each of
14009 these lists is the name of the mail group (they do not have to be called
14010 something beginning with @samp{mail}, by the way), and the second
14011 element is a regular expression used on the header of each mail to
14012 determine if it belongs in this mail group. The first string may
14013 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
14014 insert sub-expressions from the matched text. For instance:
14017 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
14021 In that case, @code{nnmail-split-lowercase-expanded} controls whether
14022 the inserted text should be made lowercase. @xref{Fancy Mail Splitting}.
14024 The second element can also be a function. In that case, it will be
14025 called narrowed to the headers with the first element of the rule as the
14026 argument. It should return a non-@code{nil} value if it thinks that the
14027 mail belongs in that group.
14029 @cindex @samp{bogus} group
14030 The last of these groups should always be a general one, and the regular
14031 expression should @emph{always} be @samp{""} so that it matches any mails
14032 that haven't been matched by any of the other regexps. (These rules are
14033 processed from the beginning of the alist toward the end. The first rule
14034 to make a match will ``win'', unless you have crossposting enabled. In
14035 that case, all matching rules will ``win''.) If no rule matched, the mail
14036 will end up in the @samp{bogus} group. When new groups are created by
14037 splitting mail, you may want to run @code{gnus-group-find-new-groups} to
14038 see the new groups. This also applies to the @samp{bogus} group.
14040 If you like to tinker with this yourself, you can set this variable to a
14041 function of your choice. This function will be called without any
14042 arguments in a buffer narrowed to the headers of an incoming mail
14043 message. The function should return a list of group names that it
14044 thinks should carry this mail message.
14046 Note that the mail back ends are free to maul the poor, innocent,
14047 incoming headers all they want to. They all add @code{Lines} headers;
14048 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
14049 @code{From<SPACE>} line to something else.
14051 @vindex nnmail-crosspost
14052 The mail back ends all support cross-posting. If several regexps match,
14053 the mail will be ``cross-posted'' to all those groups.
14054 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
14055 that no articles are crossposted to the general (@samp{""}) group.
14057 @vindex nnmail-crosspost-link-function
14060 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
14061 the crossposted articles. However, not all file systems support hard
14062 links. If that's the case for you, set
14063 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
14064 variable is @code{add-name-to-file} by default.)
14066 @kindex M-x nnmail-split-history
14067 @findex nnmail-split-history
14068 If you wish to see where the previous mail split put the messages, you
14069 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
14070 where re-spooling messages would put the messages, you can use
14071 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
14074 @vindex nnmail-split-header-length-limit
14075 Header lines longer than the value of
14076 @code{nnmail-split-header-length-limit} are excluded from the split
14079 @vindex nnmail-mail-splitting-decodes
14080 @vindex nnmail-mail-splitting-charset
14081 By default, splitting does not decode headers, so you can not match on
14082 non-@acronym{ASCII} strings. But it is useful if you want to match
14083 articles based on the raw header data. To enable it, set the
14084 @code{nnmail-mail-splitting-decodes} variable to a non-@code{nil} value.
14085 In addition, the value of the @code{nnmail-mail-splitting-charset}
14086 variable is used for decoding non-@acronym{MIME} encoded string when
14087 @code{nnmail-mail-splitting-decodes} is non-@code{nil}. The default
14088 value is @code{nil} which means not to decode non-@acronym{MIME} encoded
14089 string. A suitable value for you will be @code{undecided} or be the
14090 charset used normally in mails you are interested in.
14092 @vindex nnmail-resplit-incoming
14093 By default, splitting is performed on all incoming messages. If you
14094 specify a @code{directory} entry for the variable @code{mail-sources}
14095 (@pxref{Mail Source Specifiers}), however, then splitting does
14096 @emph{not} happen by default. You can set the variable
14097 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
14098 splitting happen even in this case. (This variable has no effect on
14099 other kinds of entries.)
14101 Gnus gives you all the opportunity you could possibly want for shooting
14102 yourself in the foot. Let's say you create a group that will contain
14103 all the mail you get from your boss. And then you accidentally
14104 unsubscribe from the group. Gnus will still put all the mail from your
14105 boss in the unsubscribed group, and so, when your boss mails you ``Have
14106 that report ready by Monday or you're fired!'', you'll never see it and,
14107 come Tuesday, you'll still believe that you're gainfully employed while
14108 you really should be out collecting empty bottles to save up for next
14109 month's rent money.
14113 @subsection Mail Sources
14115 Mail can be gotten from many different sources---the mail spool, from
14116 a @acronym{POP} mail server, from a procmail directory, or from a
14117 maildir, for instance.
14120 * Mail Source Specifiers:: How to specify what a mail source is.
14121 * Mail Source Customization:: Some variables that influence things.
14122 * Fetching Mail:: Using the mail source specifiers.
14126 @node Mail Source Specifiers
14127 @subsubsection Mail Source Specifiers
14129 @cindex mail server
14132 @cindex mail source
14134 You tell Gnus how to fetch mail by setting @code{mail-sources}
14135 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
14140 (pop :server "pop3.mailserver.com" :user "myname")
14143 As can be observed, a mail source specifier is a list where the first
14144 element is a @dfn{mail source type}, followed by an arbitrary number of
14145 @dfn{keywords}. Keywords that are not explicitly specified are given
14148 The following mail source types are available:
14152 Get mail from a single file; typically from the mail spool.
14158 The file name. Defaults to the value of the @env{MAIL}
14159 environment variable or the value of @code{rmail-spool-directory}
14160 (usually something like @file{/usr/mail/spool/user-name}).
14164 Script run before/after fetching mail.
14167 An example file mail source:
14170 (file :path "/usr/spool/mail/user-name")
14173 Or using the default file name:
14179 If the mail spool file is not located on the local machine, it's best
14180 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
14181 You can not use ange-ftp file names here---it has no way to lock the
14182 mail spool while moving the mail.
14184 If it's impossible to set up a proper server, you can use ssh instead.
14188 '((file :prescript "ssh host bin/getmail >%t")))
14191 The @samp{getmail} script would look something like the following:
14195 # getmail - move mail from spool to stdout
14198 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
14200 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
14203 Alter this script to fit the @samp{movemail} and temporary
14204 file you want to use.
14208 @vindex nnmail-scan-directory-mail-source-once
14209 Get mail from several files in a directory. This is typically used
14210 when you have procmail split the incoming mail into several files.
14211 That is, there is a one-to-one correspondence between files in that
14212 directory and groups, so that mail from the file @file{foo.bar.spool}
14213 will be put in the group @code{foo.bar}. (You can change the suffix
14214 to be used instead of @code{.spool}.) Setting
14215 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
14216 Gnus to scan the mail source only once. This is particularly useful
14217 if you want to scan mail groups at a specified level.
14219 @vindex nnmail-resplit-incoming
14220 There is also the variable @code{nnmail-resplit-incoming}, if you set
14221 that to a non-@code{nil} value, then the normal splitting process is
14222 applied to all the files from the directory, @ref{Splitting Mail}.
14228 The name of the directory where the files are. There is no default
14232 Only files ending with this suffix are used. The default is
14236 Only files that have this predicate return non-@code{nil} are returned.
14237 The default is @code{identity}. This is used as an additional
14238 filter---only files that have the right suffix @emph{and} satisfy this
14239 predicate are considered.
14243 Script run before/after fetching mail.
14247 An example directory mail source:
14250 (directory :path "/home/user-name/procmail-dir/"
14255 Get mail from a @acronym{POP} server.
14261 The name of the @acronym{POP} server. The default is taken from the
14262 @env{MAILHOST} environment variable.
14265 The port number of the @acronym{POP} server. This can be a number (eg,
14266 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
14267 string, it should be a service name as listed in @file{/etc/services} on
14268 Unix systems. The default is @samp{"pop3"}. On some systems you might
14269 need to specify it as @samp{"pop-3"} instead.
14272 The user name to give to the @acronym{POP} server. The default is the login
14276 The password to give to the @acronym{POP} server. If not specified,
14277 the user is prompted.
14280 The program to use to fetch mail from the @acronym{POP} server. This
14281 should be a @code{format}-like string. Here's an example:
14284 fetchmail %u@@%s -P %p %t
14287 The valid format specifier characters are:
14291 The name of the file the mail is to be moved to. This must always be
14292 included in this string.
14295 The name of the server.
14298 The port number of the server.
14301 The user name to use.
14304 The password to use.
14307 The values used for these specs are taken from the values you give the
14308 corresponding keywords.
14311 A script to be run before fetching the mail. The syntax is the same as
14312 the @code{:program} keyword. This can also be a function to be run.
14315 A script to be run after fetching the mail. The syntax is the same as
14316 the @code{:program} keyword. This can also be a function to be run.
14319 The function to use to fetch mail from the @acronym{POP} server. The
14320 function is called with one parameter---the name of the file where the
14321 mail should be moved to.
14323 @item :authentication
14324 This can be either the symbol @code{password} or the symbol @code{apop}
14325 and says what authentication scheme to use. The default is
14330 @vindex pop3-movemail
14331 @vindex pop3-leave-mail-on-server
14332 If the @code{:program} and @code{:function} keywords aren't specified,
14333 @code{pop3-movemail} will be used. If @code{pop3-leave-mail-on-server}
14334 is non-@code{nil} the mail is to be left on the @acronym{POP} server
14335 after fetching when using @code{pop3-movemail}. Note that POP servers
14336 maintain no state information between sessions, so what the client
14337 believes is there and what is actually there may not match up. If they
14338 do not, then you may get duplicate mails or the whole thing can fall
14339 apart and leave you with a corrupt mailbox.
14341 Here are some examples for getting mail from a @acronym{POP} server.
14342 Fetch from the default @acronym{POP} server, using the default user
14343 name, and default fetcher:
14349 Fetch from a named server with a named user and password:
14352 (pop :server "my.pop.server"
14353 :user "user-name" :password "secret")
14356 Use @samp{movemail} to move the mail:
14359 (pop :program "movemail po:%u %t %p")
14363 Get mail from a maildir. This is a type of mailbox that is supported by
14364 at least qmail and postfix, where each file in a special directory
14365 contains exactly one mail.
14371 The name of the directory where the mails are stored. The default is
14372 taken from the @env{MAILDIR} environment variable or
14375 The subdirectories of the Maildir. The default is
14376 @samp{("new" "cur")}.
14378 @c If you sometimes look at your mail through a pop3 daemon before fetching
14379 @c them with Gnus, you may also have to fetch your mails from the
14380 @c @code{cur} directory inside the maildir, like in the first example
14383 You can also get mails from remote hosts (because maildirs don't suffer
14384 from locking problems).
14388 Two example maildir mail sources:
14391 (maildir :path "/home/user-name/Maildir/"
14392 :subdirs ("cur" "new"))
14396 (maildir :path "/user@@remotehost.org:~/Maildir/"
14401 Get mail from a @acronym{IMAP} server. If you don't want to use
14402 @acronym{IMAP} as intended, as a network mail reading protocol (ie
14403 with nnimap), for some reason or other, Gnus let you treat it similar
14404 to a @acronym{POP} server and fetches articles from a given
14405 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
14407 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
14408 may need external programs and libraries, @xref{IMAP}.
14414 The name of the @acronym{IMAP} server. The default is taken from the
14415 @env{MAILHOST} environment variable.
14418 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
14419 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
14422 The user name to give to the @acronym{IMAP} server. The default is the login
14426 The password to give to the @acronym{IMAP} server. If not specified, the user is
14430 What stream to use for connecting to the server, this is one of the
14431 symbols in @code{imap-stream-alist}. Right now, this means
14432 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
14433 @samp{ssl}, @samp{shell} or the default @samp{network}.
14435 @item :authentication
14436 Which authenticator to use for authenticating to the server, this is
14437 one of the symbols in @code{imap-authenticator-alist}. Right now,
14438 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
14439 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
14442 When using the `shell' :stream, the contents of this variable is
14443 mapped into the @code{imap-shell-program} variable. This should be a
14444 @code{format}-like string (or list of strings). Here's an example:
14450 Make sure nothing is interfering with the output of the program, e.g.,
14451 don't forget to redirect the error output to the void. The valid format
14452 specifier characters are:
14456 The name of the server.
14459 User name from @code{imap-default-user}.
14462 The port number of the server.
14465 The values used for these specs are taken from the values you give the
14466 corresponding keywords.
14469 The name of the mailbox to get mail from. The default is @samp{INBOX}
14470 which normally is the mailbox which receive incoming mail.
14473 The predicate used to find articles to fetch. The default, @samp{UNSEEN
14474 UNDELETED}, is probably the best choice for most people, but if you
14475 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
14476 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
14477 Then all articles in the mailbox is fetched, no matter what. For a
14478 complete list of predicates, see RFC 2060 section 6.4.4.
14481 How to flag fetched articles on the server, the default @samp{\Deleted}
14482 will mark them as deleted, an alternative would be @samp{\Seen} which
14483 would simply mark them as read. These are the two most likely choices,
14484 but more flags are defined in RFC 2060 section 2.3.2.
14487 If non-@code{nil}, don't remove all articles marked as deleted in the
14488 mailbox after finishing the fetch.
14492 An example @acronym{IMAP} mail source:
14495 (imap :server "mail.mycorp.com"
14497 :fetchflag "\\Seen")
14501 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
14502 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
14503 @uref{http://mail.yahoo.com/}.
14505 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
14506 required for url "4.0pre.46".
14508 WARNING: Mails may be lost. NO WARRANTY.
14514 The type of the webmail server. The default is @code{hotmail}. The
14515 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
14518 The user name to give to the webmail server. The default is the login
14522 The password to give to the webmail server. If not specified, the user is
14526 If non-@code{nil}, only fetch unread articles and don't move them to
14527 trash folder after finishing the fetch.
14531 An example webmail source:
14534 (webmail :subtype 'hotmail
14536 :password "secret")
14541 @item Common Keywords
14542 Common keywords can be used in any type of mail source.
14548 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
14549 use directory source to get mail, you can specify it as in this
14554 '((directory :path "/home/pavel/.Spool/"
14559 Gnus will then fetch your mail even when you are unplugged. This is
14560 useful when you use local mail and news.
14565 @subsubsection Function Interface
14567 Some of the above keywords specify a Lisp function to be executed.
14568 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
14569 the value of the keyword while the function is executing. For example,
14570 consider the following mail-source setting:
14573 (setq mail-sources '((pop :user "jrl"
14574 :server "pophost" :function fetchfunc)))
14577 While the function @code{fetchfunc} is executing, the symbol @code{user}
14578 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
14579 @code{"pophost"}. The symbols @code{port}, @code{password},
14580 @code{program}, @code{prescript}, @code{postscript}, @code{function},
14581 and @code{authentication} are also bound (to their default values).
14583 See above for a list of keywords for each type of mail source.
14586 @node Mail Source Customization
14587 @subsubsection Mail Source Customization
14589 The following is a list of variables that influence how the mail is
14590 fetched. You would normally not need to set or change any of these
14594 @item mail-source-crash-box
14595 @vindex mail-source-crash-box
14596 File where mail will be stored while processing it. The default is@*
14597 @file{~/.emacs-mail-crash-box}.
14599 @item mail-source-delete-incoming
14600 @vindex mail-source-delete-incoming
14601 If non-@code{nil}, delete incoming files after handling them. If
14602 @code{t}, delete the files immediately, if @code{nil}, never delete any
14603 files. If a positive number, delete files older than number of days
14604 (This will only happen, when receiving new mail). You may also set
14605 @code{mail-source-delete-incoming} to @code{nil} and call
14606 @code{mail-source-delete-old-incoming} from a hook or interactively.
14608 @item mail-source-delete-old-incoming-confirm
14609 @vindex mail-source-delete-old-incoming-confirm
14610 If non-@code{nil}, ask for confirmation before deleting old incoming
14611 files. This variable only applies when
14612 @code{mail-source-delete-incoming} is a positive number.
14614 @item mail-source-ignore-errors
14615 @vindex mail-source-ignore-errors
14616 If non-@code{nil}, ignore errors when reading mail from a mail source.
14618 @item mail-source-directory
14619 @vindex mail-source-directory
14620 Directory where incoming mail source files (if any) will be stored. The
14621 default is @file{~/Mail/}. At present, the only thing this is used for
14622 is to say where the incoming files will be stored if the variable
14623 @code{mail-source-delete-incoming} is @code{nil} or a number.
14625 @item mail-source-incoming-file-prefix
14626 @vindex mail-source-incoming-file-prefix
14627 Prefix for file name for storing incoming mail. The default is
14628 @file{Incoming}, in which case files will end up with names like
14629 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
14630 relevant if @code{mail-source-delete-incoming} is @code{nil} or a
14633 @item mail-source-default-file-modes
14634 @vindex mail-source-default-file-modes
14635 All new mail files will get this file mode. The default is 384.
14637 @item mail-source-movemail-program
14638 @vindex mail-source-movemail-program
14639 If non-@code{nil}, name of program for fetching new mail. If
14640 @code{nil}, @code{movemail} in @var{exec-directory}.
14645 @node Fetching Mail
14646 @subsubsection Fetching Mail
14648 @vindex mail-sources
14649 The way to actually tell Gnus where to get new mail from is to set
14650 @code{mail-sources} to a list of mail source specifiers
14651 (@pxref{Mail Source Specifiers}).
14653 If this variable is @code{nil}, the mail back ends will never attempt to
14654 fetch mail by themselves.
14656 If you want to fetch mail both from your local spool as well as a
14657 @acronym{POP} mail server, you'd say something like:
14662 (pop :server "pop3.mail.server"
14663 :password "secret")))
14666 Or, if you don't want to use any of the keyword defaults:
14670 '((file :path "/var/spool/mail/user-name")
14671 (pop :server "pop3.mail.server"
14674 :password "secret")))
14678 When you use a mail back end, Gnus will slurp all your mail from your
14679 inbox and plonk it down in your home directory. Gnus doesn't move any
14680 mail if you're not using a mail back end---you have to do a lot of magic
14681 invocations first. At the time when you have finished drawing the
14682 pentagram, lightened the candles, and sacrificed the goat, you really
14683 shouldn't be too surprised when Gnus moves your mail.
14687 @node Mail Back End Variables
14688 @subsection Mail Back End Variables
14690 These variables are (for the most part) pertinent to all the various
14694 @vindex nnmail-read-incoming-hook
14695 @item nnmail-read-incoming-hook
14696 The mail back ends all call this hook after reading new mail. You can
14697 use this hook to notify any mail watch programs, if you want to.
14699 @vindex nnmail-split-hook
14700 @item nnmail-split-hook
14701 @findex gnus-article-decode-encoded-words
14702 @cindex RFC 1522 decoding
14703 @cindex RFC 2047 decoding
14704 Hook run in the buffer where the mail headers of each message is kept
14705 just before the splitting based on these headers is done. The hook is
14706 free to modify the buffer contents in any way it sees fit---the buffer
14707 is discarded after the splitting has been done, and no changes performed
14708 in the buffer will show up in any files.
14709 @code{gnus-article-decode-encoded-words} is one likely function to add
14712 @vindex nnmail-pre-get-new-mail-hook
14713 @vindex nnmail-post-get-new-mail-hook
14714 @item nnmail-pre-get-new-mail-hook
14715 @itemx nnmail-post-get-new-mail-hook
14716 These are two useful hooks executed when treating new incoming
14717 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
14718 starting to handle the new mail) and
14719 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
14720 is done). Here's and example of using these two hooks to change the
14721 default file modes the new mail files get:
14724 (add-hook 'nnmail-pre-get-new-mail-hook
14725 (lambda () (set-default-file-modes 511)))
14727 (add-hook 'nnmail-post-get-new-mail-hook
14728 (lambda () (set-default-file-modes 551)))
14731 @item nnmail-use-long-file-names
14732 @vindex nnmail-use-long-file-names
14733 If non-@code{nil}, the mail back ends will use long file and directory
14734 names. Groups like @samp{mail.misc} will end up in directories
14735 (assuming use of @code{nnml} back end) or files (assuming use of
14736 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
14737 the same group will end up in @file{mail/misc}.
14739 @item nnmail-delete-file-function
14740 @vindex nnmail-delete-file-function
14741 @findex delete-file
14742 Function called to delete files. It is @code{delete-file} by default.
14744 @item nnmail-cache-accepted-message-ids
14745 @vindex nnmail-cache-accepted-message-ids
14746 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
14747 the back end (via @code{Gcc}, for instance) into the mail duplication
14748 discovery cache. The default is @code{nil}.
14750 @item nnmail-cache-ignore-groups
14751 @vindex nnmail-cache-ignore-groups
14752 This can be a regular expression or a list of regular expressions.
14753 Group names that match any of the regular expressions will never be
14754 recorded in the @code{Message-ID} cache.
14756 This can be useful, for example, when using Fancy Splitting
14757 (@pxref{Fancy Mail Splitting}) together with the function
14758 @code{nnmail-split-fancy-with-parent}.
14763 @node Fancy Mail Splitting
14764 @subsection Fancy Mail Splitting
14765 @cindex mail splitting
14766 @cindex fancy mail splitting
14768 @vindex nnmail-split-fancy
14769 @findex nnmail-split-fancy
14770 If the rather simple, standard method for specifying how to split mail
14771 doesn't allow you to do what you want, you can set
14772 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
14773 play with the @code{nnmail-split-fancy} variable.
14775 Let's look at an example value of this variable first:
14778 ;; @r{Messages from the mailer daemon are not crossposted to any of}
14779 ;; @r{the ordinary groups. Warnings are put in a separate group}
14780 ;; @r{from real errors.}
14781 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
14783 ;; @r{Non-error messages are crossposted to all relevant}
14784 ;; @r{groups, but we don't crosspost between the group for the}
14785 ;; @r{(ding) list and the group for other (ding) related mail.}
14786 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
14787 ("subject" "ding" "ding.misc"))
14788 ;; @r{Other mailing lists@dots{}}
14789 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
14790 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
14791 ;; @r{Both lists below have the same suffix, so prevent}
14792 ;; @r{cross-posting to mkpkg.list of messages posted only to}
14793 ;; @r{the bugs- list, but allow cross-posting when the}
14794 ;; @r{message was really cross-posted.}
14795 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
14796 (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list")
14797 ;; @r{People@dots{}}
14798 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
14799 ;; @r{Unmatched mail goes to the catch all group.}
14803 This variable has the format of a @dfn{split}. A split is a
14804 (possibly) recursive structure where each split may contain other
14805 splits. Here are the possible split syntaxes:
14810 If the split is a string, that will be taken as a group name. Normal
14811 regexp match expansion will be done. See below for examples.
14813 @c Don't fold this line.
14814 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split} [@var{invert-partial}])
14815 The split can be a list containing at least three elements. If the
14816 first element @var{field} (a regexp matching a header) contains
14817 @var{value} (also a regexp) then store the message as specified by
14820 If @var{restrict} (yet another regexp) matches some string after
14821 @var{field} and before the end of the matched @var{value}, the
14822 @var{split} is ignored. If none of the @var{restrict} clauses match,
14823 @var{split} is processed.
14825 The last element @var{invert-partial} is optional. If it is
14826 non-@code{nil}, the match-partial-words behavior controlled by the
14827 variable @code{nnmail-split-fancy-match-partial-words} (see below) is
14828 be inverted. (New in Gnus 5.10.7)
14830 @item (| @var{split} @dots{})
14831 If the split is a list, and the first element is @code{|} (vertical
14832 bar), then process each @var{split} until one of them matches. A
14833 @var{split} is said to match if it will cause the mail message to be
14834 stored in one or more groups.
14836 @item (& @var{split} @dots{})
14837 If the split is a list, and the first element is @code{&}, then
14838 process all @var{split}s in the list.
14841 If the split is the symbol @code{junk}, then don't save (i.e., delete)
14842 this message. Use with extreme caution.
14844 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
14845 If the split is a list, and the first element is @samp{:}, then the
14846 second element will be called as a function with @var{args} given as
14847 arguments. The function should return a @var{split}.
14850 For instance, the following function could be used to split based on the
14851 body of the messages:
14854 (defun split-on-body ()
14858 (goto-char (point-min))
14859 (when (re-search-forward "Some.*string" nil t)
14863 The buffer is narrowed to the header of the message in question when
14864 @var{function} is run. That's why @code{(widen)} needs to be called
14865 after @code{save-excursion} and @code{save-restriction} in the example
14866 above. Also note that with the nnimap backend, message bodies will
14867 not be downloaded by default. You need to set
14868 @code{nnimap-split-download-body} to @code{t} to do that
14869 (@pxref{Splitting in IMAP}).
14871 @item (! @var{func} @var{split})
14872 If the split is a list, and the first element is @code{!}, then
14873 @var{split} will be processed, and @var{func} will be called as a
14874 function with the result of @var{split} as argument. @var{func}
14875 should return a split.
14878 If the split is @code{nil}, it is ignored.
14882 In these splits, @var{field} must match a complete field name.
14884 Normally, @var{value} in these splits must match a complete @emph{word}
14885 according to the fundamental mode syntax table. In other words, all
14886 @var{value}'s will be implicitly surrounded by @code{\<...\>} markers,
14887 which are word delimiters. Therefore, if you use the following split,
14891 (any "joe" "joemail")
14895 messages sent from @samp{joedavis@@foo.org} will normally not be filed
14896 in @samp{joemail}. If you want to alter this behavior, you can use any
14897 of the following three ways:
14901 @vindex nnmail-split-fancy-match-partial-words
14902 You can set the @code{nnmail-split-fancy-match-partial-words} variable
14903 to non-@code{nil} in order to ignore word boundaries and instead the
14904 match becomes more like a grep. This variable controls whether partial
14905 words are matched during fancy splitting. The default value is
14908 Note that it influences all @var{value}'s in your split rules.
14911 @var{value} beginning with @code{.*} ignores word boundaries in front of
14912 a word. Similarly, if @var{value} ends with @code{.*}, word boundaries
14913 in the rear of a word will be ignored. For example, the @var{value}
14914 @code{"@@example\\.com"} does not match @samp{foo@@example.com} but
14915 @code{".*@@example\\.com"} does.
14918 You can set the @var{invert-partial} flag in your split rules of the
14919 @samp{(@var{field} @var{value} @dots{})} types, aforementioned in this
14920 section. If the flag is set, word boundaries on both sides of a word
14921 are ignored even if @code{nnmail-split-fancy-match-partial-words} is
14922 @code{nil}. Contrarily, if the flag is set, word boundaries are not
14923 ignored even if @code{nnmail-split-fancy-match-partial-words} is
14924 non-@code{nil}. (New in Gnus 5.10.7)
14927 @vindex nnmail-split-abbrev-alist
14928 @var{field} and @var{value} can also be Lisp symbols, in that case
14929 they are expanded as specified by the variable
14930 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
14931 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14932 contains the associated value. Predefined entries in
14933 @code{nnmail-split-abbrev-alist} include:
14937 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14939 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14940 @samp{Resent-To} and @samp{Resent-Cc} fields.
14942 Is the union of the @code{from} and @code{to} entries.
14945 @vindex nnmail-split-fancy-syntax-table
14946 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14947 when all this splitting is performed.
14949 If you want to have Gnus create groups dynamically based on some
14950 information in the headers (i.e., do @code{replace-match}-like
14951 substitutions in the group names), you can say things like:
14954 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14957 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14958 will be filed in @samp{mail.debian.foo}.
14960 If the string contains the element @samp{\&}, then the previously
14961 matched string will be substituted. Similarly, the elements @samp{\\1}
14962 up to @samp{\\9} will be substituted with the text matched by the
14963 groupings 1 through 9.
14965 @vindex nnmail-split-lowercase-expanded
14966 Where @code{nnmail-split-lowercase-expanded} controls whether the
14967 lowercase of the matched string should be used for the substitution.
14968 Setting it as non-@code{nil} is useful to avoid the creation of multiple
14969 groups when users send to an address using different case
14970 (i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value
14973 @findex nnmail-split-fancy-with-parent
14974 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14975 split followups into the same groups their parents are in. Sometimes
14976 you can't make splitting rules for all your mail. For example, your
14977 boss might send you personal mail regarding different projects you are
14978 working on, and as you can't tell your boss to put a distinguishing
14979 string into the subject line, you have to resort to manually moving the
14980 messages into the right group. With this function, you only have to do
14981 it once per thread.
14983 To use this feature, you have to set @code{nnmail-treat-duplicates}
14984 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14985 value. And then you can include @code{nnmail-split-fancy-with-parent}
14986 using the colon feature, like so:
14988 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
14989 nnmail-cache-accepted-message-ids t
14991 '(| (: nnmail-split-fancy-with-parent)
14992 ;; @r{other splits go here}
14996 This feature works as follows: when @code{nnmail-treat-duplicates} is
14997 non-@code{nil}, Gnus records the message id of every message it sees
14998 in the file specified by the variable
14999 @code{nnmail-message-id-cache-file}, together with the group it is in
15000 (the group is omitted for non-mail messages). When mail splitting is
15001 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
15002 at the References (and In-Reply-To) header of each message to split
15003 and searches the file specified by @code{nnmail-message-id-cache-file}
15004 for the message ids. When it has found a parent, it returns the
15005 corresponding group name unless the group name matches the regexp
15006 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
15007 recommended that you set @code{nnmail-message-id-cache-length} to a
15008 somewhat higher number than the default so that the message ids are
15009 still in the cache. (A value of 5000 appears to create a file some
15010 300 kBytes in size.)
15011 @vindex nnmail-cache-accepted-message-ids
15012 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
15013 also records the message ids of moved articles, so that the followup
15014 messages goes into the new group.
15016 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
15017 want certain groups to be recorded in the cache. For example, if all
15018 outgoing messages are written to an ``outgoing'' group, you could set
15019 @code{nnmail-cache-ignore-groups} to match that group name.
15020 Otherwise, answers to all your messages would end up in the
15021 ``outgoing'' group.
15024 @node Group Mail Splitting
15025 @subsection Group Mail Splitting
15026 @cindex mail splitting
15027 @cindex group mail splitting
15029 @findex gnus-group-split
15030 If you subscribe to dozens of mailing lists but you don't want to
15031 maintain mail splitting rules manually, group mail splitting is for you.
15032 You just have to set @code{to-list} and/or @code{to-address} in group
15033 parameters or group customization and set @code{nnmail-split-methods} to
15034 @code{gnus-group-split}. This splitting function will scan all groups
15035 for those parameters and split mail accordingly, i.e., messages posted
15036 from or to the addresses specified in the parameters @code{to-list} or
15037 @code{to-address} of a mail group will be stored in that group.
15039 Sometimes, mailing lists have multiple addresses, and you may want mail
15040 splitting to recognize them all: just set the @code{extra-aliases} group
15041 parameter to the list of additional addresses and it's done. If you'd
15042 rather use a regular expression, set @code{split-regexp}.
15044 All these parameters in a group will be used to create an
15045 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
15046 the @var{value} is a single regular expression that matches
15047 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
15048 matches of @code{split-regexp}, and the @var{split} is the name of the
15049 group. @var{restrict}s are also supported: just set the
15050 @code{split-exclude} parameter to a list of regular expressions.
15052 If you can't get the right split to be generated using all these
15053 parameters, or you just need something fancier, you can set the
15054 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
15055 this case, all other aforementioned parameters will be ignored by
15056 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
15057 @code{nil}, in which case the group will be ignored by
15058 @code{gnus-group-split}.
15060 @vindex gnus-group-split-default-catch-all-group
15061 @code{gnus-group-split} will do cross-posting on all groups that match,
15062 by defining a single @code{&} fancy split containing one split for each
15063 group. If a message doesn't match any split, it will be stored in the
15064 group named in @code{gnus-group-split-default-catch-all-group}, unless
15065 some group has @code{split-spec} set to @code{catch-all}, in which case
15066 that group is used as the catch-all group. Even though this variable is
15067 often used just to name a group, it may also be set to an arbitrarily
15068 complex fancy split (after all, a group name is a fancy split), and this
15069 may be useful to split mail that doesn't go to any mailing list to
15070 personal mail folders. Note that this fancy split is added as the last
15071 element of a @code{|} split list that also contains a @code{&} split
15072 with the rules extracted from group parameters.
15074 It's time for an example. Assume the following group parameters have
15079 ((to-address . "bar@@femail.com")
15080 (split-regexp . ".*@@femail\\.com"))
15082 ((to-list . "foo@@nowhere.gov")
15083 (extra-aliases "foo@@localhost" "foo-redist@@home")
15084 (split-exclude "bugs-foo" "rambling-foo")
15085 (admin-address . "foo-request@@nowhere.gov"))
15087 ((split-spec . catch-all))
15090 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
15091 behave as if @code{nnmail-split-fancy} had been selected and variable
15092 @code{nnmail-split-fancy} had been set as follows:
15095 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
15096 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
15097 - "bugs-foo" - "rambling-foo" "mail.foo"))
15101 @findex gnus-group-split-fancy
15102 If you'd rather not use group splitting for all your mail groups, you
15103 may use it for only some of them, by using @code{nnmail-split-fancy}
15107 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
15110 @var{groups} may be a regular expression or a list of group names whose
15111 parameters will be scanned to generate the output split.
15112 @var{no-crosspost} can be used to disable cross-posting; in this case, a
15113 single @code{|} split will be output. @var{catch-all} is the fall back
15114 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
15115 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
15116 empty string in any selected group, no catch-all split will be issued.
15117 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
15118 this group will override the value of the @var{catch-all} argument.
15120 @findex gnus-group-split-setup
15121 Unfortunately, scanning all groups and their parameters can be quite
15122 slow, especially considering that it has to be done for every message.
15123 But don't despair! The function @code{gnus-group-split-setup} can be
15124 used to enable @code{gnus-group-split} in a much more efficient way. It
15125 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
15126 @code{nnmail-split-fancy} to the split produced by
15127 @code{gnus-group-split-fancy}. Thus, the group parameters are only
15128 scanned once, no matter how many messages are split.
15130 @findex gnus-group-split-update
15131 However, if you change group parameters, you'd have to update
15132 @code{nnmail-split-fancy} manually. You can do it by running
15133 @code{gnus-group-split-update}. If you'd rather have it updated
15134 automatically, just tell @code{gnus-group-split-setup} to do it for
15135 you. For example, add to your @file{~/.gnus.el}:
15138 (gnus-group-split-setup @var{auto-update} @var{catch-all})
15141 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
15142 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
15143 have to worry about updating @code{nnmail-split-fancy} again. If you
15144 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
15145 @code{gnus-group-split-default-catch-all-group} will be set to its
15148 @vindex gnus-group-split-updated-hook
15149 Because you may want to change @code{nnmail-split-fancy} after it is set
15150 by @code{gnus-group-split-update}, this function will run
15151 @code{gnus-group-split-updated-hook} just before finishing.
15153 @node Incorporating Old Mail
15154 @subsection Incorporating Old Mail
15155 @cindex incorporating old mail
15156 @cindex import old mail
15158 Most people have lots of old mail stored in various file formats. If
15159 you have set up Gnus to read mail using one of the spiffy Gnus mail
15160 back ends, you'll probably wish to have that old mail incorporated into
15163 Doing so can be quite easy.
15165 To take an example: You're reading mail using @code{nnml}
15166 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
15167 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
15168 file filled with important, but old, mail. You want to move it into
15169 your @code{nnml} groups.
15175 Go to the group buffer.
15178 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
15179 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
15182 Type @kbd{SPACE} to enter the newly created group.
15185 Type @kbd{M P b} to process-mark all articles in this group's buffer
15186 (@pxref{Setting Process Marks}).
15189 Type @kbd{B r} to respool all the process-marked articles, and answer
15190 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
15193 All the mail messages in the mbox file will now also be spread out over
15194 all your @code{nnml} groups. Try entering them and check whether things
15195 have gone without a glitch. If things look ok, you may consider
15196 deleting the mbox file, but I wouldn't do that unless I was absolutely
15197 sure that all the mail has ended up where it should be.
15199 Respooling is also a handy thing to do if you're switching from one mail
15200 back end to another. Just respool all the mail in the old mail groups
15201 using the new mail back end.
15204 @node Expiring Mail
15205 @subsection Expiring Mail
15206 @cindex article expiry
15207 @cindex expiring mail
15209 Traditional mail readers have a tendency to remove mail articles when
15210 you mark them as read, in some way. Gnus takes a fundamentally
15211 different approach to mail reading.
15213 Gnus basically considers mail just to be news that has been received in
15214 a rather peculiar manner. It does not think that it has the power to
15215 actually change the mail, or delete any mail messages. If you enter a
15216 mail group, and mark articles as ``read'', or kill them in some other
15217 fashion, the mail articles will still exist on the system. I repeat:
15218 Gnus will not delete your old, read mail. Unless you ask it to, of
15221 To make Gnus get rid of your unwanted mail, you have to mark the
15222 articles as @dfn{expirable}. (With the default key bindings, this means
15223 that you have to type @kbd{E}.) This does not mean that the articles
15224 will disappear right away, however. In general, a mail article will be
15225 deleted from your system if, 1) it is marked as expirable, AND 2) it is
15226 more than one week old. If you do not mark an article as expirable, it
15227 will remain on your system until hell freezes over. This bears
15228 repeating one more time, with some spurious capitalizations: IF you do
15229 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
15231 You do not have to mark articles as expirable by hand. Gnus provides
15232 two features, called ``auto-expire'' and ``total-expire'', that can help you
15233 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
15234 for you when you select an article. And ``total-expire'' means that Gnus
15235 considers all articles as expirable that are read. So, in addition to
15236 the articles marked @samp{E}, also the articles marked @samp{r},
15237 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
15240 When should either auto-expire or total-expire be used? Most people
15241 who are subscribed to mailing lists split each list into its own group
15242 and then turn on auto-expire or total-expire for those groups.
15243 (@xref{Splitting Mail}, for more information on splitting each list
15244 into its own group.)
15246 Which one is better, auto-expire or total-expire? It's not easy to
15247 answer. Generally speaking, auto-expire is probably faster. Another
15248 advantage of auto-expire is that you get more marks to work with: for
15249 the articles that are supposed to stick around, you can still choose
15250 between tick and dormant and read marks. But with total-expire, you
15251 only have dormant and ticked to choose from. The advantage of
15252 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
15253 Scoring}). Auto-expire works with normal scoring but not with adaptive
15256 @vindex gnus-auto-expirable-newsgroups
15257 Groups that match the regular expression
15258 @code{gnus-auto-expirable-newsgroups} will have all articles that you
15259 read marked as expirable automatically. All articles marked as
15260 expirable have an @samp{E} in the first column in the summary buffer.
15262 By default, if you have auto expiry switched on, Gnus will mark all the
15263 articles you read as expirable, no matter if they were read or unread
15264 before. To avoid having articles marked as read marked as expirable
15265 automatically, you can put something like the following in your
15266 @file{~/.gnus.el} file:
15268 @vindex gnus-mark-article-hook
15270 (remove-hook 'gnus-mark-article-hook
15271 'gnus-summary-mark-read-and-unread-as-read)
15272 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
15275 Note that making a group auto-expirable doesn't mean that all read
15276 articles are expired---only the articles marked as expirable
15277 will be expired. Also note that using the @kbd{d} command won't make
15278 articles expirable---only semi-automatic marking of articles as read will
15279 mark the articles as expirable in auto-expirable groups.
15281 Let's say you subscribe to a couple of mailing lists, and you want the
15282 articles you have read to disappear after a while:
15285 (setq gnus-auto-expirable-newsgroups
15286 "mail.nonsense-list\\|mail.nice-list")
15289 Another way to have auto-expiry happen is to have the element
15290 @code{auto-expire} in the group parameters of the group.
15292 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
15293 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
15294 don't really mix very well.
15296 @vindex nnmail-expiry-wait
15297 The @code{nnmail-expiry-wait} variable supplies the default time an
15298 expirable article has to live. Gnus starts counting days from when the
15299 message @emph{arrived}, not from when it was sent. The default is seven
15302 Gnus also supplies a function that lets you fine-tune how long articles
15303 are to live, based on what group they are in. Let's say you want to
15304 have one month expiry period in the @samp{mail.private} group, a one day
15305 expiry period in the @samp{mail.junk} group, and a six day expiry period
15308 @vindex nnmail-expiry-wait-function
15310 (setq nnmail-expiry-wait-function
15312 (cond ((string= group "mail.private")
15314 ((string= group "mail.junk")
15316 ((string= group "important")
15322 The group names this function is fed are ``unadorned'' group
15323 names---no @samp{nnml:} prefixes and the like.
15325 The @code{nnmail-expiry-wait} variable and
15326 @code{nnmail-expiry-wait-function} function can either be a number (not
15327 necessarily an integer) or one of the symbols @code{immediate} or
15330 You can also use the @code{expiry-wait} group parameter to selectively
15331 change the expiry period (@pxref{Group Parameters}).
15333 @vindex nnmail-expiry-target
15334 The normal action taken when expiring articles is to delete them.
15335 However, in some circumstances it might make more sense to move them
15336 to other groups instead of deleting them. The variable
15337 @code{nnmail-expiry-target} (and the @code{expiry-target} group
15338 parameter) controls this. The variable supplies a default value for
15339 all groups, which can be overridden for specific groups by the group
15340 parameter. default value is @code{delete}, but this can also be a
15341 string (which should be the name of the group the message should be
15342 moved to), or a function (which will be called in a buffer narrowed to
15343 the message in question, and with the name of the group being moved
15344 from as its parameter) which should return a target---either a group
15345 name or @code{delete}.
15347 Here's an example for specifying a group name:
15349 (setq nnmail-expiry-target "nnml:expired")
15352 @findex nnmail-fancy-expiry-target
15353 @vindex nnmail-fancy-expiry-targets
15354 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
15355 expire mail to groups according to the variable
15356 @code{nnmail-fancy-expiry-targets}. Here's an example:
15359 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
15360 nnmail-fancy-expiry-targets
15361 '((to-from "boss" "nnfolder:Work")
15362 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
15363 ("from" ".*" "nnfolder:Archive-%Y")))
15366 With this setup, any mail that has @code{IMPORTANT} in its Subject
15367 header and was sent in the year @code{YYYY} and month @code{MMM}, will
15368 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
15369 From or To header contains the string @code{boss}, it will get expired
15370 to @code{nnfolder:Work}. All other mail will get expired to
15371 @code{nnfolder:Archive-YYYY}.
15373 @vindex nnmail-keep-last-article
15374 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
15375 expire the final article in a mail newsgroup. This is to make life
15376 easier for procmail users.
15378 @vindex gnus-total-expirable-newsgroups
15379 By the way: That line up there, about Gnus never expiring non-expirable
15380 articles, is a lie. If you put @code{total-expire} in the group
15381 parameters, articles will not be marked as expirable, but all read
15382 articles will be put through the expiry process. Use with extreme
15383 caution. Even more dangerous is the
15384 @code{gnus-total-expirable-newsgroups} variable. All groups that match
15385 this regexp will have all read articles put through the expiry process,
15386 which means that @emph{all} old mail articles in the groups in question
15387 will be deleted after a while. Use with extreme caution, and don't come
15388 crying to me when you discover that the regexp you used matched the
15389 wrong group and all your important mail has disappeared. Be a
15390 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
15393 Most people make most of their mail groups total-expirable, though.
15395 @vindex gnus-inhibit-user-auto-expire
15396 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
15397 commands will not mark an article as expirable, even if the group has
15398 auto-expire turned on.
15402 @subsection Washing Mail
15403 @cindex mail washing
15404 @cindex list server brain damage
15405 @cindex incoming mail treatment
15407 Mailers and list servers are notorious for doing all sorts of really,
15408 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
15409 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
15410 end of all lines passing through our server, so let's do that!!!!1!''
15411 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
15412 considered to be self-evident were not discussed. So. Here we are.
15414 Case in point: The German version of Microsoft Exchange adds @samp{AW:
15415 } to the subjects of replies instead of @samp{Re: }. I could pretend to
15416 be shocked and dismayed by this, but I haven't got the energy. It is to
15419 Gnus provides a plethora of functions for washing articles while
15420 displaying them, but it might be nicer to do the filtering before
15421 storing the mail to disk. For that purpose, we have three hooks and
15422 various functions that can be put in these hooks.
15425 @item nnmail-prepare-incoming-hook
15426 @vindex nnmail-prepare-incoming-hook
15427 This hook is called before doing anything with the mail and is meant for
15428 grand, sweeping gestures. It is called in a buffer that contains all
15429 the new, incoming mail. Functions to be used include:
15432 @item nnheader-ms-strip-cr
15433 @findex nnheader-ms-strip-cr
15434 Remove trailing carriage returns from each line. This is default on
15435 Emacs running on MS machines.
15439 @item nnmail-prepare-incoming-header-hook
15440 @vindex nnmail-prepare-incoming-header-hook
15441 This hook is called narrowed to each header. It can be used when
15442 cleaning up the headers. Functions that can be used include:
15445 @item nnmail-remove-leading-whitespace
15446 @findex nnmail-remove-leading-whitespace
15447 Clear leading white space that ``helpful'' listservs have added to the
15448 headers to make them look nice. Aaah.
15450 (Note that this function works on both the header on the body of all
15451 messages, so it is a potentially dangerous function to use (if a body
15452 of a message contains something that looks like a header line). So
15453 rather than fix the bug, it is of course the right solution to make it
15454 into a feature by documenting it.)
15456 @item nnmail-remove-list-identifiers
15457 @findex nnmail-remove-list-identifiers
15458 Some list servers add an identifier---for example, @samp{(idm)}---to the
15459 beginning of all @code{Subject} headers. I'm sure that's nice for
15460 people who use stone age mail readers. This function will remove
15461 strings that match the @code{nnmail-list-identifiers} regexp, which can
15462 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
15465 For instance, if you want to remove the @samp{(idm)} and the
15466 @samp{nagnagnag} identifiers:
15469 (setq nnmail-list-identifiers
15470 '("(idm)" "nagnagnag"))
15473 This can also be done non-destructively with
15474 @code{gnus-list-identifiers}, @xref{Article Hiding}.
15476 @item nnmail-remove-tabs
15477 @findex nnmail-remove-tabs
15478 Translate all @samp{TAB} characters into @samp{SPACE} characters.
15480 @item nnmail-ignore-broken-references
15481 @findex nnmail-ignore-broken-references
15482 @c @findex nnmail-fix-eudora-headers
15485 Some mail user agents (e.g. Eudora and Pegasus) produce broken
15486 @code{References} headers, but correct @code{In-Reply-To} headers. This
15487 function will get rid of the @code{References} header if the headers
15488 contain a line matching the regular expression
15489 @code{nnmail-broken-references-mailers}.
15493 @item nnmail-prepare-incoming-message-hook
15494 @vindex nnmail-prepare-incoming-message-hook
15495 This hook is called narrowed to each message. Functions to be used
15499 @item article-de-quoted-unreadable
15500 @findex article-de-quoted-unreadable
15501 Decode Quoted Readable encoding.
15508 @subsection Duplicates
15510 @vindex nnmail-treat-duplicates
15511 @vindex nnmail-message-id-cache-length
15512 @vindex nnmail-message-id-cache-file
15513 @cindex duplicate mails
15514 If you are a member of a couple of mailing lists, you will sometimes
15515 receive two copies of the same mail. This can be quite annoying, so
15516 @code{nnmail} checks for and treats any duplicates it might find. To do
15517 this, it keeps a cache of old @code{Message-ID}s---
15518 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
15519 default. The approximate maximum number of @code{Message-ID}s stored
15520 there is controlled by the @code{nnmail-message-id-cache-length}
15521 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
15522 stored.) If all this sounds scary to you, you can set
15523 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
15524 default), and @code{nnmail} won't delete duplicate mails. Instead it
15525 will insert a warning into the head of the mail saying that it thinks
15526 that this is a duplicate of a different message.
15528 This variable can also be a function. If that's the case, the function
15529 will be called from a buffer narrowed to the message in question with
15530 the @code{Message-ID} as a parameter. The function must return either
15531 @code{nil}, @code{warn}, or @code{delete}.
15533 You can turn this feature off completely by setting the variable to
15536 If you want all the duplicate mails to be put into a special
15537 @dfn{duplicates} group, you could do that using the normal mail split
15541 (setq nnmail-split-fancy
15542 '(| ;; @r{Messages duplicates go to a separate group.}
15543 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
15544 ;; @r{Message from daemons, postmaster, and the like to another.}
15545 (any mail "mail.misc")
15546 ;; @r{Other rules.}
15552 (setq nnmail-split-methods
15553 '(("duplicates" "^Gnus-Warning:.*duplicate")
15554 ;; @r{Other rules.}
15558 Here's a neat feature: If you know that the recipient reads her mail
15559 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
15560 @code{delete}, you can send her as many insults as you like, just by
15561 using a @code{Message-ID} of a mail that you know that she's already
15562 received. Think of all the fun! She'll never see any of it! Whee!
15565 @node Not Reading Mail
15566 @subsection Not Reading Mail
15568 If you start using any of the mail back ends, they have the annoying
15569 habit of assuming that you want to read mail with them. This might not
15570 be unreasonable, but it might not be what you want.
15572 If you set @code{mail-sources} and @code{nnmail-spool-file} to
15573 @code{nil}, none of the back ends will ever attempt to read incoming
15574 mail, which should help.
15576 @vindex nnbabyl-get-new-mail
15577 @vindex nnmbox-get-new-mail
15578 @vindex nnml-get-new-mail
15579 @vindex nnmh-get-new-mail
15580 @vindex nnfolder-get-new-mail
15581 This might be too much, if, for instance, you are reading mail quite
15582 happily with @code{nnml} and just want to peek at some old Rmail
15583 file you have stashed away with @code{nnbabyl}. All back ends have
15584 variables called back-end-@code{get-new-mail}. If you want to disable
15585 the @code{nnbabyl} mail reading, you edit the virtual server for the
15586 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
15588 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
15589 narrowed to the article to be saved before saving it when reading
15593 @node Choosing a Mail Back End
15594 @subsection Choosing a Mail Back End
15596 Gnus will read the mail spool when you activate a mail group. The mail
15597 file is first copied to your home directory. What happens after that
15598 depends on what format you want to store your mail in.
15600 There are six different mail back ends in the standard Gnus, and more
15601 back ends are available separately. The mail back end most people use
15602 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
15606 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
15607 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
15608 * Mail Spool:: Store your mail in a private spool?
15609 * MH Spool:: An mhspool-like back end.
15610 * Maildir:: Another one-file-per-message format.
15611 * Mail Folders:: Having one file for each group.
15612 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
15616 @node Unix Mail Box
15617 @subsubsection Unix Mail Box
15619 @cindex unix mail box
15621 @vindex nnmbox-active-file
15622 @vindex nnmbox-mbox-file
15623 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
15624 mail. @code{nnmbox} will add extra headers to each mail article to say
15625 which group it belongs in.
15627 Virtual server settings:
15630 @item nnmbox-mbox-file
15631 @vindex nnmbox-mbox-file
15632 The name of the mail box in the user's home directory. Default is
15635 @item nnmbox-active-file
15636 @vindex nnmbox-active-file
15637 The name of the active file for the mail box. Default is
15638 @file{~/.mbox-active}.
15640 @item nnmbox-get-new-mail
15641 @vindex nnmbox-get-new-mail
15642 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
15643 into groups. Default is @code{t}.
15648 @subsubsection Rmail Babyl
15652 @vindex nnbabyl-active-file
15653 @vindex nnbabyl-mbox-file
15654 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
15655 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
15656 mail article to say which group it belongs in.
15658 Virtual server settings:
15661 @item nnbabyl-mbox-file
15662 @vindex nnbabyl-mbox-file
15663 The name of the Rmail mbox file. The default is @file{~/RMAIL}
15665 @item nnbabyl-active-file
15666 @vindex nnbabyl-active-file
15667 The name of the active file for the rmail box. The default is
15668 @file{~/.rmail-active}
15670 @item nnbabyl-get-new-mail
15671 @vindex nnbabyl-get-new-mail
15672 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
15678 @subsubsection Mail Spool
15680 @cindex mail @acronym{NOV} spool
15682 The @dfn{nnml} spool mail format isn't compatible with any other known
15683 format. It should be used with some caution.
15685 @vindex nnml-directory
15686 If you use this back end, Gnus will split all incoming mail into files,
15687 one file for each mail, and put the articles into the corresponding
15688 directories under the directory specified by the @code{nnml-directory}
15689 variable. The default value is @file{~/Mail/}.
15691 You do not have to create any directories beforehand; Gnus will take
15694 If you have a strict limit as to how many files you are allowed to store
15695 in your account, you should not use this back end. As each mail gets its
15696 own file, you might very well occupy thousands of inodes within a few
15697 weeks. If this is no problem for you, and it isn't a problem for you
15698 having your friendly systems administrator walking around, madly,
15699 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
15700 know that this is probably the fastest format to use. You do not have
15701 to trudge through a big mbox file just to read your new mail.
15703 @code{nnml} is probably the slowest back end when it comes to article
15704 splitting. It has to create lots of files, and it also generates
15705 @acronym{NOV} databases for the incoming mails. This makes it possibly the
15706 fastest back end when it comes to reading mail.
15708 @cindex self contained nnml servers
15710 When the marks file is used (which it is by default), @code{nnml}
15711 servers have the property that you may backup them using @code{tar} or
15712 similar, and later be able to restore them into Gnus (by adding the
15713 proper @code{nnml} server) and have all your marks be preserved. Marks
15714 for a group are usually stored in the @code{.marks} file (but see
15715 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
15716 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
15717 to restore the group (after restoring the backup into the nnml
15720 If for some reason you believe your @file{.marks} files are screwed
15721 up, you can just delete them all. Gnus will then correctly regenerate
15722 them next time it starts.
15724 Virtual server settings:
15727 @item nnml-directory
15728 @vindex nnml-directory
15729 All @code{nnml} directories will be placed under this directory. The
15730 default is the value of @code{message-directory} (whose default value
15733 @item nnml-active-file
15734 @vindex nnml-active-file
15735 The active file for the @code{nnml} server. The default is
15736 @file{~/Mail/active}.
15738 @item nnml-newsgroups-file
15739 @vindex nnml-newsgroups-file
15740 The @code{nnml} group descriptions file. @xref{Newsgroups File
15741 Format}. The default is @file{~/Mail/newsgroups}.
15743 @item nnml-get-new-mail
15744 @vindex nnml-get-new-mail
15745 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
15748 @item nnml-nov-is-evil
15749 @vindex nnml-nov-is-evil
15750 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15751 default is @code{nil}.
15753 @item nnml-nov-file-name
15754 @vindex nnml-nov-file-name
15755 The name of the @acronym{NOV} files. The default is @file{.overview}.
15757 @item nnml-prepare-save-mail-hook
15758 @vindex nnml-prepare-save-mail-hook
15759 Hook run narrowed to an article before saving.
15761 @item nnml-marks-is-evil
15762 @vindex nnml-marks-is-evil
15763 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15764 default is @code{nil}.
15766 @item nnml-marks-file-name
15767 @vindex nnml-marks-file-name
15768 The name of the @dfn{marks} files. The default is @file{.marks}.
15770 @item nnml-use-compressed-files
15771 @vindex nnml-use-compressed-files
15772 If non-@code{nil}, @code{nnml} will allow using compressed message
15773 files. This requires @code{auto-compression-mode} to be enabled
15774 (@pxref{Compressed Files, ,Compressed Files, emacs, The Emacs Manual}).
15775 If the value of @code{nnml-use-compressed-files} is a string, it is used
15776 as the file extension specifying the compression program. You can set it
15777 to @samp{.bz2} if your Emacs supports it. A value of @code{t} is
15778 equivalent to @samp{.gz}.
15780 @item nnml-compressed-files-size-threshold
15781 @vindex nnml-compressed-files-size-threshold
15782 Default size threshold for compressed message files. Message files with
15783 bodies larger than that many characters will be automatically compressed
15784 if @code{nnml-use-compressed-files} is non-@code{nil}.
15788 @findex nnml-generate-nov-databases
15789 If your @code{nnml} groups and @acronym{NOV} files get totally out of
15790 whack, you can do a complete update by typing @kbd{M-x
15791 nnml-generate-nov-databases}. This command will trawl through the
15792 entire @code{nnml} hierarchy, looking at each and every article, so it
15793 might take a while to complete. A better interface to this
15794 functionality can be found in the server buffer (@pxref{Server
15799 @subsubsection MH Spool
15801 @cindex mh-e mail spool
15803 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
15804 @acronym{NOV} databases and it doesn't keep an active file or marks
15805 file. This makes @code{nnmh} a @emph{much} slower back end than
15806 @code{nnml}, but it also makes it easier to write procmail scripts
15809 Virtual server settings:
15812 @item nnmh-directory
15813 @vindex nnmh-directory
15814 All @code{nnmh} directories will be located under this directory. The
15815 default is the value of @code{message-directory} (whose default is
15818 @item nnmh-get-new-mail
15819 @vindex nnmh-get-new-mail
15820 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
15824 @vindex nnmh-be-safe
15825 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
15826 sure that the articles in the folder are actually what Gnus thinks
15827 they are. It will check date stamps and stat everything in sight, so
15828 setting this to @code{t} will mean a serious slow-down. If you never
15829 use anything but Gnus to read the @code{nnmh} articles, you do not
15830 have to set this variable to @code{t}. The default is @code{nil}.
15835 @subsubsection Maildir
15839 @code{nnmaildir} stores mail in the maildir format, with each maildir
15840 corresponding to a group in Gnus. This format is documented here:
15841 @uref{http://cr.yp.to/proto/maildir.html} and here:
15842 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
15843 also stores extra information in the @file{.nnmaildir/} directory
15846 Maildir format was designed to allow concurrent deliveries and
15847 reading, without needing locks. With other back ends, you would have
15848 your mail delivered to a spool of some kind, and then you would
15849 configure Gnus to split mail from that spool into your groups. You
15850 can still do that with @code{nnmaildir}, but the more common
15851 configuration is to have your mail delivered directly to the maildirs
15852 that appear as group in Gnus.
15854 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
15855 never corrupt its data in memory, and @code{SIGKILL} will never
15856 corrupt its data in the filesystem.
15858 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
15859 maildir. So you can copy a whole maildir from one Gnus setup to
15860 another, and you will keep your marks.
15862 Virtual server settings:
15866 For each of your @code{nnmaildir} servers (it's very unlikely that
15867 you'd need more than one), you need to create a directory and populate
15868 it with maildirs or symlinks to maildirs (and nothing else; do not
15869 choose a directory already used for other purposes). Each maildir
15870 will be represented in Gnus as a newsgroup on that server; the
15871 filename of the symlink will be the name of the group. Any filenames
15872 in the directory starting with @samp{.} are ignored. The directory is
15873 scanned when you first start Gnus, and each time you type @kbd{g} in
15874 the group buffer; if any maildirs have been removed or added,
15875 @code{nnmaildir} notices at these times.
15877 The value of the @code{directory} parameter should be a Lisp form
15878 which is processed by @code{eval} and @code{expand-file-name} to get
15879 the path of the directory for this server. The form is @code{eval}ed
15880 only when the server is opened; the resulting string is used until the
15881 server is closed. (If you don't know about forms and @code{eval},
15882 don't worry---a simple string will work.) This parameter is not
15883 optional; you must specify it. I don't recommend using
15884 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
15885 use that directory by default for various things, and may get confused
15886 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
15889 @item target-prefix
15890 This should be a Lisp form which is processed by @code{eval} and
15891 @code{expand-file-name}. The form is @code{eval}ed only when the
15892 server is opened; the resulting string is used until the server is
15895 When you create a group on an @code{nnmaildir} server, the maildir is
15896 created with @code{target-prefix} prepended to its name, and a symlink
15897 pointing to that maildir is created, named with the plain group name.
15898 So if @code{directory} is @code{"~/.nnmaildir"} and
15899 @code{target-prefix} is @code{"../maildirs/"}, then when you create
15900 the group @code{foo}, @code{nnmaildir} will create
15901 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
15902 @file{~/.nnmaildir/foo} as a symlink pointing to
15903 @file{../maildirs/foo}.
15905 You can set @code{target-prefix} to a string without any slashes to
15906 create both maildirs and symlinks in the same @code{directory}; in
15907 this case, any maildirs found in @code{directory} whose names start
15908 with @code{target-prefix} will not be listed as groups (but the
15909 symlinks pointing to them will be).
15911 As a special case, if @code{target-prefix} is @code{""} (the default),
15912 then when you create a group, the maildir will be created in
15913 @code{directory} without a corresponding symlink. Beware that you
15914 cannot use @code{gnus-group-delete-group} on such groups without the
15915 @code{force} argument.
15917 @item directory-files
15918 This should be a function with the same interface as
15919 @code{directory-files} (such as @code{directory-files} itself). It is
15920 used to scan the server's @code{directory} for maildirs. This
15921 parameter is optional; the default is
15922 @code{nnheader-directory-files-safe} if
15923 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15924 @code{directory-files} otherwise.
15925 (@code{nnheader-directory-files-is-safe} is checked only once when the
15926 server is opened; if you want to check it each time the directory is
15927 scanned, you'll have to provide your own function that does that.)
15930 If non-@code{nil}, then after scanning for new mail in the group
15931 maildirs themselves as usual, this server will also incorporate mail
15932 the conventional Gnus way, from @code{mail-sources} according to
15933 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
15934 value is @code{nil}.
15936 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15937 an @code{nnmaildir} group. The results might happen to be useful, but
15938 that would be by chance, not by design, and the results might be
15939 different in the future. If your split rules create new groups,
15940 remember to supply a @code{create-directory} server parameter.
15943 @subsubsection Group parameters
15945 @code{nnmaildir} uses several group parameters. It's safe to ignore
15946 all this; the default behavior for @code{nnmaildir} is the same as the
15947 default behavior for other mail back ends: articles are deleted after
15948 one week, etc. Except for the expiry parameters, all this
15949 functionality is unique to @code{nnmaildir}, so you can ignore it if
15950 you're just trying to duplicate the behavior you already have with
15953 If the value of any of these parameters is a vector, the first element
15954 is evaluated as a Lisp form and the result is used, rather than the
15955 original value. If the value is not a vector, the value itself is
15956 evaluated as a Lisp form. (This is why these parameters use names
15957 different from those of other, similar parameters supported by other
15958 back ends: they have different, though similar, meanings.) (For
15959 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15960 @code{eval} business again; for other values, remember to use an extra
15961 quote and wrap the value in a vector when appropriate.)
15965 An integer specifying the minimum age, in seconds, of an article
15966 before it will be expired, or the symbol @code{never} to specify that
15967 articles should never be expired. If this parameter is not set,
15968 @code{nnmaildir} falls back to the usual
15969 @code{nnmail-expiry-wait}(@code{-function}) variables (the
15970 @code{expiry-wait} group parameter overrides @code{nnmail-expiry-wait}
15971 and makes @code{nnmail-expiry-wait-function} ineffective). If you
15972 wanted a value of 3 days, you could use something like @code{[(* 3 24
15973 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15974 An article's age is measured starting from the article file's
15975 modification time. Normally, this is the same as the article's
15976 delivery time, but editing an article makes it younger. Moving an
15977 article (other than via expiry) may also make an article younger.
15980 If this is set to a string such as a full Gnus group name, like
15982 "backend+server.address.string:group.name"
15984 and if it is not the name of the same group that the parameter belongs
15985 to, then articles will be moved to the specified group during expiry
15986 before being deleted. @emph{If this is set to an @code{nnmaildir}
15987 group, the article will be just as old in the destination group as it
15988 was in the source group.} So be careful with @code{expire-age} in the
15989 destination group. If this is set to the name of the same group that
15990 the parameter belongs to, then the article is not expired at all. If
15991 you use the vector form, the first element is evaluated once for each
15992 article. So that form can refer to
15993 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15994 article. @emph{Even if this parameter is not set, @code{nnmaildir}
15995 does not fall back to the @code{expiry-target} group parameter or the
15996 @code{nnmail-expiry-target} variable.}
15999 If this is set to @code{t}, @code{nnmaildir} will treat the articles
16000 in this maildir as read-only. This means: articles are not renamed
16001 from @file{new/} into @file{cur/}; articles are only found in
16002 @file{new/}, not @file{cur/}; articles are never deleted; articles
16003 cannot be edited. @file{new/} is expected to be a symlink to the
16004 @file{new/} directory of another maildir---e.g., a system-wide mailbox
16005 containing a mailing list of common interest. Everything in the
16006 maildir outside @file{new/} is @emph{not} treated as read-only, so for
16007 a shared mailbox, you do still need to set up your own maildir (or
16008 have write permission to the shared mailbox); your maildir just won't
16009 contain extra copies of the articles.
16011 @item directory-files
16012 A function with the same interface as @code{directory-files}. It is
16013 used to scan the directories in the maildir corresponding to this
16014 group to find articles. The default is the function specified by the
16015 server's @code{directory-files} parameter.
16017 @item distrust-Lines:
16018 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
16019 article, rather than use the @code{Lines:} header field. If
16020 @code{nil}, the header field will be used if present.
16023 A list of mark symbols, such as @code{['(read expire)]}. Whenever
16024 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
16025 say that all articles have these marks, regardless of whether the
16026 marks stored in the filesystem say so. This is a proof-of-concept
16027 feature that will probably be removed eventually; it ought to be done
16028 in Gnus proper, or abandoned if it's not worthwhile.
16031 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
16032 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
16033 say that no articles have these marks, regardless of whether the marks
16034 stored in the filesystem say so. @code{never-marks} overrides
16035 @code{always-marks}. This is a proof-of-concept feature that will
16036 probably be removed eventually; it ought to be done in Gnus proper, or
16037 abandoned if it's not worthwhile.
16039 @item nov-cache-size
16040 An integer specifying the size of the @acronym{NOV} memory cache. To
16041 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
16042 for a limited number of articles in each group. (This is probably not
16043 worthwhile, and will probably be removed in the future.) This
16044 parameter's value is noticed only the first time a group is seen after
16045 the server is opened---i.e., when you first start Gnus, typically.
16046 The @acronym{NOV} cache is never resized until the server is closed
16047 and reopened. The default is an estimate of the number of articles
16048 that would be displayed in the summary buffer: a count of articles
16049 that are either marked with @code{tick} or not marked with
16050 @code{read}, plus a little extra.
16053 @subsubsection Article identification
16054 Articles are stored in the @file{cur/} subdirectory of each maildir.
16055 Each article file is named like @code{uniq:info}, where @code{uniq}
16056 contains no colons. @code{nnmaildir} ignores, but preserves, the
16057 @code{:info} part. (Other maildir readers typically use this part of
16058 the filename to store marks.) The @code{uniq} part uniquely
16059 identifies the article, and is used in various places in the
16060 @file{.nnmaildir/} subdirectory of the maildir to store information
16061 about the corresponding article. The full pathname of an article is
16062 available in the variable @code{nnmaildir-article-file-name} after you
16063 request the article in the summary buffer.
16065 @subsubsection NOV data
16066 An article identified by @code{uniq} has its @acronym{NOV} data (used
16067 to generate lines in the summary buffer) stored in
16068 @code{.nnmaildir/nov/uniq}. There is no
16069 @code{nnmaildir-generate-nov-databases} function. (There isn't much
16070 need for it---an article's @acronym{NOV} data is updated automatically
16071 when the article or @code{nnmail-extra-headers} has changed.) You can
16072 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
16073 single article simply by deleting the corresponding @acronym{NOV}
16074 file, but @emph{beware}: this will also cause @code{nnmaildir} to
16075 assign a new article number for this article, which may cause trouble
16076 with @code{seen} marks, the Agent, and the cache.
16078 @subsubsection Article marks
16079 An article identified by @code{uniq} is considered to have the mark
16080 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
16081 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
16082 looks for such files and reports the set of marks it finds. When Gnus
16083 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
16084 creates and deletes the corresponding files as needed. (Actually,
16085 rather than create a new file for each mark, it just creates hard
16086 links to @file{.nnmaildir/markfile}, to save inodes.)
16088 You can invent new marks by creating a new directory in
16089 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
16090 your server, untar it later, and keep your marks. You can add and
16091 remove marks yourself by creating and deleting mark files. If you do
16092 this while Gnus is running and your @code{nnmaildir} server is open,
16093 it's best to exit all summary buffers for @code{nnmaildir} groups and
16094 type @kbd{s} in the group buffer first, and to type @kbd{g} or
16095 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
16096 pick up the changes, and might undo them.
16100 @subsubsection Mail Folders
16102 @cindex mbox folders
16103 @cindex mail folders
16105 @code{nnfolder} is a back end for storing each mail group in a
16106 separate file. Each file is in the standard Un*x mbox format.
16107 @code{nnfolder} will add extra headers to keep track of article
16108 numbers and arrival dates.
16110 @cindex self contained nnfolder servers
16112 When the marks file is used (which it is by default), @code{nnfolder}
16113 servers have the property that you may backup them using @code{tar} or
16114 similar, and later be able to restore them into Gnus (by adding the
16115 proper @code{nnfolder} server) and have all your marks be preserved.
16116 Marks for a group are usually stored in a file named as the mbox file
16117 with @code{.mrk} concatenated to it (but see
16118 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
16119 directory. Individual @code{nnfolder} groups are also possible to
16120 backup, use @kbd{G m} to restore the group (after restoring the backup
16121 into the @code{nnfolder} directory).
16123 Virtual server settings:
16126 @item nnfolder-directory
16127 @vindex nnfolder-directory
16128 All the @code{nnfolder} mail boxes will be stored under this
16129 directory. The default is the value of @code{message-directory}
16130 (whose default is @file{~/Mail})
16132 @item nnfolder-active-file
16133 @vindex nnfolder-active-file
16134 The name of the active file. The default is @file{~/Mail/active}.
16136 @item nnfolder-newsgroups-file
16137 @vindex nnfolder-newsgroups-file
16138 The name of the group descriptions file. @xref{Newsgroups File
16139 Format}. The default is @file{~/Mail/newsgroups}
16141 @item nnfolder-get-new-mail
16142 @vindex nnfolder-get-new-mail
16143 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
16144 default is @code{t}
16146 @item nnfolder-save-buffer-hook
16147 @vindex nnfolder-save-buffer-hook
16148 @cindex backup files
16149 Hook run before saving the folders. Note that Emacs does the normal
16150 backup renaming of files even with the @code{nnfolder} buffers. If
16151 you wish to switch this off, you could say something like the
16152 following in your @file{.emacs} file:
16155 (defun turn-off-backup ()
16156 (set (make-local-variable 'backup-inhibited) t))
16158 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
16161 @item nnfolder-delete-mail-hook
16162 @vindex nnfolder-delete-mail-hook
16163 Hook run in a buffer narrowed to the message that is to be deleted.
16164 This function can be used to copy the message to somewhere else, or to
16165 extract some information from it before removing it.
16167 @item nnfolder-nov-is-evil
16168 @vindex nnfolder-nov-is-evil
16169 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
16170 default is @code{nil}.
16172 @item nnfolder-nov-file-suffix
16173 @vindex nnfolder-nov-file-suffix
16174 The extension for @acronym{NOV} files. The default is @file{.nov}.
16176 @item nnfolder-nov-directory
16177 @vindex nnfolder-nov-directory
16178 The directory where the @acronym{NOV} files should be stored. If
16179 @code{nil}, @code{nnfolder-directory} is used.
16181 @item nnfolder-marks-is-evil
16182 @vindex nnfolder-marks-is-evil
16183 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
16184 default is @code{nil}.
16186 @item nnfolder-marks-file-suffix
16187 @vindex nnfolder-marks-file-suffix
16188 The extension for @sc{marks} files. The default is @file{.mrk}.
16190 @item nnfolder-marks-directory
16191 @vindex nnfolder-marks-directory
16192 The directory where the @sc{marks} files should be stored. If
16193 @code{nil}, @code{nnfolder-directory} is used.
16198 @findex nnfolder-generate-active-file
16199 @kindex M-x nnfolder-generate-active-file
16200 If you have lots of @code{nnfolder}-like files you'd like to read with
16201 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
16202 command to make @code{nnfolder} aware of all likely files in
16203 @code{nnfolder-directory}. This only works if you use long file names,
16206 @node Comparing Mail Back Ends
16207 @subsubsection Comparing Mail Back Ends
16209 First, just for terminology, the @dfn{back end} is the common word for a
16210 low-level access method---a transport, if you will, by which something
16211 is acquired. The sense is that one's mail has to come from somewhere,
16212 and so selection of a suitable back end is required in order to get that
16213 mail within spitting distance of Gnus.
16215 The same concept exists for Usenet itself: Though access to articles is
16216 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
16217 in the world got at Usenet by running a reader on the machine where the
16218 articles lay (the machine which today we call an @acronym{NNTP} server), and
16219 access was by the reader stepping into the articles' directory spool
16220 area directly. One can still select between either the @code{nntp} or
16221 @code{nnspool} back ends, to select between these methods, if one happens
16222 actually to live on the server (or can see its spool directly, anyway,
16225 The goal in selecting a mail back end is to pick one which
16226 simultaneously represents a suitable way of dealing with the original
16227 format plus leaving mail in a form that is convenient to use in the
16228 future. Here are some high and low points on each:
16233 UNIX systems have historically had a single, very common, and well-
16234 defined format. All messages arrive in a single @dfn{spool file}, and
16235 they are delineated by a line whose regular expression matches
16236 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
16237 to make it clear in this instance that this is not the RFC-specified
16238 @samp{From:} header.) Because Emacs and therefore Gnus emanate
16239 historically from the Unix environment, it is simplest if one does not
16240 mess a great deal with the original mailbox format, so if one chooses
16241 this back end, Gnus' primary activity in getting mail from the real spool
16242 area to Gnus' preferred directory is simply to copy it, with no
16243 (appreciable) format change in the process. It is the ``dumbest'' way
16244 to move mail into availability in the Gnus environment. This makes it
16245 fast to move into place, but slow to parse, when Gnus has to look at
16250 Once upon a time, there was the DEC-10 and DEC-20, running operating
16251 systems called TOPS and related things, and the usual (only?) mail
16252 reading environment was a thing called Babyl. I don't know what format
16253 was used for mail landing on the system, but Babyl had its own internal
16254 format to which mail was converted, primarily involving creating a
16255 spool-file-like entity with a scheme for inserting Babyl-specific
16256 headers and status bits above the top of each message in the file.
16257 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
16258 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
16259 to understand the mail files folks already had in existence. Gnus (and
16260 VM, for that matter) continue to support this format because it's
16261 perceived as having some good qualities in those mailer-specific
16262 headers/status bits stuff. Rmail itself still exists as well, of
16263 course, and is still maintained by Stallman.
16265 Both of the above forms leave your mail in a single file on your
16266 file system, and they must parse that entire file each time you take a
16271 @code{nnml} is the back end which smells the most as though you were
16272 actually operating with an @code{nnspool}-accessed Usenet system. (In
16273 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
16274 lo these years ago.) One's mail is taken from the original spool file,
16275 and is then cut up into individual message files, 1:1. It maintains a
16276 Usenet-style active file (analogous to what one finds in an INN- or
16277 CNews-based news system in (for instance) @file{/var/lib/news/active},
16278 or what is returned via the @samp{NNTP LIST} verb) and also creates
16279 @dfn{overview} files for efficient group entry, as has been defined for
16280 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
16281 due to the creation of lots of files, updates to the @code{nnml} active
16282 file, and additions to overview files on a per-message basis, but it is
16283 extremely fast on access because of what amounts to the indexing support
16284 provided by the active file and overviews.
16286 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
16287 resource which defines available places in the file system to put new
16288 files. Sysadmins take a dim view of heavy inode occupation within
16289 tight, shared file systems. But if you live on a personal machine where
16290 the file system is your own and space is not at a premium, @code{nnml}
16293 It is also problematic using this back end if you are living in a
16294 FAT16-based Windows world, since much space will be wasted on all these
16299 The Rand MH mail-reading system has been around UNIX systems for a very
16300 long time; it operates by splitting one's spool file of messages into
16301 individual files, but with little or no indexing support---@code{nnmh}
16302 is considered to be semantically equivalent to ``@code{nnml} without
16303 active file or overviews''. This is arguably the worst choice, because
16304 one gets the slowness of individual file creation married to the
16305 slowness of access parsing when learning what's new in one's groups.
16309 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
16310 method described above) on a per-group basis. That is, @code{nnmbox}
16311 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
16312 little bit of optimization to this so that each of one's mail groups has
16313 a Unix mail box file. It's faster than @code{nnmbox} because each group
16314 can be parsed separately, and still provides the simple Unix mail box
16315 format requiring minimal effort in moving the mail around. In addition,
16316 it maintains an ``active'' file making it much faster for Gnus to figure
16317 out how many messages there are in each separate group.
16319 If you have groups that are expected to have a massive amount of
16320 messages, @code{nnfolder} is not the best choice, but if you receive
16321 only a moderate amount of mail, @code{nnfolder} is probably the most
16322 friendly mail back end all over.
16326 For configuring expiry and other things, @code{nnmaildir} uses
16327 incompatible group parameters, slightly different from those of other
16330 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
16331 differences. Each message is stored in a separate file, but the
16332 filename is unrelated to the article number in Gnus. @code{nnmaildir}
16333 also stores the equivalent of @code{nnml}'s overview files in one file
16334 per article, so it uses about twice as many inodes as @code{nnml}. (Use
16335 @code{df -i} to see how plentiful your inode supply is.) If this slows
16336 you down or takes up very much space, consider switching to
16337 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
16340 Since maildirs don't require locking for delivery, the maildirs you use
16341 as groups can also be the maildirs your mail is directly delivered to.
16342 This means you can skip Gnus' mail splitting if your mail is already
16343 organized into different mailboxes during delivery. A @code{directory}
16344 entry in @code{mail-sources} would have a similar effect, but would
16345 require one set of mailboxes for spooling deliveries (in mbox format,
16346 thus damaging message bodies), and another set to be used as groups (in
16347 whatever format you like). A maildir has a built-in spool, in the
16348 @code{new/} subdirectory. Beware that currently, mail moved from
16349 @code{new/} to @code{cur/} instead of via mail splitting will not
16350 undergo treatment such as duplicate checking.
16352 @code{nnmaildir} stores article marks for a given group in the
16353 corresponding maildir, in a way designed so that it's easy to manipulate
16354 them from outside Gnus. You can tar up a maildir, unpack it somewhere
16355 else, and still have your marks. @code{nnml} also stores marks, but
16356 it's not as easy to work with them from outside Gnus as with
16359 @code{nnmaildir} uses a significant amount of memory to speed things up.
16360 (It keeps in memory some of the things that @code{nnml} stores in files
16361 and that @code{nnmh} repeatedly parses out of message files.) If this
16362 is a problem for you, you can set the @code{nov-cache-size} group
16363 parameter to something small (0 would probably not work, but 1 probably
16364 would) to make it use less memory. This caching will probably be
16365 removed in the future.
16367 Startup is likely to be slower with @code{nnmaildir} than with other
16368 back ends. Everything else is likely to be faster, depending in part
16369 on your file system.
16371 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
16372 to write an @code{nnmaildir}-derived back end.
16377 @node Browsing the Web
16378 @section Browsing the Web
16380 @cindex browsing the web
16384 Web-based discussion forums are getting more and more popular. On many
16385 subjects, the web-based forums have become the most important forums,
16386 eclipsing the importance of mailing lists and news groups. The reason
16387 is easy to understand---they are friendly to new users; you just point
16388 and click, and there's the discussion. With mailing lists, you have to
16389 go through a cumbersome subscription procedure, and most people don't
16390 even know what a news group is.
16392 The problem with this scenario is that web browsers are not very good at
16393 being newsreaders. They do not keep track of what articles you've read;
16394 they do not allow you to score on subjects you're interested in; they do
16395 not allow off-line browsing; they require you to click around and drive
16396 you mad in the end.
16398 So---if web browsers suck at reading discussion forums, why not use Gnus
16401 Gnus has been getting a bit of a collection of back ends for providing
16402 interfaces to these sources.
16406 * Web Searches:: Creating groups from articles that match a string.
16407 * Slashdot:: Reading the Slashdot comments.
16408 * Ultimate:: The Ultimate Bulletin Board systems.
16409 * Web Archive:: Reading mailing list archived on web.
16410 * RSS:: Reading RDF site summary.
16411 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
16414 All the web sources require Emacs/W3 and the url library or those
16415 alternatives to work.
16417 The main caveat with all these web sources is that they probably won't
16418 work for a very long time. Gleaning information from the @acronym{HTML} data
16419 is guesswork at best, and when the layout is altered, the Gnus back end
16420 will fail. If you have reasonably new versions of these back ends,
16421 though, you should be ok.
16423 One thing all these Web methods have in common is that the Web sources
16424 are often down, unavailable or just plain too slow to be fun. In those
16425 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
16426 Unplugged}) handle downloading articles, and then you can read them at
16427 leisure from your local disk. No more World Wide Wait for you.
16429 @node Archiving Mail
16430 @subsection Archiving Mail
16431 @cindex archiving mail
16432 @cindex backup of mail
16434 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
16435 @code{nnmaildir}, now actually store the article marks with each group.
16436 For these servers, archiving and restoring a group while preserving
16437 marks is fairly simple.
16439 (Preserving the group level and group parameters as well still
16440 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
16443 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
16444 server, take a recursive copy of the server directory. There is no need
16445 to shut down Gnus, so archiving may be invoked by @code{cron} or
16446 similar. You restore the data by restoring the directory tree, and
16447 adding a server definition pointing to that directory in Gnus. The
16448 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
16449 might interfere with overwriting data, so you may want to shut down Gnus
16450 before you restore the data.
16452 It is also possible to archive individual @code{nnml},
16453 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
16454 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
16455 directory. For @code{nnfolder} you need to copy both the base folder
16456 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
16457 this example). Restoring the group is done with @kbd{G m} from the Group
16458 buffer. The last step makes Gnus notice the new directory.
16459 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
16460 is unnecessary in that case.
16463 @subsection Web Searches
16468 @cindex Usenet searches
16469 @cindex searching the Usenet
16471 It's, like, too neat to search the Usenet for articles that match a
16472 string, but it, like, totally @emph{sucks}, like, totally, to use one of
16473 those, like, Web browsers, and you, like, have to, rilly, like, look at
16474 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
16475 searches without having to use a browser.
16477 The @code{nnweb} back end allows an easy interface to the mighty search
16478 engine. You create an @code{nnweb} group, enter a search pattern, and
16479 then enter the group and read the articles like you would any normal
16480 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
16481 Groups}) will do this in an easy-to-use fashion.
16483 @code{nnweb} groups don't really lend themselves to being solid
16484 groups---they have a very fleeting idea of article numbers. In fact,
16485 each time you enter an @code{nnweb} group (not even changing the search
16486 pattern), you are likely to get the articles ordered in a different
16487 manner. Not even using duplicate suppression (@pxref{Duplicate
16488 Suppression}) will help, since @code{nnweb} doesn't even know the
16489 @code{Message-ID} of the articles before reading them using some search
16490 engines (Google, for instance). The only possible way to keep track
16491 of which articles you've read is by scoring on the @code{Date}
16492 header---mark all articles posted before the last date you read the
16495 If the search engine changes its output substantially, @code{nnweb}
16496 won't be able to parse it and will fail. One could hardly fault the Web
16497 providers if they were to do this---their @emph{raison d'@^etre} is to
16498 make money off of advertisements, not to provide services to the
16499 community. Since @code{nnweb} washes the ads off all the articles, one
16500 might think that the providers might be somewhat miffed. We'll see.
16502 You must have the @code{url} and @code{W3} package or those alternatives
16503 (try @code{customize-group} on the @samp{mm-url} variable group)
16504 installed to be able to use @code{nnweb}.
16506 Virtual server variables:
16511 What search engine type is being used. The currently supported types
16512 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
16513 @code{dejanews} is an alias to @code{google}.
16516 @vindex nnweb-search
16517 The search string to feed to the search engine.
16519 @item nnweb-max-hits
16520 @vindex nnweb-max-hits
16521 Advisory maximum number of hits per search to display. The default is
16524 @item nnweb-type-definition
16525 @vindex nnweb-type-definition
16526 Type-to-definition alist. This alist says what @code{nnweb} should do
16527 with the various search engine types. The following elements must be
16532 Function to decode the article and provide something that Gnus
16536 Function to create an article number to message header and URL alist.
16539 Function to send the search string to the search engine.
16542 The address the aforementioned function should send the search string
16546 Format string URL to fetch an article by @code{Message-ID}.
16553 @subsection Slashdot
16557 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
16558 lively discussion following the news articles. @code{nnslashdot} will
16559 let you read this forum in a convenient manner.
16561 The easiest way to read this source is to put something like the
16562 following in your @file{~/.gnus.el} file:
16565 (setq gnus-secondary-select-methods
16566 '((nnslashdot "")))
16569 This will make Gnus query the @code{nnslashdot} back end for new comments
16570 and groups. The @kbd{F} command will subscribe each new news article as
16571 a new Gnus group, and you can read the comments by entering these
16572 groups. (Note that the default subscription method is to subscribe new
16573 groups as zombies. Other methods are available (@pxref{Subscription
16576 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
16577 command is the most handy tool (@pxref{Foreign Groups}).
16579 When following up to @code{nnslashdot} comments (or posting new
16580 comments), some light @acronym{HTML}izations will be performed. In
16581 particular, text quoted with @samp{> } will be quoted with
16582 @samp{blockquote} instead, and signatures will have @samp{br} added to
16583 the end of each line. Other than that, you can just write @acronym{HTML}
16584 directly into the message buffer. Note that Slashdot filters out some
16585 @acronym{HTML} forms.
16587 The following variables can be altered to change its behavior:
16590 @item nnslashdot-threaded
16591 Whether @code{nnslashdot} should display threaded groups or not. The
16592 default is @code{t}. To be able to display threads, @code{nnslashdot}
16593 has to retrieve absolutely all comments in a group upon entry. If a
16594 threaded display is not required, @code{nnslashdot} will only retrieve
16595 the comments that are actually wanted by the user. Threading is nicer,
16596 but much, much slower than unthreaded.
16598 @item nnslashdot-login-name
16599 @vindex nnslashdot-login-name
16600 The login name to use when posting.
16602 @item nnslashdot-password
16603 @vindex nnslashdot-password
16604 The password to use when posting.
16606 @item nnslashdot-directory
16607 @vindex nnslashdot-directory
16608 Where @code{nnslashdot} will store its files. The default is
16609 @file{~/News/slashdot/}.
16611 @item nnslashdot-active-url
16612 @vindex nnslashdot-active-url
16613 The @acronym{URL} format string that will be used to fetch the
16614 information on news articles and comments. The default is@*
16615 @samp{http://slashdot.org/search.pl?section=&min=%d}.
16617 @item nnslashdot-comments-url
16618 @vindex nnslashdot-comments-url
16619 The @acronym{URL} format string that will be used to fetch comments.
16621 @item nnslashdot-article-url
16622 @vindex nnslashdot-article-url
16623 The @acronym{URL} format string that will be used to fetch the news
16624 article. The default is
16625 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
16627 @item nnslashdot-threshold
16628 @vindex nnslashdot-threshold
16629 The score threshold. The default is -1.
16631 @item nnslashdot-group-number
16632 @vindex nnslashdot-group-number
16633 The number of old groups, in addition to the ten latest, to keep
16634 updated. The default is 0.
16641 @subsection Ultimate
16643 @cindex Ultimate Bulletin Board
16645 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
16646 probably the most popular Web bulletin board system used. It has a
16647 quite regular and nice interface, and it's possible to get the
16648 information Gnus needs to keep groups updated.
16650 The easiest way to get started with @code{nnultimate} is to say
16651 something like the following in the group buffer: @kbd{B nnultimate RET
16652 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
16653 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
16654 you're interested in; there's quite a list of them on the Ultimate web
16655 site.) Then subscribe to the groups you're interested in from the
16656 server buffer, and read them from the group buffer.
16658 The following @code{nnultimate} variables can be altered:
16661 @item nnultimate-directory
16662 @vindex nnultimate-directory
16663 The directory where @code{nnultimate} stores its files. The default is@*
16664 @file{~/News/ultimate/}.
16669 @subsection Web Archive
16671 @cindex Web Archive
16673 Some mailing lists only have archives on Web servers, such as
16674 @uref{http://www.egroups.com/} and
16675 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
16676 interface, and it's possible to get the information Gnus needs to keep
16679 @findex gnus-group-make-warchive-group
16680 The easiest way to get started with @code{nnwarchive} is to say
16681 something like the following in the group buffer: @kbd{M-x
16682 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
16683 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
16684 @var{an_egroup} with the mailing list you subscribed, the
16685 @var{your@@email.address} with your email address.), or to browse the
16686 back end by @kbd{B nnwarchive RET mail-archive RET}.
16688 The following @code{nnwarchive} variables can be altered:
16691 @item nnwarchive-directory
16692 @vindex nnwarchive-directory
16693 The directory where @code{nnwarchive} stores its files. The default is@*
16694 @file{~/News/warchive/}.
16696 @item nnwarchive-login
16697 @vindex nnwarchive-login
16698 The account name on the web server.
16700 @item nnwarchive-passwd
16701 @vindex nnwarchive-passwd
16702 The password for your account on the web server.
16710 Some web sites have an RDF Site Summary (@acronym{RSS}).
16711 @acronym{RSS} is a format for summarizing headlines from news related
16712 sites (such as BBC or CNN). But basically anything list-like can be
16713 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
16714 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
16716 @acronym{RSS} has a quite regular and nice interface, and it's
16717 possible to get the information Gnus needs to keep groups updated.
16719 Note: you had better use Emacs which supports the @code{utf-8} coding
16720 system because @acronym{RSS} uses UTF-8 for encoding non-@acronym{ASCII}
16721 text by default. It is also used by default for non-@acronym{ASCII}
16724 @kindex G R (Group)
16725 Use @kbd{G R} from the group buffer to subscribe to a feed---you will be
16726 prompted for the location, the title and the description of the feed.
16727 The title, which allows any characters, will be used for the group name
16728 and the name of the group data file. The description can be omitted.
16730 An easy way to get started with @code{nnrss} is to say something like
16731 the following in the group buffer: @kbd{B nnrss RET RET y}, then
16732 subscribe to groups.
16734 The @code{nnrss} back end saves the group data file in
16735 @code{nnrss-directory} (see below) for each @code{nnrss} group. File
16736 names containing non-@acronym{ASCII} characters will be encoded by the
16737 coding system specified with the @code{nnmail-pathname-coding-system}
16738 variable. If it is @code{nil}, in Emacs the coding system defaults to
16739 the value of @code{default-file-name-coding-system}. If you are using
16740 XEmacs and want to use non-@acronym{ASCII} group names, you should set
16741 the value for the @code{nnmail-pathname-coding-system} variable properly.
16743 The @code{nnrss} back end generates @samp{multipart/alternative}
16744 @acronym{MIME} articles in which each contains a @samp{text/plain} part
16745 and a @samp{text/html} part.
16748 You can also use the following commands to import and export your
16749 subscriptions from a file in @acronym{OPML} format (Outline Processor
16752 @defun nnrss-opml-import file
16753 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
16757 @defun nnrss-opml-export
16758 Write your current @acronym{RSS} subscriptions to a buffer in
16759 @acronym{OPML} format.
16762 The following @code{nnrss} variables can be altered:
16765 @item nnrss-directory
16766 @vindex nnrss-directory
16767 The directory where @code{nnrss} stores its files. The default is
16768 @file{~/News/rss/}.
16770 @item nnrss-file-coding-system
16771 @vindex nnrss-file-coding-system
16772 The coding system used when reading and writing the @code{nnrss} groups
16773 data files. The default is the value of
16774 @code{mm-universal-coding-system} (which defaults to @code{emacs-mule}
16775 in Emacs or @code{escape-quoted} in XEmacs).
16777 @item nnrss-ignore-article-fields
16778 @vindex nnrss-ignore-article-fields
16779 Some feeds update constantly article fields during their publications,
16780 e.g. to indicate the number of comments. However, if there is
16781 a difference between the local article and the distant one, the latter
16782 is considered to be new. To avoid this and discard some fields, set this
16783 variable to the list of fields to be ignored. The default is
16784 @code{'(slash:comments)}.
16786 @item nnrss-use-local
16787 @vindex nnrss-use-local
16788 @findex nnrss-generate-download-script
16789 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
16790 the feeds from local files in @code{nnrss-directory}. You can use
16791 the command @code{nnrss-generate-download-script} to generate a
16792 download script using @command{wget}.
16794 @item nnrss-wash-html-in-text-plain-parts
16795 Non-@code{nil} means that @code{nnrss} renders text in @samp{text/plain}
16796 parts as @acronym{HTML}. The function specified by the
16797 @code{mm-text-html-renderer} variable (@pxref{Display Customization,
16798 ,Display Customization, emacs-mime, The Emacs MIME Manual}) will be used
16799 to render text. If it is @code{nil}, which is the default, text will
16800 simply be folded. Leave it @code{nil} if you prefer to see
16801 @samp{text/html} parts.
16804 The following code may be helpful, if you want to show the description in
16805 the summary buffer.
16808 (add-to-list 'nnmail-extra-headers nnrss-description-field)
16809 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
16811 (defun gnus-user-format-function-X (header)
16813 (assq nnrss-description-field (mail-header-extra header))))
16814 (if descr (concat "\n\t" (cdr descr)) "")))
16817 The following code may be useful to open an nnrss url directly from the
16821 (require 'browse-url)
16823 (defun browse-nnrss-url (arg)
16825 (let ((url (assq nnrss-url-field
16828 (assq (gnus-summary-article-number)
16829 gnus-newsgroup-data))))))
16832 (browse-url (cdr url))
16833 (gnus-summary-mark-as-read-forward 1))
16834 (gnus-summary-scroll-up arg))))
16836 (eval-after-load "gnus"
16837 #'(define-key gnus-summary-mode-map
16838 (kbd "<RET>") 'browse-nnrss-url))
16839 (add-to-list 'nnmail-extra-headers nnrss-url-field)
16842 Even if you have added @code{"text/html"} to the
16843 @code{mm-discouraged-alternatives} variable (@pxref{Display
16844 Customization, ,Display Customization, emacs-mime, The Emacs MIME
16845 Manual}) since you don't want to see @acronym{HTML} parts, it might be
16846 more useful especially in @code{nnrss} groups to display
16847 @samp{text/html} parts. Here's an example of setting
16848 @code{mm-discouraged-alternatives} as a group parameter (@pxref{Group
16849 Parameters}) in order to display @samp{text/html} parts only in
16850 @code{nnrss} groups:
16853 ;; @r{Set the default value of @code{mm-discouraged-alternatives}.}
16854 (eval-after-load "gnus-sum"
16856 'gnus-newsgroup-variables
16857 '(mm-discouraged-alternatives
16858 . '("text/html" "image/.*"))))
16860 ;; @r{Display @samp{text/html} parts in @code{nnrss} groups.}
16863 '("\\`nnrss:" (mm-discouraged-alternatives nil)))
16867 @node Customizing W3
16868 @subsection Customizing W3
16874 Gnus uses the url library to fetch web pages and Emacs/W3 (or those
16875 alternatives) to display web pages. Emacs/W3 is documented in its own
16876 manual, but there are some things that may be more relevant for Gnus
16879 For instance, a common question is how to make Emacs/W3 follow links
16880 using the @code{browse-url} functions (which will call some external web
16881 browser like Netscape). Here's one way:
16884 (eval-after-load "w3"
16886 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
16887 (defun w3-fetch (&optional url target)
16888 (interactive (list (w3-read-url-with-default)))
16889 (if (eq major-mode 'gnus-article-mode)
16891 (w3-fetch-orig url target)))))
16894 Put that in your @file{.emacs} file, and hitting links in W3-rendered
16895 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
16902 @cindex @acronym{IMAP}
16904 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
16905 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
16906 server is much similar to connecting to a news server, you just
16907 specify the network address of the server.
16909 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
16910 everything that @acronym{POP} can, it can hence be viewed as a
16911 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
16912 similar to @acronym{NNTP} being a news storage protocol---however,
16913 @acronym{IMAP} offers more features than @acronym{NNTP} because news
16914 is more or less read-only whereas mail is read-write.
16916 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
16917 entry in @code{mail-sources}. With this, Gnus will fetch mails from
16918 the @acronym{IMAP} server and store them on the local disk. This is
16919 not the usage described in this section---@xref{Mail Sources}.
16921 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
16922 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
16923 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
16924 usage explained in this section.
16926 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
16927 servers might look something like the following. (Note that for
16928 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
16932 (setq gnus-secondary-select-methods
16933 '((nnimap "simpleserver") ; @r{no special configuration}
16934 ; @r{perhaps a ssh port forwarded server:}
16936 (nnimap-address "localhost")
16937 (nnimap-server-port 1430))
16938 ; @r{a UW server running on localhost}
16940 (nnimap-server-port 143)
16941 (nnimap-address "localhost")
16942 (nnimap-list-pattern ("INBOX" "mail/*")))
16943 ; @r{anonymous public cyrus server:}
16944 (nnimap "cyrus.andrew.cmu.edu"
16945 (nnimap-authenticator anonymous)
16946 (nnimap-list-pattern "archive.*")
16947 (nnimap-stream network))
16948 ; @r{a ssl server on a non-standard port:}
16950 (nnimap-address "vic20.somewhere.com")
16951 (nnimap-server-port 9930)
16952 (nnimap-stream ssl))))
16955 After defining the new server, you can subscribe to groups on the
16956 server using normal Gnus commands such as @kbd{U} in the Group Buffer
16957 (@pxref{Subscription Commands}) or via the Server Buffer
16958 (@pxref{Server Buffer}).
16960 The following variables can be used to create a virtual @code{nnimap}
16965 @item nnimap-address
16966 @vindex nnimap-address
16968 The address of the remote @acronym{IMAP} server. Defaults to the virtual
16969 server name if not specified.
16971 @item nnimap-server-port
16972 @vindex nnimap-server-port
16973 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
16975 Note that this should be an integer, example server specification:
16978 (nnimap "mail.server.com"
16979 (nnimap-server-port 4711))
16982 @item nnimap-list-pattern
16983 @vindex nnimap-list-pattern
16984 String or list of strings of mailboxes to limit available groups to.
16985 This is used when the server has very many mailboxes and you're only
16986 interested in a few---some servers export your home directory via
16987 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
16988 @file{~/Mail/*} then.
16990 The string can also be a cons of REFERENCE and the string as above, what
16991 REFERENCE is used for is server specific, but on the University of
16992 Washington server it's a directory that will be concatenated with the
16995 Example server specification:
16998 (nnimap "mail.server.com"
16999 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
17000 ("~friend/Mail/" . "list/*"))))
17003 @item nnimap-stream
17004 @vindex nnimap-stream
17005 The type of stream used to connect to your server. By default, nnimap
17006 will detect and automatically use all of the below, with the exception
17007 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
17008 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
17009 be automatically detected, but it's not widely deployed yet.)
17011 Example server specification:
17014 (nnimap "mail.server.com"
17015 (nnimap-stream ssl))
17018 Please note that the value of @code{nnimap-stream} is a symbol!
17022 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
17023 @samp{gsasl} or @samp{imtest} program.
17025 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
17027 @dfn{starttls:} Connect via the STARTTLS extension (similar to
17028 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
17031 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
17032 @samp{gnutls-cli}).
17034 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
17035 @samp{openssl}) or SSLeay (@samp{s_client}).
17037 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
17039 @dfn{network:} Plain, TCP/IP network connection.
17042 @vindex imap-kerberos4-program
17043 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
17044 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
17045 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
17046 to make @code{imap.el} use a pty instead of a pipe when communicating
17047 with @samp{imtest}. You will then suffer from a line length
17048 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
17049 indefinitely if you have many articles in a mailbox. The variable
17050 @code{imap-kerberos4-program} contain parameters to pass to the imtest
17053 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
17054 needed. It is available from
17055 @uref{http://www.gnu.org/software/gnutls/}.
17057 @vindex imap-gssapi-program
17058 This parameter specifies a list of command lines that invoke a GSSAPI
17059 authenticated @acronym{IMAP} stream in a subshell. They are tried
17060 sequentially until a connection is made, or the list has been
17061 exhausted. By default, @samp{gsasl} from GNU SASL, available from
17062 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
17063 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
17066 @vindex imap-ssl-program
17067 For @acronym{SSL} connections, the OpenSSL program is available from
17068 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
17069 and nnimap support it too---although the most recent versions of
17070 SSLeay, 0.9.x, are known to have serious bugs making it
17071 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
17072 work. The variable @code{imap-ssl-program} contain parameters to pass
17075 @vindex imap-shell-program
17076 @vindex imap-shell-host
17077 For @acronym{IMAP} connections using the @code{shell} stream, the
17078 variable @code{imap-shell-program} specify what program to call. Make
17079 sure nothing is interfering with the output of the program, e.g., don't
17080 forget to redirect the error output to the void.
17082 @item nnimap-authenticator
17083 @vindex nnimap-authenticator
17085 The authenticator used to connect to the server. By default, nnimap
17086 will use the most secure authenticator your server is capable of.
17088 Example server specification:
17091 (nnimap "mail.server.com"
17092 (nnimap-authenticator anonymous))
17095 Please note that the value of @code{nnimap-authenticator} is a symbol!
17099 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
17100 external program @code{gsasl} or @code{imtest}.
17102 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
17105 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
17106 external library @code{digest-md5.el}.
17108 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
17110 @dfn{login:} Plain-text username/password via LOGIN.
17112 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
17115 @item nnimap-expunge-on-close
17117 @vindex nnimap-expunge-on-close
17118 Unlike Parmenides the @acronym{IMAP} designers have decided things that
17119 don't exist actually do exist. More specifically, @acronym{IMAP} has
17120 this concept of marking articles @code{Deleted} which doesn't actually
17121 delete them, and this (marking them @code{Deleted}, that is) is what
17122 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
17125 Since the articles aren't really removed when we mark them with the
17126 @code{Deleted} flag we'll need a way to actually delete them. Feel like
17127 running in circles yet?
17129 Traditionally, nnimap has removed all articles marked as @code{Deleted}
17130 when closing a mailbox but this is now configurable by this server
17133 The possible options are:
17138 The default behavior, delete all articles marked as ``Deleted'' when
17141 Never actually delete articles. Currently there is no way of showing
17142 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
17143 may allow you to do this. If you ever want to run the EXPUNGE command
17144 manually, @xref{Expunging mailboxes}.
17146 When closing mailboxes, nnimap will ask if you wish to expunge deleted
17151 @item nnimap-importantize-dormant
17152 @vindex nnimap-importantize-dormant
17154 If non-@code{nil} (the default), marks dormant articles as ticked (as
17155 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
17156 naturally still (only) be marked as dormant. This is to make dormant
17157 articles stand out, just like ticked articles, in other @acronym{IMAP}
17158 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
17161 Probably the only reason for frobbing this would be if you're trying
17162 enable per-user persistent dormant flags, using something like:
17165 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
17166 (format "gnus-dormant-%s" (user-login-name)))
17167 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
17168 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
17171 In this case, you would not want the per-user dormant flag showing up
17172 as ticked for other users.
17174 @item nnimap-expunge-search-string
17176 @vindex nnimap-expunge-search-string
17177 @cindex expiring @acronym{IMAP} mail
17179 This variable contain the @acronym{IMAP} search command sent to server when
17180 searching for articles eligible for expiring. The default is
17181 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
17182 UID set and the second @code{%s} is replaced by a date.
17184 Probably the only useful value to change this to is
17185 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
17186 messages instead of the internal article date. See section 6.4.4 of
17187 RFC 2060 for more information on valid strings.
17189 However, if @code{nnimap-search-uids-not-since-is-evil}
17190 is true, this variable has no effect since the search logic
17191 is reversed, as described below.
17193 @item nnimap-authinfo-file
17194 @vindex nnimap-authinfo-file
17196 A file containing credentials used to log in on servers. The format is
17197 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
17198 variable @code{nntp-authinfo-file} for exact syntax; also see
17199 @ref{NNTP}. An example of an .authinfo line for an IMAP server, is:
17202 machine students.uio.no login larsi password geheimnis port imap
17205 Note that it should be @code{port imap}, or @code{port 143}, if you
17206 use a @code{nnimap-stream} of @code{tls} or @code{ssl}, even if the
17207 actual port number used is port 993 for secured IMAP. For
17208 convenience, Gnus will accept @code{port imaps} as a synonym of
17211 @item nnimap-need-unselect-to-notice-new-mail
17212 @vindex nnimap-need-unselect-to-notice-new-mail
17214 Unselect mailboxes before looking for new mail in them. Some servers
17215 seem to need this under some circumstances; it was reported that
17218 @item nnimap-nov-is-evil
17219 @vindex nnimap-nov-is-evil
17220 @cindex Courier @acronym{IMAP} server
17221 @cindex @acronym{NOV}
17223 Never generate or use a local @acronym{NOV} database. Defaults to the
17224 value of @code{gnus-agent}.
17226 Using a @acronym{NOV} database usually makes header fetching much
17227 faster, but it uses the @code{UID SEARCH UID} command, which is very
17228 slow on some servers (notably some versions of Courier). Since the Gnus
17229 Agent caches the information in the @acronym{NOV} database without using
17230 the slow command, this variable defaults to true if the Agent is in use,
17231 and false otherwise.
17233 @item nnimap-search-uids-not-since-is-evil
17234 @vindex nnimap-search-uids-not-since-is-evil
17235 @cindex Courier @acronym{IMAP} server
17236 @cindex expiring @acronym{IMAP} mail
17238 Avoid the @code{UID SEARCH UID @var{message numbers} NOT SINCE
17239 @var{date}} command, which is slow on some @acronym{IMAP} servers
17240 (notably, some versions of Courier). Instead, use @code{UID SEARCH SINCE
17241 @var{date}} and prune the list of expirable articles within Gnus.
17243 When Gnus expires your mail (@pxref{Expiring Mail}), it starts with a
17244 list of expirable articles and asks the IMAP server questions like ``Of
17245 these articles, which ones are older than a week?'' While this seems
17246 like a perfectly reasonable question, some IMAP servers take a long time
17247 to answer it, since they seemingly go looking into every old article to
17248 see if it is one of the expirable ones. Curiously, the question ``Of
17249 @emph{all} articles, which ones are newer than a week?'' seems to be
17250 much faster to answer, so setting this variable causes Gnus to ask this
17251 question and figure out the answer to the real question itself.
17253 This problem can really sneak up on you: when you first configure Gnus,
17254 everything works fine, but once you accumulate a couple thousand
17255 messages, you start cursing Gnus for being so slow. On the other hand,
17256 if you get a lot of email within a week, setting this variable will
17257 cause a lot of network traffic between Gnus and the IMAP server.
17259 @item nnimap-logout-timeout
17260 @vindex nnimap-logout-timeout
17262 There is a case where a connection to a @acronym{IMAP} server is unable
17263 to close, when connecting to the server via a certain kind of network,
17264 e.g. @acronym{VPN}. In that case, it will be observed that a connection
17265 between Emacs and the local network looks alive even if the server has
17266 closed a connection for some reason (typically, a timeout).
17267 Consequently, Emacs continues waiting for a response from the server for
17268 the @code{LOGOUT} command that Emacs sent, or hangs in other words. If
17269 you are in such a network, setting this variable to a number of seconds
17270 will be helpful. If it is set, a hung connection will be closed
17271 forcibly, after this number of seconds from the time Emacs sends the
17272 @code{LOGOUT} command. It should not be too small value but too large
17273 value will be inconvenient too. Perhaps the value 1.0 will be a good
17274 candidate but it might be worth trying some other values.
17276 Example server specification:
17279 (nnimap "mail.server.com"
17280 (nnimap-logout-timeout 1.0))
17286 * Splitting in IMAP:: Splitting mail with nnimap.
17287 * Expiring in IMAP:: Expiring mail with nnimap.
17288 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
17289 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
17290 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
17291 * Debugging IMAP:: What to do when things don't work.
17296 @node Splitting in IMAP
17297 @subsection Splitting in IMAP
17298 @cindex splitting imap mail
17300 Splitting is something Gnus users have loved and used for years, and now
17301 the rest of the world is catching up. Yeah, dream on, not many
17302 @acronym{IMAP} servers have server side splitting and those that have
17303 splitting seem to use some non-standard protocol. This means that
17304 @acronym{IMAP} support for Gnus has to do its own splitting.
17308 (Incidentally, people seem to have been dreaming on, and Sieve has
17309 gaining a market share and is supported by several IMAP servers.
17310 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
17312 Here are the variables of interest:
17316 @item nnimap-split-crosspost
17317 @cindex splitting, crosspost
17319 @vindex nnimap-split-crosspost
17321 If non-@code{nil}, do crossposting if several split methods match the
17322 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
17323 found will be used.
17325 Nnmail equivalent: @code{nnmail-crosspost}.
17327 @item nnimap-split-inbox
17328 @cindex splitting, inbox
17330 @vindex nnimap-split-inbox
17332 A string or a list of strings that gives the name(s) of @acronym{IMAP}
17333 mailboxes to split from. Defaults to @code{nil}, which means that
17334 splitting is disabled!
17337 (setq nnimap-split-inbox
17338 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
17341 No nnmail equivalent.
17343 @item nnimap-split-rule
17344 @cindex splitting, rules
17345 @vindex nnimap-split-rule
17347 New mail found in @code{nnimap-split-inbox} will be split according to
17350 This variable contains a list of lists, where the first element in the
17351 sublist gives the name of the @acronym{IMAP} mailbox to move articles
17352 matching the regexp in the second element in the sublist. Got that?
17353 Neither did I, we need examples.
17356 (setq nnimap-split-rule
17358 "^Sender: owner-nnimap@@vic20.globalcom.se")
17359 ("INBOX.junk" "^Subject:.*MAKE MONEY")
17360 ("INBOX.private" "")))
17363 This will put all articles from the nnimap mailing list into mailbox
17364 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
17365 into INBOX.junk and everything else in INBOX.private.
17367 The first string may contain @samp{\\1} forms, like the ones used by
17368 replace-match to insert sub-expressions from the matched text. For
17372 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
17375 The first element can also be the symbol @code{junk} to indicate that
17376 matching messages should simply be deleted. Use with care.
17378 The second element can also be a function. In that case, it will be
17379 called with the first element of the rule as the argument, in a buffer
17380 containing the headers of the article. It should return a
17381 non-@code{nil} value if it thinks that the mail belongs in that group.
17383 Nnmail users might recollect that the last regexp had to be empty to
17384 match all articles (like in the example above). This is not required in
17385 nnimap. Articles not matching any of the regexps will not be moved out
17386 of your inbox. (This might affect performance if you keep lots of
17387 unread articles in your inbox, since the splitting code would go over
17388 them every time you fetch new mail.)
17390 These rules are processed from the beginning of the alist toward the
17391 end. The first rule to make a match will ``win'', unless you have
17392 crossposting enabled. In that case, all matching rules will ``win''.
17394 This variable can also have a function as its value, the function will
17395 be called with the headers narrowed and should return a group where it
17396 thinks the article should be split to. See @code{nnimap-split-fancy}.
17398 The splitting code tries to create mailboxes if it needs to.
17400 To allow for different split rules on different virtual servers, and
17401 even different split rules in different inboxes on the same server,
17402 the syntax of this variable have been extended along the lines of:
17405 (setq nnimap-split-rule
17406 '(("my1server" (".*" (("ding" "ding@@gnus.org")
17407 ("junk" "From:.*Simon"))))
17408 ("my2server" ("INBOX" nnimap-split-fancy))
17409 ("my[34]server" (".*" (("private" "To:.*Simon")
17410 ("junk" my-junk-func))))))
17413 The virtual server name is in fact a regexp, so that the same rules
17414 may apply to several servers. In the example, the servers
17415 @code{my3server} and @code{my4server} both use the same rules.
17416 Similarly, the inbox string is also a regexp. The actual splitting
17417 rules are as before, either a function, or a list with group/regexp or
17418 group/function elements.
17420 Nnmail equivalent: @code{nnmail-split-methods}.
17422 @item nnimap-split-predicate
17424 @vindex nnimap-split-predicate
17426 Mail matching this predicate in @code{nnimap-split-inbox} will be
17427 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
17429 This might be useful if you use another @acronym{IMAP} client to read mail in
17430 your inbox but would like Gnus to split all articles in the inbox
17431 regardless of readedness. Then you might change this to
17434 @item nnimap-split-fancy
17435 @cindex splitting, fancy
17436 @findex nnimap-split-fancy
17437 @vindex nnimap-split-fancy
17439 It's possible to set @code{nnimap-split-rule} to
17440 @code{nnmail-split-fancy} if you want to use fancy
17441 splitting. @xref{Fancy Mail Splitting}.
17443 However, to be able to have different fancy split rules for nnmail and
17444 nnimap back ends you can set @code{nnimap-split-rule} to
17445 @code{nnimap-split-fancy} and define the nnimap specific fancy split
17446 rule in @code{nnimap-split-fancy}.
17451 (setq nnimap-split-rule 'nnimap-split-fancy
17452 nnimap-split-fancy ...)
17455 Nnmail equivalent: @code{nnmail-split-fancy}.
17457 @item nnimap-split-download-body
17458 @findex nnimap-split-download-body
17459 @vindex nnimap-split-download-body
17461 Set to non-@code{nil} to download entire articles during splitting.
17462 This is generally not required, and will slow things down
17463 considerably. You may need it if you want to use an advanced
17464 splitting function that analyzes the body to split the article.
17468 @node Expiring in IMAP
17469 @subsection Expiring in IMAP
17470 @cindex expiring @acronym{IMAP} mail
17472 Even though @code{nnimap} is not a proper @code{nnmail} derived back
17473 end, it supports most features in regular expiring (@pxref{Expiring
17474 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
17475 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
17476 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
17477 follows below are the variables used by the @code{nnimap} expiry
17480 A note on how the expire mark is stored on the @acronym{IMAP} server is
17481 appropriate here as well. The expire mark is translated into a
17482 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
17483 message. This means that likely only Gnus will understand and treat
17484 the @code{gnus-expire} mark properly, although other clients may allow
17485 you to view client specific flags on the message. It also means that
17486 your server must support permanent storage of client specific flags on
17487 messages. Most do, fortunately.
17489 If expiring @acronym{IMAP} mail seems very slow, try setting the server
17490 variable @code{nnimap-search-uids-not-since-is-evil}.
17494 @item nnmail-expiry-wait
17495 @item nnmail-expiry-wait-function
17497 These variables are fully supported. The expire value can be a
17498 number, the symbol @code{immediate} or @code{never}.
17500 @item nnmail-expiry-target
17502 This variable is supported, and internally implemented by calling the
17503 @code{nnmail} functions that handle this. It contains an optimization
17504 that if the destination is a @acronym{IMAP} group on the same server, the
17505 article is copied instead of appended (that is, uploaded again).
17509 @node Editing IMAP ACLs
17510 @subsection Editing IMAP ACLs
17511 @cindex editing imap acls
17512 @cindex Access Control Lists
17513 @cindex Editing @acronym{IMAP} ACLs
17514 @kindex G l (Group)
17515 @findex gnus-group-nnimap-edit-acl
17517 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
17518 limiting (or enabling) other users access to your mail boxes. Not all
17519 @acronym{IMAP} servers support this, this function will give an error if it
17522 To edit an ACL for a mailbox, type @kbd{G l}
17523 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
17524 editing window with detailed instructions.
17526 Some possible uses:
17530 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
17531 on your mailing list mailboxes enables other users on the same server to
17532 follow the list without subscribing to it.
17534 At least with the Cyrus server, you are required to give the user
17535 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
17536 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
17540 @node Expunging mailboxes
17541 @subsection Expunging mailboxes
17545 @cindex manual expunging
17546 @kindex G x (Group)
17547 @findex gnus-group-nnimap-expunge
17549 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
17550 you may want the option of expunging all deleted articles in a mailbox
17551 manually. This is exactly what @kbd{G x} does.
17553 Currently there is no way of showing deleted articles, you can just
17556 @node A note on namespaces
17557 @subsection A note on namespaces
17558 @cindex IMAP namespace
17561 The @acronym{IMAP} protocol has a concept called namespaces, described
17562 by the following text in the RFC2060:
17565 5.1.2. Mailbox Namespace Naming Convention
17567 By convention, the first hierarchical element of any mailbox name
17568 which begins with "#" identifies the "namespace" of the remainder of
17569 the name. This makes it possible to disambiguate between different
17570 types of mailbox stores, each of which have their own namespaces.
17572 For example, implementations which offer access to USENET
17573 newsgroups MAY use the "#news" namespace to partition the USENET
17574 newsgroup namespace from that of other mailboxes. Thus, the
17575 comp.mail.misc newsgroup would have an mailbox name of
17576 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
17577 to a different object (e.g. a user's private mailbox).
17580 While there is nothing in this text that warrants concern for the
17581 @acronym{IMAP} implementation in Gnus, some servers use namespace
17582 prefixes in a way that does not work with how Gnus uses mailbox names.
17584 Specifically, University of Washington's @acronym{IMAP} server uses
17585 mailbox names like @code{#driver.mbx/read-mail} which are valid only
17586 in the @sc{create} and @sc{append} commands. After the mailbox is
17587 created (or a messages is appended to a mailbox), it must be accessed
17588 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
17589 not make it possible for the user to guarantee that user entered
17590 mailbox names will only be used with the CREATE and APPEND commands,
17591 you should simply not use the namespace prefixed mailbox names in
17594 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
17595 for more information on how to use the prefixes. They are a power
17596 tool and should be used only if you are sure what the effects are.
17598 @node Debugging IMAP
17599 @subsection Debugging IMAP
17600 @cindex IMAP debugging
17601 @cindex protocol dump (IMAP)
17603 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
17604 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
17605 best to fix them right away. If you encounter odd behavior, chances
17606 are that either the server or Gnus is buggy.
17608 If you are familiar with network protocols in general, you will
17609 probably be able to extract some clues from the protocol dump of the
17610 exchanges between Gnus and the server. Even if you are not familiar
17611 with network protocols, when you include the protocol dump in
17612 @acronym{IMAP}-related bug reports you are helping us with data
17613 critical to solving the problem. Therefore, we strongly encourage you
17614 to include the protocol dump when reporting IMAP bugs in Gnus.
17618 Because the protocol dump, when enabled, generates lots of data, it is
17619 disabled by default. You can enable it by setting @code{imap-log} as
17626 This instructs the @code{imap.el} package to log any exchanges with
17627 the server. The log is stored in the buffer @samp{*imap-log*}. Look
17628 for error messages, which sometimes are tagged with the keyword
17629 @code{BAD}---but when submitting a bug, make sure to include all the
17632 @node Other Sources
17633 @section Other Sources
17635 Gnus can do more than just read news or mail. The methods described
17636 below allow Gnus to view directories and files as if they were
17640 * Directory Groups:: You can read a directory as if it was a newsgroup.
17641 * Anything Groups:: Dired? Who needs dired?
17642 * Document Groups:: Single files can be the basis of a group.
17643 * SOUP:: Reading @sc{soup} packets ``offline''.
17644 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
17648 @node Directory Groups
17649 @subsection Directory Groups
17651 @cindex directory groups
17653 If you have a directory that has lots of articles in separate files in
17654 it, you might treat it as a newsgroup. The files have to have numerical
17657 This might be an opportune moment to mention @code{ange-ftp} (and its
17658 successor @code{efs}), that most wonderful of all wonderful Emacs
17659 packages. When I wrote @code{nndir}, I didn't think much about it---a
17660 back end to read directories. Big deal.
17662 @code{ange-ftp} changes that picture dramatically. For instance, if you
17663 enter the @code{ange-ftp} file name
17664 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
17665 @code{ange-ftp} or @code{efs} will actually allow you to read this
17666 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
17668 @code{nndir} will use @acronym{NOV} files if they are present.
17670 @code{nndir} is a ``read-only'' back end---you can't delete or expire
17671 articles with this method. You can use @code{nnmh} or @code{nnml} for
17672 whatever you use @code{nndir} for, so you could switch to any of those
17673 methods if you feel the need to have a non-read-only @code{nndir}.
17676 @node Anything Groups
17677 @subsection Anything Groups
17680 From the @code{nndir} back end (which reads a single spool-like
17681 directory), it's just a hop and a skip to @code{nneething}, which
17682 pretends that any arbitrary directory is a newsgroup. Strange, but
17685 When @code{nneething} is presented with a directory, it will scan this
17686 directory and assign article numbers to each file. When you enter such
17687 a group, @code{nneething} must create ``headers'' that Gnus can use.
17688 After all, Gnus is a newsreader, in case you're forgetting.
17689 @code{nneething} does this in a two-step process. First, it snoops each
17690 file in question. If the file looks like an article (i.e., the first
17691 few lines look like headers), it will use this as the head. If this is
17692 just some arbitrary file without a head (e.g. a C source file),
17693 @code{nneething} will cobble up a header out of thin air. It will use
17694 file ownership, name and date and do whatever it can with these
17697 All this should happen automatically for you, and you will be presented
17698 with something that looks very much like a newsgroup. Totally like a
17699 newsgroup, to be precise. If you select an article, it will be displayed
17700 in the article buffer, just as usual.
17702 If you select a line that represents a directory, Gnus will pop you into
17703 a new summary buffer for this @code{nneething} group. And so on. You can
17704 traverse the entire disk this way, if you feel like, but remember that
17705 Gnus is not dired, really, and does not intend to be, either.
17707 There are two overall modes to this action---ephemeral or solid. When
17708 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
17709 will not store information on what files you have read, and what files
17710 are new, and so on. If you create a solid @code{nneething} group the
17711 normal way with @kbd{G m}, Gnus will store a mapping table between
17712 article numbers and file names, and you can treat this group like any
17713 other groups. When you activate a solid @code{nneething} group, you will
17714 be told how many unread articles it contains, etc., etc.
17719 @item nneething-map-file-directory
17720 @vindex nneething-map-file-directory
17721 All the mapping files for solid @code{nneething} groups will be stored
17722 in this directory, which defaults to @file{~/.nneething/}.
17724 @item nneething-exclude-files
17725 @vindex nneething-exclude-files
17726 All files that match this regexp will be ignored. Nice to use to exclude
17727 auto-save files and the like, which is what it does by default.
17729 @item nneething-include-files
17730 @vindex nneething-include-files
17731 Regexp saying what files to include in the group. If this variable is
17732 non-@code{nil}, only files matching this regexp will be included.
17734 @item nneething-map-file
17735 @vindex nneething-map-file
17736 Name of the map files.
17740 @node Document Groups
17741 @subsection Document Groups
17743 @cindex documentation group
17746 @code{nndoc} is a cute little thing that will let you read a single file
17747 as a newsgroup. Several files types are supported:
17753 The Babyl (Rmail) mail box.
17758 The standard Unix mbox file.
17760 @cindex MMDF mail box
17762 The MMDF mail box format.
17765 Several news articles appended into a file.
17767 @cindex rnews batch files
17769 The rnews batch transport format.
17772 Netscape mail boxes.
17775 @acronym{MIME} multipart messages.
17777 @item standard-digest
17778 The standard (RFC 1153) digest format.
17781 A @acronym{MIME} digest of messages.
17783 @item lanl-gov-announce
17784 Announcement messages from LANL Gov Announce.
17786 @cindex forwarded messages
17787 @item rfc822-forward
17788 A message forwarded according to RFC822.
17791 The Outlook mail box.
17794 The Outlook Express dbx mail box.
17797 A bounce message from the Exim MTA.
17800 A message forwarded according to informal rules.
17803 An RFC934-forwarded message.
17809 A digest of Clarinet brief news items.
17812 Non-standard digest format---matches most things, but does it badly.
17818 You can also use the special ``file type'' @code{guess}, which means
17819 that @code{nndoc} will try to guess what file type it is looking at.
17820 @code{digest} means that @code{nndoc} should guess what digest type the
17823 @code{nndoc} will not try to change the file or insert any extra headers into
17824 it---it will simply, like, let you use the file as the basis for a
17825 group. And that's it.
17827 If you have some old archived articles that you want to insert into your
17828 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
17829 that. Say you have an old @file{RMAIL} file with mail that you now want
17830 to split into your new @code{nnml} groups. You look at that file using
17831 @code{nndoc} (using the @kbd{G f} command in the group buffer
17832 (@pxref{Foreign Groups})), set the process mark on all the articles in
17833 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
17834 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
17835 file is now also stored in lots of @code{nnml} directories, and you can
17836 delete that pesky @file{RMAIL} file. If you have the guts!
17838 Virtual server variables:
17841 @item nndoc-article-type
17842 @vindex nndoc-article-type
17843 This should be one of @code{mbox}, @code{babyl}, @code{digest},
17844 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
17845 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
17846 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
17847 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
17849 @item nndoc-post-type
17850 @vindex nndoc-post-type
17851 This variable says whether Gnus is to consider the group a news group or
17852 a mail group. There are two valid values: @code{mail} (the default)
17857 * Document Server Internals:: How to add your own document types.
17861 @node Document Server Internals
17862 @subsubsection Document Server Internals
17864 Adding new document types to be recognized by @code{nndoc} isn't
17865 difficult. You just have to whip up a definition of what the document
17866 looks like, write a predicate function to recognize that document type,
17867 and then hook into @code{nndoc}.
17869 First, here's an example document type definition:
17873 (article-begin . "^\^A\^A\^A\^A\n")
17874 (body-end . "^\^A\^A\^A\^A\n"))
17877 The definition is simply a unique @dfn{name} followed by a series of
17878 regexp pseudo-variable settings. Below are the possible
17879 variables---don't be daunted by the number of variables; most document
17880 types can be defined with very few settings:
17883 @item first-article
17884 If present, @code{nndoc} will skip past all text until it finds
17885 something that match this regexp. All text before this will be
17888 @item article-begin
17889 This setting has to be present in all document type definitions. It
17890 says what the beginning of each article looks like. To do more
17891 complicated things that cannot be dealt with a simple regexp, you can
17892 use @code{article-begin-function} instead of this.
17894 @item article-begin-function
17895 If present, this should be a function that moves point to the beginning
17896 of each article. This setting overrides @code{article-begin}.
17899 If present, this should be a regexp that matches the head of the
17900 article. To do more complicated things that cannot be dealt with a
17901 simple regexp, you can use @code{head-begin-function} instead of this.
17903 @item head-begin-function
17904 If present, this should be a function that moves point to the head of
17905 the article. This setting overrides @code{head-begin}.
17908 This should match the end of the head of the article. It defaults to
17909 @samp{^$}---the empty line.
17912 This should match the beginning of the body of the article. It defaults
17913 to @samp{^\n}. To do more complicated things that cannot be dealt with
17914 a simple regexp, you can use @code{body-begin-function} instead of this.
17916 @item body-begin-function
17917 If present, this function should move point to the beginning of the body
17918 of the article. This setting overrides @code{body-begin}.
17921 If present, this should match the end of the body of the article. To do
17922 more complicated things that cannot be dealt with a simple regexp, you
17923 can use @code{body-end-function} instead of this.
17925 @item body-end-function
17926 If present, this function should move point to the end of the body of
17927 the article. This setting overrides @code{body-end}.
17930 If present, this should match the beginning of the file. All text
17931 before this regexp will be totally ignored.
17934 If present, this should match the end of the file. All text after this
17935 regexp will be totally ignored.
17939 So, using these variables @code{nndoc} is able to dissect a document
17940 file into a series of articles, each with a head and a body. However, a
17941 few more variables are needed since not all document types are all that
17942 news-like---variables needed to transform the head or the body into
17943 something that's palatable for Gnus:
17946 @item prepare-body-function
17947 If present, this function will be called when requesting an article. It
17948 will be called with point at the start of the body, and is useful if the
17949 document has encoded some parts of its contents.
17951 @item article-transform-function
17952 If present, this function is called when requesting an article. It's
17953 meant to be used for more wide-ranging transformation of both head and
17954 body of the article.
17956 @item generate-head-function
17957 If present, this function is called to generate a head that Gnus can
17958 understand. It is called with the article number as a parameter, and is
17959 expected to generate a nice head for the article in question. It is
17960 called when requesting the headers of all articles.
17962 @item generate-article-function
17963 If present, this function is called to generate an entire article that
17964 Gnus can understand. It is called with the article number as a
17965 parameter when requesting all articles.
17967 @item dissection-function
17968 If present, this function is called to dissect a document by itself,
17969 overriding @code{first-article}, @code{article-begin},
17970 @code{article-begin-function}, @code{head-begin},
17971 @code{head-begin-function}, @code{head-end}, @code{body-begin},
17972 @code{body-begin-function}, @code{body-end}, @code{body-end-function},
17973 @code{file-begin}, and @code{file-end}.
17977 Let's look at the most complicated example I can come up with---standard
17982 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
17983 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
17984 (prepare-body-function . nndoc-unquote-dashes)
17985 (body-end-function . nndoc-digest-body-end)
17986 (head-end . "^ ?$")
17987 (body-begin . "^ ?\n")
17988 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
17989 (subtype digest guess))
17992 We see that all text before a 70-width line of dashes is ignored; all
17993 text after a line that starts with that @samp{^End of} is also ignored;
17994 each article begins with a 30-width line of dashes; the line separating
17995 the head from the body may contain a single space; and that the body is
17996 run through @code{nndoc-unquote-dashes} before being delivered.
17998 To hook your own document definition into @code{nndoc}, use the
17999 @code{nndoc-add-type} function. It takes two parameters---the first
18000 is the definition itself and the second (optional) parameter says
18001 where in the document type definition alist to put this definition.
18002 The alist is traversed sequentially, and
18003 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
18004 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
18005 @code{mmdf} type, and so on. These type predicates should return
18006 @code{nil} if the document is not of the correct type; @code{t} if it
18007 is of the correct type; and a number if the document might be of the
18008 correct type. A high number means high probability; a low number
18009 means low probability with @samp{0} being the lowest valid number.
18017 In the PC world people often talk about ``offline'' newsreaders. These
18018 are thingies that are combined reader/news transport monstrosities.
18019 With built-in modem programs. Yecchh!
18021 Of course, us Unix Weenie types of human beans use things like
18022 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
18023 transport things like Ghod intended. And then we just use normal
18026 However, it can sometimes be convenient to do something that's a bit
18027 easier on the brain if you have a very slow modem, and you're not really
18028 that interested in doing things properly.
18030 A file format called @sc{soup} has been developed for transporting news
18031 and mail from servers to home machines and back again. It can be a bit
18034 First some terminology:
18039 This is the machine that is connected to the outside world and where you
18040 get news and/or mail from.
18043 This is the machine that you want to do the actual reading and responding
18044 on. It is typically not connected to the rest of the world in any way.
18047 Something that contains messages and/or commands. There are two kinds
18051 @item message packets
18052 These are packets made at the server, and typically contain lots of
18053 messages for you to read. These are called @file{SoupoutX.tgz} by
18054 default, where @var{x} is a number.
18056 @item response packets
18057 These are packets made at the home machine, and typically contains
18058 replies that you've written. These are called @file{SoupinX.tgz} by
18059 default, where @var{x} is a number.
18069 You log in on the server and create a @sc{soup} packet. You can either
18070 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
18071 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
18072 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
18075 You transfer the packet home. Rail, boat, car or modem will do fine.
18078 You put the packet in your home directory.
18081 You fire up Gnus on your home machine using the @code{nnsoup} back end as
18082 the native or secondary server.
18085 You read articles and mail and answer and followup to the things you
18086 want (@pxref{SOUP Replies}).
18089 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
18093 You transfer this packet to the server.
18096 You use Gnus to mail this packet out with the @kbd{G s s} command.
18099 You then repeat until you die.
18103 So you basically have a bipartite system---you use @code{nnsoup} for
18104 reading and Gnus for packing/sending these @sc{soup} packets.
18107 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
18108 * SOUP Groups:: A back end for reading @sc{soup} packets.
18109 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
18113 @node SOUP Commands
18114 @subsubsection SOUP Commands
18116 These are commands for creating and manipulating @sc{soup} packets.
18120 @kindex G s b (Group)
18121 @findex gnus-group-brew-soup
18122 Pack all unread articles in the current group
18123 (@code{gnus-group-brew-soup}). This command understands the
18124 process/prefix convention.
18127 @kindex G s w (Group)
18128 @findex gnus-soup-save-areas
18129 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
18132 @kindex G s s (Group)
18133 @findex gnus-soup-send-replies
18134 Send all replies from the replies packet
18135 (@code{gnus-soup-send-replies}).
18138 @kindex G s p (Group)
18139 @findex gnus-soup-pack-packet
18140 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
18143 @kindex G s r (Group)
18144 @findex nnsoup-pack-replies
18145 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
18148 @kindex O s (Summary)
18149 @findex gnus-soup-add-article
18150 This summary-mode command adds the current article to a @sc{soup} packet
18151 (@code{gnus-soup-add-article}). It understands the process/prefix
18152 convention (@pxref{Process/Prefix}).
18157 There are a few variables to customize where Gnus will put all these
18162 @item gnus-soup-directory
18163 @vindex gnus-soup-directory
18164 Directory where Gnus will save intermediate files while composing
18165 @sc{soup} packets. The default is @file{~/SoupBrew/}.
18167 @item gnus-soup-replies-directory
18168 @vindex gnus-soup-replies-directory
18169 This is what Gnus will use as a temporary directory while sending our
18170 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
18172 @item gnus-soup-prefix-file
18173 @vindex gnus-soup-prefix-file
18174 Name of the file where Gnus stores the last used prefix. The default is
18175 @samp{gnus-prefix}.
18177 @item gnus-soup-packer
18178 @vindex gnus-soup-packer
18179 A format string command for packing a @sc{soup} packet. The default is
18180 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
18182 @item gnus-soup-unpacker
18183 @vindex gnus-soup-unpacker
18184 Format string command for unpacking a @sc{soup} packet. The default is
18185 @samp{gunzip -c %s | tar xvf -}.
18187 @item gnus-soup-packet-directory
18188 @vindex gnus-soup-packet-directory
18189 Where Gnus will look for reply packets. The default is @file{~/}.
18191 @item gnus-soup-packet-regexp
18192 @vindex gnus-soup-packet-regexp
18193 Regular expression matching @sc{soup} reply packets in
18194 @code{gnus-soup-packet-directory}.
18200 @subsubsection SOUP Groups
18203 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
18204 read incoming packets, unpack them, and put them in a directory where
18205 you can read them at leisure.
18207 These are the variables you can use to customize its behavior:
18211 @item nnsoup-tmp-directory
18212 @vindex nnsoup-tmp-directory
18213 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
18214 directory. (@file{/tmp/} by default.)
18216 @item nnsoup-directory
18217 @vindex nnsoup-directory
18218 @code{nnsoup} then moves each message and index file to this directory.
18219 The default is @file{~/SOUP/}.
18221 @item nnsoup-replies-directory
18222 @vindex nnsoup-replies-directory
18223 All replies will be stored in this directory before being packed into a
18224 reply packet. The default is @file{~/SOUP/replies/}.
18226 @item nnsoup-replies-format-type
18227 @vindex nnsoup-replies-format-type
18228 The @sc{soup} format of the replies packets. The default is @samp{?n}
18229 (rnews), and I don't think you should touch that variable. I probably
18230 shouldn't even have documented it. Drats! Too late!
18232 @item nnsoup-replies-index-type
18233 @vindex nnsoup-replies-index-type
18234 The index type of the replies packet. The default is @samp{?n}, which
18235 means ``none''. Don't fiddle with this one either!
18237 @item nnsoup-active-file
18238 @vindex nnsoup-active-file
18239 Where @code{nnsoup} stores lots of information. This is not an ``active
18240 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
18241 this file or mess it up in any way, you're dead. The default is
18242 @file{~/SOUP/active}.
18244 @item nnsoup-packer
18245 @vindex nnsoup-packer
18246 Format string command for packing a reply @sc{soup} packet. The default
18247 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
18249 @item nnsoup-unpacker
18250 @vindex nnsoup-unpacker
18251 Format string command for unpacking incoming @sc{soup} packets. The
18252 default is @samp{gunzip -c %s | tar xvf -}.
18254 @item nnsoup-packet-directory
18255 @vindex nnsoup-packet-directory
18256 Where @code{nnsoup} will look for incoming packets. The default is
18259 @item nnsoup-packet-regexp
18260 @vindex nnsoup-packet-regexp
18261 Regular expression matching incoming @sc{soup} packets. The default is
18264 @item nnsoup-always-save
18265 @vindex nnsoup-always-save
18266 If non-@code{nil}, save the replies buffer after each posted message.
18272 @subsubsection SOUP Replies
18274 Just using @code{nnsoup} won't mean that your postings and mailings end
18275 up in @sc{soup} reply packets automagically. You have to work a bit
18276 more for that to happen.
18278 @findex nnsoup-set-variables
18279 The @code{nnsoup-set-variables} command will set the appropriate
18280 variables to ensure that all your followups and replies end up in the
18283 In specific, this is what it does:
18286 (setq message-send-news-function 'nnsoup-request-post)
18287 (setq message-send-mail-function 'nnsoup-request-mail)
18290 And that's it, really. If you only want news to go into the @sc{soup}
18291 system you just use the first line. If you only want mail to be
18292 @sc{soup}ed you use the second.
18295 @node Mail-To-News Gateways
18296 @subsection Mail-To-News Gateways
18297 @cindex mail-to-news gateways
18300 If your local @code{nntp} server doesn't allow posting, for some reason
18301 or other, you can post using one of the numerous mail-to-news gateways.
18302 The @code{nngateway} back end provides the interface.
18304 Note that you can't read anything from this back end---it can only be
18310 @item nngateway-address
18311 @vindex nngateway-address
18312 This is the address of the mail-to-news gateway.
18314 @item nngateway-header-transformation
18315 @vindex nngateway-header-transformation
18316 News headers often have to be transformed in some odd way or other
18317 for the mail-to-news gateway to accept it. This variable says what
18318 transformation should be called, and defaults to
18319 @code{nngateway-simple-header-transformation}. The function is called
18320 narrowed to the headers to be transformed and with one parameter---the
18323 This default function just inserts a new @code{To} header based on the
18324 @code{Newsgroups} header and the gateway address.
18325 For instance, an article with this @code{Newsgroups} header:
18328 Newsgroups: alt.religion.emacs
18331 will get this @code{To} header inserted:
18334 To: alt-religion-emacs@@GATEWAY
18337 The following pre-defined functions exist:
18339 @findex nngateway-simple-header-transformation
18342 @item nngateway-simple-header-transformation
18343 Creates a @code{To} header that looks like
18344 @var{newsgroup}@@@code{nngateway-address}.
18346 @findex nngateway-mail2news-header-transformation
18348 @item nngateway-mail2news-header-transformation
18349 Creates a @code{To} header that looks like
18350 @code{nngateway-address}.
18358 (setq gnus-post-method
18360 "mail2news@@replay.com"
18361 (nngateway-header-transformation
18362 nngateway-mail2news-header-transformation)))
18365 So, to use this, simply say something like:
18368 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
18373 @node Combined Groups
18374 @section Combined Groups
18376 Gnus allows combining a mixture of all the other group types into bigger
18380 * Virtual Groups:: Combining articles from many groups.
18381 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
18385 @node Virtual Groups
18386 @subsection Virtual Groups
18388 @cindex virtual groups
18389 @cindex merging groups
18391 An @dfn{nnvirtual group} is really nothing more than a collection of
18394 For instance, if you are tired of reading many small groups, you can
18395 put them all in one big group, and then grow tired of reading one
18396 big, unwieldy group. The joys of computing!
18398 You specify @code{nnvirtual} as the method. The address should be a
18399 regexp to match component groups.
18401 All marks in the virtual group will stick to the articles in the
18402 component groups. So if you tick an article in a virtual group, the
18403 article will also be ticked in the component group from whence it
18404 came. (And vice versa---marks from the component groups will also be
18405 shown in the virtual group.). To create an empty virtual group, run
18406 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
18407 and edit the method regexp with @kbd{M-e}
18408 (@code{gnus-group-edit-group-method})
18410 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
18411 newsgroups into one, big, happy newsgroup:
18414 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
18417 The component groups can be native or foreign; everything should work
18418 smoothly, but if your computer explodes, it was probably my fault.
18420 Collecting the same group from several servers might actually be a good
18421 idea if users have set the Distribution header to limit distribution.
18422 If you would like to read @samp{soc.motss} both from a server in Japan
18423 and a server in Norway, you could use the following as the group regexp:
18426 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
18429 (Remember, though, that if you're creating the group with @kbd{G m}, you
18430 shouldn't double the backslashes, and you should leave off the quote
18431 characters at the beginning and the end of the string.)
18433 This should work kinda smoothly---all articles from both groups should
18434 end up in this one, and there should be no duplicates. Threading (and
18435 the rest) will still work as usual, but there might be problems with the
18436 sequence of articles. Sorting on date might be an option here
18437 (@pxref{Selecting a Group}).
18439 One limitation, however---all groups included in a virtual
18440 group have to be alive (i.e., subscribed or unsubscribed). Killed or
18441 zombie groups can't be component groups for @code{nnvirtual} groups.
18443 @vindex nnvirtual-always-rescan
18444 If the @code{nnvirtual-always-rescan} variable is non-@code{nil} (which
18445 is the default), @code{nnvirtual} will always scan groups for unread
18446 articles when entering a virtual group. If this variable is @code{nil}
18447 and you read articles in a component group after the virtual group has
18448 been activated, the read articles from the component group will show up
18449 when you enter the virtual group. You'll also see this effect if you
18450 have two virtual groups that have a component group in common. If
18451 that's the case, you should set this variable to @code{t}. Or you can
18452 just tap @code{M-g} on the virtual group every time before you enter
18453 it---it'll have much the same effect.
18455 @code{nnvirtual} can have both mail and news groups as component groups.
18456 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
18457 has to ask the back end of the component group the article comes from
18458 whether it is a news or mail back end. However, when you do a @kbd{^},
18459 there is typically no sure way for the component back end to know this,
18460 and in that case @code{nnvirtual} tells Gnus that the article came from a
18461 not-news back end. (Just to be on the safe side.)
18463 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
18464 line from the article you respond to in these cases.
18466 @code{nnvirtual} groups do not inherit anything but articles and marks
18467 from component groups---group parameters, for instance, are not
18471 @node Kibozed Groups
18472 @subsection Kibozed Groups
18476 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
18477 (parts of) the news feed''. @code{nnkiboze} is a back end that will
18478 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
18479 down to a halt with useless requests! Oh happiness!
18481 @kindex G k (Group)
18482 To create a kibozed group, use the @kbd{G k} command in the group
18485 The address field of the @code{nnkiboze} method is, as with
18486 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
18487 @code{nnkiboze} group. That's where most similarities between
18488 @code{nnkiboze} and @code{nnvirtual} end.
18490 In addition to this regexp detailing component groups, an
18491 @code{nnkiboze} group must have a score file to say what articles are
18492 to be included in the group (@pxref{Scoring}).
18494 @kindex M-x nnkiboze-generate-groups
18495 @findex nnkiboze-generate-groups
18496 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
18497 @code{nnkiboze} groups you want to have. This command will take time.
18498 Lots of time. Oodles and oodles of time. Gnus has to fetch the
18499 headers from all the articles in all the component groups and run them
18500 through the scoring process to determine if there are any articles in
18501 the groups that are to be part of the @code{nnkiboze} groups.
18503 Please limit the number of component groups by using restrictive
18504 regexps. Otherwise your sysadmin may become annoyed with you, and the
18505 @acronym{NNTP} site may throw you off and never let you back in again.
18506 Stranger things have happened.
18508 @code{nnkiboze} component groups do not have to be alive---they can be dead,
18509 and they can be foreign. No restrictions.
18511 @vindex nnkiboze-directory
18512 The generation of an @code{nnkiboze} group means writing two files in
18513 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
18514 One contains the @acronym{NOV} header lines for all the articles in
18515 the group, and the other is an additional @file{.newsrc} file to store
18516 information on what groups have been searched through to find
18517 component articles.
18519 Articles marked as read in the @code{nnkiboze} group will have
18520 their @acronym{NOV} lines removed from the @acronym{NOV} file.
18523 @node Email Based Diary
18524 @section Email Based Diary
18526 @cindex email based diary
18529 This section describes a special mail back end called @code{nndiary},
18530 and its companion library @code{gnus-diary}. It is ``special'' in the
18531 sense that it is not meant to be one of the standard alternatives for
18532 reading mail with Gnus. See @ref{Choosing a Mail Back End} for that.
18533 Instead, it is used to treat @emph{some} of your mails in a special way,
18534 namely, as event reminders.
18536 Here is a typical scenario:
18540 You've got a date with Andy Mc Dowell or Bruce Willis (select according
18541 to your sexual preference) in one month. You don't want to forget it.
18543 So you send a ``reminder'' message (actually, a diary one) to yourself.
18545 You forget all about it and keep on getting and reading new mail, as usual.
18547 From time to time, as you type `g' in the group buffer and as the date
18548 is getting closer, the message will pop up again to remind you of your
18549 appointment, just as if it were new and unread.
18551 Read your ``new'' messages, this one included, and start dreaming again
18552 of the night you're gonna have.
18554 Once the date is over (you actually fell asleep just after dinner), the
18555 message will be automatically deleted if it is marked as expirable.
18558 The Gnus Diary back end has the ability to handle regular appointments
18559 (that wouldn't ever be deleted) as well as punctual ones, operates as a
18560 real mail back end and is configurable in many ways. All of this is
18561 explained in the sections below.
18564 * The NNDiary Back End:: Basic setup and usage.
18565 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
18566 * Sending or Not Sending:: A final note on sending diary messages.
18570 @node The NNDiary Back End
18571 @subsection The NNDiary Back End
18573 @cindex the nndiary back end
18575 @code{nndiary} is a back end very similar to @code{nnml} (@pxref{Mail
18576 Spool}). Actually, it could appear as a mix of @code{nnml} and
18577 @code{nndraft}. If you know @code{nnml}, you're already familiar with
18578 the message storing scheme of @code{nndiary}: one file per message, one
18579 directory per group.
18581 Before anything, there is one requirement to be able to run
18582 @code{nndiary} properly: you @emph{must} use the group timestamp feature
18583 of Gnus. This adds a timestamp to each group's parameters. @ref{Group
18584 Timestamp} to see how it's done.
18587 * Diary Messages:: What makes a message valid for nndiary.
18588 * Running NNDiary:: NNDiary has two modes of operation.
18589 * Customizing NNDiary:: Bells and whistles.
18592 @node Diary Messages
18593 @subsubsection Diary Messages
18594 @cindex nndiary messages
18595 @cindex nndiary mails
18597 @code{nndiary} messages are just normal ones, except for the mandatory
18598 presence of 7 special headers. These headers are of the form
18599 @code{X-Diary-<something>}, @code{<something>} being one of
18600 @code{Minute}, @code{Hour}, @code{Dom}, @code{Month}, @code{Year},
18601 @code{Time-Zone} and @code{Dow}. @code{Dom} means ``Day of Month'', and
18602 @code{dow} means ``Day of Week''. These headers actually behave like
18603 crontab specifications and define the event date(s):
18607 For all headers except the @code{Time-Zone} one, a header value is
18608 either a star (meaning all possible values), or a list of fields
18609 (separated by a comma).
18611 A field is either an integer, or a range.
18613 A range is two integers separated by a dash.
18615 Possible integer values are 0--59 for @code{Minute}, 0--23 for
18616 @code{Hour}, 1--31 for @code{Dom}, 1--12 for @code{Month}, above 1971
18617 for @code{Year} and 0--6 for @code{Dow} (0 meaning Sunday).
18619 As a special case, a star in either @code{Dom} or @code{Dow} doesn't
18620 mean ``all possible values'', but ``use only the other field''. Note
18621 that if both are star'ed, the use of either one gives the same result.
18623 The @code{Time-Zone} header is special in that it can only have one
18624 value (@code{GMT}, for instance). A star doesn't mean ``all possible
18625 values'' (because it makes no sense), but ``the current local time
18626 zone''. Most of the time, you'll be using a star here. However, for a
18627 list of available time zone values, see the variable
18628 @code{nndiary-headers}.
18631 As a concrete example, here are the diary headers to add to your message
18632 for specifying ``Each Monday and each 1st of month, at 12:00, 20:00,
18633 21:00, 22:00, 23:00 and 24:00, from 1999 to 2010'' (I'll let you find
18638 X-Diary-Hour: 12, 20-24
18641 X-Diary-Year: 1999-2010
18643 X-Diary-Time-Zone: *
18646 @node Running NNDiary
18647 @subsubsection Running NNDiary
18648 @cindex running nndiary
18649 @cindex nndiary operation modes
18651 @code{nndiary} has two modes of operation: ``traditional'' (the default)
18652 and ``autonomous''. In traditional mode, @code{nndiary} does not get new
18653 mail by itself. You have to move (@kbd{B m}) or copy (@kbd{B c}) mails
18654 from your primary mail back end to nndiary groups in order to handle them
18655 as diary messages. In autonomous mode, @code{nndiary} retrieves its own
18656 mail and handles it independently from your primary mail back end.
18658 One should note that Gnus is not inherently designed to allow several
18659 ``master'' mail back ends at the same time. However, this does make
18660 sense with @code{nndiary}: you really want to send and receive diary
18661 messages to your diary groups directly. So, @code{nndiary} supports
18662 being sort of a ``second primary mail back end'' (to my knowledge, it is
18663 the only back end offering this feature). However, there is a limitation
18664 (which I hope to fix some day): respooling doesn't work in autonomous
18667 In order to use @code{nndiary} in autonomous mode, you have several
18672 Allow @code{nndiary} to retrieve new mail by itself. Put the following
18673 line in your @file{~/.gnus.el} file:
18676 (setq nndiary-get-new-mail t)
18679 You must arrange for diary messages (those containing @code{X-Diary-*}
18680 headers) to be split in a private folder @emph{before} Gnus treat them.
18681 Again, this is needed because Gnus cannot (yet ?) properly handle
18682 multiple primary mail back ends. Getting those messages from a separate
18683 source will compensate this misfeature to some extent.
18685 As an example, here's my procmailrc entry to store diary files in
18686 @file{~/.nndiary} (the default @code{nndiary} mail source file):
18695 Once this is done, you might want to customize the following two options
18696 that affect the diary mail retrieval and splitting processes:
18698 @defvar nndiary-mail-sources
18699 This is the diary-specific replacement for the standard
18700 @code{mail-sources} variable. It obeys the same syntax, and defaults to
18701 @code{(file :path "~/.nndiary")}.
18704 @defvar nndiary-split-methods
18705 This is the diary-specific replacement for the standard
18706 @code{nnmail-split-methods} variable. It obeys the same syntax.
18709 Finally, you may add a permanent @code{nndiary} virtual server
18710 (something like @code{(nndiary "diary")} should do) to your
18711 @code{gnus-secondary-select-methods}.
18713 Hopefully, almost everything (see the TODO section in
18714 @file{nndiary.el}) will work as expected when you restart Gnus: in
18715 autonomous mode, typing @kbd{g} and @kbd{M-g} in the group buffer, will
18716 also get your new diary mails and split them according to your
18717 diary-specific rules, @kbd{F} will find your new diary groups etc.
18719 @node Customizing NNDiary
18720 @subsubsection Customizing NNDiary
18721 @cindex customizing nndiary
18722 @cindex nndiary customization
18724 Now that @code{nndiary} is up and running, it's time to customize it.
18725 The custom group is called @code{nndiary} (no, really ?!). You should
18726 browse it to figure out which options you'd like to tweak. The following
18727 two variables are probably the only ones you will want to change:
18729 @defvar nndiary-reminders
18730 This is the list of times when you want to be reminded of your
18731 appointments (e.g. 3 weeks before, then 2 days before, then 1 hour
18732 before and that's it). Remember that ``being reminded'' means that the
18733 diary message will pop up as brand new and unread again when you get new
18737 @defvar nndiary-week-starts-on-monday
18738 Rather self-explanatory. Otherwise, Sunday is assumed (this is the
18743 @node The Gnus Diary Library
18744 @subsection The Gnus Diary Library
18746 @cindex the gnus diary library
18748 Using @code{nndiary} manually (I mean, writing the headers by hand and
18749 so on) would be rather boring. Fortunately, there is a library called
18750 @code{gnus-diary} written on top of @code{nndiary}, that does many
18751 useful things for you.
18753 In order to use it, add the following line to your @file{~/.gnus.el} file:
18756 (require 'gnus-diary)
18759 Also, you shouldn't use any @code{gnus-user-format-function-[d|D]}
18760 (@pxref{Summary Buffer Lines}). @code{gnus-diary} provides both of these
18761 (sorry if you used them before).
18765 * Diary Summary Line Format:: A nicer summary buffer line format.
18766 * Diary Articles Sorting:: A nicer way to sort messages.
18767 * Diary Headers Generation:: Not doing it manually.
18768 * Diary Group Parameters:: Not handling them manually.
18771 @node Diary Summary Line Format
18772 @subsubsection Diary Summary Line Format
18773 @cindex diary summary buffer line
18774 @cindex diary summary line format
18776 Displaying diary messages in standard summary line format (usually
18777 something like @samp{From Joe: Subject}) is pretty useless. Most of
18778 the time, you're the one who wrote the message, and you mostly want to
18779 see the event's date.
18781 @code{gnus-diary} provides two supplemental user formats to be used in
18782 summary line formats. @code{D} corresponds to a formatted time string
18783 for the next occurrence of the event (e.g. ``Sat, Sep 22 01, 12:00''),
18784 while @code{d} corresponds to an approximative remaining time until the
18785 next occurrence of the event (e.g. ``in 6 months, 1 week'').
18787 For example, here's how Joe's birthday is displayed in my
18788 @code{nndiary+diary:birthdays} summary buffer (note that the message is
18789 expirable, but will never be deleted, as it specifies a periodic event):
18792 E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week)
18795 In order to get something like the above, you would normally add the
18796 following line to your diary groups'parameters:
18799 (gnus-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n")
18802 However, @code{gnus-diary} does it automatically (@pxref{Diary Group
18803 Parameters}). You can however customize the provided summary line format
18804 with the following user options:
18806 @defvar gnus-diary-summary-line-format
18807 Defines the summary line format used for diary groups (@pxref{Summary
18808 Buffer Lines}). @code{gnus-diary} uses it to automatically update the
18809 diary groups'parameters.
18812 @defvar gnus-diary-time-format
18813 Defines the format to display dates in diary summary buffers. This is
18814 used by the @code{D} user format. See the docstring for details.
18817 @defvar gnus-diary-delay-format-function
18818 Defines the format function to use for displaying delays (remaining
18819 times) in diary summary buffers. This is used by the @code{d} user
18820 format. There are currently built-in functions for English and French;
18821 you can also define your own. See the docstring for details.
18824 @node Diary Articles Sorting
18825 @subsubsection Diary Articles Sorting
18826 @cindex diary articles sorting
18827 @cindex diary summary lines sorting
18828 @findex gnus-summary-sort-by-schedule
18829 @findex gnus-thread-sort-by-schedule
18830 @findex gnus-article-sort-by-schedule
18832 @code{gnus-diary} provides new sorting functions (@pxref{Sorting the
18833 Summary Buffer} ) called @code{gnus-summary-sort-by-schedule},
18834 @code{gnus-thread-sort-by-schedule} and
18835 @code{gnus-article-sort-by-schedule}. These functions let you organize
18836 your diary summary buffers from the closest event to the farthest one.
18838 @code{gnus-diary} automatically installs
18839 @code{gnus-summary-sort-by-schedule} as a menu item in the summary
18840 buffer's ``sort'' menu, and the two others as the primary (hence
18841 default) sorting functions in the group parameters (@pxref{Diary Group
18844 @node Diary Headers Generation
18845 @subsubsection Diary Headers Generation
18846 @cindex diary headers generation
18847 @findex gnus-diary-check-message
18849 @code{gnus-diary} provides a function called
18850 @code{gnus-diary-check-message} to help you handle the @code{X-Diary-*}
18851 headers. This function ensures that the current message contains all the
18852 required diary headers, and prompts you for values or corrections if
18855 This function is hooked into the @code{nndiary} back end, so that
18856 moving or copying an article to a diary group will trigger it
18857 automatically. It is also bound to @kbd{C-c D c} in @code{message-mode}
18858 and @code{article-edit-mode} in order to ease the process of converting
18859 a usual mail to a diary one.
18861 This function takes a prefix argument which will force prompting of
18862 all diary headers, regardless of their presence or validity. That way,
18863 you can very easily reschedule an already valid diary message, for
18866 @node Diary Group Parameters
18867 @subsubsection Diary Group Parameters
18868 @cindex diary group parameters
18870 When you create a new diary group, or visit one, @code{gnus-diary}
18871 automatically checks your group parameters and if needed, sets the
18872 summary line format to the diary-specific value, installs the
18873 diary-specific sorting functions, and also adds the different
18874 @code{X-Diary-*} headers to the group's posting-style. It is then easier
18875 to send a diary message, because if you use @kbd{C-u a} or @kbd{C-u m}
18876 on a diary group to prepare a message, these headers will be inserted
18877 automatically (although not filled with proper values yet).
18879 @node Sending or Not Sending
18880 @subsection Sending or Not Sending
18882 Well, assuming you've read all of the above, here are two final notes on
18883 mail sending with @code{nndiary}:
18887 @code{nndiary} is a @emph{real} mail back end. You really send real diary
18888 messsages for real. This means for instance that you can give
18889 appointments to anybody (provided they use Gnus and @code{nndiary}) by
18890 sending the diary message to them as well.
18892 However, since @code{nndiary} also has a @code{request-post} method, you
18893 can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the
18894 message won't actually be sent; just stored locally in the group. This
18895 comes in very handy for private appointments.
18898 @node Gnus Unplugged
18899 @section Gnus Unplugged
18904 @cindex Gnus unplugged
18906 In olden times (ca. February '88), people used to run their newsreaders
18907 on big machines with permanent connections to the net. News transport
18908 was dealt with by news servers, and all the newsreaders had to do was to
18909 read news. Believe it or not.
18911 Nowadays most people read news and mail at home, and use some sort of
18912 modem to connect to the net. To avoid running up huge phone bills, it
18913 would be nice to have a way to slurp down all the news and mail, hang up
18914 the phone, read for several hours, and then upload any responses you
18915 have to make. And then you repeat the procedure.
18917 Of course, you can use news servers for doing this as well. I've used
18918 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
18919 for some years, but doing that's a bore. Moving the news server
18920 functionality up to the newsreader makes sense if you're the only person
18921 reading news on a machine.
18923 Setting up Gnus as an ``offline'' newsreader is quite simple. In
18924 fact, you don't have to configure anything as the agent is now enabled
18925 by default (@pxref{Agent Variables, gnus-agent}).
18927 Of course, to use it as such, you have to learn a few new commands.
18930 * Agent Basics:: How it all is supposed to work.
18931 * Agent Categories:: How to tell the Gnus Agent what to download.
18932 * Agent Commands:: New commands for all the buffers.
18933 * Agent Visuals:: Ways that the agent may effect your summary buffer.
18934 * Agent as Cache:: The Agent is a big cache too.
18935 * Agent Expiry:: How to make old articles go away.
18936 * Agent Regeneration:: How to recover from lost connections and other accidents.
18937 * Agent and flags:: How the Agent maintains flags.
18938 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
18939 * Outgoing Messages:: What happens when you post/mail something?
18940 * Agent Variables:: Customizing is fun.
18941 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
18942 * Batching Agents:: How to fetch news from a @code{cron} job.
18943 * Agent Caveats:: What you think it'll do and what it does.
18948 @subsection Agent Basics
18950 First, let's get some terminology out of the way.
18952 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
18953 connection to the net (and notified the Agent that this is the case).
18954 When the connection to the net is up again (and Gnus knows this), the
18955 Agent is @dfn{plugged}.
18957 The @dfn{local} machine is the one you're running on, and which isn't
18958 connected to the net continuously.
18960 @dfn{Downloading} means fetching things from the net to your local
18961 machine. @dfn{Uploading} is doing the opposite.
18963 You know that Gnus gives you all the opportunity you'd ever want for
18964 shooting yourself in the foot. Some people call it flexibility. Gnus
18965 is also customizable to a great extent, which means that the user has a
18966 say on how Gnus behaves. Other newsreaders might unconditionally shoot
18967 you in your foot, but with Gnus, you have a choice!
18969 Gnus is never really in plugged or unplugged state. Rather, it applies
18970 that state to each server individually. This means that some servers
18971 can be plugged while others can be unplugged. Additionally, some
18972 servers can be ignored by the Agent altogether (which means that
18973 they're kinda like plugged always).
18975 So when you unplug the Agent and then wonder why is Gnus opening a
18976 connection to the Net, the next step to do is to look whether all
18977 servers are agentized. If there is an unagentized server, you found
18980 Another thing is the @dfn{offline} state. Sometimes, servers aren't
18981 reachable. When Gnus notices this, it asks you whether you want the
18982 server to be switched to offline state. If you say yes, then the
18983 server will behave somewhat as if it was unplugged, except that Gnus
18984 will ask you whether you want to switch it back online again.
18986 Let's take a typical Gnus session using the Agent.
18991 @findex gnus-unplugged
18992 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
18993 Agent in a disconnected state. You can read all the news that you have
18994 already fetched while in this mode.
18997 You then decide to see whether any new news has arrived. You connect
18998 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
18999 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
19000 as usual. To check for new mail in unplugged mode (@pxref{Mail
19001 Source Specifiers}).
19004 You can then read the new news immediately, or you can download the
19005 news onto your local machine. If you want to do the latter, you press
19006 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
19007 all the eligible articles in all the groups. (To let Gnus know which
19008 articles you want to download, @pxref{Agent Categories}).
19011 After fetching the articles, you press @kbd{J j} to make Gnus become
19012 unplugged again, and you shut down the PPP thing (or whatever). And
19013 then you read the news offline.
19016 And then you go to step 2.
19019 Here are some things you should do the first time (or so) that you use
19025 Decide which servers should be covered by the Agent. If you have a mail
19026 back end, it would probably be nonsensical to have it covered by the
19027 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
19028 @kbd{J a} on the server (or servers) that you wish to have covered by the
19029 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
19030 added servers you do not wish to have covered by the Agent. By default,
19031 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
19032 @code{gnus-secondary-select-methods} are agentized.
19035 Decide on download policy. It's fairly simple once you decide whether
19036 you are going to use agent categories, topic parameters, and/or group
19037 parameters to implement your policy. If you're new to gnus, it
19038 is probably best to start with a category, @xref{Agent Categories}.
19040 Both topic parameters (@pxref{Topic Parameters}) and agent categories
19041 (@pxref{Agent Categories}) provide for setting a policy that applies
19042 to multiple groups. Which you use is entirely up to you. Topic
19043 parameters do override categories so, if you mix the two, you'll have
19044 to take that into account. If you have a few groups that deviate from
19045 your policy, you can use group parameters (@pxref{Group Parameters}) to
19049 Uhm@dots{} that's it.
19053 @node Agent Categories
19054 @subsection Agent Categories
19056 One of the main reasons to integrate the news transport layer into the
19057 newsreader is to allow greater control over what articles to download.
19058 There's not much point in downloading huge amounts of articles, just to
19059 find out that you're not interested in reading any of them. It's better
19060 to be somewhat more conservative in choosing what to download, and then
19061 mark the articles for downloading manually if it should turn out that
19062 you're interested in the articles anyway.
19064 One of the more effective methods for controlling what is to be
19065 downloaded is to create a @dfn{category} and then assign some (or all)
19066 groups to this category. Groups that do not belong in any other
19067 category belong to the @code{default} category. Gnus has its own
19068 buffer for creating and managing categories.
19070 If you prefer, you can also use group parameters (@pxref{Group
19071 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
19072 alternative approach to controlling the agent. The only real
19073 difference is that categories are specific to the agent (so there is
19074 less to learn) while group and topic parameters include the kitchen
19077 Since you can set agent parameters in several different places we have
19078 a rule to decide which source to believe. This rule specifies that
19079 the parameter sources are checked in the following order: group
19080 parameters, topic parameters, agent category, and finally customizable
19081 variables. So you can mix all of these sources to produce a wide range
19082 of behavior, just don't blame me if you don't remember where you put
19086 * Category Syntax:: What a category looks like.
19087 * Category Buffer:: A buffer for maintaining categories.
19088 * Category Variables:: Customize'r'Us.
19092 @node Category Syntax
19093 @subsubsection Category Syntax
19095 A category consists of a name, the list of groups belonging to the
19096 category, and a number of optional parameters that override the
19097 customizable variables. The complete list of agent parameters are
19100 @cindex Agent Parameters
19103 The list of groups that are in this category.
19105 @item agent-predicate
19106 A predicate which (generally) gives a rough outline of which articles
19107 are eligible for downloading; and
19110 a score rule which (generally) gives you a finer granularity when
19111 deciding what articles to download. (Note that this @dfn{download
19112 score} is not necessarily related to normal scores.)
19114 @item agent-enable-expiration
19115 a boolean indicating whether the agent should expire old articles in
19116 this group. Most groups should be expired to conserve disk space. In
19117 fact, its probably safe to say that the gnus.* hierarchy contains the
19118 only groups that should not be expired.
19120 @item agent-days-until-old
19121 an integer indicating the number of days that the agent should wait
19122 before deciding that a read article is safe to expire.
19124 @item agent-low-score
19125 an integer that overrides the value of @code{gnus-agent-low-score}.
19127 @item agent-high-score
19128 an integer that overrides the value of @code{gnus-agent-high-score}.
19130 @item agent-short-article
19131 an integer that overrides the value of
19132 @code{gnus-agent-short-article}.
19134 @item agent-long-article
19135 an integer that overrides the value of @code{gnus-agent-long-article}.
19137 @item agent-enable-undownloaded-faces
19138 a symbol indicating whether the summary buffer should display
19139 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
19140 faces. Any symbol other than @code{nil} will enable the use of
19141 undownloaded faces.
19144 The name of a category can not be changed once the category has been
19147 Each category maintains a list of groups that are exclusive members of
19148 that category. The exclusivity rule is automatically enforced, add a
19149 group to a new category and it is automatically removed from its old
19152 A predicate in its simplest form can be a single predicate such as
19153 @code{true} or @code{false}. These two will download every available
19154 article or nothing respectively. In the case of these two special
19155 predicates an additional score rule is superfluous.
19157 Predicates of @code{high} or @code{low} download articles in respect of
19158 their scores in relationship to @code{gnus-agent-high-score} and
19159 @code{gnus-agent-low-score} as described below.
19161 To gain even finer control of what is to be regarded eligible for
19162 download a predicate can consist of a number of predicates with logical
19163 operators sprinkled in between.
19165 Perhaps some examples are in order.
19167 Here's a simple predicate. (It's the default predicate, in fact, used
19168 for all groups that don't belong to any other category.)
19174 Quite simple, eh? This predicate is true if and only if the article is
19175 short (for some value of ``short'').
19177 Here's a more complex predicate:
19186 This means that an article should be downloaded if it has a high score,
19187 or if the score is not low and the article is not long. You get the
19190 The available logical operators are @code{or}, @code{and} and
19191 @code{not}. (If you prefer, you can use the more ``C''-ish operators
19192 @samp{|}, @code{&} and @code{!} instead.)
19194 The following predicates are pre-defined, but if none of these fit what
19195 you want to do, you can write your own.
19197 When evaluating each of these predicates, the named constant will be
19198 bound to the value determined by calling
19199 @code{gnus-agent-find-parameter} on the appropriate parameter. For
19200 example, gnus-agent-short-article will be bound to
19201 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
19202 means that you can specify a predicate in your category then tune that
19203 predicate to individual groups.
19207 True if the article is shorter than @code{gnus-agent-short-article}
19208 lines; default 100.
19211 True if the article is longer than @code{gnus-agent-long-article}
19212 lines; default 200.
19215 True if the article has a download score less than
19216 @code{gnus-agent-low-score}; default 0.
19219 True if the article has a download score greater than
19220 @code{gnus-agent-high-score}; default 0.
19223 True if the Gnus Agent guesses that the article is spam. The
19224 heuristics may change over time, but at present it just computes a
19225 checksum and sees whether articles match.
19234 If you want to create your own predicate function, here's what you have
19235 to know: The functions are called with no parameters, but the
19236 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
19239 For example, you could decide that you don't want to download articles
19240 that were posted more than a certain number of days ago (e.g. posted
19241 more than @code{gnus-agent-expire-days} ago) you might write a function
19242 something along the lines of the following:
19245 (defun my-article-old-p ()
19246 "Say whether an article is old."
19247 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
19248 (- (time-to-days (current-time)) gnus-agent-expire-days)))
19251 with the predicate then defined as:
19254 (not my-article-old-p)
19257 or you could append your predicate to the predefined
19258 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
19262 (require 'gnus-agent)
19263 (setq gnus-category-predicate-alist
19264 (append gnus-category-predicate-alist
19265 '((old . my-article-old-p))))
19268 and simply specify your predicate as:
19274 If/when using something like the above, be aware that there are many
19275 misconfigured systems/mailers out there and so an article's date is not
19276 always a reliable indication of when it was posted. Hell, some people
19277 just don't give a damn.
19279 The above predicates apply to @emph{all} the groups which belong to the
19280 category. However, if you wish to have a specific predicate for an
19281 individual group within a category, or you're just too lazy to set up a
19282 new category, you can enter a group's individual predicate in its group
19283 parameters like so:
19286 (agent-predicate . short)
19289 This is the group/topic parameter equivalent of the agent category default.
19290 Note that when specifying a single word predicate like this, the
19291 @code{agent-predicate} specification must be in dotted pair notation.
19293 The equivalent of the longer example from above would be:
19296 (agent-predicate or high (and (not low) (not long)))
19299 The outer parenthesis required in the category specification are not
19300 entered here as, not being in dotted pair notation, the value of the
19301 predicate is assumed to be a list.
19304 Now, the syntax of the download score is the same as the syntax of
19305 normal score files, except that all elements that require actually
19306 seeing the article itself are verboten. This means that only the
19307 following headers can be scored on: @code{Subject}, @code{From},
19308 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
19309 @code{Lines}, and @code{Xref}.
19311 As with predicates, the specification of the @code{download score rule}
19312 to use in respect of a group can be in either the category definition if
19313 it's to be applicable to all groups in therein, or a group's parameters
19314 if it's to be specific to that group.
19316 In both of these places the @code{download score rule} can take one of
19323 This has the same syntax as a normal Gnus score file except only a
19324 subset of scoring keywords are available as mentioned above.
19330 Category specification
19334 ("Lars Ingebrigtsen" 1000000 nil s))
19340 Group/Topic Parameter specification
19343 (agent-score ("from"
19344 ("Lars Ingebrigtsen" 1000000 nil s))
19349 Again, note the omission of the outermost parenthesis here.
19355 These score files must @emph{only} contain the permitted scoring
19356 keywords stated above.
19362 Category specification
19365 ("~/News/agent.SCORE")
19371 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
19375 Group Parameter specification
19378 (agent-score "~/News/agent.SCORE")
19381 Additional score files can be specified as above. Need I say anything
19386 Use @code{normal} score files
19388 If you don't want to maintain two sets of scoring rules for a group, and
19389 your desired @code{downloading} criteria for a group are the same as your
19390 @code{reading} criteria then you can tell the agent to refer to your
19391 @code{normal} score files when deciding what to download.
19393 These directives in either the category definition or a group's
19394 parameters will cause the agent to read in all the applicable score
19395 files for a group, @emph{filtering out} those sections that do not
19396 relate to one of the permitted subset of scoring keywords.
19400 Category Specification
19407 Group Parameter specification
19410 (agent-score . file)
19415 @node Category Buffer
19416 @subsubsection Category Buffer
19418 You'd normally do all category maintenance from the category buffer.
19419 When you enter it for the first time (with the @kbd{J c} command from
19420 the group buffer), you'll only see the @code{default} category.
19422 The following commands are available in this buffer:
19426 @kindex q (Category)
19427 @findex gnus-category-exit
19428 Return to the group buffer (@code{gnus-category-exit}).
19431 @kindex e (Category)
19432 @findex gnus-category-customize-category
19433 Use a customization buffer to set all of the selected category's
19434 parameters at one time (@code{gnus-category-customize-category}).
19437 @kindex k (Category)
19438 @findex gnus-category-kill
19439 Kill the current category (@code{gnus-category-kill}).
19442 @kindex c (Category)
19443 @findex gnus-category-copy
19444 Copy the current category (@code{gnus-category-copy}).
19447 @kindex a (Category)
19448 @findex gnus-category-add
19449 Add a new category (@code{gnus-category-add}).
19452 @kindex p (Category)
19453 @findex gnus-category-edit-predicate
19454 Edit the predicate of the current category
19455 (@code{gnus-category-edit-predicate}).
19458 @kindex g (Category)
19459 @findex gnus-category-edit-groups
19460 Edit the list of groups belonging to the current category
19461 (@code{gnus-category-edit-groups}).
19464 @kindex s (Category)
19465 @findex gnus-category-edit-score
19466 Edit the download score rule of the current category
19467 (@code{gnus-category-edit-score}).
19470 @kindex l (Category)
19471 @findex gnus-category-list
19472 List all the categories (@code{gnus-category-list}).
19476 @node Category Variables
19477 @subsubsection Category Variables
19480 @item gnus-category-mode-hook
19481 @vindex gnus-category-mode-hook
19482 Hook run in category buffers.
19484 @item gnus-category-line-format
19485 @vindex gnus-category-line-format
19486 Format of the lines in the category buffer (@pxref{Formatting
19487 Variables}). Valid elements are:
19491 The name of the category.
19494 The number of groups in the category.
19497 @item gnus-category-mode-line-format
19498 @vindex gnus-category-mode-line-format
19499 Format of the category mode line (@pxref{Mode Line Formatting}).
19501 @item gnus-agent-short-article
19502 @vindex gnus-agent-short-article
19503 Articles that have fewer lines than this are short. Default 100.
19505 @item gnus-agent-long-article
19506 @vindex gnus-agent-long-article
19507 Articles that have more lines than this are long. Default 200.
19509 @item gnus-agent-low-score
19510 @vindex gnus-agent-low-score
19511 Articles that have a score lower than this have a low score. Default
19514 @item gnus-agent-high-score
19515 @vindex gnus-agent-high-score
19516 Articles that have a score higher than this have a high score. Default
19519 @item gnus-agent-expire-days
19520 @vindex gnus-agent-expire-days
19521 The number of days that a @samp{read} article must stay in the agent's
19522 local disk before becoming eligible for expiration (While the name is
19523 the same, this doesn't mean expiring the article on the server. It
19524 just means deleting the local copy of the article). What is also
19525 important to understand is that the counter starts with the time the
19526 article was written to the local disk and not the time the article was
19530 @item gnus-agent-enable-expiration
19531 @vindex gnus-agent-enable-expiration
19532 Determines whether articles in a group are, by default, expired or
19533 retained indefinitely. The default is @code{ENABLE} which means that
19534 you'll have to disable expiration when desired. On the other hand,
19535 you could set this to @code{DISABLE}. In that case, you would then
19536 have to enable expiration in selected groups.
19541 @node Agent Commands
19542 @subsection Agent Commands
19543 @findex gnus-agent-toggle-plugged
19544 @kindex J j (Agent)
19546 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
19547 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
19548 toggles the plugged/unplugged state of the Gnus Agent.
19552 * Group Agent Commands:: Configure groups and fetch their contents.
19553 * Summary Agent Commands:: Manually select then fetch specific articles.
19554 * Server Agent Commands:: Select the servers that are supported by the agent.
19560 @node Group Agent Commands
19561 @subsubsection Group Agent Commands
19565 @kindex J u (Agent Group)
19566 @findex gnus-agent-fetch-groups
19567 Fetch all eligible articles in the current group
19568 (@code{gnus-agent-fetch-groups}).
19571 @kindex J c (Agent Group)
19572 @findex gnus-enter-category-buffer
19573 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
19576 @kindex J s (Agent Group)
19577 @findex gnus-agent-fetch-session
19578 Fetch all eligible articles in all groups
19579 (@code{gnus-agent-fetch-session}).
19582 @kindex J S (Agent Group)
19583 @findex gnus-group-send-queue
19584 Send all sendable messages in the queue group
19585 (@code{gnus-group-send-queue}). @xref{Drafts}.
19588 @kindex J a (Agent Group)
19589 @findex gnus-agent-add-group
19590 Add the current group to an Agent category
19591 (@code{gnus-agent-add-group}). This command understands the
19592 process/prefix convention (@pxref{Process/Prefix}).
19595 @kindex J r (Agent Group)
19596 @findex gnus-agent-remove-group
19597 Remove the current group from its category, if any
19598 (@code{gnus-agent-remove-group}). This command understands the
19599 process/prefix convention (@pxref{Process/Prefix}).
19602 @kindex J Y (Agent Group)
19603 @findex gnus-agent-synchronize-flags
19604 Synchronize flags changed while unplugged with remote server, if any.
19610 @node Summary Agent Commands
19611 @subsubsection Summary Agent Commands
19615 @kindex J # (Agent Summary)
19616 @findex gnus-agent-mark-article
19617 Mark the article for downloading (@code{gnus-agent-mark-article}).
19620 @kindex J M-# (Agent Summary)
19621 @findex gnus-agent-unmark-article
19622 Remove the downloading mark from the article
19623 (@code{gnus-agent-unmark-article}).
19627 @kindex @@ (Agent Summary)
19628 @findex gnus-agent-toggle-mark
19629 Toggle whether to download the article
19630 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
19634 @kindex J c (Agent Summary)
19635 @findex gnus-agent-catchup
19636 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
19639 @kindex J S (Agent Summary)
19640 @findex gnus-agent-fetch-group
19641 Download all eligible (@pxref{Agent Categories}) articles in this group.
19642 (@code{gnus-agent-fetch-group}).
19645 @kindex J s (Agent Summary)
19646 @findex gnus-agent-summary-fetch-series
19647 Download all processable articles in this group.
19648 (@code{gnus-agent-summary-fetch-series}).
19651 @kindex J u (Agent Summary)
19652 @findex gnus-agent-summary-fetch-group
19653 Download all downloadable articles in the current group
19654 (@code{gnus-agent-summary-fetch-group}).
19659 @node Server Agent Commands
19660 @subsubsection Server Agent Commands
19664 @kindex J a (Agent Server)
19665 @findex gnus-agent-add-server
19666 Add the current server to the list of servers covered by the Gnus Agent
19667 (@code{gnus-agent-add-server}).
19670 @kindex J r (Agent Server)
19671 @findex gnus-agent-remove-server
19672 Remove the current server from the list of servers covered by the Gnus
19673 Agent (@code{gnus-agent-remove-server}).
19678 @node Agent Visuals
19679 @subsection Agent Visuals
19681 If you open a summary while unplugged and, Gnus knows from the group's
19682 active range that there are more articles than the headers currently
19683 stored in the Agent, you may see some articles whose subject looks
19684 something like @samp{[Undownloaded article #####]}. These are
19685 placeholders for the missing headers. Aside from setting a mark,
19686 there is not much that can be done with one of these placeholders.
19687 When Gnus finally gets a chance to fetch the group's headers, the
19688 placeholders will automatically be replaced by the actual headers.
19689 You can configure the summary buffer's maneuvering to skip over the
19690 placeholders if you care (See @code{gnus-auto-goto-ignores}).
19692 While it may be obvious to all, the only headers and articles
19693 available while unplugged are those headers and articles that were
19694 fetched into the Agent while previously plugged. To put it another
19695 way, ``If you forget to fetch something while plugged, you might have a
19696 less than satisfying unplugged session''. For this reason, the Agent
19697 adds two visual effects to your summary buffer. These effects display
19698 the download status of each article so that you always know which
19699 articles will be available when unplugged.
19701 The first visual effect is the @samp{%O} spec. If you customize
19702 @code{gnus-summary-line-format} to include this specifier, you will add
19703 a single character field that indicates an article's download status.
19704 Articles that have been fetched into either the Agent or the Cache,
19705 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
19706 other articles will display @code{gnus-undownloaded-mark} (defaults to
19707 @samp{-}). If you open a group that has not been agentized, a space
19708 (@samp{ }) will be displayed.
19710 The second visual effect are the undownloaded faces. The faces, there
19711 are three indicating the article's score (low, normal, high), seem to
19712 result in a love/hate response from many Gnus users. The problem is
19713 that the face selection is controlled by a list of condition tests and
19714 face names (See @code{gnus-summary-highlight}). Each condition is
19715 tested in the order in which it appears in the list so early
19716 conditions have precedence over later conditions. All of this means
19717 that, if you tick an undownloaded article, the article will continue
19718 to be displayed in the undownloaded face rather than the ticked face.
19720 If you use the Agent as a cache (to avoid downloading the same article
19721 each time you visit it or to minimize your connection time), the
19722 undownloaded face will probably seem like a good idea. The reason
19723 being that you do all of our work (marking, reading, deleting) with
19724 downloaded articles so the normal faces always appear. For those
19725 users using the agent to improve online performance by caching the NOV
19726 database (most users since 5.10.2), the undownloaded faces may appear
19727 to be an absolutely horrible idea. The issue being that, since none
19728 of their articles have been fetched into the Agent, all of the
19729 normal faces will be obscured by the undownloaded faces.
19731 If you would like to use the undownloaded faces, you must enable the
19732 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
19733 group parameter to @code{t}. This parameter, like all other agent
19734 parameters, may be set on an Agent Category (@pxref{Agent Categories}),
19735 a Group Topic (@pxref{Topic Parameters}), or an individual group
19736 (@pxref{Group Parameters}).
19738 The one problem common to all users using the agent is how quickly it
19739 can consume disk space. If you using the agent on many groups, it is
19740 even more difficult to effectively recover disk space. One solution
19741 is the @samp{%F} format available in @code{gnus-group-line-format}.
19742 This format will display the actual disk space used by articles
19743 fetched into both the agent and cache. By knowing which groups use
19744 the most space, users know where to focus their efforts when ``agent
19745 expiring'' articles.
19747 @node Agent as Cache
19748 @subsection Agent as Cache
19750 When Gnus is plugged, it is not efficient to download headers or
19751 articles from the server again, if they are already stored in the
19752 Agent. So, Gnus normally only downloads headers once, and stores them
19753 in the Agent. These headers are later used when generating the summary
19754 buffer, regardless of whether you are plugged or unplugged. Articles
19755 are not cached in the Agent by default though (that would potentially
19756 consume lots of disk space), but if you have already downloaded an
19757 article into the Agent, Gnus will not download the article from the
19758 server again but use the locally stored copy instead.
19760 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
19761 @pxref{Agent Variables}) to always download headers and articles while
19762 plugged. Gnus will almost certainly be slower, but it will be kept
19763 synchronized with the server. That last point probably won't make any
19764 sense if you are using a nntp or nnimap back end.
19767 @subsection Agent Expiry
19769 @vindex gnus-agent-expire-days
19770 @findex gnus-agent-expire
19771 @kindex M-x gnus-agent-expire
19772 @kindex M-x gnus-agent-expire-group
19773 @findex gnus-agent-expire-group
19774 @cindex agent expiry
19775 @cindex Gnus agent expiry
19776 @cindex expiry, in Gnus agent
19778 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
19779 least it doesn't handle it like other back ends. Instead, there are
19780 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
19781 commands that will expire all read articles that are older than
19782 @code{gnus-agent-expire-days} days. They can be run whenever you feel
19783 that you're running out of space. Neither are particularly fast or
19784 efficient, and it's not a particularly good idea to interrupt them (with
19785 @kbd{C-g} or anything else) once you've started one of them.
19787 Note that other functions, e.g. @code{gnus-request-expire-articles},
19788 might run @code{gnus-agent-expire} for you to keep the agent
19789 synchronized with the group.
19791 The agent parameter @code{agent-enable-expiration} may be used to
19792 prevent expiration in selected groups.
19794 @vindex gnus-agent-expire-all
19795 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
19796 expiration commands will expire all articles---unread, read, ticked
19797 and dormant. If @code{nil} (which is the default), only read articles
19798 are eligible for expiry, and unread, ticked and dormant articles will
19799 be kept indefinitely.
19801 If you find that some articles eligible for expiry are never expired,
19802 perhaps some Gnus Agent files are corrupted. There's are special
19803 commands, @code{gnus-agent-regenerate} and
19804 @code{gnus-agent-regenerate-group}, to fix possible problems.
19806 @node Agent Regeneration
19807 @subsection Agent Regeneration
19809 @cindex agent regeneration
19810 @cindex Gnus agent regeneration
19811 @cindex regeneration
19813 The local data structures used by @code{nnagent} may become corrupted
19814 due to certain exceptional conditions. When this happens,
19815 @code{nnagent} functionality may degrade or even fail. The solution
19816 to this problem is to repair the local data structures by removing all
19817 internal inconsistencies.
19819 For example, if your connection to your server is lost while
19820 downloaded articles into the agent, the local data structures will not
19821 know about articles successfully downloaded prior to the connection
19822 failure. Running @code{gnus-agent-regenerate} or
19823 @code{gnus-agent-regenerate-group} will update the data structures
19824 such that you don't need to download these articles a second time.
19826 @findex gnus-agent-regenerate
19827 @kindex M-x gnus-agent-regenerate
19828 The command @code{gnus-agent-regenerate} will perform
19829 @code{gnus-agent-regenerate-group} on every agentized group. While
19830 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
19831 recommended that you first close all summary buffers.
19833 @findex gnus-agent-regenerate-group
19834 @kindex M-x gnus-agent-regenerate-group
19835 The command @code{gnus-agent-regenerate-group} uses the local copies
19836 of individual articles to repair the local @acronym{NOV}(header) database. It
19837 then updates the internal data structures that document which articles
19838 are stored locally. An optional argument will mark articles in the
19841 @node Agent and flags
19842 @subsection Agent and flags
19844 The Agent works with any Gnus back end including those, such as
19845 nnimap, that store flags (read, ticked, etc) on the server. Sadly,
19846 the Agent does not actually know which backends keep their flags in
19847 the backend server rather than in @file{.newsrc}. This means that the
19848 Agent, while unplugged or disconnected, will always record all changes
19849 to the flags in its own files.
19851 When you plug back in, Gnus will then check to see if you have any
19852 changed any flags and ask if you wish to synchronize these with the
19853 server. This behavior is customizable by @code{gnus-agent-synchronize-flags}.
19855 @vindex gnus-agent-synchronize-flags
19856 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19857 never automatically synchronize flags. If it is @code{ask}, which is
19858 the default, the Agent will check if you made any changes and if so
19859 ask if you wish to synchronize these when you re-connect. If it has
19860 any other value, all flags will be synchronized automatically.
19862 If you do not wish to synchronize flags automatically when you
19863 re-connect, you can do it manually with the
19864 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
19865 in the group buffer.
19867 Technical note: the synchronization algorithm does not work by ``pushing''
19868 all local flags to the server, but rather by incrementally updated the
19869 server view of flags by changing only those flags that were changed by
19870 the user. Thus, if you set one flag on an article, quit the group then
19871 re-select the group and remove the flag; the flag will be set and
19872 removed from the server when you ``synchronize''. The queued flag
19873 operations can be found in the per-server @code{flags} file in the Agent
19874 directory. It's emptied when you synchronize flags.
19876 @node Agent and IMAP
19877 @subsection Agent and IMAP
19879 The Agent works with any Gnus back end, including nnimap. However,
19880 since there are some conceptual differences between @acronym{NNTP} and
19881 @acronym{IMAP}, this section (should) provide you with some information to
19882 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
19884 Some things are currently not implemented in the Agent that you'd might
19885 expect from a disconnected @acronym{IMAP} client, including:
19890 Copying/moving articles into nnimap groups when unplugged.
19893 Creating/deleting nnimap groups when unplugged.
19897 @node Outgoing Messages
19898 @subsection Outgoing Messages
19900 By default, when Gnus is unplugged, all outgoing messages (both mail
19901 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
19902 You can view them there after posting, and edit them at will.
19904 You can control the circumstances under which outgoing mail is queued
19905 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
19906 news is always queued when Gnus is unplugged, and never otherwise.
19908 You can send the messages either from the draft group with the special
19909 commands available there, or you can use the @kbd{J S} command in the
19910 group buffer to send all the sendable messages in the draft group.
19911 Posting news will only work when Gnus is plugged, but you can send
19914 If sending mail while unplugged does not work for you and you worry
19915 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
19916 ask you to confirm your action (see
19917 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
19919 @node Agent Variables
19920 @subsection Agent Variables
19925 Is the agent enabled? The default is @code{t}. When first enabled,
19926 the agent will use @code{gnus-agent-auto-agentize-methods} to
19927 automatically mark some back ends as agentized. You may change which
19928 back ends are agentized using the agent commands in the server buffer.
19930 To enter the server buffer, use the @kbd{^}
19931 (@code{gnus-group-enter-server-mode}) command in the group buffer.
19934 @item gnus-agent-directory
19935 @vindex gnus-agent-directory
19936 Where the Gnus Agent will store its files. The default is
19937 @file{~/News/agent/}.
19939 @item gnus-agent-handle-level
19940 @vindex gnus-agent-handle-level
19941 Groups on levels (@pxref{Group Levels}) higher than this variable will
19942 be ignored by the Agent. The default is @code{gnus-level-subscribed},
19943 which means that only subscribed group will be considered by the Agent
19946 @item gnus-agent-plugged-hook
19947 @vindex gnus-agent-plugged-hook
19948 Hook run when connecting to the network.
19950 @item gnus-agent-unplugged-hook
19951 @vindex gnus-agent-unplugged-hook
19952 Hook run when disconnecting from the network.
19954 @item gnus-agent-fetched-hook
19955 @vindex gnus-agent-fetched-hook
19956 Hook run when finished fetching articles.
19958 @item gnus-agent-cache
19959 @vindex gnus-agent-cache
19960 Variable to control whether use the locally stored @acronym{NOV} and
19961 articles when plugged, e.g. essentially using the Agent as a cache.
19962 The default is non-@code{nil}, which means to use the Agent as a cache.
19964 @item gnus-agent-go-online
19965 @vindex gnus-agent-go-online
19966 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
19967 automatically switch offline servers into online status. If it is
19968 @code{ask}, the default, the Agent will ask if you wish to switch
19969 offline servers into online status when you re-connect. If it has any
19970 other value, all offline servers will be automatically switched into
19973 @item gnus-agent-mark-unread-after-downloaded
19974 @vindex gnus-agent-mark-unread-after-downloaded
19975 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
19976 mark articles as unread after downloading. This is usually a safe
19977 thing to do as the newly downloaded article has obviously not been
19978 read. The default is @code{t}.
19980 @item gnus-agent-synchronize-flags
19981 @vindex gnus-agent-synchronize-flags
19982 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19983 never automatically synchronize flags. If it is @code{ask}, which is
19984 the default, the Agent will check if you made any changes and if so
19985 ask if you wish to synchronize these when you re-connect. If it has
19986 any other value, all flags will be synchronized automatically.
19988 @item gnus-agent-consider-all-articles
19989 @vindex gnus-agent-consider-all-articles
19990 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
19991 agent will let the agent predicate decide whether articles need to be
19992 downloaded or not, for all articles. When @code{nil}, the default,
19993 the agent will only let the predicate decide whether unread articles
19994 are downloaded or not. If you enable this, you may also want to look
19995 into the agent expiry settings (@pxref{Category Variables}), so that
19996 the agent doesn't download articles which the agent will later expire,
19997 over and over again.
19999 @item gnus-agent-max-fetch-size
20000 @vindex gnus-agent-max-fetch-size
20001 The agent fetches articles into a temporary buffer prior to parsing
20002 them into individual files. To avoid exceeding the max. buffer size,
20003 the agent alternates between fetching and parsing until all articles
20004 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
20005 limit to control how often the cycling occurs. A large value improves
20006 performance. A small value minimizes the time lost should the
20007 connection be lost while fetching (You may need to run
20008 @code{gnus-agent-regenerate-group} to update the group's state.
20009 However, all articles parsed prior to loosing the connection will be
20010 available while unplugged). The default is 10M so it is unusual to
20013 @item gnus-server-unopen-status
20014 @vindex gnus-server-unopen-status
20015 Perhaps not an Agent variable, but closely related to the Agent, this
20016 variable says what will happen if Gnus cannot open a server. If the
20017 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
20018 whether to deny the server or whether to unplug the agent. If the
20019 Agent is disabled, Gnus always simply deny the server. Other choices
20020 for this variable include @code{denied} and @code{offline} the latter
20021 is only valid if the Agent is used.
20023 @item gnus-auto-goto-ignores
20024 @vindex gnus-auto-goto-ignores
20025 Another variable that isn't an Agent variable, yet so closely related
20026 that most will look for it here, this variable tells the summary
20027 buffer how to maneuver around undownloaded (only headers stored in the
20028 agent) and unfetched (neither article nor headers stored) articles.
20030 The valid values are @code{nil} (maneuver to any article),
20031 @code{undownloaded} (maneuvering while unplugged ignores articles that
20032 have not been fetched), @code{always-undownloaded} (maneuvering always
20033 ignores articles that have not been fetched), @code{unfetched}
20034 (maneuvering ignores articles whose headers have not been fetched).
20036 @item gnus-agent-queue-mail
20037 @vindex gnus-agent-queue-mail
20038 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
20039 queue mail rather than sending it straight away. When @code{t}, Gnus
20040 will queue mail when unplugged only. When @code{nil}, never queue
20041 mail. The default is @code{t}.
20043 @item gnus-agent-prompt-send-queue
20044 @vindex gnus-agent-prompt-send-queue
20045 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
20046 prompt you to confirm that you really wish to proceed if you hit
20047 @kbd{J S} while unplugged. The default is @code{nil}.
20049 @item gnus-agent-auto-agentize-methods
20050 @vindex gnus-agent-auto-agentize-methods
20051 If you have never used the Agent before (or more technically, if
20052 @file{~/News/agent/lib/servers} does not exist), Gnus will
20053 automatically agentize a few servers for you. This variable control
20054 which back ends should be auto-agentized. It is typically only useful
20055 to agentize remote back ends. The auto-agentizing has the same effect
20056 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
20057 If the file exist, you must manage the servers manually by adding or
20058 removing them, this variable is only applicable the first time you
20059 start Gnus. The default is @samp{(nntp nnimap)}.
20064 @node Example Setup
20065 @subsection Example Setup
20067 If you don't want to read this manual, and you have a fairly standard
20068 setup, you may be able to use something like the following as your
20069 @file{~/.gnus.el} file to get started.
20072 ;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
20073 ;; @r{from your ISP's server.}
20074 (setq gnus-select-method '(nntp "news.your-isp.com"))
20076 ;; @r{Define how Gnus is to read your mail. We read mail from}
20077 ;; @r{your ISP's @acronym{POP} server.}
20078 (setq mail-sources '((pop :server "pop.your-isp.com")))
20080 ;; @r{Say how Gnus is to store the mail. We use nnml groups.}
20081 (setq gnus-secondary-select-methods '((nnml "")))
20083 ;; @r{Make Gnus into an offline newsreader.}
20084 ;; (gnus-agentize) ; @r{The obsolete setting.}
20085 ;; (setq gnus-agent t) ; @r{Now the default.}
20088 That should be it, basically. Put that in your @file{~/.gnus.el} file,
20089 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
20092 If this is the first time you've run Gnus, you will be subscribed
20093 automatically to a few default newsgroups. You'll probably want to
20094 subscribe to more groups, and to do that, you have to query the
20095 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
20096 command. This usually takes quite a while, but you only have to do it
20099 After reading and parsing a while, you'll be presented with a list of
20100 groups. Subscribe to the ones you want to read with the @kbd{u}
20101 command. @kbd{l} to make all the killed groups disappear after you've
20102 subscribe to all the groups you want to read. (@kbd{A k} will bring
20103 back all the killed groups.)
20105 You can now read the groups at once, or you can download the articles
20106 with the @kbd{J s} command. And then read the rest of this manual to
20107 find out which of the other gazillion things you want to customize.
20110 @node Batching Agents
20111 @subsection Batching Agents
20112 @findex gnus-agent-batch
20114 Having the Gnus Agent fetch articles (and post whatever messages you've
20115 written) is quite easy once you've gotten things set up properly. The
20116 following shell script will do everything that is necessary:
20118 You can run a complete batch command from the command line with the
20119 following incantation:
20123 emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-agent-batch >/dev/null 2>&1
20127 @node Agent Caveats
20128 @subsection Agent Caveats
20130 The Gnus Agent doesn't seem to work like most other offline
20131 newsreaders. Here are some common questions that some imaginary people
20135 @item If I read an article while plugged, do they get entered into the Agent?
20137 @strong{No}. If you want this behavior, add
20138 @code{gnus-agent-fetch-selected-article} to
20139 @code{gnus-select-article-hook}.
20141 @item If I read an article while plugged, and the article already exists in
20142 the Agent, will it get downloaded once more?
20144 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
20148 In short, when Gnus is unplugged, it only looks into the locally stored
20149 articles; when it's plugged, it talks to your ISP and may also use the
20150 locally stored articles.
20157 Other people use @dfn{kill files}, but we here at Gnus Towers like
20158 scoring better than killing, so we'd rather switch than fight. They do
20159 something completely different as well, so sit up straight and pay
20162 @vindex gnus-summary-mark-below
20163 All articles have a default score (@code{gnus-summary-default-score}),
20164 which is 0 by default. This score may be raised or lowered either
20165 interactively or by score files. Articles that have a score lower than
20166 @code{gnus-summary-mark-below} are marked as read.
20168 Gnus will read any @dfn{score files} that apply to the current group
20169 before generating the summary buffer.
20171 There are several commands in the summary buffer that insert score
20172 entries based on the current article. You can, for instance, ask Gnus to
20173 lower or increase the score of all articles with a certain subject.
20175 There are two sorts of scoring entries: Permanent and temporary.
20176 Temporary score entries are self-expiring entries. Any entries that are
20177 temporary and have not been used for, say, a week, will be removed
20178 silently to help keep the sizes of the score files down.
20181 * Summary Score Commands:: Adding score entries for the current group.
20182 * Group Score Commands:: General score commands.
20183 * Score Variables:: Customize your scoring. (My, what terminology).
20184 * Score File Format:: What a score file may contain.
20185 * Score File Editing:: You can edit score files by hand as well.
20186 * Adaptive Scoring:: Big Sister Gnus knows what you read.
20187 * Home Score File:: How to say where new score entries are to go.
20188 * Followups To Yourself:: Having Gnus notice when people answer you.
20189 * Scoring On Other Headers:: Scoring on non-standard headers.
20190 * Scoring Tips:: How to score effectively.
20191 * Reverse Scoring:: That problem child of old is not problem.
20192 * Global Score Files:: Earth-spanning, ear-splitting score files.
20193 * Kill Files:: They are still here, but they can be ignored.
20194 * Converting Kill Files:: Translating kill files to score files.
20195 * Advanced Scoring:: Using logical expressions to build score rules.
20196 * Score Decays:: It can be useful to let scores wither away.
20200 @node Summary Score Commands
20201 @section Summary Score Commands
20202 @cindex score commands
20204 The score commands that alter score entries do not actually modify real
20205 score files. That would be too inefficient. Gnus maintains a cache of
20206 previously loaded score files, one of which is considered the
20207 @dfn{current score file alist}. The score commands simply insert
20208 entries into this list, and upon group exit, this list is saved.
20210 The current score file is by default the group's local score file, even
20211 if no such score file actually exists. To insert score commands into
20212 some other score file (e.g. @file{all.SCORE}), you must first make this
20213 score file the current one.
20215 General score commands that don't actually change the score file:
20220 @kindex V s (Summary)
20221 @findex gnus-summary-set-score
20222 Set the score of the current article (@code{gnus-summary-set-score}).
20225 @kindex V S (Summary)
20226 @findex gnus-summary-current-score
20227 Display the score of the current article
20228 (@code{gnus-summary-current-score}).
20231 @kindex V t (Summary)
20232 @findex gnus-score-find-trace
20233 Display all score rules that have been used on the current article
20234 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
20235 may type @kbd{e} to edit score file corresponding to the score rule on
20236 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
20237 score file and edit it.
20240 @kindex V w (Summary)
20241 @findex gnus-score-find-favourite-words
20242 List words used in scoring (@code{gnus-score-find-favourite-words}).
20245 @kindex V R (Summary)
20246 @findex gnus-summary-rescore
20247 Run the current summary through the scoring process
20248 (@code{gnus-summary-rescore}). This might be useful if you're playing
20249 around with your score files behind Gnus' back and want to see the
20250 effect you're having.
20253 @kindex V c (Summary)
20254 @findex gnus-score-change-score-file
20255 Make a different score file the current
20256 (@code{gnus-score-change-score-file}).
20259 @kindex V e (Summary)
20260 @findex gnus-score-edit-current-scores
20261 Edit the current score file (@code{gnus-score-edit-current-scores}).
20262 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
20266 @kindex V f (Summary)
20267 @findex gnus-score-edit-file
20268 Edit a score file and make this score file the current one
20269 (@code{gnus-score-edit-file}).
20272 @kindex V F (Summary)
20273 @findex gnus-score-flush-cache
20274 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
20275 after editing score files.
20278 @kindex V C (Summary)
20279 @findex gnus-score-customize
20280 Customize a score file in a visually pleasing manner
20281 (@code{gnus-score-customize}).
20285 The rest of these commands modify the local score file.
20290 @kindex V m (Summary)
20291 @findex gnus-score-set-mark-below
20292 Prompt for a score, and mark all articles with a score below this as
20293 read (@code{gnus-score-set-mark-below}).
20296 @kindex V x (Summary)
20297 @findex gnus-score-set-expunge-below
20298 Prompt for a score, and add a score rule to the current score file to
20299 expunge all articles below this score
20300 (@code{gnus-score-set-expunge-below}).
20303 The keystrokes for actually making score entries follow a very regular
20304 pattern, so there's no need to list all the commands. (Hundreds of
20307 @findex gnus-summary-increase-score
20308 @findex gnus-summary-lower-score
20312 The first key is either @kbd{I} (upper case i) for increasing the score
20313 or @kbd{L} for lowering the score.
20315 The second key says what header you want to score on. The following
20316 keys are available:
20320 Score on the author name.
20323 Score on the subject line.
20326 Score on the @code{Xref} line---i.e., the cross-posting line.
20329 Score on the @code{References} line.
20335 Score on the number of lines.
20338 Score on the @code{Message-ID} header.
20341 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
20342 if your @acronym{NNTP} server tracks additional header data in overviews.
20345 Score on followups---this matches the author name, and adds scores to
20346 the followups to this author. (Using this key leads to the creation of
20347 @file{ADAPT} files.)
20356 Score on thread. (Using this key leads to the creation of @file{ADAPT}
20362 The third key is the match type. Which match types are valid depends on
20363 what headers you are scoring on.
20375 Substring matching.
20378 Fuzzy matching (@pxref{Fuzzy Matching}).
20407 Greater than number.
20412 The fourth and usually final key says whether this is a temporary (i.e.,
20413 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
20414 or whether it is to be done immediately, without adding to the score
20419 Temporary score entry.
20422 Permanent score entry.
20425 Immediately scoring.
20429 If you are scoring on `e' (extra) headers, you will then be prompted for
20430 the header name on which you wish to score. This must be a header named
20431 in gnus-extra-headers, and @samp{TAB} completion is available.
20435 So, let's say you want to increase the score on the current author with
20436 exact matching permanently: @kbd{I a e p}. If you want to lower the
20437 score based on the subject line, using substring matching, and make a
20438 temporary score entry: @kbd{L s s t}. Pretty easy.
20440 To make things a bit more complicated, there are shortcuts. If you use
20441 a capital letter on either the second or third keys, Gnus will use
20442 defaults for the remaining one or two keystrokes. The defaults are
20443 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
20444 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
20446 These functions take both the numerical prefix and the symbolic prefix
20447 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
20448 (or increase) the score of the article. A symbolic prefix of @code{a}
20449 says to use the @file{all.SCORE} file for the command instead of the
20450 current score file.
20452 @vindex gnus-score-mimic-keymap
20453 The @code{gnus-score-mimic-keymap} says whether these commands will
20454 pretend they are keymaps or not.
20457 @node Group Score Commands
20458 @section Group Score Commands
20459 @cindex group score commands
20461 There aren't many of these as yet, I'm afraid.
20466 @kindex W e (Group)
20467 @findex gnus-score-edit-all-score
20468 Edit the apply-to-all-groups all.SCORE file. You will be popped into
20469 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
20472 @kindex W f (Group)
20473 @findex gnus-score-flush-cache
20474 Gnus maintains a cache of score alists to avoid having to reload them
20475 all the time. This command will flush the cache
20476 (@code{gnus-score-flush-cache}).
20480 You can do scoring from the command line by saying something like:
20482 @findex gnus-batch-score
20483 @cindex batch scoring
20485 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
20489 @node Score Variables
20490 @section Score Variables
20491 @cindex score variables
20495 @item gnus-use-scoring
20496 @vindex gnus-use-scoring
20497 If @code{nil}, Gnus will not check for score files, and will not, in
20498 general, do any score-related work. This is @code{t} by default.
20500 @item gnus-kill-killed
20501 @vindex gnus-kill-killed
20502 If this variable is @code{nil}, Gnus will never apply score files to
20503 articles that have already been through the kill process. While this
20504 may save you lots of time, it also means that if you apply a kill file
20505 to a group, and then change the kill file and want to run it over you
20506 group again to kill more articles, it won't work. You have to set this
20507 variable to @code{t} to do that. (It is @code{t} by default.)
20509 @item gnus-kill-files-directory
20510 @vindex gnus-kill-files-directory
20511 All kill and score files will be stored in this directory, which is
20512 initialized from the @env{SAVEDIR} environment variable by default.
20513 This is @file{~/News/} by default.
20515 @item gnus-score-file-suffix
20516 @vindex gnus-score-file-suffix
20517 Suffix to add to the group name to arrive at the score file name
20518 (@file{SCORE} by default.)
20520 @item gnus-score-uncacheable-files
20521 @vindex gnus-score-uncacheable-files
20522 @cindex score cache
20523 All score files are normally cached to avoid excessive re-loading of
20524 score files. However, this might make your Emacs grow big and
20525 bloated, so this regexp can be used to weed out score files unlikely
20526 to be needed again. It would be a bad idea to deny caching of
20527 @file{all.SCORE}, while it might be a good idea to not cache
20528 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
20529 variable is @samp{ADAPT$} by default, so no adaptive score files will
20532 @item gnus-save-score
20533 @vindex gnus-save-score
20534 If you have really complicated score files, and do lots of batch
20535 scoring, then you might set this variable to @code{t}. This will make
20536 Gnus save the scores into the @file{.newsrc.eld} file.
20538 If you do not set this to @code{t}, then manual scores (like those set
20539 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
20540 across group visits.
20542 @item gnus-score-interactive-default-score
20543 @vindex gnus-score-interactive-default-score
20544 Score used by all the interactive raise/lower commands to raise/lower
20545 score with. Default is 1000, which may seem excessive, but this is to
20546 ensure that the adaptive scoring scheme gets enough room to play with.
20547 We don't want the small changes from the adaptive scoring to overwrite
20548 manually entered data.
20550 @item gnus-summary-default-score
20551 @vindex gnus-summary-default-score
20552 Default score of an article, which is 0 by default.
20554 @item gnus-summary-expunge-below
20555 @vindex gnus-summary-expunge-below
20556 Don't display the summary lines of articles that have scores lower than
20557 this variable. This is @code{nil} by default, which means that no
20558 articles will be hidden. This variable is local to the summary buffers,
20559 and has to be set from @code{gnus-summary-mode-hook}.
20561 @item gnus-score-over-mark
20562 @vindex gnus-score-over-mark
20563 Mark (in the third column) used for articles with a score over the
20564 default. Default is @samp{+}.
20566 @item gnus-score-below-mark
20567 @vindex gnus-score-below-mark
20568 Mark (in the third column) used for articles with a score below the
20569 default. Default is @samp{-}.
20571 @item gnus-score-find-score-files-function
20572 @vindex gnus-score-find-score-files-function
20573 Function used to find score files for the current group. This function
20574 is called with the name of the group as the argument.
20576 Predefined functions available are:
20579 @item gnus-score-find-single
20580 @findex gnus-score-find-single
20581 Only apply the group's own score file.
20583 @item gnus-score-find-bnews
20584 @findex gnus-score-find-bnews
20585 Apply all score files that match, using bnews syntax. This is the
20586 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
20587 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
20588 @file{gnu.all.SCORE} would all apply. In short, the instances of
20589 @samp{all} in the score file names are translated into @samp{.*}, and
20590 then a regexp match is done.
20592 This means that if you have some score entries that you want to apply to
20593 all groups, then you put those entries in the @file{all.SCORE} file.
20595 The score files are applied in a semi-random order, although Gnus will
20596 try to apply the more general score files before the more specific score
20597 files. It does this by looking at the number of elements in the score
20598 file names---discarding the @samp{all} elements.
20600 @item gnus-score-find-hierarchical
20601 @findex gnus-score-find-hierarchical
20602 Apply all score files from all the parent groups. This means that you
20603 can't have score files like @file{all.SCORE}, but you can have
20604 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
20608 This variable can also be a list of functions. In that case, all
20609 these functions will be called with the group name as argument, and
20610 all the returned lists of score files will be applied. These
20611 functions can also return lists of lists of score alists directly. In
20612 that case, the functions that return these non-file score alists
20613 should probably be placed before the ``real'' score file functions, to
20614 ensure that the last score file returned is the local score file.
20617 For example, to do hierarchical scoring but use a non-server-specific
20618 overall score file, you could use the value
20620 (list (lambda (group) ("all.SCORE"))
20621 'gnus-score-find-hierarchical)
20624 @item gnus-score-expiry-days
20625 @vindex gnus-score-expiry-days
20626 This variable says how many days should pass before an unused score file
20627 entry is expired. If this variable is @code{nil}, no score file entries
20628 are expired. It's 7 by default.
20630 @item gnus-update-score-entry-dates
20631 @vindex gnus-update-score-entry-dates
20632 If this variable is non-@code{nil}, temporary score entries that have
20633 been triggered (matched) will have their dates updated. (This is how Gnus
20634 controls expiry---all non-matched-entries will become too old while
20635 matched entries will stay fresh and young.) However, if you set this
20636 variable to @code{nil}, even matched entries will grow old and will
20637 have to face that oh-so grim reaper.
20639 @item gnus-score-after-write-file-function
20640 @vindex gnus-score-after-write-file-function
20641 Function called with the name of the score file just written.
20643 @item gnus-score-thread-simplify
20644 @vindex gnus-score-thread-simplify
20645 If this variable is non-@code{nil}, article subjects will be
20646 simplified for subject scoring purposes in the same manner as with
20647 threading---according to the current value of
20648 @code{gnus-simplify-subject-functions}. If the scoring entry uses
20649 @code{substring} or @code{exact} matching, the match will also be
20650 simplified in this manner.
20655 @node Score File Format
20656 @section Score File Format
20657 @cindex score file format
20659 A score file is an @code{emacs-lisp} file that normally contains just a
20660 single form. Casual users are not expected to edit these files;
20661 everything can be changed from the summary buffer.
20663 Anyway, if you'd like to dig into it yourself, here's an example:
20667 ("Lars Ingebrigtsen" -10000)
20669 ("larsi\\|lmi" -50000 nil R))
20671 ("Ding is Badd" nil 728373))
20673 ("alt.politics" -1000 728372 s))
20678 (mark-and-expunge -10)
20682 (files "/hom/larsi/News/gnu.SCORE")
20683 (exclude-files "all.SCORE")
20684 (local (gnus-newsgroup-auto-expire t)
20685 (gnus-summary-make-false-root empty))
20689 This example demonstrates most score file elements. @xref{Advanced
20690 Scoring}, for a different approach.
20692 Even though this looks much like Lisp code, nothing here is actually
20693 @code{eval}ed. The Lisp reader is used to read this form, though, so it
20694 has to be valid syntactically, if not semantically.
20696 Six keys are supported by this alist:
20701 If the key is a string, it is the name of the header to perform the
20702 match on. Scoring can only be performed on these eight headers:
20703 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
20704 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
20705 these headers, there are three strings to tell Gnus to fetch the entire
20706 article and do the match on larger parts of the article: @code{Body}
20707 will perform the match on the body of the article, @code{Head} will
20708 perform the match on the head of the article, and @code{All} will
20709 perform the match on the entire article. Note that using any of these
20710 last three keys will slow down group entry @emph{considerably}. The
20711 final ``header'' you can score on is @code{Followup}. These score
20712 entries will result in new score entries being added for all follow-ups
20713 to articles that matches these score entries.
20715 Following this key is an arbitrary number of score entries, where each
20716 score entry has one to four elements.
20720 The first element is the @dfn{match element}. On most headers this will
20721 be a string, but on the Lines and Chars headers, this must be an
20725 If the second element is present, it should be a number---the @dfn{score
20726 element}. This number should be an integer in the neginf to posinf
20727 interval. This number is added to the score of the article if the match
20728 is successful. If this element is not present, the
20729 @code{gnus-score-interactive-default-score} number will be used
20730 instead. This is 1000 by default.
20733 If the third element is present, it should be a number---the @dfn{date
20734 element}. This date says when the last time this score entry matched,
20735 which provides a mechanism for expiring the score entries. It this
20736 element is not present, the score entry is permanent. The date is
20737 represented by the number of days since December 31, 1 BCE.
20740 If the fourth element is present, it should be a symbol---the @dfn{type
20741 element}. This element specifies what function should be used to see
20742 whether this score entry matches the article. What match types that can
20743 be used depends on what header you wish to perform the match on.
20746 @item From, Subject, References, Xref, Message-ID
20747 For most header types, there are the @code{r} and @code{R} (regexp), as
20748 well as @code{s} and @code{S} (substring) types, and @code{e} and
20749 @code{E} (exact match), and @code{w} (word match) types. If this
20750 element is not present, Gnus will assume that substring matching should
20751 be used. @code{R}, @code{S}, and @code{E} differ from the others in
20752 that the matches will be done in a case-sensitive manner. All these
20753 one-letter types are really just abbreviations for the @code{regexp},
20754 @code{string}, @code{exact}, and @code{word} types, which you can use
20755 instead, if you feel like.
20758 Just as for the standard string overview headers, if you are using
20759 gnus-extra-headers, you can score on these headers' values. In this
20760 case, there is a 5th element in the score entry, being the name of the
20761 header to be scored. The following entry is useful in your
20762 @file{all.SCORE} file in case of spam attacks from a single origin
20763 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
20767 ("111.222.333.444" -1000 nil s
20768 "NNTP-Posting-Host")
20772 These two headers use different match types: @code{<}, @code{>},
20773 @code{=}, @code{>=} and @code{<=}.
20775 These predicates are true if
20778 (PREDICATE HEADER MATCH)
20781 evaluates to non-@code{nil}. For instance, the advanced match
20782 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
20789 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
20790 the match, we get the score added if the article has less than 4 lines.
20791 (It's easy to get confused and think it's the other way around. But
20792 it's not. I think.)
20794 When matching on @code{Lines}, be careful because some back ends (like
20795 @code{nndir}) do not generate @code{Lines} header, so every article ends
20796 up being marked as having 0 lines. This can lead to strange results if
20797 you happen to lower score of the articles with few lines.
20800 For the Date header we have three kinda silly match types:
20801 @code{before}, @code{at} and @code{after}. I can't really imagine this
20802 ever being useful, but, like, it would feel kinda silly not to provide
20803 this function. Just in case. You never know. Better safe than sorry.
20804 Once burnt, twice shy. Don't judge a book by its cover. Never not have
20805 sex on a first date. (I have been told that at least one person, and I
20806 quote, ``found this function indispensable'', however.)
20810 A more useful match type is @code{regexp}. With it, you can match the
20811 date string using a regular expression. The date is normalized to
20812 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
20813 you want to match all articles that have been posted on April 1st in
20814 every year, you could use @samp{....0401.........} as a match string,
20815 for instance. (Note that the date is kept in its original time zone, so
20816 this will match articles that were posted when it was April 1st where
20817 the article was posted from. Time zones are such wholesome fun for the
20820 @item Head, Body, All
20821 These three match keys use the same match types as the @code{From} (etc)
20825 This match key is somewhat special, in that it will match the
20826 @code{From} header, and affect the score of not only the matching
20827 articles, but also all followups to the matching articles. This allows
20828 you e.g. increase the score of followups to your own articles, or
20829 decrease the score of followups to the articles of some known
20830 trouble-maker. Uses the same match types as the @code{From} header
20831 uses. (Using this match key will lead to creation of @file{ADAPT}
20835 This match key works along the same lines as the @code{Followup} match
20836 key. If you say that you want to score on a (sub-)thread started by an
20837 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
20838 match. This will add a new @samp{thread} match for each article that
20839 has @var{x} in its @code{References} header. (These new @samp{thread}
20840 matches will use the @code{Message-ID}s of these matching articles.)
20841 This will ensure that you can raise/lower the score of an entire thread,
20842 even though some articles in the thread may not have complete
20843 @code{References} headers. Note that using this may lead to
20844 undeterministic scores of the articles in the thread. (Using this match
20845 key will lead to creation of @file{ADAPT} files.)
20849 @cindex score file atoms
20851 The value of this entry should be a number. Any articles with a score
20852 lower than this number will be marked as read.
20855 The value of this entry should be a number. Any articles with a score
20856 lower than this number will be removed from the summary buffer.
20858 @item mark-and-expunge
20859 The value of this entry should be a number. Any articles with a score
20860 lower than this number will be marked as read and removed from the
20863 @item thread-mark-and-expunge
20864 The value of this entry should be a number. All articles that belong to
20865 a thread that has a total score below this number will be marked as read
20866 and removed from the summary buffer. @code{gnus-thread-score-function}
20867 says how to compute the total score for a thread.
20870 The value of this entry should be any number of file names. These files
20871 are assumed to be score files as well, and will be loaded the same way
20874 @item exclude-files
20875 The clue of this entry should be any number of files. These files will
20876 not be loaded, even though they would normally be so, for some reason or
20880 The value of this entry will be @code{eval}el. This element will be
20881 ignored when handling global score files.
20884 Read-only score files will not be updated or saved. Global score files
20885 should feature this atom (@pxref{Global Score Files}). (Note:
20886 @dfn{Global} here really means @dfn{global}; not your personal
20887 apply-to-all-groups score files.)
20890 The value of this entry should be a number. Articles that do not have
20891 parents will get this number added to their scores. Imagine you follow
20892 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
20893 will only follow a few of the threads, also want to see any new threads.
20895 You can do this with the following two score file entries:
20899 (mark-and-expunge -100)
20902 When you enter the group the first time, you will only see the new
20903 threads. You then raise the score of the threads that you find
20904 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
20905 rest. Next time you enter the group, you will see new articles in the
20906 interesting threads, plus any new threads.
20908 I.e.---the orphan score atom is for high-volume groups where a few
20909 interesting threads which can't be found automatically by ordinary
20910 scoring rules exist.
20913 This entry controls the adaptive scoring. If it is @code{t}, the
20914 default adaptive scoring rules will be used. If it is @code{ignore}, no
20915 adaptive scoring will be performed on this group. If it is a list, this
20916 list will be used as the adaptive scoring rules. If it isn't present,
20917 or is something other than @code{t} or @code{ignore}, the default
20918 adaptive scoring rules will be used. If you want to use adaptive
20919 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
20920 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
20921 not want adaptive scoring. If you only want adaptive scoring in a few
20922 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
20923 insert @code{(adapt t)} in the score files of the groups where you want
20927 All adaptive score entries will go to the file named by this entry. It
20928 will also be applied when entering the group. This atom might be handy
20929 if you want to adapt on several groups at once, using the same adaptive
20930 file for a number of groups.
20933 @cindex local variables
20934 The value of this entry should be a list of @code{(@var{var}
20935 @var{value})} pairs. Each @var{var} will be made buffer-local to the
20936 current summary buffer, and set to the value specified. This is a
20937 convenient, if somewhat strange, way of setting variables in some
20938 groups if you don't like hooks much. Note that the @var{value} won't
20943 @node Score File Editing
20944 @section Score File Editing
20946 You normally enter all scoring commands from the summary buffer, but you
20947 might feel the urge to edit them by hand as well, so we've supplied you
20948 with a mode for that.
20950 It's simply a slightly customized @code{emacs-lisp} mode, with these
20951 additional commands:
20956 @kindex C-c C-c (Score)
20957 @findex gnus-score-edit-exit
20958 Save the changes you have made and return to the summary buffer
20959 (@code{gnus-score-edit-exit}).
20962 @kindex C-c C-d (Score)
20963 @findex gnus-score-edit-insert-date
20964 Insert the current date in numerical format
20965 (@code{gnus-score-edit-insert-date}). This is really the day number, if
20966 you were wondering.
20969 @kindex C-c C-p (Score)
20970 @findex gnus-score-pretty-print
20971 The adaptive score files are saved in an unformatted fashion. If you
20972 intend to read one of these files, you want to @dfn{pretty print} it
20973 first. This command (@code{gnus-score-pretty-print}) does that for
20978 Type @kbd{M-x gnus-score-mode} to use this mode.
20980 @vindex gnus-score-mode-hook
20981 @code{gnus-score-menu-hook} is run in score mode buffers.
20983 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
20984 @kbd{V t} to begin editing score files.
20987 @node Adaptive Scoring
20988 @section Adaptive Scoring
20989 @cindex adaptive scoring
20991 If all this scoring is getting you down, Gnus has a way of making it all
20992 happen automatically---as if by magic. Or rather, as if by artificial
20993 stupidity, to be precise.
20995 @vindex gnus-use-adaptive-scoring
20996 When you read an article, or mark an article as read, or kill an
20997 article, you leave marks behind. On exit from the group, Gnus can sniff
20998 these marks and add score elements depending on what marks it finds.
20999 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
21000 @code{t} or @code{(line)}. If you want score adaptively on separate
21001 words appearing in the subjects, you should set this variable to
21002 @code{(word)}. If you want to use both adaptive methods, set this
21003 variable to @code{(word line)}.
21005 @vindex gnus-default-adaptive-score-alist
21006 To give you complete control over the scoring process, you can customize
21007 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
21008 might look something like this:
21011 (setq gnus-default-adaptive-score-alist
21012 '((gnus-unread-mark)
21013 (gnus-ticked-mark (from 4))
21014 (gnus-dormant-mark (from 5))
21015 (gnus-del-mark (from -4) (subject -1))
21016 (gnus-read-mark (from 4) (subject 2))
21017 (gnus-expirable-mark (from -1) (subject -1))
21018 (gnus-killed-mark (from -1) (subject -3))
21019 (gnus-kill-file-mark)
21020 (gnus-ancient-mark)
21021 (gnus-low-score-mark)
21022 (gnus-catchup-mark (from -1) (subject -1))))
21025 As you see, each element in this alist has a mark as a key (either a
21026 variable name or a ``real'' mark---a character). Following this key is
21027 a arbitrary number of header/score pairs. If there are no header/score
21028 pairs following the key, no adaptive scoring will be done on articles
21029 that have that key as the article mark. For instance, articles with
21030 @code{gnus-unread-mark} in the example above will not get adaptive score
21033 Each article can have only one mark, so just a single of these rules
21034 will be applied to each article.
21036 To take @code{gnus-del-mark} as an example---this alist says that all
21037 articles that have that mark (i.e., are marked with @samp{e}) will have a
21038 score entry added to lower based on the @code{From} header by -4, and
21039 lowered by @code{Subject} by -1. Change this to fit your prejudices.
21041 If you have marked 10 articles with the same subject with
21042 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
21043 That means that that subject will get a score of ten times -1, which
21044 should be, unless I'm much mistaken, -10.
21046 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
21047 the read articles will be marked with the @samp{E} mark. This'll
21048 probably make adaptive scoring slightly impossible, so auto-expiring and
21049 adaptive scoring doesn't really mix very well.
21051 The headers you can score on are @code{from}, @code{subject},
21052 @code{message-id}, @code{references}, @code{xref}, @code{lines},
21053 @code{chars} and @code{date}. In addition, you can score on
21054 @code{followup}, which will create an adaptive score entry that matches
21055 on the @code{References} header using the @code{Message-ID} of the
21056 current article, thereby matching the following thread.
21058 If you use this scheme, you should set the score file atom @code{mark}
21059 to something small---like -300, perhaps, to avoid having small random
21060 changes result in articles getting marked as read.
21062 After using adaptive scoring for a week or so, Gnus should start to
21063 become properly trained and enhance the authors you like best, and kill
21064 the authors you like least, without you having to say so explicitly.
21066 You can control what groups the adaptive scoring is to be performed on
21067 by using the score files (@pxref{Score File Format}). This will also
21068 let you use different rules in different groups.
21070 @vindex gnus-adaptive-file-suffix
21071 The adaptive score entries will be put into a file where the name is the
21072 group name with @code{gnus-adaptive-file-suffix} appended. The default
21075 @vindex gnus-adaptive-pretty-print
21076 Adaptive score files can get huge and are not meant to be edited by
21077 human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the
21078 deafult) those files will not be written in a human readable way.
21080 @vindex gnus-score-exact-adapt-limit
21081 When doing adaptive scoring, substring or fuzzy matching would probably
21082 give you the best results in most cases. However, if the header one
21083 matches is short, the possibility for false positives is great, so if
21084 the length of the match is less than
21085 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
21086 this variable is @code{nil}, exact matching will always be used to avoid
21089 @vindex gnus-default-adaptive-word-score-alist
21090 As mentioned above, you can adapt either on individual words or entire
21091 headers. If you adapt on words, the
21092 @code{gnus-default-adaptive-word-score-alist} variable says what score
21093 each instance of a word should add given a mark.
21096 (setq gnus-default-adaptive-word-score-alist
21097 `((,gnus-read-mark . 30)
21098 (,gnus-catchup-mark . -10)
21099 (,gnus-killed-mark . -20)
21100 (,gnus-del-mark . -15)))
21103 This is the default value. If you have adaption on words enabled, every
21104 word that appears in subjects of articles marked with
21105 @code{gnus-read-mark} will result in a score rule that increase the
21106 score with 30 points.
21108 @vindex gnus-default-ignored-adaptive-words
21109 @vindex gnus-ignored-adaptive-words
21110 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
21111 will be ignored. If you wish to add more words to be ignored, use the
21112 @code{gnus-ignored-adaptive-words} list instead.
21114 @vindex gnus-adaptive-word-length-limit
21115 Some may feel that short words shouldn't count when doing adaptive
21116 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
21117 an integer. Words shorter than this number will be ignored. This
21118 variable defaults to @code{nil}.
21120 @vindex gnus-adaptive-word-syntax-table
21121 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
21122 syntax table in effect. It is similar to the standard syntax table, but
21123 it considers numbers to be non-word-constituent characters.
21125 @vindex gnus-adaptive-word-minimum
21126 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
21127 word scoring process will never bring down the score of an article to
21128 below this number. The default is @code{nil}.
21130 @vindex gnus-adaptive-word-no-group-words
21131 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
21132 won't adaptively word score any of the words in the group name. Useful
21133 for groups like @samp{comp.editors.emacs}, where most of the subject
21134 lines contain the word @samp{emacs}.
21136 After using this scheme for a while, it might be nice to write a
21137 @code{gnus-psychoanalyze-user} command to go through the rules and see
21138 what words you like and what words you don't like. Or perhaps not.
21140 Note that the adaptive word scoring thing is highly experimental and is
21141 likely to change in the future. Initial impressions seem to indicate
21142 that it's totally useless as it stands. Some more work (involving more
21143 rigorous statistical methods) will have to be done to make this useful.
21146 @node Home Score File
21147 @section Home Score File
21149 The score file where new score file entries will go is called the
21150 @dfn{home score file}. This is normally (and by default) the score file
21151 for the group itself. For instance, the home score file for
21152 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
21154 However, this may not be what you want. It is often convenient to share
21155 a common home score file among many groups---all @samp{emacs} groups
21156 could perhaps use the same home score file.
21158 @vindex gnus-home-score-file
21159 The variable that controls this is @code{gnus-home-score-file}. It can
21164 A string. Then this file will be used as the home score file for all
21168 A function. The result of this function will be used as the home score
21169 file. The function will be called with the name of the group as the
21173 A list. The elements in this list can be:
21177 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
21178 group name, the @var{file-name} will be used as the home score file.
21181 A function. If the function returns non-@code{nil}, the result will
21182 be used as the home score file. The function will be called with the
21183 name of the group as the parameter.
21186 A string. Use the string as the home score file.
21189 The list will be traversed from the beginning towards the end looking
21194 So, if you want to use just a single score file, you could say:
21197 (setq gnus-home-score-file
21198 "my-total-score-file.SCORE")
21201 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
21202 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
21204 @findex gnus-hierarchial-home-score-file
21206 (setq gnus-home-score-file
21207 'gnus-hierarchial-home-score-file)
21210 This is a ready-made function provided for your convenience.
21211 Other functions include
21214 @item gnus-current-home-score-file
21215 @findex gnus-current-home-score-file
21216 Return the ``current'' regular score file. This will make scoring
21217 commands add entry to the ``innermost'' matching score file.
21221 If you want to have one score file for the @samp{emacs} groups and
21222 another for the @samp{comp} groups, while letting all other groups use
21223 their own home score files:
21226 (setq gnus-home-score-file
21227 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
21228 '(("\\.emacs" "emacs.SCORE")
21229 ;; @r{All the comp groups in one score file}
21230 ("^comp" "comp.SCORE")))
21233 @vindex gnus-home-adapt-file
21234 @code{gnus-home-adapt-file} works exactly the same way as
21235 @code{gnus-home-score-file}, but says what the home adaptive score file
21236 is instead. All new adaptive file entries will go into the file
21237 specified by this variable, and the same syntax is allowed.
21239 In addition to using @code{gnus-home-score-file} and
21240 @code{gnus-home-adapt-file}, you can also use group parameters
21241 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
21242 Parameters}) to achieve much the same. Group and topic parameters take
21243 precedence over this variable.
21246 @node Followups To Yourself
21247 @section Followups To Yourself
21249 Gnus offers two commands for picking out the @code{Message-ID} header in
21250 the current buffer. Gnus will then add a score rule that scores using
21251 this @code{Message-ID} on the @code{References} header of other
21252 articles. This will, in effect, increase the score of all articles that
21253 respond to the article in the current buffer. Quite useful if you want
21254 to easily note when people answer what you've said.
21258 @item gnus-score-followup-article
21259 @findex gnus-score-followup-article
21260 This will add a score to articles that directly follow up your own
21263 @item gnus-score-followup-thread
21264 @findex gnus-score-followup-thread
21265 This will add a score to all articles that appear in a thread ``below''
21269 @vindex message-sent-hook
21270 These two functions are both primarily meant to be used in hooks like
21271 @code{message-sent-hook}, like this:
21273 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
21277 If you look closely at your own @code{Message-ID}, you'll notice that
21278 the first two or three characters are always the same. Here's two of
21282 <x6u3u47icf.fsf@@eyesore.no>
21283 <x6sp9o7ibw.fsf@@eyesore.no>
21286 So ``my'' ident on this machine is @samp{x6}. This can be
21287 exploited---the following rule will raise the score on all followups to
21292 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
21296 Whether it's the first two or first three characters that are ``yours''
21297 is system-dependent.
21300 @node Scoring On Other Headers
21301 @section Scoring On Other Headers
21302 @cindex scoring on other headers
21304 Gnus is quite fast when scoring the ``traditional''
21305 headers---@samp{From}, @samp{Subject} and so on. However, scoring
21306 other headers requires writing a @code{head} scoring rule, which means
21307 that Gnus has to request every single article from the back end to find
21308 matches. This takes a long time in big groups.
21310 Now, there's not much you can do about this for news groups, but for
21311 mail groups, you have greater control. In @ref{To From Newsgroups},
21312 it's explained in greater detail what this mechanism does, but here's
21313 a cookbook example for @code{nnml} on how to allow scoring on the
21314 @samp{To} and @samp{Cc} headers.
21316 Put the following in your @file{~/.gnus.el} file.
21319 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
21320 nnmail-extra-headers gnus-extra-headers)
21323 Restart Gnus and rebuild your @code{nnml} overview files with the
21324 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
21325 time if you have much mail.
21327 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
21328 so: @kbd{I e s p To RET <your name> RET}.
21332 @vindex gnus-inhibit-slow-scoring
21333 You can inhibit scoring the slow scoring on headers or body by setting
21334 the variable @code{gnus-inhibit-slow-scoring}. If
21335 @code{gnus-inhibit-slow-scoring} is regexp, slow scoring is inhibited if
21336 the group matches the regexp. If it is t, slow scoring on it is
21337 inhibited for all groups.
21341 @section Scoring Tips
21342 @cindex scoring tips
21348 @cindex scoring crossposts
21349 If you want to lower the score of crossposts, the line to match on is
21350 the @code{Xref} header.
21352 ("xref" (" talk.politics.misc:" -1000))
21355 @item Multiple crossposts
21356 If you want to lower the score of articles that have been crossposted to
21357 more than, say, 3 groups:
21360 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
21364 @item Matching on the body
21365 This is generally not a very good idea---it takes a very long time.
21366 Gnus actually has to fetch each individual article from the server. But
21367 you might want to anyway, I guess. Even though there are three match
21368 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
21369 and stick with it in each score file. If you use any two, each article
21370 will be fetched @emph{twice}. If you want to match a bit on the
21371 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
21374 @item Marking as read
21375 You will probably want to mark articles that have scores below a certain
21376 number as read. This is most easily achieved by putting the following
21377 in your @file{all.SCORE} file:
21381 You may also consider doing something similar with @code{expunge}.
21383 @item Negated character classes
21384 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
21385 That will match newlines, which might lead to, well, The Unknown. Say
21386 @code{[^abcd\n]*} instead.
21390 @node Reverse Scoring
21391 @section Reverse Scoring
21392 @cindex reverse scoring
21394 If you want to keep just articles that have @samp{Sex with Emacs} in the
21395 subject header, and expunge all other articles, you could put something
21396 like this in your score file:
21400 ("Sex with Emacs" 2))
21405 So, you raise all articles that match @samp{Sex with Emacs} and mark the
21406 rest as read, and expunge them to boot.
21409 @node Global Score Files
21410 @section Global Score Files
21411 @cindex global score files
21413 Sure, other newsreaders have ``global kill files''. These are usually
21414 nothing more than a single kill file that applies to all groups, stored
21415 in the user's home directory. Bah! Puny, weak newsreaders!
21417 What I'm talking about here are Global Score Files. Score files from
21418 all over the world, from users everywhere, uniting all nations in one
21419 big, happy score file union! Ange-score! New and untested!
21421 @vindex gnus-global-score-files
21422 All you have to do to use other people's score files is to set the
21423 @code{gnus-global-score-files} variable. One entry for each score file,
21424 or each score file directory. Gnus will decide by itself what score
21425 files are applicable to which group.
21427 To use the score file
21428 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
21429 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
21433 (setq gnus-global-score-files
21434 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
21435 "/ftp@@ftp.some-where:/pub/score/"))
21438 @findex gnus-score-search-global-directories
21440 Simple, eh? Directory names must end with a @samp{/}. These
21441 directories are typically scanned only once during each Gnus session.
21442 If you feel the need to manually re-scan the remote directories, you can
21443 use the @code{gnus-score-search-global-directories} command.
21445 Note that, at present, using this option will slow down group entry
21446 somewhat. (That is---a lot.)
21448 If you want to start maintaining score files for other people to use,
21449 just put your score file up for anonymous ftp and announce it to the
21450 world. Become a retro-moderator! Participate in the retro-moderator
21451 wars sure to ensue, where retro-moderators battle it out for the
21452 sympathy of the people, luring them to use their score files on false
21453 premises! Yay! The net is saved!
21455 Here are some tips for the would-be retro-moderator, off the top of my
21461 Articles heavily crossposted are probably junk.
21463 To lower a single inappropriate article, lower by @code{Message-ID}.
21465 Particularly brilliant authors can be raised on a permanent basis.
21467 Authors that repeatedly post off-charter for the group can safely be
21468 lowered out of existence.
21470 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
21471 articles completely.
21474 Use expiring score entries to keep the size of the file down. You
21475 should probably have a long expiry period, though, as some sites keep
21476 old articles for a long time.
21479 @dots{} I wonder whether other newsreaders will support global score files
21480 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
21481 Wave, xrn and 1stReader are bound to implement scoring. Should we start
21482 holding our breath yet?
21486 @section Kill Files
21489 Gnus still supports those pesky old kill files. In fact, the kill file
21490 entries can now be expiring, which is something I wrote before Daniel
21491 Quinlan thought of doing score files, so I've left the code in there.
21493 In short, kill processing is a lot slower (and I do mean @emph{a lot})
21494 than score processing, so it might be a good idea to rewrite your kill
21495 files into score files.
21497 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
21498 forms into this file, which means that you can use kill files as some
21499 sort of primitive hook function to be run on group entry, even though
21500 that isn't a very good idea.
21502 Normal kill files look like this:
21505 (gnus-kill "From" "Lars Ingebrigtsen")
21506 (gnus-kill "Subject" "ding")
21510 This will mark every article written by me as read, and remove the
21511 marked articles from the summary buffer. Very useful, you'll agree.
21513 Other programs use a totally different kill file syntax. If Gnus
21514 encounters what looks like a @code{rn} kill file, it will take a stab at
21517 Two summary functions for editing a @sc{gnus} kill file:
21522 @kindex M-k (Summary)
21523 @findex gnus-summary-edit-local-kill
21524 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
21527 @kindex M-K (Summary)
21528 @findex gnus-summary-edit-global-kill
21529 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
21532 Two group mode functions for editing the kill files:
21537 @kindex M-k (Group)
21538 @findex gnus-group-edit-local-kill
21539 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
21542 @kindex M-K (Group)
21543 @findex gnus-group-edit-global-kill
21544 Edit the general kill file (@code{gnus-group-edit-global-kill}).
21547 Kill file variables:
21550 @item gnus-kill-file-name
21551 @vindex gnus-kill-file-name
21552 A kill file for the group @samp{soc.motss} is normally called
21553 @file{soc.motss.KILL}. The suffix appended to the group name to get
21554 this file name is detailed by the @code{gnus-kill-file-name} variable.
21555 The ``global'' kill file (not in the score file sense of ``global'', of
21556 course) is just called @file{KILL}.
21558 @vindex gnus-kill-save-kill-file
21559 @item gnus-kill-save-kill-file
21560 If this variable is non-@code{nil}, Gnus will save the
21561 kill file after processing, which is necessary if you use expiring
21564 @item gnus-apply-kill-hook
21565 @vindex gnus-apply-kill-hook
21566 @findex gnus-apply-kill-file-unless-scored
21567 @findex gnus-apply-kill-file
21568 A hook called to apply kill files to a group. It is
21569 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
21570 kill file if you have a score file for the same group, you can set this
21571 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
21572 kill files to be processed, you should set this variable to @code{nil}.
21574 @item gnus-kill-file-mode-hook
21575 @vindex gnus-kill-file-mode-hook
21576 A hook called in kill-file mode buffers.
21581 @node Converting Kill Files
21582 @section Converting Kill Files
21584 @cindex converting kill files
21586 If you have loads of old kill files, you may want to convert them into
21587 score files. If they are ``regular'', you can use
21588 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
21591 The kill to score conversion package isn't included in Gnus by default.
21592 You can fetch it from
21593 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
21595 If your old kill files are very complex---if they contain more
21596 non-@code{gnus-kill} forms than not, you'll have to convert them by
21597 hand. Or just let them be as they are. Gnus will still use them as
21601 @node Advanced Scoring
21602 @section Advanced Scoring
21604 Scoring on Subjects and From headers is nice enough, but what if you're
21605 really interested in what a person has to say only when she's talking
21606 about a particular subject? Or what if you really don't want to
21607 read what person A has to say when she's following up to person B, but
21608 want to read what she says when she's following up to person C?
21610 By using advanced scoring rules you may create arbitrarily complex
21614 * Advanced Scoring Syntax:: A definition.
21615 * Advanced Scoring Examples:: What they look like.
21616 * Advanced Scoring Tips:: Getting the most out of it.
21620 @node Advanced Scoring Syntax
21621 @subsection Advanced Scoring Syntax
21623 Ordinary scoring rules have a string as the first element in the rule.
21624 Advanced scoring rules have a list as the first element. The second
21625 element is the score to be applied if the first element evaluated to a
21626 non-@code{nil} value.
21628 These lists may consist of three logical operators, one redirection
21629 operator, and various match operators.
21636 This logical operator will evaluate each of its arguments until it finds
21637 one that evaluates to @code{false}, and then it'll stop. If all arguments
21638 evaluate to @code{true} values, then this operator will return
21643 This logical operator will evaluate each of its arguments until it finds
21644 one that evaluates to @code{true}. If no arguments are @code{true},
21645 then this operator will return @code{false}.
21650 This logical operator only takes a single argument. It returns the
21651 logical negation of the value of its argument.
21655 There is an @dfn{indirection operator} that will make its arguments
21656 apply to the ancestors of the current article being scored. For
21657 instance, @code{1-} will make score rules apply to the parent of the
21658 current article. @code{2-} will make score rules apply to the
21659 grandparent of the current article. Alternatively, you can write
21660 @code{^^}, where the number of @code{^}s (carets) says how far back into
21661 the ancestry you want to go.
21663 Finally, we have the match operators. These are the ones that do the
21664 real work. Match operators are header name strings followed by a match
21665 and a match type. A typical match operator looks like @samp{("from"
21666 "Lars Ingebrigtsen" s)}. The header names are the same as when using
21667 simple scoring, and the match types are also the same.
21670 @node Advanced Scoring Examples
21671 @subsection Advanced Scoring Examples
21673 Please note that the following examples are score file rules. To
21674 make a complete score file from them, surround them with another pair
21677 Let's say you want to increase the score of articles written by Lars
21678 when he's talking about Gnus:
21683 ("from" "Lars Ingebrigtsen")
21684 ("subject" "Gnus"))
21691 When he writes long articles, he sometimes has something nice to say:
21695 ("from" "Lars Ingebrigtsen")
21702 However, when he responds to things written by Reig Eigil Logge, you
21703 really don't want to read what he's written:
21707 ("from" "Lars Ingebrigtsen")
21708 (1- ("from" "Reig Eigil Logge")))
21712 Everybody that follows up Redmondo when he writes about disappearing
21713 socks should have their scores raised, but only when they talk about
21714 white socks. However, when Lars talks about socks, it's usually not
21721 ("from" "redmondo@@.*no" r)
21722 ("body" "disappearing.*socks" t)))
21723 (! ("from" "Lars Ingebrigtsen"))
21724 ("body" "white.*socks"))
21728 Suppose you're reading a high volume group and you're only interested
21729 in replies. The plan is to score down all articles that don't have
21730 subject that begin with "Re:", "Fw:" or "Fwd:" and then score up all
21731 parents of articles that have subjects that begin with reply marks.
21734 ((! ("subject" "re:\\|fwd?:" r))
21736 ((1- ("subject" "re:\\|fwd?:" r))
21740 The possibilities are endless.
21742 @node Advanced Scoring Tips
21743 @subsection Advanced Scoring Tips
21745 The @code{&} and @code{|} logical operators do short-circuit logic.
21746 That is, they stop processing their arguments when it's clear what the
21747 result of the operation will be. For instance, if one of the arguments
21748 of an @code{&} evaluates to @code{false}, there's no point in evaluating
21749 the rest of the arguments. This means that you should put slow matches
21750 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
21751 @samp{subject}) first.
21753 The indirection arguments (@code{1-} and so on) will make their
21754 arguments work on previous generations of the thread. If you say
21765 Then that means ``score on the from header of the grandparent of the
21766 current article''. An indirection is quite fast, but it's better to say:
21772 ("subject" "Gnus")))
21779 (1- ("from" "Lars"))
21780 (1- ("subject" "Gnus")))
21785 @section Score Decays
21786 @cindex score decays
21789 You may find that your scores have a tendency to grow without
21790 bounds, especially if you're using adaptive scoring. If scores get too
21791 big, they lose all meaning---they simply max out and it's difficult to
21792 use them in any sensible way.
21794 @vindex gnus-decay-scores
21795 @findex gnus-decay-score
21796 @vindex gnus-decay-score-function
21797 Gnus provides a mechanism for decaying scores to help with this problem.
21798 When score files are loaded and @code{gnus-decay-scores} is
21799 non-@code{nil}, Gnus will run the score files through the decaying
21800 mechanism thereby lowering the scores of all non-permanent score rules.
21801 If @code{gnus-decay-scores} is a regexp, only score files matching this
21802 regexp are treated. E.g. you may set it to @samp{\\.ADAPT\\'} if only
21803 @emph{adaptive} score files should be decayed. The decay itself if
21804 performed by the @code{gnus-decay-score-function} function, which is
21805 @code{gnus-decay-score} by default. Here's the definition of that
21809 (defun gnus-decay-score (score)
21810 "Decay SCORE according to `gnus-score-decay-constant'
21811 and `gnus-score-decay-scale'."
21813 (* (if (< score 0) -1 1)
21815 (max gnus-score-decay-constant
21817 gnus-score-decay-scale)))))))
21818 (if (and (featurep 'xemacs)
21819 ;; XEmacs' floor can handle only the floating point
21820 ;; number below the half of the maximum integer.
21821 (> (abs n) (lsh -1 -2)))
21823 (car (split-string (number-to-string n) "\\.")))
21827 @vindex gnus-score-decay-scale
21828 @vindex gnus-score-decay-constant
21829 @code{gnus-score-decay-constant} is 3 by default and
21830 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
21834 Scores between -3 and 3 will be set to 0 when this function is called.
21837 Scores with magnitudes between 3 and 60 will be shrunk by 3.
21840 Scores with magnitudes greater than 60 will be shrunk by 5% of the
21844 If you don't like this decay function, write your own. It is called
21845 with the score to be decayed as its only parameter, and it should return
21846 the new score, which should be an integer.
21848 Gnus will try to decay scores once a day. If you haven't run Gnus for
21849 four days, Gnus will decay the scores four times, for instance.
21854 @include message.texi
21855 @chapter Emacs MIME
21856 @include emacs-mime.texi
21858 @include sieve.texi
21870 * Process/Prefix:: A convention used by many treatment commands.
21871 * Interactive:: Making Gnus ask you many questions.
21872 * Symbolic Prefixes:: How to supply some Gnus functions with options.
21873 * Formatting Variables:: You can specify what buffers should look like.
21874 * Window Layout:: Configuring the Gnus buffer windows.
21875 * Faces and Fonts:: How to change how faces look.
21876 * Compilation:: How to speed Gnus up.
21877 * Mode Lines:: Displaying information in the mode lines.
21878 * Highlighting and Menus:: Making buffers look all nice and cozy.
21879 * Buttons:: Get tendinitis in ten easy steps!
21880 * Daemons:: Gnus can do things behind your back.
21881 * NoCeM:: How to avoid spam and other fatty foods.
21882 * Undo:: Some actions can be undone.
21883 * Predicate Specifiers:: Specifying predicates.
21884 * Moderation:: What to do if you're a moderator.
21885 * Fetching a Group:: Starting Gnus just to read a group.
21886 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
21887 * Fuzzy Matching:: What's the big fuzz?
21888 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
21889 * Spam Package:: A package for filtering and processing spam.
21890 * Other modes:: Interaction with other modes.
21891 * Various Various:: Things that are really various.
21895 @node Process/Prefix
21896 @section Process/Prefix
21897 @cindex process/prefix convention
21899 Many functions, among them functions for moving, decoding and saving
21900 articles, use what is known as the @dfn{Process/Prefix convention}.
21902 This is a method for figuring out what articles the user wants the
21903 command to be performed on.
21907 If the numeric prefix is N, perform the operation on the next N
21908 articles, starting with the current one. If the numeric prefix is
21909 negative, perform the operation on the previous N articles, starting
21910 with the current one.
21912 @vindex transient-mark-mode
21913 If @code{transient-mark-mode} in non-@code{nil} and the region is
21914 active, all articles in the region will be worked upon.
21916 If there is no numeric prefix, but some articles are marked with the
21917 process mark, perform the operation on the articles marked with
21920 If there is neither a numeric prefix nor any articles marked with the
21921 process mark, just perform the operation on the current article.
21923 Quite simple, really, but it needs to be made clear so that surprises
21926 Commands that react to the process mark will push the current list of
21927 process marked articles onto a stack and will then clear all process
21928 marked articles. You can restore the previous configuration with the
21929 @kbd{M P y} command (@pxref{Setting Process Marks}).
21931 @vindex gnus-summary-goto-unread
21932 One thing that seems to shock & horrify lots of people is that, for
21933 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
21934 Since each @kbd{d} (which marks the current article as read) by default
21935 goes to the next unread article after marking, this means that @kbd{3 d}
21936 will mark the next three unread articles as read, no matter what the
21937 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
21938 @code{nil} for a more straightforward action.
21940 Many commands do not use the process/prefix convention. All commands
21941 that do explicitly say so in this manual. To apply the process/prefix
21942 convention to commands that do not use it, you can use the @kbd{M-&}
21943 command. For instance, to mark all the articles in the group as
21944 expirable, you could say @kbd{M P b M-& E}.
21948 @section Interactive
21949 @cindex interaction
21953 @item gnus-novice-user
21954 @vindex gnus-novice-user
21955 If this variable is non-@code{nil}, you are either a newcomer to the
21956 World of Usenet, or you are very cautious, which is a nice thing to be,
21957 really. You will be given questions of the type ``Are you sure you want
21958 to do this?'' before doing anything dangerous. This is @code{t} by
21961 @item gnus-expert-user
21962 @vindex gnus-expert-user
21963 If this variable is non-@code{nil}, you will seldom be asked any
21964 questions by Gnus. It will simply assume you know what you're doing, no
21965 matter how strange.
21967 @item gnus-interactive-catchup
21968 @vindex gnus-interactive-catchup
21969 Require confirmation before catching up a group if non-@code{nil}. It
21970 is @code{t} by default.
21972 @item gnus-interactive-exit
21973 @vindex gnus-interactive-exit
21974 Require confirmation before exiting Gnus. This variable is @code{t} by
21979 @node Symbolic Prefixes
21980 @section Symbolic Prefixes
21981 @cindex symbolic prefixes
21983 Quite a lot of Emacs commands react to the (numeric) prefix. For
21984 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
21985 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
21986 rule of 900 to the current article.
21988 This is all nice and well, but what if you want to give a command some
21989 additional information? Well, what most commands do is interpret the
21990 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
21991 doesn't want a backup file to be created when saving the current buffer,
21992 for instance. But what if you want to save without making a backup
21993 file, and you want Emacs to flash lights and play a nice tune at the
21994 same time? You can't, and you're probably perfectly happy that way.
21996 @kindex M-i (Summary)
21997 @findex gnus-symbolic-argument
21998 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
21999 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
22000 character typed in is the value. You can stack as many @kbd{M-i}
22001 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
22002 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
22003 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
22004 @code{b}''. You get the drift.
22006 Typing in symbolic prefixes to commands that don't accept them doesn't
22007 hurt, but it doesn't do any good either. Currently not many Gnus
22008 functions make use of the symbolic prefix.
22010 If you're interested in how Gnus implements this, @pxref{Extended
22014 @node Formatting Variables
22015 @section Formatting Variables
22016 @cindex formatting variables
22018 Throughout this manual you've probably noticed lots of variables called
22019 things like @code{gnus-group-line-format} and
22020 @code{gnus-summary-mode-line-format}. These control how Gnus is to
22021 output lines in the various buffers. There's quite a lot of them.
22022 Fortunately, they all use the same syntax, so there's not that much to
22025 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
22026 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
22027 lots of percentages everywhere.
22030 * Formatting Basics:: A formatting variable is basically a format string.
22031 * Mode Line Formatting:: Some rules about mode line formatting variables.
22032 * Advanced Formatting:: Modifying output in various ways.
22033 * User-Defined Specs:: Having Gnus call your own functions.
22034 * Formatting Fonts:: Making the formatting look colorful and nice.
22035 * Positioning Point:: Moving point to a position after an operation.
22036 * Tabulation:: Tabulating your output.
22037 * Wide Characters:: Dealing with wide characters.
22040 Currently Gnus uses the following formatting variables:
22041 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
22042 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
22043 @code{gnus-group-mode-line-format},
22044 @code{gnus-summary-mode-line-format},
22045 @code{gnus-article-mode-line-format},
22046 @code{gnus-server-mode-line-format}, and
22047 @code{gnus-summary-pick-line-format}.
22049 All these format variables can also be arbitrary elisp forms. In that
22050 case, they will be @code{eval}ed to insert the required lines.
22052 @kindex M-x gnus-update-format
22053 @findex gnus-update-format
22054 Gnus includes a command to help you while creating your own format
22055 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
22056 update the spec in question and pop you to a buffer where you can
22057 examine the resulting Lisp code to be run to generate the line.
22061 @node Formatting Basics
22062 @subsection Formatting Basics
22064 Each @samp{%} element will be replaced by some string or other when the
22065 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
22066 spec, and pad with spaces to get a 5-character field''.
22068 As with normal C and Emacs Lisp formatting strings, the numerical
22069 modifier between the @samp{%} and the formatting type character will
22070 @dfn{pad} the output so that it is always at least that long.
22071 @samp{%5y} will make the field always (at least) five characters wide by
22072 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
22075 You may also wish to limit the length of the field to protect against
22076 particularly wide values. For that you can say @samp{%4,6y}, which
22077 means that the field will never be more than 6 characters wide and never
22078 less than 4 characters wide.
22080 Also Gnus supports some extended format specifications, such as
22081 @samp{%&user-date;}.
22084 @node Mode Line Formatting
22085 @subsection Mode Line Formatting
22087 Mode line formatting variables (e.g.,
22088 @code{gnus-summary-mode-line-format}) follow the same rules as other,
22089 buffer line oriented formatting variables (@pxref{Formatting Basics})
22090 with the following two differences:
22095 There must be no newline (@samp{\n}) at the end.
22098 The special @samp{%%b} spec can be used to display the buffer name.
22099 Well, it's no spec at all, really---@samp{%%} is just a way to quote
22100 @samp{%} to allow it to pass through the formatting machinery unmangled,
22101 so that Emacs receives @samp{%b}, which is something the Emacs mode line
22102 display interprets to mean ``show the buffer name''. For a full list of
22103 mode line specs Emacs understands, see the documentation of the
22104 @code{mode-line-format} variable.
22109 @node Advanced Formatting
22110 @subsection Advanced Formatting
22112 It is frequently useful to post-process the fields in some way.
22113 Padding, limiting, cutting off parts and suppressing certain values can
22114 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
22115 look like @samp{%~(cut 3)~(ignore "0")y}.
22117 These are the valid modifiers:
22122 Pad the field to the left with spaces until it reaches the required
22126 Pad the field to the right with spaces until it reaches the required
22131 Cut off characters from the left until it reaches the specified length.
22134 Cut off characters from the right until it reaches the specified
22139 Cut off the specified number of characters from the left.
22142 Cut off the specified number of characters from the right.
22145 Return an empty string if the field is equal to the specified value.
22148 Use the specified form as the field value when the @samp{@@} spec is
22154 "~(form (current-time-string))@@"
22159 Let's take an example. The @samp{%o} spec in the summary mode lines
22160 will return a date in compact ISO8601 format---@samp{19960809T230410}.
22161 This is quite a mouthful, so we want to shave off the century number and
22162 the time, leaving us with a six-character date. That would be
22163 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
22164 maxing, and we need the padding to ensure that the date is never less
22165 than 6 characters to make it look nice in columns.)
22167 Ignoring is done first; then cutting; then maxing; and then as the very
22168 last operation, padding.
22170 If you use lots of these advanced thingies, you'll find that Gnus gets
22171 quite slow. This can be helped enormously by running @kbd{M-x
22172 gnus-compile} when you are satisfied with the look of your lines.
22173 @xref{Compilation}.
22176 @node User-Defined Specs
22177 @subsection User-Defined Specs
22179 All the specs allow for inserting user defined specifiers---@samp{u}.
22180 The next character in the format string should be a letter. Gnus
22181 will call the function @code{gnus-user-format-function-}@samp{X}, where
22182 @samp{X} is the letter following @samp{%u}. The function will be passed
22183 a single parameter---what the parameter means depends on what buffer
22184 it's being called from. The function should return a string, which will
22185 be inserted into the buffer just like information from any other
22186 specifier. This function may also be called with dummy values, so it
22187 should protect against that.
22189 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
22190 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
22192 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
22193 much the same without defining new functions. Here's an example:
22194 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
22195 given here will be evaluated to yield the current line number, and then
22199 @node Formatting Fonts
22200 @subsection Formatting Fonts
22202 There are specs for highlighting, and these are shared by all the format
22203 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
22204 the special @code{mouse-face} property set, which means that it will be
22205 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
22208 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
22209 normal faces set using @code{gnus-face-0}, which is @code{bold} by
22210 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
22211 and so on. Create as many faces as you wish. The same goes for the
22212 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
22213 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
22215 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
22216 special @code{balloon-help} property set to
22217 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
22218 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
22219 variables should be either strings or symbols naming functions that
22220 return a string. When the mouse passes over text with this property
22221 set, a balloon window will appear and display the string. Please
22222 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
22223 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
22224 XEmacs) for more information on this. (For technical reasons, the
22225 guillemets have been approximated as @samp{<<} and @samp{>>} in this
22228 Here's an alternative recipe for the group buffer:
22231 ;; @r{Create three face types.}
22232 (setq gnus-face-1 'bold)
22233 (setq gnus-face-3 'italic)
22235 ;; @r{We want the article count to be in}
22236 ;; @r{a bold and green face. So we create}
22237 ;; @r{a new face called @code{my-green-bold}.}
22238 (copy-face 'bold 'my-green-bold)
22239 ;; @r{Set the color.}
22240 (set-face-foreground 'my-green-bold "ForestGreen")
22241 (setq gnus-face-2 'my-green-bold)
22243 ;; @r{Set the new & fancy format.}
22244 (setq gnus-group-line-format
22245 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
22248 I'm sure you'll be able to use this scheme to create totally unreadable
22249 and extremely vulgar displays. Have fun!
22251 Note that the @samp{%(} specs (and friends) do not make any sense on the
22252 mode-line variables.
22254 @node Positioning Point
22255 @subsection Positioning Point
22257 Gnus usually moves point to a pre-defined place on each line in most
22258 buffers. By default, point move to the first colon character on the
22259 line. You can customize this behavior in three different ways.
22261 You can move the colon character to somewhere else on the line.
22263 @findex gnus-goto-colon
22264 You can redefine the function that moves the point to the colon. The
22265 function is called @code{gnus-goto-colon}.
22267 But perhaps the most convenient way to deal with this, if you don't want
22268 to have a colon in your line, is to use the @samp{%*} specifier. If you
22269 put a @samp{%*} somewhere in your format line definition, Gnus will
22274 @subsection Tabulation
22276 You can usually line up your displays by padding and cutting your
22277 strings. However, when combining various strings of different size, it
22278 can often be more convenient to just output the strings, and then worry
22279 about lining up the following text afterwards.
22281 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
22282 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
22284 @samp{%50=} will insert space characters to pad the line up to column
22285 50. If the text is already past column 50, nothing will be inserted.
22286 This is the soft tabulator.
22288 @samp{%-50=} will insert space characters to pad the line up to column
22289 50. If the text is already past column 50, the excess text past column
22290 50 will be removed. This is the hard tabulator.
22293 @node Wide Characters
22294 @subsection Wide Characters
22296 Fixed width fonts in most countries have characters of the same width.
22297 Some countries, however, use Latin characters mixed with wider
22298 characters---most notable East Asian countries.
22300 The problem is that when formatting, Gnus assumes that if a string is 10
22301 characters wide, it'll be 10 Latin characters wide on the screen. In
22302 these countries, that's not true.
22304 @vindex gnus-use-correct-string-widths
22305 To help fix this, you can set @code{gnus-use-correct-string-widths} to
22306 @code{t}. This makes buffer generation slower, but the results will be
22307 prettier. The default value under XEmacs is @code{t} but @code{nil}
22311 @node Window Layout
22312 @section Window Layout
22313 @cindex window layout
22315 No, there's nothing here about X, so be quiet.
22317 @vindex gnus-use-full-window
22318 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
22319 other windows and occupy the entire Emacs screen by itself. It is
22320 @code{t} by default.
22322 Setting this variable to @code{nil} kinda works, but there are
22323 glitches. Use at your own peril.
22325 @vindex gnus-buffer-configuration
22326 @code{gnus-buffer-configuration} describes how much space each Gnus
22327 buffer should be given. Here's an excerpt of this variable:
22330 ((group (vertical 1.0 (group 1.0 point)
22331 (if gnus-carpal (group-carpal 4))))
22332 (article (vertical 1.0 (summary 0.25 point)
22336 This is an alist. The @dfn{key} is a symbol that names some action or
22337 other. For instance, when displaying the group buffer, the window
22338 configuration function will use @code{group} as the key. A full list of
22339 possible names is listed below.
22341 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
22342 should occupy. To take the @code{article} split as an example -
22345 (article (vertical 1.0 (summary 0.25 point)
22349 This @dfn{split} says that the summary buffer should occupy 25% of upper
22350 half of the screen, and that it is placed over the article buffer. As
22351 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
22352 reaching for that calculator there). However, the special number
22353 @code{1.0} is used to signal that this buffer should soak up all the
22354 rest of the space available after the rest of the buffers have taken
22355 whatever they need. There should be only one buffer with the @code{1.0}
22356 size spec per split.
22358 Point will be put in the buffer that has the optional third element
22359 @code{point}. In a @code{frame} split, the last subsplit having a leaf
22360 split where the tag @code{frame-focus} is a member (i.e. is the third or
22361 fourth element in the list, depending on whether the @code{point} tag is
22362 present) gets focus.
22364 Here's a more complicated example:
22367 (article (vertical 1.0 (group 4)
22368 (summary 0.25 point)
22369 (if gnus-carpal (summary-carpal 4))
22373 If the size spec is an integer instead of a floating point number,
22374 then that number will be used to say how many lines a buffer should
22375 occupy, not a percentage.
22377 If the @dfn{split} looks like something that can be @code{eval}ed (to be
22378 precise---if the @code{car} of the split is a function or a subr), this
22379 split will be @code{eval}ed. If the result is non-@code{nil}, it will
22380 be used as a split. This means that there will be three buffers if
22381 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
22384 Not complicated enough for you? Well, try this on for size:
22387 (article (horizontal 1.0
22392 (summary 0.25 point)
22397 Whoops. Two buffers with the mystery 100% tag. And what's that
22398 @code{horizontal} thingie?
22400 If the first element in one of the split is @code{horizontal}, Gnus will
22401 split the window horizontally, giving you two windows side-by-side.
22402 Inside each of these strips you may carry on all you like in the normal
22403 fashion. The number following @code{horizontal} says what percentage of
22404 the screen is to be given to this strip.
22406 For each split, there @emph{must} be one element that has the 100% tag.
22407 The splitting is never accurate, and this buffer will eat any leftover
22408 lines from the splits.
22410 To be slightly more formal, here's a definition of what a valid split
22415 split = frame | horizontal | vertical | buffer | form
22416 frame = "(frame " size *split ")"
22417 horizontal = "(horizontal " size *split ")"
22418 vertical = "(vertical " size *split ")"
22419 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
22420 size = number | frame-params
22421 buf-name = group | article | summary ...
22425 The limitations are that the @code{frame} split can only appear as the
22426 top-level split. @var{form} should be an Emacs Lisp form that should
22427 return a valid split. We see that each split is fully recursive, and
22428 may contain any number of @code{vertical} and @code{horizontal} splits.
22430 @vindex gnus-window-min-width
22431 @vindex gnus-window-min-height
22432 @cindex window height
22433 @cindex window width
22434 Finding the right sizes can be a bit complicated. No window may be less
22435 than @code{gnus-window-min-height} (default 1) characters high, and all
22436 windows must be at least @code{gnus-window-min-width} (default 1)
22437 characters wide. Gnus will try to enforce this before applying the
22438 splits. If you want to use the normal Emacs window width/height limit,
22439 you can just set these two variables to @code{nil}.
22441 If you're not familiar with Emacs terminology, @code{horizontal} and
22442 @code{vertical} splits may work the opposite way of what you'd expect.
22443 Windows inside a @code{horizontal} split are shown side-by-side, and
22444 windows within a @code{vertical} split are shown above each other.
22446 @findex gnus-configure-frame
22447 If you want to experiment with window placement, a good tip is to call
22448 @code{gnus-configure-frame} directly with a split. This is the function
22449 that does all the real work when splitting buffers. Below is a pretty
22450 nonsensical configuration with 5 windows; two for the group buffer and
22451 three for the article buffer. (I said it was nonsensical.) If you
22452 @code{eval} the statement below, you can get an idea of how that would
22453 look straight away, without going through the normal Gnus channels.
22454 Play with it until you're satisfied, and then use
22455 @code{gnus-add-configuration} to add your new creation to the buffer
22456 configuration list.
22459 (gnus-configure-frame
22463 (article 0.3 point))
22471 You might want to have several frames as well. No prob---just use the
22472 @code{frame} split:
22475 (gnus-configure-frame
22478 (summary 0.25 point frame-focus)
22480 (vertical ((height . 5) (width . 15)
22481 (user-position . t)
22482 (left . -1) (top . 1))
22487 This split will result in the familiar summary/article window
22488 configuration in the first (or ``main'') frame, while a small additional
22489 frame will be created where picons will be shown. As you can see,
22490 instead of the normal @code{1.0} top-level spec, each additional split
22491 should have a frame parameter alist as the size spec.
22492 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
22493 Reference Manual}. Under XEmacs, a frame property list will be
22494 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
22496 The list of all possible keys for @code{gnus-buffer-configuration} can
22497 be found in its default value.
22499 Note that the @code{message} key is used for both
22500 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
22501 it is desirable to distinguish between the two, something like this
22505 (message (horizontal 1.0
22506 (vertical 1.0 (message 1.0 point))
22508 (if (buffer-live-p gnus-summary-buffer)
22513 One common desire for a multiple frame split is to have a separate frame
22514 for composing mail and news while leaving the original frame intact. To
22515 accomplish that, something like the following can be done:
22520 (if (not (buffer-live-p gnus-summary-buffer))
22521 (car (cdr (assoc 'group gnus-buffer-configuration)))
22522 (car (cdr (assoc 'summary gnus-buffer-configuration))))
22523 (vertical ((user-position . t) (top . 1) (left . 1)
22524 (name . "Message"))
22525 (message 1.0 point))))
22528 @findex gnus-add-configuration
22529 Since the @code{gnus-buffer-configuration} variable is so long and
22530 complicated, there's a function you can use to ease changing the config
22531 of a single setting: @code{gnus-add-configuration}. If, for instance,
22532 you want to change the @code{article} setting, you could say:
22535 (gnus-add-configuration
22536 '(article (vertical 1.0
22538 (summary .25 point)
22542 You'd typically stick these @code{gnus-add-configuration} calls in your
22543 @file{~/.gnus.el} file or in some startup hook---they should be run after
22544 Gnus has been loaded.
22546 @vindex gnus-always-force-window-configuration
22547 If all windows mentioned in the configuration are already visible, Gnus
22548 won't change the window configuration. If you always want to force the
22549 ``right'' window configuration, you can set
22550 @code{gnus-always-force-window-configuration} to non-@code{nil}.
22552 If you're using tree displays (@pxref{Tree Display}), and the tree
22553 window is displayed vertically next to another window, you may also want
22554 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
22557 @subsection Example Window Configurations
22561 Narrow left hand side occupied by group buffer. Right hand side split
22562 between summary buffer (top one-sixth) and article buffer (bottom).
22577 (gnus-add-configuration
22580 (vertical 25 (group 1.0))
22582 (summary 0.16 point)
22585 (gnus-add-configuration
22588 (vertical 25 (group 1.0))
22589 (vertical 1.0 (summary 1.0 point)))))
22595 @node Faces and Fonts
22596 @section Faces and Fonts
22601 Fiddling with fonts and faces used to be very difficult, but these days
22602 it is very simple. You simply say @kbd{M-x customize-face}, pick out
22603 the face you want to alter, and alter it via the standard Customize
22608 @section Compilation
22609 @cindex compilation
22610 @cindex byte-compilation
22612 @findex gnus-compile
22614 Remember all those line format specification variables?
22615 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
22616 on. Now, Gnus will of course heed whatever these variables are, but,
22617 unfortunately, changing them will mean a quite significant slow-down.
22618 (The default values of these variables have byte-compiled functions
22619 associated with them, while the user-generated versions do not, of
22622 To help with this, you can run @kbd{M-x gnus-compile} after you've
22623 fiddled around with the variables and feel that you're (kind of)
22624 satisfied. This will result in the new specs being byte-compiled, and
22625 you'll get top speed again. Gnus will save these compiled specs in the
22626 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
22627 this function, though---you should compile them yourself by sticking
22628 them into the @file{~/.gnus.el} file and byte-compiling that file.)
22632 @section Mode Lines
22635 @vindex gnus-updated-mode-lines
22636 @code{gnus-updated-mode-lines} says what buffers should keep their mode
22637 lines updated. It is a list of symbols. Supported symbols include
22638 @code{group}, @code{article}, @code{summary}, @code{server},
22639 @code{browse}, and @code{tree}. If the corresponding symbol is present,
22640 Gnus will keep that mode line updated with information that may be
22641 pertinent. If this variable is @code{nil}, screen refresh may be
22644 @cindex display-time
22646 @vindex gnus-mode-non-string-length
22647 By default, Gnus displays information on the current article in the mode
22648 lines of the summary and article buffers. The information Gnus wishes
22649 to display (e.g. the subject of the article) is often longer than the
22650 mode lines, and therefore have to be cut off at some point. The
22651 @code{gnus-mode-non-string-length} variable says how long the other
22652 elements on the line is (i.e., the non-info part). If you put
22653 additional elements on the mode line (e.g. a clock), you should modify
22656 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
22658 (add-hook 'display-time-hook
22659 (lambda () (setq gnus-mode-non-string-length
22661 (if line-number-mode 5 0)
22662 (if column-number-mode 4 0)
22663 (length display-time-string)))))
22666 If this variable is @code{nil} (which is the default), the mode line
22667 strings won't be chopped off, and they won't be padded either. Note
22668 that the default is unlikely to be desirable, as even the percentage
22669 complete in the buffer may be crowded off the mode line; the user should
22670 configure this variable appropriately for her configuration.
22673 @node Highlighting and Menus
22674 @section Highlighting and Menus
22676 @cindex highlighting
22679 @vindex gnus-visual
22680 The @code{gnus-visual} variable controls most of the Gnus-prettifying
22681 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
22682 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
22685 This variable can be a list of visual properties that are enabled. The
22686 following elements are valid, and are all included by default:
22689 @item group-highlight
22690 Do highlights in the group buffer.
22691 @item summary-highlight
22692 Do highlights in the summary buffer.
22693 @item article-highlight
22694 Do highlights in the article buffer.
22696 Turn on highlighting in all buffers.
22698 Create menus in the group buffer.
22700 Create menus in the summary buffers.
22702 Create menus in the article buffer.
22704 Create menus in the browse buffer.
22706 Create menus in the server buffer.
22708 Create menus in the score buffers.
22710 Create menus in all buffers.
22713 So if you only want highlighting in the article buffer and menus in all
22714 buffers, you could say something like:
22717 (setq gnus-visual '(article-highlight menu))
22720 If you want highlighting only and no menus whatsoever, you'd say:
22723 (setq gnus-visual '(highlight))
22726 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
22727 in all Gnus buffers.
22729 Other general variables that influence the look of all buffers include:
22732 @item gnus-mouse-face
22733 @vindex gnus-mouse-face
22734 This is the face (i.e., font) used for mouse highlighting in Gnus. No
22735 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
22739 There are hooks associated with the creation of all the different menus:
22743 @item gnus-article-menu-hook
22744 @vindex gnus-article-menu-hook
22745 Hook called after creating the article mode menu.
22747 @item gnus-group-menu-hook
22748 @vindex gnus-group-menu-hook
22749 Hook called after creating the group mode menu.
22751 @item gnus-summary-menu-hook
22752 @vindex gnus-summary-menu-hook
22753 Hook called after creating the summary mode menu.
22755 @item gnus-server-menu-hook
22756 @vindex gnus-server-menu-hook
22757 Hook called after creating the server mode menu.
22759 @item gnus-browse-menu-hook
22760 @vindex gnus-browse-menu-hook
22761 Hook called after creating the browse mode menu.
22763 @item gnus-score-menu-hook
22764 @vindex gnus-score-menu-hook
22765 Hook called after creating the score mode menu.
22776 Those new-fangled @dfn{mouse} contraptions is very popular with the
22777 young, hep kids who don't want to learn the proper way to do things
22778 these days. Why, I remember way back in the summer of '89, when I was
22779 using Emacs on a Tops 20 system. Three hundred users on one single
22780 machine, and every user was running Simula compilers. Bah!
22784 @vindex gnus-carpal
22785 Well, you can make Gnus display bufferfuls of buttons you can click to
22786 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
22787 really. Tell the chiropractor I sent you.
22792 @item gnus-carpal-mode-hook
22793 @vindex gnus-carpal-mode-hook
22794 Hook run in all carpal mode buffers.
22796 @item gnus-carpal-button-face
22797 @vindex gnus-carpal-button-face
22798 Face used on buttons.
22800 @item gnus-carpal-header-face
22801 @vindex gnus-carpal-header-face
22802 Face used on carpal buffer headers.
22804 @item gnus-carpal-group-buffer-buttons
22805 @vindex gnus-carpal-group-buffer-buttons
22806 Buttons in the group buffer.
22808 @item gnus-carpal-summary-buffer-buttons
22809 @vindex gnus-carpal-summary-buffer-buttons
22810 Buttons in the summary buffer.
22812 @item gnus-carpal-server-buffer-buttons
22813 @vindex gnus-carpal-server-buffer-buttons
22814 Buttons in the server buffer.
22816 @item gnus-carpal-browse-buffer-buttons
22817 @vindex gnus-carpal-browse-buffer-buttons
22818 Buttons in the browse buffer.
22821 All the @code{buttons} variables are lists. The elements in these list
22822 are either cons cells where the @code{car} contains a text to be displayed and
22823 the @code{cdr} contains a function symbol, or a simple string.
22831 Gnus, being larger than any program ever written (allegedly), does lots
22832 of strange stuff that you may wish to have done while you're not
22833 present. For instance, you may want it to check for new mail once in a
22834 while. Or you may want it to close down all connections to all servers
22835 when you leave Emacs idle. And stuff like that.
22837 Gnus will let you do stuff like that by defining various
22838 @dfn{handlers}. Each handler consists of three elements: A
22839 @var{function}, a @var{time}, and an @var{idle} parameter.
22841 Here's an example of a handler that closes connections when Emacs has
22842 been idle for thirty minutes:
22845 (gnus-demon-close-connections nil 30)
22848 Here's a handler that scans for @acronym{PGP} headers every hour when
22852 (gnus-demon-scan-pgp 60 t)
22855 This @var{time} parameter and that @var{idle} parameter work together
22856 in a strange, but wonderful fashion. Basically, if @var{idle} is
22857 @code{nil}, then the function will be called every @var{time} minutes.
22859 If @var{idle} is @code{t}, then the function will be called after
22860 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
22861 the function will never be called. But once Emacs goes idle, the
22862 function will be called every @var{time} minutes.
22864 If @var{idle} is a number and @var{time} is a number, the function will
22865 be called every @var{time} minutes only when Emacs has been idle for
22866 @var{idle} minutes.
22868 If @var{idle} is a number and @var{time} is @code{nil}, the function
22869 will be called once every time Emacs has been idle for @var{idle}
22872 And if @var{time} is a string, it should look like @samp{07:31}, and
22873 the function will then be called once every day somewhere near that
22874 time. Modified by the @var{idle} parameter, of course.
22876 @vindex gnus-demon-timestep
22877 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
22878 seconds. This is 60 by default. If you change that variable,
22879 all the timings in the handlers will be affected.)
22881 So, if you want to add a handler, you could put something like this in
22882 your @file{~/.gnus.el} file:
22884 @findex gnus-demon-add-handler
22886 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
22889 @findex gnus-demon-add-nocem
22890 @findex gnus-demon-add-scanmail
22891 @findex gnus-demon-add-rescan
22892 @findex gnus-demon-add-scan-timestamps
22893 @findex gnus-demon-add-disconnection
22894 Some ready-made functions to do this have been created:
22895 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
22896 @code{gnus-demon-add-nntp-close-connection},
22897 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
22898 @code{gnus-demon-add-scanmail}. Just put those functions in your
22899 @file{~/.gnus.el} if you want those abilities.
22901 @findex gnus-demon-init
22902 @findex gnus-demon-cancel
22903 @vindex gnus-demon-handlers
22904 If you add handlers to @code{gnus-demon-handlers} directly, you should
22905 run @code{gnus-demon-init} to make the changes take hold. To cancel all
22906 daemons, you can use the @code{gnus-demon-cancel} function.
22908 Note that adding daemons can be pretty naughty if you over do it. Adding
22909 functions that scan all news and mail from all servers every two seconds
22910 is a sure-fire way of getting booted off any respectable system. So
22919 @dfn{Spamming} is posting the same article lots and lots of times.
22920 Spamming is bad. Spamming is evil.
22922 Spamming is usually canceled within a day or so by various anti-spamming
22923 agencies. These agencies usually also send out @dfn{NoCeM} messages.
22924 NoCeM is pronounced ``no see-'em'', and means what the name
22925 implies---these are messages that make the offending articles, like, go
22928 What use are these NoCeM messages if the articles are canceled anyway?
22929 Some sites do not honor cancel messages and some sites just honor cancels
22930 from a select few people. Then you may wish to make use of the NoCeM
22931 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
22933 Gnus can read and parse the messages in this group automatically, and
22934 this will make spam disappear.
22936 There are some variables to customize, of course:
22939 @item gnus-use-nocem
22940 @vindex gnus-use-nocem
22941 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
22944 You can also set this variable to a positive number as a group level.
22945 In that case, Gnus scans NoCeM messages when checking new news if this
22946 value is not exceeding a group level that you specify as the prefix
22947 argument to some commands, e.g. @code{gnus},
22948 @code{gnus-group-get-new-news}, etc. Otherwise, Gnus does not scan
22949 NoCeM messages if you specify a group level to those commands. For
22950 example, if you use 1 or 2 on the mail groups and the levels on the news
22951 groups remain the default, 3 is the best choice.
22953 @item gnus-nocem-groups
22954 @vindex gnus-nocem-groups
22955 Gnus will look for NoCeM messages in the groups in this list. The
22958 ("news.lists.filters" "news.admin.net-abuse.bulletins"
22959 "alt.nocem.misc" "news.admin.net-abuse.announce")
22962 @item gnus-nocem-issuers
22963 @vindex gnus-nocem-issuers
22964 There are many people issuing NoCeM messages. This list says what
22965 people you want to listen to. The default is
22967 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
22968 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
22970 fine, upstanding citizens all of them.
22972 Known despammers that you can put in this list are listed at@*
22973 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
22975 You do not have to heed NoCeM messages from all these people---just the
22976 ones you want to listen to. You also don't have to accept all NoCeM
22977 messages from the people you like. Each NoCeM message has a @dfn{type}
22978 header that gives the message a (more or less, usually less) rigorous
22979 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
22980 @samp{binary}, and @samp{troll}. To specify this, you have to use
22981 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
22982 Each condition is either a string (which is a regexp that matches types
22983 you want to use) or a list on the form @code{(not @var{string})}, where
22984 @var{string} is a regexp that matches types you don't want to use.
22986 For instance, if you want all NoCeM messages from Chris Lewis except his
22987 @samp{troll} messages, you'd say:
22990 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
22993 On the other hand, if you just want nothing but his @samp{spam} and
22994 @samp{spew} messages, you'd say:
22997 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
23000 The specs are applied left-to-right.
23003 @item gnus-nocem-verifyer
23004 @vindex gnus-nocem-verifyer
23006 This should be a function for verifying that the NoCeM issuer is who she
23007 says she is. The default is @code{pgg-verify}, which returns
23008 non-@code{nil} if the verification is successful, otherwise (including
23009 the case the NoCeM message was not signed) returns @code{nil}. If this
23010 is too slow and you don't care for verification (which may be dangerous),
23011 you can set this variable to @code{nil}.
23013 Formerly the default was @code{mc-verify}, which is a Mailcrypt
23014 function. While you can still use it, you can change it into
23015 @code{pgg-verify} running with GnuPG if you are willing to add the
23016 @acronym{PGP} public keys to GnuPG's keyring.
23018 @item gnus-nocem-directory
23019 @vindex gnus-nocem-directory
23020 This is where Gnus will store its NoCeM cache files. The default is@*
23021 @file{~/News/NoCeM/}.
23023 @item gnus-nocem-expiry-wait
23024 @vindex gnus-nocem-expiry-wait
23025 The number of days before removing old NoCeM entries from the cache.
23026 The default is 15. If you make it shorter Gnus will be faster, but you
23027 might then see old spam.
23029 @item gnus-nocem-check-from
23030 @vindex gnus-nocem-check-from
23031 Non-@code{nil} means check for valid issuers in message bodies.
23032 Otherwise don't bother fetching articles unless their author matches a
23033 valid issuer; that is much faster if you are selective about the
23036 @item gnus-nocem-check-article-limit
23037 @vindex gnus-nocem-check-article-limit
23038 If non-@code{nil}, the maximum number of articles to check in any NoCeM
23039 group. NoCeM groups can be huge and very slow to process.
23043 Using NoCeM could potentially be a memory hog. If you have many living
23044 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
23045 big. If this is a problem, you should kill off all (or most) of your
23046 unsubscribed groups (@pxref{Subscription Commands}).
23053 It is very useful to be able to undo actions one has done. In normal
23054 Emacs buffers, it's easy enough---you just push the @code{undo} button.
23055 In Gnus buffers, however, it isn't that simple.
23057 The things Gnus displays in its buffer is of no value whatsoever to
23058 Gnus---it's all just data designed to look nice to the user.
23059 Killing a group in the group buffer with @kbd{C-k} makes the line
23060 disappear, but that's just a side-effect of the real action---the
23061 removal of the group in question from the internal Gnus structures.
23062 Undoing something like that can't be done by the normal Emacs
23063 @code{undo} function.
23065 Gnus tries to remedy this somewhat by keeping track of what the user
23066 does and coming up with actions that would reverse the actions the user
23067 takes. When the user then presses the @code{undo} key, Gnus will run
23068 the code to reverse the previous action, or the previous actions.
23069 However, not all actions are easily reversible, so Gnus currently offers
23070 a few key functions to be undoable. These include killing groups,
23071 yanking groups, and changing the list of read articles of groups.
23072 That's it, really. More functions may be added in the future, but each
23073 added function means an increase in data to be stored, so Gnus will
23074 never be totally undoable.
23076 @findex gnus-undo-mode
23077 @vindex gnus-use-undo
23079 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
23080 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
23081 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
23082 command, which should feel kinda like the normal Emacs @code{undo}
23086 @node Predicate Specifiers
23087 @section Predicate Specifiers
23088 @cindex predicate specifiers
23090 Some Gnus variables are @dfn{predicate specifiers}. This is a special
23091 form that allows flexible specification of predicates without having
23092 to type all that much.
23094 These specifiers are lists consisting of functions, symbols and lists.
23099 (or gnus-article-unseen-p
23100 gnus-article-unread-p)
23103 The available symbols are @code{or}, @code{and} and @code{not}. The
23104 functions all take one parameter.
23106 @findex gnus-make-predicate
23107 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
23108 to create a function that can be called. This input parameter to this
23109 function will be passed along to all the functions in the predicate
23114 @section Moderation
23117 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
23118 It is not included in the standard Gnus package. Write a mail to
23119 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
23122 The moderation package is implemented as a minor mode for summary
23126 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
23129 in your @file{~/.gnus.el} file.
23131 If you are the moderator of @samp{rec.zoofle}, this is how it's
23136 You split your incoming mail by matching on
23137 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
23138 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
23141 You enter that group once in a while and post articles using the @kbd{e}
23142 (edit-and-post) or @kbd{s} (just send unedited) commands.
23145 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
23146 articles that weren't approved by you, you can cancel them with the
23150 To use moderation mode in these two groups, say:
23153 (setq gnus-moderated-list
23154 "^nnml:rec.zoofle$\\|^rec.zoofle$")
23158 @node Fetching a Group
23159 @section Fetching a Group
23160 @cindex fetching a group
23162 @findex gnus-fetch-group
23163 It is sometimes convenient to be able to just say ``I want to read this
23164 group and I don't care whether Gnus has been started or not''. This is
23165 perhaps more useful for people who write code than for users, but the
23166 command @code{gnus-fetch-group} provides this functionality in any case.
23167 It takes the group name as a parameter.
23170 @node Image Enhancements
23171 @section Image Enhancements
23173 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
23174 support images, Emacs 22 does.} and up, are able to display pictures and
23175 stuff, so Gnus has taken advantage of that.
23178 * X-Face:: Display a funky, teensy black-and-white image.
23179 * Face:: Display a funkier, teensier colored image.
23180 * Smileys:: Show all those happy faces the way they were meant to be shown.
23181 * Picons:: How to display pictures of what you're reading.
23182 * XVarious:: Other XEmacsy Gnusey variables.
23190 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
23191 depth) image that's supposed to represent the author of the message.
23192 It seems to be supported by an ever-growing number of mail and news
23196 @findex gnus-article-display-x-face
23197 @vindex gnus-article-x-face-command
23198 @vindex gnus-article-x-face-too-ugly
23206 Viewing an @code{X-Face} header either requires an Emacs that has
23207 @samp{compface} support (which most XEmacs versions have), or that you
23208 have suitable conversion or display programs installed. If your Emacs
23209 has image support the default action is to display the face before the
23210 @code{From} header. If there's no native @code{X-Face} support, Gnus
23211 will try to convert the @code{X-Face} header using external programs
23212 from the @code{pbmplus} package and friends, see below. For XEmacs it's
23213 faster if XEmacs has been compiled with @code{X-Face} support. The
23214 default action under Emacs without image support is to fork off the
23215 @code{display} program.
23217 On a GNU/Linux system, the @code{display} program is included in the
23218 ImageMagick package. For external conversion programs look for packages
23219 with names like @code{netpbm}, @code{libgr-progs} and @code{compface}.
23220 On Windows, you may use the packages @code{netpbm} and @code{compface}
23221 from @url{http://gnuwin32.sourceforge.net}. You need to add the
23222 @code{bin} directory to your @code{PATH} environment variable.
23223 @c In fact only the following DLLs and binaries seem to be required:
23224 @c compface1.dll uncompface.exe libnetpbm10.dll icontopbm.exe
23226 The variable @code{gnus-article-x-face-command} controls which programs
23227 are used to display the @code{X-Face} header. If this variable is a
23228 string, this string will be executed in a sub-shell. If it is a
23229 function, this function will be called with the face as the argument.
23230 If @code{gnus-article-x-face-too-ugly} (which is a regexp) matches the
23231 @code{From} header, the face will not be shown.
23233 (Note: @code{x-face} is used in the variable/function names, not
23241 @vindex gnus-x-face
23242 Face to show X-Face. The colors from this face are used as the
23243 foreground and background colors of the displayed X-Faces. The
23244 default colors are black and white.
23246 @item gnus-face-properties-alist
23247 @vindex gnus-face-properties-alist
23248 Alist of image types and properties applied to Face (@pxref{Face}) and
23249 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
23250 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
23251 XEmacs. Here are examples:
23254 ;; Specify the altitude of Face and X-Face images in the From header.
23255 (setq gnus-face-properties-alist
23256 '((pbm . (:face gnus-x-face :ascent 80))
23257 (png . (:ascent 80))))
23259 ;; Show Face and X-Face images as pressed buttons.
23260 (setq gnus-face-properties-alist
23261 '((pbm . (:face gnus-x-face :relief -2))
23262 (png . (:relief -2))))
23265 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
23266 Reference Manual} for the valid properties for various image types.
23267 Currently, @code{pbm} is used for X-Face images and @code{png} is used
23268 for Face images in Emacs. Only the @code{:face} property is effective
23269 on the @code{xface} image type in XEmacs if it is built with the
23270 @samp{libcompface} library.
23273 If you use posting styles, you can use an @code{x-face-file} entry in
23274 @code{gnus-posting-styles}, @xref{Posting Styles}. If you don't, Gnus
23275 provides a few convenience functions and variables to allow easier
23276 insertion of X-Face headers in outgoing messages. You also need the
23277 above mentioned ImageMagick, netpbm or other image conversion packages
23278 (depending the values of the variables below) for these functions.
23280 @findex gnus-random-x-face
23281 @vindex gnus-convert-pbm-to-x-face-command
23282 @vindex gnus-x-face-directory
23283 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
23284 @code{gnus-x-face-directory} and picks one at random, and then
23285 converts it to the X-Face format by using the
23286 @code{gnus-convert-pbm-to-x-face-command} shell command. The
23287 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
23288 header data as a string.
23290 @findex gnus-insert-random-x-face-header
23291 @code{gnus-insert-random-x-face-header} calls
23292 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
23293 randomly generated data.
23295 @findex gnus-x-face-from-file
23296 @vindex gnus-convert-image-to-x-face-command
23297 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
23298 converts the file to X-Face format by using the
23299 @code{gnus-convert-image-to-x-face-command} shell command.
23301 Here's how you would typically use the first function. Put something
23302 like the following in your @file{~/.gnus.el} file:
23305 (setq message-required-news-headers
23306 (nconc message-required-news-headers
23307 (list '(X-Face . gnus-random-x-face))))
23310 Using the last function would be something like this:
23313 (setq message-required-news-headers
23314 (nconc message-required-news-headers
23315 (list '(X-Face . (lambda ()
23316 (gnus-x-face-from-file
23317 "~/My-face.gif"))))))
23325 @c #### FIXME: faces and x-faces' implementations should really be harmonized.
23327 @code{Face} headers are essentially a funkier version of @code{X-Face}
23328 ones. They describe a 48x48 pixel colored image that's supposed to
23329 represent the author of the message.
23332 @findex gnus-article-display-face
23333 The contents of a @code{Face} header must be a base64 encoded PNG image.
23334 See @uref{http://quimby.gnus.org/circus/face/} for the precise
23337 The @code{gnus-face-properties-alist} variable affects the appearance of
23338 displayed Face images. @xref{X-Face}.
23340 Viewing an @code{Face} header requires an Emacs that is able to display
23343 @c (if (featurep 'xemacs)
23345 @c (image-type-available-p 'png))
23347 Gnus provides a few convenience functions and variables to allow
23348 easier insertion of Face headers in outgoing messages.
23350 @findex gnus-convert-png-to-face
23351 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
23352 726 bytes long, and converts it to a face.
23354 @findex gnus-face-from-file
23355 @vindex gnus-convert-image-to-face-command
23356 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
23357 converts the file to Face format by using the
23358 @code{gnus-convert-image-to-face-command} shell command.
23360 Here's how you would typically use this function. Put something like the
23361 following in your @file{~/.gnus.el} file:
23364 (setq message-required-news-headers
23365 (nconc message-required-news-headers
23366 (list '(Face . (lambda ()
23367 (gnus-face-from-file "~/face.jpg"))))))
23372 @subsection Smileys
23377 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
23382 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
23383 currently the only package that uses Smiley, it is documented here.
23385 In short---to use Smiley in Gnus, put the following in your
23386 @file{~/.gnus.el} file:
23389 (setq gnus-treat-display-smileys t)
23392 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
23393 the like---to pictures and displays those instead of the text smiley
23394 faces. The conversion is controlled by a list of regexps that matches
23395 text and maps that to file names.
23397 @vindex smiley-regexp-alist
23398 The alist used is specified by the @code{smiley-regexp-alist}
23399 variable. The first item in each element is the regexp to be matched;
23400 the second element is the regexp match group that is to be replaced by
23401 the picture; and the third element is the name of the file to be
23404 The following variables customize where Smiley will look for these
23409 @item smiley-data-directory
23410 @vindex smiley-data-directory
23411 Where Smiley will look for smiley faces files.
23413 @item gnus-smiley-file-types
23414 @vindex gnus-smiley-file-types
23415 List of suffixes on smiley file names to try.
23429 So@dots{} You want to slow down your news reader even more! This is a
23430 good way to do so. It's also a great way to impress people staring
23431 over your shoulder as you read news.
23433 What are Picons? To quote directly from the Picons Web site:
23442 @dfn{Picons} is short for ``personal icons''. They're small,
23443 constrained images used to represent users and domains on the net,
23444 organized into databases so that the appropriate image for a given
23445 e-mail address can be found. Besides users and domains, there are picon
23446 databases for Usenet newsgroups and weather forecasts. The picons are
23447 in either monochrome @code{XBM} format or color @code{XPM} and
23448 @code{GIF} formats.
23451 @vindex gnus-picon-databases
23452 For instructions on obtaining and installing the picons databases,
23453 point your Web browser at
23454 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
23456 If you are using Debian GNU/Linux, saying @samp{apt-get install
23457 picons.*} will install the picons where Gnus can find them.
23459 To enable displaying picons, simply make sure that
23460 @code{gnus-picon-databases} points to the directory containing the
23463 @vindex gnus-picon-style
23464 The variable @code{gnus-picon-style} controls how picons are displayed.
23465 If @code{inline}, the textual representation is replaced. If
23466 @code{right}, picons are added right to the textual representation.
23468 The following variables offer control over where things are located.
23472 @item gnus-picon-databases
23473 @vindex gnus-picon-databases
23474 The location of the picons database. This is a list of directories
23475 containing the @file{news}, @file{domains}, @file{users} (and so on)
23476 subdirectories. Defaults to @code{("/usr/lib/picon"
23477 "/usr/local/faces")}.
23479 @item gnus-picon-news-directories
23480 @vindex gnus-picon-news-directories
23481 List of subdirectories to search in @code{gnus-picon-databases} for
23482 newsgroups faces. @code{("news")} is the default.
23484 @item gnus-picon-user-directories
23485 @vindex gnus-picon-user-directories
23486 List of subdirectories to search in @code{gnus-picon-databases} for user
23487 faces. @code{("users" "usenix" "local" "misc")} is the default.
23489 @item gnus-picon-domain-directories
23490 @vindex gnus-picon-domain-directories
23491 List of subdirectories to search in @code{gnus-picon-databases} for
23492 domain name faces. Defaults to @code{("domains")}. Some people may
23493 want to add @samp{"unknown"} to this list.
23495 @item gnus-picon-file-types
23496 @vindex gnus-picon-file-types
23497 Ordered list of suffixes on picon file names to try. Defaults to
23498 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
23504 @subsection Various XEmacs Variables
23507 @item gnus-xmas-glyph-directory
23508 @vindex gnus-xmas-glyph-directory
23509 This is where Gnus will look for pictures. Gnus will normally
23510 auto-detect this directory, but you may set it manually if you have an
23511 unusual directory structure.
23513 @item gnus-xmas-modeline-glyph
23514 @vindex gnus-xmas-modeline-glyph
23515 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
23520 @subsubsection Toolbar
23524 @item gnus-use-toolbar
23525 @vindex gnus-use-toolbar
23526 This variable specifies the position to display the toolbar. If
23527 @code{nil}, don't display toolbars. If it is non-@code{nil}, it should
23528 be one of the symbols @code{default}, @code{top}, @code{bottom},
23529 @code{right}, and @code{left}. @code{default} means to use the default
23530 toolbar, the rest mean to display the toolbar on the place which those
23531 names show. The default is @code{default}.
23533 @item gnus-toolbar-thickness
23534 @vindex gnus-toolbar-thickness
23535 Cons of the height and the width specifying the thickness of a toolbar.
23536 The height is used for the toolbar displayed on the top or the bottom,
23537 the width is used for the toolbar displayed on the right or the left.
23538 The default is that of the default toolbar.
23540 @item gnus-group-toolbar
23541 @vindex gnus-group-toolbar
23542 The toolbar in the group buffer.
23544 @item gnus-summary-toolbar
23545 @vindex gnus-summary-toolbar
23546 The toolbar in the summary buffer.
23548 @item gnus-summary-mail-toolbar
23549 @vindex gnus-summary-mail-toolbar
23550 The toolbar in the summary buffer of mail groups.
23561 @node Fuzzy Matching
23562 @section Fuzzy Matching
23563 @cindex fuzzy matching
23565 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
23566 things like scoring, thread gathering and thread comparison.
23568 As opposed to regular expression matching, fuzzy matching is very fuzzy.
23569 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
23570 means, and the implementation has changed over time.
23572 Basically, it tries to remove all noise from lines before comparing.
23573 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
23574 out of the strings before comparing the results. This often leads to
23575 adequate results---even when faced with strings generated by text
23576 manglers masquerading as newsreaders.
23579 @node Thwarting Email Spam
23580 @section Thwarting Email Spam
23584 @cindex unsolicited commercial email
23586 In these last days of the Usenet, commercial vultures are hanging about
23587 and grepping through news like crazy to find email addresses they can
23588 foist off their scams and products to. As a reaction to this, many
23589 people have started putting nonsense addresses into their @code{From}
23590 lines. I think this is counterproductive---it makes it difficult for
23591 people to send you legitimate mail in response to things you write, as
23592 well as making it difficult to see who wrote what. This rewriting may
23593 perhaps be a bigger menace than the unsolicited commercial email itself
23596 The biggest problem I have with email spam is that it comes in under
23597 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
23598 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
23599 mail group, only to find two pyramid schemes, seven advertisements
23600 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
23601 and one mail asking me to repent and find some god.
23603 This is annoying. Here's what you can do about it.
23606 * The problem of spam:: Some background, and some solutions
23607 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
23608 * SpamAssassin:: How to use external anti-spam tools.
23609 * Hashcash:: Reduce spam by burning CPU time.
23612 @node The problem of spam
23613 @subsection The problem of spam
23615 @cindex spam filtering approaches
23616 @cindex filtering approaches, spam
23618 @cindex unsolicited commercial email
23620 First, some background on spam.
23622 If you have access to e-mail, you are familiar with spam (technically
23623 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
23624 exists because e-mail delivery is very cheap compared to paper mail,
23625 so only a very small percentage of people need to respond to an UCE to
23626 make it worthwhile to the advertiser. Ironically, one of the most
23627 common spams is the one offering a database of e-mail addresses for
23628 further spamming. Senders of spam are usually called @emph{spammers},
23629 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
23630 @emph{morons} are in common use as well.
23632 Spam comes from a wide variety of sources. It is simply impossible to
23633 dispose of all spam without discarding useful messages. A good
23634 example is the TMDA system, which requires senders
23635 unknown to you to confirm themselves as legitimate senders before
23636 their e-mail can reach you. Without getting into the technical side
23637 of TMDA, a downside is clearly that e-mail from legitimate sources may
23638 be discarded if those sources can't or won't confirm themselves
23639 through the TMDA system. Another problem with TMDA is that it
23640 requires its users to have a basic understanding of e-mail delivery
23643 The simplest approach to filtering spam is filtering, at the mail
23644 server or when you sort through incoming mail. If you get 200 spam
23645 messages per day from @samp{random-address@@vmadmin.com}, you block
23646 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
23647 discard all messages with @samp{VIAGRA} in the message. If you get
23648 lots of spam from Bulgaria, for example, you try to filter all mail
23649 from Bulgarian IPs.
23651 This, unfortunately, is a great way to discard legitimate e-mail. The
23652 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
23653 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
23654 you should be obvious, so don't do it if you have the choice.
23656 In another instance, the very informative and useful RISKS digest has
23657 been blocked by overzealous mail filters because it @strong{contained}
23658 words that were common in spam messages. Nevertheless, in isolated
23659 cases, with great care, direct filtering of mail can be useful.
23661 Another approach to filtering e-mail is the distributed spam
23662 processing, for instance DCC implements such a system. In essence,
23663 @var{N} systems around the world agree that a machine @var{X} in
23664 Ghana, Estonia, or California is sending out spam e-mail, and these
23665 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
23666 database. The criteria for spam detection vary---it may be the number
23667 of messages sent, the content of the messages, and so on. When a user
23668 of the distributed processing system wants to find out if a message is
23669 spam, he consults one of those @var{N} systems.
23671 Distributed spam processing works very well against spammers that send
23672 a large number of messages at once, but it requires the user to set up
23673 fairly complicated checks. There are commercial and free distributed
23674 spam processing systems. Distributed spam processing has its risks as
23675 well. For instance legitimate e-mail senders have been accused of
23676 sending spam, and their web sites and mailing lists have been shut
23677 down for some time because of the incident.
23679 The statistical approach to spam filtering is also popular. It is
23680 based on a statistical analysis of previous spam messages. Usually
23681 the analysis is a simple word frequency count, with perhaps pairs of
23682 words or 3-word combinations thrown into the mix. Statistical
23683 analysis of spam works very well in most of the cases, but it can
23684 classify legitimate e-mail as spam in some cases. It takes time to
23685 run the analysis, the full message must be analyzed, and the user has
23686 to store the database of spam analysis. Statistical analysis on the
23687 server is gaining popularity. This has the advantage of letting the
23688 user Just Read Mail, but has the disadvantage that it's harder to tell
23689 the server that it has misclassified mail.
23691 Fighting spam is not easy, no matter what anyone says. There is no
23692 magic switch that will distinguish Viagra ads from Mom's e-mails.
23693 Even people are having a hard time telling spam apart from non-spam,
23694 because spammers are actively looking to fool us into thinking they
23695 are Mom, essentially. Spamming is irritating, irresponsible, and
23696 idiotic behavior from a bunch of people who think the world owes them
23697 a favor. We hope the following sections will help you in fighting the
23700 @node Anti-Spam Basics
23701 @subsection Anti-Spam Basics
23705 @cindex unsolicited commercial email
23707 One way of dealing with spam is having Gnus split out all spam into a
23708 @samp{spam} mail group (@pxref{Splitting Mail}).
23710 First, pick one (1) valid mail address that you can be reached at, and
23711 put it in your @code{From} header of all your news articles. (I've
23712 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
23713 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
23714 sysadmin whether your sendmail installation accepts keywords in the local
23715 part of the mail address.)
23718 (setq message-default-news-headers
23719 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
23722 Then put the following split rule in @code{nnmail-split-fancy}
23723 (@pxref{Fancy Mail Splitting}):
23727 (to "larsi@@trym.ifi.uio.no"
23728 (| ("subject" "re:.*" "misc")
23729 ("references" ".*@@.*" "misc")
23734 This says that all mail to this address is suspect, but if it has a
23735 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
23736 header, it's probably ok. All the rest goes to the @samp{spam} group.
23737 (This idea probably comes from Tim Pierce.)
23739 In addition, many mail spammers talk directly to your @acronym{SMTP} server
23740 and do not include your email address explicitly in the @code{To}
23741 header. Why they do this is unknown---perhaps it's to thwart this
23742 thwarting scheme? In any case, this is trivial to deal with---you just
23743 put anything not addressed to you in the @samp{spam} group by ending
23744 your fancy split rule in this way:
23749 (to "larsi" "misc")
23753 In my experience, this will sort virtually everything into the right
23754 group. You still have to check the @samp{spam} group from time to time to
23755 check for legitimate mail, though. If you feel like being a good net
23756 citizen, you can even send off complaints to the proper authorities on
23757 each unsolicited commercial email---at your leisure.
23759 This works for me. It allows people an easy way to contact me (they can
23760 just press @kbd{r} in the usual way), and I'm not bothered at all with
23761 spam. It's a win-win situation. Forging @code{From} headers to point
23762 to non-existent domains is yucky, in my opinion.
23764 Be careful with this approach. Spammers are wise to it.
23768 @subsection SpamAssassin, Vipul's Razor, DCC, etc
23769 @cindex SpamAssassin
23770 @cindex Vipul's Razor
23773 The days where the hints in the previous section were sufficient in
23774 avoiding spam are coming to an end. There are many tools out there
23775 that claim to reduce the amount of spam you get. This section could
23776 easily become outdated fast, as new products replace old, but
23777 fortunately most of these tools seem to have similar interfaces. Even
23778 though this section will use SpamAssassin as an example, it should be
23779 easy to adapt it to most other tools.
23781 Note that this section does not involve the @code{spam.el} package,
23782 which is discussed in the next section. If you don't care for all
23783 the features of @code{spam.el}, you can make do with these simple
23786 If the tool you are using is not installed on the mail server, you
23787 need to invoke it yourself. Ideas on how to use the
23788 @code{:postscript} mail source parameter (@pxref{Mail Source
23789 Specifiers}) follow.
23793 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
23797 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
23800 Once you manage to process your incoming spool somehow, thus making
23801 the mail contain e.g.@: a header indicating it is spam, you are ready to
23802 filter it out. Using normal split methods (@pxref{Splitting Mail}):
23805 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
23809 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
23812 (setq nnmail-split-methods 'nnmail-split-fancy
23813 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
23817 Some people might not like the idea of piping the mail through various
23818 programs using a @code{:prescript} (if some program is buggy, you
23819 might lose all mail). If you are one of them, another solution is to
23820 call the external tools during splitting. Example fancy split method:
23823 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
23825 (defun kevin-spamassassin ()
23829 (if (eq 1 (call-process-region (point-min) (point-max)
23830 "spamc" nil nil nil "-c"))
23834 Note that with the nnimap back end, message bodies will not be
23835 downloaded by default. You need to set
23836 @code{nnimap-split-download-body} to @code{t} to do that
23837 (@pxref{Splitting in IMAP}).
23839 That is about it. As some spam is likely to get through anyway, you
23840 might want to have a nifty function to call when you happen to read
23841 spam. And here is the nifty function:
23844 (defun my-gnus-raze-spam ()
23845 "Submit SPAM to Vipul's Razor, then mark it as expirable."
23847 (gnus-summary-show-raw-article)
23848 (gnus-summary-save-in-pipe "razor-report -f -d")
23849 (gnus-summary-mark-as-expirable 1))
23853 @subsection Hashcash
23856 A novel technique to fight spam is to require senders to do something
23857 costly and demonstrably unique for each message they send. This has
23858 the obvious drawback that you cannot rely on everyone in the world
23859 using this technique, since it is not part of the Internet standards,
23860 but it may be useful in smaller communities.
23862 While the tools in the previous section work well in practice, they
23863 work only because the tools are constantly maintained and updated as
23864 new form of spam appears. This means that a small percentage of spam
23865 will always get through. It also means that somewhere, someone needs
23866 to read lots of spam to update these tools. Hashcash avoids that, but
23867 instead prefers that everyone you contact through e-mail supports the
23868 scheme. You can view the two approaches as pragmatic vs dogmatic.
23869 The approaches have their own advantages and disadvantages, but as
23870 often in the real world, a combination of them is stronger than either
23871 one of them separately.
23874 The ``something costly'' is to burn CPU time, more specifically to
23875 compute a hash collision up to a certain number of bits. The
23876 resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header.
23877 For more details, and for the external application @code{hashcash} you
23878 need to install to use this feature, see
23879 @uref{http://www.hashcash.org/}. Even more information can be found
23880 at @uref{http://www.camram.org/}.
23882 If you wish to generate hashcash for each message you send, you can
23883 customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail
23884 Headers,message, The Message Manual}), as in:
23887 (setq message-generate-hashcash t)
23890 You will need to set up some additional variables as well:
23894 @item hashcash-default-payment
23895 @vindex hashcash-default-payment
23896 This variable indicates the default number of bits the hash collision
23897 should consist of. By default this is 20. Suggested useful values
23900 @item hashcash-payment-alist
23901 @vindex hashcash-payment-alist
23902 Some receivers may require you to spend burn more CPU time than the
23903 default. This variable contains a list of @samp{(@var{addr}
23904 @var{amount})} cells, where @var{addr} is the receiver (email address
23905 or newsgroup) and @var{amount} is the number of bits in the collision
23906 that is needed. It can also contain @samp{(@var{addr} @var{string}
23907 @var{amount})} cells, where the @var{string} is the string to use
23908 (normally the email address or newsgroup name is used).
23910 @item hashcash-path
23911 @vindex hashcash-path
23912 Where the @code{hashcash} binary is installed. This variable should
23913 be automatically set by @code{executable-find}, but if it's @code{nil}
23914 (usually because the @code{hashcash} binary is not in your path)
23915 you'll get a warning when you check hashcash payments and an error
23916 when you generate hashcash payments.
23920 Gnus can verify hashcash cookies, although this can also be done by
23921 hand customized mail filtering scripts. To verify a hashcash cookie
23922 in a message, use the @code{mail-check-payment} function in the
23923 @code{hashcash.el} library. You can also use the @code{spam.el}
23924 package with the @code{spam-use-hashcash} back end to validate hashcash
23925 cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam
23926 Hashcash Payments}).
23929 @section Spam Package
23930 @cindex spam filtering
23933 The Spam package provides Gnus with a centralized mechanism for
23934 detecting and filtering spam. It filters new mail, and processes
23935 messages according to whether they are spam or ham. (@dfn{Ham} is the
23936 name used throughout this manual to indicate non-spam messages.)
23939 * Spam Package Introduction::
23940 * Filtering Incoming Mail::
23941 * Detecting Spam in Groups::
23942 * Spam and Ham Processors::
23943 * Spam Package Configuration Examples::
23945 * Extending the Spam package::
23946 * Spam Statistics Package::
23949 @node Spam Package Introduction
23950 @subsection Spam Package Introduction
23951 @cindex spam filtering
23952 @cindex spam filtering sequence of events
23955 You must read this section to understand how the Spam package works.
23956 Do not skip, speed-read, or glance through this section.
23958 Make sure you read the section on the @code{spam.el} sequence of
23959 events. See @xref{Extending the Spam package}.
23961 @cindex spam-initialize
23962 @vindex spam-use-stat
23963 To use the Spam package, you @strong{must} first run the function
23964 @code{spam-initialize}:
23970 This autoloads @code{spam.el} and installs the various hooks necessary
23971 to let the Spam package do its job. In order to make use of the Spam
23972 package, you have to set up certain group parameters and variables,
23973 which we will describe below. All of the variables controlling the
23974 Spam package can be found in the @samp{spam} customization group.
23976 There are two ``contact points'' between the Spam package and the rest
23977 of Gnus: checking new mail for spam, and leaving a group.
23979 Checking new mail for spam is done in one of two ways: while splitting
23980 incoming mail, or when you enter a group.
23982 The first way, checking for spam while splitting incoming mail, is
23983 suited to mail back ends such as @code{nnml} or @code{nnimap}, where
23984 new mail appears in a single spool file. The Spam package processes
23985 incoming mail, and sends mail considered to be spam to a designated
23986 ``spam'' group. @xref{Filtering Incoming Mail}.
23988 The second way is suited to back ends such as @code{nntp}, which have
23989 no incoming mail spool, or back ends where the server is in charge of
23990 splitting incoming mail. In this case, when you enter a Gnus group,
23991 the unseen or unread messages in that group are checked for spam.
23992 Detected spam messages are marked as spam. @xref{Detecting Spam in
23995 @cindex spam back ends
23996 In either case, you have to tell the Spam package what method to use
23997 to detect spam messages. There are several methods, or @dfn{spam back
23998 ends} (not to be confused with Gnus back ends!) to choose from: spam
23999 ``blacklists'' and ``whitelists'', dictionary-based filters, and so
24000 forth. @xref{Spam Back Ends}.
24002 In the Gnus summary buffer, messages that have been identified as spam
24003 always appear with a @samp{$} symbol.
24005 The Spam package divides Gnus groups into three categories: ham
24006 groups, spam groups, and unclassified groups. You should mark each of
24007 the groups you subscribe to as either a ham group or a spam group,
24008 using the @code{spam-contents} group parameter (@pxref{Group
24009 Parameters}). Spam groups have a special property: when you enter a
24010 spam group, all unseen articles are marked as spam. Thus, mail split
24011 into a spam group is automatically marked as spam.
24013 Identifying spam messages is only half of the Spam package's job. The
24014 second half comes into play whenever you exit a group buffer. At this
24015 point, the Spam package does several things:
24017 First, it calls @dfn{spam and ham processors} to process the articles
24018 according to whether they are spam or ham. There is a pair of spam
24019 and ham processors associated with each spam back end, and what the
24020 processors do depends on the back end. At present, the main role of
24021 spam and ham processors is for dictionary-based spam filters: they add
24022 the contents of the messages in the group to the filter's dictionary,
24023 to improve its ability to detect future spam. The @code{spam-process}
24024 group parameter specifies what spam processors to use. @xref{Spam and
24027 If the spam filter failed to mark a spam message, you can mark it
24028 yourself, so that the message is processed as spam when you exit the
24038 @findex gnus-summary-mark-as-spam
24039 @findex gnus-summary-mark-as-spam
24040 Mark current article as spam, showing it with the @samp{$} mark
24041 (@code{gnus-summary-mark-as-spam}).
24045 Similarly, you can unmark an article if it has been erroneously marked
24046 as spam. @xref{Setting Marks}.
24048 Normally, a ham message found in a non-ham group is not processed as
24049 ham---the rationale is that it should be moved into a ham group for
24050 further processing (see below). However, you can force these articles
24051 to be processed as ham by setting
24052 @code{spam-process-ham-in-spam-groups} and
24053 @code{spam-process-ham-in-nonham-groups}.
24055 @vindex gnus-ham-process-destinations
24056 @vindex gnus-spam-process-destinations
24057 The second thing that the Spam package does when you exit a group is
24058 to move ham articles out of spam groups, and spam articles out of ham
24059 groups. Ham in a spam group is moved to the group specified by the
24060 variable @code{gnus-ham-process-destinations}, or the group parameter
24061 @code{ham-process-destination}. Spam in a ham group is moved to the
24062 group specified by the variable @code{gnus-spam-process-destinations},
24063 or the group parameter @code{spam-process-destination}. If these
24064 variables are not set, the articles are left in their current group.
24065 If an article cannot be moved (e.g., with a read-only backend such
24066 as @acronym{NNTP}), it is copied.
24068 If an article is moved to another group, it is processed again when
24069 you visit the new group. Normally, this is not a problem, but if you
24070 want each article to be processed only once, load the
24071 @code{gnus-registry.el} package and set the variable
24072 @code{spam-log-to-registry} to @code{t}. @xref{Spam Package
24073 Configuration Examples}.
24075 Normally, spam groups ignore @code{gnus-spam-process-destinations}.
24076 However, if you set @code{spam-move-spam-nonspam-groups-only} to
24077 @code{nil}, spam will also be moved out of spam groups, depending on
24078 the @code{spam-process-destination} parameter.
24080 The final thing the Spam package does is to mark spam articles as
24081 expired, which is usually the right thing to do.
24083 If all this seems confusing, don't worry. Soon it will be as natural
24084 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
24085 50 years in the future yet. Just trust us, it's not so bad.
24087 @node Filtering Incoming Mail
24088 @subsection Filtering Incoming Mail
24089 @cindex spam filtering
24090 @cindex spam filtering incoming mail
24093 To use the Spam package to filter incoming mail, you must first set up
24094 fancy mail splitting. @xref{Fancy Mail Splitting}. The Spam package
24095 defines a special splitting function that you can add to your fancy
24096 split variable (either @code{nnmail-split-fancy} or
24097 @code{nnimap-split-fancy}, depending on your mail back end):
24103 @vindex spam-split-group
24105 The @code{spam-split} function scans incoming mail according to your
24106 chosen spam back end(s), and sends messages identified as spam to a
24107 spam group. By default, the spam group is a group named @samp{spam},
24108 but you can change this by customizing @code{spam-split-group}. Make
24109 sure the contents of @code{spam-split-group} are an unqualified group
24110 name. For instance, in an @code{nnimap} server @samp{your-server},
24111 the value @samp{spam} means @samp{nnimap+your-server:spam}. The value
24112 @samp{nnimap+server:spam} is therefore wrong---it gives the group
24113 @samp{nnimap+your-server:nnimap+server:spam}.
24115 @code{spam-split} does not modify the contents of messages in any way.
24117 @vindex nnimap-split-download-body
24118 Note for IMAP users: if you use the @code{spam-check-bogofilter},
24119 @code{spam-check-ifile}, and @code{spam-check-stat} spam back ends,
24120 you should also set set the variable @code{nnimap-split-download-body}
24121 to @code{t}. These spam back ends are most useful when they can
24122 ``scan'' the full message body. By default, the nnimap back end only
24123 retrieves the message headers; @code{nnimap-split-download-body} tells
24124 it to retrieve the message bodies as well. We don't set this by
24125 default because it will slow @acronym{IMAP} down, and that is not an
24126 appropriate decision to make on behalf of the user. @xref{Splitting
24129 You have to specify one or more spam back ends for @code{spam-split}
24130 to use, by setting the @code{spam-use-*} variables. @xref{Spam Back
24131 Ends}. Normally, @code{spam-split} simply uses all the spam back ends
24132 you enabled in this way. However, you can tell @code{spam-split} to
24133 use only some of them. Why this is useful? Suppose you are using the
24134 @code{spam-use-regex-headers} and @code{spam-use-blackholes} spam back
24135 ends, and the following split rule:
24138 nnimap-split-fancy '(|
24139 (any "ding" "ding")
24141 ;; @r{default mailbox}
24146 The problem is that you want all ding messages to make it to the ding
24147 folder. But that will let obvious spam (for example, spam detected by
24148 SpamAssassin, and @code{spam-use-regex-headers}) through, when it's
24149 sent to the ding list. On the other hand, some messages to the ding
24150 list are from a mail server in the blackhole list, so the invocation
24151 of @code{spam-split} can't be before the ding rule.
24153 The solution is to let SpamAssassin headers supersede ding rules, and
24154 perform the other @code{spam-split} rules (including a second
24155 invocation of the regex-headers check) after the ding rule. This is
24156 done by passing a parameter to @code{spam-split}:
24161 ;; @r{spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
24162 (: spam-split "regex-spam" 'spam-use-regex-headers)
24163 (any "ding" "ding")
24164 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
24166 ;; @r{default mailbox}
24171 This lets you invoke specific @code{spam-split} checks depending on
24172 your particular needs, and target the results of those checks to a
24173 particular spam group. You don't have to throw all mail into all the
24174 spam tests. Another reason why this is nice is that messages to
24175 mailing lists you have rules for don't have to have resource-intensive
24176 blackhole checks performed on them. You could also specify different
24177 spam checks for your nnmail split vs. your nnimap split. Go crazy.
24179 You should set the @code{spam-use-*} variables for whatever spam back
24180 ends you intend to use. The reason is that when loading
24181 @file{spam.el}, some conditional loading is done depending on what
24182 @code{spam-use-xyz} variables you have set. @xref{Spam Back Ends}.
24184 @c @emph{TODO: spam.el needs to provide a uniform way of training all the
24185 @c statistical databases. Some have that functionality built-in, others
24188 @node Detecting Spam in Groups
24189 @subsection Detecting Spam in Groups
24191 To detect spam when visiting a group, set the group's
24192 @code{spam-autodetect} and @code{spam-autodetect-methods} group
24193 parameters. These are accessible with @kbd{G c} or @kbd{G p}, as
24194 usual (@pxref{Group Parameters}).
24196 You should set the @code{spam-use-*} variables for whatever spam back
24197 ends you intend to use. The reason is that when loading
24198 @file{spam.el}, some conditional loading is done depending on what
24199 @code{spam-use-xyz} variables you have set.
24201 By default, only unseen articles are processed for spam. You can
24202 force Gnus to recheck all messages in the group by setting the
24203 variable @code{spam-autodetect-recheck-messages} to @code{t}.
24205 If you use the @code{spam-autodetect} method of checking for spam, you
24206 can specify different spam detection methods for different groups.
24207 For instance, the @samp{ding} group may have @code{spam-use-BBDB} as
24208 the autodetection method, while the @samp{suspect} group may have the
24209 @code{spam-use-blacklist} and @code{spam-use-bogofilter} methods
24210 enabled. Unlike with @code{spam-split}, you don't have any control
24211 over the @emph{sequence} of checks, but this is probably unimportant.
24213 @node Spam and Ham Processors
24214 @subsection Spam and Ham Processors
24215 @cindex spam filtering
24216 @cindex spam filtering variables
24217 @cindex spam variables
24220 @vindex gnus-spam-process-newsgroups
24221 Spam and ham processors specify special actions to take when you exit
24222 a group buffer. Spam processors act on spam messages, and ham
24223 processors on ham messages. At present, the main role of these
24224 processors is to update the dictionaries of dictionary-based spam back
24225 ends such as Bogofilter (@pxref{Bogofilter}) and the Spam Statistics
24226 package (@pxref{Spam Statistics Filtering}).
24228 The spam and ham processors that apply to each group are determined by
24229 the group's@code{spam-process} group parameter. If this group
24230 parameter is not defined, they are determined by the variable
24231 @code{gnus-spam-process-newsgroups}.
24233 @vindex gnus-spam-newsgroup-contents
24234 Gnus learns from the spam you get. You have to collect your spam in
24235 one or more spam groups, and set or customize the variable
24236 @code{spam-junk-mailgroups} as appropriate. You can also declare
24237 groups to contain spam by setting their group parameter
24238 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
24239 by customizing the corresponding variable
24240 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
24241 parameter and the @code{gnus-spam-newsgroup-contents} variable can
24242 also be used to declare groups as @emph{ham} groups if you set their
24243 classification to @code{gnus-group-spam-classification-ham}. If
24244 groups are not classified by means of @code{spam-junk-mailgroups},
24245 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
24246 considered @emph{unclassified}. All groups are unclassified by
24249 @vindex gnus-spam-mark
24251 In spam groups, all messages are considered to be spam by default:
24252 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
24253 group. If you have seen a message, had it marked as spam, then
24254 unmarked it, it won't be marked as spam when you enter the group
24255 thereafter. You can disable that behavior, so all unread messages
24256 will get the @samp{$} mark, if you set the
24257 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
24258 should remove the @samp{$} mark when you are in the group summary
24259 buffer for every message that is not spam after all. To remove the
24260 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
24261 @kbd{d} for declaring it read the non-spam way. When you leave a
24262 group, all spam-marked (@samp{$}) articles are sent to a spam
24263 processor which will study them as spam samples.
24265 Messages may also be deleted in various other ways, and unless
24266 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
24267 and @samp{r} for default read or explicit delete, marks @samp{X} and
24268 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
24269 low scores, are all considered to be associated with articles which
24270 are not spam. This assumption might be false, in particular if you
24271 use kill files or score files as means for detecting genuine spam, you
24272 should then adjust the @code{ham-marks} group parameter.
24275 You can customize this group or topic parameter to be the list of
24276 marks you want to consider ham. By default, the list contains the
24277 deleted, read, killed, kill-filed, and low-score marks (the idea is
24278 that these articles have been read, but are not spam). It can be
24279 useful to also include the tick mark in the ham marks. It is not
24280 recommended to make the unread mark a ham mark, because it normally
24281 indicates a lack of classification. But you can do it, and we'll be
24286 You can customize this group or topic parameter to be the list of
24287 marks you want to consider spam. By default, the list contains only
24288 the spam mark. It is not recommended to change that, but you can if
24289 you really want to.
24292 When you leave @emph{any} group, regardless of its
24293 @code{spam-contents} classification, all spam-marked articles are sent
24294 to a spam processor, which will study these as spam samples. If you
24295 explicit kill a lot, you might sometimes end up with articles marked
24296 @samp{K} which you never saw, and which might accidentally contain
24297 spam. Best is to make sure that real spam is marked with @samp{$},
24300 @vindex gnus-ham-process-destinations
24301 When you leave a @emph{spam} group, all spam-marked articles are
24302 marked as expired after processing with the spam processor. This is
24303 not done for @emph{unclassified} or @emph{ham} groups. Also, any
24304 @strong{ham} articles in a spam group will be moved to a location
24305 determined by either the @code{ham-process-destination} group
24306 parameter or a match in the @code{gnus-ham-process-destinations}
24307 variable, which is a list of regular expressions matched with group
24308 names (it's easiest to customize this variable with @kbd{M-x
24309 customize-variable @key{RET} gnus-ham-process-destinations}). Each
24310 group name list is a standard Lisp list, if you prefer to customize
24311 the variable manually. If the @code{ham-process-destination}
24312 parameter is not set, ham articles are left in place. If the
24313 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
24314 set, the ham articles are marked as unread before being moved.
24316 If ham can not be moved---because of a read-only back end such as
24317 @acronym{NNTP}, for example, it will be copied.
24319 Note that you can use multiples destinations per group or regular
24320 expression! This enables you to send your ham to a regular mail
24321 group and to a @emph{ham training} group.
24323 When you leave a @emph{ham} group, all ham-marked articles are sent to
24324 a ham processor, which will study these as non-spam samples.
24326 @vindex spam-process-ham-in-spam-groups
24327 By default the variable @code{spam-process-ham-in-spam-groups} is
24328 @code{nil}. Set it to @code{t} if you want ham found in spam groups
24329 to be processed. Normally this is not done, you are expected instead
24330 to send your ham to a ham group and process it there.
24332 @vindex spam-process-ham-in-nonham-groups
24333 By default the variable @code{spam-process-ham-in-nonham-groups} is
24334 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
24335 or unclassified) groups to be processed. Normally this is not done,
24336 you are expected instead to send your ham to a ham group and process
24339 @vindex gnus-spam-process-destinations
24340 When you leave a @emph{ham} or @emph{unclassified} group, all
24341 @strong{spam} articles are moved to a location determined by either
24342 the @code{spam-process-destination} group parameter or a match in the
24343 @code{gnus-spam-process-destinations} variable, which is a list of
24344 regular expressions matched with group names (it's easiest to
24345 customize this variable with @kbd{M-x customize-variable @key{RET}
24346 gnus-spam-process-destinations}). Each group name list is a standard
24347 Lisp list, if you prefer to customize the variable manually. If the
24348 @code{spam-process-destination} parameter is not set, the spam
24349 articles are only expired. The group name is fully qualified, meaning
24350 that if you see @samp{nntp:servername} before the group name in the
24351 group buffer then you need it here as well.
24353 If spam can not be moved---because of a read-only back end such as
24354 @acronym{NNTP}, for example, it will be copied.
24356 Note that you can use multiples destinations per group or regular
24357 expression! This enables you to send your spam to multiple @emph{spam
24360 @vindex spam-log-to-registry
24361 The problem with processing ham and spam is that Gnus doesn't track
24362 this processing by default. Enable the @code{spam-log-to-registry}
24363 variable so @code{spam.el} will use @code{gnus-registry.el} to track
24364 what articles have been processed, and avoid processing articles
24365 multiple times. Keep in mind that if you limit the number of registry
24366 entries, this won't work as well as it does without a limit.
24368 @vindex spam-mark-only-unseen-as-spam
24369 Set this variable if you want only unseen articles in spam groups to
24370 be marked as spam. By default, it is set. If you set it to
24371 @code{nil}, unread articles will also be marked as spam.
24373 @vindex spam-mark-ham-unread-before-move-from-spam-group
24374 Set this variable if you want ham to be unmarked before it is moved
24375 out of the spam group. This is very useful when you use something
24376 like the tick mark @samp{!} to mark ham---the article will be placed
24377 in your @code{ham-process-destination}, unmarked as if it came fresh
24378 from the mail server.
24380 @vindex spam-autodetect-recheck-messages
24381 When autodetecting spam, this variable tells @code{spam.el} whether
24382 only unseen articles or all unread articles should be checked for
24383 spam. It is recommended that you leave it off.
24385 @node Spam Package Configuration Examples
24386 @subsection Spam Package Configuration Examples
24387 @cindex spam filtering
24388 @cindex spam filtering configuration examples
24389 @cindex spam configuration examples
24392 @subsubheading Ted's setup
24394 From Ted Zlatanov <tzz@@lifelogs.com>.
24396 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
24397 ;; @r{see @file{gnus-registry.el} for more information}
24398 (gnus-registry-initialize)
24402 spam-log-to-registry t ; @r{for spam autodetection}
24404 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
24405 ;; @r{all groups with @samp{spam} in the name contain spam}
24406 gnus-spam-newsgroup-contents
24407 '(("spam" gnus-group-spam-classification-spam))
24408 ;; @r{see documentation for these}
24409 spam-move-spam-nonspam-groups-only nil
24410 spam-mark-only-unseen-as-spam t
24411 spam-mark-ham-unread-before-move-from-spam-group t
24412 nnimap-split-rule 'nnimap-split-fancy
24413 ;; @r{understand what this does before you copy it to your own setup!}
24414 nnimap-split-fancy '(|
24415 ;; @r{trace references to parents and put in their group}
24416 (: gnus-registry-split-fancy-with-parent)
24417 ;; @r{this will catch server-side SpamAssassin tags}
24418 (: spam-split 'spam-use-regex-headers)
24419 (any "ding" "ding")
24420 ;; @r{note that spam by default will go to @samp{spam}}
24422 ;; @r{default mailbox}
24425 ;; @r{my parameters, set with @kbd{G p}}
24427 ;; @r{all nnml groups, and all nnimap groups except}
24428 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
24429 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
24430 ;; @r{because it must have been detected manually}
24432 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24434 ;; @r{all @acronym{NNTP} groups}
24435 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
24436 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
24437 ;; @r{send all spam to the training group}
24438 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24440 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
24441 ((spam-autodetect . t))
24443 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
24445 ;; @r{this is a spam group}
24446 ((spam-contents gnus-group-spam-classification-spam)
24448 ;; @r{any spam (which happens when I enter for all unseen messages,}
24449 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
24450 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
24452 (spam-process-destination "nnimap+mail.lifelogs.com:train")
24454 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
24455 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
24457 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
24458 "nnimap+mail.lifelogs.com:trainham")
24459 ;; @r{in this group, only @samp{!} marks are ham}
24461 (gnus-ticked-mark))
24462 ;; @r{remembers senders in the blacklist on the way out---this is}
24463 ;; @r{definitely not needed, it just makes me feel better}
24464 (spam-process (gnus-group-spam-exit-processor-blacklist)))
24466 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
24467 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
24468 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
24472 @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server
24473 From Reiner Steib <reiner.steib@@gmx.de>.
24475 My provider has set up bogofilter (in combination with @acronym{DCC}) on
24476 the mail server (@acronym{IMAP}). Recognized spam goes to
24477 @samp{spam.detected}, the rest goes through the normal filter rules,
24478 i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
24479 positives or negatives is done by copying or moving the article to
24480 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
24481 the server feeds those to bogofilter with the suitable ham or spam
24482 options and deletes them from the @samp{training.ham} and
24483 @samp{training.spam} folders.
24485 With the following entries in @code{gnus-parameters}, @code{spam.el}
24486 does most of the job for me:
24489 ("nnimap:spam\\.detected"
24490 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
24491 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
24492 (spam-contents gnus-group-spam-classification-spam))
24493 ("nnimap:\\(INBOX\\|other-folders\\)"
24494 (spam-process-destination . "nnimap:training.spam")
24495 (spam-contents gnus-group-spam-classification-ham))
24500 @item @b{The Spam folder:}
24502 In the folder @samp{spam.detected}, I have to check for false positives
24503 (i.e. legitimate mails, that were wrongly judged as spam by
24504 bogofilter or DCC).
24506 Because of the @code{gnus-group-spam-classification-spam} entry, all
24507 messages are marked as spam (with @code{$}). When I find a false
24508 positive, I mark the message with some other ham mark
24509 (@code{ham-marks}, @ref{Spam and Ham Processors}). On group exit,
24510 those messages are copied to both groups, @samp{INBOX} (where I want
24511 to have the article) and @samp{training.ham} (for training bogofilter)
24512 and deleted from the @samp{spam.detected} folder.
24514 The @code{gnus-article-sort-by-chars} entry simplifies detection of
24515 false positives for me. I receive lots of worms (sweN, @dots{}), that all
24516 have a similar size. Grouping them by size (i.e. chars) makes finding
24517 other false positives easier. (Of course worms aren't @i{spam}
24518 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
24519 an excellent tool for filtering those unwanted mails for me.)
24521 @item @b{Ham folders:}
24523 In my ham folders, I just hit @kbd{S x}
24524 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
24525 mail (false negative). On group exit, those messages are moved to
24526 @samp{training.spam}.
24529 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
24531 From Reiner Steib <reiner.steib@@gmx.de>.
24533 With following entry in @code{gnus-parameters}, @kbd{S x}
24534 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
24535 groups as spam and reports the to Gmane at group exit:
24539 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
24542 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
24543 because I don't read the groups directly from news.gmane.org, but
24544 through my local news server (leafnode). I.e. the article numbers are
24545 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
24546 the @code{X-Report-Spam} header to find the correct number.
24548 @node Spam Back Ends
24549 @subsection Spam Back Ends
24550 @cindex spam back ends
24552 The spam package offers a variety of back ends for detecting spam.
24553 Each back end defines a set of methods for detecting spam
24554 (@pxref{Filtering Incoming Mail}, @pxref{Detecting Spam in Groups}),
24555 and a pair of spam and ham processors (@pxref{Spam and Ham
24559 * Blacklists and Whitelists::
24560 * BBDB Whitelists::
24561 * Gmane Spam Reporting::
24562 * Anti-spam Hashcash Payments::
24564 * Regular Expressions Header Matching::
24566 * SpamAssassin back end::
24567 * ifile spam filtering::
24568 * Spam Statistics Filtering::
24572 @node Blacklists and Whitelists
24573 @subsubsection Blacklists and Whitelists
24574 @cindex spam filtering
24575 @cindex whitelists, spam filtering
24576 @cindex blacklists, spam filtering
24579 @defvar spam-use-blacklist
24581 Set this variable to @code{t} if you want to use blacklists when
24582 splitting incoming mail. Messages whose senders are in the blacklist
24583 will be sent to the @code{spam-split-group}. This is an explicit
24584 filter, meaning that it acts only on mail senders @emph{declared} to
24589 @defvar spam-use-whitelist
24591 Set this variable to @code{t} if you want to use whitelists when
24592 splitting incoming mail. Messages whose senders are not in the
24593 whitelist will be sent to the next spam-split rule. This is an
24594 explicit filter, meaning that unless someone is in the whitelist, their
24595 messages are not assumed to be spam or ham.
24599 @defvar spam-use-whitelist-exclusive
24601 Set this variable to @code{t} if you want to use whitelists as an
24602 implicit filter, meaning that every message will be considered spam
24603 unless the sender is in the whitelist. Use with care.
24607 @defvar gnus-group-spam-exit-processor-blacklist
24609 Add this symbol to a group's @code{spam-process} parameter by
24610 customizing the group parameters or the
24611 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24612 added to a group's @code{spam-process} parameter, the senders of
24613 spam-marked articles will be added to the blacklist.
24617 Instead of the obsolete
24618 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
24619 that you use @code{(spam spam-use-blacklist)}. Everything will work
24620 the same way, we promise.
24624 @defvar gnus-group-ham-exit-processor-whitelist
24626 Add this symbol to a group's @code{spam-process} parameter by
24627 customizing the group parameters or the
24628 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24629 added to a group's @code{spam-process} parameter, the senders of
24630 ham-marked articles in @emph{ham} groups will be added to the
24635 Instead of the obsolete
24636 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
24637 that you use @code{(ham spam-use-whitelist)}. Everything will work
24638 the same way, we promise.
24642 Blacklists are lists of regular expressions matching addresses you
24643 consider to be spam senders. For instance, to block mail from any
24644 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
24645 blacklist. You start out with an empty blacklist. Blacklist entries
24646 use the Emacs regular expression syntax.
24648 Conversely, whitelists tell Gnus what addresses are considered
24649 legitimate. All messages from whitelisted addresses are considered
24650 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
24651 Emacs regular expression syntax.
24653 The blacklist and whitelist file locations can be customized with the
24654 @code{spam-directory} variable (@file{~/News/spam} by default), or
24655 the @code{spam-whitelist} and @code{spam-blacklist} variables
24656 directly. The whitelist and blacklist files will by default be in the
24657 @code{spam-directory} directory, named @file{whitelist} and
24658 @file{blacklist} respectively.
24660 @node BBDB Whitelists
24661 @subsubsection BBDB Whitelists
24662 @cindex spam filtering
24663 @cindex BBDB whitelists, spam filtering
24664 @cindex BBDB, spam filtering
24667 @defvar spam-use-BBDB
24669 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
24670 Whitelists}), but uses the BBDB as the source of whitelisted
24671 addresses, without regular expressions. You must have the BBDB loaded
24672 for @code{spam-use-BBDB} to work properly. Messages whose senders are
24673 not in the BBDB will be sent to the next spam-split rule. This is an
24674 explicit filter, meaning that unless someone is in the BBDB, their
24675 messages are not assumed to be spam or ham.
24679 @defvar spam-use-BBDB-exclusive
24681 Set this variable to @code{t} if you want to use the BBDB as an
24682 implicit filter, meaning that every message will be considered spam
24683 unless the sender is in the BBDB. Use with care. Only sender
24684 addresses in the BBDB will be allowed through; all others will be
24685 classified as spammers.
24687 While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias
24688 for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is
24689 @emph{not} a separate back end. If you set
24690 @code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting
24695 @defvar gnus-group-ham-exit-processor-BBDB
24697 Add this symbol to a group's @code{spam-process} parameter by
24698 customizing the group parameters or the
24699 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24700 added to a group's @code{spam-process} parameter, the senders of
24701 ham-marked articles in @emph{ham} groups will be added to the
24706 Instead of the obsolete
24707 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
24708 that you use @code{(ham spam-use-BBDB)}. Everything will work
24709 the same way, we promise.
24713 @node Gmane Spam Reporting
24714 @subsubsection Gmane Spam Reporting
24715 @cindex spam reporting
24716 @cindex Gmane, spam reporting
24717 @cindex Gmane, spam reporting
24720 @defvar gnus-group-spam-exit-processor-report-gmane
24722 Add this symbol to a group's @code{spam-process} parameter by
24723 customizing the group parameters or the
24724 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24725 added to a group's @code{spam-process} parameter, the spam-marked
24726 articles groups will be reported to the Gmane administrators via a
24729 Gmane can be found at @uref{http://gmane.org}.
24733 Instead of the obsolete
24734 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
24735 that you use @code{(spam spam-use-gmane)}. Everything will work the
24736 same way, we promise.
24740 @defvar spam-report-gmane-use-article-number
24742 This variable is @code{t} by default. Set it to @code{nil} if you are
24743 running your own news server, for instance, and the local article
24744 numbers don't correspond to the Gmane article numbers. When
24745 @code{spam-report-gmane-use-article-number} is @code{nil},
24746 @code{spam-report.el} will fetch the number from the article headers.
24750 @defvar spam-report-user-mail-address
24752 Mail address exposed in the User-Agent spam reports to Gmane. It allows
24753 the Gmane administrators to contact you in case of misreports. The
24754 default is @code{user-mail-address}.
24758 @node Anti-spam Hashcash Payments
24759 @subsubsection Anti-spam Hashcash Payments
24760 @cindex spam filtering
24761 @cindex hashcash, spam filtering
24764 @defvar spam-use-hashcash
24766 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
24767 Whitelists}), but uses hashcash tokens for whitelisting messages
24768 instead of the sender address. Messages without a hashcash payment
24769 token will be sent to the next spam-split rule. This is an explicit
24770 filter, meaning that unless a hashcash token is found, the messages
24771 are not assumed to be spam or ham.
24776 @subsubsection Blackholes
24777 @cindex spam filtering
24778 @cindex blackholes, spam filtering
24781 @defvar spam-use-blackholes
24783 This option is disabled by default. You can let Gnus consult the
24784 blackhole-type distributed spam processing systems (DCC, for instance)
24785 when you set this option. The variable @code{spam-blackhole-servers}
24786 holds the list of blackhole servers Gnus will consult. The current
24787 list is fairly comprehensive, but make sure to let us know if it
24788 contains outdated servers.
24790 The blackhole check uses the @code{dig.el} package, but you can tell
24791 @code{spam.el} to use @code{dns.el} instead for better performance if
24792 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
24793 this time to set @code{spam-use-dig} to @code{nil} despite the
24794 possible performance improvements, because some users may be unable to
24795 use it, but you can try it and see if it works for you.
24799 @defvar spam-blackhole-servers
24801 The list of servers to consult for blackhole checks.
24805 @defvar spam-blackhole-good-server-regex
24807 A regular expression for IPs that should not be checked against the
24808 blackhole server list. When set to @code{nil}, it has no effect.
24812 @defvar spam-use-dig
24814 Use the @code{dig.el} package instead of the @code{dns.el} package.
24815 The default setting of @code{t} is recommended.
24819 Blackhole checks are done only on incoming mail. There is no spam or
24820 ham processor for blackholes.
24822 @node Regular Expressions Header Matching
24823 @subsubsection Regular Expressions Header Matching
24824 @cindex spam filtering
24825 @cindex regular expressions header matching, spam filtering
24828 @defvar spam-use-regex-headers
24830 This option is disabled by default. You can let Gnus check the
24831 message headers against lists of regular expressions when you set this
24832 option. The variables @code{spam-regex-headers-spam} and
24833 @code{spam-regex-headers-ham} hold the list of regular expressions.
24834 Gnus will check against the message headers to determine if the
24835 message is spam or ham, respectively.
24839 @defvar spam-regex-headers-spam
24841 The list of regular expressions that, when matched in the headers of
24842 the message, positively identify it as spam.
24846 @defvar spam-regex-headers-ham
24848 The list of regular expressions that, when matched in the headers of
24849 the message, positively identify it as ham.
24853 Regular expression header checks are done only on incoming mail.
24854 There is no specific spam or ham processor for regular expressions.
24857 @subsubsection Bogofilter
24858 @cindex spam filtering
24859 @cindex bogofilter, spam filtering
24862 @defvar spam-use-bogofilter
24864 Set this variable if you want @code{spam-split} to use Eric Raymond's
24867 With a minimum of care for associating the @samp{$} mark for spam
24868 articles only, Bogofilter training all gets fairly automatic. You
24869 should do this until you get a few hundreds of articles in each
24870 category, spam or not. The command @kbd{S t} in summary mode, either
24871 for debugging or for curiosity, shows the @emph{spamicity} score of
24872 the current article (between 0.0 and 1.0).
24874 Bogofilter determines if a message is spam based on a specific
24875 threshold. That threshold can be customized, consult the Bogofilter
24878 If the @code{bogofilter} executable is not in your path, Bogofilter
24879 processing will be turned off.
24881 You should not enable this if you use @code{spam-use-bogofilter-headers}.
24890 @findex spam-bogofilter-score
24891 Get the Bogofilter spamicity score (@code{spam-bogofilter-score}).
24894 @defvar spam-use-bogofilter-headers
24896 Set this variable if you want @code{spam-split} to use Eric Raymond's
24897 speedy Bogofilter, looking only at the message headers. It works
24898 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
24899 must be in the message already. Normally you would do this with a
24900 procmail recipe or something similar; consult the Bogofilter
24901 installation documents for details.
24903 You should not enable this if you use @code{spam-use-bogofilter}.
24907 @defvar gnus-group-spam-exit-processor-bogofilter
24908 Add this symbol to a group's @code{spam-process} parameter by
24909 customizing the group parameters or the
24910 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24911 added to a group's @code{spam-process} parameter, spam-marked articles
24912 will be added to the Bogofilter spam database.
24916 Instead of the obsolete
24917 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
24918 that you use @code{(spam spam-use-bogofilter)}. Everything will work
24919 the same way, we promise.
24922 @defvar gnus-group-ham-exit-processor-bogofilter
24923 Add this symbol to a group's @code{spam-process} parameter by
24924 customizing the group parameters or the
24925 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24926 added to a group's @code{spam-process} parameter, the ham-marked
24927 articles in @emph{ham} groups will be added to the Bogofilter database
24928 of non-spam messages.
24932 Instead of the obsolete
24933 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
24934 that you use @code{(ham spam-use-bogofilter)}. Everything will work
24935 the same way, we promise.
24938 @defvar spam-bogofilter-database-directory
24940 This is the directory where Bogofilter will store its databases. It
24941 is not specified by default, so Bogofilter will use its own default
24942 database directory.
24946 The Bogofilter mail classifier is similar to @command{ifile} in intent and
24947 purpose. A ham and a spam processor are provided, plus the
24948 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
24949 variables to indicate to spam-split that Bogofilter should either be
24950 used, or has already been used on the article. The 0.9.2.1 version of
24951 Bogofilter was used to test this functionality.
24953 @node SpamAssassin back end
24954 @subsubsection SpamAssassin back end
24955 @cindex spam filtering
24956 @cindex spamassassin, spam filtering
24959 @defvar spam-use-spamassassin
24961 Set this variable if you want @code{spam-split} to use SpamAssassin.
24963 SpamAssassin assigns a score to each article based on a set of rules
24964 and tests, including a Bayesian filter. The Bayesian filter can be
24965 trained by associating the @samp{$} mark for spam articles. The
24966 spam score can be viewed by using the command @kbd{S t} in summary
24969 If you set this variable, each article will be processed by
24970 SpamAssassin when @code{spam-split} is called. If your mail is
24971 preprocessed by SpamAssassin, and you want to just use the
24972 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
24975 You should not enable this if you use
24976 @code{spam-use-spamassassin-headers}.
24980 @defvar spam-use-spamassassin-headers
24982 Set this variable if your mail is preprocessed by SpamAssassin and
24983 want @code{spam-split} to split based on the SpamAssassin headers.
24985 You should not enable this if you use @code{spam-use-spamassassin}.
24989 @defvar spam-spamassassin-program
24991 This variable points to the SpamAssassin executable. If you have
24992 @code{spamd} running, you can set this variable to the @code{spamc}
24993 executable for faster processing. See the SpamAssassin documentation
24994 for more information on @code{spamd}/@code{spamc}.
24998 SpamAssassin is a powerful and flexible spam filter that uses a wide
24999 variety of tests to identify spam. A ham and a spam processors are
25000 provided, plus the @code{spam-use-spamassassin} and
25001 @code{spam-use-spamassassin-headers} variables to indicate to
25002 spam-split that SpamAssassin should be either used, or has already
25003 been used on the article. The 2.63 version of SpamAssassin was used
25004 to test this functionality.
25006 @node ifile spam filtering
25007 @subsubsection ifile spam filtering
25008 @cindex spam filtering
25009 @cindex ifile, spam filtering
25012 @defvar spam-use-ifile
25014 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
25015 statistical analyzer similar to Bogofilter.
25019 @defvar spam-ifile-all-categories
25021 Enable this variable if you want @code{spam-use-ifile} to give you all
25022 the ifile categories, not just spam/non-spam. If you use this, make
25023 sure you train ifile as described in its documentation.
25027 @defvar spam-ifile-spam-category
25029 This is the category of spam messages as far as ifile is concerned.
25030 The actual string used is irrelevant, but you probably want to leave
25031 the default value of @samp{spam}.
25034 @defvar spam-ifile-database
25036 This is the filename for the ifile database. It is not specified by
25037 default, so ifile will use its own default database name.
25041 The ifile mail classifier is similar to Bogofilter in intent and
25042 purpose. A ham and a spam processor are provided, plus the
25043 @code{spam-use-ifile} variable to indicate to spam-split that ifile
25044 should be used. The 1.2.1 version of ifile was used to test this
25047 @node Spam Statistics Filtering
25048 @subsubsection Spam Statistics Filtering
25049 @cindex spam filtering
25050 @cindex spam-stat, spam filtering
25054 This back end uses the Spam Statistics Emacs Lisp package to perform
25055 statistics-based filtering (@pxref{Spam Statistics Package}). Before
25056 using this, you may want to perform some additional steps to
25057 initialize your Spam Statistics dictionary. @xref{Creating a
25058 spam-stat dictionary}.
25060 @defvar spam-use-stat
25064 @defvar gnus-group-spam-exit-processor-stat
25065 Add this symbol to a group's @code{spam-process} parameter by
25066 customizing the group parameters or the
25067 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25068 added to a group's @code{spam-process} parameter, the spam-marked
25069 articles will be added to the spam-stat database of spam messages.
25073 Instead of the obsolete
25074 @code{gnus-group-spam-exit-processor-stat}, it is recommended
25075 that you use @code{(spam spam-use-stat)}. Everything will work
25076 the same way, we promise.
25079 @defvar gnus-group-ham-exit-processor-stat
25080 Add this symbol to a group's @code{spam-process} parameter by
25081 customizing the group parameters or the
25082 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25083 added to a group's @code{spam-process} parameter, the ham-marked
25084 articles in @emph{ham} groups will be added to the spam-stat database
25085 of non-spam messages.
25089 Instead of the obsolete
25090 @code{gnus-group-ham-exit-processor-stat}, it is recommended
25091 that you use @code{(ham spam-use-stat)}. Everything will work
25092 the same way, we promise.
25095 This enables @code{spam.el} to cooperate with @file{spam-stat.el}.
25096 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
25097 which unlike ifile or Bogofilter does not require external programs.
25098 A spam and a ham processor, and the @code{spam-use-stat} variable for
25099 @code{spam-split} are provided.
25102 @subsubsection Using SpamOracle with Gnus
25103 @cindex spam filtering
25107 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
25108 statistical mail filtering tool written by Xavier Leroy and needs to be
25109 installed separately.
25111 There are several ways to use SpamOracle with Gnus. In all cases, your
25112 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
25113 then enter an @samp{X-Spam} header indicating whether it regards the
25114 mail as a spam mail or not.
25116 One possibility is to run SpamOracle as a @code{:prescript} from the
25117 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
25118 the advantage that the user can see the @emph{X-Spam} headers.
25120 The easiest method is to make @file{spam.el} (@pxref{Spam Package})
25123 @vindex spam-use-spamoracle
25124 To enable SpamOracle usage by @code{spam.el}, set the variable
25125 @code{spam-use-spamoracle} to @code{t} and configure the
25126 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}. @xref{Spam
25127 Package}. In this example the @samp{INBOX} of an nnimap server is
25128 filtered using SpamOracle. Mails recognized as spam mails will be
25129 moved to @code{spam-split-group}, @samp{Junk} in this case. Ham
25130 messages stay in @samp{INBOX}:
25133 (setq spam-use-spamoracle t
25134 spam-split-group "Junk"
25135 nnimap-split-inbox '("INBOX")
25136 nnimap-split-rule 'nnimap-split-fancy
25137 nnimap-split-fancy '(| (: spam-split) "INBOX"))
25140 @defvar spam-use-spamoracle
25141 Set to @code{t} if you want Gnus to enable spam filtering using
25145 @defvar spam-spamoracle-binary
25146 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
25147 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
25151 @defvar spam-spamoracle-database
25152 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
25153 store its analysis. This is controlled by the variable
25154 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
25155 the default SpamOracle database will be used. In case you want your
25156 database to live somewhere special, set
25157 @code{spam-spamoracle-database} to this path.
25160 SpamOracle employs a statistical algorithm to determine whether a
25161 message is spam or ham. In order to get good results, meaning few
25162 false hits or misses, SpamOracle needs training. SpamOracle learns
25163 the characteristics of your spam mails. Using the @emph{add} mode
25164 (training mode) one has to feed good (ham) and spam mails to
25165 SpamOracle. This can be done by pressing @kbd{|} in the Summary
25166 buffer and pipe the mail to a SpamOracle process or using
25167 @file{spam.el}'s spam- and ham-processors, which is much more
25168 convenient. For a detailed description of spam- and ham-processors,
25169 @xref{Spam Package}.
25171 @defvar gnus-group-spam-exit-processor-spamoracle
25172 Add this symbol to a group's @code{spam-process} parameter by
25173 customizing the group parameter or the
25174 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
25175 to a group's @code{spam-process} parameter, spam-marked articles will be
25176 sent to SpamOracle as spam samples.
25180 Instead of the obsolete
25181 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
25182 that you use @code{(spam spam-use-spamoracle)}. Everything will work
25183 the same way, we promise.
25186 @defvar gnus-group-ham-exit-processor-spamoracle
25187 Add this symbol to a group's @code{spam-process} parameter by
25188 customizing the group parameter or the
25189 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
25190 to a group's @code{spam-process} parameter, the ham-marked articles in
25191 @emph{ham} groups will be sent to the SpamOracle as samples of ham
25196 Instead of the obsolete
25197 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
25198 that you use @code{(ham spam-use-spamoracle)}. Everything will work
25199 the same way, we promise.
25202 @emph{Example:} These are the Group Parameters of a group that has been
25203 classified as a ham group, meaning that it should only contain ham
25206 ((spam-contents gnus-group-spam-classification-ham)
25207 (spam-process ((ham spam-use-spamoracle)
25208 (spam spam-use-spamoracle))))
25210 For this group the @code{spam-use-spamoracle} is installed for both
25211 ham and spam processing. If the group contains spam message
25212 (e.g. because SpamOracle has not had enough sample messages yet) and
25213 the user marks some messages as spam messages, these messages will be
25214 processed by SpamOracle. The processor sends the messages to
25215 SpamOracle as new samples for spam.
25217 @node Extending the Spam package
25218 @subsection Extending the Spam package
25219 @cindex spam filtering
25220 @cindex spam elisp package, extending
25221 @cindex extending the spam elisp package
25223 Say you want to add a new back end called blackbox. For filtering
25224 incoming mail, provide the following:
25232 (defvar spam-use-blackbox nil
25233 "True if blackbox should be used.")
25236 Write @code{spam-check-blackbox} if Blackbox can check incoming mail.
25238 Write @code{spam-blackbox-register-routine} and
25239 @code{spam-blackbox-unregister-routine} using the bogofilter
25240 register/unregister routines as a start, or other restister/unregister
25241 routines more appropriate to Blackbox, if Blackbox can
25242 register/unregister spam and ham.
25247 The @code{spam-check-blackbox} function should return @samp{nil} or
25248 @code{spam-split-group}, observing the other conventions. See the
25249 existing @code{spam-check-*} functions for examples of what you can
25250 do, and stick to the template unless you fully understand the reasons
25255 For processing spam and ham messages, provide the following:
25262 Note you don't have to provide a spam or a ham processor. Only
25263 provide them if Blackbox supports spam or ham processing.
25265 Also, ham and spam processors are being phased out as single
25266 variables. Instead the form @code{(spam spam-use-blackbox)} or
25267 @code{(ham spam-use-blackbox)} is favored. For now, spam/ham
25268 processor variables are still around but they won't be for long.
25271 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
25272 "The Blackbox summary exit spam processor.
25273 Only applicable to spam groups.")
25275 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
25276 "The whitelist summary exit ham processor.
25277 Only applicable to non-spam (unclassified and ham) groups.")
25286 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
25287 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
25289 to the @code{spam-process} group parameter in @code{gnus.el}. Make
25290 sure you do it twice, once for the parameter and once for the
25291 variable customization.
25295 (variable-item spam-use-blackbox)
25297 to the @code{spam-autodetect-methods} group parameter in
25298 @code{gnus.el} if Blackbox can check incoming mail for spam contents.
25300 Finally, use the appropriate @code{spam-install-*-backend} function in
25301 @code{spam.el}. Here are the available functions.
25307 @code{spam-install-backend-alias}
25309 This function will simply install an alias for a back end that does
25310 everything like the original back end. It is currently only used to
25311 make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}.
25314 @code{spam-install-nocheck-backend}
25316 This function installs a back end that has no check function, but can
25317 register/unregister ham or spam. The @code{spam-use-gmane} back end is
25321 @code{spam-install-checkonly-backend}
25323 This function will install a back end that can only check incoming mail
25324 for spam contents. It can't register or unregister messages.
25325 @code{spam-use-blackholes} and @code{spam-use-hashcash} are such
25329 @code{spam-install-statistical-checkonly-backend}
25331 This function installs a statistical back end (one which requires the
25332 full body of a message to check it) that can only check incoming mail
25333 for contents. @code{spam-use-regex-body} is such a filter.
25336 @code{spam-install-statistical-backend}
25338 This function install a statistical back end with incoming checks and
25339 registration/unregistration routines. @code{spam-use-bogofilter} is
25343 @code{spam-install-backend}
25345 This is the most normal back end installation, where a back end that can
25346 check and register/unregister messages is set up without statistical
25347 abilities. The @code{spam-use-BBDB} is such a back end.
25350 @code{spam-install-mover-backend}
25352 Mover back ends are internal to @code{spam.el} and specifically move
25353 articles around when the summary is exited. You will very probably
25354 never install such a back end.
25359 @node Spam Statistics Package
25360 @subsection Spam Statistics Package
25361 @cindex Paul Graham
25362 @cindex Graham, Paul
25363 @cindex naive Bayesian spam filtering
25364 @cindex Bayesian spam filtering, naive
25365 @cindex spam filtering, naive Bayesian
25367 Paul Graham has written an excellent essay about spam filtering using
25368 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
25369 Spam}. In it he describes the inherent deficiency of rule-based
25370 filtering as used by SpamAssassin, for example: Somebody has to write
25371 the rules, and everybody else has to install these rules. You are
25372 always late. It would be much better, he argues, to filter mail based
25373 on whether it somehow resembles spam or non-spam. One way to measure
25374 this is word distribution. He then goes on to describe a solution
25375 that checks whether a new mail resembles any of your other spam mails
25378 The basic idea is this: Create a two collections of your mail, one
25379 with spam, one with non-spam. Count how often each word appears in
25380 either collection, weight this by the total number of mails in the
25381 collections, and store this information in a dictionary. For every
25382 word in a new mail, determine its probability to belong to a spam or a
25383 non-spam mail. Use the 15 most conspicuous words, compute the total
25384 probability of the mail being spam. If this probability is higher
25385 than a certain threshold, the mail is considered to be spam.
25387 The Spam Statistics package adds support to Gnus for this kind of
25388 filtering. It can be used as one of the back ends of the Spam package
25389 (@pxref{Spam Package}), or by itself.
25391 Before using the Spam Statistics package, you need to set it up.
25392 First, you need two collections of your mail, one with spam, one with
25393 non-spam. Then you need to create a dictionary using these two
25394 collections, and save it. And last but not least, you need to use
25395 this dictionary in your fancy mail splitting rules.
25398 * Creating a spam-stat dictionary::
25399 * Splitting mail using spam-stat::
25400 * Low-level interface to the spam-stat dictionary::
25403 @node Creating a spam-stat dictionary
25404 @subsubsection Creating a spam-stat dictionary
25406 Before you can begin to filter spam based on statistics, you must
25407 create these statistics based on two mail collections, one with spam,
25408 one with non-spam. These statistics are then stored in a dictionary
25409 for later use. In order for these statistics to be meaningful, you
25410 need several hundred emails in both collections.
25412 Gnus currently supports only the nnml back end for automated dictionary
25413 creation. The nnml back end stores all mails in a directory, one file
25414 per mail. Use the following:
25416 @defun spam-stat-process-spam-directory
25417 Create spam statistics for every file in this directory. Every file
25418 is treated as one spam mail.
25421 @defun spam-stat-process-non-spam-directory
25422 Create non-spam statistics for every file in this directory. Every
25423 file is treated as one non-spam mail.
25426 Usually you would call @code{spam-stat-process-spam-directory} on a
25427 directory such as @file{~/Mail/mail/spam} (this usually corresponds to
25428 the group @samp{nnml:mail.spam}), and you would call
25429 @code{spam-stat-process-non-spam-directory} on a directory such as
25430 @file{~/Mail/mail/misc} (this usually corresponds to the group
25431 @samp{nnml:mail.misc}).
25433 When you are using @acronym{IMAP}, you won't have the mails available
25434 locally, so that will not work. One solution is to use the Gnus Agent
25435 to cache the articles. Then you can use directories such as
25436 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
25437 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
25440 This variable holds the hash-table with all the statistics---the
25441 dictionary we have been talking about. For every word in either
25442 collection, this hash-table stores a vector describing how often the
25443 word appeared in spam and often it appeared in non-spam mails.
25446 If you want to regenerate the statistics from scratch, you need to
25447 reset the dictionary.
25449 @defun spam-stat-reset
25450 Reset the @code{spam-stat} hash-table, deleting all the statistics.
25453 When you are done, you must save the dictionary. The dictionary may
25454 be rather large. If you will not update the dictionary incrementally
25455 (instead, you will recreate it once a month, for example), then you
25456 can reduce the size of the dictionary by deleting all words that did
25457 not appear often enough or that do not clearly belong to only spam or
25458 only non-spam mails.
25460 @defun spam-stat-reduce-size
25461 Reduce the size of the dictionary. Use this only if you do not want
25462 to update the dictionary incrementally.
25465 @defun spam-stat-save
25466 Save the dictionary.
25469 @defvar spam-stat-file
25470 The filename used to store the dictionary. This defaults to
25471 @file{~/.spam-stat.el}.
25474 @node Splitting mail using spam-stat
25475 @subsubsection Splitting mail using spam-stat
25477 This section describes how to use the Spam statistics
25478 @emph{independently} of the @xref{Spam Package}.
25480 First, add the following to your @file{~/.gnus.el} file:
25483 (require 'spam-stat)
25487 This will load the necessary Gnus code, and the dictionary you
25490 Next, you need to adapt your fancy splitting rules: You need to
25491 determine how to use @code{spam-stat}. The following examples are for
25492 the nnml back end. Using the nnimap back end works just as well. Just
25493 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
25495 In the simplest case, you only have two groups, @samp{mail.misc} and
25496 @samp{mail.spam}. The following expression says that mail is either
25497 spam or it should go into @samp{mail.misc}. If it is spam, then
25498 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
25501 (setq nnmail-split-fancy
25502 `(| (: spam-stat-split-fancy)
25506 @defvar spam-stat-split-fancy-spam-group
25507 The group to use for spam. Default is @samp{mail.spam}.
25510 If you also filter mail with specific subjects into other groups, use
25511 the following expression. Only mails not matching the regular
25512 expression are considered potential spam.
25515 (setq nnmail-split-fancy
25516 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
25517 (: spam-stat-split-fancy)
25521 If you want to filter for spam first, then you must be careful when
25522 creating the dictionary. Note that @code{spam-stat-split-fancy} must
25523 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
25524 non-spam, therefore both should be in your collection of non-spam
25525 mails, when creating the dictionary!
25528 (setq nnmail-split-fancy
25529 `(| (: spam-stat-split-fancy)
25530 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25534 You can combine this with traditional filtering. Here, we move all
25535 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
25536 @code{spam-stat-split-fancy} will never see them, the mails in
25537 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
25538 nor in your collection of non-spam mails, when creating the
25542 (setq nnmail-split-fancy
25543 `(| ("Content-Type" "text/html" "mail.spam.filtered")
25544 (: spam-stat-split-fancy)
25545 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25550 @node Low-level interface to the spam-stat dictionary
25551 @subsubsection Low-level interface to the spam-stat dictionary
25553 The main interface to using @code{spam-stat}, are the following functions:
25555 @defun spam-stat-buffer-is-spam
25556 Called in a buffer, that buffer is considered to be a new spam mail.
25557 Use this for new mail that has not been processed before.
25560 @defun spam-stat-buffer-is-no-spam
25561 Called in a buffer, that buffer is considered to be a new non-spam
25562 mail. Use this for new mail that has not been processed before.
25565 @defun spam-stat-buffer-change-to-spam
25566 Called in a buffer, that buffer is no longer considered to be normal
25567 mail but spam. Use this to change the status of a mail that has
25568 already been processed as non-spam.
25571 @defun spam-stat-buffer-change-to-non-spam
25572 Called in a buffer, that buffer is no longer considered to be spam but
25573 normal mail. Use this to change the status of a mail that has already
25574 been processed as spam.
25577 @defun spam-stat-save
25578 Save the hash table to the file. The filename used is stored in the
25579 variable @code{spam-stat-file}.
25582 @defun spam-stat-load
25583 Load the hash table from a file. The filename used is stored in the
25584 variable @code{spam-stat-file}.
25587 @defun spam-stat-score-word
25588 Return the spam score for a word.
25591 @defun spam-stat-score-buffer
25592 Return the spam score for a buffer.
25595 @defun spam-stat-split-fancy
25596 Use this function for fancy mail splitting. Add the rule @samp{(:
25597 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
25600 Make sure you load the dictionary before using it. This requires the
25601 following in your @file{~/.gnus.el} file:
25604 (require 'spam-stat)
25608 Typical test will involve calls to the following functions:
25611 Reset: (setq spam-stat (make-hash-table :test 'equal))
25612 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25613 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25614 Save table: (spam-stat-save)
25615 File size: (nth 7 (file-attributes spam-stat-file))
25616 Number of words: (hash-table-count spam-stat)
25617 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25618 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25619 Reduce table size: (spam-stat-reduce-size)
25620 Save table: (spam-stat-save)
25621 File size: (nth 7 (file-attributes spam-stat-file))
25622 Number of words: (hash-table-count spam-stat)
25623 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25624 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25627 Here is how you would create your dictionary:
25630 Reset: (setq spam-stat (make-hash-table :test 'equal))
25631 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25632 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25633 Repeat for any other non-spam group you need...
25634 Reduce table size: (spam-stat-reduce-size)
25635 Save table: (spam-stat-save)
25639 @section Interaction with other modes
25644 @code{gnus-dired-minor-mode} provides some useful functions for dired
25645 buffers. It is enabled with
25647 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
25652 @findex gnus-dired-attach
25653 @cindex attachments, selection via dired
25654 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
25655 You will be prompted for a message buffer.
25658 @findex gnus-dired-find-file-mailcap
25659 Visit a file according to the appropriate mailcap entry
25660 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
25664 @findex gnus-dired-print
25665 Print file according to the mailcap entry (@code{gnus-dired-print}). If
25666 there is no print command, print in a PostScript image.
25669 @node Various Various
25670 @section Various Various
25676 @item gnus-home-directory
25677 @vindex gnus-home-directory
25678 All Gnus file and directory variables will be initialized from this
25679 variable, which defaults to @file{~/}.
25681 @item gnus-directory
25682 @vindex gnus-directory
25683 Most Gnus storage file and directory variables will be initialized from
25684 this variable, which defaults to the @env{SAVEDIR} environment
25685 variable, or @file{~/News/} if that variable isn't set.
25687 Note that Gnus is mostly loaded when the @file{~/.gnus.el} file is read.
25688 This means that other directory variables that are initialized from this
25689 variable won't be set properly if you set this variable in
25690 @file{~/.gnus.el}. Set this variable in @file{.emacs} instead.
25692 @item gnus-default-directory
25693 @vindex gnus-default-directory
25694 Not related to the above variable at all---this variable says what the
25695 default directory of all Gnus buffers should be. If you issue commands
25696 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
25697 default directory. If this variable is @code{nil} (which is the
25698 default), the default directory will be the default directory of the
25699 buffer you were in when you started Gnus.
25702 @vindex gnus-verbose
25703 This variable is an integer between zero and ten. The higher the value,
25704 the more messages will be displayed. If this variable is zero, Gnus
25705 will never flash any messages, if it is seven (which is the default),
25706 most important messages will be shown, and if it is ten, Gnus won't ever
25707 shut up, but will flash so many messages it will make your head swim.
25709 @item gnus-verbose-backends
25710 @vindex gnus-verbose-backends
25711 This variable works the same way as @code{gnus-verbose}, but it applies
25712 to the Gnus back ends instead of Gnus proper.
25714 @item gnus-add-timestamp-to-message
25715 @vindex gnus-add-timestamp-to-message
25716 This variable controls whether to add timestamps to messages that are
25717 controlled by @code{gnus-verbose} and @code{gnus-verbose-backends} and
25718 are issued. The default value is @code{nil} which means never to add
25719 timestamp. If it is @code{log}, add timestamps to only the messages
25720 that go into the @samp{*Messages*} buffer (in XEmacs, it is the
25721 @w{@samp{ *Message-Log*}} buffer). If it is neither @code{nil} nor
25722 @code{log}, add timestamps not only to log messages but also to the ones
25723 displayed in the echo area.
25725 @item nnheader-max-head-length
25726 @vindex nnheader-max-head-length
25727 When the back ends read straight heads of articles, they all try to read
25728 as little as possible. This variable (default 8192) specifies
25729 the absolute max length the back ends will try to read before giving up
25730 on finding a separator line between the head and the body. If this
25731 variable is @code{nil}, there is no upper read bound. If it is
25732 @code{t}, the back ends won't try to read the articles piece by piece,
25733 but read the entire articles. This makes sense with some versions of
25734 @code{ange-ftp} or @code{efs}.
25736 @item nnheader-head-chop-length
25737 @vindex nnheader-head-chop-length
25738 This variable (default 2048) says how big a piece of each article to
25739 read when doing the operation described above.
25741 @item nnheader-file-name-translation-alist
25742 @vindex nnheader-file-name-translation-alist
25744 @cindex invalid characters in file names
25745 @cindex characters in file names
25746 This is an alist that says how to translate characters in file names.
25747 For instance, if @samp{:} is invalid as a file character in file names
25748 on your system (you OS/2 user you), you could say something like:
25752 (setq nnheader-file-name-translation-alist
25757 In fact, this is the default value for this variable on OS/2 and MS
25758 Windows (phooey) systems.
25760 @item gnus-hidden-properties
25761 @vindex gnus-hidden-properties
25762 This is a list of properties to use to hide ``invisible'' text. It is
25763 @code{(invisible t intangible t)} by default on most systems, which
25764 makes invisible text invisible and intangible.
25766 @item gnus-parse-headers-hook
25767 @vindex gnus-parse-headers-hook
25768 A hook called before parsing headers. It can be used, for instance, to
25769 gather statistics on the headers fetched, or perhaps you'd like to prune
25770 some headers. I don't see why you'd want that, though.
25772 @item gnus-shell-command-separator
25773 @vindex gnus-shell-command-separator
25774 String used to separate two shell commands. The default is @samp{;}.
25776 @item gnus-invalid-group-regexp
25777 @vindex gnus-invalid-group-regexp
25779 Regexp to match ``invalid'' group names when querying user for a group
25780 name. The default value catches some @strong{really} invalid group
25781 names who could possibly mess up Gnus internally (like allowing
25782 @samp{:} in a group name, which is normally used to delimit method and
25785 @acronym{IMAP} users might want to allow @samp{/} in group names though.
25793 Well, that's the manual---you can get on with your life now. Keep in
25794 touch. Say hello to your cats from me.
25796 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
25798 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
25804 Not because of victories @*
25807 but for the common sunshine,@*
25809 the largess of the spring.
25813 but for the day's work done@*
25814 as well as I was able;@*
25815 not for a seat upon the dais@*
25816 but at the common table.@*
25821 @chapter Appendices
25824 * XEmacs:: Requirements for installing under XEmacs.
25825 * History:: How Gnus got where it is today.
25826 * On Writing Manuals:: Why this is not a beginner's guide.
25827 * Terminology:: We use really difficult, like, words here.
25828 * Customization:: Tailoring Gnus to your needs.
25829 * Troubleshooting:: What you might try if things do not work.
25830 * Gnus Reference Guide:: Rilly, rilly technical stuff.
25831 * Emacs for Heathens:: A short introduction to Emacsian terms.
25832 * Frequently Asked Questions:: The Gnus FAQ
25839 @cindex installing under XEmacs
25841 XEmacs is distributed as a collection of packages. You should install
25842 whatever packages the Gnus XEmacs package requires. The current
25843 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
25844 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
25845 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{W3},
25846 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
25853 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
25854 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
25856 If you want to investigate the person responsible for this outrage,
25857 you can point your (feh!) web browser to
25858 @uref{http://quimby.gnus.org/}. This is also the primary
25859 distribution point for the new and spiffy versions of Gnus, and is
25860 known as The Site That Destroys Newsrcs And Drives People Mad.
25862 During the first extended alpha period of development, the new Gnus was
25863 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
25864 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
25865 (Besides, the ``Gnus'' in this abbreviation should probably be
25866 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
25867 appropriate name, don't you think?)
25869 In any case, after spending all that energy on coming up with a new and
25870 spunky name, we decided that the name was @emph{too} spunky, so we
25871 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
25872 ``@sc{gnus}''. New vs. old.
25875 * Gnus Versions:: What Gnus versions have been released.
25876 * Other Gnus Versions:: Other Gnus versions that also have been released.
25877 * Why?:: What's the point of Gnus?
25878 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
25879 * Conformity:: Gnus tries to conform to all standards.
25880 * Emacsen:: Gnus can be run on a few modern Emacsen.
25881 * Gnus Development:: How Gnus is developed.
25882 * Contributors:: Oodles of people.
25883 * New Features:: Pointers to some of the new stuff in Gnus.
25887 @node Gnus Versions
25888 @subsection Gnus Versions
25890 @cindex September Gnus
25892 @cindex Quassia Gnus
25893 @cindex Pterodactyl Gnus
25896 @cindex Gnus versions
25898 The first ``proper'' release of Gnus 5 was done in November 1995 when it
25899 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
25900 plus 15 Gnus 5.0 releases).
25902 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
25903 releases)) was released under the name ``Gnus 5.2'' (40 releases).
25905 On July 28th 1996 work on Red Gnus was begun, and it was released on
25906 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
25908 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
25909 It was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
25911 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
25912 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
25915 On the 26th of October 2000, Oort Gnus was begun and was released as
25916 Gnus 5.10 on May 1st 2003 (24 releases).
25918 On the January 4th 2004, No Gnus was begun.
25920 If you happen upon a version of Gnus that has a prefixed name --
25921 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
25922 ``Pterodactyl Gnus'', ``Oort Gnus'', ``No Gnus'' -- don't panic.
25923 Don't let it know that you're frightened. Back away. Slowly. Whatever
25924 you do, don't run. Walk away, calmly, until you're out of its reach.
25925 Find a proper released version of Gnus and snuggle up to that instead.
25928 @node Other Gnus Versions
25929 @subsection Other Gnus Versions
25932 In addition to the versions of Gnus which have had their releases
25933 coordinated by Lars, one major development has been Semi-gnus from
25934 Japan. It's based on a library called @acronym{SEMI}, which provides
25935 @acronym{MIME} capabilities.
25937 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
25938 Collectively, they are called ``Semi-gnus'', and different strains are
25939 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
25940 @acronym{MIME} and multilingualization things, especially important for
25947 What's the point of Gnus?
25949 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
25950 newsreader, that lets you do anything you can think of. That was my
25951 original motivation, but while working on Gnus, it has become clear to
25952 me that this generation of newsreaders really belong in the stone age.
25953 Newsreaders haven't developed much since the infancy of the net. If the
25954 volume continues to rise with the current rate of increase, all current
25955 newsreaders will be pretty much useless. How do you deal with
25956 newsgroups that have thousands of new articles each day? How do you
25957 keep track of millions of people who post?
25959 Gnus offers no real solutions to these questions, but I would very much
25960 like to see Gnus being used as a testing ground for new methods of
25961 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
25962 to separate the newsreader from the back ends, Gnus now offers a simple
25963 interface for anybody who wants to write new back ends for fetching mail
25964 and news from different sources. I have added hooks for customizations
25965 everywhere I could imagine it being useful. By doing so, I'm inviting
25966 every one of you to explore and invent.
25968 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
25969 @kbd{C-u 100 M-x all-hail-xemacs}.
25972 @node Compatibility
25973 @subsection Compatibility
25975 @cindex compatibility
25976 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
25977 bindings have been kept. More key bindings have been added, of course,
25978 but only in one or two obscure cases have old bindings been changed.
25983 @center In a cloud bones of steel.
25987 All commands have kept their names. Some internal functions have changed
25990 The @code{gnus-uu} package has changed drastically. @xref{Decoding
25993 One major compatibility question is the presence of several summary
25994 buffers. All variables relevant while reading a group are
25995 buffer-local to the summary buffer they belong in. Although many
25996 important variables have their values copied into their global
25997 counterparts whenever a command is executed in the summary buffer, this
25998 change might lead to incorrect values being used unless you are careful.
26000 All code that relies on knowledge of @sc{gnus} internals will probably
26001 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
26002 changing it in any way, as a matter of fact) is strictly verboten. Gnus
26003 maintains a hash table that points to the entries in this alist (which
26004 speeds up many functions), and changing the alist directly will lead to
26008 @cindex highlighting
26009 Old hilit19 code does not work at all. In fact, you should probably
26010 remove all hilit code from all Gnus hooks
26011 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
26012 Gnus provides various integrated functions for highlighting. These are
26013 faster and more accurate. To make life easier for everybody, Gnus will
26014 by default remove all hilit calls from all hilit hooks. Uncleanliness!
26017 Packages like @code{expire-kill} will no longer work. As a matter of
26018 fact, you should probably remove all old @sc{gnus} packages (and other
26019 code) when you start using Gnus. More likely than not, Gnus already
26020 does what you have written code to make @sc{gnus} do. (Snicker.)
26022 Even though old methods of doing things are still supported, only the
26023 new methods are documented in this manual. If you detect a new method of
26024 doing something while reading this manual, that does not mean you have
26025 to stop doing it the old way.
26027 Gnus understands all @sc{gnus} startup files.
26029 @kindex M-x gnus-bug
26031 @cindex reporting bugs
26033 Overall, a casual user who hasn't written much code that depends on
26034 @sc{gnus} internals should suffer no problems. If problems occur,
26035 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
26037 @vindex gnus-bug-create-help-buffer
26038 If you are in the habit of sending bug reports @emph{very} often, you
26039 may find the helpful help buffer annoying after a while. If so, set
26040 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
26045 @subsection Conformity
26047 No rebels without a clue here, ma'am. We conform to all standards known
26048 to (wo)man. Except for those standards and/or conventions we disagree
26056 There are no known breaches of this standard.
26060 There are no known breaches of this standard, either.
26062 @item Son-of-RFC 1036
26063 @cindex Son-of-RFC 1036
26064 We do have some breaches to this one.
26070 These are considered to be ``vanity headers'', while I consider them
26071 to be consumer information. After seeing so many badly formatted
26072 articles coming from @code{tin} and @code{Netscape} I know not to use
26073 either of those for posting articles. I would not have known that if
26074 it wasn't for the @code{X-Newsreader} header.
26079 USEFOR is an IETF working group writing a successor to RFC 1036, based
26080 on Son-of-RFC 1036. They have produced a number of drafts proposing
26081 various changes to the format of news articles. The Gnus towers will
26082 look into implementing the changes when the draft is accepted as an RFC.
26084 @item MIME - RFC 2045-2049 etc
26085 @cindex @acronym{MIME}
26086 All the various @acronym{MIME} RFCs are supported.
26088 @item Disposition Notifications - RFC 2298
26089 Message Mode is able to request notifications from the receiver.
26091 @item PGP - RFC 1991 and RFC 2440
26094 RFC 1991 is the original @acronym{PGP} message specification,
26095 published as an informational RFC. RFC 2440 was the follow-up, now
26096 called Open PGP, and put on the Standards Track. Both document a
26097 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
26098 encoding (signing and encryption) and decoding (verification and
26101 @item PGP/MIME - RFC 2015/3156
26102 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
26103 1991) describes the @acronym{MIME}-wrapping around the RFC 1991/2440 format.
26104 Gnus supports both encoding and decoding.
26106 @item S/MIME - RFC 2633
26107 RFC 2633 describes the @acronym{S/MIME} format.
26109 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
26110 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
26111 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
26112 authentication for @acronym{IMAP}. RFC 2086 describes access control
26113 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
26114 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
26115 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
26116 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
26120 If you ever notice Gnus acting non-compliant with regards to the texts
26121 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
26126 @subsection Emacsen
26132 Gnus should work on:
26140 XEmacs 21.4 and up.
26144 This Gnus version will absolutely not work on any Emacsen older than
26145 that. Not reliably, at least. Older versions of Gnus may work on older
26146 Emacs versions. Particularly, Gnus 5.10.8 should also work on Emacs
26147 20.7 and XEmacs 21.1.
26149 There are some vague differences between Gnus on the various
26150 platforms---XEmacs features more graphics (a logo and a toolbar)---but
26151 other than that, things should look pretty much the same under all
26155 @node Gnus Development
26156 @subsection Gnus Development
26158 Gnus is developed in a two-phased cycle. The first phase involves much
26159 discussion on the @samp{ding@@gnus.org} mailing list, where people
26160 propose changes and new features, post patches and new back ends. This
26161 phase is called the @dfn{alpha} phase, since the Gnusae released in this
26162 phase are @dfn{alpha releases}, or (perhaps more commonly in other
26163 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
26164 unstable and should not be used by casual users. Gnus alpha releases
26165 have names like ``Red Gnus'' and ``Quassia Gnus''.
26167 After futzing around for 50-100 alpha releases, Gnus is declared
26168 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
26169 and is called things like ``Gnus 5.6.32'' instead. Normal people are
26170 supposed to be able to use these, and these are mostly discussed on the
26171 @samp{gnu.emacs.gnus} newsgroup.
26174 @vindex mail-source-delete-incoming
26175 Some variable defaults differ between alpha Gnusae and released Gnusae.
26176 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
26177 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
26178 lossage of mail if an alpha release hiccups while handling the mail.
26180 The division of discussion between the ding mailing list and the Gnus
26181 newsgroup is not purely based on publicity concerns. It's true that
26182 having people write about the horrible things that an alpha Gnus release
26183 can do (sometimes) in a public forum may scare people off, but more
26184 importantly, talking about new experimental features that have been
26185 introduced may confuse casual users. New features are frequently
26186 introduced, fiddled with, and judged to be found wanting, and then
26187 either discarded or totally rewritten. People reading the mailing list
26188 usually keep up with these rapid changes, while people on the newsgroup
26189 can't be assumed to do so.
26194 @subsection Contributors
26195 @cindex contributors
26197 The new Gnus version couldn't have been done without the help of all the
26198 people on the (ding) mailing list. Every day for over a year I have
26199 gotten billions of nice bug reports from them, filling me with joy,
26200 every single one of them. Smooches. The people on the list have been
26201 tried beyond endurance, what with my ``oh, that's a neat idea <type
26202 type>, yup, I'll release it right away <ship off> no wait, that doesn't
26203 work at all <type type>, yup, I'll ship that one off right away <ship
26204 off> no, wait, that absolutely does not work'' policy for releases.
26205 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
26206 ``worser''? ``much worser''? ``worsest''?)
26208 I would like to take this opportunity to thank the Academy for@dots{} oops,
26214 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
26217 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
26218 nnwarchive and many, many other things connected with @acronym{MIME} and
26219 other types of en/decoding, as well as general bug fixing, new
26220 functionality and stuff.
26223 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
26224 well as numerous other things).
26227 Luis Fernandes---design and graphics.
26230 Joe Reiss---creator of the smiley faces.
26233 Justin Sheehy---the @acronym{FAQ} maintainer.
26236 Erik Naggum---help, ideas, support, code and stuff.
26239 Wes Hardaker---@file{gnus-picon.el} and the manual section on
26240 @dfn{picons} (@pxref{Picons}).
26243 Kim-Minh Kaplan---further work on the picon code.
26246 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
26249 Sudish Joseph---innumerable bug fixes.
26252 Ilja Weis---@file{gnus-topic.el}.
26255 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
26258 Vladimir Alexiev---the refcard and reference booklets.
26261 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
26262 distribution by Felix Lee and JWZ.
26265 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
26268 Peter Mutsaers---orphan article scoring code.
26271 Ken Raeburn---POP mail support.
26274 Hallvard B Furuseth---various bits and pieces, especially dealing with
26278 Brian Edmonds---@file{gnus-bbdb.el}.
26281 David Moore---rewrite of @file{nnvirtual.el} and many other things.
26284 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
26287 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
26288 well as autoconf support.
26292 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
26293 Borges, and Jost Krieger proof-reading parts of the manual.
26295 The following people have contributed many patches and suggestions:
26310 Jason L. Tibbitts, III,
26312 Katsumi Yamaoka, @c Yamaoka
26316 Also thanks to the following for patches and stuff:
26326 Alexei V. Barantsev,
26341 Massimo Campostrini,
26346 Jae-you Chung, @c ?
26347 James H. Cloos, Jr.,
26351 Andrew J. Cosgriff,
26354 Geoffrey T. Dairiki,
26360 Michael Welsh Duggan,
26365 Enami Tsugutomo, @c Enami
26369 Nelson Jose dos Santos Ferreira,
26377 Arne Georg Gleditsch,
26379 Michelangelo Grigni,
26383 Kenichi Handa, @c Handa
26385 Yoshiki Hayashi, @c Hayashi
26387 Hisashige Kenji, @c Hisashige
26395 Fran@,{c}ois Felix Ingrand,
26396 Tatsuya Ichikawa, @c Ichikawa
26397 Ishikawa Ichiro, @c Ishikawa
26399 Iwamuro Motonori, @c Iwamuro
26409 Peter Skov Knudsen,
26410 Shuhei Kobayashi, @c Kobayashi
26412 Koseki Yoshinori, @c Koseki
26413 Thor Kristoffersen,
26416 Seokchan Lee, @c Lee
26434 Morioka Tomohiko, @c Morioka
26435 Erik Toubro Nielsen,
26442 Masaharu Onishi, @c Onishi
26447 Jens-Ulrik Holger Petersen,
26451 John McClary Prevost,
26457 Lars Balker Rasmussen,
26462 Christian von Roques,
26465 Wolfgang Rupprecht,
26472 Philippe Schnoebelen,
26474 Randal L. Schwartz,
26488 Kiyokazu Suto, @c Suto
26493 Tozawa Akihiko, @c Tozawa
26513 For a full overview of what each person has done, the ChangeLogs
26514 included in the Gnus alpha distributions should give ample reading
26515 (550kB and counting).
26517 Apologies to everybody that I've forgotten, of which there are many, I'm
26520 Gee, that's quite a list of people. I guess that must mean that there
26521 actually are people who are using Gnus. Who'd'a thunk it!
26525 @subsection New Features
26526 @cindex new features
26529 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
26530 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
26531 * Red Gnus:: Third time best---Gnus 5.4/5.5.
26532 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
26533 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
26534 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
26535 * No Gnus:: Very punny.
26538 These lists are, of course, just @emph{short} overviews of the
26539 @emph{most} important new features. No, really. There are tons more.
26540 Yes, we have feeping creaturism in full effect.
26543 @subsubsection (ding) Gnus
26545 New features in Gnus 5.0/5.1:
26550 The look of all buffers can be changed by setting format-like variables
26551 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
26554 Local spool and several @acronym{NNTP} servers can be used at once
26555 (@pxref{Select Methods}).
26558 You can combine groups into virtual groups (@pxref{Virtual Groups}).
26561 You can read a number of different mail formats (@pxref{Getting Mail}).
26562 All the mail back ends implement a convenient mail expiry scheme
26563 (@pxref{Expiring Mail}).
26566 Gnus can use various strategies for gathering threads that have lost
26567 their roots (thereby gathering loose sub-threads into one thread) or it
26568 can go back and retrieve enough headers to build a complete thread
26569 (@pxref{Customizing Threading}).
26572 Killed groups can be displayed in the group buffer, and you can read
26573 them as well (@pxref{Listing Groups}).
26576 Gnus can do partial group updates---you do not have to retrieve the
26577 entire active file just to check for new articles in a few groups
26578 (@pxref{The Active File}).
26581 Gnus implements a sliding scale of subscribedness to groups
26582 (@pxref{Group Levels}).
26585 You can score articles according to any number of criteria
26586 (@pxref{Scoring}). You can even get Gnus to find out how to score
26587 articles for you (@pxref{Adaptive Scoring}).
26590 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
26591 manner, so it should be difficult to lose much data on what you have
26592 read if your machine should go down (@pxref{Auto Save}).
26595 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
26596 cluttering up the @file{.emacs} file.
26599 You can set the process mark on both groups and articles and perform
26600 operations on all the marked items (@pxref{Process/Prefix}).
26603 You can grep through a subset of groups and create a group from the
26604 results (@pxref{Kibozed Groups}).
26607 You can list subsets of groups according to, well, anything
26608 (@pxref{Listing Groups}).
26611 You can browse foreign servers and subscribe to groups from those
26612 servers (@pxref{Browse Foreign Server}).
26615 Gnus can fetch articles, asynchronously, on a second connection to the
26616 server (@pxref{Asynchronous Fetching}).
26619 You can cache articles locally (@pxref{Article Caching}).
26622 The uudecode functions have been expanded and generalized
26623 (@pxref{Decoding Articles}).
26626 You can still post uuencoded articles, which was a little-known feature
26627 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
26630 Fetching parents (and other articles) now actually works without
26631 glitches (@pxref{Finding the Parent}).
26634 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
26637 Digests (and other files) can be used as the basis for groups
26638 (@pxref{Document Groups}).
26641 Articles can be highlighted and customized (@pxref{Customizing
26645 URLs and other external references can be buttonized (@pxref{Article
26649 You can do lots of strange stuff with the Gnus window & frame
26650 configuration (@pxref{Window Layout}).
26653 You can click on buttons instead of using the keyboard
26659 @node September Gnus
26660 @subsubsection September Gnus
26664 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
26668 New features in Gnus 5.2/5.3:
26673 A new message composition mode is used. All old customization variables
26674 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
26678 Gnus is now able to generate @dfn{sparse} threads---threads where
26679 missing articles are represented by empty nodes (@pxref{Customizing
26683 (setq gnus-build-sparse-threads 'some)
26687 Outgoing articles are stored on a special archive server
26688 (@pxref{Archived Messages}).
26691 Partial thread regeneration now happens when articles are
26695 Gnus can make use of GroupLens predictions.
26698 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
26701 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
26704 (setq gnus-use-trees t)
26708 An @code{nn}-like pick-and-read minor mode is available for the summary
26709 buffers (@pxref{Pick and Read}).
26712 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
26716 In binary groups you can use a special binary minor mode (@pxref{Binary
26720 Groups can be grouped in a folding topic hierarchy (@pxref{Group
26724 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
26728 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
26731 Groups can now have a score, and bubbling based on entry frequency
26732 is possible (@pxref{Group Score}).
26735 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
26739 Groups can be process-marked, and commands can be performed on
26740 groups of groups (@pxref{Marking Groups}).
26743 Caching is possible in virtual groups.
26746 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
26747 news batches, ClariNet briefs collections, and just about everything
26748 else (@pxref{Document Groups}).
26751 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
26755 The Gnus cache is much faster.
26758 Groups can be sorted according to many criteria (@pxref{Sorting
26762 New group parameters have been introduced to set list-addresses and
26763 expiry times (@pxref{Group Parameters}).
26766 All formatting specs allow specifying faces to be used
26767 (@pxref{Formatting Fonts}).
26770 There are several more commands for setting/removing/acting on process
26771 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
26774 The summary buffer can be limited to show parts of the available
26775 articles based on a wide range of criteria. These commands have been
26776 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
26779 Articles can be made persistent with the @kbd{*} command
26780 (@pxref{Persistent Articles}).
26783 All functions for hiding article elements are now toggles.
26786 Article headers can be buttonized (@pxref{Article Washing}).
26789 All mail back ends support fetching articles by @code{Message-ID}.
26792 Duplicate mail can now be treated properly (@pxref{Duplicates}).
26795 All summary mode commands are available directly from the article
26796 buffer (@pxref{Article Keymap}).
26799 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
26803 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
26806 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
26811 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
26814 (setq gnus-use-nocem t)
26818 Groups can be made permanently visible (@pxref{Listing Groups}).
26821 (setq gnus-permanently-visible-groups "^nnml:")
26825 Many new hooks have been introduced to make customizing easier.
26828 Gnus respects the @code{Mail-Copies-To} header.
26831 Threads can be gathered by looking at the @code{References} header
26832 (@pxref{Customizing Threading}).
26835 (setq gnus-summary-thread-gathering-function
26836 'gnus-gather-threads-by-references)
26840 Read articles can be stored in a special backlog buffer to avoid
26841 refetching (@pxref{Article Backlog}).
26844 (setq gnus-keep-backlog 50)
26848 A clean copy of the current article is always stored in a separate
26849 buffer to allow easier treatment.
26852 Gnus can suggest where to save articles (@pxref{Saving Articles}).
26855 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
26859 (setq gnus-prompt-before-saving t)
26863 @code{gnus-uu} can view decoded files asynchronously while fetching
26864 articles (@pxref{Other Decode Variables}).
26867 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
26871 Filling in the article buffer now works properly on cited text
26872 (@pxref{Article Washing}).
26875 Hiding cited text adds buttons to toggle hiding, and how much
26876 cited text to hide is now customizable (@pxref{Article Hiding}).
26879 (setq gnus-cited-lines-visible 2)
26883 Boring headers can be hidden (@pxref{Article Hiding}).
26886 Default scoring values can now be set from the menu bar.
26889 Further syntax checking of outgoing articles have been added.
26895 @subsubsection Red Gnus
26897 New features in Gnus 5.4/5.5:
26901 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
26908 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
26911 Article prefetching functionality has been moved up into
26912 Gnus (@pxref{Asynchronous Fetching}).
26915 Scoring can now be performed with logical operators like @code{and},
26916 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
26920 Article washing status can be displayed in the
26921 article mode line (@pxref{Misc Article}).
26924 @file{gnus.el} has been split into many smaller files.
26927 Suppression of duplicate articles based on Message-ID can be done
26928 (@pxref{Duplicate Suppression}).
26931 (setq gnus-suppress-duplicates t)
26935 New variables for specifying what score and adapt files are to be
26936 considered home score and adapt files (@pxref{Home Score File}) have
26940 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
26941 Server Internals}).
26944 Groups can inherit group parameters from parent topics (@pxref{Topic
26948 Article editing has been revamped and is now actually usable.
26951 Signatures can be recognized in more intelligent fashions
26952 (@pxref{Article Signature}).
26955 Summary pick mode has been made to look more @code{nn}-like. Line
26956 numbers are displayed and the @kbd{.} command can be used to pick
26957 articles (@code{Pick and Read}).
26960 Commands for moving the @file{.newsrc.eld} from one server to
26961 another have been added (@pxref{Changing Servers}).
26964 There's a way now to specify that ``uninteresting'' fields be suppressed
26965 when generating lines in buffers (@pxref{Advanced Formatting}).
26968 Several commands in the group buffer can be undone with @kbd{C-M-_}
26972 Scoring can be done on words using the new score type @code{w}
26973 (@pxref{Score File Format}).
26976 Adaptive scoring can be done on a Subject word-by-word basis
26977 (@pxref{Adaptive Scoring}).
26980 (setq gnus-use-adaptive-scoring '(word))
26984 Scores can be decayed (@pxref{Score Decays}).
26987 (setq gnus-decay-scores t)
26991 Scoring can be performed using a regexp on the Date header. The Date is
26992 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
26995 A new command has been added to remove all data on articles from
26996 the native server (@pxref{Changing Servers}).
26999 A new command for reading collections of documents
27000 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
27001 (@pxref{Really Various Summary Commands}).
27004 Process mark sets can be pushed and popped (@pxref{Setting Process
27008 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
27009 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
27012 A new back end for reading searches from Web search engines
27013 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
27014 (@pxref{Web Searches}).
27017 Groups inside topics can now be sorted using the standard sorting
27018 functions, and each topic can be sorted independently (@pxref{Topic
27022 Subsets of the groups can be sorted independently (@code{Sorting
27026 Cached articles can be pulled into the groups (@pxref{Summary Generation
27030 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
27035 Score files are now applied in a more reliable order (@pxref{Score
27039 Reports on where mail messages end up can be generated (@pxref{Splitting
27043 More hooks and functions have been added to remove junk from incoming
27044 mail before saving the mail (@pxref{Washing Mail}).
27047 Emphasized text can be properly fontisized:
27053 @subsubsection Quassia Gnus
27055 New features in Gnus 5.6:
27060 New functionality for using Gnus as an offline newsreader has been
27061 added. A plethora of new commands and modes have been added.
27062 @xref{Gnus Unplugged}, for the full story.
27065 The @code{nndraft} back end has returned, but works differently than
27066 before. All Message buffers are now also articles in the @code{nndraft}
27067 group, which is created automatically.
27070 @code{gnus-alter-header-function} can now be used to alter header
27074 @code{gnus-summary-goto-article} now accept Message-ID's.
27077 A new Message command for deleting text in the body of a message
27078 outside the region: @kbd{C-c C-v}.
27081 You can now post to component group in @code{nnvirtual} groups with
27085 @code{nntp-rlogin-program}---new variable to ease customization.
27088 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
27089 re-highlighting of the article buffer.
27092 New element in @code{gnus-boring-article-headers}---@code{long-to}.
27095 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
27099 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
27100 @kbd{a} to add the score rule to the @file{all.SCORE} file.
27103 @code{gnus-simplify-subject-functions} variable to allow greater
27104 control over simplification.
27107 @kbd{A T}---new command for fetching the current thread.
27110 @kbd{/ T}---new command for including the current thread in the
27114 @kbd{M-RET} is a new Message command for breaking cited text.
27117 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
27120 The @code{custom-face-lookup} function has been removed.
27121 If you used this function in your initialization files, you must
27122 rewrite them to use @code{face-spec-set} instead.
27125 Canceling now uses the current select method. Symbolic prefix
27126 @kbd{a} forces normal posting method.
27129 New command to translate M******** sm*rtq**t*s into proper
27133 For easier debugging of @code{nntp}, you can set
27134 @code{nntp-record-commands} to a non-@code{nil} value.
27137 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
27138 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
27141 A command for editing group parameters from the summary buffer
27145 A history of where mails have been split is available.
27148 A new article date command has been added---@code{article-date-iso8601}.
27151 Subjects can be simplified when threading by setting
27152 @code{gnus-score-thread-simplify}.
27155 A new function for citing in Message has been
27156 added---@code{message-cite-original-without-signature}.
27159 @code{article-strip-all-blank-lines}---new article command.
27162 A new Message command to kill to the end of the article has
27166 A minimum adaptive score can be specified by using the
27167 @code{gnus-adaptive-word-minimum} variable.
27170 The ``lapsed date'' article header can be kept continually
27171 updated by the @code{gnus-start-date-timer} command.
27174 Web listserv archives can be read with the @code{nnlistserv} back end.
27177 Old dejanews archives can now be read by @code{nnweb}.
27181 @node Pterodactyl Gnus
27182 @subsubsection Pterodactyl Gnus
27184 New features in Gnus 5.8:
27189 The mail-fetching functions have changed. See the manual for the
27190 many details. In particular, all procmail fetching variables are gone.
27192 If you used procmail like in
27195 (setq nnmail-use-procmail t)
27196 (setq nnmail-spool-file 'procmail)
27197 (setq nnmail-procmail-directory "~/mail/incoming/")
27198 (setq nnmail-procmail-suffix "\\.in")
27201 this now has changed to
27205 '((directory :path "~/mail/incoming/"
27209 @xref{Mail Source Specifiers}.
27212 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
27213 Gnus, and adds a slew of new commands. See the manual for details.
27216 Gnus has also been multilingualized. This also affects too
27217 many parts of Gnus to summarize here, and adds many new variables.
27220 @code{gnus-auto-select-first} can now be a function to be
27221 called to position point.
27224 The user can now decide which extra headers should be included in
27225 summary buffers and @acronym{NOV} files.
27228 @code{gnus-article-display-hook} has been removed. Instead, a number
27229 of variables starting with @code{gnus-treat-} have been added.
27232 The Gnus posting styles have been redone again and now works in a
27233 subtly different manner.
27236 New web-based back ends have been added: @code{nnslashdot},
27237 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
27238 again, to keep up with ever-changing layouts.
27241 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
27246 @subsubsection Oort Gnus
27249 New features in Gnus 5.10:
27253 @item Installation changes
27254 @c ***********************
27258 Upgrading from previous (stable) version if you have used Oort.
27260 If you have tried Oort (the unstable Gnus branch leading to this
27261 release) but went back to a stable version, be careful when upgrading to
27262 this version. In particular, you will probably want to remove all
27263 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
27264 read from your @file{.newsrc.eld} instead of from the
27265 @file{.marks}/@file{.mrk} file where this release store flags. See a
27266 later entry for more information about marks. Note that downgrading
27267 isn't save in general.
27270 Lisp files are now installed in @file{.../site-lisp/gnus/} by default.
27271 It defaulted to @file{.../site-lisp/} formerly. In addition to this,
27272 the new installer issues a warning if other Gnus installations which
27273 will shadow the latest one are detected. You can then remove those
27274 shadows manually or remove them using @code{make
27275 remove-installed-shadows}.
27278 New @file{make.bat} for compiling and installing Gnus under MS Windows
27280 Use @file{make.bat} if you want to install Gnus under MS Windows, the
27281 first argument to the batch-program should be the directory where
27282 @file{xemacs.exe} respectively @file{emacs.exe} is located, if you want
27283 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
27284 the second parameter.
27286 @file{make.bat} has been rewritten from scratch, it now features
27287 automatic recognition of XEmacs and GNU Emacs, generates
27288 @file{gnus-load.el}, checks if errors occur while compilation and
27289 generation of info files and reports them at the end of the build
27290 process. It now uses @code{makeinfo} if it is available and falls
27291 back to @file{infohack.el} otherwise. @file{make.bat} should now
27292 install all files which are necessary to run Gnus and be generally a
27293 complete replacement for the @code{configure; make; make install}
27294 cycle used under Unix systems.
27296 The new @file{make.bat} makes @file{make-x.bat} and @file{xemacs.mak}
27297 superfluous, so they have been removed.
27300 @file{~/News/overview/} not used.
27302 As a result of the following change, the @file{~/News/overview/}
27303 directory is not used any more. You can safely delete the entire
27306 @c FIXME: `gnus-load' is mentioned in README, which is not included in
27307 @c CVS. We should find a better place for this item.
27309 @code{(require 'gnus-load)}
27311 If you use a stand-alone Gnus distribution, you'd better add
27312 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
27313 lisp directory into load-path.
27315 File @file{gnus-load.el} contains autoload commands, functions and variables,
27316 some of which may not be included in distributions of Emacsen.
27320 @item New packages and libraries within Gnus
27321 @c *****************************************
27326 The revised Gnus @acronym{FAQ} is included in the manual,
27327 @xref{Frequently Asked Questions}.
27330 @acronym{TLS} wrapper shipped with Gnus
27332 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
27333 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
27334 @acronym{TLS}/@acronym{SSL} support via (external third party)
27335 @file{ssl.el} and OpenSSL still works.
27338 Improved anti-spam features.
27340 Gnus is now able to take out spam from your mail and news streams
27341 using a wide variety of programs and filter rules. Among the supported
27342 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
27343 for easy use of external packages such as SpamAssassin and Hashcash
27344 are also new. @ref{Thwarting Email Spam} and @ref{Spam Package}.
27345 @c FIXME: @xref{Spam Package}?. Should this be under Misc?
27348 Gnus supports server-side mail filtering using Sieve.
27350 Sieve rules can be added as Group Parameters for groups, and the
27351 complete Sieve script is generated using @kbd{D g} from the Group
27352 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
27353 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
27354 manual @ref{Top, , Top, sieve, Emacs Sieve}.
27358 @item Changes in group mode
27359 @c ************************
27364 @code{gnus-group-read-ephemeral-group} can be called interactively,
27368 Retrieval of charters and control messages
27370 There are new commands for fetching newsgroup charters (@kbd{H c}) and
27371 control messages (@kbd{H C}).
27374 The new variable @code{gnus-parameters} can be used to set group parameters.
27376 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
27377 the parameters in @file{~/.newsrc.eld}, but via this variable you can
27378 enjoy the powers of customize, and simplified backups since you set the
27379 variable in @file{~/.gnus.el} instead of @file{~/.newsrc.eld}. The
27380 variable maps regular expressions matching group names to group
27383 (setq gnus-parameters
27385 (gnus-show-threads nil)
27386 (gnus-use-scoring nil))
27387 ("^nnimap:\\(foo.bar\\)$"
27388 (to-group . "\\1"))))
27392 Unread count correct in nnimap groups.
27394 The estimated number of unread articles in the group buffer should now
27395 be correct for nnimap groups. This is achieved by calling
27396 @code{nnimap-fixup-unread-after-getting-new-news} from the
27397 @code{gnus-setup-news-hook} (called on startup) and
27398 @code{gnus-after-getting-new-news-hook}. (called after getting new
27399 mail). If you have modified those variables from the default, you may
27400 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
27401 you were happy with the estimate and want to save some (minimal) time
27402 when getting new mail, remove the function.
27405 Group names are treated as UTF-8 by default.
27407 This is supposedly what USEFOR wanted to migrate to. See
27408 @code{gnus-group-name-charset-group-alist} and
27409 @code{gnus-group-name-charset-method-alist} for customization.
27412 @code{gnus-group-charset-alist} and
27413 @code{gnus-group-ignored-charsets-alist}.
27415 The regexps in these variables are compared with full group names
27416 instead of real group names in 5.8. Users who customize these
27417 variables should change those regexps accordingly. For example:
27419 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
27424 @item Changes in summary and article mode
27425 @c **************************************
27430 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
27431 (@code{gnus-article-reply-with-original}) only yank the text in the
27432 region if the region is active.
27435 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
27436 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
27441 More buttons for URLs, mail addresses, Message-IDs, Info links, man
27442 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
27443 variables @code{gnus-button-@var{*}-level} can be used to control the
27444 appearance of all article buttons. @xref{Article Button Levels}.
27447 Single-part yenc encoded attachments can be decoded.
27452 The picons code has been reimplemented to work in GNU Emacs---some of
27453 the previous options have been removed or renamed.
27455 Picons are small ``personal icons'' representing users, domain and
27456 newsgroups, which can be displayed in the Article buffer.
27460 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
27461 boundary line is drawn at the end of the headers.
27464 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
27467 The Summary Buffer uses an arrow in the fringe to indicate the current
27468 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
27471 Warn about email replies to news
27473 Do you often find yourself replying to news by email by mistake? Then
27474 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
27478 If the new option @code{gnus-summary-display-while-building} is
27479 non-@code{nil}, the summary buffer is shown and updated as it's being
27483 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
27484 opposed to old but unread messages).
27487 Gnus supports RFC 2369 mailing list headers, and adds a number of
27488 related commands in mailing list groups. @xref{Mailing List}.
27491 The Date header can be displayed in a format that can be read aloud
27492 in English. @xref{Article Date}.
27495 diffs are automatically highlighted in groups matching
27496 @code{mm-uu-diff-groups-regexp}
27499 Better handling of Microsoft citation styles
27501 Gnus now tries to recognize the mangled header block that some Microsoft
27502 mailers use to indicate that the rest of the message is a citation, even
27503 though it is not quoted in any way. The variable
27504 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
27507 The new command @kbd{W Y f}
27508 (@code{gnus-article-outlook-deuglify-article}) allows deuglifying broken
27509 Outlook (Express) articles.
27512 @code{gnus-article-skip-boring}
27514 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
27515 not scroll down to show you a page that contains only boring text,
27516 which by default means cited text and signature. You can customize
27517 what is skippable using @code{gnus-article-boring-faces}.
27519 This feature is especially useful if you read many articles that
27520 consist of a little new content at the top with a long, untrimmed
27521 message cited below.
27524 Smileys (@samp{:-)}, @samp{;-)} etc) are now displayed graphically in
27527 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.gnus.el} to
27531 Face headers handling. @xref{Face}.
27534 In the summary buffer, the new command @kbd{/ N} inserts new messages
27535 and @kbd{/ o} inserts old messages.
27538 Gnus decodes morse encoded messages if you press @kbd{W m}.
27541 @code{gnus-summary-line-format}
27543 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
27544 %s\n}. Moreover @code{gnus-extra-headers},
27545 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
27546 changed their default so that the users name will be replaced by the
27547 recipient's name or the group name posting to for @acronym{NNTP}
27551 Deleting of attachments.
27553 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
27554 on @acronym{MIME} buttons) saves a part and replaces the part with an
27555 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
27556 @acronym{MIME} buttons) removes a part. It works only on back ends
27557 that support editing.
27560 @code{gnus-default-charset}
27562 The default value is determined from the
27563 @code{current-language-environment} variable, instead of
27564 @code{iso-8859-1}. Also the @samp{.*} item in
27565 @code{gnus-group-charset-alist} is removed.
27568 Printing capabilities are enhanced.
27570 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
27571 Article buffers. Also, each individual @acronym{MIME} part can be
27572 printed using @kbd{p} on the @acronym{MIME} button.
27575 Extended format specs.
27577 Format spec @samp{%&user-date;} is added into
27578 @code{gnus-summary-line-format-alist}. Also, user defined extended
27579 format specs are supported. The extended format specs look like
27580 @samp{%u&foo;}, which invokes function
27581 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
27582 escape character, old user defined format @samp{%u&} is no longer supported.
27585 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
27586 @c FIXME: Was this a user-visible change?
27588 It was aliased to @kbd{Y c}
27589 (@code{gnus-summary-insert-cached-articles}). The new function filters
27590 out other articles.
27593 Some limiting commands accept a @kbd{C-u} prefix to negate the match.
27595 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
27596 s}, @kbd{/ a}, and @kbd{/ x}
27597 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
27598 result will be to display all articles that do not match the expression.
27601 Gnus inlines external parts (message/external).
27605 @item Changes in Message mode and related Gnus features
27606 @c ****************************************************
27613 You can delay the sending of a message with @kbd{C-c C-j} in the Message
27614 buffer. The messages are delivered at specified time. This is useful
27615 for sending yourself reminders. @xref{Delayed Articles}.
27618 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
27619 the nnml back end allows compressed message files.
27622 The new option @code{gnus-gcc-mark-as-read} automatically marks
27623 Gcc articles as read.
27626 Externalizing of attachments
27628 If @code{gnus-gcc-externalize-attachments} or
27629 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
27630 local files as external parts.
27633 The envelope sender address can be customized when using Sendmail.
27634 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
27637 Gnus no longer generate the Sender: header automatically.
27639 Earlier it was generated when the user configurable email address was
27640 different from the Gnus guessed default user address. As the guessing
27641 algorithm is rarely correct these days, and (more controversially) the
27642 only use of the Sender: header was to check if you are entitled to
27643 cancel/supersede news (which is now solved by Cancel Locks instead,
27644 see another entry), generation of the header has been disabled by
27645 default. See the variables @code{message-required-headers},
27646 @code{message-required-news-headers}, and
27647 @code{message-required-mail-headers}.
27650 Features from third party @file{message-utils.el} added to @file{message.el}.
27652 Message now asks if you wish to remove @samp{(was: <old subject>)} from
27653 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
27654 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
27655 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
27656 appropriate headers and a note in the body for cross-postings and
27657 followups (see the variables @code{message-cross-post-@var{*}}).
27660 References and X-Draft-From headers are no longer generated when you
27661 start composing messages and @code{message-generate-headers-first} is
27665 Easy inclusion of X-Faces headers. @xref{X-Face}.
27668 Group Carbon Copy (GCC) quoting
27670 To support groups that contains SPC and other weird characters, groups
27671 are quoted before they are placed in the Gcc: header. This means
27672 variables such as @code{gnus-message-archive-group} should no longer
27673 contain quote characters to make groups containing SPC work. Also, if
27674 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
27675 into two groups) you must change it to return the list
27676 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
27677 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
27678 was incorrect earlier, it just didn't generate any problems since it
27679 was inserted directly.
27682 @code{message-insinuate-rmail}
27684 Adding @code{(message-insinuate-rmail)} and @code{(setq
27685 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
27686 compose, reply and forward messages in message-mode, where you can
27687 enjoy the power of @acronym{MML}.
27690 @code{message-minibuffer-local-map}
27692 The line below enables BBDB in resending a message:
27694 (define-key message-minibuffer-local-map [(tab)]
27695 'bbdb-complete-name)
27699 @code{gnus-posting-styles}
27701 Add a new format of match like
27703 ((header "to" "larsi.*org")
27704 (Organization "Somewhere, Inc."))
27706 The old format like the lines below is obsolete, but still accepted.
27708 (header "to" "larsi.*org"
27709 (Organization "Somewhere, Inc."))
27713 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
27715 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
27716 added into these two variables. If you customized those, perhaps you
27717 need add those two headers too.
27720 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
27721 composing messages, it is enabled by @code{use-hard-newlines}.
27722 Decoding format=flowed was present but not documented in earlier
27726 The option @code{mm-fill-flowed} can be used to disable treatment of
27727 ``format=flowed'' messages. Also, flowed text is disabled when sending
27728 inline PGP signed messages. @xref{Flowed text, , Flowed text,
27729 emacs-mime, The Emacs MIME Manual}. (New in Gnus 5.10.7)
27730 @c This entry is also present in the node "No Gnus".
27733 Gnus supports the generation of RFC 2298 Disposition Notification requests.
27735 This is invoked with the @kbd{C-c M-n} key binding from message mode.
27738 Message supports the Importance: (RFC 2156) header.
27740 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
27744 Gnus supports Cancel Locks in News.
27746 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
27747 used to determine if you wrote an article or not (for canceling and
27748 superseding). Gnus generates a random password string the first time
27749 you post a message, and saves it in your @file{~/.emacs} using the Custom
27750 system. While the variable is called @code{canlock-password}, it is not
27751 security sensitive data. Publishing your canlock string on the web
27752 will not allow anyone to be able to anything she could not already do.
27753 The behavior can be changed by customizing @code{message-insert-canlock}.
27756 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
27757 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
27759 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
27760 additional Lisp libraries. This add several menu items to the
27761 Attachments menu, and @kbd{C-c RET} key bindings, when composing
27762 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
27765 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
27768 This change was made to avoid conflict with the standard binding of
27769 @code{back-to-indentation}, which is also useful in message mode.
27772 The default for @code{message-forward-show-mml} changed to the symbol
27775 The behavior for the @code{best} value is to show @acronym{MML} (i.e.,
27776 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
27777 used when forwarding signed or encrypted messages, as the conversion
27778 invalidate the digital signature.
27781 If @code{auto-compression-mode} is enabled, attachments are automatically
27782 decompressed when activated.
27783 @c FIXME: Does this affect article or message mode?
27786 Support for non-@acronym{ASCII} domain names
27788 Message supports non-@acronym{ASCII} domain names in From:, To: and
27789 Cc: and will query you whether to perform encoding when you try to
27790 send a message. The variable @code{message-use-idna} controls this.
27791 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
27792 and Cc: when you view a message. The variable @code{gnus-use-idna}
27795 @item You can now drag and drop attachments to the Message buffer.
27796 See @code{mml-dnd-protocol-alist} and @code{mml-dnd-attach-options}.
27797 @xref{MIME, ,MIME, message, Message Manual}.
27798 @c New in 5.10.9 / 5.11
27802 @item Changes in back ends
27803 @c ***********************
27807 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
27810 The nndoc back end now supports mailman digests and exim bounces.
27813 Gnus supports Maildir groups.
27815 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
27818 The nnml and nnfolder back ends store marks for each groups.
27820 This makes it possible to take backup of nnml/nnfolder servers/groups
27821 separately of @file{~/.newsrc.eld}, while preserving marks. It also
27822 makes it possible to share articles and marks between users (without
27823 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
27824 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
27825 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
27826 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
27827 another machine, Gnus will automatically use the @file{.marks} or
27828 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
27829 The new server variables @code{nnml-marks-is-evil} and
27830 @code{nnfolder-marks-is-evil} can be used to disable this feature.
27840 The menu bar item (in Group and Summary buffer) named ``Misc'' has
27841 been renamed to ``Gnus''.
27844 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
27845 renamed to ``Attachments''. Note that this menu also contains security
27846 related stuff, like signing and encryption (@pxref{Security, Security,,
27847 message, Message Manual}).
27850 The tool bars have been updated to use GNOME icons in Group, Summary and
27851 Message mode. You can also customize the tool bars. This is a new
27852 feature in Gnus 5.10.9. (Only for Emacs, not in XEmacs.)
27854 @item The tool bar icons are now (de)activated correctly
27855 in the group buffer, see the variable @code{gnus-group-update-tool-bar}.
27856 Its default value depends on your Emacs version. This is a new feature
27861 @item Miscellaneous changes
27862 @c ************************
27869 The Gnus Agent has seen a major updated and is now enabled by default,
27870 and all nntp and nnimap servers from @code{gnus-select-method} and
27871 @code{gnus-secondary-select-method} are agentized by default. Earlier
27872 only the server in @code{gnus-select-method} was agentized by the
27873 default, and the agent was disabled by default. When the agent is
27874 enabled, headers are now also retrieved from the Agent cache instead
27875 of the back ends when possible. Earlier this only happened in the
27876 unplugged state. You can enroll or remove servers with @kbd{J a} and
27877 @kbd{J r} in the server buffer. Gnus will not download articles into
27878 the Agent cache, unless you instruct it to do so, though, by using
27879 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
27880 behavior of having the Agent disabled with @code{(setq gnus-agent
27881 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
27882 is not needed any more.
27885 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
27887 If one reads an article while plugged, and the article already exists
27888 in the Agent, it won't get downloaded once more. @code{(setq
27889 gnus-agent-cache nil)} reverts to the old behavior.
27894 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
27895 bindings in dired buffers to send a file as an attachment, open a file
27896 using the appropriate mailcap entry, and print a file using the mailcap
27900 The format spec @code{%C} for positioning point has changed to @code{%*}.
27903 @code{gnus-slave-unplugged}
27905 A new command which starts Gnus offline in slave mode.
27912 @subsubsection No Gnus
27915 New features in No Gnus:
27916 @c FIXME: Gnus 5.12?
27918 @include gnus-news.texi
27924 @section The Manual
27928 This manual was generated from a TeXinfo file and then run through
27929 either @code{texi2dvi}
27931 or my own home-brewed TeXinfo to \LaTeX\ transformer,
27932 and then run through @code{latex} and @code{dvips}
27934 to get what you hold in your hands now.
27936 The following conventions have been used:
27941 This is a @samp{string}
27944 This is a @kbd{keystroke}
27947 This is a @file{file}
27950 This is a @code{symbol}
27954 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
27958 (setq flargnoze "yes")
27961 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
27964 (setq flumphel 'yes)
27967 @samp{yes} and @code{yes} are two @emph{very} different things---don't
27968 ever get them confused.
27972 Of course, everything in this manual is of vital interest, so you should
27973 read it all. Several times. However, if you feel like skimming the
27974 manual, look for that gnu head you should see in the margin over
27975 there---it means that what's being discussed is of more importance than
27976 the rest of the stuff. (On the other hand, if everything is infinitely
27977 important, how can anything be more important than that? Just one more
27978 of the mysteries of this world, I guess.)
27984 @node On Writing Manuals
27985 @section On Writing Manuals
27987 I guess most manuals are written after-the-fact; documenting a program
27988 that's already there. This is not how this manual is written. When
27989 implementing something, I write the manual entry for that something
27990 straight away. I then see that it's difficult to explain the
27991 functionality, so I write how it's supposed to be, and then I change the
27992 implementation. Writing the documentation and writing the code go hand
27995 This, of course, means that this manual has no, or little, flow. It
27996 documents absolutely everything in Gnus, but often not where you're
27997 looking for it. It is a reference manual, and not a guide to how to get
28000 That would be a totally different book, that should be written using the
28001 reference manual as source material. It would look quite different.
28006 @section Terminology
28008 @cindex terminology
28013 This is what you are supposed to use this thing for---reading news.
28014 News is generally fetched from a nearby @acronym{NNTP} server, and is
28015 generally publicly available to everybody. If you post news, the entire
28016 world is likely to read just what you have written, and they'll all
28017 snigger mischievously. Behind your back.
28021 Everything that's delivered to you personally is mail. Some news/mail
28022 readers (like Gnus) blur the distinction between mail and news, but
28023 there is a difference. Mail is private. News is public. Mailing is
28024 not posting, and replying is not following up.
28028 Send a mail to the person who has written what you are reading.
28032 Post an article to the current newsgroup responding to the article you
28037 Gnus considers mail and news to be mostly the same, really. The only
28038 difference is how to access the actual articles. News articles are
28039 commonly fetched via the protocol @acronym{NNTP}, whereas mail
28040 messages could be read from a file on the local disk. The internal
28041 architecture of Gnus thus comprises a ``front end'' and a number of
28042 ``back ends''. Internally, when you enter a group (by hitting
28043 @key{RET}, say), you thereby invoke a function in the front end in
28044 Gnus. The front end then ``talks'' to a back end and says things like
28045 ``Give me the list of articles in the foo group'' or ``Show me article
28048 So a back end mainly defines either a protocol (the @code{nntp} back
28049 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
28050 accesses mail via @acronym{IMAP}) or a file format and directory
28051 layout (the @code{nnspool} back end accesses news via the common
28052 ``spool directory'' format, the @code{nnml} back end access mail via a
28053 file format and directory layout that's quite similar).
28055 Gnus does not handle the underlying media, so to speak---this is all
28056 done by the back ends. A back end is a collection of functions to
28057 access the articles.
28059 However, sometimes the term ``back end'' is also used where ``server''
28060 would have been more appropriate. And then there is the term ``select
28061 method'' which can mean either. The Gnus terminology can be quite
28066 Gnus will always use one method (and back end) as the @dfn{native}, or
28067 default, way of getting news.
28071 You can also have any number of foreign groups active at the same time.
28072 These are groups that use non-native non-secondary back ends for getting
28077 Secondary back ends are somewhere half-way between being native and being
28078 foreign, but they mostly act like they are native.
28082 A message that has been posted as news.
28085 @cindex mail message
28086 A message that has been mailed.
28090 A mail message or news article
28094 The top part of a message, where administrative information (etc.) is
28099 The rest of an article. Everything not in the head is in the
28104 A line from the head of an article.
28108 A collection of such lines, or a collection of heads. Or even a
28109 collection of @acronym{NOV} lines.
28111 @item @acronym{NOV}
28112 @cindex @acronym{NOV}
28113 @acronym{NOV} stands for News OverView, which is a type of news server
28114 header which provide datas containing the condensed header information
28115 of articles. They are produced by the server itself; in the @code{nntp}
28116 back end Gnus uses the ones that the @acronym{NNTP} server makes, but
28117 Gnus makes them by itself for some backends (in particular, @code{nnml}).
28119 When Gnus enters a group, it asks the back end for the headers of all
28120 unread articles in the group. Most servers support the News OverView
28121 format, which is more compact and much faster to read and parse than the
28122 normal @sc{head} format.
28124 The @acronym{NOV} data consist of one or more text lines (@pxref{Text
28125 Lines, ,Motion by Text Lines, elisp, The Emacs Lisp Reference Manual})
28126 where each line has the header information of one article. The header
28127 information is a tab-separated series of the header's contents including
28128 an article number, a subject, an author, a date, a message-id,
28131 Those data enable Gnus to generate summary lines quickly. However, if
28132 the server does not support @acronym{NOV} or you disable it purposely or
28133 for some reason, Gnus will try to generate the header information by
28134 parsing each article's headers one by one. It will take time.
28135 Therefore, it is not usually a good idea to set nn*-nov-is-evil
28136 (@pxref{Slow/Expensive Connection}) to a non-@code{nil} value unless you
28137 know that the server makes wrong @acronym{NOV} data.
28141 Each group is subscribed at some @dfn{level} or other (1-9). The ones
28142 that have a lower level are ``more'' subscribed than the groups with a
28143 higher level. In fact, groups on levels 1-5 are considered
28144 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
28145 are @dfn{killed}. Commands for listing groups and scanning for new
28146 articles will all use the numeric prefix as @dfn{working level}.
28148 @item killed groups
28149 @cindex killed groups
28150 No information on killed groups is stored or updated, which makes killed
28151 groups much easier to handle than subscribed groups.
28153 @item zombie groups
28154 @cindex zombie groups
28155 Just like killed groups, only slightly less dead.
28158 @cindex active file
28159 The news server has to keep track of what articles it carries, and what
28160 groups exist. All this information in stored in the active file, which
28161 is rather large, as you might surmise.
28164 @cindex bogus groups
28165 A group that exists in the @file{.newsrc} file, but isn't known to the
28166 server (i.e., it isn't in the active file), is a @emph{bogus group}.
28167 This means that the group probably doesn't exist (any more).
28170 @cindex activating groups
28171 The act of asking the server for info on a group and computing the
28172 number of unread articles is called @dfn{activating the group}.
28173 Un-activated groups are listed with @samp{*} in the group buffer.
28177 News servers store their articles locally in one fashion or other.
28178 One old-fashioned storage method is to have just one file per
28179 article. That's called a ``traditional spool''.
28183 A machine one can connect to and get news (or mail) from.
28185 @item select method
28186 @cindex select method
28187 A structure that specifies the back end, the server and the virtual
28190 @item virtual server
28191 @cindex virtual server
28192 A named select method. Since a select method defines all there is to
28193 know about connecting to a (physical) server, taking the thing as a
28194 whole is a virtual server.
28198 Taking a buffer and running it through a filter of some sort. The
28199 result will (more often than not) be cleaner and more pleasing than the
28202 @item ephemeral groups
28203 @cindex ephemeral groups
28204 @cindex temporary groups
28205 Most groups store data on what articles you have read. @dfn{Ephemeral}
28206 groups are groups that will have no data stored---when you exit the
28207 group, it'll disappear into the aether.
28210 @cindex solid groups
28211 This is the opposite of ephemeral groups. All groups listed in the
28212 group buffer are solid groups.
28214 @item sparse articles
28215 @cindex sparse articles
28216 These are article placeholders shown in the summary buffer when
28217 @code{gnus-build-sparse-threads} has been switched on.
28221 To put responses to articles directly after the articles they respond
28222 to---in a hierarchical fashion.
28226 @cindex thread root
28227 The first article in a thread is the root. It is the ancestor of all
28228 articles in the thread.
28232 An article that has responses.
28236 An article that responds to a different article---its parent.
28240 A collection of messages in one file. The most common digest format is
28241 specified by RFC 1153.
28244 @cindex splitting, terminology
28245 @cindex mail sorting
28246 @cindex mail filtering (splitting)
28247 The action of sorting your emails according to certain rules. Sometimes
28248 incorrectly called mail filtering.
28254 @node Customization
28255 @section Customization
28256 @cindex general customization
28258 All variables are properly documented elsewhere in this manual. This
28259 section is designed to give general pointers on how to customize Gnus
28260 for some quite common situations.
28263 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
28264 * Slow Terminal Connection:: You run a remote Emacs.
28265 * Little Disk Space:: You feel that having large setup files is icky.
28266 * Slow Machine:: You feel like buying a faster machine.
28270 @node Slow/Expensive Connection
28271 @subsection Slow/Expensive Connection
28273 If you run Emacs on a machine locally, and get your news from a machine
28274 over some very thin strings, you want to cut down on the amount of data
28275 Gnus has to get from the server.
28279 @item gnus-read-active-file
28280 Set this to @code{nil}, which will inhibit Gnus from requesting the
28281 entire active file from the server. This file is often very large. You
28282 also have to set @code{gnus-check-new-newsgroups} and
28283 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
28284 doesn't suddenly decide to fetch the active file anyway.
28286 @item gnus-nov-is-evil
28287 @vindex gnus-nov-is-evil
28288 Usually this one must @emph{always} be @code{nil} (which is the
28289 default). If, for example, you wish to not use @acronym{NOV}
28290 (@pxref{Terminology}) with the @code{nntp} back end (@pxref{Crosspost
28291 Handling}), set @code{nntp-nov-is-evil} to a non-@code{nil} value
28292 instead of setting this. But you normally do not need to set
28293 @code{nntp-nov-is-evil} since Gnus by itself will detect whether the
28294 @acronym{NNTP} server supports @acronym{NOV}. Anyway, grabbing article
28295 headers from the @acronym{NNTP} server will not be very fast if you tell
28296 Gnus not to use @acronym{NOV}.
28298 As the variables for the other back ends, there are
28299 @code{nndiary-nov-is-evil}, @code{nndir-nov-is-evil},
28300 @code{nnfolder-nov-is-evil}, @code{nnimap-nov-is-evil},
28301 @code{nnml-nov-is-evil}, @code{nnspool-nov-is-evil}, and
28302 @code{nnwarchive-nov-is-evil}. Note that a non-@code{nil} value for
28303 @code{gnus-nov-is-evil} overrides all those variables.@footnote{Although
28304 the back ends @code{nnkiboze}, @code{nnslashdot}, @code{nnultimate}, and
28305 @code{nnwfm} don't have their own nn*-nov-is-evil.}
28309 @node Slow Terminal Connection
28310 @subsection Slow Terminal Connection
28312 Let's say you use your home computer for dialing up the system that runs
28313 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
28314 possible) the amount of data sent over the wires.
28318 @item gnus-auto-center-summary
28319 Set this to @code{nil} to inhibit Gnus from re-centering the summary
28320 buffer all the time. If it is @code{vertical}, do only vertical
28321 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
28322 horizontal and vertical recentering.
28324 @item gnus-visible-headers
28325 Cut down on the headers included in the articles to the
28326 minimum. You can, in fact, make do without them altogether---most of the
28327 useful data is in the summary buffer, anyway. Set this variable to
28328 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
28330 Use the following to enable all the available hiding features:
28332 (setq gnus-treat-hide-headers 'head
28333 gnus-treat-hide-signature t
28334 gnus-treat-hide-citation t)
28337 @item gnus-use-full-window
28338 By setting this to @code{nil}, you can make all the windows smaller.
28339 While this doesn't really cut down much generally, it means that you
28340 have to see smaller portions of articles before deciding that you didn't
28341 want to read them anyway.
28343 @item gnus-thread-hide-subtree
28344 If this is non-@code{nil}, all threads in the summary buffer will be
28348 @item gnus-updated-mode-lines
28349 If this is @code{nil}, Gnus will not put information in the buffer mode
28350 lines, which might save some time.
28354 @node Little Disk Space
28355 @subsection Little Disk Space
28358 The startup files can get rather large, so you may want to cut their
28359 sizes a bit if you are running out of space.
28363 @item gnus-save-newsrc-file
28364 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
28365 only save @file{.newsrc.eld}. This means that you will not be able to
28366 use any other newsreaders than Gnus. This variable is @code{t} by
28369 @item gnus-read-newsrc-file
28370 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
28371 only read @file{.newsrc.eld}. This means that you will not be able to
28372 use any other newsreaders than Gnus. This variable is @code{t} by
28375 @item gnus-save-killed-list
28376 If this is @code{nil}, Gnus will not save the list of dead groups. You
28377 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
28378 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
28379 variable to @code{nil}. This variable is @code{t} by default.
28385 @subsection Slow Machine
28386 @cindex slow machine
28388 If you have a slow machine, or are just really impatient, there are a
28389 few things you can do to make Gnus run faster.
28391 Set @code{gnus-check-new-newsgroups} and
28392 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
28394 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
28395 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
28396 summary buffer faster. Also @pxref{Slow/Expensive Connection}.
28400 @node Troubleshooting
28401 @section Troubleshooting
28402 @cindex troubleshooting
28404 Gnus works @emph{so} well straight out of the box---I can't imagine any
28412 Make sure your computer is switched on.
28415 Make sure that you really load the current Gnus version. If you have
28416 been running @sc{gnus}, you need to exit Emacs and start it up again before
28420 Try doing an @kbd{M-x gnus-version}. If you get something that looks
28422 @samp{No Gnus v0.7} @c Adjust ../Makefile.in if you change this line!
28424 you have the right files loaded. Otherwise you have some old @file{.el}
28425 files lying around. Delete these.
28428 Read the help group (@kbd{G h} in the group buffer) for a
28429 @acronym{FAQ} and a how-to.
28432 @vindex max-lisp-eval-depth
28433 Gnus works on many recursive structures, and in some extreme (and very
28434 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
28435 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
28436 something like that.
28439 If all else fails, report the problem as a bug.
28442 @cindex reporting bugs
28444 @kindex M-x gnus-bug
28446 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
28447 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
28448 me the backtrace. I will fix bugs, but I can only fix them if you send
28449 me a precise description as to how to reproduce the bug.
28451 You really can never be too detailed in a bug report. Always use the
28452 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
28453 a 10Kb mail each time you use it, and even if you have sent me your
28454 environment 500 times before. I don't care. I want the full info each
28457 It is also important to remember that I have no memory whatsoever. If
28458 you send a bug report, and I send you a reply, and then you just send
28459 back ``No, it's not! Moron!'', I will have no idea what you are
28460 insulting me about. Always over-explain everything. It's much easier
28461 for all of us---if I don't have all the information I need, I will just
28462 mail you and ask for more info, and everything takes more time.
28464 If the problem you're seeing is very visual, and you can't quite explain
28465 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
28466 it somewhere it can be reached, and include the URL of the picture in
28470 If you would like to contribute a patch to fix bugs or make
28471 improvements, please produce the patch using @samp{diff -u}.
28474 If you want to debug your problem further before reporting, possibly
28475 in order to solve the problem yourself and send a patch, you can use
28476 edebug. Debugging Lisp code is documented in the Elisp manual
28477 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
28478 Lisp Reference Manual}). To get you started with edebug, consider if
28479 you discover some weird behavior when pressing @kbd{c}, the first
28480 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
28481 the documentation buffer that leads you to the function definition,
28482 then press @kbd{M-x edebug-defun RET} with point inside that function,
28483 return to Gnus and press @kbd{c} to invoke the code. You will be
28484 placed in the lisp buffer and can single step using @kbd{SPC} and
28485 evaluate expressions using @kbd{M-:} or inspect variables using
28486 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
28487 @kbd{c} or @kbd{g}.
28492 Sometimes, a problem do not directly generate an elisp error but
28493 manifests itself by causing Gnus to be very slow. In these cases, you
28494 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
28495 slow, and then try to analyze the backtrace (repeating the procedure
28496 helps isolating the real problem areas).
28498 A fancier approach is to use the elisp profiler, ELP. The profiler is
28499 (or should be) fully documented elsewhere, but to get you started
28500 there are a few steps that need to be followed. First, instrument the
28501 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
28502 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
28503 RET message}. Then perform the operation that is slow and press
28504 @kbd{M-x elp-results}. You will then see which operations that takes
28505 time, and can debug them further. If the entire operation takes much
28506 longer than the time spent in the slowest function in the profiler
28507 output, you probably profiled the wrong part of Gnus. To reset
28508 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
28509 elp-restore-all} is supposed to remove profiling, but given the
28510 complexities and dynamic code generation in Gnus, it might not always
28513 @cindex gnu.emacs.gnus
28514 @cindex ding mailing list
28515 If you just need help, you are better off asking on
28516 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
28517 @email{ding@@gnus.org, the ding mailing list}. Write to
28518 @email{ding-request@@gnus.org} to subscribe.
28522 @node Gnus Reference Guide
28523 @section Gnus Reference Guide
28525 It is my hope that other people will figure out smart stuff that Gnus
28526 can do, and that other people will write those smart things as well. To
28527 facilitate that I thought it would be a good idea to describe the inner
28528 workings of Gnus. And some of the not-so-inner workings, while I'm at
28531 You can never expect the internals of a program not to change, but I
28532 will be defining (in some details) the interface between Gnus and its
28533 back ends (this is written in stone), the format of the score files
28534 (ditto), data structures (some are less likely to change than others)
28535 and general methods of operation.
28538 * Gnus Utility Functions:: Common functions and variable to use.
28539 * Back End Interface:: How Gnus communicates with the servers.
28540 * Score File Syntax:: A BNF definition of the score file standard.
28541 * Headers:: How Gnus stores headers internally.
28542 * Ranges:: A handy format for storing mucho numbers.
28543 * Group Info:: The group info format.
28544 * Extended Interactive:: Symbolic prefixes and stuff.
28545 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
28546 * Various File Formats:: Formats of files that Gnus use.
28550 @node Gnus Utility Functions
28551 @subsection Gnus Utility Functions
28552 @cindex Gnus utility functions
28553 @cindex utility functions
28555 @cindex internal variables
28557 When writing small functions to be run from hooks (and stuff), it's
28558 vital to have access to the Gnus internal functions and variables.
28559 Below is a list of the most common ones.
28563 @item gnus-newsgroup-name
28564 @vindex gnus-newsgroup-name
28565 This variable holds the name of the current newsgroup.
28567 @item gnus-find-method-for-group
28568 @findex gnus-find-method-for-group
28569 A function that returns the select method for @var{group}.
28571 @item gnus-group-real-name
28572 @findex gnus-group-real-name
28573 Takes a full (prefixed) Gnus group name, and returns the unprefixed
28576 @item gnus-group-prefixed-name
28577 @findex gnus-group-prefixed-name
28578 Takes an unprefixed group name and a select method, and returns the full
28579 (prefixed) Gnus group name.
28581 @item gnus-get-info
28582 @findex gnus-get-info
28583 Returns the group info list for @var{group}.
28585 @item gnus-group-unread
28586 @findex gnus-group-unread
28587 The number of unread articles in @var{group}, or @code{t} if that is
28591 @findex gnus-active
28592 The active entry for @var{group}.
28594 @item gnus-set-active
28595 @findex gnus-set-active
28596 Set the active entry for @var{group}.
28598 @item gnus-add-current-to-buffer-list
28599 @findex gnus-add-current-to-buffer-list
28600 Adds the current buffer to the list of buffers to be killed on Gnus
28603 @item gnus-continuum-version
28604 @findex gnus-continuum-version
28605 Takes a Gnus version string as a parameter and returns a floating point
28606 number. Earlier versions will always get a lower number than later
28609 @item gnus-group-read-only-p
28610 @findex gnus-group-read-only-p
28611 Says whether @var{group} is read-only or not.
28613 @item gnus-news-group-p
28614 @findex gnus-news-group-p
28615 Says whether @var{group} came from a news back end.
28617 @item gnus-ephemeral-group-p
28618 @findex gnus-ephemeral-group-p
28619 Says whether @var{group} is ephemeral or not.
28621 @item gnus-server-to-method
28622 @findex gnus-server-to-method
28623 Returns the select method corresponding to @var{server}.
28625 @item gnus-server-equal
28626 @findex gnus-server-equal
28627 Says whether two virtual servers are equal.
28629 @item gnus-group-native-p
28630 @findex gnus-group-native-p
28631 Says whether @var{group} is native or not.
28633 @item gnus-group-secondary-p
28634 @findex gnus-group-secondary-p
28635 Says whether @var{group} is secondary or not.
28637 @item gnus-group-foreign-p
28638 @findex gnus-group-foreign-p
28639 Says whether @var{group} is foreign or not.
28641 @item gnus-group-find-parameter
28642 @findex gnus-group-find-parameter
28643 Returns the parameter list of @var{group}. If given a second parameter,
28644 returns the value of that parameter for @var{group}.
28646 @item gnus-group-set-parameter
28647 @findex gnus-group-set-parameter
28648 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
28650 @item gnus-narrow-to-body
28651 @findex gnus-narrow-to-body
28652 Narrows the current buffer to the body of the article.
28654 @item gnus-check-backend-function
28655 @findex gnus-check-backend-function
28656 Takes two parameters, @var{function} and @var{group}. If the back end
28657 @var{group} comes from supports @var{function}, return non-@code{nil}.
28660 (gnus-check-backend-function "request-scan" "nnml:misc")
28664 @item gnus-read-method
28665 @findex gnus-read-method
28666 Prompts the user for a select method.
28671 @node Back End Interface
28672 @subsection Back End Interface
28674 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
28675 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
28676 server is a @dfn{back end} and some @dfn{back end variables}. As examples
28677 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
28678 examples of the latter we have @code{nntp-port-number} and
28679 @code{nnmbox-directory}.
28681 When Gnus asks for information from a back end---say @code{nntp}---on
28682 something, it will normally include a virtual server name in the
28683 function parameters. (If not, the back end should use the ``current''
28684 virtual server.) For instance, @code{nntp-request-list} takes a virtual
28685 server as its only (optional) parameter. If this virtual server hasn't
28686 been opened, the function should fail.
28688 Note that a virtual server name has no relation to some physical server
28689 name. Take this example:
28693 (nntp-address "ifi.uio.no")
28694 (nntp-port-number 4324))
28697 Here the virtual server name is @samp{odd-one} while the name of
28698 the physical server is @samp{ifi.uio.no}.
28700 The back ends should be able to switch between several virtual servers.
28701 The standard back ends implement this by keeping an alist of virtual
28702 server environments that they pull down/push up when needed.
28704 There are two groups of interface functions: @dfn{required functions},
28705 which must be present, and @dfn{optional functions}, which Gnus will
28706 always check for presence before attempting to call 'em.
28708 All these functions are expected to return data in the buffer
28709 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
28710 unfortunately named, but we'll have to live with it. When I talk about
28711 @dfn{resulting data}, I always refer to the data in that buffer. When I
28712 talk about @dfn{return value}, I talk about the function value returned by
28713 the function call. Functions that fail should return @code{nil} as the
28716 Some back ends could be said to be @dfn{server-forming} back ends, and
28717 some might be said not to be. The latter are back ends that generally
28718 only operate on one group at a time, and have no concept of ``server''
28719 ---they have a group, and they deliver info on that group and nothing
28722 Gnus identifies each message by way of group name and article number. A
28723 few remarks about these article numbers might be useful. First of all,
28724 the numbers are positive integers. Secondly, it is normally not
28725 possible for later articles to ``re-use'' older article numbers without
28726 confusing Gnus. That is, if a group has ever contained a message
28727 numbered 42, then no other message may get that number, or Gnus will get
28728 mightily confused.@footnote{See the function
28729 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
28730 Third, article numbers must be assigned in order of arrival in the
28731 group; this is not necessarily the same as the date of the message.
28733 The previous paragraph already mentions all the ``hard'' restrictions that
28734 article numbers must fulfill. But it seems that it might be useful to
28735 assign @emph{consecutive} article numbers, for Gnus gets quite confused
28736 if there are holes in the article numbering sequence. However, due to
28737 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
28738 also useful for the article numbers to start at 1 to avoid running out
28739 of numbers as long as possible.
28741 Note that by convention, back ends are named @code{nnsomething}, but
28742 Gnus also comes with some @code{nnnotbackends}, such as
28743 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
28745 In the examples and definitions I will refer to the imaginary back end
28748 @cindex @code{nnchoke}
28751 * Required Back End Functions:: Functions that must be implemented.
28752 * Optional Back End Functions:: Functions that need not be implemented.
28753 * Error Messaging:: How to get messages and report errors.
28754 * Writing New Back Ends:: Extending old back ends.
28755 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
28756 * Mail-like Back Ends:: Some tips on mail back ends.
28760 @node Required Back End Functions
28761 @subsubsection Required Back End Functions
28765 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
28767 @var{articles} is either a range of article numbers or a list of
28768 @code{Message-ID}s. Current back ends do not fully support either---only
28769 sequences (lists) of article numbers, and most back ends do not support
28770 retrieval of @code{Message-ID}s. But they should try for both.
28772 The result data should either be HEADs or @acronym{NOV} lines, and the result
28773 value should either be @code{headers} or @code{nov} to reflect this.
28774 This might later be expanded to @code{various}, which will be a mixture
28775 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
28777 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
28778 headers'', in some meaning of the word. This is generally done by
28779 fetching (at most) @var{fetch-old} extra headers less than the smallest
28780 article number in @code{articles}, and filling the gaps as well. The
28781 presence of this parameter can be ignored if the back end finds it
28782 cumbersome to follow the request. If this is non-@code{nil} and not a
28783 number, do maximum fetches.
28785 Here's an example HEAD:
28788 221 1056 Article retrieved.
28789 Path: ifi.uio.no!sturles
28790 From: sturles@@ifi.uio.no (Sturle Sunde)
28791 Newsgroups: ifi.discussion
28792 Subject: Re: Something very droll
28793 Date: 27 Oct 1994 14:02:57 +0100
28794 Organization: Dept. of Informatics, University of Oslo, Norway
28796 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
28797 References: <38jdmq$4qu@@visbur.ifi.uio.no>
28798 NNTP-Posting-Host: holmenkollen.ifi.uio.no
28802 So a @code{headers} return value would imply that there's a number of
28803 these in the data buffer.
28805 Here's a BNF definition of such a buffer:
28809 head = error / valid-head
28810 error-message = [ "4" / "5" ] 2number " " <error message> eol
28811 valid-head = valid-message *header "." eol
28812 valid-message = "221 " <number> " Article retrieved." eol
28813 header = <text> eol
28817 (The version of BNF used here is the one used in RFC822.)
28819 If the return value is @code{nov}, the data buffer should contain
28820 @dfn{network overview database} lines. These are basically fields
28824 nov-buffer = *nov-line
28825 nov-line = field 7*8[ <TAB> field ] eol
28826 field = <text except TAB>
28829 For a closer look at what should be in those fields,
28833 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
28835 @var{server} is here the virtual server name. @var{definitions} is a
28836 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
28838 If the server can't be opened, no error should be signaled. The back end
28839 may then choose to refuse further attempts at connecting to this
28840 server. In fact, it should do so.
28842 If the server is opened already, this function should return a
28843 non-@code{nil} value. There should be no data returned.
28846 @item (nnchoke-close-server &optional SERVER)
28848 Close connection to @var{server} and free all resources connected
28849 to it. Return @code{nil} if the server couldn't be closed for some
28852 There should be no data returned.
28855 @item (nnchoke-request-close)
28857 Close connection to all servers and free all resources that the back end
28858 have reserved. All buffers that have been created by that back end
28859 should be killed. (Not the @code{nntp-server-buffer}, though.) This
28860 function is generally only called when Gnus is shutting down.
28862 There should be no data returned.
28865 @item (nnchoke-server-opened &optional SERVER)
28867 If @var{server} is the current virtual server, and the connection to the
28868 physical server is alive, then this function should return a
28869 non-@code{nil} value. This function should under no circumstances
28870 attempt to reconnect to a server we have lost connection to.
28872 There should be no data returned.
28875 @item (nnchoke-status-message &optional SERVER)
28877 This function should return the last error message from @var{server}.
28879 There should be no data returned.
28882 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
28884 The result data from this function should be the article specified by
28885 @var{article}. This might either be a @code{Message-ID} or a number.
28886 It is optional whether to implement retrieval by @code{Message-ID}, but
28887 it would be nice if that were possible.
28889 If @var{to-buffer} is non-@code{nil}, the result data should be returned
28890 in this buffer instead of the normal data buffer. This is to make it
28891 possible to avoid copying large amounts of data from one buffer to
28892 another, while Gnus mainly requests articles to be inserted directly
28893 into its article buffer.
28895 If it is at all possible, this function should return a cons cell where
28896 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
28897 the article number. This will enable Gnus to find out what the real
28898 group and article numbers are when fetching articles by
28899 @code{Message-ID}. If this isn't possible, @code{t} should be returned
28900 on successful article retrieval.
28903 @item (nnchoke-request-group GROUP &optional SERVER FAST)
28905 Get data on @var{group}. This function also has the side effect of
28906 making @var{group} the current group.
28908 If @var{fast}, don't bother to return useful data, just make @var{group}
28911 Here's an example of some result data and a definition of the same:
28914 211 56 1000 1059 ifi.discussion
28917 The first number is the status, which should be 211. Next is the
28918 total number of articles in the group, the lowest article number, the
28919 highest article number, and finally the group name. Note that the total
28920 number of articles may be less than one might think while just
28921 considering the highest and lowest article numbers, but some articles
28922 may have been canceled. Gnus just discards the total-number, so
28923 whether one should take the bother to generate it properly (if that is a
28924 problem) is left as an exercise to the reader. If the group contains no
28925 articles, the lowest article number should be reported as 1 and the
28929 group-status = [ error / info ] eol
28930 error = [ "4" / "5" ] 2<number> " " <Error message>
28931 info = "211 " 3* [ <number> " " ] <string>
28935 @item (nnchoke-close-group GROUP &optional SERVER)
28937 Close @var{group} and free any resources connected to it. This will be
28938 a no-op on most back ends.
28940 There should be no data returned.
28943 @item (nnchoke-request-list &optional SERVER)
28945 Return a list of all groups available on @var{server}. And that means
28948 Here's an example from a server that only carries two groups:
28951 ifi.test 0000002200 0000002000 y
28952 ifi.discussion 3324 3300 n
28955 On each line we have a group name, then the highest article number in
28956 that group, the lowest article number, and finally a flag. If the group
28957 contains no articles, the lowest article number should be reported as 1
28958 and the highest as 0.
28961 active-file = *active-line
28962 active-line = name " " <number> " " <number> " " flags eol
28964 flags = "n" / "y" / "m" / "x" / "j" / "=" name
28967 The flag says whether the group is read-only (@samp{n}), is moderated
28968 (@samp{m}), is dead (@samp{x}), is aliased to some other group
28969 (@samp{=other-group}) or none of the above (@samp{y}).
28972 @item (nnchoke-request-post &optional SERVER)
28974 This function should post the current buffer. It might return whether
28975 the posting was successful or not, but that's not required. If, for
28976 instance, the posting is done asynchronously, it has generally not been
28977 completed by the time this function concludes. In that case, this
28978 function should set up some kind of sentinel to beep the user loud and
28979 clear if the posting could not be completed.
28981 There should be no result data from this function.
28986 @node Optional Back End Functions
28987 @subsubsection Optional Back End Functions
28991 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
28993 @var{groups} is a list of groups, and this function should request data
28994 on all those groups. How it does it is of no concern to Gnus, but it
28995 should attempt to do this in a speedy fashion.
28997 The return value of this function can be either @code{active} or
28998 @code{group}, which says what the format of the result data is. The
28999 former is in the same format as the data from
29000 @code{nnchoke-request-list}, while the latter is a buffer full of lines
29001 in the same format as @code{nnchoke-request-group} gives.
29004 group-buffer = *active-line / *group-status
29008 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
29010 A Gnus group info (@pxref{Group Info}) is handed to the back end for
29011 alterations. This comes in handy if the back end really carries all
29012 the information (as is the case with virtual and imap groups). This
29013 function should destructively alter the info to suit its needs, and
29014 should return a non-@code{nil} value (exceptionally,
29015 @code{nntp-request-update-info} always returns @code{nil} not to waste
29016 the network resources).
29018 There should be no result data from this function.
29021 @item (nnchoke-request-type GROUP &optional ARTICLE)
29023 When the user issues commands for ``sending news'' (@kbd{F} in the
29024 summary buffer, for instance), Gnus has to know whether the article the
29025 user is following up on is news or mail. This function should return
29026 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
29027 is mail and @code{unknown} if the type can't be decided. (The
29028 @var{article} parameter is necessary in @code{nnvirtual} groups which
29029 might very well combine mail groups and news groups.) Both @var{group}
29030 and @var{article} may be @code{nil}.
29032 There should be no result data from this function.
29035 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
29037 Set/remove/add marks on articles. Normally Gnus handles the article
29038 marks (such as read, ticked, expired etc) internally, and store them in
29039 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
29040 all information about the articles on the server, so Gnus need to
29041 propagate the mark information to the server.
29043 @var{action} is a list of mark setting requests, having this format:
29046 (RANGE ACTION MARK)
29049 @var{range} is a range of articles you wish to update marks on.
29050 @var{action} is @code{add} or @code{del}, used to add marks or remove
29051 marks (preserving all marks not mentioned). @var{mark} is a list of
29052 marks; where each mark is a symbol. Currently used marks are
29053 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
29054 @code{dormant}, @code{save}, @code{download}, @code{unsend},
29055 @code{forward} and @code{recent}, but your back end should, if
29056 possible, not limit itself to these.
29058 Given contradictory actions, the last action in the list should be the
29059 effective one. That is, if your action contains a request to add the
29060 @code{tick} mark on article 1 and, later in the list, a request to
29061 remove the mark on the same article, the mark should in fact be removed.
29063 An example action list:
29066 (((5 12 30) 'del '(tick))
29067 ((10 . 90) 'add '(read expire))
29068 ((92 94) 'del '(read)))
29071 The function should return a range of articles it wasn't able to set the
29072 mark on (currently not used for anything).
29074 There should be no result data from this function.
29076 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
29078 If the user tries to set a mark that the back end doesn't like, this
29079 function may change the mark. Gnus will use whatever this function
29080 returns as the mark for @var{article} instead of the original
29081 @var{mark}. If the back end doesn't care, it must return the original
29082 @var{mark}, and not @code{nil} or any other type of garbage.
29084 The only use for this I can see is what @code{nnvirtual} does with
29085 it---if a component group is auto-expirable, marking an article as read
29086 in the virtual group should result in the article being marked as
29089 There should be no result data from this function.
29092 @item (nnchoke-request-scan &optional GROUP SERVER)
29094 This function may be called at any time (by Gnus or anything else) to
29095 request that the back end check for incoming articles, in one way or
29096 another. A mail back end will typically read the spool file or query
29097 the @acronym{POP} server when this function is invoked. The
29098 @var{group} doesn't have to be heeded---if the back end decides that
29099 it is too much work just scanning for a single group, it may do a
29100 total scan of all groups. It would be nice, however, to keep things
29101 local if that's practical.
29103 There should be no result data from this function.
29106 @item (nnchoke-request-group-description GROUP &optional SERVER)
29108 The result data from this function should be a description of
29112 description-line = name <TAB> description eol
29114 description = <text>
29117 @item (nnchoke-request-list-newsgroups &optional SERVER)
29119 The result data from this function should be the description of all
29120 groups available on the server.
29123 description-buffer = *description-line
29127 @item (nnchoke-request-newgroups DATE &optional SERVER)
29129 The result data from this function should be all groups that were
29130 created after @samp{date}, which is in normal human-readable date format
29131 (i.e., the date format used in mail and news headers, and returned by
29132 the function @code{message-make-date} by default). The data should be
29133 in the active buffer format.
29135 It is okay for this function to return ``too many'' groups; some back ends
29136 might find it cheaper to return the full list of groups, rather than
29137 just the new groups. But don't do this for back ends with many groups.
29138 Normally, if the user creates the groups herself, there won't be too
29139 many groups, so @code{nnml} and the like are probably safe. But for
29140 back ends like @code{nntp}, where the groups have been created by the
29141 server, it is quite likely that there can be many groups.
29144 @item (nnchoke-request-create-group GROUP &optional SERVER)
29146 This function should create an empty group with name @var{group}.
29148 There should be no return data.
29151 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
29153 This function should run the expiry process on all articles in the
29154 @var{articles} range (which is currently a simple list of article
29155 numbers.) It is left up to the back end to decide how old articles
29156 should be before they are removed by this function. If @var{force} is
29157 non-@code{nil}, all @var{articles} should be deleted, no matter how new
29160 This function should return a list of articles that it did not/was not
29163 There should be no result data returned.
29166 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
29168 This function should move @var{article} (which is a number) from
29169 @var{group} by calling @var{accept-form}.
29171 This function should ready the article in question for moving by
29172 removing any header lines it has added to the article, and generally
29173 should ``tidy up'' the article. Then it should @code{eval}
29174 @var{accept-form} in the buffer where the ``tidy'' article is. This
29175 will do the actual copying. If this @code{eval} returns a
29176 non-@code{nil} value, the article should be removed.
29178 If @var{last} is @code{nil}, that means that there is a high likelihood
29179 that there will be more requests issued shortly, so that allows some
29182 The function should return a cons where the @code{car} is the group name and
29183 the @code{cdr} is the article number that the article was entered as.
29185 There should be no data returned.
29188 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
29190 This function takes the current buffer and inserts it into @var{group}.
29191 If @var{last} in @code{nil}, that means that there will be more calls to
29192 this function in short order.
29194 The function should return a cons where the @code{car} is the group name and
29195 the @code{cdr} is the article number that the article was entered as.
29197 The group should exist before the back end is asked to accept the
29198 article for that group.
29200 There should be no data returned.
29203 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
29205 This function should remove @var{article} (which is a number) from
29206 @var{group} and insert @var{buffer} there instead.
29208 There should be no data returned.
29211 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
29213 This function should delete @var{group}. If @var{force}, it should
29214 really delete all the articles in the group, and then delete the group
29215 itself. (If there is such a thing as ``the group itself''.)
29217 There should be no data returned.
29220 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
29222 This function should rename @var{group} into @var{new-name}. All
29223 articles in @var{group} should move to @var{new-name}.
29225 There should be no data returned.
29230 @node Error Messaging
29231 @subsubsection Error Messaging
29233 @findex nnheader-report
29234 @findex nnheader-get-report
29235 The back ends should use the function @code{nnheader-report} to report
29236 error conditions---they should not raise errors when they aren't able to
29237 perform a request. The first argument to this function is the back end
29238 symbol, and the rest are interpreted as arguments to @code{format} if
29239 there are multiple of them, or just a string if there is one of them.
29240 This function must always returns @code{nil}.
29243 (nnheader-report 'nnchoke "You did something totally bogus")
29245 (nnheader-report 'nnchoke "Could not request group %s" group)
29248 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
29249 @code{nil} back from a server, and this function returns the most
29250 recently reported message for the back end in question. This function
29251 takes one argument---the server symbol.
29253 Internally, these functions access @var{back-end}@code{-status-string},
29254 so the @code{nnchoke} back end will have its error message stored in
29255 @code{nnchoke-status-string}.
29258 @node Writing New Back Ends
29259 @subsubsection Writing New Back Ends
29261 Many back ends are quite similar. @code{nnml} is just like
29262 @code{nnspool}, but it allows you to edit the articles on the server.
29263 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
29264 and it doesn't maintain overview databases. @code{nndir} is just like
29265 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
29268 It would make sense if it were possible to ``inherit'' functions from
29269 back ends when writing new back ends. And, indeed, you can do that if you
29270 want to. (You don't have to if you don't want to, of course.)
29272 All the back ends declare their public variables and functions by using a
29273 package called @code{nnoo}.
29275 To inherit functions from other back ends (and allow other back ends to
29276 inherit functions from the current back end), you should use the
29282 This macro declares the first parameter to be a child of the subsequent
29283 parameters. For instance:
29286 (nnoo-declare nndir
29290 @code{nndir} has declared here that it intends to inherit functions from
29291 both @code{nnml} and @code{nnmh}.
29294 This macro is equivalent to @code{defvar}, but registers the variable as
29295 a public server variable. Most state-oriented variables should be
29296 declared with @code{defvoo} instead of @code{defvar}.
29298 In addition to the normal @code{defvar} parameters, it takes a list of
29299 variables in the parent back ends to map the variable to when executing
29300 a function in those back ends.
29303 (defvoo nndir-directory nil
29304 "Where nndir will look for groups."
29305 nnml-current-directory nnmh-current-directory)
29308 This means that @code{nnml-current-directory} will be set to
29309 @code{nndir-directory} when an @code{nnml} function is called on behalf
29310 of @code{nndir}. (The same with @code{nnmh}.)
29312 @item nnoo-define-basics
29313 This macro defines some common functions that almost all back ends should
29317 (nnoo-define-basics nndir)
29321 This macro is just like @code{defun} and takes the same parameters. In
29322 addition to doing the normal @code{defun} things, it registers the
29323 function as being public so that other back ends can inherit it.
29325 @item nnoo-map-functions
29326 This macro allows mapping of functions from the current back end to
29327 functions from the parent back ends.
29330 (nnoo-map-functions nndir
29331 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29332 (nnmh-request-article 0 nndir-current-group 0 0))
29335 This means that when @code{nndir-retrieve-headers} is called, the first,
29336 third, and fourth parameters will be passed on to
29337 @code{nnml-retrieve-headers}, while the second parameter is set to the
29338 value of @code{nndir-current-group}.
29341 This macro allows importing functions from back ends. It should be the
29342 last thing in the source file, since it will only define functions that
29343 haven't already been defined.
29349 nnmh-request-newgroups)
29353 This means that calls to @code{nndir-request-list} should just be passed
29354 on to @code{nnmh-request-list}, while all public functions from
29355 @code{nnml} that haven't been defined in @code{nndir} yet should be
29360 Below is a slightly shortened version of the @code{nndir} back end.
29363 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
29364 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
29368 (require 'nnheader)
29372 (eval-when-compile (require 'cl))
29374 (nnoo-declare nndir
29377 (defvoo nndir-directory nil
29378 "Where nndir will look for groups."
29379 nnml-current-directory nnmh-current-directory)
29381 (defvoo nndir-nov-is-evil nil
29382 "*Non-nil means that nndir will never retrieve NOV headers."
29385 (defvoo nndir-current-group ""
29387 nnml-current-group nnmh-current-group)
29388 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
29389 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
29391 (defvoo nndir-status-string "" nil nnmh-status-string)
29392 (defconst nndir-version "nndir 1.0")
29394 ;;; @r{Interface functions.}
29396 (nnoo-define-basics nndir)
29398 (deffoo nndir-open-server (server &optional defs)
29399 (setq nndir-directory
29400 (or (cadr (assq 'nndir-directory defs))
29402 (unless (assq 'nndir-directory defs)
29403 (push `(nndir-directory ,server) defs))
29404 (push `(nndir-current-group
29405 ,(file-name-nondirectory
29406 (directory-file-name nndir-directory)))
29408 (push `(nndir-top-directory
29409 ,(file-name-directory (directory-file-name nndir-directory)))
29411 (nnoo-change-server 'nndir server defs))
29413 (nnoo-map-functions nndir
29414 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29415 (nnmh-request-article 0 nndir-current-group 0 0)
29416 (nnmh-request-group nndir-current-group 0 0)
29417 (nnmh-close-group nndir-current-group 0))
29421 nnmh-status-message
29423 nnmh-request-newgroups))
29429 @node Hooking New Back Ends Into Gnus
29430 @subsubsection Hooking New Back Ends Into Gnus
29432 @vindex gnus-valid-select-methods
29433 @findex gnus-declare-backend
29434 Having Gnus start using your new back end is rather easy---you just
29435 declare it with the @code{gnus-declare-backend} functions. This will
29436 enter the back end into the @code{gnus-valid-select-methods} variable.
29438 @code{gnus-declare-backend} takes two parameters---the back end name and
29439 an arbitrary number of @dfn{abilities}.
29444 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
29447 The above line would then go in the @file{nnchoke.el} file.
29449 The abilities can be:
29453 This is a mailish back end---followups should (probably) go via mail.
29455 This is a newsish back end---followups should (probably) go via news.
29457 This back end supports both mail and news.
29459 This is neither a post nor mail back end---it's something completely
29462 It supports respooling---or rather, it is able to modify its source
29463 articles and groups.
29465 The name of the server should be in the virtual server name. This is
29466 true for almost all back ends.
29467 @item prompt-address
29468 The user should be prompted for an address when doing commands like
29469 @kbd{B} in the group buffer. This is true for back ends like
29470 @code{nntp}, but not @code{nnmbox}, for instance.
29474 @node Mail-like Back Ends
29475 @subsubsection Mail-like Back Ends
29477 One of the things that separate the mail back ends from the rest of the
29478 back ends is the heavy dependence by most of the mail back ends on
29479 common functions in @file{nnmail.el}. For instance, here's the
29480 definition of @code{nnml-request-scan}:
29483 (deffoo nnml-request-scan (&optional group server)
29484 (setq nnml-article-file-alist nil)
29485 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
29488 It simply calls @code{nnmail-get-new-mail} with a few parameters,
29489 and @code{nnmail} takes care of all the moving and splitting of the
29492 This function takes four parameters.
29496 This should be a symbol to designate which back end is responsible for
29499 @item exit-function
29500 This function should be called after the splitting has been performed.
29502 @item temp-directory
29503 Where the temporary files should be stored.
29506 This optional argument should be a group name if the splitting is to be
29507 performed for one group only.
29510 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
29511 save each article. @var{back-end}@code{-active-number} will be called to
29512 find the article number assigned to this article.
29514 The function also uses the following variables:
29515 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
29516 this back end); and @var{back-end}@code{-group-alist} and
29517 @var{back-end}@code{-active-file} to generate the new active file.
29518 @var{back-end}@code{-group-alist} should be a group-active alist, like
29522 (("a-group" (1 . 10))
29523 ("some-group" (34 . 39)))
29527 @node Score File Syntax
29528 @subsection Score File Syntax
29530 Score files are meant to be easily parseable, but yet extremely
29531 mallable. It was decided that something that had the same read syntax
29532 as an Emacs Lisp list would fit that spec.
29534 Here's a typical score file:
29538 ("win95" -10000 nil s)
29545 BNF definition of a score file:
29548 score-file = "" / "(" *element ")"
29549 element = rule / atom
29550 rule = string-rule / number-rule / date-rule
29551 string-rule = "(" quote string-header quote space *string-match ")"
29552 number-rule = "(" quote number-header quote space *number-match ")"
29553 date-rule = "(" quote date-header quote space *date-match ")"
29555 string-header = "subject" / "from" / "references" / "message-id" /
29556 "xref" / "body" / "head" / "all" / "followup"
29557 number-header = "lines" / "chars"
29558 date-header = "date"
29559 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
29560 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
29561 score = "nil" / <integer>
29562 date = "nil" / <natural number>
29563 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
29564 "r" / "regex" / "R" / "Regex" /
29565 "e" / "exact" / "E" / "Exact" /
29566 "f" / "fuzzy" / "F" / "Fuzzy"
29567 number-match = "(" <integer> [ "" / [ space score [ "" /
29568 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
29569 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
29570 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
29571 space date [ "" / [ space date-match-t ] ] ] ] ")"
29572 date-match-t = "nil" / "at" / "before" / "after"
29573 atom = "(" [ required-atom / optional-atom ] ")"
29574 required-atom = mark / expunge / mark-and-expunge / files /
29575 exclude-files / read-only / touched
29576 optional-atom = adapt / local / eval
29577 mark = "mark" space nil-or-number
29578 nil-or-number = "nil" / <integer>
29579 expunge = "expunge" space nil-or-number
29580 mark-and-expunge = "mark-and-expunge" space nil-or-number
29581 files = "files" *[ space <string> ]
29582 exclude-files = "exclude-files" *[ space <string> ]
29583 read-only = "read-only" [ space "nil" / space "t" ]
29584 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
29585 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
29586 local = "local" *[ space "(" <string> space <form> ")" ]
29587 eval = "eval" space <form>
29588 space = *[ " " / <TAB> / <NEWLINE> ]
29591 Any unrecognized elements in a score file should be ignored, but not
29594 As you can see, white space is needed, but the type and amount of white
29595 space is irrelevant. This means that formatting of the score file is
29596 left up to the programmer---if it's simpler to just spew it all out on
29597 one looong line, then that's ok.
29599 The meaning of the various atoms are explained elsewhere in this
29600 manual (@pxref{Score File Format}).
29604 @subsection Headers
29606 Internally Gnus uses a format for storing article headers that
29607 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
29608 almost suspect that the author looked at the @acronym{NOV} specification and
29609 just shamelessly @emph{stole} the entire thing, and one would be right.
29611 @dfn{Header} is a severely overloaded term. ``Header'' is used in
29612 RFC 1036 to talk about lines in the head of an article (e.g.,
29613 @code{From}). It is used by many people as a synonym for
29614 ``head''---``the header and the body''. (That should be avoided, in my
29615 opinion.) And Gnus uses a format internally that it calls ``header'',
29616 which is what I'm talking about here. This is a 9-element vector,
29617 basically, with each header (ouch) having one slot.
29619 These slots are, in order: @code{number}, @code{subject}, @code{from},
29620 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
29621 @code{xref}, and @code{extra}. There are macros for accessing and
29622 setting these slots---they all have predictable names beginning with
29623 @code{mail-header-} and @code{mail-header-set-}, respectively.
29625 All these slots contain strings, except the @code{extra} slot, which
29626 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
29632 @sc{gnus} introduced a concept that I found so useful that I've started
29633 using it a lot and have elaborated on it greatly.
29635 The question is simple: If you have a large amount of objects that are
29636 identified by numbers (say, articles, to take a @emph{wild} example)
29637 that you want to qualify as being ``included'', a normal sequence isn't
29638 very useful. (A 200,000 length sequence is a bit long-winded.)
29640 The solution is as simple as the question: You just collapse the
29644 (1 2 3 4 5 6 10 11 12)
29647 is transformed into
29650 ((1 . 6) (10 . 12))
29653 To avoid having those nasty @samp{(13 . 13)} elements to denote a
29654 lonesome object, a @samp{13} is a valid element:
29657 ((1 . 6) 7 (10 . 12))
29660 This means that comparing two ranges to find out whether they are equal
29661 is slightly tricky:
29664 ((1 . 5) 7 8 (10 . 12))
29670 ((1 . 5) (7 . 8) (10 . 12))
29673 are equal. In fact, any non-descending list is a range:
29679 is a perfectly valid range, although a pretty long-winded one. This is
29686 and is equal to the previous range.
29688 Here's a BNF definition of ranges. Of course, one must remember the
29689 semantic requirement that the numbers are non-descending. (Any number
29690 of repetition of the same number is allowed, but apt to disappear in
29694 range = simple-range / normal-range
29695 simple-range = "(" number " . " number ")"
29696 normal-range = "(" start-contents ")"
29697 contents = "" / simple-range *[ " " contents ] /
29698 number *[ " " contents ]
29701 Gnus currently uses ranges to keep track of read articles and article
29702 marks. I plan on implementing a number of range operators in C if The
29703 Powers That Be are willing to let me. (I haven't asked yet, because I
29704 need to do some more thinking on what operators I need to make life
29705 totally range-based without ever having to convert back to normal
29710 @subsection Group Info
29712 Gnus stores all permanent info on groups in a @dfn{group info} list.
29713 This list is from three to six elements (or more) long and exhaustively
29714 describes the group.
29716 Here are two example group infos; one is a very simple group while the
29717 second is a more complex one:
29720 ("no.group" 5 ((1 . 54324)))
29722 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
29723 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
29725 ((auto-expire . t) (to-address . "ding@@gnus.org")))
29728 The first element is the @dfn{group name}---as Gnus knows the group,
29729 anyway. The second element is the @dfn{subscription level}, which
29730 normally is a small integer. (It can also be the @dfn{rank}, which is a
29731 cons cell where the @code{car} is the level and the @code{cdr} is the
29732 score.) The third element is a list of ranges of read articles. The
29733 fourth element is a list of lists of article marks of various kinds.
29734 The fifth element is the select method (or virtual server, if you like).
29735 The sixth element is a list of @dfn{group parameters}, which is what
29736 this section is about.
29738 Any of the last three elements may be missing if they are not required.
29739 In fact, the vast majority of groups will normally only have the first
29740 three elements, which saves quite a lot of cons cells.
29742 Here's a BNF definition of the group info format:
29745 info = "(" group space ralevel space read
29746 [ "" / [ space marks-list [ "" / [ space method [ "" /
29747 space parameters ] ] ] ] ] ")"
29748 group = quote <string> quote
29749 ralevel = rank / level
29750 level = <integer in the range of 1 to inf>
29751 rank = "(" level "." score ")"
29752 score = <integer in the range of 1 to inf>
29754 marks-lists = nil / "(" *marks ")"
29755 marks = "(" <string> range ")"
29756 method = "(" <string> *elisp-forms ")"
29757 parameters = "(" *elisp-forms ")"
29760 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
29761 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
29764 If you have a Gnus info and want to access the elements, Gnus offers a
29765 series of macros for getting/setting these elements.
29768 @item gnus-info-group
29769 @itemx gnus-info-set-group
29770 @findex gnus-info-group
29771 @findex gnus-info-set-group
29772 Get/set the group name.
29774 @item gnus-info-rank
29775 @itemx gnus-info-set-rank
29776 @findex gnus-info-rank
29777 @findex gnus-info-set-rank
29778 Get/set the group rank (@pxref{Group Score}).
29780 @item gnus-info-level
29781 @itemx gnus-info-set-level
29782 @findex gnus-info-level
29783 @findex gnus-info-set-level
29784 Get/set the group level.
29786 @item gnus-info-score
29787 @itemx gnus-info-set-score
29788 @findex gnus-info-score
29789 @findex gnus-info-set-score
29790 Get/set the group score (@pxref{Group Score}).
29792 @item gnus-info-read
29793 @itemx gnus-info-set-read
29794 @findex gnus-info-read
29795 @findex gnus-info-set-read
29796 Get/set the ranges of read articles.
29798 @item gnus-info-marks
29799 @itemx gnus-info-set-marks
29800 @findex gnus-info-marks
29801 @findex gnus-info-set-marks
29802 Get/set the lists of ranges of marked articles.
29804 @item gnus-info-method
29805 @itemx gnus-info-set-method
29806 @findex gnus-info-method
29807 @findex gnus-info-set-method
29808 Get/set the group select method.
29810 @item gnus-info-params
29811 @itemx gnus-info-set-params
29812 @findex gnus-info-params
29813 @findex gnus-info-set-params
29814 Get/set the group parameters.
29817 All the getter functions take one parameter---the info list. The setter
29818 functions take two parameters---the info list and the new value.
29820 The last three elements in the group info aren't mandatory, so it may be
29821 necessary to extend the group info before setting the element. If this
29822 is necessary, you can just pass on a non-@code{nil} third parameter to
29823 the three final setter functions to have this happen automatically.
29826 @node Extended Interactive
29827 @subsection Extended Interactive
29828 @cindex interactive
29829 @findex gnus-interactive
29831 Gnus extends the standard Emacs @code{interactive} specification
29832 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
29833 Prefixes}). Here's an example of how this is used:
29836 (defun gnus-summary-increase-score (&optional score symp)
29837 (interactive (gnus-interactive "P\ny"))
29842 The best thing to do would have been to implement
29843 @code{gnus-interactive} as a macro which would have returned an
29844 @code{interactive} form, but this isn't possible since Emacs checks
29845 whether a function is interactive or not by simply doing an @code{assq}
29846 on the lambda form. So, instead we have @code{gnus-interactive}
29847 function that takes a string and returns values that are usable to
29848 @code{interactive}.
29850 This function accepts (almost) all normal @code{interactive} specs, but
29855 @vindex gnus-current-prefix-symbol
29856 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
29860 @vindex gnus-current-prefix-symbols
29861 A list of the current symbolic prefixes---the
29862 @code{gnus-current-prefix-symbol} variable.
29865 The current article number---the @code{gnus-summary-article-number}
29869 The current article header---the @code{gnus-summary-article-header}
29873 The current group name---the @code{gnus-group-group-name}
29879 @node Emacs/XEmacs Code
29880 @subsection Emacs/XEmacs Code
29884 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
29885 platforms must be the primary one. I chose Emacs. Not because I don't
29886 like XEmacs or Mule, but because it comes first alphabetically.
29888 This means that Gnus will byte-compile under Emacs with nary a warning,
29889 while XEmacs will pump out gigabytes of warnings while byte-compiling.
29890 As I use byte-compilation warnings to help me root out trivial errors in
29891 Gnus, that's very useful.
29893 I've also consistently used Emacs function interfaces, but have used
29894 Gnusey aliases for the functions. To take an example: Emacs defines a
29895 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
29896 function. I then define a function called @code{gnus-run-at-time} that
29897 takes the same parameters as the Emacs @code{run-at-time}. When running
29898 Gnus under Emacs, the former function is just an alias for the latter.
29899 However, when running under XEmacs, the former is an alias for the
29900 following function:
29903 (defun gnus-xmas-run-at-time (time repeat function &rest args)
29907 (,function ,@@args))
29911 This sort of thing has been done for bunches of functions. Gnus does
29912 not redefine any native Emacs functions while running under XEmacs---it
29913 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
29916 In the cases where the XEmacs function interface was obviously cleaner,
29917 I used it instead. For example @code{gnus-region-active-p} is an alias
29918 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
29920 Of course, I could have chosen XEmacs as my native platform and done
29921 mapping functions the other way around. But I didn't. The performance
29922 hit these indirections impose on Gnus under XEmacs should be slight.
29925 @node Various File Formats
29926 @subsection Various File Formats
29929 * Active File Format:: Information on articles and groups available.
29930 * Newsgroups File Format:: Group descriptions.
29934 @node Active File Format
29935 @subsubsection Active File Format
29937 The active file lists all groups available on the server in
29938 question. It also lists the highest and lowest current article numbers
29941 Here's an excerpt from a typical active file:
29944 soc.motss 296030 293865 y
29945 alt.binaries.pictures.fractals 3922 3913 n
29946 comp.sources.unix 1605 1593 m
29947 comp.binaries.ibm.pc 5097 5089 y
29948 no.general 1000 900 y
29951 Here's a pseudo-BNF definition of this file:
29954 active = *group-line
29955 group-line = group spc high-number spc low-number spc flag <NEWLINE>
29956 group = <non-white-space string>
29958 high-number = <non-negative integer>
29959 low-number = <positive integer>
29960 flag = "y" / "n" / "m" / "j" / "x" / "=" group
29963 For a full description of this file, see the manual pages for
29964 @samp{innd}, in particular @samp{active(5)}.
29967 @node Newsgroups File Format
29968 @subsubsection Newsgroups File Format
29970 The newsgroups file lists groups along with their descriptions. Not all
29971 groups on the server have to be listed, and not all groups in the file
29972 have to exist on the server. The file is meant purely as information to
29975 The format is quite simple; a group name, a tab, and the description.
29976 Here's the definition:
29980 line = group tab description <NEWLINE>
29981 group = <non-white-space string>
29983 description = <string>
29988 @node Emacs for Heathens
29989 @section Emacs for Heathens
29991 Believe it or not, but some people who use Gnus haven't really used
29992 Emacs much before they embarked on their journey on the Gnus Love Boat.
29993 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
29994 region'', and ``set @code{gnus-flargblossen} to an alist where the key
29995 is a regexp that is used for matching on the group name'' are magical
29996 phrases with little or no meaning, then this appendix is for you. If
29997 you are already familiar with Emacs, just ignore this and go fondle your
30001 * Keystrokes:: Entering text and executing commands.
30002 * Emacs Lisp:: The built-in Emacs programming language.
30007 @subsection Keystrokes
30011 Q: What is an experienced Emacs user?
30014 A: A person who wishes that the terminal had pedals.
30017 Yes, when you use Emacs, you are apt to use the control key, the shift
30018 key and the meta key a lot. This is very annoying to some people
30019 (notably @code{vi}le users), and the rest of us just love the hell out
30020 of it. Just give up and submit. Emacs really does stand for
30021 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
30022 may have heard from other disreputable sources (like the Emacs author).
30024 The shift keys are normally located near your pinky fingers, and are
30025 normally used to get capital letters and stuff. You probably use it all
30026 the time. The control key is normally marked ``CTRL'' or something like
30027 that. The meta key is, funnily enough, never marked as such on any
30028 keyboard. The one I'm currently at has a key that's marked ``Alt'',
30029 which is the meta key on this keyboard. It's usually located somewhere
30030 to the left hand side of the keyboard, usually on the bottom row.
30032 Now, us Emacs people don't say ``press the meta-control-m key'',
30033 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
30034 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
30035 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
30036 down the control key, and hold it down while you press @kbd{k}''.
30037 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
30038 the control key and then press @kbd{k}''. Simple, ay?
30040 This is somewhat complicated by the fact that not all keyboards have a
30041 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
30042 means ``press escape, release escape, press @kbd{k}''. That's much more
30043 work than if you have a meta key, so if that's the case, I respectfully
30044 suggest you get a real keyboard with a meta key. You can't live without
30050 @subsection Emacs Lisp
30052 Emacs is the King of Editors because it's really a Lisp interpreter.
30053 Each and every key you tap runs some Emacs Lisp code snippet, and since
30054 Emacs Lisp is an interpreted language, that means that you can configure
30055 any key to run any arbitrary code. You just, like, do it.
30057 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
30058 functions. (These are byte-compiled for speed, but it's still
30059 interpreted.) If you decide that you don't like the way Gnus does
30060 certain things, it's trivial to have it do something a different way.
30061 (Well, at least if you know how to write Lisp code.) However, that's
30062 beyond the scope of this manual, so we are simply going to talk about
30063 some common constructs that you normally use in your @file{~/.gnus.el}
30064 file to customize Gnus. (You can also use the @file{~/.emacs} file, but
30065 in order to set things of Gnus up, it is much better to use the
30066 @file{~/.gnus.el} file, @xref{Startup Files}.)
30068 If you want to set the variable @code{gnus-florgbnize} to four (4), you
30069 write the following:
30072 (setq gnus-florgbnize 4)
30075 This function (really ``special form'') @code{setq} is the one that can
30076 set a variable to some value. This is really all you need to know. Now
30077 you can go and fill your @file{~/.gnus.el} file with lots of these to
30078 change how Gnus works.
30080 If you have put that thing in your @file{~/.gnus.el} file, it will be
30081 read and @code{eval}ed (which is Lisp-ese for ``run'') the next time you
30082 start Gnus. If you want to change the variable right away, simply say
30083 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
30084 previous ``form'', which is a simple @code{setq} statement here.
30086 Go ahead---just try it, if you're located at your Emacs. After you
30087 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
30088 is the return value of the form you @code{eval}ed.
30092 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
30096 (setq gnus-read-active-file 'some)
30099 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
30100 @samp{nntp.ifi.uio.no}'', that means:
30103 (setq gnus-nntp-server "nntp.ifi.uio.no")
30106 So be careful not to mix up strings (the latter) with symbols (the
30107 former). The manual is unambiguous, but it can be confusing.
30110 @include gnus-faq.texi
30112 @node GNU Free Documentation License
30113 @chapter GNU Free Documentation License
30114 @include doclicense.texi
30134 @c Local Variables:
30136 @c coding: iso-8859-1
30140 arch-tag: c9fa47e7-78ca-4681-bda9-9fef45d1c819