4 @settitle T-gnus 6.17 Manual
9 @documentencoding ISO-8859-1
12 Copyright (c) 1995, 1996, 1997, 1998, 1999, 2000, 2001,
14 Free Software Foundation, Inc.
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.1 or
19 any later version published by the Free Software Foundation; with no
20 Invariant Sections, with the Front-Cover texts being ``A GNU
21 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
22 license is included in the section entitled ``GNU Free Documentation
23 License'' in the Emacs manual.
25 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
26 this GNU Manual, like GNU software. Copies published by the Free
27 Software Foundation raise funds for GNU development.''
29 This document is part of a collection distributed under the GNU Free
30 Documentation License. If you want to distribute this document
31 separately from the collection, you can do so by adding a copy of the
32 license to the document, as described in section 6 of the license.
38 \documentclass[twoside,a4paper,openright,11pt]{book}
39 \usepackage[latin1]{inputenc}
40 \usepackage{pagestyle}
43 \input{gnusconfig.tex}
45 \ifx\pdfoutput\undefined
47 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
55 \newcommand{\gnusversionname}{T-gnus v6.17}
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
345 @title T-gnus 6.17 Manual
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 T-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 T-gnus provides @acronym{MIME} features based on @acronym{SEMI} API. So
365 T-gnus supports your right to read strange messages including big images
366 or other various kinds of formats. T-gnus also supports
367 internationalization/localization and multiscript features based on MULE
368 API. So T-gnus does not discriminate various language communities. Oh,
369 if you are a Klingon, please wait Unicode Next Generation.
371 This manual corresponds to T-gnus 6.17.
382 Gnus is the advanced, self-documenting, customizable, extensible
383 unreal-time newsreader for GNU Emacs.
385 Oops. That sounds oddly familiar, so let's start over again to avoid
386 being accused of plagiarism:
388 Gnus is a message-reading laboratory. It will let you look at just
389 about anything as if it were a newsgroup. You can read mail with it,
390 you can browse directories with it, you can @code{ftp} with it---you
391 can even read news with it!
393 Gnus tries to empower people who read news the same way Emacs empowers
394 people who edit text. Gnus sets no limits to what the user should be
395 allowed to do. Users are encouraged to extend gnus to make it behave
396 like they want it to behave. A program should not control people;
397 people should be empowered to do what they want by using (or abusing)
403 * Starting Up:: Finding news can be a pain.
404 * Group Buffer:: Selecting, subscribing and killing groups.
405 * Summary Buffer:: Reading, saving and posting articles.
406 * Article Buffer:: Displaying and handling articles.
407 * Composing Messages:: Information on sending mail and news.
408 * Select Methods:: Gnus reads all messages from various select methods.
409 * Scoring:: Assigning values to articles.
410 * Various:: General purpose settings.
411 * The End:: Farewell and goodbye.
412 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
413 * Index:: Variable, function and concept index.
414 * Key Index:: Key Index.
416 Other related manuals
418 * Message:(message). Composing messages.
419 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
420 * Sieve:(sieve). Managing Sieve scripts in Emacs.
421 * PGG:(pgg). @acronym{PGP/MIME} with Gnus.
422 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
425 --- The Detailed Node Listing ---
429 * Finding the News:: Choosing a method for getting news.
430 * The First Time:: What does Gnus do the first time you start it?
431 * The Server is Down:: How can I read my mail then?
432 * Slave Gnusae:: You can have more than one Gnus active at a time.
433 * Fetching a Group:: Starting Gnus just to read a group.
434 * New Groups:: What is Gnus supposed to do with new groups?
435 * Changing Servers:: You may want to move from one server to another.
436 * Startup Files:: Those pesky startup files---@file{.newsrc}.
437 * Auto Save:: Recovering from a crash.
438 * The Active File:: Reading the active file over a slow line Takes Time.
439 * Startup Variables:: Other variables you might change.
443 * Checking New Groups:: Determining what groups are new.
444 * Subscription Methods:: What Gnus should do with new groups.
445 * Filtering New Groups:: Making Gnus ignore certain new groups.
449 * Group Buffer Format:: Information listed and how you can change it.
450 * Group Maneuvering:: Commands for moving in the group buffer.
451 * Selecting a Group:: Actually reading news.
452 * Subscription Commands:: Unsubscribing, killing, subscribing.
453 * Group Data:: Changing the info for a group.
454 * Group Levels:: Levels? What are those, then?
455 * Group Score:: A mechanism for finding out what groups you like.
456 * Marking Groups:: You can mark groups for later processing.
457 * Foreign Groups:: Creating and editing groups.
458 * Group Parameters:: Each group may have different parameters set.
459 * Listing Groups:: Gnus can list various subsets of the groups.
460 * Sorting Groups:: Re-arrange the group order.
461 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
462 * Browse Foreign Server:: You can browse a server. See what it has to offer.
463 * Exiting Gnus:: Stop reading news and get some work done.
464 * Group Topics:: A folding group mode divided into topics.
465 * Misc Group Stuff:: Other stuff that you can to do.
469 * Group Line Specification:: Deciding how the group buffer is to look.
470 * Group Mode Line Specification:: The group buffer mode line.
471 * Group Highlighting:: Having nice colors in the group buffer.
475 * Topic Commands:: Interactive E-Z commands.
476 * Topic Variables:: How to customize the topics the Lisp Way.
477 * Topic Sorting:: Sorting each topic individually.
478 * Topic Topology:: A map of the world.
479 * Topic Parameters:: Parameters that apply to all groups in a topic.
483 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
484 * Group Information:: Information and help on groups and Gnus.
485 * Group Timestamp:: Making Gnus keep track of when you last read a group.
486 * File Commands:: Reading and writing the Gnus files.
487 * Sieve Commands:: Managing Sieve scripts.
491 * Summary Buffer Format:: Deciding how the summary buffer is to look.
492 * Summary Maneuvering:: Moving around the summary buffer.
493 * Choosing Articles:: Reading articles.
494 * Paging the Article:: Scrolling the current article.
495 * Reply Followup and Post:: Posting articles.
496 * Delayed Articles:: Send articles at a later time.
497 * Marking Articles:: Marking articles as read, expirable, etc.
498 * Limiting:: You can limit the summary buffer.
499 * Threading:: How threads are made.
500 * Sorting the Summary Buffer:: How articles and threads are sorted.
501 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
502 * Article Caching:: You may store articles in a cache.
503 * Persistent Articles:: Making articles expiry-resistant.
504 * Article Backlog:: Having already read articles hang around.
505 * Saving Articles:: Ways of customizing article saving.
506 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
507 * Article Treatment:: The article buffer can be mangled at will.
508 * MIME Commands:: Doing MIMEy things with the articles.
509 * Charsets:: Character set issues.
510 * Article Commands:: Doing various things with the article buffer.
511 * Summary Sorting:: Sorting the summary buffer in various ways.
512 * Finding the Parent:: No child support? Get the parent.
513 * Alternative Approaches:: Reading using non-default summaries.
514 * Tree Display:: A more visual display of threads.
515 * Mail Group Commands:: Some commands can only be used in mail groups.
516 * Various Summary Stuff:: What didn't fit anywhere else.
517 * Exiting the Summary Buffer:: Returning to the Group buffer,
518 or reselecting the current group.
519 * Crosspost Handling:: How crossposted articles are dealt with.
520 * Duplicate Suppression:: An alternative when crosspost handling fails.
521 * Security:: Decrypt and Verify.
522 * Mailing List:: Mailing list minor mode.
524 Summary Buffer Format
526 * Summary Buffer Lines:: You can specify how summary lines should look.
527 * To From Newsgroups:: How to not display your own name.
528 * Summary Buffer Mode Line:: You can say how the mode line should look.
529 * Summary Highlighting:: Making the summary buffer all pretty and nice.
533 * Choosing Commands:: Commands for choosing articles.
534 * Choosing Variables:: Variables that influence these commands.
536 Reply, Followup and Post
538 * Summary Mail Commands:: Sending mail.
539 * Summary Post Commands:: Sending news.
540 * Summary Message Commands:: Other Message-related commands.
541 * Canceling and Superseding::
545 * Unread Articles:: Marks for unread articles.
546 * Read Articles:: Marks for read articles.
547 * Other Marks:: Marks that do not affect readedness.
548 * Setting Marks:: How to set and remove marks.
549 * Generic Marking Commands:: How to customize the marking.
550 * Setting Process Marks:: How to mark articles for later processing.
554 * Customizing Threading:: Variables you can change to affect the threading.
555 * Thread Commands:: Thread based commands in the summary buffer.
557 Customizing Threading
559 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
560 * Filling In Threads:: Making the threads displayed look fuller.
561 * More Threading:: Even more variables for fiddling with threads.
562 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
566 * Uuencoded Articles:: Uudecode articles.
567 * Shell Archives:: Unshar articles.
568 * PostScript Files:: Split PostScript.
569 * Other Files:: Plain save and binhex.
570 * Decoding Variables:: Variables for a happy decoding.
571 * Viewing Files:: You want to look at the result of the decoding?
575 * Rule Variables:: Variables that say how a file is to be viewed.
576 * Other Decode Variables:: Other decode variables.
577 * Uuencoding and Posting:: Variables for customizing uuencoding.
581 * Article Highlighting:: You want to make the article look like fruit salad.
582 * Article Fontisizing:: Making emphasized text look nice.
583 * Article Hiding:: You also want to make certain info go away.
584 * Article Washing:: Lots of way-neat functions to make life better.
585 * Article Header:: Doing various header transformations.
586 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
587 * Article Button Levels:: Controlling appearance of buttons.
588 * Article Date:: Grumble, UT!
589 * Article Display:: Display various stuff---X-Face, Picons, Smileys
590 * Article Signature:: What is a signature?
591 * Article Miscellanea:: Various other stuff.
593 Alternative Approaches
595 * Pick and Read:: First mark articles and then read them.
596 * Binary Groups:: Auto-decode all articles.
598 Various Summary Stuff
600 * Summary Group Information:: Information oriented commands.
601 * Searching for Articles:: Multiple article commands.
602 * Summary Generation Commands::
603 * Really Various Summary Commands:: Those pesky non-conformant commands.
607 * Hiding Headers:: Deciding what headers should be displayed.
608 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
609 * Customizing Articles:: Tailoring the look of the articles.
610 * Article Keymap:: Keystrokes available in the article buffer.
611 * Misc Article:: Other stuff.
615 * Mail:: Mailing and replying.
616 * Posting Server:: What server should you post and mail via?
617 * POP before SMTP:: You cannot send a mail unless you read a mail.
618 * Mail and Post:: Mailing and posting at the same time.
619 * Archived Messages:: Where Gnus stores the messages you've sent.
620 * Posting Styles:: An easier way to specify who you are.
621 * Drafts:: Postponing messages and rejected messages.
622 * Rejected Articles:: What happens if the server doesn't like your article?
623 * Signing and encrypting:: How to compose secure messages.
627 * Server Buffer:: Making and editing virtual servers.
628 * Getting News:: Reading USENET news with Gnus.
629 * Getting Mail:: Reading your personal mail with Gnus.
630 * Browsing the Web:: Getting messages from a plethora of Web sources.
631 * IMAP:: Using Gnus as a @acronym{IMAP} client.
632 * Other Sources:: Reading directories, files, SOUP packets.
633 * Combined Groups:: Combining groups into one group.
634 * Gnus Unplugged:: Reading news and mail offline.
638 * Server Buffer Format:: You can customize the look of this buffer.
639 * Server Commands:: Commands to manipulate servers.
640 * Example Methods:: Examples server specifications.
641 * Creating a Virtual Server:: An example session.
642 * Server Variables:: Which variables to set.
643 * Servers and Methods:: You can use server names as select methods.
644 * Unavailable Servers:: Some servers you try to contact may be down.
648 * NNTP:: Reading news from an @acronym{NNTP} server.
649 * News Spool:: Reading news from the local spool.
653 * Direct Functions:: Connecting directly to the server.
654 * Indirect Functions:: Connecting indirectly to the server.
655 * Common Variables:: Understood by several connection functions.
656 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
660 * Mail in a Newsreader:: Important introductory notes.
661 * Getting Started Reading Mail:: A simple cookbook example.
662 * Splitting Mail:: How to create mail groups.
663 * Mail Sources:: How to tell Gnus where to get mail from.
664 * Mail Back End Variables:: Variables for customizing mail handling.
665 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
666 * Group Mail Splitting:: Use group customize to drive mail splitting.
667 * Incorporating Old Mail:: What about the old mail you have?
668 * Expiring Mail:: Getting rid of unwanted mail.
669 * Washing Mail:: Removing cruft from the mail you get.
670 * Duplicates:: Dealing with duplicated mail.
671 * Not Reading Mail:: Using mail back ends for reading other files.
672 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
676 * Mail Source Specifiers:: How to specify what a mail source is.
677 * Mail Source Customization:: Some variables that influence things.
678 * Fetching Mail:: Using the mail source specifiers.
680 Choosing a Mail Back End
682 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
683 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
684 * Mail Spool:: Store your mail in a private spool?
685 * MH Spool:: An mhspool-like back end.
686 * Maildir:: Another one-file-per-message format.
687 * Mail Folders:: Having one file for each group.
688 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
693 * Web Searches:: Creating groups from articles that match a string.
694 * Slashdot:: Reading the Slashdot comments.
695 * Ultimate:: The Ultimate Bulletin Board systems.
696 * Web Archive:: Reading mailing list archived on web.
697 * RSS:: Reading RDF site summary.
698 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
702 * Splitting in IMAP:: Splitting mail with nnimap.
703 * Expiring in IMAP:: Expiring mail with nnimap.
704 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
705 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
706 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
707 * Debugging IMAP:: What to do when things don't work.
711 * Directory Groups:: You can read a directory as if it was a newsgroup.
712 * Anything Groups:: Dired? Who needs dired?
713 * Document Groups:: Single files can be the basis of a group.
714 * SOUP:: Reading @sc{soup} packets ``offline''.
715 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
719 * Document Server Internals:: How to add your own document types.
723 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
724 * SOUP Groups:: A back end for reading @sc{soup} packets.
725 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
729 * Virtual Groups:: Combining articles from many groups.
730 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
734 * Agent Basics:: How it all is supposed to work.
735 * Agent Categories:: How to tell the Gnus Agent what to download.
736 * Agent Commands:: New commands for all the buffers.
737 * Agent Visuals:: Ways that the agent may effect your summary buffer.
738 * Agent as Cache:: The Agent is a big cache too.
739 * Agent Expiry:: How to make old articles go away.
740 * Agent Regeneration:: How to recover from lost connections and other accidents.
741 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
742 * Outgoing Messages:: What happens when you post/mail something?
743 * Agent Variables:: Customizing is fun.
744 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
745 * Batching Agents:: How to fetch news from a @code{cron} job.
746 * Agent Caveats:: What you think it'll do and what it does.
750 * Category Syntax:: What a category looks like.
751 * Category Buffer:: A buffer for maintaining categories.
752 * Category Variables:: Customize'r'Us.
756 * Group Agent Commands:: Configure groups and fetch their contents.
757 * Summary Agent Commands:: Manually select then fetch specific articles.
758 * Server Agent Commands:: Select the servers that are supported by the agent.
762 * Summary Score Commands:: Adding score entries for the current group.
763 * Group Score Commands:: General score commands.
764 * Score Variables:: Customize your scoring. (My, what terminology).
765 * Score File Format:: What a score file may contain.
766 * Score File Editing:: You can edit score files by hand as well.
767 * Adaptive Scoring:: Big Sister Gnus knows what you read.
768 * Home Score File:: How to say where new score entries are to go.
769 * Followups To Yourself:: Having Gnus notice when people answer you.
770 * Scoring On Other Headers:: Scoring on non-standard headers.
771 * Scoring Tips:: How to score effectively.
772 * Reverse Scoring:: That problem child of old is not problem.
773 * Global Score Files:: Earth-spanning, ear-splitting score files.
774 * Kill Files:: They are still here, but they can be ignored.
775 * Converting Kill Files:: Translating kill files to score files.
776 * Advanced Scoring:: Using logical expressions to build score rules.
777 * Score Decays:: It can be useful to let scores wither away.
781 * Advanced Scoring Syntax:: A definition.
782 * Advanced Scoring Examples:: What they look like.
783 * Advanced Scoring Tips:: Getting the most out of it.
787 * Process/Prefix:: A convention used by many treatment commands.
788 * Interactive:: Making Gnus ask you many questions.
789 * Symbolic Prefixes:: How to supply some Gnus functions with options.
790 * Formatting Variables:: You can specify what buffers should look like.
791 * Window Layout:: Configuring the Gnus buffer windows.
792 * Faces and Fonts:: How to change how faces look.
793 * Compilation:: How to speed Gnus up.
794 * Mode Lines:: Displaying information in the mode lines.
795 * Highlighting and Menus:: Making buffers look all nice and cozy.
796 * Buttons:: Get tendinitis in ten easy steps!
797 * Daemons:: Gnus can do things behind your back.
798 * NoCeM:: How to avoid spam and other fatty foods.
799 * Undo:: Some actions can be undone.
800 * Predicate Specifiers:: Specifying predicates.
801 * Moderation:: What to do if you're a moderator.
802 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
803 * Fuzzy Matching:: What's the big fuzz?
804 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
805 * Other modes:: Interaction with other modes.
806 * Various Various:: Things that are really various.
810 * Formatting Basics:: A formatting variable is basically a format string.
811 * Mode Line Formatting:: Some rules about mode line formatting variables.
812 * Advanced Formatting:: Modifying output in various ways.
813 * User-Defined Specs:: Having Gnus call your own functions.
814 * Formatting Fonts:: Making the formatting look colorful and nice.
815 * Positioning Point:: Moving point to a position after an operation.
816 * Tabulation:: Tabulating your output.
817 * Wide Characters:: Dealing with wide characters.
821 * X-Face:: Display a funky, teensy black-and-white image.
822 * Face:: Display a funkier, teensier colored image.
823 * Smileys:: Show all those happy faces the way they were meant to be shown.
824 * Picons:: How to display pictures of what you're reading.
825 * XVarious:: Other XEmacsy Gnusey variables.
829 * The problem of spam:: Some background, and some solutions
830 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
831 * SpamAssassin:: How to use external anti-spam tools.
832 * Hashcash:: Reduce spam by burning CPU time.
833 * Filtering Spam Using The Spam ELisp Package::
834 * Filtering Spam Using Statistics with spam-stat::
836 Filtering Spam Using The Spam ELisp Package
838 * Spam ELisp Package Sequence of Events::
839 * Spam ELisp Package Filtering of Incoming Mail::
840 * Spam ELisp Package Global Variables::
841 * Spam ELisp Package Configuration Examples::
842 * Blacklists and Whitelists::
844 * Gmane Spam Reporting::
845 * Anti-spam Hashcash Payments::
847 * Regular Expressions Header Matching::
849 * SpamAssassin back end::
850 * ifile spam filtering::
851 * spam-stat spam filtering::
853 * Extending the Spam ELisp package::
855 Filtering Spam Using Statistics with spam-stat
857 * Creating a spam-stat dictionary::
858 * Splitting mail using spam-stat::
859 * Low-level interface to the spam-stat dictionary::
863 * XEmacs:: Requirements for installing under XEmacs.
864 * History:: How Gnus got where it is today.
865 * On Writing Manuals:: Why this is not a beginner's guide.
866 * Terminology:: We use really difficult, like, words here.
867 * Customization:: Tailoring Gnus to your needs.
868 * Troubleshooting:: What you might try if things do not work.
869 * Gnus Reference Guide:: Rilly, rilly technical stuff.
870 * Emacs for Heathens:: A short introduction to Emacsian terms.
871 * Frequently Asked Questions:: The Gnus FAQ
875 * Gnus Versions:: What Gnus versions have been released.
876 * Other Gnus Versions:: Other Gnus versions that also have been released.
877 * Why?:: What's the point of Gnus?
878 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
879 * Conformity:: Gnus tries to conform to all standards.
880 * Emacsen:: Gnus can be run on a few modern Emacsen.
881 * Gnus Development:: How Gnus is developed.
882 * Contributors:: Oodles of people.
883 * New Features:: Pointers to some of the new stuff in Gnus.
887 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
888 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
889 * Red Gnus:: Third time best---Gnus 5.4/5.5.
890 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
891 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
892 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
893 * No Gnus:: Lars, FIXME!
897 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
898 * Slow Terminal Connection:: You run a remote Emacs.
899 * Little Disk Space:: You feel that having large setup files is icky.
900 * Slow Machine:: You feel like buying a faster machine.
904 * Gnus Utility Functions:: Common functions and variable to use.
905 * Back End Interface:: How Gnus communicates with the servers.
906 * Score File Syntax:: A BNF definition of the score file standard.
907 * Headers:: How Gnus stores headers internally.
908 * Ranges:: A handy format for storing mucho numbers.
909 * Group Info:: The group info format.
910 * Extended Interactive:: Symbolic prefixes and stuff.
911 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
912 * Various File Formats:: Formats of files that Gnus use.
916 * Required Back End Functions:: Functions that must be implemented.
917 * Optional Back End Functions:: Functions that need not be implemented.
918 * Error Messaging:: How to get messages and report errors.
919 * Writing New Back Ends:: Extending old back ends.
920 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
921 * Mail-like Back Ends:: Some tips on mail back ends.
925 * Active File Format:: Information on articles and groups available.
926 * Newsgroups File Format:: Group descriptions.
930 * Keystrokes:: Entering text and executing commands.
931 * Emacs Lisp:: The built-in Emacs programming language.
937 @chapter Starting gnus
942 If your system administrator has set things up properly, starting gnus
943 and reading news is extremely easy---you just type @kbd{M-x gnus} in
946 @findex gnus-other-frame
947 @kindex M-x gnus-other-frame
948 If you want to start gnus in a different frame, you can use the command
949 @kbd{M-x gnus-other-frame} instead.
951 If things do not go smoothly at startup, you have to twiddle some
952 variables in your @file{~/.gnus.el} file. This file is similar to
953 @file{~/.emacs}, but is read when Gnus starts.
955 If you puzzle at any terms used in this manual, please refer to the
956 terminology section (@pxref{Terminology}).
959 * Finding the News:: Choosing a method for getting news.
960 * The First Time:: What does Gnus do the first time you start it?
961 * The Server is Down:: How can I read my mail then?
962 * Slave Gnusae:: You can have more than one Gnus active at a time.
963 * Fetching a Group:: Starting Gnus just to read a group.
964 * New Groups:: What is Gnus supposed to do with new groups?
965 * Changing Servers:: You may want to move from one server to another.
966 * Startup Files:: Those pesky startup files---@file{.newsrc}.
967 * Auto Save:: Recovering from a crash.
968 * The Active File:: Reading the active file over a slow line Takes Time.
969 * Startup Variables:: Other variables you might change.
973 @node Finding the News
974 @section Finding the News
977 @vindex gnus-select-method
979 The @code{gnus-select-method} variable says where gnus should look for
980 news. This variable should be a list where the first element says
981 @dfn{how} and the second element says @dfn{where}. This method is your
982 native method. All groups not fetched with this method are
985 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
986 you want to get your daily dosage of news from, you'd say:
989 (setq gnus-select-method '(nntp "news.somewhere.edu"))
992 If you want to read directly from the local spool, say:
995 (setq gnus-select-method '(nnspool ""))
998 If you can use a local spool, you probably should, as it will almost
999 certainly be much faster. But do not use the local spool if your
1000 server is running Leafnode; in this case, use @code{(nntp "localhost")}.
1002 @vindex gnus-nntpserver-file
1004 @cindex @acronym{NNTP} server
1005 If this variable is not set, gnus will take a look at the
1006 @env{NNTPSERVER} environment variable. If that variable isn't set,
1007 gnus will see whether @code{gnus-nntpserver-file}
1008 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1009 If that fails as well, gnus will try to use the machine running Emacs
1010 as an @acronym{NNTP} server. That's a long shot, though.
1012 @vindex gnus-nntp-server
1013 If @code{gnus-nntp-server} is set, this variable will override
1014 @code{gnus-select-method}. You should therefore set
1015 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1017 @vindex gnus-secondary-servers
1018 @vindex gnus-nntp-server
1019 You can also make gnus prompt you interactively for the name of an
1020 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1021 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
1022 in the @code{gnus-secondary-servers} list (if any). You can also just
1023 type in the name of any server you feel like visiting. (Note that this
1024 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1025 gnus} later in the same Emacs session, Gnus will contact the same
1028 @findex gnus-group-browse-foreign-server
1030 However, if you use one @acronym{NNTP} server regularly and are just
1031 interested in a couple of groups from a different server, you would be
1032 better served by using the @kbd{B} command in the group buffer. It will
1033 let you have a look at what groups are available, and you can subscribe
1034 to any of the groups you want to. This also makes @file{.newsrc}
1035 maintenance much tidier. @xref{Foreign Groups}.
1037 @vindex gnus-secondary-select-methods
1039 A slightly different approach to foreign groups is to set the
1040 @code{gnus-secondary-select-methods} variable. The select methods
1041 listed in this variable are in many ways just as native as the
1042 @code{gnus-select-method} server. They will also be queried for active
1043 files during startup (if that's required), and new newsgroups that
1044 appear on these servers will be subscribed (or not) just as native
1047 For instance, if you use the @code{nnmbox} back end to read your mail,
1048 you would typically set this variable to
1051 (setq gnus-secondary-select-methods '((nnmbox "")))
1054 Note: the @acronym{NNTP} back end stores marks in marks files
1055 (@pxref{NNTP marks}). This feature makes it easy to share marks between
1056 several Gnus installations, but may slow down things a bit when fetching
1057 new articles. @xref{NNTP marks}, for more information.
1060 @node The First Time
1061 @section The First Time
1062 @cindex first time usage
1064 If no startup files exist, gnus will try to determine what groups should
1065 be subscribed by default.
1067 @vindex gnus-default-subscribed-newsgroups
1068 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1069 will subscribe you to just those groups in that list, leaving the rest
1070 killed. Your system administrator should have set this variable to
1073 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1074 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1075 here as @dfn{whatever Lars thinks you should read}.)
1077 You'll also be subscribed to the gnus documentation group, which should
1078 help you with most common problems.
1080 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1081 use the normal functions for handling new groups, and not do anything
1085 @node The Server is Down
1086 @section The Server is Down
1087 @cindex server errors
1089 If the default server is down, gnus will understandably have some
1090 problems starting. However, if you have some mail groups in addition to
1091 the news groups, you may want to start gnus anyway.
1093 Gnus, being the trusting sort of program, will ask whether to proceed
1094 without a native select method if that server can't be contacted. This
1095 will happen whether the server doesn't actually exist (i.e., you have
1096 given the wrong address) or the server has just momentarily taken ill
1097 for some reason or other. If you decide to continue and have no foreign
1098 groups, you'll find it difficult to actually do anything in the group
1099 buffer. But, hey, that's your problem. Blllrph!
1101 @findex gnus-no-server
1102 @kindex M-x gnus-no-server
1104 If you know that the server is definitely down, or you just want to read
1105 your mail without bothering with the server at all, you can use the
1106 @code{gnus-no-server} command to start gnus. That might come in handy
1107 if you're in a hurry as well. This command will not attempt to contact
1108 your primary server---instead, it will just activate all groups on level
1109 1 and 2. (You should preferably keep no native groups on those two
1110 levels.) Also @pxref{Group Levels}.
1114 @section Slave Gnusae
1117 You might want to run more than one Emacs with more than one gnus at the
1118 same time. If you are using different @file{.newsrc} files (e.g., if you
1119 are using the two different gnusae to read from two different servers),
1120 that is no problem whatsoever. You just do it.
1122 The problem appears when you want to run two Gnusae that use the same
1123 @file{.newsrc} file.
1125 To work around that problem some, we here at the Think-Tank at the gnus
1126 Towers have come up with a new concept: @dfn{Masters} and
1127 @dfn{slaves}. (We have applied for a patent on this concept, and have
1128 taken out a copyright on those words. If you wish to use those words in
1129 conjunction with each other, you have to send $1 per usage instance to
1130 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1131 Applications}) will be much more expensive, of course.)
1134 Anyway, you start one gnus up the normal way with @kbd{M-x gnus} (or
1135 however you do it). Each subsequent slave gnusae should be started with
1136 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1137 files, but instead save @dfn{slave files} that contain information only
1138 on what groups have been read in the slave session. When a master gnus
1139 starts, it will read (and delete) these slave files, incorporating all
1140 information from them. (The slave files will be read in the sequence
1141 they were created, so the latest changes will have precedence.)
1143 Information from the slave files has, of course, precedence over the
1144 information in the normal (i.e., master) @file{.newsrc} file.
1146 If the @file{.newsrc*} files have not been saved in the master when the
1147 slave starts, you may be prompted as to whether to read an auto-save
1148 file. If you answer ``yes'', the unsaved changes to the master will be
1149 incorporated into the slave. If you answer ``no'', the slave may see some
1150 messages as unread that have been read in the master.
1152 @node Fetching a Group
1153 @section Fetching a Group
1154 @cindex fetching a group
1156 @findex gnus-fetch-group
1157 It is sometimes convenient to be able to just say ``I want to read this
1158 group and I don't care whether gnus has been started or not''. This is
1159 perhaps more useful for people who write code than for users, but the
1160 command @code{gnus-fetch-group} provides this functionality in any case.
1161 It takes the group name as a parameter.
1167 @cindex subscription
1169 @vindex gnus-check-new-newsgroups
1170 If you are satisfied that you really never want to see any new groups,
1171 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1172 also save you some time at startup. Even if this variable is
1173 @code{nil}, you can always subscribe to the new groups just by pressing
1174 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1175 is @code{ask-server} by default. If you set this variable to
1176 @code{always}, then Gnus will query the back ends for new groups even
1177 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1180 * Checking New Groups:: Determining what groups are new.
1181 * Subscription Methods:: What Gnus should do with new groups.
1182 * Filtering New Groups:: Making Gnus ignore certain new groups.
1186 @node Checking New Groups
1187 @subsection Checking New Groups
1189 Gnus normally determines whether a group is new or not by comparing the
1190 list of groups from the active file(s) with the lists of subscribed and
1191 dead groups. This isn't a particularly fast method. If
1192 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1193 server for new groups since the last time. This is both faster and
1194 cheaper. This also means that you can get rid of the list of killed
1195 groups altogether, so you may set @code{gnus-save-killed-list} to
1196 @code{nil}, which will save time both at startup, at exit, and all over.
1197 Saves disk space, too. Why isn't this the default, then?
1198 Unfortunately, not all servers support this command.
1200 I bet I know what you're thinking now: How do I find out whether my
1201 server supports @code{ask-server}? No? Good, because I don't have a
1202 fail-safe answer. I would suggest just setting this variable to
1203 @code{ask-server} and see whether any new groups appear within the next
1204 few days. If any do, then it works. If none do, then it doesn't
1205 work. I could write a function to make gnus guess whether the server
1206 supports @code{ask-server}, but it would just be a guess. So I won't.
1207 You could @code{telnet} to the server and say @code{HELP} and see
1208 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1209 it does, then it might work. (But there are servers that lists
1210 @samp{NEWGROUPS} without supporting the function properly.)
1212 This variable can also be a list of select methods. If so, gnus will
1213 issue an @code{ask-server} command to each of the select methods, and
1214 subscribe them (or not) using the normal methods. This might be handy
1215 if you are monitoring a few servers for new groups. A side effect is
1216 that startup will take much longer, so you can meditate while waiting.
1217 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1220 @node Subscription Methods
1221 @subsection Subscription Methods
1223 @vindex gnus-subscribe-newsgroup-method
1224 What gnus does when it encounters a new group is determined by the
1225 @code{gnus-subscribe-newsgroup-method} variable.
1227 This variable should contain a function. This function will be called
1228 with the name of the new group as the only parameter.
1230 Some handy pre-fab functions are:
1234 @item gnus-subscribe-zombies
1235 @vindex gnus-subscribe-zombies
1236 Make all new groups zombies. This is the default. You can browse the
1237 zombies later (with @kbd{A z}) and either kill them all off properly
1238 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1240 @item gnus-subscribe-randomly
1241 @vindex gnus-subscribe-randomly
1242 Subscribe all new groups in arbitrary order. This really means that all
1243 new groups will be added at ``the top'' of the group buffer.
1245 @item gnus-subscribe-alphabetically
1246 @vindex gnus-subscribe-alphabetically
1247 Subscribe all new groups in alphabetical order.
1249 @item gnus-subscribe-hierarchically
1250 @vindex gnus-subscribe-hierarchically
1251 Subscribe all new groups hierarchically. The difference between this
1252 function and @code{gnus-subscribe-alphabetically} is slight.
1253 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1254 alphabetical fashion, while this function will enter groups into its
1255 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1256 @samp{comp} hierarchy, this function will not mess that configuration
1257 up. Or something like that.
1259 @item gnus-subscribe-interactively
1260 @vindex gnus-subscribe-interactively
1261 Subscribe new groups interactively. This means that gnus will ask
1262 you about @strong{all} new groups. The groups you choose to subscribe
1263 to will be subscribed hierarchically.
1265 @item gnus-subscribe-killed
1266 @vindex gnus-subscribe-killed
1267 Kill all new groups.
1269 @item gnus-subscribe-topics
1270 @vindex gnus-subscribe-topics
1271 Put the groups into the topic that has a matching @code{subscribe} topic
1272 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1273 topic parameter that looks like
1279 will mean that all groups that match that regex will be subscribed under
1282 If no topics match the groups, the groups will be subscribed in the
1287 @vindex gnus-subscribe-hierarchical-interactive
1288 A closely related variable is
1289 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1290 mouthful.) If this variable is non-@code{nil}, gnus will ask you in a
1291 hierarchical fashion whether to subscribe to new groups or not. Gnus
1292 will ask you for each sub-hierarchy whether you want to descend the
1295 One common mistake is to set the variable a few paragraphs above
1296 (@code{gnus-subscribe-newsgroup-method}) to
1297 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1298 will not work. This is ga-ga. So don't do it.
1301 @node Filtering New Groups
1302 @subsection Filtering New Groups
1304 A nice and portable way to control which new newsgroups should be
1305 subscribed (or ignored) is to put an @dfn{options} line at the start of
1306 the @file{.newsrc} file. Here's an example:
1309 options -n !alt.all !rec.all sci.all
1312 @vindex gnus-subscribe-options-newsgroup-method
1313 This line obviously belongs to a serious-minded intellectual scientific
1314 person (or she may just be plain old boring), because it says that all
1315 groups that have names beginning with @samp{alt} and @samp{rec} should
1316 be ignored, and all groups with names beginning with @samp{sci} should
1317 be subscribed. Gnus will not use the normal subscription method for
1318 subscribing these groups.
1319 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1320 variable defaults to @code{gnus-subscribe-alphabetically}.
1322 @vindex gnus-options-not-subscribe
1323 @vindex gnus-options-subscribe
1324 If you don't want to mess with your @file{.newsrc} file, you can just
1325 set the two variables @code{gnus-options-subscribe} and
1326 @code{gnus-options-not-subscribe}. These two variables do exactly the
1327 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1328 and if the new group matches the former, it will be unconditionally
1329 subscribed, and if it matches the latter, it will be ignored.
1331 @vindex gnus-auto-subscribed-groups
1332 Yet another variable that meddles here is
1333 @code{gnus-auto-subscribed-groups}. It works exactly like
1334 @code{gnus-options-subscribe}, and is therefore really superfluous,
1335 but I thought it would be nice to have two of these. This variable is
1336 more meant for setting some ground rules, while the other variable is
1337 used more for user fiddling. By default this variable makes all new
1338 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1339 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1340 subscribed. If you don't like that, just set this variable to
1343 New groups that match this regexp are subscribed using
1344 @code{gnus-subscribe-options-newsgroup-method}.
1347 @node Changing Servers
1348 @section Changing Servers
1349 @cindex changing servers
1351 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1352 This happens very rarely, but perhaps you change jobs, or one server is
1353 very flaky and you want to use another.
1355 Changing the server is pretty easy, right? You just change
1356 @code{gnus-select-method} to point to the new server?
1360 Article numbers are not (in any way) kept synchronized between different
1361 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1362 you have read is by keeping track of article numbers. So when you
1363 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1366 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1367 file from one server to another. They all have one thing in
1368 common---they take a looong time to run. You don't want to use these
1369 functions more than absolutely necessary.
1371 @kindex M-x gnus-change-server
1372 @findex gnus-change-server
1373 If you have access to both servers, Gnus can request the headers for all
1374 the articles you have read and compare @code{Message-ID}s and map the
1375 article numbers of the read articles and article marks. The @kbd{M-x
1376 gnus-change-server} command will do this for all your native groups. It
1377 will prompt for the method you want to move to.
1379 @kindex M-x gnus-group-move-group-to-server
1380 @findex gnus-group-move-group-to-server
1381 You can also move individual groups with the @kbd{M-x
1382 gnus-group-move-group-to-server} command. This is useful if you want to
1383 move a (foreign) group from one server to another.
1385 @kindex M-x gnus-group-clear-data-on-native-groups
1386 @findex gnus-group-clear-data-on-native-groups
1387 If you don't have access to both the old and new server, all your marks
1388 and read ranges have become worthless. You can use the @kbd{M-x
1389 gnus-group-clear-data-on-native-groups} command to clear out all data
1390 that you have on your native groups. Use with caution.
1392 @kindex M-x gnus-group-clear-data
1393 @findex gnus-group-clear-data
1394 Clear the data from the current group only---nix out marks and the
1395 list of read articles (@code{gnus-group-clear-data}).
1397 After changing servers, you @strong{must} move the cache hierarchy away,
1398 since the cached articles will have wrong article numbers, which will
1399 affect which articles Gnus thinks are read.
1400 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1401 to have it done automatically; for @code{gnus-group-clear-data}, you
1402 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1403 cache for all groups).
1407 @section Startup Files
1408 @cindex startup files
1413 Now, you all know about the @file{.newsrc} file. All subscription
1414 information is traditionally stored in this file.
1416 Things got a bit more complicated with @sc{gnus}. In addition to
1417 keeping the @file{.newsrc} file updated, it also used a file called
1418 @file{.newsrc.el} for storing all the information that didn't fit into
1419 the @file{.newsrc} file. (Actually, it also duplicated everything in
1420 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1421 files was the most recently saved, which enabled people to swap between
1422 @sc{gnus} and other newsreaders.
1424 That was kinda silly, so Gnus went one better: In addition to the
1425 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1426 @file{.newsrc.eld}. It will read whichever of these files that are most
1427 recent, but it will never write a @file{.newsrc.el} file. You should
1428 never delete the @file{.newsrc.eld} file---it contains much information
1429 not stored in the @file{.newsrc} file.
1431 @vindex gnus-save-newsrc-file
1432 @vindex gnus-read-newsrc-file
1433 You can turn off writing the @file{.newsrc} file by setting
1434 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1435 the file and save some space, as well as exiting from gnus faster.
1436 However, this will make it impossible to use other newsreaders than
1437 gnus. But hey, who would want to, right? Similarly, setting
1438 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1439 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1440 convenient if you have a tendency to use Netscape once in a while.
1442 @vindex gnus-save-killed-list
1443 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1444 will not save the list of killed groups to the startup file. This will
1445 save both time (when starting and quitting) and space (on disk). It
1446 will also mean that Gnus has no record of what groups are new or old,
1447 so the automatic new groups subscription methods become meaningless.
1448 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1449 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1450 Groups}). This variable can also be a regular expression. If that's
1451 the case, remove all groups that do not match this regexp before
1452 saving. This can be useful in certain obscure situations that involve
1453 several servers where not all servers support @code{ask-server}.
1455 @vindex gnus-startup-file
1456 @vindex gnus-backup-startup-file
1457 @vindex version-control
1458 The @code{gnus-startup-file} variable says where the startup files are.
1459 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1460 file being whatever that one is, with a @samp{.eld} appended.
1461 If you want version control for this file, set
1462 @code{gnus-backup-startup-file}. It respects the same values as the
1463 @code{version-control} variable.
1465 @vindex gnus-save-newsrc-hook
1466 @vindex gnus-save-quick-newsrc-hook
1467 @vindex gnus-save-standard-newsrc-hook
1468 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1469 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1470 saving the @file{.newsrc.eld} file, and
1471 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1472 @file{.newsrc} file. The latter two are commonly used to turn version
1473 control on or off. Version control is on by default when saving the
1474 startup files. If you want to turn backup creation off, say something like:
1477 (defun turn-off-backup ()
1478 (set (make-local-variable 'backup-inhibited) t))
1480 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1481 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1484 @vindex gnus-init-file
1485 @vindex gnus-site-init-file
1486 When gnus starts, it will read the @code{gnus-site-init-file}
1487 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1488 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1489 and can be used to avoid cluttering your @file{~/.emacs} and
1490 @file{site-init} files with gnus stuff. Gnus will also check for files
1491 with the same names as these, but with @file{.elc} and @file{.el}
1492 suffixes. In other words, if you have set @code{gnus-init-file} to
1493 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1494 and finally @file{~/.gnus} (in this order).
1500 @cindex dribble file
1503 Whenever you do something that changes the gnus data (reading articles,
1504 catching up, killing/subscribing groups), the change is added to a
1505 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1506 Emacs way. If your Emacs should crash before you have saved the
1507 @file{.newsrc} files, all changes you have made can be recovered from
1510 If gnus detects this file at startup, it will ask the user whether to
1511 read it. The auto save file is deleted whenever the real startup file is
1514 @vindex gnus-use-dribble-file
1515 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1516 maintain a dribble buffer. The default is @code{t}.
1518 @vindex gnus-dribble-directory
1519 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1520 this variable is @code{nil}, which it is by default, gnus will dribble
1521 into the directory where the @file{.newsrc} file is located. (This is
1522 normally the user's home directory.) The dribble file will get the same
1523 file permissions as the @file{.newsrc} file.
1525 @vindex gnus-always-read-dribble-file
1526 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1527 read the dribble file on startup without querying the user.
1530 @node The Active File
1531 @section The Active File
1533 @cindex ignored groups
1535 When gnus starts, or indeed whenever it tries to determine whether new
1536 articles have arrived, it reads the active file. This is a very large
1537 file that lists all the active groups and articles on the server.
1539 @vindex gnus-ignored-newsgroups
1540 Before examining the active file, gnus deletes all lines that match the
1541 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1542 any groups with bogus names, but you can use this variable to make gnus
1543 ignore hierarchies you aren't ever interested in. However, this is not
1544 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1545 Groups} for an overview of other variables that can be used instead.
1548 @c @code{nil} by default, and will slow down active file handling somewhat
1549 @c if you set it to anything else.
1551 @vindex gnus-read-active-file
1553 The active file can be rather Huge, so if you have a slow network, you
1554 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1555 reading the active file. This variable is @code{some} by default.
1557 Gnus will try to make do by getting information just on the groups that
1558 you actually subscribe to.
1560 Note that if you subscribe to lots and lots of groups, setting this
1561 variable to @code{nil} will probably make gnus slower, not faster. At
1562 present, having this variable @code{nil} will slow gnus down
1563 considerably, unless you read news over a 2400 baud modem.
1565 This variable can also have the value @code{some}. Gnus will then
1566 attempt to read active info only on the subscribed groups. On some
1567 servers this is quite fast (on sparkling, brand new INN servers that
1568 support the @code{LIST ACTIVE group} command), on others this isn't fast
1569 at all. In any case, @code{some} should be faster than @code{nil}, and
1570 is certainly faster than @code{t} over slow lines.
1572 Some news servers (old versions of Leafnode and old versions of INN, for
1573 instance) do not support the @code{LIST ACTIVE group}. For these
1574 servers, @code{nil} is probably the most efficient value for this
1577 If this variable is @code{nil}, gnus will ask for group info in total
1578 lock-step, which isn't very fast. If it is @code{some} and you use an
1579 @acronym{NNTP} server, gnus will pump out commands as fast as it can, and
1580 read all the replies in one swoop. This will normally result in better
1581 performance, but if the server does not support the aforementioned
1582 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1584 If you think that starting up Gnus takes too long, try all the three
1585 different values for this variable and see what works best for you.
1587 In any case, if you use @code{some} or @code{nil}, you should definitely
1588 kill all groups that you aren't interested in to speed things up.
1590 Note that this variable also affects active file retrieval from
1591 secondary select methods.
1594 @node Startup Variables
1595 @section Startup Variables
1599 @item gnus-load-hook
1600 @vindex gnus-load-hook
1601 A hook run while gnus is being loaded. Note that this hook will
1602 normally be run just once in each Emacs session, no matter how many
1603 times you start gnus.
1605 @item gnus-before-startup-hook
1606 @vindex gnus-before-startup-hook
1607 A hook run after starting up gnus successfully.
1609 @item gnus-startup-hook
1610 @vindex gnus-startup-hook
1611 A hook run as the very last thing after starting up gnus
1613 @item gnus-started-hook
1614 @vindex gnus-started-hook
1615 A hook that is run as the very last thing after starting up gnus
1618 @item gnus-setup-news-hook
1619 @vindex gnus-setup-news-hook
1620 A hook that is run after reading the @file{.newsrc} file(s), but before
1621 generating the group buffer.
1623 @item gnus-check-bogus-newsgroups
1624 @vindex gnus-check-bogus-newsgroups
1625 If non-@code{nil}, gnus will check for and delete all bogus groups at
1626 startup. A @dfn{bogus group} is a group that you have in your
1627 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1628 bogus groups can take quite a while, so to save time and resources it's
1629 best to leave this option off, and do the checking for bogus groups once
1630 in a while from the group buffer instead (@pxref{Group Maintenance}).
1632 @item gnus-inhibit-startup-message
1633 @vindex gnus-inhibit-startup-message
1634 If non-@code{nil}, the startup message won't be displayed. That way,
1635 your boss might not notice as easily that you are reading news instead
1636 of doing your job. Note that this variable is used before
1637 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1639 @item gnus-no-groups-message
1640 @vindex gnus-no-groups-message
1641 Message displayed by gnus when no groups are available.
1643 @item gnus-play-startup-jingle
1644 @vindex gnus-play-startup-jingle
1645 If non-@code{nil}, play the gnus jingle at startup.
1647 @item gnus-startup-jingle
1648 @vindex gnus-startup-jingle
1649 Jingle to be played if the above variable is non-@code{nil}. The
1650 default is @samp{Tuxedomoon.Jingle4.au}.
1656 @chapter Group Buffer
1657 @cindex group buffer
1659 @c Alex Schroeder suggests to rearrange this as follows:
1661 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1662 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1663 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1664 @c 7. Group Score, 8. Group Buffer Format
1665 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1666 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1667 @c <kensanata> First, "Gnus considers groups... (default 9)."
1668 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1669 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1670 @c <kensanata> Then expand the next paragraph or add some more to it.
1671 @c This short one sentence explains levels 1 and 2, therefore I understand
1672 @c that I should keep important news at 3 and boring news at 4.
1673 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1674 @c Maybe keep those that you don't want to read temporarily at 6,
1675 @c those that you never want to read at 8, those that offend your
1676 @c human rights at 9...
1679 The @dfn{group buffer} lists all (or parts) of the available groups. It
1680 is the first buffer shown when gnus starts, and will never be killed as
1681 long as gnus is active.
1685 \gnusfigure{The Group Buffer}{320}{
1686 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1687 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1688 \put(120,38){\vector(1,2){10}}
1689 \put(40,60){\makebox(0,0)[r]{Mode line}}
1690 \put(40,58){\vector(1,0){30}}
1691 \put(200,28){\makebox(0,0)[t]{Native select method}}
1692 \put(200,26){\vector(-1,2){15}}
1698 * Group Buffer Format:: Information listed and how you can change it.
1699 * Group Maneuvering:: Commands for moving in the group buffer.
1700 * Selecting a Group:: Actually reading news.
1701 * Subscription Commands:: Unsubscribing, killing, subscribing.
1702 * Group Data:: Changing the info for a group.
1703 * Group Levels:: Levels? What are those, then?
1704 * Group Score:: A mechanism for finding out what groups you like.
1705 * Marking Groups:: You can mark groups for later processing.
1706 * Foreign Groups:: Creating and editing groups.
1707 * Group Parameters:: Each group may have different parameters set.
1708 * Listing Groups:: Gnus can list various subsets of the groups.
1709 * Sorting Groups:: Re-arrange the group order.
1710 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1711 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1712 * Exiting Gnus:: Stop reading news and get some work done.
1713 * Group Topics:: A folding group mode divided into topics.
1714 * Misc Group Stuff:: Other stuff that you can to do.
1718 @node Group Buffer Format
1719 @section Group Buffer Format
1722 * Group Line Specification:: Deciding how the group buffer is to look.
1723 * Group Mode Line Specification:: The group buffer mode line.
1724 * Group Highlighting:: Having nice colors in the group buffer.
1728 @node Group Line Specification
1729 @subsection Group Line Specification
1730 @cindex group buffer format
1732 The default format of the group buffer is nice and dull, but you can
1733 make it as exciting and ugly as you feel like.
1735 Here's a couple of example group lines:
1738 25: news.announce.newusers
1739 * 0: alt.fan.andrea-dworkin
1744 You can see that there are 25 unread articles in
1745 @samp{news.announce.newusers}. There are no unread articles, but some
1746 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1747 asterisk at the beginning of the line?).
1749 @vindex gnus-group-line-format
1750 You can change that format to whatever you want by fiddling with the
1751 @code{gnus-group-line-format} variable. This variable works along the
1752 lines of a @code{format} specification, which is pretty much the same as
1753 a @code{printf} specifications, for those of you who use (feh!) C.
1754 @xref{Formatting Variables}.
1756 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1758 There should always be a colon on the line; the cursor always moves to
1759 the colon after performing an operation. @xref{Positioning
1760 Point}. Nothing else is required---not even the group name. All
1761 displayed text is just window dressing, and is never examined by Gnus.
1762 Gnus stores all real information it needs using text properties.
1764 (Note that if you make a really strange, wonderful, spreadsheet-like
1765 layout, everybody will believe you are hard at work with the accounting
1766 instead of wasting time reading news.)
1768 Here's a list of all available format characters:
1773 An asterisk if the group only has marked articles.
1776 Whether the group is subscribed.
1779 Level of subscribedness.
1782 Number of unread articles.
1785 Number of dormant articles.
1788 Number of ticked articles.
1791 Number of read articles.
1794 Number of unseen articles.
1797 Estimated total number of articles. (This is really @var{max-number}
1798 minus @var{min-number} plus 1.)
1800 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1801 efficient access to @var{max-number} and @var{min-number} but getting
1802 the true unread message count is not possible efficiently. For
1803 hysterical raisins, even the mail back ends, where the true number of
1804 unread messages might be available efficiently, use the same limited
1805 interface. To remove this restriction from Gnus means that the back
1806 end interface has to be changed, which is not an easy job. If you
1807 want to work on this, please contact the Gnus mailing list.
1810 Number of unread, unticked, non-dormant articles.
1813 Number of ticked and dormant articles.
1822 Group comment (@pxref{Group Parameters}) or group name if there is no
1823 comment element in the group parameters.
1826 Newsgroup description. You need to read the group descriptions
1827 before these will appear, and to do that, you either have to set
1828 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1832 @samp{m} if moderated.
1835 @samp{(m)} if moderated.
1841 If the summary buffer for the group is open or not.
1847 A string that looks like @samp{<%s:%n>} if a foreign select method is
1851 Indentation based on the level of the topic (@pxref{Group Topics}).
1854 @vindex gnus-group-uncollapsed-levels
1855 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1856 variable says how many levels to leave at the end of the group name.
1857 The default is 1---this will mean that group names like
1858 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1861 @vindex gnus-new-mail-mark
1863 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1867 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1870 A string that says when you last read the group (@pxref{Group
1874 The disk space used by the articles fetched by both the cache and
1875 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1876 megabytes(M), or gigabytes(G) to minimize the column width. A format
1877 of %7F is sufficient for a fixed-width column.
1880 User defined specifier. The next character in the format string should
1881 be a letter. Gnus will call the function
1882 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1883 following @samp{%u}. The function will be passed a single dummy
1884 parameter as argument. The function should return a string, which will
1885 be inserted into the buffer just like information from any other
1890 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1891 if no info is available---for instance, if it is a non-activated foreign
1892 group, or a bogus native group.
1895 @node Group Mode Line Specification
1896 @subsection Group Mode Line Specification
1897 @cindex group mode line
1899 @vindex gnus-group-mode-line-format
1900 The mode line can be changed by setting
1901 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1902 doesn't understand that many format specifiers:
1906 The native news server.
1908 The native select method.
1912 @node Group Highlighting
1913 @subsection Group Highlighting
1914 @cindex highlighting
1915 @cindex group highlighting
1917 @vindex gnus-group-highlight
1918 Highlighting in the group buffer is controlled by the
1919 @code{gnus-group-highlight} variable. This is an alist with elements
1920 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1921 something non-@code{nil}, the @var{face} will be used on the line.
1923 Here's an example value for this variable that might look nice if the
1927 (cond (window-system
1928 (setq custom-background-mode 'light)
1929 (defface my-group-face-1
1930 '((t (:foreground "Red" :bold t))) "First group face")
1931 (defface my-group-face-2
1932 '((t (:foreground "DarkSeaGreen4" :bold t)))
1933 "Second group face")
1934 (defface my-group-face-3
1935 '((t (:foreground "Green4" :bold t))) "Third group face")
1936 (defface my-group-face-4
1937 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1938 (defface my-group-face-5
1939 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1941 (setq gnus-group-highlight
1942 '(((> unread 200) . my-group-face-1)
1943 ((and (< level 3) (zerop unread)) . my-group-face-2)
1944 ((< level 3) . my-group-face-3)
1945 ((zerop unread) . my-group-face-4)
1946 (t . my-group-face-5)))
1949 Also @pxref{Faces and Fonts}.
1951 Variables that are dynamically bound when the forms are evaluated
1958 The number of unread articles in the group.
1962 Whether the group is a mail group.
1964 The level of the group.
1966 The score of the group.
1968 The number of ticked articles in the group.
1970 The total number of articles in the group. Or rather,
1971 @var{max-number} minus @var{min-number} plus one.
1973 When using the topic minor mode, this variable is bound to the current
1974 topic being inserted.
1977 When the forms are @code{eval}ed, point is at the beginning of the line
1978 of the group in question, so you can use many of the normal gnus
1979 functions for snarfing info on the group.
1981 @vindex gnus-group-update-hook
1982 @findex gnus-group-highlight-line
1983 @code{gnus-group-update-hook} is called when a group line is changed.
1984 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1985 calls @code{gnus-group-highlight-line} by default.
1988 @node Group Maneuvering
1989 @section Group Maneuvering
1990 @cindex group movement
1992 All movement commands understand the numeric prefix and will behave as
1993 expected, hopefully.
1999 @findex gnus-group-next-unread-group
2000 Go to the next group that has unread articles
2001 (@code{gnus-group-next-unread-group}).
2007 @findex gnus-group-prev-unread-group
2008 Go to the previous group that has unread articles
2009 (@code{gnus-group-prev-unread-group}).
2013 @findex gnus-group-next-group
2014 Go to the next group (@code{gnus-group-next-group}).
2018 @findex gnus-group-prev-group
2019 Go to the previous group (@code{gnus-group-prev-group}).
2023 @findex gnus-group-next-unread-group-same-level
2024 Go to the next unread group on the same (or lower) level
2025 (@code{gnus-group-next-unread-group-same-level}).
2029 @findex gnus-group-prev-unread-group-same-level
2030 Go to the previous unread group on the same (or lower) level
2031 (@code{gnus-group-prev-unread-group-same-level}).
2034 Three commands for jumping to groups:
2040 @findex gnus-group-jump-to-group
2041 Jump to a group (and make it visible if it isn't already)
2042 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2047 @findex gnus-group-best-unread-group
2048 Jump to the unread group with the lowest level
2049 (@code{gnus-group-best-unread-group}).
2053 @findex gnus-group-first-unread-group
2054 Jump to the first group with unread articles
2055 (@code{gnus-group-first-unread-group}).
2058 @vindex gnus-group-goto-unread
2059 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2060 commands will move to the next group, not the next unread group. Even
2061 the commands that say they move to the next unread group. The default
2065 @node Selecting a Group
2066 @section Selecting a Group
2067 @cindex group selection
2072 @kindex SPACE (Group)
2073 @findex gnus-group-read-group
2074 Select the current group, switch to the summary buffer and display the
2075 first unread article (@code{gnus-group-read-group}). If there are no
2076 unread articles in the group, or if you give a non-numerical prefix to
2077 this command, gnus will offer to fetch all the old articles in this
2078 group from the server. If you give a numerical prefix @var{n}, @var{n}
2079 determines the number of articles Gnus will fetch. If @var{n} is
2080 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2081 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2083 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2084 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2085 - 4 2 SPC} fetches the 42 oldest ones.
2087 When you are in the group (in the Summary buffer), you can type
2088 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2093 @findex gnus-group-select-group
2094 Select the current group and switch to the summary buffer
2095 (@code{gnus-group-select-group}). Takes the same arguments as
2096 @code{gnus-group-read-group}---the only difference is that this command
2097 does not display the first unread article automatically upon group
2101 @kindex M-RET (Group)
2102 @findex gnus-group-quick-select-group
2103 This does the same as the command above, but tries to do it with the
2104 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2105 scoring/killing will be performed, there will be no highlights and no
2106 expunging. This might be useful if you're in a real hurry and have to
2107 enter some humongous group. If you give a 0 prefix to this command
2108 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
2109 which is useful if you want to toggle threading before generating the
2110 summary buffer (@pxref{Summary Generation Commands}).
2113 @kindex M-SPACE (Group)
2114 @findex gnus-group-visible-select-group
2115 This is yet one more command that does the same as the @kbd{RET}
2116 command, but this one does it without expunging and hiding dormants
2117 (@code{gnus-group-visible-select-group}).
2120 @kindex C-M-RET (Group)
2121 @findex gnus-group-select-group-ephemerally
2122 Finally, this command selects the current group ephemerally without
2123 doing any processing of its contents
2124 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2125 turned off. Everything you do in the group after selecting it in this
2126 manner will have no permanent effects.
2130 @vindex gnus-large-newsgroup
2131 The @code{gnus-large-newsgroup} variable says what Gnus should
2132 consider to be a big group. If it is @code{nil}, no groups are
2133 considered big. The default value is 200. If the group has more
2134 (unread and/or ticked) articles than this, gnus will query the user
2135 before entering the group. The user can then specify how many
2136 articles should be fetched from the server. If the user specifies a
2137 negative number (@var{-n}), the @var{n} oldest articles will be
2138 fetched. If it is positive, the @var{n} articles that have arrived
2139 most recently will be fetched.
2141 @vindex gnus-large-ephemeral-newsgroup
2142 @code{gnus-large-ephemeral-newsgroup} is the same as
2143 @code{gnus-large-newsgroup}, but is only used for ephemeral
2146 @vindex gnus-select-group-hook
2147 @vindex gnus-auto-select-first
2148 @vindex gnus-auto-select-subject
2149 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2150 automatically when entering a group with the @kbd{SPACE} command.
2151 Which article this is is controlled by the
2152 @code{gnus-auto-select-subject} variable. Valid values for this
2158 Place point on the subject line of the first unread article.
2161 Place point on the subject line of the first article.
2164 Place point on the subject line of the first unseen article.
2166 @item unseen-or-unread
2167 Place point on the subject line of the first unseen article, and if
2168 there is no such article, place point on the subject line of the first
2172 Place point on the subject line of the highest-scored unread article.
2176 This variable can also be a function. In that case, that function
2177 will be called to place point on a subject line.
2179 If you want to prevent automatic selection in some group (say, in a
2180 binary group with Huge articles) you can set the
2181 @code{gnus-auto-select-first} variable to @code{nil} in
2182 @code{gnus-select-group-hook}, which is called when a group is
2186 @node Subscription Commands
2187 @section Subscription Commands
2188 @cindex subscription
2196 @findex gnus-group-unsubscribe-current-group
2197 @c @icon{gnus-group-unsubscribe}
2198 Toggle subscription to the current group
2199 (@code{gnus-group-unsubscribe-current-group}).
2205 @findex gnus-group-unsubscribe-group
2206 Prompt for a group to subscribe, and then subscribe it. If it was
2207 subscribed already, unsubscribe it instead
2208 (@code{gnus-group-unsubscribe-group}).
2214 @findex gnus-group-kill-group
2215 @c @icon{gnus-group-kill-group}
2216 Kill the current group (@code{gnus-group-kill-group}).
2222 @findex gnus-group-yank-group
2223 Yank the last killed group (@code{gnus-group-yank-group}).
2226 @kindex C-x C-t (Group)
2227 @findex gnus-group-transpose-groups
2228 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2229 really a subscription command, but you can use it instead of a
2230 kill-and-yank sequence sometimes.
2236 @findex gnus-group-kill-region
2237 Kill all groups in the region (@code{gnus-group-kill-region}).
2241 @findex gnus-group-kill-all-zombies
2242 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2245 @kindex S C-k (Group)
2246 @findex gnus-group-kill-level
2247 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2248 These groups can't be yanked back after killing, so this command should
2249 be used with some caution. The only time where this command comes in
2250 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2251 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2252 kill off all unsubscribed groups that do not have message numbers in the
2253 @file{.newsrc} file.
2257 Also @pxref{Group Levels}.
2267 @findex gnus-group-catchup-current
2268 @vindex gnus-group-catchup-group-hook
2269 @c @icon{gnus-group-catchup-current}
2270 Mark all unticked articles in this group as read
2271 (@code{gnus-group-catchup-current}).
2272 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2277 @findex gnus-group-catchup-current-all
2278 Mark all articles in this group, even the ticked ones, as read
2279 (@code{gnus-group-catchup-current-all}).
2283 @findex gnus-group-clear-data
2284 Clear the data from the current group---nix out marks and the list of
2285 read articles (@code{gnus-group-clear-data}).
2287 @item M-x gnus-group-clear-data-on-native-groups
2288 @kindex M-x gnus-group-clear-data-on-native-groups
2289 @findex gnus-group-clear-data-on-native-groups
2290 If you have switched from one @acronym{NNTP} server to another, all your marks
2291 and read ranges have become worthless. You can use this command to
2292 clear out all data that you have on your native groups. Use with
2299 @section Group Levels
2303 All groups have a level of @dfn{subscribedness}. For instance, if a
2304 group is on level 2, it is more subscribed than a group on level 5. You
2305 can ask gnus to just list groups on a given level or lower
2306 (@pxref{Listing Groups}), or to just check for new articles in groups on
2307 a given level or lower (@pxref{Scanning New Messages}).
2309 Remember: The higher the level of the group, the less important it is.
2315 @findex gnus-group-set-current-level
2316 Set the level of the current group. If a numeric prefix is given, the
2317 next @var{n} groups will have their levels set. The user will be
2318 prompted for a level.
2321 @vindex gnus-level-killed
2322 @vindex gnus-level-zombie
2323 @vindex gnus-level-unsubscribed
2324 @vindex gnus-level-subscribed
2325 Gnus considers groups from levels 1 to
2326 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2327 @code{gnus-level-subscribed} (exclusive) and
2328 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2329 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2330 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2331 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2332 same, but zombie and killed groups have no information on what articles
2333 you have read, etc, stored. This distinction between dead and living
2334 groups isn't done because it is nice or clever, it is done purely for
2335 reasons of efficiency.
2337 It is recommended that you keep all your mail groups (if any) on quite
2338 low levels (e.g. 1 or 2).
2340 Maybe the following description of the default behavior of Gnus helps to
2341 understand what these levels are all about. By default, Gnus shows you
2342 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2343 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2344 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2345 groups are hidden, in a way.
2347 Zombie and killed groups are similar to unsubscribed groups in that they
2348 are hidden by default. But they are different from subscribed and
2349 unsubscribed groups in that Gnus doesn't ask the news server for
2350 information (number of messages, number of unread messages) on zombie
2351 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2352 aren't interested in. If most groups are killed, Gnus is faster.
2354 Why does Gnus distinguish between zombie and killed groups? Well, when
2355 a new group arrives on the server, Gnus by default makes it a zombie
2356 group. This means that you are normally not bothered with new groups,
2357 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2358 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2359 list of killed groups.)
2361 If you want to play with the level variables, you should show some care.
2362 Set them once, and don't touch them ever again. Better yet, don't touch
2363 them at all unless you know exactly what you're doing.
2365 @vindex gnus-level-default-unsubscribed
2366 @vindex gnus-level-default-subscribed
2367 Two closely related variables are @code{gnus-level-default-subscribed}
2368 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2369 which are the levels that new groups will be put on if they are
2370 (un)subscribed. These two variables should, of course, be inside the
2371 relevant valid ranges.
2373 @vindex gnus-keep-same-level
2374 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2375 will only move to groups of the same level (or lower). In
2376 particular, going from the last article in one group to the next group
2377 will go to the next group of the same level (or lower). This might be
2378 handy if you want to read the most important groups before you read the
2381 If this variable is @code{best}, Gnus will make the next newsgroup the
2382 one with the best level.
2384 @vindex gnus-group-default-list-level
2385 All groups with a level less than or equal to
2386 @code{gnus-group-default-list-level} will be listed in the group buffer
2389 @vindex gnus-group-list-inactive-groups
2390 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2391 groups will be listed along with the unread groups. This variable is
2392 @code{t} by default. If it is @code{nil}, inactive groups won't be
2395 @vindex gnus-group-use-permanent-levels
2396 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2397 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2398 use this level as the ``work'' level.
2400 @vindex gnus-activate-level
2401 Gnus will normally just activate (i. e., query the server about) groups
2402 on level @code{gnus-activate-level} or less. If you don't want to
2403 activate unsubscribed groups, for instance, you might set this variable
2404 to 5. The default is 6.
2408 @section Group Score
2413 You would normally keep important groups on high levels, but that scheme
2414 is somewhat restrictive. Don't you wish you could have Gnus sort the
2415 group buffer according to how often you read groups, perhaps? Within
2418 This is what @dfn{group score} is for. You can have Gnus assign a score
2419 to each group through the mechanism described below. You can then sort
2420 the group buffer based on this score. Alternatively, you can sort on
2421 score and then level. (Taken together, the level and the score is
2422 called the @dfn{rank} of the group. A group that is on level 4 and has
2423 a score of 1 has a higher rank than a group on level 5 that has a score
2424 of 300. (The level is the most significant part and the score is the
2425 least significant part.))
2427 @findex gnus-summary-bubble-group
2428 If you want groups you read often to get higher scores than groups you
2429 read seldom you can add the @code{gnus-summary-bubble-group} function to
2430 the @code{gnus-summary-exit-hook} hook. This will result (after
2431 sorting) in a bubbling sort of action. If you want to see that in
2432 action after each summary exit, you can add
2433 @code{gnus-group-sort-groups-by-rank} or
2434 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2435 slow things down somewhat.
2438 @node Marking Groups
2439 @section Marking Groups
2440 @cindex marking groups
2442 If you want to perform some command on several groups, and they appear
2443 subsequently in the group buffer, you would normally just give a
2444 numerical prefix to the command. Most group commands will then do your
2445 bidding on those groups.
2447 However, if the groups are not in sequential order, you can still
2448 perform a command on several groups. You simply mark the groups first
2449 with the process mark and then execute the command.
2457 @findex gnus-group-mark-group
2458 Set the mark on the current group (@code{gnus-group-mark-group}).
2464 @findex gnus-group-unmark-group
2465 Remove the mark from the current group
2466 (@code{gnus-group-unmark-group}).
2470 @findex gnus-group-unmark-all-groups
2471 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2475 @findex gnus-group-mark-region
2476 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2480 @findex gnus-group-mark-buffer
2481 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2485 @findex gnus-group-mark-regexp
2486 Mark all groups that match some regular expression
2487 (@code{gnus-group-mark-regexp}).
2490 Also @pxref{Process/Prefix}.
2492 @findex gnus-group-universal-argument
2493 If you want to execute some command on all groups that have been marked
2494 with the process mark, you can use the @kbd{M-&}
2495 (@code{gnus-group-universal-argument}) command. It will prompt you for
2496 the command to be executed.
2499 @node Foreign Groups
2500 @section Foreign Groups
2501 @cindex foreign groups
2503 Below are some group mode commands for making and editing general foreign
2504 groups, as well as commands to ease the creation of a few
2505 special-purpose groups. All these commands insert the newly created
2506 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2513 @findex gnus-group-make-group
2514 @cindex making groups
2515 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2516 for a name, a method and possibly an @dfn{address}. For an easier way
2517 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2521 @findex gnus-group-read-ephemeral-group
2522 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2523 will prompt you for a name, a method and an @dfn{address}.
2527 @findex gnus-group-rename-group
2528 @cindex renaming groups
2529 Rename the current group to something else
2530 (@code{gnus-group-rename-group}). This is valid only on some
2531 groups---mail groups mostly. This command might very well be quite slow
2537 @findex gnus-group-customize
2538 Customize the group parameters (@code{gnus-group-customize}).
2542 @findex gnus-group-edit-group-method
2543 @cindex renaming groups
2544 Enter a buffer where you can edit the select method of the current
2545 group (@code{gnus-group-edit-group-method}).
2549 @findex gnus-group-edit-group-parameters
2550 Enter a buffer where you can edit the group parameters
2551 (@code{gnus-group-edit-group-parameters}).
2555 @findex gnus-group-edit-group
2556 Enter a buffer where you can edit the group info
2557 (@code{gnus-group-edit-group}).
2561 @findex gnus-group-make-directory-group
2563 Make a directory group (@pxref{Directory Groups}). You will be prompted
2564 for a directory name (@code{gnus-group-make-directory-group}).
2569 @findex gnus-group-make-help-group
2570 Make the gnus help group (@code{gnus-group-make-help-group}).
2574 @cindex (ding) archive
2575 @cindex archive group
2576 @findex gnus-group-make-archive-group
2577 @vindex gnus-group-archive-directory
2578 @vindex gnus-group-recent-archive-directory
2579 Make a gnus archive group (@code{gnus-group-make-archive-group}). By
2580 default a group pointing to the most recent articles will be created
2581 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2582 group will be created from @code{gnus-group-archive-directory}.
2586 @findex gnus-group-make-kiboze-group
2588 Make a kiboze group. You will be prompted for a name, for a regexp to
2589 match groups to be ``included'' in the kiboze group, and a series of
2590 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2591 @xref{Kibozed Groups}.
2595 @findex gnus-group-enter-directory
2597 Read an arbitrary directory as if it were a newsgroup with the
2598 @code{nneething} back end (@code{gnus-group-enter-directory}).
2599 @xref{Anything Groups}.
2603 @findex gnus-group-make-doc-group
2604 @cindex ClariNet Briefs
2606 Make a group based on some file or other
2607 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2608 command, you will be prompted for a file name and a file type.
2609 Currently supported types are @code{mbox}, @code{babyl},
2610 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2611 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2612 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2613 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2614 you run this command without a prefix, Gnus will guess at the file
2615 type. @xref{Document Groups}.
2619 @vindex gnus-useful-groups
2620 @findex gnus-group-make-useful-group
2621 Create one of the groups mentioned in @code{gnus-useful-groups}
2622 (@code{gnus-group-make-useful-group}).
2626 @findex gnus-group-make-web-group
2630 Make an ephemeral group based on a web search
2631 (@code{gnus-group-make-web-group}). If you give a prefix to this
2632 command, make a solid group instead. You will be prompted for the
2633 search engine type and the search string. Valid search engine types
2634 include @code{google}, @code{dejanews}, and @code{gmane}.
2635 @xref{Web Searches}.
2637 If you use the @code{google} search engine, you can limit the search
2638 to a particular group by using a match string like
2639 @samp{shaving group:alt.sysadmin.recovery}.
2643 @findex gnus-group-make-rss-group
2644 Make a group based on an @acronym{RSS} feed
2645 (@code{gnus-group-make-rss-group}). You will be prompted for an URL.
2649 @kindex G DEL (Group)
2650 @findex gnus-group-delete-group
2651 This function will delete the current group
2652 (@code{gnus-group-delete-group}). If given a prefix, this function will
2653 actually delete all the articles in the group, and forcibly remove the
2654 group itself from the face of the Earth. Use a prefix only if you are
2655 absolutely sure of what you are doing. This command can't be used on
2656 read-only groups (like @code{nntp} groups), though.
2660 @findex gnus-group-make-empty-virtual
2661 Make a new, fresh, empty @code{nnvirtual} group
2662 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2666 @findex gnus-group-add-to-virtual
2667 Add the current group to an @code{nnvirtual} group
2668 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2671 @xref{Select Methods}, for more information on the various select
2674 @vindex gnus-activate-foreign-newsgroups
2675 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2676 gnus will check all foreign groups with this level or lower at startup.
2677 This might take quite a while, especially if you subscribe to lots of
2678 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2679 @code{gnus-activate-level} also affects activation of foreign
2683 @node Group Parameters
2684 @section Group Parameters
2685 @cindex group parameters
2687 The group parameters store information local to a particular group.
2688 Here's an example group parameter list:
2691 ((to-address . "ding@@gnus.org")
2695 We see that each element consists of a ``dotted pair''---the thing before
2696 the dot is the key, while the thing after the dot is the value. All the
2697 parameters have this form @emph{except} local variable specs, which are
2698 not dotted pairs, but proper lists.
2700 Some parameters have correspondent customizable variables, each of which
2701 is an alist of regexps and values.
2703 The following group parameters can be used:
2708 Address used by when doing followups and new posts.
2711 (to-address . "some@@where.com")
2714 This is primarily useful in mail groups that represent closed mailing
2715 lists---mailing lists where it's expected that everybody that writes to
2716 the mailing list is subscribed to it. Since using this parameter
2717 ensures that the mail only goes to the mailing list itself, it means
2718 that members won't receive two copies of your followups.
2720 Using @code{to-address} will actually work whether the group is foreign
2721 or not. Let's say there's a group on the server that is called
2722 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2723 the articles from a mail-to-news gateway. Posting directly to this
2724 group is therefore impossible---you have to send mail to the mailing
2725 list address instead.
2727 See also @code{gnus-parameter-to-address-alist}.
2731 Address used when doing @kbd{a} in that group.
2734 (to-list . "some@@where.com")
2737 It is totally ignored
2738 when doing a followup---except that if it is present in a news group,
2739 you'll get mail group semantics when doing @kbd{f}.
2741 If you do an @kbd{a} command in a mail group and you have neither a
2742 @code{to-list} group parameter nor a @code{to-address} group parameter,
2743 then a @code{to-list} group parameter will be added automatically upon
2744 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2745 @vindex gnus-add-to-list
2747 @findex gnus-mailing-list-mode
2748 @cindex mail list groups
2749 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2750 entering summary buffer.
2752 See also @code{gnus-parameter-to-list-alist}.
2757 @cindex Mail-Followup-To
2758 @findex gnus-find-subscribed-addresses
2759 If this parameter is set to @code{t}, Gnus will consider the
2760 to-address and to-list parameters for this group as addresses of
2761 mailing lists you are subscribed to. Giving Gnus this information is
2762 (only) a first step in getting it to generate correct Mail-Followup-To
2763 headers for your posts to these lists. The second step is to put the
2764 following in your @file{.gnus.el}
2767 (setq message-subscribed-address-functions
2768 '(gnus-find-subscribed-addresses))
2771 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2772 a complete treatment of available MFT support.
2776 If the group parameter list has the element @code{(visible . t)},
2777 that group will always be visible in the Group buffer, regardless
2778 of whether it has any unread articles.
2780 @item broken-reply-to
2781 @cindex broken-reply-to
2782 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2783 headers in this group are to be ignored, and for the header to be hidden
2784 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2785 can be useful if you're reading a mailing list group where the listserv
2786 has inserted @code{Reply-To} headers that point back to the listserv
2787 itself. That is broken behavior. So there!
2791 Elements like @code{(to-group . "some.group.name")} means that all
2792 posts in that group will be sent to @code{some.group.name}.
2796 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2797 will treat all responses as if they were responses to news articles.
2798 This can be useful if you have a mail group that's really a mirror of a
2803 If @code{(gcc-self . t)} is present in the group parameter list, newly
2804 composed messages will be @code{Gcc}'d to the current group. If
2805 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2806 generated, if @code{(gcc-self . "string")} is present, this string will
2807 be inserted literally as a @code{gcc} header. This parameter takes
2808 precedence over any default @code{Gcc} rules as described later
2809 (@pxref{Archived Messages}).
2811 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2812 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2813 doesn't accept articles.
2817 If the group parameter has an element that looks like @code{(auto-expire
2818 . t)}, all articles read will be marked as expirable. For an
2819 alternative approach, @pxref{Expiring Mail}.
2821 See also @code{gnus-auto-expirable-newsgroups}.
2824 @cindex total-expire
2825 If the group parameter has an element that looks like
2826 @code{(total-expire . t)}, all read articles will be put through the
2827 expiry process, even if they are not marked as expirable. Use with
2828 caution. Unread, ticked and dormant articles are not eligible for
2831 See also @code{gnus-total-expirable-newsgroups}.
2835 @vindex nnmail-expiry-wait-function
2836 If the group parameter has an element that looks like
2837 @code{(expiry-wait . 10)}, this value will override any
2838 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2839 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2840 can either be a number of days (not necessarily an integer) or the
2841 symbols @code{never} or @code{immediate}.
2844 @cindex expiry-target
2845 Where expired messages end up. This parameter overrides
2846 @code{nnmail-expiry-target}.
2849 @cindex score file group parameter
2850 Elements that look like @code{(score-file . "file")} will make
2851 @file{file} into the current score file for the group in question. All
2852 interactive score entries will be put into this file.
2855 @cindex adapt file group parameter
2856 Elements that look like @code{(adapt-file . "file")} will make
2857 @file{file} into the current adaptive file for the group in question.
2858 All adaptive score entries will be put into this file.
2861 @cindex admin-address
2862 When unsubscribing from a mailing list you should never send the
2863 unsubscription notice to the mailing list itself. Instead, you'd send
2864 messages to the administrative address. This parameter allows you to
2865 put the admin address somewhere convenient.
2869 Elements that look like @code{(display . MODE)} say which articles to
2870 display on entering the group. Valid values are:
2874 Display all articles, both read and unread.
2877 Display the last @var{integer} articles in the group. This is the same as
2878 entering the group with @kbd{C-u @var{integer}}.
2881 Display the default visible articles, which normally includes unread and
2885 Display articles that satisfy a predicate.
2887 Here are some examples:
2891 Display only unread articles.
2894 Display everything except expirable articles.
2896 @item [and (not reply) (not expire)]
2897 Display everything except expirable and articles you've already
2901 The available operators are @code{not}, @code{and} and @code{or}.
2902 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2903 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2904 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2905 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2909 The @code{display} parameter works by limiting the summary buffer to
2910 the subset specified. You can pop the limit by using the @kbd{/ w}
2911 command (@pxref{Limiting}).
2915 Elements that look like @code{(comment . "This is a comment")} are
2916 arbitrary comments on the group. You can display comments in the
2917 group line (@pxref{Group Line Specification}).
2921 Elements that look like @code{(charset . iso-8859-1)} will make
2922 @code{iso-8859-1} the default charset; that is, the charset that will be
2923 used for all articles that do not specify a charset.
2925 See also @code{gnus-group-charset-alist}.
2927 @item ignored-charsets
2928 @cindex ignored-charset
2929 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2930 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2931 default charset will be used for decoding articles.
2933 See also @code{gnus-group-ignored-charsets-alist}.
2936 @cindex posting-style
2937 You can store additional posting style information for this group
2938 here (@pxref{Posting Styles}). The format is that of an entry in the
2939 @code{gnus-posting-styles} alist, except that there's no regexp matching
2940 the group name (of course). Style elements in this group parameter will
2941 take precedence over the ones found in @code{gnus-posting-styles}.
2943 For instance, if you want a funky name and signature in this group only,
2944 instead of hacking @code{gnus-posting-styles}, you could put something
2945 like this in the group parameters:
2950 ("X-My-Header" "Funky Value")
2951 (signature "Funky Signature"))
2956 If it is set, the value is used as the method for posting message
2957 instead of @code{gnus-post-method}.
2961 An item like @code{(banner . @var{regexp})} causes any part of an article
2962 that matches the regular expression @var{regexp} to be stripped. Instead of
2963 @var{regexp}, you can also use the symbol @code{signature} which strips the
2964 last signature or any of the elements of the alist
2965 @code{gnus-article-banner-alist}.
2969 This parameter contains a Sieve test that should match incoming mail
2970 that should be placed in this group. From this group parameter, a
2971 Sieve @samp{IF} control structure is generated, having the test as the
2972 condition and @samp{fileinto "group.name";} as the body.
2974 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
2975 address "sender" "sieve-admin@@extundo.com")} group parameter, when
2976 translating the group parameter into a Sieve script (@pxref{Sieve
2977 Commands}) the following Sieve code is generated:
2980 if address \"sender\" \"sieve-admin@@extundo.com\" @{
2981 fileinto \"INBOX.list.sieve\";
2985 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
2986 Top, sieve, Emacs Sieve}.
2988 @item (agent parameters)
2989 If the agent has been enabled, you can set any of the its parameters
2990 to control the behavior of the agent in individual groups. See Agent
2991 Parameters in @ref{Category Syntax}. Most users will choose to set
2992 agent parameters in either an agent category or group topic to
2993 minimize the configuration effort.
2995 @item (@var{variable} @var{form})
2996 You can use the group parameters to set variables local to the group you
2997 are entering. If you want to turn threading off in @samp{news.answers},
2998 you could put @code{(gnus-show-threads nil)} in the group parameters of
2999 that group. @code{gnus-show-threads} will be made into a local variable
3000 in the summary buffer you enter, and the form @code{nil} will be
3001 @code{eval}ed there.
3003 Note that this feature sets the variable locally to the summary buffer.
3004 But some variables are evaluated in the article buffer, or in the
3005 message buffer (of a reply or followup or otherwise newly created
3006 message). As a workaround, it might help to add the variable in
3007 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3008 Stuff}. So if you want to set @code{message-from-style} via the group
3009 parameters, then you may need the following statement elsewhere in your
3010 @file{~/.gnus} file:
3013 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3016 @vindex gnus-list-identifiers
3017 A use for this feature is to remove a mailing list identifier tag in
3018 the subject fields of articles. E.g. if the news group
3021 nntp+news.gnus.org:gmane.text.docbook.apps
3024 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3025 tag can be removed from the article subjects in the summary buffer for
3026 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3027 into the group parameters for the group.
3029 This can also be used as a group-specific hook function. If you want to
3030 hear a beep when you enter a group, you could put something like
3031 @code{(dummy-variable (ding))} in the parameters of that group.
3032 @code{dummy-variable} will be set to the (meaningless) result of the
3035 Alternatively, since the VARIABLE becomes local to the group, this
3036 pattern can be used to temporarily change a hook. For example, if the
3037 following is added to a group parameter
3040 (gnus-summary-prepared-hook
3041 '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3044 when the group is entered, the 'd' key will not mark the article as
3049 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3050 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3051 presents you with a Customize-like interface. The latter helps avoid
3052 silly Lisp errors.) You might also be interested in reading about topic
3053 parameters (@pxref{Topic Parameters}).
3055 @vindex gnus-parameters
3056 Group parameters can be set via the @code{gnus-parameters} variable too.
3057 But some variables, such as @code{visible}, have no effect. For
3061 (setq gnus-parameters
3063 (gnus-show-threads nil)
3064 (gnus-use-scoring nil)
3065 (gnus-summary-line-format
3066 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3070 ("^nnimap:\\(foo.bar\\)$"
3074 (gnus-use-scoring t))
3078 (broken-reply-to . t))))
3081 String value of parameters will be subjected to regexp substitution, as
3082 the @code{to-group} example shows.
3085 @node Listing Groups
3086 @section Listing Groups
3087 @cindex group listing
3089 These commands all list various slices of the groups available.
3097 @findex gnus-group-list-groups
3098 List all groups that have unread articles
3099 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3100 command will list only groups of level ARG and lower. By default, it
3101 only lists groups of level five (i.e.,
3102 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3109 @findex gnus-group-list-all-groups
3110 List all groups, whether they have unread articles or not
3111 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3112 this command will list only groups of level ARG and lower. By default,
3113 it lists groups of level seven or lower (i.e., just subscribed and
3114 unsubscribed groups).
3118 @findex gnus-group-list-level
3119 List all unread groups on a specific level
3120 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3121 with no unread articles.
3125 @findex gnus-group-list-killed
3126 List all killed groups (@code{gnus-group-list-killed}). If given a
3127 prefix argument, really list all groups that are available, but aren't
3128 currently (un)subscribed. This could entail reading the active file
3133 @findex gnus-group-list-zombies
3134 List all zombie groups (@code{gnus-group-list-zombies}).
3138 @findex gnus-group-list-matching
3139 List all unread, subscribed groups with names that match a regexp
3140 (@code{gnus-group-list-matching}).
3144 @findex gnus-group-list-all-matching
3145 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3149 @findex gnus-group-list-active
3150 List absolutely all groups in the active file(s) of the
3151 server(s) you are connected to (@code{gnus-group-list-active}). This
3152 might very well take quite a while. It might actually be a better idea
3153 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3154 thing to match on. Also note that this command may list groups that
3155 don't exist (yet)---these will be listed as if they were killed groups.
3156 Take the output with some grains of salt.
3160 @findex gnus-group-apropos
3161 List all groups that have names that match a regexp
3162 (@code{gnus-group-apropos}).
3166 @findex gnus-group-description-apropos
3167 List all groups that have names or descriptions that match a regexp
3168 (@code{gnus-group-description-apropos}).
3172 @findex gnus-group-list-cached
3173 List all groups with cached articles (@code{gnus-group-list-cached}).
3177 @findex gnus-group-list-dormant
3178 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3182 @findex gnus-group-list-limit
3183 List groups limited within the current selection
3184 (@code{gnus-group-list-limit}).
3188 @findex gnus-group-list-flush
3189 Flush groups from the current selection (@code{gnus-group-list-flush}).
3193 @findex gnus-group-list-plus
3194 List groups plus the current selection (@code{gnus-group-list-plus}).
3198 @vindex gnus-permanently-visible-groups
3199 @cindex visible group parameter
3200 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3201 always be shown, whether they have unread articles or not. You can also
3202 add the @code{visible} element to the group parameters in question to
3203 get the same effect.
3205 @vindex gnus-list-groups-with-ticked-articles
3206 Groups that have just ticked articles in it are normally listed in the
3207 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3208 @code{nil}, these groups will be treated just like totally empty
3209 groups. It is @code{t} by default.
3212 @node Sorting Groups
3213 @section Sorting Groups
3214 @cindex sorting groups
3216 @kindex C-c C-s (Group)
3217 @findex gnus-group-sort-groups
3218 @vindex gnus-group-sort-function
3219 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3220 group buffer according to the function(s) given by the
3221 @code{gnus-group-sort-function} variable. Available sorting functions
3226 @item gnus-group-sort-by-alphabet
3227 @findex gnus-group-sort-by-alphabet
3228 Sort the group names alphabetically. This is the default.
3230 @item gnus-group-sort-by-real-name
3231 @findex gnus-group-sort-by-real-name
3232 Sort the group alphabetically on the real (unprefixed) group names.
3234 @item gnus-group-sort-by-level
3235 @findex gnus-group-sort-by-level
3236 Sort by group level.
3238 @item gnus-group-sort-by-score
3239 @findex gnus-group-sort-by-score
3240 Sort by group score. @xref{Group Score}.
3242 @item gnus-group-sort-by-rank
3243 @findex gnus-group-sort-by-rank
3244 Sort by group score and then the group level. The level and the score
3245 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3247 @item gnus-group-sort-by-unread
3248 @findex gnus-group-sort-by-unread
3249 Sort by number of unread articles.
3251 @item gnus-group-sort-by-method
3252 @findex gnus-group-sort-by-method
3253 Sort alphabetically on the select method.
3255 @item gnus-group-sort-by-server
3256 @findex gnus-group-sort-by-server
3257 Sort alphabetically on the Gnus server name.
3262 @code{gnus-group-sort-function} can also be a list of sorting
3263 functions. In that case, the most significant sort key function must be
3267 There are also a number of commands for sorting directly according to
3268 some sorting criteria:
3272 @kindex G S a (Group)
3273 @findex gnus-group-sort-groups-by-alphabet
3274 Sort the group buffer alphabetically by group name
3275 (@code{gnus-group-sort-groups-by-alphabet}).
3278 @kindex G S u (Group)
3279 @findex gnus-group-sort-groups-by-unread
3280 Sort the group buffer by the number of unread articles
3281 (@code{gnus-group-sort-groups-by-unread}).
3284 @kindex G S l (Group)
3285 @findex gnus-group-sort-groups-by-level
3286 Sort the group buffer by group level
3287 (@code{gnus-group-sort-groups-by-level}).
3290 @kindex G S v (Group)
3291 @findex gnus-group-sort-groups-by-score
3292 Sort the group buffer by group score
3293 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3296 @kindex G S r (Group)
3297 @findex gnus-group-sort-groups-by-rank
3298 Sort the group buffer by group rank
3299 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3302 @kindex G S m (Group)
3303 @findex gnus-group-sort-groups-by-method
3304 Sort the group buffer alphabetically by back end name@*
3305 (@code{gnus-group-sort-groups-by-method}).
3308 @kindex G S n (Group)
3309 @findex gnus-group-sort-groups-by-real-name
3310 Sort the group buffer alphabetically by real (unprefixed) group name
3311 (@code{gnus-group-sort-groups-by-real-name}).
3315 All the commands below obey the process/prefix convention
3316 (@pxref{Process/Prefix}).
3318 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3319 commands will sort in reverse order.
3321 You can also sort a subset of the groups:
3325 @kindex G P a (Group)
3326 @findex gnus-group-sort-selected-groups-by-alphabet
3327 Sort the groups alphabetically by group name
3328 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3331 @kindex G P u (Group)
3332 @findex gnus-group-sort-selected-groups-by-unread
3333 Sort the groups by the number of unread articles
3334 (@code{gnus-group-sort-selected-groups-by-unread}).
3337 @kindex G P l (Group)
3338 @findex gnus-group-sort-selected-groups-by-level
3339 Sort the groups by group level
3340 (@code{gnus-group-sort-selected-groups-by-level}).
3343 @kindex G P v (Group)
3344 @findex gnus-group-sort-selected-groups-by-score
3345 Sort the groups by group score
3346 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3349 @kindex G P r (Group)
3350 @findex gnus-group-sort-selected-groups-by-rank
3351 Sort the groups by group rank
3352 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3355 @kindex G P m (Group)
3356 @findex gnus-group-sort-selected-groups-by-method
3357 Sort the groups alphabetically by back end name@*
3358 (@code{gnus-group-sort-selected-groups-by-method}).
3361 @kindex G P n (Group)
3362 @findex gnus-group-sort-selected-groups-by-real-name
3363 Sort the groups alphabetically by real (unprefixed) group name
3364 (@code{gnus-group-sort-selected-groups-by-real-name}).
3367 @kindex G P s (Group)
3368 @findex gnus-group-sort-selected-groups
3369 Sort the groups according to @code{gnus-group-sort-function}.
3373 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3377 @node Group Maintenance
3378 @section Group Maintenance
3379 @cindex bogus groups
3384 @findex gnus-group-check-bogus-groups
3385 Find bogus groups and delete them
3386 (@code{gnus-group-check-bogus-groups}).
3390 @findex gnus-group-find-new-groups
3391 Find new groups and process them (@code{gnus-group-find-new-groups}).
3392 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3393 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3394 to query the server for new groups, and subscribe the new groups as
3398 @kindex C-c C-x (Group)
3399 @findex gnus-group-expire-articles
3400 Run all expirable articles in the current group through the expiry
3401 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3402 all expirable articles in the group that have been around for a while.
3403 (@pxref{Expiring Mail}).
3406 @kindex C-c C-M-x (Group)
3407 @findex gnus-group-expire-all-groups
3408 Run all expirable articles in all groups through the expiry process
3409 (@code{gnus-group-expire-all-groups}).
3414 @node Browse Foreign Server
3415 @section Browse Foreign Server
3416 @cindex foreign servers
3417 @cindex browsing servers
3422 @findex gnus-group-browse-foreign-server
3423 You will be queried for a select method and a server name. Gnus will
3424 then attempt to contact this server and let you browse the groups there
3425 (@code{gnus-group-browse-foreign-server}).
3428 @findex gnus-browse-mode
3429 A new buffer with a list of available groups will appear. This buffer
3430 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3431 a lot) like a normal group buffer.
3433 Here's a list of keystrokes available in the browse mode:
3438 @findex gnus-group-next-group
3439 Go to the next group (@code{gnus-group-next-group}).
3443 @findex gnus-group-prev-group
3444 Go to the previous group (@code{gnus-group-prev-group}).
3447 @kindex SPACE (Browse)
3448 @findex gnus-browse-read-group
3449 Enter the current group and display the first article
3450 (@code{gnus-browse-read-group}).
3453 @kindex RET (Browse)
3454 @findex gnus-browse-select-group
3455 Enter the current group (@code{gnus-browse-select-group}).
3459 @findex gnus-browse-unsubscribe-current-group
3460 Unsubscribe to the current group, or, as will be the case here,
3461 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3467 @findex gnus-browse-exit
3468 Exit browse mode (@code{gnus-browse-exit}).
3472 @findex gnus-browse-describe-group
3473 Describe the current group (@code{gnus-browse-describe-group}).
3477 @findex gnus-browse-describe-briefly
3478 Describe browse mode briefly (well, there's not much to describe, is
3479 there) (@code{gnus-browse-describe-briefly}).
3484 @section Exiting gnus
3485 @cindex exiting gnus
3487 Yes, gnus is ex(c)iting.
3492 @findex gnus-group-suspend
3493 Suspend gnus (@code{gnus-group-suspend}). This doesn't really exit gnus,
3494 but it kills all buffers except the Group buffer. I'm not sure why this
3495 is a gain, but then who am I to judge?
3499 @findex gnus-group-exit
3500 @c @icon{gnus-group-exit}
3501 Quit gnus (@code{gnus-group-exit}).
3505 @findex gnus-group-quit
3506 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3507 The dribble file will be saved, though (@pxref{Auto Save}).
3510 @vindex gnus-exit-gnus-hook
3511 @vindex gnus-suspend-gnus-hook
3512 @vindex gnus-after-exiting-gnus-hook
3513 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3514 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3515 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3521 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3522 numbly heavy and herself fall into a hazy trance as the boy sitting
3523 behind her drew repeated lines with his pencil across the back of her
3529 @section Group Topics
3532 If you read lots and lots of groups, it might be convenient to group
3533 them hierarchically according to topics. You put your Emacs groups over
3534 here, your sex groups over there, and the rest (what, two groups or so?)
3535 you put in some misc section that you never bother with anyway. You can
3536 even group the Emacs sex groups as a sub-topic to either the Emacs
3537 groups or the sex groups---or both! Go wild!
3541 \gnusfigure{Group Topics}{400}{
3542 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3553 2: alt.religion.emacs
3556 0: comp.talk.emacs.recovery
3558 8: comp.binaries.fractals
3559 13: comp.sources.unix
3562 @findex gnus-topic-mode
3564 To get this @emph{fab} functionality you simply turn on (ooh!) the
3565 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3566 is a toggling command.)
3568 Go ahead, just try it. I'll still be here when you get back. La de
3569 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3570 Yes, and now press @kbd{l}. There. All your groups are now listed
3571 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3574 If you want this permanently enabled, you should add that minor mode to
3575 the hook for the group mode. Put the following line in your
3576 @file{~/.gnus.el} file:
3579 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3583 * Topic Commands:: Interactive E-Z commands.
3584 * Topic Variables:: How to customize the topics the Lisp Way.
3585 * Topic Sorting:: Sorting each topic individually.
3586 * Topic Topology:: A map of the world.
3587 * Topic Parameters:: Parameters that apply to all groups in a topic.
3591 @node Topic Commands
3592 @subsection Topic Commands
3593 @cindex topic commands
3595 When the topic minor mode is turned on, a new @kbd{T} submap will be
3596 available. In addition, a few of the standard keys change their
3597 definitions slightly.
3599 In general, the following kinds of operations are possible on topics.
3600 First of all, you want to create topics. Secondly, you want to put
3601 groups in topics and to move them around until you have an order you
3602 like. The third kind of operation is to show/hide parts of the whole
3603 shebang. You might want to hide a topic including its subtopics and
3604 groups, to get a better overview of the other groups.
3606 Here is a list of the basic keys that you might need to set up topics
3613 @findex gnus-topic-create-topic
3614 Prompt for a new topic name and create it
3615 (@code{gnus-topic-create-topic}).
3619 @kindex T TAB (Topic)
3621 @findex gnus-topic-indent
3622 ``Indent'' the current topic so that it becomes a sub-topic of the
3623 previous topic (@code{gnus-topic-indent}). If given a prefix,
3624 ``un-indent'' the topic instead.
3627 @kindex M-TAB (Topic)
3628 @findex gnus-topic-unindent
3629 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3630 parent of its current parent (@code{gnus-topic-unindent}).
3634 The following two keys can be used to move groups and topics around.
3635 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3636 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3637 kill and yank rather than cut and paste.
3643 @findex gnus-topic-kill-group
3644 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3645 topic will be removed along with the topic.
3649 @findex gnus-topic-yank-group
3650 Yank the previously killed group or topic
3651 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3654 So, to move a topic to the beginning of the list of topics, just hit
3655 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3656 move the cursor to the beginning of the buffer (just below the ``Gnus''
3657 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3658 paste. Like I said -- E-Z.
3660 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3661 you can move topics around as well as groups.
3665 After setting up the topics the way you like them, you might wish to
3666 hide a topic, or to show it again. That's why we have the following
3673 @findex gnus-topic-select-group
3675 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3676 When you perform this command on a group, you'll enter the group, as
3677 usual. When done on a topic line, the topic will be folded (if it was
3678 visible) or unfolded (if it was folded already). So it's basically a
3679 toggling command on topics. In addition, if you give a numerical
3680 prefix, group on that level (and lower) will be displayed.
3684 Now for a list of other commands, in no particular order.
3690 @findex gnus-topic-move-group
3691 Move the current group to some other topic
3692 (@code{gnus-topic-move-group}). This command uses the process/prefix
3693 convention (@pxref{Process/Prefix}).
3697 @findex gnus-topic-jump-to-topic
3698 Go to a topic (@code{gnus-topic-jump-to-topic}).
3702 @findex gnus-topic-copy-group
3703 Copy the current group to some other topic
3704 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3705 convention (@pxref{Process/Prefix}).
3709 @findex gnus-topic-hide-topic
3710 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3711 a prefix, hide the topic permanently.
3715 @findex gnus-topic-show-topic
3716 Show the current topic (@code{gnus-topic-show-topic}). If given
3717 a prefix, show the topic permanently.
3721 @findex gnus-topic-remove-group
3722 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3723 This command is mainly useful if you have the same group in several
3724 topics and wish to remove it from one of the topics. You may also
3725 remove a group from all topics, but in that case, Gnus will add it to
3726 the root topic the next time you start Gnus. In fact, all new groups
3727 (which, naturally, don't belong to any topic) will show up in the root
3730 This command uses the process/prefix convention
3731 (@pxref{Process/Prefix}).
3735 @findex gnus-topic-move-matching
3736 Move all groups that match some regular expression to a topic
3737 (@code{gnus-topic-move-matching}).
3741 @findex gnus-topic-copy-matching
3742 Copy all groups that match some regular expression to a topic
3743 (@code{gnus-topic-copy-matching}).
3747 @findex gnus-topic-toggle-display-empty-topics
3748 Toggle hiding empty topics
3749 (@code{gnus-topic-toggle-display-empty-topics}).
3753 @findex gnus-topic-mark-topic
3754 Mark all groups in the current topic with the process mark
3755 (@code{gnus-topic-mark-topic}). This command works recursively on
3756 sub-topics unless given a prefix.
3759 @kindex T M-# (Topic)
3760 @findex gnus-topic-unmark-topic
3761 Remove the process mark from all groups in the current topic
3762 (@code{gnus-topic-unmark-topic}). This command works recursively on
3763 sub-topics unless given a prefix.
3766 @kindex C-c C-x (Topic)
3767 @findex gnus-topic-expire-articles
3768 Run all expirable articles in the current group or topic through the
3769 expiry process (if any)
3770 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3774 @findex gnus-topic-rename
3775 Rename a topic (@code{gnus-topic-rename}).
3778 @kindex T DEL (Topic)
3779 @findex gnus-topic-delete
3780 Delete an empty topic (@code{gnus-topic-delete}).
3784 @findex gnus-topic-list-active
3785 List all groups that gnus knows about in a topics-ified way
3786 (@code{gnus-topic-list-active}).
3789 @kindex T M-n (Topic)
3790 @findex gnus-topic-goto-next-topic
3791 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3794 @kindex T M-p (Topic)
3795 @findex gnus-topic-goto-previous-topic
3796 Go to the next topic (@code{gnus-topic-goto-previous-topic}).
3800 @findex gnus-topic-edit-parameters
3801 @cindex group parameters
3802 @cindex topic parameters
3804 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3805 @xref{Topic Parameters}.
3810 @node Topic Variables
3811 @subsection Topic Variables
3812 @cindex topic variables
3814 The previous section told you how to tell Gnus which topics to display.
3815 This section explains how to tell Gnus what to display about each topic.
3817 @vindex gnus-topic-line-format
3818 The topic lines themselves are created according to the
3819 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3832 Number of groups in the topic.
3834 Number of unread articles in the topic.
3836 Number of unread articles in the topic and all its subtopics.
3839 @vindex gnus-topic-indent-level
3840 Each sub-topic (and the groups in the sub-topics) will be indented with
3841 @code{gnus-topic-indent-level} times the topic level number of spaces.
3844 @vindex gnus-topic-mode-hook
3845 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3847 @vindex gnus-topic-display-empty-topics
3848 The @code{gnus-topic-display-empty-topics} says whether to display even
3849 topics that have no unread articles in them. The default is @code{t}.
3853 @subsection Topic Sorting
3854 @cindex topic sorting
3856 You can sort the groups in each topic individually with the following
3862 @kindex T S a (Topic)
3863 @findex gnus-topic-sort-groups-by-alphabet
3864 Sort the current topic alphabetically by group name
3865 (@code{gnus-topic-sort-groups-by-alphabet}).
3868 @kindex T S u (Topic)
3869 @findex gnus-topic-sort-groups-by-unread
3870 Sort the current topic by the number of unread articles
3871 (@code{gnus-topic-sort-groups-by-unread}).
3874 @kindex T S l (Topic)
3875 @findex gnus-topic-sort-groups-by-level
3876 Sort the current topic by group level
3877 (@code{gnus-topic-sort-groups-by-level}).
3880 @kindex T S v (Topic)
3881 @findex gnus-topic-sort-groups-by-score
3882 Sort the current topic by group score
3883 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3886 @kindex T S r (Topic)
3887 @findex gnus-topic-sort-groups-by-rank
3888 Sort the current topic by group rank
3889 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3892 @kindex T S m (Topic)
3893 @findex gnus-topic-sort-groups-by-method
3894 Sort the current topic alphabetically by back end name
3895 (@code{gnus-topic-sort-groups-by-method}).
3898 @kindex T S e (Topic)
3899 @findex gnus-topic-sort-groups-by-server
3900 Sort the current topic alphabetically by server name
3901 (@code{gnus-topic-sort-groups-by-server}).
3904 @kindex T S s (Topic)
3905 @findex gnus-topic-sort-groups
3906 Sort the current topic according to the function(s) given by the
3907 @code{gnus-group-sort-function} variable
3908 (@code{gnus-topic-sort-groups}).
3912 When given a prefix argument, all these commands will sort in reverse
3913 order. @xref{Sorting Groups}, for more information about group
3917 @node Topic Topology
3918 @subsection Topic Topology
3919 @cindex topic topology
3922 So, let's have a look at an example group buffer:
3929 2: alt.religion.emacs
3932 0: comp.talk.emacs.recovery
3934 8: comp.binaries.fractals
3935 13: comp.sources.unix
3939 So, here we have one top-level topic (@samp{Gnus}), two topics under
3940 that, and one sub-topic under one of the sub-topics. (There is always
3941 just one (1) top-level topic). This topology can be expressed as
3946 (("Emacs -- I wuw it!" visible)
3947 (("Naughty Emacs" visible)))
3951 @vindex gnus-topic-topology
3952 This is in fact how the variable @code{gnus-topic-topology} would look
3953 for the display above. That variable is saved in the @file{.newsrc.eld}
3954 file, and shouldn't be messed with manually---unless you really want
3955 to. Since this variable is read from the @file{.newsrc.eld} file,
3956 setting it in any other startup files will have no effect.
3958 This topology shows what topics are sub-topics of what topics (right),
3959 and which topics are visible. Two settings are currently
3960 allowed---@code{visible} and @code{invisible}.
3963 @node Topic Parameters
3964 @subsection Topic Parameters
3965 @cindex topic parameters
3967 All groups in a topic will inherit group parameters from the parent
3968 (and ancestor) topic parameters. All valid group parameters are valid
3969 topic parameters (@pxref{Group Parameters}). When the agent is
3970 enabled, all agent parameters (See Agent Parameters in @ref{Category
3971 Syntax}) are also valid topic parameters.
3973 In addition, the following parameters are only valid as topic
3978 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3979 @code{subscribe} topic parameter says what groups go in what topic. Its
3980 value should be a regexp to match the groups that should go in that
3983 @item subscribe-level
3984 When subscribing new groups by topic (see the @code{subscribe} parameter),
3985 the group will be subscribed with the level specified in the
3986 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
3990 Group parameters (of course) override topic parameters, and topic
3991 parameters in sub-topics override topic parameters in super-topics. You
3992 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
3993 verb, although you may feel free to disagree with me here.)
4000 2: alt.religion.emacs
4004 0: comp.talk.emacs.recovery
4006 8: comp.binaries.fractals
4007 13: comp.sources.unix
4012 The @samp{Emacs} topic has the topic parameter @code{(score-file
4013 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4014 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4015 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4016 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4017 . "religion.SCORE")}.
4019 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4020 will get the @file{relief.SCORE} home score file. If you enter the same
4021 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4022 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4023 get the @file{religion.SCORE} home score file.
4025 This seems rather simple and self-evident, doesn't it? Well, yes. But
4026 there are some problems, especially with the @code{total-expiry}
4027 parameter. Say you have a mail group in two topics; one with
4028 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4029 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4030 of these topics you mean to expire articles from, so anything may
4031 happen. In fact, I hereby declare that it is @dfn{undefined} what
4032 happens. You just have to be careful if you do stuff like that.
4035 @node Misc Group Stuff
4036 @section Misc Group Stuff
4039 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4040 * Group Information:: Information and help on groups and Gnus.
4041 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4042 * File Commands:: Reading and writing the Gnus files.
4043 * Sieve Commands:: Managing Sieve scripts.
4050 @findex gnus-group-enter-server-mode
4051 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4052 @xref{Server Buffer}.
4056 @findex gnus-group-post-news
4057 Start composing a message (a news by default)
4058 (@code{gnus-group-post-news}). If given a prefix, post to the group
4059 under the point. If the prefix is 1, prompt for a group to post to.
4060 Contrary to what the name of this function suggests, the prepared
4061 article might be a mail instead of a news, if a mail group is specified
4062 with the prefix argument. @xref{Composing Messages}.
4066 @findex gnus-group-mail
4067 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4068 use the posting style of the group under the point. If the prefix is 1,
4069 prompt for a group name to find the posting style.
4070 @xref{Composing Messages}.
4074 @findex gnus-group-news
4075 Start composing a news (@code{gnus-group-news}). If given a prefix,
4076 post to the group under the point. If the prefix is 1, prompt
4077 for group to post to. @xref{Composing Messages}.
4079 This function actually prepares a news even when using mail groups.
4080 This is useful for ``posting'' messages to mail groups without actually
4081 sending them over the network: they're just saved directly to the group
4082 in question. The corresponding back end must have a request-post method
4083 for this to work though.
4087 Variables for the group buffer:
4091 @item gnus-group-mode-hook
4092 @vindex gnus-group-mode-hook
4093 is called after the group buffer has been
4096 @item gnus-group-prepare-hook
4097 @vindex gnus-group-prepare-hook
4098 is called after the group buffer is
4099 generated. It may be used to modify the buffer in some strange,
4102 @item gnus-group-prepared-hook
4103 @vindex gnus-group-prepare-hook
4104 is called as the very last thing after the group buffer has been
4105 generated. It may be used to move point around, for instance.
4107 @item gnus-permanently-visible-groups
4108 @vindex gnus-permanently-visible-groups
4109 Groups matching this regexp will always be listed in the group buffer,
4110 whether they are empty or not.
4112 @item gnus-group-name-charset-method-alist
4113 @vindex gnus-group-name-charset-method-alist
4114 An alist of method and the charset for group names. It is used to show
4115 non-@acronym{ASCII} group names.
4119 (setq gnus-group-name-charset-method-alist
4120 '(((nntp "news.com.cn") . cn-gb-2312)))
4123 @item gnus-group-name-charset-group-alist
4124 @cindex UTF-8 group names
4125 @vindex gnus-group-name-charset-group-alist
4126 An alist of regexp of group name and the charset for group names. It
4127 is used to show non-@acronym{ASCII} group names. @code{((".*"
4128 utf-8))} is the default value if UTF-8 is supported, otherwise the
4129 default is @code{nil}.
4133 (setq gnus-group-name-charset-group-alist
4134 '(("\\.com\\.cn:" . cn-gb-2312)))
4139 @node Scanning New Messages
4140 @subsection Scanning New Messages
4141 @cindex new messages
4142 @cindex scanning new news
4148 @findex gnus-group-get-new-news
4149 @c @icon{gnus-group-get-new-news}
4150 Check the server(s) for new articles. If the numerical prefix is used,
4151 this command will check only groups of level @var{arg} and lower
4152 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4153 command will force a total re-reading of the active file(s) from the
4158 @findex gnus-group-get-new-news-this-group
4159 @vindex gnus-goto-next-group-when-activating
4160 @c @icon{gnus-group-get-new-news-this-group}
4161 Check whether new articles have arrived in the current group
4162 (@code{gnus-group-get-new-news-this-group}).
4163 @code{gnus-goto-next-group-when-activating} says whether this command is
4164 to move point to the next group or not. It is @code{t} by default.
4166 @findex gnus-activate-all-groups
4167 @cindex activating groups
4169 @kindex C-c M-g (Group)
4170 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4175 @findex gnus-group-restart
4176 Restart gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4177 file(s), closes the connection to all servers, clears up all run-time
4178 gnus variables, and then starts gnus all over again.
4182 @vindex gnus-get-new-news-hook
4183 @code{gnus-get-new-news-hook} is run just before checking for new news.
4185 @vindex gnus-after-getting-new-news-hook
4186 @code{gnus-after-getting-new-news-hook} is run after checking for new
4190 @node Group Information
4191 @subsection Group Information
4192 @cindex group information
4193 @cindex information on groups
4200 @findex gnus-group-fetch-faq
4201 @vindex gnus-group-faq-directory
4204 Try to fetch the @acronym{FAQ} for the current group
4205 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4206 from @code{gnus-group-faq-directory}, which is usually a directory on
4207 a remote machine. This variable can also be a list of directories.
4208 In that case, giving a prefix to this command will allow you to choose
4209 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4210 used for fetching the file.
4212 If fetching from the first site is unsuccessful, gnus will attempt to go
4213 through @code{gnus-group-faq-directory} and try to open them one by one.
4217 @findex gnus-group-fetch-charter
4218 @vindex gnus-group-charter-alist
4220 Try to open the charter for the current group in a web browser
4221 (@code{gnus-group-fetch-charter}). Query for a group if given a
4224 Gnus will use @code{gnus-group-charter-alist} to find the location of
4225 the charter. If no location is known, Gnus will fetch the control
4226 messages for the group, which in some cases includes the charter.
4230 @findex gnus-group-fetch-control
4231 @vindex gnus-group-fetch-control-use-browse-url
4232 @cindex control message
4233 Fetch the control messages for the group from the archive at
4234 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4235 group if given a prefix argument.
4237 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4238 Gnus will open the control messages in a browser using
4239 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4240 and displayed in an ephemeral group.
4242 Note that the control messages are compressed. To use this command
4243 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4244 Files, ,Compressed Files, emacs, The Emacs Manual}).
4248 @c @icon{gnus-group-describe-group}
4250 @kindex C-c C-d (Group)
4251 @cindex describing groups
4252 @cindex group description
4253 @findex gnus-group-describe-group
4254 Describe the current group (@code{gnus-group-describe-group}). If given
4255 a prefix, force Gnus to re-read the description from the server.
4259 @findex gnus-group-describe-all-groups
4260 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4261 prefix, force gnus to re-read the description file from the server.
4268 @findex gnus-version
4269 Display current gnus version numbers (@code{gnus-version}).
4273 @findex gnus-group-describe-briefly
4274 Give a very short help message (@code{gnus-group-describe-briefly}).
4277 @kindex C-c C-i (Group)
4280 @findex gnus-info-find-node
4281 Go to the gnus info node (@code{gnus-info-find-node}).
4285 @node Group Timestamp
4286 @subsection Group Timestamp
4288 @cindex group timestamps
4290 It can be convenient to let gnus keep track of when you last read a
4291 group. To set the ball rolling, you should add
4292 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4295 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4298 After doing this, each time you enter a group, it'll be recorded.
4300 This information can be displayed in various ways---the easiest is to
4301 use the @samp{%d} spec in the group line format:
4304 (setq gnus-group-line-format
4305 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4308 This will result in lines looking like:
4311 * 0: mail.ding 19961002T012943
4312 0: custom 19961002T012713
4315 As you can see, the date is displayed in compact ISO 8601 format. This
4316 may be a bit too much, so to just display the date, you could say
4320 (setq gnus-group-line-format
4321 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4324 If you would like greater control of the time format, you can use a
4325 user-defined format spec. Something like the following should do the
4329 (setq gnus-group-line-format
4330 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4331 (defun gnus-user-format-function-d (headers)
4332 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4334 (format-time-string "%b %d %H:%M" time)
4340 @subsection File Commands
4341 @cindex file commands
4347 @findex gnus-group-read-init-file
4348 @vindex gnus-init-file
4349 @cindex reading init file
4350 Re-read the init file (@code{gnus-init-file}, which defaults to
4351 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4355 @findex gnus-group-save-newsrc
4356 @cindex saving .newsrc
4357 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4358 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4359 file(s) whether Gnus thinks it is necessary or not.
4362 @c @kindex Z (Group)
4363 @c @findex gnus-group-clear-dribble
4364 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4369 @node Sieve Commands
4370 @subsection Sieve Commands
4371 @cindex group sieve commands
4373 Sieve is a server-side mail filtering language. In Gnus you can use
4374 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4375 sieve rules that should apply to each group. Gnus provides two
4376 commands to translate all these group parameters into a proper Sieve
4377 script that can be transfered to the server somehow.
4379 @vindex gnus-sieve-file
4380 @vindex gnus-sieve-region-start
4381 @vindex gnus-sieve-region-end
4382 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4383 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4384 between two delimiters, @code{gnus-sieve-region-start} and
4385 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4386 outside these delimiters that will not be removed the next time you
4387 regenerate the Sieve script.
4389 @vindex gnus-sieve-crosspost
4390 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4391 is generated. If it is non-@code{nil} (the default) articles is
4392 placed in all groups that have matching rules, otherwise the article
4393 is only placed in the group with the first matching rule. For
4394 example, the group parameter @samp{(sieve address "sender"
4395 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4396 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4397 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4398 except that the line containing the call to @code{stop} is removed.)
4401 if address "sender" "owner-ding@@hpc.uh.edu" @{
4402 fileinto "INBOX.ding";
4407 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4413 @findex gnus-sieve-generate
4414 @vindex gnus-sieve-file
4415 @cindex generating sieve script
4416 Regenerate a Sieve script from the @code{sieve} group parameters and
4417 put you into the @code{gnus-sieve-file} without saving it.
4421 @findex gnus-sieve-update
4422 @vindex gnus-sieve-file
4423 @cindex updating sieve script
4424 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4425 @code{sieve} group parameters, save the file and upload it to the
4426 server using the @code{sieveshell} program.
4431 @node Summary Buffer
4432 @chapter Summary Buffer
4433 @cindex summary buffer
4435 A line for each article is displayed in the summary buffer. You can
4436 move around, read articles, post articles and reply to articles.
4438 The most common way to a summary buffer is to select a group from the
4439 group buffer (@pxref{Selecting a Group}).
4441 You can have as many summary buffers open as you wish.
4444 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4445 * Summary Maneuvering:: Moving around the summary buffer.
4446 * Choosing Articles:: Reading articles.
4447 * Paging the Article:: Scrolling the current article.
4448 * Reply Followup and Post:: Posting articles.
4449 * Delayed Articles:: Send articles at a later time.
4450 * Marking Articles:: Marking articles as read, expirable, etc.
4451 * Limiting:: You can limit the summary buffer.
4452 * Threading:: How threads are made.
4453 * Sorting the Summary Buffer:: How articles and threads are sorted.
4454 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4455 * Article Caching:: You may store articles in a cache.
4456 * Persistent Articles:: Making articles expiry-resistant.
4457 * Article Backlog:: Having already read articles hang around.
4458 * Saving Articles:: Ways of customizing article saving.
4459 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4460 * Article Treatment:: The article buffer can be mangled at will.
4461 * MIME Commands:: Doing MIMEy things with the articles.
4462 * Charsets:: Character set issues.
4463 * Article Commands:: Doing various things with the article buffer.
4464 * Summary Sorting:: Sorting the summary buffer in various ways.
4465 * Finding the Parent:: No child support? Get the parent.
4466 * Alternative Approaches:: Reading using non-default summaries.
4467 * Tree Display:: A more visual display of threads.
4468 * Mail Group Commands:: Some commands can only be used in mail groups.
4469 * Various Summary Stuff:: What didn't fit anywhere else.
4470 * Exiting the Summary Buffer:: Returning to the Group buffer,
4471 or reselecting the current group.
4472 * Crosspost Handling:: How crossposted articles are dealt with.
4473 * Duplicate Suppression:: An alternative when crosspost handling fails.
4474 * Security:: Decrypt and Verify.
4475 * Mailing List:: Mailing list minor mode.
4479 @node Summary Buffer Format
4480 @section Summary Buffer Format
4481 @cindex summary buffer format
4485 \gnusfigure{The Summary Buffer}{180}{
4486 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4487 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4493 * Summary Buffer Lines:: You can specify how summary lines should look.
4494 * To From Newsgroups:: How to not display your own name.
4495 * Summary Buffer Mode Line:: You can say how the mode line should look.
4496 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4499 @findex mail-extract-address-components
4500 @findex gnus-extract-address-components
4501 @vindex gnus-extract-address-components
4502 Gnus will use the value of the @code{gnus-extract-address-components}
4503 variable as a function for getting the name and address parts of a
4504 @code{From} header. Three pre-defined functions exist:
4505 @code{gnus-extract-address-components}, which is the default, quite
4506 fast, and too simplistic solution;
4507 @code{mail-extract-address-components}, which works nicely, but is
4508 slower; and @code{std11-extract-address-components}, which works very
4509 nicely, but is slower. The default function will return the wrong
4510 answer in 5% of the cases. If this is unacceptable to you, use the
4511 other function instead:
4514 (setq gnus-extract-address-components
4515 'mail-extract-address-components)
4518 @vindex gnus-summary-same-subject
4519 @code{gnus-summary-same-subject} is a string indicating that the current
4520 article has the same subject as the previous. This string will be used
4521 with those specs that require it. The default is @code{""}.
4524 @node Summary Buffer Lines
4525 @subsection Summary Buffer Lines
4527 @vindex gnus-summary-line-format
4528 You can change the format of the lines in the summary buffer by changing
4529 the @code{gnus-summary-line-format} variable. It works along the same
4530 lines as a normal @code{format} string, with some extensions
4531 (@pxref{Formatting Variables}).
4533 There should always be a colon or a point position marker on the line;
4534 the cursor always moves to the point position marker or the colon after
4535 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4536 possible to change this. Just write a new function
4537 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4538 @xref{Positioning Point}.
4540 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4542 The following format specification characters and extended format
4543 specification(s) are understood:
4549 Subject string. List identifiers stripped,
4550 @code{gnus-list-identifies}. @xref{Article Hiding}.
4552 Subject if the article is the root of the thread or the previous article
4553 had a different subject, @code{gnus-summary-same-subject} otherwise.
4554 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4556 Full @code{From} header.
4558 The name (from the @code{From} header).
4560 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4563 The name (from the @code{From} header). This differs from the @code{n}
4564 spec in that it uses the function designated by the
4565 @code{gnus-extract-address-components} variable, which is slower, but
4566 may be more thorough.
4568 The address (from the @code{From} header). This works the same way as
4571 Number of lines in the article.
4573 Number of characters in the article. This specifier is not supported
4574 in some methods (like nnfolder).
4576 Pretty-printed version of the number of characters in the article;
4577 for example, @samp{1.2k} or @samp{0.4M}.
4579 Indentation based on thread level (@pxref{Customizing Threading}).
4581 A complex trn-style thread tree, showing response-connecting trace
4582 lines. A thread could be drawn like this:
4595 You can customize the appearance with the following options. Note
4596 that it is possible to make the thread display look really neat by
4597 replacing the default @acronym{ASCII} characters with graphic
4598 line-drawing glyphs.
4600 @item gnus-sum-thread-tree-root
4601 @vindex gnus-sum-thread-tree-root
4602 Used for the root of a thread. If @code{nil}, use subject
4603 instead. The default is @samp{> }.
4605 @item gnus-sum-thread-tree-false-root
4606 @vindex gnus-sum-thread-tree-false-root
4607 Used for the false root of a thread (@pxref{Loose Threads}). If
4608 @code{nil}, use subject instead. The default is @samp{> }.
4610 @item gnus-sum-thread-tree-single-indent
4611 @vindex gnus-sum-thread-tree-single-indent
4612 Used for a thread with just one message. If @code{nil}, use subject
4613 instead. The default is @samp{}.
4615 @item gnus-sum-thread-tree-vertical
4616 @vindex gnus-sum-thread-tree-vertical
4617 Used for drawing a vertical line. The default is @samp{| }.
4619 @item gnus-sum-thread-tree-indent
4620 @vindex gnus-sum-thread-tree-indent
4621 Used for indenting. The default is @samp{ }.
4623 @item gnus-sum-thread-tree-leaf-with-other
4624 @vindex gnus-sum-thread-tree-leaf-with-other
4625 Used for a leaf with brothers. The default is @samp{+-> }.
4627 @item gnus-sum-thread-tree-single-leaf
4628 @vindex gnus-sum-thread-tree-single-leaf
4629 Used for a leaf without brothers. The default is @samp{\-> }
4634 Nothing if the article is a root and lots of spaces if it isn't (it
4635 pushes everything after it off the screen).
4637 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4638 for adopted articles (@pxref{Customizing Threading}).
4640 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4641 for adopted articles.
4643 One space for each thread level.
4645 Twenty minus thread level spaces.
4647 Unread. @xref{Read Articles}.
4650 This misleadingly named specifier is the @dfn{secondary mark}. This
4651 mark will say whether the article has been replied to, has been cached,
4652 or has been saved. @xref{Other Marks}.
4655 Score as a number (@pxref{Scoring}).
4657 @vindex gnus-summary-zcore-fuzz
4658 Zcore, @samp{+} if above the default level and @samp{-} if below the
4659 default level. If the difference between
4660 @code{gnus-summary-default-score} and the score is less than
4661 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4669 The @code{Date} in @code{DD-MMM} format.
4671 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4677 Number of articles in the current sub-thread. Using this spec will slow
4678 down summary buffer generation somewhat.
4680 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4681 article has any children.
4687 Age sensitive date format. Various date format is defined in
4688 @code{gnus-user-date-format-alist}.
4690 User defined specifier. The next character in the format string should
4691 be a letter. Gnus will call the function
4692 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4693 following @samp{%u}. The function will be passed the current header as
4694 argument. The function should return a string, which will be inserted
4695 into the summary just like information from any other summary specifier.
4698 Text between @samp{%(} and @samp{%)} will be highlighted with
4699 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4700 There can only be one such area.
4702 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4703 have to be handled with care. For reasons of efficiency, gnus will
4704 compute what column these characters will end up in, and ``hard-code''
4705 that. This means that it is invalid to have these specs after a
4706 variable-length spec. Well, you might not be arrested, but your summary
4707 buffer will look strange, which is bad enough.
4709 The smart choice is to have these specs as far to the left as possible.
4710 (Isn't that the case with everything, though? But I digress.)
4712 This restriction may disappear in later versions of gnus.
4715 @node To From Newsgroups
4716 @subsection To From Newsgroups
4720 In some groups (particularly in archive groups), the @code{From} header
4721 isn't very interesting, since all the articles there are written by
4722 you. To display the information in the @code{To} or @code{Newsgroups}
4723 headers instead, you need to decide three things: What information to
4724 gather; where to display it; and when to display it.
4728 @vindex gnus-extra-headers
4729 The reading of extra header information is controlled by the
4730 @code{gnus-extra-headers}. This is a list of header symbols. For
4734 (setq gnus-extra-headers
4735 '(To Newsgroups X-Newsreader))
4738 This will result in Gnus trying to obtain these three headers, and
4739 storing it in header structures for later easy retrieval.
4742 @findex gnus-extra-header
4743 The value of these extra headers can be accessed via the
4744 @code{gnus-extra-header} function. Here's a format line spec that will
4745 access the @code{X-Newsreader} header:
4748 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4752 @vindex gnus-ignored-from-addresses
4753 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4754 summary line spec returns the @code{To}, @code{Newsreader} or
4755 @code{From} header. If this regexp matches the contents of the
4756 @code{From} header, the value of the @code{To} or @code{Newsreader}
4757 headers are used instead.
4761 @vindex nnmail-extra-headers
4762 A related variable is @code{nnmail-extra-headers}, which controls when
4763 to include extra headers when generating overview (@acronym{NOV}) files.
4764 If you have old overview files, you should regenerate them after
4765 changing this variable, by entering the server buffer using @kbd{^},
4766 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
4769 @vindex gnus-summary-line-format
4770 You also have to instruct Gnus to display the data by changing the
4771 @code{%n} spec to the @code{%f} spec in the
4772 @code{gnus-summary-line-format} variable.
4774 In summary, you'd typically put something like the following in
4778 (setq gnus-extra-headers
4780 (setq nnmail-extra-headers gnus-extra-headers)
4781 (setq gnus-summary-line-format
4782 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4783 (setq gnus-ignored-from-addresses
4787 (The values listed above are the default values in Gnus. Alter them
4790 A note for news server administrators, or for users who wish to try to
4791 convince their news server administrator to provide some additional
4794 The above is mostly useful for mail groups, where you have control over
4795 the @acronym{NOV} files that are created. However, if you can persuade your
4796 nntp admin to add (in the usual implementation, notably INN):
4802 to the end of her @file{overview.fmt} file, then you can use that just
4803 as you would the extra headers from the mail groups.
4806 @node Summary Buffer Mode Line
4807 @subsection Summary Buffer Mode Line
4809 @vindex gnus-summary-mode-line-format
4810 You can also change the format of the summary mode bar (@pxref{Mode Line
4811 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4812 like. The default is @samp{Gnus: %%b [%A] %Z}.
4814 Here are the elements you can play with:
4820 Unprefixed group name.
4822 Current article number.
4824 Current article score.
4828 Number of unread articles in this group.
4830 Number of unread articles in this group that aren't displayed in the
4833 A string with the number of unread and unselected articles represented
4834 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4835 articles, and just as @samp{<%U more>} if there are just unread articles
4836 and no unselected ones.
4838 Shortish group name. For instance, @samp{rec.arts.anime} will be
4839 shortened to @samp{r.a.anime}.
4841 Subject of the current article.
4843 User-defined spec (@pxref{User-Defined Specs}).
4845 Name of the current score file (@pxref{Scoring}).
4847 Number of dormant articles (@pxref{Unread Articles}).
4849 Number of ticked articles (@pxref{Unread Articles}).
4851 Number of articles that have been marked as read in this session.
4853 Number of articles expunged by the score files.
4857 @node Summary Highlighting
4858 @subsection Summary Highlighting
4862 @item gnus-visual-mark-article-hook
4863 @vindex gnus-visual-mark-article-hook
4864 This hook is run after selecting an article. It is meant to be used for
4865 highlighting the article in some way. It is not run if
4866 @code{gnus-visual} is @code{nil}.
4868 @item gnus-summary-update-hook
4869 @vindex gnus-summary-update-hook
4870 This hook is called when a summary line is changed. It is not run if
4871 @code{gnus-visual} is @code{nil}.
4873 @item gnus-summary-selected-face
4874 @vindex gnus-summary-selected-face
4875 This is the face (or @dfn{font} as some people call it) used to
4876 highlight the current article in the summary buffer.
4878 @item gnus-summary-highlight
4879 @vindex gnus-summary-highlight
4880 Summary lines are highlighted according to this variable, which is a
4881 list where the elements are of the format @code{(@var{form}
4882 . @var{face})}. If you would, for instance, like ticked articles to be
4883 italic and high-scored articles to be bold, you could set this variable
4886 (((eq mark gnus-ticked-mark) . italic)
4887 ((> score default) . bold))
4889 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4890 @var{face} will be applied to the line.
4894 @node Summary Maneuvering
4895 @section Summary Maneuvering
4896 @cindex summary movement
4898 All the straight movement commands understand the numeric prefix and
4899 behave pretty much as you'd expect.
4901 None of these commands select articles.
4906 @kindex M-n (Summary)
4907 @kindex G M-n (Summary)
4908 @findex gnus-summary-next-unread-subject
4909 Go to the next summary line of an unread article
4910 (@code{gnus-summary-next-unread-subject}).
4914 @kindex M-p (Summary)
4915 @kindex G M-p (Summary)
4916 @findex gnus-summary-prev-unread-subject
4917 Go to the previous summary line of an unread article
4918 (@code{gnus-summary-prev-unread-subject}).
4921 @kindex G g (Summary)
4922 @findex gnus-summary-goto-subject
4923 Ask for an article number and then go to the summary line of that article
4924 without displaying the article (@code{gnus-summary-goto-subject}).
4927 If gnus asks you to press a key to confirm going to the next group, you
4928 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4929 buffer, searching for the next group to read without actually returning
4930 to the group buffer.
4932 Variables related to summary movement:
4936 @vindex gnus-auto-select-next
4937 @item gnus-auto-select-next
4938 If you issue one of the movement commands (like @kbd{n}) and there are
4939 no more unread articles after the current one, gnus will offer to go to
4940 the next group. If this variable is @code{t} and the next group is
4941 empty, gnus will exit summary mode and return to the group buffer. If
4942 this variable is neither @code{t} nor @code{nil}, gnus will select the
4943 next group with unread articles. As a special case, if this variable
4944 is @code{quietly}, Gnus will select the next group without asking for
4945 confirmation. If this variable is @code{almost-quietly}, the same
4946 will happen only if you are located on the last article in the group.
4947 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
4948 command will go to the next group without confirmation. Also
4949 @pxref{Group Levels}.
4951 @item gnus-auto-select-same
4952 @vindex gnus-auto-select-same
4953 If non-@code{nil}, all the movement commands will try to go to the next
4954 article with the same subject as the current. (@dfn{Same} here might
4955 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4956 for details (@pxref{Customizing Threading}).) If there are no more
4957 articles with the same subject, go to the first unread article.
4959 This variable is not particularly useful if you use a threaded display.
4961 @item gnus-summary-check-current
4962 @vindex gnus-summary-check-current
4963 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4964 to the next (or previous) article if the current article is unread.
4965 Instead, they will choose the current article.
4967 @item gnus-auto-center-summary
4968 @vindex gnus-auto-center-summary
4969 If non-@code{nil}, gnus will keep the point in the summary buffer
4970 centered at all times. This makes things quite tidy, but if you have a
4971 slow network connection, or simply do not like this un-Emacsism, you can
4972 set this variable to @code{nil} to get the normal Emacs scrolling
4973 action. This will also inhibit horizontal re-centering of the summary
4974 buffer, which might make it more inconvenient to read extremely long
4977 This variable can also be a number. In that case, center the window at
4978 the given number of lines from the top.
4983 @node Choosing Articles
4984 @section Choosing Articles
4985 @cindex selecting articles
4988 * Choosing Commands:: Commands for choosing articles.
4989 * Choosing Variables:: Variables that influence these commands.
4993 @node Choosing Commands
4994 @subsection Choosing Commands
4996 None of the following movement commands understand the numeric prefix,
4997 and they all select and display an article.
4999 If you want to fetch new articles or redisplay the group, see
5000 @ref{Exiting the Summary Buffer}.
5004 @kindex SPACE (Summary)
5005 @findex gnus-summary-next-page
5006 Select the current article, or, if that one's read already, the next
5007 unread article (@code{gnus-summary-next-page}).
5009 If you have an article window open already and you press @kbd{SPACE}
5010 again, the article will be scrolled. This lets you conveniently
5011 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5016 @kindex G n (Summary)
5017 @findex gnus-summary-next-unread-article
5018 @c @icon{gnus-summary-next-unread}
5019 Go to next unread article (@code{gnus-summary-next-unread-article}).
5024 @findex gnus-summary-prev-unread-article
5025 @c @icon{gnus-summary-prev-unread}
5026 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5031 @kindex G N (Summary)
5032 @findex gnus-summary-next-article
5033 Go to the next article (@code{gnus-summary-next-article}).
5038 @kindex G P (Summary)
5039 @findex gnus-summary-prev-article
5040 Go to the previous article (@code{gnus-summary-prev-article}).
5043 @kindex G C-n (Summary)
5044 @findex gnus-summary-next-same-subject
5045 Go to the next article with the same subject
5046 (@code{gnus-summary-next-same-subject}).
5049 @kindex G C-p (Summary)
5050 @findex gnus-summary-prev-same-subject
5051 Go to the previous article with the same subject
5052 (@code{gnus-summary-prev-same-subject}).
5056 @kindex G f (Summary)
5058 @findex gnus-summary-first-unread-article
5059 Go to the first unread article
5060 (@code{gnus-summary-first-unread-article}).
5064 @kindex G b (Summary)
5066 @findex gnus-summary-best-unread-article
5067 Go to the unread article with the highest score
5068 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5069 go to the first unread article that has a score over the default score.
5074 @kindex G l (Summary)
5075 @findex gnus-summary-goto-last-article
5076 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5079 @kindex G o (Summary)
5080 @findex gnus-summary-pop-article
5082 @cindex article history
5083 Pop an article off the summary history and go to this article
5084 (@code{gnus-summary-pop-article}). This command differs from the
5085 command above in that you can pop as many previous articles off the
5086 history as you like, while @kbd{l} toggles the two last read articles.
5087 For a somewhat related issue (if you use these commands a lot),
5088 @pxref{Article Backlog}.
5093 @kindex G j (Summary)
5094 @findex gnus-summary-goto-article
5095 Ask for an article number or @code{Message-ID}, and then go to that
5096 article (@code{gnus-summary-goto-article}).
5101 @node Choosing Variables
5102 @subsection Choosing Variables
5104 Some variables relevant for moving and selecting articles:
5107 @item gnus-auto-extend-newsgroup
5108 @vindex gnus-auto-extend-newsgroup
5109 All the movement commands will try to go to the previous (or next)
5110 article, even if that article isn't displayed in the Summary buffer if
5111 this variable is non-@code{nil}. Gnus will then fetch the article from
5112 the server and display it in the article buffer.
5114 @item gnus-select-article-hook
5115 @vindex gnus-select-article-hook
5116 This hook is called whenever an article is selected. By default it
5117 exposes any threads hidden under the selected article. If you would
5118 like each article to be saved in the Agent as you read it, putting
5119 @code{gnus-agent-fetch-selected-article} on this hook will do so.
5121 @item gnus-mark-article-hook
5122 @vindex gnus-mark-article-hook
5123 @findex gnus-summary-mark-unread-as-read
5124 @findex gnus-summary-mark-read-and-unread-as-read
5125 @findex gnus-unread-mark
5126 This hook is called whenever an article is selected. It is intended to
5127 be used for marking articles as read. The default value is
5128 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5129 mark of almost any article you read to @code{gnus-unread-mark}. The
5130 only articles not affected by this function are ticked, dormant, and
5131 expirable articles. If you'd instead like to just have unread articles
5132 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5133 instead. It will leave marks like @code{gnus-low-score-mark},
5134 @code{gnus-del-mark} (and so on) alone.
5139 @node Paging the Article
5140 @section Scrolling the Article
5141 @cindex article scrolling
5146 @kindex SPACE (Summary)
5147 @findex gnus-summary-next-page
5148 Pressing @kbd{SPACE} will scroll the current article forward one page,
5149 or, if you have come to the end of the current article, will choose the
5150 next article (@code{gnus-summary-next-page}).
5152 @vindex gnus-article-boring-faces
5153 @vindex gnus-article-skip-boring
5154 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5155 the article consists only of citations and signature, then it will be
5156 skipped; the next article will be shown instead. You can customize
5157 what is considered uninteresting with
5158 @code{gnus-article-boring-faces}. You can manually view the article's
5159 pages, no matter how boring, using @kbd{C-M-v}.
5162 @kindex DEL (Summary)
5163 @findex gnus-summary-prev-page
5164 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5167 @kindex RET (Summary)
5168 @findex gnus-summary-scroll-up
5169 Scroll the current article one line forward
5170 (@code{gnus-summary-scroll-up}).
5173 @kindex M-RET (Summary)
5174 @findex gnus-summary-scroll-down
5175 Scroll the current article one line backward
5176 (@code{gnus-summary-scroll-down}).
5180 @kindex A g (Summary)
5182 @findex gnus-summary-show-article
5183 @vindex gnus-summary-show-article-charset-alist
5184 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5185 given a prefix, fetch the current article, but don't run any of the
5186 article treatment functions. This will give you a ``raw'' article, just
5187 the way it came from the server.
5189 If given a numerical prefix, you can do semi-manual charset stuff.
5190 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5191 encoded in the @code{cn-gb-2312} charset. If you have
5194 (setq gnus-summary-show-article-charset-alist
5199 then you can say @kbd{C-u 1 g} to get the same effect.
5204 @kindex A < (Summary)
5205 @findex gnus-summary-beginning-of-article
5206 Scroll to the beginning of the article
5207 (@code{gnus-summary-beginning-of-article}).
5212 @kindex A > (Summary)
5213 @findex gnus-summary-end-of-article
5214 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5218 @kindex A s (Summary)
5220 @findex gnus-summary-isearch-article
5221 Perform an isearch in the article buffer
5222 (@code{gnus-summary-isearch-article}).
5226 @findex gnus-summary-select-article-buffer
5227 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5232 @node Reply Followup and Post
5233 @section Reply, Followup and Post
5236 * Summary Mail Commands:: Sending mail.
5237 * Summary Post Commands:: Sending news.
5238 * Summary Message Commands:: Other Message-related commands.
5239 * Canceling and Superseding::
5243 @node Summary Mail Commands
5244 @subsection Summary Mail Commands
5246 @cindex composing mail
5248 Commands for composing a mail message:
5254 @kindex S r (Summary)
5256 @findex gnus-summary-reply
5257 @c @icon{gnus-summary-mail-reply}
5258 @c @icon{gnus-summary-reply}
5259 Mail a reply to the author of the current article
5260 (@code{gnus-summary-reply}).
5265 @kindex S R (Summary)
5266 @findex gnus-summary-reply-with-original
5267 @c @icon{gnus-summary-reply-with-original}
5268 Mail a reply to the author of the current article and include the
5269 original message (@code{gnus-summary-reply-with-original}). This
5270 command uses the process/prefix convention.
5273 @kindex S w (Summary)
5274 @findex gnus-summary-wide-reply
5275 Mail a wide reply to the author of the current article
5276 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5277 goes out to all people listed in the @code{To}, @code{From} (or
5278 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5279 present, that's used instead.
5282 @kindex S W (Summary)
5283 @findex gnus-summary-wide-reply-with-original
5284 Mail a wide reply to the current article and include the original
5285 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5286 the process/prefix convention.
5289 @kindex S v (Summary)
5290 @findex gnus-summary-very-wide-reply
5291 Mail a very wide reply to the author of the current article
5292 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5293 that goes out to all people listed in the @code{To}, @code{From} (or
5294 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5295 articles. This command uses the process/prefix convention.
5298 @kindex S V (Summary)
5299 @findex gnus-summary-very-wide-reply-with-original
5300 Mail a very wide reply to the author of the current article and include the
5301 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5302 command uses the process/prefix convention.
5305 @kindex S B r (Summary)
5306 @findex gnus-summary-reply-broken-reply-to
5307 Mail a reply to the author of the current article but ignore the
5308 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5309 If you need this because a mailing list incorrectly sets a
5310 @code{Reply-To} header pointing to the list, you probably want to set
5311 the @code{broken-reply-to} group parameter instead, so things will work
5312 correctly. @xref{Group Parameters}.
5315 @kindex S B R (Summary)
5316 @findex gnus-summary-reply-broken-reply-to-with-original
5317 Mail a reply to the author of the current article and include the
5318 original message but ignore the @code{Reply-To} field
5319 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5323 @kindex S o m (Summary)
5324 @kindex C-c C-f (Summary)
5325 @findex gnus-summary-mail-forward
5326 @c @icon{gnus-summary-mail-forward}
5327 Forward the current article to some other person
5328 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
5329 headers of the forwarded article.
5334 @kindex S m (Summary)
5335 @findex gnus-summary-mail-other-window
5336 @c @icon{gnus-summary-mail-originate}
5337 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5338 the posting style of the current group. If given a prefix, disable that.
5339 If the prefix is 1, prompt for a group name to find the posting style.
5344 @kindex S i (Summary)
5345 @findex gnus-summary-news-other-window
5346 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5347 post to the current group. If given a prefix, disable that. If the
5348 prefix is 1, prompt for a group to post to.
5350 This function actually prepares a news even when using mail groups.
5351 This is useful for ``posting'' messages to mail groups without actually
5352 sending them over the network: they're just saved directly to the group
5353 in question. The corresponding back end must have a request-post method
5354 for this to work though.
5357 @kindex S D b (Summary)
5358 @findex gnus-summary-resend-bounced-mail
5359 @cindex bouncing mail
5360 If you have sent a mail, but the mail was bounced back to you for some
5361 reason (wrong address, transient failure), you can use this command to
5362 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5363 will be popped into a mail buffer where you can edit the headers before
5364 sending the mail off again. If you give a prefix to this command, and
5365 the bounced mail is a reply to some other mail, gnus will try to fetch
5366 that mail and display it for easy perusal of its headers. This might
5367 very well fail, though.
5370 @kindex S D r (Summary)
5371 @findex gnus-summary-resend-message
5372 Not to be confused with the previous command,
5373 @code{gnus-summary-resend-message} will prompt you for an address to
5374 send the current message off to, and then send it to that place. The
5375 headers of the message won't be altered---but lots of headers that say
5376 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5377 means that you actually send a mail to someone that has a @code{To}
5378 header that (probably) points to yourself. This will confuse people.
5379 So, natcherly you'll only do that if you're really eVIl.
5381 This command is mainly used if you have several accounts and want to
5382 ship a mail to a different account of yours. (If you're both
5383 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5384 to the @code{root} account, you may want to resend it to
5385 @code{postmaster}. Ordnung muss sein!
5387 This command understands the process/prefix convention
5388 (@pxref{Process/Prefix}).
5391 @kindex S D e (Summary)
5392 @findex gnus-summary-resend-message-edit
5394 Like the previous command, but will allow you to edit the message as
5395 if it were a new message before resending.
5398 @kindex S O m (Summary)
5399 @findex gnus-summary-digest-mail-forward
5400 Digest the current series (@pxref{Decoding Articles}) and forward the
5401 result using mail (@code{gnus-summary-digest-mail-forward}). This
5402 command uses the process/prefix convention (@pxref{Process/Prefix}).
5405 @kindex S M-c (Summary)
5406 @findex gnus-summary-mail-crosspost-complaint
5407 @cindex crossposting
5408 @cindex excessive crossposting
5409 Send a complaint about excessive crossposting to the author of the
5410 current article (@code{gnus-summary-mail-crosspost-complaint}).
5412 @findex gnus-crosspost-complaint
5413 This command is provided as a way to fight back against the current
5414 crossposting pandemic that's sweeping Usenet. It will compose a reply
5415 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5416 command understands the process/prefix convention
5417 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5421 Also @xref{Header Commands, ,Header Commands, message, The Message
5422 Manual}, for more information.
5425 @node Summary Post Commands
5426 @subsection Summary Post Commands
5428 @cindex composing news
5430 Commands for posting a news article:
5436 @kindex S p (Summary)
5437 @findex gnus-summary-post-news
5438 @c @icon{gnus-summary-post-news}
5439 Prepare for posting an article (@code{gnus-summary-post-news}). By
5440 default, post to the current group. If given a prefix, disable that.
5441 If the prefix is 1, prompt for another group instead.
5446 @kindex S f (Summary)
5447 @findex gnus-summary-followup
5448 @c @icon{gnus-summary-followup}
5449 Post a followup to the current article (@code{gnus-summary-followup}).
5453 @kindex S F (Summary)
5455 @c @icon{gnus-summary-followup-with-original}
5456 @findex gnus-summary-followup-with-original
5457 Post a followup to the current article and include the original message
5458 (@code{gnus-summary-followup-with-original}). This command uses the
5459 process/prefix convention.
5462 @kindex S n (Summary)
5463 @findex gnus-summary-followup-to-mail
5464 Post a followup to the current article via news, even if you got the
5465 message through mail (@code{gnus-summary-followup-to-mail}).
5468 @kindex S N (Summary)
5469 @findex gnus-summary-followup-to-mail-with-original
5470 Post a followup to the current article via news, even if you got the
5471 message through mail and include the original message
5472 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5473 the process/prefix convention.
5476 @kindex S o p (Summary)
5477 @findex gnus-summary-post-forward
5478 Forward the current article to a newsgroup
5479 (@code{gnus-summary-post-forward}). If given a prefix, include the full
5480 headers of the forwarded article.
5483 @kindex S O p (Summary)
5484 @findex gnus-summary-digest-post-forward
5486 @cindex making digests
5487 Digest the current series and forward the result to a newsgroup
5488 (@code{gnus-summary-digest-post-forward}). This command uses the
5489 process/prefix convention.
5492 @kindex S u (Summary)
5493 @findex gnus-uu-post-news
5494 @c @icon{gnus-uu-post-news}
5495 Uuencode a file, split it into parts, and post it as a series
5496 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5499 Also @xref{Header Commands, ,Header Commands, message, The Message
5500 Manual}, for more information.
5503 @node Summary Message Commands
5504 @subsection Summary Message Commands
5508 @kindex S y (Summary)
5509 @findex gnus-summary-yank-message
5510 Yank the current article into an already existing Message composition
5511 buffer (@code{gnus-summary-yank-message}). This command prompts for
5512 what message buffer you want to yank into, and understands the
5513 process/prefix convention (@pxref{Process/Prefix}).
5518 @node Canceling and Superseding
5519 @subsection Canceling Articles
5520 @cindex canceling articles
5521 @cindex superseding articles
5523 Have you ever written something, and then decided that you really,
5524 really, really wish you hadn't posted that?
5526 Well, you can't cancel mail, but you can cancel posts.
5528 @findex gnus-summary-cancel-article
5530 @c @icon{gnus-summary-cancel-article}
5531 Find the article you wish to cancel (you can only cancel your own
5532 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5533 c} (@code{gnus-summary-cancel-article}). Your article will be
5534 canceled---machines all over the world will be deleting your article.
5535 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5537 Be aware, however, that not all sites honor cancels, so your article may
5538 live on here and there, while most sites will delete the article in
5541 Gnus will use the ``current'' select method when canceling. If you
5542 want to use the standard posting method, use the @samp{a} symbolic
5543 prefix (@pxref{Symbolic Prefixes}).
5545 Gnus ensures that only you can cancel your own messages using a
5546 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5547 message, Message Manual}).
5549 If you discover that you have made some mistakes and want to do some
5550 corrections, you can post a @dfn{superseding} article that will replace
5551 your original article.
5553 @findex gnus-summary-supersede-article
5555 Go to the original article and press @kbd{S s}
5556 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5557 where you can edit the article all you want before sending it off the
5560 The same goes for superseding as for canceling, only more so: Some
5561 sites do not honor superseding. On those sites, it will appear that you
5562 have posted almost the same article twice.
5564 If you have just posted the article, and change your mind right away,
5565 there is a trick you can use to cancel/supersede the article without
5566 waiting for the article to appear on your site first. You simply return
5567 to the post buffer (which is called @code{*sent ...*}). There you will
5568 find the article you just posted, with all the headers intact. Change
5569 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5570 header by substituting one of those words for the word
5571 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5572 you would do normally. The previous article will be
5573 canceled/superseded.
5575 Just remember, kids: There is no 'c' in 'supersede'.
5577 @node Delayed Articles
5578 @section Delayed Articles
5579 @cindex delayed sending
5580 @cindex send delayed
5582 Sometimes, you might wish to delay the sending of a message. For
5583 example, you might wish to arrange for a message to turn up just in time
5584 to remind your about the birthday of your Significant Other. For this,
5585 there is the @code{gnus-delay} package. Setup is simple:
5588 (gnus-delay-initialize)
5591 @findex gnus-delay-article
5592 Normally, to send a message you use the @kbd{C-c C-c} command from
5593 Message mode. To delay a message, use @kbd{C-c C-j}
5594 (@code{gnus-delay-article}) instead. This will ask you for how long the
5595 message should be delayed. Possible answers are:
5599 A time span. Consists of an integer and a letter. For example,
5600 @code{42d} means to delay for 42 days. Available letters are @code{m}
5601 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5602 (months) and @code{Y} (years).
5605 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5606 delayed until that day, at a specific time (eight o'clock by default).
5607 See also @code{gnus-delay-default-hour}.
5610 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5611 stuff. The deadline will be at that time today, except if that time has
5612 already passed, then it's at the given time tomorrow. So if it's ten
5613 o'clock in the morning and you specify @code{11:15}, then the deadline
5614 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5615 that means a time tomorrow.
5618 The action of the @code{gnus-delay-article} command is influenced by a
5619 couple of variables:
5622 @item gnus-delay-default-hour
5623 @vindex gnus-delay-default-hour
5624 When you specify a specific date, the message will be due on that hour
5625 on the given date. Possible values are integers 0 through 23.
5627 @item gnus-delay-default-delay
5628 @vindex gnus-delay-default-delay
5629 This is a string and gives the default delay. It can be of any of the
5630 formats described above.
5632 @item gnus-delay-group
5633 @vindex gnus-delay-group
5634 Delayed articles will be kept in this group on the drafts server until
5635 they are due. You probably don't need to change this. The default
5636 value is @code{"delayed"}.
5638 @item gnus-delay-header
5639 @vindex gnus-delay-header
5640 The deadline for each article will be stored in a header. This variable
5641 is a string and gives the header name. You probably don't need to
5642 change this. The default value is @code{"X-Gnus-Delayed"}.
5645 The way delaying works is like this: when you use the
5646 @code{gnus-delay-article} command, you give a certain delay. Gnus
5647 calculates the deadline of the message and stores it in the
5648 @code{X-Gnus-Delayed} header and puts the message in the
5649 @code{nndraft:delayed} group.
5651 @findex gnus-delay-send-queue
5652 And whenever you get new news, Gnus looks through the group for articles
5653 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5654 function for this. By default, this function is added to the hook
5655 @code{gnus-get-new-news-hook}. But of course, you can change this.
5656 Maybe you want to use the demon to send drafts? Just tell the demon to
5657 execute the @code{gnus-delay-send-queue} function.
5660 @item gnus-delay-initialize
5661 @findex gnus-delay-initialize
5663 By default, this function installs @code{gnus-delay-send-queue} in
5664 @code{gnus-get-new-news-hook}. But it accepts the optional second
5665 argument @code{no-check}. If it is non-@code{nil},
5666 @code{gnus-get-new-news-hook} is not changed. The optional first
5667 argument is ignored.
5669 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5670 Presumably, you want to use the demon for sending due delayed articles.
5671 Just don't forget to set that up :-)
5675 @node Marking Articles
5676 @section Marking Articles
5677 @cindex article marking
5678 @cindex article ticking
5681 There are several marks you can set on an article.
5683 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5684 neologism ohoy!) of the article. Alphabetic marks generally mean
5685 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5687 In addition, you also have marks that do not affect readedness.
5690 There's a plethora of commands for manipulating these marks.
5694 * Unread Articles:: Marks for unread articles.
5695 * Read Articles:: Marks for read articles.
5696 * Other Marks:: Marks that do not affect readedness.
5697 * Setting Marks:: How to set and remove marks.
5698 * Generic Marking Commands:: How to customize the marking.
5699 * Setting Process Marks:: How to mark articles for later processing.
5703 @node Unread Articles
5704 @subsection Unread Articles
5706 The following marks mark articles as (kinda) unread, in one form or
5711 @vindex gnus-ticked-mark
5712 Marked as ticked (@code{gnus-ticked-mark}).
5714 @dfn{Ticked articles} are articles that will remain visible always. If
5715 you see an article that you find interesting, or you want to put off
5716 reading it, or replying to it, until sometime later, you'd typically
5717 tick it. However, articles can be expired (from news servers by the
5718 news server software, Gnus itself never expires ticked messages), so if
5719 you want to keep an article forever, you'll have to make it persistent
5720 (@pxref{Persistent Articles}).
5723 @vindex gnus-dormant-mark
5724 Marked as dormant (@code{gnus-dormant-mark}).
5726 @dfn{Dormant articles} will only appear in the summary buffer if there
5727 are followups to it. If you want to see them even if they don't have
5728 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5729 Otherwise (except for the visibility issue), they are just like ticked
5733 @vindex gnus-unread-mark
5734 Marked as unread (@code{gnus-unread-mark}).
5736 @dfn{Unread articles} are articles that haven't been read at all yet.
5741 @subsection Read Articles
5742 @cindex expirable mark
5744 All the following marks mark articles as read.
5749 @vindex gnus-del-mark
5750 These are articles that the user has marked as read with the @kbd{d}
5751 command manually, more or less (@code{gnus-del-mark}).
5754 @vindex gnus-read-mark
5755 Articles that have actually been read (@code{gnus-read-mark}).
5758 @vindex gnus-ancient-mark
5759 Articles that were marked as read in previous sessions and are now
5760 @dfn{old} (@code{gnus-ancient-mark}).
5763 @vindex gnus-killed-mark
5764 Marked as killed (@code{gnus-killed-mark}).
5767 @vindex gnus-kill-file-mark
5768 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5771 @vindex gnus-low-score-mark
5772 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5775 @vindex gnus-catchup-mark
5776 Marked as read by a catchup (@code{gnus-catchup-mark}).
5779 @vindex gnus-canceled-mark
5780 Canceled article (@code{gnus-canceled-mark})
5783 @vindex gnus-souped-mark
5784 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5787 @vindex gnus-sparse-mark
5788 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5792 @vindex gnus-duplicate-mark
5793 Article marked as read by duplicate suppression
5794 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5798 All these marks just mean that the article is marked as read, really.
5799 They are interpreted differently when doing adaptive scoring, though.
5801 One more special mark, though:
5805 @vindex gnus-expirable-mark
5806 Marked as expirable (@code{gnus-expirable-mark}).
5808 Marking articles as @dfn{expirable} (or have them marked as such
5809 automatically) doesn't make much sense in normal groups---a user doesn't
5810 control expiring of news articles, but in mail groups, for instance,
5811 articles marked as @dfn{expirable} can be deleted by gnus at
5817 @subsection Other Marks
5818 @cindex process mark
5821 There are some marks that have nothing to do with whether the article is
5827 You can set a bookmark in the current article. Say you are reading a
5828 long thesis on cats' urinary tracts, and have to go home for dinner
5829 before you've finished reading the thesis. You can then set a bookmark
5830 in the article, and gnus will jump to this bookmark the next time it
5831 encounters the article. @xref{Setting Marks}.
5834 @vindex gnus-replied-mark
5835 All articles that you have replied to or made a followup to (i.e., have
5836 answered) will be marked with an @samp{A} in the second column
5837 (@code{gnus-replied-mark}).
5840 @vindex gnus-forwarded-mark
5841 All articles that you have forwarded will be marked with an @samp{F} in
5842 the second column (@code{gnus-forwarded-mark}).
5845 @vindex gnus-cached-mark
5846 Articles stored in the article cache will be marked with an @samp{*} in
5847 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5850 @vindex gnus-saved-mark
5851 Articles ``saved'' (in some manner or other; not necessarily
5852 religiously) are marked with an @samp{S} in the second column
5853 (@code{gnus-saved-mark}).
5856 @vindex gnus-recent-mark
5857 Articles that according to the server haven't been shown to the user
5858 before are marked with a @samp{N} in the second column
5859 (@code{gnus-recent-mark}). Note that not all servers support this
5860 mark, in which case it simply never appears. Compare with
5861 @code{gnus-unseen-mark}.
5864 @vindex gnus-unseen-mark
5865 Articles that haven't been seen before in Gnus by the user are marked
5866 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5867 Compare with @code{gnus-recent-mark}.
5870 @vindex gnus-downloaded-mark
5871 When using the Gnus agent (@pxref{Agent Basics}), articles may be
5872 downloaded for unplugged (offline) viewing. If you are using the
5873 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
5874 (The variable @code{gnus-downloaded-mark} controls which character to
5878 @vindex gnus-undownloaded-mark
5879 When using the Gnus agent (@pxref{Agent Basics}), some articles might
5880 not have been downloaded. Such articles cannot be viewed while you
5881 are unplugged (offline). If you are using the @samp{%O} spec, these
5882 articles get the @samp{-} mark in that spec. (The variable
5883 @code{gnus-undownloaded-mark} controls which character to use.)
5886 @vindex gnus-downloadable-mark
5887 The Gnus agent (@pxref{Agent Basics}) downloads some articles
5888 automatically, but it is also possible to explicitly mark articles for
5889 download, even if they would not be downloaded automatically. Such
5890 explicitly-marked articles get the @samp{%} mark in the first column.
5891 (The variable @code{gnus-downloadable-mark} controls which character to
5895 @vindex gnus-not-empty-thread-mark
5896 @vindex gnus-empty-thread-mark
5897 If the @samp{%e} spec is used, the presence of threads or not will be
5898 marked with @code{gnus-not-empty-thread-mark} and
5899 @code{gnus-empty-thread-mark} in the third column, respectively.
5902 @vindex gnus-process-mark
5903 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5904 variety of commands react to the presence of the process mark. For
5905 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5906 all articles that have been marked with the process mark. Articles
5907 marked with the process mark have a @samp{#} in the second column.
5911 You might have noticed that most of these ``non-readedness'' marks
5912 appear in the second column by default. So if you have a cached, saved,
5913 replied article that you have process-marked, what will that look like?
5915 Nothing much. The precedence rules go as follows: process -> cache ->
5916 replied -> saved. So if the article is in the cache and is replied,
5917 you'll only see the cache mark and not the replied mark.
5921 @subsection Setting Marks
5922 @cindex setting marks
5924 All the marking commands understand the numeric prefix.
5929 @kindex M c (Summary)
5930 @kindex M-u (Summary)
5931 @findex gnus-summary-clear-mark-forward
5932 @cindex mark as unread
5933 Clear all readedness-marks from the current article
5934 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5940 @kindex M t (Summary)
5941 @findex gnus-summary-tick-article-forward
5942 Tick the current article (@code{gnus-summary-tick-article-forward}).
5943 @xref{Article Caching}.
5948 @kindex M ? (Summary)
5949 @findex gnus-summary-mark-as-dormant
5950 Mark the current article as dormant
5951 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5955 @kindex M d (Summary)
5957 @findex gnus-summary-mark-as-read-forward
5958 Mark the current article as read
5959 (@code{gnus-summary-mark-as-read-forward}).
5963 @findex gnus-summary-mark-as-read-backward
5964 Mark the current article as read and move point to the previous line
5965 (@code{gnus-summary-mark-as-read-backward}).
5970 @kindex M k (Summary)
5971 @findex gnus-summary-kill-same-subject-and-select
5972 Mark all articles that have the same subject as the current one as read,
5973 and then select the next unread article
5974 (@code{gnus-summary-kill-same-subject-and-select}).
5978 @kindex M K (Summary)
5979 @kindex C-k (Summary)
5980 @findex gnus-summary-kill-same-subject
5981 Mark all articles that have the same subject as the current one as read
5982 (@code{gnus-summary-kill-same-subject}).
5985 @kindex M C (Summary)
5986 @findex gnus-summary-catchup
5987 @c @icon{gnus-summary-catchup}
5988 Mark all unread articles as read (@code{gnus-summary-catchup}).
5991 @kindex M C-c (Summary)
5992 @findex gnus-summary-catchup-all
5993 Mark all articles in the group as read---even the ticked and dormant
5994 articles (@code{gnus-summary-catchup-all}).
5997 @kindex M H (Summary)
5998 @findex gnus-summary-catchup-to-here
5999 Catchup the current group to point (before the point)
6000 (@code{gnus-summary-catchup-to-here}).
6003 @kindex M h (Summary)
6004 @findex gnus-summary-catchup-from-here
6005 Catchup the current group from point (after the point)
6006 (@code{gnus-summary-catchup-from-here}).
6009 @kindex C-w (Summary)
6010 @findex gnus-summary-mark-region-as-read
6011 Mark all articles between point and mark as read
6012 (@code{gnus-summary-mark-region-as-read}).
6015 @kindex M V k (Summary)
6016 @findex gnus-summary-kill-below
6017 Kill all articles with scores below the default score (or below the
6018 numeric prefix) (@code{gnus-summary-kill-below}).
6022 @kindex M e (Summary)
6024 @findex gnus-summary-mark-as-expirable
6025 Mark the current article as expirable
6026 (@code{gnus-summary-mark-as-expirable}).
6029 @kindex M b (Summary)
6030 @findex gnus-summary-set-bookmark
6031 Set a bookmark in the current article
6032 (@code{gnus-summary-set-bookmark}).
6035 @kindex M B (Summary)
6036 @findex gnus-summary-remove-bookmark
6037 Remove the bookmark from the current article
6038 (@code{gnus-summary-remove-bookmark}).
6041 @kindex M V c (Summary)
6042 @findex gnus-summary-clear-above
6043 Clear all marks from articles with scores over the default score (or
6044 over the numeric prefix) (@code{gnus-summary-clear-above}).
6047 @kindex M V u (Summary)
6048 @findex gnus-summary-tick-above
6049 Tick all articles with scores over the default score (or over the
6050 numeric prefix) (@code{gnus-summary-tick-above}).
6053 @kindex M V m (Summary)
6054 @findex gnus-summary-mark-above
6055 Prompt for a mark, and mark all articles with scores over the default
6056 score (or over the numeric prefix) with this mark
6057 (@code{gnus-summary-clear-above}).
6060 @vindex gnus-summary-goto-unread
6061 The @code{gnus-summary-goto-unread} variable controls what action should
6062 be taken after setting a mark. If non-@code{nil}, point will move to
6063 the next/previous unread article. If @code{nil}, point will just move
6064 one line up or down. As a special case, if this variable is
6065 @code{never}, all the marking commands as well as other commands (like
6066 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6067 The default is @code{t}.
6070 @node Generic Marking Commands
6071 @subsection Generic Marking Commands
6073 Some people would like the command that ticks an article (@kbd{!}) go to
6074 the next article. Others would like it to go to the next unread
6075 article. Yet others would like it to stay on the current article. And
6076 even though I haven't heard of anybody wanting it to go to the
6077 previous (unread) article, I'm sure there are people that want that as
6080 Multiply these five behaviors with five different marking commands, and
6081 you get a potentially complex set of variable to control what each
6084 To sidestep that mess, Gnus provides commands that do all these
6085 different things. They can be found on the @kbd{M M} map in the summary
6086 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6087 to list in this manual.
6089 While you can use these commands directly, most users would prefer
6090 altering the summary mode keymap. For instance, if you would like the
6091 @kbd{!} command to go to the next article instead of the next unread
6092 article, you could say something like:
6096 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6097 (defun my-alter-summary-map ()
6098 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6106 (defun my-alter-summary-map ()
6107 (local-set-key "!" "MM!n"))
6111 @node Setting Process Marks
6112 @subsection Setting Process Marks
6113 @cindex setting process marks
6115 Process marks are displayed as @code{#} in the summary buffer, and are
6116 used for marking articles in such a way that other commands will
6117 process these articles. For instance, if you process mark four
6118 articles and then use the @kbd{*} command, Gnus will enter these four
6119 commands into the cache. For more information,
6120 @pxref{Process/Prefix}.
6127 @kindex M P p (Summary)
6128 @findex gnus-summary-mark-as-processable
6129 Mark the current article with the process mark
6130 (@code{gnus-summary-mark-as-processable}).
6131 @findex gnus-summary-unmark-as-processable
6135 @kindex M P u (Summary)
6136 @kindex M-# (Summary)
6137 Remove the process mark, if any, from the current article
6138 (@code{gnus-summary-unmark-as-processable}).
6141 @kindex M P U (Summary)
6142 @findex gnus-summary-unmark-all-processable
6143 Remove the process mark from all articles
6144 (@code{gnus-summary-unmark-all-processable}).
6147 @kindex M P i (Summary)
6148 @findex gnus-uu-invert-processable
6149 Invert the list of process marked articles
6150 (@code{gnus-uu-invert-processable}).
6153 @kindex M P R (Summary)
6154 @findex gnus-uu-mark-by-regexp
6155 Mark articles that have a @code{Subject} header that matches a regular
6156 expression (@code{gnus-uu-mark-by-regexp}).
6159 @kindex M P G (Summary)
6160 @findex gnus-uu-unmark-by-regexp
6161 Unmark articles that have a @code{Subject} header that matches a regular
6162 expression (@code{gnus-uu-unmark-by-regexp}).
6165 @kindex M P r (Summary)
6166 @findex gnus-uu-mark-region
6167 Mark articles in region (@code{gnus-uu-mark-region}).
6170 @kindex M P g (Summary)
6171 @findex gnus-uu-unmark-region
6172 Unmark articles in region (@code{gnus-uu-unmark-region}).
6175 @kindex M P t (Summary)
6176 @findex gnus-uu-mark-thread
6177 Mark all articles in the current (sub)thread
6178 (@code{gnus-uu-mark-thread}).
6181 @kindex M P T (Summary)
6182 @findex gnus-uu-unmark-thread
6183 Unmark all articles in the current (sub)thread
6184 (@code{gnus-uu-unmark-thread}).
6187 @kindex M P v (Summary)
6188 @findex gnus-uu-mark-over
6189 Mark all articles that have a score above the prefix argument
6190 (@code{gnus-uu-mark-over}).
6193 @kindex M P s (Summary)
6194 @findex gnus-uu-mark-series
6195 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6198 @kindex M P S (Summary)
6199 @findex gnus-uu-mark-sparse
6200 Mark all series that have already had some articles marked
6201 (@code{gnus-uu-mark-sparse}).
6204 @kindex M P a (Summary)
6205 @findex gnus-uu-mark-all
6206 Mark all articles in series order (@code{gnus-uu-mark-all}).
6209 @kindex M P b (Summary)
6210 @findex gnus-uu-mark-buffer
6211 Mark all articles in the buffer in the order they appear
6212 (@code{gnus-uu-mark-buffer}).
6215 @kindex M P k (Summary)
6216 @findex gnus-summary-kill-process-mark
6217 Push the current process mark set onto the stack and unmark all articles
6218 (@code{gnus-summary-kill-process-mark}).
6221 @kindex M P y (Summary)
6222 @findex gnus-summary-yank-process-mark
6223 Pop the previous process mark set from the stack and restore it
6224 (@code{gnus-summary-yank-process-mark}).
6227 @kindex M P w (Summary)
6228 @findex gnus-summary-save-process-mark
6229 Push the current process mark set onto the stack
6230 (@code{gnus-summary-save-process-mark}).
6234 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6235 set process marks based on article body contents.
6242 It can be convenient to limit the summary buffer to just show some
6243 subset of the articles currently in the group. The effect most limit
6244 commands have is to remove a few (or many) articles from the summary
6247 All limiting commands work on subsets of the articles already fetched
6248 from the servers. None of these commands query the server for
6249 additional articles.
6255 @kindex / / (Summary)
6256 @findex gnus-summary-limit-to-subject
6257 Limit the summary buffer to articles that match some subject
6258 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6262 @kindex / a (Summary)
6263 @findex gnus-summary-limit-to-author
6264 Limit the summary buffer to articles that match some author
6265 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6269 @kindex / x (Summary)
6270 @findex gnus-summary-limit-to-extra
6271 Limit the summary buffer to articles that match one of the ``extra''
6272 headers (@pxref{To From Newsgroups})
6273 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6278 @kindex / u (Summary)
6280 @findex gnus-summary-limit-to-unread
6281 Limit the summary buffer to articles not marked as read
6282 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6283 buffer to articles strictly unread. This means that ticked and
6284 dormant articles will also be excluded.
6287 @kindex / m (Summary)
6288 @findex gnus-summary-limit-to-marks
6289 Ask for a mark and then limit to all articles that have been marked
6290 with that mark (@code{gnus-summary-limit-to-marks}).
6293 @kindex / t (Summary)
6294 @findex gnus-summary-limit-to-age
6295 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6296 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6297 articles younger than that number of days.
6300 @kindex / n (Summary)
6301 @findex gnus-summary-limit-to-articles
6302 Limit the summary buffer to the current article
6303 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
6304 convention (@pxref{Process/Prefix}).
6307 @kindex / w (Summary)
6308 @findex gnus-summary-pop-limit
6309 Pop the previous limit off the stack and restore it
6310 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6314 @kindex / . (Summary)
6315 @findex gnus-summary-limit-to-unseen
6316 Limit the summary buffer to the unseen articles
6317 (@code{gnus-summary-limit-to-unseen}).
6320 @kindex / v (Summary)
6321 @findex gnus-summary-limit-to-score
6322 Limit the summary buffer to articles that have a score at or above some
6323 score (@code{gnus-summary-limit-to-score}).
6326 @kindex / p (Summary)
6327 @findex gnus-summary-limit-to-display-predicate
6328 Limit the summary buffer to articles that satisfy the @code{display}
6329 group parameter predicate
6330 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6331 Parameters}, for more on this predicate.
6334 @kindex / r (Summary)
6335 @findex gnus-summary-limit-to-replied
6336 Limit the summary buffer to replied articles
6337 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6342 @kindex M S (Summary)
6343 @kindex / E (Summary)
6344 @findex gnus-summary-limit-include-expunged
6345 Include all expunged articles in the limit
6346 (@code{gnus-summary-limit-include-expunged}).
6349 @kindex / D (Summary)
6350 @findex gnus-summary-limit-include-dormant
6351 Include all dormant articles in the limit
6352 (@code{gnus-summary-limit-include-dormant}).
6355 @kindex / * (Summary)
6356 @findex gnus-summary-limit-include-cached
6357 Include all cached articles in the limit
6358 (@code{gnus-summary-limit-include-cached}).
6361 @kindex / d (Summary)
6362 @findex gnus-summary-limit-exclude-dormant
6363 Exclude all dormant articles from the limit
6364 (@code{gnus-summary-limit-exclude-dormant}).
6367 @kindex / M (Summary)
6368 @findex gnus-summary-limit-exclude-marks
6369 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6372 @kindex / T (Summary)
6373 @findex gnus-summary-limit-include-thread
6374 Include all the articles in the current thread in the limit.
6377 @kindex / c (Summary)
6378 @findex gnus-summary-limit-exclude-childless-dormant
6379 Exclude all dormant articles that have no children from the limit@*
6380 (@code{gnus-summary-limit-exclude-childless-dormant}).
6383 @kindex / C (Summary)
6384 @findex gnus-summary-limit-mark-excluded-as-read
6385 Mark all excluded unread articles as read
6386 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6387 also mark excluded ticked and dormant articles as read.
6390 @kindex / N (Summary)
6391 @findex gnus-summary-insert-new-articles
6392 Insert all new articles in the summary buffer. It scans for new emails
6393 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6396 @kindex / o (Summary)
6397 @findex gnus-summary-insert-old-articles
6398 Insert all old articles in the summary buffer. If given a numbered
6399 prefix, fetch this number of articles.
6407 @cindex article threading
6409 Gnus threads articles by default. @dfn{To thread} is to put responses
6410 to articles directly after the articles they respond to---in a
6411 hierarchical fashion.
6413 Threading is done by looking at the @code{References} headers of the
6414 articles. In a perfect world, this would be enough to build pretty
6415 trees, but unfortunately, the @code{References} header is often broken
6416 or simply missing. Weird news propagation exacerbates the problem,
6417 so one has to employ other heuristics to get pleasing results. A
6418 plethora of approaches exists, as detailed in horrible detail in
6419 @ref{Customizing Threading}.
6421 First, a quick overview of the concepts:
6425 The top-most article in a thread; the first article in the thread.
6428 A tree-like article structure.
6431 A small(er) section of this tree-like structure.
6434 Threads often lose their roots due to article expiry, or due to the root
6435 already having been read in a previous session, and not displayed in the
6436 summary buffer. We then typically have many sub-threads that really
6437 belong to one thread, but are without connecting roots. These are
6438 called loose threads.
6440 @item thread gathering
6441 An attempt to gather loose threads into bigger threads.
6443 @item sparse threads
6444 A thread where the missing articles have been ``guessed'' at, and are
6445 displayed as empty lines in the summary buffer.
6451 * Customizing Threading:: Variables you can change to affect the threading.
6452 * Thread Commands:: Thread based commands in the summary buffer.
6456 @node Customizing Threading
6457 @subsection Customizing Threading
6458 @cindex customizing threading
6461 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6462 * Filling In Threads:: Making the threads displayed look fuller.
6463 * More Threading:: Even more variables for fiddling with threads.
6464 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6469 @subsubsection Loose Threads
6472 @cindex loose threads
6475 @item gnus-summary-make-false-root
6476 @vindex gnus-summary-make-false-root
6477 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
6478 and create a dummy root at the top. (Wait a minute. Root at the top?
6479 Yup.) Loose subtrees occur when the real root has expired, or you've
6480 read or killed the root in a previous session.
6482 When there is no real root of a thread, gnus will have to fudge
6483 something. This variable says what fudging method gnus should use.
6484 There are four possible values:
6488 \gnusfigure{The Summary Buffer}{390}{
6489 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6490 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6491 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6492 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6497 @cindex adopting articles
6502 Gnus will make the first of the orphaned articles the parent. This
6503 parent will adopt all the other articles. The adopted articles will be
6504 marked as such by pointy brackets (@samp{<>}) instead of the standard
6505 square brackets (@samp{[]}). This is the default method.
6508 @vindex gnus-summary-dummy-line-format
6509 @vindex gnus-summary-make-false-root-always
6510 Gnus will create a dummy summary line that will pretend to be the
6511 parent. This dummy line does not correspond to any real article, so
6512 selecting it will just select the first real article after the dummy
6513 article. @code{gnus-summary-dummy-line-format} is used to specify the
6514 format of the dummy roots. It accepts only one format spec: @samp{S},
6515 which is the subject of the article. @xref{Formatting Variables}.
6516 If you want all threads to have a dummy root, even the non-gathered
6517 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6520 Gnus won't actually make any article the parent, but simply leave the
6521 subject field of all orphans except the first empty. (Actually, it will
6522 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6526 Don't make any article parent at all. Just gather the threads and
6527 display them after one another.
6530 Don't gather loose threads.
6533 @item gnus-summary-gather-subject-limit
6534 @vindex gnus-summary-gather-subject-limit
6535 Loose threads are gathered by comparing subjects of articles. If this
6536 variable is @code{nil}, gnus requires an exact match between the
6537 subjects of the loose threads before gathering them into one big
6538 super-thread. This might be too strict a requirement, what with the
6539 presence of stupid newsreaders that chop off long subject lines. If
6540 you think so, set this variable to, say, 20 to require that only the
6541 first 20 characters of the subjects have to match. If you set this
6542 variable to a really low number, you'll find that gnus will gather
6543 everything in sight into one thread, which isn't very helpful.
6545 @cindex fuzzy article gathering
6546 If you set this variable to the special value @code{fuzzy}, gnus will
6547 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6550 @item gnus-simplify-subject-fuzzy-regexp
6551 @vindex gnus-simplify-subject-fuzzy-regexp
6552 This can either be a regular expression or list of regular expressions
6553 that match strings that will be removed from subjects if fuzzy subject
6554 simplification is used.
6556 @item gnus-simplify-ignored-prefixes
6557 @vindex gnus-simplify-ignored-prefixes
6558 If you set @code{gnus-summary-gather-subject-limit} to something as low
6559 as 10, you might consider setting this variable to something sensible:
6561 @c Written by Michael Ernst <mernst@cs.rice.edu>
6563 (setq gnus-simplify-ignored-prefixes
6569 "wanted" "followup" "summary\\( of\\)?"
6570 "help" "query" "problem" "question"
6571 "answer" "reference" "announce"
6572 "How can I" "How to" "Comparison of"
6577 (mapconcat 'identity
6578 '("for" "for reference" "with" "about")
6580 "\\)?\\]?:?[ \t]*"))
6583 All words that match this regexp will be removed before comparing two
6586 @item gnus-simplify-subject-functions
6587 @vindex gnus-simplify-subject-functions
6588 If non-@code{nil}, this variable overrides
6589 @code{gnus-summary-gather-subject-limit}. This variable should be a
6590 list of functions to apply to the @code{Subject} string iteratively to
6591 arrive at the simplified version of the string.
6593 Useful functions to put in this list include:
6596 @item gnus-simplify-subject-re
6597 @findex gnus-simplify-subject-re
6598 Strip the leading @samp{Re:}.
6600 @item gnus-simplify-subject-fuzzy
6601 @findex gnus-simplify-subject-fuzzy
6604 @item gnus-simplify-whitespace
6605 @findex gnus-simplify-whitespace
6606 Remove excessive whitespace.
6608 @item gnus-simplify-all-whitespace
6609 @findex gnus-simplify-all-whitespace
6610 Remove all whitespace.
6613 You may also write your own functions, of course.
6616 @item gnus-summary-gather-exclude-subject
6617 @vindex gnus-summary-gather-exclude-subject
6618 Since loose thread gathering is done on subjects only, that might lead
6619 to many false hits, especially with certain common subjects like
6620 @samp{} and @samp{(none)}. To make the situation slightly better,
6621 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6622 what subjects should be excluded from the gathering process.@*
6623 The default is @samp{^ *$\\|^(none)$}.
6625 @item gnus-summary-thread-gathering-function
6626 @vindex gnus-summary-thread-gathering-function
6627 Gnus gathers threads by looking at @code{Subject} headers. This means
6628 that totally unrelated articles may end up in the same ``thread'', which
6629 is confusing. An alternate approach is to look at all the
6630 @code{Message-ID}s in all the @code{References} headers to find matches.
6631 This will ensure that no gathered threads ever include unrelated
6632 articles, but it also means that people who have posted with broken
6633 newsreaders won't be gathered properly. The choice is yours---plague or
6637 @item gnus-gather-threads-by-subject
6638 @findex gnus-gather-threads-by-subject
6639 This function is the default gathering function and looks at
6640 @code{Subject}s exclusively.
6642 @item gnus-gather-threads-by-references
6643 @findex gnus-gather-threads-by-references
6644 This function looks at @code{References} headers exclusively.
6647 If you want to test gathering by @code{References}, you could say
6651 (setq gnus-summary-thread-gathering-function
6652 'gnus-gather-threads-by-references)
6658 @node Filling In Threads
6659 @subsubsection Filling In Threads
6662 @item gnus-fetch-old-headers
6663 @vindex gnus-fetch-old-headers
6664 If non-@code{nil}, gnus will attempt to build old threads by fetching
6665 more old headers---headers to articles marked as read. If you would
6666 like to display as few summary lines as possible, but still connect as
6667 many loose threads as possible, you should set this variable to
6668 @code{some} or a number. If you set it to a number, no more than that
6669 number of extra old headers will be fetched. In either case, fetching
6670 old headers only works if the back end you are using carries overview
6671 files---this would normally be @code{nntp}, @code{nnspool},
6672 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
6673 the thread has been expired by the server, there's not much Gnus can
6676 This variable can also be set to @code{invisible}. This won't have any
6677 visible effects, but is useful if you use the @kbd{A T} command a lot
6678 (@pxref{Finding the Parent}).
6680 @item gnus-fetch-old-ephemeral-headers
6681 @vindex gnus-fetch-old-ephemeral-headers
6682 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
6685 @item gnus-build-sparse-threads
6686 @vindex gnus-build-sparse-threads
6687 Fetching old headers can be slow. A low-rent similar effect can be
6688 gotten by setting this variable to @code{some}. Gnus will then look at
6689 the complete @code{References} headers of all articles and try to string
6690 together articles that belong in the same thread. This will leave
6691 @dfn{gaps} in the threading display where gnus guesses that an article
6692 is missing from the thread. (These gaps appear like normal summary
6693 lines. If you select a gap, gnus will try to fetch the article in
6694 question.) If this variable is @code{t}, gnus will display all these
6695 ``gaps'' without regard for whether they are useful for completing the
6696 thread or not. Finally, if this variable is @code{more}, gnus won't cut
6697 off sparse leaf nodes that don't lead anywhere. This variable is
6698 @code{nil} by default.
6700 @item gnus-read-all-available-headers
6701 @vindex gnus-read-all-available-headers
6702 This is a rather obscure variable that few will find useful. It's
6703 intended for those non-news newsgroups where the back end has to fetch
6704 quite a lot to present the summary buffer, and where it's impossible to
6705 go back to parents of articles. This is mostly the case in the
6706 web-based groups, like the @code{nnultimate} groups.
6708 If you don't use those, then it's safe to leave this as the default
6709 @code{nil}. If you want to use this variable, it should be a regexp
6710 that matches the group name, or @code{t} for all groups.
6715 @node More Threading
6716 @subsubsection More Threading
6719 @item gnus-show-threads
6720 @vindex gnus-show-threads
6721 If this variable is @code{nil}, no threading will be done, and all of
6722 the rest of the variables here will have no effect. Turning threading
6723 off will speed group selection up a bit, but it is sure to make reading
6724 slower and more awkward.
6726 @item gnus-thread-hide-subtree
6727 @vindex gnus-thread-hide-subtree
6728 If non-@code{nil}, all threads will be hidden when the summary buffer is
6731 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6732 Available predicates are @code{gnus-article-unread-p} and
6733 @code{gnus-article-unseen-p}.
6738 (setq gnus-thread-hide-subtree
6739 '(or gnus-article-unread-p
6740 gnus-article-unseen-p))
6743 (It's a pretty nonsensical example, since all unseen articles are also
6744 unread, but you get my drift.)
6747 @item gnus-thread-expunge-below
6748 @vindex gnus-thread-expunge-below
6749 All threads that have a total score (as defined by
6750 @code{gnus-thread-score-function}) less than this number will be
6751 expunged. This variable is @code{nil} by default, which means that no
6752 threads are expunged.
6754 @item gnus-thread-hide-killed
6755 @vindex gnus-thread-hide-killed
6756 if you kill a thread and this variable is non-@code{nil}, the subtree
6759 @item gnus-thread-ignore-subject
6760 @vindex gnus-thread-ignore-subject
6761 Sometimes somebody changes the subject in the middle of a thread. If
6762 this variable is non-@code{nil}, which is the default, the subject
6763 change is ignored. If it is @code{nil}, a change in the subject will
6764 result in a new thread.
6766 @item gnus-thread-indent-level
6767 @vindex gnus-thread-indent-level
6768 This is a number that says how much each sub-thread should be indented.
6771 @item gnus-sort-gathered-threads-function
6772 @vindex gnus-sort-gathered-threads-function
6773 Sometimes, particularly with mailing lists, the order in which mails
6774 arrive locally is not necessarily the same as the order in which they
6775 arrived on the mailing list. Consequently, when sorting sub-threads
6776 using the default @code{gnus-thread-sort-by-number}, responses can end
6777 up appearing before the article to which they are responding to.
6778 Setting this variable to an alternate value
6779 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6780 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6781 more logical sub-thread ordering in such instances.
6786 @node Low-Level Threading
6787 @subsubsection Low-Level Threading
6791 @item gnus-parse-headers-hook
6792 @vindex gnus-parse-headers-hook
6793 Hook run before parsing any headers. The default value is
6794 @code{(gnus-set-summary-default-charset)}, which sets up local value of
6795 @code{default-mime-charset} in summary buffer based on variable
6796 @code{gnus-newsgroup-default-charset-alist}.
6798 @item gnus-alter-header-function
6799 @vindex gnus-alter-header-function
6800 If non-@code{nil}, this function will be called to allow alteration of
6801 article header structures. The function is called with one parameter,
6802 the article header vector, which it may alter in any way. For instance,
6803 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6804 in systematic ways (by adding prefixes and such), you can use this
6805 variable to un-scramble the @code{Message-ID}s so that they are more
6806 meaningful. Here's one example:
6809 (setq gnus-alter-header-function 'my-alter-message-id)
6811 (defun my-alter-message-id (header)
6812 (let ((id (mail-header-id header)))
6814 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6816 (concat (match-string 1 id) "@@" (match-string 2 id))
6823 @node Thread Commands
6824 @subsection Thread Commands
6825 @cindex thread commands
6831 @kindex T k (Summary)
6832 @kindex C-M-k (Summary)
6833 @findex gnus-summary-kill-thread
6834 Mark all articles in the current (sub-)thread as read
6835 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
6836 remove all marks instead. If the prefix argument is negative, tick
6841 @kindex T l (Summary)
6842 @kindex C-M-l (Summary)
6843 @findex gnus-summary-lower-thread
6844 Lower the score of the current (sub-)thread
6845 (@code{gnus-summary-lower-thread}).
6848 @kindex T i (Summary)
6849 @findex gnus-summary-raise-thread
6850 Increase the score of the current (sub-)thread
6851 (@code{gnus-summary-raise-thread}).
6854 @kindex T # (Summary)
6855 @findex gnus-uu-mark-thread
6856 Set the process mark on the current (sub-)thread
6857 (@code{gnus-uu-mark-thread}).
6860 @kindex T M-# (Summary)
6861 @findex gnus-uu-unmark-thread
6862 Remove the process mark from the current (sub-)thread
6863 (@code{gnus-uu-unmark-thread}).
6866 @kindex T T (Summary)
6867 @findex gnus-summary-toggle-threads
6868 Toggle threading (@code{gnus-summary-toggle-threads}).
6871 @kindex T s (Summary)
6872 @findex gnus-summary-show-thread
6873 Expose the (sub-)thread hidden under the current article, if any@*
6874 (@code{gnus-summary-show-thread}).
6877 @kindex T h (Summary)
6878 @findex gnus-summary-hide-thread
6879 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6882 @kindex T S (Summary)
6883 @findex gnus-summary-show-all-threads
6884 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6887 @kindex T H (Summary)
6888 @findex gnus-summary-hide-all-threads
6889 Hide all threads (@code{gnus-summary-hide-all-threads}).
6892 @kindex T t (Summary)
6893 @findex gnus-summary-rethread-current
6894 Re-thread the current article's thread
6895 (@code{gnus-summary-rethread-current}). This works even when the
6896 summary buffer is otherwise unthreaded.
6899 @kindex T ^ (Summary)
6900 @findex gnus-summary-reparent-thread
6901 Make the current article the child of the marked (or previous) article
6902 (@code{gnus-summary-reparent-thread}).
6906 The following commands are thread movement commands. They all
6907 understand the numeric prefix.
6912 @kindex T n (Summary)
6914 @kindex C-M-n (Summary)
6916 @kindex M-down (Summary)
6917 @findex gnus-summary-next-thread
6918 Go to the next thread (@code{gnus-summary-next-thread}).
6921 @kindex T p (Summary)
6923 @kindex C-M-p (Summary)
6925 @kindex M-up (Summary)
6926 @findex gnus-summary-prev-thread
6927 Go to the previous thread (@code{gnus-summary-prev-thread}).
6930 @kindex T d (Summary)
6931 @findex gnus-summary-down-thread
6932 Descend the thread (@code{gnus-summary-down-thread}).
6935 @kindex T u (Summary)
6936 @findex gnus-summary-up-thread
6937 Ascend the thread (@code{gnus-summary-up-thread}).
6940 @kindex T o (Summary)
6941 @findex gnus-summary-top-thread
6942 Go to the top of the thread (@code{gnus-summary-top-thread}).
6945 @vindex gnus-thread-operation-ignore-subject
6946 If you ignore subject while threading, you'll naturally end up with
6947 threads that have several different subjects in them. If you then issue
6948 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
6949 wish to kill the entire thread, but just those parts of the thread that
6950 have the same subject as the current article. If you like this idea,
6951 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6952 is non-@code{nil} (which it is by default), subjects will be ignored
6953 when doing thread commands. If this variable is @code{nil}, articles in
6954 the same thread with different subjects will not be included in the
6955 operation in question. If this variable is @code{fuzzy}, only articles
6956 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6960 @node Sorting the Summary Buffer
6961 @section Sorting the Summary Buffer
6963 @findex gnus-thread-sort-by-total-score
6964 @findex gnus-thread-sort-by-date
6965 @findex gnus-thread-sort-by-score
6966 @findex gnus-thread-sort-by-subject
6967 @findex gnus-thread-sort-by-author
6968 @findex gnus-thread-sort-by-number
6969 @findex gnus-thread-sort-by-random
6970 @vindex gnus-thread-sort-functions
6971 @findex gnus-thread-sort-by-most-recent-number
6972 @findex gnus-thread-sort-by-most-recent-date
6973 If you are using a threaded summary display, you can sort the threads by
6974 setting @code{gnus-thread-sort-functions}, which can be either a single
6975 function, a list of functions, or a list containing functions and
6976 @code{(not some-function)} elements.
6978 By default, sorting is done on article numbers. Ready-made sorting
6979 predicate functions include @code{gnus-thread-sort-by-number},
6980 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6981 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score},
6982 @code{gnus-thread-sort-by-most-recent-number},
6983 @code{gnus-thread-sort-by-most-recent-date},
6984 @code{gnus-thread-sort-by-random} and
6985 @code{gnus-thread-sort-by-total-score}.
6987 Each function takes two threads and returns non-@code{nil} if the first
6988 thread should be sorted before the other. Note that sorting really is
6989 normally done by looking only at the roots of each thread.
6991 If you use more than one function, the primary sort key should be the
6992 last function in the list. You should probably always include
6993 @code{gnus-thread-sort-by-number} in the list of sorting
6994 functions---preferably first. This will ensure that threads that are
6995 equal with respect to the other sort criteria will be displayed in
6996 ascending article order.
6998 If you would like to sort by reverse score, then by subject, and finally
6999 by number, you could do something like:
7002 (setq gnus-thread-sort-functions
7003 '(gnus-thread-sort-by-number
7004 gnus-thread-sort-by-subject
7005 (not gnus-thread-sort-by-total-score)))
7008 The threads that have highest score will be displayed first in the
7009 summary buffer. When threads have the same score, they will be sorted
7010 alphabetically. The threads that have the same score and the same
7011 subject will be sorted by number, which is (normally) the sequence in
7012 which the articles arrived.
7014 If you want to sort by score and then reverse arrival order, you could
7018 (setq gnus-thread-sort-functions
7020 (not (gnus-thread-sort-by-number t1 t2)))
7021 gnus-thread-sort-by-score))
7024 @vindex gnus-thread-score-function
7025 The function in the @code{gnus-thread-score-function} variable (default
7026 @code{+}) is used for calculating the total score of a thread. Useful
7027 functions might be @code{max}, @code{min}, or squared means, or whatever
7030 @findex gnus-article-sort-functions
7031 @findex gnus-article-sort-by-date
7032 @findex gnus-article-sort-by-score
7033 @findex gnus-article-sort-by-subject
7034 @findex gnus-article-sort-by-author
7035 @findex gnus-article-sort-by-random
7036 @findex gnus-article-sort-by-number
7037 If you are using an unthreaded display for some strange reason or
7038 other, you have to fiddle with the @code{gnus-article-sort-functions}
7039 variable. It is very similar to the
7040 @code{gnus-thread-sort-functions}, except that it uses slightly
7041 different functions for article comparison. Available sorting
7042 predicate functions are @code{gnus-article-sort-by-number},
7043 @code{gnus-article-sort-by-author},
7044 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7045 @code{gnus-article-sort-by-random}, and
7046 @code{gnus-article-sort-by-score}.
7048 If you want to sort an unthreaded summary display by subject, you could
7052 (setq gnus-article-sort-functions
7053 '(gnus-article-sort-by-number
7054 gnus-article-sort-by-subject))
7059 @node Asynchronous Fetching
7060 @section Asynchronous Article Fetching
7061 @cindex asynchronous article fetching
7062 @cindex article pre-fetch
7065 If you read your news from an @acronym{NNTP} server that's far away, the
7066 network latencies may make reading articles a chore. You have to wait
7067 for a while after pressing @kbd{n} to go to the next article before the
7068 article appears. Why can't gnus just go ahead and fetch the article
7069 while you are reading the previous one? Why not, indeed.
7071 First, some caveats. There are some pitfalls to using asynchronous
7072 article fetching, especially the way gnus does it.
7074 Let's say you are reading article 1, which is short, and article 2 is
7075 quite long, and you are not interested in reading that. Gnus does not
7076 know this, so it goes ahead and fetches article 2. You decide to read
7077 article 3, but since gnus is in the process of fetching article 2, the
7078 connection is blocked.
7080 To avoid these situations, gnus will open two (count 'em two)
7081 connections to the server. Some people may think this isn't a very nice
7082 thing to do, but I don't see any real alternatives. Setting up that
7083 extra connection takes some time, so gnus startup will be slower.
7085 Gnus will fetch more articles than you will read. This will mean that
7086 the link between your machine and the @acronym{NNTP} server will become more
7087 loaded than if you didn't use article pre-fetch. The server itself will
7088 also become more loaded---both with the extra article requests, and the
7091 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7094 @vindex gnus-asynchronous
7095 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7096 happen automatically.
7098 @vindex gnus-use-article-prefetch
7099 You can control how many articles are to be pre-fetched by setting
7100 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7101 that when you read an article in the group, the back end will pre-fetch
7102 the next 30 articles. If this variable is @code{t}, the back end will
7103 pre-fetch all the articles it can without bound. If it is
7104 @code{nil}, no pre-fetching will be done.
7106 @vindex gnus-async-prefetch-article-p
7107 @findex gnus-async-read-p
7108 There are probably some articles that you don't want to pre-fetch---read
7109 articles, for instance. The @code{gnus-async-prefetch-article-p}
7110 variable controls whether an article is to be pre-fetched. This
7111 function should return non-@code{nil} when the article in question is
7112 to be pre-fetched. The default is @code{gnus-async-read-p}, which
7113 returns @code{nil} on read articles. The function is called with an
7114 article data structure as the only parameter.
7116 If, for instance, you wish to pre-fetch only unread articles shorter
7117 than 100 lines, you could say something like:
7120 (defun my-async-short-unread-p (data)
7121 "Return non-nil for short, unread articles."
7122 (and (gnus-data-unread-p data)
7123 (< (mail-header-lines (gnus-data-header data))
7126 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7129 These functions will be called many, many times, so they should
7130 preferably be short and sweet to avoid slowing down gnus too much.
7131 It's probably a good idea to byte-compile things like this.
7133 @vindex gnus-prefetched-article-deletion-strategy
7134 Articles have to be removed from the asynch buffer sooner or later. The
7135 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7136 articles. This is a list that may contain the following elements:
7140 Remove articles when they are read.
7143 Remove articles when exiting the group.
7146 The default value is @code{(read exit)}.
7148 @c @vindex gnus-use-header-prefetch
7149 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7150 @c from the next group.
7153 @node Article Caching
7154 @section Article Caching
7155 @cindex article caching
7158 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7159 consider turning article caching on. Each article will then be stored
7160 locally under your home directory. As you may surmise, this could
7161 potentially use @emph{huge} amounts of disk space, as well as eat up all
7162 your inodes so fast it will make your head swim. In vodka.
7164 Used carefully, though, it could be just an easier way to save articles.
7166 @vindex gnus-use-long-file-name
7167 @vindex gnus-cache-directory
7168 @vindex gnus-use-cache
7169 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7170 all articles ticked or marked as dormant will then be copied
7171 over to your local cache (@code{gnus-cache-directory}). Whether this
7172 cache is flat or hierarchical is controlled by the
7173 @code{gnus-use-long-file-name} variable, as usual.
7175 When re-selecting a ticked or dormant article, it will be fetched from the
7176 cache instead of from the server. As articles in your cache will never
7177 expire, this might serve as a method of saving articles while still
7178 keeping them where they belong. Just mark all articles you want to save
7179 as dormant, and don't worry.
7181 When an article is marked as read, is it removed from the cache.
7183 @vindex gnus-cache-remove-articles
7184 @vindex gnus-cache-enter-articles
7185 The entering/removal of articles from the cache is controlled by the
7186 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7187 variables. Both are lists of symbols. The first is @code{(ticked
7188 dormant)} by default, meaning that ticked and dormant articles will be
7189 put in the cache. The latter is @code{(read)} by default, meaning that
7190 articles marked as read are removed from the cache. Possibly
7191 symbols in these two lists are @code{ticked}, @code{dormant},
7192 @code{unread} and @code{read}.
7194 @findex gnus-jog-cache
7195 So where does the massive article-fetching and storing come into the
7196 picture? The @code{gnus-jog-cache} command will go through all
7197 subscribed newsgroups, request all unread articles, score them, and
7198 store them in the cache. You should only ever, ever ever ever, use this
7199 command if 1) your connection to the @acronym{NNTP} server is really, really,
7200 really slow and 2) you have a really, really, really huge disk.
7201 Seriously. One way to cut down on the number of articles downloaded is
7202 to score unwanted articles down and have them marked as read. They will
7203 not then be downloaded by this command.
7205 @vindex gnus-uncacheable-groups
7206 @vindex gnus-cacheable-groups
7207 It is likely that you do not want caching on all groups. For instance,
7208 if your @code{nnml} mail is located under your home directory, it makes no
7209 sense to cache it somewhere else under your home directory. Unless you
7210 feel that it's neat to use twice as much space.
7212 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7213 regexp of groups to cache, @samp{^nntp} for instance, or set the
7214 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7215 Both variables are @code{nil} by default. If a group matches both
7216 variables, the group is not cached.
7218 @findex gnus-cache-generate-nov-databases
7219 @findex gnus-cache-generate-active
7220 @vindex gnus-cache-active-file
7221 The cache stores information on what articles it contains in its active
7222 file (@code{gnus-cache-active-file}). If this file (or any other parts
7223 of the cache) becomes all messed up for some reason or other, gnus
7224 offers two functions that will try to set things right. @kbd{M-x
7225 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7226 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7229 @findex gnus-cache-move-cache
7230 @code{gnus-cache-move-cache} will move your whole
7231 @code{gnus-cache-directory} to some other location. You get asked to
7232 where, isn't that cool?
7234 @node Persistent Articles
7235 @section Persistent Articles
7236 @cindex persistent articles
7238 Closely related to article caching, we have @dfn{persistent articles}.
7239 In fact, it's just a different way of looking at caching, and much more
7240 useful in my opinion.
7242 Say you're reading a newsgroup, and you happen on to some valuable gem
7243 that you want to keep and treasure forever. You'd normally just save it
7244 (using one of the many saving commands) in some file. The problem with
7245 that is that it's just, well, yucky. Ideally you'd prefer just having
7246 the article remain in the group where you found it forever; untouched by
7247 the expiry going on at the news server.
7249 This is what a @dfn{persistent article} is---an article that just won't
7250 be deleted. It's implemented using the normal cache functions, but
7251 you use two explicit commands for managing persistent articles:
7257 @findex gnus-cache-enter-article
7258 Make the current article persistent (@code{gnus-cache-enter-article}).
7261 @kindex M-* (Summary)
7262 @findex gnus-cache-remove-article
7263 Remove the current article from the persistent articles
7264 (@code{gnus-cache-remove-article}). This will normally delete the
7268 Both these commands understand the process/prefix convention.
7270 To avoid having all ticked articles (and stuff) entered into the cache,
7271 you should set @code{gnus-use-cache} to @code{passive} if you're just
7272 interested in persistent articles:
7275 (setq gnus-use-cache 'passive)
7279 @node Article Backlog
7280 @section Article Backlog
7282 @cindex article backlog
7284 If you have a slow connection, but the idea of using caching seems
7285 unappealing to you (and it is, really), you can help the situation some
7286 by switching on the @dfn{backlog}. This is where gnus will buffer
7287 already read articles so that it doesn't have to re-fetch articles
7288 you've already read. This only helps if you are in the habit of
7289 re-selecting articles you've recently read, of course. If you never do
7290 that, turning the backlog on will slow gnus down a little bit, and
7291 increase memory usage some.
7293 @vindex gnus-keep-backlog
7294 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
7295 at most @var{n} old articles in a buffer for later re-fetching. If this
7296 variable is non-@code{nil} and is not a number, gnus will store
7297 @emph{all} read articles, which means that your Emacs will grow without
7298 bound before exploding and taking your machine down with you. I put
7299 that in there just to keep y'all on your toes.
7301 The default value is 20.
7304 @node Saving Articles
7305 @section Saving Articles
7306 @cindex saving articles
7308 Gnus can save articles in a number of ways. Below is the documentation
7309 for saving articles in a fairly straight-forward fashion (i.e., little
7310 processing of the article is done before it is saved). For a different
7311 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7312 (@pxref{Decoding Articles}).
7314 For the commands listed here, the target is a file. If you want to
7315 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7316 command (@pxref{Mail Group Commands}).
7318 @vindex gnus-save-all-headers
7319 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
7320 unwanted headers before saving the article.
7322 @vindex gnus-saved-headers
7323 If the preceding variable is @code{nil}, all headers that match the
7324 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7325 deleted before saving.
7331 @kindex O o (Summary)
7333 @findex gnus-summary-save-article
7334 @c @icon{gnus-summary-save-article}
7335 Save the current article using the default article saver
7336 (@code{gnus-summary-save-article}).
7339 @kindex O m (Summary)
7340 @findex gnus-summary-save-article-mail
7341 Save the current article in mail format
7342 (@code{gnus-summary-save-article-mail}).
7345 @kindex O r (Summary)
7346 @findex gnus-summary-save-article-rmail
7347 Save the current article in Rmail format
7348 (@code{gnus-summary-save-article-rmail}).
7351 @kindex O f (Summary)
7352 @findex gnus-summary-save-article-file
7353 @c @icon{gnus-summary-save-article-file}
7354 Save the current article in plain file format
7355 (@code{gnus-summary-save-article-file}).
7358 @kindex O F (Summary)
7359 @findex gnus-summary-write-article-file
7360 Write the current article in plain file format, overwriting any previous
7361 file contents (@code{gnus-summary-write-article-file}).
7364 @kindex O b (Summary)
7365 @findex gnus-summary-save-article-body-file
7366 Save the current article body in plain file format
7367 (@code{gnus-summary-save-article-body-file}).
7370 @kindex O h (Summary)
7371 @findex gnus-summary-save-article-folder
7372 Save the current article in mh folder format
7373 (@code{gnus-summary-save-article-folder}).
7376 @kindex O v (Summary)
7377 @findex gnus-summary-save-article-vm
7378 Save the current article in a VM folder
7379 (@code{gnus-summary-save-article-vm}).
7383 @kindex O p (Summary)
7385 @findex gnus-summary-pipe-output
7386 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7387 the current article to a process (@code{gnus-summary-pipe-output}).
7388 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7389 complete headers in the piped output.
7392 @kindex O P (Summary)
7393 @findex gnus-summary-muttprint
7394 @vindex gnus-summary-muttprint-program
7395 Save the current article into muttprint. That is, print it using the
7396 external program @uref{http://muttprint.sourceforge.net/,
7397 Muttprint}. The program name and options to use is controlled by the
7398 variable @code{gnus-summary-muttprint-program}.
7399 (@code{gnus-summary-muttprint}).
7403 @vindex gnus-prompt-before-saving
7404 All these commands use the process/prefix convention
7405 (@pxref{Process/Prefix}). If you save bunches of articles using these
7406 functions, you might get tired of being prompted for files to save each
7407 and every article in. The prompting action is controlled by
7408 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7409 default, giving you that excessive prompting action you know and
7410 loathe. If you set this variable to @code{t} instead, you'll be prompted
7411 just once for each series of articles you save. If you like to really
7412 have Gnus do all your thinking for you, you can even set this variable
7413 to @code{nil}, which means that you will never be prompted for files to
7414 save articles in. Gnus will simply save all the articles in the default
7418 @vindex gnus-default-article-saver
7419 You can customize the @code{gnus-default-article-saver} variable to make
7420 gnus do what you want it to. You can use any of the six ready-made
7421 functions below, or you can create your own.
7425 @item gnus-summary-save-in-rmail
7426 @findex gnus-summary-save-in-rmail
7427 @vindex gnus-rmail-save-name
7428 @findex gnus-plain-save-name
7429 This is the default format, @dfn{Babyl}. Uses the function in the
7430 @code{gnus-rmail-save-name} variable to get a file name to save the
7431 article in. The default is @code{gnus-plain-save-name}.
7433 @item gnus-summary-save-in-mail
7434 @findex gnus-summary-save-in-mail
7435 @vindex gnus-mail-save-name
7436 Save in a Unix mail (mbox) file. Uses the function in the
7437 @code{gnus-mail-save-name} variable to get a file name to save the
7438 article in. The default is @code{gnus-plain-save-name}.
7440 @item gnus-summary-save-in-file
7441 @findex gnus-summary-save-in-file
7442 @vindex gnus-file-save-name
7443 @findex gnus-numeric-save-name
7444 Append the article straight to an ordinary file. Uses the function in
7445 the @code{gnus-file-save-name} variable to get a file name to save the
7446 article in. The default is @code{gnus-numeric-save-name}.
7448 @item gnus-summary-write-to-file
7449 @findex gnus-summary-write-to-file
7450 Write the article straight to an ordinary file. The file is
7451 overwritten if it exists. Uses the function in the
7452 @code{gnus-file-save-name} variable to get a file name to save the
7453 article in. The default is @code{gnus-numeric-save-name}.
7455 @item gnus-summary-save-body-in-file
7456 @findex gnus-summary-save-body-in-file
7457 Append the article body to an ordinary file. Uses the function in the
7458 @code{gnus-file-save-name} variable to get a file name to save the
7459 article in. The default is @code{gnus-numeric-save-name}.
7461 @item gnus-summary-save-in-folder
7462 @findex gnus-summary-save-in-folder
7463 @findex gnus-folder-save-name
7464 @findex gnus-Folder-save-name
7465 @vindex gnus-folder-save-name
7468 Save the article to an MH folder using @code{rcvstore} from the MH
7469 library. Uses the function in the @code{gnus-folder-save-name} variable
7470 to get a file name to save the article in. The default is
7471 @code{gnus-folder-save-name}, but you can also use
7472 @code{gnus-Folder-save-name}, which creates capitalized names.
7474 @item gnus-summary-save-in-vm
7475 @findex gnus-summary-save-in-vm
7476 Save the article in a VM folder. You have to have the VM mail
7477 reader to use this setting.
7480 @vindex gnus-article-save-directory
7481 All of these functions, except for the last one, will save the article
7482 in the @code{gnus-article-save-directory}, which is initialized from the
7483 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7486 As you can see above, the functions use different functions to find a
7487 suitable name of a file to save the article in. Below is a list of
7488 available functions that generate names:
7492 @item gnus-Numeric-save-name
7493 @findex gnus-Numeric-save-name
7494 File names like @file{~/News/Alt.andrea-dworkin/45}.
7496 @item gnus-numeric-save-name
7497 @findex gnus-numeric-save-name
7498 File names like @file{~/News/alt.andrea-dworkin/45}.
7500 @item gnus-Plain-save-name
7501 @findex gnus-Plain-save-name
7502 File names like @file{~/News/Alt.andrea-dworkin}.
7504 @item gnus-plain-save-name
7505 @findex gnus-plain-save-name
7506 File names like @file{~/News/alt.andrea-dworkin}.
7508 @item gnus-sender-save-name
7509 @findex gnus-sender-save-name
7510 File names like @file{~/News/larsi}.
7513 @vindex gnus-split-methods
7514 You can have gnus suggest where to save articles by plonking a regexp into
7515 the @code{gnus-split-methods} alist. For instance, if you would like to
7516 save articles related to gnus in the file @file{gnus-stuff}, and articles
7517 related to VM in @file{vm-stuff}, you could set this variable to something
7521 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7522 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7523 (my-choosing-function "../other-dir/my-stuff")
7524 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7527 We see that this is a list where each element is a list that has two
7528 elements---the @dfn{match} and the @dfn{file}. The match can either be
7529 a string (in which case it is used as a regexp to match on the article
7530 head); it can be a symbol (which will be called as a function with the
7531 group name as a parameter); or it can be a list (which will be
7532 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7533 the @dfn{file} will be used as a default prompt. In addition, the
7534 result of the operation itself will be used if the function or form
7535 called returns a string or a list of strings.
7537 You basically end up with a list of file names that might be used when
7538 saving the current article. (All ``matches'' will be used.) You will
7539 then be prompted for what you really want to use as a name, with file
7540 name completion over the results from applying this variable.
7542 This variable is @code{((gnus-article-archive-name))} by default, which
7543 means that gnus will look at the articles it saves for an
7544 @code{Archive-name} line and use that as a suggestion for the file
7547 Here's an example function to clean up file names somewhat. If you have
7548 lots of mail groups called things like
7549 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7550 these group names before creating the file name to save to. The
7551 following will do just that:
7554 (defun my-save-name (group)
7555 (when (string-match "^nnml:mail." group)
7556 (substring group (match-end 0))))
7558 (setq gnus-split-methods
7559 '((gnus-article-archive-name)
7564 @vindex gnus-use-long-file-name
7565 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7566 @code{nil}, all the preceding functions will replace all periods
7567 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7568 the functions will generate hierarchies of directories instead of having
7569 all the files in the top level directory
7570 (@file{~/News/alt/andrea-dworkin} instead of
7571 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7572 on most systems. However, for historical reasons, this is @code{nil} on
7573 Xenix and usg-unix-v machines by default.
7575 This function also affects kill and score file names. If this variable
7576 is a list, and the list contains the element @code{not-score}, long file
7577 names will not be used for score files, if it contains the element
7578 @code{not-save}, long file names will not be used for saving, and if it
7579 contains the element @code{not-kill}, long file names will not be used
7582 If you'd like to save articles in a hierarchy that looks something like
7586 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
7587 (setq gnus-default-article-saver
7588 'gnus-summary-save-in-file) ; @r{no encoding}
7591 Then just save with @kbd{o}. You'd then read this hierarchy with
7592 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7593 the top level directory as the argument (@file{~/News/}). Then just walk
7594 around to the groups/directories with @code{nneething}.
7597 @node Decoding Articles
7598 @section Decoding Articles
7599 @cindex decoding articles
7601 Sometime users post articles (or series of articles) that have been
7602 encoded in some way or other. Gnus can decode them for you.
7605 * Uuencoded Articles:: Uudecode articles.
7606 * Shell Archives:: Unshar articles.
7607 * PostScript Files:: Split PostScript.
7608 * Other Files:: Plain save and binhex.
7609 * Decoding Variables:: Variables for a happy decoding.
7610 * Viewing Files:: You want to look at the result of the decoding?
7614 @cindex article series
7615 All these functions use the process/prefix convention
7616 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7617 the extension that a ``single article'' means ``a single series''. Gnus
7618 can find out by itself what articles belong to a series, decode all the
7619 articles and unpack/view/save the resulting file(s).
7621 Gnus guesses what articles are in the series according to the following
7622 simplish rule: The subjects must be (nearly) identical, except for the
7623 last two numbers of the line. (Spaces are largely ignored, however.)
7625 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
7626 will find all the articles that match the regexp @samp{^cat.gif
7627 ([0-9]+/[0-9]+).*$}.
7629 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7630 series}, will not be properly recognized by any of the automatic viewing
7631 commands, and you have to mark the articles manually with @kbd{#}.
7634 @node Uuencoded Articles
7635 @subsection Uuencoded Articles
7637 @cindex uuencoded articles
7642 @kindex X u (Summary)
7643 @findex gnus-uu-decode-uu
7644 @c @icon{gnus-uu-decode-uu}
7645 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7648 @kindex X U (Summary)
7649 @findex gnus-uu-decode-uu-and-save
7650 Uudecodes and saves the current series
7651 (@code{gnus-uu-decode-uu-and-save}).
7654 @kindex X v u (Summary)
7655 @findex gnus-uu-decode-uu-view
7656 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7659 @kindex X v U (Summary)
7660 @findex gnus-uu-decode-uu-and-save-view
7661 Uudecodes, views and saves the current series
7662 (@code{gnus-uu-decode-uu-and-save-view}).
7666 Remember that these all react to the presence of articles marked with
7667 the process mark. If, for instance, you'd like to decode and save an
7668 entire newsgroup, you'd typically do @kbd{M P a}
7669 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7670 (@code{gnus-uu-decode-uu-and-save}).
7672 All this is very much different from how @code{gnus-uu} worked with
7673 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7674 the sun. This version of @code{gnus-uu} generally assumes that you mark
7675 articles in some way (@pxref{Setting Process Marks}) and then press
7678 @vindex gnus-uu-notify-files
7679 Note: When trying to decode articles that have names matching
7680 @code{gnus-uu-notify-files}, which is hard-coded to
7681 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7682 automatically post an article on @samp{comp.unix.wizards} saying that
7683 you have just viewed the file in question. This feature can't be turned
7687 @node Shell Archives
7688 @subsection Shell Archives
7690 @cindex shell archives
7691 @cindex shared articles
7693 Shell archives (``shar files'') used to be a popular way to distribute
7694 sources, but it isn't used all that much today. In any case, we have
7695 some commands to deal with these:
7700 @kindex X s (Summary)
7701 @findex gnus-uu-decode-unshar
7702 Unshars the current series (@code{gnus-uu-decode-unshar}).
7705 @kindex X S (Summary)
7706 @findex gnus-uu-decode-unshar-and-save
7707 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7710 @kindex X v s (Summary)
7711 @findex gnus-uu-decode-unshar-view
7712 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7715 @kindex X v S (Summary)
7716 @findex gnus-uu-decode-unshar-and-save-view
7717 Unshars, views and saves the current series
7718 (@code{gnus-uu-decode-unshar-and-save-view}).
7722 @node PostScript Files
7723 @subsection PostScript Files
7729 @kindex X p (Summary)
7730 @findex gnus-uu-decode-postscript
7731 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7734 @kindex X P (Summary)
7735 @findex gnus-uu-decode-postscript-and-save
7736 Unpack and save the current PostScript series
7737 (@code{gnus-uu-decode-postscript-and-save}).
7740 @kindex X v p (Summary)
7741 @findex gnus-uu-decode-postscript-view
7742 View the current PostScript series
7743 (@code{gnus-uu-decode-postscript-view}).
7746 @kindex X v P (Summary)
7747 @findex gnus-uu-decode-postscript-and-save-view
7748 View and save the current PostScript series
7749 (@code{gnus-uu-decode-postscript-and-save-view}).
7754 @subsection Other Files
7758 @kindex X o (Summary)
7759 @findex gnus-uu-decode-save
7760 Save the current series
7761 (@code{gnus-uu-decode-save}).
7764 @kindex X b (Summary)
7765 @findex gnus-uu-decode-binhex
7766 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7767 doesn't really work yet.
7771 @node Decoding Variables
7772 @subsection Decoding Variables
7774 Adjective, not verb.
7777 * Rule Variables:: Variables that say how a file is to be viewed.
7778 * Other Decode Variables:: Other decode variables.
7779 * Uuencoding and Posting:: Variables for customizing uuencoding.
7783 @node Rule Variables
7784 @subsubsection Rule Variables
7785 @cindex rule variables
7787 Gnus uses @dfn{rule variables} to decide how to view a file. All these
7788 variables are of the form
7791 (list '(regexp1 command2)
7798 @item gnus-uu-user-view-rules
7799 @vindex gnus-uu-user-view-rules
7801 This variable is consulted first when viewing files. If you wish to use,
7802 for instance, @code{sox} to convert an @file{.au} sound file, you could
7805 (setq gnus-uu-user-view-rules
7806 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7809 @item gnus-uu-user-view-rules-end
7810 @vindex gnus-uu-user-view-rules-end
7811 This variable is consulted if gnus couldn't make any matches from the
7812 user and default view rules.
7814 @item gnus-uu-user-archive-rules
7815 @vindex gnus-uu-user-archive-rules
7816 This variable can be used to say what commands should be used to unpack
7821 @node Other Decode Variables
7822 @subsubsection Other Decode Variables
7825 @vindex gnus-uu-grabbed-file-functions
7827 @item gnus-uu-grabbed-file-functions
7828 All functions in this list will be called right after each file has been
7829 successfully decoded---so that you can move or view files right away,
7830 and don't have to wait for all files to be decoded before you can do
7831 anything. Ready-made functions you can put in this list are:
7835 @item gnus-uu-grab-view
7836 @findex gnus-uu-grab-view
7839 @item gnus-uu-grab-move
7840 @findex gnus-uu-grab-move
7841 Move the file (if you're using a saving function.)
7844 @item gnus-uu-be-dangerous
7845 @vindex gnus-uu-be-dangerous
7846 Specifies what to do if unusual situations arise during decoding. If
7847 @code{nil}, be as conservative as possible. If @code{t}, ignore things
7848 that didn't work, and overwrite existing files. Otherwise, ask each
7851 @item gnus-uu-ignore-files-by-name
7852 @vindex gnus-uu-ignore-files-by-name
7853 Files with name matching this regular expression won't be viewed.
7855 @item gnus-uu-ignore-files-by-type
7856 @vindex gnus-uu-ignore-files-by-type
7857 Files with a @acronym{MIME} type matching this variable won't be viewed.
7858 Note that Gnus tries to guess what type the file is based on the name.
7859 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
7862 @item gnus-uu-tmp-dir
7863 @vindex gnus-uu-tmp-dir
7864 Where @code{gnus-uu} does its work.
7866 @item gnus-uu-do-not-unpack-archives
7867 @vindex gnus-uu-do-not-unpack-archives
7868 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7869 looking for files to display.
7871 @item gnus-uu-view-and-save
7872 @vindex gnus-uu-view-and-save
7873 Non-@code{nil} means that the user will always be asked to save a file
7876 @item gnus-uu-ignore-default-view-rules
7877 @vindex gnus-uu-ignore-default-view-rules
7878 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7881 @item gnus-uu-ignore-default-archive-rules
7882 @vindex gnus-uu-ignore-default-archive-rules
7883 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7886 @item gnus-uu-kill-carriage-return
7887 @vindex gnus-uu-kill-carriage-return
7888 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7891 @item gnus-uu-unmark-articles-not-decoded
7892 @vindex gnus-uu-unmark-articles-not-decoded
7893 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7894 decoded articles as unread.
7896 @item gnus-uu-correct-stripped-uucode
7897 @vindex gnus-uu-correct-stripped-uucode
7898 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7899 uuencoded files that have had trailing spaces deleted.
7901 @item gnus-uu-pre-uudecode-hook
7902 @vindex gnus-uu-pre-uudecode-hook
7903 Hook run before sending a message to @code{uudecode}.
7905 @item gnus-uu-view-with-metamail
7906 @vindex gnus-uu-view-with-metamail
7908 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7909 commands defined by the rule variables and just fudge a @acronym{MIME}
7910 content type based on the file name. The result will be fed to
7911 @code{metamail} for viewing.
7913 @item gnus-uu-save-in-digest
7914 @vindex gnus-uu-save-in-digest
7915 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7916 decoding, will save in digests. If this variable is @code{nil},
7917 @code{gnus-uu} will just save everything in a file without any
7918 embellishments. The digesting almost conforms to RFC 1153---no easy way
7919 to specify any meaningful volume and issue numbers were found, so I
7920 simply dropped them.
7925 @node Uuencoding and Posting
7926 @subsubsection Uuencoding and Posting
7930 @item gnus-uu-post-include-before-composing
7931 @vindex gnus-uu-post-include-before-composing
7932 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7933 before you compose the article. If this variable is @code{t}, you can
7934 either include an encoded file with @kbd{C-c C-i} or have one included
7935 for you when you post the article.
7937 @item gnus-uu-post-length
7938 @vindex gnus-uu-post-length
7939 Maximum length of an article. The encoded file will be split into how
7940 many articles it takes to post the entire file.
7942 @item gnus-uu-post-threaded
7943 @vindex gnus-uu-post-threaded
7944 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7945 thread. This may not be smart, as no other decoder I have seen is able
7946 to follow threads when collecting uuencoded articles. (Well, I have
7947 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7948 think that counts@dots{}) Default is @code{nil}.
7950 @item gnus-uu-post-separate-description
7951 @vindex gnus-uu-post-separate-description
7952 Non-@code{nil} means that the description will be posted in a separate
7953 article. The first article will typically be numbered (0/x). If this
7954 variable is @code{nil}, the description the user enters will be included
7955 at the beginning of the first article, which will be numbered (1/x).
7956 Default is @code{t}.
7962 @subsection Viewing Files
7963 @cindex viewing files
7964 @cindex pseudo-articles
7966 After decoding, if the file is some sort of archive, gnus will attempt
7967 to unpack the archive and see if any of the files in the archive can be
7968 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
7969 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
7970 uncompress and de-tar the main file, and then view the two pictures.
7971 This unpacking process is recursive, so if the archive contains archives
7972 of archives, it'll all be unpacked.
7974 Finally, gnus will normally insert a @dfn{pseudo-article} for each
7975 extracted file into the summary buffer. If you go to these
7976 ``articles'', you will be prompted for a command to run (usually Gnus
7977 will make a suggestion), and then the command will be run.
7979 @vindex gnus-view-pseudo-asynchronously
7980 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7981 until the viewing is done before proceeding.
7983 @vindex gnus-view-pseudos
7984 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7985 the pseudo-articles into the summary buffer, but view them
7986 immediately. If this variable is @code{not-confirm}, the user won't even
7987 be asked for a confirmation before viewing is done.
7989 @vindex gnus-view-pseudos-separately
7990 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7991 pseudo-article will be created for each file to be viewed. If
7992 @code{nil}, all files that use the same viewing command will be given as
7993 a list of parameters to that command.
7995 @vindex gnus-insert-pseudo-articles
7996 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7997 pseudo-articles when decoding. It is @code{t} by default.
7999 So; there you are, reading your @emph{pseudo-articles} in your
8000 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8001 Why isn't anything real anymore? How did we get here?
8004 @node Article Treatment
8005 @section Article Treatment
8007 Reading through this huge manual, you may have quite forgotten that the
8008 object of newsreaders is to actually, like, read what people have
8009 written. Reading articles. Unfortunately, people are quite bad at
8010 writing, so there are tons of functions and variables to make reading
8011 these articles easier.
8014 * Article Highlighting:: You want to make the article look like fruit salad.
8015 * Article Fontisizing:: Making emphasized text look nice.
8016 * Article Hiding:: You also want to make certain info go away.
8017 * Article Washing:: Lots of way-neat functions to make life better.
8018 * Article Header:: Doing various header transformations.
8019 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8020 * Article Button Levels:: Controlling appearance of buttons.
8021 * Article Date:: Grumble, UT!
8022 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8023 * Article Signature:: What is a signature?
8024 * Article Miscellanea:: Various other stuff.
8028 @node Article Highlighting
8029 @subsection Article Highlighting
8030 @cindex highlighting
8032 Not only do you want your article buffer to look like fruit salad, but
8033 you want it to look like technicolor fruit salad.
8038 @kindex W H a (Summary)
8039 @findex gnus-article-highlight
8040 @findex gnus-article-maybe-highlight
8041 Do much highlighting of the current article
8042 (@code{gnus-article-highlight}). This function highlights header, cited
8043 text, the signature, and adds buttons to the body and the head.
8046 @kindex W H h (Summary)
8047 @findex gnus-article-highlight-headers
8048 @vindex gnus-header-face-alist
8049 Highlight the headers (@code{gnus-article-highlight-headers}). The
8050 highlighting will be done according to the @code{gnus-header-face-alist}
8051 variable, which is a list where each element has the form
8052 @code{(@var{regexp} @var{name} @var{content})}.
8053 @var{regexp} is a regular expression for matching the
8054 header, @var{name} is the face used for highlighting the header name
8055 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8056 the header value. The first match made will be used. Note that
8057 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8060 @kindex W H c (Summary)
8061 @findex gnus-article-highlight-citation
8062 Highlight cited text (@code{gnus-article-highlight-citation}).
8064 Some variables to customize the citation highlights:
8067 @vindex gnus-cite-parse-max-size
8069 @item gnus-cite-parse-max-size
8070 If the article size if bigger than this variable (which is 25000 by
8071 default), no citation highlighting will be performed.
8073 @item gnus-cite-max-prefix
8074 @vindex gnus-cite-max-prefix
8075 Maximum possible length for a citation prefix (default 20).
8077 @item gnus-cite-face-list
8078 @vindex gnus-cite-face-list
8079 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8080 When there are citations from multiple articles in the same message,
8081 gnus will try to give each citation from each article its own face.
8082 This should make it easier to see who wrote what.
8084 @item gnus-supercite-regexp
8085 @vindex gnus-supercite-regexp
8086 Regexp matching normal Supercite attribution lines.
8088 @item gnus-supercite-secondary-regexp
8089 @vindex gnus-supercite-secondary-regexp
8090 Regexp matching mangled Supercite attribution lines.
8092 @item gnus-cite-minimum-match-count
8093 @vindex gnus-cite-minimum-match-count
8094 Minimum number of identical prefixes we have to see before we believe
8095 that it's a citation.
8097 @item gnus-cite-attribution-prefix
8098 @vindex gnus-cite-attribution-prefix
8099 Regexp matching the beginning of an attribution line.
8101 @item gnus-cite-attribution-suffix
8102 @vindex gnus-cite-attribution-suffix
8103 Regexp matching the end of an attribution line.
8105 @item gnus-cite-attribution-face
8106 @vindex gnus-cite-attribution-face
8107 Face used for attribution lines. It is merged with the face for the
8108 cited text belonging to the attribution.
8110 @item gnus-cite-ignore-quoted-from
8111 @vindex gnus-cite-ignore-quoted-from
8112 If non-@code{nil}, no citation highlighting will be performed on lines
8113 beginning with @samp{>From }. Those lines may have been quoted by MTAs
8114 in order not to mix up with the envelope From line. The default value
8121 @kindex W H s (Summary)
8122 @vindex gnus-signature-separator
8123 @vindex gnus-signature-face
8124 @findex gnus-article-highlight-signature
8125 Highlight the signature (@code{gnus-article-highlight-signature}).
8126 Everything after @code{gnus-signature-separator} (@pxref{Article
8127 Signature}) in an article will be considered a signature and will be
8128 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8133 @xref{Customizing Articles}, for how to highlight articles automatically.
8136 @node Article Fontisizing
8137 @subsection Article Fontisizing
8139 @cindex article emphasis
8141 @findex gnus-article-emphasize
8142 @kindex W e (Summary)
8143 People commonly add emphasis to words in news articles by writing things
8144 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8145 this look nicer by running the article through the @kbd{W e}
8146 (@code{gnus-article-emphasize}) command.
8148 @vindex gnus-emphasis-alist
8149 How the emphasis is computed is controlled by the
8150 @code{gnus-emphasis-alist} variable. This is an alist where the first
8151 element is a regular expression to be matched. The second is a number
8152 that says what regular expression grouping is used to find the entire
8153 emphasized word. The third is a number that says what regexp grouping
8154 should be displayed and highlighted. (The text between these two
8155 groupings will be hidden.) The fourth is the face used for
8159 (setq gnus-emphasis-alist
8160 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8161 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8170 @vindex gnus-emphasis-underline
8171 @vindex gnus-emphasis-bold
8172 @vindex gnus-emphasis-italic
8173 @vindex gnus-emphasis-underline-bold
8174 @vindex gnus-emphasis-underline-italic
8175 @vindex gnus-emphasis-bold-italic
8176 @vindex gnus-emphasis-underline-bold-italic
8177 By default, there are seven rules, and they use the following faces:
8178 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8179 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8180 @code{gnus-emphasis-underline-italic},
8181 @code{gnus-emphasis-underline-bold}, and
8182 @code{gnus-emphasis-underline-bold-italic}.
8184 If you want to change these faces, you can either use @kbd{M-x
8185 customize}, or you can use @code{copy-face}. For instance, if you want
8186 to make @code{gnus-emphasis-italic} use a red face instead, you could
8190 (copy-face 'red 'gnus-emphasis-italic)
8193 @vindex gnus-group-highlight-words-alist
8195 If you want to highlight arbitrary words, you can use the
8196 @code{gnus-group-highlight-words-alist} variable, which uses the same
8197 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8198 parameter (@pxref{Group Parameters}) can also be used.
8200 @xref{Customizing Articles}, for how to fontize articles automatically.
8203 @node Article Hiding
8204 @subsection Article Hiding
8205 @cindex article hiding
8207 Or rather, hiding certain things in each article. There usually is much
8208 too much cruft in most articles.
8213 @kindex W W a (Summary)
8214 @findex gnus-article-hide
8215 Do quite a lot of hiding on the article buffer
8216 (@kbd{gnus-article-hide}). In particular, this function will hide
8217 headers, @acronym{PGP}, cited text and the signature.
8220 @kindex W W h (Summary)
8221 @findex gnus-article-hide-headers
8222 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8226 @kindex W W b (Summary)
8227 @findex gnus-article-hide-boring-headers
8228 Hide headers that aren't particularly interesting
8229 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8232 @kindex W W s (Summary)
8233 @findex gnus-article-hide-signature
8234 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8238 @kindex W W l (Summary)
8239 @findex gnus-article-hide-list-identifiers
8240 @vindex gnus-list-identifiers
8241 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8242 are strings some mailing list servers add to the beginning of all
8243 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8244 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8245 may not contain @code{\\(..\\)}.
8249 @item gnus-list-identifiers
8250 @vindex gnus-list-identifiers
8251 A regular expression that matches list identifiers to be removed from
8252 subject. This can also be a list of regular expressions.
8257 @kindex W W P (Summary)
8258 @findex gnus-article-hide-pem
8259 Hide @acronym{PEM} (privacy enhanced messages) cruft
8260 (@code{gnus-article-hide-pem}).
8263 @kindex W W B (Summary)
8264 @findex gnus-article-strip-banner
8265 @vindex gnus-article-banner-alist
8266 @vindex gnus-article-address-banner-alist
8269 @cindex stripping advertisements
8270 @cindex advertisements
8271 Strip the banner specified by the @code{banner} group parameter
8272 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8273 annoying banners and/or signatures that some mailing lists and moderated
8274 groups adds to all the messages. The way to use this function is to add
8275 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8276 group you want banners stripped from. The parameter either be a string,
8277 which will be interpreted as a regular expression matching text to be
8278 removed, or the symbol @code{signature}, meaning that the (last)
8279 signature should be removed, or other symbol, meaning that the
8280 corresponding regular expression in @code{gnus-article-banner-alist} is
8283 Regardless of a group, you can hide things like advertisements only when
8284 the sender of an article has a certain mail address specified in
8285 @code{gnus-article-address-banner-alist}.
8289 @item gnus-article-address-banner-alist
8290 @vindex gnus-article-address-banner-alist
8291 Alist of mail addresses and banners. Each element has the form
8292 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8293 matching a mail address in the From header, @var{banner} is one of a
8294 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8295 a regexp and @code{nil}. If @var{address} matches author's mail
8296 address, it will remove things like advertisements. For example, if a
8297 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8298 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8299 sends, you can use the following element to remove them:
8302 ("@@yoo-hoo\\.co\\.jp\\'" .
8303 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8309 @kindex W W c (Summary)
8310 @findex gnus-article-hide-citation
8311 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8312 customizing the hiding:
8316 @item gnus-cited-opened-text-button-line-format
8317 @itemx gnus-cited-closed-text-button-line-format
8318 @vindex gnus-cited-closed-text-button-line-format
8319 @vindex gnus-cited-opened-text-button-line-format
8320 Gnus adds buttons to show where the cited text has been hidden, and to
8321 allow toggle hiding the text. The format of the variable is specified
8322 by these format-like variable (@pxref{Formatting Variables}). These
8327 Starting point of the hidden text.
8329 Ending point of the hidden text.
8331 Number of characters in the hidden region.
8333 Number of lines of hidden text.
8336 @item gnus-cited-lines-visible
8337 @vindex gnus-cited-lines-visible
8338 The number of lines at the beginning of the cited text to leave
8339 shown. This can also be a cons cell with the number of lines at the top
8340 and bottom of the text, respectively, to remain visible.
8345 @kindex W W C-c (Summary)
8346 @findex gnus-article-hide-citation-maybe
8348 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8349 following two variables:
8352 @item gnus-cite-hide-percentage
8353 @vindex gnus-cite-hide-percentage
8354 If the cited text is of a bigger percentage than this variable (default
8355 50), hide the cited text.
8357 @item gnus-cite-hide-absolute
8358 @vindex gnus-cite-hide-absolute
8359 The cited text must have at least this length (default 10) before it
8364 @kindex W W C (Summary)
8365 @findex gnus-article-hide-citation-in-followups
8366 Hide cited text in articles that aren't roots
8367 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8368 useful as an interactive command, but might be a handy function to stick
8369 have happen automatically (@pxref{Customizing Articles}).
8373 All these ``hiding'' commands are toggles, but if you give a negative
8374 prefix to these commands, they will show what they have previously
8375 hidden. If you give a positive prefix, they will always hide.
8377 Also @pxref{Article Highlighting} for further variables for
8378 citation customization.
8380 @xref{Customizing Articles}, for how to hide article elements
8384 @node Article Washing
8385 @subsection Article Washing
8387 @cindex article washing
8389 We call this ``article washing'' for a really good reason. Namely, the
8390 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8392 @dfn{Washing} is defined by us as ``changing something from something to
8393 something else'', but normally results in something looking better.
8396 @xref{Customizing Articles}, if you want to change how Gnus displays
8397 articles by default.
8402 This is not really washing, it's sort of the opposite of washing. If
8403 you type this, you see the article exactly as it exists on disk or on
8407 Force redisplaying of the current article
8408 (@code{gnus-summary-show-article}). This is also not really washing.
8409 If you type this, you see the article without any previously applied
8410 interactive Washing functions but with all default treatments
8411 (@pxref{Customizing Articles}).
8414 @kindex W l (Summary)
8415 @findex gnus-summary-stop-page-breaking
8416 Remove page breaks from the current article
8417 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8421 @kindex W r (Summary)
8422 @findex gnus-summary-caesar-message
8423 @c @icon{gnus-summary-caesar-message}
8424 Do a Caesar rotate (rot13) on the article buffer
8425 (@code{gnus-summary-caesar-message}).
8426 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8427 (Typically offensive jokes and such.)
8429 It's commonly called ``rot13'' because each letter is rotated 13
8430 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8431 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8432 is rumored to have employed this form of, uh, somewhat weak encryption.
8435 @kindex W m (Summary)
8436 @findex gnus-summary-morse-message
8437 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8441 @kindex W t (Summary)
8443 @findex gnus-summary-toggle-header
8444 Toggle whether to display all headers in the article buffer
8445 (@code{gnus-summary-toggle-header}).
8448 @kindex W v (Summary)
8449 @findex gnus-summary-verbose-headers
8450 Toggle whether to display all headers in the article buffer permanently
8451 (@code{gnus-summary-verbose-headers}).
8454 @kindex W m (Summary)
8455 @findex gnus-summary-toggle-mime
8456 Toggle whether to run the article through @acronym{MIME} before
8457 displaying (@code{gnus-summary-toggle-mime}).
8460 @kindex W o (Summary)
8461 @findex gnus-article-treat-overstrike
8462 Treat overstrike (@code{gnus-article-treat-overstrike}).
8465 @kindex W d (Summary)
8466 @findex gnus-article-treat-dumbquotes
8467 @vindex gnus-article-dumbquotes-map
8469 @cindex M****s*** sm*rtq**t*s
8471 Treat M****s*** sm*rtq**t*s according to
8472 @code{gnus-article-dumbquotes-map}
8473 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8474 whether a character is a sm*rtq**t* or not, so it should only be used
8477 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8478 an attempt to provide more quoting characters. If you see something
8479 like @code{\222} or @code{\264} where you're expecting some kind of
8480 apostrophe or quotation mark, then try this wash.
8483 @kindex W Y f (Summary)
8484 @findex gnus-article-outlook-deuglify-article
8485 @cindex Outlook Express
8486 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8487 unwrap lines, repair attribution and rearrange citation.
8488 (@code{gnus-article-outlook-deuglify-article}).
8491 @kindex W Y u (Summary)
8492 @findex gnus-article-outlook-unwrap-lines
8493 @vindex gnus-outlook-deuglify-unwrap-min
8494 @vindex gnus-outlook-deuglify-unwrap-max
8495 Unwrap lines that appear to be wrapped citation lines. You can control
8496 what lines will be unwrapped by frobbing
8497 @code{gnus-outlook-deuglify-unwrap-min} and
8498 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8499 maximum length of an unwrapped citation line.
8500 (@code{gnus-article-outlook-unwrap-lines}).
8503 @kindex W Y a (Summary)
8504 @findex gnus-article-outlook-repair-attribution
8505 Repair a broken attribution line.@*
8506 (@code{gnus-article-outlook-repair-attribution}).
8509 @kindex W Y c (Summary)
8510 @findex gnus-article-outlook-rearrange-citation
8511 Repair broken citations by rearranging the text.
8512 (@code{gnus-article-outlook-rearrange-citation}).
8515 @kindex W w (Summary)
8516 @findex gnus-article-fill-cited-article
8517 Do word wrap (@code{gnus-article-fill-cited-article}).
8519 You can give the command a numerical prefix to specify the width to use
8523 @kindex W Q (Summary)
8524 @findex gnus-article-fill-long-lines
8525 Fill long lines (@code{gnus-article-fill-long-lines}).
8528 @kindex W C (Summary)
8529 @findex gnus-article-capitalize-sentences
8530 Capitalize the first word in each sentence
8531 (@code{gnus-article-capitalize-sentences}).
8534 @kindex W c (Summary)
8535 @findex gnus-article-remove-cr
8536 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8537 (this takes care of DOS line endings), and then translate any remaining
8538 CRs into LF (this takes care of Mac line endings)
8539 (@code{gnus-article-remove-cr}).
8541 @kindex W q (Summary)
8542 @findex gnus-article-de-quoted-unreadable
8543 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8544 Quoted-Printable is one common @acronym{MIME} encoding employed when
8545 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8546 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
8547 which doesn't look very readable to me. Note that this is usually
8548 done automatically by Gnus if the message in question has a
8549 @code{Content-Transfer-Encoding} header that says that this encoding
8550 has been done. If a prefix is given, a charset will be asked for.
8553 @kindex W 6 (Summary)
8554 @findex gnus-article-de-base64-unreadable
8555 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8556 one common @acronym{MIME} encoding employed when sending
8557 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8558 usually done automatically by Gnus if the message in question has a
8559 @code{Content-Transfer-Encoding} header that says that this encoding
8560 has been done. If a prefix is given, a charset will be asked for.
8563 @kindex W Z (Summary)
8564 @findex gnus-article-decode-HZ
8565 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8566 common encoding employed when sending Chinese articles. It typically
8567 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8570 @kindex W A (Summary)
8571 @findex gnus-article-treat-ansi-sequences
8572 @cindex @acronym{ANSI} control sequences
8573 Translate @acronym{ANSI} SGR control sequences into overlays or
8574 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
8575 sequences are used in some Chinese hierarchies for highlighting.
8578 @kindex W u (Summary)
8579 @findex gnus-article-unsplit-urls
8580 Remove newlines from within URLs. Some mailers insert newlines into
8581 outgoing email messages to keep lines short. This reformatting can
8582 split long URLs onto multiple lines. Repair those URLs by removing
8583 the newlines (@code{gnus-article-unsplit-urls}).
8586 @kindex W h (Summary)
8587 @findex gnus-article-wash-html
8588 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
8589 usually done automatically by Gnus if the message in question has a
8590 @code{Content-Type} header that says that the message is @acronym{HTML}.
8592 If a prefix is given, a charset will be asked for.
8594 @vindex gnus-article-wash-function
8595 The default is to use the function specified by
8596 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
8597 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8598 @acronym{HTML}, but this is controlled by the
8599 @code{gnus-article-wash-function} variable. Pre-defined functions you
8607 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
8610 Use @uref{http://links.sf.net/, Links}.
8613 Use @uref{http://lynx.isc.org/, Lynx}.
8616 Use html2text---a simple @acronym{HTML} converter included with Gnus.
8621 @kindex W b (Summary)
8622 @findex gnus-article-add-buttons
8623 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8624 @xref{Article Buttons}.
8627 @kindex W B (Summary)
8628 @findex gnus-article-add-buttons-to-head
8629 Add clickable buttons to the article headers
8630 (@code{gnus-article-add-buttons-to-head}).
8633 @kindex W p (Summary)
8634 @findex gnus-article-verify-x-pgp-sig
8635 Verify a signed control message
8636 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
8637 @code{newgroup} and @code{checkgroups} are usually signed by the
8638 hierarchy maintainer. You need to add the @acronym{PGP} public key of
8639 the maintainer to your keyring to verify the
8640 message.@footnote{@acronym{PGP} keys for many hierarchies are
8641 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8644 @kindex W s (Summary)
8645 @findex gnus-summary-force-verify-and-decrypt
8646 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
8647 @acronym{S/MIME}) message
8648 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8651 @kindex W a (Summary)
8652 @findex gnus-article-strip-headers-in-body
8653 Strip headers like the @code{X-No-Archive} header from the beginning of
8654 article bodies (@code{gnus-article-strip-headers-in-body}).
8657 @kindex W E l (Summary)
8658 @findex gnus-article-strip-leading-blank-lines
8659 Remove all blank lines from the beginning of the article
8660 (@code{gnus-article-strip-leading-blank-lines}).
8663 @kindex W E m (Summary)
8664 @findex gnus-article-strip-multiple-blank-lines
8665 Replace all blank lines with empty lines and then all multiple empty
8666 lines with a single empty line.
8667 (@code{gnus-article-strip-multiple-blank-lines}).
8670 @kindex W E t (Summary)
8671 @findex gnus-article-remove-trailing-blank-lines
8672 Remove all blank lines at the end of the article
8673 (@code{gnus-article-remove-trailing-blank-lines}).
8676 @kindex W E a (Summary)
8677 @findex gnus-article-strip-blank-lines
8678 Do all the three commands above
8679 (@code{gnus-article-strip-blank-lines}).
8682 @kindex W E A (Summary)
8683 @findex gnus-article-strip-all-blank-lines
8684 Remove all blank lines
8685 (@code{gnus-article-strip-all-blank-lines}).
8688 @kindex W E s (Summary)
8689 @findex gnus-article-strip-leading-space
8690 Remove all white space from the beginning of all lines of the article
8691 body (@code{gnus-article-strip-leading-space}).
8694 @kindex W E e (Summary)
8695 @findex gnus-article-strip-trailing-space
8696 Remove all white space from the end of all lines of the article
8697 body (@code{gnus-article-strip-trailing-space}).
8701 @xref{Customizing Articles}, for how to wash articles automatically.
8704 @node Article Header
8705 @subsection Article Header
8707 These commands perform various transformations of article header.
8712 @kindex W G u (Summary)
8713 @findex gnus-article-treat-unfold-headers
8714 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8717 @kindex W G n (Summary)
8718 @findex gnus-article-treat-fold-newsgroups
8719 Fold the @code{Newsgroups} and @code{Followup-To} headers
8720 (@code{gnus-article-treat-fold-newsgroups}).
8723 @kindex W G f (Summary)
8724 @findex gnus-article-treat-fold-headers
8725 Fold all the message headers
8726 (@code{gnus-article-treat-fold-headers}).
8729 @kindex W E w (Summary)
8730 @findex gnus-article-remove-leading-whitespace
8731 Remove excessive whitespace from all headers
8732 (@code{gnus-article-remove-leading-whitespace}).
8737 @node Article Buttons
8738 @subsection Article Buttons
8741 People often include references to other stuff in articles, and it would
8742 be nice if Gnus could just fetch whatever it is that people talk about
8743 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8744 button on these references.
8746 @vindex gnus-button-man-handler
8747 Gnus adds @dfn{buttons} to certain standard references by default:
8748 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
8749 Emacs or Gnus related references. This is controlled by two variables,
8750 one that handles article bodies and one that handles article heads:
8754 @item gnus-button-alist
8755 @vindex gnus-button-alist
8756 This is an alist where each entry has this form:
8759 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8765 All text that match this regular expression (case insensitive) will be
8766 considered an external reference. Here's a typical regexp that matches
8767 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
8768 variable containing a regexp, useful variables to use include
8769 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
8772 Gnus has to know which parts of the matches is to be highlighted. This
8773 is a number that says what sub-expression of the regexp is to be
8774 highlighted. If you want it all highlighted, you use 0 here.
8777 This form will be @code{eval}ed, and if the result is non-@code{nil},
8778 this is considered a match. This is useful if you want extra sifting to
8779 avoid false matches. Often variables named
8780 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
8781 Levels}, but any other form may be used too.
8783 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
8786 This function will be called when you click on this button.
8789 As with @var{button-par}, this is a sub-expression number, but this one
8790 says which part of the match is to be sent as data to @var{function}.
8794 So the full entry for buttonizing URLs is then
8797 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8800 @item gnus-header-button-alist
8801 @vindex gnus-header-button-alist
8802 This is just like the other alist, except that it is applied to the
8803 article head only, and that each entry has an additional element that is
8804 used to say what headers to apply the buttonize coding to:
8807 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8810 @var{header} is a regular expression.
8813 @subsubsection Related variables and functions
8816 @item gnus-button-@var{*}-level
8817 @xref{Article Button Levels}.
8819 @c Stuff related to gnus-button-browse-level
8821 @item gnus-button-url-regexp
8822 @vindex gnus-button-url-regexp
8823 A regular expression that matches embedded URLs. It is used in the
8824 default values of the variables above.
8826 @c Stuff related to gnus-button-man-level
8828 @item gnus-button-man-handler
8829 @vindex gnus-button-man-handler
8830 The function to use for displaying man pages. It must take at least one
8831 argument with a string naming the man page.
8833 @c Stuff related to gnus-button-message-level
8835 @item gnus-button-mid-or-mail-regexp
8836 @vindex gnus-button-mid-or-mail-regexp
8837 Regular expression that matches a message ID or a mail address.
8839 @item gnus-button-prefer-mid-or-mail
8840 @vindex gnus-button-prefer-mid-or-mail
8841 This variable determines what to do when the button on a string as
8842 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
8843 message ID or a mail address. If it is one of the symbols @code{mid} or
8844 @code{mail}, Gnus will always assume that the string is a message ID or
8845 a mail address, respectively. If this variable is set to the symbol
8846 @code{ask}, always query the user what do do. If it is a function, this
8847 function will be called with the string as its only argument. The
8848 function must return @code{mid}, @code{mail}, @code{invalid} or
8849 @code{ask}. The default value is the function
8850 @code{gnus-button-mid-or-mail-heuristic}.
8852 @item gnus-button-mid-or-mail-heuristic
8853 @findex gnus-button-mid-or-mail-heuristic
8854 Function that guesses whether its argument is a message ID or a mail
8855 address. Returns @code{mid} if it's a message IDs, @code{mail} if
8856 it's a mail address, @code{ask} if unsure and @code{invalid} if the
8859 @item gnus-button-mid-or-mail-heuristic-alist
8860 @vindex gnus-button-mid-or-mail-heuristic-alist
8861 An alist of @code{(RATE . REGEXP)} pairs used by the function
8862 @code{gnus-button-mid-or-mail-heuristic}.
8864 @c Stuff related to gnus-button-tex-level
8866 @item gnus-button-ctan-handler
8867 @findex gnus-button-ctan-handler
8868 The function to use for displaying CTAN links. It must take one
8869 argument, the string naming the URL.
8872 @vindex gnus-ctan-url
8873 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
8874 by @code{gnus-button-ctan-handler}.
8878 @item gnus-article-button-face
8879 @vindex gnus-article-button-face
8880 Face used on buttons.
8882 @item gnus-article-mouse-face
8883 @vindex gnus-article-mouse-face
8884 Face used when the mouse cursor is over a button.
8888 @xref{Customizing Articles}, for how to buttonize articles automatically.
8891 @node Article Button Levels
8892 @subsection Article button levels
8893 @cindex button levels
8894 The higher the value of the variables @code{gnus-button-@var{*}-level},
8895 the more buttons will appear. If the level is zero, no corresponding
8896 buttons are displayed. With the default value (which is 5) you should
8897 already see quite a lot of buttons. With higher levels, you will see
8898 more buttons, but you may also get more false positives. To avoid them,
8899 you can set the variables @code{gnus-button-@var{*}-level} local to
8900 specific groups (@pxref{Group Parameters}). Here's an example for the
8901 variable @code{gnus-parameters}:
8904 ;; @r{increase @code{gnus-button-*-level} in some groups:}
8905 (setq gnus-parameters
8906 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
8907 ("\\<unix\\>" (gnus-button-man-level 10))
8908 ("\\<tex\\>" (gnus-button-tex-level 10))))
8913 @item gnus-button-browse-level
8914 @vindex gnus-button-browse-level
8915 Controls the display of references to message IDs, mail addresses and
8916 news URLs. Related variables and functions include
8917 @code{gnus-button-url-regexp}, @code{browse-url}, and
8918 @code{browse-url-browser-function}.
8920 @item gnus-button-emacs-level
8921 @vindex gnus-button-emacs-level
8922 Controls the display of Emacs or Gnus references. Related functions are
8923 @code{gnus-button-handle-custom},
8924 @code{gnus-button-handle-describe-function},
8925 @code{gnus-button-handle-describe-variable},
8926 @code{gnus-button-handle-symbol},
8927 @code{gnus-button-handle-describe-key},
8928 @code{gnus-button-handle-apropos},
8929 @code{gnus-button-handle-apropos-command},
8930 @code{gnus-button-handle-apropos-variable},
8931 @code{gnus-button-handle-apropos-documentation}, and
8932 @code{gnus-button-handle-library}.
8934 @item gnus-button-man-level
8935 @vindex gnus-button-man-level
8936 Controls the display of references to (Unix) man pages.
8937 See @code{gnus-button-man-handler}.
8939 @item gnus-button-message-level
8940 @vindex gnus-button-message-level
8941 Controls the display of message IDs, mail addresses and news URLs.
8942 Related variables and functions include
8943 @code{gnus-button-mid-or-mail-regexp},
8944 @code{gnus-button-prefer-mid-or-mail},
8945 @code{gnus-button-mid-or-mail-heuristic}, and
8946 @code{gnus-button-mid-or-mail-heuristic-alist}.
8948 @item gnus-button-tex-level
8949 @vindex gnus-button-tex-level
8950 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
8951 URLs. See the variables @code{gnus-ctan-url},
8952 @code{gnus-button-ctan-handler},
8953 @code{gnus-button-ctan-directory-regexp}, and
8954 @code{gnus-button-handle-ctan-bogus-regexp}.
8960 @subsection Article Date
8962 The date is most likely generated in some obscure timezone you've never
8963 heard of, so it's quite nice to be able to find out what the time was
8964 when the article was sent.
8969 @kindex W T u (Summary)
8970 @findex gnus-article-date-ut
8971 Display the date in UT (aka. GMT, aka ZULU)
8972 (@code{gnus-article-date-ut}).
8975 @kindex W T i (Summary)
8976 @findex gnus-article-date-iso8601
8978 Display the date in international format, aka. ISO 8601
8979 (@code{gnus-article-date-iso8601}).
8982 @kindex W T l (Summary)
8983 @findex gnus-article-date-local
8984 Display the date in the local timezone (@code{gnus-article-date-local}).
8987 @kindex W T p (Summary)
8988 @findex gnus-article-date-english
8989 Display the date in a format that's easily pronounceable in English
8990 (@code{gnus-article-date-english}).
8993 @kindex W T s (Summary)
8994 @vindex gnus-article-time-format
8995 @findex gnus-article-date-user
8996 @findex format-time-string
8997 Display the date using a user-defined format
8998 (@code{gnus-article-date-user}). The format is specified by the
8999 @code{gnus-article-time-format} variable, and is a string that's passed
9000 to @code{format-time-string}. See the documentation of that variable
9001 for a list of possible format specs.
9004 @kindex W T e (Summary)
9005 @findex gnus-article-date-lapsed
9006 @findex gnus-start-date-timer
9007 @findex gnus-stop-date-timer
9008 Say how much time has elapsed between the article was posted and now
9009 (@code{gnus-article-date-lapsed}). It looks something like:
9012 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9015 @vindex gnus-article-date-lapsed-new-header
9016 The value of @code{gnus-article-date-lapsed-new-header} determines
9017 whether this header will just be added below the old Date one, or will
9020 An advantage of using Gnus to read mail is that it converts simple bugs
9021 into wonderful absurdities.
9023 If you want to have this line updated continually, you can put
9026 (gnus-start-date-timer)
9029 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9030 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9034 @kindex W T o (Summary)
9035 @findex gnus-article-date-original
9036 Display the original date (@code{gnus-article-date-original}). This can
9037 be useful if you normally use some other conversion function and are
9038 worried that it might be doing something totally wrong. Say, claiming
9039 that the article was posted in 1854. Although something like that is
9040 @emph{totally} impossible. Don't you trust me? *titter*
9044 @xref{Customizing Articles}, for how to display the date in your
9045 preferred format automatically.
9048 @node Article Display
9049 @subsection Article Display
9054 These commands add various frivolous display gimmicks to the article
9055 buffer in Emacs versions that support them.
9057 @code{X-Face} headers are small black-and-white images supplied by the
9058 message headers (@pxref{X-Face}).
9060 @code{Face} headers are small colored images supplied by the message
9061 headers (@pxref{Face}).
9063 Smileys are those little @samp{:-)} symbols that people like to litter
9064 their messages with (@pxref{Smileys}).
9066 Picons, on the other hand, reside on your own system, and Gnus will
9067 try to match the headers to what you have (@pxref{Picons}).
9069 All these functions are toggles---if the elements already exist,
9074 @kindex W D x (Summary)
9075 @findex gnus-article-display-x-face
9076 Display an @code{X-Face} in the @code{From} header.
9077 (@code{gnus-article-display-x-face}).
9080 @kindex W D d (Summary)
9081 @findex gnus-article-display-face
9082 Display a @code{Face} in the @code{From} header.
9083 (@code{gnus-article-display-face}).
9086 @kindex W D s (Summary)
9087 @findex gnus-treat-smiley
9088 Display smileys (@code{gnus-treat-smiley}).
9091 @kindex W D f (Summary)
9092 @findex gnus-treat-from-picon
9093 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9096 @kindex W D m (Summary)
9097 @findex gnus-treat-mail-picon
9098 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9099 (@code{gnus-treat-mail-picon}).
9102 @kindex W D n (Summary)
9103 @findex gnus-treat-newsgroups-picon
9104 Piconify all news headers (i. e., @code{Newsgroups} and
9105 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9108 @kindex W D D (Summary)
9109 @findex gnus-article-remove-images
9110 Remove all images from the article buffer
9111 (@code{gnus-article-remove-images}).
9117 @node Article Signature
9118 @subsection Article Signature
9120 @cindex article signature
9122 @vindex gnus-signature-separator
9123 Each article is divided into two parts---the head and the body. The
9124 body can be divided into a signature part and a text part. The variable
9125 that says what is to be considered a signature is
9126 @code{gnus-signature-separator}. This is normally the standard
9127 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9128 non-standard signature separators, so this variable can also be a list
9129 of regular expressions to be tested, one by one. (Searches are done
9130 from the end of the body towards the beginning.) One likely value is:
9133 (setq gnus-signature-separator
9134 '("^-- $" ; @r{The standard}
9135 "^-- *$" ; @r{A common mangling}
9136 "^-------*$" ; @r{Many people just use a looong}
9137 ; @r{line of dashes. Shame!}
9138 "^ *--------*$" ; @r{Double-shame!}
9139 "^________*$" ; @r{Underscores are also popular}
9140 "^========*$")) ; @r{Pervert!}
9143 The more permissive you are, the more likely it is that you'll get false
9146 @vindex gnus-signature-limit
9147 @code{gnus-signature-limit} provides a limit to what is considered a
9148 signature when displaying articles.
9152 If it is an integer, no signature may be longer (in characters) than
9155 If it is a floating point number, no signature may be longer (in lines)
9158 If it is a function, the function will be called without any parameters,
9159 and if it returns @code{nil}, there is no signature in the buffer.
9161 If it is a string, it will be used as a regexp. If it matches, the text
9162 in question is not a signature.
9165 This variable can also be a list where the elements may be of the types
9166 listed above. Here's an example:
9169 (setq gnus-signature-limit
9170 '(200.0 "^---*Forwarded article"))
9173 This means that if there are more than 200 lines after the signature
9174 separator, or the text after the signature separator is matched by
9175 the regular expression @samp{^---*Forwarded article}, then it isn't a
9176 signature after all.
9179 @node Article Miscellanea
9180 @subsection Article Miscellanea
9184 @kindex A t (Summary)
9185 @findex gnus-article-babel
9186 Translate the article from one language to another
9187 (@code{gnus-article-babel}).
9193 @section MIME Commands
9194 @cindex MIME decoding
9196 @cindex viewing attachments
9198 The following commands all understand the numerical prefix. For
9199 instance, @kbd{3 b} means ``view the third @acronym{MIME} part''.
9205 @kindex K v (Summary)
9206 View the @acronym{MIME} part.
9209 @kindex K o (Summary)
9210 Save the @acronym{MIME} part.
9213 @kindex K c (Summary)
9214 Copy the @acronym{MIME} part.
9217 @kindex K e (Summary)
9218 View the @acronym{MIME} part externally.
9221 @kindex K i (Summary)
9222 View the @acronym{MIME} part internally.
9225 @kindex K | (Summary)
9226 Pipe the @acronym{MIME} part to an external command.
9229 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9234 @kindex K b (Summary)
9235 Make all the @acronym{MIME} parts have buttons in front of them. This is
9236 mostly useful if you wish to save (or perform other actions) on inlined
9240 @kindex K m (Summary)
9241 @findex gnus-summary-repair-multipart
9242 Some multipart messages are transmitted with missing or faulty headers.
9243 This command will attempt to ``repair'' these messages so that they can
9244 be viewed in a more pleasant manner
9245 (@code{gnus-summary-repair-multipart}).
9248 @kindex X m (Summary)
9249 @findex gnus-summary-save-parts
9250 Save all parts matching a @acronym{MIME} type to a directory
9251 (@code{gnus-summary-save-parts}). Understands the process/prefix
9252 convention (@pxref{Process/Prefix}).
9255 @kindex M-t (Summary)
9256 @findex gnus-summary-toggle-display-buttonized
9257 Toggle the buttonized display of the article buffer
9258 (@code{gnus-summary-toggle-display-buttonized}).
9261 @kindex W M w (Summary)
9262 @findex gnus-article-decode-mime-words
9263 Decode RFC 2047-encoded words in the article headers
9264 (@code{gnus-article-decode-mime-words}).
9267 @kindex W M c (Summary)
9268 @findex gnus-article-decode-charset
9269 Decode encoded article bodies as well as charsets
9270 (@code{gnus-article-decode-charset}).
9272 This command looks in the @code{Content-Type} header to determine the
9273 charset. If there is no such header in the article, you can give it a
9274 prefix, which will prompt for the charset to decode as. In regional
9275 groups where people post using some common encoding (but do not
9276 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9277 parameter to the required charset (@pxref{Group Parameters}).
9280 @kindex W M v (Summary)
9281 @findex gnus-mime-view-all-parts
9282 View all the @acronym{MIME} parts in the current article
9283 (@code{gnus-mime-view-all-parts}).
9290 @item gnus-ignored-mime-types
9291 @vindex gnus-ignored-mime-types
9292 This is a list of regexps. @acronym{MIME} types that match a regexp from
9293 this list will be completely ignored by Gnus. The default value is
9296 To have all Vcards be ignored, you'd say something like this:
9299 (setq gnus-ignored-mime-types
9303 @item gnus-article-loose-mime
9304 @vindex gnus-article-loose-mime
9305 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9306 before interpreting the message as a @acronym{MIME} message. This helps
9307 when reading messages from certain broken mail user agents. The
9308 default is @code{nil}.
9310 @item gnus-article-emulate-mime
9311 @vindex gnus-article-emulate-mime
9312 There are other, non-@acronym{MIME} encoding methods used. The most common
9313 is @samp{uuencode}, but yEncode is also getting to be popular. If
9314 this variable is non-@code{nil}, Gnus will look in message bodies to
9315 see if it finds these encodings, and if so, it'll run them through the
9316 Gnus @acronym{MIME} machinery. The default is @code{t}.
9318 @item gnus-unbuttonized-mime-types
9319 @vindex gnus-unbuttonized-mime-types
9320 This is a list of regexps. @acronym{MIME} types that match a regexp from
9321 this list won't have @acronym{MIME} buttons inserted unless they aren't
9322 displayed or this variable is overridden by
9323 @code{gnus-buttonized-mime-types}. The default value is
9324 @code{(".*/.*")}. This variable is only used when
9325 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9327 @item gnus-buttonized-mime-types
9328 @vindex gnus-buttonized-mime-types
9329 This is a list of regexps. @acronym{MIME} types that match a regexp from
9330 this list will have @acronym{MIME} buttons inserted unless they aren't
9331 displayed. This variable overrides
9332 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9333 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9336 To see e.g. security buttons but no other buttons, you could set this
9337 variable to @code{("multipart/signed")} and leave
9338 @code{gnus-unbuttonized-mime-types} at the default value.
9340 @item gnus-inhibit-mime-unbuttonizing
9341 @vindex gnus-inhibit-mime-unbuttonizing
9342 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9343 default value is @code{nil}.
9345 @item gnus-article-mime-part-function
9346 @vindex gnus-article-mime-part-function
9347 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9348 handle as the parameter. The function is meant to be used to allow
9349 users to gather information from the article (e. g., add Vcard info to
9350 the bbdb database) or to do actions based on parts (e. g., automatically
9351 save all jpegs into some directory).
9353 Here's an example function the does the latter:
9356 (defun my-save-all-jpeg-parts (handle)
9357 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9359 (insert (mm-get-part handle))
9360 (write-region (point-min) (point-max)
9361 (read-file-name "Save jpeg to: ")))))
9362 (setq gnus-article-mime-part-function
9363 'my-save-all-jpeg-parts)
9366 @vindex gnus-mime-multipart-functions
9367 @item gnus-mime-multipart-functions
9368 Alist of @acronym{MIME} multipart types and functions to handle them.
9370 @vindex gnus-mime-display-multipart-alternative-as-mixed
9371 @item gnus-mime-display-multipart-alternative-as-mixed
9372 Display "multipart/alternative" parts as "multipart/mixed".
9374 @vindex gnus-mime-display-multipart-related-as-mixed
9375 @item gnus-mime-display-multipart-related-as-mixed
9376 Display "multipart/related" parts as "multipart/mixed".
9378 If displaying "text/html" is discouraged, see
9379 @code{mm-discouraged-alternatives} in @ref{Display Customization,
9380 Display Customization, , emacs-mime, Emacs-Mime Manual}. Images or
9381 other material inside a "multipart/related" part might be overlooked
9382 when this variable is @code{nil}.
9384 @vindex gnus-mime-display-multipart-as-mixed
9385 @item gnus-mime-display-multipart-as-mixed
9386 Display "multipart" parts as "multipart/mixed". If @code{t}, it
9387 overrides @code{nil} values of
9388 @code{gnus-mime-display-multipart-alternative-as-mixed} and
9389 @code{gnus-mime-display-multipart-related-as-mixed}.
9391 @vindex mm-file-name-rewrite-functions
9392 @item mm-file-name-rewrite-functions
9393 List of functions used for rewriting file names of @acronym{MIME} parts.
9394 Each function takes a file name as input and returns a file name.
9396 Ready-made functions include@*
9397 @code{mm-file-name-delete-whitespace},
9398 @code{mm-file-name-trim-whitespace},
9399 @code{mm-file-name-collapse-whitespace}, and
9400 @code{mm-file-name-replace-whitespace}. The later uses the value of
9401 the variable @code{mm-file-name-replace-whitespace} to replace each
9402 whitespace character in a file name with that string; default value
9403 is @code{"_"} (a single underscore).
9404 @findex mm-file-name-delete-whitespace
9405 @findex mm-file-name-trim-whitespace
9406 @findex mm-file-name-collapse-whitespace
9407 @findex mm-file-name-replace-whitespace
9408 @vindex mm-file-name-replace-whitespace
9410 The standard functions @code{capitalize}, @code{downcase},
9411 @code{upcase}, and @code{upcase-initials} may be useful, too.
9413 Everybody knows that whitespace characters in file names are evil,
9414 except those who don't know. If you receive lots of attachments from
9415 such unenlightened users, you can make live easier by adding
9418 (setq mm-file-name-rewrite-functions
9419 '(mm-file-name-trim-whitespace
9420 mm-file-name-collapse-whitespace
9421 mm-file-name-replace-whitespace))
9425 to your @file{~/.gnus.el} file.
9434 People use different charsets, and we have @acronym{MIME} to let us know what
9435 charsets they use. Or rather, we wish we had. Many people use
9436 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9437 just send out messages without saying what character sets they use. To
9438 help a bit with this, some local news hierarchies have policies that say
9439 what character set is the default. For instance, the @samp{fj}
9440 hierarchy uses @code{iso-2022-jp-2}.
9442 @vindex gnus-group-charset-alist
9443 This knowledge is encoded in the @code{gnus-group-charset-alist}
9444 variable, which is an alist of regexps (use the first item to match full
9445 group names) and default charsets to be used when reading these groups.
9447 @vindex gnus-newsgroup-ignored-charsets
9448 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9449 aren't. These blithely mark messages as being in @code{iso-8859-1}
9450 even if they really are in @code{koi-8}. To help here, the
9451 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9452 charsets that are listed here will be ignored. The variable can be
9453 set on a group-by-group basis using the group parameters (@pxref{Group
9454 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9455 which includes values some agents insist on having in there.
9457 @vindex gnus-group-posting-charset-alist
9458 When posting, @code{gnus-group-posting-charset-alist} is used to
9459 determine which charsets should not be encoded using the @acronym{MIME}
9460 encodings. For instance, some hierarchies discourage using
9461 quoted-printable header encoding.
9463 This variable is an alist of regexps and permitted unencoded charsets
9464 for posting. Each element of the alist has the form @code{(}@var{test
9465 header body-list}@code{)}, where:
9469 is either a regular expression matching the newsgroup header or a
9472 is the charset which may be left unencoded in the header (@code{nil}
9473 means encode all charsets),
9475 is a list of charsets which may be encoded using 8bit content-transfer
9476 encoding in the body, or one of the special values @code{nil} (always
9477 encode using quoted-printable) or @code{t} (always use 8bit).
9484 @cindex coding system aliases
9485 @cindex preferred charset
9487 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
9488 The Emacs MIME Manual}, for additional variables that control which
9489 MIME charsets are used when sending messages.
9491 Other charset tricks that may be useful, although not Gnus-specific:
9493 If there are several @acronym{MIME} charsets that encode the same Emacs
9494 charset, you can choose what charset to use by saying the following:
9497 (put-charset-property 'cyrillic-iso8859-5
9498 'preferred-coding-system 'koi8-r)
9501 This means that Russian will be encoded using @code{koi8-r} instead of
9502 the default @code{iso-8859-5} @acronym{MIME} charset.
9504 If you want to read messages in @code{koi8-u}, you can cheat and say
9507 (define-coding-system-alias 'koi8-u 'koi8-r)
9510 This will almost do the right thing.
9512 And finally, to read charsets like @code{windows-1251}, you can say
9516 (codepage-setup 1251)
9517 (define-coding-system-alias 'windows-1251 'cp1251)
9521 @node Article Commands
9522 @section Article Commands
9529 @kindex A P (Summary)
9530 @vindex gnus-ps-print-hook
9531 @findex gnus-summary-print-article
9532 Generate and print a PostScript image of the article buffer
9533 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9534 be run just before printing the buffer. An alternative way to print
9535 article is to use Muttprint (@pxref{Saving Articles}).
9540 @node Summary Sorting
9541 @section Summary Sorting
9542 @cindex summary sorting
9544 You can have the summary buffer sorted in various ways, even though I
9545 can't really see why you'd want that.
9550 @kindex C-c C-s C-n (Summary)
9551 @findex gnus-summary-sort-by-number
9552 Sort by article number (@code{gnus-summary-sort-by-number}).
9555 @kindex C-c C-s C-a (Summary)
9556 @findex gnus-summary-sort-by-author
9557 Sort by author (@code{gnus-summary-sort-by-author}).
9560 @kindex C-c C-s C-s (Summary)
9561 @findex gnus-summary-sort-by-subject
9562 Sort by subject (@code{gnus-summary-sort-by-subject}).
9565 @kindex C-c C-s C-d (Summary)
9566 @findex gnus-summary-sort-by-date
9567 Sort by date (@code{gnus-summary-sort-by-date}).
9570 @kindex C-c C-s C-l (Summary)
9571 @findex gnus-summary-sort-by-lines
9572 Sort by lines (@code{gnus-summary-sort-by-lines}).
9575 @kindex C-c C-s C-c (Summary)
9576 @findex gnus-summary-sort-by-chars
9577 Sort by article length (@code{gnus-summary-sort-by-chars}).
9580 @kindex C-c C-s C-i (Summary)
9581 @findex gnus-summary-sort-by-score
9582 Sort by score (@code{gnus-summary-sort-by-score}).
9585 @kindex C-c C-s C-r (Summary)
9586 @findex gnus-summary-sort-by-random
9587 Randomize (@code{gnus-summary-sort-by-random}).
9590 @kindex C-c C-s C-o (Summary)
9591 @findex gnus-summary-sort-by-original
9592 Sort using the default sorting method
9593 (@code{gnus-summary-sort-by-original}).
9596 These functions will work both when you use threading and when you don't
9597 use threading. In the latter case, all summary lines will be sorted,
9598 line by line. In the former case, sorting will be done on a
9599 root-by-root basis, which might not be what you were looking for. To
9600 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9604 @node Finding the Parent
9605 @section Finding the Parent
9606 @cindex parent articles
9607 @cindex referring articles
9612 @findex gnus-summary-refer-parent-article
9613 If you'd like to read the parent of the current article, and it is not
9614 displayed in the summary buffer, you might still be able to. That is,
9615 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
9616 and the @code{References} in the current article are not mangled, you
9617 can just press @kbd{^} or @kbd{A r}
9618 (@code{gnus-summary-refer-parent-article}). If everything goes well,
9619 you'll get the parent. If the parent is already displayed in the
9620 summary buffer, point will just move to this article.
9622 If given a positive numerical prefix, fetch that many articles back into
9623 the ancestry. If given a negative numerical prefix, fetch just that
9624 ancestor. So if you say @kbd{3 ^}, gnus will fetch the parent, the
9625 grandparent and the grandgrandparent of the current article. If you say
9626 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
9630 @findex gnus-summary-refer-references
9631 @kindex A R (Summary)
9632 Fetch all articles mentioned in the @code{References} header of the
9633 article (@code{gnus-summary-refer-references}).
9636 @findex gnus-summary-refer-thread
9637 @kindex A T (Summary)
9638 Display the full thread where the current article appears
9639 (@code{gnus-summary-refer-thread}). This command has to fetch all the
9640 headers in the current group to work, so it usually takes a while. If
9641 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9642 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
9643 visible effects normally, but it'll make this command work a whole lot
9644 faster. Of course, it'll make group entry somewhat slow.
9646 @vindex gnus-refer-thread-limit
9647 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9648 articles before the first displayed in the current group) headers to
9649 fetch when doing this command. The default is 200. If @code{t}, all
9650 the available headers will be fetched. This variable can be overridden
9651 by giving the @kbd{A T} command a numerical prefix.
9654 @findex gnus-summary-refer-article
9655 @kindex M-^ (Summary)
9657 @cindex fetching by Message-ID
9658 You can also ask the @acronym{NNTP} server for an arbitrary article, no
9659 matter what group it belongs to. @kbd{M-^}
9660 (@code{gnus-summary-refer-article}) will ask you for a
9661 @code{Message-ID}, which is one of those long, hard-to-read thingies
9662 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
9663 have to get it all exactly right. No fuzzy searches, I'm afraid.
9666 The current select method will be used when fetching by
9667 @code{Message-ID} from non-news select method, but you can override this
9668 by giving this command a prefix.
9670 @vindex gnus-refer-article-method
9671 If the group you are reading is located on a back end that does not
9672 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9673 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
9674 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
9675 updating the spool you are reading from, but that's not really
9678 It can also be a list of select methods, as well as the special symbol
9679 @code{current}, which means to use the current select method. If it
9680 is a list, Gnus will try all the methods in the list until it finds a
9683 Here's an example setting that will first try the current method, and
9684 then ask Google if that fails:
9687 (setq gnus-refer-article-method
9689 (nnweb "google" (nnweb-type google))))
9692 Most of the mail back ends support fetching by @code{Message-ID}, but
9693 do not do a particularly excellent job at it. That is, @code{nnmbox},
9694 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
9695 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
9696 only able to locate articles that have been posted to the current
9697 group. (Anything else would be too time consuming.) @code{nnmh} does
9698 not support this at all.
9701 @node Alternative Approaches
9702 @section Alternative Approaches
9704 Different people like to read news using different methods. This being
9705 gnus, we offer a small selection of minor modes for the summary buffers.
9708 * Pick and Read:: First mark articles and then read them.
9709 * Binary Groups:: Auto-decode all articles.
9714 @subsection Pick and Read
9715 @cindex pick and read
9717 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9718 a two-phased reading interface. The user first marks in a summary
9719 buffer the articles she wants to read. Then she starts reading the
9720 articles with just an article buffer displayed.
9722 @findex gnus-pick-mode
9723 @kindex M-x gnus-pick-mode
9724 Gnus provides a summary buffer minor mode that allows
9725 this---@code{gnus-pick-mode}. This basically means that a few process
9726 mark commands become one-keystroke commands to allow easy marking, and
9727 it provides one additional command for switching to the summary buffer.
9729 Here are the available keystrokes when using pick mode:
9734 @findex gnus-pick-article-or-thread
9735 Pick the article or thread on the current line
9736 (@code{gnus-pick-article-or-thread}). If the variable
9737 @code{gnus-thread-hide-subtree} is true, then this key selects the
9738 entire thread when used at the first article of the thread. Otherwise,
9739 it selects just the article. If given a numerical prefix, go to that
9740 thread or article and pick it. (The line number is normally displayed
9741 at the beginning of the summary pick lines.)
9744 @kindex SPACE (Pick)
9745 @findex gnus-pick-next-page
9746 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
9747 at the end of the buffer, start reading the picked articles.
9751 @findex gnus-pick-unmark-article-or-thread.
9752 Unpick the thread or article
9753 (@code{gnus-pick-unmark-article-or-thread}). If the variable
9754 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9755 thread if used at the first article of the thread. Otherwise it unpicks
9756 just the article. You can give this key a numerical prefix to unpick
9757 the thread or article at that line.
9761 @findex gnus-pick-start-reading
9762 @vindex gnus-pick-display-summary
9763 Start reading the picked articles (@code{gnus-pick-start-reading}). If
9764 given a prefix, mark all unpicked articles as read first. If
9765 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9766 will still be visible when you are reading.
9770 All the normal summary mode commands are still available in the
9771 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
9772 which is mapped to the same function
9773 @code{gnus-summary-tick-article-forward}.
9775 If this sounds like a good idea to you, you could say:
9778 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9781 @vindex gnus-pick-mode-hook
9782 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9784 @vindex gnus-mark-unpicked-articles-as-read
9785 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9786 all unpicked articles as read. The default is @code{nil}.
9788 @vindex gnus-summary-pick-line-format
9789 The summary line format in pick mode is slightly different from the
9790 standard format. At the beginning of each line the line number is
9791 displayed. The pick mode line format is controlled by the
9792 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9793 Variables}). It accepts the same format specs that
9794 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9798 @subsection Binary Groups
9799 @cindex binary groups
9801 @findex gnus-binary-mode
9802 @kindex M-x gnus-binary-mode
9803 If you spend much time in binary groups, you may grow tired of hitting
9804 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
9805 is a minor mode for summary buffers that makes all ordinary Gnus article
9806 selection functions uudecode series of articles and display the result
9807 instead of just displaying the articles the normal way.
9810 @findex gnus-binary-show-article
9811 The only way, in fact, to see the actual articles is the @kbd{g}
9812 command, when you have turned on this mode
9813 (@code{gnus-binary-show-article}).
9815 @vindex gnus-binary-mode-hook
9816 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9820 @section Tree Display
9823 @vindex gnus-use-trees
9824 If you don't like the normal gnus summary display, you might try setting
9825 @code{gnus-use-trees} to @code{t}. This will create (by default) an
9826 additional @dfn{tree buffer}. You can execute all summary mode commands
9829 There are a few variables to customize the tree display, of course:
9832 @item gnus-tree-mode-hook
9833 @vindex gnus-tree-mode-hook
9834 A hook called in all tree mode buffers.
9836 @item gnus-tree-mode-line-format
9837 @vindex gnus-tree-mode-line-format
9838 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9839 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
9840 of valid specs, @pxref{Summary Buffer Mode Line}.
9842 @item gnus-selected-tree-face
9843 @vindex gnus-selected-tree-face
9844 Face used for highlighting the selected article in the tree buffer. The
9845 default is @code{modeline}.
9847 @item gnus-tree-line-format
9848 @vindex gnus-tree-line-format
9849 A format string for the tree nodes. The name is a bit of a misnomer,
9850 though---it doesn't define a line, but just the node. The default value
9851 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9852 the name of the poster. It is vital that all nodes are of the same
9853 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9859 The name of the poster.
9861 The @code{From} header.
9863 The number of the article.
9865 The opening bracket.
9867 The closing bracket.
9872 @xref{Formatting Variables}.
9874 Variables related to the display are:
9877 @item gnus-tree-brackets
9878 @vindex gnus-tree-brackets
9879 This is used for differentiating between ``real'' articles and
9880 ``sparse'' articles. The format is
9882 ((@var{real-open} . @var{real-close})
9883 (@var{sparse-open} . @var{sparse-close})
9884 (@var{dummy-open} . @var{dummy-close}))
9886 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
9888 @item gnus-tree-parent-child-edges
9889 @vindex gnus-tree-parent-child-edges
9890 This is a list that contains the characters used for connecting parent
9891 nodes to their children. The default is @code{(?- ?\\ ?|)}.
9895 @item gnus-tree-minimize-window
9896 @vindex gnus-tree-minimize-window
9897 If this variable is non-@code{nil}, gnus will try to keep the tree
9898 buffer as small as possible to allow more room for the other gnus
9899 windows. If this variable is a number, the tree buffer will never be
9900 higher than that number. The default is @code{t}. Note that if you
9901 have several windows displayed side-by-side in a frame and the tree
9902 buffer is one of these, minimizing the tree window will also resize all
9903 other windows displayed next to it.
9905 You may also wish to add the following hook to keep the window minimized
9909 (add-hook 'gnus-configure-windows-hook
9910 'gnus-tree-perhaps-minimize)
9913 @item gnus-generate-tree-function
9914 @vindex gnus-generate-tree-function
9915 @findex gnus-generate-horizontal-tree
9916 @findex gnus-generate-vertical-tree
9917 The function that actually generates the thread tree. Two predefined
9918 functions are available: @code{gnus-generate-horizontal-tree} and
9919 @code{gnus-generate-vertical-tree} (which is the default).
9923 Here's an example from a horizontal tree buffer:
9926 @{***@}-(***)-[odd]-[Gun]
9936 Here's the same thread displayed in a vertical tree buffer:
9941 |--------------------------\-----\-----\
9942 (***) [Bjo] [Gun] [Gun]
9944 [odd] [Jan] [odd] (***) [Jor]
9946 [Gun] [Eri] [Eri] [odd]
9952 If you're using horizontal trees, it might be nice to display the trees
9953 side-by-side with the summary buffer. You could add something like the
9954 following to your @file{~/.gnus.el} file:
9957 (setq gnus-use-trees t
9958 gnus-generate-tree-function 'gnus-generate-horizontal-tree
9959 gnus-tree-minimize-window nil)
9960 (gnus-add-configuration
9964 (summary 0.75 point)
9969 @xref{Window Layout}.
9972 @node Mail Group Commands
9973 @section Mail Group Commands
9974 @cindex mail group commands
9976 Some commands only make sense in mail groups. If these commands are
9977 invalid in the current group, they will raise a hell and let you know.
9979 All these commands (except the expiry and edit commands) use the
9980 process/prefix convention (@pxref{Process/Prefix}).
9985 @kindex B e (Summary)
9986 @findex gnus-summary-expire-articles
9987 Run all expirable articles in the current group through the expiry
9988 process (@code{gnus-summary-expire-articles}). That is, delete all
9989 expirable articles in the group that have been around for a while.
9990 (@pxref{Expiring Mail}).
9993 @kindex B C-M-e (Summary)
9994 @findex gnus-summary-expire-articles-now
9995 Delete all the expirable articles in the group
9996 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
9997 articles eligible for expiry in the current group will
9998 disappear forever into that big @file{/dev/null} in the sky.
10001 @kindex B DEL (Summary)
10002 @findex gnus-summary-delete-article
10003 @c @icon{gnus-summary-mail-delete}
10004 Delete the mail article. This is ``delete'' as in ``delete it from your
10005 disk forever and ever, never to return again.'' Use with caution.
10006 (@code{gnus-summary-delete-article}).
10009 @kindex B m (Summary)
10011 @findex gnus-summary-move-article
10012 @vindex gnus-preserve-marks
10013 Move the article from one mail group to another
10014 (@code{gnus-summary-move-article}). Marks will be preserved if
10015 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10018 @kindex B c (Summary)
10020 @findex gnus-summary-copy-article
10021 @c @icon{gnus-summary-mail-copy}
10022 Copy the article from one group (mail group or not) to a mail group
10023 (@code{gnus-summary-copy-article}). Marks will be preserved if
10024 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10027 @kindex B B (Summary)
10028 @cindex crosspost mail
10029 @findex gnus-summary-crosspost-article
10030 Crosspost the current article to some other group
10031 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10032 the article in the other group, and the Xref headers of the article will
10033 be properly updated.
10036 @kindex B i (Summary)
10037 @findex gnus-summary-import-article
10038 Import an arbitrary file into the current mail newsgroup
10039 (@code{gnus-summary-import-article}). You will be prompted for a file
10040 name, a @code{From} header and a @code{Subject} header.
10043 @kindex B I (Summary)
10044 @findex gnus-summary-create-article
10045 Create an empty article in the current mail newsgroups
10046 (@code{gnus-summary-create-article}). You will be prompted for a
10047 @code{From} header and a @code{Subject} header.
10050 @kindex B r (Summary)
10051 @findex gnus-summary-respool-article
10052 @vindex gnus-summary-respool-default-method
10053 Respool the mail article (@code{gnus-summary-respool-article}).
10054 @code{gnus-summary-respool-default-method} will be used as the default
10055 select method when respooling. This variable is @code{nil} by default,
10056 which means that the current group select method will be used instead.
10057 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10058 (which is the default).
10062 @kindex B w (Summary)
10063 @kindex e (Summary)
10064 @findex gnus-summary-edit-article
10065 @kindex C-c C-c (Article)
10066 @findex gnus-summary-edit-article-done
10067 Edit the current article (@code{gnus-summary-edit-article}). To finish
10068 editing and make the changes permanent, type @kbd{C-c C-c}
10069 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10070 @kbd{C-c C-c} command, gnus won't re-highlight the article.
10073 @kindex B q (Summary)
10074 @findex gnus-summary-respool-query
10075 If you want to re-spool an article, you might be curious as to what group
10076 the article will end up in before you do the re-spooling. This command
10077 will tell you (@code{gnus-summary-respool-query}).
10080 @kindex B t (Summary)
10081 @findex gnus-summary-respool-trace
10082 Similarly, this command will display all fancy splitting patterns used
10083 when respooling, if any (@code{gnus-summary-respool-trace}).
10086 @kindex B p (Summary)
10087 @findex gnus-summary-article-posted-p
10088 Some people have a tendency to send you ``courtesy'' copies when they
10089 follow up to articles you have posted. These usually have a
10090 @code{Newsgroups} header in them, but not always. This command
10091 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10092 article from your news server (or rather, from
10093 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10094 report back whether it found the article or not. Even if it says that
10095 it didn't find the article, it may have been posted anyway---mail
10096 propagation is much faster than news propagation, and the news copy may
10097 just not have arrived yet.
10100 @kindex K E (Summary)
10101 @findex gnus-article-encrypt-body
10102 @vindex gnus-article-encrypt-protocol
10103 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10104 The body is encrypted with the encryption protocol specified by the
10105 variable @code{gnus-article-encrypt-protocol}.
10109 @vindex gnus-move-split-methods
10110 @cindex moving articles
10111 If you move (or copy) articles regularly, you might wish to have gnus
10112 suggest where to put the articles. @code{gnus-move-split-methods} is a
10113 variable that uses the same syntax as @code{gnus-split-methods}
10114 (@pxref{Saving Articles}). You may customize that variable to create
10115 suggestions you find reasonable. (Note that
10116 @code{gnus-move-split-methods} uses group names where
10117 @code{gnus-split-methods} uses file names.)
10120 (setq gnus-move-split-methods
10121 '(("^From:.*Lars Magne" "nnml:junk")
10122 ("^Subject:.*gnus" "nnfolder:important")
10123 (".*" "nnml:misc")))
10127 @node Various Summary Stuff
10128 @section Various Summary Stuff
10131 * Summary Group Information:: Information oriented commands.
10132 * Searching for Articles:: Multiple article commands.
10133 * Summary Generation Commands::
10134 * Really Various Summary Commands:: Those pesky non-conformant commands.
10138 @vindex gnus-summary-display-while-building
10139 @item gnus-summary-display-while-building
10140 If non-@code{nil}, show and update the summary buffer as it's being
10141 built. If @code{t}, update the buffer after every line is inserted.
10142 If the value is an integer, @var{n}, update the display every @var{n}
10143 lines. The default is @code{nil}.
10145 @vindex gnus-summary-display-arrow
10146 @item gnus-summary-display-arrow
10147 If non-@code{nil}, display an arrow in the fringe to indicate the
10150 @vindex gnus-summary-mode-hook
10151 @item gnus-summary-mode-hook
10152 This hook is called when creating a summary mode buffer.
10154 @vindex gnus-summary-generate-hook
10155 @item gnus-summary-generate-hook
10156 This is called as the last thing before doing the threading and the
10157 generation of the summary buffer. It's quite convenient for customizing
10158 the threading variables based on what data the newsgroup has. This hook
10159 is called from the summary buffer after most summary buffer variables
10162 @vindex gnus-summary-prepare-hook
10163 @item gnus-summary-prepare-hook
10164 It is called after the summary buffer has been generated. You might use
10165 it to, for instance, highlight lines or modify the look of the buffer in
10166 some other ungodly manner. I don't care.
10168 @vindex gnus-summary-prepared-hook
10169 @item gnus-summary-prepared-hook
10170 A hook called as the very last thing after the summary buffer has been
10173 @vindex gnus-summary-ignore-duplicates
10174 @item gnus-summary-ignore-duplicates
10175 When gnus discovers two articles that have the same @code{Message-ID},
10176 it has to do something drastic. No articles are allowed to have the
10177 same @code{Message-ID}, but this may happen when reading mail from some
10178 sources. Gnus allows you to customize what happens with this variable.
10179 If it is @code{nil} (which is the default), gnus will rename the
10180 @code{Message-ID} (for display purposes only) and display the article as
10181 any other article. If this variable is @code{t}, it won't display the
10182 article---it'll be as if it never existed.
10184 @vindex gnus-alter-articles-to-read-function
10185 @item gnus-alter-articles-to-read-function
10186 This function, which takes two parameters (the group name and the list
10187 of articles to be selected), is called to allow the user to alter the
10188 list of articles to be selected.
10190 For instance, the following function adds the list of cached articles to
10191 the list in one particular group:
10194 (defun my-add-cached-articles (group articles)
10195 (if (string= group "some.group")
10196 (append gnus-newsgroup-cached articles)
10200 @vindex gnus-newsgroup-variables
10201 @item gnus-newsgroup-variables
10202 A list of newsgroup (summary buffer) local variables, or cons of
10203 variables and their default expressions to be evalled (when the default
10204 values are not @code{nil}), that should be made global while the summary
10207 Note: The default expressions will be evaluated (using function
10208 @code{eval}) before assignment to the local variable rather than just
10209 assigned to it. If the default expression is the symbol @code{global},
10210 that symbol will not be evaluated but the global value of the local
10211 variable will be used instead.
10213 These variables can be used to set variables in the group parameters
10214 while still allowing them to affect operations done in other
10215 buffers. For example:
10218 (setq gnus-newsgroup-variables
10219 '(message-use-followup-to
10220 (gnus-visible-headers .
10221 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10224 Also @pxref{Group Parameters}.
10228 @node Summary Group Information
10229 @subsection Summary Group Information
10234 @kindex H f (Summary)
10235 @findex gnus-summary-fetch-faq
10236 @vindex gnus-group-faq-directory
10237 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10238 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10239 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10240 is usually a directory on a remote machine. This variable can also be
10241 a list of directories. In that case, giving a prefix to this command
10242 will allow you to choose between the various sites. @code{ange-ftp}
10243 or @code{efs} will probably be used for fetching the file.
10246 @kindex H d (Summary)
10247 @findex gnus-summary-describe-group
10248 Give a brief description of the current group
10249 (@code{gnus-summary-describe-group}). If given a prefix, force
10250 rereading the description from the server.
10253 @kindex H h (Summary)
10254 @findex gnus-summary-describe-briefly
10255 Give an extremely brief description of the most important summary
10256 keystrokes (@code{gnus-summary-describe-briefly}).
10259 @kindex H i (Summary)
10260 @findex gnus-info-find-node
10261 Go to the gnus info node (@code{gnus-info-find-node}).
10265 @node Searching for Articles
10266 @subsection Searching for Articles
10271 @kindex M-s (Summary)
10272 @findex gnus-summary-search-article-forward
10273 Search through all subsequent (raw) articles for a regexp
10274 (@code{gnus-summary-search-article-forward}).
10277 @kindex M-r (Summary)
10278 @findex gnus-summary-search-article-backward
10279 Search through all previous (raw) articles for a regexp
10280 (@code{gnus-summary-search-article-backward}).
10283 @kindex & (Summary)
10284 @findex gnus-summary-execute-command
10285 This command will prompt you for a header, a regular expression to match
10286 on this field, and a command to be executed if the match is made
10287 (@code{gnus-summary-execute-command}). If the header is an empty
10288 string, the match is done on the entire article. If given a prefix,
10289 search backward instead.
10291 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10292 all articles that have heads or bodies that match @samp{some.*string}.
10295 @kindex M-& (Summary)
10296 @findex gnus-summary-universal-argument
10297 Perform any operation on all articles that have been marked with
10298 the process mark (@code{gnus-summary-universal-argument}).
10301 @node Summary Generation Commands
10302 @subsection Summary Generation Commands
10307 @kindex Y g (Summary)
10308 @findex gnus-summary-prepare
10309 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10312 @kindex Y c (Summary)
10313 @findex gnus-summary-insert-cached-articles
10314 Pull all cached articles (for the current group) into the summary buffer
10315 (@code{gnus-summary-insert-cached-articles}).
10318 @kindex Y d (Summary)
10319 @findex gnus-summary-insert-dormant-articles
10320 Pull all dormant articles (for the current group) into the summary buffer
10321 (@code{gnus-summary-insert-dormant-articles}).
10326 @node Really Various Summary Commands
10327 @subsection Really Various Summary Commands
10333 @kindex C-d (Summary)
10334 @kindex A D (Summary)
10335 @findex gnus-summary-enter-digest-group
10336 If the current article is a collection of other articles (for instance,
10337 a digest), you might use this command to enter a group based on the that
10338 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10339 guess what article type is currently displayed unless you give a prefix
10340 to this command, which forces a ``digest'' interpretation. Basically,
10341 whenever you see a message that is a collection of other messages of
10342 some format, you @kbd{C-d} and read these messages in a more convenient
10346 @kindex C-M-d (Summary)
10347 @findex gnus-summary-read-document
10348 This command is very similar to the one above, but lets you gather
10349 several documents into one biiig group
10350 (@code{gnus-summary-read-document}). It does this by opening several
10351 @code{nndoc} groups for each document, and then opening an
10352 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10353 command understands the process/prefix convention
10354 (@pxref{Process/Prefix}).
10357 @kindex C-t (Summary)
10358 @findex gnus-summary-toggle-truncation
10359 Toggle truncation of summary lines
10360 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10361 line centering function in the summary buffer, so it's not a good idea
10362 to have truncation switched off while reading articles.
10365 @kindex = (Summary)
10366 @findex gnus-summary-expand-window
10367 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10368 If given a prefix, force an @code{article} window configuration.
10371 @kindex C-M-e (Summary)
10372 @findex gnus-summary-edit-parameters
10373 Edit the group parameters (@pxref{Group Parameters}) of the current
10374 group (@code{gnus-summary-edit-parameters}).
10377 @kindex C-M-a (Summary)
10378 @findex gnus-summary-customize-parameters
10379 Customize the group parameters (@pxref{Group Parameters}) of the current
10380 group (@code{gnus-summary-customize-parameters}).
10385 @node Exiting the Summary Buffer
10386 @section Exiting the Summary Buffer
10387 @cindex summary exit
10388 @cindex exiting groups
10390 Exiting from the summary buffer will normally update all info on the
10391 group and return you to the group buffer.
10398 @kindex Z Z (Summary)
10399 @kindex Z Q (Summary)
10400 @kindex q (Summary)
10401 @findex gnus-summary-exit
10402 @vindex gnus-summary-exit-hook
10403 @vindex gnus-summary-prepare-exit-hook
10404 @vindex gnus-group-no-more-groups-hook
10405 @c @icon{gnus-summary-exit}
10406 Exit the current group and update all information on the group
10407 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10408 called before doing much of the exiting, which calls
10409 @code{gnus-summary-expire-articles} by default.
10410 @code{gnus-summary-exit-hook} is called after finishing the exit
10411 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10412 group mode having no more (unread) groups.
10416 @kindex Z E (Summary)
10417 @kindex Q (Summary)
10418 @findex gnus-summary-exit-no-update
10419 Exit the current group without updating any information on the group
10420 (@code{gnus-summary-exit-no-update}).
10424 @kindex Z c (Summary)
10425 @kindex c (Summary)
10426 @findex gnus-summary-catchup-and-exit
10427 @c @icon{gnus-summary-catchup-and-exit}
10428 Mark all unticked articles in the group as read and then exit
10429 (@code{gnus-summary-catchup-and-exit}).
10432 @kindex Z C (Summary)
10433 @findex gnus-summary-catchup-all-and-exit
10434 Mark all articles, even the ticked ones, as read and then exit
10435 (@code{gnus-summary-catchup-all-and-exit}).
10438 @kindex Z n (Summary)
10439 @findex gnus-summary-catchup-and-goto-next-group
10440 Mark all articles as read and go to the next group
10441 (@code{gnus-summary-catchup-and-goto-next-group}).
10445 @kindex Z R (Summary)
10446 @kindex C-x C-s (Summary)
10447 @findex gnus-summary-reselect-current-group
10448 Exit this group, and then enter it again
10449 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10450 all articles, both read and unread.
10454 @kindex Z G (Summary)
10455 @kindex M-g (Summary)
10456 @findex gnus-summary-rescan-group
10457 @c @icon{gnus-summary-mail-get}
10458 Exit the group, check for new articles in the group, and select the
10459 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10460 articles, both read and unread.
10463 @kindex Z N (Summary)
10464 @findex gnus-summary-next-group
10465 Exit the group and go to the next group
10466 (@code{gnus-summary-next-group}).
10469 @kindex Z P (Summary)
10470 @findex gnus-summary-prev-group
10471 Exit the group and go to the previous group
10472 (@code{gnus-summary-prev-group}).
10475 @kindex Z s (Summary)
10476 @findex gnus-summary-save-newsrc
10477 Save the current number of read/marked articles in the dribble buffer
10478 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10479 given a prefix, also save the @file{.newsrc} file(s). Using this
10480 command will make exit without updating (the @kbd{Q} command) worthless.
10483 @vindex gnus-exit-group-hook
10484 @code{gnus-exit-group-hook} is called when you exit the current group
10485 with an ``updating'' exit. For instance @kbd{Q}
10486 (@code{gnus-summary-exit-no-update}) does not call this hook.
10488 @findex gnus-summary-wake-up-the-dead
10489 @findex gnus-dead-summary-mode
10490 @vindex gnus-kill-summary-on-exit
10491 If you're in the habit of exiting groups, and then changing your mind
10492 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10493 If you do that, gnus won't kill the summary buffer when you exit it.
10494 (Quelle surprise!) Instead it will change the name of the buffer to
10495 something like @samp{*Dead Summary ... *} and install a minor mode
10496 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
10497 buffer, you'll find that all keys are mapped to a function called
10498 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
10499 summary buffer will result in a live, normal summary buffer.
10501 There will never be more than one dead summary buffer at any one time.
10503 @vindex gnus-use-cross-reference
10504 The data on the current group will be updated (which articles you have
10505 read, which articles you have replied to, etc.) when you exit the
10506 summary buffer. If the @code{gnus-use-cross-reference} variable is
10507 @code{t} (which is the default), articles that are cross-referenced to
10508 this group and are marked as read, will also be marked as read in the
10509 other subscribed groups they were cross-posted to. If this variable is
10510 neither @code{nil} nor @code{t}, the article will be marked as read in
10511 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10514 @node Crosspost Handling
10515 @section Crosspost Handling
10519 Marking cross-posted articles as read ensures that you'll never have to
10520 read the same article more than once. Unless, of course, somebody has
10521 posted it to several groups separately. Posting the same article to
10522 several groups (not cross-posting) is called @dfn{spamming}, and you are
10523 by law required to send nasty-grams to anyone who perpetrates such a
10524 heinous crime. You may want to try NoCeM handling to filter out spam
10527 Remember: Cross-posting is kinda ok, but posting the same article
10528 separately to several groups is not. Massive cross-posting (aka.
10529 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10530 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10531 excessive crossposting (@pxref{Summary Mail Commands}).
10533 @cindex cross-posting
10535 @cindex @acronym{NOV}
10536 One thing that may cause Gnus to not do the cross-posting thing
10537 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
10538 (which is very nice, because it speeds things up considerably) which
10539 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
10540 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
10541 even with @sc{xover} by registering the @code{Xref} lines of all
10542 articles you actually read, but if you kill the articles, or just mark
10543 them as read without reading them, Gnus will not get a chance to snoop
10544 the @code{Xref} lines out of these articles, and will be unable to use
10545 the cross reference mechanism.
10547 @cindex LIST overview.fmt
10548 @cindex overview.fmt
10549 To check whether your @acronym{NNTP} server includes the @code{Xref} header
10550 in its overview files, try @samp{telnet your.nntp.server nntp},
10551 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10552 overview.fmt}. This may not work, but if it does, and the last line you
10553 get does not read @samp{Xref:full}, then you should shout and whine at
10554 your news admin until she includes the @code{Xref} header in the
10557 @vindex gnus-nov-is-evil
10558 If you want Gnus to get the @code{Xref}s right all the time, you have to
10559 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10564 For an alternative approach, @pxref{Duplicate Suppression}.
10567 @node Duplicate Suppression
10568 @section Duplicate Suppression
10570 By default, gnus tries to make sure that you don't have to read the same
10571 article more than once by utilizing the crossposting mechanism
10572 (@pxref{Crosspost Handling}). However, that simple and efficient
10573 approach may not work satisfactory for some users for various
10578 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
10579 is evil and not very common.
10582 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
10583 @file{.overview} data bases. This is evil and all too common, alas.
10586 You may be reading the same group (or several related groups) from
10587 different @acronym{NNTP} servers.
10590 You may be getting mail that duplicates articles posted to groups.
10593 I'm sure there are other situations where @code{Xref} handling fails as
10594 well, but these four are the most common situations.
10596 If, and only if, @code{Xref} handling fails for you, then you may
10597 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
10598 will remember the @code{Message-ID}s of all articles you have read or
10599 otherwise marked as read, and then, as if by magic, mark them as read
10600 all subsequent times you see them---in @emph{all} groups. Using this
10601 mechanism is quite likely to be somewhat inefficient, but not overly
10602 so. It's certainly preferable to reading the same articles more than
10605 Duplicate suppression is not a very subtle instrument. It's more like a
10606 sledge hammer than anything else. It works in a very simple
10607 fashion---if you have marked an article as read, it adds this Message-ID
10608 to a cache. The next time it sees this Message-ID, it will mark the
10609 article as read with the @samp{M} mark. It doesn't care what group it
10610 saw the article in.
10613 @item gnus-suppress-duplicates
10614 @vindex gnus-suppress-duplicates
10615 If non-@code{nil}, suppress duplicates.
10617 @item gnus-save-duplicate-list
10618 @vindex gnus-save-duplicate-list
10619 If non-@code{nil}, save the list of duplicates to a file. This will
10620 make startup and shutdown take longer, so the default is @code{nil}.
10621 However, this means that only duplicate articles read in a single gnus
10622 session are suppressed.
10624 @item gnus-duplicate-list-length
10625 @vindex gnus-duplicate-list-length
10626 This variable says how many @code{Message-ID}s to keep in the duplicate
10627 suppression list. The default is 10000.
10629 @item gnus-duplicate-file
10630 @vindex gnus-duplicate-file
10631 The name of the file to store the duplicate suppression list in. The
10632 default is @file{~/News/suppression}.
10635 If you have a tendency to stop and start gnus often, setting
10636 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
10637 you leave gnus running for weeks on end, you may have it @code{nil}. On
10638 the other hand, saving the list makes startup and shutdown much slower,
10639 so that means that if you stop and start gnus often, you should set
10640 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
10641 to you to figure out, I think.
10646 Gnus is able to verify signed messages or decrypt encrypted messages.
10647 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
10648 and @acronym{S/MIME}, however you need some external programs to get
10653 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
10654 install an OpenPGP implementation such as GnuPG. The Lisp interface
10655 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
10656 Manual}), but Mailcrypt and gpg.el are also supported.
10659 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
10660 or newer is recommended.
10664 More information on how to set things up can be found in the message
10665 manual (@pxref{Security, ,Security, message, Message Manual}).
10668 @item mm-verify-option
10669 @vindex mm-verify-option
10670 Option of verifying signed parts. @code{never}, not verify;
10671 @code{always}, always verify; @code{known}, only verify known
10672 protocols. Otherwise, ask user.
10674 @item mm-decrypt-option
10675 @vindex mm-decrypt-option
10676 Option of decrypting encrypted parts. @code{never}, no decryption;
10677 @code{always}, always decrypt; @code{known}, only decrypt known
10678 protocols. Otherwise, ask user.
10681 @vindex mml1991-use
10682 Symbol indicating elisp interface to OpenPGP implementation for
10683 @acronym{PGP} messages. The default is @code{pgg}, but
10684 @code{mailcrypt} and @code{gpg} are also supported although
10688 @vindex mml2015-use
10689 Symbol indicating elisp interface to OpenPGP implementation for
10690 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
10691 @code{mailcrypt} and @code{gpg} are also supported although
10696 @cindex snarfing keys
10697 @cindex importing PGP keys
10698 @cindex PGP key ring import
10699 Snarfing OpenPGP keys (i.e., importing keys from articles into your
10700 key ring) is not supported explicitly through a menu item or command,
10701 rather Gnus do detect and label keys as @samp{application/pgp-keys},
10702 allowing you to specify whatever action you think is appropriate
10703 through the usual @acronym{MIME} infrastructure. You can use a
10704 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
10705 Emacs MIME Manual}) such as the following to import keys using GNU
10706 Privacy Guard when you click on the @acronym{MIME} button
10707 (@pxref{Using MIME}).
10710 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
10713 This happens to also be the default action defined in
10714 @code{mailcap-mime-data}.
10717 @section Mailing List
10718 @cindex mailing list
10721 @kindex A M (summary)
10722 @findex gnus-mailing-list-insinuate
10723 Gnus understands some mailing list fields of RFC 2369. To enable it,
10724 add a @code{to-list} group parameter (@pxref{Group Parameters}),
10725 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10728 That enables the following commands to the summary buffer:
10733 @kindex C-c C-n h (Summary)
10734 @findex gnus-mailing-list-help
10735 Send a message to fetch mailing list help, if List-Help field exists.
10738 @kindex C-c C-n s (Summary)
10739 @findex gnus-mailing-list-subscribe
10740 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10743 @kindex C-c C-n u (Summary)
10744 @findex gnus-mailing-list-unsubscribe
10745 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10749 @kindex C-c C-n p (Summary)
10750 @findex gnus-mailing-list-post
10751 Post to the mailing list, if List-Post field exists.
10754 @kindex C-c C-n o (Summary)
10755 @findex gnus-mailing-list-owner
10756 Send a message to the mailing list owner, if List-Owner field exists.
10759 @kindex C-c C-n a (Summary)
10760 @findex gnus-mailing-list-archive
10761 Browse the mailing list archive, if List-Archive field exists.
10766 @node Article Buffer
10767 @chapter Article Buffer
10768 @cindex article buffer
10770 The articles are displayed in the article buffer, of which there is only
10771 one. All the summary buffers share the same article buffer unless you
10772 tell gnus otherwise.
10775 * Hiding Headers:: Deciding what headers should be displayed.
10776 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
10777 * Customizing Articles:: Tailoring the look of the articles.
10778 * Article Keymap:: Keystrokes available in the article buffer.
10779 * Misc Article:: Other stuff.
10783 @node Hiding Headers
10784 @section Hiding Headers
10785 @cindex hiding headers
10786 @cindex deleting headers
10788 The top section of each article is the @dfn{head}. (The rest is the
10789 @dfn{body}, but you may have guessed that already.)
10791 @vindex gnus-show-all-headers
10792 There is a lot of useful information in the head: the name of the person
10793 who wrote the article, the date it was written and the subject of the
10794 article. That's well and nice, but there's also lots of information
10795 most people do not want to see---what systems the article has passed
10796 through before reaching you, the @code{Message-ID}, the
10797 @code{References}, etc. ad nauseam---and you'll probably want to get rid
10798 of some of those lines. If you want to keep all those lines in the
10799 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10801 Gnus provides you with two variables for sifting headers:
10805 @item gnus-visible-headers
10806 @vindex gnus-visible-headers
10807 If this variable is non-@code{nil}, it should be a regular expression
10808 that says what headers you wish to keep in the article buffer. All
10809 headers that do not match this variable will be hidden.
10811 For instance, if you only want to see the name of the person who wrote
10812 the article and the subject, you'd say:
10815 (setq gnus-visible-headers "^From:\\|^Subject:")
10818 This variable can also be a list of regexps to match headers to
10821 @item gnus-ignored-headers
10822 @vindex gnus-ignored-headers
10823 This variable is the reverse of @code{gnus-visible-headers}. If this
10824 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10825 should be a regular expression that matches all lines that you want to
10826 hide. All lines that do not match this variable will remain visible.
10828 For instance, if you just want to get rid of the @code{References} field
10829 and the @code{Xref} field, you might say:
10832 (setq gnus-ignored-headers "^References:\\|^Xref:")
10835 This variable can also be a list of regexps to match headers to
10838 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10839 variable will have no effect.
10843 @vindex gnus-sorted-header-list
10844 Gnus can also sort the headers for you. (It does this by default.) You
10845 can control the sorting by setting the @code{gnus-sorted-header-list}
10846 variable. It is a list of regular expressions that says in what order
10847 the headers are to be displayed.
10849 For instance, if you want the name of the author of the article first,
10850 and then the subject, you might say something like:
10853 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10856 Any headers that are to remain visible, but are not listed in this
10857 variable, will be displayed in random order after all the headers listed in this variable.
10859 @findex gnus-article-hide-boring-headers
10860 @vindex gnus-boring-article-headers
10861 You can hide further boring headers by setting
10862 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
10863 does depends on the @code{gnus-boring-article-headers} variable. It's a
10864 list, but this list doesn't actually contain header names. Instead it
10865 lists various @dfn{boring conditions} that Gnus can check and remove
10868 These conditions are:
10871 Remove all empty headers.
10873 Remove the @code{Followup-To} header if it is identical to the
10874 @code{Newsgroups} header.
10876 Remove the @code{Reply-To} header if it lists the same addresses as
10877 the @code{From} header, or if the @code{broken-reply-to} group
10880 Remove the @code{Newsgroups} header if it only contains the current group
10883 Remove the @code{To} header if it only contains the address identical to
10884 the current group's @code{to-address} parameter.
10886 Remove the @code{To} header if it only contains the address identical to
10887 the current group's @code{to-list} parameter.
10889 Remove the @code{CC} header if it only contains the address identical to
10890 the current group's @code{to-list} parameter.
10892 Remove the @code{Date} header if the article is less than three days
10895 Remove the @code{To} header if it is very long.
10897 Remove all @code{To} headers if there are more than one.
10900 To include these three elements, you could say something like:
10903 (setq gnus-boring-article-headers
10904 '(empty followup-to reply-to))
10907 This is also the default value for this variable.
10911 @section Using MIME
10912 @cindex @acronym{MIME}
10914 Mime is a standard for waving your hands through the air, aimlessly,
10915 while people stand around yawning.
10917 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
10918 while all newsreaders die of fear.
10920 @acronym{MIME} may specify what character set the article uses, the encoding
10921 of the characters, and it also makes it possible to embed pictures and
10922 other naughty stuff in innocent-looking articles.
10924 @vindex gnus-show-mime
10925 @vindex gnus-article-display-method-for-mime
10926 @findex gnus-article-display-mime-message
10927 gnus handles @acronym{MIME} by pushing the articles through
10928 @code{gnus-article-display-method-for-mime}, which is
10929 @code{gnus-article-display-mime-message} by default. This function
10930 calls the @acronym{SEMI} MIME-View program to actually do the work. For
10931 more information on @acronym{SEMI} MIME-View, see its manual page
10932 (however it is not existed yet, sorry).
10934 Set @code{gnus-show-mime} to @code{t} if you want to use
10935 @acronym{MIME} all the time. If you have @code{gnus-show-mime} set,
10936 then you'll see some unfortunate display glitches in the article buffer.
10937 These can't be avoided.
10939 In GNUS or Gnus, it might be best to just use the toggling functions
10940 from the summary buffer to avoid getting nasty surprises. (For instance,
10941 you enter the group @samp{alt.sing-a-long} and, before you know it,
10942 @acronym{MIME} has decoded the sound file in the article and some
10943 horrible sing-a-long song comes screaming out your speakers, and you
10944 can't find the volume button, because there isn't one, and people are
10945 starting to look at you, and you try to stop the program, but you can't,
10946 and you can't find the program to control the volume, and everybody else
10947 in the room suddenly decides to look at you disdainfully, and you'll
10948 feel rather stupid.)
10950 Any similarity to real events and people is purely coincidental. Ahem.
10952 To avoid such kind of situation, gnus stops to use
10953 @code{metamail-buffer}. So now, you can set @code{gnus-show-mime} to
10954 non-@code{nil} every-time, then you can push button in the article
10955 buffer when there are nobody else.
10957 Also @pxref{MIME Commands}.
10960 @node Customizing Articles
10961 @section Customizing Articles
10962 @cindex article customization
10964 A slew of functions for customizing how the articles are to look like
10965 exist. You can call these functions interactively
10966 (@pxref{Article Washing}), or you can have them
10967 called automatically when you select the articles.
10969 To have them called automatically, you should set the corresponding
10970 ``treatment'' variable. For instance, to have headers hidden, you'd set
10971 @code{gnus-treat-hide-headers}. Below is a list of variables that can
10972 be set, but first we discuss the values these variables can have.
10974 Note: Some values, while valid, make little sense. Check the list below
10975 for sensible values.
10979 @code{nil}: Don't do this treatment.
10982 @code{t}: Do this treatment on all body parts.
10985 @code{head}: Do the treatment on the headers.
10988 @code{last}: Do this treatment on the last part.
10991 An integer: Do this treatment on all body parts that have a length less
10995 A list of strings: Do this treatment on all body parts that are in
10996 articles that are read in groups that have names that match one of the
10997 regexps in the list.
11000 A list where the first element is not a string:
11002 The list is evaluated recursively. The first element of the list is a
11003 predicate. The following predicates are recognized: @code{or},
11004 @code{and}, @code{not} and @code{typep}. Here's an example:
11008 (typep "text/x-vcard"))
11012 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
11017 You may have noticed that the word @dfn{part} is used here. This refers
11018 to the fact that some messages are @acronym{MIME} multipart articles that may
11019 be divided into several parts. Articles that are not multiparts are
11020 considered to contain just a single part.
11022 @vindex gnus-article-treat-types
11023 Are the treatments applied to all sorts of multipart parts? Yes, if you
11024 want to, but by default, only @samp{text/plain} parts are given the
11025 treatment. This is controlled by the @code{gnus-article-treat-types}
11026 variable, which is a list of regular expressions that are matched to the
11027 type of the part. This variable is ignored if the value of the
11028 controlling variable is a predicate list, as described above.
11030 The following treatment options are available. The easiest way to
11031 customize this is to examine the @code{gnus-article-treat} customization
11032 group. Values in parenthesis are suggested sensible values. Others are
11033 possible but those listed are probably sufficient for most people.
11036 @item gnus-treat-buttonize (t, integer)
11037 @item gnus-treat-buttonize-head (head)
11039 @xref{Article Buttons}.
11041 @item gnus-treat-capitalize-sentences (t, integer)
11042 @item gnus-treat-overstrike (t, integer)
11043 @item gnus-treat-strip-cr (t, integer)
11044 @item gnus-treat-strip-headers-in-body (t, integer)
11045 @item gnus-treat-strip-leading-blank-lines (t, integer)
11046 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11047 @item gnus-treat-strip-pem (t, last, integer)
11048 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11049 @item gnus-treat-unsplit-urls (t, integer)
11050 @item gnus-treat-wash-html (t, integer)
11051 @item gnus-treat-decode-article-as-default-mime-charset (t, integer)
11053 @xref{Article Washing}.
11055 @item gnus-treat-date-english (head)
11056 @item gnus-treat-date-iso8601 (head)
11057 @item gnus-treat-date-lapsed (head)
11058 @item gnus-treat-date-local (head)
11059 @item gnus-treat-date-original (head)
11060 @item gnus-treat-date-user-defined (head)
11061 @item gnus-treat-date-ut (head)
11063 @xref{Article Date}.
11065 @item gnus-treat-from-picon (head)
11066 @item gnus-treat-mail-picon (head)
11067 @item gnus-treat-newsgroups-picon (head)
11071 @item gnus-treat-display-smileys (t, integer)
11073 @item gnus-treat-body-boundary (head)
11075 @vindex gnus-body-boundary-delimiter
11076 Adds a delimiter between header and body, the string used as delimiter
11077 is controlled by @code{gnus-body-boundary-delimiter}.
11081 @item gnus-treat-display-x-face (head)
11085 @item gnus-treat-display-face (head)
11089 @item gnus-treat-emphasize (t, head, integer)
11090 @item gnus-treat-fill-article (t, integer)
11091 @item gnus-treat-fill-long-lines (t, integer)
11092 @item gnus-treat-hide-boring-headers (head)
11093 @item gnus-treat-hide-citation (t, integer)
11094 @item gnus-treat-hide-citation-maybe (t, integer)
11095 @item gnus-treat-hide-headers (head)
11096 @item gnus-treat-hide-signature (t, last)
11097 @item gnus-treat-strip-banner (t, last)
11098 @item gnus-treat-strip-list-identifiers (head)
11100 @xref{Article Hiding}.
11102 @item gnus-treat-highlight-citation (t, integer)
11103 @item gnus-treat-highlight-headers (head)
11104 @item gnus-treat-highlight-signature (t, last, integer)
11106 @xref{Article Highlighting}.
11108 @item gnus-treat-play-sounds
11109 @item gnus-treat-translate
11110 @item gnus-treat-ansi-sequences (t)
11111 @item gnus-treat-x-pgp-sig (head)
11113 @item gnus-treat-unfold-headers (head)
11114 @item gnus-treat-fold-headers (head)
11115 @item gnus-treat-fold-newsgroups (head)
11116 @item gnus-treat-leading-whitespace (head)
11118 @xref{Article Header}.
11123 @vindex gnus-part-display-hook
11124 You can, of course, write your own functions to be called from
11125 @code{gnus-part-display-hook}. The functions are called narrowed to the
11126 part, and you can do anything you like, pretty much. There is no
11127 information that you have to keep in the buffer---you can change
11131 @node Article Keymap
11132 @section Article Keymap
11134 Most of the keystrokes in the summary buffer can also be used in the
11135 article buffer. They should behave as if you typed them in the summary
11136 buffer, which means that you don't actually have to have a summary
11137 buffer displayed while reading. You can do it all from the article
11140 A few additional keystrokes are available:
11145 @kindex SPACE (Article)
11146 @findex gnus-article-next-page
11147 Scroll forwards one page (@code{gnus-article-next-page}).
11148 This is exactly the same as @kbd{h SPACE h}.
11151 @kindex DEL (Article)
11152 @findex gnus-article-prev-page
11153 Scroll backwards one page (@code{gnus-article-prev-page}).
11154 This is exactly the same as @kbd{h DEL h}.
11157 @kindex C-c ^ (Article)
11158 @findex gnus-article-refer-article
11159 If point is in the neighborhood of a @code{Message-ID} and you press
11160 @kbd{C-c ^}, Gnus will try to get that article from the server
11161 (@code{gnus-article-refer-article}).
11164 @kindex C-c C-m (Article)
11165 @findex gnus-article-mail
11166 Send a reply to the address near point (@code{gnus-article-mail}). If
11167 given a prefix, include the mail.
11170 @kindex s (Article)
11171 @findex gnus-article-show-summary
11172 Reconfigure the buffers so that the summary buffer becomes visible
11173 (@code{gnus-article-show-summary}).
11176 @kindex ? (Article)
11177 @findex gnus-article-describe-briefly
11178 Give a very brief description of the available keystrokes
11179 (@code{gnus-article-describe-briefly}).
11182 @kindex TAB (Article)
11183 @findex gnus-article-next-button
11184 Go to the next button, if any (@code{gnus-article-next-button}). This
11185 only makes sense if you have buttonizing turned on.
11188 @kindex M-TAB (Article)
11189 @findex gnus-article-prev-button
11190 Go to the previous button, if any (@code{gnus-article-prev-button}).
11193 @kindex R (Article)
11194 @findex gnus-article-reply-with-original
11195 Send a reply to the current article and yank the current article
11196 (@code{gnus-article-reply-with-original}). If given a prefix, make a
11197 wide reply. If the region is active, only yank the text in the
11201 @kindex F (Article)
11202 @findex gnus-article-followup-with-original
11203 Send a followup to the current article and yank the current article
11204 (@code{gnus-article-followup-with-original}). If given a prefix, make
11205 a wide reply. If the region is active, only yank the text in the
11213 @section Misc Article
11217 @item gnus-single-article-buffer
11218 @vindex gnus-single-article-buffer
11219 If non-@code{nil}, use the same article buffer for all the groups.
11220 (This is the default.) If @code{nil}, each group will have its own
11223 @vindex gnus-article-decode-hook
11224 @item gnus-article-decode-hook
11225 @cindex @acronym{MIME}
11226 Hook used to decode @acronym{MIME} articles. The default value is
11227 @code{(article-decode-charset article-decode-encoded-words)}
11229 @vindex gnus-article-prepare-hook
11230 @item gnus-article-prepare-hook
11231 This hook is called right after the article has been inserted into the
11232 article buffer. It is mainly intended for functions that do something
11233 depending on the contents; it should probably not be used for changing
11234 the contents of the article buffer.
11236 @item gnus-article-mode-hook
11237 @vindex gnus-article-mode-hook
11238 Hook called in article mode buffers.
11240 @item gnus-article-mode-syntax-table
11241 @vindex gnus-article-mode-syntax-table
11242 Syntax table used in article buffers. It is initialized from
11243 @code{text-mode-syntax-table}.
11245 @vindex gnus-article-over-scroll
11246 @item gnus-article-over-scroll
11247 If non-@code{nil}, allow scrolling the article buffer even when there
11248 no more new text to scroll in. The default is @code{nil}.
11250 @vindex gnus-article-mode-line-format
11251 @item gnus-article-mode-line-format
11252 This variable is a format string along the same lines as
11253 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
11254 Line}). It accepts the same format specifications as that variable,
11255 with two extensions:
11260 The @dfn{wash status} of the article. This is a short string with one
11261 character for each possible article wash operation that may have been
11262 performed. The characters and their meaning:
11267 Displayed when cited text may be hidden in the article buffer.
11270 Displayed when headers are hidden in the article buffer.
11273 Displayed when article is digitally signed or encrypted, and Gnus has
11274 hidden the security headers. (N.B. does not tell anything about
11275 security status, i.e. good or bad signature.)
11278 Displayed when the signature has been hidden in the Article buffer.
11281 Displayed when Gnus has treated overstrike characters in the article buffer.
11284 Displayed when Gnus has treated emphasised strings in the article buffer.
11289 The number of @acronym{MIME} parts in the article.
11293 @vindex gnus-break-pages
11295 @item gnus-break-pages
11296 Controls whether @dfn{page breaking} is to take place. If this variable
11297 is non-@code{nil}, the articles will be divided into pages whenever a
11298 page delimiter appears in the article. If this variable is @code{nil},
11299 paging will not be done.
11301 @item gnus-page-delimiter
11302 @vindex gnus-page-delimiter
11303 This is the delimiter mentioned above. By default, it is @samp{^L}
11307 @cindex internationalized domain names
11308 @vindex gnus-use-idna
11309 @item gnus-use-idna
11310 This variable controls whether Gnus performs IDNA decoding of
11311 internationalized domain names inside @samp{From}, @samp{To} and
11312 @samp{Cc} headers. @xref{IDNA, ,IDNA,message, The Message Manual},
11313 for how to compose such messages. This requires
11314 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
11315 variable is only enabled if you have installed it.
11320 @node Composing Messages
11321 @chapter Composing Messages
11322 @cindex composing messages
11325 @cindex sending mail
11330 @cindex using s/mime
11331 @cindex using smime
11333 @kindex C-c C-c (Post)
11334 All commands for posting and mailing will put you in a message buffer
11335 where you can edit the article all you like, before you send the
11336 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
11337 Message Manual}. Where the message will be posted/mailed to depends
11338 on your setup (@pxref{Posting Server}).
11341 * Mail:: Mailing and replying.
11342 * Posting Server:: What server should you post and mail via?
11343 * POP before SMTP:: You cannot send a mail unless you read a mail.
11344 * Mail and Post:: Mailing and posting at the same time.
11345 * Archived Messages:: Where Gnus stores the messages you've sent.
11346 * Posting Styles:: An easier way to specify who you are.
11347 * Drafts:: Postponing messages and rejected messages.
11348 * Rejected Articles:: What happens if the server doesn't like your article?
11349 * Signing and encrypting:: How to compose secure messages.
11352 Also @pxref{Canceling and Superseding} for information on how to
11353 remove articles you shouldn't have posted.
11359 Variables for customizing outgoing mail:
11362 @item gnus-uu-digest-headers
11363 @vindex gnus-uu-digest-headers
11364 List of regexps to match headers included in digested messages. The
11365 headers will be included in the sequence they are matched. If
11366 @code{nil} include all headers.
11368 @item gnus-add-to-list
11369 @vindex gnus-add-to-list
11370 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11371 that have none when you do a @kbd{a}.
11373 @item gnus-confirm-mail-reply-to-news
11374 @vindex gnus-confirm-mail-reply-to-news
11375 This can also be a function receiving the group name as the only
11376 parameter which should return non-@code{nil} if a confirmation is
11377 needed, or a regular expression matching group names, where
11378 confirmation is should be asked for.
11380 If you find yourself never wanting to reply to mail, but occasionally
11381 press R anyway, this variable might be for you.
11383 @item gnus-confirm-treat-mail-like-news
11384 @vindex gnus-confirm-treat-mail-like-news
11385 If non-@code{nil}, Gnus also requests confirmation according to
11386 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
11387 useful for treating mailing lists like newsgroups.
11392 @node Posting Server
11393 @section Posting Server
11395 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11396 (extremely intelligent, of course) article, where does it go?
11398 Thank you for asking. I hate you.
11400 It can be quite complicated.
11402 @vindex gnus-post-method
11403 When posting news, Message usually invokes @code{message-send-news}
11404 (@pxref{News Variables, , News Variables, message, Message Manual}).
11405 Normally, Gnus will post using the same select method as you're
11406 reading from (which might be convenient if you're reading lots of
11407 groups from different private servers). However. If the server
11408 you're reading from doesn't allow posting, just reading, you probably
11409 want to use some other server to post your (extremely intelligent and
11410 fabulously interesting) articles. You can then set the
11411 @code{gnus-post-method} to some other method:
11414 (setq gnus-post-method '(nnspool ""))
11417 Now, if you've done this, and then this server rejects your article, or
11418 this server is down, what do you do then? To override this variable you
11419 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11420 the ``current'' server, to get back the default behavior, for posting.
11422 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11423 gnus will prompt you for what method to use for posting.
11425 You can also set @code{gnus-post-method} to a list of select methods.
11426 If that's the case, gnus will always prompt you for what method to use
11429 Finally, if you want to always post using the native select method,
11430 you can set this variable to @code{native}.
11432 When sending mail, Message invokes @code{message-send-mail-function}.
11433 The default function, @code{message-send-mail-with-sendmail}, pipes
11434 your article to the @code{sendmail} binary for further queuing and
11435 sending. When your local system is not configured for sending mail
11436 using @code{sendmail}, and you have access to a remote @acronym{SMTP}
11437 server, you can set @code{message-send-mail-function} to
11438 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11439 package correctly. An example:
11442 (setq message-send-mail-function 'smtpmail-send-it
11443 smtpmail-default-smtp-server "YOUR SMTP HOST")
11444 ;; @r{The following variable needs to be set if you are using smtpmail.el}
11445 ;; @r{distributed with FLIM, lesser than the version 1.14.6.}
11446 (setq smtp-default-server "YOUR SMTP HOST")
11449 To the thing similar to this, there is
11450 @code{message-smtpmail-send-it}. It is useful if your @acronym{ISP}
11451 requires the @acronym{POP}-before-@acronym{SMTP} authentication.
11452 @xref{POP before SMTP}.
11454 Other possible choices for @code{message-send-mail-function} includes
11455 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11456 and @code{feedmail-send-it}.
11458 @node POP before SMTP
11459 @section POP before SMTP
11460 @cindex pop before smtp
11461 @findex message-smtpmail-send-it
11462 @findex mail-source-touch-pop
11464 Does your @acronym{ISP} require the @acronym{POP}-before-@acronym{SMTP}
11465 authentication? It is whether you need to connect to the @acronym{POP}
11466 mail server within a certain time before sending mails. If so, there is
11467 a convenient way. To do that, put the following lines in your
11468 @file{~/.gnus.el} file:
11471 (setq message-send-mail-function 'message-smtpmail-send-it)
11472 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
11476 It means to let Gnus connect to the @acronym{POP} mail server in advance
11477 whenever you send a mail. The @code{mail-source-touch-pop} function
11478 does only a @acronym{POP} authentication according to the value of
11479 @code{mail-sources} without fetching mails, just before sending a mail.
11480 Note that you have to use @code{message-smtpmail-send-it} which runs
11481 @code{message-send-mail-hook} rather than @code{smtpmail-send-it} and
11482 set the value of @code{mail-sources} for a @acronym{POP} connection
11483 correctly. @xref{Mail Sources}.
11485 If you have two or more @acronym{POP} mail servers set in
11486 @code{mail-sources}, you may want to specify one of them to
11487 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
11488 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
11489 is your primary @acronym{POP} mail server (i.e., you are fetching mails
11490 mainly from that server), you can set it permanently as follows:
11493 (setq mail-source-primary-source
11494 '(pop :server "pop3.mail.server"
11495 :password "secret"))
11499 Otherwise, bind it dynamically only when performing the
11500 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
11503 (add-hook 'message-send-mail-hook
11505 (let ((mail-source-primary-source
11506 '(pop :server "pop3.mail.server"
11507 :password "secret")))
11508 (mail-source-touch-pop))))
11511 @node Mail and Post
11512 @section Mail and Post
11514 Here's a list of variables relevant to both mailing and
11518 @item gnus-mailing-list-groups
11519 @findex gnus-mailing-list-groups
11520 @cindex mailing lists
11522 If your news server offers groups that are really mailing lists
11523 gatewayed to the @acronym{NNTP} server, you can read those groups without
11524 problems, but you can't post/followup to them without some difficulty.
11525 One solution is to add a @code{to-address} to the group parameters
11526 (@pxref{Group Parameters}). An easier thing to do is set the
11527 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
11528 really are mailing lists. Then, at least, followups to the mailing
11529 lists will work most of the time. Posting to these groups (@kbd{a}) is
11530 still a pain, though.
11532 @item gnus-user-agent
11533 @vindex gnus-user-agent
11536 This variable controls which information should be exposed in the
11537 User-Agent header. It can be one of the symbols @code{gnus} (show only
11538 Gnus version), @code{emacs-gnus} (show only Emacs and Gnus versions),
11539 @code{emacs-gnus-config} (same as @code{emacs-gnus} plus system
11540 configuration), @code{emacs-gnus-type} (same as @code{emacs-gnus} plus
11541 system type) or a custom string. If you set it to a string, be sure to
11542 use a valid format, see RFC 2616.
11546 You may want to do spell-checking on messages that you send out. Or, if
11547 you don't want to spell-check by hand, you could add automatic
11548 spell-checking via the @code{ispell} package:
11551 @findex ispell-message
11553 (add-hook 'message-send-hook 'ispell-message)
11556 If you want to change the @code{ispell} dictionary based on what group
11557 you're in, you could say something like the following:
11560 (add-hook 'gnus-select-group-hook
11564 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
11565 (ispell-change-dictionary "deutsch"))
11567 (ispell-change-dictionary "english")))))
11570 Modify to suit your needs.
11573 @node Archived Messages
11574 @section Archived Messages
11575 @cindex archived messages
11576 @cindex sent messages
11578 Gnus provides a few different methods for storing the mail and news you
11579 send. The default method is to use the @dfn{archive virtual server} to
11580 store the messages. If you want to disable this completely, the
11581 @code{gnus-message-archive-group} variable should be @code{nil}, which
11584 For archiving interesting messages in a group you read, see the
11585 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
11588 @vindex gnus-message-archive-method
11589 @code{gnus-message-archive-method} says what virtual server gnus is to
11590 use to store sent messages. The default is:
11593 (nnfolder "archive"
11594 (nnfolder-directory "~/Mail/archive")
11595 (nnfolder-active-file "~/Mail/archive/active")
11596 (nnfolder-get-new-mail nil)
11597 (nnfolder-inhibit-expiry t))
11600 You can, however, use any mail select method (@code{nnml},
11601 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
11602 for doing this sort of thing, though. If you don't like the default
11603 directory chosen, you could say something like:
11606 (setq gnus-message-archive-method
11607 '(nnfolder "archive"
11608 (nnfolder-inhibit-expiry t)
11609 (nnfolder-active-file "~/News/sent-mail/active")
11610 (nnfolder-directory "~/News/sent-mail/")))
11613 @vindex gnus-message-archive-group
11615 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11616 to one or more group(s) on that server. Which group to use is
11617 determined by the @code{gnus-message-archive-group} variable.
11619 This variable can be used to do the following:
11623 Messages will be saved in that group.
11625 Note that you can include a select method in the group name, then the
11626 message will not be stored in the select method given by
11627 @code{gnus-message-archive-method}, but in the select method specified
11628 by the group name, instead. Suppose @code{gnus-message-archive-method}
11629 has the default value shown above. Then setting
11630 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11631 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11632 value @code{"nnml:foo"}, then outgoing messages will be stored in
11635 @item a list of strings
11636 Messages will be saved in all those groups.
11638 @item an alist of regexps, functions and forms
11639 When a key ``matches'', the result is used.
11642 No message archiving will take place. This is the default.
11647 Just saving to a single group called @samp{MisK}:
11649 (setq gnus-message-archive-group "MisK")
11652 Saving to two groups, @samp{MisK} and @samp{safe}:
11654 (setq gnus-message-archive-group '("MisK" "safe"))
11657 Save to different groups based on what group you are in:
11659 (setq gnus-message-archive-group
11660 '(("^alt" "sent-to-alt")
11661 ("mail" "sent-to-mail")
11662 (".*" "sent-to-misc")))
11665 More complex stuff:
11667 (setq gnus-message-archive-group
11668 '((if (message-news-p)
11673 How about storing all news messages in one file, but storing all mail
11674 messages in one file per month:
11677 (setq gnus-message-archive-group
11678 '((if (message-news-p)
11680 (concat "mail." (format-time-string "%Y-%m")))))
11683 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11684 @c use a different value for @code{gnus-message-archive-group} there.)
11686 Now, when you send a message off, it will be stored in the appropriate
11687 group. (If you want to disable storing for just one particular message,
11688 you can just remove the @code{Gcc} header that has been inserted.) The
11689 archive group will appear in the group buffer the next time you start
11690 gnus, or the next time you press @kbd{F} in the group buffer. You can
11691 enter it and read the articles in it just like you'd read any other
11692 group. If the group gets really big and annoying, you can simply rename
11693 if (using @kbd{G r} in the group buffer) to something
11694 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
11695 continue to be stored in the old (now empty) group.
11697 That's the default method of archiving sent messages. Gnus offers a
11698 different way for the people who don't like the default method. In that
11699 case you should set @code{gnus-message-archive-group} to @code{nil};
11700 this will disable archiving.
11703 @item gnus-outgoing-message-group
11704 @vindex gnus-outgoing-message-group
11705 All outgoing messages will be put in this group. If you want to store
11706 all your outgoing mail and articles in the group @samp{nnml:archive},
11707 you set this variable to that value. This variable can also be a list of
11710 If you want to have greater control over what group to put each
11711 message in, you can set this variable to a function that checks the
11712 current newsgroup name and then returns a suitable group name (or list
11715 This variable can be used instead of @code{gnus-message-archive-group},
11716 but the latter is the preferred method.
11718 @item gnus-gcc-mark-as-read
11719 @vindex gnus-gcc-mark-as-read
11720 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11722 @item gnus-gcc-externalize-attachments
11723 @vindex gnus-gcc-externalize-attachments
11724 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11725 and matches the Gcc group name, attach files as external parts; if it is
11726 @code{all}, attach local files as external parts; if it is other
11727 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11728 changed in the future.
11733 @node Posting Styles
11734 @section Posting Styles
11735 @cindex posting styles
11738 All them variables, they make my head swim.
11740 So what if you want a different @code{Organization} and signature based
11741 on what groups you post to? And you post both from your home machine
11742 and your work machine, and you want different @code{From} lines, and so
11745 @vindex gnus-posting-styles
11746 One way to do stuff like that is to write clever hooks that change the
11747 variables you need to have changed. That's a bit boring, so somebody
11748 came up with the bright idea of letting the user specify these things in
11749 a handy alist. Here's an example of a @code{gnus-posting-styles}
11754 (signature "Peace and happiness")
11755 (organization "What me?"))
11757 (signature "Death to everybody"))
11758 ("comp.emacs.i-love-it"
11759 (organization "Emacs is it")))
11762 As you might surmise from this example, this alist consists of several
11763 @dfn{styles}. Each style will be applicable if the first element
11764 ``matches'', in some form or other. The entire alist will be iterated
11765 over, from the beginning towards the end, and each match will be
11766 applied, which means that attributes in later styles that match override
11767 the same attributes in earlier matching styles. So
11768 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11769 signature and the @samp{What me?} @code{Organization} header.
11771 The first element in each style is called the @code{match}. If it's a
11772 string, then Gnus will try to regexp match it against the group name.
11773 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
11774 will look in the original article for a header whose name is
11775 @var{match} and compare that @var{regexp}. @var{match} and
11776 @var{regexp} are strings. (The original article is the one you are
11777 replying or following up to. If you are not composing a reply or a
11778 followup, then there is nothing to match against.) If the
11779 @code{match} is a function symbol, that function will be called with
11780 no arguments. If it's a variable symbol, then the variable will be
11781 referenced. If it's a list, then that list will be @code{eval}ed. In
11782 any case, if this returns a non-@code{nil} value, then the style is
11783 said to @dfn{match}.
11785 Each style may contain an arbitrary amount of @dfn{attributes}. Each
11786 attribute consists of a @code{(@var{name} @var{value})} pair. In
11787 addition, you can also use the @code{(@var{name} :file @var{value})}
11788 form or the @code{(@var{name} :value @var{value})} form. Where
11789 @code{:file} signifies @var{value} represents a file name and its
11790 contents should be used as the attribute value, @code{:value} signifies
11791 @var{value} does not represent a file name explicitly. The attribute
11792 name can be one of:
11795 @item @code{signature}
11796 @item @code{signature-file}
11797 @item @code{x-face-file}
11798 @item @code{address}, overriding @code{user-mail-address}
11799 @item @code{name}, overriding @code{(user-full-name)}
11803 The attribute name can also be a string or a symbol. In that case,
11804 this will be used as a header name, and the value will be inserted in
11805 the headers of the article; if the value is @code{nil}, the header
11806 name will be removed. If the attribute name is @code{eval}, the form
11807 is evaluated, and the result is thrown away.
11809 The attribute value can be a string (used verbatim), a function with
11810 zero arguments (the return value will be used), a variable (its value
11811 will be used) or a list (it will be @code{eval}ed and the return value
11812 will be used). The functions and sexps are called/@code{eval}ed in the
11813 message buffer that is being set up. The headers of the current article
11814 are available through the @code{message-reply-headers} variable, which
11815 is a vector of the following headers: number subject from date id
11816 references chars lines xref extra.
11818 @vindex message-reply-headers
11820 If you wish to check whether the message you are about to compose is
11821 meant to be a news article or a mail message, you can check the values
11822 of the @code{message-news-p} and @code{message-mail-p} functions.
11824 @findex message-mail-p
11825 @findex message-news-p
11827 So here's a new example:
11830 (setq gnus-posting-styles
11832 (signature-file "~/.signature")
11834 ("X-Home-Page" (getenv "WWW_HOME"))
11835 (organization "People's Front Against MWM"))
11837 (signature my-funny-signature-randomizer))
11838 ((equal (system-name) "gnarly") ;; @r{A form}
11839 (signature my-quote-randomizer))
11840 (message-news-p ;; @r{A function symbol}
11841 (signature my-news-signature))
11842 (window-system ;; @r{A value symbol}
11843 ("X-Window-System" (format "%s" window-system)))
11844 ;; @r{If I'm replying to Larsi, set the Organization header.}
11845 ((header "from" "larsi.*org")
11846 (Organization "Somewhere, Inc."))
11847 ((posting-from-work-p) ;; @r{A user defined function}
11848 (signature-file "~/.work-signature")
11849 (address "user@@bar.foo")
11850 (body "You are fired.\n\nSincerely, your boss.")
11851 (organization "Important Work, Inc"))
11853 (From (save-excursion
11854 (set-buffer gnus-article-buffer)
11855 (message-fetch-field "to"))))
11857 (signature-file "~/.mail-signature"))))
11860 The @samp{nnml:.*} rule means that you use the @code{To} address as the
11861 @code{From} address in all your outgoing replies, which might be handy
11862 if you fill many roles.
11864 Setting the @code{gnus-named-posting-styles} variable will make
11865 posting-styles allow to have distinctive names. You can specify an
11866 arbitrary posting-style when article posting with @kbd{S P} in the
11867 summary buffer. @code{gnus-named-posting-styles} is an alist which maps
11868 the names to styles. Once a posting-style is added to the alist, we can
11869 import it from @code{gnus-posting-styles}. If an attribute whose name
11870 is @code{import} is found, Gnus will look for the attribute value in
11871 @code{gnus-named-posting-styles} and expand it in place.
11876 (setq gnus-named-posting-styles
11878 (signature-file "~/.signature")
11880 ("X-Home-Page" (getenv "WWW_HOME"))
11881 (organization "People's Front Against MWM"))
11884 (organization "The Church of Emacs"))))
11887 The posting-style named "Emacs" will inherit all the attributes from
11888 "Default" except @code{organization}.
11895 If you are writing a message (mail or news) and suddenly remember that
11896 you have a steak in the oven (or some pesto in the food processor, you
11897 craaazy vegetarians), you'll probably wish there was a method to save
11898 the message you are writing so that you can continue editing it some
11899 other day, and send it when you feel its finished.
11901 Well, don't worry about it. Whenever you start composing a message of
11902 some sort using the gnus mail and post commands, the buffer you get will
11903 automatically associate to an article in a special @dfn{draft} group.
11904 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
11905 article will be saved there. (Auto-save files also go to the draft
11909 @vindex nndraft-directory
11910 The draft group is a special group (which is implemented as an
11911 @code{nndraft} group, if you absolutely have to know) called
11912 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
11913 @code{nndraft} is to store its files. What makes this group special is
11914 that you can't tick any articles in it or mark any articles as
11915 read---all articles in the group are permanently unread.
11917 If the group doesn't exist, it will be created and you'll be subscribed
11918 to it. The only way to make it disappear from the Group buffer is to
11919 unsubscribe it. The special properties of the draft group comes from
11920 a group property (@pxref{Group Parameters}), and if lost the group
11921 behaves like any other group. This means the commands below will not
11922 be available. To restore the special properties of the group, the
11923 simplest way is to kill the group, using @kbd{C-k}, and restart
11924 Gnus. The group is automatically created again with the
11925 correct parameters. The content of the group is not lost.
11927 @c @findex gnus-dissociate-buffer-from-draft
11928 @c @kindex C-c M-d (Mail)
11929 @c @kindex C-c M-d (Post)
11930 @c @findex gnus-associate-buffer-with-draft
11931 @c @kindex C-c C-d (Mail)
11932 @c @kindex C-c C-d (Post)
11933 @c If you're writing some super-secret message that you later want to
11934 @c encode with PGP before sending, you may wish to turn the auto-saving
11935 @c (and association with the draft group) off. You never know who might be
11936 @c interested in reading all your extremely valuable and terribly horrible
11937 @c and interesting secrets. The @kbd{C-c M-d}
11938 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
11939 @c If you change your mind and want to turn the auto-saving back on again,
11940 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
11942 @c @vindex gnus-use-draft
11943 @c To leave association with the draft group off by default, set
11944 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
11946 @findex gnus-draft-edit-message
11947 @kindex D e (Draft)
11948 When you want to continue editing the article, you simply enter the
11949 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
11950 that. You will be placed in a buffer where you left off.
11952 Rejected articles will also be put in this draft group (@pxref{Rejected
11955 @findex gnus-draft-send-all-messages
11956 @kindex D s (Draft)
11957 @findex gnus-draft-send-message
11958 @kindex D S (Draft)
11959 If you have lots of rejected messages you want to post (or mail) without
11960 doing further editing, you can use the @kbd{D s} command
11961 (@code{gnus-draft-send-message}). This command understands the
11962 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
11963 command (@code{gnus-draft-send-all-messages}) will ship off all messages
11966 @findex gnus-draft-toggle-sending
11967 @kindex D t (Draft)
11968 If you have some messages that you wish not to send, you can use the
11969 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
11970 as unsendable. This is a toggling command.
11973 @node Rejected Articles
11974 @section Rejected Articles
11975 @cindex rejected articles
11977 Sometimes a news server will reject an article. Perhaps the server
11978 doesn't like your face. Perhaps it just feels miserable. Perhaps
11979 @emph{there be demons}. Perhaps you have included too much cited text.
11980 Perhaps the disk is full. Perhaps the server is down.
11982 These situations are, of course, totally beyond the control of gnus.
11983 (Gnus, of course, loves the way you look, always feels great, has angels
11984 fluttering around inside of it, doesn't care about how much cited text
11985 you include, never runs full and never goes down.) So gnus saves these
11986 articles until some later time when the server feels better.
11988 The rejected articles will automatically be put in a special draft group
11989 (@pxref{Drafts}). When the server comes back up again, you'd then
11990 typically enter that group and send all the articles off.
11992 @node Signing and encrypting
11993 @section Signing and encrypting
11995 @cindex using s/mime
11996 @cindex using smime
11998 Gnus can digitally sign and encrypt your messages, using vanilla
11999 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
12000 decoding such messages, see the @code{mm-verify-option} and
12001 @code{mm-decrypt-option} options (@pxref{Security}).
12003 @vindex gnus-message-replysign
12004 @vindex gnus-message-replyencrypt
12005 @vindex gnus-message-replysignencrypted
12006 Often, you would like to sign replies to people who send you signed
12007 messages. Even more often, you might want to encrypt messages which
12008 are in reply to encrypted messages. Gnus offers
12009 @code{gnus-message-replysign} to enable the former, and
12010 @code{gnus-message-replyencrypt} for the latter. In addition, setting
12011 @code{gnus-message-replysignencrypted} (on by default) will sign
12012 automatically encrypted messages.
12014 Instructing @acronym{MML} to perform security operations on a
12015 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
12016 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
12021 @kindex C-c C-m s s (Message)
12022 @findex mml-secure-message-sign-smime
12024 Digitally sign current message using @acronym{S/MIME}.
12027 @kindex C-c C-m s o (Message)
12028 @findex mml-secure-message-sign-pgp
12030 Digitally sign current message using @acronym{PGP}.
12033 @kindex C-c C-m s p (Message)
12034 @findex mml-secure-message-sign-pgp
12036 Digitally sign current message using @acronym{PGP/MIME}.
12039 @kindex C-c C-m c s (Message)
12040 @findex mml-secure-message-encrypt-smime
12042 Digitally encrypt current message using @acronym{S/MIME}.
12045 @kindex C-c C-m c o (Message)
12046 @findex mml-secure-message-encrypt-pgp
12048 Digitally encrypt current message using @acronym{PGP}.
12051 @kindex C-c C-m c p (Message)
12052 @findex mml-secure-message-encrypt-pgpmime
12054 Digitally encrypt current message using @acronym{PGP/MIME}.
12057 @kindex C-c C-m C-n (Message)
12058 @findex mml-unsecure-message
12059 Remove security related @acronym{MML} tags from message.
12063 @xref{Security, ,Security, message, Message Manual}, for more information.
12065 @node Select Methods
12066 @chapter Select Methods
12067 @cindex foreign groups
12068 @cindex select methods
12070 A @dfn{foreign group} is a group not read by the usual (or
12071 default) means. It could be, for instance, a group from a different
12072 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12073 personal mail group.
12075 A foreign group (or any group, really) is specified by a @dfn{name} and
12076 a @dfn{select method}. To take the latter first, a select method is a
12077 list where the first element says what back end to use (e.g. @code{nntp},
12078 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12079 name}. There may be additional elements in the select method, where the
12080 value may have special meaning for the back end in question.
12082 One could say that a select method defines a @dfn{virtual server}---so
12083 we do just that (@pxref{Server Buffer}).
12085 The @dfn{name} of the group is the name the back end will recognize the
12088 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12089 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12090 method @code{(nntp "some.where.edu")}. Gnus will call this group
12091 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12092 back end just knows this group as @samp{soc.motss}.
12094 The different methods all have their peculiarities, of course.
12097 * Server Buffer:: Making and editing virtual servers.
12098 * Getting News:: Reading USENET news with Gnus.
12099 * Getting Mail:: Reading your personal mail with Gnus.
12100 * Browsing the Web:: Getting messages from a plethora of Web sources.
12101 * IMAP:: Using Gnus as a @acronym{IMAP} client.
12102 * Other Sources:: Reading directories, files, SOUP packets.
12103 * Combined Groups:: Combining groups into one group.
12104 * Gnus Unplugged:: Reading news and mail offline.
12108 @node Server Buffer
12109 @section Server Buffer
12111 Traditionally, a @dfn{server} is a machine or a piece of software that
12112 one connects to, and then requests information from. Gnus does not
12113 connect directly to any real servers, but does all transactions through
12114 one back end or other. But that's just putting one layer more between
12115 the actual media and Gnus, so we might just as well say that each
12116 back end represents a virtual server.
12118 For instance, the @code{nntp} back end may be used to connect to several
12119 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12120 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12121 use, and what parameters to set by specifying a @dfn{select method}.
12123 These select method specifications can sometimes become quite
12124 complicated---say, for instance, that you want to read from the
12125 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12126 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12127 Anyway, if you had to specify that for each group that used this
12128 server, that would be too much work, so Gnus offers a way of naming
12129 select methods, which is what you do in the server buffer.
12131 To enter the server buffer, use the @kbd{^}
12132 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12135 * Server Buffer Format:: You can customize the look of this buffer.
12136 * Server Commands:: Commands to manipulate servers.
12137 * Example Methods:: Examples server specifications.
12138 * Creating a Virtual Server:: An example session.
12139 * Server Variables:: Which variables to set.
12140 * Servers and Methods:: You can use server names as select methods.
12141 * Unavailable Servers:: Some servers you try to contact may be down.
12144 @vindex gnus-server-mode-hook
12145 @code{gnus-server-mode-hook} is run when creating the server buffer.
12148 @node Server Buffer Format
12149 @subsection Server Buffer Format
12150 @cindex server buffer format
12152 @vindex gnus-server-line-format
12153 You can change the look of the server buffer lines by changing the
12154 @code{gnus-server-line-format} variable. This is a @code{format}-like
12155 variable, with some simple extensions:
12160 How the news is fetched---the back end name.
12163 The name of this server.
12166 Where the news is to be fetched from---the address.
12169 The opened/closed/denied status of the server.
12172 @vindex gnus-server-mode-line-format
12173 The mode line can also be customized by using the
12174 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12175 Formatting}). The following specs are understood:
12185 Also @pxref{Formatting Variables}.
12188 @node Server Commands
12189 @subsection Server Commands
12190 @cindex server commands
12196 @findex gnus-server-add-server
12197 Add a new server (@code{gnus-server-add-server}).
12201 @findex gnus-server-edit-server
12202 Edit a server (@code{gnus-server-edit-server}).
12205 @kindex SPACE (Server)
12206 @findex gnus-server-read-server
12207 Browse the current server (@code{gnus-server-read-server}).
12211 @findex gnus-server-exit
12212 Return to the group buffer (@code{gnus-server-exit}).
12216 @findex gnus-server-kill-server
12217 Kill the current server (@code{gnus-server-kill-server}).
12221 @findex gnus-server-yank-server
12222 Yank the previously killed server (@code{gnus-server-yank-server}).
12226 @findex gnus-server-copy-server
12227 Copy the current server (@code{gnus-server-copy-server}).
12231 @findex gnus-server-list-servers
12232 List all servers (@code{gnus-server-list-servers}).
12236 @findex gnus-server-scan-server
12237 Request that the server scan its sources for new articles
12238 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12243 @findex gnus-server-regenerate-server
12244 Request that the server regenerate all its data structures
12245 (@code{gnus-server-regenerate-server}). This can be useful if you have
12246 a mail back end that has gotten out of sync.
12251 @node Example Methods
12252 @subsection Example Methods
12254 Most select methods are pretty simple and self-explanatory:
12257 (nntp "news.funet.fi")
12260 Reading directly from the spool is even simpler:
12266 As you can see, the first element in a select method is the name of the
12267 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12270 After these two elements, there may be an arbitrary number of
12271 @code{(@var{variable} @var{form})} pairs.
12273 To go back to the first example---imagine that you want to read from
12274 port 15 on that machine. This is what the select method should
12278 (nntp "news.funet.fi" (nntp-port-number 15))
12281 You should read the documentation to each back end to find out what
12282 variables are relevant, but here's an @code{nnmh} example:
12284 @code{nnmh} is a mail back end that reads a spool-like structure. Say
12285 you have two structures that you wish to access: One is your private
12286 mail spool, and the other is a public one. Here's the possible spec for
12290 (nnmh "private" (nnmh-directory "~/private/mail/"))
12293 (This server is then called @samp{private}, but you may have guessed
12296 Here's the method for a public spool:
12300 (nnmh-directory "/usr/information/spool/")
12301 (nnmh-get-new-mail nil))
12307 If you are behind a firewall and only have access to the @acronym{NNTP}
12308 server from the firewall machine, you can instruct Gnus to @code{rlogin}
12309 on the firewall machine and telnet from there to the @acronym{NNTP} server.
12310 Doing this can be rather fiddly, but your virtual server definition
12311 should probably look something like this:
12315 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
12316 (nntp-via-address "the.firewall.machine")
12317 (nntp-address "the.real.nntp.host")
12318 (nntp-end-of-line "\n"))
12321 If you want to use the wonderful @code{ssh} program to provide a
12322 compressed connection over the modem line, you could add the following
12323 configuration to the example above:
12326 (nntp-via-rlogin-command "ssh")
12329 See also @code{nntp-via-rlogin-command-switches}.
12331 If you're behind a firewall, but have direct access to the outside world
12332 through a wrapper command like "runsocks", you could open a socksified
12333 telnet connection to the news server as follows:
12337 (nntp-pre-command "runsocks")
12338 (nntp-open-connection-function nntp-open-via-telnet)
12339 (nntp-address "the.news.server")
12340 (nntp-end-of-line "\n"))
12343 This means that you have to have set up @code{ssh-agent} correctly to
12344 provide automatic authorization, of course. And to get a compressed
12345 connection, you have to have the @samp{Compression} option in the
12346 @code{ssh} @file{config} file.
12349 @node Creating a Virtual Server
12350 @subsection Creating a Virtual Server
12352 If you're saving lots of articles in the cache by using persistent
12353 articles, you may want to create a virtual server to read the cache.
12355 First you need to add a new server. The @kbd{a} command does that. It
12356 would probably be best to use @code{nnml} to read the cache. You
12357 could also use @code{nnspool} or @code{nnmh}, though.
12359 Type @kbd{a nnml RET cache RET}.
12361 You should now have a brand new @code{nnml} virtual server called
12362 @samp{cache}. You now need to edit it to have the right definitions.
12363 Type @kbd{e} to edit the server. You'll be entered into a buffer that
12364 will contain the following:
12374 (nnml-directory "~/News/cache/")
12375 (nnml-active-file "~/News/cache/active"))
12378 Type @kbd{C-c C-c} to return to the server buffer. If you now press
12379 @kbd{RET} over this virtual server, you should be entered into a browse
12380 buffer, and you should be able to enter any of the groups displayed.
12383 @node Server Variables
12384 @subsection Server Variables
12385 @cindex server variables
12386 @cindex server parameters
12388 One sticky point when defining variables (both on back ends and in Emacs
12389 in general) is that some variables are typically initialized from other
12390 variables when the definition of the variables is being loaded. If you
12391 change the ``base'' variable after the variables have been loaded, you
12392 won't change the ``derived'' variables.
12394 This typically affects directory and file variables. For instance,
12395 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
12396 directory variables are initialized from that variable, so
12397 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
12398 new virtual @code{nnml} server, it will @emph{not} suffice to set just
12399 @code{nnml-directory}---you have to explicitly set all the file
12400 variables to be what you want them to be. For a complete list of
12401 variables for each back end, see each back end's section later in this
12402 manual, but here's an example @code{nnml} definition:
12406 (nnml-directory "~/my-mail/")
12407 (nnml-active-file "~/my-mail/active")
12408 (nnml-newsgroups-file "~/my-mail/newsgroups"))
12411 Server variables are often called @dfn{server parameters}.
12413 @node Servers and Methods
12414 @subsection Servers and Methods
12416 Wherever you would normally use a select method
12417 (e.g. @code{gnus-secondary-select-method}, in the group select method,
12418 when browsing a foreign server) you can use a virtual server name
12419 instead. This could potentially save lots of typing. And it's nice all
12423 @node Unavailable Servers
12424 @subsection Unavailable Servers
12426 If a server seems to be unreachable, Gnus will mark that server as
12427 @code{denied}. That means that any subsequent attempt to make contact
12428 with that server will just be ignored. ``It can't be opened,'' Gnus
12429 will tell you, without making the least effort to see whether that is
12430 actually the case or not.
12432 That might seem quite naughty, but it does make sense most of the time.
12433 Let's say you have 10 groups subscribed to on server
12434 @samp{nephelococcygia.com}. This server is located somewhere quite far
12435 away from you and the machine is quite slow, so it takes 1 minute just
12436 to find out that it refuses connection to you today. If Gnus were to
12437 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12438 attempt to do that. Once it has gotten a single ``connection refused'',
12439 it will regard that server as ``down''.
12441 So, what happens if the machine was only feeling unwell temporarily?
12442 How do you test to see whether the machine has come up again?
12444 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12445 with the following commands:
12451 @findex gnus-server-open-server
12452 Try to establish connection to the server on the current line
12453 (@code{gnus-server-open-server}).
12457 @findex gnus-server-close-server
12458 Close the connection (if any) to the server
12459 (@code{gnus-server-close-server}).
12463 @findex gnus-server-deny-server
12464 Mark the current server as unreachable
12465 (@code{gnus-server-deny-server}).
12468 @kindex M-o (Server)
12469 @findex gnus-server-open-all-servers
12470 Open the connections to all servers in the buffer
12471 (@code{gnus-server-open-all-servers}).
12474 @kindex M-c (Server)
12475 @findex gnus-server-close-all-servers
12476 Close the connections to all servers in the buffer
12477 (@code{gnus-server-close-all-servers}).
12481 @findex gnus-server-remove-denials
12482 Remove all marks to whether Gnus was denied connection from any servers
12483 (@code{gnus-server-remove-denials}).
12487 @findex gnus-server-offline-server
12488 Set server status to offline (@code{gnus-server-offline-server}).
12494 @section Getting News
12495 @cindex reading news
12496 @cindex news back ends
12498 A newsreader is normally used for reading news. Gnus currently provides
12499 only two methods of getting news---it can read from an @acronym{NNTP} server,
12500 or it can read from a local spool.
12503 * NNTP:: Reading news from an @acronym{NNTP} server.
12504 * News Spool:: Reading news from the local spool.
12512 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
12513 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
12514 server as the, uhm, address.
12516 If the @acronym{NNTP} server is located at a non-standard port, setting the
12517 third element of the select method to this port number should allow you
12518 to connect to the right port. You'll have to edit the group info for
12519 that (@pxref{Foreign Groups}).
12521 The name of the foreign group can be the same as a native group. In
12522 fact, you can subscribe to the same group from as many different servers
12523 you feel like. There will be no name collisions.
12525 The following variables can be used to create a virtual @code{nntp}
12530 @item nntp-server-opened-hook
12531 @vindex nntp-server-opened-hook
12532 @cindex @sc{mode reader}
12534 @cindex authentification
12535 @cindex nntp authentification
12536 @findex nntp-send-authinfo
12537 @findex nntp-send-mode-reader
12538 is run after a connection has been made. It can be used to send
12539 commands to the @acronym{NNTP} server after it has been contacted. By
12540 default it sends the command @code{MODE READER} to the server with the
12541 @code{nntp-send-mode-reader} function. This function should always be
12542 present in this hook.
12544 @item nntp-authinfo-function
12545 @vindex nntp-authinfo-function
12546 @findex nntp-send-authinfo
12547 @vindex nntp-authinfo-file
12548 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
12549 server. The default function is @code{nntp-send-authinfo}, which looks
12550 through your @file{~/.authinfo} (or whatever you've set the
12551 @code{nntp-authinfo-file} variable to) for applicable entries. If none
12552 are found, it will prompt you for a login name and a password. The
12553 format of the @file{~/.authinfo} file is (almost) the same as the
12554 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
12555 manual page, but here are the salient facts:
12559 The file contains one or more line, each of which define one server.
12562 Each line may contain an arbitrary number of token/value pairs.
12564 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
12565 @samp{default}. In addition Gnus introduces two new tokens, not present
12566 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
12567 @samp{force}. (This is the only way the @file{.authinfo} file format
12568 deviates from the @file{.netrc} file format.) @samp{port} is used to
12569 indicate what port on the server the credentials apply to and
12570 @samp{force} is explained below.
12574 Here's an example file:
12577 machine news.uio.no login larsi password geheimnis
12578 machine nntp.ifi.uio.no login larsi force yes
12581 The token/value pairs may appear in any order; @samp{machine} doesn't
12582 have to be first, for instance.
12584 In this example, both login name and password have been supplied for the
12585 former server, while the latter has only the login name listed, and the
12586 user will be prompted for the password. The latter also has the
12587 @samp{force} tag, which means that the authinfo will be sent to the
12588 @var{nntp} server upon connection; the default (i.e., when there is not
12589 @samp{force} tag) is to not send authinfo to the @var{nntp} server
12590 until the @var{nntp} server asks for it.
12592 You can also add @samp{default} lines that will apply to all servers
12593 that don't have matching @samp{machine} lines.
12599 This will force sending @samp{AUTHINFO} commands to all servers not
12600 previously mentioned.
12602 Remember to not leave the @file{~/.authinfo} file world-readable.
12604 @item nntp-server-action-alist
12605 @vindex nntp-server-action-alist
12606 This is a list of regexps to match on server types and actions to be
12607 taken when matches are made. For instance, if you want Gnus to beep
12608 every time you connect to innd, you could say something like:
12611 (setq nntp-server-action-alist
12612 '(("innd" (ding))))
12615 You probably don't want to do that, though.
12617 The default value is
12620 '(("nntpd 1\\.5\\.11t"
12621 (remove-hook 'nntp-server-opened-hook
12622 'nntp-send-mode-reader)))
12625 This ensures that Gnus doesn't send the @code{MODE READER} command to
12626 nntpd 1.5.11t, since that command chokes that server, I've been told.
12628 @item nntp-maximum-request
12629 @vindex nntp-maximum-request
12630 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
12631 will collect headers by sending a series of @code{head} commands. To
12632 speed things up, the back end sends lots of these commands without
12633 waiting for reply, and then reads all the replies. This is controlled
12634 by the @code{nntp-maximum-request} variable, and is 400 by default. If
12635 your network is buggy, you should set this to 1.
12637 @item nntp-connection-timeout
12638 @vindex nntp-connection-timeout
12639 If you have lots of foreign @code{nntp} groups that you connect to
12640 regularly, you're sure to have problems with @acronym{NNTP} servers not
12641 responding properly, or being too loaded to reply within reasonable
12642 time. This is can lead to awkward problems, which can be helped
12643 somewhat by setting @code{nntp-connection-timeout}. This is an integer
12644 that says how many seconds the @code{nntp} back end should wait for a
12645 connection before giving up. If it is @code{nil}, which is the default,
12646 no timeouts are done.
12648 @c @item nntp-command-timeout
12649 @c @vindex nntp-command-timeout
12650 @c @cindex PPP connections
12651 @c @cindex dynamic IP addresses
12652 @c If you're running Gnus on a machine that has a dynamically assigned
12653 @c address, Gnus may become confused. If the address of your machine
12654 @c changes after connecting to the @acronym{NNTP} server, Gnus will simply sit
12655 @c waiting forever for replies from the server. To help with this
12656 @c unfortunate problem, you can set this command to a number. Gnus will
12657 @c then, if it sits waiting for a reply from the server longer than that
12658 @c number of seconds, shut down the connection, start a new one, and resend
12659 @c the command. This should hopefully be transparent to the user. A
12660 @c likely number is 30 seconds.
12662 @c @item nntp-retry-on-break
12663 @c @vindex nntp-retry-on-break
12664 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
12665 @c hangs. This will have much the same effect as the command timeout
12666 @c described above.
12668 @item nntp-server-hook
12669 @vindex nntp-server-hook
12670 This hook is run as the last step when connecting to an @acronym{NNTP}
12673 @item nntp-buggy-select
12674 @vindex nntp-buggy-select
12675 Set this to non-@code{nil} if your select routine is buggy.
12677 @item nntp-nov-is-evil
12678 @vindex nntp-nov-is-evil
12679 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
12680 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
12683 @item nntp-xover-commands
12684 @vindex nntp-xover-commands
12685 @cindex @acronym{NOV}
12687 List of strings used as commands to fetch @acronym{NOV} lines from a
12688 server. The default value of this variable is @code{("XOVER"
12692 @vindex nntp-nov-gap
12693 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
12694 the server. The server responds with one huge list of lines. However,
12695 if you have read articles 2-5000 in the group, and only want to read
12696 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
12697 lines that you will not need. This variable says how
12698 big a gap between two consecutive articles is allowed to be before the
12699 @code{XOVER} request is split into several request. Note that if your
12700 network is fast, setting this variable to a really small number means
12701 that fetching will probably be slower. If this variable is @code{nil},
12702 @code{nntp} will never split requests. The default is 5.
12704 @item nntp-prepare-server-hook
12705 @vindex nntp-prepare-server-hook
12706 A hook run before attempting to connect to an @acronym{NNTP} server.
12708 @item nntp-warn-about-losing-connection
12709 @vindex nntp-warn-about-losing-connection
12710 If this variable is non-@code{nil}, some noise will be made when a
12711 server closes connection.
12713 @item nntp-record-commands
12714 @vindex nntp-record-commands
12715 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12716 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
12717 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
12718 that doesn't seem to work.
12720 @item nntp-open-connection-function
12721 @vindex nntp-open-connection-function
12722 It is possible to customize how the connection to the nntp server will
12723 be opened. If you specify an @code{nntp-open-connection-function}
12724 parameter, Gnus will use that function to establish the connection.
12725 Five pre-made functions are supplied. These functions can be grouped in
12726 two categories: direct connection functions (three pre-made), and
12727 indirect ones (two pre-made).
12729 @item nntp-prepare-post-hook
12730 @vindex nntp-prepare-post-hook
12731 A hook run just before posting an article. If there is no
12732 @code{Message-ID} header in the article and the news server provides the
12733 recommended ID, it will be added to the article before running this
12734 hook. It is useful to make @code{Cancel-Lock} headers even if you
12735 inhibit Gnus to add a @code{Message-ID} header, you could say:
12738 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12741 Note that not all servers support the recommended ID. This works for
12742 INN versions 2.3.0 and later, for instance.
12744 @item nntp-read-timeout
12745 @vindex nntp-read-timeout
12746 How long nntp should wait between checking for the end of output.
12747 Shorter values mean quicker response, but is more CPU intensive. The
12748 default is 0.1 seconds. If you have a slow line to the server (and
12749 don't like to see Emacs eat your available CPU power), you might set
12752 @item nntp-list-options
12753 @vindex nntp-list-options
12754 List of newsgroup name used for a option of the LIST command to restrict
12755 the listing output to only the specified newsgroups. Each newsgroup name
12756 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
12757 etc. Fortunately, if the server can accept such a option, it will
12758 probably make gnus run faster. You may use it as a server variable as
12762 (setq gnus-select-method
12763 '(nntp "news.somewhere.edu"
12764 (nntp-list-options ("fj.*" "japan.*"))))
12767 @item nntp-options-subscribe
12768 @vindex nntp-options-subscribe
12769 Regexp matching the newsgroup names which will be subscribed
12770 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12771 It may be effective as well as @code{nntp-list-options} even though the
12772 server could not accept a shell-style wildcard as a option of the LIST
12773 command. You may use it as a server variable as follows:
12776 (setq gnus-select-method
12777 '(nntp "news.somewhere.edu"
12778 (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
12781 @item nntp-options-not-subscribe
12782 @vindex nntp-options-not-subscribe
12783 Regexp matching the newsgroup names which will not be subscribed
12784 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12785 It may be effective as well as @code{nntp-list-options} even though the
12786 server could not accept a shell-style wildcard as a option of the LIST
12787 command. You may use it as a server variable as follows:
12790 (setq gnus-select-method
12791 '(nntp "news.somewhere.edu"
12792 (nntp-options-not-subscribe "\\.binaries\\.")))
12797 * Direct Functions:: Connecting directly to the server.
12798 * Indirect Functions:: Connecting indirectly to the server.
12799 * Common Variables:: Understood by several connection functions.
12800 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
12804 @node Direct Functions
12805 @subsubsection Direct Functions
12806 @cindex direct connection functions
12808 These functions are called direct because they open a direct connection
12809 between your machine and the @acronym{NNTP} server. The behavior of these
12810 functions is also affected by commonly understood variables
12811 (@pxref{Common Variables}).
12814 @findex nntp-open-network-stream
12815 @item nntp-open-network-stream
12816 This is the default, and simply connects to some port or other on the
12819 @findex nntp-open-tls-stream
12820 @item nntp-open-tls-stream
12821 Opens a connection to a server over a @dfn{secure} channel. To use
12822 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
12823 installed. You then define a server as follows:
12826 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
12827 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
12829 (nntp "snews.bar.com"
12830 (nntp-open-connection-function nntp-open-tls-stream)
12831 (nntp-port-number )
12832 (nntp-address "snews.bar.com"))
12835 @findex nntp-open-ssl-stream
12836 @item nntp-open-ssl-stream
12837 Opens a connection to a server over a @dfn{secure} channel. To use
12838 this you must have @uref{http://www.openssl.org, OpenSSL} or
12839 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
12840 then define a server as follows:
12843 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
12844 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
12846 (nntp "snews.bar.com"
12847 (nntp-open-connection-function nntp-open-ssl-stream)
12848 (nntp-port-number 563)
12849 (nntp-address "snews.bar.com"))
12852 @findex nntp-open-telnet-stream
12853 @item nntp-open-telnet-stream
12854 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
12855 it. You might wonder why this function exists, since we have the
12856 default @code{nntp-open-network-stream} which would do the job. (One
12857 of) the reason(s) is that if you are behind a firewall but have direct
12858 connections to the outside world thanks to a command wrapper like
12859 @code{runsocks}, you can use it like this:
12863 (nntp-pre-command "runsocks")
12864 (nntp-open-connection-function nntp-open-telnet-stream)
12865 (nntp-address "the.news.server"))
12868 With the default method, you would need to wrap your whole Emacs
12869 session, which is not a good idea.
12873 @node Indirect Functions
12874 @subsubsection Indirect Functions
12875 @cindex indirect connection functions
12877 These functions are called indirect because they connect to an
12878 intermediate host before actually connecting to the @acronym{NNTP} server.
12879 All of these functions and related variables are also said to belong to
12880 the ``via'' family of connection: they're all prefixed with ``via'' to make
12881 things cleaner. The behavior of these functions is also affected by
12882 commonly understood variables (@pxref{Common Variables}).
12885 @item nntp-open-via-rlogin-and-telnet
12886 @findex nntp-open-via-rlogin-and-telnet
12887 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
12888 to the real @acronym{NNTP} server from there. This is useful for instance if
12889 you need to connect to a firewall machine first.
12891 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
12894 @item nntp-via-rlogin-command
12895 @vindex nntp-via-rlogin-command
12896 Command used to log in on the intermediate host. The default is
12897 @samp{rsh}, but @samp{ssh} is a popular alternative.
12899 @item nntp-via-rlogin-command-switches
12900 @vindex nntp-via-rlogin-command-switches
12901 List of strings to be used as the switches to
12902 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
12903 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
12904 @samp{("-C")} in order to compress all data connections, otherwise set
12905 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
12906 the telnet command requires a pseudo-tty allocation on an intermediate
12910 Note that you may want to change the value for @code{nntp-end-of-line}
12911 to @samp{\n} (@pxref{Common Variables}).
12913 @item nntp-open-via-rlogin-and-netcat
12914 @findex nntp-open-via-rlogin-and-netcat
12915 Does essentially the same, but uses @samp{netcat}
12916 (@uref{http://netcat.sourceforge.net/}) instead of @samp{telnet} to
12917 connect to the real @acronym{NNTP} server from the intermediate host.
12919 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
12922 @item nntp-via-netcat-command
12923 @vindex nntp-via-netcat-command
12924 Command used to connect to the real @acronym{NNTP} server from the
12925 intermediate host. The default is @samp{nc}. You can also use other
12926 programs like @samp{connect}
12927 (@uref{http://www.imasy.or.jp/~gotoh/ssh/connect.html}) instead.
12929 @item nntp-via-netcat-switches
12930 @vindex nntp-via-netcat-switches
12931 List of strings to be used as the switches to the
12932 @code{nntp-via-telnet-command} command. The default is @code{nil}.
12934 @item nntp-via-rlogin-command
12935 Command used to log in on the intermediate host. The default is
12936 @samp{rsh}, but @samp{ssh} is a popular alternative.
12938 @item nntp-via-rlogin-command-switches
12939 List of strings to be used as the switches to
12940 @code{nntp-via-rlogin-command}. The default is @code{nil}.
12943 @item nntp-open-via-telnet-and-telnet
12944 @findex nntp-open-via-telnet-and-telnet
12945 Does essentially also the same, but uses @samp{telnet} instead of
12946 @samp{rlogin} to connect to the intermediate host.
12948 @code{nntp-open-via-telnet-and-telnet}-specific variables:
12951 @item nntp-via-telnet-command
12952 @vindex nntp-via-telnet-command
12953 Command used to @code{telnet} the intermediate host. The default is
12956 @item nntp-via-telnet-switches
12957 @vindex nntp-via-telnet-switches
12958 List of strings to be used as the switches to the
12959 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
12961 @item nntp-via-user-password
12962 @vindex nntp-via-user-password
12963 Password to use when logging in on the intermediate host.
12965 @item nntp-via-envuser
12966 @vindex nntp-via-envuser
12967 If non-@code{nil}, the intermediate @code{telnet} session (client and
12968 server both) will support the @code{ENVIRON} option and not prompt for
12969 login name. This works for Solaris @code{telnet}, for instance.
12971 @item nntp-via-shell-prompt
12972 @vindex nntp-via-shell-prompt
12973 Regexp matching the shell prompt on the intermediate host. The default
12974 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
12978 Note that you may want to change the value for @code{nntp-end-of-line}
12979 to @samp{\n} (@pxref{Common Variables}).
12983 Here are some additional variables that are understood by all the above
12988 @item nntp-via-user-name
12989 @vindex nntp-via-user-name
12990 User name to use when connecting to the intermediate host.
12992 @item nntp-via-address
12993 @vindex nntp-via-address
12994 Address of the intermediate host to connect to.
12999 @node Common Variables
13000 @subsubsection Common Variables
13002 The following variables affect the behavior of all, or several of the
13003 pre-made connection functions. When not specified, all functions are
13008 @item nntp-pre-command
13009 @vindex nntp-pre-command
13010 A command wrapper to use when connecting through a non native
13011 connection function (all except @code{nntp-open-network-stream},
13012 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}. This is
13013 where you would put a @samp{SOCKS} wrapper for instance.
13016 @vindex nntp-address
13017 The address of the @acronym{NNTP} server.
13019 @item nntp-port-number
13020 @vindex nntp-port-number
13021 Port number to connect to the @acronym{NNTP} server. The default is
13022 @samp{nntp}. If you use @acronym{NNTP} over
13023 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
13024 than named ports (i.e, use @samp{563} instead of @samp{snews} or
13025 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
13026 not work with named ports.
13028 @item nntp-end-of-line
13029 @vindex nntp-end-of-line
13030 String to use as end-of-line marker when talking to the @acronym{NNTP}
13031 server. This is @samp{\r\n} by default, but should be @samp{\n} when
13032 using a non native telnet connection function.
13034 @item nntp-telnet-command
13035 @vindex nntp-telnet-command
13036 Command to use when connecting to the @acronym{NNTP} server through
13037 @samp{telnet}. This is @emph{not} for an intermediate host. This is
13038 just for the real @acronym{NNTP} server. The default is
13041 @item nntp-telnet-switches
13042 @vindex nntp-telnet-switches
13043 A list of switches to pass to @code{nntp-telnet-command}. The default
13049 @subsubsection NNTP marks
13050 @cindex storing NNTP marks
13052 Gnus stores marks (@pxref{Marking Articles}) for @acronym{NNTP}
13053 servers in marks files. A marks file records what marks you have set
13054 in a group and each file is specific to the corresponding server.
13055 Marks files are stored in @file{~/News/marks}
13056 (@code{nntp-marks-directory}) under a classic hierarchy resembling
13057 that of a news server, for example marks for the group
13058 @samp{gmane.discuss} on the news.gmane.org server will be stored in
13059 the file @file{~/News/marks/news.gmane.org/gmane/discuss/.marks}.
13061 Marks files are useful because you can copy the @file{~/News/marks}
13062 directory (using rsync, scp or whatever) to another Gnus installation,
13063 and it will realize what articles you have read and marked. The data
13064 in @file{~/News/marks} has priority over the same data in
13065 @file{~/.newsrc.eld}.
13067 Note that marks files are very much server-specific: Gnus remembers
13068 the article numbers so if you don't use the same servers on both
13069 installations things are most likely to break (most @acronym{NNTP}
13070 servers do not use the same article numbers as any other server).
13071 However, if you use servers A, B, C on one installation and servers A,
13072 D, E on the other, you can sync the marks files for A and then you'll
13073 get synchronization for that server between the two installations.
13075 Using @acronym{NNTP} marks can possibly incur a performance penalty so
13076 if Gnus feels sluggish, try setting the @code{nntp-marks-is-evil}
13077 variable to @code{t}. Marks will then be stored in @file{~/.newsrc.eld}.
13083 @item nntp-marks-is-evil
13084 @vindex nntp-marks-is-evil
13085 If non-@code{nil}, this back end will ignore any marks files. The
13086 default is @code{nil}.
13088 @item nntp-marks-directory
13089 @vindex nntp-marks-directory
13090 The directory where marks for nntp groups will be stored.
13096 @subsection News Spool
13100 Subscribing to a foreign group from the local spool is extremely easy,
13101 and might be useful, for instance, to speed up reading groups that
13102 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
13105 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
13106 anything else) as the address.
13108 If you have access to a local spool, you should probably use that as the
13109 native select method (@pxref{Finding the News}). It is normally faster
13110 than using an @code{nntp} select method, but might not be. It depends.
13111 You just have to try to find out what's best at your site.
13115 @item nnspool-inews-program
13116 @vindex nnspool-inews-program
13117 Program used to post an article.
13119 @item nnspool-inews-switches
13120 @vindex nnspool-inews-switches
13121 Parameters given to the inews program when posting an article.
13123 @item nnspool-spool-directory
13124 @vindex nnspool-spool-directory
13125 Where @code{nnspool} looks for the articles. This is normally
13126 @file{/usr/spool/news/}.
13128 @item nnspool-nov-directory
13129 @vindex nnspool-nov-directory
13130 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
13131 @file{/usr/spool/news/over.view/}.
13133 @item nnspool-lib-dir
13134 @vindex nnspool-lib-dir
13135 Where the news lib dir is (@file{/usr/lib/news/} by default).
13137 @item nnspool-active-file
13138 @vindex nnspool-active-file
13139 The name of the active file.
13141 @item nnspool-newsgroups-file
13142 @vindex nnspool-newsgroups-file
13143 The name of the group descriptions file.
13145 @item nnspool-history-file
13146 @vindex nnspool-history-file
13147 The name of the news history file.
13149 @item nnspool-active-times-file
13150 @vindex nnspool-active-times-file
13151 The name of the active date file.
13153 @item nnspool-nov-is-evil
13154 @vindex nnspool-nov-is-evil
13155 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13158 @item nnspool-sift-nov-with-sed
13159 @vindex nnspool-sift-nov-with-sed
13161 If non-@code{nil}, which is the default, use @code{sed} to get the
13162 relevant portion from the overview file. If @code{nil},
13163 @code{nnspool} will load the entire file into a buffer and process it
13170 @section Getting Mail
13171 @cindex reading mail
13174 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13178 * Mail in a Newsreader:: Important introductory notes.
13179 * Getting Started Reading Mail:: A simple cookbook example.
13180 * Splitting Mail:: How to create mail groups.
13181 * Mail Sources:: How to tell Gnus where to get mail from.
13182 * Mail Back End Variables:: Variables for customizing mail handling.
13183 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
13184 * Group Mail Splitting:: Use group customize to drive mail splitting.
13185 * Incorporating Old Mail:: What about the old mail you have?
13186 * Expiring Mail:: Getting rid of unwanted mail.
13187 * Washing Mail:: Removing cruft from the mail you get.
13188 * Duplicates:: Dealing with duplicated mail.
13189 * Not Reading Mail:: Using mail back ends for reading other files.
13190 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
13194 @node Mail in a Newsreader
13195 @subsection Mail in a Newsreader
13197 If you are used to traditional mail readers, but have decided to switch
13198 to reading mail with Gnus, you may find yourself experiencing something
13199 of a culture shock.
13201 Gnus does not behave like traditional mail readers. If you want to make
13202 it behave that way, you can, but it's an uphill battle.
13204 Gnus, by default, handles all its groups using the same approach. This
13205 approach is very newsreaderly---you enter a group, see the new/unread
13206 messages, and when you read the messages, they get marked as read, and
13207 you don't see them any more. (Unless you explicitly ask for them.)
13209 In particular, you do not do anything explicitly to delete messages.
13211 Does this mean that all the messages that have been marked as read are
13212 deleted? How awful!
13214 But, no, it means that old messages are @dfn{expired} according to some
13215 scheme or other. For news messages, the expire process is controlled by
13216 the news administrator; for mail, the expire process is controlled by
13217 you. The expire process for mail is covered in depth in @ref{Expiring
13220 What many Gnus users find, after using it a while for both news and
13221 mail, is that the transport mechanism has very little to do with how
13222 they want to treat a message.
13224 Many people subscribe to several mailing lists. These are transported
13225 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13226 answering, or even reading these messages very carefully. We may not
13227 need to save them because if we should need to read one again, they are
13228 archived somewhere else.
13230 Some people have local news groups which have only a handful of readers.
13231 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13232 to read and answer a large fraction of the messages very carefully in
13233 order to do our work. And there may not be an archive, so we may need
13234 to save the interesting messages the same way we would personal mail.
13236 The important distinction turns out to be not the transport mechanism,
13237 but other factors such as how interested we are in the subject matter,
13238 or how easy it is to retrieve the message if we need to read it again.
13240 Gnus provides many options for sorting mail into ``groups'' which behave
13241 like newsgroups, and for treating each group (whether mail or news)
13244 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13245 that Gnus should grow up and be a male, er, mail reader. It is possible
13246 to whip Gnus into a more mailreaderly being, but, as said before, it's
13247 not easy. People who prefer proper mail readers should try @sc{vm}
13248 instead, which is an excellent, and proper, mail reader.
13250 I don't mean to scare anybody off, but I want to make it clear that you
13251 may be required to learn a new way of thinking about messages. After
13252 you've been subjected to The Gnus Way, you will come to love it. I can
13253 guarantee it. (At least the guy who sold me the Emacs Subliminal
13254 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13255 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13259 @node Getting Started Reading Mail
13260 @subsection Getting Started Reading Mail
13262 It's quite easy to use Gnus to read your new mail. You just plonk the
13263 mail back end of your choice into @code{gnus-secondary-select-methods},
13264 and things will happen automatically.
13266 For instance, if you want to use @code{nnml} (which is a ``one file per
13267 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13270 (setq gnus-secondary-select-methods '((nnml "")))
13273 Now, the next time you start Gnus, this back end will be queried for new
13274 articles, and it will move all the messages in your spool file to its
13275 directory, which is @file{~/Mail/} by default. The new group that will
13276 be created (@samp{mail.misc}) will be subscribed, and you can read it
13277 like any other group.
13279 You will probably want to split the mail into several groups, though:
13282 (setq nnmail-split-methods
13283 '(("junk" "^From:.*Lars Ingebrigtsen")
13284 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13288 This will result in three new @code{nnml} mail groups being created:
13289 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
13290 mail that doesn't fit into the first two groups will be placed in the
13293 This should be sufficient for reading mail with Gnus. You might want to
13294 give the other sections in this part of the manual a perusal, though.
13295 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13298 @node Splitting Mail
13299 @subsection Splitting Mail
13300 @cindex splitting mail
13301 @cindex mail splitting
13302 @cindex mail filtering (splitting)
13304 @vindex nnmail-split-methods
13305 The @code{nnmail-split-methods} variable says how the incoming mail is
13306 to be split into groups.
13309 (setq nnmail-split-methods
13310 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
13311 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
13312 ("mail.other" "")))
13315 This variable is a list of lists, where the first element of each of
13316 these lists is the name of the mail group (they do not have to be called
13317 something beginning with @samp{mail}, by the way), and the second
13318 element is a regular expression used on the header of each mail to
13319 determine if it belongs in this mail group. The first string may
13320 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
13321 insert sub-expressions from the matched text. For instance:
13324 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
13328 In that case, @code{nnmail-split-lowercase-expanded} controls whether
13329 the inserted text should be made lowercase. @xref{Fancy Mail Splitting}.
13331 The second element can also be a function. In that case, it will be
13332 called narrowed to the headers with the first element of the rule as the
13333 argument. It should return a non-@code{nil} value if it thinks that the
13334 mail belongs in that group.
13336 The last of these groups should always be a general one, and the regular
13337 expression should @emph{always} be @samp{*} so that it matches any mails
13338 that haven't been matched by any of the other regexps. (These rules are
13339 processed from the beginning of the alist toward the end. The first
13340 rule to make a match will ``win'', unless you have crossposting enabled.
13341 In that case, all matching rules will ``win''.) When new groups are
13342 created by splitting mail, you may want to run
13343 @code{gnus-group-find-new-groups} to see the new groups.
13345 If you like to tinker with this yourself, you can set this variable to a
13346 function of your choice. This function will be called without any
13347 arguments in a buffer narrowed to the headers of an incoming mail
13348 message. The function should return a list of group names that it
13349 thinks should carry this mail message.
13351 Note that the mail back ends are free to maul the poor, innocent,
13352 incoming headers all they want to. They all add @code{Lines} headers;
13353 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
13354 @code{From<SPACE>} line to something else.
13356 @vindex nnmail-crosspost
13357 The mail back ends all support cross-posting. If several regexps match,
13358 the mail will be ``cross-posted'' to all those groups.
13359 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
13360 that no articles are crossposted to the general (@samp{*}) group.
13362 @vindex nnmail-crosspost-link-function
13365 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
13366 the crossposted articles. However, not all file systems support hard
13367 links. If that's the case for you, set
13368 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
13369 variable is @code{add-name-to-file} by default.)
13371 @kindex M-x nnmail-split-history
13372 @findex nnmail-split-history
13373 If you wish to see where the previous mail split put the messages, you
13374 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
13375 where re-spooling messages would put the messages, you can use
13376 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
13379 @vindex nnmail-split-header-length-limit
13380 Header lines longer than the value of
13381 @code{nnmail-split-header-length-limit} are excluded from the split
13384 @vindex nnmail-mail-splitting-charset
13385 @vindex nnmail-mail-splitting-decodes
13386 By default the splitting codes @acronym{MIME} decodes headers so you
13387 can match on non-@acronym{ASCII} strings. The
13388 @code{nnmail-mail-splitting-charset} variable specifies the default
13389 charset for decoding. The behaviour can be turned off completely by
13390 binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is
13391 useful if you want to match articles based on the raw header data.
13393 @vindex nnmail-resplit-incoming
13394 By default, splitting is performed on all incoming messages. If you
13395 specify a @code{directory} entry for the variable @code{mail-sources}
13396 (@pxref{Mail Source Specifiers}), however, then splitting does
13397 @emph{not} happen by default. You can set the variable
13398 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
13399 splitting happen even in this case. (This variable has no effect on
13400 other kinds of entries.)
13402 Gnus gives you all the opportunity you could possibly want for shooting
13403 yourself in the foot. Let's say you create a group that will contain
13404 all the mail you get from your boss. And then you accidentally
13405 unsubscribe from the group. Gnus will still put all the mail from your
13406 boss in the unsubscribed group, and so, when your boss mails you ``Have
13407 that report ready by Monday or you're fired!'', you'll never see it and,
13408 come Tuesday, you'll still believe that you're gainfully employed while
13409 you really should be out collecting empty bottles to save up for next
13410 month's rent money.
13414 @subsection Mail Sources
13416 Mail can be gotten from many different sources---the mail spool, from
13417 a @acronym{POP} mail server, from a procmail directory, or from a
13418 maildir, for instance.
13421 * Mail Source Specifiers:: How to specify what a mail source is.
13422 * Mail Source Customization:: Some variables that influence things.
13423 * Fetching Mail:: Using the mail source specifiers.
13427 @node Mail Source Specifiers
13428 @subsubsection Mail Source Specifiers
13430 @cindex mail server
13433 @cindex mail source
13435 You tell Gnus how to fetch mail by setting @code{mail-sources}
13436 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
13441 (pop :server "pop3.mailserver.com" :user "myname")
13444 As can be observed, a mail source specifier is a list where the first
13445 element is a @dfn{mail source type}, followed by an arbitrary number of
13446 @dfn{keywords}. Keywords that are not explicitly specified are given
13449 The following mail source types are available:
13453 Get mail from a single file; typically from the mail spool.
13459 The file name. Defaults to the value of the @env{MAIL}
13460 environment variable or the value of @code{rmail-spool-directory}
13461 (usually something like @file{/usr/mail/spool/user-name}).
13465 Script run before/after fetching mail.
13468 An example file mail source:
13471 (file :path "/usr/spool/mail/user-name")
13474 Or using the default file name:
13480 If the mail spool file is not located on the local machine, it's best
13481 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
13482 You can not use ange-ftp file names here---it has no way to lock the
13483 mail spool while moving the mail.
13485 If it's impossible to set up a proper server, you can use ssh instead.
13489 '((file :prescript "ssh host bin/getmail >%t")))
13492 The @samp{getmail} script would look something like the following:
13496 # getmail - move mail from spool to stdout
13499 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
13501 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
13504 Alter this script to fit find the @samp{movemail} you want to use.
13508 @vindex nnmail-scan-directory-mail-source-once
13509 Get mail from several files in a directory. This is typically used
13510 when you have procmail split the incoming mail into several files.
13511 That is, there is a one-to-one correspondence between files in that
13512 directory and groups, so that mail from the file @file{foo.bar.spool}
13513 will be put in the group @code{foo.bar}. (You can change the suffix
13514 to be used instead of @code{.spool}.) Setting
13515 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
13516 Gnus to scan the mail source only once. This is particularly useful
13517 if you want to scan mail groups at a specified level.
13519 @vindex nnmail-resplit-incoming
13520 There is also the variable @code{nnmail-resplit-incoming}, if you set
13521 that to a non-@code{nil} value, then the normal splitting process is
13522 applied to all the files from the directory, @ref{Splitting Mail}.
13528 The name of the directory where the files are. There is no default
13532 Only files ending with this suffix are used. The default is
13536 Only files that have this predicate return non-@code{nil} are returned.
13537 The default is @code{identity}. This is used as an additional
13538 filter---only files that have the right suffix @emph{and} satisfy this
13539 predicate are considered.
13543 Script run before/after fetching mail.
13547 An example directory mail source:
13550 (directory :path "/home/user-name/procmail-dir/"
13555 Get mail from a @acronym{POP} server.
13561 The name of the @acronym{POP} server. The default is taken from the
13562 @env{MAILHOST} environment variable.
13565 The port number of the @acronym{POP} server. This can be a number (eg,
13566 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
13567 string, it should be a service name as listed in @file{/etc/services} on
13568 Unix systems. The default is @samp{"pop3"}. On some systems you might
13569 need to specify it as @samp{"pop-3"} instead.
13572 The user name to give to the @acronym{POP} server. The default is the login
13576 The password to give to the @acronym{POP} server. If not specified,
13577 the user is prompted.
13580 The program to use to fetch mail from the @acronym{POP} server. This
13581 should be a @code{format}-like string. Here's an example:
13584 fetchmail %u@@%s -P %p %t
13587 The valid format specifier characters are:
13591 The name of the file the mail is to be moved to. This must always be
13592 included in this string.
13595 The name of the server.
13598 The port number of the server.
13601 The user name to use.
13604 The password to use.
13607 The values used for these specs are taken from the values you give the
13608 corresponding keywords.
13611 A script to be run before fetching the mail. The syntax is the same as
13612 the @code{:program} keyword. This can also be a function to be run.
13615 A script to be run after fetching the mail. The syntax is the same as
13616 the @code{:program} keyword. This can also be a function to be run.
13619 The function to use to fetch mail from the @acronym{POP} server. The
13620 function is called with one parameter---the name of the file where the
13621 mail should be moved to.
13623 @item :authentication
13624 This can be either the symbol @code{password} or the symbol @code{apop}
13625 and says what authentication scheme to use. The default is
13629 What stream to use for connecting to the server, this can be the symbol
13630 @code{ssl}, the symbol @code{tls} or others. The default is @code{nil}
13631 and use insecure connections. Note that for SSL/TLS, you need external
13632 programs and libraries:
13636 @dfn{ssl:} Connect through SSL@. Requires OpenSSL (the program
13637 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
13638 library @samp{ssl.el}.
13640 @dfn{starttls:} Connect via the STARTTLS extension (similar to SSL)@.
13641 Requires the external library @samp{starttls.el} and program
13646 Non-@code{nil} if mail is to be left on the server and UIDL used for
13647 message retrieval. The default is @code{nil}.
13651 @vindex pop3-movemail
13652 @vindex pop3-leave-mail-on-server
13653 If the @code{:program} and @code{:function} keywords aren't specified,
13654 @code{pop3-movemail} will be used. If the
13655 @code{pop3-leave-mail-on-server} is non-@code{nil} the mail is to be
13656 left on the @acronym{POP} server after fetching when using
13657 @code{pop3-movemail}. Note that POP servers maintain no state
13658 information between sessions, so what the client believes is there and
13659 what is actually there may not match up. If they do not, then the whole
13660 thing can fall apart and leave you with a corrupt mailbox.
13662 Here are some examples. Fetch from the default @acronym{POP} server,
13663 using the default user name, and default fetcher:
13669 Fetch from a named server with a named user and password:
13672 (pop :server "my.pop.server"
13673 :user "user-name" :password "secret")
13676 Use @samp{movemail} to move the mail:
13679 (pop :program "movemail po:%u %t %p")
13683 Get mail from a maildir. This is a type of mailbox that is supported by
13684 at least qmail and postfix, where each file in a special directory
13685 contains exactly one mail.
13691 The name of the directory where the mails are stored. The default is
13692 taken from the @env{MAILDIR} environment variable or
13695 The subdirectories of the Maildir. The default is
13696 @samp{("new" "cur")}.
13698 @c If you sometimes look at your mail through a pop3 daemon before fetching
13699 @c them with Gnus, you may also have to fetch your mails from the
13700 @c @code{cur} directory inside the maildir, like in the first example
13703 You can also get mails from remote hosts (because maildirs don't suffer
13704 from locking problems).
13708 Two example maildir mail sources:
13711 (maildir :path "/home/user-name/Maildir/"
13712 :subdirs ("cur" "new"))
13716 (maildir :path "/user@@remotehost.org:~/Maildir/"
13721 Get mail from a @acronym{IMAP} server. If you don't want to use
13722 @acronym{IMAP} as intended, as a network mail reading protocol (ie
13723 with nnimap), for some reason or other, Gnus let you treat it similar
13724 to a @acronym{POP} server and fetches articles from a given
13725 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
13727 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
13728 may need external programs and libraries, @xref{IMAP}.
13734 The name of the @acronym{IMAP} server. The default is taken from the
13735 @env{MAILHOST} environment variable.
13738 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
13739 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
13742 The user name to give to the @acronym{IMAP} server. The default is the login
13746 The password to give to the @acronym{IMAP} server. If not specified, the user is
13750 What stream to use for connecting to the server, this is one of the
13751 symbols in @code{imap-stream-alist}. Right now, this means
13752 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
13753 @samp{ssl}, @samp{shell} or the default @samp{network}.
13755 @item :authentication
13756 Which authenticator to use for authenticating to the server, this is
13757 one of the symbols in @code{imap-authenticator-alist}. Right now,
13758 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13759 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13762 When using the `shell' :stream, the contents of this variable is
13763 mapped into the @code{imap-shell-program} variable. This should be a
13764 @code{format}-like string (or list of strings). Here's an example:
13770 The valid format specifier characters are:
13774 The name of the server.
13777 User name from @code{imap-default-user}.
13780 The port number of the server.
13783 The values used for these specs are taken from the values you give the
13784 corresponding keywords.
13787 The name of the mailbox to get mail from. The default is @samp{INBOX}
13788 which normally is the mailbox which receive incoming mail.
13791 The predicate used to find articles to fetch. The default, @samp{UNSEEN
13792 UNDELETED}, is probably the best choice for most people, but if you
13793 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
13794 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13795 Then all articles in the mailbox is fetched, no matter what. For a
13796 complete list of predicates, see RFC 2060 section 6.4.4.
13799 How to flag fetched articles on the server, the default @samp{\Deleted}
13800 will mark them as deleted, an alternative would be @samp{\Seen} which
13801 would simply mark them as read. These are the two most likely choices,
13802 but more flags are defined in RFC 2060 section 2.3.2.
13805 If non-@code{nil}, don't remove all articles marked as deleted in the
13806 mailbox after finishing the fetch.
13810 An example @acronym{IMAP} mail source:
13813 (imap :server "mail.mycorp.com"
13815 :fetchflag "\\Seen")
13819 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
13820 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
13821 @uref{http://mail.yahoo.com/}.
13823 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
13824 required for url "4.0pre.46".
13826 WARNING: Mails may be lost. NO WARRANTY.
13832 The type of the webmail server. The default is @code{hotmail}. The
13833 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13836 The user name to give to the webmail server. The default is the login
13840 The password to give to the webmail server. If not specified, the user is
13844 If non-@code{nil}, only fetch unread articles and don't move them to
13845 trash folder after finishing the fetch.
13849 An example webmail source:
13852 (webmail :subtype 'hotmail
13854 :password "secret")
13859 @item Common Keywords
13860 Common keywords can be used in any type of mail source.
13866 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
13867 use directory source to get mail, you can specify it as in this
13872 '((directory :path "/home/pavel/.Spool/"
13877 Gnus will then fetch your mail even when you are unplugged. This is
13878 useful when you use local mail and news.
13883 @subsubsection Function Interface
13885 Some of the above keywords specify a Lisp function to be executed.
13886 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
13887 the value of the keyword while the function is executing. For example,
13888 consider the following mail-source setting:
13891 (setq mail-sources '((pop :user "jrl"
13892 :server "pophost" :function fetchfunc)))
13895 While the function @code{fetchfunc} is executing, the symbol @code{user}
13896 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
13897 @code{"pophost"}. The symbols @code{port}, @code{password},
13898 @code{program}, @code{prescript}, @code{postscript}, @code{function},
13899 and @code{authentication} are also bound (to their default values).
13901 See above for a list of keywords for each type of mail source.
13904 @node Mail Source Customization
13905 @subsubsection Mail Source Customization
13907 The following is a list of variables that influence how the mail is
13908 fetched. You would normally not need to set or change any of these
13912 @item mail-source-crash-box
13913 @vindex mail-source-crash-box
13914 File where mail will be stored while processing it. The default is@*
13915 @file{~/.emacs-mail-crash-box}.
13917 @item mail-source-delete-incoming
13918 @vindex mail-source-delete-incoming
13919 If non-@code{nil}, delete incoming files after handling them. If
13920 @code{t}, delete the files immediately, if @code{nil}, never delete any
13921 files. If a positive number, delete files older than number of days
13922 (This will only happen, when receiving new mail). You may also set
13923 @code{mail-source-delete-incoming} to @code{nil} and call
13924 @code{mail-source-delete-old-incoming} from a hook or interactively.
13926 @item mail-source-delete-old-incoming-confirm
13927 @vindex mail-source-delete-old-incoming-confirm
13928 If non-@code{nil}, ask for for confirmation before deleting old incoming
13929 files. This variable only applies when
13930 @code{mail-source-delete-incoming} is a positive number.
13932 @item mail-source-ignore-errors
13933 @vindex mail-source-ignore-errors
13934 If non-@code{nil}, ignore errors when reading mail from a mail source.
13936 @item mail-source-directory
13937 @vindex mail-source-directory
13938 Directory where incoming mail source files (if any) will be stored. The
13939 default is @file{~/Mail/}. At present, the only thing this is used for
13940 is to say where the incoming files will be stored if the variable
13941 @code{mail-source-delete-incoming} is @code{nil} or a number.
13943 @item mail-source-incoming-file-prefix
13944 @vindex mail-source-incoming-file-prefix
13945 Prefix for file name for storing incoming mail. The default is
13946 @file{Incoming}, in which case files will end up with names like
13947 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
13948 relevant if @code{mail-source-delete-incoming} is @code{nil}.
13950 @item mail-source-default-file-modes
13951 @vindex mail-source-default-file-modes
13952 All new mail files will get this file mode. The default is 384.
13954 @item mail-source-movemail-program
13955 @vindex mail-source-movemail-program
13956 If non-@code{nil}, name of program for fetching new mail. If
13957 @code{nil}, @code{movemail} in @var{exec-directory}.
13962 @node Fetching Mail
13963 @subsubsection Fetching Mail
13965 @vindex mail-sources
13966 @vindex nnmail-spool-file
13967 The way to actually tell Gnus where to get new mail from is to set
13968 @code{mail-sources} to a list of mail source specifiers
13969 (@pxref{Mail Source Specifiers}).
13971 If this variable (and the obsolescent @code{nnmail-spool-file}) is
13972 @code{nil}, the mail back ends will never attempt to fetch mail by
13975 If you want to fetch mail both from your local spool as well as a
13976 @acronym{POP} mail server, you'd say something like:
13981 (pop :server "pop3.mail.server"
13982 :password "secret")))
13985 Or, if you don't want to use any of the keyword defaults:
13989 '((file :path "/var/spool/mail/user-name")
13990 (pop :server "pop3.mail.server"
13993 :password "secret")))
13997 When you use a mail back end, Gnus will slurp all your mail from your
13998 inbox and plonk it down in your home directory. Gnus doesn't move any
13999 mail if you're not using a mail back end---you have to do a lot of magic
14000 invocations first. At the time when you have finished drawing the
14001 pentagram, lightened the candles, and sacrificed the goat, you really
14002 shouldn't be too surprised when Gnus moves your mail.
14006 @node Mail Back End Variables
14007 @subsection Mail Back End Variables
14009 These variables are (for the most part) pertinent to all the various
14013 @vindex nnmail-read-incoming-hook
14014 @item nnmail-read-incoming-hook
14015 The mail back ends all call this hook after reading new mail. You can
14016 use this hook to notify any mail watch programs, if you want to.
14018 @vindex nnmail-split-hook
14019 @item nnmail-split-hook
14020 @findex gnus-article-decode-encoded-words
14021 @cindex RFC 1522 decoding
14022 @cindex RFC 2047 decoding
14023 Hook run in the buffer where the mail headers of each message is kept
14024 just before the splitting based on these headers is done. The hook is
14025 free to modify the buffer contents in any way it sees fit---the buffer
14026 is discarded after the splitting has been done, and no changes performed
14027 in the buffer will show up in any files.
14028 @code{gnus-article-decode-encoded-words} is one likely function to add
14031 @vindex nnmail-pre-get-new-mail-hook
14032 @vindex nnmail-post-get-new-mail-hook
14033 @item nnmail-pre-get-new-mail-hook
14034 @itemx nnmail-post-get-new-mail-hook
14035 These are two useful hooks executed when treating new incoming
14036 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
14037 starting to handle the new mail) and
14038 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
14039 is done). Here's and example of using these two hooks to change the
14040 default file modes the new mail files get:
14043 (add-hook 'nnmail-pre-get-new-mail-hook
14044 (lambda () (set-default-file-modes 511)))
14046 (add-hook 'nnmail-post-get-new-mail-hook
14047 (lambda () (set-default-file-modes 551)))
14050 @item nnmail-use-long-file-names
14051 @vindex nnmail-use-long-file-names
14052 If non-@code{nil}, the mail back ends will use long file and directory
14053 names. Groups like @samp{mail.misc} will end up in directories
14054 (assuming use of @code{nnml} back end) or files (assuming use of
14055 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
14056 the same group will end up in @file{mail/misc}.
14058 @item nnmail-delete-file-function
14059 @vindex nnmail-delete-file-function
14060 @findex delete-file
14061 Function called to delete files. It is @code{delete-file} by default.
14063 @item nnmail-cache-accepted-message-ids
14064 @vindex nnmail-cache-accepted-message-ids
14065 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
14066 the back end (via @code{Gcc}, for instance) into the mail duplication
14067 discovery cache. The default is @code{nil}.
14069 @item nnmail-cache-ignore-groups
14070 @vindex nnmail-cache-ignore-groups
14071 This can be a regular expression or a list of regular expressions.
14072 Group names that match any of the regular expressions will never be
14073 recorded in the @code{Message-ID} cache.
14075 This can be useful, for example, when using Fancy Splitting
14076 (@pxref{Fancy Mail Splitting}) together with the function
14077 @code{nnmail-split-fancy-with-parent}.
14082 @node Fancy Mail Splitting
14083 @subsection Fancy Mail Splitting
14084 @cindex mail splitting
14085 @cindex fancy mail splitting
14087 @vindex nnmail-split-fancy
14088 @findex nnmail-split-fancy
14089 If the rather simple, standard method for specifying how to split mail
14090 doesn't allow you to do what you want, you can set
14091 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
14092 play with the @code{nnmail-split-fancy} variable.
14094 Let's look at an example value of this variable first:
14097 ;; @r{Messages from the mailer daemon are not crossposted to any of}
14098 ;; @r{the ordinary groups. Warnings are put in a separate group}
14099 ;; @r{from real errors.}
14100 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
14102 ;; @r{Non-error messages are crossposted to all relevant}
14103 ;; @r{groups, but we don't crosspost between the group for the}
14104 ;; @r{(ding) list and the group for other (ding) related mail.}
14105 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
14106 ("subject" "ding" "ding.misc"))
14107 ;; @r{Other mailing lists@dots{}}
14108 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
14109 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
14110 ;; @r{Both lists below have the same suffix, so prevent}
14111 ;; @r{cross-posting to mkpkg.list of messages posted only to}
14112 ;; @r{the bugs- list, but allow cross-posting when the}
14113 ;; @r{message was really cross-posted.}
14114 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
14115 (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list")
14116 ;; @r{People@dots{}}
14117 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
14118 ;; @r{Unmatched mail goes to the catch all group.}
14122 This variable has the format of a @dfn{split}. A split is a
14123 (possibly) recursive structure where each split may contain other
14124 splits. Here are the possible split syntaxes:
14129 If the split is a string, that will be taken as a group name. Normal
14130 regexp match expansion will be done. See below for examples.
14132 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split})
14133 If the split is a list, the first element of which is a string, then
14134 store the message as specified by @var{split}, if header @var{field}
14135 (a regexp) contains @var{value} (also a regexp). If @var{restrict}
14136 (yet another regexp) matches some string after @var{field} and before
14137 the end of the matched @var{value}, the @var{split} is ignored. If
14138 none of the @var{restrict} clauses match, @var{split} is processed.
14140 @item (| @var{split} @dots{})
14141 If the split is a list, and the first element is @code{|} (vertical
14142 bar), then process each @var{split} until one of them matches. A
14143 @var{split} is said to match if it will cause the mail message to be
14144 stored in one or more groups.
14146 @item (& @var{split} @dots{})
14147 If the split is a list, and the first element is @code{&}, then
14148 process all @var{split}s in the list.
14151 If the split is the symbol @code{junk}, then don't save (i.e., delete)
14152 this message. Use with extreme caution.
14154 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
14155 If the split is a list, and the first element is @samp{:}, then the
14156 second element will be called as a function with @var{args} given as
14157 arguments. The function should return a @var{split}.
14160 For instance, the following function could be used to split based on the
14161 body of the messages:
14164 (defun split-on-body ()
14168 (goto-char (point-min))
14169 (when (re-search-forward "Some.*string" nil t)
14173 The buffer is narrowed to the message in question when @var{function}
14174 is run. That's why @code{(widen)} needs to be called after
14175 @code{save-excursion} and @code{save-restriction} in the example
14176 above. Also note that with the nnimap back end, message bodies will
14177 not be downloaded by default. You need to set
14178 @code{nnimap-split-download-body} to @code{t} to do that
14179 (@pxref{Splitting in IMAP}).
14181 @item (! @var{func} @var{split})
14182 If the split is a list, and the first element is @code{!}, then
14183 @var{split} will be processed, and @var{func} will be called as a
14184 function with the result of @var{split} as argument. @var{func}
14185 should return a split.
14188 If the split is @code{nil}, it is ignored.
14192 In these splits, @var{field} must match a complete field name.
14193 @var{value} must match a complete word according to the fundamental mode
14194 syntax table. You can use @code{.*} in the regexps to match partial
14195 field names or words. In other words, all @var{value}'s are wrapped in
14196 @samp{\<} and @samp{\>} pairs.
14198 @vindex nnmail-split-abbrev-alist
14199 @var{field} and @var{value} can also be Lisp symbols, in that case
14200 they are expanded as specified by the variable
14201 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
14202 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14203 contains the associated value. Predefined entries in
14204 @code{nnmail-split-abbrev-alist} include:
14208 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14210 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14211 @samp{Resent-To} and @samp{Resent-Cc} fields.
14213 Is the union of the @code{from} and @code{to} entries.
14216 @vindex nnmail-split-fancy-syntax-table
14217 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14218 when all this splitting is performed.
14220 If you want to have Gnus create groups dynamically based on some
14221 information in the headers (i.e., do @code{replace-match}-like
14222 substitutions in the group names), you can say things like:
14225 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14228 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14229 will be filed in @samp{mail.debian.foo}.
14231 If the string contains the element @samp{\&}, then the previously
14232 matched string will be substituted. Similarly, the elements @samp{\\1}
14233 up to @samp{\\9} will be substituted with the text matched by the
14234 groupings 1 through 9.
14236 @vindex nnmail-split-lowercase-expanded
14237 Where @code{nnmail-split-lowercase-expanded} controls whether the
14238 lowercase of the matched string should be used for the substitution.
14239 Setting it as non-@code{nil} is useful to avoid the creation of multiple
14240 groups when users send to an address using different case
14241 (i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value
14244 @vindex nnmail-split-fancy-match-partial-words
14245 @code{nnmail-split-fancy-match-partial-words} controls whether partial
14246 words are matched during fancy splitting.
14248 Normally, regular expressions given in @code{nnmail-split-fancy} are
14249 implicitly surrounded by @code{\<...\>} markers, which are word
14250 delimiters. If this variable is true, they are not implicitly
14251 surrounded by anything.
14254 (any "joe" "joemail")
14257 In this example, messages sent from @samp{joedavis@@foo.org} will
14258 normally not be filed in @samp{joemail}. With
14259 @code{nnmail-split-fancy-match-partial-words} set to t, however, the
14260 match will happen. In effect, the requirement of a word boundary is
14261 removed and instead the match becomes more like a grep.
14263 @findex nnmail-split-fancy-with-parent
14264 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14265 split followups into the same groups their parents are in. Sometimes
14266 you can't make splitting rules for all your mail. For example, your
14267 boss might send you personal mail regarding different projects you are
14268 working on, and as you can't tell your boss to put a distinguishing
14269 string into the subject line, you have to resort to manually moving the
14270 messages into the right group. With this function, you only have to do
14271 it once per thread.
14273 To use this feature, you have to set @code{nnmail-treat-duplicates}
14274 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14275 value. And then you can include @code{nnmail-split-fancy-with-parent}
14276 using the colon feature, like so:
14278 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
14279 nnmail-cache-accepted-message-ids t
14281 '(| (: nnmail-split-fancy-with-parent)
14282 ;; @r{other splits go here}
14286 This feature works as follows: when @code{nnmail-treat-duplicates} is
14287 non-@code{nil}, Gnus records the message id of every message it sees
14288 in the file specified by the variable
14289 @code{nnmail-message-id-cache-file}, together with the group it is in
14290 (the group is omitted for non-mail messages). When mail splitting is
14291 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
14292 at the References (and In-Reply-To) header of each message to split
14293 and searches the file specified by @code{nnmail-message-id-cache-file}
14294 for the message ids. When it has found a parent, it returns the
14295 corresponding group name unless the group name matches the regexp
14296 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
14297 recommended that you set @code{nnmail-message-id-cache-length} to a
14298 somewhat higher number than the default so that the message ids are
14299 still in the cache. (A value of 5000 appears to create a file some
14300 300 kBytes in size.)
14301 @vindex nnmail-cache-accepted-message-ids
14302 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
14303 also records the message ids of moved articles, so that the followup
14304 messages goes into the new group.
14306 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
14307 want certain groups to be recorded in the cache. For example, if all
14308 outgoing messages are written to an ``outgoing'' group, you could set
14309 @code{nnmail-cache-ignore-groups} to match that group name.
14310 Otherwise, answers to all your messages would end up in the
14311 ``outgoing'' group.
14314 @node Group Mail Splitting
14315 @subsection Group Mail Splitting
14316 @cindex mail splitting
14317 @cindex group mail splitting
14319 @findex gnus-group-split
14320 If you subscribe to dozens of mailing lists but you don't want to
14321 maintain mail splitting rules manually, group mail splitting is for you.
14322 You just have to set @code{to-list} and/or @code{to-address} in group
14323 parameters or group customization and set @code{nnmail-split-methods} to
14324 @code{gnus-group-split}. This splitting function will scan all groups
14325 for those parameters and split mail accordingly, i.e., messages posted
14326 from or to the addresses specified in the parameters @code{to-list} or
14327 @code{to-address} of a mail group will be stored in that group.
14329 Sometimes, mailing lists have multiple addresses, and you may want mail
14330 splitting to recognize them all: just set the @code{extra-aliases} group
14331 parameter to the list of additional addresses and it's done. If you'd
14332 rather use a regular expression, set @code{split-regexp}.
14334 All these parameters in a group will be used to create an
14335 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
14336 the @var{value} is a single regular expression that matches
14337 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
14338 matches of @code{split-regexp}, and the @var{split} is the name of the
14339 group. @var{restrict}s are also supported: just set the
14340 @code{split-exclude} parameter to a list of regular expressions.
14342 If you can't get the right split to be generated using all these
14343 parameters, or you just need something fancier, you can set the
14344 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
14345 this case, all other aforementioned parameters will be ignored by
14346 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
14347 @code{nil}, in which case the group will be ignored by
14348 @code{gnus-group-split}.
14350 @vindex gnus-group-split-default-catch-all-group
14351 @code{gnus-group-split} will do cross-posting on all groups that match,
14352 by defining a single @code{&} fancy split containing one split for each
14353 group. If a message doesn't match any split, it will be stored in the
14354 group named in @code{gnus-group-split-default-catch-all-group}, unless
14355 some group has @code{split-spec} set to @code{catch-all}, in which case
14356 that group is used as the catch-all group. Even though this variable is
14357 often used just to name a group, it may also be set to an arbitrarily
14358 complex fancy split (after all, a group name is a fancy split), and this
14359 may be useful to split mail that doesn't go to any mailing list to
14360 personal mail folders. Note that this fancy split is added as the last
14361 element of a @code{|} split list that also contains a @code{&} split
14362 with the rules extracted from group parameters.
14364 It's time for an example. Assume the following group parameters have
14369 ((to-address . "bar@@femail.com")
14370 (split-regexp . ".*@@femail\\.com"))
14372 ((to-list . "foo@@nowhere.gov")
14373 (extra-aliases "foo@@localhost" "foo-redist@@home")
14374 (split-exclude "bugs-foo" "rambling-foo")
14375 (admin-address . "foo-request@@nowhere.gov"))
14377 ((split-spec . catch-all))
14380 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
14381 behave as if @code{nnmail-split-fancy} had been selected and variable
14382 @code{nnmail-split-fancy} had been set as follows:
14385 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
14386 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
14387 - "bugs-foo" - "rambling-foo" "mail.foo"))
14391 @findex gnus-group-split-fancy
14392 If you'd rather not use group splitting for all your mail groups, you
14393 may use it for only some of them, by using @code{nnmail-split-fancy}
14397 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
14400 @var{groups} may be a regular expression or a list of group names whose
14401 parameters will be scanned to generate the output split.
14402 @var{no-crosspost} can be used to disable cross-posting; in this case, a
14403 single @code{|} split will be output. @var{catch-all} is the fall back
14404 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
14405 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
14406 empty string in any selected group, no catch-all split will be issued.
14407 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
14408 this group will override the value of the @var{catch-all} argument.
14410 @findex gnus-group-split-setup
14411 Unfortunately, scanning all groups and their parameters can be quite
14412 slow, especially considering that it has to be done for every message.
14413 But don't despair! The function @code{gnus-group-split-setup} can be
14414 used to enable @code{gnus-group-split} in a much more efficient way. It
14415 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
14416 @code{nnmail-split-fancy} to the split produced by
14417 @code{gnus-group-split-fancy}. Thus, the group parameters are only
14418 scanned once, no matter how many messages are split.
14420 @findex gnus-group-split-update
14421 However, if you change group parameters, you'd have to update
14422 @code{nnmail-split-fancy} manually. You can do it by running
14423 @code{gnus-group-split-update}. If you'd rather have it updated
14424 automatically, just tell @code{gnus-group-split-setup} to do it for
14425 you. For example, add to your @file{~/.gnus.el}:
14428 (gnus-group-split-setup @var{auto-update} @var{catch-all})
14431 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
14432 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
14433 have to worry about updating @code{nnmail-split-fancy} again. If you
14434 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
14435 @code{gnus-group-split-default-catch-all-group} will be set to its
14438 @vindex gnus-group-split-updated-hook
14439 Because you may want to change @code{nnmail-split-fancy} after it is set
14440 by @code{gnus-group-split-update}, this function will run
14441 @code{gnus-group-split-updated-hook} just before finishing.
14443 @node Incorporating Old Mail
14444 @subsection Incorporating Old Mail
14445 @cindex incorporating old mail
14446 @cindex import old mail
14448 Most people have lots of old mail stored in various file formats. If
14449 you have set up Gnus to read mail using one of the spiffy Gnus mail
14450 back ends, you'll probably wish to have that old mail incorporated into
14453 Doing so can be quite easy.
14455 To take an example: You're reading mail using @code{nnml}
14456 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
14457 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
14458 file filled with important, but old, mail. You want to move it into
14459 your @code{nnml} groups.
14465 Go to the group buffer.
14468 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
14469 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
14472 Type @kbd{SPACE} to enter the newly created group.
14475 Type @kbd{M P b} to process-mark all articles in this group's buffer
14476 (@pxref{Setting Process Marks}).
14479 Type @kbd{B r} to respool all the process-marked articles, and answer
14480 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
14483 All the mail messages in the mbox file will now also be spread out over
14484 all your @code{nnml} groups. Try entering them and check whether things
14485 have gone without a glitch. If things look ok, you may consider
14486 deleting the mbox file, but I wouldn't do that unless I was absolutely
14487 sure that all the mail has ended up where it should be.
14489 Respooling is also a handy thing to do if you're switching from one mail
14490 back end to another. Just respool all the mail in the old mail groups
14491 using the new mail back end.
14494 @node Expiring Mail
14495 @subsection Expiring Mail
14496 @cindex article expiry
14498 Traditional mail readers have a tendency to remove mail articles when
14499 you mark them as read, in some way. Gnus takes a fundamentally
14500 different approach to mail reading.
14502 Gnus basically considers mail just to be news that has been received in
14503 a rather peculiar manner. It does not think that it has the power to
14504 actually change the mail, or delete any mail messages. If you enter a
14505 mail group, and mark articles as ``read'', or kill them in some other
14506 fashion, the mail articles will still exist on the system. I repeat:
14507 Gnus will not delete your old, read mail. Unless you ask it to, of
14510 To make Gnus get rid of your unwanted mail, you have to mark the
14511 articles as @dfn{expirable}. (With the default key bindings, this means
14512 that you have to type @kbd{E}.) This does not mean that the articles
14513 will disappear right away, however. In general, a mail article will be
14514 deleted from your system if, 1) it is marked as expirable, AND 2) it is
14515 more than one week old. If you do not mark an article as expirable, it
14516 will remain on your system until hell freezes over. This bears
14517 repeating one more time, with some spurious capitalizations: IF you do
14518 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
14520 You do not have to mark articles as expirable by hand. Gnus provides
14521 two features, called ``auto-expire'' and ``total-expire'', that can help you
14522 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
14523 for you when you select an article. And ``total-expire'' means that Gnus
14524 considers all articles as expirable that are read. So, in addition to
14525 the articles marked @samp{E}, also the articles marked @samp{r},
14526 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
14529 When should either auto-expire or total-expire be used? Most people
14530 who are subscribed to mailing lists split each list into its own group
14531 and then turn on auto-expire or total-expire for those groups.
14532 (@xref{Splitting Mail}, for more information on splitting each list
14533 into its own group.)
14535 Which one is better, auto-expire or total-expire? It's not easy to
14536 answer. Generally speaking, auto-expire is probably faster. Another
14537 advantage of auto-expire is that you get more marks to work with: for
14538 the articles that are supposed to stick around, you can still choose
14539 between tick and dormant and read marks. But with total-expire, you
14540 only have dormant and ticked to choose from. The advantage of
14541 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
14542 Scoring}). Auto-expire works with normal scoring but not with adaptive
14545 @vindex gnus-auto-expirable-newsgroups
14546 Groups that match the regular expression
14547 @code{gnus-auto-expirable-newsgroups} will have all articles that you
14548 read marked as expirable automatically. All articles marked as
14549 expirable have an @samp{E} in the first column in the summary buffer.
14551 By default, if you have auto expiry switched on, Gnus will mark all the
14552 articles you read as expirable, no matter if they were read or unread
14553 before. To avoid having articles marked as read marked as expirable
14554 automatically, you can put something like the following in your
14555 @file{~/.gnus.el} file:
14557 @vindex gnus-mark-article-hook
14559 (remove-hook 'gnus-mark-article-hook
14560 'gnus-summary-mark-read-and-unread-as-read)
14561 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
14564 Note that making a group auto-expirable doesn't mean that all read
14565 articles are expired---only the articles marked as expirable
14566 will be expired. Also note that using the @kbd{d} command won't make
14567 articles expirable---only semi-automatic marking of articles as read will
14568 mark the articles as expirable in auto-expirable groups.
14570 Let's say you subscribe to a couple of mailing lists, and you want the
14571 articles you have read to disappear after a while:
14574 (setq gnus-auto-expirable-newsgroups
14575 "mail.nonsense-list\\|mail.nice-list")
14578 Another way to have auto-expiry happen is to have the element
14579 @code{auto-expire} in the group parameters of the group.
14581 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
14582 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
14583 don't really mix very well.
14585 @vindex nnmail-expiry-wait
14586 The @code{nnmail-expiry-wait} variable supplies the default time an
14587 expirable article has to live. Gnus starts counting days from when the
14588 message @emph{arrived}, not from when it was sent. The default is seven
14591 Gnus also supplies a function that lets you fine-tune how long articles
14592 are to live, based on what group they are in. Let's say you want to
14593 have one month expiry period in the @samp{mail.private} group, a one day
14594 expiry period in the @samp{mail.junk} group, and a six day expiry period
14597 @vindex nnmail-expiry-wait-function
14599 (setq nnmail-expiry-wait-function
14601 (cond ((string= group "mail.private")
14603 ((string= group "mail.junk")
14605 ((string= group "important")
14611 The group names this function is fed are ``unadorned'' group
14612 names---no @samp{nnml:} prefixes and the like.
14614 The @code{nnmail-expiry-wait} variable and
14615 @code{nnmail-expiry-wait-function} function can either be a number (not
14616 necessarily an integer) or one of the symbols @code{immediate} or
14619 You can also use the @code{expiry-wait} group parameter to selectively
14620 change the expiry period (@pxref{Group Parameters}).
14622 @vindex nnmail-expiry-target
14623 The normal action taken when expiring articles is to delete them.
14624 However, in some circumstances it might make more sense to move them
14625 to other groups instead of deleting them. The variable
14626 @code{nnmail-expiry-target} (and the @code{expiry-target} group
14627 parameter) controls this. The variable supplies a default value for
14628 all groups, which can be overridden for specific groups by the group
14629 parameter. default value is @code{delete}, but this can also be a
14630 string (which should be the name of the group the message should be
14631 moved to), or a function (which will be called in a buffer narrowed to
14632 the message in question, and with the name of the group being moved
14633 from as its parameter) which should return a target---either a group
14634 name or @code{delete}.
14636 Here's an example for specifying a group name:
14638 (setq nnmail-expiry-target "nnml:expired")
14641 @findex nnmail-fancy-expiry-target
14642 @vindex nnmail-fancy-expiry-targets
14643 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
14644 expire mail to groups according to the variable
14645 @code{nnmail-fancy-expiry-targets}. Here's an example:
14648 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
14649 nnmail-fancy-expiry-targets
14650 '((to-from "boss" "nnfolder:Work")
14651 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
14652 ("from" ".*" "nnfolder:Archive-%Y")))
14655 With this setup, any mail that has @code{IMPORTANT} in its Subject
14656 header and was sent in the year @code{YYYY} and month @code{MMM}, will
14657 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
14658 From or To header contains the string @code{boss}, it will get expired
14659 to @code{nnfolder:Work}. All other mail will get expired to
14660 @code{nnfolder:Archive-YYYY}.
14662 @vindex nnmail-keep-last-article
14663 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
14664 expire the final article in a mail newsgroup. This is to make life
14665 easier for procmail users.
14667 @vindex gnus-total-expirable-newsgroups
14668 By the way: That line up there, about Gnus never expiring non-expirable
14669 articles, is a lie. If you put @code{total-expire} in the group
14670 parameters, articles will not be marked as expirable, but all read
14671 articles will be put through the expiry process. Use with extreme
14672 caution. Even more dangerous is the
14673 @code{gnus-total-expirable-newsgroups} variable. All groups that match
14674 this regexp will have all read articles put through the expiry process,
14675 which means that @emph{all} old mail articles in the groups in question
14676 will be deleted after a while. Use with extreme caution, and don't come
14677 crying to me when you discover that the regexp you used matched the
14678 wrong group and all your important mail has disappeared. Be a
14679 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
14682 Most people make most of their mail groups total-expirable, though.
14684 @vindex gnus-inhibit-user-auto-expire
14685 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
14686 commands will not mark an article as expirable, even if the group has
14687 auto-expire turned on.
14691 @subsection Washing Mail
14692 @cindex mail washing
14693 @cindex list server brain damage
14694 @cindex incoming mail treatment
14696 Mailers and list servers are notorious for doing all sorts of really,
14697 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
14698 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
14699 end of all lines passing through our server, so let's do that!!!!1!''
14700 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
14701 considered to be self-evident were not discussed. So. Here we are.
14703 Case in point: The German version of Microsoft Exchange adds @samp{AW:
14704 } to the subjects of replies instead of @samp{Re: }. I could pretend to
14705 be shocked and dismayed by this, but I haven't got the energy. It is to
14708 Gnus provides a plethora of functions for washing articles while
14709 displaying them, but it might be nicer to do the filtering before
14710 storing the mail to disk. For that purpose, we have three hooks and
14711 various functions that can be put in these hooks.
14714 @item nnmail-prepare-incoming-hook
14715 @vindex nnmail-prepare-incoming-hook
14716 This hook is called before doing anything with the mail and is meant for
14717 grand, sweeping gestures. It is called in a buffer that contains all
14718 the new, incoming mail. Functions to be used include:
14721 @item nnheader-ms-strip-cr
14722 @findex nnheader-ms-strip-cr
14723 Remove trailing carriage returns from each line. This is default on
14724 Emacs running on MS machines.
14728 @item nnmail-prepare-incoming-header-hook
14729 @vindex nnmail-prepare-incoming-header-hook
14730 This hook is called narrowed to each header. It can be used when
14731 cleaning up the headers. Functions that can be used include:
14734 @item nnmail-remove-leading-whitespace
14735 @findex nnmail-remove-leading-whitespace
14736 Clear leading white space that ``helpful'' listservs have added to the
14737 headers to make them look nice. Aaah.
14739 (Note that this function works on both the header on the body of all
14740 messages, so it is a potentially dangerous function to use (if a body
14741 of a message contains something that looks like a header line). So
14742 rather than fix the bug, it is of course the right solution to make it
14743 into a feature by documenting it.)
14745 @item nnmail-remove-list-identifiers
14746 @findex nnmail-remove-list-identifiers
14747 Some list servers add an identifier---for example, @samp{(idm)}---to the
14748 beginning of all @code{Subject} headers. I'm sure that's nice for
14749 people who use stone age mail readers. This function will remove
14750 strings that match the @code{nnmail-list-identifiers} regexp, which can
14751 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
14754 For instance, if you want to remove the @samp{(idm)} and the
14755 @samp{nagnagnag} identifiers:
14758 (setq nnmail-list-identifiers
14759 '("(idm)" "nagnagnag"))
14762 This can also be done non-destructively with
14763 @code{gnus-list-identifiers}, @xref{Article Hiding}.
14765 @item nnmail-remove-tabs
14766 @findex nnmail-remove-tabs
14767 Translate all @samp{TAB} characters into @samp{SPACE} characters.
14769 @item nnmail-fix-eudora-headers
14770 @findex nnmail-fix-eudora-headers
14772 Eudora produces broken @code{References} headers, but OK
14773 @code{In-Reply-To} headers. This function will get rid of the
14774 @code{References} headers.
14778 @item nnmail-prepare-incoming-message-hook
14779 @vindex nnmail-prepare-incoming-message-hook
14780 This hook is called narrowed to each message. Functions to be used
14784 @item article-de-quoted-unreadable
14785 @findex article-de-quoted-unreadable
14786 Decode Quoted Readable encoding.
14793 @subsection Duplicates
14795 @vindex nnmail-treat-duplicates
14796 @vindex nnmail-message-id-cache-length
14797 @vindex nnmail-message-id-cache-file
14798 @cindex duplicate mails
14799 If you are a member of a couple of mailing lists, you will sometimes
14800 receive two copies of the same mail. This can be quite annoying, so
14801 @code{nnmail} checks for and treats any duplicates it might find. To do
14802 this, it keeps a cache of old @code{Message-ID}s---
14803 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
14804 default. The approximate maximum number of @code{Message-ID}s stored
14805 there is controlled by the @code{nnmail-message-id-cache-length}
14806 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
14807 stored.) If all this sounds scary to you, you can set
14808 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
14809 default), and @code{nnmail} won't delete duplicate mails. Instead it
14810 will insert a warning into the head of the mail saying that it thinks
14811 that this is a duplicate of a different message.
14813 This variable can also be a function. If that's the case, the function
14814 will be called from a buffer narrowed to the message in question with
14815 the @code{Message-ID} as a parameter. The function must return either
14816 @code{nil}, @code{warn}, or @code{delete}.
14818 You can turn this feature off completely by setting the variable to
14821 If you want all the duplicate mails to be put into a special
14822 @dfn{duplicates} group, you could do that using the normal mail split
14826 (setq nnmail-split-fancy
14827 '(| ;; @r{Messages duplicates go to a separate group.}
14828 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14829 ;; @r{Message from daemons, postmaster, and the like to another.}
14830 (any mail "mail.misc")
14831 ;; @r{Other rules.}
14837 (setq nnmail-split-methods
14838 '(("duplicates" "^Gnus-Warning:.*duplicate")
14839 ;; @r{Other rules.}
14843 Here's a neat feature: If you know that the recipient reads her mail
14844 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14845 @code{delete}, you can send her as many insults as you like, just by
14846 using a @code{Message-ID} of a mail that you know that she's already
14847 received. Think of all the fun! She'll never see any of it! Whee!
14850 @node Not Reading Mail
14851 @subsection Not Reading Mail
14853 If you start using any of the mail back ends, they have the annoying
14854 habit of assuming that you want to read mail with them. This might not
14855 be unreasonable, but it might not be what you want.
14857 If you set @code{mail-sources} and @code{nnmail-spool-file} to
14858 @code{nil}, none of the back ends will ever attempt to read incoming
14859 mail, which should help.
14861 @vindex nnbabyl-get-new-mail
14862 @vindex nnmbox-get-new-mail
14863 @vindex nnml-get-new-mail
14864 @vindex nnmh-get-new-mail
14865 @vindex nnfolder-get-new-mail
14866 This might be too much, if, for instance, you are reading mail quite
14867 happily with @code{nnml} and just want to peek at some old Rmail
14868 file you have stashed away with @code{nnbabyl}. All back ends have
14869 variables called back-end-@code{get-new-mail}. If you want to disable
14870 the @code{nnbabyl} mail reading, you edit the virtual server for the
14871 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
14873 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
14874 narrowed to the article to be saved before saving it when reading
14878 @node Choosing a Mail Back End
14879 @subsection Choosing a Mail Back End
14881 Gnus will read the mail spool when you activate a mail group. The mail
14882 file is first copied to your home directory. What happens after that
14883 depends on what format you want to store your mail in.
14885 There are six different mail back ends in the standard Gnus, and more
14886 back ends are available separately. The mail back end most people use
14887 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
14891 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
14892 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
14893 * Mail Spool:: Store your mail in a private spool?
14894 * MH Spool:: An mhspool-like back end.
14895 * Maildir:: Another one-file-per-message format.
14896 * Mail Folders:: Having one file for each group.
14897 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
14901 @node Unix Mail Box
14902 @subsubsection Unix Mail Box
14904 @cindex unix mail box
14906 @vindex nnmbox-active-file
14907 @vindex nnmbox-mbox-file
14908 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
14909 mail. @code{nnmbox} will add extra headers to each mail article to say
14910 which group it belongs in.
14912 Virtual server settings:
14915 @item nnmbox-mbox-file
14916 @vindex nnmbox-mbox-file
14917 The name of the mail box in the user's home directory. Default is
14920 @item nnmbox-active-file
14921 @vindex nnmbox-active-file
14922 The name of the active file for the mail box. Default is
14923 @file{~/.mbox-active}.
14925 @item nnmbox-get-new-mail
14926 @vindex nnmbox-get-new-mail
14927 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
14928 into groups. Default is @code{t}.
14933 @subsubsection Rmail Babyl
14937 @vindex nnbabyl-active-file
14938 @vindex nnbabyl-mbox-file
14939 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
14940 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
14941 mail article to say which group it belongs in.
14943 Virtual server settings:
14946 @item nnbabyl-mbox-file
14947 @vindex nnbabyl-mbox-file
14948 The name of the Rmail mbox file. The default is @file{~/RMAIL}
14950 @item nnbabyl-active-file
14951 @vindex nnbabyl-active-file
14952 The name of the active file for the rmail box. The default is
14953 @file{~/.rmail-active}
14955 @item nnbabyl-get-new-mail
14956 @vindex nnbabyl-get-new-mail
14957 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
14963 @subsubsection Mail Spool
14965 @cindex mail @acronym{NOV} spool
14967 The @dfn{nnml} spool mail format isn't compatible with any other known
14968 format. It should be used with some caution.
14970 @vindex nnml-directory
14971 If you use this back end, Gnus will split all incoming mail into files,
14972 one file for each mail, and put the articles into the corresponding
14973 directories under the directory specified by the @code{nnml-directory}
14974 variable. The default value is @file{~/Mail/}.
14976 You do not have to create any directories beforehand; Gnus will take
14979 If you have a strict limit as to how many files you are allowed to store
14980 in your account, you should not use this back end. As each mail gets its
14981 own file, you might very well occupy thousands of inodes within a few
14982 weeks. If this is no problem for you, and it isn't a problem for you
14983 having your friendly systems administrator walking around, madly,
14984 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
14985 know that this is probably the fastest format to use. You do not have
14986 to trudge through a big mbox file just to read your new mail.
14988 @code{nnml} is probably the slowest back end when it comes to article
14989 splitting. It has to create lots of files, and it also generates
14990 @acronym{NOV} databases for the incoming mails. This makes it possibly the
14991 fastest back end when it comes to reading mail.
14993 @cindex self contained nnml servers
14995 When the marks file is used (which it is by default), @code{nnml}
14996 servers have the property that you may backup them using @code{tar} or
14997 similar, and later be able to restore them into Gnus (by adding the
14998 proper @code{nnml} server) and have all your marks be preserved. Marks
14999 for a group is usually stored in the @code{.marks} file (but see
15000 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
15001 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
15002 to restore the group (after restoring the backup into the nnml
15005 If for some reason you believe your @file{.marks} files are screwed
15006 up, you can just delete them all. Gnus will then correctly regenerate
15007 them next time it starts.
15009 Virtual server settings:
15012 @item nnml-directory
15013 @vindex nnml-directory
15014 All @code{nnml} directories will be placed under this directory. The
15015 default is the value of @code{message-directory} (whose default value
15018 @item nnml-active-file
15019 @vindex nnml-active-file
15020 The active file for the @code{nnml} server. The default is
15021 @file{~/Mail/active}.
15023 @item nnml-newsgroups-file
15024 @vindex nnml-newsgroups-file
15025 The @code{nnml} group descriptions file. @xref{Newsgroups File
15026 Format}. The default is @file{~/Mail/newsgroups}.
15028 @item nnml-get-new-mail
15029 @vindex nnml-get-new-mail
15030 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
15033 @item nnml-nov-is-evil
15034 @vindex nnml-nov-is-evil
15035 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15036 default is @code{nil}.
15038 @item nnml-nov-file-name
15039 @vindex nnml-nov-file-name
15040 The name of the @acronym{NOV} files. The default is @file{.overview}.
15042 @item nnml-prepare-save-mail-hook
15043 @vindex nnml-prepare-save-mail-hook
15044 Hook run narrowed to an article before saving.
15046 @item nnml-marks-is-evil
15047 @vindex nnml-marks-is-evil
15048 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15049 default is @code{nil}.
15051 @item nnml-marks-file-name
15052 @vindex nnml-marks-file-name
15053 The name of the @dfn{marks} files. The default is @file{.marks}.
15055 @item nnml-use-compressed-files
15056 @vindex nnml-use-compressed-files
15057 If non-@code{nil}, @code{nnml} will allow using compressed message
15062 @findex nnml-generate-nov-databases
15063 If your @code{nnml} groups and @acronym{NOV} files get totally out of
15064 whack, you can do a complete update by typing @kbd{M-x
15065 nnml-generate-nov-databases}. This command will trawl through the
15066 entire @code{nnml} hierarchy, looking at each and every article, so it
15067 might take a while to complete. A better interface to this
15068 functionality can be found in the server buffer (@pxref{Server
15073 @subsubsection MH Spool
15075 @cindex mh-e mail spool
15077 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
15078 @acronym{NOV} databases and it doesn't keep an active file or marks
15079 file. This makes @code{nnmh} a @emph{much} slower back end than
15080 @code{nnml}, but it also makes it easier to write procmail scripts
15083 Virtual server settings:
15086 @item nnmh-directory
15087 @vindex nnmh-directory
15088 All @code{nnmh} directories will be located under this directory. The
15089 default is the value of @code{message-directory} (whose default is
15092 @item nnmh-get-new-mail
15093 @vindex nnmh-get-new-mail
15094 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
15098 @vindex nnmh-be-safe
15099 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
15100 sure that the articles in the folder are actually what Gnus thinks
15101 they are. It will check date stamps and stat everything in sight, so
15102 setting this to @code{t} will mean a serious slow-down. If you never
15103 use anything but Gnus to read the @code{nnmh} articles, you do not
15104 have to set this variable to @code{t}. The default is @code{nil}.
15109 @subsubsection Maildir
15113 @code{nnmaildir} stores mail in the maildir format, with each maildir
15114 corresponding to a group in Gnus. This format is documented here:
15115 @uref{http://cr.yp.to/proto/maildir.html} and here:
15116 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
15117 also stores extra information in the @file{.nnmaildir/} directory
15120 Maildir format was designed to allow concurrent deliveries and
15121 reading, without needing locks. With other back ends, you would have
15122 your mail delivered to a spool of some kind, and then you would
15123 configure Gnus to split mail from that spool into your groups. You
15124 can still do that with @code{nnmaildir}, but the more common
15125 configuration is to have your mail delivered directly to the maildirs
15126 that appear as group in Gnus.
15128 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
15129 never corrupt its data in memory, and @code{SIGKILL} will never
15130 corrupt its data in the filesystem.
15132 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
15133 maildir. So you can copy a whole maildir from one Gnus setup to
15134 another, and you will keep your marks.
15136 Virtual server settings:
15140 For each of your @code{nnmaildir} servers (it's very unlikely that
15141 you'd need more than one), you need to create a directory and populate
15142 it with maildirs or symlinks to maildirs (and nothing else; do not
15143 choose a directory already used for other purposes). Each maildir
15144 will be represented in Gnus as a newsgroup on that server; the
15145 filename of the symlink will be the name of the group. Any filenames
15146 in the directory starting with @samp{.} are ignored. The directory is
15147 scanned when you first start Gnus, and each time you type @kbd{g} in
15148 the group buffer; if any maildirs have been removed or added,
15149 @code{nnmaildir} notices at these times.
15151 The value of the @code{directory} parameter should be a Lisp form
15152 which is processed by @code{eval} and @code{expand-file-name} to get
15153 the path of the directory for this server. The form is @code{eval}ed
15154 only when the server is opened; the resulting string is used until the
15155 server is closed. (If you don't know about forms and @code{eval},
15156 don't worry---a simple string will work.) This parameter is not
15157 optional; you must specify it. I don't recommend using
15158 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
15159 use that directory by default for various things, and may get confused
15160 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
15163 @item target-prefix
15164 This should be a Lisp form which is processed by @code{eval} and
15165 @code{expand-file-name}. The form is @code{eval}ed only when the
15166 server is opened; the resulting string is used until the server is
15169 When you create a group on an @code{nnmaildir} server, the maildir is
15170 created with @code{target-prefix} prepended to its name, and a symlink
15171 pointing to that maildir is created, named with the plain group name.
15172 So if @code{directory} is @code{"~/.nnmaildir"} and
15173 @code{target-prefix} is @code{"../maildirs/"}, then when you create
15174 the group @code{foo}, @code{nnmaildir} will create
15175 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
15176 @file{~/.nnmaildir/foo} as a symlink pointing to
15177 @file{../maildirs/foo}.
15179 You can set @code{target-prefix} to a string without any slashes to
15180 create both maildirs and symlinks in the same @code{directory}; in
15181 this case, any maildirs found in @code{directory} whose names start
15182 with @code{target-prefix} will not be listed as groups (but the
15183 symlinks pointing to them will be).
15185 As a special case, if @code{target-prefix} is @code{""} (the default),
15186 then when you create a group, the maildir will be created in
15187 @code{directory} without a corresponding symlink. Beware that you
15188 cannot use @code{gnus-group-delete-group} on such groups without the
15189 @code{force} argument.
15191 @item directory-files
15192 This should be a function with the same interface as
15193 @code{directory-files} (such as @code{directory-files} itself). It is
15194 used to scan the server's @code{directory} for maildirs. This
15195 parameter is optional; the default is
15196 @code{nnheader-directory-files-safe} if
15197 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15198 @code{directory-files} otherwise.
15199 (@code{nnheader-directory-files-is-safe} is checked only once when the
15200 server is opened; if you want to check it each time the directory is
15201 scanned, you'll have to provide your own function that does that.)
15204 If non-@code{nil}, then after scanning for new mail in the group
15205 maildirs themselves as usual, this server will also incorporate mail
15206 the conventional Gnus way, from @code{mail-sources} according to
15207 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
15208 value is @code{nil}.
15210 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15211 an @code{nnmaildir} group. The results might happen to be useful, but
15212 that would be by chance, not by design, and the results might be
15213 different in the future. If your split rules create new groups,
15214 remember to supply a @code{create-directory} server parameter.
15217 @subsubsection Group parameters
15219 @code{nnmaildir} uses several group parameters. It's safe to ignore
15220 all this; the default behavior for @code{nnmaildir} is the same as the
15221 default behavior for other mail back ends: articles are deleted after
15222 one week, etc. Except for the expiry parameters, all this
15223 functionality is unique to @code{nnmaildir}, so you can ignore it if
15224 you're just trying to duplicate the behavior you already have with
15227 If the value of any of these parameters is a vector, the first element
15228 is evaluated as a Lisp form and the result is used, rather than the
15229 original value. If the value is not a vector, the value itself is
15230 evaluated as a Lisp form. (This is why these parameters use names
15231 different from those of other, similar parameters supported by other
15232 back ends: they have different, though similar, meanings.) (For
15233 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15234 @code{eval} business again; for other values, remember to use an extra
15235 quote and wrap the value in a vector when appropriate.)
15239 An integer specifying the minimum age, in seconds, of an article
15240 before it will be expired, or the symbol @code{never} to specify that
15241 articles should never be expired. If this parameter is not set,
15242 @code{nnmaildir} falls back to the usual
15243 @code{nnmail-expiry-wait}(@code{-function}) variables (overrideable by
15244 the @code{expiry-wait}(@code{-function}) group parameters. If you
15245 wanted a value of 3 days, you could use something like @code{[(* 3 24
15246 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15247 An article's age is measured starting from the article file's
15248 modification time. Normally, this is the same as the article's
15249 delivery time, but editing an article makes it younger. Moving an
15250 article (other than via expiry) may also make an article younger.
15253 If this is set to a string such as a full Gnus group name, like
15255 "backend+server.address.string:group.name"
15257 and if it is not the name of the same group that the parameter belongs
15258 to, then articles will be moved to the specified group during expiry
15259 before being deleted. @emph{If this is set to an @code{nnmaildir}
15260 group, the article will be just as old in the destination group as it
15261 was in the source group.} So be careful with @code{expire-age} in the
15262 destination group. If this is set to the name of the same group that
15263 the parameter belongs to, then the article is not expired at all. If
15264 you use the vector form, the first element is evaluated once for each
15265 article. So that form can refer to
15266 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15267 article. @emph{If this parameter is not set, @code{nnmaildir} does
15268 not fall back to the @code{expiry-target} group parameter or the
15269 @code{nnmail-expiry-target} variable.}
15272 If this is set to @code{t}, @code{nnmaildir} will treat the articles
15273 in this maildir as read-only. This means: articles are not renamed
15274 from @file{new/} into @file{cur/}; articles are only found in
15275 @file{new/}, not @file{cur/}; articles are never deleted; articles
15276 cannot be edited. @file{new/} is expected to be a symlink to the
15277 @file{new/} directory of another maildir---e.g., a system-wide mailbox
15278 containing a mailing list of common interest. Everything in the
15279 maildir outside @file{new/} is @emph{not} treated as read-only, so for
15280 a shared mailbox, you do still need to set up your own maildir (or
15281 have write permission to the shared mailbox); your maildir just won't
15282 contain extra copies of the articles.
15284 @item directory-files
15285 A function with the same interface as @code{directory-files}. It is
15286 used to scan the directories in the maildir corresponding to this
15287 group to find articles. The default is the function specified by the
15288 server's @code{directory-files} parameter.
15290 @item distrust-Lines:
15291 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
15292 article, rather than use the @code{Lines:} header field. If
15293 @code{nil}, the header field will be used if present.
15296 A list of mark symbols, such as @code{['(read expire)]}. Whenever
15297 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15298 say that all articles have these marks, regardless of whether the
15299 marks stored in the filesystem say so. This is a proof-of-concept
15300 feature that will probably be removed eventually; it ought to be done
15301 in Gnus proper, or abandoned if it's not worthwhile.
15304 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
15305 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15306 say that no articles have these marks, regardless of whether the marks
15307 stored in the filesystem say so. @code{never-marks} overrides
15308 @code{always-marks}. This is a proof-of-concept feature that will
15309 probably be removed eventually; it ought to be done in Gnus proper, or
15310 abandoned if it's not worthwhile.
15312 @item nov-cache-size
15313 An integer specifying the size of the @acronym{NOV} memory cache. To
15314 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
15315 for a limited number of articles in each group. (This is probably not
15316 worthwhile, and will probably be removed in the future.) This
15317 parameter's value is noticed only the first time a group is seen after
15318 the server is opened---i.e., when you first start Gnus, typically.
15319 The @acronym{NOV} cache is never resized until the server is closed
15320 and reopened. The default is an estimate of the number of articles
15321 that would be displayed in the summary buffer: a count of articles
15322 that are either marked with @code{tick} or not marked with
15323 @code{read}, plus a little extra.
15326 @subsubsection Article identification
15327 Articles are stored in the @file{cur/} subdirectory of each maildir.
15328 Each article file is named like @code{uniq:info}, where @code{uniq}
15329 contains no colons. @code{nnmaildir} ignores, but preserves, the
15330 @code{:info} part. (Other maildir readers typically use this part of
15331 the filename to store marks.) The @code{uniq} part uniquely
15332 identifies the article, and is used in various places in the
15333 @file{.nnmaildir/} subdirectory of the maildir to store information
15334 about the corresponding article. The full pathname of an article is
15335 available in the variable @code{nnmaildir-article-file-name} after you
15336 request the article in the summary buffer.
15338 @subsubsection NOV data
15339 An article identified by @code{uniq} has its @acronym{NOV} data (used
15340 to generate lines in the summary buffer) stored in
15341 @code{.nnmaildir/nov/uniq}. There is no
15342 @code{nnmaildir-generate-nov-databases} function. (There isn't much
15343 need for it---an article's @acronym{NOV} data is updated automatically
15344 when the article or @code{nnmail-extra-headers} has changed.) You can
15345 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
15346 single article simply by deleting the corresponding @acronym{NOV}
15347 file, but @emph{beware}: this will also cause @code{nnmaildir} to
15348 assign a new article number for this article, which may cause trouble
15349 with @code{seen} marks, the Agent, and the cache.
15351 @subsubsection Article marks
15352 An article identified by @code{uniq} is considered to have the mark
15353 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
15354 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
15355 looks for such files and reports the set of marks it finds. When Gnus
15356 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
15357 creates and deletes the corresponding files as needed. (Actually,
15358 rather than create a new file for each mark, it just creates hard
15359 links to @file{.nnmaildir/markfile}, to save inodes.)
15361 You can invent new marks by creating a new directory in
15362 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
15363 your server, untar it later, and keep your marks. You can add and
15364 remove marks yourself by creating and deleting mark files. If you do
15365 this while Gnus is running and your @code{nnmaildir} server is open,
15366 it's best to exit all summary buffers for @code{nnmaildir} groups and
15367 type @kbd{s} in the group buffer first, and to type @kbd{g} or
15368 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
15369 pick up the changes, and might undo them.
15373 @subsubsection Mail Folders
15375 @cindex mbox folders
15376 @cindex mail folders
15378 @code{nnfolder} is a back end for storing each mail group in a
15379 separate file. Each file is in the standard Un*x mbox format.
15380 @code{nnfolder} will add extra headers to keep track of article
15381 numbers and arrival dates.
15383 @cindex self contained nnfolder servers
15385 When the marks file is used (which it is by default), @code{nnfolder}
15386 servers have the property that you may backup them using @code{tar} or
15387 similar, and later be able to restore them into Gnus (by adding the
15388 proper @code{nnfolder} server) and have all your marks be preserved.
15389 Marks for a group is usually stored in a file named as the mbox file
15390 with @code{.mrk} concatenated to it (but see
15391 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
15392 directory. Individual @code{nnfolder} groups are also possible to
15393 backup, use @kbd{G m} to restore the group (after restoring the backup
15394 into the @code{nnfolder} directory).
15396 Virtual server settings:
15399 @item nnfolder-directory
15400 @vindex nnfolder-directory
15401 All the @code{nnfolder} mail boxes will be stored under this
15402 directory. The default is the value of @code{message-directory}
15403 (whose default is @file{~/Mail})
15405 @item nnfolder-active-file
15406 @vindex nnfolder-active-file
15407 The name of the active file. The default is @file{~/Mail/active}.
15409 @item nnfolder-newsgroups-file
15410 @vindex nnfolder-newsgroups-file
15411 The name of the group descriptions file. @xref{Newsgroups File
15412 Format}. The default is @file{~/Mail/newsgroups}
15414 @item nnfolder-get-new-mail
15415 @vindex nnfolder-get-new-mail
15416 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
15417 default is @code{t}
15419 @item nnfolder-save-buffer-hook
15420 @vindex nnfolder-save-buffer-hook
15421 @cindex backup files
15422 Hook run before saving the folders. Note that Emacs does the normal
15423 backup renaming of files even with the @code{nnfolder} buffers. If
15424 you wish to switch this off, you could say something like the
15425 following in your @file{.emacs} file:
15428 (defun turn-off-backup ()
15429 (set (make-local-variable 'backup-inhibited) t))
15431 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
15434 @item nnfolder-delete-mail-hook
15435 @vindex nnfolder-delete-mail-hook
15436 Hook run in a buffer narrowed to the message that is to be deleted.
15437 This function can be used to copy the message to somewhere else, or to
15438 extract some information from it before removing it.
15440 @item nnfolder-nov-is-evil
15441 @vindex nnfolder-nov-is-evil
15442 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15443 default is @code{nil}.
15445 @item nnfolder-nov-file-suffix
15446 @vindex nnfolder-nov-file-suffix
15447 The extension for @acronym{NOV} files. The default is @file{.nov}.
15449 @item nnfolder-nov-directory
15450 @vindex nnfolder-nov-directory
15451 The directory where the @acronym{NOV} files should be stored. If
15452 @code{nil}, @code{nnfolder-directory} is used.
15454 @item nnfolder-marks-is-evil
15455 @vindex nnfolder-marks-is-evil
15456 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15457 default is @code{nil}.
15459 @item nnfolder-marks-file-suffix
15460 @vindex nnfolder-marks-file-suffix
15461 The extension for @sc{marks} files. The default is @file{.mrk}.
15463 @item nnfolder-marks-directory
15464 @vindex nnfolder-marks-directory
15465 The directory where the @sc{marks} files should be stored. If
15466 @code{nil}, @code{nnfolder-directory} is used.
15471 @findex nnfolder-generate-active-file
15472 @kindex M-x nnfolder-generate-active-file
15473 If you have lots of @code{nnfolder}-like files you'd like to read with
15474 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
15475 command to make @code{nnfolder} aware of all likely files in
15476 @code{nnfolder-directory}. This only works if you use long file names,
15479 @node Comparing Mail Back Ends
15480 @subsubsection Comparing Mail Back Ends
15482 First, just for terminology, the @dfn{back end} is the common word for a
15483 low-level access method---a transport, if you will, by which something
15484 is acquired. The sense is that one's mail has to come from somewhere,
15485 and so selection of a suitable back end is required in order to get that
15486 mail within spitting distance of Gnus.
15488 The same concept exists for Usenet itself: Though access to articles is
15489 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
15490 in the world got at Usenet by running a reader on the machine where the
15491 articles lay (the machine which today we call an @acronym{NNTP} server), and
15492 access was by the reader stepping into the articles' directory spool
15493 area directly. One can still select between either the @code{nntp} or
15494 @code{nnspool} back ends, to select between these methods, if one happens
15495 actually to live on the server (or can see its spool directly, anyway,
15498 The goal in selecting a mail back end is to pick one which
15499 simultaneously represents a suitable way of dealing with the original
15500 format plus leaving mail in a form that is convenient to use in the
15501 future. Here are some high and low points on each:
15506 UNIX systems have historically had a single, very common, and well-
15507 defined format. All messages arrive in a single @dfn{spool file}, and
15508 they are delineated by a line whose regular expression matches
15509 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
15510 to make it clear in this instance that this is not the RFC-specified
15511 @samp{From:} header.) Because Emacs and therefore Gnus emanate
15512 historically from the Unix environment, it is simplest if one does not
15513 mess a great deal with the original mailbox format, so if one chooses
15514 this back end, Gnus' primary activity in getting mail from the real spool
15515 area to Gnus' preferred directory is simply to copy it, with no
15516 (appreciable) format change in the process. It is the ``dumbest'' way
15517 to move mail into availability in the Gnus environment. This makes it
15518 fast to move into place, but slow to parse, when Gnus has to look at
15523 Once upon a time, there was the DEC-10 and DEC-20, running operating
15524 systems called TOPS and related things, and the usual (only?) mail
15525 reading environment was a thing called Babyl. I don't know what format
15526 was used for mail landing on the system, but Babyl had its own internal
15527 format to which mail was converted, primarily involving creating a
15528 spool-file-like entity with a scheme for inserting Babyl-specific
15529 headers and status bits above the top of each message in the file.
15530 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
15531 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
15532 to understand the mail files folks already had in existence. Gnus (and
15533 VM, for that matter) continue to support this format because it's
15534 perceived as having some good qualities in those mailer-specific
15535 headers/status bits stuff. Rmail itself still exists as well, of
15536 course, and is still maintained by Stallman.
15538 Both of the above forms leave your mail in a single file on your
15539 file system, and they must parse that entire file each time you take a
15544 @code{nnml} is the back end which smells the most as though you were
15545 actually operating with an @code{nnspool}-accessed Usenet system. (In
15546 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
15547 lo these years ago.) One's mail is taken from the original spool file,
15548 and is then cut up into individual message files, 1:1. It maintains a
15549 Usenet-style active file (analogous to what one finds in an INN- or
15550 CNews-based news system in (for instance) @file{/var/lib/news/active},
15551 or what is returned via the @samp{NNTP LIST} verb) and also creates
15552 @dfn{overview} files for efficient group entry, as has been defined for
15553 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
15554 due to the creation of lots of files, updates to the @code{nnml} active
15555 file, and additions to overview files on a per-message basis, but it is
15556 extremely fast on access because of what amounts to the indexing support
15557 provided by the active file and overviews.
15559 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
15560 resource which defines available places in the file system to put new
15561 files. Sysadmins take a dim view of heavy inode occupation within
15562 tight, shared file systems. But if you live on a personal machine where
15563 the file system is your own and space is not at a premium, @code{nnml}
15566 It is also problematic using this back end if you are living in a
15567 FAT16-based Windows world, since much space will be wasted on all these
15572 The Rand MH mail-reading system has been around UNIX systems for a very
15573 long time; it operates by splitting one's spool file of messages into
15574 individual files, but with little or no indexing support---@code{nnmh}
15575 is considered to be semantically equivalent to ``@code{nnml} without
15576 active file or overviews''. This is arguably the worst choice, because
15577 one gets the slowness of individual file creation married to the
15578 slowness of access parsing when learning what's new in one's groups.
15582 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
15583 method described above) on a per-group basis. That is, @code{nnmbox}
15584 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
15585 little bit of optimization to this so that each of one's mail groups has
15586 a Unix mail box file. It's faster than @code{nnmbox} because each group
15587 can be parsed separately, and still provides the simple Unix mail box
15588 format requiring minimal effort in moving the mail around. In addition,
15589 it maintains an ``active'' file making it much faster for Gnus to figure
15590 out how many messages there are in each separate group.
15592 If you have groups that are expected to have a massive amount of
15593 messages, @code{nnfolder} is not the best choice, but if you receive
15594 only a moderate amount of mail, @code{nnfolder} is probably the most
15595 friendly mail back end all over.
15599 For configuring expiry and other things, @code{nnmaildir} uses
15600 incompatible group parameters, slightly different from those of other
15603 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
15604 differences. Each message is stored in a separate file, but the
15605 filename is unrelated to the article number in Gnus. @code{nnmaildir}
15606 also stores the equivalent of @code{nnml}'s overview files in one file
15607 per article, so it uses about twice as many inodes as @code{nnml}. (Use
15608 @code{df -i} to see how plentiful your inode supply is.) If this slows
15609 you down or takes up very much space, consider switching to
15610 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
15613 Since maildirs don't require locking for delivery, the maildirs you use
15614 as groups can also be the maildirs your mail is directly delivered to.
15615 This means you can skip Gnus' mail splitting if your mail is already
15616 organized into different mailboxes during delivery. A @code{directory}
15617 entry in @code{mail-sources} would have a similar effect, but would
15618 require one set of mailboxes for spooling deliveries (in mbox format,
15619 thus damaging message bodies), and another set to be used as groups (in
15620 whatever format you like). A maildir has a built-in spool, in the
15621 @code{new/} subdirectory. Beware that currently, mail moved from
15622 @code{new/} to @code{cur/} instead of via mail splitting will not
15623 undergo treatment such as duplicate checking.
15625 @code{nnmaildir} stores article marks for a given group in the
15626 corresponding maildir, in a way designed so that it's easy to manipulate
15627 them from outside Gnus. You can tar up a maildir, unpack it somewhere
15628 else, and still have your marks. @code{nnml} also stores marks, but
15629 it's not as easy to work with them from outside Gnus as with
15632 @code{nnmaildir} uses a significant amount of memory to speed things up.
15633 (It keeps in memory some of the things that @code{nnml} stores in files
15634 and that @code{nnmh} repeatedly parses out of message files.) If this
15635 is a problem for you, you can set the @code{nov-cache-size} group
15636 parameter to something small (0 would probably not work, but 1 probably
15637 would) to make it use less memory. This caching will probably be
15638 removed in the future.
15640 Startup is likely to be slower with @code{nnmaildir} than with other
15641 back ends. Everything else is likely to be faster, depending in part
15642 on your file system.
15644 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
15645 to write an @code{nnmaildir}-derived back end.
15650 @node Browsing the Web
15651 @section Browsing the Web
15653 @cindex browsing the web
15657 Web-based discussion forums are getting more and more popular. On many
15658 subjects, the web-based forums have become the most important forums,
15659 eclipsing the importance of mailing lists and news groups. The reason
15660 is easy to understand---they are friendly to new users; you just point
15661 and click, and there's the discussion. With mailing lists, you have to
15662 go through a cumbersome subscription procedure, and most people don't
15663 even know what a news group is.
15665 The problem with this scenario is that web browsers are not very good at
15666 being newsreaders. They do not keep track of what articles you've read;
15667 they do not allow you to score on subjects you're interested in; they do
15668 not allow off-line browsing; they require you to click around and drive
15669 you mad in the end.
15671 So---if web browsers suck at reading discussion forums, why not use Gnus
15674 Gnus has been getting a bit of a collection of back ends for providing
15675 interfaces to these sources.
15679 * Web Searches:: Creating groups from articles that match a string.
15680 * Slashdot:: Reading the Slashdot comments.
15681 * Ultimate:: The Ultimate Bulletin Board systems.
15682 * Web Archive:: Reading mailing list archived on web.
15683 * RSS:: Reading RDF site summary.
15684 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
15687 All the web sources require Emacs/w3 and the url library to work.
15689 The main caveat with all these web sources is that they probably won't
15690 work for a very long time. Gleaning information from the @acronym{HTML} data
15691 is guesswork at best, and when the layout is altered, the Gnus back end
15692 will fail. If you have reasonably new versions of these back ends,
15693 though, you should be ok.
15695 One thing all these Web methods have in common is that the Web sources
15696 are often down, unavailable or just plain too slow to be fun. In those
15697 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
15698 Unplugged}) handle downloading articles, and then you can read them at
15699 leisure from your local disk. No more World Wide Wait for you.
15701 @node Archiving Mail
15702 @subsection Archiving Mail
15703 @cindex archiving mail
15704 @cindex backup of mail
15706 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
15707 @code{nnmaildir}, now actually store the article marks with each group.
15708 For these servers, archiving and restoring a group while preserving
15709 marks is fairly simple.
15711 (Preserving the group level and group parameters as well still
15712 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
15715 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
15716 server, take a recursive copy of the server directory. There is no need
15717 to shut down Gnus, so archiving may be invoked by @code{cron} or
15718 similar. You restore the data by restoring the directory tree, and
15719 adding a server definition pointing to that directory in Gnus. The
15720 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
15721 might interfere with overwriting data, so you may want to shut down Gnus
15722 before you restore the data.
15724 It is also possible to archive individual @code{nnml},
15725 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
15726 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
15727 directory. For @code{nnfolder} you need to copy both the base folder
15728 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
15729 this example). Restoring the group is done with @kbd{G m} from the Group
15730 buffer. The last step makes Gnus notice the new directory.
15731 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
15732 is unnecessary in that case.
15735 @subsection Web Searches
15740 @cindex Usenet searches
15741 @cindex searching the Usenet
15743 It's, like, too neat to search the Usenet for articles that match a
15744 string, but it, like, totally @emph{sucks}, like, totally, to use one of
15745 those, like, Web browsers, and you, like, have to, rilly, like, look at
15746 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
15747 searches without having to use a browser.
15749 The @code{nnweb} back end allows an easy interface to the mighty search
15750 engine. You create an @code{nnweb} group, enter a search pattern, and
15751 then enter the group and read the articles like you would any normal
15752 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
15753 Groups}) will do this in an easy-to-use fashion.
15755 @code{nnweb} groups don't really lend themselves to being solid
15756 groups---they have a very fleeting idea of article numbers. In fact,
15757 each time you enter an @code{nnweb} group (not even changing the search
15758 pattern), you are likely to get the articles ordered in a different
15759 manner. Not even using duplicate suppression (@pxref{Duplicate
15760 Suppression}) will help, since @code{nnweb} doesn't even know the
15761 @code{Message-ID} of the articles before reading them using some search
15762 engines (Google, for instance). The only possible way to keep track
15763 of which articles you've read is by scoring on the @code{Date}
15764 header---mark all articles posted before the last date you read the
15767 If the search engine changes its output substantially, @code{nnweb}
15768 won't be able to parse it and will fail. One could hardly fault the Web
15769 providers if they were to do this---their @emph{raison d'@^etre} is to
15770 make money off of advertisements, not to provide services to the
15771 community. Since @code{nnweb} washes the ads off all the articles, one
15772 might think that the providers might be somewhat miffed. We'll see.
15774 You must have the @code{url} and @code{w3} package installed to be able
15775 to use @code{nnweb}.
15777 Virtual server variables:
15782 What search engine type is being used. The currently supported types
15783 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
15784 @code{dejanews} is an alias to @code{google}.
15787 @vindex nnweb-search
15788 The search string to feed to the search engine.
15790 @item nnweb-max-hits
15791 @vindex nnweb-max-hits
15792 Advisory maximum number of hits per search to display. The default is
15795 @item nnweb-type-definition
15796 @vindex nnweb-type-definition
15797 Type-to-definition alist. This alist says what @code{nnweb} should do
15798 with the various search engine types. The following elements must be
15803 Function to decode the article and provide something that Gnus
15807 Function to create an article number to message header and URL alist.
15810 Function to send the search string to the search engine.
15813 The address the aforementioned function should send the search string
15817 Format string URL to fetch an article by @code{Message-ID}.
15824 @subsection Slashdot
15828 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
15829 lively discussion following the news articles. @code{nnslashdot} will
15830 let you read this forum in a convenient manner.
15832 The easiest way to read this source is to put something like the
15833 following in your @file{~/.gnus.el} file:
15836 (setq gnus-secondary-select-methods
15837 '((nnslashdot "")))
15840 This will make Gnus query the @code{nnslashdot} back end for new comments
15841 and groups. The @kbd{F} command will subscribe each new news article as
15842 a new Gnus group, and you can read the comments by entering these
15843 groups. (Note that the default subscription method is to subscribe new
15844 groups as zombies. Other methods are available (@pxref{Subscription
15847 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
15848 command is the most handy tool (@pxref{Foreign Groups}).
15850 When following up to @code{nnslashdot} comments (or posting new
15851 comments), some light @acronym{HTML}izations will be performed. In
15852 particular, text quoted with @samp{> } will be quoted with
15853 @samp{blockquote} instead, and signatures will have @samp{br} added to
15854 the end of each line. Other than that, you can just write @acronym{HTML}
15855 directly into the message buffer. Note that Slashdot filters out some
15856 @acronym{HTML} forms.
15858 The following variables can be altered to change its behavior:
15861 @item nnslashdot-threaded
15862 Whether @code{nnslashdot} should display threaded groups or not. The
15863 default is @code{t}. To be able to display threads, @code{nnslashdot}
15864 has to retrieve absolutely all comments in a group upon entry. If a
15865 threaded display is not required, @code{nnslashdot} will only retrieve
15866 the comments that are actually wanted by the user. Threading is nicer,
15867 but much, much slower than unthreaded.
15869 @item nnslashdot-login-name
15870 @vindex nnslashdot-login-name
15871 The login name to use when posting.
15873 @item nnslashdot-password
15874 @vindex nnslashdot-password
15875 The password to use when posting.
15877 @item nnslashdot-directory
15878 @vindex nnslashdot-directory
15879 Where @code{nnslashdot} will store its files. The default is
15880 @file{~/News/slashdot/}.
15882 @item nnslashdot-active-url
15883 @vindex nnslashdot-active-url
15884 The @acronym{URL} format string that will be used to fetch the
15885 information on news articles and comments. The default is@*
15886 @samp{http://slashdot.org/search.pl?section=&min=%d}.
15888 @item nnslashdot-comments-url
15889 @vindex nnslashdot-comments-url
15890 The @acronym{URL} format string that will be used to fetch comments.
15892 @item nnslashdot-article-url
15893 @vindex nnslashdot-article-url
15894 The @acronym{URL} format string that will be used to fetch the news
15895 article. The default is
15896 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
15898 @item nnslashdot-threshold
15899 @vindex nnslashdot-threshold
15900 The score threshold. The default is -1.
15902 @item nnslashdot-group-number
15903 @vindex nnslashdot-group-number
15904 The number of old groups, in addition to the ten latest, to keep
15905 updated. The default is 0.
15912 @subsection Ultimate
15914 @cindex Ultimate Bulletin Board
15916 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
15917 probably the most popular Web bulletin board system used. It has a
15918 quite regular and nice interface, and it's possible to get the
15919 information Gnus needs to keep groups updated.
15921 The easiest way to get started with @code{nnultimate} is to say
15922 something like the following in the group buffer: @kbd{B nnultimate RET
15923 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
15924 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
15925 you're interested in; there's quite a list of them on the Ultimate web
15926 site.) Then subscribe to the groups you're interested in from the
15927 server buffer, and read them from the group buffer.
15929 The following @code{nnultimate} variables can be altered:
15932 @item nnultimate-directory
15933 @vindex nnultimate-directory
15934 The directory where @code{nnultimate} stores its files. The default is@*
15935 @file{~/News/ultimate/}.
15940 @subsection Web Archive
15942 @cindex Web Archive
15944 Some mailing lists only have archives on Web servers, such as
15945 @uref{http://www.egroups.com/} and
15946 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
15947 interface, and it's possible to get the information Gnus needs to keep
15950 @findex gnus-group-make-warchive-group
15951 The easiest way to get started with @code{nnwarchive} is to say
15952 something like the following in the group buffer: @kbd{M-x
15953 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
15954 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
15955 @var{an_egroup} with the mailing list you subscribed, the
15956 @var{your@@email.address} with your email address.), or to browse the
15957 back end by @kbd{B nnwarchive RET mail-archive RET}.
15959 The following @code{nnwarchive} variables can be altered:
15962 @item nnwarchive-directory
15963 @vindex nnwarchive-directory
15964 The directory where @code{nnwarchive} stores its files. The default is@*
15965 @file{~/News/warchive/}.
15967 @item nnwarchive-login
15968 @vindex nnwarchive-login
15969 The account name on the web server.
15971 @item nnwarchive-passwd
15972 @vindex nnwarchive-passwd
15973 The password for your account on the web server.
15981 Some web sites have an RDF Site Summary (@acronym{RSS}).
15982 @acronym{RSS} is a format for summarizing headlines from news related
15983 sites (such as BBC or CNN). But basically anything list-like can be
15984 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
15985 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
15987 @acronym{RSS} has a quite regular and nice interface, and it's
15988 possible to get the information Gnus needs to keep groups updated.
15990 @kindex G R (Summary)
15991 Use @kbd{G R} from the summary buffer to subscribe to a feed---you
15992 will be prompted for the location of the feed.
15994 An easy way to get started with @code{nnrss} is to say something like
15995 the following in the group buffer: @kbd{B nnrss RET y}, then
15996 subscribe to groups.
15999 You can also use the following commands to import and export your
16000 subscriptions from a file in @acronym{OPML} format (Outline Processor
16003 @defun nnrss-opml-import file
16004 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
16008 @defun nnrss-opml-export
16009 Write your current @acronym{RSS} subscriptions to a buffer in
16010 @acronym{OPML} format.
16013 The following @code{nnrss} variables can be altered:
16016 @item nnrss-directory
16017 @vindex nnrss-directory
16018 The directory where @code{nnrss} stores its files. The default is
16019 @file{~/News/rss/}.
16021 @item nnrss-use-local
16022 @vindex nnrss-use-local
16023 @findex nnrss-generate-download-script
16024 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
16025 the feeds from local files in @code{nnrss-directory}. You can use
16026 the command @code{nnrss-generate-download-script} to generate a
16027 download script using @command{wget}.
16030 The following code may be helpful, if you want to show the description in
16031 the summary buffer.
16034 (add-to-list 'nnmail-extra-headers nnrss-description-field)
16035 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
16037 (defun gnus-user-format-function-X (header)
16039 (assq nnrss-description-field (mail-header-extra header))))
16040 (if descr (concat "\n\t" (cdr descr)) "")))
16043 The following code may be useful to open an nnrss url directly from the
16046 (require 'browse-url)
16048 (defun browse-nnrss-url( arg )
16050 (let ((url (assq nnrss-url-field
16053 (assq (gnus-summary-article-number)
16054 gnus-newsgroup-data))))))
16057 (browse-url (cdr url))
16058 (gnus-summary-mark-as-read-forward 1))
16059 (gnus-summary-scroll-up arg))))
16061 (eval-after-load "gnus"
16062 #'(define-key gnus-summary-mode-map
16063 (kbd "<RET>") 'browse-nnrss-url))
16064 (add-to-list 'nnmail-extra-headers nnrss-url-field)
16067 @node Customizing w3
16068 @subsection Customizing w3
16074 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
16075 pages. Emacs/w3 is documented in its own manual, but there are some
16076 things that may be more relevant for Gnus users.
16078 For instance, a common question is how to make Emacs/w3 follow links
16079 using the @code{browse-url} functions (which will call some external web
16080 browser like Netscape). Here's one way:
16083 (eval-after-load "w3"
16085 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
16086 (defun w3-fetch (&optional url target)
16087 (interactive (list (w3-read-url-with-default)))
16088 (if (eq major-mode 'gnus-article-mode)
16090 (w3-fetch-orig url target)))))
16093 Put that in your @file{.emacs} file, and hitting links in w3-rendered
16094 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
16101 @cindex @acronym{IMAP}
16103 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
16104 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
16105 server is much similar to connecting to a news server, you just
16106 specify the network address of the server.
16108 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
16109 everything that @acronym{POP} can, it can hence be viewed as a
16110 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
16111 similar to @acronym{NNTP} being a news storage protocol---however,
16112 @acronym{IMAP} offers more features than @acronym{NNTP} because news
16113 is more or less read-only whereas mail is read-write.
16115 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
16116 entry in @code{mail-sources}. With this, Gnus will fetch mails from
16117 the @acronym{IMAP} server and store them on the local disk. This is
16118 not the usage described in this section---@xref{Mail Sources}.
16120 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
16121 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
16122 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
16123 usage explained in this section.
16125 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
16126 servers might look something like the following. (Note that for
16127 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
16131 (setq gnus-secondary-select-methods
16132 '((nnimap "simpleserver") ; @r{no special configuration}
16133 ; @r{perhaps a ssh port forwarded server:}
16135 (nnimap-address "localhost")
16136 (nnimap-server-port 1430))
16137 ; @r{a UW server running on localhost}
16139 (nnimap-server-port 143)
16140 (nnimap-address "localhost")
16141 (nnimap-list-pattern ("INBOX" "mail/*")))
16142 ; @r{anonymous public cyrus server:}
16143 (nnimap "cyrus.andrew.cmu.edu"
16144 (nnimap-authenticator anonymous)
16145 (nnimap-list-pattern "archive.*")
16146 (nnimap-stream network))
16147 ; @r{a ssl server on a non-standard port:}
16149 (nnimap-address "vic20.somewhere.com")
16150 (nnimap-server-port 9930)
16151 (nnimap-stream ssl))))
16154 After defining the new server, you can subscribe to groups on the
16155 server using normal Gnus commands such as @kbd{U} in the Group Buffer
16156 (@pxref{Subscription Commands}) or via the Server Buffer
16157 (@pxref{Server Buffer}).
16159 The following variables can be used to create a virtual @code{nnimap}
16164 @item nnimap-address
16165 @vindex nnimap-address
16167 The address of the remote @acronym{IMAP} server. Defaults to the virtual
16168 server name if not specified.
16170 @item nnimap-server-port
16171 @vindex nnimap-server-port
16172 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
16174 Note that this should be an integer, example server specification:
16177 (nnimap "mail.server.com"
16178 (nnimap-server-port 4711))
16181 @item nnimap-list-pattern
16182 @vindex nnimap-list-pattern
16183 String or list of strings of mailboxes to limit available groups to.
16184 This is used when the server has very many mailboxes and you're only
16185 interested in a few---some servers export your home directory via
16186 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
16187 @file{~/Mail/*} then.
16189 The string can also be a cons of REFERENCE and the string as above, what
16190 REFERENCE is used for is server specific, but on the University of
16191 Washington server it's a directory that will be concatenated with the
16194 Example server specification:
16197 (nnimap "mail.server.com"
16198 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
16199 ("~friend/Mail/" . "list/*"))))
16202 @item nnimap-stream
16203 @vindex nnimap-stream
16204 The type of stream used to connect to your server. By default, nnimap
16205 will detect and automatically use all of the below, with the exception
16206 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
16207 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
16208 be automatically detected, but it's not widely deployed yet.)
16210 Example server specification:
16213 (nnimap "mail.server.com"
16214 (nnimap-stream ssl))
16217 Please note that the value of @code{nnimap-stream} is a symbol!
16221 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
16222 @samp{gsasl} or @samp{imtest} program.
16224 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
16226 @dfn{starttls:} Connect via the STARTTLS extension (similar to
16227 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
16230 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
16231 @samp{gnutls-cli}).
16233 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
16234 @samp{openssl}) or SSLeay (@samp{s_client}).
16236 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
16238 @dfn{network:} Plain, TCP/IP network connection.
16241 @vindex imap-kerberos4-program
16242 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
16243 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
16244 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
16245 to make @code{imap.el} use a pty instead of a pipe when communicating
16246 with @samp{imtest}. You will then suffer from a line length
16247 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
16248 indefinitely if you have many articles in a mailbox. The variable
16249 @code{imap-kerberos4-program} contain parameters to pass to the imtest
16252 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
16253 needed. It is available from
16254 @uref{http://www.gnu.org/software/gnutls/}.
16256 @vindex imap-gssapi-program
16257 This parameter specifies a list of command lines that invoke a GSSAPI
16258 authenticated @acronym{IMAP} stream in a subshell. They are tried
16259 sequentially until a connection is made, or the list has been
16260 exhausted. By default, @samp{gsasl} from GNU SASL, available from
16261 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
16262 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
16265 @vindex imap-ssl-program
16266 For @acronym{SSL} connections, the OpenSSL program is available from
16267 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
16268 and nnimap support it too---although the most recent versions of
16269 SSLeay, 0.9.x, are known to have serious bugs making it
16270 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
16271 work. The variable @code{imap-ssl-program} contain parameters to pass
16274 @vindex imap-shell-program
16275 @vindex imap-shell-host
16276 For @acronym{IMAP} connections using the @code{shell} stream, the variable
16277 @code{imap-shell-program} specify what program to call.
16279 @item nnimap-authenticator
16280 @vindex nnimap-authenticator
16282 The authenticator used to connect to the server. By default, nnimap
16283 will use the most secure authenticator your server is capable of.
16285 Example server specification:
16288 (nnimap "mail.server.com"
16289 (nnimap-authenticator anonymous))
16292 Please note that the value of @code{nnimap-authenticator} is a symbol!
16296 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
16297 external program @code{gsasl} or @code{imtest}.
16299 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
16302 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
16303 external library @code{digest-md5.el}.
16305 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
16307 @dfn{login:} Plain-text username/password via LOGIN.
16309 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
16312 @item nnimap-expunge-on-close
16314 @vindex nnimap-expunge-on-close
16315 Unlike Parmenides the @acronym{IMAP} designers have decided things that
16316 don't exist actually do exist. More specifically, @acronym{IMAP} has
16317 this concept of marking articles @code{Deleted} which doesn't actually
16318 delete them, and this (marking them @code{Deleted}, that is) is what
16319 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
16322 Since the articles aren't really removed when we mark them with the
16323 @code{Deleted} flag we'll need a way to actually delete them. Feel like
16324 running in circles yet?
16326 Traditionally, nnimap has removed all articles marked as @code{Deleted}
16327 when closing a mailbox but this is now configurable by this server
16330 The possible options are:
16335 The default behavior, delete all articles marked as ``Deleted'' when
16338 Never actually delete articles. Currently there is no way of showing
16339 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
16340 may allow you to do this. If you ever want to run the EXPUNGE command
16341 manually, @xref{Expunging mailboxes}.
16343 When closing mailboxes, nnimap will ask if you wish to expunge deleted
16348 @item nnimap-importantize-dormant
16349 @vindex nnimap-importantize-dormant
16351 If non-@code{nil} (the default), marks dormant articles as ticked (as
16352 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
16353 naturally still (only) be marked as dormant. This is to make dormant
16354 articles stand out, just like ticked articles, in other @acronym{IMAP}
16355 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
16358 Probably the only reason for frobing this would be if you're trying
16359 enable per-user persistent dormant flags, using something like:
16362 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
16363 (format "gnus-dormant-%s" (user-login-name)))
16364 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
16365 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
16368 In this case, you would not want the per-user dormant flag showing up
16369 as ticked for other users.
16371 @item nnimap-expunge-search-string
16373 @vindex nnimap-expunge-search-string
16375 This variable contain the @acronym{IMAP} search command sent to server when
16376 searching for articles eligible for expiring. The default is
16377 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
16378 UID set and the second @code{%s} is replaced by a date.
16380 Probably the only useful value to change this to is
16381 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
16382 messages instead of the internal article date. See section 6.4.4 of
16383 RFC 2060 for more information on valid strings.
16385 @item nnimap-authinfo-file
16386 @vindex nnimap-authinfo-file
16388 A file containing credentials used to log in on servers. The format is
16389 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
16390 variable @code{nntp-authinfo-file} for exact syntax; also see
16391 @ref{NNTP}. An example of an .authinfo line for an IMAP server, is:
16394 machine students.uio.no login larsi password geheimnis port imap
16397 Note that it should be @code{port imap}, or @code{port 143}, if you
16398 use a @code{nnimap-stream} of @code{tls} or @code{ssl}, even if the
16399 actual port number used is port 993 for secured IMAP. For
16400 convenience, Gnus will accept @code{port imaps} as a synonym of
16403 @item nnimap-need-unselect-to-notice-new-mail
16404 @vindex nnimap-need-unselect-to-notice-new-mail
16406 Unselect mailboxes before looking for new mail in them. Some servers
16407 seem to need this under some circumstances; it was reported that
16413 * Splitting in IMAP:: Splitting mail with nnimap.
16414 * Expiring in IMAP:: Expiring mail with nnimap.
16415 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
16416 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
16417 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
16418 * Debugging IMAP:: What to do when things don't work.
16423 @node Splitting in IMAP
16424 @subsection Splitting in IMAP
16425 @cindex splitting imap mail
16427 Splitting is something Gnus users have loved and used for years, and now
16428 the rest of the world is catching up. Yeah, dream on, not many
16429 @acronym{IMAP} servers have server side splitting and those that have
16430 splitting seem to use some non-standard protocol. This means that
16431 @acronym{IMAP} support for Gnus has to do its own splitting.
16435 (Incidentally, people seem to have been dreaming on, and Sieve has
16436 gaining a market share and is supported by several IMAP servers.
16437 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
16439 Here are the variables of interest:
16443 @item nnimap-split-crosspost
16444 @cindex splitting, crosspost
16446 @vindex nnimap-split-crosspost
16448 If non-@code{nil}, do crossposting if several split methods match the
16449 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
16450 found will be used.
16452 Nnmail equivalent: @code{nnmail-crosspost}.
16454 @item nnimap-split-inbox
16455 @cindex splitting, inbox
16457 @vindex nnimap-split-inbox
16459 A string or a list of strings that gives the name(s) of @acronym{IMAP}
16460 mailboxes to split from. Defaults to @code{nil}, which means that
16461 splitting is disabled!
16464 (setq nnimap-split-inbox
16465 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
16468 No nnmail equivalent.
16470 @item nnimap-split-rule
16471 @cindex splitting, rules
16472 @vindex nnimap-split-rule
16474 New mail found in @code{nnimap-split-inbox} will be split according to
16477 This variable contains a list of lists, where the first element in the
16478 sublist gives the name of the @acronym{IMAP} mailbox to move articles
16479 matching the regexp in the second element in the sublist. Got that?
16480 Neither did I, we need examples.
16483 (setq nnimap-split-rule
16485 "^Sender: owner-nnimap@@vic20.globalcom.se")
16486 ("INBOX.junk" "^Subject:.*MAKE MONEY")
16487 ("INBOX.private" "")))
16490 This will put all articles from the nnimap mailing list into mailbox
16491 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
16492 into INBOX.junk and everything else in INBOX.private.
16494 The first string may contain @samp{\\1} forms, like the ones used by
16495 replace-match to insert sub-expressions from the matched text. For
16499 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
16502 The first element can also be the symbol @code{junk} to indicate that
16503 matching messages should simply be deleted. Use with care.
16505 The second element can also be a function. In that case, it will be
16506 called with the first element of the rule as the argument, in a buffer
16507 containing the headers of the article. It should return a
16508 non-@code{nil} value if it thinks that the mail belongs in that group.
16510 Nnmail users might recollect that the last regexp had to be empty to
16511 match all articles (like in the example above). This is not required in
16512 nnimap. Articles not matching any of the regexps will not be moved out
16513 of your inbox. (This might affect performance if you keep lots of
16514 unread articles in your inbox, since the splitting code would go over
16515 them every time you fetch new mail.)
16517 These rules are processed from the beginning of the alist toward the
16518 end. The first rule to make a match will ``win'', unless you have
16519 crossposting enabled. In that case, all matching rules will ``win''.
16521 This variable can also have a function as its value, the function will
16522 be called with the headers narrowed and should return a group where it
16523 thinks the article should be split to. See @code{nnimap-split-fancy}.
16525 The splitting code tries to create mailboxes if it needs to.
16527 To allow for different split rules on different virtual servers, and
16528 even different split rules in different inboxes on the same server,
16529 the syntax of this variable have been extended along the lines of:
16532 (setq nnimap-split-rule
16533 '(("my1server" (".*" (("ding" "ding@@gnus.org")
16534 ("junk" "From:.*Simon"))))
16535 ("my2server" ("INBOX" nnimap-split-fancy))
16536 ("my[34]server" (".*" (("private" "To:.*Simon")
16537 ("junk" my-junk-func))))))
16540 The virtual server name is in fact a regexp, so that the same rules
16541 may apply to several servers. In the example, the servers
16542 @code{my3server} and @code{my4server} both use the same rules.
16543 Similarly, the inbox string is also a regexp. The actual splitting
16544 rules are as before, either a function, or a list with group/regexp or
16545 group/function elements.
16547 Nnmail equivalent: @code{nnmail-split-methods}.
16549 @item nnimap-split-predicate
16551 @vindex nnimap-split-predicate
16553 Mail matching this predicate in @code{nnimap-split-inbox} will be
16554 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
16556 This might be useful if you use another @acronym{IMAP} client to read mail in
16557 your inbox but would like Gnus to split all articles in the inbox
16558 regardless of readedness. Then you might change this to
16561 @item nnimap-split-fancy
16562 @cindex splitting, fancy
16563 @findex nnimap-split-fancy
16564 @vindex nnimap-split-fancy
16566 It's possible to set @code{nnimap-split-rule} to
16567 @code{nnmail-split-fancy} if you want to use fancy
16568 splitting. @xref{Fancy Mail Splitting}.
16570 However, to be able to have different fancy split rules for nnmail and
16571 nnimap back ends you can set @code{nnimap-split-rule} to
16572 @code{nnimap-split-fancy} and define the nnimap specific fancy split
16573 rule in @code{nnimap-split-fancy}.
16578 (setq nnimap-split-rule 'nnimap-split-fancy
16579 nnimap-split-fancy ...)
16582 Nnmail equivalent: @code{nnmail-split-fancy}.
16584 @item nnimap-split-download-body
16585 @findex nnimap-split-download-body
16586 @vindex nnimap-split-download-body
16588 Set to non-@code{nil} to download entire articles during splitting.
16589 This is generally not required, and will slow things down
16590 considerably. You may need it if you want to use an advanced
16591 splitting function that analyses the body to split the article.
16595 @node Expiring in IMAP
16596 @subsection Expiring in IMAP
16597 @cindex expiring imap mail
16599 Even though @code{nnimap} is not a proper @code{nnmail} derived back
16600 end, it supports most features in regular expiring (@pxref{Expiring
16601 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
16602 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
16603 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
16604 follows below are the variables used by the @code{nnimap} expiry
16607 A note on how the expire mark is stored on the @acronym{IMAP} server is
16608 appropriate here as well. The expire mark is translated into a
16609 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
16610 message. This means that likely only Gnus will understand and treat
16611 the @code{gnus-expire} mark properly, although other clients may allow
16612 you to view client specific flags on the message. It also means that
16613 your server must support permanent storage of client specific flags on
16614 messages. Most do, fortunately.
16618 @item nnmail-expiry-wait
16619 @item nnmail-expiry-wait-function
16621 These variables are fully supported. The expire value can be a
16622 number, the symbol @code{immediate} or @code{never}.
16624 @item nnmail-expiry-target
16626 This variable is supported, and internally implemented by calling the
16627 @code{nnmail} functions that handle this. It contains an optimization
16628 that if the destination is a @acronym{IMAP} group on the same server, the
16629 article is copied instead of appended (that is, uploaded again).
16633 @node Editing IMAP ACLs
16634 @subsection Editing IMAP ACLs
16635 @cindex editing imap acls
16636 @cindex Access Control Lists
16637 @cindex Editing @acronym{IMAP} ACLs
16638 @kindex G l (Group)
16639 @findex gnus-group-nnimap-edit-acl
16641 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
16642 limiting (or enabling) other users access to your mail boxes. Not all
16643 @acronym{IMAP} servers support this, this function will give an error if it
16646 To edit an ACL for a mailbox, type @kbd{G l}
16647 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
16648 editing window with detailed instructions.
16650 Some possible uses:
16654 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
16655 on your mailing list mailboxes enables other users on the same server to
16656 follow the list without subscribing to it.
16658 At least with the Cyrus server, you are required to give the user
16659 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
16660 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
16664 @node Expunging mailboxes
16665 @subsection Expunging mailboxes
16669 @cindex manual expunging
16670 @kindex G x (Group)
16671 @findex gnus-group-nnimap-expunge
16673 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
16674 you may want the option of expunging all deleted articles in a mailbox
16675 manually. This is exactly what @kbd{G x} does.
16677 Currently there is no way of showing deleted articles, you can just
16680 @node A note on namespaces
16681 @subsection A note on namespaces
16682 @cindex IMAP namespace
16685 The @acronym{IMAP} protocol has a concept called namespaces, described
16686 by the following text in the RFC:
16689 5.1.2. Mailbox Namespace Naming Convention
16691 By convention, the first hierarchical element of any mailbox name
16692 which begins with "#" identifies the "namespace" of the remainder of
16693 the name. This makes it possible to disambiguate between different
16694 types of mailbox stores, each of which have their own namespaces.
16696 For example, implementations which offer access to USENET
16697 newsgroups MAY use the "#news" namespace to partition the USENET
16698 newsgroup namespace from that of other mailboxes. Thus, the
16699 comp.mail.misc newsgroup would have an mailbox name of
16700 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
16701 to a different object (e.g. a user's private mailbox).
16704 While there is nothing in this text that warrants concern for the
16705 @acronym{IMAP} implementation in Gnus, some servers use namespace
16706 prefixes in a way that does not work with how Gnus uses mailbox names.
16708 Specifically, University of Washington's @acronym{IMAP} server uses
16709 mailbox names like @code{#driver.mbx/read-mail} which are valid only
16710 in the @sc{create} and @sc{append} commands. After the mailbox is
16711 created (or a messages is appended to a mailbox), it must be accessed
16712 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
16713 not make it possible for the user to guarantee that user entered
16714 mailbox names will only be used with the CREATE and APPEND commands,
16715 you should simply not use the namespace prefixed mailbox names in
16718 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
16719 for more information on how to use the prefixes. They are a power
16720 tool and should be used only if you are sure what the effects are.
16722 @node Debugging IMAP
16723 @subsection Debugging IMAP
16724 @cindex IMAP debugging
16725 @cindex protocol dump (IMAP)
16727 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
16728 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
16729 best to fix them right away. If you encounter odd behaviour, chances
16730 are that either the server or Gnus is buggy.
16732 If you are familiar with network protocols in general, you will
16733 probably be able to extract some clues from the protocol dump of the
16734 exchanges between Gnus and the server. Even if you are not familiar
16735 with network protocols, when you include the protocol dump in
16736 @acronym{IMAP}-related bug reports you are helping us with data
16737 critical to solving the problem. Therefore, we strongly encourage you
16738 to include the protocol dump when reporting IMAP bugs in Gnus.
16742 Because the protocol dump, when enabled, generates lots of data, it is
16743 disabled by default. You can enable it by setting @code{imap-log} as
16750 This instructs the @code{imap.el} package to log any exchanges with
16751 the server. The log is stored in the buffer @samp{*imap-log*}. Look
16752 for error messages, which sometimes are tagged with the keyword
16753 @code{BAD}---but when submitting a bug, make sure to include all the
16756 @node Other Sources
16757 @section Other Sources
16759 Gnus can do more than just read news or mail. The methods described
16760 below allow Gnus to view directories and files as if they were
16764 * Directory Groups:: You can read a directory as if it was a newsgroup.
16765 * Anything Groups:: Dired? Who needs dired?
16766 * Document Groups:: Single files can be the basis of a group.
16767 * SOUP:: Reading @sc{soup} packets ``offline''.
16768 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
16772 @node Directory Groups
16773 @subsection Directory Groups
16775 @cindex directory groups
16777 If you have a directory that has lots of articles in separate files in
16778 it, you might treat it as a newsgroup. The files have to have numerical
16781 This might be an opportune moment to mention @code{ange-ftp} (and its
16782 successor @code{efs}), that most wonderful of all wonderful Emacs
16783 packages. When I wrote @code{nndir}, I didn't think much about it---a
16784 back end to read directories. Big deal.
16786 @code{ange-ftp} changes that picture dramatically. For instance, if you
16787 enter the @code{ange-ftp} file name
16788 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
16789 @code{ange-ftp} or @code{efs} will actually allow you to read this
16790 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
16792 @code{nndir} will use @acronym{NOV} files if they are present.
16794 @code{nndir} is a ``read-only'' back end---you can't delete or expire
16795 articles with this method. You can use @code{nnmh} or @code{nnml} for
16796 whatever you use @code{nndir} for, so you could switch to any of those
16797 methods if you feel the need to have a non-read-only @code{nndir}.
16800 @node Anything Groups
16801 @subsection Anything Groups
16804 From the @code{nndir} back end (which reads a single spool-like
16805 directory), it's just a hop and a skip to @code{nneething}, which
16806 pretends that any arbitrary directory is a newsgroup. Strange, but
16809 When @code{nneething} is presented with a directory, it will scan this
16810 directory and assign article numbers to each file. When you enter such
16811 a group, @code{nneething} must create ``headers'' that Gnus can use.
16812 After all, Gnus is a newsreader, in case you're forgetting.
16813 @code{nneething} does this in a two-step process. First, it snoops each
16814 file in question. If the file looks like an article (i.e., the first
16815 few lines look like headers), it will use this as the head. If this is
16816 just some arbitrary file without a head (e.g. a C source file),
16817 @code{nneething} will cobble up a header out of thin air. It will use
16818 file ownership, name and date and do whatever it can with these
16821 All this should happen automatically for you, and you will be presented
16822 with something that looks very much like a newsgroup. Totally like a
16823 newsgroup, to be precise. If you select an article, it will be displayed
16824 in the article buffer, just as usual.
16826 If you select a line that represents a directory, Gnus will pop you into
16827 a new summary buffer for this @code{nneething} group. And so on. You can
16828 traverse the entire disk this way, if you feel like, but remember that
16829 Gnus is not dired, really, and does not intend to be, either.
16831 There are two overall modes to this action---ephemeral or solid. When
16832 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
16833 will not store information on what files you have read, and what files
16834 are new, and so on. If you create a solid @code{nneething} group the
16835 normal way with @kbd{G m}, Gnus will store a mapping table between
16836 article numbers and file names, and you can treat this group like any
16837 other groups. When you activate a solid @code{nneething} group, you will
16838 be told how many unread articles it contains, etc., etc.
16843 @item nneething-map-file-directory
16844 @vindex nneething-map-file-directory
16845 All the mapping files for solid @code{nneething} groups will be stored
16846 in this directory, which defaults to @file{~/.nneething/}.
16848 @item nneething-exclude-files
16849 @vindex nneething-exclude-files
16850 All files that match this regexp will be ignored. Nice to use to exclude
16851 auto-save files and the like, which is what it does by default.
16853 @item nneething-include-files
16854 @vindex nneething-include-files
16855 Regexp saying what files to include in the group. If this variable is
16856 non-@code{nil}, only files matching this regexp will be included.
16858 @item nneething-map-file
16859 @vindex nneething-map-file
16860 Name of the map files.
16864 @node Document Groups
16865 @subsection Document Groups
16867 @cindex documentation group
16870 @code{nndoc} is a cute little thing that will let you read a single file
16871 as a newsgroup. Several files types are supported:
16878 The Babyl (Rmail) mail box.
16883 The standard Unix mbox file.
16885 @cindex MMDF mail box
16887 The MMDF mail box format.
16890 Several news articles appended into a file.
16893 @cindex rnews batch files
16894 The rnews batch transport format.
16895 @cindex forwarded messages
16898 Forwarded articles.
16901 Netscape mail boxes.
16904 @acronym{MIME} multipart messages.
16906 @item standard-digest
16907 The standard (RFC 1153) digest format.
16910 A @acronym{MIME} digest of messages.
16912 @item lanl-gov-announce
16913 Announcement messages from LANL Gov Announce.
16915 @item rfc822-forward
16916 A message forwarded according to RFC822.
16919 The Outlook mail box.
16922 The Outlook Express dbx mail box.
16925 A bounce message from the Exim MTA.
16928 A message forwarded according to informal rules.
16931 An RFC934-forwarded message.
16937 A digest of Clarinet brief news items.
16940 Non-standard digest format---matches most things, but does it badly.
16946 You can also use the special ``file type'' @code{guess}, which means
16947 that @code{nndoc} will try to guess what file type it is looking at.
16948 @code{digest} means that @code{nndoc} should guess what digest type the
16951 @code{nndoc} will not try to change the file or insert any extra headers into
16952 it---it will simply, like, let you use the file as the basis for a
16953 group. And that's it.
16955 If you have some old archived articles that you want to insert into your
16956 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
16957 that. Say you have an old @file{RMAIL} file with mail that you now want
16958 to split into your new @code{nnml} groups. You look at that file using
16959 @code{nndoc} (using the @kbd{G f} command in the group buffer
16960 (@pxref{Foreign Groups})), set the process mark on all the articles in
16961 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
16962 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
16963 file is now also stored in lots of @code{nnml} directories, and you can
16964 delete that pesky @file{RMAIL} file. If you have the guts!
16966 Virtual server variables:
16969 @item nndoc-article-type
16970 @vindex nndoc-article-type
16971 This should be one of @code{mbox}, @code{babyl}, @code{digest},
16972 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
16973 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
16974 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
16975 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
16977 @item nndoc-post-type
16978 @vindex nndoc-post-type
16979 This variable says whether Gnus is to consider the group a news group or
16980 a mail group. There are two valid values: @code{mail} (the default)
16985 * Document Server Internals:: How to add your own document types.
16989 @node Document Server Internals
16990 @subsubsection Document Server Internals
16992 Adding new document types to be recognized by @code{nndoc} isn't
16993 difficult. You just have to whip up a definition of what the document
16994 looks like, write a predicate function to recognize that document type,
16995 and then hook into @code{nndoc}.
16997 First, here's an example document type definition:
17001 (article-begin . "^\^A\^A\^A\^A\n")
17002 (body-end . "^\^A\^A\^A\^A\n"))
17005 The definition is simply a unique @dfn{name} followed by a series of
17006 regexp pseudo-variable settings. Below are the possible
17007 variables---don't be daunted by the number of variables; most document
17008 types can be defined with very few settings:
17011 @item first-article
17012 If present, @code{nndoc} will skip past all text until it finds
17013 something that match this regexp. All text before this will be
17016 @item article-begin
17017 This setting has to be present in all document type definitions. It
17018 says what the beginning of each article looks like.
17020 @item head-begin-function
17021 If present, this should be a function that moves point to the head of
17024 @item nndoc-head-begin
17025 If present, this should be a regexp that matches the head of the
17028 @item nndoc-head-end
17029 This should match the end of the head of the article. It defaults to
17030 @samp{^$}---the empty line.
17032 @item body-begin-function
17033 If present, this function should move point to the beginning of the body
17037 This should match the beginning of the body of the article. It defaults
17040 @item body-end-function
17041 If present, this function should move point to the end of the body of
17045 If present, this should match the end of the body of the article.
17048 If present, this should match the end of the file. All text after this
17049 regexp will be totally ignored.
17053 So, using these variables @code{nndoc} is able to dissect a document
17054 file into a series of articles, each with a head and a body. However, a
17055 few more variables are needed since not all document types are all that
17056 news-like---variables needed to transform the head or the body into
17057 something that's palatable for Gnus:
17060 @item prepare-body-function
17061 If present, this function will be called when requesting an article. It
17062 will be called with point at the start of the body, and is useful if the
17063 document has encoded some parts of its contents.
17065 @item article-transform-function
17066 If present, this function is called when requesting an article. It's
17067 meant to be used for more wide-ranging transformation of both head and
17068 body of the article.
17070 @item generate-head-function
17071 If present, this function is called to generate a head that Gnus can
17072 understand. It is called with the article number as a parameter, and is
17073 expected to generate a nice head for the article in question. It is
17074 called when requesting the headers of all articles.
17078 Let's look at the most complicated example I can come up with---standard
17083 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
17084 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
17085 (prepare-body-function . nndoc-unquote-dashes)
17086 (body-end-function . nndoc-digest-body-end)
17087 (head-end . "^ ?$")
17088 (body-begin . "^ ?\n")
17089 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
17090 (subtype digest guess))
17093 We see that all text before a 70-width line of dashes is ignored; all
17094 text after a line that starts with that @samp{^End of} is also ignored;
17095 each article begins with a 30-width line of dashes; the line separating
17096 the head from the body may contain a single space; and that the body is
17097 run through @code{nndoc-unquote-dashes} before being delivered.
17099 To hook your own document definition into @code{nndoc}, use the
17100 @code{nndoc-add-type} function. It takes two parameters---the first
17101 is the definition itself and the second (optional) parameter says
17102 where in the document type definition alist to put this definition.
17103 The alist is traversed sequentially, and
17104 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
17105 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
17106 @code{mmdf} type, and so on. These type predicates should return
17107 @code{nil} if the document is not of the correct type; @code{t} if it
17108 is of the correct type; and a number if the document might be of the
17109 correct type. A high number means high probability; a low number
17110 means low probability with @samp{0} being the lowest valid number.
17118 In the PC world people often talk about ``offline'' newsreaders. These
17119 are thingies that are combined reader/news transport monstrosities.
17120 With built-in modem programs. Yecchh!
17122 Of course, us Unix Weenie types of human beans use things like
17123 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
17124 transport things like Ghod intended. And then we just use normal
17127 However, it can sometimes be convenient to do something that's a bit
17128 easier on the brain if you have a very slow modem, and you're not really
17129 that interested in doing things properly.
17131 A file format called @sc{soup} has been developed for transporting news
17132 and mail from servers to home machines and back again. It can be a bit
17135 First some terminology:
17140 This is the machine that is connected to the outside world and where you
17141 get news and/or mail from.
17144 This is the machine that you want to do the actual reading and responding
17145 on. It is typically not connected to the rest of the world in any way.
17148 Something that contains messages and/or commands. There are two kinds
17152 @item message packets
17153 These are packets made at the server, and typically contain lots of
17154 messages for you to read. These are called @file{SoupoutX.tgz} by
17155 default, where @var{x} is a number.
17157 @item response packets
17158 These are packets made at the home machine, and typically contains
17159 replies that you've written. These are called @file{SoupinX.tgz} by
17160 default, where @var{x} is a number.
17170 You log in on the server and create a @sc{soup} packet. You can either
17171 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
17172 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
17173 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
17176 You transfer the packet home. Rail, boat, car or modem will do fine.
17179 You put the packet in your home directory.
17182 You fire up Gnus on your home machine using the @code{nnsoup} back end as
17183 the native or secondary server.
17186 You read articles and mail and answer and followup to the things you
17187 want (@pxref{SOUP Replies}).
17190 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
17194 You transfer this packet to the server.
17197 You use Gnus to mail this packet out with the @kbd{G s s} command.
17200 You then repeat until you die.
17204 So you basically have a bipartite system---you use @code{nnsoup} for
17205 reading and Gnus for packing/sending these @sc{soup} packets.
17208 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
17209 * SOUP Groups:: A back end for reading @sc{soup} packets.
17210 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
17214 @node SOUP Commands
17215 @subsubsection SOUP Commands
17217 These are commands for creating and manipulating @sc{soup} packets.
17221 @kindex G s b (Group)
17222 @findex gnus-group-brew-soup
17223 Pack all unread articles in the current group
17224 (@code{gnus-group-brew-soup}). This command understands the
17225 process/prefix convention.
17228 @kindex G s w (Group)
17229 @findex gnus-soup-save-areas
17230 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
17233 @kindex G s s (Group)
17234 @findex gnus-soup-send-replies
17235 Send all replies from the replies packet
17236 (@code{gnus-soup-send-replies}).
17239 @kindex G s p (Group)
17240 @findex gnus-soup-pack-packet
17241 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
17244 @kindex G s r (Group)
17245 @findex nnsoup-pack-replies
17246 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
17249 @kindex O s (Summary)
17250 @findex gnus-soup-add-article
17251 This summary-mode command adds the current article to a @sc{soup} packet
17252 (@code{gnus-soup-add-article}). It understands the process/prefix
17253 convention (@pxref{Process/Prefix}).
17258 There are a few variables to customize where Gnus will put all these
17263 @item gnus-soup-directory
17264 @vindex gnus-soup-directory
17265 Directory where Gnus will save intermediate files while composing
17266 @sc{soup} packets. The default is @file{~/SoupBrew/}.
17268 @item gnus-soup-replies-directory
17269 @vindex gnus-soup-replies-directory
17270 This is what Gnus will use as a temporary directory while sending our
17271 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
17273 @item gnus-soup-prefix-file
17274 @vindex gnus-soup-prefix-file
17275 Name of the file where Gnus stores the last used prefix. The default is
17276 @samp{gnus-prefix}.
17278 @item gnus-soup-packer
17279 @vindex gnus-soup-packer
17280 A format string command for packing a @sc{soup} packet. The default is
17281 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
17283 @item gnus-soup-unpacker
17284 @vindex gnus-soup-unpacker
17285 Format string command for unpacking a @sc{soup} packet. The default is
17286 @samp{gunzip -c %s | tar xvf -}.
17288 @item gnus-soup-packet-directory
17289 @vindex gnus-soup-packet-directory
17290 Where Gnus will look for reply packets. The default is @file{~/}.
17292 @item gnus-soup-packet-regexp
17293 @vindex gnus-soup-packet-regexp
17294 Regular expression matching @sc{soup} reply packets in
17295 @code{gnus-soup-packet-directory}.
17301 @subsubsection SOUP Groups
17304 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
17305 read incoming packets, unpack them, and put them in a directory where
17306 you can read them at leisure.
17308 These are the variables you can use to customize its behavior:
17312 @item nnsoup-tmp-directory
17313 @vindex nnsoup-tmp-directory
17314 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
17315 directory. (@file{/tmp/} by default.)
17317 @item nnsoup-directory
17318 @vindex nnsoup-directory
17319 @code{nnsoup} then moves each message and index file to this directory.
17320 The default is @file{~/SOUP/}.
17322 @item nnsoup-replies-directory
17323 @vindex nnsoup-replies-directory
17324 All replies will be stored in this directory before being packed into a
17325 reply packet. The default is @file{~/SOUP/replies/}.
17327 @item nnsoup-replies-format-type
17328 @vindex nnsoup-replies-format-type
17329 The @sc{soup} format of the replies packets. The default is @samp{?n}
17330 (rnews), and I don't think you should touch that variable. I probably
17331 shouldn't even have documented it. Drats! Too late!
17333 @item nnsoup-replies-index-type
17334 @vindex nnsoup-replies-index-type
17335 The index type of the replies packet. The default is @samp{?n}, which
17336 means ``none''. Don't fiddle with this one either!
17338 @item nnsoup-active-file
17339 @vindex nnsoup-active-file
17340 Where @code{nnsoup} stores lots of information. This is not an ``active
17341 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
17342 this file or mess it up in any way, you're dead. The default is
17343 @file{~/SOUP/active}.
17345 @item nnsoup-packer
17346 @vindex nnsoup-packer
17347 Format string command for packing a reply @sc{soup} packet. The default
17348 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
17350 @item nnsoup-unpacker
17351 @vindex nnsoup-unpacker
17352 Format string command for unpacking incoming @sc{soup} packets. The
17353 default is @samp{gunzip -c %s | tar xvf -}.
17355 @item nnsoup-packet-directory
17356 @vindex nnsoup-packet-directory
17357 Where @code{nnsoup} will look for incoming packets. The default is
17360 @item nnsoup-packet-regexp
17361 @vindex nnsoup-packet-regexp
17362 Regular expression matching incoming @sc{soup} packets. The default is
17365 @item nnsoup-always-save
17366 @vindex nnsoup-always-save
17367 If non-@code{nil}, save the replies buffer after each posted message.
17373 @subsubsection SOUP Replies
17375 Just using @code{nnsoup} won't mean that your postings and mailings end
17376 up in @sc{soup} reply packets automagically. You have to work a bit
17377 more for that to happen.
17379 @findex nnsoup-set-variables
17380 The @code{nnsoup-set-variables} command will set the appropriate
17381 variables to ensure that all your followups and replies end up in the
17384 In specific, this is what it does:
17387 (setq message-send-news-function 'nnsoup-request-post)
17388 (setq message-send-mail-function 'nnsoup-request-mail)
17391 And that's it, really. If you only want news to go into the @sc{soup}
17392 system you just use the first line. If you only want mail to be
17393 @sc{soup}ed you use the second.
17396 @node Mail-To-News Gateways
17397 @subsection Mail-To-News Gateways
17398 @cindex mail-to-news gateways
17401 If your local @code{nntp} server doesn't allow posting, for some reason
17402 or other, you can post using one of the numerous mail-to-news gateways.
17403 The @code{nngateway} back end provides the interface.
17405 Note that you can't read anything from this back end---it can only be
17411 @item nngateway-address
17412 @vindex nngateway-address
17413 This is the address of the mail-to-news gateway.
17415 @item nngateway-header-transformation
17416 @vindex nngateway-header-transformation
17417 News headers often have to be transformed in some odd way or other
17418 for the mail-to-news gateway to accept it. This variable says what
17419 transformation should be called, and defaults to
17420 @code{nngateway-simple-header-transformation}. The function is called
17421 narrowed to the headers to be transformed and with one parameter---the
17424 This default function just inserts a new @code{To} header based on the
17425 @code{Newsgroups} header and the gateway address.
17426 For instance, an article with this @code{Newsgroups} header:
17429 Newsgroups: alt.religion.emacs
17432 will get this @code{To} header inserted:
17435 To: alt-religion-emacs@@GATEWAY
17438 The following pre-defined functions exist:
17440 @findex nngateway-simple-header-transformation
17443 @item nngateway-simple-header-transformation
17444 Creates a @code{To} header that looks like
17445 @var{newsgroup}@@@code{nngateway-address}.
17447 @findex nngateway-mail2news-header-transformation
17449 @item nngateway-mail2news-header-transformation
17450 Creates a @code{To} header that looks like
17451 @code{nngateway-address}.
17459 (setq gnus-post-method
17461 "mail2news@@replay.com"
17462 (nngateway-header-transformation
17463 nngateway-mail2news-header-transformation)))
17466 So, to use this, simply say something like:
17469 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17474 @node Combined Groups
17475 @section Combined Groups
17477 Gnus allows combining a mixture of all the other group types into bigger
17481 * Virtual Groups:: Combining articles from many groups.
17482 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
17486 @node Virtual Groups
17487 @subsection Virtual Groups
17489 @cindex virtual groups
17490 @cindex merging groups
17492 An @dfn{nnvirtual group} is really nothing more than a collection of
17495 For instance, if you are tired of reading many small groups, you can
17496 put them all in one big group, and then grow tired of reading one
17497 big, unwieldy group. The joys of computing!
17499 You specify @code{nnvirtual} as the method. The address should be a
17500 regexp to match component groups.
17502 All marks in the virtual group will stick to the articles in the
17503 component groups. So if you tick an article in a virtual group, the
17504 article will also be ticked in the component group from whence it
17505 came. (And vice versa---marks from the component groups will also be
17506 shown in the virtual group.). To create an empty virtual group, run
17507 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17508 and edit the method regexp with @kbd{M-e}
17509 (@code{gnus-group-edit-group-method})
17511 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17512 newsgroups into one, big, happy newsgroup:
17515 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17518 The component groups can be native or foreign; everything should work
17519 smoothly, but if your computer explodes, it was probably my fault.
17521 Collecting the same group from several servers might actually be a good
17522 idea if users have set the Distribution header to limit distribution.
17523 If you would like to read @samp{soc.motss} both from a server in Japan
17524 and a server in Norway, you could use the following as the group regexp:
17527 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17530 (Remember, though, that if you're creating the group with @kbd{G m}, you
17531 shouldn't double the backslashes, and you should leave off the quote
17532 characters at the beginning and the end of the string.)
17534 This should work kinda smoothly---all articles from both groups should
17535 end up in this one, and there should be no duplicates. Threading (and
17536 the rest) will still work as usual, but there might be problems with the
17537 sequence of articles. Sorting on date might be an option here
17538 (@pxref{Selecting a Group}).
17540 One limitation, however---all groups included in a virtual
17541 group have to be alive (i.e., subscribed or unsubscribed). Killed or
17542 zombie groups can't be component groups for @code{nnvirtual} groups.
17544 @vindex nnvirtual-always-rescan
17545 If the @code{nnvirtual-always-rescan} is non-@code{nil},
17546 @code{nnvirtual} will always scan groups for unread articles when
17547 entering a virtual group. If this variable is @code{nil} (which is the
17548 default) and you read articles in a component group after the virtual
17549 group has been activated, the read articles from the component group
17550 will show up when you enter the virtual group. You'll also see this
17551 effect if you have two virtual groups that have a component group in
17552 common. If that's the case, you should set this variable to @code{t}.
17553 Or you can just tap @code{M-g} on the virtual group every time before
17554 you enter it---it'll have much the same effect.
17556 @code{nnvirtual} can have both mail and news groups as component groups.
17557 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17558 has to ask the back end of the component group the article comes from
17559 whether it is a news or mail back end. However, when you do a @kbd{^},
17560 there is typically no sure way for the component back end to know this,
17561 and in that case @code{nnvirtual} tells Gnus that the article came from a
17562 not-news back end. (Just to be on the safe side.)
17564 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17565 line from the article you respond to in these cases.
17567 @code{nnvirtual} groups do not inherit anything but articles and marks
17568 from component groups---group parameters, for instance, are not
17572 @node Kibozed Groups
17573 @subsection Kibozed Groups
17577 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
17578 (parts of) the news feed''. @code{nnkiboze} is a back end that will
17579 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
17580 down to a halt with useless requests! Oh happiness!
17582 @kindex G k (Group)
17583 To create a kibozed group, use the @kbd{G k} command in the group
17586 The address field of the @code{nnkiboze} method is, as with
17587 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
17588 @code{nnkiboze} group. That's where most similarities between
17589 @code{nnkiboze} and @code{nnvirtual} end.
17591 In addition to this regexp detailing component groups, an
17592 @code{nnkiboze} group must have a score file to say what articles are
17593 to be included in the group (@pxref{Scoring}).
17595 @kindex M-x nnkiboze-generate-groups
17596 @findex nnkiboze-generate-groups
17597 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
17598 @code{nnkiboze} groups you want to have. This command will take time.
17599 Lots of time. Oodles and oodles of time. Gnus has to fetch the
17600 headers from all the articles in all the component groups and run them
17601 through the scoring process to determine if there are any articles in
17602 the groups that are to be part of the @code{nnkiboze} groups.
17604 Please limit the number of component groups by using restrictive
17605 regexps. Otherwise your sysadmin may become annoyed with you, and the
17606 @acronym{NNTP} site may throw you off and never let you back in again.
17607 Stranger things have happened.
17609 @code{nnkiboze} component groups do not have to be alive---they can be dead,
17610 and they can be foreign. No restrictions.
17612 @vindex nnkiboze-directory
17613 The generation of an @code{nnkiboze} group means writing two files in
17614 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
17615 One contains the @acronym{NOV} header lines for all the articles in
17616 the group, and the other is an additional @file{.newsrc} file to store
17617 information on what groups have been searched through to find
17618 component articles.
17620 Articles marked as read in the @code{nnkiboze} group will have
17621 their @acronym{NOV} lines removed from the @acronym{NOV} file.
17624 @node Gnus Unplugged
17625 @section Gnus Unplugged
17630 @cindex Gnus unplugged
17632 In olden times (ca. February '88), people used to run their newsreaders
17633 on big machines with permanent connections to the net. News transport
17634 was dealt with by news servers, and all the newsreaders had to do was to
17635 read news. Believe it or not.
17637 Nowadays most people read news and mail at home, and use some sort of
17638 modem to connect to the net. To avoid running up huge phone bills, it
17639 would be nice to have a way to slurp down all the news and mail, hang up
17640 the phone, read for several hours, and then upload any responses you
17641 have to make. And then you repeat the procedure.
17643 Of course, you can use news servers for doing this as well. I've used
17644 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
17645 for some years, but doing that's a bore. Moving the news server
17646 functionality up to the newsreader makes sense if you're the only person
17647 reading news on a machine.
17649 Setting up Gnus as an ``offline'' newsreader is quite simple. In
17650 fact, you don't have to configure anything as the agent is now enabled
17651 by default (@pxref{Agent Variables, gnus-agent}).
17653 Of course, to use it as such, you have to learn a few new commands.
17656 * Agent Basics:: How it all is supposed to work.
17657 * Agent Categories:: How to tell the Gnus Agent what to download.
17658 * Agent Commands:: New commands for all the buffers.
17659 * Agent Visuals:: Ways that the agent may effect your summary buffer.
17660 * Agent as Cache:: The Agent is a big cache too.
17661 * Agent Expiry:: How to make old articles go away.
17662 * Agent Regeneration:: How to recover from lost connections and other accidents.
17663 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
17664 * Outgoing Messages:: What happens when you post/mail something?
17665 * Agent Variables:: Customizing is fun.
17666 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
17667 * Batching Agents:: How to fetch news from a @code{cron} job.
17668 * Agent Caveats:: What you think it'll do and what it does.
17673 @subsection Agent Basics
17675 First, let's get some terminology out of the way.
17677 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
17678 connection to the net (and notified the Agent that this is the case).
17679 When the connection to the net is up again (and Gnus knows this), the
17680 Agent is @dfn{plugged}.
17682 The @dfn{local} machine is the one you're running on, and which isn't
17683 connected to the net continuously.
17685 @dfn{Downloading} means fetching things from the net to your local
17686 machine. @dfn{Uploading} is doing the opposite.
17688 You know that Gnus gives you all the opportunity you'd ever want for
17689 shooting yourself in the foot. Some people call it flexibility. Gnus
17690 is also customizable to a great extent, which means that the user has a
17691 say on how Gnus behaves. Other newsreaders might unconditionally shoot
17692 you in your foot, but with Gnus, you have a choice!
17694 Gnus is never really in plugged or unplugged state. Rather, it applies
17695 that state to each server individually. This means that some servers
17696 can be plugged while others can be unplugged. Additionally, some
17697 servers can be ignored by the Agent altogether (which means that
17698 they're kinda like plugged always).
17700 So when you unplug the Agent and then wonder why is Gnus opening a
17701 connection to the Net, the next step to do is to look whether all
17702 servers are agentized. If there is an unagentized server, you found
17705 Another thing is the @dfn{offline} state. Sometimes, servers aren't
17706 reachable. When Gnus notices this, it asks you whether you want the
17707 server to be switched to offline state. If you say yes, then the
17708 server will behave somewhat as if it was unplugged, except that Gnus
17709 will ask you whether you want to switch it back online again.
17711 Let's take a typical Gnus session using the Agent.
17716 @findex gnus-unplugged
17717 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
17718 Agent in a disconnected state. You can read all the news that you have
17719 already fetched while in this mode.
17722 You then decide to see whether any new news has arrived. You connect
17723 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
17724 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
17725 as usual. To check for new mail in unplugged mode (@pxref{Mail
17726 Source Specifiers}).
17729 You can then read the new news immediately, or you can download the
17730 news onto your local machine. If you want to do the latter, you press
17731 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
17732 all the eligible articles in all the groups. (To let Gnus know which
17733 articles you want to download, @pxref{Agent Categories}).
17736 After fetching the articles, you press @kbd{J j} to make Gnus become
17737 unplugged again, and you shut down the PPP thing (or whatever). And
17738 then you read the news offline.
17741 And then you go to step 2.
17744 Here are some things you should do the first time (or so) that you use
17750 Decide which servers should be covered by the Agent. If you have a mail
17751 back end, it would probably be nonsensical to have it covered by the
17752 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
17753 @kbd{J a} on the server (or servers) that you wish to have covered by the
17754 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
17755 added servers you do not wish to have covered by the Agent. By default,
17756 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
17757 @code{gnus-secondary-select-methods} are agentized.
17760 Decide on download policy. It's fairly simple once you decide whether
17761 you are going to use agent categories, topic parameters, and/or group
17762 parameters to implement your policy. If you're new to gnus, it
17763 is probably best to start with a category, @xref{Agent Categories}.
17765 Both topic parameters (@pxref{Topic Parameters}) and agent categories
17766 (@pxref{Agent Categories}) provide for setting a policy that applies
17767 to multiple groups. Which you use is entirely up to you. Topic
17768 parameters do override categories so, if you mix the two, you'll have
17769 to take that into account. If you have a few groups that deviate from
17770 your policy, you can use group parameters (@pxref{Group Parameters}) to
17774 Uhm@dots{} that's it.
17778 @node Agent Categories
17779 @subsection Agent Categories
17781 One of the main reasons to integrate the news transport layer into the
17782 newsreader is to allow greater control over what articles to download.
17783 There's not much point in downloading huge amounts of articles, just to
17784 find out that you're not interested in reading any of them. It's better
17785 to be somewhat more conservative in choosing what to download, and then
17786 mark the articles for downloading manually if it should turn out that
17787 you're interested in the articles anyway.
17789 One of the more effective methods for controlling what is to be
17790 downloaded is to create a @dfn{category} and then assign some (or all)
17791 groups to this category. Groups that do not belong in any other
17792 category belong to the @code{default} category. Gnus has its own
17793 buffer for creating and managing categories.
17795 If you prefer, you can also use group parameters (@pxref{Group
17796 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
17797 alternative approach to controlling the agent. The only real
17798 difference is that categories are specific to the agent (so there is
17799 less to learn) while group and topic parameters include the kitchen
17802 Since you can set agent parameters in several different places we have
17803 a rule to decide which source to believe. This rule specifies that
17804 the parameter sources are checked in the following order: group
17805 parameters, topic parameters, agent category, and finally customizable
17806 variables. So you can mix all of these sources to produce a wide range
17807 of behavior, just don't blame me if you don't remember where you put
17811 * Category Syntax:: What a category looks like.
17812 * Category Buffer:: A buffer for maintaining categories.
17813 * Category Variables:: Customize'r'Us.
17817 @node Category Syntax
17818 @subsubsection Category Syntax
17820 A category consists of a name, the list of groups belonging to the
17821 category, and a number of optional parameters that override the
17822 customizable variables. The complete list of agent parameters are
17825 @cindex Agent Parameters
17827 @item agent-cat-name
17828 The name of the category.
17831 The list of groups that are in this category.
17833 @item agent-predicate
17834 A predicate which (generally) gives a rough outline of which articles
17835 are eligible for downloading; and
17837 @item agent-score-file
17838 a score rule which (generally) gives you a finer granularity when
17839 deciding what articles to download. (Note that this @dfn{download
17840 score} is not necessarily related to normal scores.)
17842 @item agent-enable-expiration
17843 a boolean indicating whether the agent should expire old articles in
17844 this group. Most groups should be expired to conserve disk space. In
17845 fact, its probably safe to say that the gnus.* hierarchy contains the
17846 only groups that should not be expired.
17848 @item agent-days-until-old
17849 an integer indicating the number of days that the agent should wait
17850 before deciding that a read article is safe to expire.
17852 @item agent-low-score
17853 an integer that overrides the value of @code{gnus-agent-low-score}.
17855 @item agent-high-score
17856 an integer that overrides the value of @code{gnus-agent-high-score}.
17858 @item agent-length-when-short
17859 an integer that overrides the value of
17860 @code{gnus-agent-short-article}.
17862 @item agent-length-when-long
17863 an integer that overrides the value of @code{gnus-agent-long-article}.
17865 @item agent-enable-undownloaded-faces
17866 a symbol indicating whether the summary buffer should display
17867 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
17868 faces. Any symbol other than @code{nil} will enable the use of
17869 undownloaded faces.
17872 The name of a category can not be changed once the category has been
17875 Each category maintains a list of groups that are exclusive members of
17876 that category. The exclusivity rule is automatically enforced, add a
17877 group to a new category and it is automatically removed from its old
17880 A predicate in its simplest form can be a single predicate such as
17881 @code{true} or @code{false}. These two will download every available
17882 article or nothing respectively. In the case of these two special
17883 predicates an additional score rule is superfluous.
17885 Predicates of @code{high} or @code{low} download articles in respect of
17886 their scores in relationship to @code{gnus-agent-high-score} and
17887 @code{gnus-agent-low-score} as described below.
17889 To gain even finer control of what is to be regarded eligible for
17890 download a predicate can consist of a number of predicates with logical
17891 operators sprinkled in between.
17893 Perhaps some examples are in order.
17895 Here's a simple predicate. (It's the default predicate, in fact, used
17896 for all groups that don't belong to any other category.)
17902 Quite simple, eh? This predicate is true if and only if the article is
17903 short (for some value of ``short'').
17905 Here's a more complex predicate:
17914 This means that an article should be downloaded if it has a high score,
17915 or if the score is not low and the article is not long. You get the
17918 The available logical operators are @code{or}, @code{and} and
17919 @code{not}. (If you prefer, you can use the more ``C''-ish operators
17920 @samp{|}, @code{&} and @code{!} instead.)
17922 The following predicates are pre-defined, but if none of these fit what
17923 you want to do, you can write your own.
17925 When evaluating each of these predicates, the named constant will be
17926 bound to the value determined by calling
17927 @code{gnus-agent-find-parameter} on the appropriate parameter. For
17928 example, gnus-agent-short-article will be bound to
17929 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
17930 means that you can specify a predicate in your category then tune that
17931 predicate to individual groups.
17935 True iff the article is shorter than @code{gnus-agent-short-article}
17936 lines; default 100.
17939 True iff the article is longer than @code{gnus-agent-long-article}
17940 lines; default 200.
17943 True iff the article has a download score less than
17944 @code{gnus-agent-low-score}; default 0.
17947 True iff the article has a download score greater than
17948 @code{gnus-agent-high-score}; default 0.
17951 True iff the Gnus Agent guesses that the article is spam. The
17952 heuristics may change over time, but at present it just computes a
17953 checksum and sees whether articles match.
17962 If you want to create your own predicate function, here's what you have
17963 to know: The functions are called with no parameters, but the
17964 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
17967 For example, you could decide that you don't want to download articles
17968 that were posted more than a certain number of days ago (e.g. posted
17969 more than @code{gnus-agent-expire-days} ago) you might write a function
17970 something along the lines of the following:
17973 (defun my-article-old-p ()
17974 "Say whether an article is old."
17975 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
17976 (- (time-to-days (current-time)) gnus-agent-expire-days)))
17979 with the predicate then defined as:
17982 (not my-article-old-p)
17985 or you could append your predicate to the predefined
17986 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
17990 (require 'gnus-agent)
17991 (setq gnus-category-predicate-alist
17992 (append gnus-category-predicate-alist
17993 '((old . my-article-old-p))))
17996 and simply specify your predicate as:
18002 If/when using something like the above, be aware that there are many
18003 misconfigured systems/mailers out there and so an article's date is not
18004 always a reliable indication of when it was posted. Hell, some people
18005 just don't give a damn.
18007 The above predicates apply to @emph{all} the groups which belong to the
18008 category. However, if you wish to have a specific predicate for an
18009 individual group within a category, or you're just too lazy to set up a
18010 new category, you can enter a group's individual predicate in its group
18011 parameters like so:
18014 (agent-predicate . short)
18017 This is the group/topic parameter equivalent of the agent category default.
18018 Note that when specifying a single word predicate like this, the
18019 @code{agent-predicate} specification must be in dotted pair notation.
18021 The equivalent of the longer example from above would be:
18024 (agent-predicate or high (and (not low) (not long)))
18027 The outer parenthesis required in the category specification are not
18028 entered here as, not being in dotted pair notation, the value of the
18029 predicate is assumed to be a list.
18032 Now, the syntax of the download score is the same as the syntax of
18033 normal score files, except that all elements that require actually
18034 seeing the article itself are verboten. This means that only the
18035 following headers can be scored on: @code{Subject}, @code{From},
18036 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
18037 @code{Lines}, and @code{Xref}.
18039 As with predicates, the specification of the @code{download score rule}
18040 to use in respect of a group can be in either the category definition if
18041 it's to be applicable to all groups in therein, or a group's parameters
18042 if it's to be specific to that group.
18044 In both of these places the @code{download score rule} can take one of
18051 This has the same syntax as a normal Gnus score file except only a
18052 subset of scoring keywords are available as mentioned above.
18058 Category specification
18062 ("Lars Ingebrigtsen" 1000000 nil s))
18068 Group/Topic Parameter specification
18071 (agent-score ("from"
18072 ("Lars Ingebrigtsen" 1000000 nil s))
18077 Again, note the omission of the outermost parenthesis here.
18083 These score files must @emph{only} contain the permitted scoring
18084 keywords stated above.
18090 Category specification
18093 ("~/News/agent.SCORE")
18099 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
18103 Group Parameter specification
18106 (agent-score "~/News/agent.SCORE")
18109 Additional score files can be specified as above. Need I say anything
18114 Use @code{normal} score files
18116 If you don't want to maintain two sets of scoring rules for a group, and
18117 your desired @code{downloading} criteria for a group are the same as your
18118 @code{reading} criteria then you can tell the agent to refer to your
18119 @code{normal} score files when deciding what to download.
18121 These directives in either the category definition or a group's
18122 parameters will cause the agent to read in all the applicable score
18123 files for a group, @emph{filtering out} those sections that do not
18124 relate to one of the permitted subset of scoring keywords.
18128 Category Specification
18135 Group Parameter specification
18138 (agent-score . file)
18143 @node Category Buffer
18144 @subsubsection Category Buffer
18146 You'd normally do all category maintenance from the category buffer.
18147 When you enter it for the first time (with the @kbd{J c} command from
18148 the group buffer), you'll only see the @code{default} category.
18150 The following commands are available in this buffer:
18154 @kindex q (Category)
18155 @findex gnus-category-exit
18156 Return to the group buffer (@code{gnus-category-exit}).
18159 @kindex e (Category)
18160 @findex gnus-category-customize-category
18161 Use a customization buffer to set all of the selected category's
18162 parameters at one time (@code{gnus-category-customize-category}).
18165 @kindex k (Category)
18166 @findex gnus-category-kill
18167 Kill the current category (@code{gnus-category-kill}).
18170 @kindex c (Category)
18171 @findex gnus-category-copy
18172 Copy the current category (@code{gnus-category-copy}).
18175 @kindex a (Category)
18176 @findex gnus-category-add
18177 Add a new category (@code{gnus-category-add}).
18180 @kindex p (Category)
18181 @findex gnus-category-edit-predicate
18182 Edit the predicate of the current category
18183 (@code{gnus-category-edit-predicate}).
18186 @kindex g (Category)
18187 @findex gnus-category-edit-groups
18188 Edit the list of groups belonging to the current category
18189 (@code{gnus-category-edit-groups}).
18192 @kindex s (Category)
18193 @findex gnus-category-edit-score
18194 Edit the download score rule of the current category
18195 (@code{gnus-category-edit-score}).
18198 @kindex l (Category)
18199 @findex gnus-category-list
18200 List all the categories (@code{gnus-category-list}).
18204 @node Category Variables
18205 @subsubsection Category Variables
18208 @item gnus-category-mode-hook
18209 @vindex gnus-category-mode-hook
18210 Hook run in category buffers.
18212 @item gnus-category-line-format
18213 @vindex gnus-category-line-format
18214 Format of the lines in the category buffer (@pxref{Formatting
18215 Variables}). Valid elements are:
18219 The name of the category.
18222 The number of groups in the category.
18225 @item gnus-category-mode-line-format
18226 @vindex gnus-category-mode-line-format
18227 Format of the category mode line (@pxref{Mode Line Formatting}).
18229 @item gnus-agent-short-article
18230 @vindex gnus-agent-short-article
18231 Articles that have fewer lines than this are short. Default 100.
18233 @item gnus-agent-long-article
18234 @vindex gnus-agent-long-article
18235 Articles that have more lines than this are long. Default 200.
18237 @item gnus-agent-low-score
18238 @vindex gnus-agent-low-score
18239 Articles that have a score lower than this have a low score. Default
18242 @item gnus-agent-high-score
18243 @vindex gnus-agent-high-score
18244 Articles that have a score higher than this have a high score. Default
18247 @item gnus-agent-expire-days
18248 @vindex gnus-agent-expire-days
18249 The number of days that a @samp{read} article must stay in the agent's
18250 local disk before becoming eligible for expiration (While the name is
18251 the same, this doesn't mean expiring the article on the server. It
18252 just means deleting the local copy of the article). What is also
18253 important to understand is that the counter starts with the time the
18254 article was written to the local disk and not the time the article was
18258 @item gnus-agent-enable-expiration
18259 @vindex gnus-agent-enable-expiration
18260 Determines whether articles in a group are, by default, expired or
18261 retained indefinitely. The default is @code{ENABLE} which means that
18262 you'll have to disable expiration when desired. On the other hand,
18263 you could set this to @code{DISABLE}. In that case, you would then
18264 have to enable expiration in selected groups.
18269 @node Agent Commands
18270 @subsection Agent Commands
18271 @findex gnus-agent-toggle-plugged
18272 @kindex J j (Agent)
18274 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
18275 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18276 toggles the plugged/unplugged state of the Gnus Agent.
18280 * Group Agent Commands:: Configure groups and fetch their contents.
18281 * Summary Agent Commands:: Manually select then fetch specific articles.
18282 * Server Agent Commands:: Select the servers that are supported by the agent.
18288 @node Group Agent Commands
18289 @subsubsection Group Agent Commands
18293 @kindex J u (Agent Group)
18294 @findex gnus-agent-fetch-groups
18295 Fetch all eligible articles in the current group
18296 (@code{gnus-agent-fetch-groups}).
18299 @kindex J c (Agent Group)
18300 @findex gnus-enter-category-buffer
18301 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18304 @kindex J s (Agent Group)
18305 @findex gnus-agent-fetch-session
18306 Fetch all eligible articles in all groups
18307 (@code{gnus-agent-fetch-session}).
18310 @kindex J S (Agent Group)
18311 @findex gnus-group-send-queue
18312 Send all sendable messages in the queue group
18313 (@code{gnus-group-send-queue}). @xref{Drafts}.
18316 @kindex J a (Agent Group)
18317 @findex gnus-agent-add-group
18318 Add the current group to an Agent category
18319 (@code{gnus-agent-add-group}). This command understands the
18320 process/prefix convention (@pxref{Process/Prefix}).
18323 @kindex J r (Agent Group)
18324 @findex gnus-agent-remove-group
18325 Remove the current group from its category, if any
18326 (@code{gnus-agent-remove-group}). This command understands the
18327 process/prefix convention (@pxref{Process/Prefix}).
18330 @kindex J Y (Agent Group)
18331 @findex gnus-agent-synchronize-flags
18332 Synchronize flags changed while unplugged with remote server, if any.
18338 @node Summary Agent Commands
18339 @subsubsection Summary Agent Commands
18343 @kindex J # (Agent Summary)
18344 @findex gnus-agent-mark-article
18345 Mark the article for downloading (@code{gnus-agent-mark-article}).
18348 @kindex J M-# (Agent Summary)
18349 @findex gnus-agent-unmark-article
18350 Remove the downloading mark from the article
18351 (@code{gnus-agent-unmark-article}).
18355 @kindex @@ (Agent Summary)
18356 @findex gnus-agent-toggle-mark
18357 Toggle whether to download the article
18358 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
18362 @kindex J c (Agent Summary)
18363 @findex gnus-agent-catchup
18364 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18367 @kindex J S (Agent Summary)
18368 @findex gnus-agent-fetch-group
18369 Download all eligible (@pxref{Agent Categories}) articles in this group.
18370 (@code{gnus-agent-fetch-group}).
18373 @kindex J s (Agent Summary)
18374 @findex gnus-agent-fetch-series
18375 Download all processable articles in this group.
18376 (@code{gnus-agent-fetch-series}).
18379 @kindex J u (Agent Summary)
18380 @findex gnus-agent-summary-fetch-group
18381 Download all downloadable articles in the current group
18382 (@code{gnus-agent-summary-fetch-group}).
18387 @node Server Agent Commands
18388 @subsubsection Server Agent Commands
18392 @kindex J a (Agent Server)
18393 @findex gnus-agent-add-server
18394 Add the current server to the list of servers covered by the Gnus Agent
18395 (@code{gnus-agent-add-server}).
18398 @kindex J r (Agent Server)
18399 @findex gnus-agent-remove-server
18400 Remove the current server from the list of servers covered by the Gnus
18401 Agent (@code{gnus-agent-remove-server}).
18406 @node Agent Visuals
18407 @subsection Agent Visuals
18409 If you open a summary while unplugged and, Gnus knows from the group's
18410 active range that there are more articles than the headers currently
18411 stored in the Agent, you may see some articles whose subject looks
18412 something like @samp{[Undownloaded article #####]}. These are
18413 placeholders for the missing headers. Aside from setting a mark,
18414 there is not much that can be done with one of these placeholders.
18415 When Gnus finally gets a chance to fetch the group's headers, the
18416 placeholders will automatically be replaced by the actual headers.
18417 You can configure the summary buffer's maneuvering to skip over the
18418 placeholders if you care (See @code{gnus-auto-goto-ignores}).
18420 While it may be obvious to all, the only headers and articles
18421 available while unplugged are those headers and articles that were
18422 fetched into the Agent while previously plugged. To put it another
18423 way, ``If you forget to fetch something while plugged, you might have a
18424 less than satisfying unplugged session''. For this reason, the Agent
18425 adds two visual effects to your summary buffer. These effects display
18426 the download status of each article so that you always know which
18427 articles will be available when unplugged.
18429 The first visual effect is the @samp{%O} spec. If you customize
18430 @code{gnus-summary-line-format} to include this specifier, you will add
18431 a single character field that indicates an article's download status.
18432 Articles that have been fetched into either the Agent or the Cache,
18433 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
18434 other articles will display @code{gnus-undownloaded-mark} (defaults to
18435 @samp{-}). If you open a group that has not been agentized, a space
18436 (@samp{ }) will be displayed.
18438 The second visual effect are the undownloaded faces. The faces, there
18439 are three indicating the article's score (low, normal, high), seem to
18440 result in a love/hate response from many Gnus users. The problem is
18441 that the face selection is controlled by a list of condition tests and
18442 face names (See @code{gnus-summary-highlight}). Each condition is
18443 tested in the order in which it appears in the list so early
18444 conditions have precedence over later conditions. All of this means
18445 that, if you tick an undownloaded article, the article will continue
18446 to be displayed in the undownloaded face rather than the ticked face.
18448 If you use the Agent as a cache (to avoid downloading the same article
18449 each time you visit it or to minimize your connection time), the
18450 undownloaded face will probably seem like a good idea. The reason
18451 being that you do all of our work (marking, reading, deleting) with
18452 downloaded articles so the normal faces always appear. For those
18453 users using the agent to improve online performance by caching the NOV
18454 database (most users since 5.10.2), the undownloaded faces may appear
18455 to be an absolutely horrible idea. The issue being that, since none
18456 of their articles have been fetched into the Agent, all of the
18457 normal faces will be obscured by the undownloaded faces.
18459 If you would like to use the undownloaded faces, you must enable the
18460 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
18461 group parameter to t. This parameter, like all other agent
18462 parameters, may be set on an Agent Category (@pxref{Agent
18463 Categories}), a Group Topic (@pxref{Topic Parameters}), or an
18464 individual group (@pxref{Group Parameters}).
18466 The one problem common to all users using the agent is how quickly it
18467 can consume disk space. If you using the agent on many groups, it is
18468 even more difficult to effectively recover disk space. One solution
18469 is the @samp{%F} format available in @code{gnus-group-line-format}.
18470 This format will display the actual disk space used by articles
18471 fetched into both the agent and cache. By knowing which groups use
18472 the most space, users know where to focus their efforts when ``agent
18473 expiring'' articles.
18475 @node Agent as Cache
18476 @subsection Agent as Cache
18478 When Gnus is plugged, it is not efficient to download headers or
18479 articles from the server again, if they are already stored in the
18480 Agent. So, Gnus normally only downloads headers once, and stores them
18481 in the Agent. These headers are later used when generating the summary
18482 buffer, regardless of whether you are plugged or unplugged. Articles
18483 are not cached in the Agent by default though (that would potentially
18484 consume lots of disk space), but if you have already downloaded an
18485 article into the Agent, Gnus will not download the article from the
18486 server again but use the locally stored copy instead.
18488 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
18489 @pxref{Agent Variables}) to always download headers and articles while
18490 plugged. Gnus will almost certainly be slower, but it will be kept
18491 synchronized with the server. That last point probably won't make any
18492 sense if you are using a nntp or nnimap back end.
18495 @subsection Agent Expiry
18497 @vindex gnus-agent-expire-days
18498 @findex gnus-agent-expire
18499 @kindex M-x gnus-agent-expire
18500 @kindex M-x gnus-agent-expire-group
18501 @findex gnus-agent-expire-group
18502 @cindex agent expiry
18503 @cindex Gnus agent expiry
18506 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
18507 least it doesn't handle it like other back ends. Instead, there are
18508 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
18509 commands that will expire all read articles that are older than
18510 @code{gnus-agent-expire-days} days. They can be run whenever you feel
18511 that you're running out of space. Neither are particularly fast or
18512 efficient, and it's not a particularly good idea to interrupt them (with
18513 @kbd{C-g} or anything else) once you've started one of them.
18515 Note that other functions, e.g. @code{gnus-request-expire-articles},
18516 might run @code{gnus-agent-expire} for you to keep the agent
18517 synchronized with the group.
18519 The agent parameter @code{agent-enable-expiration} may be used to
18520 prevent expiration in selected groups.
18522 @vindex gnus-agent-expire-all
18523 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
18524 expiration commands will expire all articles---unread, read, ticked
18525 and dormant. If @code{nil} (which is the default), only read articles
18526 are eligible for expiry, and unread, ticked and dormant articles will
18527 be kept indefinitely.
18529 If you find that some articles eligible for expiry are never expired,
18530 perhaps some Gnus Agent files are corrupted. There's are special
18531 commands, @code{gnus-agent-regenerate} and
18532 @code{gnus-agent-regenerate-group}, to fix possible problems.
18534 @node Agent Regeneration
18535 @subsection Agent Regeneration
18537 @cindex agent regeneration
18538 @cindex Gnus agent regeneration
18539 @cindex regeneration
18541 The local data structures used by @code{nnagent} may become corrupted
18542 due to certain exceptional conditions. When this happens,
18543 @code{nnagent} functionality may degrade or even fail. The solution
18544 to this problem is to repair the local data structures by removing all
18545 internal inconsistencies.
18547 For example, if your connection to your server is lost while
18548 downloaded articles into the agent, the local data structures will not
18549 know about articles successfully downloaded prior to the connection
18550 failure. Running @code{gnus-agent-regenerate} or
18551 @code{gnus-agent-regenerate-group} will update the data structures
18552 such that you don't need to download these articles a second time.
18554 @findex gnus-agent-regenerate
18555 @kindex M-x gnus-agent-regenerate
18556 The command @code{gnus-agent-regenerate} will perform
18557 @code{gnus-agent-regenerate-group} on every agentized group. While
18558 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
18559 recommended that you first close all summary buffers.
18561 @findex gnus-agent-regenerate-group
18562 @kindex M-x gnus-agent-regenerate-group
18563 The command @code{gnus-agent-regenerate-group} uses the local copies
18564 of individual articles to repair the local @acronym{NOV}(header) database. It
18565 then updates the internal data structures that document which articles
18566 are stored locally. An optional argument will mark articles in the
18569 @node Agent and IMAP
18570 @subsection Agent and IMAP
18572 The Agent works with any Gnus back end, including nnimap. However,
18573 since there are some conceptual differences between @acronym{NNTP} and
18574 @acronym{IMAP}, this section (should) provide you with some information to
18575 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
18577 The first thing to keep in mind is that all flags (read, ticked, etc)
18578 are kept on the @acronym{IMAP} server, rather than in @file{.newsrc} as is the
18579 case for nntp. Thus Gnus need to remember flag changes when
18580 disconnected, and synchronize these flags when you plug back in.
18582 Gnus keeps track of flag changes when reading nnimap groups under the
18583 Agent. When you plug back in, Gnus will check if you have any changed
18584 any flags and ask if you wish to synchronize these with the server.
18585 The behavior is customizable by @code{gnus-agent-synchronize-flags}.
18587 @vindex gnus-agent-synchronize-flags
18588 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
18589 never automatically synchronize flags. If it is @code{ask}, which is
18590 the default, the Agent will check if you made any changes and if so
18591 ask if you wish to synchronize these when you re-connect. If it has
18592 any other value, all flags will be synchronized automatically.
18594 If you do not wish to synchronize flags automatically when you
18595 re-connect, you can do it manually with the
18596 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
18597 in the group buffer.
18599 Some things are currently not implemented in the Agent that you'd might
18600 expect from a disconnected @acronym{IMAP} client, including:
18605 Copying/moving articles into nnimap groups when unplugged.
18608 Creating/deleting nnimap groups when unplugged.
18612 Technical note: the synchronization algorithm does not work by ``pushing''
18613 all local flags to the server, but rather incrementally update the
18614 server view of flags by changing only those flags that were changed by
18615 the user. Thus, if you set one flag on an article, quit the group and
18616 re-select the group and remove the flag; the flag will be set and
18617 removed from the server when you ``synchronize''. The queued flag
18618 operations can be found in the per-server @code{flags} file in the Agent
18619 directory. It's emptied when you synchronize flags.
18622 @node Outgoing Messages
18623 @subsection Outgoing Messages
18625 By default, when Gnus is unplugged, all outgoing messages (both mail
18626 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
18627 You can view them there after posting, and edit them at will.
18629 You can control the circumstances under which outgoing mail is queued
18630 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
18631 news is always queued when Gnus is unplugged, and never otherwise.
18633 You can send the messages either from the draft group with the special
18634 commands available there, or you can use the @kbd{J S} command in the
18635 group buffer to send all the sendable messages in the draft group.
18636 Posting news will only work when Gnus is plugged, but you can send
18639 If sending mail while unplugged does not work for you and you worry
18640 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
18641 ask you to confirm your action (see
18642 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
18644 @node Agent Variables
18645 @subsection Agent Variables
18650 Is the agent enabled? The default is @code{t}. When first enabled,
18651 the agent will use @code{gnus-agent-auto-agentize-methods} to
18652 automatically mark some back ends as agentized. You may change which
18653 back ends are agentized using the agent commands in the server buffer.
18655 To enter the server buffer, use the @kbd{^}
18656 (@code{gnus-group-enter-server-mode}) command in the group buffer.
18659 @item gnus-agent-directory
18660 @vindex gnus-agent-directory
18661 Where the Gnus Agent will store its files. The default is
18662 @file{~/News/agent/}.
18664 @item gnus-agent-handle-level
18665 @vindex gnus-agent-handle-level
18666 Groups on levels (@pxref{Group Levels}) higher than this variable will
18667 be ignored by the Agent. The default is @code{gnus-level-subscribed},
18668 which means that only subscribed group will be considered by the Agent
18671 @item gnus-agent-plugged-hook
18672 @vindex gnus-agent-plugged-hook
18673 Hook run when connecting to the network.
18675 @item gnus-agent-unplugged-hook
18676 @vindex gnus-agent-unplugged-hook
18677 Hook run when disconnecting from the network.
18679 @item gnus-agent-fetched-hook
18680 @vindex gnus-agent-fetched-hook
18681 Hook run when finished fetching articles.
18683 @item gnus-agent-cache
18684 @vindex gnus-agent-cache
18685 Variable to control whether use the locally stored @acronym{NOV} and
18686 articles when plugged, e.g. essentially using the Agent as a cache.
18687 The default is non-@code{nil}, which means to use the Agent as a cache.
18689 @item gnus-agent-go-online
18690 @vindex gnus-agent-go-online
18691 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
18692 automatically switch offline servers into online status. If it is
18693 @code{ask}, the default, the Agent will ask if you wish to switch
18694 offline servers into online status when you re-connect. If it has any
18695 other value, all offline servers will be automatically switched into
18698 @item gnus-agent-mark-unread-after-downloaded
18699 @vindex gnus-agent-mark-unread-after-downloaded
18700 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
18701 mark articles as unread after downloading. This is usually a safe
18702 thing to do as the newly downloaded article has obviously not been
18703 read. The default is t.
18705 @item gnus-agent-consider-all-articles
18706 @vindex gnus-agent-consider-all-articles
18707 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
18708 agent will let the agent predicate decide whether articles need to be
18709 downloaded or not, for all articles. When @code{nil}, the default,
18710 the agent will only let the predicate decide whether unread articles
18711 are downloaded or not. If you enable this, you may also want to look
18712 into the agent expiry settings (@pxref{Category Variables}), so that
18713 the agent doesn't download articles which the agent will later expire,
18714 over and over again.
18716 @item gnus-agent-max-fetch-size
18717 @vindex gnus-agent-max-fetch-size
18718 The agent fetches articles into a temporary buffer prior to parsing
18719 them into individual files. To avoid exceeding the max. buffer size,
18720 the agent alternates between fetching and parsing until all articles
18721 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
18722 limit to control how often the cycling occurs. A large value improves
18723 performance. A small value minimizes the time lost should the
18724 connection be lost while fetching (You may need to run
18725 @code{gnus-agent-regenerate-group} to update the group's state.
18726 However, all articles parsed prior to loosing the connection will be
18727 available while unplugged). The default is 10M so it is unusual to
18730 @item gnus-server-unopen-status
18731 @vindex gnus-server-unopen-status
18732 Perhaps not an Agent variable, but closely related to the Agent, this
18733 variable says what will happen if Gnus cannot open a server. If the
18734 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
18735 whether to deny the server or whether to unplug the agent. If the
18736 Agent is disabled, Gnus always simply deny the server. Other choices
18737 for this variable include @code{denied} and @code{offline} the latter
18738 is only valid if the Agent is used.
18740 @item gnus-auto-goto-ignores
18741 @vindex gnus-auto-goto-ignores
18742 Another variable that isn't an Agent variable, yet so closely related
18743 that most will look for it here, this variable tells the summary
18744 buffer how to maneuver around undownloaded (only headers stored in the
18745 agent) and unfetched (neither article nor headers stored) articles.
18747 The legal values are @code{nil} (maneuver to any article),
18748 @code{undownloaded} (maneuvering while unplugged ignores articles that
18749 have not been fetched), @code{always-undownloaded} (maneuvering always
18750 ignores articles that have not been fetched), @code{unfetched}
18751 (maneuvering ignores articles whose headers have not been fetched).
18753 @item gnus-agent-queue-mail
18754 @vindex gnus-agent-queue-mail
18755 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
18756 queue mail rather than sending it straight away. When @code{t}, Gnus
18757 will queue mail when unplugged only. When @code{nil}, never queue
18758 mail. The default is @code{t}.
18760 @item gnus-agent-prompt-send-queue
18761 @vindex gnus-agent-prompt-send-queue
18762 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
18763 prompt you to confirm that you really wish to proceed if you hit
18764 @kbd{J S} while unplugged. The default is @code{nil}.
18766 @item gnus-agent-auto-agentize-methods
18767 @vindex gnus-agent-auto-agentize-methods
18768 If you have never used the Agent before (or more technically, if
18769 @file{~/News/agent/lib/servers} does not exist), Gnus will
18770 automatically agentize a few servers for you. This variable control
18771 which back ends should be auto-agentized. It is typically only useful
18772 to agentize remote back ends. The auto-agentizing has the same effect
18773 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
18774 If the file exist, you must manage the servers manually by adding or
18775 removing them, this variable is only applicable the first time you
18776 start Gnus. The default is @samp{(nntp nnimap)}.
18781 @node Example Setup
18782 @subsection Example Setup
18784 If you don't want to read this manual, and you have a fairly standard
18785 setup, you may be able to use something like the following as your
18786 @file{~/.gnus.el} file to get started.
18789 ;;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
18790 ;;; @r{from your ISP's server.}
18791 (setq gnus-select-method '(nntp "news.your-isp.com"))
18793 ;;; @r{Define how Gnus is to read your mail. We read mail from}
18794 ;;; @r{your ISP's @acronym{POP} server.}
18795 (setq mail-sources '((pop :server "pop.your-isp.com")))
18797 ;;; @r{Say how Gnus is to store the mail. We use nnml groups.}
18798 (setq gnus-secondary-select-methods '((nnml "")))
18800 ;;; @r{Make Gnus into an offline newsreader.}
18801 ;;; (gnus-agentize) ; @r{The obsolete setting.}
18802 ;;; (setq gnus-agent t) ; @r{Now the default.}
18805 That should be it, basically. Put that in your @file{~/.gnus.el} file,
18806 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
18809 If this is the first time you've run Gnus, you will be subscribed
18810 automatically to a few default newsgroups. You'll probably want to
18811 subscribe to more groups, and to do that, you have to query the
18812 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
18813 command. This usually takes quite a while, but you only have to do it
18816 After reading and parsing a while, you'll be presented with a list of
18817 groups. Subscribe to the ones you want to read with the @kbd{u}
18818 command. @kbd{l} to make all the killed groups disappear after you've
18819 subscribe to all the groups you want to read. (@kbd{A k} will bring
18820 back all the killed groups.)
18822 You can now read the groups at once, or you can download the articles
18823 with the @kbd{J s} command. And then read the rest of this manual to
18824 find out which of the other gazillion things you want to customize.
18827 @node Batching Agents
18828 @subsection Batching Agents
18829 @findex gnus-agent-batch
18831 Having the Gnus Agent fetch articles (and post whatever messages you've
18832 written) is quite easy once you've gotten things set up properly. The
18833 following shell script will do everything that is necessary:
18835 You can run a complete batch command from the command line with the
18836 following incantation:
18840 emacs -batch -l ~/.emacs -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1
18844 @node Agent Caveats
18845 @subsection Agent Caveats
18847 The Gnus Agent doesn't seem to work like most other offline
18848 newsreaders. Here are some common questions that some imaginary people
18852 @item If I read an article while plugged, do they get entered into the Agent?
18854 @strong{No}. If you want this behaviour, add
18855 @code{gnus-agent-fetch-selected-article} to
18856 @code{gnus-select-article-hook}.
18858 @item If I read an article while plugged, and the article already exists in
18859 the Agent, will it get downloaded once more?
18861 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
18865 In short, when Gnus is unplugged, it only looks into the locally stored
18866 articles; when it's plugged, it talks to your ISP and may also use the
18867 locally stored articles.
18874 Other people use @dfn{kill files}, but we here at Gnus Towers like
18875 scoring better than killing, so we'd rather switch than fight. They do
18876 something completely different as well, so sit up straight and pay
18879 @vindex gnus-summary-mark-below
18880 All articles have a default score (@code{gnus-summary-default-score}),
18881 which is 0 by default. This score may be raised or lowered either
18882 interactively or by score files. Articles that have a score lower than
18883 @code{gnus-summary-mark-below} are marked as read.
18885 Gnus will read any @dfn{score files} that apply to the current group
18886 before generating the summary buffer.
18888 There are several commands in the summary buffer that insert score
18889 entries based on the current article. You can, for instance, ask Gnus to
18890 lower or increase the score of all articles with a certain subject.
18892 There are two sorts of scoring entries: Permanent and temporary.
18893 Temporary score entries are self-expiring entries. Any entries that are
18894 temporary and have not been used for, say, a week, will be removed
18895 silently to help keep the sizes of the score files down.
18898 * Summary Score Commands:: Adding score entries for the current group.
18899 * Group Score Commands:: General score commands.
18900 * Score Variables:: Customize your scoring. (My, what terminology).
18901 * Score File Format:: What a score file may contain.
18902 * Score File Editing:: You can edit score files by hand as well.
18903 * Adaptive Scoring:: Big Sister Gnus knows what you read.
18904 * Home Score File:: How to say where new score entries are to go.
18905 * Followups To Yourself:: Having Gnus notice when people answer you.
18906 * Scoring On Other Headers:: Scoring on non-standard headers.
18907 * Scoring Tips:: How to score effectively.
18908 * Reverse Scoring:: That problem child of old is not problem.
18909 * Global Score Files:: Earth-spanning, ear-splitting score files.
18910 * Kill Files:: They are still here, but they can be ignored.
18911 * Converting Kill Files:: Translating kill files to score files.
18912 * Advanced Scoring:: Using logical expressions to build score rules.
18913 * Score Decays:: It can be useful to let scores wither away.
18917 @node Summary Score Commands
18918 @section Summary Score Commands
18919 @cindex score commands
18921 The score commands that alter score entries do not actually modify real
18922 score files. That would be too inefficient. Gnus maintains a cache of
18923 previously loaded score files, one of which is considered the
18924 @dfn{current score file alist}. The score commands simply insert
18925 entries into this list, and upon group exit, this list is saved.
18927 The current score file is by default the group's local score file, even
18928 if no such score file actually exists. To insert score commands into
18929 some other score file (e.g. @file{all.SCORE}), you must first make this
18930 score file the current one.
18932 General score commands that don't actually change the score file:
18937 @kindex V s (Summary)
18938 @findex gnus-summary-set-score
18939 Set the score of the current article (@code{gnus-summary-set-score}).
18942 @kindex V S (Summary)
18943 @findex gnus-summary-current-score
18944 Display the score of the current article
18945 (@code{gnus-summary-current-score}).
18948 @kindex V t (Summary)
18949 @findex gnus-score-find-trace
18950 Display all score rules that have been used on the current article
18951 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
18952 may type @kbd{e} to edit score file corresponding to the score rule on
18953 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
18954 score file and edit it.
18957 @kindex V w (Summary)
18958 @findex gnus-score-find-favourite-words
18959 List words used in scoring (@code{gnus-score-find-favourite-words}).
18962 @kindex V R (Summary)
18963 @findex gnus-summary-rescore
18964 Run the current summary through the scoring process
18965 (@code{gnus-summary-rescore}). This might be useful if you're playing
18966 around with your score files behind Gnus' back and want to see the
18967 effect you're having.
18970 @kindex V c (Summary)
18971 @findex gnus-score-change-score-file
18972 Make a different score file the current
18973 (@code{gnus-score-change-score-file}).
18976 @kindex V e (Summary)
18977 @findex gnus-score-edit-current-scores
18978 Edit the current score file (@code{gnus-score-edit-current-scores}).
18979 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
18983 @kindex V f (Summary)
18984 @findex gnus-score-edit-file
18985 Edit a score file and make this score file the current one
18986 (@code{gnus-score-edit-file}).
18989 @kindex V F (Summary)
18990 @findex gnus-score-flush-cache
18991 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
18992 after editing score files.
18995 @kindex V C (Summary)
18996 @findex gnus-score-customize
18997 Customize a score file in a visually pleasing manner
18998 (@code{gnus-score-customize}).
19002 The rest of these commands modify the local score file.
19007 @kindex V m (Summary)
19008 @findex gnus-score-set-mark-below
19009 Prompt for a score, and mark all articles with a score below this as
19010 read (@code{gnus-score-set-mark-below}).
19013 @kindex V x (Summary)
19014 @findex gnus-score-set-expunge-below
19015 Prompt for a score, and add a score rule to the current score file to
19016 expunge all articles below this score
19017 (@code{gnus-score-set-expunge-below}).
19020 The keystrokes for actually making score entries follow a very regular
19021 pattern, so there's no need to list all the commands. (Hundreds of
19024 @findex gnus-summary-increase-score
19025 @findex gnus-summary-lower-score
19029 The first key is either @kbd{I} (upper case i) for increasing the score
19030 or @kbd{L} for lowering the score.
19032 The second key says what header you want to score on. The following
19033 keys are available:
19037 Score on the author name.
19040 Score on the subject line.
19043 Score on the @code{Xref} line---i.e., the cross-posting line.
19046 Score on the @code{References} line.
19052 Score on the number of lines.
19055 Score on the @code{Message-ID} header.
19058 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
19059 if your @acronym{NNTP} server tracks additional header data in overviews.
19062 Score on followups---this matches the author name, and adds scores to
19063 the followups to this author. (Using this key leads to the creation of
19064 @file{ADAPT} files.)
19073 Score on thread. (Using this key leads to the creation of @file{ADAPT}
19079 The third key is the match type. Which match types are valid depends on
19080 what headers you are scoring on.
19092 Substring matching.
19095 Fuzzy matching (@pxref{Fuzzy Matching}).
19124 Greater than number.
19129 The fourth and usually final key says whether this is a temporary (i.e.,
19130 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
19131 or whether it is to be done immediately, without adding to the score
19136 Temporary score entry.
19139 Permanent score entry.
19142 Immediately scoring.
19146 If you are scoring on `e' (extra) headers, you will then be prompted for
19147 the header name on which you wish to score. This must be a header named
19148 in gnus-extra-headers, and @samp{TAB} completion is available.
19152 So, let's say you want to increase the score on the current author with
19153 exact matching permanently: @kbd{I a e p}. If you want to lower the
19154 score based on the subject line, using substring matching, and make a
19155 temporary score entry: @kbd{L s s t}. Pretty easy.
19157 To make things a bit more complicated, there are shortcuts. If you use
19158 a capital letter on either the second or third keys, Gnus will use
19159 defaults for the remaining one or two keystrokes. The defaults are
19160 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
19161 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
19163 These functions take both the numerical prefix and the symbolic prefix
19164 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
19165 (or increase) the score of the article. A symbolic prefix of @code{a}
19166 says to use the @file{all.SCORE} file for the command instead of the
19167 current score file.
19169 @vindex gnus-score-mimic-keymap
19170 The @code{gnus-score-mimic-keymap} says whether these commands will
19171 pretend they are keymaps or not.
19174 @node Group Score Commands
19175 @section Group Score Commands
19176 @cindex group score commands
19178 There aren't many of these as yet, I'm afraid.
19183 @kindex W e (Group)
19184 @findex gnus-score-edit-all-score
19185 Edit the apply-to-all-groups all.SCORE file. You will be popped into
19186 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
19189 @kindex W f (Group)
19190 @findex gnus-score-flush-cache
19191 Gnus maintains a cache of score alists to avoid having to reload them
19192 all the time. This command will flush the cache
19193 (@code{gnus-score-flush-cache}).
19197 You can do scoring from the command line by saying something like:
19199 @findex gnus-batch-score
19200 @cindex batch scoring
19202 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
19206 @node Score Variables
19207 @section Score Variables
19208 @cindex score variables
19212 @item gnus-use-scoring
19213 @vindex gnus-use-scoring
19214 If @code{nil}, Gnus will not check for score files, and will not, in
19215 general, do any score-related work. This is @code{t} by default.
19217 @item gnus-kill-killed
19218 @vindex gnus-kill-killed
19219 If this variable is @code{nil}, Gnus will never apply score files to
19220 articles that have already been through the kill process. While this
19221 may save you lots of time, it also means that if you apply a kill file
19222 to a group, and then change the kill file and want to run it over you
19223 group again to kill more articles, it won't work. You have to set this
19224 variable to @code{t} to do that. (It is @code{t} by default.)
19226 @item gnus-kill-files-directory
19227 @vindex gnus-kill-files-directory
19228 All kill and score files will be stored in this directory, which is
19229 initialized from the @env{SAVEDIR} environment variable by default.
19230 This is @file{~/News/} by default.
19232 @item gnus-score-file-suffix
19233 @vindex gnus-score-file-suffix
19234 Suffix to add to the group name to arrive at the score file name
19235 (@file{SCORE} by default.)
19237 @item gnus-score-uncacheable-files
19238 @vindex gnus-score-uncacheable-files
19239 @cindex score cache
19240 All score files are normally cached to avoid excessive re-loading of
19241 score files. However, if this might make your Emacs grow big and
19242 bloated, so this regexp can be used to weed out score files unlikely
19243 to be needed again. It would be a bad idea to deny caching of
19244 @file{all.SCORE}, while it might be a good idea to not cache
19245 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
19246 variable is @samp{ADAPT$} by default, so no adaptive score files will
19249 @item gnus-save-score
19250 @vindex gnus-save-score
19251 If you have really complicated score files, and do lots of batch
19252 scoring, then you might set this variable to @code{t}. This will make
19253 Gnus save the scores into the @file{.newsrc.eld} file.
19255 If you do not set this to @code{t}, then manual scores (like those set
19256 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
19257 across group visits.
19259 @item gnus-score-interactive-default-score
19260 @vindex gnus-score-interactive-default-score
19261 Score used by all the interactive raise/lower commands to raise/lower
19262 score with. Default is 1000, which may seem excessive, but this is to
19263 ensure that the adaptive scoring scheme gets enough room to play with.
19264 We don't want the small changes from the adaptive scoring to overwrite
19265 manually entered data.
19267 @item gnus-summary-default-score
19268 @vindex gnus-summary-default-score
19269 Default score of an article, which is 0 by default.
19271 @item gnus-summary-expunge-below
19272 @vindex gnus-summary-expunge-below
19273 Don't display the summary lines of articles that have scores lower than
19274 this variable. This is @code{nil} by default, which means that no
19275 articles will be hidden. This variable is local to the summary buffers,
19276 and has to be set from @code{gnus-summary-mode-hook}.
19278 @item gnus-score-over-mark
19279 @vindex gnus-score-over-mark
19280 Mark (in the third column) used for articles with a score over the
19281 default. Default is @samp{+}.
19283 @item gnus-score-below-mark
19284 @vindex gnus-score-below-mark
19285 Mark (in the third column) used for articles with a score below the
19286 default. Default is @samp{-}.
19288 @item gnus-score-find-score-files-function
19289 @vindex gnus-score-find-score-files-function
19290 Function used to find score files for the current group. This function
19291 is called with the name of the group as the argument.
19293 Predefined functions available are:
19296 @item gnus-score-find-single
19297 @findex gnus-score-find-single
19298 Only apply the group's own score file.
19300 @item gnus-score-find-bnews
19301 @findex gnus-score-find-bnews
19302 Apply all score files that match, using bnews syntax. This is the
19303 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
19304 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
19305 @file{gnu.all.SCORE} would all apply. In short, the instances of
19306 @samp{all} in the score file names are translated into @samp{.*}, and
19307 then a regexp match is done.
19309 This means that if you have some score entries that you want to apply to
19310 all groups, then you put those entries in the @file{all.SCORE} file.
19312 The score files are applied in a semi-random order, although Gnus will
19313 try to apply the more general score files before the more specific score
19314 files. It does this by looking at the number of elements in the score
19315 file names---discarding the @samp{all} elements.
19317 @item gnus-score-find-hierarchical
19318 @findex gnus-score-find-hierarchical
19319 Apply all score files from all the parent groups. This means that you
19320 can't have score files like @file{all.SCORE}, but you can have
19321 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19325 This variable can also be a list of functions. In that case, all
19326 these functions will be called with the group name as argument, and
19327 all the returned lists of score files will be applied. These
19328 functions can also return lists of lists of score alists directly. In
19329 that case, the functions that return these non-file score alists
19330 should probably be placed before the ``real'' score file functions, to
19331 ensure that the last score file returned is the local score file.
19334 For example, to do hierarchical scoring but use a non-server-specific
19335 overall score file, you could use the value
19337 (list (lambda (group) ("all.SCORE"))
19338 'gnus-score-find-hierarchical)
19341 @item gnus-score-expiry-days
19342 @vindex gnus-score-expiry-days
19343 This variable says how many days should pass before an unused score file
19344 entry is expired. If this variable is @code{nil}, no score file entries
19345 are expired. It's 7 by default.
19347 @item gnus-update-score-entry-dates
19348 @vindex gnus-update-score-entry-dates
19349 If this variable is non-@code{nil}, temporary score entries that have
19350 been triggered (matched) will have their dates updated. (This is how Gnus
19351 controls expiry---all non-matched-entries will become too old while
19352 matched entries will stay fresh and young.) However, if you set this
19353 variable to @code{nil}, even matched entries will grow old and will
19354 have to face that oh-so grim reaper.
19356 @item gnus-score-after-write-file-function
19357 @vindex gnus-score-after-write-file-function
19358 Function called with the name of the score file just written.
19360 @item gnus-score-thread-simplify
19361 @vindex gnus-score-thread-simplify
19362 If this variable is non-@code{nil}, article subjects will be
19363 simplified for subject scoring purposes in the same manner as with
19364 threading---according to the current value of
19365 @code{gnus-simplify-subject-functions}. If the scoring entry uses
19366 @code{substring} or @code{exact} matching, the match will also be
19367 simplified in this manner.
19372 @node Score File Format
19373 @section Score File Format
19374 @cindex score file format
19376 A score file is an @code{emacs-lisp} file that normally contains just a
19377 single form. Casual users are not expected to edit these files;
19378 everything can be changed from the summary buffer.
19380 Anyway, if you'd like to dig into it yourself, here's an example:
19384 ("Lars Ingebrigtsen" -10000)
19386 ("larsi\\|lmi" -50000 nil R))
19388 ("Ding is Badd" nil 728373))
19390 ("alt.politics" -1000 728372 s))
19395 (mark-and-expunge -10)
19399 (files "/hom/larsi/News/gnu.SCORE")
19400 (exclude-files "all.SCORE")
19401 (local (gnus-newsgroup-auto-expire t)
19402 (gnus-summary-make-false-root empty))
19406 This example demonstrates most score file elements. @xref{Advanced
19407 Scoring}, for a different approach.
19409 Even though this looks much like Lisp code, nothing here is actually
19410 @code{eval}ed. The Lisp reader is used to read this form, though, so it
19411 has to be valid syntactically, if not semantically.
19413 Six keys are supported by this alist:
19418 If the key is a string, it is the name of the header to perform the
19419 match on. Scoring can only be performed on these eight headers:
19420 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
19421 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
19422 these headers, there are three strings to tell Gnus to fetch the entire
19423 article and do the match on larger parts of the article: @code{Body}
19424 will perform the match on the body of the article, @code{Head} will
19425 perform the match on the head of the article, and @code{All} will
19426 perform the match on the entire article. Note that using any of these
19427 last three keys will slow down group entry @emph{considerably}. The
19428 final ``header'' you can score on is @code{Followup}. These score
19429 entries will result in new score entries being added for all follow-ups
19430 to articles that matches these score entries.
19432 Following this key is an arbitrary number of score entries, where each
19433 score entry has one to four elements.
19437 The first element is the @dfn{match element}. On most headers this will
19438 be a string, but on the Lines and Chars headers, this must be an
19442 If the second element is present, it should be a number---the @dfn{score
19443 element}. This number should be an integer in the neginf to posinf
19444 interval. This number is added to the score of the article if the match
19445 is successful. If this element is not present, the
19446 @code{gnus-score-interactive-default-score} number will be used
19447 instead. This is 1000 by default.
19450 If the third element is present, it should be a number---the @dfn{date
19451 element}. This date says when the last time this score entry matched,
19452 which provides a mechanism for expiring the score entries. It this
19453 element is not present, the score entry is permanent. The date is
19454 represented by the number of days since December 31, 1 BCE.
19457 If the fourth element is present, it should be a symbol---the @dfn{type
19458 element}. This element specifies what function should be used to see
19459 whether this score entry matches the article. What match types that can
19460 be used depends on what header you wish to perform the match on.
19463 @item From, Subject, References, Xref, Message-ID
19464 For most header types, there are the @code{r} and @code{R} (regexp), as
19465 well as @code{s} and @code{S} (substring) types, and @code{e} and
19466 @code{E} (exact match), and @code{w} (word match) types. If this
19467 element is not present, Gnus will assume that substring matching should
19468 be used. @code{R}, @code{S}, and @code{E} differ from the others in
19469 that the matches will be done in a case-sensitive manner. All these
19470 one-letter types are really just abbreviations for the @code{regexp},
19471 @code{string}, @code{exact}, and @code{word} types, which you can use
19472 instead, if you feel like.
19475 Just as for the standard string overview headers, if you are using
19476 gnus-extra-headers, you can score on these headers' values. In this
19477 case, there is a 5th element in the score entry, being the name of the
19478 header to be scored. The following entry is useful in your
19479 @file{all.SCORE} file in case of spam attacks from a single origin
19480 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
19484 ("111.222.333.444" -1000 nil s
19485 "NNTP-Posting-Host")
19489 These two headers use different match types: @code{<}, @code{>},
19490 @code{=}, @code{>=} and @code{<=}.
19492 These predicates are true if
19495 (PREDICATE HEADER MATCH)
19498 evaluates to non-@code{nil}. For instance, the advanced match
19499 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
19506 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
19507 the match, we get the score added if the article has less than 4 lines.
19508 (It's easy to get confused and think it's the other way around. But
19509 it's not. I think.)
19511 When matching on @code{Lines}, be careful because some back ends (like
19512 @code{nndir}) do not generate @code{Lines} header, so every article ends
19513 up being marked as having 0 lines. This can lead to strange results if
19514 you happen to lower score of the articles with few lines.
19517 For the Date header we have three kinda silly match types:
19518 @code{before}, @code{at} and @code{after}. I can't really imagine this
19519 ever being useful, but, like, it would feel kinda silly not to provide
19520 this function. Just in case. You never know. Better safe than sorry.
19521 Once burnt, twice shy. Don't judge a book by its cover. Never not have
19522 sex on a first date. (I have been told that at least one person, and I
19523 quote, ``found this function indispensable'', however.)
19527 A more useful match type is @code{regexp}. With it, you can match the
19528 date string using a regular expression. The date is normalized to
19529 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
19530 you want to match all articles that have been posted on April 1st in
19531 every year, you could use @samp{....0401.........} as a match string,
19532 for instance. (Note that the date is kept in its original time zone, so
19533 this will match articles that were posted when it was April 1st where
19534 the article was posted from. Time zones are such wholesome fun for the
19537 @item Head, Body, All
19538 These three match keys use the same match types as the @code{From} (etc)
19542 This match key is somewhat special, in that it will match the
19543 @code{From} header, and affect the score of not only the matching
19544 articles, but also all followups to the matching articles. This allows
19545 you e.g. increase the score of followups to your own articles, or
19546 decrease the score of followups to the articles of some known
19547 trouble-maker. Uses the same match types as the @code{From} header
19548 uses. (Using this match key will lead to creation of @file{ADAPT}
19552 This match key works along the same lines as the @code{Followup} match
19553 key. If you say that you want to score on a (sub-)thread started by an
19554 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
19555 match. This will add a new @samp{thread} match for each article that
19556 has @var{x} in its @code{References} header. (These new @samp{thread}
19557 matches will use the @code{Message-ID}s of these matching articles.)
19558 This will ensure that you can raise/lower the score of an entire thread,
19559 even though some articles in the thread may not have complete
19560 @code{References} headers. Note that using this may lead to
19561 undeterministic scores of the articles in the thread. (Using this match
19562 key will lead to creation of @file{ADAPT} files.)
19566 @cindex score file atoms
19568 The value of this entry should be a number. Any articles with a score
19569 lower than this number will be marked as read.
19572 The value of this entry should be a number. Any articles with a score
19573 lower than this number will be removed from the summary buffer.
19575 @item mark-and-expunge
19576 The value of this entry should be a number. Any articles with a score
19577 lower than this number will be marked as read and removed from the
19580 @item thread-mark-and-expunge
19581 The value of this entry should be a number. All articles that belong to
19582 a thread that has a total score below this number will be marked as read
19583 and removed from the summary buffer. @code{gnus-thread-score-function}
19584 says how to compute the total score for a thread.
19587 The value of this entry should be any number of file names. These files
19588 are assumed to be score files as well, and will be loaded the same way
19591 @item exclude-files
19592 The clue of this entry should be any number of files. These files will
19593 not be loaded, even though they would normally be so, for some reason or
19597 The value of this entry will be @code{eval}el. This element will be
19598 ignored when handling global score files.
19601 Read-only score files will not be updated or saved. Global score files
19602 should feature this atom (@pxref{Global Score Files}). (Note:
19603 @dfn{Global} here really means @dfn{global}; not your personal
19604 apply-to-all-groups score files.)
19607 The value of this entry should be a number. Articles that do not have
19608 parents will get this number added to their scores. Imagine you follow
19609 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
19610 will only follow a few of the threads, also want to see any new threads.
19612 You can do this with the following two score file entries:
19616 (mark-and-expunge -100)
19619 When you enter the group the first time, you will only see the new
19620 threads. You then raise the score of the threads that you find
19621 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
19622 rest. Next time you enter the group, you will see new articles in the
19623 interesting threads, plus any new threads.
19625 I.e.---the orphan score atom is for high-volume groups where a few
19626 interesting threads which can't be found automatically by ordinary
19627 scoring rules exist.
19630 This entry controls the adaptive scoring. If it is @code{t}, the
19631 default adaptive scoring rules will be used. If it is @code{ignore}, no
19632 adaptive scoring will be performed on this group. If it is a list, this
19633 list will be used as the adaptive scoring rules. If it isn't present,
19634 or is something other than @code{t} or @code{ignore}, the default
19635 adaptive scoring rules will be used. If you want to use adaptive
19636 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
19637 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
19638 not want adaptive scoring. If you only want adaptive scoring in a few
19639 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
19640 insert @code{(adapt t)} in the score files of the groups where you want
19644 All adaptive score entries will go to the file named by this entry. It
19645 will also be applied when entering the group. This atom might be handy
19646 if you want to adapt on several groups at once, using the same adaptive
19647 file for a number of groups.
19650 @cindex local variables
19651 The value of this entry should be a list of @code{(@var{var}
19652 @var{value})} pairs. Each @var{var} will be made buffer-local to the
19653 current summary buffer, and set to the value specified. This is a
19654 convenient, if somewhat strange, way of setting variables in some
19655 groups if you don't like hooks much. Note that the @var{value} won't
19660 @node Score File Editing
19661 @section Score File Editing
19663 You normally enter all scoring commands from the summary buffer, but you
19664 might feel the urge to edit them by hand as well, so we've supplied you
19665 with a mode for that.
19667 It's simply a slightly customized @code{emacs-lisp} mode, with these
19668 additional commands:
19673 @kindex C-c C-c (Score)
19674 @findex gnus-score-edit-done
19675 Save the changes you have made and return to the summary buffer
19676 (@code{gnus-score-edit-done}).
19679 @kindex C-c C-d (Score)
19680 @findex gnus-score-edit-insert-date
19681 Insert the current date in numerical format
19682 (@code{gnus-score-edit-insert-date}). This is really the day number, if
19683 you were wondering.
19686 @kindex C-c C-p (Score)
19687 @findex gnus-score-pretty-print
19688 The adaptive score files are saved in an unformatted fashion. If you
19689 intend to read one of these files, you want to @dfn{pretty print} it
19690 first. This command (@code{gnus-score-pretty-print}) does that for
19695 Type @kbd{M-x gnus-score-mode} to use this mode.
19697 @vindex gnus-score-mode-hook
19698 @code{gnus-score-menu-hook} is run in score mode buffers.
19700 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
19701 @kbd{V t} to begin editing score files.
19704 @node Adaptive Scoring
19705 @section Adaptive Scoring
19706 @cindex adaptive scoring
19708 If all this scoring is getting you down, Gnus has a way of making it all
19709 happen automatically---as if by magic. Or rather, as if by artificial
19710 stupidity, to be precise.
19712 @vindex gnus-use-adaptive-scoring
19713 When you read an article, or mark an article as read, or kill an
19714 article, you leave marks behind. On exit from the group, Gnus can sniff
19715 these marks and add score elements depending on what marks it finds.
19716 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
19717 @code{t} or @code{(line)}. If you want score adaptively on separate
19718 words appearing in the subjects, you should set this variable to
19719 @code{(word)}. If you want to use both adaptive methods, set this
19720 variable to @code{(word line)}.
19722 @vindex gnus-default-adaptive-score-alist
19723 To give you complete control over the scoring process, you can customize
19724 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
19725 might look something like this:
19728 (setq gnus-default-adaptive-score-alist
19729 '((gnus-unread-mark)
19730 (gnus-ticked-mark (from 4))
19731 (gnus-dormant-mark (from 5))
19732 (gnus-del-mark (from -4) (subject -1))
19733 (gnus-read-mark (from 4) (subject 2))
19734 (gnus-expirable-mark (from -1) (subject -1))
19735 (gnus-killed-mark (from -1) (subject -3))
19736 (gnus-kill-file-mark)
19737 (gnus-ancient-mark)
19738 (gnus-low-score-mark)
19739 (gnus-catchup-mark (from -1) (subject -1))))
19742 As you see, each element in this alist has a mark as a key (either a
19743 variable name or a ``real'' mark---a character). Following this key is
19744 a arbitrary number of header/score pairs. If there are no header/score
19745 pairs following the key, no adaptive scoring will be done on articles
19746 that have that key as the article mark. For instance, articles with
19747 @code{gnus-unread-mark} in the example above will not get adaptive score
19750 Each article can have only one mark, so just a single of these rules
19751 will be applied to each article.
19753 To take @code{gnus-del-mark} as an example---this alist says that all
19754 articles that have that mark (i.e., are marked with @samp{e}) will have a
19755 score entry added to lower based on the @code{From} header by -4, and
19756 lowered by @code{Subject} by -1. Change this to fit your prejudices.
19758 If you have marked 10 articles with the same subject with
19759 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
19760 That means that that subject will get a score of ten times -1, which
19761 should be, unless I'm much mistaken, -10.
19763 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
19764 the read articles will be marked with the @samp{E} mark. This'll
19765 probably make adaptive scoring slightly impossible, so auto-expiring and
19766 adaptive scoring doesn't really mix very well.
19768 The headers you can score on are @code{from}, @code{subject},
19769 @code{message-id}, @code{references}, @code{xref}, @code{lines},
19770 @code{chars} and @code{date}. In addition, you can score on
19771 @code{followup}, which will create an adaptive score entry that matches
19772 on the @code{References} header using the @code{Message-ID} of the
19773 current article, thereby matching the following thread.
19775 If you use this scheme, you should set the score file atom @code{mark}
19776 to something small---like -300, perhaps, to avoid having small random
19777 changes result in articles getting marked as read.
19779 After using adaptive scoring for a week or so, Gnus should start to
19780 become properly trained and enhance the authors you like best, and kill
19781 the authors you like least, without you having to say so explicitly.
19783 You can control what groups the adaptive scoring is to be performed on
19784 by using the score files (@pxref{Score File Format}). This will also
19785 let you use different rules in different groups.
19787 @vindex gnus-adaptive-file-suffix
19788 The adaptive score entries will be put into a file where the name is the
19789 group name with @code{gnus-adaptive-file-suffix} appended. The default
19792 @vindex gnus-adaptive-pretty-print
19793 Adaptive score files can get huge and are not meant to be edited by
19794 human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the
19795 deafult) those files will not be written in a human readable way.
19797 @vindex gnus-score-exact-adapt-limit
19798 When doing adaptive scoring, substring or fuzzy matching would probably
19799 give you the best results in most cases. However, if the header one
19800 matches is short, the possibility for false positives is great, so if
19801 the length of the match is less than
19802 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
19803 this variable is @code{nil}, exact matching will always be used to avoid
19806 @vindex gnus-default-adaptive-word-score-alist
19807 As mentioned above, you can adapt either on individual words or entire
19808 headers. If you adapt on words, the
19809 @code{gnus-default-adaptive-word-score-alist} variable says what score
19810 each instance of a word should add given a mark.
19813 (setq gnus-default-adaptive-word-score-alist
19814 `((,gnus-read-mark . 30)
19815 (,gnus-catchup-mark . -10)
19816 (,gnus-killed-mark . -20)
19817 (,gnus-del-mark . -15)))
19820 This is the default value. If you have adaption on words enabled, every
19821 word that appears in subjects of articles marked with
19822 @code{gnus-read-mark} will result in a score rule that increase the
19823 score with 30 points.
19825 @vindex gnus-default-ignored-adaptive-words
19826 @vindex gnus-ignored-adaptive-words
19827 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
19828 will be ignored. If you wish to add more words to be ignored, use the
19829 @code{gnus-ignored-adaptive-words} list instead.
19831 @vindex gnus-adaptive-word-length-limit
19832 Some may feel that short words shouldn't count when doing adaptive
19833 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
19834 an integer. Words shorter than this number will be ignored. This
19835 variable defaults to @code{nil}.
19837 @vindex gnus-adaptive-word-syntax-table
19838 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
19839 syntax table in effect. It is similar to the standard syntax table, but
19840 it considers numbers to be non-word-constituent characters.
19842 @vindex gnus-adaptive-word-minimum
19843 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
19844 word scoring process will never bring down the score of an article to
19845 below this number. The default is @code{nil}.
19847 @vindex gnus-adaptive-word-no-group-words
19848 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
19849 won't adaptively word score any of the words in the group name. Useful
19850 for groups like @samp{comp.editors.emacs}, where most of the subject
19851 lines contain the word @samp{emacs}.
19853 After using this scheme for a while, it might be nice to write a
19854 @code{gnus-psychoanalyze-user} command to go through the rules and see
19855 what words you like and what words you don't like. Or perhaps not.
19857 Note that the adaptive word scoring thing is highly experimental and is
19858 likely to change in the future. Initial impressions seem to indicate
19859 that it's totally useless as it stands. Some more work (involving more
19860 rigorous statistical methods) will have to be done to make this useful.
19863 @node Home Score File
19864 @section Home Score File
19866 The score file where new score file entries will go is called the
19867 @dfn{home score file}. This is normally (and by default) the score file
19868 for the group itself. For instance, the home score file for
19869 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
19871 However, this may not be what you want. It is often convenient to share
19872 a common home score file among many groups---all @samp{emacs} groups
19873 could perhaps use the same home score file.
19875 @vindex gnus-home-score-file
19876 The variable that controls this is @code{gnus-home-score-file}. It can
19881 A string. Then this file will be used as the home score file for all
19885 A function. The result of this function will be used as the home score
19886 file. The function will be called with the name of the group as the
19890 A list. The elements in this list can be:
19894 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
19895 group name, the @var{file-name} will be used as the home score file.
19898 A function. If the function returns non-@code{nil}, the result will
19899 be used as the home score file.
19902 A string. Use the string as the home score file.
19905 The list will be traversed from the beginning towards the end looking
19910 So, if you want to use just a single score file, you could say:
19913 (setq gnus-home-score-file
19914 "my-total-score-file.SCORE")
19917 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
19918 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
19920 @findex gnus-hierarchial-home-score-file
19922 (setq gnus-home-score-file
19923 'gnus-hierarchial-home-score-file)
19926 This is a ready-made function provided for your convenience.
19927 Other functions include
19930 @item gnus-current-home-score-file
19931 @findex gnus-current-home-score-file
19932 Return the ``current'' regular score file. This will make scoring
19933 commands add entry to the ``innermost'' matching score file.
19937 If you want to have one score file for the @samp{emacs} groups and
19938 another for the @samp{comp} groups, while letting all other groups use
19939 their own home score files:
19942 (setq gnus-home-score-file
19943 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
19944 '(("\\.emacs" "emacs.SCORE")
19945 ;; @r{All the comp groups in one score file}
19946 ("^comp" "comp.SCORE")))
19949 @vindex gnus-home-adapt-file
19950 @code{gnus-home-adapt-file} works exactly the same way as
19951 @code{gnus-home-score-file}, but says what the home adaptive score file
19952 is instead. All new adaptive file entries will go into the file
19953 specified by this variable, and the same syntax is allowed.
19955 In addition to using @code{gnus-home-score-file} and
19956 @code{gnus-home-adapt-file}, you can also use group parameters
19957 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
19958 Parameters}) to achieve much the same. Group and topic parameters take
19959 precedence over this variable.
19962 @node Followups To Yourself
19963 @section Followups To Yourself
19965 Gnus offers two commands for picking out the @code{Message-ID} header in
19966 the current buffer. Gnus will then add a score rule that scores using
19967 this @code{Message-ID} on the @code{References} header of other
19968 articles. This will, in effect, increase the score of all articles that
19969 respond to the article in the current buffer. Quite useful if you want
19970 to easily note when people answer what you've said.
19974 @item gnus-score-followup-article
19975 @findex gnus-score-followup-article
19976 This will add a score to articles that directly follow up your own
19979 @item gnus-score-followup-thread
19980 @findex gnus-score-followup-thread
19981 This will add a score to all articles that appear in a thread ``below''
19985 @vindex message-sent-hook
19986 These two functions are both primarily meant to be used in hooks like
19987 @code{message-sent-hook}, like this:
19989 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
19993 If you look closely at your own @code{Message-ID}, you'll notice that
19994 the first two or three characters are always the same. Here's two of
19998 <x6u3u47icf.fsf@@eyesore.no>
19999 <x6sp9o7ibw.fsf@@eyesore.no>
20002 So ``my'' ident on this machine is @samp{x6}. This can be
20003 exploited---the following rule will raise the score on all followups to
20008 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
20012 Whether it's the first two or first three characters that are ``yours''
20013 is system-dependent.
20016 @node Scoring On Other Headers
20017 @section Scoring On Other Headers
20018 @cindex scoring on other headers
20020 Gnus is quite fast when scoring the ``traditional''
20021 headers---@samp{From}, @samp{Subject} and so on. However, scoring
20022 other headers requires writing a @code{head} scoring rule, which means
20023 that Gnus has to request every single article from the back end to find
20024 matches. This takes a long time in big groups.
20026 Now, there's not much you can do about this for news groups, but for
20027 mail groups, you have greater control. In @ref{To From Newsgroups},
20028 it's explained in greater detail what this mechanism does, but here's
20029 a cookbook example for @code{nnml} on how to allow scoring on the
20030 @samp{To} and @samp{Cc} headers.
20032 Put the following in your @file{~/.gnus.el} file.
20035 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
20036 nnmail-extra-headers gnus-extra-headers)
20039 Restart Gnus and rebuild your @code{nnml} overview files with the
20040 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
20041 time if you have much mail.
20043 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
20044 so: @kbd{I e s p To RET <your name> RET}.
20050 @section Scoring Tips
20051 @cindex scoring tips
20057 @cindex scoring crossposts
20058 If you want to lower the score of crossposts, the line to match on is
20059 the @code{Xref} header.
20061 ("xref" (" talk.politics.misc:" -1000))
20064 @item Multiple crossposts
20065 If you want to lower the score of articles that have been crossposted to
20066 more than, say, 3 groups:
20069 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
20073 @item Matching on the body
20074 This is generally not a very good idea---it takes a very long time.
20075 Gnus actually has to fetch each individual article from the server. But
20076 you might want to anyway, I guess. Even though there are three match
20077 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
20078 and stick with it in each score file. If you use any two, each article
20079 will be fetched @emph{twice}. If you want to match a bit on the
20080 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
20083 @item Marking as read
20084 You will probably want to mark articles that have scores below a certain
20085 number as read. This is most easily achieved by putting the following
20086 in your @file{all.SCORE} file:
20090 You may also consider doing something similar with @code{expunge}.
20092 @item Negated character classes
20093 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
20094 That will match newlines, which might lead to, well, The Unknown. Say
20095 @code{[^abcd\n]*} instead.
20099 @node Reverse Scoring
20100 @section Reverse Scoring
20101 @cindex reverse scoring
20103 If you want to keep just articles that have @samp{Sex with Emacs} in the
20104 subject header, and expunge all other articles, you could put something
20105 like this in your score file:
20109 ("Sex with Emacs" 2))
20114 So, you raise all articles that match @samp{Sex with Emacs} and mark the
20115 rest as read, and expunge them to boot.
20118 @node Global Score Files
20119 @section Global Score Files
20120 @cindex global score files
20122 Sure, other newsreaders have ``global kill files''. These are usually
20123 nothing more than a single kill file that applies to all groups, stored
20124 in the user's home directory. Bah! Puny, weak newsreaders!
20126 What I'm talking about here are Global Score Files. Score files from
20127 all over the world, from users everywhere, uniting all nations in one
20128 big, happy score file union! Ange-score! New and untested!
20130 @vindex gnus-global-score-files
20131 All you have to do to use other people's score files is to set the
20132 @code{gnus-global-score-files} variable. One entry for each score file,
20133 or each score file directory. Gnus will decide by itself what score
20134 files are applicable to which group.
20136 To use the score file
20137 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
20138 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
20142 (setq gnus-global-score-files
20143 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
20144 "/ftp@@ftp.some-where:/pub/score/"))
20147 @findex gnus-score-search-global-directories
20149 Simple, eh? Directory names must end with a @samp{/}. These
20150 directories are typically scanned only once during each Gnus session.
20151 If you feel the need to manually re-scan the remote directories, you can
20152 use the @code{gnus-score-search-global-directories} command.
20154 Note that, at present, using this option will slow down group entry
20155 somewhat. (That is---a lot.)
20157 If you want to start maintaining score files for other people to use,
20158 just put your score file up for anonymous ftp and announce it to the
20159 world. Become a retro-moderator! Participate in the retro-moderator
20160 wars sure to ensue, where retro-moderators battle it out for the
20161 sympathy of the people, luring them to use their score files on false
20162 premises! Yay! The net is saved!
20164 Here are some tips for the would-be retro-moderator, off the top of my
20170 Articles heavily crossposted are probably junk.
20172 To lower a single inappropriate article, lower by @code{Message-ID}.
20174 Particularly brilliant authors can be raised on a permanent basis.
20176 Authors that repeatedly post off-charter for the group can safely be
20177 lowered out of existence.
20179 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
20180 articles completely.
20183 Use expiring score entries to keep the size of the file down. You
20184 should probably have a long expiry period, though, as some sites keep
20185 old articles for a long time.
20188 @dots{} I wonder whether other newsreaders will support global score files
20189 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
20190 Wave, xrn and 1stReader are bound to implement scoring. Should we start
20191 holding our breath yet?
20195 @section Kill Files
20198 Gnus still supports those pesky old kill files. In fact, the kill file
20199 entries can now be expiring, which is something I wrote before Daniel
20200 Quinlan thought of doing score files, so I've left the code in there.
20202 In short, kill processing is a lot slower (and I do mean @emph{a lot})
20203 than score processing, so it might be a good idea to rewrite your kill
20204 files into score files.
20206 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
20207 forms into this file, which means that you can use kill files as some
20208 sort of primitive hook function to be run on group entry, even though
20209 that isn't a very good idea.
20211 Normal kill files look like this:
20214 (gnus-kill "From" "Lars Ingebrigtsen")
20215 (gnus-kill "Subject" "ding")
20219 This will mark every article written by me as read, and remove the
20220 marked articles from the summary buffer. Very useful, you'll agree.
20222 Other programs use a totally different kill file syntax. If Gnus
20223 encounters what looks like a @code{rn} kill file, it will take a stab at
20226 Two summary functions for editing a @sc{gnus} kill file:
20231 @kindex M-k (Summary)
20232 @findex gnus-summary-edit-local-kill
20233 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
20236 @kindex M-K (Summary)
20237 @findex gnus-summary-edit-global-kill
20238 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
20241 Two group mode functions for editing the kill files:
20246 @kindex M-k (Group)
20247 @findex gnus-group-edit-local-kill
20248 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
20251 @kindex M-K (Group)
20252 @findex gnus-group-edit-global-kill
20253 Edit the general kill file (@code{gnus-group-edit-global-kill}).
20256 Kill file variables:
20259 @item gnus-kill-file-name
20260 @vindex gnus-kill-file-name
20261 A kill file for the group @samp{soc.motss} is normally called
20262 @file{soc.motss.KILL}. The suffix appended to the group name to get
20263 this file name is detailed by the @code{gnus-kill-file-name} variable.
20264 The ``global'' kill file (not in the score file sense of ``global'', of
20265 course) is just called @file{KILL}.
20267 @vindex gnus-kill-save-kill-file
20268 @item gnus-kill-save-kill-file
20269 If this variable is non-@code{nil}, Gnus will save the
20270 kill file after processing, which is necessary if you use expiring
20273 @item gnus-apply-kill-hook
20274 @vindex gnus-apply-kill-hook
20275 @findex gnus-apply-kill-file-unless-scored
20276 @findex gnus-apply-kill-file
20277 A hook called to apply kill files to a group. It is
20278 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
20279 kill file if you have a score file for the same group, you can set this
20280 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
20281 kill files to be processed, you should set this variable to @code{nil}.
20283 @item gnus-kill-file-mode-hook
20284 @vindex gnus-kill-file-mode-hook
20285 A hook called in kill-file mode buffers.
20290 @node Converting Kill Files
20291 @section Converting Kill Files
20293 @cindex converting kill files
20295 If you have loads of old kill files, you may want to convert them into
20296 score files. If they are ``regular'', you can use
20297 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
20300 The kill to score conversion package isn't included in Gnus by default.
20301 You can fetch it from
20302 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
20304 If your old kill files are very complex---if they contain more
20305 non-@code{gnus-kill} forms than not, you'll have to convert them by
20306 hand. Or just let them be as they are. Gnus will still use them as
20310 @node Advanced Scoring
20311 @section Advanced Scoring
20313 Scoring on Subjects and From headers is nice enough, but what if you're
20314 really interested in what a person has to say only when she's talking
20315 about a particular subject? Or what if you really don't want to
20316 read what person A has to say when she's following up to person B, but
20317 want to read what she says when she's following up to person C?
20319 By using advanced scoring rules you may create arbitrarily complex
20323 * Advanced Scoring Syntax:: A definition.
20324 * Advanced Scoring Examples:: What they look like.
20325 * Advanced Scoring Tips:: Getting the most out of it.
20329 @node Advanced Scoring Syntax
20330 @subsection Advanced Scoring Syntax
20332 Ordinary scoring rules have a string as the first element in the rule.
20333 Advanced scoring rules have a list as the first element. The second
20334 element is the score to be applied if the first element evaluated to a
20335 non-@code{nil} value.
20337 These lists may consist of three logical operators, one redirection
20338 operator, and various match operators.
20345 This logical operator will evaluate each of its arguments until it finds
20346 one that evaluates to @code{false}, and then it'll stop. If all arguments
20347 evaluate to @code{true} values, then this operator will return
20352 This logical operator will evaluate each of its arguments until it finds
20353 one that evaluates to @code{true}. If no arguments are @code{true},
20354 then this operator will return @code{false}.
20359 This logical operator only takes a single argument. It returns the
20360 logical negation of the value of its argument.
20364 There is an @dfn{indirection operator} that will make its arguments
20365 apply to the ancestors of the current article being scored. For
20366 instance, @code{1-} will make score rules apply to the parent of the
20367 current article. @code{2-} will make score rules apply to the
20368 grandparent of the current article. Alternatively, you can write
20369 @code{^^}, where the number of @code{^}s (carets) says how far back into
20370 the ancestry you want to go.
20372 Finally, we have the match operators. These are the ones that do the
20373 real work. Match operators are header name strings followed by a match
20374 and a match type. A typical match operator looks like @samp{("from"
20375 "Lars Ingebrigtsen" s)}. The header names are the same as when using
20376 simple scoring, and the match types are also the same.
20379 @node Advanced Scoring Examples
20380 @subsection Advanced Scoring Examples
20382 Please note that the following examples are score file rules. To
20383 make a complete score file from them, surround them with another pair
20386 Let's say you want to increase the score of articles written by Lars
20387 when he's talking about Gnus:
20392 ("from" "Lars Ingebrigtsen")
20393 ("subject" "Gnus"))
20400 When he writes long articles, he sometimes has something nice to say:
20404 ("from" "Lars Ingebrigtsen")
20411 However, when he responds to things written by Reig Eigil Logge, you
20412 really don't want to read what he's written:
20416 ("from" "Lars Ingebrigtsen")
20417 (1- ("from" "Reig Eigir Logge")))
20421 Everybody that follows up Redmondo when he writes about disappearing
20422 socks should have their scores raised, but only when they talk about
20423 white socks. However, when Lars talks about socks, it's usually not
20430 ("from" "redmondo@@.*no" r)
20431 ("body" "disappearing.*socks" t)))
20432 (! ("from" "Lars Ingebrigtsen"))
20433 ("body" "white.*socks"))
20437 The possibilities are endless.
20440 @node Advanced Scoring Tips
20441 @subsection Advanced Scoring Tips
20443 The @code{&} and @code{|} logical operators do short-circuit logic.
20444 That is, they stop processing their arguments when it's clear what the
20445 result of the operation will be. For instance, if one of the arguments
20446 of an @code{&} evaluates to @code{false}, there's no point in evaluating
20447 the rest of the arguments. This means that you should put slow matches
20448 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
20449 @samp{subject}) first.
20451 The indirection arguments (@code{1-} and so on) will make their
20452 arguments work on previous generations of the thread. If you say
20463 Then that means ``score on the from header of the grandparent of the
20464 current article''. An indirection is quite fast, but it's better to say:
20470 ("subject" "Gnus")))
20477 (1- ("from" "Lars"))
20478 (1- ("subject" "Gnus")))
20483 @section Score Decays
20484 @cindex score decays
20487 You may find that your scores have a tendency to grow without
20488 bounds, especially if you're using adaptive scoring. If scores get too
20489 big, they lose all meaning---they simply max out and it's difficult to
20490 use them in any sensible way.
20492 @vindex gnus-decay-scores
20493 @findex gnus-decay-score
20494 @vindex gnus-decay-score-function
20495 Gnus provides a mechanism for decaying scores to help with this problem.
20496 When score files are loaded and @code{gnus-decay-scores} is
20497 non-@code{nil}, Gnus will run the score files through the decaying
20498 mechanism thereby lowering the scores of all non-permanent score rules.
20499 The decay itself if performed by the @code{gnus-decay-score-function}
20500 function, which is @code{gnus-decay-score} by default. Here's the
20501 definition of that function:
20504 (defun gnus-decay-score (score)
20505 "Decay SCORE according to `gnus-score-decay-constant'
20506 and `gnus-score-decay-scale'."
20508 (* (if (< score 0) -1 1)
20510 (max gnus-score-decay-constant
20512 gnus-score-decay-scale)))))))
20513 (if (and (featurep 'xemacs)
20514 ;; XEmacs' floor can handle only the floating point
20515 ;; number below the half of the maximum integer.
20516 (> (abs n) (lsh -1 -2)))
20518 (car (split-string (number-to-string n) "\\.")))
20522 @vindex gnus-score-decay-scale
20523 @vindex gnus-score-decay-constant
20524 @code{gnus-score-decay-constant} is 3 by default and
20525 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
20529 Scores between -3 and 3 will be set to 0 when this function is called.
20532 Scores with magnitudes between 3 and 60 will be shrunk by 3.
20535 Scores with magnitudes greater than 60 will be shrunk by 5% of the
20539 If you don't like this decay function, write your own. It is called
20540 with the score to be decayed as its only parameter, and it should return
20541 the new score, which should be an integer.
20543 Gnus will try to decay scores once a day. If you haven't run Gnus for
20544 four days, Gnus will decay the scores four times, for instance.
20549 @include message.texi
20550 @chapter Emacs MIME
20551 @include emacs-mime.texi
20553 @include sieve.texi
20555 @c @include pgg.texi
20557 @c @include sasl.texi
20565 * Process/Prefix:: A convention used by many treatment commands.
20566 * Interactive:: Making Gnus ask you many questions.
20567 * Symbolic Prefixes:: How to supply some Gnus functions with options.
20568 * Formatting Variables:: You can specify what buffers should look like.
20569 * Window Layout:: Configuring the Gnus buffer windows.
20570 * Faces and Fonts:: How to change how faces look.
20571 * Compilation:: How to speed Gnus up.
20572 * Mode Lines:: Displaying information in the mode lines.
20573 * Highlighting and Menus:: Making buffers look all nice and cozy.
20574 * Buttons:: Get tendinitis in ten easy steps!
20575 * Daemons:: Gnus can do things behind your back.
20576 * NoCeM:: How to avoid spam and other fatty foods.
20577 * Undo:: Some actions can be undone.
20578 * Predicate Specifiers:: Specifying predicates.
20579 * Moderation:: What to do if you're a moderator.
20580 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
20581 * Fuzzy Matching:: What's the big fuzz?
20582 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
20583 * Other modes:: Interaction with other modes.
20584 * Various Various:: Things that are really various.
20588 @node Process/Prefix
20589 @section Process/Prefix
20590 @cindex process/prefix convention
20592 Many functions, among them functions for moving, decoding and saving
20593 articles, use what is known as the @dfn{Process/Prefix convention}.
20595 This is a method for figuring out what articles the user wants the
20596 command to be performed on.
20600 If the numeric prefix is N, perform the operation on the next N
20601 articles, starting with the current one. If the numeric prefix is
20602 negative, perform the operation on the previous N articles, starting
20603 with the current one.
20605 @vindex transient-mark-mode
20606 If @code{transient-mark-mode} in non-@code{nil} and the region is
20607 active, all articles in the region will be worked upon.
20609 If there is no numeric prefix, but some articles are marked with the
20610 process mark, perform the operation on the articles marked with
20613 If there is neither a numeric prefix nor any articles marked with the
20614 process mark, just perform the operation on the current article.
20616 Quite simple, really, but it needs to be made clear so that surprises
20619 Commands that react to the process mark will push the current list of
20620 process marked articles onto a stack and will then clear all process
20621 marked articles. You can restore the previous configuration with the
20622 @kbd{M P y} command (@pxref{Setting Process Marks}).
20624 @vindex gnus-summary-goto-unread
20625 One thing that seems to shock & horrify lots of people is that, for
20626 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
20627 Since each @kbd{d} (which marks the current article as read) by default
20628 goes to the next unread article after marking, this means that @kbd{3 d}
20629 will mark the next three unread articles as read, no matter what the
20630 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
20631 @code{nil} for a more straightforward action.
20633 Many commands do not use the process/prefix convention. All commands
20634 that do explicitly say so in this manual. To apply the process/prefix
20635 convention to commands that do not use it, you can use the @kbd{M-&}
20636 command. For instance, to mark all the articles in the group as
20637 expirable, you could say @kbd{M P b M-& E}.
20641 @section Interactive
20642 @cindex interaction
20646 @item gnus-novice-user
20647 @vindex gnus-novice-user
20648 If this variable is non-@code{nil}, you are either a newcomer to the
20649 World of Usenet, or you are very cautious, which is a nice thing to be,
20650 really. You will be given questions of the type ``Are you sure you want
20651 to do this?'' before doing anything dangerous. This is @code{t} by
20654 @item gnus-expert-user
20655 @vindex gnus-expert-user
20656 If this variable is non-@code{nil}, you will seldom be asked any
20657 questions by Gnus. It will simply assume you know what you're doing, no
20658 matter how strange.
20660 @item gnus-interactive-catchup
20661 @vindex gnus-interactive-catchup
20662 Require confirmation before catching up a group if non-@code{nil}. It
20663 is @code{t} by default.
20665 @item gnus-interactive-exit
20666 @vindex gnus-interactive-exit
20667 Require confirmation before exiting Gnus. This variable is @code{t} by
20672 @node Symbolic Prefixes
20673 @section Symbolic Prefixes
20674 @cindex symbolic prefixes
20676 Quite a lot of Emacs commands react to the (numeric) prefix. For
20677 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
20678 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
20679 rule of 900 to the current article.
20681 This is all nice and well, but what if you want to give a command some
20682 additional information? Well, what most commands do is interpret the
20683 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
20684 doesn't want a backup file to be created when saving the current buffer,
20685 for instance. But what if you want to save without making a backup
20686 file, and you want Emacs to flash lights and play a nice tune at the
20687 same time? You can't, and you're probably perfectly happy that way.
20689 @kindex M-i (Summary)
20690 @findex gnus-symbolic-argument
20691 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
20692 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
20693 character typed in is the value. You can stack as many @kbd{M-i}
20694 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
20695 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
20696 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
20697 @code{b}''. You get the drift.
20699 Typing in symbolic prefixes to commands that don't accept them doesn't
20700 hurt, but it doesn't do any good either. Currently not many Gnus
20701 functions make use of the symbolic prefix.
20703 If you're interested in how Gnus implements this, @pxref{Extended
20707 @node Formatting Variables
20708 @section Formatting Variables
20709 @cindex formatting variables
20711 Throughout this manual you've probably noticed lots of variables called
20712 things like @code{gnus-group-line-format} and
20713 @code{gnus-summary-mode-line-format}. These control how Gnus is to
20714 output lines in the various buffers. There's quite a lot of them.
20715 Fortunately, they all use the same syntax, so there's not that much to
20718 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
20719 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
20720 lots of percentages everywhere.
20723 * Formatting Basics:: A formatting variable is basically a format string.
20724 * Mode Line Formatting:: Some rules about mode line formatting variables.
20725 * Advanced Formatting:: Modifying output in various ways.
20726 * User-Defined Specs:: Having Gnus call your own functions.
20727 * Formatting Fonts:: Making the formatting look colorful and nice.
20728 * Positioning Point:: Moving point to a position after an operation.
20729 * Tabulation:: Tabulating your output.
20730 * Wide Characters:: Dealing with wide characters.
20733 Currently Gnus uses the following formatting variables:
20734 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
20735 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
20736 @code{gnus-group-mode-line-format},
20737 @code{gnus-summary-mode-line-format},
20738 @code{gnus-article-mode-line-format},
20739 @code{gnus-server-mode-line-format}, and
20740 @code{gnus-summary-pick-line-format}.
20742 All these format variables can also be arbitrary elisp forms. In that
20743 case, they will be @code{eval}ed to insert the required lines.
20745 @kindex M-x gnus-update-format
20746 @findex gnus-update-format
20747 Gnus includes a command to help you while creating your own format
20748 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
20749 update the spec in question and pop you to a buffer where you can
20750 examine the resulting Lisp code to be run to generate the line.
20754 @node Formatting Basics
20755 @subsection Formatting Basics
20757 Each @samp{%} element will be replaced by some string or other when the
20758 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
20759 spec, and pad with spaces to get a 5-character field''.
20761 As with normal C and Emacs Lisp formatting strings, the numerical
20762 modifier between the @samp{%} and the formatting type character will
20763 @dfn{pad} the output so that it is always at least that long.
20764 @samp{%5y} will make the field always (at least) five characters wide by
20765 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
20768 You may also wish to limit the length of the field to protect against
20769 particularly wide values. For that you can say @samp{%4,6y}, which
20770 means that the field will never be more than 6 characters wide and never
20771 less than 4 characters wide.
20773 Also Gnus supports some extended format specifications, such as
20774 @samp{%&user-date;}.
20777 @node Mode Line Formatting
20778 @subsection Mode Line Formatting
20780 Mode line formatting variables (e.g.,
20781 @code{gnus-summary-mode-line-format}) follow the same rules as other,
20782 buffer line oriented formatting variables (@pxref{Formatting Basics})
20783 with the following two differences:
20788 There must be no newline (@samp{\n}) at the end.
20791 The special @samp{%%b} spec can be used to display the buffer name.
20792 Well, it's no spec at all, really---@samp{%%} is just a way to quote
20793 @samp{%} to allow it to pass through the formatting machinery unmangled,
20794 so that Emacs receives @samp{%b}, which is something the Emacs mode line
20795 display interprets to mean ``show the buffer name''. For a full list of
20796 mode line specs Emacs understands, see the documentation of the
20797 @code{mode-line-format} variable.
20802 @node Advanced Formatting
20803 @subsection Advanced Formatting
20805 It is frequently useful to post-process the fields in some way.
20806 Padding, limiting, cutting off parts and suppressing certain values can
20807 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
20808 look like @samp{%~(cut 3)~(ignore "0")y}.
20810 These are the valid modifiers:
20815 Pad the field to the left with spaces until it reaches the required
20819 Pad the field to the right with spaces until it reaches the required
20824 Cut off characters from the left until it reaches the specified length.
20827 Cut off characters from the right until it reaches the specified
20832 Cut off the specified number of characters from the left.
20835 Cut off the specified number of characters from the right.
20838 Return an empty string if the field is equal to the specified value.
20841 Use the specified form as the field value when the @samp{@@} spec is
20847 "~(form (current-time-string))@@"
20852 Let's take an example. The @samp{%o} spec in the summary mode lines
20853 will return a date in compact ISO8601 format---@samp{19960809T230410}.
20854 This is quite a mouthful, so we want to shave off the century number and
20855 the time, leaving us with a six-character date. That would be
20856 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
20857 maxing, and we need the padding to ensure that the date is never less
20858 than 6 characters to make it look nice in columns.)
20860 Ignoring is done first; then cutting; then maxing; and then as the very
20861 last operation, padding.
20863 @vindex gnus-compile-user-specs
20864 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
20865 default) with your strong personality, and use a lots of these advanced
20866 thingies, you'll find that Gnus gets quite slow. This can be helped
20867 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
20868 the look of your lines.
20869 @xref{Compilation}.
20872 @node User-Defined Specs
20873 @subsection User-Defined Specs
20875 All the specs allow for inserting user defined specifiers---@samp{u}.
20876 The next character in the format string should be a letter. Gnus
20877 will call the function @code{gnus-user-format-function-}@samp{X}, where
20878 @samp{X} is the letter following @samp{%u}. The function will be passed
20879 a single parameter---what the parameter means depends on what buffer
20880 it's being called from. The function should return a string, which will
20881 be inserted into the buffer just like information from any other
20882 specifier. This function may also be called with dummy values, so it
20883 should protect against that.
20885 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
20886 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
20888 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
20889 much the same without defining new functions. Here's an example:
20890 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
20891 given here will be evaluated to yield the current line number, and then
20895 @node Formatting Fonts
20896 @subsection Formatting Fonts
20898 There are specs for highlighting, and these are shared by all the format
20899 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
20900 the special @code{mouse-face} property set, which means that it will be
20901 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
20904 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
20905 normal faces set using @code{gnus-face-0}, which is @code{bold} by
20906 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
20907 and so on. Create as many faces as you wish. The same goes for the
20908 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
20909 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
20911 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
20912 special @code{balloon-help} property set to
20913 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
20914 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
20915 variables should be either strings or symbols naming functions that
20916 return a string. When the mouse passes over text with this property
20917 set, a balloon window will appear and display the string. Please
20918 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
20919 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
20920 XEmacs) for more information on this. (For technical reasons, the
20921 guillemets have been approximated as @samp{<<} and @samp{>>} in this
20924 Here's an alternative recipe for the group buffer:
20927 ;; @r{Create three face types.}
20928 (setq gnus-face-1 'bold)
20929 (setq gnus-face-3 'italic)
20931 ;; @r{We want the article count to be in}
20932 ;; @r{a bold and green face. So we create}
20933 ;; @r{a new face called @code{my-green-bold}.}
20934 (copy-face 'bold 'my-green-bold)
20935 ;; @r{Set the color.}
20936 (set-face-foreground 'my-green-bold "ForestGreen")
20937 (setq gnus-face-2 'my-green-bold)
20939 ;; @r{Set the new & fancy format.}
20940 (setq gnus-group-line-format
20941 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
20944 I'm sure you'll be able to use this scheme to create totally unreadable
20945 and extremely vulgar displays. Have fun!
20947 Note that the @samp{%(} specs (and friends) do not make any sense on the
20948 mode-line variables.
20950 @node Positioning Point
20951 @subsection Positioning Point
20953 Gnus usually moves point to a pre-defined place on each line in most
20954 buffers. By default, point move to the first colon character on the
20955 line. You can customize this behaviour in three different ways.
20957 You can move the colon character to somewhere else on the line.
20959 @findex gnus-goto-colon
20960 You can redefine the function that moves the point to the colon. The
20961 function is called @code{gnus-goto-colon}.
20963 But perhaps the most convenient way to deal with this, if you don't want
20964 to have a colon in your line, is to use the @samp{%*} specifier. If you
20965 put a @samp{%*} somewhere in your format line definition, Gnus will
20970 @subsection Tabulation
20972 You can usually line up your displays by padding and cutting your
20973 strings. However, when combining various strings of different size, it
20974 can often be more convenient to just output the strings, and then worry
20975 about lining up the following text afterwards.
20977 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
20978 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
20980 @samp{%50=} will insert space characters to pad the line up to column
20981 50. If the text is already past column 50, nothing will be inserted.
20982 This is the soft tabulator.
20984 @samp{%-50=} will insert space characters to pad the line up to column
20985 50. If the text is already past column 50, the excess text past column
20986 50 will be removed. This is the hard tabulator.
20989 @node Wide Characters
20990 @subsection Wide Characters
20992 Fixed width fonts in most countries have characters of the same width.
20993 Some countries, however, use Latin characters mixed with wider
20994 characters---most notable East Asian countries.
20996 The problem is that when formatting, Gnus assumes that if a string is 10
20997 characters wide, it'll be 10 Latin characters wide on the screen. In
20998 these countries, that's not true.
21000 @vindex gnus-use-correct-string-widths
21001 To help fix this, you can set @code{gnus-use-correct-string-widths} to
21002 @code{t}. This makes buffer generation slower, but the results will be
21003 prettier. The default value under XEmacs is @code{t} but @code{nil}
21007 @node Window Layout
21008 @section Window Layout
21009 @cindex window layout
21011 No, there's nothing here about X, so be quiet.
21013 @vindex gnus-use-full-window
21014 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
21015 other windows and occupy the entire Emacs screen by itself. It is
21016 @code{t} by default.
21018 Setting this variable to @code{nil} kinda works, but there are
21019 glitches. Use at your own peril.
21021 @vindex gnus-buffer-configuration
21022 @code{gnus-buffer-configuration} describes how much space each Gnus
21023 buffer should be given. Here's an excerpt of this variable:
21026 ((group (vertical 1.0 (group 1.0 point)
21027 (if gnus-carpal (group-carpal 4))))
21028 (article (vertical 1.0 (summary 0.25 point)
21032 This is an alist. The @dfn{key} is a symbol that names some action or
21033 other. For instance, when displaying the group buffer, the window
21034 configuration function will use @code{group} as the key. A full list of
21035 possible names is listed below.
21037 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
21038 should occupy. To take the @code{article} split as an example -
21041 (article (vertical 1.0 (summary 0.25 point)
21045 This @dfn{split} says that the summary buffer should occupy 25% of upper
21046 half of the screen, and that it is placed over the article buffer. As
21047 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
21048 reaching for that calculator there). However, the special number
21049 @code{1.0} is used to signal that this buffer should soak up all the
21050 rest of the space available after the rest of the buffers have taken
21051 whatever they need. There should be only one buffer with the @code{1.0}
21052 size spec per split.
21054 Point will be put in the buffer that has the optional third element
21055 @code{point}. In a @code{frame} split, the last subsplit having a leaf
21056 split where the tag @code{frame-focus} is a member (i.e. is the third or
21057 fourth element in the list, depending on whether the @code{point} tag is
21058 present) gets focus.
21060 Here's a more complicated example:
21063 (article (vertical 1.0 (group 4)
21064 (summary 0.25 point)
21065 (if gnus-carpal (summary-carpal 4))
21069 If the size spec is an integer instead of a floating point number,
21070 then that number will be used to say how many lines a buffer should
21071 occupy, not a percentage.
21073 If the @dfn{split} looks like something that can be @code{eval}ed (to be
21074 precise---if the @code{car} of the split is a function or a subr), this
21075 split will be @code{eval}ed. If the result is non-@code{nil}, it will
21076 be used as a split. This means that there will be three buffers if
21077 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
21080 Not complicated enough for you? Well, try this on for size:
21083 (article (horizontal 1.0
21088 (summary 0.25 point)
21093 Whoops. Two buffers with the mystery 100% tag. And what's that
21094 @code{horizontal} thingie?
21096 If the first element in one of the split is @code{horizontal}, Gnus will
21097 split the window horizontally, giving you two windows side-by-side.
21098 Inside each of these strips you may carry on all you like in the normal
21099 fashion. The number following @code{horizontal} says what percentage of
21100 the screen is to be given to this strip.
21102 For each split, there @emph{must} be one element that has the 100% tag.
21103 The splitting is never accurate, and this buffer will eat any leftover
21104 lines from the splits.
21106 To be slightly more formal, here's a definition of what a valid split
21111 split = frame | horizontal | vertical | buffer | form
21112 frame = "(frame " size *split ")"
21113 horizontal = "(horizontal " size *split ")"
21114 vertical = "(vertical " size *split ")"
21115 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
21116 size = number | frame-params
21117 buf-name = group | article | summary ...
21121 The limitations are that the @code{frame} split can only appear as the
21122 top-level split. @var{form} should be an Emacs Lisp form that should
21123 return a valid split. We see that each split is fully recursive, and
21124 may contain any number of @code{vertical} and @code{horizontal} splits.
21126 @vindex gnus-window-min-width
21127 @vindex gnus-window-min-height
21128 @cindex window height
21129 @cindex window width
21130 Finding the right sizes can be a bit complicated. No window may be less
21131 than @code{gnus-window-min-height} (default 1) characters high, and all
21132 windows must be at least @code{gnus-window-min-width} (default 1)
21133 characters wide. Gnus will try to enforce this before applying the
21134 splits. If you want to use the normal Emacs window width/height limit,
21135 you can just set these two variables to @code{nil}.
21137 If you're not familiar with Emacs terminology, @code{horizontal} and
21138 @code{vertical} splits may work the opposite way of what you'd expect.
21139 Windows inside a @code{horizontal} split are shown side-by-side, and
21140 windows within a @code{vertical} split are shown above each other.
21142 @findex gnus-configure-frame
21143 If you want to experiment with window placement, a good tip is to call
21144 @code{gnus-configure-frame} directly with a split. This is the function
21145 that does all the real work when splitting buffers. Below is a pretty
21146 nonsensical configuration with 5 windows; two for the group buffer and
21147 three for the article buffer. (I said it was nonsensical.) If you
21148 @code{eval} the statement below, you can get an idea of how that would
21149 look straight away, without going through the normal Gnus channels.
21150 Play with it until you're satisfied, and then use
21151 @code{gnus-add-configuration} to add your new creation to the buffer
21152 configuration list.
21155 (gnus-configure-frame
21159 (article 0.3 point))
21167 You might want to have several frames as well. No prob---just use the
21168 @code{frame} split:
21171 (gnus-configure-frame
21174 (summary 0.25 point frame-focus)
21176 (vertical ((height . 5) (width . 15)
21177 (user-position . t)
21178 (left . -1) (top . 1))
21183 This split will result in the familiar summary/article window
21184 configuration in the first (or ``main'') frame, while a small additional
21185 frame will be created where picons will be shown. As you can see,
21186 instead of the normal @code{1.0} top-level spec, each additional split
21187 should have a frame parameter alist as the size spec.
21188 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
21189 Reference Manual}. Under XEmacs, a frame property list will be
21190 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
21192 The list of all possible keys for @code{gnus-buffer-configuration} can
21193 be found in its default value.
21195 Note that the @code{message} key is used for both
21196 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
21197 it is desirable to distinguish between the two, something like this
21201 (message (horizontal 1.0
21202 (vertical 1.0 (message 1.0 point))
21204 (if (buffer-live-p gnus-summary-buffer)
21209 One common desire for a multiple frame split is to have a separate frame
21210 for composing mail and news while leaving the original frame intact. To
21211 accomplish that, something like the following can be done:
21216 (if (not (buffer-live-p gnus-summary-buffer))
21217 (car (cdr (assoc 'group gnus-buffer-configuration)))
21218 (car (cdr (assoc 'summary gnus-buffer-configuration))))
21219 (vertical ((user-position . t) (top . 1) (left . 1)
21220 (name . "Message"))
21221 (message 1.0 point))))
21224 @findex gnus-add-configuration
21225 Since the @code{gnus-buffer-configuration} variable is so long and
21226 complicated, there's a function you can use to ease changing the config
21227 of a single setting: @code{gnus-add-configuration}. If, for instance,
21228 you want to change the @code{article} setting, you could say:
21231 (gnus-add-configuration
21232 '(article (vertical 1.0
21234 (summary .25 point)
21238 You'd typically stick these @code{gnus-add-configuration} calls in your
21239 @file{~/.gnus.el} file or in some startup hook---they should be run after
21240 Gnus has been loaded.
21242 @vindex gnus-always-force-window-configuration
21243 If all windows mentioned in the configuration are already visible, Gnus
21244 won't change the window configuration. If you always want to force the
21245 ``right'' window configuration, you can set
21246 @code{gnus-always-force-window-configuration} to non-@code{nil}.
21248 If you're using tree displays (@pxref{Tree Display}), and the tree
21249 window is displayed vertically next to another window, you may also want
21250 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
21253 @subsection Example Window Configurations
21257 Narrow left hand side occupied by group buffer. Right hand side split
21258 between summary buffer (top one-sixth) and article buffer (bottom).
21273 (gnus-add-configuration
21276 (vertical 25 (group 1.0))
21278 (summary 0.16 point)
21281 (gnus-add-configuration
21284 (vertical 25 (group 1.0))
21285 (vertical 1.0 (summary 1.0 point)))))
21291 @node Faces and Fonts
21292 @section Faces and Fonts
21297 Fiddling with fonts and faces used to be very difficult, but these days
21298 it is very simple. You simply say @kbd{M-x customize-face}, pick out
21299 the face you want to alter, and alter it via the standard Customize
21304 @section Compilation
21305 @cindex compilation
21306 @cindex byte-compilation
21308 @findex gnus-compile
21310 Remember all those line format specification variables?
21311 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
21312 on. By default, T-gnus will use the byte-compiled codes of these
21313 variables and we can keep a slow-down to a minimum. However, if you set
21314 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
21315 unfortunately, changing them will mean a quite significant slow-down.
21316 (The default values of these variables have byte-compiled functions
21317 associated with them, while the user-generated versions do not, of
21320 To help with this, you can run @kbd{M-x gnus-compile} after you've
21321 fiddled around with the variables and feel that you're (kind of)
21322 satisfied. This will result in the new specs being byte-compiled, and
21323 you'll get top speed again. Note that T-gnus will not save these
21324 compiled specs in the @file{.newsrc.eld} file.
21327 @item gnus-compile-user-specs
21328 @vindex gnus-compile-user-specs
21329 If it is non-nil, the user-defined format specs will be byte-compiled
21330 automatically. The default value of this variable is @code{t}. It has
21331 an effect on the values of @code{gnus-*-line-format-spec}.
21336 @section Mode Lines
21339 @vindex gnus-updated-mode-lines
21340 @code{gnus-updated-mode-lines} says what buffers should keep their mode
21341 lines updated. It is a list of symbols. Supported symbols include
21342 @code{group}, @code{article}, @code{summary}, @code{server},
21343 @code{browse}, and @code{tree}. If the corresponding symbol is present,
21344 Gnus will keep that mode line updated with information that may be
21345 pertinent. If this variable is @code{nil}, screen refresh may be
21348 @cindex display-time
21350 @vindex gnus-mode-non-string-length
21351 By default, Gnus displays information on the current article in the mode
21352 lines of the summary and article buffers. The information Gnus wishes
21353 to display (e.g. the subject of the article) is often longer than the
21354 mode lines, and therefore have to be cut off at some point. The
21355 @code{gnus-mode-non-string-length} variable says how long the other
21356 elements on the line is (i.e., the non-info part). If you put
21357 additional elements on the mode line (e.g. a clock), you should modify
21360 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
21362 (add-hook 'display-time-hook
21363 (lambda () (setq gnus-mode-non-string-length
21365 (if line-number-mode 5 0)
21366 (if column-number-mode 4 0)
21367 (length display-time-string)))))
21370 If this variable is @code{nil} (which is the default), the mode line
21371 strings won't be chopped off, and they won't be padded either. Note
21372 that the default is unlikely to be desirable, as even the percentage
21373 complete in the buffer may be crowded off the mode line; the user should
21374 configure this variable appropriately for her configuration.
21377 @node Highlighting and Menus
21378 @section Highlighting and Menus
21380 @cindex highlighting
21383 @vindex gnus-visual
21384 The @code{gnus-visual} variable controls most of the Gnus-prettifying
21385 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
21386 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
21389 This variable can be a list of visual properties that are enabled. The
21390 following elements are valid, and are all included by default:
21393 @item group-highlight
21394 Do highlights in the group buffer.
21395 @item summary-highlight
21396 Do highlights in the summary buffer.
21397 @item article-highlight
21398 Do highlights in the article buffer.
21400 Turn on highlighting in all buffers.
21402 Create menus in the group buffer.
21404 Create menus in the summary buffers.
21406 Create menus in the article buffer.
21408 Create menus in the browse buffer.
21410 Create menus in the server buffer.
21412 Create menus in the score buffers.
21414 Create menus in all buffers.
21417 So if you only want highlighting in the article buffer and menus in all
21418 buffers, you could say something like:
21421 (setq gnus-visual '(article-highlight menu))
21424 If you want highlighting only and no menus whatsoever, you'd say:
21427 (setq gnus-visual '(highlight))
21430 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
21431 in all Gnus buffers.
21433 Other general variables that influence the look of all buffers include:
21436 @item gnus-mouse-face
21437 @vindex gnus-mouse-face
21438 This is the face (i.e., font) used for mouse highlighting in Gnus. No
21439 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
21443 There are hooks associated with the creation of all the different menus:
21447 @item gnus-article-menu-hook
21448 @vindex gnus-article-menu-hook
21449 Hook called after creating the article mode menu.
21451 @item gnus-group-menu-hook
21452 @vindex gnus-group-menu-hook
21453 Hook called after creating the group mode menu.
21455 @item gnus-summary-menu-hook
21456 @vindex gnus-summary-menu-hook
21457 Hook called after creating the summary mode menu.
21459 @item gnus-server-menu-hook
21460 @vindex gnus-server-menu-hook
21461 Hook called after creating the server mode menu.
21463 @item gnus-browse-menu-hook
21464 @vindex gnus-browse-menu-hook
21465 Hook called after creating the browse mode menu.
21467 @item gnus-score-menu-hook
21468 @vindex gnus-score-menu-hook
21469 Hook called after creating the score mode menu.
21480 Those new-fangled @dfn{mouse} contraptions is very popular with the
21481 young, hep kids who don't want to learn the proper way to do things
21482 these days. Why, I remember way back in the summer of '89, when I was
21483 using Emacs on a Tops 20 system. Three hundred users on one single
21484 machine, and every user was running Simula compilers. Bah!
21488 @vindex gnus-carpal
21489 Well, you can make Gnus display bufferfuls of buttons you can click to
21490 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
21491 really. Tell the chiropractor I sent you.
21496 @item gnus-carpal-mode-hook
21497 @vindex gnus-carpal-mode-hook
21498 Hook run in all carpal mode buffers.
21500 @item gnus-carpal-button-face
21501 @vindex gnus-carpal-button-face
21502 Face used on buttons.
21504 @item gnus-carpal-header-face
21505 @vindex gnus-carpal-header-face
21506 Face used on carpal buffer headers.
21508 @item gnus-carpal-group-buffer-buttons
21509 @vindex gnus-carpal-group-buffer-buttons
21510 Buttons in the group buffer.
21512 @item gnus-carpal-summary-buffer-buttons
21513 @vindex gnus-carpal-summary-buffer-buttons
21514 Buttons in the summary buffer.
21516 @item gnus-carpal-server-buffer-buttons
21517 @vindex gnus-carpal-server-buffer-buttons
21518 Buttons in the server buffer.
21520 @item gnus-carpal-browse-buffer-buttons
21521 @vindex gnus-carpal-browse-buffer-buttons
21522 Buttons in the browse buffer.
21525 All the @code{buttons} variables are lists. The elements in these list
21526 are either cons cells where the @code{car} contains a text to be displayed and
21527 the @code{cdr} contains a function symbol, or a simple string.
21535 Gnus, being larger than any program ever written (allegedly), does lots
21536 of strange stuff that you may wish to have done while you're not
21537 present. For instance, you may want it to check for new mail once in a
21538 while. Or you may want it to close down all connections to all servers
21539 when you leave Emacs idle. And stuff like that.
21541 Gnus will let you do stuff like that by defining various
21542 @dfn{handlers}. Each handler consists of three elements: A
21543 @var{function}, a @var{time}, and an @var{idle} parameter.
21545 Here's an example of a handler that closes connections when Emacs has
21546 been idle for thirty minutes:
21549 (gnus-demon-close-connections nil 30)
21552 Here's a handler that scans for @acronym{PGP} headers every hour when
21556 (gnus-demon-scan-pgp 60 t)
21559 This @var{time} parameter and that @var{idle} parameter work together
21560 in a strange, but wonderful fashion. Basically, if @var{idle} is
21561 @code{nil}, then the function will be called every @var{time} minutes.
21563 If @var{idle} is @code{t}, then the function will be called after
21564 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
21565 the function will never be called. But once Emacs goes idle, the
21566 function will be called every @var{time} minutes.
21568 If @var{idle} is a number and @var{time} is a number, the function will
21569 be called every @var{time} minutes only when Emacs has been idle for
21570 @var{idle} minutes.
21572 If @var{idle} is a number and @var{time} is @code{nil}, the function
21573 will be called once every time Emacs has been idle for @var{idle}
21576 And if @var{time} is a string, it should look like @samp{07:31}, and
21577 the function will then be called once every day somewhere near that
21578 time. Modified by the @var{idle} parameter, of course.
21580 @vindex gnus-demon-timestep
21581 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
21582 seconds. This is 60 by default. If you change that variable,
21583 all the timings in the handlers will be affected.)
21585 So, if you want to add a handler, you could put something like this in
21586 your @file{~/.gnus.el} file:
21588 @findex gnus-demon-add-handler
21590 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
21593 @findex gnus-demon-add-nocem
21594 @findex gnus-demon-add-scanmail
21595 @findex gnus-demon-add-rescan
21596 @findex gnus-demon-add-scan-timestamps
21597 @findex gnus-demon-add-disconnection
21598 Some ready-made functions to do this have been created:
21599 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
21600 @code{gnus-demon-add-nntp-close-connection},
21601 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
21602 @code{gnus-demon-add-scanmail}. Just put those functions in your
21603 @file{~/.gnus.el} if you want those abilities.
21605 @findex gnus-demon-init
21606 @findex gnus-demon-cancel
21607 @vindex gnus-demon-handlers
21608 If you add handlers to @code{gnus-demon-handlers} directly, you should
21609 run @code{gnus-demon-init} to make the changes take hold. To cancel all
21610 daemons, you can use the @code{gnus-demon-cancel} function.
21612 Note that adding daemons can be pretty naughty if you over do it. Adding
21613 functions that scan all news and mail from all servers every two seconds
21614 is a sure-fire way of getting booted off any respectable system. So
21623 @dfn{Spamming} is posting the same article lots and lots of times.
21624 Spamming is bad. Spamming is evil.
21626 Spamming is usually canceled within a day or so by various anti-spamming
21627 agencies. These agencies usually also send out @dfn{NoCeM} messages.
21628 NoCeM is pronounced ``no see-'em'', and means what the name
21629 implies---these are messages that make the offending articles, like, go
21632 What use are these NoCeM messages if the articles are canceled anyway?
21633 Some sites do not honor cancel messages and some sites just honor cancels
21634 from a select few people. Then you may wish to make use of the NoCeM
21635 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
21637 Gnus can read and parse the messages in this group automatically, and
21638 this will make spam disappear.
21640 There are some variables to customize, of course:
21643 @item gnus-use-nocem
21644 @vindex gnus-use-nocem
21645 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
21648 @item gnus-nocem-groups
21649 @vindex gnus-nocem-groups
21650 Gnus will look for NoCeM messages in the groups in this list. The
21653 ("news.lists.filters" "news.admin.net-abuse.bulletins"
21654 "alt.nocem.misc" "news.admin.net-abuse.announce")
21657 @item gnus-nocem-issuers
21658 @vindex gnus-nocem-issuers
21659 There are many people issuing NoCeM messages. This list says what
21660 people you want to listen to. The default is
21662 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
21663 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
21665 fine, upstanding citizens all of them.
21667 Known despammers that you can put in this list are listed at@*
21668 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
21670 You do not have to heed NoCeM messages from all these people---just the
21671 ones you want to listen to. You also don't have to accept all NoCeM
21672 messages from the people you like. Each NoCeM message has a @dfn{type}
21673 header that gives the message a (more or less, usually less) rigorous
21674 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
21675 @samp{binary}, and @samp{troll}. To specify this, you have to use
21676 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
21677 Each condition is either a string (which is a regexp that matches types
21678 you want to use) or a list on the form @code{(not @var{string})}, where
21679 @var{string} is a regexp that matches types you don't want to use.
21681 For instance, if you want all NoCeM messages from Chris Lewis except his
21682 @samp{troll} messages, you'd say:
21685 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
21688 On the other hand, if you just want nothing but his @samp{spam} and
21689 @samp{spew} messages, you'd say:
21692 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
21695 The specs are applied left-to-right.
21698 @item gnus-nocem-verifyer
21699 @vindex gnus-nocem-verifyer
21701 This should be a function for verifying that the NoCeM issuer is who she
21702 says she is. The default is @code{mc-verify}, which is a Mailcrypt
21703 function. If this is too slow and you don't care for verification
21704 (which may be dangerous), you can set this variable to @code{nil}.
21706 If you want signed NoCeM messages to be verified and unsigned messages
21707 not to be verified (but used anyway), you could do something like:
21710 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
21712 (defun my-gnus-mc-verify ()
21720 This might be dangerous, though.
21722 @item gnus-nocem-directory
21723 @vindex gnus-nocem-directory
21724 This is where Gnus will store its NoCeM cache files. The default is@*
21725 @file{~/News/NoCeM/}.
21727 @item gnus-nocem-expiry-wait
21728 @vindex gnus-nocem-expiry-wait
21729 The number of days before removing old NoCeM entries from the cache.
21730 The default is 15. If you make it shorter Gnus will be faster, but you
21731 might then see old spam.
21733 @item gnus-nocem-check-from
21734 @vindex gnus-nocem-check-from
21735 Non-@code{nil} means check for valid issuers in message bodies.
21736 Otherwise don't bother fetching articles unless their author matches a
21737 valid issuer; that is much faster if you are selective about the
21740 @item gnus-nocem-check-article-limit
21741 @vindex gnus-nocem-check-article-limit
21742 If non-@code{nil}, the maximum number of articles to check in any NoCeM
21743 group. NoCeM groups can be huge and very slow to process.
21747 Using NoCeM could potentially be a memory hog. If you have many living
21748 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
21749 big. If this is a problem, you should kill off all (or most) of your
21750 unsubscribed groups (@pxref{Subscription Commands}).
21757 It is very useful to be able to undo actions one has done. In normal
21758 Emacs buffers, it's easy enough---you just push the @code{undo} button.
21759 In Gnus buffers, however, it isn't that simple.
21761 The things Gnus displays in its buffer is of no value whatsoever to
21762 Gnus---it's all just data designed to look nice to the user.
21763 Killing a group in the group buffer with @kbd{C-k} makes the line
21764 disappear, but that's just a side-effect of the real action---the
21765 removal of the group in question from the internal Gnus structures.
21766 Undoing something like that can't be done by the normal Emacs
21767 @code{undo} function.
21769 Gnus tries to remedy this somewhat by keeping track of what the user
21770 does and coming up with actions that would reverse the actions the user
21771 takes. When the user then presses the @code{undo} key, Gnus will run
21772 the code to reverse the previous action, or the previous actions.
21773 However, not all actions are easily reversible, so Gnus currently offers
21774 a few key functions to be undoable. These include killing groups,
21775 yanking groups, and changing the list of read articles of groups.
21776 That's it, really. More functions may be added in the future, but each
21777 added function means an increase in data to be stored, so Gnus will
21778 never be totally undoable.
21780 @findex gnus-undo-mode
21781 @vindex gnus-use-undo
21783 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
21784 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
21785 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
21786 command, which should feel kinda like the normal Emacs @code{undo}
21790 @node Predicate Specifiers
21791 @section Predicate Specifiers
21792 @cindex predicate specifiers
21794 Some Gnus variables are @dfn{predicate specifiers}. This is a special
21795 form that allows flexible specification of predicates without having
21796 to type all that much.
21798 These specifiers are lists consisting of functions, symbols and lists.
21803 (or gnus-article-unseen-p
21804 gnus-article-unread-p)
21807 The available symbols are @code{or}, @code{and} and @code{not}. The
21808 functions all take one parameter.
21810 @findex gnus-make-predicate
21811 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
21812 to create a function that can be called. This input parameter to this
21813 function will be passed along to all the functions in the predicate
21818 @section Moderation
21821 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
21822 It is not included in the standard Gnus package. Write a mail to
21823 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
21826 The moderation package is implemented as a minor mode for summary
21830 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
21833 in your @file{~/.gnus.el} file.
21835 If you are the moderator of @samp{rec.zoofle}, this is how it's
21840 You split your incoming mail by matching on
21841 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
21842 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
21845 You enter that group once in a while and post articles using the @kbd{e}
21846 (edit-and-post) or @kbd{s} (just send unedited) commands.
21849 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
21850 articles that weren't approved by you, you can cancel them with the
21854 To use moderation mode in these two groups, say:
21857 (setq gnus-moderated-list
21858 "^nnml:rec.zoofle$\\|^rec.zoofle$")
21862 @node Image Enhancements
21863 @section Image Enhancements
21865 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
21866 support images yet.}, is able to display pictures and stuff, so Gnus has
21867 taken advantage of that.
21870 * X-Face:: Display a funky, teensy black-and-white image.
21871 * Face:: Display a funkier, teensier colored image.
21872 * Smileys:: Show all those happy faces the way they were meant to be shown.
21873 * Picons:: How to display pictures of what you're reading.
21874 * XVarious:: Other XEmacsy Gnusey variables.
21882 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
21883 depth) image that's supposed to represent the author of the message.
21884 It seems to be supported by an ever-growing number of mail and news
21888 @findex gnus-article-display-x-face
21889 @vindex gnus-article-x-face-command
21890 @vindex gnus-article-x-face-too-ugly
21898 Decoding an @code{X-Face} header either requires an Emacs that has
21899 @samp{compface} support (which most XEmacs versions has), or that you
21900 have @samp{compface} installed on your system. If either is true,
21901 Gnus will default to displaying @code{X-Face} headers.
21903 The variable that controls this is the
21904 @code{gnus-article-x-face-command} variable. If this variable is a
21905 string, this string will be executed in a sub-shell. If it is a
21906 function, this function will be called with the face as the argument.
21907 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
21908 the @code{From} header, the face will not be shown.
21910 The default action under Emacs 20 is to fork off the @code{display}
21911 program@footnote{@code{display} is from the ImageMagick package. For
21912 the @code{uncompface} and @code{icontopbm} programs look for a package
21913 like @code{compface} or @code{faces-xface} on a GNU/Linux system.} to
21916 Under XEmacs or Emacs 21+ with suitable image support, the default
21917 action is to display the face before the @code{From} header. (It's
21918 nicer if XEmacs has been compiled with @code{X-Face} support---that
21919 will make display somewhat faster. If there's no native @code{X-Face}
21920 support, Gnus will try to convert the @code{X-Face} header using
21921 external programs from the @code{pbmplus} package and
21922 friends.@footnote{On a GNU/Linux system look for packages with names
21923 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
21925 (Note: @code{x-face} is used in the variable/function names, not
21933 @vindex gnus-x-face
21934 Face to show X-Face. The colors from this face are used as the
21935 foreground and background colors of the displayed X-Faces. The
21936 default colors are black and white.
21938 @item gnus-face-properties-alist
21939 @vindex gnus-face-properties-alist
21940 Alist of image types and properties applied to Face (@pxref{Face}) and
21941 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
21942 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
21943 XEmacs. Here are examples:
21946 ;; Specify the altitude of Face and X-Face images in the From header.
21947 (setq gnus-face-properties-alist
21948 '((pbm . (:face gnus-x-face :ascent 80))
21949 (png . (:ascent 80))))
21951 ;; Show Face and X-Face images as pressed buttons.
21952 (setq gnus-face-properties-alist
21953 '((pbm . (:face gnus-x-face :relief -2))
21954 (png . (:relief -2))))
21957 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
21958 Reference Manual} for the valid properties for various image types.
21959 Currently, @code{pbm} is used for X-Face images and @code{png} is used
21960 for Face images in Emacs. Only the @code{:face} property is effective
21961 on the @code{xface} image type in XEmacs if it is built with the
21962 @samp{libcompface} library.
21965 Gnus provides a few convenience functions and variables to allow
21966 easier insertion of X-Face headers in outgoing messages.
21968 @findex gnus-random-x-face
21969 @vindex gnus-convert-pbm-to-x-face-command
21970 @vindex gnus-x-face-directory
21971 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
21972 @code{gnus-x-face-directory} and picks one at random, and then
21973 converts it to the X-Face format by using the
21974 @code{gnus-convert-pbm-to-x-face-command} shell command. The
21975 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
21976 header data as a string.
21978 @findex gnus-insert-random-x-face-header
21979 @code{gnus-insert-random-x-face-header} calls
21980 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
21981 randomly generated data.
21983 @findex gnus-x-face-from-file
21984 @vindex gnus-convert-image-to-x-face-command
21985 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
21986 converts the file to X-Face format by using the
21987 @code{gnus-convert-image-to-x-face-command} shell command.
21989 Here's how you would typically use the first function. Put something
21990 like the following in your @file{~/.gnus.el} file:
21993 (setq message-required-news-headers
21994 (nconc message-required-news-headers
21995 (list '(X-Face . gnus-random-x-face))))
21998 Using the last function would be something like this:
22001 (setq message-required-news-headers
22002 (nconc message-required-news-headers
22003 (list '(X-Face . (lambda ()
22004 (gnus-x-face-from-file
22005 "~/My-face.gif"))))))
22013 @c #### FIXME: faces and x-faces'implementations should really be harmonized.
22015 @code{Face} headers are essentially a funkier version of @code{X-Face}
22016 ones. They describe a 48x48 pixel colored image that's supposed to
22017 represent the author of the message.
22020 @findex gnus-article-display-face
22021 The contents of a @code{Face} header must be a base64 encoded PNG image.
22022 See @uref{http://quimby.gnus.org/circus/face/} for the precise
22025 The @code{gnus-face-properties-alist} variable affects the appearance of
22026 displayed Face images. @xref{X-Face}.
22028 Gnus provides a few convenience functions and variables to allow
22029 easier insertion of Face headers in outgoing messages.
22031 @findex gnus-convert-png-to-face
22032 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
22033 726 bytes long, and converts it to a face.
22035 @findex gnus-face-from-file
22036 @vindex gnus-convert-image-to-face-command
22037 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
22038 converts the file to Face format by using the
22039 @code{gnus-convert-image-to-face-command} shell command.
22041 Here's how you would typically use this function. Put something like the
22042 following in your @file{~/.gnus.el} file:
22045 (setq message-required-news-headers
22046 (nconc message-required-news-headers
22047 (list '(Face . (lambda ()
22048 (gnus-face-from-file "~/face.jpg"))))))
22053 @subsection Smileys
22058 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
22063 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
22064 currently the only package that uses Smiley, it is documented here.
22066 In short---to use Smiley in Gnus, put the following in your
22067 @file{~/.gnus.el} file:
22070 (setq gnus-treat-display-smileys t)
22073 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
22074 the like---to pictures and displays those instead of the text smiley
22075 faces. The conversion is controlled by a list of regexps that matches
22076 text and maps that to file names.
22078 @vindex smiley-regexp-alist
22079 The alist used is specified by the @code{smiley-regexp-alist}
22080 variable. The first item in each element is the regexp to be matched;
22081 the second element is the regexp match group that is to be replaced by
22082 the picture; and the third element is the name of the file to be
22085 The following variables customize where Smiley will look for these
22090 @item smiley-data-directory
22091 @vindex smiley-data-directory
22092 Where Smiley will look for smiley faces files.
22094 @item gnus-smiley-file-types
22095 @vindex gnus-smiley-file-types
22096 List of suffixes on smiley file names to try.
22110 So@dots{} You want to slow down your news reader even more! This is a
22111 good way to do so. It's also a great way to impress people staring
22112 over your shoulder as you read news.
22114 What are Picons? To quote directly from the Picons Web site:
22123 @dfn{Picons} is short for ``personal icons''. They're small,
22124 constrained images used to represent users and domains on the net,
22125 organized into databases so that the appropriate image for a given
22126 e-mail address can be found. Besides users and domains, there are picon
22127 databases for Usenet newsgroups and weather forecasts. The picons are
22128 in either monochrome @code{XBM} format or color @code{XPM} and
22129 @code{GIF} formats.
22132 @vindex gnus-picon-databases
22133 For instructions on obtaining and installing the picons databases,
22134 point your Web browser at
22135 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
22137 If you are using Debian GNU/Linux, saying @samp{apt-get install
22138 picons.*} will install the picons where Gnus can find them.
22140 To enable displaying picons, simply make sure that
22141 @code{gnus-picon-databases} points to the directory containing the
22144 The following variables offer control over where things are located.
22148 @item gnus-picon-databases
22149 @vindex gnus-picon-databases
22150 The location of the picons database. This is a list of directories
22151 containing the @file{news}, @file{domains}, @file{users} (and so on)
22152 subdirectories. Defaults to @code{("/usr/lib/picon"
22153 "/usr/local/faces")}.
22155 @item gnus-picon-news-directories
22156 @vindex gnus-picon-news-directories
22157 List of subdirectories to search in @code{gnus-picon-databases} for
22158 newsgroups faces. @code{("news")} is the default.
22160 @item gnus-picon-user-directories
22161 @vindex gnus-picon-user-directories
22162 List of subdirectories to search in @code{gnus-picon-databases} for user
22163 faces. @code{("users" "usenix" "local" "misc")} is the default.
22165 @item gnus-picon-domain-directories
22166 @vindex gnus-picon-domain-directories
22167 List of subdirectories to search in @code{gnus-picon-databases} for
22168 domain name faces. Defaults to @code{("domains")}. Some people may
22169 want to add @samp{"unknown"} to this list.
22171 @item gnus-picon-file-types
22172 @vindex gnus-picon-file-types
22173 Ordered list of suffixes on picon file names to try. Defaults to
22174 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
22180 @subsection Various XEmacs Variables
22183 @item gnus-xmas-glyph-directory
22184 @vindex gnus-xmas-glyph-directory
22185 This is where Gnus will look for pictures. Gnus will normally
22186 auto-detect this directory, but you may set it manually if you have an
22187 unusual directory structure.
22189 @item gnus-xmas-logo-color-alist
22190 @vindex gnus-xmas-logo-color-alist
22191 This is an alist where the key is a type symbol and the values are the
22192 foreground and background color of the splash page glyph.
22194 @item gnus-xmas-logo-color-style
22195 @vindex gnus-xmas-logo-color-style
22196 This is the key used to look up the color in the alist described above.
22197 Valid values include @code{flame}, @code{pine}, @code{moss},
22198 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
22199 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
22201 @item gnus-xmas-modeline-glyph
22202 @vindex gnus-xmas-modeline-glyph
22203 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
22208 @subsubsection Toolbar
22212 @item gnus-use-toolbar
22213 @vindex gnus-use-toolbar
22214 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
22215 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
22216 @code{right-toolbar}, or @code{left-toolbar}.
22218 @item gnus-group-toolbar
22219 @vindex gnus-group-toolbar
22220 The toolbar in the group buffer.
22222 @item gnus-summary-toolbar
22223 @vindex gnus-summary-toolbar
22224 The toolbar in the summary buffer.
22226 @item gnus-summary-mail-toolbar
22227 @vindex gnus-summary-mail-toolbar
22228 The toolbar in the summary buffer of mail groups.
22239 @node Fuzzy Matching
22240 @section Fuzzy Matching
22241 @cindex fuzzy matching
22243 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
22244 things like scoring, thread gathering and thread comparison.
22246 As opposed to regular expression matching, fuzzy matching is very fuzzy.
22247 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
22248 means, and the implementation has changed over time.
22250 Basically, it tries to remove all noise from lines before comparing.
22251 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
22252 out of the strings before comparing the results. This often leads to
22253 adequate results---even when faced with strings generated by text
22254 manglers masquerading as newsreaders.
22257 @node Thwarting Email Spam
22258 @section Thwarting Email Spam
22262 @cindex unsolicited commercial email
22264 In these last days of the Usenet, commercial vultures are hanging about
22265 and grepping through news like crazy to find email addresses they can
22266 foist off their scams and products to. As a reaction to this, many
22267 people have started putting nonsense addresses into their @code{From}
22268 lines. I think this is counterproductive---it makes it difficult for
22269 people to send you legitimate mail in response to things you write, as
22270 well as making it difficult to see who wrote what. This rewriting may
22271 perhaps be a bigger menace than the unsolicited commercial email itself
22274 The biggest problem I have with email spam is that it comes in under
22275 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
22276 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
22277 mail group, only to find two pyramid schemes, seven advertisements
22278 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
22279 and one mail asking me to repent and find some god.
22281 This is annoying. Here's what you can do about it.
22284 * The problem of spam:: Some background, and some solutions
22285 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
22286 * SpamAssassin:: How to use external anti-spam tools.
22287 * Hashcash:: Reduce spam by burning CPU time.
22288 * Filtering Spam Using The Spam ELisp Package::
22289 * Filtering Spam Using Statistics with spam-stat::
22292 @node The problem of spam
22293 @subsection The problem of spam
22295 @cindex spam filtering approaches
22296 @cindex filtering approaches, spam
22298 @cindex unsolicited commercial email
22300 First, some background on spam.
22302 If you have access to e-mail, you are familiar with spam (technically
22303 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
22304 exists because e-mail delivery is very cheap compared to paper mail,
22305 so only a very small percentage of people need to respond to an UCE to
22306 make it worthwhile to the advertiser. Ironically, one of the most
22307 common spams is the one offering a database of e-mail addresses for
22308 further spamming. Senders of spam are usually called @emph{spammers},
22309 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
22310 @emph{morons} are in common use as well.
22312 Spam comes from a wide variety of sources. It is simply impossible to
22313 dispose of all spam without discarding useful messages. A good
22314 example is the TMDA system, which requires senders
22315 unknown to you to confirm themselves as legitimate senders before
22316 their e-mail can reach you. Without getting into the technical side
22317 of TMDA, a downside is clearly that e-mail from legitimate sources may
22318 be discarded if those sources can't or won't confirm themselves
22319 through the TMDA system. Another problem with TMDA is that it
22320 requires its users to have a basic understanding of e-mail delivery
22323 The simplest approach to filtering spam is filtering, at the mail
22324 server or when you sort through incoming mail. If you get 200 spam
22325 messages per day from @samp{random-address@@vmadmin.com}, you block
22326 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
22327 discard all messages with @samp{VIAGRA} in the message. If you get
22328 lots of spam from Bulgaria, for example, you try to filter all mail
22329 from Bulgarian IPs.
22331 This, unfortunately, is a great way to discard legitimate e-mail. The
22332 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
22333 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
22334 you should be obvious, so don't do it if you have the choice.
22336 In another instance, the very informative and useful RISKS digest has
22337 been blocked by overzealous mail filters because it @strong{contained}
22338 words that were common in spam messages. Nevertheless, in isolated
22339 cases, with great care, direct filtering of mail can be useful.
22341 Another approach to filtering e-mail is the distributed spam
22342 processing, for instance DCC implements such a system. In essence,
22343 @var{N} systems around the world agree that a machine @var{X} in
22344 Ghana, Estonia, or California is sending out spam e-mail, and these
22345 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
22346 database. The criteria for spam detection vary---it may be the number
22347 of messages sent, the content of the messages, and so on. When a user
22348 of the distributed processing system wants to find out if a message is
22349 spam, he consults one of those @var{N} systems.
22351 Distributed spam processing works very well against spammers that send
22352 a large number of messages at once, but it requires the user to set up
22353 fairly complicated checks. There are commercial and free distributed
22354 spam processing systems. Distributed spam processing has its risks as
22355 well. For instance legitimate e-mail senders have been accused of
22356 sending spam, and their web sites and mailing lists have been shut
22357 down for some time because of the incident.
22359 The statistical approach to spam filtering is also popular. It is
22360 based on a statistical analysis of previous spam messages. Usually
22361 the analysis is a simple word frequency count, with perhaps pairs of
22362 words or 3-word combinations thrown into the mix. Statistical
22363 analysis of spam works very well in most of the cases, but it can
22364 classify legitimate e-mail as spam in some cases. It takes time to
22365 run the analysis, the full message must be analyzed, and the user has
22366 to store the database of spam analyses. Statistical analysis on the
22367 server is gaining popularity. This has the advantage of letting the
22368 user Just Read Mail, but has the disadvantage that it's harder to tell
22369 the server that it has misclassified mail.
22371 Fighting spam is not easy, no matter what anyone says. There is no
22372 magic switch that will distinguish Viagra ads from Mom's e-mails.
22373 Even people are having a hard time telling spam apart from non-spam,
22374 because spammers are actively looking to fool us into thinking they
22375 are Mom, essentially. Spamming is irritating, irresponsible, and
22376 idiotic behavior from a bunch of people who think the world owes them
22377 a favor. We hope the following sections will help you in fighting the
22380 @node Anti-Spam Basics
22381 @subsection Anti-Spam Basics
22385 @cindex unsolicited commercial email
22387 One way of dealing with spam is having Gnus split out all spam into a
22388 @samp{spam} mail group (@pxref{Splitting Mail}).
22390 First, pick one (1) valid mail address that you can be reached at, and
22391 put it in your @code{From} header of all your news articles. (I've
22392 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
22393 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
22394 sysadmin whether your sendmail installation accepts keywords in the local
22395 part of the mail address.)
22398 (setq message-default-news-headers
22399 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
22402 Then put the following split rule in @code{nnmail-split-fancy}
22403 (@pxref{Fancy Mail Splitting}):
22407 (to "larsi@@trym.ifi.uio.no"
22408 (| ("subject" "re:.*" "misc")
22409 ("references" ".*@@.*" "misc")
22414 This says that all mail to this address is suspect, but if it has a
22415 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
22416 header, it's probably ok. All the rest goes to the @samp{spam} group.
22417 (This idea probably comes from Tim Pierce.)
22419 In addition, many mail spammers talk directly to your @acronym{SMTP} server
22420 and do not include your email address explicitly in the @code{To}
22421 header. Why they do this is unknown---perhaps it's to thwart this
22422 thwarting scheme? In any case, this is trivial to deal with---you just
22423 put anything not addressed to you in the @samp{spam} group by ending
22424 your fancy split rule in this way:
22429 (to "larsi" "misc")
22433 In my experience, this will sort virtually everything into the right
22434 group. You still have to check the @samp{spam} group from time to time to
22435 check for legitimate mail, though. If you feel like being a good net
22436 citizen, you can even send off complaints to the proper authorities on
22437 each unsolicited commercial email---at your leisure.
22439 This works for me. It allows people an easy way to contact me (they can
22440 just press @kbd{r} in the usual way), and I'm not bothered at all with
22441 spam. It's a win-win situation. Forging @code{From} headers to point
22442 to non-existent domains is yucky, in my opinion.
22444 Be careful with this approach. Spammers are wise to it.
22448 @subsection SpamAssassin, Vipul's Razor, DCC, etc
22449 @cindex SpamAssassin
22450 @cindex Vipul's Razor
22453 The days where the hints in the previous section were sufficient in
22454 avoiding spam are coming to an end. There are many tools out there
22455 that claim to reduce the amount of spam you get. This section could
22456 easily become outdated fast, as new products replace old, but
22457 fortunately most of these tools seem to have similar interfaces. Even
22458 though this section will use SpamAssassin as an example, it should be
22459 easy to adapt it to most other tools.
22461 Note that this section does not involve the @code{spam.el} package,
22462 which is discussed in the next section. If you don't care for all
22463 the features of @code{spam.el}, you can make do with these simple
22466 If the tool you are using is not installed on the mail server, you
22467 need to invoke it yourself. Ideas on how to use the
22468 @code{:postscript} mail source parameter (@pxref{Mail Source
22469 Specifiers}) follow.
22473 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
22477 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
22480 Once you manage to process your incoming spool somehow, thus making
22481 the mail contain e.g.@: a header indicating it is spam, you are ready to
22482 filter it out. Using normal split methods (@pxref{Splitting Mail}):
22485 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
22489 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
22492 (setq nnmail-split-methods 'nnmail-split-fancy
22493 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
22497 Some people might not like the idea of piping the mail through various
22498 programs using a @code{:prescript} (if some program is buggy, you
22499 might lose all mail). If you are one of them, another solution is to
22500 call the external tools during splitting. Example fancy split method:
22503 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
22505 (defun kevin-spamassassin ()
22509 (if (eq 1 (call-process-region (point-min) (point-max)
22510 "spamc" nil nil nil "-c"))
22514 Note that with the nnimap back end, message bodies will not be
22515 downloaded by default. You need to set
22516 @code{nnimap-split-download-body} to @code{t} to do that
22517 (@pxref{Splitting in IMAP}).
22519 That is about it. As some spam is likely to get through anyway, you
22520 might want to have a nifty function to call when you happen to read
22521 spam. And here is the nifty function:
22524 (defun my-gnus-raze-spam ()
22525 "Submit SPAM to Vipul's Razor, then mark it as expirable."
22527 (gnus-summary-show-raw-article)
22528 (gnus-summary-save-in-pipe "razor-report -f -d")
22529 (gnus-summary-mark-as-expirable 1))
22533 @subsection Hashcash
22536 A novel technique to fight spam is to require senders to do something
22537 costly and demonstrably unique for each message they send. This has
22538 the obvious drawback that you cannot rely on everyone in the world
22539 using this technique, since it is not part of the Internet standards,
22540 but it may be useful in smaller communities.
22542 While the tools in the previous section work well in practice, they
22543 work only because the tools are constantly maintained and updated as
22544 new form of spam appears. This means that a small percentage of spam
22545 will always get through. It also means that somewhere, someone needs
22546 to read lots of spam to update these tools. Hashcash avoids that, but
22547 instead prefers that everyone you contact through e-mail supports the
22548 scheme. You can view the two approaches as pragmatic vs dogmatic.
22549 The approaches have their own advantages and disadvantages, but as
22550 often in the real world, a combination of them is stronger than either
22551 one of them separately.
22554 The ``something costly'' is to burn CPU time, more specifically to
22555 compute a hash collision up to a certain number of bits. The
22556 resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header.
22557 For more details, and for the external application @code{hashcash} you
22558 need to install to use this feature, see
22559 @uref{http://www.hashcash.org/}. Even more information can be found
22560 at @uref{http://www.camram.org/}.
22562 If you wish to generate hashcash for each message you send, you can
22563 customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail
22564 Headers,message, The Message Manual}), as in:
22567 (setq message-generate-hashcash t)
22570 You will need to set up some additional variables as well:
22574 @item hashcash-default-payment
22575 @vindex hashcash-default-payment
22576 This variable indicates the default number of bits the hash collision
22577 should consist of. By default this is 20. Suggested useful values
22580 @item hashcash-payment-alist
22581 @vindex hashcash-payment-alist
22582 Some receivers may require you to spend burn more CPU time than the
22583 default. This variable contains a list of @samp{(@var{addr}
22584 @var{amount})} cells, where @var{addr} is the receiver (email address
22585 or newsgroup) and @var{amount} is the number of bits in the collision
22586 that is needed. It can also contain @samp{(@var{addr} @var{string}
22587 @var{amount})} cells, where the @var{string} is the string to use
22588 (normally the email address or newsgroup name is used).
22590 @item hashcash-path
22591 @vindex hashcash-path
22592 Where the @code{hashcash} binary is installed. This variable should
22593 be automatically set by @code{executable-find}, but if it's @code{nil}
22594 (usually because the @code{hashcash} binary is not in your path)
22595 you'll get a warning when you check hashcash payments and an error
22596 when you generate hashcash payments.
22600 Gnus can verify hashcash cookies, although this can also be done by
22601 hand customized mail filtering scripts. To verify a hashcash cookie
22602 in a message, use the @code{mail-check-payment} function in the
22603 @code{hashcash.el} library. You can also use the @code{spam.el}
22604 package with the @code{spam-use-hashcash} back end to validate hashcash
22605 cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam
22606 Hashcash Payments}).
22608 @node Filtering Spam Using The Spam ELisp Package
22609 @subsection Filtering Spam Using The Spam ELisp Package
22610 @cindex spam filtering
22613 The idea behind @code{spam.el} is to have a control center for spam detection
22614 and filtering in Gnus. To that end, @code{spam.el} does two things: it
22615 filters new mail, and it analyzes mail known to be spam or ham.
22616 @dfn{Ham} is the name used throughout @code{spam.el} to indicate
22619 Make sure you read the section on the @code{spam.el} sequence of
22620 events. See @xref{Spam ELisp Package Sequence of Events}.
22622 To use @code{spam.el}, you @strong{must} run the function
22623 @code{spam-initialize} to autoload @code{spam.el} and to install the
22624 @code{spam.el} hooks. There is one exception: if you use the
22625 @code{spam-use-stat} (@pxref{spam-stat spam filtering}) setting, you
22626 should turn it on before @code{spam-initialize}:
22629 (setq spam-use-stat t) ;; if needed
22633 So, what happens when you load @code{spam.el}?
22635 First, some hooks will get installed by @code{spam-initialize}. There
22636 are some hooks for @code{spam-stat} so it can save its databases, and
22637 there are hooks so interesting things will happen when you enter and
22638 leave a group. More on the sequence of events later (@pxref{Spam
22639 ELisp Package Sequence of Events}).
22641 You get the following keyboard commands:
22651 @findex gnus-summary-mark-as-spam
22652 @code{gnus-summary-mark-as-spam}.
22654 Mark current article as spam, showing it with the @samp{$} mark.
22655 Whenever you see a spam article, make sure to mark its summary line
22656 with @kbd{M-d} before leaving the group. This is done automatically
22657 for unread articles in @emph{spam} groups.
22663 @findex spam-bogofilter-score
22664 @code{spam-bogofilter-score}.
22666 You must have Bogofilter installed for that command to work properly.
22672 Also, when you load @code{spam.el}, you will be able to customize its
22673 variables. Try @code{customize-group} on the @samp{spam} variable
22677 * Spam ELisp Package Sequence of Events::
22678 * Spam ELisp Package Filtering of Incoming Mail::
22679 * Spam ELisp Package Global Variables::
22680 * Spam ELisp Package Sorting and Score Display in Summary Buffer::
22681 * Spam ELisp Package Configuration Examples::
22682 * Blacklists and Whitelists::
22683 * BBDB Whitelists::
22684 * Gmane Spam Reporting::
22685 * Anti-spam Hashcash Payments::
22687 * Regular Expressions Header Matching::
22689 * SpamAssassin back end::
22690 * ifile spam filtering::
22691 * spam-stat spam filtering::
22693 * Extending the Spam ELisp package::
22696 @node Spam ELisp Package Sequence of Events
22697 @subsubsection Spam ELisp Package Sequence of Events
22698 @cindex spam filtering
22699 @cindex spam filtering sequence of events
22701 You must read this section to understand how @code{spam.el} works.
22702 Do not skip, speed-read, or glance through this section.
22704 There are two @emph{contact points}, if you will, between
22705 @code{spam.el} and the rest of Gnus: checking new mail for spam, and
22708 Getting new mail in Gnus is done in one of two ways. You can either
22709 split your incoming mail or you can classify new articles as ham or
22710 spam when you enter the group.
22712 Splitting incoming mail is better suited to mail back ends such as
22713 @code{nnml} or @code{nnimap} where new mail appears in a single file
22714 called a @dfn{Spool File}. See @xref{Spam ELisp Package Filtering of
22717 @vindex gnus-spam-autodetect
22718 @vindex gnus-spam-autodetect-methods
22719 For back ends such as @code{nntp} there is no incoming mail spool, so
22720 an alternate mechanism must be used. This may also happen for
22721 back ends where the server is in charge of splitting incoming mail, and
22722 Gnus does not do further splitting. The @code{spam-autodetect} and
22723 @code{spam-autodetect-methods} group parameters (accessible with
22724 @kbd{G c} and @kbd{G p} as usual), and the corresponding variables
22725 @code{gnus-spam-autodetect} and @code{gnus-spam-autodetect-methods}
22726 (accessible with @kbd{M-x customize-variable} as usual) can help.
22728 When @code{spam-autodetect} is used (you can turn it on for a
22729 group/topic or wholesale by regular expression matches, as needed), it
22730 hooks into the process of entering a group. Thus, entering a group
22731 with unseen or unread articles becomes the substitute for checking
22732 incoming mail. Whether only unseen articles or all unread articles
22733 will be processed is determined by the
22734 @code{spam-autodetect-recheck-messages}. When set to @code{t}, unread
22735 messages will be rechecked. You should probably stick with the
22736 default of only checking unseen messages.
22738 @code{spam-autodetect} grants the user at once more and less control
22739 of spam filtering. The user will have more control over each group's
22740 spam methods, so for instance the @samp{ding} group may have
22741 @code{spam-use-BBDB} as the autodetection method, while the
22742 @samp{suspect} group may have the @code{spam-use-blacklist} and
22743 @code{spam-use-bogofilter} methods enabled. Every article detected to
22744 be spam will be marked with the spam mark @samp{$} and processed on
22745 exit from the group as normal spam. The user has less control over
22746 the @emph{sequence} of checks, as he might with @code{spam-split}.
22748 When the newly split mail goes into groups, or messages are
22749 autodetected to be ham or spam, those groups must be exited (after
22750 entering, if needed) for further spam processing to happen. It
22751 matters whether the group is considered a ham group, a spam group, or
22752 is unclassified, based on its @code{spam-content} parameter
22753 (@pxref{Spam ELisp Package Global Variables}). Spam groups have the
22754 additional characteristic that, when entered, any unseen or unread
22755 articles (depending on the @code{spam-mark-only-unseen-as-spam}
22756 variable) will be marked as spam. Thus, mail split into a spam group
22757 gets automatically marked as spam when you enter the group.
22759 Thus, when you exit a group, the @code{spam-processors} are applied,
22760 if any are set, and the processed mail is moved to the
22761 @code{ham-process-destination} or the @code{spam-process-destination}
22762 depending on the article's classification. If the
22763 @code{ham-process-destination} or the @code{spam-process-destination},
22764 whichever is appropriate, are @code{nil}, the article is left in the
22767 If a spam is found in any group (this can be changed to only non-spam
22768 groups with @code{spam-move-spam-nonspam-groups-only}), it is
22769 processed by the active @code{spam-processors} (@pxref{Spam ELisp
22770 Package Global Variables}) when the group is exited. Furthermore, the
22771 spam is moved to the @code{spam-process-destination} (@pxref{Spam
22772 ELisp Package Global Variables}) for further training or deletion.
22773 You have to load the @code{gnus-registry.el} package and enable the
22774 @code{spam-log-to-registry} variable if you want spam to be processed
22775 no more than once. Thus, spam is detected and processed everywhere,
22776 which is what most people want. If the
22777 @code{spam-process-destination} is @code{nil}, the spam is marked as
22778 expired, which is usually the right thing to do.
22780 If spam can not be moved---because of a read-only back end such as
22781 @acronym{NNTP}, for example, it will be copied.
22783 If a ham mail is found in a ham group, as determined by the
22784 @code{ham-marks} parameter, it is processed as ham by the active ham
22785 @code{spam-processor} when the group is exited. With the variables
22786 @code{spam-process-ham-in-spam-groups} and
22787 @code{spam-process-ham-in-nonham-groups} the behavior can be further
22788 altered so ham found anywhere can be processed. You have to load the
22789 @code{gnus-registry.el} package and enable the
22790 @code{spam-log-to-registry} variable if you want ham to be processed
22791 no more than once. Thus, ham is detected and processed only when
22792 necessary, which is what most people want. More on this in
22793 @xref{Spam ELisp Package Configuration Examples}.
22795 If ham can not be moved---because of a read-only back end such as
22796 @acronym{NNTP}, for example, it will be copied.
22798 If all this seems confusing, don't worry. Soon it will be as natural
22799 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
22800 50 years in the future yet. Just trust us, it's not so bad.
22802 @node Spam ELisp Package Filtering of Incoming Mail
22803 @subsubsection Spam ELisp Package Filtering of Incoming Mail
22804 @cindex spam filtering
22805 @cindex spam filtering incoming mail
22808 To use the @code{spam.el} facilities for incoming mail filtering, you
22809 must add the following to your fancy split list
22810 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
22816 Note that the fancy split may be called @code{nnmail-split-fancy} or
22817 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
22818 nnimap back ends to retrieve your mail.
22820 Also, @code{spam-split} will not modify incoming mail in any way.
22822 The @code{spam-split} function will process incoming mail and send the
22823 mail considered to be spam into the group name given by the variable
22824 @code{spam-split-group}. By default that group name is @samp{spam},
22825 but you can customize @code{spam-split-group}. Make sure the contents
22826 of @code{spam-split-group} are an @emph{unqualified} group name, for
22827 instance in an @code{nnimap} server @samp{your-server} the value
22828 @samp{spam} will turn out to be @samp{nnimap+your-server:spam}. The
22829 value @samp{nnimap+server:spam}, therefore, is wrong and will
22830 actually give you the group
22831 @samp{nnimap+your-server:nnimap+server:spam} which may or may not
22832 work depending on your server's tolerance for strange group names.
22834 You can also give @code{spam-split} a parameter,
22835 e.g. @code{spam-use-regex-headers} or @code{"maybe-spam"}. Why is
22838 Take these split rules (with @code{spam-use-regex-headers} and
22839 @code{spam-use-blackholes} set):
22842 nnimap-split-fancy '(|
22843 (any "ding" "ding")
22845 ;; @r{default mailbox}
22849 Now, the problem is that you want all ding messages to make it to the
22850 ding folder. But that will let obvious spam (for example, spam
22851 detected by SpamAssassin, and @code{spam-use-regex-headers}) through,
22852 when it's sent to the ding list. On the other hand, some messages to
22853 the ding list are from a mail server in the blackhole list, so the
22854 invocation of @code{spam-split} can't be before the ding rule.
22856 You can let SpamAssassin headers supersede ding rules, but all other
22857 @code{spam-split} rules (including a second invocation of the
22858 regex-headers check) will be after the ding rule:
22863 ;; @r{all spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
22864 (: spam-split "regex-spam" 'spam-use-regex-headers)
22865 (any "ding" "ding")
22866 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
22868 ;; @r{default mailbox}
22872 This lets you invoke specific @code{spam-split} checks depending on
22873 your particular needs, and to target the results of those checks to a
22874 particular spam group. You don't have to throw all mail into all the
22875 spam tests. Another reason why this is nice is that messages to
22876 mailing lists you have rules for don't have to have resource-intensive
22877 blackhole checks performed on them. You could also specify different
22878 spam checks for your nnmail split vs. your nnimap split. Go crazy.
22880 You should still have specific checks such as
22881 @code{spam-use-regex-headers} set to @code{t}, even if you
22882 specifically invoke @code{spam-split} with the check. The reason is
22883 that when loading @code{spam.el}, some conditional loading is done
22884 depending on what @code{spam-use-xyz} variables you have set. This
22885 is usually not critical, though.
22887 @emph{Note for IMAP users}
22889 The boolean variable @code{nnimap-split-download-body} needs to be
22890 set, if you want to split based on the whole message instead of just
22891 the headers. By default, the nnimap back end will only retrieve the
22892 message headers. If you use a @emph{statistical} filter,
22893 e.g. @code{spam-check-bogofilter}, @code{spam-check-ifile}, or
22894 @code{spam-check-stat} (the splitters that can benefit from the full
22895 message body), this variable will be set automatically. It is not set
22896 for non-statistical back ends by default because it will slow
22897 @acronym{IMAP} down.
22899 @xref{Splitting in IMAP}.
22901 @node Spam ELisp Package Global Variables
22902 @subsubsection Spam ELisp Package Global Variables
22903 @cindex spam filtering
22904 @cindex spam filtering variables
22905 @cindex spam variables
22908 @vindex gnus-spam-process-newsgroups
22909 The concepts of ham processors and spam processors are very important.
22910 Ham processors and spam processors for a group can be set with the
22911 @code{spam-process} group parameter, or the
22912 @code{gnus-spam-process-newsgroups} variable. Ham processors take
22913 mail known to be non-spam (@emph{ham}) and process it in some way so
22914 that later similar mail will also be considered non-spam. Spam
22915 processors take mail known to be spam and process it so similar spam
22916 will be detected later.
22918 The format of the spam or ham processor entry used to be a symbol,
22919 but now it is a @sc{cons} cell. See the individual spam processor entries
22920 for more information.
22922 @vindex gnus-spam-newsgroup-contents
22923 Gnus learns from the spam you get. You have to collect your spam in
22924 one or more spam groups, and set or customize the variable
22925 @code{spam-junk-mailgroups} as appropriate. You can also declare
22926 groups to contain spam by setting their group parameter
22927 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
22928 by customizing the corresponding variable
22929 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
22930 parameter and the @code{gnus-spam-newsgroup-contents} variable can
22931 also be used to declare groups as @emph{ham} groups if you set their
22932 classification to @code{gnus-group-spam-classification-ham}. If
22933 groups are not classified by means of @code{spam-junk-mailgroups},
22934 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
22935 considered @emph{unclassified}. All groups are unclassified by
22938 @vindex gnus-spam-mark
22940 In spam groups, all messages are considered to be spam by default:
22941 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
22942 group. If you have seen a message, had it marked as spam, then
22943 unmarked it, it won't be marked as spam when you enter the group
22944 thereafter. You can disable that behavior, so all unread messages
22945 will get the @samp{$} mark, if you set the
22946 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
22947 should remove the @samp{$} mark when you are in the group summary
22948 buffer for every message that is not spam after all. To remove the
22949 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
22950 @kbd{d} for declaring it read the non-spam way. When you leave a
22951 group, all spam-marked (@samp{$}) articles are sent to a spam
22952 processor which will study them as spam samples.
22954 Messages may also be deleted in various other ways, and unless
22955 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
22956 and @samp{r} for default read or explicit delete, marks @samp{X} and
22957 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
22958 low scores, are all considered to be associated with articles which
22959 are not spam. This assumption might be false, in particular if you
22960 use kill files or score files as means for detecting genuine spam, you
22961 should then adjust the @code{ham-marks} group parameter.
22964 You can customize this group or topic parameter to be the list of
22965 marks you want to consider ham. By default, the list contains the
22966 deleted, read, killed, kill-filed, and low-score marks (the idea is
22967 that these articles have been read, but are not spam). It can be
22968 useful to also include the tick mark in the ham marks. It is not
22969 recommended to make the unread mark a ham mark, because it normally
22970 indicates a lack of classification. But you can do it, and we'll be
22975 You can customize this group or topic parameter to be the list of
22976 marks you want to consider spam. By default, the list contains only
22977 the spam mark. It is not recommended to change that, but you can if
22978 you really want to.
22981 When you leave @emph{any} group, regardless of its
22982 @code{spam-contents} classification, all spam-marked articles are sent
22983 to a spam processor, which will study these as spam samples. If you
22984 explicit kill a lot, you might sometimes end up with articles marked
22985 @samp{K} which you never saw, and which might accidentally contain
22986 spam. Best is to make sure that real spam is marked with @samp{$},
22989 @vindex gnus-ham-process-destinations
22990 When you leave a @emph{spam} group, all spam-marked articles are
22991 marked as expired after processing with the spam processor. This is
22992 not done for @emph{unclassified} or @emph{ham} groups. Also, any
22993 @strong{ham} articles in a spam group will be moved to a location
22994 determined by either the @code{ham-process-destination} group
22995 parameter or a match in the @code{gnus-ham-process-destinations}
22996 variable, which is a list of regular expressions matched with group
22997 names (it's easiest to customize this variable with @kbd{M-x
22998 customize-variable @key{RET} gnus-ham-process-destinations}). Each
22999 group name list is a standard Lisp list, if you prefer to customize
23000 the variable manually. If the @code{ham-process-destination}
23001 parameter is not set, ham articles are left in place. If the
23002 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
23003 set, the ham articles are marked as unread before being moved.
23005 If ham can not be moved---because of a read-only back end such as
23006 @acronym{NNTP}, for example, it will be copied.
23008 Note that you can use multiples destinations per group or regular
23009 expression! This enables you to send your ham to a regular mail
23010 group and to a @emph{ham training} group.
23012 When you leave a @emph{ham} group, all ham-marked articles are sent to
23013 a ham processor, which will study these as non-spam samples.
23015 @vindex spam-process-ham-in-spam-groups
23016 By default the variable @code{spam-process-ham-in-spam-groups} is
23017 @code{nil}. Set it to @code{t} if you want ham found in spam groups
23018 to be processed. Normally this is not done, you are expected instead
23019 to send your ham to a ham group and process it there.
23021 @vindex spam-process-ham-in-nonham-groups
23022 By default the variable @code{spam-process-ham-in-nonham-groups} is
23023 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
23024 or unclassified) groups to be processed. Normally this is not done,
23025 you are expected instead to send your ham to a ham group and process
23028 @vindex gnus-spam-process-destinations
23029 When you leave a @emph{ham} or @emph{unclassified} group, all
23030 @strong{spam} articles are moved to a location determined by either
23031 the @code{spam-process-destination} group parameter or a match in the
23032 @code{gnus-spam-process-destinations} variable, which is a list of
23033 regular expressions matched with group names (it's easiest to
23034 customize this variable with @kbd{M-x customize-variable @key{RET}
23035 gnus-spam-process-destinations}). Each group name list is a standard
23036 Lisp list, if you prefer to customize the variable manually. If the
23037 @code{spam-process-destination} parameter is not set, the spam
23038 articles are only expired. The group name is fully qualified, meaning
23039 that if you see @samp{nntp:servername} before the group name in the
23040 group buffer then you need it here as well.
23042 If spam can not be moved---because of a read-only back end such as
23043 @acronym{NNTP}, for example, it will be copied.
23045 Note that you can use multiples destinations per group or regular
23046 expression! This enables you to send your spam to multiple @emph{spam
23049 @vindex spam-log-to-registry
23050 The problem with processing ham and spam is that Gnus doesn't track
23051 this processing by default. Enable the @code{spam-log-to-registry}
23052 variable so @code{spam.el} will use @code{gnus-registry.el} to track
23053 what articles have been processed, and avoid processing articles
23054 multiple times. Keep in mind that if you limit the number of registry
23055 entries, this won't work as well as it does without a limit.
23057 @vindex spam-mark-only-unseen-as-spam
23058 Set this variable if you want only unseen articles in spam groups to
23059 be marked as spam. By default, it is set. If you set it to
23060 @code{nil}, unread articles will also be marked as spam.
23062 @vindex spam-mark-ham-unread-before-move-from-spam-group
23063 Set this variable if you want ham to be unmarked before it is moved
23064 out of the spam group. This is very useful when you use something
23065 like the tick mark @samp{!} to mark ham---the article will be placed
23066 in your @code{ham-process-destination}, unmarked as if it came fresh
23067 from the mail server.
23069 @vindex spam-autodetect-recheck-messages
23070 When autodetecting spam, this variable tells @code{spam.el} whether
23071 only unseen articles or all unread articles should be checked for
23072 spam. It is recommended that you leave it off.
23074 @node Spam ELisp Package Sorting and Score Display in Summary Buffer
23075 @subsubsection Spam ELisp Package Sorting and Score Display in Summary Buffer
23076 @cindex spam scoring
23077 @cindex spam sorting
23078 @cindex spam score summary buffer
23079 @cindex spam sort summary buffer
23082 You can display the spam score of articles in your summary buffer, and
23083 you can sort articles by their spam score.
23085 First you need to decide which back end you will be using. If you use
23086 the @code{spam-use-spamassassin},
23087 @code{spam-use-spamassassin-headers}, or @code{spam-use-regex-headers}
23088 back end, the @code{X-Spam-Status} header will be used. If you use
23089 @code{spam-use-bogofilter}, the @code{X-Bogosity} header will be used.
23090 If you use @code{spam-use-crm114}, any header that matches the CRM114
23091 score format will be used. As long as you set the appropriate back end
23092 variable to t @emph{before} you load @code{spam.el}, you will be
23093 fine. @code{spam.el} will automatically add the right header to the
23094 internal Gnus list of required headers.
23096 To show the spam score in your summary buffer, add this line to your
23097 @code{gnus.el} file (note @code{spam.el} does not do that by default
23098 so it won't override any existing @code{S} formats you may have).
23101 (defalias 'gnus-user-format-function-S 'spam-user-format-function-S)
23104 Now just set your summary line format to use @code{%uS}. Here's an
23105 example that formats the spam score in a 5-character field:
23108 (setq gnus-summary-line-format
23109 "%U%R %10&user-date; $%5uS %6k %B %(%4L: %*%-25,25a%) %s \n")
23112 Finally, to sort by spam status, either do it globally:
23116 gnus-show-threads nil
23117 gnus-article-sort-functions
23118 '(spam-article-sort-by-spam-status))
23121 or per group (@pxref{Sorting the Summary Buffer}).
23123 @node Spam ELisp Package Configuration Examples
23124 @subsubsection Spam ELisp Package Configuration Examples
23125 @cindex spam filtering
23126 @cindex spam filtering configuration examples
23127 @cindex spam configuration examples
23130 @subsubheading Ted's setup
23132 From Ted Zlatanov <tzz@@lifelogs.com>.
23134 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
23135 ;; @r{see @file{gnus-registry.el} for more information}
23136 (gnus-registry-initialize)
23139 ;; @r{I like @kbd{C-s} for marking spam}
23140 (define-key gnus-summary-mode-map "\C-s" 'gnus-summary-mark-as-spam)
23143 spam-log-to-registry t ; @r{for spam autodetection}
23145 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
23146 ;; @r{all groups with @samp{spam} in the name contain spam}
23147 gnus-spam-newsgroup-contents
23148 '(("spam" gnus-group-spam-classification-spam))
23149 ;; @r{see documentation for these}
23150 spam-move-spam-nonspam-groups-only nil
23151 spam-mark-only-unseen-as-spam t
23152 spam-mark-ham-unread-before-move-from-spam-group t
23153 nnimap-split-rule 'nnimap-split-fancy
23154 ;; @r{understand what this does before you copy it to your own setup!}
23155 nnimap-split-fancy '(|
23156 ;; @r{trace references to parents and put in their group}
23157 (: gnus-registry-split-fancy-with-parent)
23158 ;; @r{this will catch server-side SpamAssassin tags}
23159 (: spam-split 'spam-use-regex-headers)
23160 (any "ding" "ding")
23161 ;; @r{note that spam by default will go to @samp{spam}}
23163 ;; @r{default mailbox}
23166 ;; @r{my parameters, set with @kbd{G p}}
23168 ;; @r{all nnml groups, and all nnimap groups except}
23169 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
23170 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
23171 ;; @r{because it must have been detected manually}
23173 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23175 ;; @r{all @acronym{NNTP} groups}
23176 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
23177 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
23178 ;; @r{send all spam to the training group}
23179 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23181 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
23182 ((spam-autodetect . t))
23184 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
23186 ;; @r{this is a spam group}
23187 ((spam-contents gnus-group-spam-classification-spam)
23189 ;; @r{any spam (which happens when I enter for all unseen messages,}
23190 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
23191 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
23193 (spam-process-destination "nnimap+mail.lifelogs.com:train")
23195 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
23196 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
23198 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
23199 "nnimap+mail.lifelogs.com:trainham")
23200 ;; @r{in this group, only @samp{!} marks are ham}
23202 (gnus-ticked-mark))
23203 ;; @r{remembers senders in the blacklist on the way out---this is}
23204 ;; @r{definitely not needed, it just makes me feel better}
23205 (spam-process (gnus-group-spam-exit-processor-blacklist)))
23207 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
23208 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
23209 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
23213 @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server
23214 From Reiner Steib <reiner.steib@@gmx.de>.
23216 My provider has set up bogofilter (in combination with @acronym{DCC}) on
23217 the mail server (@acronym{IMAP}). Recognized spam goes to
23218 @samp{spam.detected}, the rest goes through the normal filter rules,
23219 i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
23220 positives or negatives is done by copying or moving the article to
23221 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
23222 the server feeds those to bogofilter with the suitable ham or spam
23223 options and deletes them from the @samp{training.ham} and
23224 @samp{training.spam} folders.
23226 With the following entries in @code{gnus-parameters}, @code{spam.el}
23227 does most of the job for me:
23230 ("nnimap:spam\\.detected"
23231 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
23232 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
23233 (spam-contents gnus-group-spam-classification-spam))
23234 ("nnimap:\\(INBOX\\|other-folders\\)"
23235 (spam-process-destination . "nnimap:training.spam")
23236 (spam-contents gnus-group-spam-classification-ham))
23241 @item @b{The Spam folder:}
23243 In the folder @samp{spam.detected}, I have to check for false positives
23244 (i.e. legitimate mails, that were wrongly judged as spam by
23245 bogofilter or DCC).
23247 Because of the @code{gnus-group-spam-classification-spam} entry, all
23248 messages are marked as spam (with @code{$}). When I find a false
23249 positive, I mark the message with some other ham mark (@code{ham-marks},
23250 @ref{Spam ELisp Package Global Variables}). On group exit, those
23251 messages are copied to both groups, @samp{INBOX} (where I want to have
23252 the article) and @samp{training.ham} (for training bogofilter) and
23253 deleted from the @samp{spam.detected} folder.
23255 The @code{gnus-article-sort-by-chars} entry simplifies detection of
23256 false positives for me. I receive lots of worms (sweN, @dots{}), that all
23257 have a similar size. Grouping them by size (i.e. chars) makes finding
23258 other false positives easier. (Of course worms aren't @i{spam}
23259 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
23260 an excellent tool for filtering those unwanted mails for me.)
23262 @item @b{Ham folders:}
23264 In my ham folders, I just hit @kbd{S x}
23265 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
23266 mail (false negative). On group exit, those messages are moved to
23267 @samp{training.ham}.
23270 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
23272 From Reiner Steib <reiner.steib@@gmx.de>.
23274 With following entry in @code{gnus-parameters}, @kbd{S x}
23275 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
23276 groups as spam and reports the to Gmane at group exit:
23280 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
23283 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
23284 because I don't read the groups directly from news.gmane.org, but
23285 through my local news server (leafnode). I.e. the article numbers are
23286 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
23287 the @code{X-Report-Spam} header to find the correct number.
23289 @node Blacklists and Whitelists
23290 @subsubsection Blacklists and Whitelists
23291 @cindex spam filtering
23292 @cindex whitelists, spam filtering
23293 @cindex blacklists, spam filtering
23296 @defvar spam-use-blacklist
23298 Set this variable to @code{t} if you want to use blacklists when
23299 splitting incoming mail. Messages whose senders are in the blacklist
23300 will be sent to the @code{spam-split-group}. This is an explicit
23301 filter, meaning that it acts only on mail senders @emph{declared} to
23306 @defvar spam-use-whitelist
23308 Set this variable to @code{t} if you want to use whitelists when
23309 splitting incoming mail. Messages whose senders are not in the
23310 whitelist will be sent to the next spam-split rule. This is an
23311 explicit filter, meaning that unless someone is in the whitelist, their
23312 messages are not assumed to be spam or ham.
23316 @defvar spam-use-whitelist-exclusive
23318 Set this variable to @code{t} if you want to use whitelists as an
23319 implicit filter, meaning that every message will be considered spam
23320 unless the sender is in the whitelist. Use with care.
23324 @defvar gnus-group-spam-exit-processor-blacklist
23326 Add this symbol to a group's @code{spam-process} parameter by
23327 customizing the group parameters or the
23328 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23329 added to a group's @code{spam-process} parameter, the senders of
23330 spam-marked articles will be added to the blacklist.
23334 Instead of the obsolete
23335 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
23336 that you use @code{'(spam spam-use-blacklist)}. Everything will work
23337 the same way, we promise.
23341 @defvar gnus-group-ham-exit-processor-whitelist
23343 Add this symbol to a group's @code{spam-process} parameter by
23344 customizing the group parameters or the
23345 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23346 added to a group's @code{spam-process} parameter, the senders of
23347 ham-marked articles in @emph{ham} groups will be added to the
23352 Instead of the obsolete
23353 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
23354 that you use @code{'(ham spam-use-whitelist)}. Everything will work
23355 the same way, we promise.
23359 Blacklists are lists of regular expressions matching addresses you
23360 consider to be spam senders. For instance, to block mail from any
23361 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
23362 blacklist. You start out with an empty blacklist. Blacklist entries
23363 use the Emacs regular expression syntax.
23365 Conversely, whitelists tell Gnus what addresses are considered
23366 legitimate. All messages from whitelisted addresses are considered
23367 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
23368 Emacs regular expression syntax.
23370 The blacklist and whitelist file locations can be customized with the
23371 @code{spam-directory} variable (@file{~/News/spam} by default), or
23372 the @code{spam-whitelist} and @code{spam-blacklist} variables
23373 directly. The whitelist and blacklist files will by default be in the
23374 @code{spam-directory} directory, named @file{whitelist} and
23375 @file{blacklist} respectively.
23377 @node BBDB Whitelists
23378 @subsubsection BBDB Whitelists
23379 @cindex spam filtering
23380 @cindex BBDB whitelists, spam filtering
23381 @cindex BBDB, spam filtering
23384 @defvar spam-use-BBDB
23386 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
23387 Whitelists}), but uses the BBDB as the source of whitelisted
23388 addresses, without regular expressions. You must have the BBDB loaded
23389 for @code{spam-use-BBDB} to work properly. Messages whose senders are
23390 not in the BBDB will be sent to the next spam-split rule. This is an
23391 explicit filter, meaning that unless someone is in the BBDB, their
23392 messages are not assumed to be spam or ham.
23396 @defvar spam-use-BBDB-exclusive
23398 Set this variable to @code{t} if you want to use the BBDB as an
23399 implicit filter, meaning that every message will be considered spam
23400 unless the sender is in the BBDB. Use with care. Only sender
23401 addresses in the BBDB will be allowed through; all others will be
23402 classified as spammers.
23404 While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias
23405 for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is
23406 @emph{not} a separate back end. If you set
23407 @code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting
23412 @defvar gnus-group-ham-exit-processor-BBDB
23414 Add this symbol to a group's @code{spam-process} parameter by
23415 customizing the group parameters or the
23416 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23417 added to a group's @code{spam-process} parameter, the senders of
23418 ham-marked articles in @emph{ham} groups will be added to the
23423 Instead of the obsolete
23424 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
23425 that you use @code{'(ham spam-use-BBDB)}. Everything will work
23426 the same way, we promise.
23430 @node Gmane Spam Reporting
23431 @subsubsection Gmane Spam Reporting
23432 @cindex spam reporting
23433 @cindex Gmane, spam reporting
23434 @cindex Gmane, spam reporting
23437 @defvar gnus-group-spam-exit-processor-report-gmane
23439 Add this symbol to a group's @code{spam-process} parameter by
23440 customizing the group parameters or the
23441 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23442 added to a group's @code{spam-process} parameter, the spam-marked
23443 articles groups will be reported to the Gmane administrators via a
23446 Gmane can be found at @uref{http://gmane.org}.
23450 Instead of the obsolete
23451 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
23452 that you use @code{'(spam spam-use-gmane)}. Everything will work the
23453 same way, we promise.
23457 @defvar spam-report-gmane-use-article-number
23459 This variable is @code{t} by default. Set it to @code{nil} if you are
23460 running your own news server, for instance, and the local article
23461 numbers don't correspond to the Gmane article numbers. When
23462 @code{spam-report-gmane-use-article-number} is @code{nil},
23463 @code{spam-report.el} will use the @code{X-Report-Spam} header that
23468 @node Anti-spam Hashcash Payments
23469 @subsubsection Anti-spam Hashcash Payments
23470 @cindex spam filtering
23471 @cindex hashcash, spam filtering
23474 @defvar spam-use-hashcash
23476 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
23477 Whitelists}), but uses hashcash tokens for whitelisting messages
23478 instead of the sender address. Messages without a hashcash payment
23479 token will be sent to the next spam-split rule. This is an explicit
23480 filter, meaning that unless a hashcash token is found, the messages
23481 are not assumed to be spam or ham.
23486 @subsubsection Blackholes
23487 @cindex spam filtering
23488 @cindex blackholes, spam filtering
23491 @defvar spam-use-blackholes
23493 This option is disabled by default. You can let Gnus consult the
23494 blackhole-type distributed spam processing systems (DCC, for instance)
23495 when you set this option. The variable @code{spam-blackhole-servers}
23496 holds the list of blackhole servers Gnus will consult. The current
23497 list is fairly comprehensive, but make sure to let us know if it
23498 contains outdated servers.
23500 The blackhole check uses the @code{dig.el} package, but you can tell
23501 @code{spam.el} to use @code{dns.el} instead for better performance if
23502 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
23503 this time to set @code{spam-use-dig} to @code{nil} despite the
23504 possible performance improvements, because some users may be unable to
23505 use it, but you can try it and see if it works for you.
23509 @defvar spam-blackhole-servers
23511 The list of servers to consult for blackhole checks.
23515 @defvar spam-blackhole-good-server-regex
23517 A regular expression for IPs that should not be checked against the
23518 blackhole server list. When set to @code{nil}, it has no effect.
23522 @defvar spam-use-dig
23524 Use the @code{dig.el} package instead of the @code{dns.el} package.
23525 The default setting of @code{t} is recommended.
23529 Blackhole checks are done only on incoming mail. There is no spam or
23530 ham processor for blackholes.
23532 @node Regular Expressions Header Matching
23533 @subsubsection Regular Expressions Header Matching
23534 @cindex spam filtering
23535 @cindex regular expressions header matching, spam filtering
23538 @defvar spam-use-regex-headers
23540 This option is disabled by default. You can let Gnus check the
23541 message headers against lists of regular expressions when you set this
23542 option. The variables @code{spam-regex-headers-spam} and
23543 @code{spam-regex-headers-ham} hold the list of regular expressions.
23544 Gnus will check against the message headers to determine if the
23545 message is spam or ham, respectively.
23549 @defvar spam-regex-headers-spam
23551 The list of regular expressions that, when matched in the headers of
23552 the message, positively identify it as spam.
23556 @defvar spam-regex-headers-ham
23558 The list of regular expressions that, when matched in the headers of
23559 the message, positively identify it as ham.
23563 Regular expression header checks are done only on incoming mail.
23564 There is no specific spam or ham processor for regular expressions.
23567 @subsubsection Bogofilter
23568 @cindex spam filtering
23569 @cindex bogofilter, spam filtering
23572 @defvar spam-use-bogofilter
23574 Set this variable if you want @code{spam-split} to use Eric Raymond's
23577 With a minimum of care for associating the @samp{$} mark for spam
23578 articles only, Bogofilter training all gets fairly automatic. You
23579 should do this until you get a few hundreds of articles in each
23580 category, spam or not. The command @kbd{S t} in summary mode, either
23581 for debugging or for curiosity, shows the @emph{spamicity} score of
23582 the current article (between 0.0 and 1.0).
23584 Bogofilter determines if a message is spam based on a specific
23585 threshold. That threshold can be customized, consult the Bogofilter
23588 If the @code{bogofilter} executable is not in your path, Bogofilter
23589 processing will be turned off.
23591 You should not enable this if you use @code{spam-use-bogofilter-headers}.
23595 @defvar spam-use-bogofilter-headers
23597 Set this variable if you want @code{spam-split} to use Eric Raymond's
23598 speedy Bogofilter, looking only at the message headers. It works
23599 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
23600 must be in the message already. Normally you would do this with a
23601 procmail recipe or something similar; consult the Bogofilter
23602 installation documents for details.
23604 You should not enable this if you use @code{spam-use-bogofilter}.
23608 @defvar gnus-group-spam-exit-processor-bogofilter
23609 Add this symbol to a group's @code{spam-process} parameter by
23610 customizing the group parameters or the
23611 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23612 added to a group's @code{spam-process} parameter, spam-marked articles
23613 will be added to the Bogofilter spam database.
23617 Instead of the obsolete
23618 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
23619 that you use @code{'(spam spam-use-bogofilter)}. Everything will work
23620 the same way, we promise.
23623 @defvar gnus-group-ham-exit-processor-bogofilter
23624 Add this symbol to a group's @code{spam-process} parameter by
23625 customizing the group parameters or the
23626 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23627 added to a group's @code{spam-process} parameter, the ham-marked
23628 articles in @emph{ham} groups will be added to the Bogofilter database
23629 of non-spam messages.
23633 Instead of the obsolete
23634 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
23635 that you use @code{'(ham spam-use-bogofilter)}. Everything will work
23636 the same way, we promise.
23639 @defvar spam-bogofilter-database-directory
23641 This is the directory where Bogofilter will store its databases. It
23642 is not specified by default, so Bogofilter will use its own default
23643 database directory.
23647 The Bogofilter mail classifier is similar to @command{ifile} in intent and
23648 purpose. A ham and a spam processor are provided, plus the
23649 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
23650 variables to indicate to spam-split that Bogofilter should either be
23651 used, or has already been used on the article. The 0.9.2.1 version of
23652 Bogofilter was used to test this functionality.
23654 @node SpamAssassin back end
23655 @subsubsection SpamAssassin back end
23656 @cindex spam filtering
23657 @cindex spamassassin, spam filtering
23660 @defvar spam-use-spamassassin
23662 Set this variable if you want @code{spam-split} to use SpamAssassin.
23664 SpamAssassin assigns a score to each article based on a set of rules
23665 and tests, including a Bayesian filter. The Bayesian filter can be
23666 trained by associating the @samp{$} mark for spam articles. The
23667 spam score can be viewed by using the command @kbd{S t} in summary
23670 If you set this variable, each article will be processed by
23671 SpamAssassin when @code{spam-split} is called. If your mail is
23672 preprocessed by SpamAssassin, and you want to just use the
23673 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
23676 You should not enable this is you use
23677 @code{spam-use-spamassassin-headers}.
23681 @defvar spam-use-spamassassin-headers
23683 Set this variable if your mail is preprocessed by SpamAssassin and
23684 want @code{spam-split} to split based on the SpamAssassin headers.
23686 You should not enable this is you use @code{spam-use-spamassassin}.
23690 @defvar spam-spamassassin-path
23692 This variable points to the SpamAssassin executable. If you have
23693 @code{spamd} running, you can set this variable to the @code{spamc}
23694 executable for faster processing. See the SpamAssassin documentation
23695 for more information on @code{spamd}/@code{spamc}.
23699 SpamAssassin is a powerful and flexible spam filter that uses a wide
23700 variety of tests to identify spam. A ham and a spam processors are
23701 provided, plus the @code{spam-use-spamassassin} and
23702 @code{spam-use-spamassassin-headers} variables to indicate to
23703 spam-split that SpamAssassin should be either used, or has already
23704 been used on the article. The 2.63 version of SpamAssassin was used
23705 to test this functionality.
23707 @node ifile spam filtering
23708 @subsubsection ifile spam filtering
23709 @cindex spam filtering
23710 @cindex ifile, spam filtering
23713 @defvar spam-use-ifile
23715 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
23716 statistical analyzer similar to Bogofilter.
23720 @defvar spam-ifile-all-categories
23722 Enable this variable if you want @code{spam-use-ifile} to give you all
23723 the ifile categories, not just spam/non-spam. If you use this, make
23724 sure you train ifile as described in its documentation.
23728 @defvar spam-ifile-spam-category
23730 This is the category of spam messages as far as ifile is concerned.
23731 The actual string used is irrelevant, but you probably want to leave
23732 the default value of @samp{spam}.
23735 @defvar spam-ifile-database-path
23737 This is the filename for the ifile database. It is not specified by
23738 default, so ifile will use its own default database name.
23742 The ifile mail classifier is similar to Bogofilter in intent and
23743 purpose. A ham and a spam processor are provided, plus the
23744 @code{spam-use-ifile} variable to indicate to spam-split that ifile
23745 should be used. The 1.2.1 version of ifile was used to test this
23748 @node spam-stat spam filtering
23749 @subsubsection spam-stat spam filtering
23750 @cindex spam filtering
23751 @cindex spam-stat, spam filtering
23755 @xref{Filtering Spam Using Statistics with spam-stat}.
23757 @defvar spam-use-stat
23759 Enable this variable if you want @code{spam-split} to use
23760 spam-stat.el, an Emacs Lisp statistical analyzer.
23764 @defvar gnus-group-spam-exit-processor-stat
23765 Add this symbol to a group's @code{spam-process} parameter by
23766 customizing the group parameters or the
23767 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23768 added to a group's @code{spam-process} parameter, the spam-marked
23769 articles will be added to the spam-stat database of spam messages.
23773 Instead of the obsolete
23774 @code{gnus-group-spam-exit-processor-stat}, it is recommended
23775 that you use @code{'(spam spam-use-stat)}. Everything will work
23776 the same way, we promise.
23779 @defvar gnus-group-ham-exit-processor-stat
23780 Add this symbol to a group's @code{spam-process} parameter by
23781 customizing the group parameters or the
23782 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23783 added to a group's @code{spam-process} parameter, the ham-marked
23784 articles in @emph{ham} groups will be added to the spam-stat database
23785 of non-spam messages.
23789 Instead of the obsolete
23790 @code{gnus-group-ham-exit-processor-stat}, it is recommended
23791 that you use @code{'(ham spam-use-stat)}. Everything will work
23792 the same way, we promise.
23795 This enables @code{spam.el} to cooperate with @file{spam-stat.el}.
23796 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
23797 which unlike ifile or Bogofilter does not require external programs.
23798 A spam and a ham processor, and the @code{spam-use-stat} variable for
23799 @code{spam-split} are provided.
23802 @subsubsection Using SpamOracle with Gnus
23803 @cindex spam filtering
23807 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
23808 statistical mail filtering tool written by Xavier Leroy and needs to be
23809 installed separately.
23811 There are several ways to use SpamOracle with Gnus. In all cases, your
23812 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
23813 then enter an @samp{X-Spam} header indicating whether it regards the
23814 mail as a spam mail or not.
23816 One possibility is to run SpamOracle as a @code{:prescript} from the
23817 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
23818 the advantage that the user can see the @emph{X-Spam} headers.
23820 The easiest method is to make @code{spam.el} (@pxref{Filtering Spam
23821 Using The Spam ELisp Package}) call SpamOracle.
23823 @vindex spam-use-spamoracle
23824 To enable SpamOracle usage by @code{spam.el}, set the variable
23825 @code{spam-use-spamoracle} to @code{t} and configure the
23826 @code{nnmail-split-fancy} or @code{nnimap-split-fancy} as described in
23827 the section @xref{Filtering Spam Using The Spam ELisp Package}. In
23828 this example the @samp{INBOX} of an nnimap server is filtered using
23829 SpamOracle. Mails recognized as spam mails will be moved to
23830 @code{spam-split-group}, @samp{Junk} in this case. Ham messages stay
23834 (setq spam-use-spamoracle t
23835 spam-split-group "Junk"
23836 nnimap-split-inbox '("INBOX")
23837 nnimap-split-rule 'nnimap-split-fancy
23838 nnimap-split-fancy '(| (: spam-split) "INBOX"))
23841 @defvar spam-use-spamoracle
23842 Set to @code{t} if you want Gnus to enable spam filtering using
23846 @defvar spam-spamoracle-binary
23847 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
23848 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
23852 @defvar spam-spamoracle-database
23853 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
23854 store its analyses. This is controlled by the variable
23855 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
23856 the default SpamOracle database will be used. In case you want your
23857 database to live somewhere special, set
23858 @code{spam-spamoracle-database} to this path.
23861 SpamOracle employs a statistical algorithm to determine whether a
23862 message is spam or ham. In order to get good results, meaning few
23863 false hits or misses, SpamOracle needs training. SpamOracle learns the
23864 characteristics of your spam mails. Using the @emph{add} mode
23865 (training mode) one has to feed good (ham) and spam mails to
23866 SpamOracle. This can be done by pressing @kbd{|} in the Summary buffer
23867 and pipe the mail to a SpamOracle process or using @code{spam.el}'s
23868 spam- and ham-processors, which is much more convenient. For a
23869 detailed description of spam- and ham-processors, @xref{Filtering Spam
23870 Using The Spam ELisp Package}.
23872 @defvar gnus-group-spam-exit-processor-spamoracle
23873 Add this symbol to a group's @code{spam-process} parameter by
23874 customizing the group parameter or the
23875 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23876 to a group's @code{spam-process} parameter, spam-marked articles will be
23877 sent to SpamOracle as spam samples.
23881 Instead of the obsolete
23882 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
23883 that you use @code{'(spam spam-use-spamoracle)}. Everything will work
23884 the same way, we promise.
23887 @defvar gnus-group-ham-exit-processor-spamoracle
23888 Add this symbol to a group's @code{spam-process} parameter by
23889 customizing the group parameter or the
23890 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23891 to a group's @code{spam-process} parameter, the ham-marked articles in
23892 @emph{ham} groups will be sent to the SpamOracle as samples of ham
23897 Instead of the obsolete
23898 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
23899 that you use @code{'(ham spam-use-spamoracle)}. Everything will work
23900 the same way, we promise.
23903 @emph{Example:} These are the Group Parameters of a group that has been
23904 classified as a ham group, meaning that it should only contain ham
23907 ((spam-contents gnus-group-spam-classification-ham)
23908 (spam-process ((ham spam-use-spamoracle)
23909 (spam spam-use-spamoracle))))
23911 For this group the @code{spam-use-spamoracle} is installed for both
23912 ham and spam processing. If the group contains spam message
23913 (e.g. because SpamOracle has not had enough sample messages yet) and
23914 the user marks some messages as spam messages, these messages will be
23915 processed by SpamOracle. The processor sends the messages to
23916 SpamOracle as new samples for spam.
23918 @node Extending the Spam ELisp package
23919 @subsubsection Extending the Spam ELisp package
23920 @cindex spam filtering
23921 @cindex spam elisp package, extending
23922 @cindex extending the spam elisp package
23924 Say you want to add a new back end called blackbox. For filtering
23925 incoming mail, provide the following:
23933 (defvar spam-use-blackbox nil
23934 "True if blackbox should be used.")
23937 Write @code{spam-check-blackbox} if Blackbox can check incoming mail.
23939 Write @code{spam-blackbox-register-routine} and
23940 @code{spam-blackbox-unregister-routine} using the bogofilter
23941 register/unregister routines as a start, or other restister/unregister
23942 routines more appropriate to Blackbox, if Blackbox can
23943 register/unregister spam and ham.
23948 The @code{spam-check-blackbox} function should return @samp{nil} or
23949 @code{spam-split-group}, observing the other conventions. See the
23950 existing @code{spam-check-*} functions for examples of what you can
23951 do, and stick to the template unless you fully understand the reasons
23956 For processing spam and ham messages, provide the following:
23963 Note you don't have to provide a spam or a ham processor. Only
23964 provide them if Blackbox supports spam or ham processing.
23966 Also, ham and spam processors are being phased out as single
23967 variables. Instead the form @code{'(spam spam-use-blackbox)} or
23968 @code{'(ham spam-use-blackbox)} is favored. For now, spam/ham
23969 processor variables are still around but they won't be for long.
23972 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
23973 "The Blackbox summary exit spam processor.
23974 Only applicable to spam groups.")
23976 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
23977 "The whitelist summary exit ham processor.
23978 Only applicable to non-spam (unclassified and ham) groups.")
23987 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
23988 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
23990 to the @code{spam-process} group parameter in @code{gnus.el}. Make
23991 sure you do it twice, once for the parameter and once for the
23992 variable customization.
23996 (variable-item spam-use-blackbox)
23998 to the @code{spam-autodetect-methods} group parameter in
23999 @code{gnus.el} if Blackbox can check incoming mail for spam contents.
24001 Finally, use the appropriate @code{spam-install-*-backend} function in
24002 @code{spam.el}. Here are the available functions.
24008 @code{spam-install-backend-alias}
24010 This function will simply install an alias for a back end that does
24011 everything like the original back end. It is currently only used to
24012 make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}.
24015 @code{spam-install-nocheck-backend}
24017 This function installs a back end that has no check function, but can
24018 register/unregister ham or spam. The @code{spam-use-gmane} back end is
24022 @code{spam-install-checkonly-backend}
24024 This function will install a back end that can only check incoming mail
24025 for spam contents. It can't register or unregister messages.
24026 @code{spam-use-blackholes} and @code{spam-use-hashcash} are such
24030 @code{spam-install-statistical-checkonly-backend}
24032 This function installs a statistical back end (one which requires the
24033 full body of a message to check it) that can only check incoming mail
24034 for contents. @code{spam-use-regex-body} is such a filter.
24037 @code{spam-install-statistical-backend}
24039 This function install a statistical back end with incoming checks and
24040 registration/unregistration routines. @code{spam-use-bogofilter} is
24044 @code{spam-install-backend}
24046 This is the most normal back end installation, where a back end that can
24047 check and register/unregister messages is set up without statistical
24048 abilities. The @code{spam-use-BBDB} is such a back end.
24051 @code{spam-install-mover-backend}
24053 Mover back ends are internal to @code{spam.el} and specifically move
24054 articles around when the summary is exited. You will very probably
24055 never install such a back end.
24061 @node Filtering Spam Using Statistics with spam-stat
24062 @subsection Filtering Spam Using Statistics with spam-stat
24063 @cindex Paul Graham
24064 @cindex Graham, Paul
24065 @cindex naive Bayesian spam filtering
24066 @cindex Bayesian spam filtering, naive
24067 @cindex spam filtering, naive Bayesian
24069 Paul Graham has written an excellent essay about spam filtering using
24070 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
24071 Spam}. In it he describes the inherent deficiency of rule-based
24072 filtering as used by SpamAssassin, for example: Somebody has to write
24073 the rules, and everybody else has to install these rules. You are
24074 always late. It would be much better, he argues, to filter mail based
24075 on whether it somehow resembles spam or non-spam. One way to measure
24076 this is word distribution. He then goes on to describe a solution
24077 that checks whether a new mail resembles any of your other spam mails
24080 The basic idea is this: Create a two collections of your mail, one
24081 with spam, one with non-spam. Count how often each word appears in
24082 either collection, weight this by the total number of mails in the
24083 collections, and store this information in a dictionary. For every
24084 word in a new mail, determine its probability to belong to a spam or a
24085 non-spam mail. Use the 15 most conspicuous words, compute the total
24086 probability of the mail being spam. If this probability is higher
24087 than a certain threshold, the mail is considered to be spam.
24089 Gnus supports this kind of filtering. But it needs some setting up.
24090 First, you need two collections of your mail, one with spam, one with
24091 non-spam. Then you need to create a dictionary using these two
24092 collections, and save it. And last but not least, you need to use
24093 this dictionary in your fancy mail splitting rules.
24096 * Creating a spam-stat dictionary::
24097 * Splitting mail using spam-stat::
24098 * Low-level interface to the spam-stat dictionary::
24101 @node Creating a spam-stat dictionary
24102 @subsubsection Creating a spam-stat dictionary
24104 Before you can begin to filter spam based on statistics, you must
24105 create these statistics based on two mail collections, one with spam,
24106 one with non-spam. These statistics are then stored in a dictionary
24107 for later use. In order for these statistics to be meaningful, you
24108 need several hundred emails in both collections.
24110 Gnus currently supports only the nnml back end for automated dictionary
24111 creation. The nnml back end stores all mails in a directory, one file
24112 per mail. Use the following:
24114 @defun spam-stat-process-spam-directory
24115 Create spam statistics for every file in this directory. Every file
24116 is treated as one spam mail.
24119 @defun spam-stat-process-non-spam-directory
24120 Create non-spam statistics for every file in this directory. Every
24121 file is treated as one non-spam mail.
24124 Usually you would call @code{spam-stat-process-spam-directory} on a
24125 directory such as @file{~/Mail/mail/spam} (this usually corresponds
24126 the the group @samp{nnml:mail.spam}), and you would call
24127 @code{spam-stat-process-non-spam-directory} on a directory such as
24128 @file{~/Mail/mail/misc} (this usually corresponds the the group
24129 @samp{nnml:mail.misc}).
24131 When you are using @acronym{IMAP}, you won't have the mails available
24132 locally, so that will not work. One solution is to use the Gnus Agent
24133 to cache the articles. Then you can use directories such as
24134 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
24135 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
24138 This variable holds the hash-table with all the statistics---the
24139 dictionary we have been talking about. For every word in either
24140 collection, this hash-table stores a vector describing how often the
24141 word appeared in spam and often it appeared in non-spam mails.
24144 If you want to regenerate the statistics from scratch, you need to
24145 reset the dictionary.
24147 @defun spam-stat-reset
24148 Reset the @code{spam-stat} hash-table, deleting all the statistics.
24151 When you are done, you must save the dictionary. The dictionary may
24152 be rather large. If you will not update the dictionary incrementally
24153 (instead, you will recreate it once a month, for example), then you
24154 can reduce the size of the dictionary by deleting all words that did
24155 not appear often enough or that do not clearly belong to only spam or
24156 only non-spam mails.
24158 @defun spam-stat-reduce-size
24159 Reduce the size of the dictionary. Use this only if you do not want
24160 to update the dictionary incrementally.
24163 @defun spam-stat-save
24164 Save the dictionary.
24167 @defvar spam-stat-file
24168 The filename used to store the dictionary. This defaults to
24169 @file{~/.spam-stat.el}.
24172 @node Splitting mail using spam-stat
24173 @subsubsection Splitting mail using spam-stat
24175 In order to use @code{spam-stat} to split your mail, you need to add the
24176 following to your @file{~/.gnus.el} file:
24179 (require 'spam-stat)
24183 This will load the necessary Gnus code, and the dictionary you
24186 Next, you need to adapt your fancy splitting rules: You need to
24187 determine how to use @code{spam-stat}. The following examples are for
24188 the nnml back end. Using the nnimap back end works just as well. Just
24189 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
24191 In the simplest case, you only have two groups, @samp{mail.misc} and
24192 @samp{mail.spam}. The following expression says that mail is either
24193 spam or it should go into @samp{mail.misc}. If it is spam, then
24194 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
24197 (setq nnmail-split-fancy
24198 `(| (: spam-stat-split-fancy)
24202 @defvar spam-stat-split-fancy-spam-group
24203 The group to use for spam. Default is @samp{mail.spam}.
24206 If you also filter mail with specific subjects into other groups, use
24207 the following expression. Only mails not matching the regular
24208 expression are considered potential spam.
24211 (setq nnmail-split-fancy
24212 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
24213 (: spam-stat-split-fancy)
24217 If you want to filter for spam first, then you must be careful when
24218 creating the dictionary. Note that @code{spam-stat-split-fancy} must
24219 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
24220 non-spam, therefore both should be in your collection of non-spam
24221 mails, when creating the dictionary!
24224 (setq nnmail-split-fancy
24225 `(| (: spam-stat-split-fancy)
24226 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24230 You can combine this with traditional filtering. Here, we move all
24231 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
24232 @code{spam-stat-split-fancy} will never see them, the mails in
24233 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
24234 nor in your collection of non-spam mails, when creating the
24238 (setq nnmail-split-fancy
24239 `(| ("Content-Type" "text/html" "mail.spam.filtered")
24240 (: spam-stat-split-fancy)
24241 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24246 @node Low-level interface to the spam-stat dictionary
24247 @subsubsection Low-level interface to the spam-stat dictionary
24249 The main interface to using @code{spam-stat}, are the following functions:
24251 @defun spam-stat-buffer-is-spam
24252 Called in a buffer, that buffer is considered to be a new spam mail.
24253 Use this for new mail that has not been processed before.
24256 @defun spam-stat-buffer-is-no-spam
24257 Called in a buffer, that buffer is considered to be a new non-spam
24258 mail. Use this for new mail that has not been processed before.
24261 @defun spam-stat-buffer-change-to-spam
24262 Called in a buffer, that buffer is no longer considered to be normal
24263 mail but spam. Use this to change the status of a mail that has
24264 already been processed as non-spam.
24267 @defun spam-stat-buffer-change-to-non-spam
24268 Called in a buffer, that buffer is no longer considered to be spam but
24269 normal mail. Use this to change the status of a mail that has already
24270 been processed as spam.
24273 @defun spam-stat-save
24274 Save the hash table to the file. The filename used is stored in the
24275 variable @code{spam-stat-file}.
24278 @defun spam-stat-load
24279 Load the hash table from a file. The filename used is stored in the
24280 variable @code{spam-stat-file}.
24283 @defun spam-stat-score-word
24284 Return the spam score for a word.
24287 @defun spam-stat-score-buffer
24288 Return the spam score for a buffer.
24291 @defun spam-stat-split-fancy
24292 Use this function for fancy mail splitting. Add the rule @samp{(:
24293 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
24296 Make sure you load the dictionary before using it. This requires the
24297 following in your @file{~/.gnus.el} file:
24300 (require 'spam-stat)
24304 Typical test will involve calls to the following functions:
24307 Reset: (setq spam-stat (make-hash-table :test 'equal))
24308 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24309 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24310 Save table: (spam-stat-save)
24311 File size: (nth 7 (file-attributes spam-stat-file))
24312 Number of words: (hash-table-count spam-stat)
24313 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24314 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24315 Reduce table size: (spam-stat-reduce-size)
24316 Save table: (spam-stat-save)
24317 File size: (nth 7 (file-attributes spam-stat-file))
24318 Number of words: (hash-table-count spam-stat)
24319 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24320 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24323 Here is how you would create your dictionary:
24326 Reset: (setq spam-stat (make-hash-table :test 'equal))
24327 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24328 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24329 Repeat for any other non-spam group you need...
24330 Reduce table size: (spam-stat-reduce-size)
24331 Save table: (spam-stat-save)
24335 @section Interaction with other modes
24340 @code{gnus-dired-minor-mode} provided some useful functions for dired
24341 buffers. It is enabled with
24343 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
24348 @findex gnus-dired-attach
24349 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
24350 You will be prompted for a message buffer.
24353 @findex gnus-dired-find-file-mailcap
24354 Visit a file according to the appropriate mailcap entry
24355 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
24359 @findex gnus-dired-print
24360 Print file according to the mailcap entry (@code{gnus-dired-print}). If
24361 there is no print command, print in a PostScript image.
24364 @node Various Various
24365 @section Various Various
24371 @item gnus-home-directory
24372 @vindex gnus-home-directory
24373 All Gnus file and directory variables will be initialized from this
24374 variable, which defaults to @file{~/}.
24376 @item gnus-directory
24377 @vindex gnus-directory
24378 Most Gnus storage file and directory variables will be initialized from
24379 this variable, which defaults to the @env{SAVEDIR} environment
24380 variable, or @file{~/News/} if that variable isn't set.
24382 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
24383 This means that other directory variables that are initialized from this
24384 variable won't be set properly if you set this variable in
24385 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
24387 @item gnus-default-directory
24388 @vindex gnus-default-directory
24389 Not related to the above variable at all---this variable says what the
24390 default directory of all Gnus buffers should be. If you issue commands
24391 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
24392 default directory. If this variable is @code{nil} (which is the
24393 default), the default directory will be the default directory of the
24394 buffer you were in when you started Gnus.
24397 @vindex gnus-verbose
24398 This variable is an integer between zero and ten. The higher the value,
24399 the more messages will be displayed. If this variable is zero, Gnus
24400 will never flash any messages, if it is seven (which is the default),
24401 most important messages will be shown, and if it is ten, Gnus won't ever
24402 shut up, but will flash so many messages it will make your head swim.
24404 @item gnus-verbose-backends
24405 @vindex gnus-verbose-backends
24406 This variable works the same way as @code{gnus-verbose}, but it applies
24407 to the Gnus back ends instead of Gnus proper.
24409 @item nnheader-max-head-length
24410 @vindex nnheader-max-head-length
24411 When the back ends read straight heads of articles, they all try to read
24412 as little as possible. This variable (default 4096) specifies
24413 the absolute max length the back ends will try to read before giving up
24414 on finding a separator line between the head and the body. If this
24415 variable is @code{nil}, there is no upper read bound. If it is
24416 @code{t}, the back ends won't try to read the articles piece by piece,
24417 but read the entire articles. This makes sense with some versions of
24418 @code{ange-ftp} or @code{efs}.
24420 @item nnheader-head-chop-length
24421 @vindex nnheader-head-chop-length
24422 This variable (default 2048) says how big a piece of each article to
24423 read when doing the operation described above.
24425 @item nnheader-file-name-translation-alist
24426 @vindex nnheader-file-name-translation-alist
24428 @cindex invalid characters in file names
24429 @cindex characters in file names
24430 This is an alist that says how to translate characters in file names.
24431 For instance, if @samp{:} is invalid as a file character in file names
24432 on your system (you OS/2 user you), you could say something like:
24436 (setq nnheader-file-name-translation-alist
24441 In fact, this is the default value for this variable on OS/2 and MS
24442 Windows (phooey) systems.
24444 @item gnus-hidden-properties
24445 @vindex gnus-hidden-properties
24446 This is a list of properties to use to hide ``invisible'' text. It is
24447 @code{(invisible t intangible t)} by default on most systems, which
24448 makes invisible text invisible and intangible.
24450 @item gnus-parse-headers-hook
24451 @vindex gnus-parse-headers-hook
24452 A hook called before parsing headers. It can be used, for instance, to
24453 gather statistics on the headers fetched, or perhaps you'd like to prune
24454 some headers. I don't see why you'd want that, though.
24456 @item gnus-shell-command-separator
24457 @vindex gnus-shell-command-separator
24458 String used to separate two shell commands. The default is @samp{;}.
24460 @item gnus-invalid-group-regexp
24461 @vindex gnus-invalid-group-regexp
24463 Regexp to match ``invalid'' group names when querying user for a group
24464 name. The default value catches some @strong{really} invalid group
24465 names who could possibly mess up Gnus internally (like allowing
24466 @samp{:} in a group name, which is normally used to delimit method and
24469 @acronym{IMAP} users might want to allow @samp{/} in group names though.
24477 Well, that's the manual---you can get on with your life now. Keep in
24478 touch. Say hello to your cats from me.
24480 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
24482 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
24488 Not because of victories @*
24491 but for the common sunshine,@*
24493 the largess of the spring.
24497 but for the day's work done@*
24498 as well as I was able;@*
24499 not for a seat upon the dais@*
24500 but at the common table.@*
24505 @chapter Appendices
24508 * XEmacs:: Requirements for installing under XEmacs.
24509 * History:: How Gnus got where it is today.
24510 * On Writing Manuals:: Why this is not a beginner's guide.
24511 * Terminology:: We use really difficult, like, words here.
24512 * Customization:: Tailoring Gnus to your needs.
24513 * Troubleshooting:: What you might try if things do not work.
24514 * Gnus Reference Guide:: Rilly, rilly technical stuff.
24515 * Emacs for Heathens:: A short introduction to Emacsian terms.
24516 * Frequently Asked Questions:: The Gnus FAQ
24523 @cindex installing under XEmacs
24525 XEmacs is distributed as a collection of packages. You should install
24526 whatever packages the Gnus XEmacs package requires. The current
24527 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
24528 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
24529 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{w3},
24530 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
24537 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
24538 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
24540 If you want to investigate the person responsible for this outrage,
24541 you can point your (feh!) web browser to
24542 @uref{http://quimby.gnus.org/}. This is also the primary
24543 distribution point for the new and spiffy versions of Gnus, and is
24544 known as The Site That Destroys Newsrcs And Drives People Mad.
24546 During the first extended alpha period of development, the new Gnus was
24547 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
24548 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
24549 (Besides, the ``Gnus'' in this abbreviation should probably be
24550 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
24551 appropriate name, don't you think?)
24553 In any case, after spending all that energy on coming up with a new and
24554 spunky name, we decided that the name was @emph{too} spunky, so we
24555 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
24556 ``@sc{gnus}''. New vs. old.
24559 * Gnus Versions:: What Gnus versions have been released.
24560 * Other Gnus Versions:: Other Gnus versions that also have been released.
24561 * Why?:: What's the point of Gnus?
24562 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
24563 * Conformity:: Gnus tries to conform to all standards.
24564 * Emacsen:: Gnus can be run on a few modern Emacsen.
24565 * Gnus Development:: How Gnus is developed.
24566 * Contributors:: Oodles of people.
24567 * New Features:: Pointers to some of the new stuff in Gnus.
24571 @node Gnus Versions
24572 @subsection Gnus Versions
24574 @cindex September Gnus
24576 @cindex Quassia Gnus
24577 @cindex Pterodactyl Gnus
24580 @cindex Gnus versions
24582 The first ``proper'' release of Gnus 5 was done in November 1995 when it
24583 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
24584 plus 15 Gnus 5.0 releases).
24586 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
24587 releases)) was released under the name ``Gnus 5.2'' (40 releases).
24589 On July 28th 1996 work on Red Gnus was begun, and it was released on
24590 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
24592 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
24593 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
24595 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
24596 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
24599 On the 26th of October 2000, Oort Gnus was begun.
24601 If you happen upon a version of Gnus that has a prefixed name --
24602 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
24603 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
24604 that you're frightened. Back away. Slowly. Whatever you do, don't
24605 run. Walk away, calmly, until you're out of its reach. Find a proper
24606 released version of Gnus and snuggle up to that instead.
24609 @node Other Gnus Versions
24610 @subsection Other Gnus Versions
24613 In addition to the versions of Gnus which have had their releases
24614 coordinated by Lars, one major development has been Semi-gnus from
24615 Japan. It's based on a library called @acronym{SEMI}, which provides
24616 @acronym{MIME} capabilities.
24618 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
24619 Collectively, they are called ``Semi-gnus'', and different strains are
24620 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
24621 @acronym{MIME} and multilingualization things, especially important for
24628 What's the point of Gnus?
24630 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
24631 newsreader, that lets you do anything you can think of. That was my
24632 original motivation, but while working on Gnus, it has become clear to
24633 me that this generation of newsreaders really belong in the stone age.
24634 Newsreaders haven't developed much since the infancy of the net. If the
24635 volume continues to rise with the current rate of increase, all current
24636 newsreaders will be pretty much useless. How do you deal with
24637 newsgroups that have thousands of new articles each day? How do you
24638 keep track of millions of people who post?
24640 Gnus offers no real solutions to these questions, but I would very much
24641 like to see Gnus being used as a testing ground for new methods of
24642 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
24643 to separate the newsreader from the back ends, Gnus now offers a simple
24644 interface for anybody who wants to write new back ends for fetching mail
24645 and news from different sources. I have added hooks for customizations
24646 everywhere I could imagine it being useful. By doing so, I'm inviting
24647 every one of you to explore and invent.
24649 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
24650 @kbd{C-u 100 M-x all-hail-xemacs}.
24653 @node Compatibility
24654 @subsection Compatibility
24656 @cindex compatibility
24657 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
24658 bindings have been kept. More key bindings have been added, of course,
24659 but only in one or two obscure cases have old bindings been changed.
24664 @center In a cloud bones of steel.
24668 All commands have kept their names. Some internal functions have changed
24671 The @code{gnus-uu} package has changed drastically. @xref{Decoding
24674 One major compatibility question is the presence of several summary
24675 buffers. All variables relevant while reading a group are
24676 buffer-local to the summary buffer they belong in. Although many
24677 important variables have their values copied into their global
24678 counterparts whenever a command is executed in the summary buffer, this
24679 change might lead to incorrect values being used unless you are careful.
24681 All code that relies on knowledge of @sc{gnus} internals will probably
24682 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
24683 changing it in any way, as a matter of fact) is strictly verboten. Gnus
24684 maintains a hash table that points to the entries in this alist (which
24685 speeds up many functions), and changing the alist directly will lead to
24689 @cindex highlighting
24690 Old hilit19 code does not work at all. In fact, you should probably
24691 remove all hilit code from all Gnus hooks
24692 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
24693 Gnus provides various integrated functions for highlighting. These are
24694 faster and more accurate. To make life easier for everybody, Gnus will
24695 by default remove all hilit calls from all hilit hooks. Uncleanliness!
24698 Packages like @code{expire-kill} will no longer work. As a matter of
24699 fact, you should probably remove all old @sc{gnus} packages (and other
24700 code) when you start using Gnus. More likely than not, Gnus already
24701 does what you have written code to make @sc{gnus} do. (Snicker.)
24703 Even though old methods of doing things are still supported, only the
24704 new methods are documented in this manual. If you detect a new method of
24705 doing something while reading this manual, that does not mean you have
24706 to stop doing it the old way.
24708 Gnus understands all @sc{gnus} startup files.
24710 @kindex M-x gnus-bug
24712 @cindex reporting bugs
24714 Overall, a casual user who hasn't written much code that depends on
24715 @sc{gnus} internals should suffer no problems. If problems occur,
24716 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
24718 @vindex gnus-bug-create-help-buffer
24719 If you are in the habit of sending bug reports @emph{very} often, you
24720 may find the helpful help buffer annoying after a while. If so, set
24721 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
24726 @subsection Conformity
24728 No rebels without a clue here, ma'am. We conform to all standards known
24729 to (wo)man. Except for those standards and/or conventions we disagree
24737 There are no known breaches of this standard.
24741 There are no known breaches of this standard, either.
24743 @item Son-of-RFC 1036
24744 @cindex Son-of-RFC 1036
24745 We do have some breaches to this one.
24751 These are considered to be ``vanity headers'', while I consider them
24752 to be consumer information. After seeing so many badly formatted
24753 articles coming from @code{tin} and @code{Netscape} I know not to use
24754 either of those for posting articles. I would not have known that if
24755 it wasn't for the @code{X-Newsreader} header.
24760 USEFOR is an IETF working group writing a successor to RFC 1036, based
24761 on Son-of-RFC 1036. They have produced a number of drafts proposing
24762 various changes to the format of news articles. The Gnus towers will
24763 look into implementing the changes when the draft is accepted as an RFC.
24765 @item MIME - RFC 2045-2049 etc
24766 @cindex @acronym{MIME}
24767 All the various @acronym{MIME} RFCs are supported.
24769 @item Disposition Notifications - RFC 2298
24770 Message Mode is able to request notifications from the receiver.
24772 @item PGP - RFC 1991 and RFC 2440
24775 RFC 1991 is the original @acronym{PGP} message specification,
24776 published as an informational RFC. RFC 2440 was the follow-up, now
24777 called Open PGP, and put on the Standards Track. Both document a
24778 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
24779 encoding (signing and encryption) and decoding (verification and
24782 @item PGP/MIME - RFC 2015/3156
24783 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
24784 1991) describes the @acronym{MIME}-wrapping around the RF 1991/2440 format.
24785 Gnus supports both encoding and decoding.
24787 @item S/MIME - RFC 2633
24788 RFC 2633 describes the @acronym{S/MIME} format.
24790 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
24791 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
24792 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
24793 authentication for @acronym{IMAP}. RFC 2086 describes access control
24794 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
24795 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
24796 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
24797 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
24801 If you ever notice Gnus acting non-compliant with regards to the texts
24802 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
24807 @subsection Emacsen
24813 Gnus should work on:
24821 XEmacs 21.4 and up.
24825 This Gnus version will absolutely not work on any Emacsen older than
24826 that. Not reliably, at least. Older versions of Gnus may work on older
24827 Emacs versions. However, T-gnus does support ``Mule 2.3 based on Emacs
24828 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
24829 See the file ``README'' in the T-gnus distribution for more details.
24831 There are some vague differences between Gnus on the various
24832 platforms---XEmacs features more graphics (a logo and a toolbar)---but
24833 other than that, things should look pretty much the same under all
24837 @node Gnus Development
24838 @subsection Gnus Development
24840 Gnus is developed in a two-phased cycle. The first phase involves much
24841 discussion on the @samp{ding@@gnus.org} mailing list, where people
24842 propose changes and new features, post patches and new back ends. This
24843 phase is called the @dfn{alpha} phase, since the Gnusae released in this
24844 phase are @dfn{alpha releases}, or (perhaps more commonly in other
24845 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
24846 unstable and should not be used by casual users. Gnus alpha releases
24847 have names like ``Red Gnus'' and ``Quassia Gnus''.
24849 After futzing around for 50-100 alpha releases, Gnus is declared
24850 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
24851 and is called things like ``Gnus 5.6.32'' instead. Normal people are
24852 supposed to be able to use these, and these are mostly discussed on the
24853 @samp{gnu.emacs.gnus} newsgroup.
24856 @vindex mail-source-delete-incoming
24857 Some variable defaults differ between alpha Gnusae and released Gnusae.
24858 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
24859 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
24860 lossage of mail if an alpha release hiccups while handling the mail.
24862 The division of discussion between the ding mailing list and the Gnus
24863 newsgroup is not purely based on publicity concerns. It's true that
24864 having people write about the horrible things that an alpha Gnus release
24865 can do (sometimes) in a public forum may scare people off, but more
24866 importantly, talking about new experimental features that have been
24867 introduced may confuse casual users. New features are frequently
24868 introduced, fiddled with, and judged to be found wanting, and then
24869 either discarded or totally rewritten. People reading the mailing list
24870 usually keep up with these rapid changes, while people on the newsgroup
24871 can't be assumed to do so.
24876 @subsection Contributors
24877 @cindex contributors
24879 The new Gnus version couldn't have been done without the help of all the
24880 people on the (ding) mailing list. Every day for over a year I have
24881 gotten billions of nice bug reports from them, filling me with joy,
24882 every single one of them. Smooches. The people on the list have been
24883 tried beyond endurance, what with my ``oh, that's a neat idea <type
24884 type>, yup, I'll release it right away <ship off> no wait, that doesn't
24885 work at all <type type>, yup, I'll ship that one off right away <ship
24886 off> no, wait, that absolutely does not work'' policy for releases.
24887 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
24888 ``worser''? ``much worser''? ``worsest''?)
24890 I would like to take this opportunity to thank the Academy for@dots{} oops,
24896 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
24899 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
24900 nnwarchive and many, many other things connected with @acronym{MIME} and
24901 other types of en/decoding, as well as general bug fixing, new
24902 functionality and stuff.
24905 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
24906 well as numerous other things).
24909 Luis Fernandes---design and graphics.
24912 Joe Reiss---creator of the smiley faces.
24915 Justin Sheehy---the @acronym{FAQ} maintainer.
24918 Erik Naggum---help, ideas, support, code and stuff.
24921 Wes Hardaker---@file{gnus-picon.el} and the manual section on
24922 @dfn{picons} (@pxref{Picons}).
24925 Kim-Minh Kaplan---further work on the picon code.
24928 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
24931 Sudish Joseph---innumerable bug fixes.
24934 Ilja Weis---@file{gnus-topic.el}.
24937 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
24940 Vladimir Alexiev---the refcard and reference booklets.
24943 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
24944 distribution by Felix Lee and JWZ.
24947 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
24950 Peter Mutsaers---orphan article scoring code.
24953 Ken Raeburn---POP mail support.
24956 Hallvard B Furuseth---various bits and pieces, especially dealing with
24960 Brian Edmonds---@file{gnus-bbdb.el}.
24963 David Moore---rewrite of @file{nnvirtual.el} and many other things.
24966 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
24969 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
24970 well as autoconf support.
24974 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
24975 Borges, and Jost Krieger proof-reading parts of the manual.
24977 The following people have contributed many patches and suggestions:
24992 Jason L. Tibbitts, III,
24994 Katsumi Yamaoka, @c Yamaoka
24998 Also thanks to the following for patches and stuff:
25008 Alexei V. Barantsev,
25023 Massimo Campostrini,
25028 Jae-you Chung, @c ?
25029 James H. Cloos, Jr.,
25033 Andrew J. Cosgriff,
25036 Geoffrey T. Dairiki,
25042 Michael Welsh Duggan,
25047 Enami Tsugutomo, @c Enami
25051 Nelson Jose dos Santos Ferreira,
25059 Arne Georg Gleditsch,
25061 Michelangelo Grigni,
25065 Kenichi Handa, @c Handa
25067 Yoshiki Hayashi, @c Hayashi
25069 Hisashige Kenji, @c Hisashige
25076 Fran@,{c}ois Felix Ingrand,
25077 Tatsuya Ichikawa, @c Ichikawa
25078 Ishikawa Ichiro, @c Ishikawa
25080 Iwamuro Motonori, @c Iwamuro
25090 Peter Skov Knudsen,
25091 Shuhei Kobayashi, @c Kobayashi
25093 Koseki Yoshinori, @c Koseki
25094 Thor Kristoffersen,
25097 Seokchan Lee, @c Lee
25115 Morioka Tomohiko, @c Morioka
25116 Erik Toubro Nielsen,
25123 Masaharu Onishi, @c Onishi
25128 Jens-Ulrik Holger Petersen,
25132 John McClary Prevost,
25138 Lars Balker Rasmussen,
25143 Christian von Roques,
25146 Wolfgang Rupprecht,
25153 Philippe Schnoebelen,
25155 Randal L. Schwartz,
25169 Kiyokazu Suto, @c Suto
25174 Tozawa Akihiko, @c Tozawa
25194 For a full overview of what each person has done, the ChangeLogs
25195 included in the Gnus alpha distributions should give ample reading
25196 (550kB and counting).
25198 Apologies to everybody that I've forgotten, of which there are many, I'm
25201 Gee, that's quite a list of people. I guess that must mean that there
25202 actually are people who are using Gnus. Who'd'a thunk it!
25206 @subsection New Features
25207 @cindex new features
25210 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
25211 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
25212 * Red Gnus:: Third time best---Gnus 5.4/5.5.
25213 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
25214 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
25215 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
25216 * No Gnus:: Lars, FIXME!
25219 These lists are, of course, just @emph{short} overviews of the
25220 @emph{most} important new features. No, really. There are tons more.
25221 Yes, we have feeping creaturism in full effect.
25224 @subsubsection (ding) Gnus
25226 New features in Gnus 5.0/5.1:
25231 The look of all buffers can be changed by setting format-like variables
25232 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
25235 Local spool and several @acronym{NNTP} servers can be used at once
25236 (@pxref{Select Methods}).
25239 You can combine groups into virtual groups (@pxref{Virtual Groups}).
25242 You can read a number of different mail formats (@pxref{Getting Mail}).
25243 All the mail back ends implement a convenient mail expiry scheme
25244 (@pxref{Expiring Mail}).
25247 Gnus can use various strategies for gathering threads that have lost
25248 their roots (thereby gathering loose sub-threads into one thread) or it
25249 can go back and retrieve enough headers to build a complete thread
25250 (@pxref{Customizing Threading}).
25253 Killed groups can be displayed in the group buffer, and you can read
25254 them as well (@pxref{Listing Groups}).
25257 Gnus can do partial group updates---you do not have to retrieve the
25258 entire active file just to check for new articles in a few groups
25259 (@pxref{The Active File}).
25262 Gnus implements a sliding scale of subscribedness to groups
25263 (@pxref{Group Levels}).
25266 You can score articles according to any number of criteria
25267 (@pxref{Scoring}). You can even get Gnus to find out how to score
25268 articles for you (@pxref{Adaptive Scoring}).
25271 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
25272 manner, so it should be difficult to lose much data on what you have
25273 read if your machine should go down (@pxref{Auto Save}).
25276 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
25277 cluttering up the @file{.emacs} file.
25280 You can set the process mark on both groups and articles and perform
25281 operations on all the marked items (@pxref{Process/Prefix}).
25284 You can grep through a subset of groups and create a group from the
25285 results (@pxref{Kibozed Groups}).
25288 You can list subsets of groups according to, well, anything
25289 (@pxref{Listing Groups}).
25292 You can browse foreign servers and subscribe to groups from those
25293 servers (@pxref{Browse Foreign Server}).
25296 Gnus can fetch articles, asynchronously, on a second connection to the
25297 server (@pxref{Asynchronous Fetching}).
25300 You can cache articles locally (@pxref{Article Caching}).
25303 The uudecode functions have been expanded and generalized
25304 (@pxref{Decoding Articles}).
25307 You can still post uuencoded articles, which was a little-known feature
25308 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
25311 Fetching parents (and other articles) now actually works without
25312 glitches (@pxref{Finding the Parent}).
25315 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
25318 Digests (and other files) can be used as the basis for groups
25319 (@pxref{Document Groups}).
25322 Articles can be highlighted and customized (@pxref{Customizing
25326 URLs and other external references can be buttonized (@pxref{Article
25330 You can do lots of strange stuff with the Gnus window & frame
25331 configuration (@pxref{Window Layout}).
25334 You can click on buttons instead of using the keyboard
25340 @node September Gnus
25341 @subsubsection September Gnus
25345 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
25349 New features in Gnus 5.2/5.3:
25354 A new message composition mode is used. All old customization variables
25355 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
25359 Gnus is now able to generate @dfn{sparse} threads---threads where
25360 missing articles are represented by empty nodes (@pxref{Customizing
25364 (setq gnus-build-sparse-threads 'some)
25368 Outgoing articles are stored on a special archive server
25369 (@pxref{Archived Messages}).
25372 Partial thread regeneration now happens when articles are
25376 Gnus can make use of GroupLens predictions.
25379 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
25382 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
25385 (setq gnus-use-trees t)
25389 An @code{nn}-like pick-and-read minor mode is available for the summary
25390 buffers (@pxref{Pick and Read}).
25393 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
25397 In binary groups you can use a special binary minor mode (@pxref{Binary
25401 Groups can be grouped in a folding topic hierarchy (@pxref{Group
25405 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
25409 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
25412 Groups can now have a score, and bubbling based on entry frequency
25413 is possible (@pxref{Group Score}).
25416 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
25420 Groups can be process-marked, and commands can be performed on
25421 groups of groups (@pxref{Marking Groups}).
25424 Caching is possible in virtual groups.
25427 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
25428 news batches, ClariNet briefs collections, and just about everything
25429 else (@pxref{Document Groups}).
25432 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
25436 The Gnus cache is much faster.
25439 Groups can be sorted according to many criteria (@pxref{Sorting
25443 New group parameters have been introduced to set list-addresses and
25444 expiry times (@pxref{Group Parameters}).
25447 All formatting specs allow specifying faces to be used
25448 (@pxref{Formatting Fonts}).
25451 There are several more commands for setting/removing/acting on process
25452 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
25455 The summary buffer can be limited to show parts of the available
25456 articles based on a wide range of criteria. These commands have been
25457 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
25460 Articles can be made persistent with the @kbd{*} command
25461 (@pxref{Persistent Articles}).
25464 All functions for hiding article elements are now toggles.
25467 Article headers can be buttonized (@pxref{Article Washing}).
25470 All mail back ends support fetching articles by @code{Message-ID}.
25473 Duplicate mail can now be treated properly (@pxref{Duplicates}).
25476 All summary mode commands are available directly from the article
25477 buffer (@pxref{Article Keymap}).
25480 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
25484 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
25487 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
25492 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
25495 (setq gnus-use-nocem t)
25499 Groups can be made permanently visible (@pxref{Listing Groups}).
25502 (setq gnus-permanently-visible-groups "^nnml:")
25506 Many new hooks have been introduced to make customizing easier.
25509 Gnus respects the @code{Mail-Copies-To} header.
25512 Threads can be gathered by looking at the @code{References} header
25513 (@pxref{Customizing Threading}).
25516 (setq gnus-summary-thread-gathering-function
25517 'gnus-gather-threads-by-references)
25521 Read articles can be stored in a special backlog buffer to avoid
25522 refetching (@pxref{Article Backlog}).
25525 (setq gnus-keep-backlog 50)
25529 A clean copy of the current article is always stored in a separate
25530 buffer to allow easier treatment.
25533 Gnus can suggest where to save articles (@pxref{Saving Articles}).
25536 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
25540 (setq gnus-prompt-before-saving t)
25544 @code{gnus-uu} can view decoded files asynchronously while fetching
25545 articles (@pxref{Other Decode Variables}).
25548 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
25552 Filling in the article buffer now works properly on cited text
25553 (@pxref{Article Washing}).
25556 Hiding cited text adds buttons to toggle hiding, and how much
25557 cited text to hide is now customizable (@pxref{Article Hiding}).
25560 (setq gnus-cited-lines-visible 2)
25564 Boring headers can be hidden (@pxref{Article Hiding}).
25567 Default scoring values can now be set from the menu bar.
25570 Further syntax checking of outgoing articles have been added.
25576 @subsubsection Red Gnus
25578 New features in Gnus 5.4/5.5:
25582 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
25589 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
25592 Article prefetching functionality has been moved up into
25593 Gnus (@pxref{Asynchronous Fetching}).
25596 Scoring can now be performed with logical operators like @code{and},
25597 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
25601 Article washing status can be displayed in the
25602 article mode line (@pxref{Misc Article}).
25605 @file{gnus.el} has been split into many smaller files.
25608 Suppression of duplicate articles based on Message-ID can be done
25609 (@pxref{Duplicate Suppression}).
25612 (setq gnus-suppress-duplicates t)
25616 New variables for specifying what score and adapt files are to be
25617 considered home score and adapt files (@pxref{Home Score File}) have
25621 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
25622 Server Internals}).
25625 Groups can inherit group parameters from parent topics (@pxref{Topic
25629 Article editing has been revamped and is now actually usable.
25632 Signatures can be recognized in more intelligent fashions
25633 (@pxref{Article Signature}).
25636 Summary pick mode has been made to look more @code{nn}-like. Line
25637 numbers are displayed and the @kbd{.} command can be used to pick
25638 articles (@code{Pick and Read}).
25641 Commands for moving the @file{.newsrc.eld} from one server to
25642 another have been added (@pxref{Changing Servers}).
25645 There's a way now to specify that ``uninteresting'' fields be suppressed
25646 when generating lines in buffers (@pxref{Advanced Formatting}).
25649 Several commands in the group buffer can be undone with @kbd{C-M-_}
25653 Scoring can be done on words using the new score type @code{w}
25654 (@pxref{Score File Format}).
25657 Adaptive scoring can be done on a Subject word-by-word basis
25658 (@pxref{Adaptive Scoring}).
25661 (setq gnus-use-adaptive-scoring '(word))
25665 Scores can be decayed (@pxref{Score Decays}).
25668 (setq gnus-decay-scores t)
25672 Scoring can be performed using a regexp on the Date header. The Date is
25673 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
25676 A new command has been added to remove all data on articles from
25677 the native server (@pxref{Changing Servers}).
25680 A new command for reading collections of documents
25681 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
25682 (@pxref{Really Various Summary Commands}).
25685 Process mark sets can be pushed and popped (@pxref{Setting Process
25689 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
25690 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
25693 A new back end for reading searches from Web search engines
25694 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
25695 (@pxref{Web Searches}).
25698 Groups inside topics can now be sorted using the standard sorting
25699 functions, and each topic can be sorted independently (@pxref{Topic
25703 Subsets of the groups can be sorted independently (@code{Sorting
25707 Cached articles can be pulled into the groups (@pxref{Summary Generation
25711 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
25716 Score files are now applied in a more reliable order (@pxref{Score
25720 Reports on where mail messages end up can be generated (@pxref{Splitting
25724 More hooks and functions have been added to remove junk from incoming
25725 mail before saving the mail (@pxref{Washing Mail}).
25728 Emphasized text can be properly fontisized:
25734 @subsubsection Quassia Gnus
25736 New features in Gnus 5.6:
25741 New functionality for using Gnus as an offline newsreader has been
25742 added. A plethora of new commands and modes have been added.
25743 @xref{Gnus Unplugged}, for the full story.
25746 The @code{nndraft} back end has returned, but works differently than
25747 before. All Message buffers are now also articles in the @code{nndraft}
25748 group, which is created automatically.
25751 @code{gnus-alter-header-function} can now be used to alter header
25755 @code{gnus-summary-goto-article} now accept Message-ID's.
25758 A new Message command for deleting text in the body of a message
25759 outside the region: @kbd{C-c C-v}.
25762 You can now post to component group in @code{nnvirtual} groups with
25766 @code{nntp-rlogin-program}---new variable to ease customization.
25769 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
25770 re-highlighting of the article buffer.
25773 New element in @code{gnus-boring-article-headers}---@code{long-to}.
25776 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
25780 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
25781 @kbd{a} to add the score rule to the @file{all.SCORE} file.
25784 @code{gnus-simplify-subject-functions} variable to allow greater
25785 control over simplification.
25788 @kbd{A T}---new command for fetching the current thread.
25791 @kbd{/ T}---new command for including the current thread in the
25795 @kbd{M-RET} is a new Message command for breaking cited text.
25798 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
25801 The @code{custom-face-lookup} function has been removed.
25802 If you used this function in your initialization files, you must
25803 rewrite them to use @code{face-spec-set} instead.
25806 Canceling now uses the current select method. Symbolic prefix
25807 @kbd{a} forces normal posting method.
25810 New command to translate M******** sm*rtq**t*s into proper
25814 For easier debugging of @code{nntp}, you can set
25815 @code{nntp-record-commands} to a non-@code{nil} value.
25818 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
25819 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
25822 A command for editing group parameters from the summary buffer
25826 A history of where mails have been split is available.
25829 A new article date command has been added---@code{article-date-iso8601}.
25832 Subjects can be simplified when threading by setting
25833 @code{gnus-score-thread-simplify}.
25836 A new function for citing in Message has been
25837 added---@code{message-cite-original-without-signature}.
25840 @code{article-strip-all-blank-lines}---new article command.
25843 A new Message command to kill to the end of the article has
25847 A minimum adaptive score can be specified by using the
25848 @code{gnus-adaptive-word-minimum} variable.
25851 The ``lapsed date'' article header can be kept continually
25852 updated by the @code{gnus-start-date-timer} command.
25855 Web listserv archives can be read with the @code{nnlistserv} back end.
25858 Old dejanews archives can now be read by @code{nnweb}.
25862 @node Pterodactyl Gnus
25863 @subsubsection Pterodactyl Gnus
25865 New features in Gnus 5.8:
25870 The mail-fetching functions have changed. See the manual for the
25871 many details. In particular, all procmail fetching variables are gone.
25873 If you used procmail like in
25876 (setq nnmail-use-procmail t)
25877 (setq nnmail-spool-file 'procmail)
25878 (setq nnmail-procmail-directory "~/mail/incoming/")
25879 (setq nnmail-procmail-suffix "\\.in")
25882 this now has changed to
25886 '((directory :path "~/mail/incoming/"
25890 @xref{Mail Source Specifiers}.
25893 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
25894 Gnus, and adds a slew of new commands. See the manual for details.
25897 Gnus has also been multilingualized. This also affects too
25898 many parts of Gnus to summarize here, and adds many new variables.
25901 @code{gnus-auto-select-first} can now be a function to be
25902 called to position point.
25905 The user can now decide which extra headers should be included in
25906 summary buffers and @acronym{NOV} files.
25909 @code{gnus-article-display-hook} has been removed. Instead, a number
25910 of variables starting with @code{gnus-treat-} have been added.
25913 The Gnus posting styles have been redone again and now works in a
25914 subtly different manner.
25917 New web-based back ends have been added: @code{nnslashdot},
25918 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
25919 again, to keep up with ever-changing layouts.
25922 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
25927 @subsubsection Oort Gnus
25930 New features in Gnus 5.10:
25935 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
25936 (@code{gnus-article-reply-with-original}) only yank the text in the
25937 region if the region is active.
25940 @code{gnus-group-read-ephemeral-group} can be called interactively,
25944 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
25945 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
25948 The revised Gnus @acronym{FAQ} is included in the manual,
25949 @xref{Frequently Asked Questions}.
25952 Upgrading from previous (stable) version if you have used Oort.
25954 If you have tried Oort (the unstable Gnus branch leading to this
25955 release) but went back to a stable version, be careful when upgrading to
25956 this version. In particular, you will probably want to remove all
25957 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
25958 read from your @file{.newsrc.eld} instead of from the
25959 @file{.marks}/@file{.mrk} file where this release store flags. See a
25960 later entry for more information about marks. Note that downgrading
25961 isn't save in general.
25966 More buttons for URLs, mail addresses, Message-IDs, Info links, man
25967 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
25968 variables @code{gnus-button-@var{*}-level} can be used to control the
25969 appearance of all article buttons. @xref{Article Button Levels}.
25974 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
25975 bindings in dired buffers to send a file as an attachment, open a file
25976 using the appropriate mailcap entry, and print a file using the mailcap
25980 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
25983 Single-part yenc encoded attachments can be decoded.
25988 The picons code has been reimplemented to work in GNU Emacs---some of
25989 the previous options have been removed or renamed.
25991 Picons are small ``personal icons'' representing users, domain and
25992 newsgroups, which can be displayed in the Article buffer.
25996 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
25997 boundary line is drawn at the end of the headers.
26000 Retrieval of charters and control messages
26002 There are new commands for fetching newsgroup charters (@kbd{H c}) and
26003 control messages (@kbd{H C}).
26008 You can delay the sending of a message with @kbd{C-c C-j} in the Message
26009 buffer. The messages are delivered at specified time. This is useful
26010 for sending yourself reminders. @xref{Delayed Articles}.
26013 If @code{auto-compression-mode} is enabled, attachments are automatically
26014 decompressed when activated.
26017 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
26018 the nnml back end allows compressed message files.
26021 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
26024 The Summary Buffer uses an arrow in the fringe to indicate the current
26025 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
26028 Warn about email replies to news
26030 Do you often find yourself replying to news by email by mistake? Then
26031 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
26035 If the new option @code{gnus-summary-display-while-building} is
26036 non-@code{nil}, the summary buffer is shown and updated as it's being
26040 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
26041 opposed to old but unread messages).
26044 The new option @code{gnus-gcc-mark-as-read} automatically marks
26045 Gcc articles as read.
26048 The nndoc back end now supports mailman digests and exim bounces.
26051 Gnus supports RFC 2369 mailing list headers, and adds a number of
26052 related commands in mailing list groups. @xref{Mailing List}.
26055 The Date header can be displayed in a format that can be read aloud
26056 in English. @xref{Article Date}.
26059 The envelope sender address can be customized when using Sendmail.
26060 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
26063 diffs are automatically highlighted in groups matching
26064 @code{mm-uu-diff-groups-regexp}
26067 @acronym{TLS} wrapper shipped with Gnus
26069 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
26070 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
26071 @acronym{TLS}/@acronym{SSL} support via (external third party)
26072 @file{ssl.el} and OpenSSL still works.
26075 New @file{make.bat} for compiling and installing Gnus under MS Windows
26077 Use @file{make.bat} if you want to install Gnus under MS Windows, the
26078 first argument to the batch-program should be the directory where
26079 @file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want
26080 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
26081 the second parameter.
26083 @file{make.bat} has been rewritten from scratch, it now features
26084 automatic recognition of XEmacs and GNU Emacs, generates
26085 @file{gnus-load.el}, checks if errors occur while compilation and
26086 generation of info files and reports them at the end of the build
26087 process. It now uses @code{makeinfo} if it is available and falls
26088 back to @file{infohack.el} otherwise. @file{make.bat} should now
26089 install all files which are necessary to run Gnus and be generally a
26090 complete replacement for the @code{configure; make; make install}
26091 cycle used under Unix systems.
26093 The new @file{make.bat} makes @file{make-x.bat} superfluous, so it has
26097 Support for non-@acronym{ASCII} domain names
26099 Message supports non-@acronym{ASCII} domain names in From:, To: and
26100 Cc: and will query you whether to perform encoding when you try to
26101 send a message. The variable @code{message-use-idna} controls this.
26102 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
26103 and Cc: when you view a message. The variable @code{gnus-use-idna}
26107 Better handling of Microsoft citation styles
26109 Gnus now tries to recognize the mangled header block that some Microsoft
26110 mailers use to indicate that the rest of the message is a citation, even
26111 though it is not quoted in any way. The variable
26112 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
26116 @code{gnus-article-skip-boring}
26118 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
26119 not scroll down to show you a page that contains only boring text,
26120 which by default means cited text and signature. You can customize
26121 what is skippable using @code{gnus-article-boring-faces}.
26123 This feature is especially useful if you read many articles that
26124 consist of a little new content at the top with a long, untrimmed
26125 message cited below.
26128 The format spec @code{%C} for positioning point has changed to @code{%*}.
26131 The new variable @code{gnus-parameters} can be used to set group parameters.
26133 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
26134 the parameters in @file{~/.newsrc.eld}, but via this variable you can
26135 enjoy the powers of customize, and simplified backups since you set the
26136 variable in @file{~/.emacs} instead of @file{~/.newsrc.eld}. The
26137 variable maps regular expressions matching group names to group
26140 (setq gnus-parameters
26142 (gnus-show-threads nil)
26143 (gnus-use-scoring nil))
26144 ("^nnimap:\\(foo.bar\\)$"
26145 (to-group . "\\1"))))
26149 Smileys (@samp{:-)}, @samp{;-)} etc) are now iconized for Emacs too.
26151 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.emacs} to
26155 Gnus no longer generate the Sender: header automatically.
26157 Earlier it was generated iff the user configurable email address was
26158 different from the Gnus guessed default user address. As the guessing
26159 algorithm is rarely correct these days, and (more controversially) the
26160 only use of the Sender: header was to check if you are entitled to
26161 cancel/supersede news (which is now solved by Cancel Locks instead,
26162 see another entry), generation of the header has been disabled by
26163 default. See the variables @code{message-required-headers},
26164 @code{message-required-news-headers}, and
26165 @code{message-required-mail-headers}.
26168 Features from third party @file{message-utils.el} added to @file{message.el}.
26170 Message now asks if you wish to remove @samp{(was: <old subject>)} from
26171 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
26172 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
26173 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
26174 appropriate headers and a note in the body for cross-postings and
26175 followups (see the variables @code{message-cross-post-@var{*}}).
26178 References and X-Draft-Headers are no longer generated when you start
26179 composing messages and @code{message-generate-headers-first} is
26183 Improved anti-spam features.
26185 Gnus is now able to take out spam from your mail and news streams
26186 using a wide variety of programs and filter rules. Among the supported
26187 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
26188 for easy use of external packages such as SpamAssassin and Hashcash
26189 are also new. @xref{Thwarting Email Spam}.
26192 Easy inclusion of X-Faces headers.
26195 Face headers handling.
26198 In the summary buffer, the new command @kbd{/ N} inserts new messages
26199 and @kbd{/ o} inserts old messages.
26202 Gnus decodes morse encoded messages if you press @kbd{W m}.
26205 Unread count correct in nnimap groups.
26207 The estimated number of unread articles in the group buffer should now
26208 be correct for nnimap groups. This is achieved by calling
26209 @code{nnimap-fixup-unread-after-getting-new-news} from the
26210 @code{gnus-setup-news-hook} (called on startup) and
26211 @code{gnus-after-getting-new-news-hook}. (called after getting new
26212 mail). If you have modified those variables from the default, you may
26213 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
26214 you were happy with the estimate and want to save some (minimal) time
26215 when getting new mail, remove the function.
26218 Group Carbon Copy (GCC) quoting
26220 To support groups that contains SPC and other weird characters, groups
26221 are quoted before they are placed in the Gcc: header. This means
26222 variables such as @code{gnus-message-archive-group} should no longer
26223 contain quote characters to make groups containing SPC work. Also, if
26224 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
26225 into two groups) you must change it to return the list
26226 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
26227 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
26228 was incorrect earlier, it just didn't generate any problems since it
26229 was inserted directly.
26232 @file{~/News/overview/} not used.
26234 As a result of the following change, the @file{~/News/overview/}
26235 directory is not used any more. You can safely delete the entire
26241 The Gnus Agent has seen a major updated and is now enabled by default,
26242 and all nntp and nnimap servers from @code{gnus-select-method} and
26243 @code{gnus-secondary-select-method} are agentized by default. Earlier
26244 only the server in @code{gnus-select-method} was agentized by the
26245 default, and the agent was disabled by default. When the agent is
26246 enabled, headers are now also retrieved from the Agent cache instead
26247 of the back ends when possible. Earlier this only happened in the
26248 unplugged state. You can enroll or remove servers with @kbd{J a} and
26249 @kbd{J r} in the server buffer. Gnus will not download articles into
26250 the Agent cache, unless you instruct it to do so, though, by using
26251 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
26252 behaviour of having the Agent disabled with @code{(setq gnus-agent
26253 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
26254 is not needed any more.
26257 @code{gnus-summary-line-format}
26259 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
26260 %s\n}. Moreover @code{gnus-extra-headers},
26261 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
26262 changed their default so that the users name will be replaced by the
26263 recipient's name or the group name posting to for @acronym{NNTP}
26267 @file{deuglify.el} (@code{gnus-article-outlook-deuglify-article})
26269 A new file from Raymond Scholz @email{rscholz@@zonix.de} for deuglifying
26270 broken Outlook (Express) articles.
26273 @code{(require 'gnus-load)}
26275 If you use a stand-alone Gnus distribution, you'd better add
26276 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
26277 lisp directory into load-path.
26279 File @file{gnus-load.el} contains autoload commands, functions and variables,
26280 some of which may not be included in distributions of Emacsen.
26283 @code{gnus-slave-unplugged}
26285 A new command which starts Gnus offline in slave mode.
26288 @code{message-insinuate-rmail}
26290 Adding @code{(message-insinuate-rmail)} and @code{(setq
26291 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
26292 compose, reply and forward messages in message-mode, where you can
26293 enjoy the power of @acronym{MML}.
26296 @code{message-minibuffer-local-map}
26298 The line below enables BBDB in resending a message:
26300 (define-key message-minibuffer-local-map [(tab)]
26301 'bbdb-complete-name)
26305 Externalizing and deleting of attachments.
26307 If @code{gnus-gcc-externalize-attachments} or
26308 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
26309 local files as external parts.
26311 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
26312 on @acronym{MIME} buttons) saves a part and replaces the part with an
26313 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
26314 @acronym{MIME} buttons) removes a part. It works only on back ends
26315 that support editing.
26318 @code{gnus-default-charset}
26320 The default value is determined from the
26321 @code{current-language-environment} variable, instead of
26322 @code{iso-8859-1}. Also the @samp{.*} item in
26323 @code{gnus-group-charset-alist} is removed.
26326 @code{gnus-posting-styles}
26328 Add a new format of match like
26330 ((header "to" "larsi.*org")
26331 (Organization "Somewhere, Inc."))
26333 The old format like the lines below is obsolete, but still accepted.
26335 (header "to" "larsi.*org"
26336 (Organization "Somewhere, Inc."))
26340 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
26342 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
26343 added into these two variables. If you customized those, perhaps you
26344 need add those two headers too.
26347 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
26349 If one reads an article while plugged, and the article already exists
26350 in the Agent, it won't get downloaded once more. @code{(setq
26351 gnus-agent-cache nil)} reverts to the old behavior.
26354 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
26355 composing messages, it is enabled by @code{use-hard-newlines}.
26356 Decoding format=flowed was present but not documented in earlier
26360 Gnus supports the generation of RFC 2298 Disposition Notification requests.
26362 This is invoked with the @kbd{C-c M-n} key binding from message mode.
26365 Gnus supports Maildir groups.
26367 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
26370 Printing capabilities are enhanced.
26372 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
26373 Article buffers. Also, each individual @acronym{MIME} part can be
26374 printed using @kbd{p} on the @acronym{MIME} button.
26377 Message supports the Importance: (RFC 2156) header.
26379 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
26383 Gnus supports Cancel Locks in News.
26385 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
26386 used to determine if you wrote an article or not (for canceling and
26387 superseding). Gnus generates a random password string the first time
26388 you post a message, and saves it in your @file{~/.emacs} using the Custom
26389 system. While the variable is called @code{canlock-password}, it is not
26390 security sensitive data. Publishing your canlock string on the web
26391 will not allow anyone to be able to anything she could not already do.
26392 The behaviour can be changed by customizing @code{message-insert-canlock}.
26395 Gnus supports server-side mail filtering using Sieve.
26397 Sieve rules can be added as Group Parameters for groups, and the
26398 complete Sieve script is generated using @kbd{D g} from the Group
26399 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
26400 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
26401 manual @ref{Top, , Top, sieve, Emacs Sieve}.
26404 Extended format specs.
26406 Format spec @samp{%&user-date;} is added into
26407 @code{gnus-summary-line-format-alist}. Also, user defined extended
26408 format specs are supported. The extended format specs look like
26409 @samp{%u&foo;}, which invokes function
26410 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
26411 escape character, old user defined format @samp{%u&} is no longer supported.
26414 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
26416 It was aliased to @kbd{Y c}
26417 (@code{gnus-summary-insert-cached-articles}). The new function filters
26418 out other articles.
26420 @item Some limiting commands accept a @kbd{C-u} prefix to negate the match.
26422 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
26423 s}, @kbd{/ a}, and @kbd{/ x}
26424 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
26425 result will be to display all articles that do not match the expression.
26428 Group names are treated as UTF-8 by default.
26430 This is supposedly what USEFOR wanted to migrate to. See
26431 @code{gnus-group-name-charset-group-alist} and
26432 @code{gnus-group-name-charset-method-alist} for customization.
26435 The nnml and nnfolder back ends store marks for each groups.
26437 This makes it possible to take backup of nnml/nnfolder servers/groups
26438 separately of @file{~/.newsrc.eld}, while preserving marks. It also
26439 makes it possible to share articles and marks between users (without
26440 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
26441 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
26442 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
26443 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
26444 another machine, Gnus will automatically use the @file{.marks} or
26445 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
26446 The new server variables @code{nnml-marks-is-evil} and
26447 @code{nnfolder-marks-is-evil} can be used to disable this feature.
26450 The menu bar item (in Group and Summary buffer) named ``Misc'' has
26451 been renamed to ``Gnus''.
26454 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
26455 renamed to ``Attachments''. Note that this menu also contains security
26456 related stuff, like signing and encryption (@pxref{Security, Security,,
26457 message, Message Manual}).
26460 @code{gnus-group-charset-alist} and
26461 @code{gnus-group-ignored-charsets-alist}.
26463 The regexps in these variables are compared with full group names
26464 instead of real group names in 5.8. Users who customize these
26465 variables should change those regexps accordingly. For example:
26467 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
26471 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
26472 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
26474 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
26475 additional Lisp libraries. This add several menu items to the
26476 Attachments menu, and @kbd{C-c RET} key bindings, when composing
26477 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
26480 Gnus inlines external parts (message/external).
26483 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
26486 This change was made to avoid conflict with the standard binding of
26487 @code{back-to-indentation}, which is also useful in message mode.
26490 The default for @code{message-forward-show-mml} changed to symbol @code{best}.
26492 The behaviour for the @code{best} value is to show @acronym{MML} (i.e.,
26493 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
26494 used when forwarding signed or encrypted messages, as the conversion
26495 invalidate the digital signature.
26499 @subsubsection No Gnus
26502 New features in No Gnus:
26503 @c FIXME: Gnus 5.12?
26505 @include gnus-news.texi
26511 @section The Manual
26515 This manual was generated from a TeXinfo file and then run through
26516 either @code{texi2dvi}
26518 or my own home-brewed TeXinfo to \LaTeX\ transformer,
26519 and then run through @code{latex} and @code{dvips}
26521 to get what you hold in your hands now.
26523 The following conventions have been used:
26528 This is a @samp{string}
26531 This is a @kbd{keystroke}
26534 This is a @file{file}
26537 This is a @code{symbol}
26541 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
26545 (setq flargnoze "yes")
26548 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
26551 (setq flumphel 'yes)
26554 @samp{yes} and @code{yes} are two @emph{very} different things---don't
26555 ever get them confused.
26559 Of course, everything in this manual is of vital interest, so you should
26560 read it all. Several times. However, if you feel like skimming the
26561 manual, look for that gnu head you should see in the margin over
26562 there---it means that what's being discussed is of more importance than
26563 the rest of the stuff. (On the other hand, if everything is infinitely
26564 important, how can anything be more important than that? Just one more
26565 of the mysteries of this world, I guess.)
26571 @node On Writing Manuals
26572 @section On Writing Manuals
26574 I guess most manuals are written after-the-fact; documenting a program
26575 that's already there. This is not how this manual is written. When
26576 implementing something, I write the manual entry for that something
26577 straight away. I then see that it's difficult to explain the
26578 functionality, so I write how it's supposed to be, and then I change the
26579 implementation. Writing the documentation and writing the code goes
26582 This, of course, means that this manual has no, or little, flow. It
26583 documents absolutely everything in Gnus, but often not where you're
26584 looking for it. It is a reference manual, and not a guide to how to get
26587 That would be a totally different book, that should be written using the
26588 reference manual as source material. It would look quite differently.
26593 @section Terminology
26595 @cindex terminology
26600 This is what you are supposed to use this thing for---reading news.
26601 News is generally fetched from a nearby @acronym{NNTP} server, and is
26602 generally publicly available to everybody. If you post news, the entire
26603 world is likely to read just what you have written, and they'll all
26604 snigger mischievously. Behind your back.
26608 Everything that's delivered to you personally is mail. Some news/mail
26609 readers (like Gnus) blur the distinction between mail and news, but
26610 there is a difference. Mail is private. News is public. Mailing is
26611 not posting, and replying is not following up.
26615 Send a mail to the person who has written what you are reading.
26619 Post an article to the current newsgroup responding to the article you
26624 Gnus considers mail and news to be mostly the same, really. The only
26625 difference is how to access the actual articles. News articles are
26626 commonly fetched via the protocol @acronym{NNTP}, whereas mail
26627 messages could be read from a file on the local disk. The internal
26628 architecture of Gnus thus comprises a ``front end'' and a number of
26629 ``back ends''. Internally, when you enter a group (by hitting
26630 @key{RET}, say), you thereby invoke a function in the front end in
26631 Gnus. The front end then ``talks'' to a back end and says things like
26632 ``Give me the list of articles in the foo group'' or ``Show me article
26635 So a back end mainly defines either a protocol (the @code{nntp} back
26636 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
26637 accesses mail via @acronym{IMAP}) or a file format and directory
26638 layout (the @code{nnspool} back end accesses news via the common
26639 ``spool directory'' format, the @code{nnml} back end access mail via a
26640 file format and directory layout that's quite similar).
26642 Gnus does not handle the underlying media, so to speak---this is all
26643 done by the back ends. A back end is a collection of functions to
26644 access the articles.
26646 However, sometimes the term ``back end'' is also used where ``server''
26647 would have been more appropriate. And then there is the term ``select
26648 method'' which can mean either. The Gnus terminology can be quite
26653 Gnus will always use one method (and back end) as the @dfn{native}, or
26654 default, way of getting news.
26658 You can also have any number of foreign groups active at the same time.
26659 These are groups that use non-native non-secondary back ends for getting
26664 Secondary back ends are somewhere half-way between being native and being
26665 foreign, but they mostly act like they are native.
26669 A message that has been posted as news.
26672 @cindex mail message
26673 A message that has been mailed.
26677 A mail message or news article
26681 The top part of a message, where administrative information (etc.) is
26686 The rest of an article. Everything not in the head is in the
26691 A line from the head of an article.
26695 A collection of such lines, or a collection of heads. Or even a
26696 collection of @acronym{NOV} lines.
26698 @item @acronym{NOV}
26699 @cindex @acronym{NOV}
26700 When Gnus enters a group, it asks the back end for the headers of all
26701 unread articles in the group. Most servers support the News OverView
26702 format, which is more compact and much faster to read and parse than the
26703 normal @sc{head} format.
26707 Each group is subscribed at some @dfn{level} or other (1-9). The ones
26708 that have a lower level are ``more'' subscribed than the groups with a
26709 higher level. In fact, groups on levels 1-5 are considered
26710 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
26711 are @dfn{killed}. Commands for listing groups and scanning for new
26712 articles will all use the numeric prefix as @dfn{working level}.
26714 @item killed groups
26715 @cindex killed groups
26716 No information on killed groups is stored or updated, which makes killed
26717 groups much easier to handle than subscribed groups.
26719 @item zombie groups
26720 @cindex zombie groups
26721 Just like killed groups, only slightly less dead.
26724 @cindex active file
26725 The news server has to keep track of what articles it carries, and what
26726 groups exist. All this information in stored in the active file, which
26727 is rather large, as you might surmise.
26730 @cindex bogus groups
26731 A group that exists in the @file{.newsrc} file, but isn't known to the
26732 server (i.e., it isn't in the active file), is a @emph{bogus group}.
26733 This means that the group probably doesn't exist (any more).
26736 @cindex activating groups
26737 The act of asking the server for info on a group and computing the
26738 number of unread articles is called @dfn{activating the group}.
26739 Un-activated groups are listed with @samp{*} in the group buffer.
26743 A machine one can connect to and get news (or mail) from.
26745 @item select method
26746 @cindex select method
26747 A structure that specifies the back end, the server and the virtual
26750 @item virtual server
26751 @cindex virtual server
26752 A named select method. Since a select method defines all there is to
26753 know about connecting to a (physical) server, taking the thing as a
26754 whole is a virtual server.
26758 Taking a buffer and running it through a filter of some sort. The
26759 result will (more often than not) be cleaner and more pleasing than the
26762 @item ephemeral groups
26763 @cindex ephemeral groups
26764 @cindex temporary groups
26765 Most groups store data on what articles you have read. @dfn{Ephemeral}
26766 groups are groups that will have no data stored---when you exit the
26767 group, it'll disappear into the aether.
26770 @cindex solid groups
26771 This is the opposite of ephemeral groups. All groups listed in the
26772 group buffer are solid groups.
26774 @item sparse articles
26775 @cindex sparse articles
26776 These are article placeholders shown in the summary buffer when
26777 @code{gnus-build-sparse-threads} has been switched on.
26781 To put responses to articles directly after the articles they respond
26782 to---in a hierarchical fashion.
26786 @cindex thread root
26787 The first article in a thread is the root. It is the ancestor of all
26788 articles in the thread.
26792 An article that has responses.
26796 An article that responds to a different article---its parent.
26800 A collection of messages in one file. The most common digest format is
26801 specified by RFC 1153.
26804 @cindex splitting, terminolgy
26805 @cindex mail sorting
26806 @cindex mail filtering (splitting)
26807 The action of sorting your emails according to certain rules. Sometimes
26808 incorrectly called mail filtering.
26814 @node Customization
26815 @section Customization
26816 @cindex general customization
26818 All variables are properly documented elsewhere in this manual. This
26819 section is designed to give general pointers on how to customize Gnus
26820 for some quite common situations.
26823 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
26824 * Slow Terminal Connection:: You run a remote Emacs.
26825 * Little Disk Space:: You feel that having large setup files is icky.
26826 * Slow Machine:: You feel like buying a faster machine.
26830 @node Slow/Expensive Connection
26831 @subsection Slow/Expensive NNTP Connection
26833 If you run Emacs on a machine locally, and get your news from a machine
26834 over some very thin strings, you want to cut down on the amount of data
26835 Gnus has to get from the @acronym{NNTP} server.
26839 @item gnus-read-active-file
26840 Set this to @code{nil}, which will inhibit Gnus from requesting the
26841 entire active file from the server. This file is often v. large. You
26842 also have to set @code{gnus-check-new-newsgroups} and
26843 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
26844 doesn't suddenly decide to fetch the active file anyway.
26846 @item gnus-nov-is-evil
26847 This one has to be @code{nil}. If not, grabbing article headers from
26848 the @acronym{NNTP} server will not be very fast. Not all @acronym{NNTP} servers
26849 support @sc{xover}; Gnus will detect this by itself.
26853 @node Slow Terminal Connection
26854 @subsection Slow Terminal Connection
26856 Let's say you use your home computer for dialing up the system that runs
26857 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
26858 possible) the amount of data sent over the wires.
26862 @item gnus-auto-center-summary
26863 Set this to @code{nil} to inhibit Gnus from re-centering the summary
26864 buffer all the time. If it is @code{vertical}, do only vertical
26865 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
26866 horizontal and vertical recentering.
26868 @item gnus-visible-headers
26869 Cut down on the headers included in the articles to the
26870 minimum. You can, in fact, make do without them altogether---most of the
26871 useful data is in the summary buffer, anyway. Set this variable to
26872 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
26874 Set this hook to all the available hiding commands:
26876 (setq gnus-treat-hide-headers 'head
26877 gnus-treat-hide-signature t
26878 gnus-treat-hide-citation t)
26881 @item gnus-use-full-window
26882 By setting this to @code{nil}, you can make all the windows smaller.
26883 While this doesn't really cut down much generally, it means that you
26884 have to see smaller portions of articles before deciding that you didn't
26885 want to read them anyway.
26887 @item gnus-thread-hide-subtree
26888 If this is non-@code{nil}, all threads in the summary buffer will be
26892 @item gnus-updated-mode-lines
26893 If this is @code{nil}, Gnus will not put information in the buffer mode
26894 lines, which might save some time.
26898 @node Little Disk Space
26899 @subsection Little Disk Space
26902 The startup files can get rather large, so you may want to cut their
26903 sizes a bit if you are running out of space.
26907 @item gnus-save-newsrc-file
26908 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
26909 only save @file{.newsrc.eld}. This means that you will not be able to
26910 use any other newsreaders than Gnus. This variable is @code{t} by
26913 @item gnus-read-newsrc-file
26914 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
26915 only read @file{.newsrc.eld}. This means that you will not be able to
26916 use any other newsreaders than Gnus. This variable is @code{t} by
26919 @item gnus-save-killed-list
26920 If this is @code{nil}, Gnus will not save the list of dead groups. You
26921 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
26922 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
26923 variable to @code{nil}. This variable is @code{t} by default.
26929 @subsection Slow Machine
26930 @cindex slow machine
26932 If you have a slow machine, or are just really impatient, there are a
26933 few things you can do to make Gnus run faster.
26935 Set @code{gnus-check-new-newsgroups} and
26936 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
26938 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
26939 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
26940 summary buffer faster.
26944 @node Troubleshooting
26945 @section Troubleshooting
26946 @cindex troubleshooting
26948 Gnus works @emph{so} well straight out of the box---I can't imagine any
26956 Make sure your computer is switched on.
26959 Make sure that you really load the current Gnus version. If you have
26960 been running @sc{gnus}, you need to exit Emacs and start it up again before
26964 Try doing an @kbd{M-x gnus-version}. If you get something that looks
26965 like @samp{T-gnus 6.17.* (based on Gnus v5.10.*; for SEMI 1.1*, FLIM
26966 1.1*)} you have the right files loaded. Otherwise you have some old
26967 @file{.el} files lying around. Delete these.
26970 Read the help group (@kbd{G h} in the group buffer) for a
26971 @acronym{FAQ} and a how-to.
26974 @vindex max-lisp-eval-depth
26975 Gnus works on many recursive structures, and in some extreme (and very
26976 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
26977 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
26978 something like that.
26981 If all else fails, report the problem as a bug.
26984 @cindex reporting bugs
26986 @kindex M-x gnus-bug
26988 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
26989 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
26990 me the backtrace. I will fix bugs, but I can only fix them if you send
26991 me a precise description as to how to reproduce the bug.
26993 You really can never be too detailed in a bug report. Always use the
26994 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
26995 a 10Kb mail each time you use it, and even if you have sent me your
26996 environment 500 times before. I don't care. I want the full info each
26999 It is also important to remember that I have no memory whatsoever. If
27000 you send a bug report, and I send you a reply, and then you just send
27001 back ``No, it's not! Moron!'', I will have no idea what you are
27002 insulting me about. Always over-explain everything. It's much easier
27003 for all of us---if I don't have all the information I need, I will just
27004 mail you and ask for more info, and everything takes more time.
27006 If the problem you're seeing is very visual, and you can't quite explain
27007 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
27008 it somewhere it can be reached, and include the URL of the picture in
27012 If you would like to contribute a patch to fix bugs or make
27013 improvements, please produce the patch using @samp{diff -u}.
27016 If you want to debug your problem further before reporting, possibly
27017 in order to solve the problem yourself and send a patch, you can use
27018 edebug. Debugging Lisp code is documented in the Elisp manual
27019 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
27020 Lisp Reference Manual}). To get you started with edebug, consider if
27021 you discover some weird behaviour when pressing @kbd{c}, the first
27022 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
27023 the documentation buffer that leads you to the function definition,
27024 then press @kbd{M-x edebug-defun RET} with point inside that function,
27025 return to Gnus and press @kbd{c} to invoke the code. You will be
27026 placed in the lisp buffer and can single step using @kbd{SPC} and
27027 evaluate expressions using @kbd{M-:} or inspect variables using
27028 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
27029 @kbd{c} or @kbd{g}.
27034 Sometimes, a problem do not directly generate an elisp error but
27035 manifests itself by causing Gnus to be very slow. In these cases, you
27036 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
27037 slow, and then try to analyze the backtrace (repeating the procedure
27038 helps isolating the real problem areas).
27040 A fancier approach is to use the elisp profiler, ELP. The profiler is
27041 (or should be) fully documented elsewhere, but to get you started
27042 there are a few steps that need to be followed. First, instrument the
27043 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
27044 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
27045 RET message}. Then perform the operation that is slow and press
27046 @kbd{M-x elp-results}. You will then see which operations that takes
27047 time, and can debug them further. If the entire operation takes much
27048 longer than the time spent in the slowest function in the profiler
27049 output, you probably profiled the wrong part of Gnus. To reset
27050 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
27051 elp-restore-all} is supposed to remove profiling, but given the
27052 complexities and dynamic code generation in Gnus, it might not always
27055 @cindex gnu.emacs.gnus
27056 @cindex ding mailing list
27057 If you just need help, you are better off asking on
27058 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
27059 @email{ding@@gnus.org, the ding mailing list}. Write to
27060 @email{ding-request@@gnus.org} to subscribe.
27064 @node Gnus Reference Guide
27065 @section Gnus Reference Guide
27067 It is my hope that other people will figure out smart stuff that Gnus
27068 can do, and that other people will write those smart things as well. To
27069 facilitate that I thought it would be a good idea to describe the inner
27070 workings of Gnus. And some of the not-so-inner workings, while I'm at
27073 You can never expect the internals of a program not to change, but I
27074 will be defining (in some details) the interface between Gnus and its
27075 back ends (this is written in stone), the format of the score files
27076 (ditto), data structures (some are less likely to change than others)
27077 and general methods of operation.
27080 * Gnus Utility Functions:: Common functions and variable to use.
27081 * Back End Interface:: How Gnus communicates with the servers.
27082 * Score File Syntax:: A BNF definition of the score file standard.
27083 * Headers:: How Gnus stores headers internally.
27084 * Ranges:: A handy format for storing mucho numbers.
27085 * Group Info:: The group info format.
27086 * Extended Interactive:: Symbolic prefixes and stuff.
27087 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
27088 * Various File Formats:: Formats of files that Gnus use.
27092 @node Gnus Utility Functions
27093 @subsection Gnus Utility Functions
27094 @cindex Gnus utility functions
27095 @cindex utility functions
27097 @cindex internal variables
27099 When writing small functions to be run from hooks (and stuff), it's
27100 vital to have access to the Gnus internal functions and variables.
27101 Below is a list of the most common ones.
27105 @item gnus-newsgroup-name
27106 @vindex gnus-newsgroup-name
27107 This variable holds the name of the current newsgroup.
27109 @item gnus-find-method-for-group
27110 @findex gnus-find-method-for-group
27111 A function that returns the select method for @var{group}.
27113 @item gnus-group-real-name
27114 @findex gnus-group-real-name
27115 Takes a full (prefixed) Gnus group name, and returns the unprefixed
27118 @item gnus-group-prefixed-name
27119 @findex gnus-group-prefixed-name
27120 Takes an unprefixed group name and a select method, and returns the full
27121 (prefixed) Gnus group name.
27123 @item gnus-get-info
27124 @findex gnus-get-info
27125 Returns the group info list for @var{group}.
27127 @item gnus-group-unread
27128 @findex gnus-group-unread
27129 The number of unread articles in @var{group}, or @code{t} if that is
27133 @findex gnus-active
27134 The active entry for @var{group}.
27136 @item gnus-set-active
27137 @findex gnus-set-active
27138 Set the active entry for @var{group}.
27140 @item gnus-add-current-to-buffer-list
27141 @findex gnus-add-current-to-buffer-list
27142 Adds the current buffer to the list of buffers to be killed on Gnus
27145 @item gnus-continuum-version
27146 @findex gnus-continuum-version
27147 Takes a Gnus version string as a parameter and returns a floating point
27148 number. Earlier versions will always get a lower number than later
27151 @item gnus-group-read-only-p
27152 @findex gnus-group-read-only-p
27153 Says whether @var{group} is read-only or not.
27155 @item gnus-news-group-p
27156 @findex gnus-news-group-p
27157 Says whether @var{group} came from a news back end.
27159 @item gnus-ephemeral-group-p
27160 @findex gnus-ephemeral-group-p
27161 Says whether @var{group} is ephemeral or not.
27163 @item gnus-server-to-method
27164 @findex gnus-server-to-method
27165 Returns the select method corresponding to @var{server}.
27167 @item gnus-server-equal
27168 @findex gnus-server-equal
27169 Says whether two virtual servers are equal.
27171 @item gnus-group-native-p
27172 @findex gnus-group-native-p
27173 Says whether @var{group} is native or not.
27175 @item gnus-group-secondary-p
27176 @findex gnus-group-secondary-p
27177 Says whether @var{group} is secondary or not.
27179 @item gnus-group-foreign-p
27180 @findex gnus-group-foreign-p
27181 Says whether @var{group} is foreign or not.
27183 @item gnus-group-find-parameter
27184 @findex gnus-group-find-parameter
27185 Returns the parameter list of @var{group}. If given a second parameter,
27186 returns the value of that parameter for @var{group}.
27188 @item gnus-group-set-parameter
27189 @findex gnus-group-set-parameter
27190 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
27192 @item gnus-narrow-to-body
27193 @findex gnus-narrow-to-body
27194 Narrows the current buffer to the body of the article.
27196 @item gnus-check-backend-function
27197 @findex gnus-check-backend-function
27198 Takes two parameters, @var{function} and @var{group}. If the back end
27199 @var{group} comes from supports @var{function}, return non-@code{nil}.
27202 (gnus-check-backend-function "request-scan" "nnml:misc")
27206 @item gnus-read-method
27207 @findex gnus-read-method
27208 Prompts the user for a select method.
27213 @node Back End Interface
27214 @subsection Back End Interface
27216 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
27217 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
27218 server is a @dfn{back end} and some @dfn{back end variables}. As examples
27219 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
27220 examples of the latter we have @code{nntp-port-number} and
27221 @code{nnmbox-directory}.
27223 When Gnus asks for information from a back end---say @code{nntp}---on
27224 something, it will normally include a virtual server name in the
27225 function parameters. (If not, the back end should use the ``current''
27226 virtual server.) For instance, @code{nntp-request-list} takes a virtual
27227 server as its only (optional) parameter. If this virtual server hasn't
27228 been opened, the function should fail.
27230 Note that a virtual server name has no relation to some physical server
27231 name. Take this example:
27235 (nntp-address "ifi.uio.no")
27236 (nntp-port-number 4324))
27239 Here the virtual server name is @samp{odd-one} while the name of
27240 the physical server is @samp{ifi.uio.no}.
27242 The back ends should be able to switch between several virtual servers.
27243 The standard back ends implement this by keeping an alist of virtual
27244 server environments that they pull down/push up when needed.
27246 There are two groups of interface functions: @dfn{required functions},
27247 which must be present, and @dfn{optional functions}, which Gnus will
27248 always check for presence before attempting to call 'em.
27250 All these functions are expected to return data in the buffer
27251 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
27252 unfortunately named, but we'll have to live with it. When I talk about
27253 @dfn{resulting data}, I always refer to the data in that buffer. When I
27254 talk about @dfn{return value}, I talk about the function value returned by
27255 the function call. Functions that fail should return @code{nil} as the
27258 Some back ends could be said to be @dfn{server-forming} back ends, and
27259 some might be said not to be. The latter are back ends that generally
27260 only operate on one group at a time, and have no concept of ``server''
27261 ---they have a group, and they deliver info on that group and nothing
27264 Gnus identifies each message by way of group name and article number. A
27265 few remarks about these article numbers might be useful. First of all,
27266 the numbers are positive integers. Secondly, it is normally not
27267 possible for later articles to ``re-use'' older article numbers without
27268 confusing Gnus. That is, if a group has ever contained a message
27269 numbered 42, then no other message may get that number, or Gnus will get
27270 mightily confused.@footnote{See the function
27271 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
27272 Third, article numbers must be assigned in order of arrival in the
27273 group; this is not necessarily the same as the date of the message.
27275 The previous paragraph already mentions all the ``hard'' restrictions that
27276 article numbers must fulfill. But it seems that it might be useful to
27277 assign @emph{consecutive} article numbers, for Gnus gets quite confused
27278 if there are holes in the article numbering sequence. However, due to
27279 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
27280 also useful for the article numbers to start at 1 to avoid running out
27281 of numbers as long as possible.
27283 Note that by convention, back ends are named @code{nnsomething}, but
27284 Gnus also comes with some @code{nnnotbackends}, such as
27285 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
27287 In the examples and definitions I will refer to the imaginary back end
27290 @cindex @code{nnchoke}
27293 * Required Back End Functions:: Functions that must be implemented.
27294 * Optional Back End Functions:: Functions that need not be implemented.
27295 * Error Messaging:: How to get messages and report errors.
27296 * Writing New Back Ends:: Extending old back ends.
27297 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
27298 * Mail-like Back Ends:: Some tips on mail back ends.
27302 @node Required Back End Functions
27303 @subsubsection Required Back End Functions
27307 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
27309 @var{articles} is either a range of article numbers or a list of
27310 @code{Message-ID}s. Current back ends do not fully support either---only
27311 sequences (lists) of article numbers, and most back ends do not support
27312 retrieval of @code{Message-ID}s. But they should try for both.
27314 The result data should either be HEADs or @acronym{NOV} lines, and the result
27315 value should either be @code{headers} or @code{nov} to reflect this.
27316 This might later be expanded to @code{various}, which will be a mixture
27317 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
27319 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
27320 headers'', in some meaning of the word. This is generally done by
27321 fetching (at most) @var{fetch-old} extra headers less than the smallest
27322 article number in @code{articles}, and filling the gaps as well. The
27323 presence of this parameter can be ignored if the back end finds it
27324 cumbersome to follow the request. If this is non-@code{nil} and not a
27325 number, do maximum fetches.
27327 Here's an example HEAD:
27330 221 1056 Article retrieved.
27331 Path: ifi.uio.no!sturles
27332 From: sturles@@ifi.uio.no (Sturle Sunde)
27333 Newsgroups: ifi.discussion
27334 Subject: Re: Something very droll
27335 Date: 27 Oct 1994 14:02:57 +0100
27336 Organization: Dept. of Informatics, University of Oslo, Norway
27338 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
27339 References: <38jdmq$4qu@@visbur.ifi.uio.no>
27340 NNTP-Posting-Host: holmenkollen.ifi.uio.no
27344 So a @code{headers} return value would imply that there's a number of
27345 these in the data buffer.
27347 Here's a BNF definition of such a buffer:
27351 head = error / valid-head
27352 error-message = [ "4" / "5" ] 2number " " <error message> eol
27353 valid-head = valid-message *header "." eol
27354 valid-message = "221 " <number> " Article retrieved." eol
27355 header = <text> eol
27359 (The version of BNF used here is the one used in RFC822.)
27361 If the return value is @code{nov}, the data buffer should contain
27362 @dfn{network overview database} lines. These are basically fields
27366 nov-buffer = *nov-line
27367 nov-line = field 7*8[ <TAB> field ] eol
27368 field = <text except TAB>
27371 For a closer look at what should be in those fields,
27375 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
27377 @var{server} is here the virtual server name. @var{definitions} is a
27378 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
27380 If the server can't be opened, no error should be signaled. The back end
27381 may then choose to refuse further attempts at connecting to this
27382 server. In fact, it should do so.
27384 If the server is opened already, this function should return a
27385 non-@code{nil} value. There should be no data returned.
27388 @item (nnchoke-close-server &optional SERVER)
27390 Close connection to @var{server} and free all resources connected
27391 to it. Return @code{nil} if the server couldn't be closed for some
27394 There should be no data returned.
27397 @item (nnchoke-request-close)
27399 Close connection to all servers and free all resources that the back end
27400 have reserved. All buffers that have been created by that back end
27401 should be killed. (Not the @code{nntp-server-buffer}, though.) This
27402 function is generally only called when Gnus is shutting down.
27404 There should be no data returned.
27407 @item (nnchoke-server-opened &optional SERVER)
27409 If @var{server} is the current virtual server, and the connection to the
27410 physical server is alive, then this function should return a
27411 non-@code{nil} value. This function should under no circumstances
27412 attempt to reconnect to a server we have lost connection to.
27414 There should be no data returned.
27417 @item (nnchoke-status-message &optional SERVER)
27419 This function should return the last error message from @var{server}.
27421 There should be no data returned.
27424 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
27426 The result data from this function should be the article specified by
27427 @var{article}. This might either be a @code{Message-ID} or a number.
27428 It is optional whether to implement retrieval by @code{Message-ID}, but
27429 it would be nice if that were possible.
27431 If @var{to-buffer} is non-@code{nil}, the result data should be returned
27432 in this buffer instead of the normal data buffer. This is to make it
27433 possible to avoid copying large amounts of data from one buffer to
27434 another, while Gnus mainly requests articles to be inserted directly
27435 into its article buffer.
27437 If it is at all possible, this function should return a cons cell where
27438 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
27439 the article number. This will enable Gnus to find out what the real
27440 group and article numbers are when fetching articles by
27441 @code{Message-ID}. If this isn't possible, @code{t} should be returned
27442 on successful article retrieval.
27445 @item (nnchoke-request-group GROUP &optional SERVER FAST)
27447 Get data on @var{group}. This function also has the side effect of
27448 making @var{group} the current group.
27450 If @var{fast}, don't bother to return useful data, just make @var{group}
27453 Here's an example of some result data and a definition of the same:
27456 211 56 1000 1059 ifi.discussion
27459 The first number is the status, which should be 211. Next is the
27460 total number of articles in the group, the lowest article number, the
27461 highest article number, and finally the group name. Note that the total
27462 number of articles may be less than one might think while just
27463 considering the highest and lowest article numbers, but some articles
27464 may have been canceled. Gnus just discards the total-number, so
27465 whether one should take the bother to generate it properly (if that is a
27466 problem) is left as an exercise to the reader. If the group contains no
27467 articles, the lowest article number should be reported as 1 and the
27471 group-status = [ error / info ] eol
27472 error = [ "4" / "5" ] 2<number> " " <Error message>
27473 info = "211 " 3* [ <number> " " ] <string>
27477 @item (nnchoke-close-group GROUP &optional SERVER)
27479 Close @var{group} and free any resources connected to it. This will be
27480 a no-op on most back ends.
27482 There should be no data returned.
27485 @item (nnchoke-request-list &optional SERVER)
27487 Return a list of all groups available on @var{server}. And that means
27490 Here's an example from a server that only carries two groups:
27493 ifi.test 0000002200 0000002000 y
27494 ifi.discussion 3324 3300 n
27497 On each line we have a group name, then the highest article number in
27498 that group, the lowest article number, and finally a flag. If the group
27499 contains no articles, the lowest article number should be reported as 1
27500 and the highest as 0.
27503 active-file = *active-line
27504 active-line = name " " <number> " " <number> " " flags eol
27506 flags = "n" / "y" / "m" / "x" / "j" / "=" name
27509 The flag says whether the group is read-only (@samp{n}), is moderated
27510 (@samp{m}), is dead (@samp{x}), is aliased to some other group
27511 (@samp{=other-group}) or none of the above (@samp{y}).
27514 @item (nnchoke-request-post &optional SERVER)
27516 This function should post the current buffer. It might return whether
27517 the posting was successful or not, but that's not required. If, for
27518 instance, the posting is done asynchronously, it has generally not been
27519 completed by the time this function concludes. In that case, this
27520 function should set up some kind of sentinel to beep the user loud and
27521 clear if the posting could not be completed.
27523 There should be no result data from this function.
27528 @node Optional Back End Functions
27529 @subsubsection Optional Back End Functions
27533 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
27535 @var{groups} is a list of groups, and this function should request data
27536 on all those groups. How it does it is of no concern to Gnus, but it
27537 should attempt to do this in a speedy fashion.
27539 The return value of this function can be either @code{active} or
27540 @code{group}, which says what the format of the result data is. The
27541 former is in the same format as the data from
27542 @code{nnchoke-request-list}, while the latter is a buffer full of lines
27543 in the same format as @code{nnchoke-request-group} gives.
27546 group-buffer = *active-line / *group-status
27550 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
27552 A Gnus group info (@pxref{Group Info}) is handed to the back end for
27553 alterations. This comes in handy if the back end really carries all
27554 the information (as is the case with virtual and imap groups). This
27555 function should destructively alter the info to suit its needs, and
27556 should return a non-@code{nil} value.
27558 There should be no result data from this function.
27561 @item (nnchoke-request-type GROUP &optional ARTICLE)
27563 When the user issues commands for ``sending news'' (@kbd{F} in the
27564 summary buffer, for instance), Gnus has to know whether the article the
27565 user is following up on is news or mail. This function should return
27566 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
27567 is mail and @code{unknown} if the type can't be decided. (The
27568 @var{article} parameter is necessary in @code{nnvirtual} groups which
27569 might very well combine mail groups and news groups.) Both @var{group}
27570 and @var{article} may be @code{nil}.
27572 There should be no result data from this function.
27575 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
27577 Set/remove/add marks on articles. Normally Gnus handles the article
27578 marks (such as read, ticked, expired etc) internally, and store them in
27579 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
27580 all information about the articles on the server, so Gnus need to
27581 propagate the mark information to the server.
27583 @var{action} is a list of mark setting requests, having this format:
27586 (RANGE ACTION MARK)
27589 @var{range} is a range of articles you wish to update marks on.
27590 @var{action} is @code{add} or @code{del}, used to add marks or remove
27591 marks (preserving all marks not mentioned). @var{mark} is a list of
27592 marks; where each mark is a symbol. Currently used marks are
27593 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
27594 @code{dormant}, @code{save}, @code{download}, @code{unsend},
27595 @code{forward} and @code{recent}, but your back end should, if
27596 possible, not limit itself to these.
27598 Given contradictory actions, the last action in the list should be the
27599 effective one. That is, if your action contains a request to add the
27600 @code{tick} mark on article 1 and, later in the list, a request to
27601 remove the mark on the same article, the mark should in fact be removed.
27603 An example action list:
27606 (((5 12 30) 'del '(tick))
27607 ((10 . 90) 'add '(read expire))
27608 ((92 94) 'del '(read)))
27611 The function should return a range of articles it wasn't able to set the
27612 mark on (currently not used for anything).
27614 There should be no result data from this function.
27616 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
27618 If the user tries to set a mark that the back end doesn't like, this
27619 function may change the mark. Gnus will use whatever this function
27620 returns as the mark for @var{article} instead of the original
27621 @var{mark}. If the back end doesn't care, it must return the original
27622 @var{mark}, and not @code{nil} or any other type of garbage.
27624 The only use for this I can see is what @code{nnvirtual} does with
27625 it---if a component group is auto-expirable, marking an article as read
27626 in the virtual group should result in the article being marked as
27629 There should be no result data from this function.
27632 @item (nnchoke-request-scan &optional GROUP SERVER)
27634 This function may be called at any time (by Gnus or anything else) to
27635 request that the back end check for incoming articles, in one way or
27636 another. A mail back end will typically read the spool file or query
27637 the @acronym{POP} server when this function is invoked. The
27638 @var{group} doesn't have to be heeded---if the back end decides that
27639 it is too much work just scanning for a single group, it may do a
27640 total scan of all groups. It would be nice, however, to keep things
27641 local if that's practical.
27643 There should be no result data from this function.
27646 @item (nnchoke-request-group-description GROUP &optional SERVER)
27648 The result data from this function should be a description of
27652 description-line = name <TAB> description eol
27654 description = <text>
27657 @item (nnchoke-request-list-newsgroups &optional SERVER)
27659 The result data from this function should be the description of all
27660 groups available on the server.
27663 description-buffer = *description-line
27667 @item (nnchoke-request-newgroups DATE &optional SERVER)
27669 The result data from this function should be all groups that were
27670 created after @samp{date}, which is in normal human-readable date format
27671 (i.e., the date format used in mail and news headers, and returned by
27672 the function @code{message-make-date} by default). The data should be
27673 in the active buffer format.
27675 It is okay for this function to return ``too many'' groups; some back ends
27676 might find it cheaper to return the full list of groups, rather than
27677 just the new groups. But don't do this for back ends with many groups.
27678 Normally, if the user creates the groups herself, there won't be too
27679 many groups, so @code{nnml} and the like are probably safe. But for
27680 back ends like @code{nntp}, where the groups have been created by the
27681 server, it is quite likely that there can be many groups.
27684 @item (nnchoke-request-create-group GROUP &optional SERVER)
27686 This function should create an empty group with name @var{group}.
27688 There should be no return data.
27691 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
27693 This function should run the expiry process on all articles in the
27694 @var{articles} range (which is currently a simple list of article
27695 numbers.) It is left up to the back end to decide how old articles
27696 should be before they are removed by this function. If @var{force} is
27697 non-@code{nil}, all @var{articles} should be deleted, no matter how new
27700 This function should return a list of articles that it did not/was not
27703 There should be no result data returned.
27706 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
27708 This function should move @var{article} (which is a number) from
27709 @var{group} by calling @var{accept-form}.
27711 This function should ready the article in question for moving by
27712 removing any header lines it has added to the article, and generally
27713 should ``tidy up'' the article. Then it should @code{eval}
27714 @var{accept-form} in the buffer where the ``tidy'' article is. This
27715 will do the actual copying. If this @code{eval} returns a
27716 non-@code{nil} value, the article should be removed.
27718 If @var{last} is @code{nil}, that means that there is a high likelihood
27719 that there will be more requests issued shortly, so that allows some
27722 The function should return a cons where the @code{car} is the group name and
27723 the @code{cdr} is the article number that the article was entered as.
27725 The group should exist before the back end is asked to accept the
27726 article for that group.
27728 There should be no data returned.
27731 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
27733 This function takes the current buffer and inserts it into @var{group}.
27734 If @var{last} in @code{nil}, that means that there will be more calls to
27735 this function in short order.
27737 The function should return a cons where the @code{car} is the group name and
27738 the @code{cdr} is the article number that the article was entered as.
27740 There should be no data returned.
27743 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
27745 This function should remove @var{article} (which is a number) from
27746 @var{group} and insert @var{buffer} there instead.
27748 There should be no data returned.
27751 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
27753 This function should delete @var{group}. If @var{force}, it should
27754 really delete all the articles in the group, and then delete the group
27755 itself. (If there is such a thing as ``the group itself''.)
27757 There should be no data returned.
27760 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
27762 This function should rename @var{group} into @var{new-name}. All
27763 articles in @var{group} should move to @var{new-name}.
27765 There should be no data returned.
27770 @node Error Messaging
27771 @subsubsection Error Messaging
27773 @findex nnheader-report
27774 @findex nnheader-get-report
27775 The back ends should use the function @code{nnheader-report} to report
27776 error conditions---they should not raise errors when they aren't able to
27777 perform a request. The first argument to this function is the back end
27778 symbol, and the rest are interpreted as arguments to @code{format} if
27779 there are multiple of them, or just a string if there is one of them.
27780 This function must always returns @code{nil}.
27783 (nnheader-report 'nnchoke "You did something totally bogus")
27785 (nnheader-report 'nnchoke "Could not request group %s" group)
27788 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
27789 @code{nil} back from a server, and this function returns the most
27790 recently reported message for the back end in question. This function
27791 takes one argument---the server symbol.
27793 Internally, these functions access @var{back-end}@code{-status-string},
27794 so the @code{nnchoke} back end will have its error message stored in
27795 @code{nnchoke-status-string}.
27798 @node Writing New Back Ends
27799 @subsubsection Writing New Back Ends
27801 Many back ends are quite similar. @code{nnml} is just like
27802 @code{nnspool}, but it allows you to edit the articles on the server.
27803 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
27804 and it doesn't maintain overview databases. @code{nndir} is just like
27805 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
27808 It would make sense if it were possible to ``inherit'' functions from
27809 back ends when writing new back ends. And, indeed, you can do that if you
27810 want to. (You don't have to if you don't want to, of course.)
27812 All the back ends declare their public variables and functions by using a
27813 package called @code{nnoo}.
27815 To inherit functions from other back ends (and allow other back ends to
27816 inherit functions from the current back end), you should use the
27822 This macro declares the first parameter to be a child of the subsequent
27823 parameters. For instance:
27826 (nnoo-declare nndir
27830 @code{nndir} has declared here that it intends to inherit functions from
27831 both @code{nnml} and @code{nnmh}.
27834 This macro is equivalent to @code{defvar}, but registers the variable as
27835 a public server variable. Most state-oriented variables should be
27836 declared with @code{defvoo} instead of @code{defvar}.
27838 In addition to the normal @code{defvar} parameters, it takes a list of
27839 variables in the parent back ends to map the variable to when executing
27840 a function in those back ends.
27843 (defvoo nndir-directory nil
27844 "Where nndir will look for groups."
27845 nnml-current-directory nnmh-current-directory)
27848 This means that @code{nnml-current-directory} will be set to
27849 @code{nndir-directory} when an @code{nnml} function is called on behalf
27850 of @code{nndir}. (The same with @code{nnmh}.)
27852 @item nnoo-define-basics
27853 This macro defines some common functions that almost all back ends should
27857 (nnoo-define-basics nndir)
27861 This macro is just like @code{defun} and takes the same parameters. In
27862 addition to doing the normal @code{defun} things, it registers the
27863 function as being public so that other back ends can inherit it.
27865 @item nnoo-map-functions
27866 This macro allows mapping of functions from the current back end to
27867 functions from the parent back ends.
27870 (nnoo-map-functions nndir
27871 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27872 (nnmh-request-article 0 nndir-current-group 0 0))
27875 This means that when @code{nndir-retrieve-headers} is called, the first,
27876 third, and fourth parameters will be passed on to
27877 @code{nnml-retrieve-headers}, while the second parameter is set to the
27878 value of @code{nndir-current-group}.
27881 This macro allows importing functions from back ends. It should be the
27882 last thing in the source file, since it will only define functions that
27883 haven't already been defined.
27889 nnmh-request-newgroups)
27893 This means that calls to @code{nndir-request-list} should just be passed
27894 on to @code{nnmh-request-list}, while all public functions from
27895 @code{nnml} that haven't been defined in @code{nndir} yet should be
27900 Below is a slightly shortened version of the @code{nndir} back end.
27903 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
27904 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
27908 (require 'nnheader)
27912 (eval-when-compile (require 'cl))
27914 (nnoo-declare nndir
27917 (defvoo nndir-directory nil
27918 "Where nndir will look for groups."
27919 nnml-current-directory nnmh-current-directory)
27921 (defvoo nndir-nov-is-evil nil
27922 "*Non-nil means that nndir will never retrieve NOV headers."
27925 (defvoo nndir-current-group ""
27927 nnml-current-group nnmh-current-group)
27928 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
27929 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
27931 (defvoo nndir-status-string "" nil nnmh-status-string)
27932 (defconst nndir-version "nndir 1.0")
27934 ;;; @r{Interface functions.}
27936 (nnoo-define-basics nndir)
27938 (deffoo nndir-open-server (server &optional defs)
27939 (setq nndir-directory
27940 (or (cadr (assq 'nndir-directory defs))
27942 (unless (assq 'nndir-directory defs)
27943 (push `(nndir-directory ,server) defs))
27944 (push `(nndir-current-group
27945 ,(file-name-nondirectory
27946 (directory-file-name nndir-directory)))
27948 (push `(nndir-top-directory
27949 ,(file-name-directory (directory-file-name nndir-directory)))
27951 (nnoo-change-server 'nndir server defs))
27953 (nnoo-map-functions nndir
27954 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27955 (nnmh-request-article 0 nndir-current-group 0 0)
27956 (nnmh-request-group nndir-current-group 0 0)
27957 (nnmh-close-group nndir-current-group 0))
27961 nnmh-status-message
27963 nnmh-request-newgroups))
27969 @node Hooking New Back Ends Into Gnus
27970 @subsubsection Hooking New Back Ends Into Gnus
27972 @vindex gnus-valid-select-methods
27973 @findex gnus-declare-backend
27974 Having Gnus start using your new back end is rather easy---you just
27975 declare it with the @code{gnus-declare-backend} functions. This will
27976 enter the back end into the @code{gnus-valid-select-methods} variable.
27978 @code{gnus-declare-backend} takes two parameters---the back end name and
27979 an arbitrary number of @dfn{abilities}.
27984 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
27987 The above line would then go in the @file{nnchoke.el} file.
27989 The abilities can be:
27993 This is a mailish back end---followups should (probably) go via mail.
27995 This is a newsish back end---followups should (probably) go via news.
27997 This back end supports both mail and news.
27999 This is neither a post nor mail back end---it's something completely
28002 It supports respooling---or rather, it is able to modify its source
28003 articles and groups.
28005 The name of the server should be in the virtual server name. This is
28006 true for almost all back ends.
28007 @item prompt-address
28008 The user should be prompted for an address when doing commands like
28009 @kbd{B} in the group buffer. This is true for back ends like
28010 @code{nntp}, but not @code{nnmbox}, for instance.
28014 @node Mail-like Back Ends
28015 @subsubsection Mail-like Back Ends
28017 One of the things that separate the mail back ends from the rest of the
28018 back ends is the heavy dependence by most of the mail back ends on
28019 common functions in @file{nnmail.el}. For instance, here's the
28020 definition of @code{nnml-request-scan}:
28023 (deffoo nnml-request-scan (&optional group server)
28024 (setq nnml-article-file-alist nil)
28025 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
28028 It simply calls @code{nnmail-get-new-mail} with a few parameters,
28029 and @code{nnmail} takes care of all the moving and splitting of the
28032 This function takes four parameters.
28036 This should be a symbol to designate which back end is responsible for
28039 @item exit-function
28040 This function should be called after the splitting has been performed.
28042 @item temp-directory
28043 Where the temporary files should be stored.
28046 This optional argument should be a group name if the splitting is to be
28047 performed for one group only.
28050 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
28051 save each article. @var{back-end}@code{-active-number} will be called to
28052 find the article number assigned to this article.
28054 The function also uses the following variables:
28055 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
28056 this back end); and @var{back-end}@code{-group-alist} and
28057 @var{back-end}@code{-active-file} to generate the new active file.
28058 @var{back-end}@code{-group-alist} should be a group-active alist, like
28062 (("a-group" (1 . 10))
28063 ("some-group" (34 . 39)))
28067 @node Score File Syntax
28068 @subsection Score File Syntax
28070 Score files are meant to be easily parseable, but yet extremely
28071 mallable. It was decided that something that had the same read syntax
28072 as an Emacs Lisp list would fit that spec.
28074 Here's a typical score file:
28078 ("win95" -10000 nil s)
28085 BNF definition of a score file:
28088 score-file = "" / "(" *element ")"
28089 element = rule / atom
28090 rule = string-rule / number-rule / date-rule
28091 string-rule = "(" quote string-header quote space *string-match ")"
28092 number-rule = "(" quote number-header quote space *number-match ")"
28093 date-rule = "(" quote date-header quote space *date-match ")"
28095 string-header = "subject" / "from" / "references" / "message-id" /
28096 "xref" / "body" / "head" / "all" / "followup"
28097 number-header = "lines" / "chars"
28098 date-header = "date"
28099 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
28100 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
28101 score = "nil" / <integer>
28102 date = "nil" / <natural number>
28103 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
28104 "r" / "regex" / "R" / "Regex" /
28105 "e" / "exact" / "E" / "Exact" /
28106 "f" / "fuzzy" / "F" / "Fuzzy"
28107 number-match = "(" <integer> [ "" / [ space score [ "" /
28108 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
28109 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
28110 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
28111 space date [ "" / [ space date-match-t ] ] ] ] ")"
28112 date-match-t = "nil" / "at" / "before" / "after"
28113 atom = "(" [ required-atom / optional-atom ] ")"
28114 required-atom = mark / expunge / mark-and-expunge / files /
28115 exclude-files / read-only / touched
28116 optional-atom = adapt / local / eval
28117 mark = "mark" space nil-or-number
28118 nil-or-number = "nil" / <integer>
28119 expunge = "expunge" space nil-or-number
28120 mark-and-expunge = "mark-and-expunge" space nil-or-number
28121 files = "files" *[ space <string> ]
28122 exclude-files = "exclude-files" *[ space <string> ]
28123 read-only = "read-only" [ space "nil" / space "t" ]
28124 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
28125 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
28126 local = "local" *[ space "(" <string> space <form> ")" ]
28127 eval = "eval" space <form>
28128 space = *[ " " / <TAB> / <NEWLINE> ]
28131 Any unrecognized elements in a score file should be ignored, but not
28134 As you can see, white space is needed, but the type and amount of white
28135 space is irrelevant. This means that formatting of the score file is
28136 left up to the programmer---if it's simpler to just spew it all out on
28137 one looong line, then that's ok.
28139 The meaning of the various atoms are explained elsewhere in this
28140 manual (@pxref{Score File Format}).
28144 @subsection Headers
28146 Internally Gnus uses a format for storing article headers that
28147 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
28148 almost suspect that the author looked at the @acronym{NOV} specification and
28149 just shamelessly @emph{stole} the entire thing, and one would be right.
28151 @dfn{Header} is a severely overloaded term. ``Header'' is used in
28152 RFC 1036 to talk about lines in the head of an article (e.g.,
28153 @code{From}). It is used by many people as a synonym for
28154 ``head''---``the header and the body''. (That should be avoided, in my
28155 opinion.) And Gnus uses a format internally that it calls ``header'',
28156 which is what I'm talking about here. This is a 9-element vector,
28157 basically, with each header (ouch) having one slot.
28159 These slots are, in order: @code{number}, @code{subject}, @code{from},
28160 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
28161 @code{xref}, and @code{extra}. There are macros for accessing and
28162 setting these slots---they all have predictable names beginning with
28163 @code{mail-header-} and @code{mail-header-set-}, respectively.
28165 All these slots contain strings, except the @code{extra} slot, which
28166 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
28172 @sc{gnus} introduced a concept that I found so useful that I've started
28173 using it a lot and have elaborated on it greatly.
28175 The question is simple: If you have a large amount of objects that are
28176 identified by numbers (say, articles, to take a @emph{wild} example)
28177 that you want to qualify as being ``included'', a normal sequence isn't
28178 very useful. (A 200,000 length sequence is a bit long-winded.)
28180 The solution is as simple as the question: You just collapse the
28184 (1 2 3 4 5 6 10 11 12)
28187 is transformed into
28190 ((1 . 6) (10 . 12))
28193 To avoid having those nasty @samp{(13 . 13)} elements to denote a
28194 lonesome object, a @samp{13} is a valid element:
28197 ((1 . 6) 7 (10 . 12))
28200 This means that comparing two ranges to find out whether they are equal
28201 is slightly tricky:
28204 ((1 . 5) 7 8 (10 . 12))
28210 ((1 . 5) (7 . 8) (10 . 12))
28213 are equal. In fact, any non-descending list is a range:
28219 is a perfectly valid range, although a pretty long-winded one. This is
28226 and is equal to the previous range.
28228 Here's a BNF definition of ranges. Of course, one must remember the
28229 semantic requirement that the numbers are non-descending. (Any number
28230 of repetition of the same number is allowed, but apt to disappear in
28234 range = simple-range / normal-range
28235 simple-range = "(" number " . " number ")"
28236 normal-range = "(" start-contents ")"
28237 contents = "" / simple-range *[ " " contents ] /
28238 number *[ " " contents ]
28241 Gnus currently uses ranges to keep track of read articles and article
28242 marks. I plan on implementing a number of range operators in C if The
28243 Powers That Be are willing to let me. (I haven't asked yet, because I
28244 need to do some more thinking on what operators I need to make life
28245 totally range-based without ever having to convert back to normal
28250 @subsection Group Info
28252 Gnus stores all permanent info on groups in a @dfn{group info} list.
28253 This list is from three to six elements (or more) long and exhaustively
28254 describes the group.
28256 Here are two example group infos; one is a very simple group while the
28257 second is a more complex one:
28260 ("no.group" 5 ((1 . 54324)))
28262 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
28263 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
28265 ((auto-expire . t) (to-address . "ding@@gnus.org")))
28268 The first element is the @dfn{group name}---as Gnus knows the group,
28269 anyway. The second element is the @dfn{subscription level}, which
28270 normally is a small integer. (It can also be the @dfn{rank}, which is a
28271 cons cell where the @code{car} is the level and the @code{cdr} is the
28272 score.) The third element is a list of ranges of read articles. The
28273 fourth element is a list of lists of article marks of various kinds.
28274 The fifth element is the select method (or virtual server, if you like).
28275 The sixth element is a list of @dfn{group parameters}, which is what
28276 this section is about.
28278 Any of the last three elements may be missing if they are not required.
28279 In fact, the vast majority of groups will normally only have the first
28280 three elements, which saves quite a lot of cons cells.
28282 Here's a BNF definition of the group info format:
28285 info = "(" group space ralevel space read
28286 [ "" / [ space marks-list [ "" / [ space method [ "" /
28287 space parameters ] ] ] ] ] ")"
28288 group = quote <string> quote
28289 ralevel = rank / level
28290 level = <integer in the range of 1 to inf>
28291 rank = "(" level "." score ")"
28292 score = <integer in the range of 1 to inf>
28294 marks-lists = nil / "(" *marks ")"
28295 marks = "(" <string> range ")"
28296 method = "(" <string> *elisp-forms ")"
28297 parameters = "(" *elisp-forms ")"
28300 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
28301 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
28304 If you have a Gnus info and want to access the elements, Gnus offers a
28305 series of macros for getting/setting these elements.
28308 @item gnus-info-group
28309 @itemx gnus-info-set-group
28310 @findex gnus-info-group
28311 @findex gnus-info-set-group
28312 Get/set the group name.
28314 @item gnus-info-rank
28315 @itemx gnus-info-set-rank
28316 @findex gnus-info-rank
28317 @findex gnus-info-set-rank
28318 Get/set the group rank (@pxref{Group Score}).
28320 @item gnus-info-level
28321 @itemx gnus-info-set-level
28322 @findex gnus-info-level
28323 @findex gnus-info-set-level
28324 Get/set the group level.
28326 @item gnus-info-score
28327 @itemx gnus-info-set-score
28328 @findex gnus-info-score
28329 @findex gnus-info-set-score
28330 Get/set the group score (@pxref{Group Score}).
28332 @item gnus-info-read
28333 @itemx gnus-info-set-read
28334 @findex gnus-info-read
28335 @findex gnus-info-set-read
28336 Get/set the ranges of read articles.
28338 @item gnus-info-marks
28339 @itemx gnus-info-set-marks
28340 @findex gnus-info-marks
28341 @findex gnus-info-set-marks
28342 Get/set the lists of ranges of marked articles.
28344 @item gnus-info-method
28345 @itemx gnus-info-set-method
28346 @findex gnus-info-method
28347 @findex gnus-info-set-method
28348 Get/set the group select method.
28350 @item gnus-info-params
28351 @itemx gnus-info-set-params
28352 @findex gnus-info-params
28353 @findex gnus-info-set-params
28354 Get/set the group parameters.
28357 All the getter functions take one parameter---the info list. The setter
28358 functions take two parameters---the info list and the new value.
28360 The last three elements in the group info aren't mandatory, so it may be
28361 necessary to extend the group info before setting the element. If this
28362 is necessary, you can just pass on a non-@code{nil} third parameter to
28363 the three final setter functions to have this happen automatically.
28366 @node Extended Interactive
28367 @subsection Extended Interactive
28368 @cindex interactive
28369 @findex gnus-interactive
28371 Gnus extends the standard Emacs @code{interactive} specification
28372 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
28373 Prefixes}). Here's an example of how this is used:
28376 (defun gnus-summary-increase-score (&optional score symp)
28377 (interactive (gnus-interactive "P\ny"))
28382 The best thing to do would have been to implement
28383 @code{gnus-interactive} as a macro which would have returned an
28384 @code{interactive} form, but this isn't possible since Emacs checks
28385 whether a function is interactive or not by simply doing an @code{assq}
28386 on the lambda form. So, instead we have @code{gnus-interactive}
28387 function that takes a string and returns values that are usable to
28388 @code{interactive}.
28390 This function accepts (almost) all normal @code{interactive} specs, but
28395 @vindex gnus-current-prefix-symbol
28396 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
28400 @vindex gnus-current-prefix-symbols
28401 A list of the current symbolic prefixes---the
28402 @code{gnus-current-prefix-symbol} variable.
28405 The current article number---the @code{gnus-summary-article-number}
28409 The current article header---the @code{gnus-summary-article-header}
28413 The current group name---the @code{gnus-group-group-name}
28419 @node Emacs/XEmacs Code
28420 @subsection Emacs/XEmacs Code
28424 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
28425 platforms must be the primary one. I chose Emacs. Not because I don't
28426 like XEmacs or Mule, but because it comes first alphabetically.
28428 This means that Gnus will byte-compile under Emacs with nary a warning,
28429 while XEmacs will pump out gigabytes of warnings while byte-compiling.
28430 As I use byte-compilation warnings to help me root out trivial errors in
28431 Gnus, that's very useful.
28433 I've also consistently used Emacs function interfaces, but have used
28434 Gnusey aliases for the functions. To take an example: Emacs defines a
28435 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
28436 function. I then define a function called @code{gnus-run-at-time} that
28437 takes the same parameters as the Emacs @code{run-at-time}. When running
28438 Gnus under Emacs, the former function is just an alias for the latter.
28439 However, when running under XEmacs, the former is an alias for the
28440 following function:
28443 (defun gnus-xmas-run-at-time (time repeat function &rest args)
28447 (,function ,@@args))
28451 This sort of thing has been done for bunches of functions. Gnus does
28452 not redefine any native Emacs functions while running under XEmacs---it
28453 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
28456 In the cases where the XEmacs function interface was obviously cleaner,
28457 I used it instead. For example @code{gnus-region-active-p} is an alias
28458 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
28460 Of course, I could have chosen XEmacs as my native platform and done
28461 mapping functions the other way around. But I didn't. The performance
28462 hit these indirections impose on Gnus under XEmacs should be slight.
28465 @node Various File Formats
28466 @subsection Various File Formats
28469 * Active File Format:: Information on articles and groups available.
28470 * Newsgroups File Format:: Group descriptions.
28474 @node Active File Format
28475 @subsubsection Active File Format
28477 The active file lists all groups available on the server in
28478 question. It also lists the highest and lowest current article numbers
28481 Here's an excerpt from a typical active file:
28484 soc.motss 296030 293865 y
28485 alt.binaries.pictures.fractals 3922 3913 n
28486 comp.sources.unix 1605 1593 m
28487 comp.binaries.ibm.pc 5097 5089 y
28488 no.general 1000 900 y
28491 Here's a pseudo-BNF definition of this file:
28494 active = *group-line
28495 group-line = group spc high-number spc low-number spc flag <NEWLINE>
28496 group = <non-white-space string>
28498 high-number = <non-negative integer>
28499 low-number = <positive integer>
28500 flag = "y" / "n" / "m" / "j" / "x" / "=" group
28503 For a full description of this file, see the manual pages for
28504 @samp{innd}, in particular @samp{active(5)}.
28507 @node Newsgroups File Format
28508 @subsubsection Newsgroups File Format
28510 The newsgroups file lists groups along with their descriptions. Not all
28511 groups on the server have to be listed, and not all groups in the file
28512 have to exist on the server. The file is meant purely as information to
28515 The format is quite simple; a group name, a tab, and the description.
28516 Here's the definition:
28520 line = group tab description <NEWLINE>
28521 group = <non-white-space string>
28523 description = <string>
28528 @node Emacs for Heathens
28529 @section Emacs for Heathens
28531 Believe it or not, but some people who use Gnus haven't really used
28532 Emacs much before they embarked on their journey on the Gnus Love Boat.
28533 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
28534 region'', and ``set @code{gnus-flargblossen} to an alist where the key
28535 is a regexp that is used for matching on the group name'' are magical
28536 phrases with little or no meaning, then this appendix is for you. If
28537 you are already familiar with Emacs, just ignore this and go fondle your
28541 * Keystrokes:: Entering text and executing commands.
28542 * Emacs Lisp:: The built-in Emacs programming language.
28547 @subsection Keystrokes
28551 Q: What is an experienced Emacs user?
28554 A: A person who wishes that the terminal had pedals.
28557 Yes, when you use Emacs, you are apt to use the control key, the shift
28558 key and the meta key a lot. This is very annoying to some people
28559 (notably @code{vi}le users), and the rest of us just love the hell out
28560 of it. Just give up and submit. Emacs really does stand for
28561 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
28562 may have heard from other disreputable sources (like the Emacs author).
28564 The shift keys are normally located near your pinky fingers, and are
28565 normally used to get capital letters and stuff. You probably use it all
28566 the time. The control key is normally marked ``CTRL'' or something like
28567 that. The meta key is, funnily enough, never marked as such on any
28568 keyboard. The one I'm currently at has a key that's marked ``Alt'',
28569 which is the meta key on this keyboard. It's usually located somewhere
28570 to the left hand side of the keyboard, usually on the bottom row.
28572 Now, us Emacs people don't say ``press the meta-control-m key'',
28573 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
28574 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
28575 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
28576 down the control key, and hold it down while you press @kbd{k}''.
28577 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
28578 the control key and then press @kbd{k}''. Simple, ay?
28580 This is somewhat complicated by the fact that not all keyboards have a
28581 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
28582 means ``press escape, release escape, press @kbd{k}''. That's much more
28583 work than if you have a meta key, so if that's the case, I respectfully
28584 suggest you get a real keyboard with a meta key. You can't live without
28590 @subsection Emacs Lisp
28592 Emacs is the King of Editors because it's really a Lisp interpreter.
28593 Each and every key you tap runs some Emacs Lisp code snippet, and since
28594 Emacs Lisp is an interpreted language, that means that you can configure
28595 any key to run any arbitrary code. You just, like, do it.
28597 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
28598 functions. (These are byte-compiled for speed, but it's still
28599 interpreted.) If you decide that you don't like the way Gnus does
28600 certain things, it's trivial to have it do something a different way.
28601 (Well, at least if you know how to write Lisp code.) However, that's
28602 beyond the scope of this manual, so we are simply going to talk about
28603 some common constructs that you normally use in your @file{.emacs} file
28606 If you want to set the variable @code{gnus-florgbnize} to four (4), you
28607 write the following:
28610 (setq gnus-florgbnize 4)
28613 This function (really ``special form'') @code{setq} is the one that can
28614 set a variable to some value. This is really all you need to know. Now
28615 you can go and fill your @file{.emacs} file with lots of these to change
28618 If you have put that thing in your @file{.emacs} file, it will be read
28619 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
28620 start Emacs. If you want to change the variable right away, simply say
28621 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
28622 previous ``form'', which is a simple @code{setq} statement here.
28624 Go ahead---just try it, if you're located at your Emacs. After you
28625 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
28626 is the return value of the form you @code{eval}ed.
28630 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
28634 (setq gnus-read-active-file 'some)
28637 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
28638 @samp{nntp.ifi.uio.no}'', that means:
28641 (setq gnus-nntp-server "nntp.ifi.uio.no")
28644 So be careful not to mix up strings (the latter) with symbols (the
28645 former). The manual is unambiguous, but it can be confusing.
28648 @include gnus-faq.texi
28668 @c Local Variables:
28670 @c coding: iso-8859-1