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.
659 * Mail in a Newsreader:: Important introductory notes.
660 * Getting Started Reading Mail:: A simple cookbook example.
661 * Splitting Mail:: How to create mail groups.
662 * Mail Sources:: How to tell Gnus where to get mail from.
663 * Mail Back End Variables:: Variables for customizing mail handling.
664 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
665 * Group Mail Splitting:: Use group customize to drive mail splitting.
666 * Incorporating Old Mail:: What about the old mail you have?
667 * Expiring Mail:: Getting rid of unwanted mail.
668 * Washing Mail:: Removing cruft from the mail you get.
669 * Duplicates:: Dealing with duplicated mail.
670 * Not Reading Mail:: Using mail back ends for reading other files.
671 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
675 * Mail Source Specifiers:: How to specify what a mail source is.
676 * Mail Source Customization:: Some variables that influence things.
677 * Fetching Mail:: Using the mail source specifiers.
679 Choosing a Mail Back End
681 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
682 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
683 * Mail Spool:: Store your mail in a private spool?
684 * MH Spool:: An mhspool-like back end.
685 * Maildir:: Another one-file-per-message format.
686 * Mail Folders:: Having one file for each group.
687 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
692 * Web Searches:: Creating groups from articles that match a string.
693 * Slashdot:: Reading the Slashdot comments.
694 * Ultimate:: The Ultimate Bulletin Board systems.
695 * Web Archive:: Reading mailing list archived on web.
696 * RSS:: Reading RDF site summary.
697 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
701 * Splitting in IMAP:: Splitting mail with nnimap.
702 * Expiring in IMAP:: Expiring mail with nnimap.
703 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
704 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
705 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
706 * Debugging IMAP:: What to do when things don't work.
710 * Directory Groups:: You can read a directory as if it was a newsgroup.
711 * Anything Groups:: Dired? Who needs dired?
712 * Document Groups:: Single files can be the basis of a group.
713 * SOUP:: Reading @sc{soup} packets ``offline''.
714 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
718 * Document Server Internals:: How to add your own document types.
722 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
723 * SOUP Groups:: A back end for reading @sc{soup} packets.
724 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
728 * Virtual Groups:: Combining articles from many groups.
729 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
733 * Agent Basics:: How it all is supposed to work.
734 * Agent Categories:: How to tell the Gnus Agent what to download.
735 * Agent Commands:: New commands for all the buffers.
736 * Agent Visuals:: Ways that the agent may effect your summary buffer.
737 * Agent as Cache:: The Agent is a big cache too.
738 * Agent Expiry:: How to make old articles go away.
739 * Agent Regeneration:: How to recover from lost connections and other accidents.
740 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
741 * Outgoing Messages:: What happens when you post/mail something?
742 * Agent Variables:: Customizing is fun.
743 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
744 * Batching Agents:: How to fetch news from a @code{cron} job.
745 * Agent Caveats:: What you think it'll do and what it does.
749 * Category Syntax:: What a category looks like.
750 * Category Buffer:: A buffer for maintaining categories.
751 * Category Variables:: Customize'r'Us.
755 * Group Agent Commands:: Configure groups and fetch their contents.
756 * Summary Agent Commands:: Manually select then fetch specific articles.
757 * Server Agent Commands:: Select the servers that are supported by the agent.
761 * Summary Score Commands:: Adding score entries for the current group.
762 * Group Score Commands:: General score commands.
763 * Score Variables:: Customize your scoring. (My, what terminology).
764 * Score File Format:: What a score file may contain.
765 * Score File Editing:: You can edit score files by hand as well.
766 * Adaptive Scoring:: Big Sister Gnus knows what you read.
767 * Home Score File:: How to say where new score entries are to go.
768 * Followups To Yourself:: Having Gnus notice when people answer you.
769 * Scoring On Other Headers:: Scoring on non-standard headers.
770 * Scoring Tips:: How to score effectively.
771 * Reverse Scoring:: That problem child of old is not problem.
772 * Global Score Files:: Earth-spanning, ear-splitting score files.
773 * Kill Files:: They are still here, but they can be ignored.
774 * Converting Kill Files:: Translating kill files to score files.
775 * Advanced Scoring:: Using logical expressions to build score rules.
776 * Score Decays:: It can be useful to let scores wither away.
780 * Advanced Scoring Syntax:: A definition.
781 * Advanced Scoring Examples:: What they look like.
782 * Advanced Scoring Tips:: Getting the most out of it.
786 * Process/Prefix:: A convention used by many treatment commands.
787 * Interactive:: Making Gnus ask you many questions.
788 * Symbolic Prefixes:: How to supply some Gnus functions with options.
789 * Formatting Variables:: You can specify what buffers should look like.
790 * Window Layout:: Configuring the Gnus buffer windows.
791 * Faces and Fonts:: How to change how faces look.
792 * Compilation:: How to speed Gnus up.
793 * Mode Lines:: Displaying information in the mode lines.
794 * Highlighting and Menus:: Making buffers look all nice and cozy.
795 * Buttons:: Get tendinitis in ten easy steps!
796 * Daemons:: Gnus can do things behind your back.
797 * NoCeM:: How to avoid spam and other fatty foods.
798 * Undo:: Some actions can be undone.
799 * Predicate Specifiers:: Specifying predicates.
800 * Moderation:: What to do if you're a moderator.
801 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
802 * Fuzzy Matching:: What's the big fuzz?
803 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
804 * Other modes:: Interaction with other modes.
805 * Various Various:: Things that are really various.
809 * Formatting Basics:: A formatting variable is basically a format string.
810 * Mode Line Formatting:: Some rules about mode line formatting variables.
811 * Advanced Formatting:: Modifying output in various ways.
812 * User-Defined Specs:: Having Gnus call your own functions.
813 * Formatting Fonts:: Making the formatting look colorful and nice.
814 * Positioning Point:: Moving point to a position after an operation.
815 * Tabulation:: Tabulating your output.
816 * Wide Characters:: Dealing with wide characters.
820 * X-Face:: Display a funky, teensy black-and-white image.
821 * Face:: Display a funkier, teensier colored image.
822 * Smileys:: Show all those happy faces the way they were meant to be shown.
823 * Picons:: How to display pictures of what you're reading.
824 * XVarious:: Other XEmacsy Gnusey variables.
828 * The problem of spam:: Some background, and some solutions
829 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
830 * SpamAssassin:: How to use external anti-spam tools.
831 * Hashcash:: Reduce spam by burning CPU time.
832 * Filtering Spam Using The Spam ELisp Package::
833 * Filtering Spam Using Statistics with spam-stat::
835 Filtering Spam Using The Spam ELisp Package
837 * Spam ELisp Package Sequence of Events::
838 * Spam ELisp Package Filtering of Incoming Mail::
839 * Spam ELisp Package Global Variables::
840 * Spam ELisp Package Configuration Examples::
841 * Blacklists and Whitelists::
843 * Gmane Spam Reporting::
844 * Anti-spam Hashcash Payments::
846 * Regular Expressions Header Matching::
848 * SpamAssassin back end::
849 * ifile spam filtering::
850 * spam-stat spam filtering::
852 * Extending the Spam ELisp package::
854 Filtering Spam Using Statistics with spam-stat
856 * Creating a spam-stat dictionary::
857 * Splitting mail using spam-stat::
858 * Low-level interface to the spam-stat dictionary::
862 * XEmacs:: Requirements for installing under XEmacs.
863 * History:: How Gnus got where it is today.
864 * On Writing Manuals:: Why this is not a beginner's guide.
865 * Terminology:: We use really difficult, like, words here.
866 * Customization:: Tailoring Gnus to your needs.
867 * Troubleshooting:: What you might try if things do not work.
868 * Gnus Reference Guide:: Rilly, rilly technical stuff.
869 * Emacs for Heathens:: A short introduction to Emacsian terms.
870 * Frequently Asked Questions:: The Gnus FAQ
874 * Gnus Versions:: What Gnus versions have been released.
875 * Other Gnus Versions:: Other Gnus versions that also have been released.
876 * Why?:: What's the point of Gnus?
877 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
878 * Conformity:: Gnus tries to conform to all standards.
879 * Emacsen:: Gnus can be run on a few modern Emacsen.
880 * Gnus Development:: How Gnus is developed.
881 * Contributors:: Oodles of people.
882 * New Features:: Pointers to some of the new stuff in Gnus.
886 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
887 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
888 * Red Gnus:: Third time best---Gnus 5.4/5.5.
889 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
890 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
891 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
892 * No Gnus:: Lars, FIXME!
896 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
897 * Slow Terminal Connection:: You run a remote Emacs.
898 * Little Disk Space:: You feel that having large setup files is icky.
899 * Slow Machine:: You feel like buying a faster machine.
903 * Gnus Utility Functions:: Common functions and variable to use.
904 * Back End Interface:: How Gnus communicates with the servers.
905 * Score File Syntax:: A BNF definition of the score file standard.
906 * Headers:: How Gnus stores headers internally.
907 * Ranges:: A handy format for storing mucho numbers.
908 * Group Info:: The group info format.
909 * Extended Interactive:: Symbolic prefixes and stuff.
910 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
911 * Various File Formats:: Formats of files that Gnus use.
915 * Required Back End Functions:: Functions that must be implemented.
916 * Optional Back End Functions:: Functions that need not be implemented.
917 * Error Messaging:: How to get messages and report errors.
918 * Writing New Back Ends:: Extending old back ends.
919 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
920 * Mail-like Back Ends:: Some tips on mail back ends.
924 * Active File Format:: Information on articles and groups available.
925 * Newsgroups File Format:: Group descriptions.
929 * Keystrokes:: Entering text and executing commands.
930 * Emacs Lisp:: The built-in Emacs programming language.
936 @chapter Starting gnus
941 If your system administrator has set things up properly, starting gnus
942 and reading news is extremely easy---you just type @kbd{M-x gnus} in
945 @findex gnus-other-frame
946 @kindex M-x gnus-other-frame
947 If you want to start gnus in a different frame, you can use the command
948 @kbd{M-x gnus-other-frame} instead.
950 If things do not go smoothly at startup, you have to twiddle some
951 variables in your @file{~/.gnus.el} file. This file is similar to
952 @file{~/.emacs}, but is read when Gnus starts.
954 If you puzzle at any terms used in this manual, please refer to the
955 terminology section (@pxref{Terminology}).
958 * Finding the News:: Choosing a method for getting news.
959 * The First Time:: What does Gnus do the first time you start it?
960 * The Server is Down:: How can I read my mail then?
961 * Slave Gnusae:: You can have more than one Gnus active at a time.
962 * Fetching a Group:: Starting Gnus just to read a group.
963 * New Groups:: What is Gnus supposed to do with new groups?
964 * Changing Servers:: You may want to move from one server to another.
965 * Startup Files:: Those pesky startup files---@file{.newsrc}.
966 * Auto Save:: Recovering from a crash.
967 * The Active File:: Reading the active file over a slow line Takes Time.
968 * Startup Variables:: Other variables you might change.
972 @node Finding the News
973 @section Finding the News
976 @vindex gnus-select-method
978 The @code{gnus-select-method} variable says where gnus should look for
979 news. This variable should be a list where the first element says
980 @dfn{how} and the second element says @dfn{where}. This method is your
981 native method. All groups not fetched with this method are
984 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
985 you want to get your daily dosage of news from, you'd say:
988 (setq gnus-select-method '(nntp "news.somewhere.edu"))
991 If you want to read directly from the local spool, say:
994 (setq gnus-select-method '(nnspool ""))
997 If you can use a local spool, you probably should, as it will almost
998 certainly be much faster. But do not use the local spool if your
999 server is running Leafnode; in this case, use @code{(nntp "localhost")}.
1001 @vindex gnus-nntpserver-file
1003 @cindex @acronym{NNTP} server
1004 If this variable is not set, gnus will take a look at the
1005 @env{NNTPSERVER} environment variable. If that variable isn't set,
1006 gnus will see whether @code{gnus-nntpserver-file}
1007 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1008 If that fails as well, gnus will try to use the machine running Emacs
1009 as an @acronym{NNTP} server. That's a long shot, though.
1011 @vindex gnus-nntp-server
1012 If @code{gnus-nntp-server} is set, this variable will override
1013 @code{gnus-select-method}. You should therefore set
1014 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1016 @vindex gnus-secondary-servers
1017 @vindex gnus-nntp-server
1018 You can also make gnus prompt you interactively for the name of an
1019 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1020 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
1021 in the @code{gnus-secondary-servers} list (if any). You can also just
1022 type in the name of any server you feel like visiting. (Note that this
1023 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1024 gnus} later in the same Emacs session, Gnus will contact the same
1027 @findex gnus-group-browse-foreign-server
1029 However, if you use one @acronym{NNTP} server regularly and are just
1030 interested in a couple of groups from a different server, you would be
1031 better served by using the @kbd{B} command in the group buffer. It will
1032 let you have a look at what groups are available, and you can subscribe
1033 to any of the groups you want to. This also makes @file{.newsrc}
1034 maintenance much tidier. @xref{Foreign Groups}.
1036 @vindex gnus-secondary-select-methods
1038 A slightly different approach to foreign groups is to set the
1039 @code{gnus-secondary-select-methods} variable. The select methods
1040 listed in this variable are in many ways just as native as the
1041 @code{gnus-select-method} server. They will also be queried for active
1042 files during startup (if that's required), and new newsgroups that
1043 appear on these servers will be subscribed (or not) just as native
1046 For instance, if you use the @code{nnmbox} back end to read your mail,
1047 you would typically set this variable to
1050 (setq gnus-secondary-select-methods '((nnmbox "")))
1054 @node The First Time
1055 @section The First Time
1056 @cindex first time usage
1058 If no startup files exist, gnus will try to determine what groups should
1059 be subscribed by default.
1061 @vindex gnus-default-subscribed-newsgroups
1062 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1063 will subscribe you to just those groups in that list, leaving the rest
1064 killed. Your system administrator should have set this variable to
1067 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1068 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1069 here as @dfn{whatever Lars thinks you should read}.)
1071 You'll also be subscribed to the gnus documentation group, which should
1072 help you with most common problems.
1074 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1075 use the normal functions for handling new groups, and not do anything
1079 @node The Server is Down
1080 @section The Server is Down
1081 @cindex server errors
1083 If the default server is down, gnus will understandably have some
1084 problems starting. However, if you have some mail groups in addition to
1085 the news groups, you may want to start gnus anyway.
1087 Gnus, being the trusting sort of program, will ask whether to proceed
1088 without a native select method if that server can't be contacted. This
1089 will happen whether the server doesn't actually exist (i.e., you have
1090 given the wrong address) or the server has just momentarily taken ill
1091 for some reason or other. If you decide to continue and have no foreign
1092 groups, you'll find it difficult to actually do anything in the group
1093 buffer. But, hey, that's your problem. Blllrph!
1095 @findex gnus-no-server
1096 @kindex M-x gnus-no-server
1098 If you know that the server is definitely down, or you just want to read
1099 your mail without bothering with the server at all, you can use the
1100 @code{gnus-no-server} command to start gnus. That might come in handy
1101 if you're in a hurry as well. This command will not attempt to contact
1102 your primary server---instead, it will just activate all groups on level
1103 1 and 2. (You should preferably keep no native groups on those two
1104 levels.) Also @pxref{Group Levels}.
1108 @section Slave Gnusae
1111 You might want to run more than one Emacs with more than one gnus at the
1112 same time. If you are using different @file{.newsrc} files (e.g., if you
1113 are using the two different gnusae to read from two different servers),
1114 that is no problem whatsoever. You just do it.
1116 The problem appears when you want to run two Gnusae that use the same
1117 @file{.newsrc} file.
1119 To work around that problem some, we here at the Think-Tank at the gnus
1120 Towers have come up with a new concept: @dfn{Masters} and
1121 @dfn{slaves}. (We have applied for a patent on this concept, and have
1122 taken out a copyright on those words. If you wish to use those words in
1123 conjunction with each other, you have to send $1 per usage instance to
1124 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1125 Applications}) will be much more expensive, of course.)
1128 Anyway, you start one gnus up the normal way with @kbd{M-x gnus} (or
1129 however you do it). Each subsequent slave gnusae should be started with
1130 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1131 files, but instead save @dfn{slave files} that contain information only
1132 on what groups have been read in the slave session. When a master gnus
1133 starts, it will read (and delete) these slave files, incorporating all
1134 information from them. (The slave files will be read in the sequence
1135 they were created, so the latest changes will have precedence.)
1137 Information from the slave files has, of course, precedence over the
1138 information in the normal (i.e., master) @file{.newsrc} file.
1140 If the @file{.newsrc*} files have not been saved in the master when the
1141 slave starts, you may be prompted as to whether to read an auto-save
1142 file. If you answer ``yes'', the unsaved changes to the master will be
1143 incorporated into the slave. If you answer ``no'', the slave may see some
1144 messages as unread that have been read in the master.
1146 @node Fetching a Group
1147 @section Fetching a Group
1148 @cindex fetching a group
1150 @findex gnus-fetch-group
1151 It is sometimes convenient to be able to just say ``I want to read this
1152 group and I don't care whether gnus has been started or not''. This is
1153 perhaps more useful for people who write code than for users, but the
1154 command @code{gnus-fetch-group} provides this functionality in any case.
1155 It takes the group name as a parameter.
1161 @cindex subscription
1163 @vindex gnus-check-new-newsgroups
1164 If you are satisfied that you really never want to see any new groups,
1165 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1166 also save you some time at startup. Even if this variable is
1167 @code{nil}, you can always subscribe to the new groups just by pressing
1168 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1169 is @code{ask-server} by default. If you set this variable to
1170 @code{always}, then Gnus will query the back ends for new groups even
1171 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1174 * Checking New Groups:: Determining what groups are new.
1175 * Subscription Methods:: What Gnus should do with new groups.
1176 * Filtering New Groups:: Making Gnus ignore certain new groups.
1180 @node Checking New Groups
1181 @subsection Checking New Groups
1183 Gnus normally determines whether a group is new or not by comparing the
1184 list of groups from the active file(s) with the lists of subscribed and
1185 dead groups. This isn't a particularly fast method. If
1186 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1187 server for new groups since the last time. This is both faster and
1188 cheaper. This also means that you can get rid of the list of killed
1189 groups altogether, so you may set @code{gnus-save-killed-list} to
1190 @code{nil}, which will save time both at startup, at exit, and all over.
1191 Saves disk space, too. Why isn't this the default, then?
1192 Unfortunately, not all servers support this command.
1194 I bet I know what you're thinking now: How do I find out whether my
1195 server supports @code{ask-server}? No? Good, because I don't have a
1196 fail-safe answer. I would suggest just setting this variable to
1197 @code{ask-server} and see whether any new groups appear within the next
1198 few days. If any do, then it works. If none do, then it doesn't
1199 work. I could write a function to make gnus guess whether the server
1200 supports @code{ask-server}, but it would just be a guess. So I won't.
1201 You could @code{telnet} to the server and say @code{HELP} and see
1202 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1203 it does, then it might work. (But there are servers that lists
1204 @samp{NEWGROUPS} without supporting the function properly.)
1206 This variable can also be a list of select methods. If so, gnus will
1207 issue an @code{ask-server} command to each of the select methods, and
1208 subscribe them (or not) using the normal methods. This might be handy
1209 if you are monitoring a few servers for new groups. A side effect is
1210 that startup will take much longer, so you can meditate while waiting.
1211 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1214 @node Subscription Methods
1215 @subsection Subscription Methods
1217 @vindex gnus-subscribe-newsgroup-method
1218 What gnus does when it encounters a new group is determined by the
1219 @code{gnus-subscribe-newsgroup-method} variable.
1221 This variable should contain a function. This function will be called
1222 with the name of the new group as the only parameter.
1224 Some handy pre-fab functions are:
1228 @item gnus-subscribe-zombies
1229 @vindex gnus-subscribe-zombies
1230 Make all new groups zombies. This is the default. You can browse the
1231 zombies later (with @kbd{A z}) and either kill them all off properly
1232 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1234 @item gnus-subscribe-randomly
1235 @vindex gnus-subscribe-randomly
1236 Subscribe all new groups in arbitrary order. This really means that all
1237 new groups will be added at ``the top'' of the group buffer.
1239 @item gnus-subscribe-alphabetically
1240 @vindex gnus-subscribe-alphabetically
1241 Subscribe all new groups in alphabetical order.
1243 @item gnus-subscribe-hierarchically
1244 @vindex gnus-subscribe-hierarchically
1245 Subscribe all new groups hierarchically. The difference between this
1246 function and @code{gnus-subscribe-alphabetically} is slight.
1247 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1248 alphabetical fashion, while this function will enter groups into its
1249 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1250 @samp{comp} hierarchy, this function will not mess that configuration
1251 up. Or something like that.
1253 @item gnus-subscribe-interactively
1254 @vindex gnus-subscribe-interactively
1255 Subscribe new groups interactively. This means that gnus will ask
1256 you about @strong{all} new groups. The groups you choose to subscribe
1257 to will be subscribed hierarchically.
1259 @item gnus-subscribe-killed
1260 @vindex gnus-subscribe-killed
1261 Kill all new groups.
1263 @item gnus-subscribe-topics
1264 @vindex gnus-subscribe-topics
1265 Put the groups into the topic that has a matching @code{subscribe} topic
1266 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1267 topic parameter that looks like
1273 will mean that all groups that match that regex will be subscribed under
1276 If no topics match the groups, the groups will be subscribed in the
1281 @vindex gnus-subscribe-hierarchical-interactive
1282 A closely related variable is
1283 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1284 mouthful.) If this variable is non-@code{nil}, gnus will ask you in a
1285 hierarchical fashion whether to subscribe to new groups or not. Gnus
1286 will ask you for each sub-hierarchy whether you want to descend the
1289 One common mistake is to set the variable a few paragraphs above
1290 (@code{gnus-subscribe-newsgroup-method}) to
1291 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1292 will not work. This is ga-ga. So don't do it.
1295 @node Filtering New Groups
1296 @subsection Filtering New Groups
1298 A nice and portable way to control which new newsgroups should be
1299 subscribed (or ignored) is to put an @dfn{options} line at the start of
1300 the @file{.newsrc} file. Here's an example:
1303 options -n !alt.all !rec.all sci.all
1306 @vindex gnus-subscribe-options-newsgroup-method
1307 This line obviously belongs to a serious-minded intellectual scientific
1308 person (or she may just be plain old boring), because it says that all
1309 groups that have names beginning with @samp{alt} and @samp{rec} should
1310 be ignored, and all groups with names beginning with @samp{sci} should
1311 be subscribed. Gnus will not use the normal subscription method for
1312 subscribing these groups.
1313 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1314 variable defaults to @code{gnus-subscribe-alphabetically}.
1316 @vindex gnus-options-not-subscribe
1317 @vindex gnus-options-subscribe
1318 If you don't want to mess with your @file{.newsrc} file, you can just
1319 set the two variables @code{gnus-options-subscribe} and
1320 @code{gnus-options-not-subscribe}. These two variables do exactly the
1321 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1322 and if the new group matches the former, it will be unconditionally
1323 subscribed, and if it matches the latter, it will be ignored.
1325 @vindex gnus-auto-subscribed-groups
1326 Yet another variable that meddles here is
1327 @code{gnus-auto-subscribed-groups}. It works exactly like
1328 @code{gnus-options-subscribe}, and is therefore really superfluous,
1329 but I thought it would be nice to have two of these. This variable is
1330 more meant for setting some ground rules, while the other variable is
1331 used more for user fiddling. By default this variable makes all new
1332 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1333 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1334 subscribed. If you don't like that, just set this variable to
1337 New groups that match this regexp are subscribed using
1338 @code{gnus-subscribe-options-newsgroup-method}.
1341 @node Changing Servers
1342 @section Changing Servers
1343 @cindex changing servers
1345 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1346 This happens very rarely, but perhaps you change jobs, or one server is
1347 very flaky and you want to use another.
1349 Changing the server is pretty easy, right? You just change
1350 @code{gnus-select-method} to point to the new server?
1354 Article numbers are not (in any way) kept synchronized between different
1355 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1356 you have read is by keeping track of article numbers. So when you
1357 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1360 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1361 file from one server to another. They all have one thing in
1362 common---they take a looong time to run. You don't want to use these
1363 functions more than absolutely necessary.
1365 @kindex M-x gnus-change-server
1366 @findex gnus-change-server
1367 If you have access to both servers, Gnus can request the headers for all
1368 the articles you have read and compare @code{Message-ID}s and map the
1369 article numbers of the read articles and article marks. The @kbd{M-x
1370 gnus-change-server} command will do this for all your native groups. It
1371 will prompt for the method you want to move to.
1373 @kindex M-x gnus-group-move-group-to-server
1374 @findex gnus-group-move-group-to-server
1375 You can also move individual groups with the @kbd{M-x
1376 gnus-group-move-group-to-server} command. This is useful if you want to
1377 move a (foreign) group from one server to another.
1379 @kindex M-x gnus-group-clear-data-on-native-groups
1380 @findex gnus-group-clear-data-on-native-groups
1381 If you don't have access to both the old and new server, all your marks
1382 and read ranges have become worthless. You can use the @kbd{M-x
1383 gnus-group-clear-data-on-native-groups} command to clear out all data
1384 that you have on your native groups. Use with caution.
1386 @kindex M-x gnus-group-clear-data
1387 @findex gnus-group-clear-data
1388 Clear the data from the current group only---nix out marks and the
1389 list of read articles (@code{gnus-group-clear-data}).
1391 After changing servers, you @strong{must} move the cache hierarchy away,
1392 since the cached articles will have wrong article numbers, which will
1393 affect which articles Gnus thinks are read.
1394 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1395 to have it done automatically; for @code{gnus-group-clear-data}, you
1396 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1397 cache for all groups).
1401 @section Startup Files
1402 @cindex startup files
1407 Now, you all know about the @file{.newsrc} file. All subscription
1408 information is traditionally stored in this file.
1410 Things got a bit more complicated with @sc{gnus}. In addition to
1411 keeping the @file{.newsrc} file updated, it also used a file called
1412 @file{.newsrc.el} for storing all the information that didn't fit into
1413 the @file{.newsrc} file. (Actually, it also duplicated everything in
1414 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1415 files was the most recently saved, which enabled people to swap between
1416 @sc{gnus} and other newsreaders.
1418 That was kinda silly, so Gnus went one better: In addition to the
1419 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1420 @file{.newsrc.eld}. It will read whichever of these files that are most
1421 recent, but it will never write a @file{.newsrc.el} file. You should
1422 never delete the @file{.newsrc.eld} file---it contains much information
1423 not stored in the @file{.newsrc} file.
1425 @vindex gnus-save-newsrc-file
1426 @vindex gnus-read-newsrc-file
1427 You can turn off writing the @file{.newsrc} file by setting
1428 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1429 the file and save some space, as well as exiting from gnus faster.
1430 However, this will make it impossible to use other newsreaders than
1431 gnus. But hey, who would want to, right? Similarly, setting
1432 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1433 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1434 convenient if you have a tendency to use Netscape once in a while.
1436 @vindex gnus-save-killed-list
1437 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1438 will not save the list of killed groups to the startup file. This will
1439 save both time (when starting and quitting) and space (on disk). It
1440 will also mean that Gnus has no record of what groups are new or old,
1441 so the automatic new groups subscription methods become meaningless.
1442 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1443 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1444 Groups}). This variable can also be a regular expression. If that's
1445 the case, remove all groups that do not match this regexp before
1446 saving. This can be useful in certain obscure situations that involve
1447 several servers where not all servers support @code{ask-server}.
1449 @vindex gnus-startup-file
1450 @vindex gnus-backup-startup-file
1451 @vindex version-control
1452 The @code{gnus-startup-file} variable says where the startup files are.
1453 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1454 file being whatever that one is, with a @samp{.eld} appended.
1455 If you want version control for this file, set
1456 @code{gnus-backup-startup-file}. It respects the same values as the
1457 @code{version-control} variable.
1459 @vindex gnus-save-newsrc-hook
1460 @vindex gnus-save-quick-newsrc-hook
1461 @vindex gnus-save-standard-newsrc-hook
1462 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1463 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1464 saving the @file{.newsrc.eld} file, and
1465 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1466 @file{.newsrc} file. The latter two are commonly used to turn version
1467 control on or off. Version control is on by default when saving the
1468 startup files. If you want to turn backup creation off, say something like:
1471 (defun turn-off-backup ()
1472 (set (make-local-variable 'backup-inhibited) t))
1474 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1475 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1478 @vindex gnus-init-file
1479 @vindex gnus-site-init-file
1480 When gnus starts, it will read the @code{gnus-site-init-file}
1481 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1482 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1483 and can be used to avoid cluttering your @file{~/.emacs} and
1484 @file{site-init} files with gnus stuff. Gnus will also check for files
1485 with the same names as these, but with @file{.elc} and @file{.el}
1486 suffixes. In other words, if you have set @code{gnus-init-file} to
1487 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1488 and finally @file{~/.gnus} (in this order).
1494 @cindex dribble file
1497 Whenever you do something that changes the gnus data (reading articles,
1498 catching up, killing/subscribing groups), the change is added to a
1499 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1500 Emacs way. If your Emacs should crash before you have saved the
1501 @file{.newsrc} files, all changes you have made can be recovered from
1504 If gnus detects this file at startup, it will ask the user whether to
1505 read it. The auto save file is deleted whenever the real startup file is
1508 @vindex gnus-use-dribble-file
1509 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1510 maintain a dribble buffer. The default is @code{t}.
1512 @vindex gnus-dribble-directory
1513 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1514 this variable is @code{nil}, which it is by default, gnus will dribble
1515 into the directory where the @file{.newsrc} file is located. (This is
1516 normally the user's home directory.) The dribble file will get the same
1517 file permissions as the @file{.newsrc} file.
1519 @vindex gnus-always-read-dribble-file
1520 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1521 read the dribble file on startup without querying the user.
1524 @node The Active File
1525 @section The Active File
1527 @cindex ignored groups
1529 When gnus starts, or indeed whenever it tries to determine whether new
1530 articles have arrived, it reads the active file. This is a very large
1531 file that lists all the active groups and articles on the server.
1533 @vindex gnus-ignored-newsgroups
1534 Before examining the active file, gnus deletes all lines that match the
1535 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1536 any groups with bogus names, but you can use this variable to make gnus
1537 ignore hierarchies you aren't ever interested in. However, this is not
1538 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1539 Groups} for an overview of other variables that can be used instead.
1542 @c @code{nil} by default, and will slow down active file handling somewhat
1543 @c if you set it to anything else.
1545 @vindex gnus-read-active-file
1547 The active file can be rather Huge, so if you have a slow network, you
1548 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1549 reading the active file. This variable is @code{some} by default.
1551 Gnus will try to make do by getting information just on the groups that
1552 you actually subscribe to.
1554 Note that if you subscribe to lots and lots of groups, setting this
1555 variable to @code{nil} will probably make gnus slower, not faster. At
1556 present, having this variable @code{nil} will slow gnus down
1557 considerably, unless you read news over a 2400 baud modem.
1559 This variable can also have the value @code{some}. Gnus will then
1560 attempt to read active info only on the subscribed groups. On some
1561 servers this is quite fast (on sparkling, brand new INN servers that
1562 support the @code{LIST ACTIVE group} command), on others this isn't fast
1563 at all. In any case, @code{some} should be faster than @code{nil}, and
1564 is certainly faster than @code{t} over slow lines.
1566 Some news servers (old versions of Leafnode and old versions of INN, for
1567 instance) do not support the @code{LIST ACTIVE group}. For these
1568 servers, @code{nil} is probably the most efficient value for this
1571 If this variable is @code{nil}, gnus will ask for group info in total
1572 lock-step, which isn't very fast. If it is @code{some} and you use an
1573 @acronym{NNTP} server, gnus will pump out commands as fast as it can, and
1574 read all the replies in one swoop. This will normally result in better
1575 performance, but if the server does not support the aforementioned
1576 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1578 If you think that starting up Gnus takes too long, try all the three
1579 different values for this variable and see what works best for you.
1581 In any case, if you use @code{some} or @code{nil}, you should definitely
1582 kill all groups that you aren't interested in to speed things up.
1584 Note that this variable also affects active file retrieval from
1585 secondary select methods.
1588 @node Startup Variables
1589 @section Startup Variables
1593 @item gnus-load-hook
1594 @vindex gnus-load-hook
1595 A hook run while gnus is being loaded. Note that this hook will
1596 normally be run just once in each Emacs session, no matter how many
1597 times you start gnus.
1599 @item gnus-before-startup-hook
1600 @vindex gnus-before-startup-hook
1601 A hook run after starting up gnus successfully.
1603 @item gnus-startup-hook
1604 @vindex gnus-startup-hook
1605 A hook run as the very last thing after starting up gnus
1607 @item gnus-started-hook
1608 @vindex gnus-started-hook
1609 A hook that is run as the very last thing after starting up gnus
1612 @item gnus-setup-news-hook
1613 @vindex gnus-setup-news-hook
1614 A hook that is run after reading the @file{.newsrc} file(s), but before
1615 generating the group buffer.
1617 @item gnus-check-bogus-newsgroups
1618 @vindex gnus-check-bogus-newsgroups
1619 If non-@code{nil}, gnus will check for and delete all bogus groups at
1620 startup. A @dfn{bogus group} is a group that you have in your
1621 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1622 bogus groups can take quite a while, so to save time and resources it's
1623 best to leave this option off, and do the checking for bogus groups once
1624 in a while from the group buffer instead (@pxref{Group Maintenance}).
1626 @item gnus-inhibit-startup-message
1627 @vindex gnus-inhibit-startup-message
1628 If non-@code{nil}, the startup message won't be displayed. That way,
1629 your boss might not notice as easily that you are reading news instead
1630 of doing your job. Note that this variable is used before
1631 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1633 @item gnus-no-groups-message
1634 @vindex gnus-no-groups-message
1635 Message displayed by gnus when no groups are available.
1637 @item gnus-play-startup-jingle
1638 @vindex gnus-play-startup-jingle
1639 If non-@code{nil}, play the gnus jingle at startup.
1641 @item gnus-startup-jingle
1642 @vindex gnus-startup-jingle
1643 Jingle to be played if the above variable is non-@code{nil}. The
1644 default is @samp{Tuxedomoon.Jingle4.au}.
1650 @chapter Group Buffer
1651 @cindex group buffer
1653 @c Alex Schroeder suggests to rearrange this as follows:
1655 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1656 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1657 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1658 @c 7. Group Score, 8. Group Buffer Format
1659 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1660 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1661 @c <kensanata> First, "Gnus considers groups... (default 9)."
1662 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1663 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1664 @c <kensanata> Then expand the next paragraph or add some more to it.
1665 @c This short one sentence explains levels 1 and 2, therefore I understand
1666 @c that I should keep important news at 3 and boring news at 4.
1667 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1668 @c Maybe keep those that you don't want to read temporarily at 6,
1669 @c those that you never want to read at 8, those that offend your
1670 @c human rights at 9...
1673 The @dfn{group buffer} lists all (or parts) of the available groups. It
1674 is the first buffer shown when gnus starts, and will never be killed as
1675 long as gnus is active.
1679 \gnusfigure{The Group Buffer}{320}{
1680 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1681 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1682 \put(120,38){\vector(1,2){10}}
1683 \put(40,60){\makebox(0,0)[r]{Mode line}}
1684 \put(40,58){\vector(1,0){30}}
1685 \put(200,28){\makebox(0,0)[t]{Native select method}}
1686 \put(200,26){\vector(-1,2){15}}
1692 * Group Buffer Format:: Information listed and how you can change it.
1693 * Group Maneuvering:: Commands for moving in the group buffer.
1694 * Selecting a Group:: Actually reading news.
1695 * Subscription Commands:: Unsubscribing, killing, subscribing.
1696 * Group Data:: Changing the info for a group.
1697 * Group Levels:: Levels? What are those, then?
1698 * Group Score:: A mechanism for finding out what groups you like.
1699 * Marking Groups:: You can mark groups for later processing.
1700 * Foreign Groups:: Creating and editing groups.
1701 * Group Parameters:: Each group may have different parameters set.
1702 * Listing Groups:: Gnus can list various subsets of the groups.
1703 * Sorting Groups:: Re-arrange the group order.
1704 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1705 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1706 * Exiting Gnus:: Stop reading news and get some work done.
1707 * Group Topics:: A folding group mode divided into topics.
1708 * Misc Group Stuff:: Other stuff that you can to do.
1712 @node Group Buffer Format
1713 @section Group Buffer Format
1716 * Group Line Specification:: Deciding how the group buffer is to look.
1717 * Group Mode Line Specification:: The group buffer mode line.
1718 * Group Highlighting:: Having nice colors in the group buffer.
1722 @node Group Line Specification
1723 @subsection Group Line Specification
1724 @cindex group buffer format
1726 The default format of the group buffer is nice and dull, but you can
1727 make it as exciting and ugly as you feel like.
1729 Here's a couple of example group lines:
1732 25: news.announce.newusers
1733 * 0: alt.fan.andrea-dworkin
1738 You can see that there are 25 unread articles in
1739 @samp{news.announce.newusers}. There are no unread articles, but some
1740 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1741 asterisk at the beginning of the line?).
1743 @vindex gnus-group-line-format
1744 You can change that format to whatever you want by fiddling with the
1745 @code{gnus-group-line-format} variable. This variable works along the
1746 lines of a @code{format} specification, which is pretty much the same as
1747 a @code{printf} specifications, for those of you who use (feh!) C.
1748 @xref{Formatting Variables}.
1750 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1752 There should always be a colon on the line; the cursor always moves to
1753 the colon after performing an operation. @xref{Positioning
1754 Point}. Nothing else is required---not even the group name. All
1755 displayed text is just window dressing, and is never examined by Gnus.
1756 Gnus stores all real information it needs using text properties.
1758 (Note that if you make a really strange, wonderful, spreadsheet-like
1759 layout, everybody will believe you are hard at work with the accounting
1760 instead of wasting time reading news.)
1762 Here's a list of all available format characters:
1767 An asterisk if the group only has marked articles.
1770 Whether the group is subscribed.
1773 Level of subscribedness.
1776 Number of unread articles.
1779 Number of dormant articles.
1782 Number of ticked articles.
1785 Number of read articles.
1788 Number of unseen articles.
1791 Estimated total number of articles. (This is really @var{max-number}
1792 minus @var{min-number} plus 1.)
1794 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1795 efficient access to @var{max-number} and @var{min-number} but getting
1796 the true unread message count is not possible efficiently. For
1797 hysterical raisins, even the mail back ends, where the true number of
1798 unread messages might be available efficiently, use the same limited
1799 interface. To remove this restriction from Gnus means that the back
1800 end interface has to be changed, which is not an easy job. If you
1801 want to work on this, please contact the Gnus mailing list.
1804 Number of unread, unticked, non-dormant articles.
1807 Number of ticked and dormant articles.
1816 Group comment (@pxref{Group Parameters}) or group name if there is no
1817 comment element in the group parameters.
1820 Newsgroup description. You need to read the group descriptions
1821 before these will appear, and to do that, you either have to set
1822 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1826 @samp{m} if moderated.
1829 @samp{(m)} if moderated.
1835 If the summary buffer for the group is open or not.
1841 A string that looks like @samp{<%s:%n>} if a foreign select method is
1845 Indentation based on the level of the topic (@pxref{Group Topics}).
1848 @vindex gnus-group-uncollapsed-levels
1849 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1850 variable says how many levels to leave at the end of the group name.
1851 The default is 1---this will mean that group names like
1852 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1855 @vindex gnus-new-mail-mark
1857 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1861 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1864 A string that says when you last read the group (@pxref{Group
1868 The disk space used by the articles fetched by both the cache and
1869 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1870 megabytes(M), or gigabytes(G) to minimize the column width. A format
1871 of %7F is sufficient for a fixed-width column.
1874 User defined specifier. The next character in the format string should
1875 be a letter. Gnus will call the function
1876 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1877 following @samp{%u}. The function will be passed a single dummy
1878 parameter as argument. The function should return a string, which will
1879 be inserted into the buffer just like information from any other
1884 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1885 if no info is available---for instance, if it is a non-activated foreign
1886 group, or a bogus native group.
1889 @node Group Mode Line Specification
1890 @subsection Group Mode Line Specification
1891 @cindex group mode line
1893 @vindex gnus-group-mode-line-format
1894 The mode line can be changed by setting
1895 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1896 doesn't understand that many format specifiers:
1900 The native news server.
1902 The native select method.
1906 @node Group Highlighting
1907 @subsection Group Highlighting
1908 @cindex highlighting
1909 @cindex group highlighting
1911 @vindex gnus-group-highlight
1912 Highlighting in the group buffer is controlled by the
1913 @code{gnus-group-highlight} variable. This is an alist with elements
1914 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1915 something non-@code{nil}, the @var{face} will be used on the line.
1917 Here's an example value for this variable that might look nice if the
1921 (cond (window-system
1922 (setq custom-background-mode 'light)
1923 (defface my-group-face-1
1924 '((t (:foreground "Red" :bold t))) "First group face")
1925 (defface my-group-face-2
1926 '((t (:foreground "DarkSeaGreen4" :bold t)))
1927 "Second group face")
1928 (defface my-group-face-3
1929 '((t (:foreground "Green4" :bold t))) "Third group face")
1930 (defface my-group-face-4
1931 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1932 (defface my-group-face-5
1933 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1935 (setq gnus-group-highlight
1936 '(((> unread 200) . my-group-face-1)
1937 ((and (< level 3) (zerop unread)) . my-group-face-2)
1938 ((< level 3) . my-group-face-3)
1939 ((zerop unread) . my-group-face-4)
1940 (t . my-group-face-5)))
1943 Also @pxref{Faces and Fonts}.
1945 Variables that are dynamically bound when the forms are evaluated
1952 The number of unread articles in the group.
1956 Whether the group is a mail group.
1958 The level of the group.
1960 The score of the group.
1962 The number of ticked articles in the group.
1964 The total number of articles in the group. Or rather,
1965 @var{max-number} minus @var{min-number} plus one.
1967 When using the topic minor mode, this variable is bound to the current
1968 topic being inserted.
1971 When the forms are @code{eval}ed, point is at the beginning of the line
1972 of the group in question, so you can use many of the normal gnus
1973 functions for snarfing info on the group.
1975 @vindex gnus-group-update-hook
1976 @findex gnus-group-highlight-line
1977 @code{gnus-group-update-hook} is called when a group line is changed.
1978 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1979 calls @code{gnus-group-highlight-line} by default.
1982 @node Group Maneuvering
1983 @section Group Maneuvering
1984 @cindex group movement
1986 All movement commands understand the numeric prefix and will behave as
1987 expected, hopefully.
1993 @findex gnus-group-next-unread-group
1994 Go to the next group that has unread articles
1995 (@code{gnus-group-next-unread-group}).
2001 @findex gnus-group-prev-unread-group
2002 Go to the previous group that has unread articles
2003 (@code{gnus-group-prev-unread-group}).
2007 @findex gnus-group-next-group
2008 Go to the next group (@code{gnus-group-next-group}).
2012 @findex gnus-group-prev-group
2013 Go to the previous group (@code{gnus-group-prev-group}).
2017 @findex gnus-group-next-unread-group-same-level
2018 Go to the next unread group on the same (or lower) level
2019 (@code{gnus-group-next-unread-group-same-level}).
2023 @findex gnus-group-prev-unread-group-same-level
2024 Go to the previous unread group on the same (or lower) level
2025 (@code{gnus-group-prev-unread-group-same-level}).
2028 Three commands for jumping to groups:
2034 @findex gnus-group-jump-to-group
2035 Jump to a group (and make it visible if it isn't already)
2036 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2041 @findex gnus-group-best-unread-group
2042 Jump to the unread group with the lowest level
2043 (@code{gnus-group-best-unread-group}).
2047 @findex gnus-group-first-unread-group
2048 Jump to the first group with unread articles
2049 (@code{gnus-group-first-unread-group}).
2052 @vindex gnus-group-goto-unread
2053 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2054 commands will move to the next group, not the next unread group. Even
2055 the commands that say they move to the next unread group. The default
2059 @node Selecting a Group
2060 @section Selecting a Group
2061 @cindex group selection
2066 @kindex SPACE (Group)
2067 @findex gnus-group-read-group
2068 Select the current group, switch to the summary buffer and display the
2069 first unread article (@code{gnus-group-read-group}). If there are no
2070 unread articles in the group, or if you give a non-numerical prefix to
2071 this command, gnus will offer to fetch all the old articles in this
2072 group from the server. If you give a numerical prefix @var{n}, @var{n}
2073 determines the number of articles Gnus will fetch. If @var{n} is
2074 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2075 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2077 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2078 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2079 - 4 2 SPC} fetches the 42 oldest ones.
2081 When you are in the group (in the Summary buffer), you can type
2082 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2087 @findex gnus-group-select-group
2088 Select the current group and switch to the summary buffer
2089 (@code{gnus-group-select-group}). Takes the same arguments as
2090 @code{gnus-group-read-group}---the only difference is that this command
2091 does not display the first unread article automatically upon group
2095 @kindex M-RET (Group)
2096 @findex gnus-group-quick-select-group
2097 This does the same as the command above, but tries to do it with the
2098 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2099 scoring/killing will be performed, there will be no highlights and no
2100 expunging. This might be useful if you're in a real hurry and have to
2101 enter some humongous group. If you give a 0 prefix to this command
2102 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
2103 which is useful if you want to toggle threading before generating the
2104 summary buffer (@pxref{Summary Generation Commands}).
2107 @kindex M-SPACE (Group)
2108 @findex gnus-group-visible-select-group
2109 This is yet one more command that does the same as the @kbd{RET}
2110 command, but this one does it without expunging and hiding dormants
2111 (@code{gnus-group-visible-select-group}).
2114 @kindex C-M-RET (Group)
2115 @findex gnus-group-select-group-ephemerally
2116 Finally, this command selects the current group ephemerally without
2117 doing any processing of its contents
2118 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2119 turned off. Everything you do in the group after selecting it in this
2120 manner will have no permanent effects.
2124 @vindex gnus-large-newsgroup
2125 The @code{gnus-large-newsgroup} variable says what Gnus should
2126 consider to be a big group. If it is @code{nil}, no groups are
2127 considered big. The default value is 200. If the group has more
2128 (unread and/or ticked) articles than this, gnus will query the user
2129 before entering the group. The user can then specify how many
2130 articles should be fetched from the server. If the user specifies a
2131 negative number (@var{-n}), the @var{n} oldest articles will be
2132 fetched. If it is positive, the @var{n} articles that have arrived
2133 most recently will be fetched.
2135 @vindex gnus-large-ephemeral-newsgroup
2136 @code{gnus-large-ephemeral-newsgroup} is the same as
2137 @code{gnus-large-newsgroup}, but is only used for ephemeral
2140 @vindex gnus-select-group-hook
2141 @vindex gnus-auto-select-first
2142 @vindex gnus-auto-select-subject
2143 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2144 automatically when entering a group with the @kbd{SPACE} command.
2145 Which article this is is controlled by the
2146 @code{gnus-auto-select-subject} variable. Valid values for this
2152 Place point on the subject line of the first unread article.
2155 Place point on the subject line of the first article.
2158 Place point on the subject line of the first unseen article.
2160 @item unseen-or-unread
2161 Place point on the subject line of the first unseen article, and if
2162 there is no such article, place point on the subject line of the first
2166 Place point on the subject line of the highest-scored unread article.
2170 This variable can also be a function. In that case, that function
2171 will be called to place point on a subject line.
2173 If you want to prevent automatic selection in some group (say, in a
2174 binary group with Huge articles) you can set the
2175 @code{gnus-auto-select-first} variable to @code{nil} in
2176 @code{gnus-select-group-hook}, which is called when a group is
2180 @node Subscription Commands
2181 @section Subscription Commands
2182 @cindex subscription
2190 @findex gnus-group-unsubscribe-current-group
2191 @c @icon{gnus-group-unsubscribe}
2192 Toggle subscription to the current group
2193 (@code{gnus-group-unsubscribe-current-group}).
2199 @findex gnus-group-unsubscribe-group
2200 Prompt for a group to subscribe, and then subscribe it. If it was
2201 subscribed already, unsubscribe it instead
2202 (@code{gnus-group-unsubscribe-group}).
2208 @findex gnus-group-kill-group
2209 @c @icon{gnus-group-kill-group}
2210 Kill the current group (@code{gnus-group-kill-group}).
2216 @findex gnus-group-yank-group
2217 Yank the last killed group (@code{gnus-group-yank-group}).
2220 @kindex C-x C-t (Group)
2221 @findex gnus-group-transpose-groups
2222 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2223 really a subscription command, but you can use it instead of a
2224 kill-and-yank sequence sometimes.
2230 @findex gnus-group-kill-region
2231 Kill all groups in the region (@code{gnus-group-kill-region}).
2235 @findex gnus-group-kill-all-zombies
2236 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2239 @kindex S C-k (Group)
2240 @findex gnus-group-kill-level
2241 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2242 These groups can't be yanked back after killing, so this command should
2243 be used with some caution. The only time where this command comes in
2244 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2245 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2246 kill off all unsubscribed groups that do not have message numbers in the
2247 @file{.newsrc} file.
2251 Also @pxref{Group Levels}.
2261 @findex gnus-group-catchup-current
2262 @vindex gnus-group-catchup-group-hook
2263 @c @icon{gnus-group-catchup-current}
2264 Mark all unticked articles in this group as read
2265 (@code{gnus-group-catchup-current}).
2266 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2271 @findex gnus-group-catchup-current-all
2272 Mark all articles in this group, even the ticked ones, as read
2273 (@code{gnus-group-catchup-current-all}).
2277 @findex gnus-group-clear-data
2278 Clear the data from the current group---nix out marks and the list of
2279 read articles (@code{gnus-group-clear-data}).
2281 @item M-x gnus-group-clear-data-on-native-groups
2282 @kindex M-x gnus-group-clear-data-on-native-groups
2283 @findex gnus-group-clear-data-on-native-groups
2284 If you have switched from one @acronym{NNTP} server to another, all your marks
2285 and read ranges have become worthless. You can use this command to
2286 clear out all data that you have on your native groups. Use with
2293 @section Group Levels
2297 All groups have a level of @dfn{subscribedness}. For instance, if a
2298 group is on level 2, it is more subscribed than a group on level 5. You
2299 can ask gnus to just list groups on a given level or lower
2300 (@pxref{Listing Groups}), or to just check for new articles in groups on
2301 a given level or lower (@pxref{Scanning New Messages}).
2303 Remember: The higher the level of the group, the less important it is.
2309 @findex gnus-group-set-current-level
2310 Set the level of the current group. If a numeric prefix is given, the
2311 next @var{n} groups will have their levels set. The user will be
2312 prompted for a level.
2315 @vindex gnus-level-killed
2316 @vindex gnus-level-zombie
2317 @vindex gnus-level-unsubscribed
2318 @vindex gnus-level-subscribed
2319 Gnus considers groups from levels 1 to
2320 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2321 @code{gnus-level-subscribed} (exclusive) and
2322 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2323 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2324 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2325 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2326 same, but zombie and killed groups have no information on what articles
2327 you have read, etc, stored. This distinction between dead and living
2328 groups isn't done because it is nice or clever, it is done purely for
2329 reasons of efficiency.
2331 It is recommended that you keep all your mail groups (if any) on quite
2332 low levels (e.g. 1 or 2).
2334 Maybe the following description of the default behavior of Gnus helps to
2335 understand what these levels are all about. By default, Gnus shows you
2336 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2337 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2338 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2339 groups are hidden, in a way.
2341 Zombie and killed groups are similar to unsubscribed groups in that they
2342 are hidden by default. But they are different from subscribed and
2343 unsubscribed groups in that Gnus doesn't ask the news server for
2344 information (number of messages, number of unread messages) on zombie
2345 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2346 aren't interested in. If most groups are killed, Gnus is faster.
2348 Why does Gnus distinguish between zombie and killed groups? Well, when
2349 a new group arrives on the server, Gnus by default makes it a zombie
2350 group. This means that you are normally not bothered with new groups,
2351 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2352 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2353 list of killed groups.)
2355 If you want to play with the level variables, you should show some care.
2356 Set them once, and don't touch them ever again. Better yet, don't touch
2357 them at all unless you know exactly what you're doing.
2359 @vindex gnus-level-default-unsubscribed
2360 @vindex gnus-level-default-subscribed
2361 Two closely related variables are @code{gnus-level-default-subscribed}
2362 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2363 which are the levels that new groups will be put on if they are
2364 (un)subscribed. These two variables should, of course, be inside the
2365 relevant valid ranges.
2367 @vindex gnus-keep-same-level
2368 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2369 will only move to groups of the same level (or lower). In
2370 particular, going from the last article in one group to the next group
2371 will go to the next group of the same level (or lower). This might be
2372 handy if you want to read the most important groups before you read the
2375 If this variable is @code{best}, Gnus will make the next newsgroup the
2376 one with the best level.
2378 @vindex gnus-group-default-list-level
2379 All groups with a level less than or equal to
2380 @code{gnus-group-default-list-level} will be listed in the group buffer
2383 @vindex gnus-group-list-inactive-groups
2384 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2385 groups will be listed along with the unread groups. This variable is
2386 @code{t} by default. If it is @code{nil}, inactive groups won't be
2389 @vindex gnus-group-use-permanent-levels
2390 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2391 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2392 use this level as the ``work'' level.
2394 @vindex gnus-activate-level
2395 Gnus will normally just activate (i. e., query the server about) groups
2396 on level @code{gnus-activate-level} or less. If you don't want to
2397 activate unsubscribed groups, for instance, you might set this variable
2398 to 5. The default is 6.
2402 @section Group Score
2407 You would normally keep important groups on high levels, but that scheme
2408 is somewhat restrictive. Don't you wish you could have Gnus sort the
2409 group buffer according to how often you read groups, perhaps? Within
2412 This is what @dfn{group score} is for. You can have Gnus assign a score
2413 to each group through the mechanism described below. You can then sort
2414 the group buffer based on this score. Alternatively, you can sort on
2415 score and then level. (Taken together, the level and the score is
2416 called the @dfn{rank} of the group. A group that is on level 4 and has
2417 a score of 1 has a higher rank than a group on level 5 that has a score
2418 of 300. (The level is the most significant part and the score is the
2419 least significant part.))
2421 @findex gnus-summary-bubble-group
2422 If you want groups you read often to get higher scores than groups you
2423 read seldom you can add the @code{gnus-summary-bubble-group} function to
2424 the @code{gnus-summary-exit-hook} hook. This will result (after
2425 sorting) in a bubbling sort of action. If you want to see that in
2426 action after each summary exit, you can add
2427 @code{gnus-group-sort-groups-by-rank} or
2428 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2429 slow things down somewhat.
2432 @node Marking Groups
2433 @section Marking Groups
2434 @cindex marking groups
2436 If you want to perform some command on several groups, and they appear
2437 subsequently in the group buffer, you would normally just give a
2438 numerical prefix to the command. Most group commands will then do your
2439 bidding on those groups.
2441 However, if the groups are not in sequential order, you can still
2442 perform a command on several groups. You simply mark the groups first
2443 with the process mark and then execute the command.
2451 @findex gnus-group-mark-group
2452 Set the mark on the current group (@code{gnus-group-mark-group}).
2458 @findex gnus-group-unmark-group
2459 Remove the mark from the current group
2460 (@code{gnus-group-unmark-group}).
2464 @findex gnus-group-unmark-all-groups
2465 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2469 @findex gnus-group-mark-region
2470 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2474 @findex gnus-group-mark-buffer
2475 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2479 @findex gnus-group-mark-regexp
2480 Mark all groups that match some regular expression
2481 (@code{gnus-group-mark-regexp}).
2484 Also @pxref{Process/Prefix}.
2486 @findex gnus-group-universal-argument
2487 If you want to execute some command on all groups that have been marked
2488 with the process mark, you can use the @kbd{M-&}
2489 (@code{gnus-group-universal-argument}) command. It will prompt you for
2490 the command to be executed.
2493 @node Foreign Groups
2494 @section Foreign Groups
2495 @cindex foreign groups
2497 Below are some group mode commands for making and editing general foreign
2498 groups, as well as commands to ease the creation of a few
2499 special-purpose groups. All these commands insert the newly created
2500 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2507 @findex gnus-group-make-group
2508 @cindex making groups
2509 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2510 for a name, a method and possibly an @dfn{address}. For an easier way
2511 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2515 @findex gnus-group-read-ephemeral-group
2516 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2517 will prompt you for a name, a method and an @dfn{address}.
2521 @findex gnus-group-rename-group
2522 @cindex renaming groups
2523 Rename the current group to something else
2524 (@code{gnus-group-rename-group}). This is valid only on some
2525 groups---mail groups mostly. This command might very well be quite slow
2531 @findex gnus-group-customize
2532 Customize the group parameters (@code{gnus-group-customize}).
2536 @findex gnus-group-edit-group-method
2537 @cindex renaming groups
2538 Enter a buffer where you can edit the select method of the current
2539 group (@code{gnus-group-edit-group-method}).
2543 @findex gnus-group-edit-group-parameters
2544 Enter a buffer where you can edit the group parameters
2545 (@code{gnus-group-edit-group-parameters}).
2549 @findex gnus-group-edit-group
2550 Enter a buffer where you can edit the group info
2551 (@code{gnus-group-edit-group}).
2555 @findex gnus-group-make-directory-group
2557 Make a directory group (@pxref{Directory Groups}). You will be prompted
2558 for a directory name (@code{gnus-group-make-directory-group}).
2563 @findex gnus-group-make-help-group
2564 Make the gnus help group (@code{gnus-group-make-help-group}).
2568 @cindex (ding) archive
2569 @cindex archive group
2570 @findex gnus-group-make-archive-group
2571 @vindex gnus-group-archive-directory
2572 @vindex gnus-group-recent-archive-directory
2573 Make a gnus archive group (@code{gnus-group-make-archive-group}). By
2574 default a group pointing to the most recent articles will be created
2575 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2576 group will be created from @code{gnus-group-archive-directory}.
2580 @findex gnus-group-make-kiboze-group
2582 Make a kiboze group. You will be prompted for a name, for a regexp to
2583 match groups to be ``included'' in the kiboze group, and a series of
2584 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2585 @xref{Kibozed Groups}.
2589 @findex gnus-group-enter-directory
2591 Read an arbitrary directory as if it were a newsgroup with the
2592 @code{nneething} back end (@code{gnus-group-enter-directory}).
2593 @xref{Anything Groups}.
2597 @findex gnus-group-make-doc-group
2598 @cindex ClariNet Briefs
2600 Make a group based on some file or other
2601 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2602 command, you will be prompted for a file name and a file type.
2603 Currently supported types are @code{mbox}, @code{babyl},
2604 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2605 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2606 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2607 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2608 you run this command without a prefix, Gnus will guess at the file
2609 type. @xref{Document Groups}.
2613 @vindex gnus-useful-groups
2614 @findex gnus-group-make-useful-group
2615 Create one of the groups mentioned in @code{gnus-useful-groups}
2616 (@code{gnus-group-make-useful-group}).
2620 @findex gnus-group-make-web-group
2624 Make an ephemeral group based on a web search
2625 (@code{gnus-group-make-web-group}). If you give a prefix to this
2626 command, make a solid group instead. You will be prompted for the
2627 search engine type and the search string. Valid search engine types
2628 include @code{google}, @code{dejanews}, and @code{gmane}.
2629 @xref{Web Searches}.
2631 If you use the @code{google} search engine, you can limit the search
2632 to a particular group by using a match string like
2633 @samp{shaving group:alt.sysadmin.recovery}.
2637 @findex gnus-group-make-rss-group
2638 Make a group based on an @acronym{RSS} feed
2639 (@code{gnus-group-make-rss-group}). You will be prompted for an URL.
2643 @kindex G DEL (Group)
2644 @findex gnus-group-delete-group
2645 This function will delete the current group
2646 (@code{gnus-group-delete-group}). If given a prefix, this function will
2647 actually delete all the articles in the group, and forcibly remove the
2648 group itself from the face of the Earth. Use a prefix only if you are
2649 absolutely sure of what you are doing. This command can't be used on
2650 read-only groups (like @code{nntp} groups), though.
2654 @findex gnus-group-make-empty-virtual
2655 Make a new, fresh, empty @code{nnvirtual} group
2656 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2660 @findex gnus-group-add-to-virtual
2661 Add the current group to an @code{nnvirtual} group
2662 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2665 @xref{Select Methods}, for more information on the various select
2668 @vindex gnus-activate-foreign-newsgroups
2669 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2670 gnus will check all foreign groups with this level or lower at startup.
2671 This might take quite a while, especially if you subscribe to lots of
2672 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2673 @code{gnus-activate-level} also affects activation of foreign
2677 @node Group Parameters
2678 @section Group Parameters
2679 @cindex group parameters
2681 The group parameters store information local to a particular group.
2682 Here's an example group parameter list:
2685 ((to-address . "ding@@gnus.org")
2689 We see that each element consists of a ``dotted pair''---the thing before
2690 the dot is the key, while the thing after the dot is the value. All the
2691 parameters have this form @emph{except} local variable specs, which are
2692 not dotted pairs, but proper lists.
2694 Some parameters have correspondent customizable variables, each of which
2695 is an alist of regexps and values.
2697 The following group parameters can be used:
2702 Address used by when doing followups and new posts.
2705 (to-address . "some@@where.com")
2708 This is primarily useful in mail groups that represent closed mailing
2709 lists---mailing lists where it's expected that everybody that writes to
2710 the mailing list is subscribed to it. Since using this parameter
2711 ensures that the mail only goes to the mailing list itself, it means
2712 that members won't receive two copies of your followups.
2714 Using @code{to-address} will actually work whether the group is foreign
2715 or not. Let's say there's a group on the server that is called
2716 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2717 the articles from a mail-to-news gateway. Posting directly to this
2718 group is therefore impossible---you have to send mail to the mailing
2719 list address instead.
2721 See also @code{gnus-parameter-to-address-alist}.
2725 Address used when doing @kbd{a} in that group.
2728 (to-list . "some@@where.com")
2731 It is totally ignored
2732 when doing a followup---except that if it is present in a news group,
2733 you'll get mail group semantics when doing @kbd{f}.
2735 If you do an @kbd{a} command in a mail group and you have neither a
2736 @code{to-list} group parameter nor a @code{to-address} group parameter,
2737 then a @code{to-list} group parameter will be added automatically upon
2738 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2739 @vindex gnus-add-to-list
2741 @findex gnus-mailing-list-mode
2742 @cindex mail list groups
2743 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2744 entering summary buffer.
2746 See also @code{gnus-parameter-to-list-alist}.
2751 @cindex Mail-Followup-To
2752 @findex gnus-find-subscribed-addresses
2753 If this parameter is set to @code{t}, Gnus will consider the
2754 to-address and to-list parameters for this group as addresses of
2755 mailing lists you are subscribed to. Giving Gnus this information is
2756 (only) a first step in getting it to generate correct Mail-Followup-To
2757 headers for your posts to these lists. The second step is to put the
2758 following in your @file{.gnus.el}
2761 (setq message-subscribed-address-functions
2762 '(gnus-find-subscribed-addresses))
2765 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2766 a complete treatment of available MFT support.
2770 If the group parameter list has the element @code{(visible . t)},
2771 that group will always be visible in the Group buffer, regardless
2772 of whether it has any unread articles.
2774 @item broken-reply-to
2775 @cindex broken-reply-to
2776 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2777 headers in this group are to be ignored, and for the header to be hidden
2778 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2779 can be useful if you're reading a mailing list group where the listserv
2780 has inserted @code{Reply-To} headers that point back to the listserv
2781 itself. That is broken behavior. So there!
2785 Elements like @code{(to-group . "some.group.name")} means that all
2786 posts in that group will be sent to @code{some.group.name}.
2790 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2791 will treat all responses as if they were responses to news articles.
2792 This can be useful if you have a mail group that's really a mirror of a
2797 If @code{(gcc-self . t)} is present in the group parameter list, newly
2798 composed messages will be @code{Gcc}'d to the current group. If
2799 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2800 generated, if @code{(gcc-self . "string")} is present, this string will
2801 be inserted literally as a @code{gcc} header. This parameter takes
2802 precedence over any default @code{Gcc} rules as described later
2803 (@pxref{Archived Messages}).
2805 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2806 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2807 doesn't accept articles.
2811 If the group parameter has an element that looks like @code{(auto-expire
2812 . t)}, all articles read will be marked as expirable. For an
2813 alternative approach, @pxref{Expiring Mail}.
2815 See also @code{gnus-auto-expirable-newsgroups}.
2818 @cindex total-expire
2819 If the group parameter has an element that looks like
2820 @code{(total-expire . t)}, all read articles will be put through the
2821 expiry process, even if they are not marked as expirable. Use with
2822 caution. Unread, ticked and dormant articles are not eligible for
2825 See also @code{gnus-total-expirable-newsgroups}.
2829 @vindex nnmail-expiry-wait-function
2830 If the group parameter has an element that looks like
2831 @code{(expiry-wait . 10)}, this value will override any
2832 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2833 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2834 can either be a number of days (not necessarily an integer) or the
2835 symbols @code{never} or @code{immediate}.
2838 @cindex expiry-target
2839 Where expired messages end up. This parameter overrides
2840 @code{nnmail-expiry-target}.
2843 @cindex score file group parameter
2844 Elements that look like @code{(score-file . "file")} will make
2845 @file{file} into the current score file for the group in question. All
2846 interactive score entries will be put into this file.
2849 @cindex adapt file group parameter
2850 Elements that look like @code{(adapt-file . "file")} will make
2851 @file{file} into the current adaptive file for the group in question.
2852 All adaptive score entries will be put into this file.
2855 @cindex admin-address
2856 When unsubscribing from a mailing list you should never send the
2857 unsubscription notice to the mailing list itself. Instead, you'd send
2858 messages to the administrative address. This parameter allows you to
2859 put the admin address somewhere convenient.
2863 Elements that look like @code{(display . MODE)} say which articles to
2864 display on entering the group. Valid values are:
2868 Display all articles, both read and unread.
2871 Display the last @var{integer} articles in the group. This is the same as
2872 entering the group with @kbd{C-u @var{integer}}.
2875 Display the default visible articles, which normally includes unread and
2879 Display articles that satisfy a predicate.
2881 Here are some examples:
2885 Display only unread articles.
2888 Display everything except expirable articles.
2890 @item [and (not reply) (not expire)]
2891 Display everything except expirable and articles you've already
2895 The available operators are @code{not}, @code{and} and @code{or}.
2896 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2897 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2898 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2899 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2903 The @code{display} parameter works by limiting the summary buffer to
2904 the subset specified. You can pop the limit by using the @kbd{/ w}
2905 command (@pxref{Limiting}).
2909 Elements that look like @code{(comment . "This is a comment")} are
2910 arbitrary comments on the group. You can display comments in the
2911 group line (@pxref{Group Line Specification}).
2915 Elements that look like @code{(charset . iso-8859-1)} will make
2916 @code{iso-8859-1} the default charset; that is, the charset that will be
2917 used for all articles that do not specify a charset.
2919 See also @code{gnus-group-charset-alist}.
2921 @item ignored-charsets
2922 @cindex ignored-charset
2923 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2924 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2925 default charset will be used for decoding articles.
2927 See also @code{gnus-group-ignored-charsets-alist}.
2930 @cindex posting-style
2931 You can store additional posting style information for this group
2932 here (@pxref{Posting Styles}). The format is that of an entry in the
2933 @code{gnus-posting-styles} alist, except that there's no regexp matching
2934 the group name (of course). Style elements in this group parameter will
2935 take precedence over the ones found in @code{gnus-posting-styles}.
2937 For instance, if you want a funky name and signature in this group only,
2938 instead of hacking @code{gnus-posting-styles}, you could put something
2939 like this in the group parameters:
2944 ("X-My-Header" "Funky Value")
2945 (signature "Funky Signature"))
2950 If it is set, the value is used as the method for posting message
2951 instead of @code{gnus-post-method}.
2955 An item like @code{(banner . @var{regexp})} causes any part of an article
2956 that matches the regular expression @var{regexp} to be stripped. Instead of
2957 @var{regexp}, you can also use the symbol @code{signature} which strips the
2958 last signature or any of the elements of the alist
2959 @code{gnus-article-banner-alist}.
2963 This parameter contains a Sieve test that should match incoming mail
2964 that should be placed in this group. From this group parameter, a
2965 Sieve @samp{IF} control structure is generated, having the test as the
2966 condition and @samp{fileinto "group.name";} as the body.
2968 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
2969 address "sender" "sieve-admin@@extundo.com")} group parameter, when
2970 translating the group parameter into a Sieve script (@pxref{Sieve
2971 Commands}) the following Sieve code is generated:
2974 if address \"sender\" \"sieve-admin@@extundo.com\" @{
2975 fileinto \"INBOX.list.sieve\";
2979 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
2980 Top, sieve, Emacs Sieve}.
2982 @item (agent parameters)
2983 If the agent has been enabled, you can set any of the its parameters
2984 to control the behavior of the agent in individual groups. See Agent
2985 Parameters in @ref{Category Syntax}. Most users will choose to set
2986 agent parameters in either an agent category or group topic to
2987 minimize the configuration effort.
2989 @item (@var{variable} @var{form})
2990 You can use the group parameters to set variables local to the group you
2991 are entering. If you want to turn threading off in @samp{news.answers},
2992 you could put @code{(gnus-show-threads nil)} in the group parameters of
2993 that group. @code{gnus-show-threads} will be made into a local variable
2994 in the summary buffer you enter, and the form @code{nil} will be
2995 @code{eval}ed there.
2997 Note that this feature sets the variable locally to the summary buffer.
2998 But some variables are evaluated in the article buffer, or in the
2999 message buffer (of a reply or followup or otherwise newly created
3000 message). As a workaround, it might help to add the variable in
3001 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3002 Stuff}. So if you want to set @code{message-from-style} via the group
3003 parameters, then you may need the following statement elsewhere in your
3004 @file{~/.gnus} file:
3007 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3010 @vindex gnus-list-identifiers
3011 A use for this feature is to remove a mailing list identifier tag in
3012 the subject fields of articles. E.g. if the news group
3015 nntp+news.gnus.org:gmane.text.docbook.apps
3018 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3019 tag can be removed from the article subjects in the summary buffer for
3020 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3021 into the group parameters for the group.
3023 This can also be used as a group-specific hook function. If you want to
3024 hear a beep when you enter a group, you could put something like
3025 @code{(dummy-variable (ding))} in the parameters of that group.
3026 @code{dummy-variable} will be set to the (meaningless) result of the
3029 Alternatively, since the VARIABLE becomes local to the group, this
3030 pattern can be used to temporarily change a hook. For example, if the
3031 following is added to a group parameter
3034 (gnus-summary-prepared-hook
3035 '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3038 when the group is entered, the 'd' key will not mark the article as
3043 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3044 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3045 presents you with a Customize-like interface. The latter helps avoid
3046 silly Lisp errors.) You might also be interested in reading about topic
3047 parameters (@pxref{Topic Parameters}).
3049 @vindex gnus-parameters
3050 Group parameters can be set via the @code{gnus-parameters} variable too.
3051 But some variables, such as @code{visible}, have no effect. For
3055 (setq gnus-parameters
3057 (gnus-show-threads nil)
3058 (gnus-use-scoring nil)
3059 (gnus-summary-line-format
3060 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3064 ("^nnimap:\\(foo.bar\\)$"
3068 (gnus-use-scoring t))
3072 (broken-reply-to . t))))
3075 String value of parameters will be subjected to regexp substitution, as
3076 the @code{to-group} example shows.
3079 @node Listing Groups
3080 @section Listing Groups
3081 @cindex group listing
3083 These commands all list various slices of the groups available.
3091 @findex gnus-group-list-groups
3092 List all groups that have unread articles
3093 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3094 command will list only groups of level ARG and lower. By default, it
3095 only lists groups of level five (i.e.,
3096 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3103 @findex gnus-group-list-all-groups
3104 List all groups, whether they have unread articles or not
3105 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3106 this command will list only groups of level ARG and lower. By default,
3107 it lists groups of level seven or lower (i.e., just subscribed and
3108 unsubscribed groups).
3112 @findex gnus-group-list-level
3113 List all unread groups on a specific level
3114 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3115 with no unread articles.
3119 @findex gnus-group-list-killed
3120 List all killed groups (@code{gnus-group-list-killed}). If given a
3121 prefix argument, really list all groups that are available, but aren't
3122 currently (un)subscribed. This could entail reading the active file
3127 @findex gnus-group-list-zombies
3128 List all zombie groups (@code{gnus-group-list-zombies}).
3132 @findex gnus-group-list-matching
3133 List all unread, subscribed groups with names that match a regexp
3134 (@code{gnus-group-list-matching}).
3138 @findex gnus-group-list-all-matching
3139 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3143 @findex gnus-group-list-active
3144 List absolutely all groups in the active file(s) of the
3145 server(s) you are connected to (@code{gnus-group-list-active}). This
3146 might very well take quite a while. It might actually be a better idea
3147 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3148 thing to match on. Also note that this command may list groups that
3149 don't exist (yet)---these will be listed as if they were killed groups.
3150 Take the output with some grains of salt.
3154 @findex gnus-group-apropos
3155 List all groups that have names that match a regexp
3156 (@code{gnus-group-apropos}).
3160 @findex gnus-group-description-apropos
3161 List all groups that have names or descriptions that match a regexp
3162 (@code{gnus-group-description-apropos}).
3166 @findex gnus-group-list-cached
3167 List all groups with cached articles (@code{gnus-group-list-cached}).
3171 @findex gnus-group-list-dormant
3172 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3176 @findex gnus-group-list-limit
3177 List groups limited within the current selection
3178 (@code{gnus-group-list-limit}).
3182 @findex gnus-group-list-flush
3183 Flush groups from the current selection (@code{gnus-group-list-flush}).
3187 @findex gnus-group-list-plus
3188 List groups plus the current selection (@code{gnus-group-list-plus}).
3192 @vindex gnus-permanently-visible-groups
3193 @cindex visible group parameter
3194 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3195 always be shown, whether they have unread articles or not. You can also
3196 add the @code{visible} element to the group parameters in question to
3197 get the same effect.
3199 @vindex gnus-list-groups-with-ticked-articles
3200 Groups that have just ticked articles in it are normally listed in the
3201 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3202 @code{nil}, these groups will be treated just like totally empty
3203 groups. It is @code{t} by default.
3206 @node Sorting Groups
3207 @section Sorting Groups
3208 @cindex sorting groups
3210 @kindex C-c C-s (Group)
3211 @findex gnus-group-sort-groups
3212 @vindex gnus-group-sort-function
3213 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3214 group buffer according to the function(s) given by the
3215 @code{gnus-group-sort-function} variable. Available sorting functions
3220 @item gnus-group-sort-by-alphabet
3221 @findex gnus-group-sort-by-alphabet
3222 Sort the group names alphabetically. This is the default.
3224 @item gnus-group-sort-by-real-name
3225 @findex gnus-group-sort-by-real-name
3226 Sort the group alphabetically on the real (unprefixed) group names.
3228 @item gnus-group-sort-by-level
3229 @findex gnus-group-sort-by-level
3230 Sort by group level.
3232 @item gnus-group-sort-by-score
3233 @findex gnus-group-sort-by-score
3234 Sort by group score. @xref{Group Score}.
3236 @item gnus-group-sort-by-rank
3237 @findex gnus-group-sort-by-rank
3238 Sort by group score and then the group level. The level and the score
3239 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3241 @item gnus-group-sort-by-unread
3242 @findex gnus-group-sort-by-unread
3243 Sort by number of unread articles.
3245 @item gnus-group-sort-by-method
3246 @findex gnus-group-sort-by-method
3247 Sort alphabetically on the select method.
3249 @item gnus-group-sort-by-server
3250 @findex gnus-group-sort-by-server
3251 Sort alphabetically on the Gnus server name.
3256 @code{gnus-group-sort-function} can also be a list of sorting
3257 functions. In that case, the most significant sort key function must be
3261 There are also a number of commands for sorting directly according to
3262 some sorting criteria:
3266 @kindex G S a (Group)
3267 @findex gnus-group-sort-groups-by-alphabet
3268 Sort the group buffer alphabetically by group name
3269 (@code{gnus-group-sort-groups-by-alphabet}).
3272 @kindex G S u (Group)
3273 @findex gnus-group-sort-groups-by-unread
3274 Sort the group buffer by the number of unread articles
3275 (@code{gnus-group-sort-groups-by-unread}).
3278 @kindex G S l (Group)
3279 @findex gnus-group-sort-groups-by-level
3280 Sort the group buffer by group level
3281 (@code{gnus-group-sort-groups-by-level}).
3284 @kindex G S v (Group)
3285 @findex gnus-group-sort-groups-by-score
3286 Sort the group buffer by group score
3287 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3290 @kindex G S r (Group)
3291 @findex gnus-group-sort-groups-by-rank
3292 Sort the group buffer by group rank
3293 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3296 @kindex G S m (Group)
3297 @findex gnus-group-sort-groups-by-method
3298 Sort the group buffer alphabetically by back end name@*
3299 (@code{gnus-group-sort-groups-by-method}).
3302 @kindex G S n (Group)
3303 @findex gnus-group-sort-groups-by-real-name
3304 Sort the group buffer alphabetically by real (unprefixed) group name
3305 (@code{gnus-group-sort-groups-by-real-name}).
3309 All the commands below obey the process/prefix convention
3310 (@pxref{Process/Prefix}).
3312 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3313 commands will sort in reverse order.
3315 You can also sort a subset of the groups:
3319 @kindex G P a (Group)
3320 @findex gnus-group-sort-selected-groups-by-alphabet
3321 Sort the groups alphabetically by group name
3322 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3325 @kindex G P u (Group)
3326 @findex gnus-group-sort-selected-groups-by-unread
3327 Sort the groups by the number of unread articles
3328 (@code{gnus-group-sort-selected-groups-by-unread}).
3331 @kindex G P l (Group)
3332 @findex gnus-group-sort-selected-groups-by-level
3333 Sort the groups by group level
3334 (@code{gnus-group-sort-selected-groups-by-level}).
3337 @kindex G P v (Group)
3338 @findex gnus-group-sort-selected-groups-by-score
3339 Sort the groups by group score
3340 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3343 @kindex G P r (Group)
3344 @findex gnus-group-sort-selected-groups-by-rank
3345 Sort the groups by group rank
3346 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3349 @kindex G P m (Group)
3350 @findex gnus-group-sort-selected-groups-by-method
3351 Sort the groups alphabetically by back end name@*
3352 (@code{gnus-group-sort-selected-groups-by-method}).
3355 @kindex G P n (Group)
3356 @findex gnus-group-sort-selected-groups-by-real-name
3357 Sort the groups alphabetically by real (unprefixed) group name
3358 (@code{gnus-group-sort-selected-groups-by-real-name}).
3361 @kindex G P s (Group)
3362 @findex gnus-group-sort-selected-groups
3363 Sort the groups according to @code{gnus-group-sort-function}.
3367 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3371 @node Group Maintenance
3372 @section Group Maintenance
3373 @cindex bogus groups
3378 @findex gnus-group-check-bogus-groups
3379 Find bogus groups and delete them
3380 (@code{gnus-group-check-bogus-groups}).
3384 @findex gnus-group-find-new-groups
3385 Find new groups and process them (@code{gnus-group-find-new-groups}).
3386 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3387 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3388 to query the server for new groups, and subscribe the new groups as
3392 @kindex C-c C-x (Group)
3393 @findex gnus-group-expire-articles
3394 Run all expirable articles in the current group through the expiry
3395 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3396 all expirable articles in the group that have been around for a while.
3397 (@pxref{Expiring Mail}).
3400 @kindex C-c C-M-x (Group)
3401 @findex gnus-group-expire-all-groups
3402 Run all expirable articles in all groups through the expiry process
3403 (@code{gnus-group-expire-all-groups}).
3408 @node Browse Foreign Server
3409 @section Browse Foreign Server
3410 @cindex foreign servers
3411 @cindex browsing servers
3416 @findex gnus-group-browse-foreign-server
3417 You will be queried for a select method and a server name. Gnus will
3418 then attempt to contact this server and let you browse the groups there
3419 (@code{gnus-group-browse-foreign-server}).
3422 @findex gnus-browse-mode
3423 A new buffer with a list of available groups will appear. This buffer
3424 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3425 a lot) like a normal group buffer.
3427 Here's a list of keystrokes available in the browse mode:
3432 @findex gnus-group-next-group
3433 Go to the next group (@code{gnus-group-next-group}).
3437 @findex gnus-group-prev-group
3438 Go to the previous group (@code{gnus-group-prev-group}).
3441 @kindex SPACE (Browse)
3442 @findex gnus-browse-read-group
3443 Enter the current group and display the first article
3444 (@code{gnus-browse-read-group}).
3447 @kindex RET (Browse)
3448 @findex gnus-browse-select-group
3449 Enter the current group (@code{gnus-browse-select-group}).
3453 @findex gnus-browse-unsubscribe-current-group
3454 Unsubscribe to the current group, or, as will be the case here,
3455 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3461 @findex gnus-browse-exit
3462 Exit browse mode (@code{gnus-browse-exit}).
3466 @findex gnus-browse-describe-group
3467 Describe the current group (@code{gnus-browse-describe-group}).
3471 @findex gnus-browse-describe-briefly
3472 Describe browse mode briefly (well, there's not much to describe, is
3473 there) (@code{gnus-browse-describe-briefly}).
3478 @section Exiting gnus
3479 @cindex exiting gnus
3481 Yes, gnus is ex(c)iting.
3486 @findex gnus-group-suspend
3487 Suspend gnus (@code{gnus-group-suspend}). This doesn't really exit gnus,
3488 but it kills all buffers except the Group buffer. I'm not sure why this
3489 is a gain, but then who am I to judge?
3493 @findex gnus-group-exit
3494 @c @icon{gnus-group-exit}
3495 Quit gnus (@code{gnus-group-exit}).
3499 @findex gnus-group-quit
3500 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3501 The dribble file will be saved, though (@pxref{Auto Save}).
3504 @vindex gnus-exit-gnus-hook
3505 @vindex gnus-suspend-gnus-hook
3506 @vindex gnus-after-exiting-gnus-hook
3507 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3508 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3509 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3515 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3516 numbly heavy and herself fall into a hazy trance as the boy sitting
3517 behind her drew repeated lines with his pencil across the back of her
3523 @section Group Topics
3526 If you read lots and lots of groups, it might be convenient to group
3527 them hierarchically according to topics. You put your Emacs groups over
3528 here, your sex groups over there, and the rest (what, two groups or so?)
3529 you put in some misc section that you never bother with anyway. You can
3530 even group the Emacs sex groups as a sub-topic to either the Emacs
3531 groups or the sex groups---or both! Go wild!
3535 \gnusfigure{Group Topics}{400}{
3536 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3547 2: alt.religion.emacs
3550 0: comp.talk.emacs.recovery
3552 8: comp.binaries.fractals
3553 13: comp.sources.unix
3556 @findex gnus-topic-mode
3558 To get this @emph{fab} functionality you simply turn on (ooh!) the
3559 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3560 is a toggling command.)
3562 Go ahead, just try it. I'll still be here when you get back. La de
3563 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3564 Yes, and now press @kbd{l}. There. All your groups are now listed
3565 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3568 If you want this permanently enabled, you should add that minor mode to
3569 the hook for the group mode. Put the following line in your
3570 @file{~/.gnus.el} file:
3573 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3577 * Topic Commands:: Interactive E-Z commands.
3578 * Topic Variables:: How to customize the topics the Lisp Way.
3579 * Topic Sorting:: Sorting each topic individually.
3580 * Topic Topology:: A map of the world.
3581 * Topic Parameters:: Parameters that apply to all groups in a topic.
3585 @node Topic Commands
3586 @subsection Topic Commands
3587 @cindex topic commands
3589 When the topic minor mode is turned on, a new @kbd{T} submap will be
3590 available. In addition, a few of the standard keys change their
3591 definitions slightly.
3593 In general, the following kinds of operations are possible on topics.
3594 First of all, you want to create topics. Secondly, you want to put
3595 groups in topics and to move them around until you have an order you
3596 like. The third kind of operation is to show/hide parts of the whole
3597 shebang. You might want to hide a topic including its subtopics and
3598 groups, to get a better overview of the other groups.
3600 Here is a list of the basic keys that you might need to set up topics
3607 @findex gnus-topic-create-topic
3608 Prompt for a new topic name and create it
3609 (@code{gnus-topic-create-topic}).
3613 @kindex T TAB (Topic)
3615 @findex gnus-topic-indent
3616 ``Indent'' the current topic so that it becomes a sub-topic of the
3617 previous topic (@code{gnus-topic-indent}). If given a prefix,
3618 ``un-indent'' the topic instead.
3621 @kindex M-TAB (Topic)
3622 @findex gnus-topic-unindent
3623 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3624 parent of its current parent (@code{gnus-topic-unindent}).
3628 The following two keys can be used to move groups and topics around.
3629 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3630 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3631 kill and yank rather than cut and paste.
3637 @findex gnus-topic-kill-group
3638 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3639 topic will be removed along with the topic.
3643 @findex gnus-topic-yank-group
3644 Yank the previously killed group or topic
3645 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3648 So, to move a topic to the beginning of the list of topics, just hit
3649 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3650 move the cursor to the beginning of the buffer (just below the ``Gnus''
3651 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3652 paste. Like I said -- E-Z.
3654 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3655 you can move topics around as well as groups.
3659 After setting up the topics the way you like them, you might wish to
3660 hide a topic, or to show it again. That's why we have the following
3667 @findex gnus-topic-select-group
3669 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3670 When you perform this command on a group, you'll enter the group, as
3671 usual. When done on a topic line, the topic will be folded (if it was
3672 visible) or unfolded (if it was folded already). So it's basically a
3673 toggling command on topics. In addition, if you give a numerical
3674 prefix, group on that level (and lower) will be displayed.
3678 Now for a list of other commands, in no particular order.
3684 @findex gnus-topic-move-group
3685 Move the current group to some other topic
3686 (@code{gnus-topic-move-group}). This command uses the process/prefix
3687 convention (@pxref{Process/Prefix}).
3691 @findex gnus-topic-jump-to-topic
3692 Go to a topic (@code{gnus-topic-jump-to-topic}).
3696 @findex gnus-topic-copy-group
3697 Copy the current group to some other topic
3698 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3699 convention (@pxref{Process/Prefix}).
3703 @findex gnus-topic-hide-topic
3704 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3705 a prefix, hide the topic permanently.
3709 @findex gnus-topic-show-topic
3710 Show the current topic (@code{gnus-topic-show-topic}). If given
3711 a prefix, show the topic permanently.
3715 @findex gnus-topic-remove-group
3716 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3717 This command is mainly useful if you have the same group in several
3718 topics and wish to remove it from one of the topics. You may also
3719 remove a group from all topics, but in that case, Gnus will add it to
3720 the root topic the next time you start Gnus. In fact, all new groups
3721 (which, naturally, don't belong to any topic) will show up in the root
3724 This command uses the process/prefix convention
3725 (@pxref{Process/Prefix}).
3729 @findex gnus-topic-move-matching
3730 Move all groups that match some regular expression to a topic
3731 (@code{gnus-topic-move-matching}).
3735 @findex gnus-topic-copy-matching
3736 Copy all groups that match some regular expression to a topic
3737 (@code{gnus-topic-copy-matching}).
3741 @findex gnus-topic-toggle-display-empty-topics
3742 Toggle hiding empty topics
3743 (@code{gnus-topic-toggle-display-empty-topics}).
3747 @findex gnus-topic-mark-topic
3748 Mark all groups in the current topic with the process mark
3749 (@code{gnus-topic-mark-topic}). This command works recursively on
3750 sub-topics unless given a prefix.
3753 @kindex T M-# (Topic)
3754 @findex gnus-topic-unmark-topic
3755 Remove the process mark from all groups in the current topic
3756 (@code{gnus-topic-unmark-topic}). This command works recursively on
3757 sub-topics unless given a prefix.
3760 @kindex C-c C-x (Topic)
3761 @findex gnus-topic-expire-articles
3762 Run all expirable articles in the current group or topic through the
3763 expiry process (if any)
3764 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3768 @findex gnus-topic-rename
3769 Rename a topic (@code{gnus-topic-rename}).
3772 @kindex T DEL (Topic)
3773 @findex gnus-topic-delete
3774 Delete an empty topic (@code{gnus-topic-delete}).
3778 @findex gnus-topic-list-active
3779 List all groups that gnus knows about in a topics-ified way
3780 (@code{gnus-topic-list-active}).
3783 @kindex T M-n (Topic)
3784 @findex gnus-topic-goto-next-topic
3785 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3788 @kindex T M-p (Topic)
3789 @findex gnus-topic-goto-previous-topic
3790 Go to the next topic (@code{gnus-topic-goto-previous-topic}).
3794 @findex gnus-topic-edit-parameters
3795 @cindex group parameters
3796 @cindex topic parameters
3798 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3799 @xref{Topic Parameters}.
3804 @node Topic Variables
3805 @subsection Topic Variables
3806 @cindex topic variables
3808 The previous section told you how to tell Gnus which topics to display.
3809 This section explains how to tell Gnus what to display about each topic.
3811 @vindex gnus-topic-line-format
3812 The topic lines themselves are created according to the
3813 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3826 Number of groups in the topic.
3828 Number of unread articles in the topic.
3830 Number of unread articles in the topic and all its subtopics.
3833 @vindex gnus-topic-indent-level
3834 Each sub-topic (and the groups in the sub-topics) will be indented with
3835 @code{gnus-topic-indent-level} times the topic level number of spaces.
3838 @vindex gnus-topic-mode-hook
3839 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3841 @vindex gnus-topic-display-empty-topics
3842 The @code{gnus-topic-display-empty-topics} says whether to display even
3843 topics that have no unread articles in them. The default is @code{t}.
3847 @subsection Topic Sorting
3848 @cindex topic sorting
3850 You can sort the groups in each topic individually with the following
3856 @kindex T S a (Topic)
3857 @findex gnus-topic-sort-groups-by-alphabet
3858 Sort the current topic alphabetically by group name
3859 (@code{gnus-topic-sort-groups-by-alphabet}).
3862 @kindex T S u (Topic)
3863 @findex gnus-topic-sort-groups-by-unread
3864 Sort the current topic by the number of unread articles
3865 (@code{gnus-topic-sort-groups-by-unread}).
3868 @kindex T S l (Topic)
3869 @findex gnus-topic-sort-groups-by-level
3870 Sort the current topic by group level
3871 (@code{gnus-topic-sort-groups-by-level}).
3874 @kindex T S v (Topic)
3875 @findex gnus-topic-sort-groups-by-score
3876 Sort the current topic by group score
3877 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3880 @kindex T S r (Topic)
3881 @findex gnus-topic-sort-groups-by-rank
3882 Sort the current topic by group rank
3883 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3886 @kindex T S m (Topic)
3887 @findex gnus-topic-sort-groups-by-method
3888 Sort the current topic alphabetically by back end name
3889 (@code{gnus-topic-sort-groups-by-method}).
3892 @kindex T S e (Topic)
3893 @findex gnus-topic-sort-groups-by-server
3894 Sort the current topic alphabetically by server name
3895 (@code{gnus-topic-sort-groups-by-server}).
3898 @kindex T S s (Topic)
3899 @findex gnus-topic-sort-groups
3900 Sort the current topic according to the function(s) given by the
3901 @code{gnus-group-sort-function} variable
3902 (@code{gnus-topic-sort-groups}).
3906 When given a prefix argument, all these commands will sort in reverse
3907 order. @xref{Sorting Groups}, for more information about group
3911 @node Topic Topology
3912 @subsection Topic Topology
3913 @cindex topic topology
3916 So, let's have a look at an example group buffer:
3923 2: alt.religion.emacs
3926 0: comp.talk.emacs.recovery
3928 8: comp.binaries.fractals
3929 13: comp.sources.unix
3933 So, here we have one top-level topic (@samp{Gnus}), two topics under
3934 that, and one sub-topic under one of the sub-topics. (There is always
3935 just one (1) top-level topic). This topology can be expressed as
3940 (("Emacs -- I wuw it!" visible)
3941 (("Naughty Emacs" visible)))
3945 @vindex gnus-topic-topology
3946 This is in fact how the variable @code{gnus-topic-topology} would look
3947 for the display above. That variable is saved in the @file{.newsrc.eld}
3948 file, and shouldn't be messed with manually---unless you really want
3949 to. Since this variable is read from the @file{.newsrc.eld} file,
3950 setting it in any other startup files will have no effect.
3952 This topology shows what topics are sub-topics of what topics (right),
3953 and which topics are visible. Two settings are currently
3954 allowed---@code{visible} and @code{invisible}.
3957 @node Topic Parameters
3958 @subsection Topic Parameters
3959 @cindex topic parameters
3961 All groups in a topic will inherit group parameters from the parent
3962 (and ancestor) topic parameters. All valid group parameters are valid
3963 topic parameters (@pxref{Group Parameters}). When the agent is
3964 enabled, all agent parameters (See Agent Parameters in @ref{Category
3965 Syntax}) are also valid topic parameters.
3967 In addition, the following parameters are only valid as topic
3972 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3973 @code{subscribe} topic parameter says what groups go in what topic. Its
3974 value should be a regexp to match the groups that should go in that
3977 @item subscribe-level
3978 When subscribing new groups by topic (see the @code{subscribe} parameter),
3979 the group will be subscribed with the level specified in the
3980 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
3984 Group parameters (of course) override topic parameters, and topic
3985 parameters in sub-topics override topic parameters in super-topics. You
3986 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
3987 verb, although you may feel free to disagree with me here.)
3994 2: alt.religion.emacs
3998 0: comp.talk.emacs.recovery
4000 8: comp.binaries.fractals
4001 13: comp.sources.unix
4006 The @samp{Emacs} topic has the topic parameter @code{(score-file
4007 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4008 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4009 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4010 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4011 . "religion.SCORE")}.
4013 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4014 will get the @file{relief.SCORE} home score file. If you enter the same
4015 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4016 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4017 get the @file{religion.SCORE} home score file.
4019 This seems rather simple and self-evident, doesn't it? Well, yes. But
4020 there are some problems, especially with the @code{total-expiry}
4021 parameter. Say you have a mail group in two topics; one with
4022 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4023 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4024 of these topics you mean to expire articles from, so anything may
4025 happen. In fact, I hereby declare that it is @dfn{undefined} what
4026 happens. You just have to be careful if you do stuff like that.
4029 @node Misc Group Stuff
4030 @section Misc Group Stuff
4033 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4034 * Group Information:: Information and help on groups and Gnus.
4035 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4036 * File Commands:: Reading and writing the Gnus files.
4037 * Sieve Commands:: Managing Sieve scripts.
4044 @findex gnus-group-enter-server-mode
4045 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4046 @xref{Server Buffer}.
4050 @findex gnus-group-post-news
4051 Start composing a message (a news by default)
4052 (@code{gnus-group-post-news}). If given a prefix, post to the group
4053 under the point. If the prefix is 1, prompt for a group to post to.
4054 Contrary to what the name of this function suggests, the prepared
4055 article might be a mail instead of a news, if a mail group is specified
4056 with the prefix argument. @xref{Composing Messages}.
4060 @findex gnus-group-mail
4061 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4062 use the posting style of the group under the point. If the prefix is 1,
4063 prompt for a group name to find the posting style.
4064 @xref{Composing Messages}.
4068 @findex gnus-group-news
4069 Start composing a news (@code{gnus-group-news}). If given a prefix,
4070 post to the group under the point. If the prefix is 1, prompt
4071 for group to post to. @xref{Composing Messages}.
4073 This function actually prepares a news even when using mail groups.
4074 This is useful for ``posting'' messages to mail groups without actually
4075 sending them over the network: they're just saved directly to the group
4076 in question. The corresponding back end must have a request-post method
4077 for this to work though.
4081 Variables for the group buffer:
4085 @item gnus-group-mode-hook
4086 @vindex gnus-group-mode-hook
4087 is called after the group buffer has been
4090 @item gnus-group-prepare-hook
4091 @vindex gnus-group-prepare-hook
4092 is called after the group buffer is
4093 generated. It may be used to modify the buffer in some strange,
4096 @item gnus-group-prepared-hook
4097 @vindex gnus-group-prepare-hook
4098 is called as the very last thing after the group buffer has been
4099 generated. It may be used to move point around, for instance.
4101 @item gnus-permanently-visible-groups
4102 @vindex gnus-permanently-visible-groups
4103 Groups matching this regexp will always be listed in the group buffer,
4104 whether they are empty or not.
4106 @item gnus-group-name-charset-method-alist
4107 @vindex gnus-group-name-charset-method-alist
4108 An alist of method and the charset for group names. It is used to show
4109 non-@acronym{ASCII} group names.
4113 (setq gnus-group-name-charset-method-alist
4114 '(((nntp "news.com.cn") . cn-gb-2312)))
4117 @item gnus-group-name-charset-group-alist
4118 @cindex UTF-8 group names
4119 @vindex gnus-group-name-charset-group-alist
4120 An alist of regexp of group name and the charset for group names. It
4121 is used to show non-@acronym{ASCII} group names. @code{((".*"
4122 utf-8))} is the default value if UTF-8 is supported, otherwise the
4123 default is @code{nil}.
4127 (setq gnus-group-name-charset-group-alist
4128 '(("\\.com\\.cn:" . cn-gb-2312)))
4133 @node Scanning New Messages
4134 @subsection Scanning New Messages
4135 @cindex new messages
4136 @cindex scanning new news
4142 @findex gnus-group-get-new-news
4143 @c @icon{gnus-group-get-new-news}
4144 Check the server(s) for new articles. If the numerical prefix is used,
4145 this command will check only groups of level @var{arg} and lower
4146 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4147 command will force a total re-reading of the active file(s) from the
4152 @findex gnus-group-get-new-news-this-group
4153 @vindex gnus-goto-next-group-when-activating
4154 @c @icon{gnus-group-get-new-news-this-group}
4155 Check whether new articles have arrived in the current group
4156 (@code{gnus-group-get-new-news-this-group}).
4157 @code{gnus-goto-next-group-when-activating} says whether this command is
4158 to move point to the next group or not. It is @code{t} by default.
4160 @findex gnus-activate-all-groups
4161 @cindex activating groups
4163 @kindex C-c M-g (Group)
4164 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4169 @findex gnus-group-restart
4170 Restart gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4171 file(s), closes the connection to all servers, clears up all run-time
4172 gnus variables, and then starts gnus all over again.
4176 @vindex gnus-get-new-news-hook
4177 @code{gnus-get-new-news-hook} is run just before checking for new news.
4179 @vindex gnus-after-getting-new-news-hook
4180 @code{gnus-after-getting-new-news-hook} is run after checking for new
4184 @node Group Information
4185 @subsection Group Information
4186 @cindex group information
4187 @cindex information on groups
4194 @findex gnus-group-fetch-faq
4195 @vindex gnus-group-faq-directory
4198 Try to fetch the @acronym{FAQ} for the current group
4199 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4200 from @code{gnus-group-faq-directory}, which is usually a directory on
4201 a remote machine. This variable can also be a list of directories.
4202 In that case, giving a prefix to this command will allow you to choose
4203 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4204 used for fetching the file.
4206 If fetching from the first site is unsuccessful, gnus will attempt to go
4207 through @code{gnus-group-faq-directory} and try to open them one by one.
4211 @findex gnus-group-fetch-charter
4212 @vindex gnus-group-charter-alist
4214 Try to open the charter for the current group in a web browser
4215 (@code{gnus-group-fetch-charter}). Query for a group if given a
4218 Gnus will use @code{gnus-group-charter-alist} to find the location of
4219 the charter. If no location is known, Gnus will fetch the control
4220 messages for the group, which in some cases includes the charter.
4224 @findex gnus-group-fetch-control
4225 @vindex gnus-group-fetch-control-use-browse-url
4226 @cindex control message
4227 Fetch the control messages for the group from the archive at
4228 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4229 group if given a prefix argument.
4231 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4232 Gnus will open the control messages in a browser using
4233 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4234 and displayed in an ephemeral group.
4236 Note that the control messages are compressed. To use this command
4237 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4238 Files, ,Compressed Files, emacs, The Emacs Manual}).
4242 @c @icon{gnus-group-describe-group}
4244 @kindex C-c C-d (Group)
4245 @cindex describing groups
4246 @cindex group description
4247 @findex gnus-group-describe-group
4248 Describe the current group (@code{gnus-group-describe-group}). If given
4249 a prefix, force Gnus to re-read the description from the server.
4253 @findex gnus-group-describe-all-groups
4254 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4255 prefix, force gnus to re-read the description file from the server.
4262 @findex gnus-version
4263 Display current gnus version numbers (@code{gnus-version}).
4267 @findex gnus-group-describe-briefly
4268 Give a very short help message (@code{gnus-group-describe-briefly}).
4271 @kindex C-c C-i (Group)
4274 @findex gnus-info-find-node
4275 Go to the gnus info node (@code{gnus-info-find-node}).
4279 @node Group Timestamp
4280 @subsection Group Timestamp
4282 @cindex group timestamps
4284 It can be convenient to let gnus keep track of when you last read a
4285 group. To set the ball rolling, you should add
4286 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4289 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4292 After doing this, each time you enter a group, it'll be recorded.
4294 This information can be displayed in various ways---the easiest is to
4295 use the @samp{%d} spec in the group line format:
4298 (setq gnus-group-line-format
4299 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4302 This will result in lines looking like:
4305 * 0: mail.ding 19961002T012943
4306 0: custom 19961002T012713
4309 As you can see, the date is displayed in compact ISO 8601 format. This
4310 may be a bit too much, so to just display the date, you could say
4314 (setq gnus-group-line-format
4315 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4318 If you would like greater control of the time format, you can use a
4319 user-defined format spec. Something like the following should do the
4323 (setq gnus-group-line-format
4324 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4325 (defun gnus-user-format-function-d (headers)
4326 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4328 (format-time-string "%b %d %H:%M" time)
4334 @subsection File Commands
4335 @cindex file commands
4341 @findex gnus-group-read-init-file
4342 @vindex gnus-init-file
4343 @cindex reading init file
4344 Re-read the init file (@code{gnus-init-file}, which defaults to
4345 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4349 @findex gnus-group-save-newsrc
4350 @cindex saving .newsrc
4351 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4352 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4353 file(s) whether Gnus thinks it is necessary or not.
4356 @c @kindex Z (Group)
4357 @c @findex gnus-group-clear-dribble
4358 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4363 @node Sieve Commands
4364 @subsection Sieve Commands
4365 @cindex group sieve commands
4367 Sieve is a server-side mail filtering language. In Gnus you can use
4368 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4369 sieve rules that should apply to each group. Gnus provides two
4370 commands to translate all these group parameters into a proper Sieve
4371 script that can be transfered to the server somehow.
4373 @vindex gnus-sieve-file
4374 @vindex gnus-sieve-region-start
4375 @vindex gnus-sieve-region-end
4376 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4377 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4378 between two delimiters, @code{gnus-sieve-region-start} and
4379 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4380 outside these delimiters that will not be removed the next time you
4381 regenerate the Sieve script.
4383 @vindex gnus-sieve-crosspost
4384 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4385 is generated. If it is non-@code{nil} (the default) articles is
4386 placed in all groups that have matching rules, otherwise the article
4387 is only placed in the group with the first matching rule. For
4388 example, the group parameter @samp{(sieve address "sender"
4389 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4390 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4391 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4392 except that the line containing the call to @code{stop} is removed.)
4395 if address "sender" "owner-ding@@hpc.uh.edu" @{
4396 fileinto "INBOX.ding";
4401 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4407 @findex gnus-sieve-generate
4408 @vindex gnus-sieve-file
4409 @cindex generating sieve script
4410 Regenerate a Sieve script from the @code{sieve} group parameters and
4411 put you into the @code{gnus-sieve-file} without saving it.
4415 @findex gnus-sieve-update
4416 @vindex gnus-sieve-file
4417 @cindex updating sieve script
4418 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4419 @code{sieve} group parameters, save the file and upload it to the
4420 server using the @code{sieveshell} program.
4425 @node Summary Buffer
4426 @chapter Summary Buffer
4427 @cindex summary buffer
4429 A line for each article is displayed in the summary buffer. You can
4430 move around, read articles, post articles and reply to articles.
4432 The most common way to a summary buffer is to select a group from the
4433 group buffer (@pxref{Selecting a Group}).
4435 You can have as many summary buffers open as you wish.
4438 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4439 * Summary Maneuvering:: Moving around the summary buffer.
4440 * Choosing Articles:: Reading articles.
4441 * Paging the Article:: Scrolling the current article.
4442 * Reply Followup and Post:: Posting articles.
4443 * Delayed Articles:: Send articles at a later time.
4444 * Marking Articles:: Marking articles as read, expirable, etc.
4445 * Limiting:: You can limit the summary buffer.
4446 * Threading:: How threads are made.
4447 * Sorting the Summary Buffer:: How articles and threads are sorted.
4448 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4449 * Article Caching:: You may store articles in a cache.
4450 * Persistent Articles:: Making articles expiry-resistant.
4451 * Article Backlog:: Having already read articles hang around.
4452 * Saving Articles:: Ways of customizing article saving.
4453 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4454 * Article Treatment:: The article buffer can be mangled at will.
4455 * MIME Commands:: Doing MIMEy things with the articles.
4456 * Charsets:: Character set issues.
4457 * Article Commands:: Doing various things with the article buffer.
4458 * Summary Sorting:: Sorting the summary buffer in various ways.
4459 * Finding the Parent:: No child support? Get the parent.
4460 * Alternative Approaches:: Reading using non-default summaries.
4461 * Tree Display:: A more visual display of threads.
4462 * Mail Group Commands:: Some commands can only be used in mail groups.
4463 * Various Summary Stuff:: What didn't fit anywhere else.
4464 * Exiting the Summary Buffer:: Returning to the Group buffer,
4465 or reselecting the current group.
4466 * Crosspost Handling:: How crossposted articles are dealt with.
4467 * Duplicate Suppression:: An alternative when crosspost handling fails.
4468 * Security:: Decrypt and Verify.
4469 * Mailing List:: Mailing list minor mode.
4473 @node Summary Buffer Format
4474 @section Summary Buffer Format
4475 @cindex summary buffer format
4479 \gnusfigure{The Summary Buffer}{180}{
4480 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4481 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4487 * Summary Buffer Lines:: You can specify how summary lines should look.
4488 * To From Newsgroups:: How to not display your own name.
4489 * Summary Buffer Mode Line:: You can say how the mode line should look.
4490 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4493 @findex mail-extract-address-components
4494 @findex gnus-extract-address-components
4495 @vindex gnus-extract-address-components
4496 Gnus will use the value of the @code{gnus-extract-address-components}
4497 variable as a function for getting the name and address parts of a
4498 @code{From} header. Three pre-defined functions exist:
4499 @code{gnus-extract-address-components}, which is the default, quite
4500 fast, and too simplistic solution;
4501 @code{mail-extract-address-components}, which works nicely, but is
4502 slower; and @code{std11-extract-address-components}, which works very
4503 nicely, but is slower. The default function will return the wrong
4504 answer in 5% of the cases. If this is unacceptable to you, use the
4505 other function instead:
4508 (setq gnus-extract-address-components
4509 'mail-extract-address-components)
4512 @vindex gnus-summary-same-subject
4513 @code{gnus-summary-same-subject} is a string indicating that the current
4514 article has the same subject as the previous. This string will be used
4515 with those specs that require it. The default is @code{""}.
4518 @node Summary Buffer Lines
4519 @subsection Summary Buffer Lines
4521 @vindex gnus-summary-line-format
4522 You can change the format of the lines in the summary buffer by changing
4523 the @code{gnus-summary-line-format} variable. It works along the same
4524 lines as a normal @code{format} string, with some extensions
4525 (@pxref{Formatting Variables}).
4527 There should always be a colon or a point position marker on the line;
4528 the cursor always moves to the point position marker or the colon after
4529 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4530 possible to change this. Just write a new function
4531 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4532 @xref{Positioning Point}.
4534 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4536 The following format specification characters and extended format
4537 specification(s) are understood:
4543 Subject string. List identifiers stripped,
4544 @code{gnus-list-identifies}. @xref{Article Hiding}.
4546 Subject if the article is the root of the thread or the previous article
4547 had a different subject, @code{gnus-summary-same-subject} otherwise.
4548 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4550 Full @code{From} header.
4552 The name (from the @code{From} header).
4554 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4557 The name (from the @code{From} header). This differs from the @code{n}
4558 spec in that it uses the function designated by the
4559 @code{gnus-extract-address-components} variable, which is slower, but
4560 may be more thorough.
4562 The address (from the @code{From} header). This works the same way as
4565 Number of lines in the article.
4567 Number of characters in the article. This specifier is not supported
4568 in some methods (like nnfolder).
4570 Pretty-printed version of the number of characters in the article;
4571 for example, @samp{1.2k} or @samp{0.4M}.
4573 Indentation based on thread level (@pxref{Customizing Threading}).
4575 A complex trn-style thread tree, showing response-connecting trace
4576 lines. A thread could be drawn like this:
4589 You can customize the appearance with the following options. Note
4590 that it is possible to make the thread display look really neat by
4591 replacing the default @acronym{ASCII} characters with graphic
4592 line-drawing glyphs.
4594 @item gnus-sum-thread-tree-root
4595 @vindex gnus-sum-thread-tree-root
4596 Used for the root of a thread. If @code{nil}, use subject
4597 instead. The default is @samp{> }.
4599 @item gnus-sum-thread-tree-false-root
4600 @vindex gnus-sum-thread-tree-false-root
4601 Used for the false root of a thread (@pxref{Loose Threads}). If
4602 @code{nil}, use subject instead. The default is @samp{> }.
4604 @item gnus-sum-thread-tree-single-indent
4605 @vindex gnus-sum-thread-tree-single-indent
4606 Used for a thread with just one message. If @code{nil}, use subject
4607 instead. The default is @samp{}.
4609 @item gnus-sum-thread-tree-vertical
4610 @vindex gnus-sum-thread-tree-vertical
4611 Used for drawing a vertical line. The default is @samp{| }.
4613 @item gnus-sum-thread-tree-indent
4614 @vindex gnus-sum-thread-tree-indent
4615 Used for indenting. The default is @samp{ }.
4617 @item gnus-sum-thread-tree-leaf-with-other
4618 @vindex gnus-sum-thread-tree-leaf-with-other
4619 Used for a leaf with brothers. The default is @samp{+-> }.
4621 @item gnus-sum-thread-tree-single-leaf
4622 @vindex gnus-sum-thread-tree-single-leaf
4623 Used for a leaf without brothers. The default is @samp{\-> }
4628 Nothing if the article is a root and lots of spaces if it isn't (it
4629 pushes everything after it off the screen).
4631 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4632 for adopted articles (@pxref{Customizing Threading}).
4634 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4635 for adopted articles.
4637 One space for each thread level.
4639 Twenty minus thread level spaces.
4641 Unread. @xref{Read Articles}.
4644 This misleadingly named specifier is the @dfn{secondary mark}. This
4645 mark will say whether the article has been replied to, has been cached,
4646 or has been saved. @xref{Other Marks}.
4649 Score as a number (@pxref{Scoring}).
4651 @vindex gnus-summary-zcore-fuzz
4652 Zcore, @samp{+} if above the default level and @samp{-} if below the
4653 default level. If the difference between
4654 @code{gnus-summary-default-score} and the score is less than
4655 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4663 The @code{Date} in @code{DD-MMM} format.
4665 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4671 Number of articles in the current sub-thread. Using this spec will slow
4672 down summary buffer generation somewhat.
4674 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4675 article has any children.
4681 Age sensitive date format. Various date format is defined in
4682 @code{gnus-user-date-format-alist}.
4684 User defined specifier. The next character in the format string should
4685 be a letter. Gnus will call the function
4686 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4687 following @samp{%u}. The function will be passed the current header as
4688 argument. The function should return a string, which will be inserted
4689 into the summary just like information from any other summary specifier.
4692 Text between @samp{%(} and @samp{%)} will be highlighted with
4693 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4694 There can only be one such area.
4696 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4697 have to be handled with care. For reasons of efficiency, gnus will
4698 compute what column these characters will end up in, and ``hard-code''
4699 that. This means that it is invalid to have these specs after a
4700 variable-length spec. Well, you might not be arrested, but your summary
4701 buffer will look strange, which is bad enough.
4703 The smart choice is to have these specs as far to the left as possible.
4704 (Isn't that the case with everything, though? But I digress.)
4706 This restriction may disappear in later versions of gnus.
4709 @node To From Newsgroups
4710 @subsection To From Newsgroups
4714 In some groups (particularly in archive groups), the @code{From} header
4715 isn't very interesting, since all the articles there are written by
4716 you. To display the information in the @code{To} or @code{Newsgroups}
4717 headers instead, you need to decide three things: What information to
4718 gather; where to display it; and when to display it.
4722 @vindex gnus-extra-headers
4723 The reading of extra header information is controlled by the
4724 @code{gnus-extra-headers}. This is a list of header symbols. For
4728 (setq gnus-extra-headers
4729 '(To Newsgroups X-Newsreader))
4732 This will result in Gnus trying to obtain these three headers, and
4733 storing it in header structures for later easy retrieval.
4736 @findex gnus-extra-header
4737 The value of these extra headers can be accessed via the
4738 @code{gnus-extra-header} function. Here's a format line spec that will
4739 access the @code{X-Newsreader} header:
4742 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4746 @vindex gnus-ignored-from-addresses
4747 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4748 summary line spec returns the @code{To}, @code{Newsreader} or
4749 @code{From} header. If this regexp matches the contents of the
4750 @code{From} header, the value of the @code{To} or @code{Newsreader}
4751 headers are used instead.
4755 @vindex nnmail-extra-headers
4756 A related variable is @code{nnmail-extra-headers}, which controls when
4757 to include extra headers when generating overview (@acronym{NOV}) files.
4758 If you have old overview files, you should regenerate them after
4759 changing this variable, by entering the server buffer using @kbd{^},
4760 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
4763 @vindex gnus-summary-line-format
4764 You also have to instruct Gnus to display the data by changing the
4765 @code{%n} spec to the @code{%f} spec in the
4766 @code{gnus-summary-line-format} variable.
4768 In summary, you'd typically put something like the following in
4772 (setq gnus-extra-headers
4774 (setq nnmail-extra-headers gnus-extra-headers)
4775 (setq gnus-summary-line-format
4776 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4777 (setq gnus-ignored-from-addresses
4781 (The values listed above are the default values in Gnus. Alter them
4784 A note for news server administrators, or for users who wish to try to
4785 convince their news server administrator to provide some additional
4788 The above is mostly useful for mail groups, where you have control over
4789 the @acronym{NOV} files that are created. However, if you can persuade your
4790 nntp admin to add (in the usual implementation, notably INN):
4796 to the end of her @file{overview.fmt} file, then you can use that just
4797 as you would the extra headers from the mail groups.
4800 @node Summary Buffer Mode Line
4801 @subsection Summary Buffer Mode Line
4803 @vindex gnus-summary-mode-line-format
4804 You can also change the format of the summary mode bar (@pxref{Mode Line
4805 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4806 like. The default is @samp{Gnus: %%b [%A] %Z}.
4808 Here are the elements you can play with:
4814 Unprefixed group name.
4816 Current article number.
4818 Current article score.
4822 Number of unread articles in this group.
4824 Number of unread articles in this group that aren't displayed in the
4827 A string with the number of unread and unselected articles represented
4828 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4829 articles, and just as @samp{<%U more>} if there are just unread articles
4830 and no unselected ones.
4832 Shortish group name. For instance, @samp{rec.arts.anime} will be
4833 shortened to @samp{r.a.anime}.
4835 Subject of the current article.
4837 User-defined spec (@pxref{User-Defined Specs}).
4839 Name of the current score file (@pxref{Scoring}).
4841 Number of dormant articles (@pxref{Unread Articles}).
4843 Number of ticked articles (@pxref{Unread Articles}).
4845 Number of articles that have been marked as read in this session.
4847 Number of articles expunged by the score files.
4851 @node Summary Highlighting
4852 @subsection Summary Highlighting
4856 @item gnus-visual-mark-article-hook
4857 @vindex gnus-visual-mark-article-hook
4858 This hook is run after selecting an article. It is meant to be used for
4859 highlighting the article in some way. It is not run if
4860 @code{gnus-visual} is @code{nil}.
4862 @item gnus-summary-update-hook
4863 @vindex gnus-summary-update-hook
4864 This hook is called when a summary line is changed. It is not run if
4865 @code{gnus-visual} is @code{nil}.
4867 @item gnus-summary-selected-face
4868 @vindex gnus-summary-selected-face
4869 This is the face (or @dfn{font} as some people call it) used to
4870 highlight the current article in the summary buffer.
4872 @item gnus-summary-highlight
4873 @vindex gnus-summary-highlight
4874 Summary lines are highlighted according to this variable, which is a
4875 list where the elements are of the format @code{(@var{form}
4876 . @var{face})}. If you would, for instance, like ticked articles to be
4877 italic and high-scored articles to be bold, you could set this variable
4880 (((eq mark gnus-ticked-mark) . italic)
4881 ((> score default) . bold))
4883 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4884 @var{face} will be applied to the line.
4888 @node Summary Maneuvering
4889 @section Summary Maneuvering
4890 @cindex summary movement
4892 All the straight movement commands understand the numeric prefix and
4893 behave pretty much as you'd expect.
4895 None of these commands select articles.
4900 @kindex M-n (Summary)
4901 @kindex G M-n (Summary)
4902 @findex gnus-summary-next-unread-subject
4903 Go to the next summary line of an unread article
4904 (@code{gnus-summary-next-unread-subject}).
4908 @kindex M-p (Summary)
4909 @kindex G M-p (Summary)
4910 @findex gnus-summary-prev-unread-subject
4911 Go to the previous summary line of an unread article
4912 (@code{gnus-summary-prev-unread-subject}).
4915 @kindex G g (Summary)
4916 @findex gnus-summary-goto-subject
4917 Ask for an article number and then go to the summary line of that article
4918 without displaying the article (@code{gnus-summary-goto-subject}).
4921 If gnus asks you to press a key to confirm going to the next group, you
4922 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4923 buffer, searching for the next group to read without actually returning
4924 to the group buffer.
4926 Variables related to summary movement:
4930 @vindex gnus-auto-select-next
4931 @item gnus-auto-select-next
4932 If you issue one of the movement commands (like @kbd{n}) and there are
4933 no more unread articles after the current one, gnus will offer to go to
4934 the next group. If this variable is @code{t} and the next group is
4935 empty, gnus will exit summary mode and return to the group buffer. If
4936 this variable is neither @code{t} nor @code{nil}, gnus will select the
4937 next group with unread articles. As a special case, if this variable
4938 is @code{quietly}, Gnus will select the next group without asking for
4939 confirmation. If this variable is @code{almost-quietly}, the same
4940 will happen only if you are located on the last article in the group.
4941 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
4942 command will go to the next group without confirmation. Also
4943 @pxref{Group Levels}.
4945 @item gnus-auto-select-same
4946 @vindex gnus-auto-select-same
4947 If non-@code{nil}, all the movement commands will try to go to the next
4948 article with the same subject as the current. (@dfn{Same} here might
4949 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4950 for details (@pxref{Customizing Threading}).) If there are no more
4951 articles with the same subject, go to the first unread article.
4953 This variable is not particularly useful if you use a threaded display.
4955 @item gnus-summary-check-current
4956 @vindex gnus-summary-check-current
4957 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4958 to the next (or previous) article if the current article is unread.
4959 Instead, they will choose the current article.
4961 @item gnus-auto-center-summary
4962 @vindex gnus-auto-center-summary
4963 If non-@code{nil}, gnus will keep the point in the summary buffer
4964 centered at all times. This makes things quite tidy, but if you have a
4965 slow network connection, or simply do not like this un-Emacsism, you can
4966 set this variable to @code{nil} to get the normal Emacs scrolling
4967 action. This will also inhibit horizontal re-centering of the summary
4968 buffer, which might make it more inconvenient to read extremely long
4971 This variable can also be a number. In that case, center the window at
4972 the given number of lines from the top.
4977 @node Choosing Articles
4978 @section Choosing Articles
4979 @cindex selecting articles
4982 * Choosing Commands:: Commands for choosing articles.
4983 * Choosing Variables:: Variables that influence these commands.
4987 @node Choosing Commands
4988 @subsection Choosing Commands
4990 None of the following movement commands understand the numeric prefix,
4991 and they all select and display an article.
4993 If you want to fetch new articles or redisplay the group, see
4994 @ref{Exiting the Summary Buffer}.
4998 @kindex SPACE (Summary)
4999 @findex gnus-summary-next-page
5000 Select the current article, or, if that one's read already, the next
5001 unread article (@code{gnus-summary-next-page}).
5003 If you have an article window open already and you press @kbd{SPACE}
5004 again, the article will be scrolled. This lets you conveniently
5005 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5010 @kindex G n (Summary)
5011 @findex gnus-summary-next-unread-article
5012 @c @icon{gnus-summary-next-unread}
5013 Go to next unread article (@code{gnus-summary-next-unread-article}).
5018 @findex gnus-summary-prev-unread-article
5019 @c @icon{gnus-summary-prev-unread}
5020 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5025 @kindex G N (Summary)
5026 @findex gnus-summary-next-article
5027 Go to the next article (@code{gnus-summary-next-article}).
5032 @kindex G P (Summary)
5033 @findex gnus-summary-prev-article
5034 Go to the previous article (@code{gnus-summary-prev-article}).
5037 @kindex G C-n (Summary)
5038 @findex gnus-summary-next-same-subject
5039 Go to the next article with the same subject
5040 (@code{gnus-summary-next-same-subject}).
5043 @kindex G C-p (Summary)
5044 @findex gnus-summary-prev-same-subject
5045 Go to the previous article with the same subject
5046 (@code{gnus-summary-prev-same-subject}).
5050 @kindex G f (Summary)
5052 @findex gnus-summary-first-unread-article
5053 Go to the first unread article
5054 (@code{gnus-summary-first-unread-article}).
5058 @kindex G b (Summary)
5060 @findex gnus-summary-best-unread-article
5061 Go to the unread article with the highest score
5062 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5063 go to the first unread article that has a score over the default score.
5068 @kindex G l (Summary)
5069 @findex gnus-summary-goto-last-article
5070 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5073 @kindex G o (Summary)
5074 @findex gnus-summary-pop-article
5076 @cindex article history
5077 Pop an article off the summary history and go to this article
5078 (@code{gnus-summary-pop-article}). This command differs from the
5079 command above in that you can pop as many previous articles off the
5080 history as you like, while @kbd{l} toggles the two last read articles.
5081 For a somewhat related issue (if you use these commands a lot),
5082 @pxref{Article Backlog}.
5087 @kindex G j (Summary)
5088 @findex gnus-summary-goto-article
5089 Ask for an article number or @code{Message-ID}, and then go to that
5090 article (@code{gnus-summary-goto-article}).
5095 @node Choosing Variables
5096 @subsection Choosing Variables
5098 Some variables relevant for moving and selecting articles:
5101 @item gnus-auto-extend-newsgroup
5102 @vindex gnus-auto-extend-newsgroup
5103 All the movement commands will try to go to the previous (or next)
5104 article, even if that article isn't displayed in the Summary buffer if
5105 this variable is non-@code{nil}. Gnus will then fetch the article from
5106 the server and display it in the article buffer.
5108 @item gnus-select-article-hook
5109 @vindex gnus-select-article-hook
5110 This hook is called whenever an article is selected. By default it
5111 exposes any threads hidden under the selected article. If you would
5112 like each article to be saved in the Agent as you read it, putting
5113 @code{gnus-agent-fetch-selected-article} on this hook will do so.
5115 @item gnus-mark-article-hook
5116 @vindex gnus-mark-article-hook
5117 @findex gnus-summary-mark-unread-as-read
5118 @findex gnus-summary-mark-read-and-unread-as-read
5119 @findex gnus-unread-mark
5120 This hook is called whenever an article is selected. It is intended to
5121 be used for marking articles as read. The default value is
5122 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5123 mark of almost any article you read to @code{gnus-unread-mark}. The
5124 only articles not affected by this function are ticked, dormant, and
5125 expirable articles. If you'd instead like to just have unread articles
5126 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5127 instead. It will leave marks like @code{gnus-low-score-mark},
5128 @code{gnus-del-mark} (and so on) alone.
5133 @node Paging the Article
5134 @section Scrolling the Article
5135 @cindex article scrolling
5140 @kindex SPACE (Summary)
5141 @findex gnus-summary-next-page
5142 Pressing @kbd{SPACE} will scroll the current article forward one page,
5143 or, if you have come to the end of the current article, will choose the
5144 next article (@code{gnus-summary-next-page}).
5146 @vindex gnus-article-boring-faces
5147 @vindex gnus-article-skip-boring
5148 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5149 the article consists only of citations and signature, then it will be
5150 skipped; the next article will be shown instead. You can customize
5151 what is considered uninteresting with
5152 @code{gnus-article-boring-faces}. You can manually view the article's
5153 pages, no matter how boring, using @kbd{C-M-v}.
5156 @kindex DEL (Summary)
5157 @findex gnus-summary-prev-page
5158 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5161 @kindex RET (Summary)
5162 @findex gnus-summary-scroll-up
5163 Scroll the current article one line forward
5164 (@code{gnus-summary-scroll-up}).
5167 @kindex M-RET (Summary)
5168 @findex gnus-summary-scroll-down
5169 Scroll the current article one line backward
5170 (@code{gnus-summary-scroll-down}).
5174 @kindex A g (Summary)
5176 @findex gnus-summary-show-article
5177 @vindex gnus-summary-show-article-charset-alist
5178 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5179 given a prefix, fetch the current article, but don't run any of the
5180 article treatment functions. This will give you a ``raw'' article, just
5181 the way it came from the server.
5183 If given a numerical prefix, you can do semi-manual charset stuff.
5184 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5185 encoded in the @code{cn-gb-2312} charset. If you have
5188 (setq gnus-summary-show-article-charset-alist
5193 then you can say @kbd{C-u 1 g} to get the same effect.
5198 @kindex A < (Summary)
5199 @findex gnus-summary-beginning-of-article
5200 Scroll to the beginning of the article
5201 (@code{gnus-summary-beginning-of-article}).
5206 @kindex A > (Summary)
5207 @findex gnus-summary-end-of-article
5208 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5212 @kindex A s (Summary)
5214 @findex gnus-summary-isearch-article
5215 Perform an isearch in the article buffer
5216 (@code{gnus-summary-isearch-article}).
5220 @findex gnus-summary-select-article-buffer
5221 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5226 @node Reply Followup and Post
5227 @section Reply, Followup and Post
5230 * Summary Mail Commands:: Sending mail.
5231 * Summary Post Commands:: Sending news.
5232 * Summary Message Commands:: Other Message-related commands.
5233 * Canceling and Superseding::
5237 @node Summary Mail Commands
5238 @subsection Summary Mail Commands
5240 @cindex composing mail
5242 Commands for composing a mail message:
5248 @kindex S r (Summary)
5250 @findex gnus-summary-reply
5251 @c @icon{gnus-summary-mail-reply}
5252 @c @icon{gnus-summary-reply}
5253 Mail a reply to the author of the current article
5254 (@code{gnus-summary-reply}).
5259 @kindex S R (Summary)
5260 @findex gnus-summary-reply-with-original
5261 @c @icon{gnus-summary-reply-with-original}
5262 Mail a reply to the author of the current article and include the
5263 original message (@code{gnus-summary-reply-with-original}). This
5264 command uses the process/prefix convention.
5267 @kindex S w (Summary)
5268 @findex gnus-summary-wide-reply
5269 Mail a wide reply to the author of the current article
5270 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5271 goes out to all people listed in the @code{To}, @code{From} (or
5272 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5273 present, that's used instead.
5276 @kindex S W (Summary)
5277 @findex gnus-summary-wide-reply-with-original
5278 Mail a wide reply to the current article and include the original
5279 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5280 the process/prefix convention.
5283 @kindex S v (Summary)
5284 @findex gnus-summary-very-wide-reply
5285 Mail a very wide reply to the author of the current article
5286 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5287 that goes out to all people listed in the @code{To}, @code{From} (or
5288 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5289 articles. This command uses the process/prefix convention.
5292 @kindex S V (Summary)
5293 @findex gnus-summary-very-wide-reply-with-original
5294 Mail a very wide reply to the author of the current article and include the
5295 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5296 command uses the process/prefix convention.
5299 @kindex S B r (Summary)
5300 @findex gnus-summary-reply-broken-reply-to
5301 Mail a reply to the author of the current article but ignore the
5302 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5303 If you need this because a mailing list incorrectly sets a
5304 @code{Reply-To} header pointing to the list, you probably want to set
5305 the @code{broken-reply-to} group parameter instead, so things will work
5306 correctly. @xref{Group Parameters}.
5309 @kindex S B R (Summary)
5310 @findex gnus-summary-reply-broken-reply-to-with-original
5311 Mail a reply to the author of the current article and include the
5312 original message but ignore the @code{Reply-To} field
5313 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5317 @kindex S o m (Summary)
5318 @kindex C-c C-f (Summary)
5319 @findex gnus-summary-mail-forward
5320 @c @icon{gnus-summary-mail-forward}
5321 Forward the current article to some other person
5322 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
5323 headers of the forwarded article.
5328 @kindex S m (Summary)
5329 @findex gnus-summary-mail-other-window
5330 @c @icon{gnus-summary-mail-originate}
5331 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5332 the posting style of the current group. If given a prefix, disable that.
5333 If the prefix is 1, prompt for a group name to find the posting style.
5338 @kindex S i (Summary)
5339 @findex gnus-summary-news-other-window
5340 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5341 post to the current group. If given a prefix, disable that. If the
5342 prefix is 1, prompt for a group to post to.
5344 This function actually prepares a news even when using mail groups.
5345 This is useful for ``posting'' messages to mail groups without actually
5346 sending them over the network: they're just saved directly to the group
5347 in question. The corresponding back end must have a request-post method
5348 for this to work though.
5351 @kindex S D b (Summary)
5352 @findex gnus-summary-resend-bounced-mail
5353 @cindex bouncing mail
5354 If you have sent a mail, but the mail was bounced back to you for some
5355 reason (wrong address, transient failure), you can use this command to
5356 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5357 will be popped into a mail buffer where you can edit the headers before
5358 sending the mail off again. If you give a prefix to this command, and
5359 the bounced mail is a reply to some other mail, gnus will try to fetch
5360 that mail and display it for easy perusal of its headers. This might
5361 very well fail, though.
5364 @kindex S D r (Summary)
5365 @findex gnus-summary-resend-message
5366 Not to be confused with the previous command,
5367 @code{gnus-summary-resend-message} will prompt you for an address to
5368 send the current message off to, and then send it to that place. The
5369 headers of the message won't be altered---but lots of headers that say
5370 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5371 means that you actually send a mail to someone that has a @code{To}
5372 header that (probably) points to yourself. This will confuse people.
5373 So, natcherly you'll only do that if you're really eVIl.
5375 This command is mainly used if you have several accounts and want to
5376 ship a mail to a different account of yours. (If you're both
5377 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5378 to the @code{root} account, you may want to resend it to
5379 @code{postmaster}. Ordnung muss sein!
5381 This command understands the process/prefix convention
5382 (@pxref{Process/Prefix}).
5385 @kindex S D e (Summary)
5386 @findex gnus-summary-resend-message-edit
5388 Like the previous command, but will allow you to edit the message as
5389 if it were a new message before resending.
5392 @kindex S O m (Summary)
5393 @findex gnus-summary-digest-mail-forward
5394 Digest the current series (@pxref{Decoding Articles}) and forward the
5395 result using mail (@code{gnus-summary-digest-mail-forward}). This
5396 command uses the process/prefix convention (@pxref{Process/Prefix}).
5399 @kindex S M-c (Summary)
5400 @findex gnus-summary-mail-crosspost-complaint
5401 @cindex crossposting
5402 @cindex excessive crossposting
5403 Send a complaint about excessive crossposting to the author of the
5404 current article (@code{gnus-summary-mail-crosspost-complaint}).
5406 @findex gnus-crosspost-complaint
5407 This command is provided as a way to fight back against the current
5408 crossposting pandemic that's sweeping Usenet. It will compose a reply
5409 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5410 command understands the process/prefix convention
5411 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5415 Also @xref{Header Commands, ,Header Commands, message, The Message
5416 Manual}, for more information.
5419 @node Summary Post Commands
5420 @subsection Summary Post Commands
5422 @cindex composing news
5424 Commands for posting a news article:
5430 @kindex S p (Summary)
5431 @findex gnus-summary-post-news
5432 @c @icon{gnus-summary-post-news}
5433 Prepare for posting an article (@code{gnus-summary-post-news}). By
5434 default, post to the current group. If given a prefix, disable that.
5435 If the prefix is 1, prompt for another group instead.
5440 @kindex S f (Summary)
5441 @findex gnus-summary-followup
5442 @c @icon{gnus-summary-followup}
5443 Post a followup to the current article (@code{gnus-summary-followup}).
5447 @kindex S F (Summary)
5449 @c @icon{gnus-summary-followup-with-original}
5450 @findex gnus-summary-followup-with-original
5451 Post a followup to the current article and include the original message
5452 (@code{gnus-summary-followup-with-original}). This command uses the
5453 process/prefix convention.
5456 @kindex S n (Summary)
5457 @findex gnus-summary-followup-to-mail
5458 Post a followup to the current article via news, even if you got the
5459 message through mail (@code{gnus-summary-followup-to-mail}).
5462 @kindex S N (Summary)
5463 @findex gnus-summary-followup-to-mail-with-original
5464 Post a followup to the current article via news, even if you got the
5465 message through mail and include the original message
5466 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5467 the process/prefix convention.
5470 @kindex S o p (Summary)
5471 @findex gnus-summary-post-forward
5472 Forward the current article to a newsgroup
5473 (@code{gnus-summary-post-forward}). If given a prefix, include the full
5474 headers of the forwarded article.
5477 @kindex S O p (Summary)
5478 @findex gnus-summary-digest-post-forward
5480 @cindex making digests
5481 Digest the current series and forward the result to a newsgroup
5482 (@code{gnus-summary-digest-post-forward}). This command uses the
5483 process/prefix convention.
5486 @kindex S u (Summary)
5487 @findex gnus-uu-post-news
5488 @c @icon{gnus-uu-post-news}
5489 Uuencode a file, split it into parts, and post it as a series
5490 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5493 Also @xref{Header Commands, ,Header Commands, message, The Message
5494 Manual}, for more information.
5497 @node Summary Message Commands
5498 @subsection Summary Message Commands
5502 @kindex S y (Summary)
5503 @findex gnus-summary-yank-message
5504 Yank the current article into an already existing Message composition
5505 buffer (@code{gnus-summary-yank-message}). This command prompts for
5506 what message buffer you want to yank into, and understands the
5507 process/prefix convention (@pxref{Process/Prefix}).
5512 @node Canceling and Superseding
5513 @subsection Canceling Articles
5514 @cindex canceling articles
5515 @cindex superseding articles
5517 Have you ever written something, and then decided that you really,
5518 really, really wish you hadn't posted that?
5520 Well, you can't cancel mail, but you can cancel posts.
5522 @findex gnus-summary-cancel-article
5524 @c @icon{gnus-summary-cancel-article}
5525 Find the article you wish to cancel (you can only cancel your own
5526 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5527 c} (@code{gnus-summary-cancel-article}). Your article will be
5528 canceled---machines all over the world will be deleting your article.
5529 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5531 Be aware, however, that not all sites honor cancels, so your article may
5532 live on here and there, while most sites will delete the article in
5535 Gnus will use the ``current'' select method when canceling. If you
5536 want to use the standard posting method, use the @samp{a} symbolic
5537 prefix (@pxref{Symbolic Prefixes}).
5539 Gnus ensures that only you can cancel your own messages using a
5540 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5541 message, Message Manual}).
5543 If you discover that you have made some mistakes and want to do some
5544 corrections, you can post a @dfn{superseding} article that will replace
5545 your original article.
5547 @findex gnus-summary-supersede-article
5549 Go to the original article and press @kbd{S s}
5550 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5551 where you can edit the article all you want before sending it off the
5554 The same goes for superseding as for canceling, only more so: Some
5555 sites do not honor superseding. On those sites, it will appear that you
5556 have posted almost the same article twice.
5558 If you have just posted the article, and change your mind right away,
5559 there is a trick you can use to cancel/supersede the article without
5560 waiting for the article to appear on your site first. You simply return
5561 to the post buffer (which is called @code{*sent ...*}). There you will
5562 find the article you just posted, with all the headers intact. Change
5563 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5564 header by substituting one of those words for the word
5565 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5566 you would do normally. The previous article will be
5567 canceled/superseded.
5569 Just remember, kids: There is no 'c' in 'supersede'.
5571 @node Delayed Articles
5572 @section Delayed Articles
5573 @cindex delayed sending
5574 @cindex send delayed
5576 Sometimes, you might wish to delay the sending of a message. For
5577 example, you might wish to arrange for a message to turn up just in time
5578 to remind your about the birthday of your Significant Other. For this,
5579 there is the @code{gnus-delay} package. Setup is simple:
5582 (gnus-delay-initialize)
5585 @findex gnus-delay-article
5586 Normally, to send a message you use the @kbd{C-c C-c} command from
5587 Message mode. To delay a message, use @kbd{C-c C-j}
5588 (@code{gnus-delay-article}) instead. This will ask you for how long the
5589 message should be delayed. Possible answers are:
5593 A time span. Consists of an integer and a letter. For example,
5594 @code{42d} means to delay for 42 days. Available letters are @code{m}
5595 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5596 (months) and @code{Y} (years).
5599 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5600 delayed until that day, at a specific time (eight o'clock by default).
5601 See also @code{gnus-delay-default-hour}.
5604 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5605 stuff. The deadline will be at that time today, except if that time has
5606 already passed, then it's at the given time tomorrow. So if it's ten
5607 o'clock in the morning and you specify @code{11:15}, then the deadline
5608 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5609 that means a time tomorrow.
5612 The action of the @code{gnus-delay-article} command is influenced by a
5613 couple of variables:
5616 @item gnus-delay-default-hour
5617 @vindex gnus-delay-default-hour
5618 When you specify a specific date, the message will be due on that hour
5619 on the given date. Possible values are integers 0 through 23.
5621 @item gnus-delay-default-delay
5622 @vindex gnus-delay-default-delay
5623 This is a string and gives the default delay. It can be of any of the
5624 formats described above.
5626 @item gnus-delay-group
5627 @vindex gnus-delay-group
5628 Delayed articles will be kept in this group on the drafts server until
5629 they are due. You probably don't need to change this. The default
5630 value is @code{"delayed"}.
5632 @item gnus-delay-header
5633 @vindex gnus-delay-header
5634 The deadline for each article will be stored in a header. This variable
5635 is a string and gives the header name. You probably don't need to
5636 change this. The default value is @code{"X-Gnus-Delayed"}.
5639 The way delaying works is like this: when you use the
5640 @code{gnus-delay-article} command, you give a certain delay. Gnus
5641 calculates the deadline of the message and stores it in the
5642 @code{X-Gnus-Delayed} header and puts the message in the
5643 @code{nndraft:delayed} group.
5645 @findex gnus-delay-send-queue
5646 And whenever you get new news, Gnus looks through the group for articles
5647 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5648 function for this. By default, this function is added to the hook
5649 @code{gnus-get-new-news-hook}. But of course, you can change this.
5650 Maybe you want to use the demon to send drafts? Just tell the demon to
5651 execute the @code{gnus-delay-send-queue} function.
5654 @item gnus-delay-initialize
5655 @findex gnus-delay-initialize
5657 By default, this function installs @code{gnus-delay-send-queue} in
5658 @code{gnus-get-new-news-hook}. But it accepts the optional second
5659 argument @code{no-check}. If it is non-@code{nil},
5660 @code{gnus-get-new-news-hook} is not changed. The optional first
5661 argument is ignored.
5663 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5664 Presumably, you want to use the demon for sending due delayed articles.
5665 Just don't forget to set that up :-)
5669 @node Marking Articles
5670 @section Marking Articles
5671 @cindex article marking
5672 @cindex article ticking
5675 There are several marks you can set on an article.
5677 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5678 neologism ohoy!) of the article. Alphabetic marks generally mean
5679 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5681 In addition, you also have marks that do not affect readedness.
5684 There's a plethora of commands for manipulating these marks.
5688 * Unread Articles:: Marks for unread articles.
5689 * Read Articles:: Marks for read articles.
5690 * Other Marks:: Marks that do not affect readedness.
5691 * Setting Marks:: How to set and remove marks.
5692 * Generic Marking Commands:: How to customize the marking.
5693 * Setting Process Marks:: How to mark articles for later processing.
5697 @node Unread Articles
5698 @subsection Unread Articles
5700 The following marks mark articles as (kinda) unread, in one form or
5705 @vindex gnus-ticked-mark
5706 Marked as ticked (@code{gnus-ticked-mark}).
5708 @dfn{Ticked articles} are articles that will remain visible always. If
5709 you see an article that you find interesting, or you want to put off
5710 reading it, or replying to it, until sometime later, you'd typically
5711 tick it. However, articles can be expired (from news servers by the
5712 news server software, Gnus itself never expires ticked messages), so if
5713 you want to keep an article forever, you'll have to make it persistent
5714 (@pxref{Persistent Articles}).
5717 @vindex gnus-dormant-mark
5718 Marked as dormant (@code{gnus-dormant-mark}).
5720 @dfn{Dormant articles} will only appear in the summary buffer if there
5721 are followups to it. If you want to see them even if they don't have
5722 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5723 Otherwise (except for the visibility issue), they are just like ticked
5727 @vindex gnus-unread-mark
5728 Marked as unread (@code{gnus-unread-mark}).
5730 @dfn{Unread articles} are articles that haven't been read at all yet.
5735 @subsection Read Articles
5736 @cindex expirable mark
5738 All the following marks mark articles as read.
5743 @vindex gnus-del-mark
5744 These are articles that the user has marked as read with the @kbd{d}
5745 command manually, more or less (@code{gnus-del-mark}).
5748 @vindex gnus-read-mark
5749 Articles that have actually been read (@code{gnus-read-mark}).
5752 @vindex gnus-ancient-mark
5753 Articles that were marked as read in previous sessions and are now
5754 @dfn{old} (@code{gnus-ancient-mark}).
5757 @vindex gnus-killed-mark
5758 Marked as killed (@code{gnus-killed-mark}).
5761 @vindex gnus-kill-file-mark
5762 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5765 @vindex gnus-low-score-mark
5766 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5769 @vindex gnus-catchup-mark
5770 Marked as read by a catchup (@code{gnus-catchup-mark}).
5773 @vindex gnus-canceled-mark
5774 Canceled article (@code{gnus-canceled-mark})
5777 @vindex gnus-souped-mark
5778 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5781 @vindex gnus-sparse-mark
5782 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5786 @vindex gnus-duplicate-mark
5787 Article marked as read by duplicate suppression
5788 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5792 All these marks just mean that the article is marked as read, really.
5793 They are interpreted differently when doing adaptive scoring, though.
5795 One more special mark, though:
5799 @vindex gnus-expirable-mark
5800 Marked as expirable (@code{gnus-expirable-mark}).
5802 Marking articles as @dfn{expirable} (or have them marked as such
5803 automatically) doesn't make much sense in normal groups---a user doesn't
5804 control expiring of news articles, but in mail groups, for instance,
5805 articles marked as @dfn{expirable} can be deleted by gnus at
5811 @subsection Other Marks
5812 @cindex process mark
5815 There are some marks that have nothing to do with whether the article is
5821 You can set a bookmark in the current article. Say you are reading a
5822 long thesis on cats' urinary tracts, and have to go home for dinner
5823 before you've finished reading the thesis. You can then set a bookmark
5824 in the article, and gnus will jump to this bookmark the next time it
5825 encounters the article. @xref{Setting Marks}.
5828 @vindex gnus-replied-mark
5829 All articles that you have replied to or made a followup to (i.e., have
5830 answered) will be marked with an @samp{A} in the second column
5831 (@code{gnus-replied-mark}).
5834 @vindex gnus-forwarded-mark
5835 All articles that you have forwarded will be marked with an @samp{F} in
5836 the second column (@code{gnus-forwarded-mark}).
5839 @vindex gnus-cached-mark
5840 Articles stored in the article cache will be marked with an @samp{*} in
5841 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5844 @vindex gnus-saved-mark
5845 Articles ``saved'' (in some manner or other; not necessarily
5846 religiously) are marked with an @samp{S} in the second column
5847 (@code{gnus-saved-mark}).
5850 @vindex gnus-recent-mark
5851 Articles that according to the server haven't been shown to the user
5852 before are marked with a @samp{N} in the second column
5853 (@code{gnus-recent-mark}). Note that not all servers support this
5854 mark, in which case it simply never appears. Compare with
5855 @code{gnus-unseen-mark}.
5858 @vindex gnus-unseen-mark
5859 Articles that haven't been seen before in Gnus by the user are marked
5860 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5861 Compare with @code{gnus-recent-mark}.
5864 @vindex gnus-downloaded-mark
5865 When using the Gnus agent (@pxref{Agent Basics}), articles may be
5866 downloaded for unplugged (offline) viewing. If you are using the
5867 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
5868 (The variable @code{gnus-downloaded-mark} controls which character to
5872 @vindex gnus-undownloaded-mark
5873 When using the Gnus agent (@pxref{Agent Basics}), some articles might
5874 not have been downloaded. Such articles cannot be viewed while you
5875 are unplugged (offline). If you are using the @samp{%O} spec, these
5876 articles get the @samp{-} mark in that spec. (The variable
5877 @code{gnus-undownloaded-mark} controls which character to use.)
5880 @vindex gnus-downloadable-mark
5881 The Gnus agent (@pxref{Agent Basics}) downloads some articles
5882 automatically, but it is also possible to explicitly mark articles for
5883 download, even if they would not be downloaded automatically. Such
5884 explicitly-marked articles get the @samp{%} mark in the first column.
5885 (The variable @code{gnus-downloadable-mark} controls which character to
5889 @vindex gnus-not-empty-thread-mark
5890 @vindex gnus-empty-thread-mark
5891 If the @samp{%e} spec is used, the presence of threads or not will be
5892 marked with @code{gnus-not-empty-thread-mark} and
5893 @code{gnus-empty-thread-mark} in the third column, respectively.
5896 @vindex gnus-process-mark
5897 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5898 variety of commands react to the presence of the process mark. For
5899 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5900 all articles that have been marked with the process mark. Articles
5901 marked with the process mark have a @samp{#} in the second column.
5905 You might have noticed that most of these ``non-readedness'' marks
5906 appear in the second column by default. So if you have a cached, saved,
5907 replied article that you have process-marked, what will that look like?
5909 Nothing much. The precedence rules go as follows: process -> cache ->
5910 replied -> saved. So if the article is in the cache and is replied,
5911 you'll only see the cache mark and not the replied mark.
5915 @subsection Setting Marks
5916 @cindex setting marks
5918 All the marking commands understand the numeric prefix.
5923 @kindex M c (Summary)
5924 @kindex M-u (Summary)
5925 @findex gnus-summary-clear-mark-forward
5926 @cindex mark as unread
5927 Clear all readedness-marks from the current article
5928 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5934 @kindex M t (Summary)
5935 @findex gnus-summary-tick-article-forward
5936 Tick the current article (@code{gnus-summary-tick-article-forward}).
5937 @xref{Article Caching}.
5942 @kindex M ? (Summary)
5943 @findex gnus-summary-mark-as-dormant
5944 Mark the current article as dormant
5945 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5949 @kindex M d (Summary)
5951 @findex gnus-summary-mark-as-read-forward
5952 Mark the current article as read
5953 (@code{gnus-summary-mark-as-read-forward}).
5957 @findex gnus-summary-mark-as-read-backward
5958 Mark the current article as read and move point to the previous line
5959 (@code{gnus-summary-mark-as-read-backward}).
5964 @kindex M k (Summary)
5965 @findex gnus-summary-kill-same-subject-and-select
5966 Mark all articles that have the same subject as the current one as read,
5967 and then select the next unread article
5968 (@code{gnus-summary-kill-same-subject-and-select}).
5972 @kindex M K (Summary)
5973 @kindex C-k (Summary)
5974 @findex gnus-summary-kill-same-subject
5975 Mark all articles that have the same subject as the current one as read
5976 (@code{gnus-summary-kill-same-subject}).
5979 @kindex M C (Summary)
5980 @findex gnus-summary-catchup
5981 @c @icon{gnus-summary-catchup}
5982 Mark all unread articles as read (@code{gnus-summary-catchup}).
5985 @kindex M C-c (Summary)
5986 @findex gnus-summary-catchup-all
5987 Mark all articles in the group as read---even the ticked and dormant
5988 articles (@code{gnus-summary-catchup-all}).
5991 @kindex M H (Summary)
5992 @findex gnus-summary-catchup-to-here
5993 Catchup the current group to point (before the point)
5994 (@code{gnus-summary-catchup-to-here}).
5997 @kindex M h (Summary)
5998 @findex gnus-summary-catchup-from-here
5999 Catchup the current group from point (after the point)
6000 (@code{gnus-summary-catchup-from-here}).
6003 @kindex C-w (Summary)
6004 @findex gnus-summary-mark-region-as-read
6005 Mark all articles between point and mark as read
6006 (@code{gnus-summary-mark-region-as-read}).
6009 @kindex M V k (Summary)
6010 @findex gnus-summary-kill-below
6011 Kill all articles with scores below the default score (or below the
6012 numeric prefix) (@code{gnus-summary-kill-below}).
6016 @kindex M e (Summary)
6018 @findex gnus-summary-mark-as-expirable
6019 Mark the current article as expirable
6020 (@code{gnus-summary-mark-as-expirable}).
6023 @kindex M b (Summary)
6024 @findex gnus-summary-set-bookmark
6025 Set a bookmark in the current article
6026 (@code{gnus-summary-set-bookmark}).
6029 @kindex M B (Summary)
6030 @findex gnus-summary-remove-bookmark
6031 Remove the bookmark from the current article
6032 (@code{gnus-summary-remove-bookmark}).
6035 @kindex M V c (Summary)
6036 @findex gnus-summary-clear-above
6037 Clear all marks from articles with scores over the default score (or
6038 over the numeric prefix) (@code{gnus-summary-clear-above}).
6041 @kindex M V u (Summary)
6042 @findex gnus-summary-tick-above
6043 Tick all articles with scores over the default score (or over the
6044 numeric prefix) (@code{gnus-summary-tick-above}).
6047 @kindex M V m (Summary)
6048 @findex gnus-summary-mark-above
6049 Prompt for a mark, and mark all articles with scores over the default
6050 score (or over the numeric prefix) with this mark
6051 (@code{gnus-summary-clear-above}).
6054 @vindex gnus-summary-goto-unread
6055 The @code{gnus-summary-goto-unread} variable controls what action should
6056 be taken after setting a mark. If non-@code{nil}, point will move to
6057 the next/previous unread article. If @code{nil}, point will just move
6058 one line up or down. As a special case, if this variable is
6059 @code{never}, all the marking commands as well as other commands (like
6060 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6061 The default is @code{t}.
6064 @node Generic Marking Commands
6065 @subsection Generic Marking Commands
6067 Some people would like the command that ticks an article (@kbd{!}) go to
6068 the next article. Others would like it to go to the next unread
6069 article. Yet others would like it to stay on the current article. And
6070 even though I haven't heard of anybody wanting it to go to the
6071 previous (unread) article, I'm sure there are people that want that as
6074 Multiply these five behaviors with five different marking commands, and
6075 you get a potentially complex set of variable to control what each
6078 To sidestep that mess, Gnus provides commands that do all these
6079 different things. They can be found on the @kbd{M M} map in the summary
6080 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6081 to list in this manual.
6083 While you can use these commands directly, most users would prefer
6084 altering the summary mode keymap. For instance, if you would like the
6085 @kbd{!} command to go to the next article instead of the next unread
6086 article, you could say something like:
6090 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6091 (defun my-alter-summary-map ()
6092 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6100 (defun my-alter-summary-map ()
6101 (local-set-key "!" "MM!n"))
6105 @node Setting Process Marks
6106 @subsection Setting Process Marks
6107 @cindex setting process marks
6109 Process marks are displayed as @code{#} in the summary buffer, and are
6110 used for marking articles in such a way that other commands will
6111 process these articles. For instance, if you process mark four
6112 articles and then use the @kbd{*} command, Gnus will enter these four
6113 commands into the cache. For more information,
6114 @pxref{Process/Prefix}.
6121 @kindex M P p (Summary)
6122 @findex gnus-summary-mark-as-processable
6123 Mark the current article with the process mark
6124 (@code{gnus-summary-mark-as-processable}).
6125 @findex gnus-summary-unmark-as-processable
6129 @kindex M P u (Summary)
6130 @kindex M-# (Summary)
6131 Remove the process mark, if any, from the current article
6132 (@code{gnus-summary-unmark-as-processable}).
6135 @kindex M P U (Summary)
6136 @findex gnus-summary-unmark-all-processable
6137 Remove the process mark from all articles
6138 (@code{gnus-summary-unmark-all-processable}).
6141 @kindex M P i (Summary)
6142 @findex gnus-uu-invert-processable
6143 Invert the list of process marked articles
6144 (@code{gnus-uu-invert-processable}).
6147 @kindex M P R (Summary)
6148 @findex gnus-uu-mark-by-regexp
6149 Mark articles that have a @code{Subject} header that matches a regular
6150 expression (@code{gnus-uu-mark-by-regexp}).
6153 @kindex M P G (Summary)
6154 @findex gnus-uu-unmark-by-regexp
6155 Unmark articles that have a @code{Subject} header that matches a regular
6156 expression (@code{gnus-uu-unmark-by-regexp}).
6159 @kindex M P r (Summary)
6160 @findex gnus-uu-mark-region
6161 Mark articles in region (@code{gnus-uu-mark-region}).
6164 @kindex M P g (Summary)
6165 @findex gnus-uu-unmark-region
6166 Unmark articles in region (@code{gnus-uu-unmark-region}).
6169 @kindex M P t (Summary)
6170 @findex gnus-uu-mark-thread
6171 Mark all articles in the current (sub)thread
6172 (@code{gnus-uu-mark-thread}).
6175 @kindex M P T (Summary)
6176 @findex gnus-uu-unmark-thread
6177 Unmark all articles in the current (sub)thread
6178 (@code{gnus-uu-unmark-thread}).
6181 @kindex M P v (Summary)
6182 @findex gnus-uu-mark-over
6183 Mark all articles that have a score above the prefix argument
6184 (@code{gnus-uu-mark-over}).
6187 @kindex M P s (Summary)
6188 @findex gnus-uu-mark-series
6189 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6192 @kindex M P S (Summary)
6193 @findex gnus-uu-mark-sparse
6194 Mark all series that have already had some articles marked
6195 (@code{gnus-uu-mark-sparse}).
6198 @kindex M P a (Summary)
6199 @findex gnus-uu-mark-all
6200 Mark all articles in series order (@code{gnus-uu-mark-all}).
6203 @kindex M P b (Summary)
6204 @findex gnus-uu-mark-buffer
6205 Mark all articles in the buffer in the order they appear
6206 (@code{gnus-uu-mark-buffer}).
6209 @kindex M P k (Summary)
6210 @findex gnus-summary-kill-process-mark
6211 Push the current process mark set onto the stack and unmark all articles
6212 (@code{gnus-summary-kill-process-mark}).
6215 @kindex M P y (Summary)
6216 @findex gnus-summary-yank-process-mark
6217 Pop the previous process mark set from the stack and restore it
6218 (@code{gnus-summary-yank-process-mark}).
6221 @kindex M P w (Summary)
6222 @findex gnus-summary-save-process-mark
6223 Push the current process mark set onto the stack
6224 (@code{gnus-summary-save-process-mark}).
6228 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6229 set process marks based on article body contents.
6236 It can be convenient to limit the summary buffer to just show some
6237 subset of the articles currently in the group. The effect most limit
6238 commands have is to remove a few (or many) articles from the summary
6241 All limiting commands work on subsets of the articles already fetched
6242 from the servers. None of these commands query the server for
6243 additional articles.
6249 @kindex / / (Summary)
6250 @findex gnus-summary-limit-to-subject
6251 Limit the summary buffer to articles that match some subject
6252 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6256 @kindex / a (Summary)
6257 @findex gnus-summary-limit-to-author
6258 Limit the summary buffer to articles that match some author
6259 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6263 @kindex / x (Summary)
6264 @findex gnus-summary-limit-to-extra
6265 Limit the summary buffer to articles that match one of the ``extra''
6266 headers (@pxref{To From Newsgroups})
6267 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6272 @kindex / u (Summary)
6274 @findex gnus-summary-limit-to-unread
6275 Limit the summary buffer to articles not marked as read
6276 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6277 buffer to articles strictly unread. This means that ticked and
6278 dormant articles will also be excluded.
6281 @kindex / m (Summary)
6282 @findex gnus-summary-limit-to-marks
6283 Ask for a mark and then limit to all articles that have been marked
6284 with that mark (@code{gnus-summary-limit-to-marks}).
6287 @kindex / t (Summary)
6288 @findex gnus-summary-limit-to-age
6289 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6290 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6291 articles younger than that number of days.
6294 @kindex / n (Summary)
6295 @findex gnus-summary-limit-to-articles
6296 Limit the summary buffer to the current article
6297 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
6298 convention (@pxref{Process/Prefix}).
6301 @kindex / w (Summary)
6302 @findex gnus-summary-pop-limit
6303 Pop the previous limit off the stack and restore it
6304 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6308 @kindex / . (Summary)
6309 @findex gnus-summary-limit-to-unseen
6310 Limit the summary buffer to the unseen articles
6311 (@code{gnus-summary-limit-to-unseen}).
6314 @kindex / v (Summary)
6315 @findex gnus-summary-limit-to-score
6316 Limit the summary buffer to articles that have a score at or above some
6317 score (@code{gnus-summary-limit-to-score}).
6320 @kindex / p (Summary)
6321 @findex gnus-summary-limit-to-display-predicate
6322 Limit the summary buffer to articles that satisfy the @code{display}
6323 group parameter predicate
6324 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6325 Parameters}, for more on this predicate.
6328 @kindex / r (Summary)
6329 @findex gnus-summary-limit-to-replied
6330 Limit the summary buffer to replied articles
6331 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6336 @kindex M S (Summary)
6337 @kindex / E (Summary)
6338 @findex gnus-summary-limit-include-expunged
6339 Include all expunged articles in the limit
6340 (@code{gnus-summary-limit-include-expunged}).
6343 @kindex / D (Summary)
6344 @findex gnus-summary-limit-include-dormant
6345 Include all dormant articles in the limit
6346 (@code{gnus-summary-limit-include-dormant}).
6349 @kindex / * (Summary)
6350 @findex gnus-summary-limit-include-cached
6351 Include all cached articles in the limit
6352 (@code{gnus-summary-limit-include-cached}).
6355 @kindex / d (Summary)
6356 @findex gnus-summary-limit-exclude-dormant
6357 Exclude all dormant articles from the limit
6358 (@code{gnus-summary-limit-exclude-dormant}).
6361 @kindex / M (Summary)
6362 @findex gnus-summary-limit-exclude-marks
6363 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6366 @kindex / T (Summary)
6367 @findex gnus-summary-limit-include-thread
6368 Include all the articles in the current thread in the limit.
6371 @kindex / c (Summary)
6372 @findex gnus-summary-limit-exclude-childless-dormant
6373 Exclude all dormant articles that have no children from the limit@*
6374 (@code{gnus-summary-limit-exclude-childless-dormant}).
6377 @kindex / C (Summary)
6378 @findex gnus-summary-limit-mark-excluded-as-read
6379 Mark all excluded unread articles as read
6380 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6381 also mark excluded ticked and dormant articles as read.
6384 @kindex / N (Summary)
6385 @findex gnus-summary-insert-new-articles
6386 Insert all new articles in the summary buffer. It scans for new emails
6387 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6390 @kindex / o (Summary)
6391 @findex gnus-summary-insert-old-articles
6392 Insert all old articles in the summary buffer. If given a numbered
6393 prefix, fetch this number of articles.
6401 @cindex article threading
6403 Gnus threads articles by default. @dfn{To thread} is to put responses
6404 to articles directly after the articles they respond to---in a
6405 hierarchical fashion.
6407 Threading is done by looking at the @code{References} headers of the
6408 articles. In a perfect world, this would be enough to build pretty
6409 trees, but unfortunately, the @code{References} header is often broken
6410 or simply missing. Weird news propagation exacerbates the problem,
6411 so one has to employ other heuristics to get pleasing results. A
6412 plethora of approaches exists, as detailed in horrible detail in
6413 @ref{Customizing Threading}.
6415 First, a quick overview of the concepts:
6419 The top-most article in a thread; the first article in the thread.
6422 A tree-like article structure.
6425 A small(er) section of this tree-like structure.
6428 Threads often lose their roots due to article expiry, or due to the root
6429 already having been read in a previous session, and not displayed in the
6430 summary buffer. We then typically have many sub-threads that really
6431 belong to one thread, but are without connecting roots. These are
6432 called loose threads.
6434 @item thread gathering
6435 An attempt to gather loose threads into bigger threads.
6437 @item sparse threads
6438 A thread where the missing articles have been ``guessed'' at, and are
6439 displayed as empty lines in the summary buffer.
6445 * Customizing Threading:: Variables you can change to affect the threading.
6446 * Thread Commands:: Thread based commands in the summary buffer.
6450 @node Customizing Threading
6451 @subsection Customizing Threading
6452 @cindex customizing threading
6455 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6456 * Filling In Threads:: Making the threads displayed look fuller.
6457 * More Threading:: Even more variables for fiddling with threads.
6458 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6463 @subsubsection Loose Threads
6466 @cindex loose threads
6469 @item gnus-summary-make-false-root
6470 @vindex gnus-summary-make-false-root
6471 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
6472 and create a dummy root at the top. (Wait a minute. Root at the top?
6473 Yup.) Loose subtrees occur when the real root has expired, or you've
6474 read or killed the root in a previous session.
6476 When there is no real root of a thread, gnus will have to fudge
6477 something. This variable says what fudging method gnus should use.
6478 There are four possible values:
6482 \gnusfigure{The Summary Buffer}{390}{
6483 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6484 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6485 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6486 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6491 @cindex adopting articles
6496 Gnus will make the first of the orphaned articles the parent. This
6497 parent will adopt all the other articles. The adopted articles will be
6498 marked as such by pointy brackets (@samp{<>}) instead of the standard
6499 square brackets (@samp{[]}). This is the default method.
6502 @vindex gnus-summary-dummy-line-format
6503 @vindex gnus-summary-make-false-root-always
6504 Gnus will create a dummy summary line that will pretend to be the
6505 parent. This dummy line does not correspond to any real article, so
6506 selecting it will just select the first real article after the dummy
6507 article. @code{gnus-summary-dummy-line-format} is used to specify the
6508 format of the dummy roots. It accepts only one format spec: @samp{S},
6509 which is the subject of the article. @xref{Formatting Variables}.
6510 If you want all threads to have a dummy root, even the non-gathered
6511 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6514 Gnus won't actually make any article the parent, but simply leave the
6515 subject field of all orphans except the first empty. (Actually, it will
6516 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6520 Don't make any article parent at all. Just gather the threads and
6521 display them after one another.
6524 Don't gather loose threads.
6527 @item gnus-summary-gather-subject-limit
6528 @vindex gnus-summary-gather-subject-limit
6529 Loose threads are gathered by comparing subjects of articles. If this
6530 variable is @code{nil}, gnus requires an exact match between the
6531 subjects of the loose threads before gathering them into one big
6532 super-thread. This might be too strict a requirement, what with the
6533 presence of stupid newsreaders that chop off long subject lines. If
6534 you think so, set this variable to, say, 20 to require that only the
6535 first 20 characters of the subjects have to match. If you set this
6536 variable to a really low number, you'll find that gnus will gather
6537 everything in sight into one thread, which isn't very helpful.
6539 @cindex fuzzy article gathering
6540 If you set this variable to the special value @code{fuzzy}, gnus will
6541 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6544 @item gnus-simplify-subject-fuzzy-regexp
6545 @vindex gnus-simplify-subject-fuzzy-regexp
6546 This can either be a regular expression or list of regular expressions
6547 that match strings that will be removed from subjects if fuzzy subject
6548 simplification is used.
6550 @item gnus-simplify-ignored-prefixes
6551 @vindex gnus-simplify-ignored-prefixes
6552 If you set @code{gnus-summary-gather-subject-limit} to something as low
6553 as 10, you might consider setting this variable to something sensible:
6555 @c Written by Michael Ernst <mernst@cs.rice.edu>
6557 (setq gnus-simplify-ignored-prefixes
6563 "wanted" "followup" "summary\\( of\\)?"
6564 "help" "query" "problem" "question"
6565 "answer" "reference" "announce"
6566 "How can I" "How to" "Comparison of"
6571 (mapconcat 'identity
6572 '("for" "for reference" "with" "about")
6574 "\\)?\\]?:?[ \t]*"))
6577 All words that match this regexp will be removed before comparing two
6580 @item gnus-simplify-subject-functions
6581 @vindex gnus-simplify-subject-functions
6582 If non-@code{nil}, this variable overrides
6583 @code{gnus-summary-gather-subject-limit}. This variable should be a
6584 list of functions to apply to the @code{Subject} string iteratively to
6585 arrive at the simplified version of the string.
6587 Useful functions to put in this list include:
6590 @item gnus-simplify-subject-re
6591 @findex gnus-simplify-subject-re
6592 Strip the leading @samp{Re:}.
6594 @item gnus-simplify-subject-fuzzy
6595 @findex gnus-simplify-subject-fuzzy
6598 @item gnus-simplify-whitespace
6599 @findex gnus-simplify-whitespace
6600 Remove excessive whitespace.
6602 @item gnus-simplify-all-whitespace
6603 @findex gnus-simplify-all-whitespace
6604 Remove all whitespace.
6607 You may also write your own functions, of course.
6610 @item gnus-summary-gather-exclude-subject
6611 @vindex gnus-summary-gather-exclude-subject
6612 Since loose thread gathering is done on subjects only, that might lead
6613 to many false hits, especially with certain common subjects like
6614 @samp{} and @samp{(none)}. To make the situation slightly better,
6615 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6616 what subjects should be excluded from the gathering process.@*
6617 The default is @samp{^ *$\\|^(none)$}.
6619 @item gnus-summary-thread-gathering-function
6620 @vindex gnus-summary-thread-gathering-function
6621 Gnus gathers threads by looking at @code{Subject} headers. This means
6622 that totally unrelated articles may end up in the same ``thread'', which
6623 is confusing. An alternate approach is to look at all the
6624 @code{Message-ID}s in all the @code{References} headers to find matches.
6625 This will ensure that no gathered threads ever include unrelated
6626 articles, but it also means that people who have posted with broken
6627 newsreaders won't be gathered properly. The choice is yours---plague or
6631 @item gnus-gather-threads-by-subject
6632 @findex gnus-gather-threads-by-subject
6633 This function is the default gathering function and looks at
6634 @code{Subject}s exclusively.
6636 @item gnus-gather-threads-by-references
6637 @findex gnus-gather-threads-by-references
6638 This function looks at @code{References} headers exclusively.
6641 If you want to test gathering by @code{References}, you could say
6645 (setq gnus-summary-thread-gathering-function
6646 'gnus-gather-threads-by-references)
6652 @node Filling In Threads
6653 @subsubsection Filling In Threads
6656 @item gnus-fetch-old-headers
6657 @vindex gnus-fetch-old-headers
6658 If non-@code{nil}, gnus will attempt to build old threads by fetching
6659 more old headers---headers to articles marked as read. If you would
6660 like to display as few summary lines as possible, but still connect as
6661 many loose threads as possible, you should set this variable to
6662 @code{some} or a number. If you set it to a number, no more than that
6663 number of extra old headers will be fetched. In either case, fetching
6664 old headers only works if the back end you are using carries overview
6665 files---this would normally be @code{nntp}, @code{nnspool},
6666 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
6667 the thread has been expired by the server, there's not much Gnus can
6670 This variable can also be set to @code{invisible}. This won't have any
6671 visible effects, but is useful if you use the @kbd{A T} command a lot
6672 (@pxref{Finding the Parent}).
6674 @item gnus-fetch-old-ephemeral-headers
6675 @vindex gnus-fetch-old-ephemeral-headers
6676 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
6679 @item gnus-build-sparse-threads
6680 @vindex gnus-build-sparse-threads
6681 Fetching old headers can be slow. A low-rent similar effect can be
6682 gotten by setting this variable to @code{some}. Gnus will then look at
6683 the complete @code{References} headers of all articles and try to string
6684 together articles that belong in the same thread. This will leave
6685 @dfn{gaps} in the threading display where gnus guesses that an article
6686 is missing from the thread. (These gaps appear like normal summary
6687 lines. If you select a gap, gnus will try to fetch the article in
6688 question.) If this variable is @code{t}, gnus will display all these
6689 ``gaps'' without regard for whether they are useful for completing the
6690 thread or not. Finally, if this variable is @code{more}, gnus won't cut
6691 off sparse leaf nodes that don't lead anywhere. This variable is
6692 @code{nil} by default.
6694 @item gnus-read-all-available-headers
6695 @vindex gnus-read-all-available-headers
6696 This is a rather obscure variable that few will find useful. It's
6697 intended for those non-news newsgroups where the back end has to fetch
6698 quite a lot to present the summary buffer, and where it's impossible to
6699 go back to parents of articles. This is mostly the case in the
6700 web-based groups, like the @code{nnultimate} groups.
6702 If you don't use those, then it's safe to leave this as the default
6703 @code{nil}. If you want to use this variable, it should be a regexp
6704 that matches the group name, or @code{t} for all groups.
6709 @node More Threading
6710 @subsubsection More Threading
6713 @item gnus-show-threads
6714 @vindex gnus-show-threads
6715 If this variable is @code{nil}, no threading will be done, and all of
6716 the rest of the variables here will have no effect. Turning threading
6717 off will speed group selection up a bit, but it is sure to make reading
6718 slower and more awkward.
6720 @item gnus-thread-hide-subtree
6721 @vindex gnus-thread-hide-subtree
6722 If non-@code{nil}, all threads will be hidden when the summary buffer is
6725 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6726 Available predicates are @code{gnus-article-unread-p} and
6727 @code{gnus-article-unseen-p}.
6732 (setq gnus-thread-hide-subtree
6733 '(or gnus-article-unread-p
6734 gnus-article-unseen-p))
6737 (It's a pretty nonsensical example, since all unseen articles are also
6738 unread, but you get my drift.)
6741 @item gnus-thread-expunge-below
6742 @vindex gnus-thread-expunge-below
6743 All threads that have a total score (as defined by
6744 @code{gnus-thread-score-function}) less than this number will be
6745 expunged. This variable is @code{nil} by default, which means that no
6746 threads are expunged.
6748 @item gnus-thread-hide-killed
6749 @vindex gnus-thread-hide-killed
6750 if you kill a thread and this variable is non-@code{nil}, the subtree
6753 @item gnus-thread-ignore-subject
6754 @vindex gnus-thread-ignore-subject
6755 Sometimes somebody changes the subject in the middle of a thread. If
6756 this variable is non-@code{nil}, which is the default, the subject
6757 change is ignored. If it is @code{nil}, a change in the subject will
6758 result in a new thread.
6760 @item gnus-thread-indent-level
6761 @vindex gnus-thread-indent-level
6762 This is a number that says how much each sub-thread should be indented.
6765 @item gnus-sort-gathered-threads-function
6766 @vindex gnus-sort-gathered-threads-function
6767 Sometimes, particularly with mailing lists, the order in which mails
6768 arrive locally is not necessarily the same as the order in which they
6769 arrived on the mailing list. Consequently, when sorting sub-threads
6770 using the default @code{gnus-thread-sort-by-number}, responses can end
6771 up appearing before the article to which they are responding to.
6772 Setting this variable to an alternate value
6773 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6774 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6775 more logical sub-thread ordering in such instances.
6780 @node Low-Level Threading
6781 @subsubsection Low-Level Threading
6785 @item gnus-parse-headers-hook
6786 @vindex gnus-parse-headers-hook
6787 Hook run before parsing any headers. The default value is
6788 @code{(gnus-set-summary-default-charset)}, which sets up local value of
6789 @code{default-mime-charset} in summary buffer based on variable
6790 @code{gnus-newsgroup-default-charset-alist}.
6792 @item gnus-alter-header-function
6793 @vindex gnus-alter-header-function
6794 If non-@code{nil}, this function will be called to allow alteration of
6795 article header structures. The function is called with one parameter,
6796 the article header vector, which it may alter in any way. For instance,
6797 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6798 in systematic ways (by adding prefixes and such), you can use this
6799 variable to un-scramble the @code{Message-ID}s so that they are more
6800 meaningful. Here's one example:
6803 (setq gnus-alter-header-function 'my-alter-message-id)
6805 (defun my-alter-message-id (header)
6806 (let ((id (mail-header-id header)))
6808 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6810 (concat (match-string 1 id) "@@" (match-string 2 id))
6817 @node Thread Commands
6818 @subsection Thread Commands
6819 @cindex thread commands
6825 @kindex T k (Summary)
6826 @kindex C-M-k (Summary)
6827 @findex gnus-summary-kill-thread
6828 Mark all articles in the current (sub-)thread as read
6829 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
6830 remove all marks instead. If the prefix argument is negative, tick
6835 @kindex T l (Summary)
6836 @kindex C-M-l (Summary)
6837 @findex gnus-summary-lower-thread
6838 Lower the score of the current (sub-)thread
6839 (@code{gnus-summary-lower-thread}).
6842 @kindex T i (Summary)
6843 @findex gnus-summary-raise-thread
6844 Increase the score of the current (sub-)thread
6845 (@code{gnus-summary-raise-thread}).
6848 @kindex T # (Summary)
6849 @findex gnus-uu-mark-thread
6850 Set the process mark on the current (sub-)thread
6851 (@code{gnus-uu-mark-thread}).
6854 @kindex T M-# (Summary)
6855 @findex gnus-uu-unmark-thread
6856 Remove the process mark from the current (sub-)thread
6857 (@code{gnus-uu-unmark-thread}).
6860 @kindex T T (Summary)
6861 @findex gnus-summary-toggle-threads
6862 Toggle threading (@code{gnus-summary-toggle-threads}).
6865 @kindex T s (Summary)
6866 @findex gnus-summary-show-thread
6867 Expose the (sub-)thread hidden under the current article, if any@*
6868 (@code{gnus-summary-show-thread}).
6871 @kindex T h (Summary)
6872 @findex gnus-summary-hide-thread
6873 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6876 @kindex T S (Summary)
6877 @findex gnus-summary-show-all-threads
6878 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6881 @kindex T H (Summary)
6882 @findex gnus-summary-hide-all-threads
6883 Hide all threads (@code{gnus-summary-hide-all-threads}).
6886 @kindex T t (Summary)
6887 @findex gnus-summary-rethread-current
6888 Re-thread the current article's thread
6889 (@code{gnus-summary-rethread-current}). This works even when the
6890 summary buffer is otherwise unthreaded.
6893 @kindex T ^ (Summary)
6894 @findex gnus-summary-reparent-thread
6895 Make the current article the child of the marked (or previous) article
6896 (@code{gnus-summary-reparent-thread}).
6900 The following commands are thread movement commands. They all
6901 understand the numeric prefix.
6906 @kindex T n (Summary)
6908 @kindex C-M-n (Summary)
6910 @kindex M-down (Summary)
6911 @findex gnus-summary-next-thread
6912 Go to the next thread (@code{gnus-summary-next-thread}).
6915 @kindex T p (Summary)
6917 @kindex C-M-p (Summary)
6919 @kindex M-up (Summary)
6920 @findex gnus-summary-prev-thread
6921 Go to the previous thread (@code{gnus-summary-prev-thread}).
6924 @kindex T d (Summary)
6925 @findex gnus-summary-down-thread
6926 Descend the thread (@code{gnus-summary-down-thread}).
6929 @kindex T u (Summary)
6930 @findex gnus-summary-up-thread
6931 Ascend the thread (@code{gnus-summary-up-thread}).
6934 @kindex T o (Summary)
6935 @findex gnus-summary-top-thread
6936 Go to the top of the thread (@code{gnus-summary-top-thread}).
6939 @vindex gnus-thread-operation-ignore-subject
6940 If you ignore subject while threading, you'll naturally end up with
6941 threads that have several different subjects in them. If you then issue
6942 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
6943 wish to kill the entire thread, but just those parts of the thread that
6944 have the same subject as the current article. If you like this idea,
6945 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6946 is non-@code{nil} (which it is by default), subjects will be ignored
6947 when doing thread commands. If this variable is @code{nil}, articles in
6948 the same thread with different subjects will not be included in the
6949 operation in question. If this variable is @code{fuzzy}, only articles
6950 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6954 @node Sorting the Summary Buffer
6955 @section Sorting the Summary Buffer
6957 @findex gnus-thread-sort-by-total-score
6958 @findex gnus-thread-sort-by-date
6959 @findex gnus-thread-sort-by-score
6960 @findex gnus-thread-sort-by-subject
6961 @findex gnus-thread-sort-by-author
6962 @findex gnus-thread-sort-by-number
6963 @findex gnus-thread-sort-by-random
6964 @vindex gnus-thread-sort-functions
6965 @findex gnus-thread-sort-by-most-recent-number
6966 @findex gnus-thread-sort-by-most-recent-date
6967 If you are using a threaded summary display, you can sort the threads by
6968 setting @code{gnus-thread-sort-functions}, which can be either a single
6969 function, a list of functions, or a list containing functions and
6970 @code{(not some-function)} elements.
6972 By default, sorting is done on article numbers. Ready-made sorting
6973 predicate functions include @code{gnus-thread-sort-by-number},
6974 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6975 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score},
6976 @code{gnus-thread-sort-by-most-recent-number},
6977 @code{gnus-thread-sort-by-most-recent-date},
6978 @code{gnus-thread-sort-by-random} and
6979 @code{gnus-thread-sort-by-total-score}.
6981 Each function takes two threads and returns non-@code{nil} if the first
6982 thread should be sorted before the other. Note that sorting really is
6983 normally done by looking only at the roots of each thread.
6985 If you use more than one function, the primary sort key should be the
6986 last function in the list. You should probably always include
6987 @code{gnus-thread-sort-by-number} in the list of sorting
6988 functions---preferably first. This will ensure that threads that are
6989 equal with respect to the other sort criteria will be displayed in
6990 ascending article order.
6992 If you would like to sort by reverse score, then by subject, and finally
6993 by number, you could do something like:
6996 (setq gnus-thread-sort-functions
6997 '(gnus-thread-sort-by-number
6998 gnus-thread-sort-by-subject
6999 (not gnus-thread-sort-by-total-score)))
7002 The threads that have highest score will be displayed first in the
7003 summary buffer. When threads have the same score, they will be sorted
7004 alphabetically. The threads that have the same score and the same
7005 subject will be sorted by number, which is (normally) the sequence in
7006 which the articles arrived.
7008 If you want to sort by score and then reverse arrival order, you could
7012 (setq gnus-thread-sort-functions
7014 (not (gnus-thread-sort-by-number t1 t2)))
7015 gnus-thread-sort-by-score))
7018 @vindex gnus-thread-score-function
7019 The function in the @code{gnus-thread-score-function} variable (default
7020 @code{+}) is used for calculating the total score of a thread. Useful
7021 functions might be @code{max}, @code{min}, or squared means, or whatever
7024 @findex gnus-article-sort-functions
7025 @findex gnus-article-sort-by-date
7026 @findex gnus-article-sort-by-score
7027 @findex gnus-article-sort-by-subject
7028 @findex gnus-article-sort-by-author
7029 @findex gnus-article-sort-by-random
7030 @findex gnus-article-sort-by-number
7031 If you are using an unthreaded display for some strange reason or
7032 other, you have to fiddle with the @code{gnus-article-sort-functions}
7033 variable. It is very similar to the
7034 @code{gnus-thread-sort-functions}, except that it uses slightly
7035 different functions for article comparison. Available sorting
7036 predicate functions are @code{gnus-article-sort-by-number},
7037 @code{gnus-article-sort-by-author},
7038 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7039 @code{gnus-article-sort-by-random}, and
7040 @code{gnus-article-sort-by-score}.
7042 If you want to sort an unthreaded summary display by subject, you could
7046 (setq gnus-article-sort-functions
7047 '(gnus-article-sort-by-number
7048 gnus-article-sort-by-subject))
7053 @node Asynchronous Fetching
7054 @section Asynchronous Article Fetching
7055 @cindex asynchronous article fetching
7056 @cindex article pre-fetch
7059 If you read your news from an @acronym{NNTP} server that's far away, the
7060 network latencies may make reading articles a chore. You have to wait
7061 for a while after pressing @kbd{n} to go to the next article before the
7062 article appears. Why can't gnus just go ahead and fetch the article
7063 while you are reading the previous one? Why not, indeed.
7065 First, some caveats. There are some pitfalls to using asynchronous
7066 article fetching, especially the way gnus does it.
7068 Let's say you are reading article 1, which is short, and article 2 is
7069 quite long, and you are not interested in reading that. Gnus does not
7070 know this, so it goes ahead and fetches article 2. You decide to read
7071 article 3, but since gnus is in the process of fetching article 2, the
7072 connection is blocked.
7074 To avoid these situations, gnus will open two (count 'em two)
7075 connections to the server. Some people may think this isn't a very nice
7076 thing to do, but I don't see any real alternatives. Setting up that
7077 extra connection takes some time, so gnus startup will be slower.
7079 Gnus will fetch more articles than you will read. This will mean that
7080 the link between your machine and the @acronym{NNTP} server will become more
7081 loaded than if you didn't use article pre-fetch. The server itself will
7082 also become more loaded---both with the extra article requests, and the
7085 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7088 @vindex gnus-asynchronous
7089 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7090 happen automatically.
7092 @vindex gnus-use-article-prefetch
7093 You can control how many articles are to be pre-fetched by setting
7094 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7095 that when you read an article in the group, the back end will pre-fetch
7096 the next 30 articles. If this variable is @code{t}, the back end will
7097 pre-fetch all the articles it can without bound. If it is
7098 @code{nil}, no pre-fetching will be done.
7100 @vindex gnus-async-prefetch-article-p
7101 @findex gnus-async-read-p
7102 There are probably some articles that you don't want to pre-fetch---read
7103 articles, for instance. The @code{gnus-async-prefetch-article-p}
7104 variable controls whether an article is to be pre-fetched. This
7105 function should return non-@code{nil} when the article in question is
7106 to be pre-fetched. The default is @code{gnus-async-read-p}, which
7107 returns @code{nil} on read articles. The function is called with an
7108 article data structure as the only parameter.
7110 If, for instance, you wish to pre-fetch only unread articles shorter
7111 than 100 lines, you could say something like:
7114 (defun my-async-short-unread-p (data)
7115 "Return non-nil for short, unread articles."
7116 (and (gnus-data-unread-p data)
7117 (< (mail-header-lines (gnus-data-header data))
7120 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7123 These functions will be called many, many times, so they should
7124 preferably be short and sweet to avoid slowing down gnus too much.
7125 It's probably a good idea to byte-compile things like this.
7127 @vindex gnus-prefetched-article-deletion-strategy
7128 Articles have to be removed from the asynch buffer sooner or later. The
7129 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7130 articles. This is a list that may contain the following elements:
7134 Remove articles when they are read.
7137 Remove articles when exiting the group.
7140 The default value is @code{(read exit)}.
7142 @c @vindex gnus-use-header-prefetch
7143 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7144 @c from the next group.
7147 @node Article Caching
7148 @section Article Caching
7149 @cindex article caching
7152 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7153 consider turning article caching on. Each article will then be stored
7154 locally under your home directory. As you may surmise, this could
7155 potentially use @emph{huge} amounts of disk space, as well as eat up all
7156 your inodes so fast it will make your head swim. In vodka.
7158 Used carefully, though, it could be just an easier way to save articles.
7160 @vindex gnus-use-long-file-name
7161 @vindex gnus-cache-directory
7162 @vindex gnus-use-cache
7163 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7164 all articles ticked or marked as dormant will then be copied
7165 over to your local cache (@code{gnus-cache-directory}). Whether this
7166 cache is flat or hierarchical is controlled by the
7167 @code{gnus-use-long-file-name} variable, as usual.
7169 When re-selecting a ticked or dormant article, it will be fetched from the
7170 cache instead of from the server. As articles in your cache will never
7171 expire, this might serve as a method of saving articles while still
7172 keeping them where they belong. Just mark all articles you want to save
7173 as dormant, and don't worry.
7175 When an article is marked as read, is it removed from the cache.
7177 @vindex gnus-cache-remove-articles
7178 @vindex gnus-cache-enter-articles
7179 The entering/removal of articles from the cache is controlled by the
7180 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7181 variables. Both are lists of symbols. The first is @code{(ticked
7182 dormant)} by default, meaning that ticked and dormant articles will be
7183 put in the cache. The latter is @code{(read)} by default, meaning that
7184 articles marked as read are removed from the cache. Possibly
7185 symbols in these two lists are @code{ticked}, @code{dormant},
7186 @code{unread} and @code{read}.
7188 @findex gnus-jog-cache
7189 So where does the massive article-fetching and storing come into the
7190 picture? The @code{gnus-jog-cache} command will go through all
7191 subscribed newsgroups, request all unread articles, score them, and
7192 store them in the cache. You should only ever, ever ever ever, use this
7193 command if 1) your connection to the @acronym{NNTP} server is really, really,
7194 really slow and 2) you have a really, really, really huge disk.
7195 Seriously. One way to cut down on the number of articles downloaded is
7196 to score unwanted articles down and have them marked as read. They will
7197 not then be downloaded by this command.
7199 @vindex gnus-uncacheable-groups
7200 @vindex gnus-cacheable-groups
7201 It is likely that you do not want caching on all groups. For instance,
7202 if your @code{nnml} mail is located under your home directory, it makes no
7203 sense to cache it somewhere else under your home directory. Unless you
7204 feel that it's neat to use twice as much space.
7206 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7207 regexp of groups to cache, @samp{^nntp} for instance, or set the
7208 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7209 Both variables are @code{nil} by default. If a group matches both
7210 variables, the group is not cached.
7212 @findex gnus-cache-generate-nov-databases
7213 @findex gnus-cache-generate-active
7214 @vindex gnus-cache-active-file
7215 The cache stores information on what articles it contains in its active
7216 file (@code{gnus-cache-active-file}). If this file (or any other parts
7217 of the cache) becomes all messed up for some reason or other, gnus
7218 offers two functions that will try to set things right. @kbd{M-x
7219 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7220 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7223 @findex gnus-cache-move-cache
7224 @code{gnus-cache-move-cache} will move your whole
7225 @code{gnus-cache-directory} to some other location. You get asked to
7226 where, isn't that cool?
7228 @node Persistent Articles
7229 @section Persistent Articles
7230 @cindex persistent articles
7232 Closely related to article caching, we have @dfn{persistent articles}.
7233 In fact, it's just a different way of looking at caching, and much more
7234 useful in my opinion.
7236 Say you're reading a newsgroup, and you happen on to some valuable gem
7237 that you want to keep and treasure forever. You'd normally just save it
7238 (using one of the many saving commands) in some file. The problem with
7239 that is that it's just, well, yucky. Ideally you'd prefer just having
7240 the article remain in the group where you found it forever; untouched by
7241 the expiry going on at the news server.
7243 This is what a @dfn{persistent article} is---an article that just won't
7244 be deleted. It's implemented using the normal cache functions, but
7245 you use two explicit commands for managing persistent articles:
7251 @findex gnus-cache-enter-article
7252 Make the current article persistent (@code{gnus-cache-enter-article}).
7255 @kindex M-* (Summary)
7256 @findex gnus-cache-remove-article
7257 Remove the current article from the persistent articles
7258 (@code{gnus-cache-remove-article}). This will normally delete the
7262 Both these commands understand the process/prefix convention.
7264 To avoid having all ticked articles (and stuff) entered into the cache,
7265 you should set @code{gnus-use-cache} to @code{passive} if you're just
7266 interested in persistent articles:
7269 (setq gnus-use-cache 'passive)
7273 @node Article Backlog
7274 @section Article Backlog
7276 @cindex article backlog
7278 If you have a slow connection, but the idea of using caching seems
7279 unappealing to you (and it is, really), you can help the situation some
7280 by switching on the @dfn{backlog}. This is where gnus will buffer
7281 already read articles so that it doesn't have to re-fetch articles
7282 you've already read. This only helps if you are in the habit of
7283 re-selecting articles you've recently read, of course. If you never do
7284 that, turning the backlog on will slow gnus down a little bit, and
7285 increase memory usage some.
7287 @vindex gnus-keep-backlog
7288 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
7289 at most @var{n} old articles in a buffer for later re-fetching. If this
7290 variable is non-@code{nil} and is not a number, gnus will store
7291 @emph{all} read articles, which means that your Emacs will grow without
7292 bound before exploding and taking your machine down with you. I put
7293 that in there just to keep y'all on your toes.
7295 The default value is 20.
7298 @node Saving Articles
7299 @section Saving Articles
7300 @cindex saving articles
7302 Gnus can save articles in a number of ways. Below is the documentation
7303 for saving articles in a fairly straight-forward fashion (i.e., little
7304 processing of the article is done before it is saved). For a different
7305 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7306 (@pxref{Decoding Articles}).
7308 For the commands listed here, the target is a file. If you want to
7309 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7310 command (@pxref{Mail Group Commands}).
7312 @vindex gnus-save-all-headers
7313 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
7314 unwanted headers before saving the article.
7316 @vindex gnus-saved-headers
7317 If the preceding variable is @code{nil}, all headers that match the
7318 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7319 deleted before saving.
7325 @kindex O o (Summary)
7327 @findex gnus-summary-save-article
7328 @c @icon{gnus-summary-save-article}
7329 Save the current article using the default article saver
7330 (@code{gnus-summary-save-article}).
7333 @kindex O m (Summary)
7334 @findex gnus-summary-save-article-mail
7335 Save the current article in mail format
7336 (@code{gnus-summary-save-article-mail}).
7339 @kindex O r (Summary)
7340 @findex gnus-summary-save-article-rmail
7341 Save the current article in Rmail format
7342 (@code{gnus-summary-save-article-rmail}).
7345 @kindex O f (Summary)
7346 @findex gnus-summary-save-article-file
7347 @c @icon{gnus-summary-save-article-file}
7348 Save the current article in plain file format
7349 (@code{gnus-summary-save-article-file}).
7352 @kindex O F (Summary)
7353 @findex gnus-summary-write-article-file
7354 Write the current article in plain file format, overwriting any previous
7355 file contents (@code{gnus-summary-write-article-file}).
7358 @kindex O b (Summary)
7359 @findex gnus-summary-save-article-body-file
7360 Save the current article body in plain file format
7361 (@code{gnus-summary-save-article-body-file}).
7364 @kindex O h (Summary)
7365 @findex gnus-summary-save-article-folder
7366 Save the current article in mh folder format
7367 (@code{gnus-summary-save-article-folder}).
7370 @kindex O v (Summary)
7371 @findex gnus-summary-save-article-vm
7372 Save the current article in a VM folder
7373 (@code{gnus-summary-save-article-vm}).
7377 @kindex O p (Summary)
7379 @findex gnus-summary-pipe-output
7380 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7381 the current article to a process (@code{gnus-summary-pipe-output}).
7382 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7383 complete headers in the piped output.
7386 @kindex O P (Summary)
7387 @findex gnus-summary-muttprint
7388 @vindex gnus-summary-muttprint-program
7389 Save the current article into muttprint. That is, print it using the
7390 external program @uref{http://muttprint.sourceforge.net/,
7391 Muttprint}. The program name and options to use is controlled by the
7392 variable @code{gnus-summary-muttprint-program}.
7393 (@code{gnus-summary-muttprint}).
7397 @vindex gnus-prompt-before-saving
7398 All these commands use the process/prefix convention
7399 (@pxref{Process/Prefix}). If you save bunches of articles using these
7400 functions, you might get tired of being prompted for files to save each
7401 and every article in. The prompting action is controlled by
7402 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7403 default, giving you that excessive prompting action you know and
7404 loathe. If you set this variable to @code{t} instead, you'll be prompted
7405 just once for each series of articles you save. If you like to really
7406 have Gnus do all your thinking for you, you can even set this variable
7407 to @code{nil}, which means that you will never be prompted for files to
7408 save articles in. Gnus will simply save all the articles in the default
7412 @vindex gnus-default-article-saver
7413 You can customize the @code{gnus-default-article-saver} variable to make
7414 gnus do what you want it to. You can use any of the six ready-made
7415 functions below, or you can create your own.
7419 @item gnus-summary-save-in-rmail
7420 @findex gnus-summary-save-in-rmail
7421 @vindex gnus-rmail-save-name
7422 @findex gnus-plain-save-name
7423 This is the default format, @dfn{Babyl}. Uses the function in the
7424 @code{gnus-rmail-save-name} variable to get a file name to save the
7425 article in. The default is @code{gnus-plain-save-name}.
7427 @item gnus-summary-save-in-mail
7428 @findex gnus-summary-save-in-mail
7429 @vindex gnus-mail-save-name
7430 Save in a Unix mail (mbox) file. Uses the function in the
7431 @code{gnus-mail-save-name} variable to get a file name to save the
7432 article in. The default is @code{gnus-plain-save-name}.
7434 @item gnus-summary-save-in-file
7435 @findex gnus-summary-save-in-file
7436 @vindex gnus-file-save-name
7437 @findex gnus-numeric-save-name
7438 Append the article straight to an ordinary file. Uses the function in
7439 the @code{gnus-file-save-name} variable to get a file name to save the
7440 article in. The default is @code{gnus-numeric-save-name}.
7442 @item gnus-summary-write-to-file
7443 @findex gnus-summary-write-to-file
7444 Write the article straight to an ordinary file. The file is
7445 overwritten if it exists. Uses the function in the
7446 @code{gnus-file-save-name} variable to get a file name to save the
7447 article in. The default is @code{gnus-numeric-save-name}.
7449 @item gnus-summary-save-body-in-file
7450 @findex gnus-summary-save-body-in-file
7451 Append the article body to an ordinary file. 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-in-folder
7456 @findex gnus-summary-save-in-folder
7457 @findex gnus-folder-save-name
7458 @findex gnus-Folder-save-name
7459 @vindex gnus-folder-save-name
7462 Save the article to an MH folder using @code{rcvstore} from the MH
7463 library. Uses the function in the @code{gnus-folder-save-name} variable
7464 to get a file name to save the article in. The default is
7465 @code{gnus-folder-save-name}, but you can also use
7466 @code{gnus-Folder-save-name}, which creates capitalized names.
7468 @item gnus-summary-save-in-vm
7469 @findex gnus-summary-save-in-vm
7470 Save the article in a VM folder. You have to have the VM mail
7471 reader to use this setting.
7474 @vindex gnus-article-save-directory
7475 All of these functions, except for the last one, will save the article
7476 in the @code{gnus-article-save-directory}, which is initialized from the
7477 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7480 As you can see above, the functions use different functions to find a
7481 suitable name of a file to save the article in. Below is a list of
7482 available functions that generate names:
7486 @item gnus-Numeric-save-name
7487 @findex gnus-Numeric-save-name
7488 File names like @file{~/News/Alt.andrea-dworkin/45}.
7490 @item gnus-numeric-save-name
7491 @findex gnus-numeric-save-name
7492 File names like @file{~/News/alt.andrea-dworkin/45}.
7494 @item gnus-Plain-save-name
7495 @findex gnus-Plain-save-name
7496 File names like @file{~/News/Alt.andrea-dworkin}.
7498 @item gnus-plain-save-name
7499 @findex gnus-plain-save-name
7500 File names like @file{~/News/alt.andrea-dworkin}.
7502 @item gnus-sender-save-name
7503 @findex gnus-sender-save-name
7504 File names like @file{~/News/larsi}.
7507 @vindex gnus-split-methods
7508 You can have gnus suggest where to save articles by plonking a regexp into
7509 the @code{gnus-split-methods} alist. For instance, if you would like to
7510 save articles related to gnus in the file @file{gnus-stuff}, and articles
7511 related to VM in @file{vm-stuff}, you could set this variable to something
7515 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7516 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7517 (my-choosing-function "../other-dir/my-stuff")
7518 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7521 We see that this is a list where each element is a list that has two
7522 elements---the @dfn{match} and the @dfn{file}. The match can either be
7523 a string (in which case it is used as a regexp to match on the article
7524 head); it can be a symbol (which will be called as a function with the
7525 group name as a parameter); or it can be a list (which will be
7526 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7527 the @dfn{file} will be used as a default prompt. In addition, the
7528 result of the operation itself will be used if the function or form
7529 called returns a string or a list of strings.
7531 You basically end up with a list of file names that might be used when
7532 saving the current article. (All ``matches'' will be used.) You will
7533 then be prompted for what you really want to use as a name, with file
7534 name completion over the results from applying this variable.
7536 This variable is @code{((gnus-article-archive-name))} by default, which
7537 means that gnus will look at the articles it saves for an
7538 @code{Archive-name} line and use that as a suggestion for the file
7541 Here's an example function to clean up file names somewhat. If you have
7542 lots of mail groups called things like
7543 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7544 these group names before creating the file name to save to. The
7545 following will do just that:
7548 (defun my-save-name (group)
7549 (when (string-match "^nnml:mail." group)
7550 (substring group (match-end 0))))
7552 (setq gnus-split-methods
7553 '((gnus-article-archive-name)
7558 @vindex gnus-use-long-file-name
7559 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7560 @code{nil}, all the preceding functions will replace all periods
7561 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7562 the functions will generate hierarchies of directories instead of having
7563 all the files in the top level directory
7564 (@file{~/News/alt/andrea-dworkin} instead of
7565 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7566 on most systems. However, for historical reasons, this is @code{nil} on
7567 Xenix and usg-unix-v machines by default.
7569 This function also affects kill and score file names. If this variable
7570 is a list, and the list contains the element @code{not-score}, long file
7571 names will not be used for score files, if it contains the element
7572 @code{not-save}, long file names will not be used for saving, and if it
7573 contains the element @code{not-kill}, long file names will not be used
7576 If you'd like to save articles in a hierarchy that looks something like
7580 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
7581 (setq gnus-default-article-saver
7582 'gnus-summary-save-in-file) ; @r{no encoding}
7585 Then just save with @kbd{o}. You'd then read this hierarchy with
7586 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7587 the top level directory as the argument (@file{~/News/}). Then just walk
7588 around to the groups/directories with @code{nneething}.
7591 @node Decoding Articles
7592 @section Decoding Articles
7593 @cindex decoding articles
7595 Sometime users post articles (or series of articles) that have been
7596 encoded in some way or other. Gnus can decode them for you.
7599 * Uuencoded Articles:: Uudecode articles.
7600 * Shell Archives:: Unshar articles.
7601 * PostScript Files:: Split PostScript.
7602 * Other Files:: Plain save and binhex.
7603 * Decoding Variables:: Variables for a happy decoding.
7604 * Viewing Files:: You want to look at the result of the decoding?
7608 @cindex article series
7609 All these functions use the process/prefix convention
7610 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7611 the extension that a ``single article'' means ``a single series''. Gnus
7612 can find out by itself what articles belong to a series, decode all the
7613 articles and unpack/view/save the resulting file(s).
7615 Gnus guesses what articles are in the series according to the following
7616 simplish rule: The subjects must be (nearly) identical, except for the
7617 last two numbers of the line. (Spaces are largely ignored, however.)
7619 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
7620 will find all the articles that match the regexp @samp{^cat.gif
7621 ([0-9]+/[0-9]+).*$}.
7623 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7624 series}, will not be properly recognized by any of the automatic viewing
7625 commands, and you have to mark the articles manually with @kbd{#}.
7628 @node Uuencoded Articles
7629 @subsection Uuencoded Articles
7631 @cindex uuencoded articles
7636 @kindex X u (Summary)
7637 @findex gnus-uu-decode-uu
7638 @c @icon{gnus-uu-decode-uu}
7639 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7642 @kindex X U (Summary)
7643 @findex gnus-uu-decode-uu-and-save
7644 Uudecodes and saves the current series
7645 (@code{gnus-uu-decode-uu-and-save}).
7648 @kindex X v u (Summary)
7649 @findex gnus-uu-decode-uu-view
7650 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7653 @kindex X v U (Summary)
7654 @findex gnus-uu-decode-uu-and-save-view
7655 Uudecodes, views and saves the current series
7656 (@code{gnus-uu-decode-uu-and-save-view}).
7660 Remember that these all react to the presence of articles marked with
7661 the process mark. If, for instance, you'd like to decode and save an
7662 entire newsgroup, you'd typically do @kbd{M P a}
7663 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7664 (@code{gnus-uu-decode-uu-and-save}).
7666 All this is very much different from how @code{gnus-uu} worked with
7667 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7668 the sun. This version of @code{gnus-uu} generally assumes that you mark
7669 articles in some way (@pxref{Setting Process Marks}) and then press
7672 @vindex gnus-uu-notify-files
7673 Note: When trying to decode articles that have names matching
7674 @code{gnus-uu-notify-files}, which is hard-coded to
7675 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7676 automatically post an article on @samp{comp.unix.wizards} saying that
7677 you have just viewed the file in question. This feature can't be turned
7681 @node Shell Archives
7682 @subsection Shell Archives
7684 @cindex shell archives
7685 @cindex shared articles
7687 Shell archives (``shar files'') used to be a popular way to distribute
7688 sources, but it isn't used all that much today. In any case, we have
7689 some commands to deal with these:
7694 @kindex X s (Summary)
7695 @findex gnus-uu-decode-unshar
7696 Unshars the current series (@code{gnus-uu-decode-unshar}).
7699 @kindex X S (Summary)
7700 @findex gnus-uu-decode-unshar-and-save
7701 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7704 @kindex X v s (Summary)
7705 @findex gnus-uu-decode-unshar-view
7706 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7709 @kindex X v S (Summary)
7710 @findex gnus-uu-decode-unshar-and-save-view
7711 Unshars, views and saves the current series
7712 (@code{gnus-uu-decode-unshar-and-save-view}).
7716 @node PostScript Files
7717 @subsection PostScript Files
7723 @kindex X p (Summary)
7724 @findex gnus-uu-decode-postscript
7725 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7728 @kindex X P (Summary)
7729 @findex gnus-uu-decode-postscript-and-save
7730 Unpack and save the current PostScript series
7731 (@code{gnus-uu-decode-postscript-and-save}).
7734 @kindex X v p (Summary)
7735 @findex gnus-uu-decode-postscript-view
7736 View the current PostScript series
7737 (@code{gnus-uu-decode-postscript-view}).
7740 @kindex X v P (Summary)
7741 @findex gnus-uu-decode-postscript-and-save-view
7742 View and save the current PostScript series
7743 (@code{gnus-uu-decode-postscript-and-save-view}).
7748 @subsection Other Files
7752 @kindex X o (Summary)
7753 @findex gnus-uu-decode-save
7754 Save the current series
7755 (@code{gnus-uu-decode-save}).
7758 @kindex X b (Summary)
7759 @findex gnus-uu-decode-binhex
7760 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7761 doesn't really work yet.
7765 @node Decoding Variables
7766 @subsection Decoding Variables
7768 Adjective, not verb.
7771 * Rule Variables:: Variables that say how a file is to be viewed.
7772 * Other Decode Variables:: Other decode variables.
7773 * Uuencoding and Posting:: Variables for customizing uuencoding.
7777 @node Rule Variables
7778 @subsubsection Rule Variables
7779 @cindex rule variables
7781 Gnus uses @dfn{rule variables} to decide how to view a file. All these
7782 variables are of the form
7785 (list '(regexp1 command2)
7792 @item gnus-uu-user-view-rules
7793 @vindex gnus-uu-user-view-rules
7795 This variable is consulted first when viewing files. If you wish to use,
7796 for instance, @code{sox} to convert an @file{.au} sound file, you could
7799 (setq gnus-uu-user-view-rules
7800 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7803 @item gnus-uu-user-view-rules-end
7804 @vindex gnus-uu-user-view-rules-end
7805 This variable is consulted if gnus couldn't make any matches from the
7806 user and default view rules.
7808 @item gnus-uu-user-archive-rules
7809 @vindex gnus-uu-user-archive-rules
7810 This variable can be used to say what commands should be used to unpack
7815 @node Other Decode Variables
7816 @subsubsection Other Decode Variables
7819 @vindex gnus-uu-grabbed-file-functions
7821 @item gnus-uu-grabbed-file-functions
7822 All functions in this list will be called right after each file has been
7823 successfully decoded---so that you can move or view files right away,
7824 and don't have to wait for all files to be decoded before you can do
7825 anything. Ready-made functions you can put in this list are:
7829 @item gnus-uu-grab-view
7830 @findex gnus-uu-grab-view
7833 @item gnus-uu-grab-move
7834 @findex gnus-uu-grab-move
7835 Move the file (if you're using a saving function.)
7838 @item gnus-uu-be-dangerous
7839 @vindex gnus-uu-be-dangerous
7840 Specifies what to do if unusual situations arise during decoding. If
7841 @code{nil}, be as conservative as possible. If @code{t}, ignore things
7842 that didn't work, and overwrite existing files. Otherwise, ask each
7845 @item gnus-uu-ignore-files-by-name
7846 @vindex gnus-uu-ignore-files-by-name
7847 Files with name matching this regular expression won't be viewed.
7849 @item gnus-uu-ignore-files-by-type
7850 @vindex gnus-uu-ignore-files-by-type
7851 Files with a @acronym{MIME} type matching this variable won't be viewed.
7852 Note that Gnus tries to guess what type the file is based on the name.
7853 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
7856 @item gnus-uu-tmp-dir
7857 @vindex gnus-uu-tmp-dir
7858 Where @code{gnus-uu} does its work.
7860 @item gnus-uu-do-not-unpack-archives
7861 @vindex gnus-uu-do-not-unpack-archives
7862 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7863 looking for files to display.
7865 @item gnus-uu-view-and-save
7866 @vindex gnus-uu-view-and-save
7867 Non-@code{nil} means that the user will always be asked to save a file
7870 @item gnus-uu-ignore-default-view-rules
7871 @vindex gnus-uu-ignore-default-view-rules
7872 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7875 @item gnus-uu-ignore-default-archive-rules
7876 @vindex gnus-uu-ignore-default-archive-rules
7877 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7880 @item gnus-uu-kill-carriage-return
7881 @vindex gnus-uu-kill-carriage-return
7882 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7885 @item gnus-uu-unmark-articles-not-decoded
7886 @vindex gnus-uu-unmark-articles-not-decoded
7887 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7888 decoded articles as unread.
7890 @item gnus-uu-correct-stripped-uucode
7891 @vindex gnus-uu-correct-stripped-uucode
7892 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7893 uuencoded files that have had trailing spaces deleted.
7895 @item gnus-uu-pre-uudecode-hook
7896 @vindex gnus-uu-pre-uudecode-hook
7897 Hook run before sending a message to @code{uudecode}.
7899 @item gnus-uu-view-with-metamail
7900 @vindex gnus-uu-view-with-metamail
7902 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7903 commands defined by the rule variables and just fudge a @acronym{MIME}
7904 content type based on the file name. The result will be fed to
7905 @code{metamail} for viewing.
7907 @item gnus-uu-save-in-digest
7908 @vindex gnus-uu-save-in-digest
7909 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7910 decoding, will save in digests. If this variable is @code{nil},
7911 @code{gnus-uu} will just save everything in a file without any
7912 embellishments. The digesting almost conforms to RFC 1153---no easy way
7913 to specify any meaningful volume and issue numbers were found, so I
7914 simply dropped them.
7919 @node Uuencoding and Posting
7920 @subsubsection Uuencoding and Posting
7924 @item gnus-uu-post-include-before-composing
7925 @vindex gnus-uu-post-include-before-composing
7926 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7927 before you compose the article. If this variable is @code{t}, you can
7928 either include an encoded file with @kbd{C-c C-i} or have one included
7929 for you when you post the article.
7931 @item gnus-uu-post-length
7932 @vindex gnus-uu-post-length
7933 Maximum length of an article. The encoded file will be split into how
7934 many articles it takes to post the entire file.
7936 @item gnus-uu-post-threaded
7937 @vindex gnus-uu-post-threaded
7938 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7939 thread. This may not be smart, as no other decoder I have seen is able
7940 to follow threads when collecting uuencoded articles. (Well, I have
7941 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7942 think that counts@dots{}) Default is @code{nil}.
7944 @item gnus-uu-post-separate-description
7945 @vindex gnus-uu-post-separate-description
7946 Non-@code{nil} means that the description will be posted in a separate
7947 article. The first article will typically be numbered (0/x). If this
7948 variable is @code{nil}, the description the user enters will be included
7949 at the beginning of the first article, which will be numbered (1/x).
7950 Default is @code{t}.
7956 @subsection Viewing Files
7957 @cindex viewing files
7958 @cindex pseudo-articles
7960 After decoding, if the file is some sort of archive, gnus will attempt
7961 to unpack the archive and see if any of the files in the archive can be
7962 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
7963 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
7964 uncompress and de-tar the main file, and then view the two pictures.
7965 This unpacking process is recursive, so if the archive contains archives
7966 of archives, it'll all be unpacked.
7968 Finally, gnus will normally insert a @dfn{pseudo-article} for each
7969 extracted file into the summary buffer. If you go to these
7970 ``articles'', you will be prompted for a command to run (usually Gnus
7971 will make a suggestion), and then the command will be run.
7973 @vindex gnus-view-pseudo-asynchronously
7974 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7975 until the viewing is done before proceeding.
7977 @vindex gnus-view-pseudos
7978 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7979 the pseudo-articles into the summary buffer, but view them
7980 immediately. If this variable is @code{not-confirm}, the user won't even
7981 be asked for a confirmation before viewing is done.
7983 @vindex gnus-view-pseudos-separately
7984 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7985 pseudo-article will be created for each file to be viewed. If
7986 @code{nil}, all files that use the same viewing command will be given as
7987 a list of parameters to that command.
7989 @vindex gnus-insert-pseudo-articles
7990 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7991 pseudo-articles when decoding. It is @code{t} by default.
7993 So; there you are, reading your @emph{pseudo-articles} in your
7994 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
7995 Why isn't anything real anymore? How did we get here?
7998 @node Article Treatment
7999 @section Article Treatment
8001 Reading through this huge manual, you may have quite forgotten that the
8002 object of newsreaders is to actually, like, read what people have
8003 written. Reading articles. Unfortunately, people are quite bad at
8004 writing, so there are tons of functions and variables to make reading
8005 these articles easier.
8008 * Article Highlighting:: You want to make the article look like fruit salad.
8009 * Article Fontisizing:: Making emphasized text look nice.
8010 * Article Hiding:: You also want to make certain info go away.
8011 * Article Washing:: Lots of way-neat functions to make life better.
8012 * Article Header:: Doing various header transformations.
8013 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8014 * Article Button Levels:: Controlling appearance of buttons.
8015 * Article Date:: Grumble, UT!
8016 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8017 * Article Signature:: What is a signature?
8018 * Article Miscellanea:: Various other stuff.
8022 @node Article Highlighting
8023 @subsection Article Highlighting
8024 @cindex highlighting
8026 Not only do you want your article buffer to look like fruit salad, but
8027 you want it to look like technicolor fruit salad.
8032 @kindex W H a (Summary)
8033 @findex gnus-article-highlight
8034 @findex gnus-article-maybe-highlight
8035 Do much highlighting of the current article
8036 (@code{gnus-article-highlight}). This function highlights header, cited
8037 text, the signature, and adds buttons to the body and the head.
8040 @kindex W H h (Summary)
8041 @findex gnus-article-highlight-headers
8042 @vindex gnus-header-face-alist
8043 Highlight the headers (@code{gnus-article-highlight-headers}). The
8044 highlighting will be done according to the @code{gnus-header-face-alist}
8045 variable, which is a list where each element has the form
8046 @code{(@var{regexp} @var{name} @var{content})}.
8047 @var{regexp} is a regular expression for matching the
8048 header, @var{name} is the face used for highlighting the header name
8049 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8050 the header value. The first match made will be used. Note that
8051 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8054 @kindex W H c (Summary)
8055 @findex gnus-article-highlight-citation
8056 Highlight cited text (@code{gnus-article-highlight-citation}).
8058 Some variables to customize the citation highlights:
8061 @vindex gnus-cite-parse-max-size
8063 @item gnus-cite-parse-max-size
8064 If the article size if bigger than this variable (which is 25000 by
8065 default), no citation highlighting will be performed.
8067 @item gnus-cite-max-prefix
8068 @vindex gnus-cite-max-prefix
8069 Maximum possible length for a citation prefix (default 20).
8071 @item gnus-cite-face-list
8072 @vindex gnus-cite-face-list
8073 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8074 When there are citations from multiple articles in the same message,
8075 gnus will try to give each citation from each article its own face.
8076 This should make it easier to see who wrote what.
8078 @item gnus-supercite-regexp
8079 @vindex gnus-supercite-regexp
8080 Regexp matching normal Supercite attribution lines.
8082 @item gnus-supercite-secondary-regexp
8083 @vindex gnus-supercite-secondary-regexp
8084 Regexp matching mangled Supercite attribution lines.
8086 @item gnus-cite-minimum-match-count
8087 @vindex gnus-cite-minimum-match-count
8088 Minimum number of identical prefixes we have to see before we believe
8089 that it's a citation.
8091 @item gnus-cite-attribution-prefix
8092 @vindex gnus-cite-attribution-prefix
8093 Regexp matching the beginning of an attribution line.
8095 @item gnus-cite-attribution-suffix
8096 @vindex gnus-cite-attribution-suffix
8097 Regexp matching the end of an attribution line.
8099 @item gnus-cite-attribution-face
8100 @vindex gnus-cite-attribution-face
8101 Face used for attribution lines. It is merged with the face for the
8102 cited text belonging to the attribution.
8104 @item gnus-cite-ignore-quoted-from
8105 @vindex gnus-cite-ignore-quoted-from
8106 If non-@code{nil}, no citation highlighting will be performed on lines
8107 beginning with @samp{>From }. Those lines may have been quoted by MTAs
8108 in order not to mix up with the envelope From line. The default value
8115 @kindex W H s (Summary)
8116 @vindex gnus-signature-separator
8117 @vindex gnus-signature-face
8118 @findex gnus-article-highlight-signature
8119 Highlight the signature (@code{gnus-article-highlight-signature}).
8120 Everything after @code{gnus-signature-separator} (@pxref{Article
8121 Signature}) in an article will be considered a signature and will be
8122 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8127 @xref{Customizing Articles}, for how to highlight articles automatically.
8130 @node Article Fontisizing
8131 @subsection Article Fontisizing
8133 @cindex article emphasis
8135 @findex gnus-article-emphasize
8136 @kindex W e (Summary)
8137 People commonly add emphasis to words in news articles by writing things
8138 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8139 this look nicer by running the article through the @kbd{W e}
8140 (@code{gnus-article-emphasize}) command.
8142 @vindex gnus-emphasis-alist
8143 How the emphasis is computed is controlled by the
8144 @code{gnus-emphasis-alist} variable. This is an alist where the first
8145 element is a regular expression to be matched. The second is a number
8146 that says what regular expression grouping is used to find the entire
8147 emphasized word. The third is a number that says what regexp grouping
8148 should be displayed and highlighted. (The text between these two
8149 groupings will be hidden.) The fourth is the face used for
8153 (setq gnus-emphasis-alist
8154 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8155 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8164 @vindex gnus-emphasis-underline
8165 @vindex gnus-emphasis-bold
8166 @vindex gnus-emphasis-italic
8167 @vindex gnus-emphasis-underline-bold
8168 @vindex gnus-emphasis-underline-italic
8169 @vindex gnus-emphasis-bold-italic
8170 @vindex gnus-emphasis-underline-bold-italic
8171 By default, there are seven rules, and they use the following faces:
8172 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8173 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8174 @code{gnus-emphasis-underline-italic},
8175 @code{gnus-emphasis-underline-bold}, and
8176 @code{gnus-emphasis-underline-bold-italic}.
8178 If you want to change these faces, you can either use @kbd{M-x
8179 customize}, or you can use @code{copy-face}. For instance, if you want
8180 to make @code{gnus-emphasis-italic} use a red face instead, you could
8184 (copy-face 'red 'gnus-emphasis-italic)
8187 @vindex gnus-group-highlight-words-alist
8189 If you want to highlight arbitrary words, you can use the
8190 @code{gnus-group-highlight-words-alist} variable, which uses the same
8191 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8192 parameter (@pxref{Group Parameters}) can also be used.
8194 @xref{Customizing Articles}, for how to fontize articles automatically.
8197 @node Article Hiding
8198 @subsection Article Hiding
8199 @cindex article hiding
8201 Or rather, hiding certain things in each article. There usually is much
8202 too much cruft in most articles.
8207 @kindex W W a (Summary)
8208 @findex gnus-article-hide
8209 Do quite a lot of hiding on the article buffer
8210 (@kbd{gnus-article-hide}). In particular, this function will hide
8211 headers, @acronym{PGP}, cited text and the signature.
8214 @kindex W W h (Summary)
8215 @findex gnus-article-hide-headers
8216 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8220 @kindex W W b (Summary)
8221 @findex gnus-article-hide-boring-headers
8222 Hide headers that aren't particularly interesting
8223 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8226 @kindex W W s (Summary)
8227 @findex gnus-article-hide-signature
8228 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8232 @kindex W W l (Summary)
8233 @findex gnus-article-hide-list-identifiers
8234 @vindex gnus-list-identifiers
8235 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8236 are strings some mailing list servers add to the beginning of all
8237 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8238 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8239 may not contain @code{\\(..\\)}.
8243 @item gnus-list-identifiers
8244 @vindex gnus-list-identifiers
8245 A regular expression that matches list identifiers to be removed from
8246 subject. This can also be a list of regular expressions.
8251 @kindex W W P (Summary)
8252 @findex gnus-article-hide-pem
8253 Hide @acronym{PEM} (privacy enhanced messages) cruft
8254 (@code{gnus-article-hide-pem}).
8257 @kindex W W B (Summary)
8258 @findex gnus-article-strip-banner
8259 @vindex gnus-article-banner-alist
8260 @vindex gnus-article-address-banner-alist
8263 @cindex stripping advertisements
8264 @cindex advertisements
8265 Strip the banner specified by the @code{banner} group parameter
8266 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8267 annoying banners and/or signatures that some mailing lists and moderated
8268 groups adds to all the messages. The way to use this function is to add
8269 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8270 group you want banners stripped from. The parameter either be a string,
8271 which will be interpreted as a regular expression matching text to be
8272 removed, or the symbol @code{signature}, meaning that the (last)
8273 signature should be removed, or other symbol, meaning that the
8274 corresponding regular expression in @code{gnus-article-banner-alist} is
8277 Regardless of a group, you can hide things like advertisements only when
8278 the sender of an article has a certain mail address specified in
8279 @code{gnus-article-address-banner-alist}.
8283 @item gnus-article-address-banner-alist
8284 @vindex gnus-article-address-banner-alist
8285 Alist of mail addresses and banners. Each element has the form
8286 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8287 matching a mail address in the From header, @var{banner} is one of a
8288 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8289 a regexp and @code{nil}. If @var{address} matches author's mail
8290 address, it will remove things like advertisements. For example, if a
8291 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8292 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8293 sends, you can use the following element to remove them:
8296 ("@@yoo-hoo\\.co\\.jp\\'" .
8297 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8303 @kindex W W c (Summary)
8304 @findex gnus-article-hide-citation
8305 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8306 customizing the hiding:
8310 @item gnus-cited-opened-text-button-line-format
8311 @itemx gnus-cited-closed-text-button-line-format
8312 @vindex gnus-cited-closed-text-button-line-format
8313 @vindex gnus-cited-opened-text-button-line-format
8314 Gnus adds buttons to show where the cited text has been hidden, and to
8315 allow toggle hiding the text. The format of the variable is specified
8316 by these format-like variable (@pxref{Formatting Variables}). These
8321 Starting point of the hidden text.
8323 Ending point of the hidden text.
8325 Number of characters in the hidden region.
8327 Number of lines of hidden text.
8330 @item gnus-cited-lines-visible
8331 @vindex gnus-cited-lines-visible
8332 The number of lines at the beginning of the cited text to leave
8333 shown. This can also be a cons cell with the number of lines at the top
8334 and bottom of the text, respectively, to remain visible.
8339 @kindex W W C-c (Summary)
8340 @findex gnus-article-hide-citation-maybe
8342 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8343 following two variables:
8346 @item gnus-cite-hide-percentage
8347 @vindex gnus-cite-hide-percentage
8348 If the cited text is of a bigger percentage than this variable (default
8349 50), hide the cited text.
8351 @item gnus-cite-hide-absolute
8352 @vindex gnus-cite-hide-absolute
8353 The cited text must have at least this length (default 10) before it
8358 @kindex W W C (Summary)
8359 @findex gnus-article-hide-citation-in-followups
8360 Hide cited text in articles that aren't roots
8361 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8362 useful as an interactive command, but might be a handy function to stick
8363 have happen automatically (@pxref{Customizing Articles}).
8367 All these ``hiding'' commands are toggles, but if you give a negative
8368 prefix to these commands, they will show what they have previously
8369 hidden. If you give a positive prefix, they will always hide.
8371 Also @pxref{Article Highlighting} for further variables for
8372 citation customization.
8374 @xref{Customizing Articles}, for how to hide article elements
8378 @node Article Washing
8379 @subsection Article Washing
8381 @cindex article washing
8383 We call this ``article washing'' for a really good reason. Namely, the
8384 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8386 @dfn{Washing} is defined by us as ``changing something from something to
8387 something else'', but normally results in something looking better.
8390 @xref{Customizing Articles}, if you want to change how Gnus displays
8391 articles by default.
8396 This is not really washing, it's sort of the opposite of washing. If
8397 you type this, you see the article exactly as it exists on disk or on
8401 Force redisplaying of the current article
8402 (@code{gnus-summary-show-article}). This is also not really washing.
8403 If you type this, you see the article without any previously applied
8404 interactive Washing functions but with all default treatments
8405 (@pxref{Customizing Articles}).
8408 @kindex W l (Summary)
8409 @findex gnus-summary-stop-page-breaking
8410 Remove page breaks from the current article
8411 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8415 @kindex W r (Summary)
8416 @findex gnus-summary-caesar-message
8417 @c @icon{gnus-summary-caesar-message}
8418 Do a Caesar rotate (rot13) on the article buffer
8419 (@code{gnus-summary-caesar-message}).
8420 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8421 (Typically offensive jokes and such.)
8423 It's commonly called ``rot13'' because each letter is rotated 13
8424 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8425 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8426 is rumored to have employed this form of, uh, somewhat weak encryption.
8429 @kindex W m (Summary)
8430 @findex gnus-summary-morse-message
8431 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8435 @kindex W t (Summary)
8437 @findex gnus-summary-toggle-header
8438 Toggle whether to display all headers in the article buffer
8439 (@code{gnus-summary-toggle-header}).
8442 @kindex W v (Summary)
8443 @findex gnus-summary-verbose-headers
8444 Toggle whether to display all headers in the article buffer permanently
8445 (@code{gnus-summary-verbose-headers}).
8448 @kindex W m (Summary)
8449 @findex gnus-summary-toggle-mime
8450 Toggle whether to run the article through @acronym{MIME} before
8451 displaying (@code{gnus-summary-toggle-mime}).
8454 @kindex W o (Summary)
8455 @findex gnus-article-treat-overstrike
8456 Treat overstrike (@code{gnus-article-treat-overstrike}).
8459 @kindex W d (Summary)
8460 @findex gnus-article-treat-dumbquotes
8461 @vindex gnus-article-dumbquotes-map
8463 @cindex M****s*** sm*rtq**t*s
8465 Treat M****s*** sm*rtq**t*s according to
8466 @code{gnus-article-dumbquotes-map}
8467 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8468 whether a character is a sm*rtq**t* or not, so it should only be used
8471 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8472 an attempt to provide more quoting characters. If you see something
8473 like @code{\222} or @code{\264} where you're expecting some kind of
8474 apostrophe or quotation mark, then try this wash.
8477 @kindex W Y f (Summary)
8478 @findex gnus-article-outlook-deuglify-article
8479 @cindex Outlook Express
8480 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8481 unwrap lines, repair attribution and rearrange citation.
8482 (@code{gnus-article-outlook-deuglify-article}).
8485 @kindex W Y u (Summary)
8486 @findex gnus-article-outlook-unwrap-lines
8487 @vindex gnus-outlook-deuglify-unwrap-min
8488 @vindex gnus-outlook-deuglify-unwrap-max
8489 Unwrap lines that appear to be wrapped citation lines. You can control
8490 what lines will be unwrapped by frobbing
8491 @code{gnus-outlook-deuglify-unwrap-min} and
8492 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8493 maximum length of an unwrapped citation line.
8494 (@code{gnus-article-outlook-unwrap-lines}).
8497 @kindex W Y a (Summary)
8498 @findex gnus-article-outlook-repair-attribution
8499 Repair a broken attribution line.@*
8500 (@code{gnus-article-outlook-repair-attribution}).
8503 @kindex W Y c (Summary)
8504 @findex gnus-article-outlook-rearrange-citation
8505 Repair broken citations by rearranging the text.
8506 (@code{gnus-article-outlook-rearrange-citation}).
8509 @kindex W w (Summary)
8510 @findex gnus-article-fill-cited-article
8511 Do word wrap (@code{gnus-article-fill-cited-article}).
8513 You can give the command a numerical prefix to specify the width to use
8517 @kindex W Q (Summary)
8518 @findex gnus-article-fill-long-lines
8519 Fill long lines (@code{gnus-article-fill-long-lines}).
8522 @kindex W C (Summary)
8523 @findex gnus-article-capitalize-sentences
8524 Capitalize the first word in each sentence
8525 (@code{gnus-article-capitalize-sentences}).
8528 @kindex W c (Summary)
8529 @findex gnus-article-remove-cr
8530 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8531 (this takes care of DOS line endings), and then translate any remaining
8532 CRs into LF (this takes care of Mac line endings)
8533 (@code{gnus-article-remove-cr}).
8535 @kindex W q (Summary)
8536 @findex gnus-article-de-quoted-unreadable
8537 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8538 Quoted-Printable is one common @acronym{MIME} encoding employed when
8539 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8540 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
8541 which doesn't look very readable to me. Note that this is usually
8542 done automatically by Gnus if the message in question has a
8543 @code{Content-Transfer-Encoding} header that says that this encoding
8544 has been done. If a prefix is given, a charset will be asked for.
8547 @kindex W 6 (Summary)
8548 @findex gnus-article-de-base64-unreadable
8549 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8550 one common @acronym{MIME} encoding employed when sending
8551 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8552 usually done automatically by Gnus if the message in question has a
8553 @code{Content-Transfer-Encoding} header that says that this encoding
8554 has been done. If a prefix is given, a charset will be asked for.
8557 @kindex W Z (Summary)
8558 @findex gnus-article-decode-HZ
8559 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8560 common encoding employed when sending Chinese articles. It typically
8561 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8564 @kindex W A (Summary)
8565 @findex gnus-article-treat-ansi-sequences
8566 @cindex @acronym{ANSI} control sequences
8567 Translate @acronym{ANSI} SGR control sequences into overlays or
8568 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
8569 sequences are used in some Chinese hierarchies for highlighting.
8572 @kindex W u (Summary)
8573 @findex gnus-article-unsplit-urls
8574 Remove newlines from within URLs. Some mailers insert newlines into
8575 outgoing email messages to keep lines short. This reformatting can
8576 split long URLs onto multiple lines. Repair those URLs by removing
8577 the newlines (@code{gnus-article-unsplit-urls}).
8580 @kindex W h (Summary)
8581 @findex gnus-article-wash-html
8582 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
8583 usually done automatically by Gnus if the message in question has a
8584 @code{Content-Type} header that says that the message is @acronym{HTML}.
8586 If a prefix is given, a charset will be asked for.
8588 @vindex gnus-article-wash-function
8589 The default is to use the function specified by
8590 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
8591 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8592 @acronym{HTML}, but this is controlled by the
8593 @code{gnus-article-wash-function} variable. Pre-defined functions you
8601 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
8604 Use @uref{http://links.sf.net/, Links}.
8607 Use @uref{http://lynx.isc.org/, Lynx}.
8610 Use html2text---a simple @acronym{HTML} converter included with Gnus.
8615 @kindex W b (Summary)
8616 @findex gnus-article-add-buttons
8617 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8618 @xref{Article Buttons}.
8621 @kindex W B (Summary)
8622 @findex gnus-article-add-buttons-to-head
8623 Add clickable buttons to the article headers
8624 (@code{gnus-article-add-buttons-to-head}).
8627 @kindex W p (Summary)
8628 @findex gnus-article-verify-x-pgp-sig
8629 Verify a signed control message
8630 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
8631 @code{newgroup} and @code{checkgroups} are usually signed by the
8632 hierarchy maintainer. You need to add the @acronym{PGP} public key of
8633 the maintainer to your keyring to verify the
8634 message.@footnote{@acronym{PGP} keys for many hierarchies are
8635 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8638 @kindex W s (Summary)
8639 @findex gnus-summary-force-verify-and-decrypt
8640 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
8641 @acronym{S/MIME}) message
8642 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8645 @kindex W a (Summary)
8646 @findex gnus-article-strip-headers-in-body
8647 Strip headers like the @code{X-No-Archive} header from the beginning of
8648 article bodies (@code{gnus-article-strip-headers-in-body}).
8651 @kindex W E l (Summary)
8652 @findex gnus-article-strip-leading-blank-lines
8653 Remove all blank lines from the beginning of the article
8654 (@code{gnus-article-strip-leading-blank-lines}).
8657 @kindex W E m (Summary)
8658 @findex gnus-article-strip-multiple-blank-lines
8659 Replace all blank lines with empty lines and then all multiple empty
8660 lines with a single empty line.
8661 (@code{gnus-article-strip-multiple-blank-lines}).
8664 @kindex W E t (Summary)
8665 @findex gnus-article-remove-trailing-blank-lines
8666 Remove all blank lines at the end of the article
8667 (@code{gnus-article-remove-trailing-blank-lines}).
8670 @kindex W E a (Summary)
8671 @findex gnus-article-strip-blank-lines
8672 Do all the three commands above
8673 (@code{gnus-article-strip-blank-lines}).
8676 @kindex W E A (Summary)
8677 @findex gnus-article-strip-all-blank-lines
8678 Remove all blank lines
8679 (@code{gnus-article-strip-all-blank-lines}).
8682 @kindex W E s (Summary)
8683 @findex gnus-article-strip-leading-space
8684 Remove all white space from the beginning of all lines of the article
8685 body (@code{gnus-article-strip-leading-space}).
8688 @kindex W E e (Summary)
8689 @findex gnus-article-strip-trailing-space
8690 Remove all white space from the end of all lines of the article
8691 body (@code{gnus-article-strip-trailing-space}).
8695 @xref{Customizing Articles}, for how to wash articles automatically.
8698 @node Article Header
8699 @subsection Article Header
8701 These commands perform various transformations of article header.
8706 @kindex W G u (Summary)
8707 @findex gnus-article-treat-unfold-headers
8708 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8711 @kindex W G n (Summary)
8712 @findex gnus-article-treat-fold-newsgroups
8713 Fold the @code{Newsgroups} and @code{Followup-To} headers
8714 (@code{gnus-article-treat-fold-newsgroups}).
8717 @kindex W G f (Summary)
8718 @findex gnus-article-treat-fold-headers
8719 Fold all the message headers
8720 (@code{gnus-article-treat-fold-headers}).
8723 @kindex W E w (Summary)
8724 @findex gnus-article-remove-leading-whitespace
8725 Remove excessive whitespace from all headers
8726 (@code{gnus-article-remove-leading-whitespace}).
8731 @node Article Buttons
8732 @subsection Article Buttons
8735 People often include references to other stuff in articles, and it would
8736 be nice if Gnus could just fetch whatever it is that people talk about
8737 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8738 button on these references.
8740 @vindex gnus-button-man-handler
8741 Gnus adds @dfn{buttons} to certain standard references by default:
8742 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
8743 Emacs or Gnus related references. This is controlled by two variables,
8744 one that handles article bodies and one that handles article heads:
8748 @item gnus-button-alist
8749 @vindex gnus-button-alist
8750 This is an alist where each entry has this form:
8753 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8759 All text that match this regular expression (case insensitive) will be
8760 considered an external reference. Here's a typical regexp that matches
8761 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
8762 variable containing a regexp, useful variables to use include
8763 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
8766 Gnus has to know which parts of the matches is to be highlighted. This
8767 is a number that says what sub-expression of the regexp is to be
8768 highlighted. If you want it all highlighted, you use 0 here.
8771 This form will be @code{eval}ed, and if the result is non-@code{nil},
8772 this is considered a match. This is useful if you want extra sifting to
8773 avoid false matches. Often variables named
8774 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
8775 Levels}, but any other form may be used too.
8777 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
8780 This function will be called when you click on this button.
8783 As with @var{button-par}, this is a sub-expression number, but this one
8784 says which part of the match is to be sent as data to @var{function}.
8788 So the full entry for buttonizing URLs is then
8791 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8794 @item gnus-header-button-alist
8795 @vindex gnus-header-button-alist
8796 This is just like the other alist, except that it is applied to the
8797 article head only, and that each entry has an additional element that is
8798 used to say what headers to apply the buttonize coding to:
8801 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8804 @var{header} is a regular expression.
8807 @subsubsection Related variables and functions
8810 @item gnus-button-@var{*}-level
8811 @xref{Article Button Levels}.
8813 @c Stuff related to gnus-button-browse-level
8815 @item gnus-button-url-regexp
8816 @vindex gnus-button-url-regexp
8817 A regular expression that matches embedded URLs. It is used in the
8818 default values of the variables above.
8820 @c Stuff related to gnus-button-man-level
8822 @item gnus-button-man-handler
8823 @vindex gnus-button-man-handler
8824 The function to use for displaying man pages. It must take at least one
8825 argument with a string naming the man page.
8827 @c Stuff related to gnus-button-message-level
8829 @item gnus-button-mid-or-mail-regexp
8830 @vindex gnus-button-mid-or-mail-regexp
8831 Regular expression that matches a message ID or a mail address.
8833 @item gnus-button-prefer-mid-or-mail
8834 @vindex gnus-button-prefer-mid-or-mail
8835 This variable determines what to do when the button on a string as
8836 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
8837 message ID or a mail address. If it is one of the symbols @code{mid} or
8838 @code{mail}, Gnus will always assume that the string is a message ID or
8839 a mail address, respectively. If this variable is set to the symbol
8840 @code{ask}, always query the user what do do. If it is a function, this
8841 function will be called with the string as its only argument. The
8842 function must return @code{mid}, @code{mail}, @code{invalid} or
8843 @code{ask}. The default value is the function
8844 @code{gnus-button-mid-or-mail-heuristic}.
8846 @item gnus-button-mid-or-mail-heuristic
8847 @findex gnus-button-mid-or-mail-heuristic
8848 Function that guesses whether its argument is a message ID or a mail
8849 address. Returns @code{mid} if it's a message IDs, @code{mail} if
8850 it's a mail address, @code{ask} if unsure and @code{invalid} if the
8853 @item gnus-button-mid-or-mail-heuristic-alist
8854 @vindex gnus-button-mid-or-mail-heuristic-alist
8855 An alist of @code{(RATE . REGEXP)} pairs used by the function
8856 @code{gnus-button-mid-or-mail-heuristic}.
8858 @c Stuff related to gnus-button-tex-level
8860 @item gnus-button-ctan-handler
8861 @findex gnus-button-ctan-handler
8862 The function to use for displaying CTAN links. It must take one
8863 argument, the string naming the URL.
8866 @vindex gnus-ctan-url
8867 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
8868 by @code{gnus-button-ctan-handler}.
8872 @item gnus-article-button-face
8873 @vindex gnus-article-button-face
8874 Face used on buttons.
8876 @item gnus-article-mouse-face
8877 @vindex gnus-article-mouse-face
8878 Face used when the mouse cursor is over a button.
8882 @xref{Customizing Articles}, for how to buttonize articles automatically.
8885 @node Article Button Levels
8886 @subsection Article button levels
8887 @cindex button levels
8888 The higher the value of the variables @code{gnus-button-@var{*}-level},
8889 the more buttons will appear. If the level is zero, no corresponding
8890 buttons are displayed. With the default value (which is 5) you should
8891 already see quite a lot of buttons. With higher levels, you will see
8892 more buttons, but you may also get more false positives. To avoid them,
8893 you can set the variables @code{gnus-button-@var{*}-level} local to
8894 specific groups (@pxref{Group Parameters}). Here's an example for the
8895 variable @code{gnus-parameters}:
8898 ;; @r{increase @code{gnus-button-*-level} in some groups:}
8899 (setq gnus-parameters
8900 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
8901 ("\\<unix\\>" (gnus-button-man-level 10))
8902 ("\\<tex\\>" (gnus-button-tex-level 10))))
8907 @item gnus-button-browse-level
8908 @vindex gnus-button-browse-level
8909 Controls the display of references to message IDs, mail addresses and
8910 news URLs. Related variables and functions include
8911 @code{gnus-button-url-regexp}, @code{browse-url}, and
8912 @code{browse-url-browser-function}.
8914 @item gnus-button-emacs-level
8915 @vindex gnus-button-emacs-level
8916 Controls the display of Emacs or Gnus references. Related functions are
8917 @code{gnus-button-handle-custom},
8918 @code{gnus-button-handle-describe-function},
8919 @code{gnus-button-handle-describe-variable},
8920 @code{gnus-button-handle-symbol},
8921 @code{gnus-button-handle-describe-key},
8922 @code{gnus-button-handle-apropos},
8923 @code{gnus-button-handle-apropos-command},
8924 @code{gnus-button-handle-apropos-variable},
8925 @code{gnus-button-handle-apropos-documentation}, and
8926 @code{gnus-button-handle-library}.
8928 @item gnus-button-man-level
8929 @vindex gnus-button-man-level
8930 Controls the display of references to (Unix) man pages.
8931 See @code{gnus-button-man-handler}.
8933 @item gnus-button-message-level
8934 @vindex gnus-button-message-level
8935 Controls the display of message IDs, mail addresses and news URLs.
8936 Related variables and functions include
8937 @code{gnus-button-mid-or-mail-regexp},
8938 @code{gnus-button-prefer-mid-or-mail},
8939 @code{gnus-button-mid-or-mail-heuristic}, and
8940 @code{gnus-button-mid-or-mail-heuristic-alist}.
8942 @item gnus-button-tex-level
8943 @vindex gnus-button-tex-level
8944 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
8945 URLs. See the variables @code{gnus-ctan-url},
8946 @code{gnus-button-ctan-handler},
8947 @code{gnus-button-ctan-directory-regexp}, and
8948 @code{gnus-button-handle-ctan-bogus-regexp}.
8954 @subsection Article Date
8956 The date is most likely generated in some obscure timezone you've never
8957 heard of, so it's quite nice to be able to find out what the time was
8958 when the article was sent.
8963 @kindex W T u (Summary)
8964 @findex gnus-article-date-ut
8965 Display the date in UT (aka. GMT, aka ZULU)
8966 (@code{gnus-article-date-ut}).
8969 @kindex W T i (Summary)
8970 @findex gnus-article-date-iso8601
8972 Display the date in international format, aka. ISO 8601
8973 (@code{gnus-article-date-iso8601}).
8976 @kindex W T l (Summary)
8977 @findex gnus-article-date-local
8978 Display the date in the local timezone (@code{gnus-article-date-local}).
8981 @kindex W T p (Summary)
8982 @findex gnus-article-date-english
8983 Display the date in a format that's easily pronounceable in English
8984 (@code{gnus-article-date-english}).
8987 @kindex W T s (Summary)
8988 @vindex gnus-article-time-format
8989 @findex gnus-article-date-user
8990 @findex format-time-string
8991 Display the date using a user-defined format
8992 (@code{gnus-article-date-user}). The format is specified by the
8993 @code{gnus-article-time-format} variable, and is a string that's passed
8994 to @code{format-time-string}. See the documentation of that variable
8995 for a list of possible format specs.
8998 @kindex W T e (Summary)
8999 @findex gnus-article-date-lapsed
9000 @findex gnus-start-date-timer
9001 @findex gnus-stop-date-timer
9002 Say how much time has elapsed between the article was posted and now
9003 (@code{gnus-article-date-lapsed}). It looks something like:
9006 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9009 @vindex gnus-article-date-lapsed-new-header
9010 The value of @code{gnus-article-date-lapsed-new-header} determines
9011 whether this header will just be added below the old Date one, or will
9014 An advantage of using Gnus to read mail is that it converts simple bugs
9015 into wonderful absurdities.
9017 If you want to have this line updated continually, you can put
9020 (gnus-start-date-timer)
9023 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9024 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9028 @kindex W T o (Summary)
9029 @findex gnus-article-date-original
9030 Display the original date (@code{gnus-article-date-original}). This can
9031 be useful if you normally use some other conversion function and are
9032 worried that it might be doing something totally wrong. Say, claiming
9033 that the article was posted in 1854. Although something like that is
9034 @emph{totally} impossible. Don't you trust me? *titter*
9038 @xref{Customizing Articles}, for how to display the date in your
9039 preferred format automatically.
9042 @node Article Display
9043 @subsection Article Display
9048 These commands add various frivolous display gimmicks to the article
9049 buffer in Emacs versions that support them.
9051 @code{X-Face} headers are small black-and-white images supplied by the
9052 message headers (@pxref{X-Face}).
9054 @code{Face} headers are small colored images supplied by the message
9055 headers (@pxref{Face}).
9057 Smileys are those little @samp{:-)} symbols that people like to litter
9058 their messages with (@pxref{Smileys}).
9060 Picons, on the other hand, reside on your own system, and Gnus will
9061 try to match the headers to what you have (@pxref{Picons}).
9063 All these functions are toggles---if the elements already exist,
9068 @kindex W D x (Summary)
9069 @findex gnus-article-display-x-face
9070 Display an @code{X-Face} in the @code{From} header.
9071 (@code{gnus-article-display-x-face}).
9074 @kindex W D d (Summary)
9075 @findex gnus-article-display-face
9076 Display a @code{Face} in the @code{From} header.
9077 (@code{gnus-article-display-face}).
9080 @kindex W D s (Summary)
9081 @findex gnus-treat-smiley
9082 Display smileys (@code{gnus-treat-smiley}).
9085 @kindex W D f (Summary)
9086 @findex gnus-treat-from-picon
9087 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9090 @kindex W D m (Summary)
9091 @findex gnus-treat-mail-picon
9092 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9093 (@code{gnus-treat-mail-picon}).
9096 @kindex W D n (Summary)
9097 @findex gnus-treat-newsgroups-picon
9098 Piconify all news headers (i. e., @code{Newsgroups} and
9099 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9102 @kindex W D D (Summary)
9103 @findex gnus-article-remove-images
9104 Remove all images from the article buffer
9105 (@code{gnus-article-remove-images}).
9111 @node Article Signature
9112 @subsection Article Signature
9114 @cindex article signature
9116 @vindex gnus-signature-separator
9117 Each article is divided into two parts---the head and the body. The
9118 body can be divided into a signature part and a text part. The variable
9119 that says what is to be considered a signature is
9120 @code{gnus-signature-separator}. This is normally the standard
9121 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9122 non-standard signature separators, so this variable can also be a list
9123 of regular expressions to be tested, one by one. (Searches are done
9124 from the end of the body towards the beginning.) One likely value is:
9127 (setq gnus-signature-separator
9128 '("^-- $" ; @r{The standard}
9129 "^-- *$" ; @r{A common mangling}
9130 "^-------*$" ; @r{Many people just use a looong}
9131 ; @r{line of dashes. Shame!}
9132 "^ *--------*$" ; @r{Double-shame!}
9133 "^________*$" ; @r{Underscores are also popular}
9134 "^========*$")) ; @r{Pervert!}
9137 The more permissive you are, the more likely it is that you'll get false
9140 @vindex gnus-signature-limit
9141 @code{gnus-signature-limit} provides a limit to what is considered a
9142 signature when displaying articles.
9146 If it is an integer, no signature may be longer (in characters) than
9149 If it is a floating point number, no signature may be longer (in lines)
9152 If it is a function, the function will be called without any parameters,
9153 and if it returns @code{nil}, there is no signature in the buffer.
9155 If it is a string, it will be used as a regexp. If it matches, the text
9156 in question is not a signature.
9159 This variable can also be a list where the elements may be of the types
9160 listed above. Here's an example:
9163 (setq gnus-signature-limit
9164 '(200.0 "^---*Forwarded article"))
9167 This means that if there are more than 200 lines after the signature
9168 separator, or the text after the signature separator is matched by
9169 the regular expression @samp{^---*Forwarded article}, then it isn't a
9170 signature after all.
9173 @node Article Miscellanea
9174 @subsection Article Miscellanea
9178 @kindex A t (Summary)
9179 @findex gnus-article-babel
9180 Translate the article from one language to another
9181 (@code{gnus-article-babel}).
9187 @section MIME Commands
9188 @cindex MIME decoding
9190 @cindex viewing attachments
9192 The following commands all understand the numerical prefix. For
9193 instance, @kbd{3 b} means ``view the third @acronym{MIME} part''.
9199 @kindex K v (Summary)
9200 View the @acronym{MIME} part.
9203 @kindex K o (Summary)
9204 Save the @acronym{MIME} part.
9207 @kindex K c (Summary)
9208 Copy the @acronym{MIME} part.
9211 @kindex K e (Summary)
9212 View the @acronym{MIME} part externally.
9215 @kindex K i (Summary)
9216 View the @acronym{MIME} part internally.
9219 @kindex K | (Summary)
9220 Pipe the @acronym{MIME} part to an external command.
9223 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9228 @kindex K b (Summary)
9229 Make all the @acronym{MIME} parts have buttons in front of them. This is
9230 mostly useful if you wish to save (or perform other actions) on inlined
9234 @kindex K m (Summary)
9235 @findex gnus-summary-repair-multipart
9236 Some multipart messages are transmitted with missing or faulty headers.
9237 This command will attempt to ``repair'' these messages so that they can
9238 be viewed in a more pleasant manner
9239 (@code{gnus-summary-repair-multipart}).
9242 @kindex X m (Summary)
9243 @findex gnus-summary-save-parts
9244 Save all parts matching a @acronym{MIME} type to a directory
9245 (@code{gnus-summary-save-parts}). Understands the process/prefix
9246 convention (@pxref{Process/Prefix}).
9249 @kindex M-t (Summary)
9250 @findex gnus-summary-toggle-display-buttonized
9251 Toggle the buttonized display of the article buffer
9252 (@code{gnus-summary-toggle-display-buttonized}).
9255 @kindex W M w (Summary)
9256 @findex gnus-article-decode-mime-words
9257 Decode RFC 2047-encoded words in the article headers
9258 (@code{gnus-article-decode-mime-words}).
9261 @kindex W M c (Summary)
9262 @findex gnus-article-decode-charset
9263 Decode encoded article bodies as well as charsets
9264 (@code{gnus-article-decode-charset}).
9266 This command looks in the @code{Content-Type} header to determine the
9267 charset. If there is no such header in the article, you can give it a
9268 prefix, which will prompt for the charset to decode as. In regional
9269 groups where people post using some common encoding (but do not
9270 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9271 parameter to the required charset (@pxref{Group Parameters}).
9274 @kindex W M v (Summary)
9275 @findex gnus-mime-view-all-parts
9276 View all the @acronym{MIME} parts in the current article
9277 (@code{gnus-mime-view-all-parts}).
9284 @item gnus-ignored-mime-types
9285 @vindex gnus-ignored-mime-types
9286 This is a list of regexps. @acronym{MIME} types that match a regexp from
9287 this list will be completely ignored by Gnus. The default value is
9290 To have all Vcards be ignored, you'd say something like this:
9293 (setq gnus-ignored-mime-types
9297 @item gnus-article-loose-mime
9298 @vindex gnus-article-loose-mime
9299 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9300 before interpreting the message as a @acronym{MIME} message. This helps
9301 when reading messages from certain broken mail user agents. The
9302 default is @code{nil}.
9304 @item gnus-article-emulate-mime
9305 @vindex gnus-article-emulate-mime
9306 There are other, non-@acronym{MIME} encoding methods used. The most common
9307 is @samp{uuencode}, but yEncode is also getting to be popular. If
9308 this variable is non-@code{nil}, Gnus will look in message bodies to
9309 see if it finds these encodings, and if so, it'll run them through the
9310 Gnus @acronym{MIME} machinery. The default is @code{t}.
9312 @item gnus-unbuttonized-mime-types
9313 @vindex gnus-unbuttonized-mime-types
9314 This is a list of regexps. @acronym{MIME} types that match a regexp from
9315 this list won't have @acronym{MIME} buttons inserted unless they aren't
9316 displayed or this variable is overridden by
9317 @code{gnus-buttonized-mime-types}. The default value is
9318 @code{(".*/.*")}. This variable is only used when
9319 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9321 @item gnus-buttonized-mime-types
9322 @vindex gnus-buttonized-mime-types
9323 This is a list of regexps. @acronym{MIME} types that match a regexp from
9324 this list will have @acronym{MIME} buttons inserted unless they aren't
9325 displayed. This variable overrides
9326 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9327 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9330 To see e.g. security buttons but no other buttons, you could set this
9331 variable to @code{("multipart/signed")} and leave
9332 @code{gnus-unbuttonized-mime-types} at the default value.
9334 @item gnus-inhibit-mime-unbuttonizing
9335 @vindex gnus-inhibit-mime-unbuttonizing
9336 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9337 default value is @code{nil}.
9339 @item gnus-article-mime-part-function
9340 @vindex gnus-article-mime-part-function
9341 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9342 handle as the parameter. The function is meant to be used to allow
9343 users to gather information from the article (e. g., add Vcard info to
9344 the bbdb database) or to do actions based on parts (e. g., automatically
9345 save all jpegs into some directory).
9347 Here's an example function the does the latter:
9350 (defun my-save-all-jpeg-parts (handle)
9351 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9353 (insert (mm-get-part handle))
9354 (write-region (point-min) (point-max)
9355 (read-file-name "Save jpeg to: ")))))
9356 (setq gnus-article-mime-part-function
9357 'my-save-all-jpeg-parts)
9360 @vindex gnus-mime-multipart-functions
9361 @item gnus-mime-multipart-functions
9362 Alist of @acronym{MIME} multipart types and functions to handle them.
9364 @vindex gnus-mime-display-multipart-alternative-as-mixed
9365 @item gnus-mime-display-multipart-alternative-as-mixed
9366 Display "multipart/alternative" parts as "multipart/mixed".
9368 @vindex gnus-mime-display-multipart-related-as-mixed
9369 @item gnus-mime-display-multipart-related-as-mixed
9370 Display "multipart/related" parts as "multipart/mixed".
9372 If displaying "text/html" is discouraged, see
9373 @code{mm-discouraged-alternatives} in @ref{Display Customization,
9374 Display Customization, , emacs-mime, Emacs-Mime Manual}. Images or
9375 other material inside a "multipart/related" part might be overlooked
9376 when this variable is @code{nil}.
9378 @vindex gnus-mime-display-multipart-as-mixed
9379 @item gnus-mime-display-multipart-as-mixed
9380 Display "multipart" parts as "multipart/mixed". If @code{t}, it
9381 overrides @code{nil} values of
9382 @code{gnus-mime-display-multipart-alternative-as-mixed} and
9383 @code{gnus-mime-display-multipart-related-as-mixed}.
9385 @vindex mm-file-name-rewrite-functions
9386 @item mm-file-name-rewrite-functions
9387 List of functions used for rewriting file names of @acronym{MIME} parts.
9388 Each function takes a file name as input and returns a file name.
9390 Ready-made functions include@*
9391 @code{mm-file-name-delete-whitespace},
9392 @code{mm-file-name-trim-whitespace},
9393 @code{mm-file-name-collapse-whitespace}, and
9394 @code{mm-file-name-replace-whitespace}. The later uses the value of
9395 the variable @code{mm-file-name-replace-whitespace} to replace each
9396 whitespace character in a file name with that string; default value
9397 is @code{"_"} (a single underscore).
9398 @findex mm-file-name-delete-whitespace
9399 @findex mm-file-name-trim-whitespace
9400 @findex mm-file-name-collapse-whitespace
9401 @findex mm-file-name-replace-whitespace
9402 @vindex mm-file-name-replace-whitespace
9404 The standard functions @code{capitalize}, @code{downcase},
9405 @code{upcase}, and @code{upcase-initials} may be useful, too.
9407 Everybody knows that whitespace characters in file names are evil,
9408 except those who don't know. If you receive lots of attachments from
9409 such unenlightened users, you can make live easier by adding
9412 (setq mm-file-name-rewrite-functions
9413 '(mm-file-name-trim-whitespace
9414 mm-file-name-collapse-whitespace
9415 mm-file-name-replace-whitespace))
9419 to your @file{~/.gnus.el} file.
9428 People use different charsets, and we have @acronym{MIME} to let us know what
9429 charsets they use. Or rather, we wish we had. Many people use
9430 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9431 just send out messages without saying what character sets they use. To
9432 help a bit with this, some local news hierarchies have policies that say
9433 what character set is the default. For instance, the @samp{fj}
9434 hierarchy uses @code{iso-2022-jp-2}.
9436 @vindex gnus-group-charset-alist
9437 This knowledge is encoded in the @code{gnus-group-charset-alist}
9438 variable, which is an alist of regexps (use the first item to match full
9439 group names) and default charsets to be used when reading these groups.
9441 @vindex gnus-newsgroup-ignored-charsets
9442 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9443 aren't. These blithely mark messages as being in @code{iso-8859-1}
9444 even if they really are in @code{koi-8}. To help here, the
9445 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9446 charsets that are listed here will be ignored. The variable can be
9447 set on a group-by-group basis using the group parameters (@pxref{Group
9448 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9449 which includes values some agents insist on having in there.
9451 @vindex gnus-group-posting-charset-alist
9452 When posting, @code{gnus-group-posting-charset-alist} is used to
9453 determine which charsets should not be encoded using the @acronym{MIME}
9454 encodings. For instance, some hierarchies discourage using
9455 quoted-printable header encoding.
9457 This variable is an alist of regexps and permitted unencoded charsets
9458 for posting. Each element of the alist has the form @code{(}@var{test
9459 header body-list}@code{)}, where:
9463 is either a regular expression matching the newsgroup header or a
9466 is the charset which may be left unencoded in the header (@code{nil}
9467 means encode all charsets),
9469 is a list of charsets which may be encoded using 8bit content-transfer
9470 encoding in the body, or one of the special values @code{nil} (always
9471 encode using quoted-printable) or @code{t} (always use 8bit).
9478 @cindex coding system aliases
9479 @cindex preferred charset
9481 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
9482 The Emacs MIME Manual}, for additional variables that control which
9483 MIME charsets are used when sending messages.
9485 Other charset tricks that may be useful, although not Gnus-specific:
9487 If there are several @acronym{MIME} charsets that encode the same Emacs
9488 charset, you can choose what charset to use by saying the following:
9491 (put-charset-property 'cyrillic-iso8859-5
9492 'preferred-coding-system 'koi8-r)
9495 This means that Russian will be encoded using @code{koi8-r} instead of
9496 the default @code{iso-8859-5} @acronym{MIME} charset.
9498 If you want to read messages in @code{koi8-u}, you can cheat and say
9501 (define-coding-system-alias 'koi8-u 'koi8-r)
9504 This will almost do the right thing.
9506 And finally, to read charsets like @code{windows-1251}, you can say
9510 (codepage-setup 1251)
9511 (define-coding-system-alias 'windows-1251 'cp1251)
9515 @node Article Commands
9516 @section Article Commands
9523 @kindex A P (Summary)
9524 @vindex gnus-ps-print-hook
9525 @findex gnus-summary-print-article
9526 Generate and print a PostScript image of the article buffer
9527 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9528 be run just before printing the buffer. An alternative way to print
9529 article is to use Muttprint (@pxref{Saving Articles}).
9534 @node Summary Sorting
9535 @section Summary Sorting
9536 @cindex summary sorting
9538 You can have the summary buffer sorted in various ways, even though I
9539 can't really see why you'd want that.
9544 @kindex C-c C-s C-n (Summary)
9545 @findex gnus-summary-sort-by-number
9546 Sort by article number (@code{gnus-summary-sort-by-number}).
9549 @kindex C-c C-s C-a (Summary)
9550 @findex gnus-summary-sort-by-author
9551 Sort by author (@code{gnus-summary-sort-by-author}).
9554 @kindex C-c C-s C-s (Summary)
9555 @findex gnus-summary-sort-by-subject
9556 Sort by subject (@code{gnus-summary-sort-by-subject}).
9559 @kindex C-c C-s C-d (Summary)
9560 @findex gnus-summary-sort-by-date
9561 Sort by date (@code{gnus-summary-sort-by-date}).
9564 @kindex C-c C-s C-l (Summary)
9565 @findex gnus-summary-sort-by-lines
9566 Sort by lines (@code{gnus-summary-sort-by-lines}).
9569 @kindex C-c C-s C-c (Summary)
9570 @findex gnus-summary-sort-by-chars
9571 Sort by article length (@code{gnus-summary-sort-by-chars}).
9574 @kindex C-c C-s C-i (Summary)
9575 @findex gnus-summary-sort-by-score
9576 Sort by score (@code{gnus-summary-sort-by-score}).
9579 @kindex C-c C-s C-r (Summary)
9580 @findex gnus-summary-sort-by-random
9581 Randomize (@code{gnus-summary-sort-by-random}).
9584 @kindex C-c C-s C-o (Summary)
9585 @findex gnus-summary-sort-by-original
9586 Sort using the default sorting method
9587 (@code{gnus-summary-sort-by-original}).
9590 These functions will work both when you use threading and when you don't
9591 use threading. In the latter case, all summary lines will be sorted,
9592 line by line. In the former case, sorting will be done on a
9593 root-by-root basis, which might not be what you were looking for. To
9594 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9598 @node Finding the Parent
9599 @section Finding the Parent
9600 @cindex parent articles
9601 @cindex referring articles
9606 @findex gnus-summary-refer-parent-article
9607 If you'd like to read the parent of the current article, and it is not
9608 displayed in the summary buffer, you might still be able to. That is,
9609 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
9610 and the @code{References} in the current article are not mangled, you
9611 can just press @kbd{^} or @kbd{A r}
9612 (@code{gnus-summary-refer-parent-article}). If everything goes well,
9613 you'll get the parent. If the parent is already displayed in the
9614 summary buffer, point will just move to this article.
9616 If given a positive numerical prefix, fetch that many articles back into
9617 the ancestry. If given a negative numerical prefix, fetch just that
9618 ancestor. So if you say @kbd{3 ^}, gnus will fetch the parent, the
9619 grandparent and the grandgrandparent of the current article. If you say
9620 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
9624 @findex gnus-summary-refer-references
9625 @kindex A R (Summary)
9626 Fetch all articles mentioned in the @code{References} header of the
9627 article (@code{gnus-summary-refer-references}).
9630 @findex gnus-summary-refer-thread
9631 @kindex A T (Summary)
9632 Display the full thread where the current article appears
9633 (@code{gnus-summary-refer-thread}). This command has to fetch all the
9634 headers in the current group to work, so it usually takes a while. If
9635 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9636 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
9637 visible effects normally, but it'll make this command work a whole lot
9638 faster. Of course, it'll make group entry somewhat slow.
9640 @vindex gnus-refer-thread-limit
9641 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9642 articles before the first displayed in the current group) headers to
9643 fetch when doing this command. The default is 200. If @code{t}, all
9644 the available headers will be fetched. This variable can be overridden
9645 by giving the @kbd{A T} command a numerical prefix.
9648 @findex gnus-summary-refer-article
9649 @kindex M-^ (Summary)
9651 @cindex fetching by Message-ID
9652 You can also ask the @acronym{NNTP} server for an arbitrary article, no
9653 matter what group it belongs to. @kbd{M-^}
9654 (@code{gnus-summary-refer-article}) will ask you for a
9655 @code{Message-ID}, which is one of those long, hard-to-read thingies
9656 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
9657 have to get it all exactly right. No fuzzy searches, I'm afraid.
9660 The current select method will be used when fetching by
9661 @code{Message-ID} from non-news select method, but you can override this
9662 by giving this command a prefix.
9664 @vindex gnus-refer-article-method
9665 If the group you are reading is located on a back end that does not
9666 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9667 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
9668 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
9669 updating the spool you are reading from, but that's not really
9672 It can also be a list of select methods, as well as the special symbol
9673 @code{current}, which means to use the current select method. If it
9674 is a list, Gnus will try all the methods in the list until it finds a
9677 Here's an example setting that will first try the current method, and
9678 then ask Google if that fails:
9681 (setq gnus-refer-article-method
9683 (nnweb "google" (nnweb-type google))))
9686 Most of the mail back ends support fetching by @code{Message-ID}, but
9687 do not do a particularly excellent job at it. That is, @code{nnmbox},
9688 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
9689 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
9690 only able to locate articles that have been posted to the current
9691 group. (Anything else would be too time consuming.) @code{nnmh} does
9692 not support this at all.
9695 @node Alternative Approaches
9696 @section Alternative Approaches
9698 Different people like to read news using different methods. This being
9699 gnus, we offer a small selection of minor modes for the summary buffers.
9702 * Pick and Read:: First mark articles and then read them.
9703 * Binary Groups:: Auto-decode all articles.
9708 @subsection Pick and Read
9709 @cindex pick and read
9711 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9712 a two-phased reading interface. The user first marks in a summary
9713 buffer the articles she wants to read. Then she starts reading the
9714 articles with just an article buffer displayed.
9716 @findex gnus-pick-mode
9717 @kindex M-x gnus-pick-mode
9718 Gnus provides a summary buffer minor mode that allows
9719 this---@code{gnus-pick-mode}. This basically means that a few process
9720 mark commands become one-keystroke commands to allow easy marking, and
9721 it provides one additional command for switching to the summary buffer.
9723 Here are the available keystrokes when using pick mode:
9728 @findex gnus-pick-article-or-thread
9729 Pick the article or thread on the current line
9730 (@code{gnus-pick-article-or-thread}). If the variable
9731 @code{gnus-thread-hide-subtree} is true, then this key selects the
9732 entire thread when used at the first article of the thread. Otherwise,
9733 it selects just the article. If given a numerical prefix, go to that
9734 thread or article and pick it. (The line number is normally displayed
9735 at the beginning of the summary pick lines.)
9738 @kindex SPACE (Pick)
9739 @findex gnus-pick-next-page
9740 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
9741 at the end of the buffer, start reading the picked articles.
9745 @findex gnus-pick-unmark-article-or-thread.
9746 Unpick the thread or article
9747 (@code{gnus-pick-unmark-article-or-thread}). If the variable
9748 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9749 thread if used at the first article of the thread. Otherwise it unpicks
9750 just the article. You can give this key a numerical prefix to unpick
9751 the thread or article at that line.
9755 @findex gnus-pick-start-reading
9756 @vindex gnus-pick-display-summary
9757 Start reading the picked articles (@code{gnus-pick-start-reading}). If
9758 given a prefix, mark all unpicked articles as read first. If
9759 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9760 will still be visible when you are reading.
9764 All the normal summary mode commands are still available in the
9765 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
9766 which is mapped to the same function
9767 @code{gnus-summary-tick-article-forward}.
9769 If this sounds like a good idea to you, you could say:
9772 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9775 @vindex gnus-pick-mode-hook
9776 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9778 @vindex gnus-mark-unpicked-articles-as-read
9779 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9780 all unpicked articles as read. The default is @code{nil}.
9782 @vindex gnus-summary-pick-line-format
9783 The summary line format in pick mode is slightly different from the
9784 standard format. At the beginning of each line the line number is
9785 displayed. The pick mode line format is controlled by the
9786 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9787 Variables}). It accepts the same format specs that
9788 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9792 @subsection Binary Groups
9793 @cindex binary groups
9795 @findex gnus-binary-mode
9796 @kindex M-x gnus-binary-mode
9797 If you spend much time in binary groups, you may grow tired of hitting
9798 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
9799 is a minor mode for summary buffers that makes all ordinary Gnus article
9800 selection functions uudecode series of articles and display the result
9801 instead of just displaying the articles the normal way.
9804 @findex gnus-binary-show-article
9805 The only way, in fact, to see the actual articles is the @kbd{g}
9806 command, when you have turned on this mode
9807 (@code{gnus-binary-show-article}).
9809 @vindex gnus-binary-mode-hook
9810 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9814 @section Tree Display
9817 @vindex gnus-use-trees
9818 If you don't like the normal gnus summary display, you might try setting
9819 @code{gnus-use-trees} to @code{t}. This will create (by default) an
9820 additional @dfn{tree buffer}. You can execute all summary mode commands
9823 There are a few variables to customize the tree display, of course:
9826 @item gnus-tree-mode-hook
9827 @vindex gnus-tree-mode-hook
9828 A hook called in all tree mode buffers.
9830 @item gnus-tree-mode-line-format
9831 @vindex gnus-tree-mode-line-format
9832 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9833 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
9834 of valid specs, @pxref{Summary Buffer Mode Line}.
9836 @item gnus-selected-tree-face
9837 @vindex gnus-selected-tree-face
9838 Face used for highlighting the selected article in the tree buffer. The
9839 default is @code{modeline}.
9841 @item gnus-tree-line-format
9842 @vindex gnus-tree-line-format
9843 A format string for the tree nodes. The name is a bit of a misnomer,
9844 though---it doesn't define a line, but just the node. The default value
9845 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9846 the name of the poster. It is vital that all nodes are of the same
9847 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9853 The name of the poster.
9855 The @code{From} header.
9857 The number of the article.
9859 The opening bracket.
9861 The closing bracket.
9866 @xref{Formatting Variables}.
9868 Variables related to the display are:
9871 @item gnus-tree-brackets
9872 @vindex gnus-tree-brackets
9873 This is used for differentiating between ``real'' articles and
9874 ``sparse'' articles. The format is
9876 ((@var{real-open} . @var{real-close})
9877 (@var{sparse-open} . @var{sparse-close})
9878 (@var{dummy-open} . @var{dummy-close}))
9880 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
9882 @item gnus-tree-parent-child-edges
9883 @vindex gnus-tree-parent-child-edges
9884 This is a list that contains the characters used for connecting parent
9885 nodes to their children. The default is @code{(?- ?\\ ?|)}.
9889 @item gnus-tree-minimize-window
9890 @vindex gnus-tree-minimize-window
9891 If this variable is non-@code{nil}, gnus will try to keep the tree
9892 buffer as small as possible to allow more room for the other gnus
9893 windows. If this variable is a number, the tree buffer will never be
9894 higher than that number. The default is @code{t}. Note that if you
9895 have several windows displayed side-by-side in a frame and the tree
9896 buffer is one of these, minimizing the tree window will also resize all
9897 other windows displayed next to it.
9899 You may also wish to add the following hook to keep the window minimized
9903 (add-hook 'gnus-configure-windows-hook
9904 'gnus-tree-perhaps-minimize)
9907 @item gnus-generate-tree-function
9908 @vindex gnus-generate-tree-function
9909 @findex gnus-generate-horizontal-tree
9910 @findex gnus-generate-vertical-tree
9911 The function that actually generates the thread tree. Two predefined
9912 functions are available: @code{gnus-generate-horizontal-tree} and
9913 @code{gnus-generate-vertical-tree} (which is the default).
9917 Here's an example from a horizontal tree buffer:
9920 @{***@}-(***)-[odd]-[Gun]
9930 Here's the same thread displayed in a vertical tree buffer:
9935 |--------------------------\-----\-----\
9936 (***) [Bjo] [Gun] [Gun]
9938 [odd] [Jan] [odd] (***) [Jor]
9940 [Gun] [Eri] [Eri] [odd]
9946 If you're using horizontal trees, it might be nice to display the trees
9947 side-by-side with the summary buffer. You could add something like the
9948 following to your @file{~/.gnus.el} file:
9951 (setq gnus-use-trees t
9952 gnus-generate-tree-function 'gnus-generate-horizontal-tree
9953 gnus-tree-minimize-window nil)
9954 (gnus-add-configuration
9958 (summary 0.75 point)
9963 @xref{Window Layout}.
9966 @node Mail Group Commands
9967 @section Mail Group Commands
9968 @cindex mail group commands
9970 Some commands only make sense in mail groups. If these commands are
9971 invalid in the current group, they will raise a hell and let you know.
9973 All these commands (except the expiry and edit commands) use the
9974 process/prefix convention (@pxref{Process/Prefix}).
9979 @kindex B e (Summary)
9980 @findex gnus-summary-expire-articles
9981 Run all expirable articles in the current group through the expiry
9982 process (@code{gnus-summary-expire-articles}). That is, delete all
9983 expirable articles in the group that have been around for a while.
9984 (@pxref{Expiring Mail}).
9987 @kindex B C-M-e (Summary)
9988 @findex gnus-summary-expire-articles-now
9989 Delete all the expirable articles in the group
9990 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
9991 articles eligible for expiry in the current group will
9992 disappear forever into that big @file{/dev/null} in the sky.
9995 @kindex B DEL (Summary)
9996 @findex gnus-summary-delete-article
9997 @c @icon{gnus-summary-mail-delete}
9998 Delete the mail article. This is ``delete'' as in ``delete it from your
9999 disk forever and ever, never to return again.'' Use with caution.
10000 (@code{gnus-summary-delete-article}).
10003 @kindex B m (Summary)
10005 @findex gnus-summary-move-article
10006 @vindex gnus-preserve-marks
10007 Move the article from one mail group to another
10008 (@code{gnus-summary-move-article}). Marks will be preserved if
10009 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10012 @kindex B c (Summary)
10014 @findex gnus-summary-copy-article
10015 @c @icon{gnus-summary-mail-copy}
10016 Copy the article from one group (mail group or not) to a mail group
10017 (@code{gnus-summary-copy-article}). Marks will be preserved if
10018 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10021 @kindex B B (Summary)
10022 @cindex crosspost mail
10023 @findex gnus-summary-crosspost-article
10024 Crosspost the current article to some other group
10025 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10026 the article in the other group, and the Xref headers of the article will
10027 be properly updated.
10030 @kindex B i (Summary)
10031 @findex gnus-summary-import-article
10032 Import an arbitrary file into the current mail newsgroup
10033 (@code{gnus-summary-import-article}). You will be prompted for a file
10034 name, a @code{From} header and a @code{Subject} header.
10037 @kindex B I (Summary)
10038 @findex gnus-summary-create-article
10039 Create an empty article in the current mail newsgroups
10040 (@code{gnus-summary-create-article}). You will be prompted for a
10041 @code{From} header and a @code{Subject} header.
10044 @kindex B r (Summary)
10045 @findex gnus-summary-respool-article
10046 @vindex gnus-summary-respool-default-method
10047 Respool the mail article (@code{gnus-summary-respool-article}).
10048 @code{gnus-summary-respool-default-method} will be used as the default
10049 select method when respooling. This variable is @code{nil} by default,
10050 which means that the current group select method will be used instead.
10051 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10052 (which is the default).
10056 @kindex B w (Summary)
10057 @kindex e (Summary)
10058 @findex gnus-summary-edit-article
10059 @kindex C-c C-c (Article)
10060 @findex gnus-summary-edit-article-done
10061 Edit the current article (@code{gnus-summary-edit-article}). To finish
10062 editing and make the changes permanent, type @kbd{C-c C-c}
10063 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10064 @kbd{C-c C-c} command, gnus won't re-highlight the article.
10067 @kindex B q (Summary)
10068 @findex gnus-summary-respool-query
10069 If you want to re-spool an article, you might be curious as to what group
10070 the article will end up in before you do the re-spooling. This command
10071 will tell you (@code{gnus-summary-respool-query}).
10074 @kindex B t (Summary)
10075 @findex gnus-summary-respool-trace
10076 Similarly, this command will display all fancy splitting patterns used
10077 when respooling, if any (@code{gnus-summary-respool-trace}).
10080 @kindex B p (Summary)
10081 @findex gnus-summary-article-posted-p
10082 Some people have a tendency to send you ``courtesy'' copies when they
10083 follow up to articles you have posted. These usually have a
10084 @code{Newsgroups} header in them, but not always. This command
10085 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10086 article from your news server (or rather, from
10087 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10088 report back whether it found the article or not. Even if it says that
10089 it didn't find the article, it may have been posted anyway---mail
10090 propagation is much faster than news propagation, and the news copy may
10091 just not have arrived yet.
10094 @kindex K E (Summary)
10095 @findex gnus-article-encrypt-body
10096 @vindex gnus-article-encrypt-protocol
10097 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10098 The body is encrypted with the encryption protocol specified by the
10099 variable @code{gnus-article-encrypt-protocol}.
10103 @vindex gnus-move-split-methods
10104 @cindex moving articles
10105 If you move (or copy) articles regularly, you might wish to have gnus
10106 suggest where to put the articles. @code{gnus-move-split-methods} is a
10107 variable that uses the same syntax as @code{gnus-split-methods}
10108 (@pxref{Saving Articles}). You may customize that variable to create
10109 suggestions you find reasonable. (Note that
10110 @code{gnus-move-split-methods} uses group names where
10111 @code{gnus-split-methods} uses file names.)
10114 (setq gnus-move-split-methods
10115 '(("^From:.*Lars Magne" "nnml:junk")
10116 ("^Subject:.*gnus" "nnfolder:important")
10117 (".*" "nnml:misc")))
10121 @node Various Summary Stuff
10122 @section Various Summary Stuff
10125 * Summary Group Information:: Information oriented commands.
10126 * Searching for Articles:: Multiple article commands.
10127 * Summary Generation Commands::
10128 * Really Various Summary Commands:: Those pesky non-conformant commands.
10132 @vindex gnus-summary-display-while-building
10133 @item gnus-summary-display-while-building
10134 If non-@code{nil}, show and update the summary buffer as it's being
10135 built. If @code{t}, update the buffer after every line is inserted.
10136 If the value is an integer, @var{n}, update the display every @var{n}
10137 lines. The default is @code{nil}.
10139 @vindex gnus-summary-display-arrow
10140 @item gnus-summary-display-arrow
10141 If non-@code{nil}, display an arrow in the fringe to indicate the
10144 @vindex gnus-summary-mode-hook
10145 @item gnus-summary-mode-hook
10146 This hook is called when creating a summary mode buffer.
10148 @vindex gnus-summary-generate-hook
10149 @item gnus-summary-generate-hook
10150 This is called as the last thing before doing the threading and the
10151 generation of the summary buffer. It's quite convenient for customizing
10152 the threading variables based on what data the newsgroup has. This hook
10153 is called from the summary buffer after most summary buffer variables
10156 @vindex gnus-summary-prepare-hook
10157 @item gnus-summary-prepare-hook
10158 It is called after the summary buffer has been generated. You might use
10159 it to, for instance, highlight lines or modify the look of the buffer in
10160 some other ungodly manner. I don't care.
10162 @vindex gnus-summary-prepared-hook
10163 @item gnus-summary-prepared-hook
10164 A hook called as the very last thing after the summary buffer has been
10167 @vindex gnus-summary-ignore-duplicates
10168 @item gnus-summary-ignore-duplicates
10169 When gnus discovers two articles that have the same @code{Message-ID},
10170 it has to do something drastic. No articles are allowed to have the
10171 same @code{Message-ID}, but this may happen when reading mail from some
10172 sources. Gnus allows you to customize what happens with this variable.
10173 If it is @code{nil} (which is the default), gnus will rename the
10174 @code{Message-ID} (for display purposes only) and display the article as
10175 any other article. If this variable is @code{t}, it won't display the
10176 article---it'll be as if it never existed.
10178 @vindex gnus-alter-articles-to-read-function
10179 @item gnus-alter-articles-to-read-function
10180 This function, which takes two parameters (the group name and the list
10181 of articles to be selected), is called to allow the user to alter the
10182 list of articles to be selected.
10184 For instance, the following function adds the list of cached articles to
10185 the list in one particular group:
10188 (defun my-add-cached-articles (group articles)
10189 (if (string= group "some.group")
10190 (append gnus-newsgroup-cached articles)
10194 @vindex gnus-newsgroup-variables
10195 @item gnus-newsgroup-variables
10196 A list of newsgroup (summary buffer) local variables, or cons of
10197 variables and their default expressions to be evalled (when the default
10198 values are not @code{nil}), that should be made global while the summary
10201 Note: The default expressions will be evaluated (using function
10202 @code{eval}) before assignment to the local variable rather than just
10203 assigned to it. If the default expression is the symbol @code{global},
10204 that symbol will not be evaluated but the global value of the local
10205 variable will be used instead.
10207 These variables can be used to set variables in the group parameters
10208 while still allowing them to affect operations done in other
10209 buffers. For example:
10212 (setq gnus-newsgroup-variables
10213 '(message-use-followup-to
10214 (gnus-visible-headers .
10215 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10218 Also @pxref{Group Parameters}.
10222 @node Summary Group Information
10223 @subsection Summary Group Information
10228 @kindex H f (Summary)
10229 @findex gnus-summary-fetch-faq
10230 @vindex gnus-group-faq-directory
10231 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10232 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10233 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10234 is usually a directory on a remote machine. This variable can also be
10235 a list of directories. In that case, giving a prefix to this command
10236 will allow you to choose between the various sites. @code{ange-ftp}
10237 or @code{efs} will probably be used for fetching the file.
10240 @kindex H d (Summary)
10241 @findex gnus-summary-describe-group
10242 Give a brief description of the current group
10243 (@code{gnus-summary-describe-group}). If given a prefix, force
10244 rereading the description from the server.
10247 @kindex H h (Summary)
10248 @findex gnus-summary-describe-briefly
10249 Give an extremely brief description of the most important summary
10250 keystrokes (@code{gnus-summary-describe-briefly}).
10253 @kindex H i (Summary)
10254 @findex gnus-info-find-node
10255 Go to the gnus info node (@code{gnus-info-find-node}).
10259 @node Searching for Articles
10260 @subsection Searching for Articles
10265 @kindex M-s (Summary)
10266 @findex gnus-summary-search-article-forward
10267 Search through all subsequent (raw) articles for a regexp
10268 (@code{gnus-summary-search-article-forward}).
10271 @kindex M-r (Summary)
10272 @findex gnus-summary-search-article-backward
10273 Search through all previous (raw) articles for a regexp
10274 (@code{gnus-summary-search-article-backward}).
10277 @kindex & (Summary)
10278 @findex gnus-summary-execute-command
10279 This command will prompt you for a header, a regular expression to match
10280 on this field, and a command to be executed if the match is made
10281 (@code{gnus-summary-execute-command}). If the header is an empty
10282 string, the match is done on the entire article. If given a prefix,
10283 search backward instead.
10285 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10286 all articles that have heads or bodies that match @samp{some.*string}.
10289 @kindex M-& (Summary)
10290 @findex gnus-summary-universal-argument
10291 Perform any operation on all articles that have been marked with
10292 the process mark (@code{gnus-summary-universal-argument}).
10295 @node Summary Generation Commands
10296 @subsection Summary Generation Commands
10301 @kindex Y g (Summary)
10302 @findex gnus-summary-prepare
10303 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10306 @kindex Y c (Summary)
10307 @findex gnus-summary-insert-cached-articles
10308 Pull all cached articles (for the current group) into the summary buffer
10309 (@code{gnus-summary-insert-cached-articles}).
10312 @kindex Y d (Summary)
10313 @findex gnus-summary-insert-dormant-articles
10314 Pull all dormant articles (for the current group) into the summary buffer
10315 (@code{gnus-summary-insert-dormant-articles}).
10320 @node Really Various Summary Commands
10321 @subsection Really Various Summary Commands
10327 @kindex C-d (Summary)
10328 @kindex A D (Summary)
10329 @findex gnus-summary-enter-digest-group
10330 If the current article is a collection of other articles (for instance,
10331 a digest), you might use this command to enter a group based on the that
10332 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10333 guess what article type is currently displayed unless you give a prefix
10334 to this command, which forces a ``digest'' interpretation. Basically,
10335 whenever you see a message that is a collection of other messages of
10336 some format, you @kbd{C-d} and read these messages in a more convenient
10340 @kindex C-M-d (Summary)
10341 @findex gnus-summary-read-document
10342 This command is very similar to the one above, but lets you gather
10343 several documents into one biiig group
10344 (@code{gnus-summary-read-document}). It does this by opening several
10345 @code{nndoc} groups for each document, and then opening an
10346 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10347 command understands the process/prefix convention
10348 (@pxref{Process/Prefix}).
10351 @kindex C-t (Summary)
10352 @findex gnus-summary-toggle-truncation
10353 Toggle truncation of summary lines
10354 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10355 line centering function in the summary buffer, so it's not a good idea
10356 to have truncation switched off while reading articles.
10359 @kindex = (Summary)
10360 @findex gnus-summary-expand-window
10361 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10362 If given a prefix, force an @code{article} window configuration.
10365 @kindex C-M-e (Summary)
10366 @findex gnus-summary-edit-parameters
10367 Edit the group parameters (@pxref{Group Parameters}) of the current
10368 group (@code{gnus-summary-edit-parameters}).
10371 @kindex C-M-a (Summary)
10372 @findex gnus-summary-customize-parameters
10373 Customize the group parameters (@pxref{Group Parameters}) of the current
10374 group (@code{gnus-summary-customize-parameters}).
10379 @node Exiting the Summary Buffer
10380 @section Exiting the Summary Buffer
10381 @cindex summary exit
10382 @cindex exiting groups
10384 Exiting from the summary buffer will normally update all info on the
10385 group and return you to the group buffer.
10392 @kindex Z Z (Summary)
10393 @kindex Z Q (Summary)
10394 @kindex q (Summary)
10395 @findex gnus-summary-exit
10396 @vindex gnus-summary-exit-hook
10397 @vindex gnus-summary-prepare-exit-hook
10398 @vindex gnus-group-no-more-groups-hook
10399 @c @icon{gnus-summary-exit}
10400 Exit the current group and update all information on the group
10401 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10402 called before doing much of the exiting, which calls
10403 @code{gnus-summary-expire-articles} by default.
10404 @code{gnus-summary-exit-hook} is called after finishing the exit
10405 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10406 group mode having no more (unread) groups.
10410 @kindex Z E (Summary)
10411 @kindex Q (Summary)
10412 @findex gnus-summary-exit-no-update
10413 Exit the current group without updating any information on the group
10414 (@code{gnus-summary-exit-no-update}).
10418 @kindex Z c (Summary)
10419 @kindex c (Summary)
10420 @findex gnus-summary-catchup-and-exit
10421 @c @icon{gnus-summary-catchup-and-exit}
10422 Mark all unticked articles in the group as read and then exit
10423 (@code{gnus-summary-catchup-and-exit}).
10426 @kindex Z C (Summary)
10427 @findex gnus-summary-catchup-all-and-exit
10428 Mark all articles, even the ticked ones, as read and then exit
10429 (@code{gnus-summary-catchup-all-and-exit}).
10432 @kindex Z n (Summary)
10433 @findex gnus-summary-catchup-and-goto-next-group
10434 Mark all articles as read and go to the next group
10435 (@code{gnus-summary-catchup-and-goto-next-group}).
10439 @kindex Z R (Summary)
10440 @kindex C-x C-s (Summary)
10441 @findex gnus-summary-reselect-current-group
10442 Exit this group, and then enter it again
10443 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10444 all articles, both read and unread.
10448 @kindex Z G (Summary)
10449 @kindex M-g (Summary)
10450 @findex gnus-summary-rescan-group
10451 @c @icon{gnus-summary-mail-get}
10452 Exit the group, check for new articles in the group, and select the
10453 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10454 articles, both read and unread.
10457 @kindex Z N (Summary)
10458 @findex gnus-summary-next-group
10459 Exit the group and go to the next group
10460 (@code{gnus-summary-next-group}).
10463 @kindex Z P (Summary)
10464 @findex gnus-summary-prev-group
10465 Exit the group and go to the previous group
10466 (@code{gnus-summary-prev-group}).
10469 @kindex Z s (Summary)
10470 @findex gnus-summary-save-newsrc
10471 Save the current number of read/marked articles in the dribble buffer
10472 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10473 given a prefix, also save the @file{.newsrc} file(s). Using this
10474 command will make exit without updating (the @kbd{Q} command) worthless.
10477 @vindex gnus-exit-group-hook
10478 @code{gnus-exit-group-hook} is called when you exit the current group
10479 with an ``updating'' exit. For instance @kbd{Q}
10480 (@code{gnus-summary-exit-no-update}) does not call this hook.
10482 @findex gnus-summary-wake-up-the-dead
10483 @findex gnus-dead-summary-mode
10484 @vindex gnus-kill-summary-on-exit
10485 If you're in the habit of exiting groups, and then changing your mind
10486 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10487 If you do that, gnus won't kill the summary buffer when you exit it.
10488 (Quelle surprise!) Instead it will change the name of the buffer to
10489 something like @samp{*Dead Summary ... *} and install a minor mode
10490 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
10491 buffer, you'll find that all keys are mapped to a function called
10492 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
10493 summary buffer will result in a live, normal summary buffer.
10495 There will never be more than one dead summary buffer at any one time.
10497 @vindex gnus-use-cross-reference
10498 The data on the current group will be updated (which articles you have
10499 read, which articles you have replied to, etc.) when you exit the
10500 summary buffer. If the @code{gnus-use-cross-reference} variable is
10501 @code{t} (which is the default), articles that are cross-referenced to
10502 this group and are marked as read, will also be marked as read in the
10503 other subscribed groups they were cross-posted to. If this variable is
10504 neither @code{nil} nor @code{t}, the article will be marked as read in
10505 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10508 @node Crosspost Handling
10509 @section Crosspost Handling
10513 Marking cross-posted articles as read ensures that you'll never have to
10514 read the same article more than once. Unless, of course, somebody has
10515 posted it to several groups separately. Posting the same article to
10516 several groups (not cross-posting) is called @dfn{spamming}, and you are
10517 by law required to send nasty-grams to anyone who perpetrates such a
10518 heinous crime. You may want to try NoCeM handling to filter out spam
10521 Remember: Cross-posting is kinda ok, but posting the same article
10522 separately to several groups is not. Massive cross-posting (aka.
10523 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10524 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10525 excessive crossposting (@pxref{Summary Mail Commands}).
10527 @cindex cross-posting
10529 @cindex @acronym{NOV}
10530 One thing that may cause Gnus to not do the cross-posting thing
10531 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
10532 (which is very nice, because it speeds things up considerably) which
10533 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
10534 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
10535 even with @sc{xover} by registering the @code{Xref} lines of all
10536 articles you actually read, but if you kill the articles, or just mark
10537 them as read without reading them, Gnus will not get a chance to snoop
10538 the @code{Xref} lines out of these articles, and will be unable to use
10539 the cross reference mechanism.
10541 @cindex LIST overview.fmt
10542 @cindex overview.fmt
10543 To check whether your @acronym{NNTP} server includes the @code{Xref} header
10544 in its overview files, try @samp{telnet your.nntp.server nntp},
10545 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10546 overview.fmt}. This may not work, but if it does, and the last line you
10547 get does not read @samp{Xref:full}, then you should shout and whine at
10548 your news admin until she includes the @code{Xref} header in the
10551 @vindex gnus-nov-is-evil
10552 If you want Gnus to get the @code{Xref}s right all the time, you have to
10553 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10558 For an alternative approach, @pxref{Duplicate Suppression}.
10561 @node Duplicate Suppression
10562 @section Duplicate Suppression
10564 By default, gnus tries to make sure that you don't have to read the same
10565 article more than once by utilizing the crossposting mechanism
10566 (@pxref{Crosspost Handling}). However, that simple and efficient
10567 approach may not work satisfactory for some users for various
10572 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
10573 is evil and not very common.
10576 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
10577 @file{.overview} data bases. This is evil and all too common, alas.
10580 You may be reading the same group (or several related groups) from
10581 different @acronym{NNTP} servers.
10584 You may be getting mail that duplicates articles posted to groups.
10587 I'm sure there are other situations where @code{Xref} handling fails as
10588 well, but these four are the most common situations.
10590 If, and only if, @code{Xref} handling fails for you, then you may
10591 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
10592 will remember the @code{Message-ID}s of all articles you have read or
10593 otherwise marked as read, and then, as if by magic, mark them as read
10594 all subsequent times you see them---in @emph{all} groups. Using this
10595 mechanism is quite likely to be somewhat inefficient, but not overly
10596 so. It's certainly preferable to reading the same articles more than
10599 Duplicate suppression is not a very subtle instrument. It's more like a
10600 sledge hammer than anything else. It works in a very simple
10601 fashion---if you have marked an article as read, it adds this Message-ID
10602 to a cache. The next time it sees this Message-ID, it will mark the
10603 article as read with the @samp{M} mark. It doesn't care what group it
10604 saw the article in.
10607 @item gnus-suppress-duplicates
10608 @vindex gnus-suppress-duplicates
10609 If non-@code{nil}, suppress duplicates.
10611 @item gnus-save-duplicate-list
10612 @vindex gnus-save-duplicate-list
10613 If non-@code{nil}, save the list of duplicates to a file. This will
10614 make startup and shutdown take longer, so the default is @code{nil}.
10615 However, this means that only duplicate articles read in a single gnus
10616 session are suppressed.
10618 @item gnus-duplicate-list-length
10619 @vindex gnus-duplicate-list-length
10620 This variable says how many @code{Message-ID}s to keep in the duplicate
10621 suppression list. The default is 10000.
10623 @item gnus-duplicate-file
10624 @vindex gnus-duplicate-file
10625 The name of the file to store the duplicate suppression list in. The
10626 default is @file{~/News/suppression}.
10629 If you have a tendency to stop and start gnus often, setting
10630 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
10631 you leave gnus running for weeks on end, you may have it @code{nil}. On
10632 the other hand, saving the list makes startup and shutdown much slower,
10633 so that means that if you stop and start gnus often, you should set
10634 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
10635 to you to figure out, I think.
10640 Gnus is able to verify signed messages or decrypt encrypted messages.
10641 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
10642 and @acronym{S/MIME}, however you need some external programs to get
10647 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
10648 install an OpenPGP implementation such as GnuPG. The Lisp interface
10649 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
10650 Manual}), but Mailcrypt and gpg.el are also supported.
10653 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
10654 or newer is recommended.
10658 More information on how to set things up can be found in the message
10659 manual (@pxref{Security, ,Security, message, Message Manual}).
10662 @item mm-verify-option
10663 @vindex mm-verify-option
10664 Option of verifying signed parts. @code{never}, not verify;
10665 @code{always}, always verify; @code{known}, only verify known
10666 protocols. Otherwise, ask user.
10668 @item mm-decrypt-option
10669 @vindex mm-decrypt-option
10670 Option of decrypting encrypted parts. @code{never}, no decryption;
10671 @code{always}, always decrypt; @code{known}, only decrypt known
10672 protocols. Otherwise, ask user.
10675 @vindex mml1991-use
10676 Symbol indicating elisp interface to OpenPGP implementation for
10677 @acronym{PGP} messages. The default is @code{pgg}, but
10678 @code{mailcrypt} and @code{gpg} are also supported although
10682 @vindex mml2015-use
10683 Symbol indicating elisp interface to OpenPGP implementation for
10684 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
10685 @code{mailcrypt} and @code{gpg} are also supported although
10690 @cindex snarfing keys
10691 @cindex importing PGP keys
10692 @cindex PGP key ring import
10693 Snarfing OpenPGP keys (i.e., importing keys from articles into your
10694 key ring) is not supported explicitly through a menu item or command,
10695 rather Gnus do detect and label keys as @samp{application/pgp-keys},
10696 allowing you to specify whatever action you think is appropriate
10697 through the usual @acronym{MIME} infrastructure. You can use a
10698 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
10699 Emacs MIME Manual}) such as the following to import keys using GNU
10700 Privacy Guard when you click on the @acronym{MIME} button
10701 (@pxref{Using MIME}).
10704 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
10707 This happens to also be the default action defined in
10708 @code{mailcap-mime-data}.
10711 @section Mailing List
10712 @cindex mailing list
10715 @kindex A M (summary)
10716 @findex gnus-mailing-list-insinuate
10717 Gnus understands some mailing list fields of RFC 2369. To enable it,
10718 add a @code{to-list} group parameter (@pxref{Group Parameters}),
10719 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10722 That enables the following commands to the summary buffer:
10727 @kindex C-c C-n h (Summary)
10728 @findex gnus-mailing-list-help
10729 Send a message to fetch mailing list help, if List-Help field exists.
10732 @kindex C-c C-n s (Summary)
10733 @findex gnus-mailing-list-subscribe
10734 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10737 @kindex C-c C-n u (Summary)
10738 @findex gnus-mailing-list-unsubscribe
10739 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10743 @kindex C-c C-n p (Summary)
10744 @findex gnus-mailing-list-post
10745 Post to the mailing list, if List-Post field exists.
10748 @kindex C-c C-n o (Summary)
10749 @findex gnus-mailing-list-owner
10750 Send a message to the mailing list owner, if List-Owner field exists.
10753 @kindex C-c C-n a (Summary)
10754 @findex gnus-mailing-list-archive
10755 Browse the mailing list archive, if List-Archive field exists.
10760 @node Article Buffer
10761 @chapter Article Buffer
10762 @cindex article buffer
10764 The articles are displayed in the article buffer, of which there is only
10765 one. All the summary buffers share the same article buffer unless you
10766 tell gnus otherwise.
10769 * Hiding Headers:: Deciding what headers should be displayed.
10770 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
10771 * Customizing Articles:: Tailoring the look of the articles.
10772 * Article Keymap:: Keystrokes available in the article buffer.
10773 * Misc Article:: Other stuff.
10777 @node Hiding Headers
10778 @section Hiding Headers
10779 @cindex hiding headers
10780 @cindex deleting headers
10782 The top section of each article is the @dfn{head}. (The rest is the
10783 @dfn{body}, but you may have guessed that already.)
10785 @vindex gnus-show-all-headers
10786 There is a lot of useful information in the head: the name of the person
10787 who wrote the article, the date it was written and the subject of the
10788 article. That's well and nice, but there's also lots of information
10789 most people do not want to see---what systems the article has passed
10790 through before reaching you, the @code{Message-ID}, the
10791 @code{References}, etc. ad nauseam---and you'll probably want to get rid
10792 of some of those lines. If you want to keep all those lines in the
10793 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10795 Gnus provides you with two variables for sifting headers:
10799 @item gnus-visible-headers
10800 @vindex gnus-visible-headers
10801 If this variable is non-@code{nil}, it should be a regular expression
10802 that says what headers you wish to keep in the article buffer. All
10803 headers that do not match this variable will be hidden.
10805 For instance, if you only want to see the name of the person who wrote
10806 the article and the subject, you'd say:
10809 (setq gnus-visible-headers "^From:\\|^Subject:")
10812 This variable can also be a list of regexps to match headers to
10815 @item gnus-ignored-headers
10816 @vindex gnus-ignored-headers
10817 This variable is the reverse of @code{gnus-visible-headers}. If this
10818 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10819 should be a regular expression that matches all lines that you want to
10820 hide. All lines that do not match this variable will remain visible.
10822 For instance, if you just want to get rid of the @code{References} field
10823 and the @code{Xref} field, you might say:
10826 (setq gnus-ignored-headers "^References:\\|^Xref:")
10829 This variable can also be a list of regexps to match headers to
10832 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10833 variable will have no effect.
10837 @vindex gnus-sorted-header-list
10838 Gnus can also sort the headers for you. (It does this by default.) You
10839 can control the sorting by setting the @code{gnus-sorted-header-list}
10840 variable. It is a list of regular expressions that says in what order
10841 the headers are to be displayed.
10843 For instance, if you want the name of the author of the article first,
10844 and then the subject, you might say something like:
10847 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10850 Any headers that are to remain visible, but are not listed in this
10851 variable, will be displayed in random order after all the headers listed in this variable.
10853 @findex gnus-article-hide-boring-headers
10854 @vindex gnus-boring-article-headers
10855 You can hide further boring headers by setting
10856 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
10857 does depends on the @code{gnus-boring-article-headers} variable. It's a
10858 list, but this list doesn't actually contain header names. Instead it
10859 lists various @dfn{boring conditions} that Gnus can check and remove
10862 These conditions are:
10865 Remove all empty headers.
10867 Remove the @code{Followup-To} header if it is identical to the
10868 @code{Newsgroups} header.
10870 Remove the @code{Reply-To} header if it lists the same addresses as
10871 the @code{From} header, or if the @code{broken-reply-to} group
10874 Remove the @code{Newsgroups} header if it only contains the current group
10877 Remove the @code{To} header if it only contains the address identical to
10878 the current group's @code{to-address} parameter.
10880 Remove the @code{To} header if it only contains the address identical to
10881 the current group's @code{to-list} parameter.
10883 Remove the @code{CC} header if it only contains the address identical to
10884 the current group's @code{to-list} parameter.
10886 Remove the @code{Date} header if the article is less than three days
10889 Remove the @code{To} header if it is very long.
10891 Remove all @code{To} headers if there are more than one.
10894 To include these three elements, you could say something like:
10897 (setq gnus-boring-article-headers
10898 '(empty followup-to reply-to))
10901 This is also the default value for this variable.
10905 @section Using MIME
10906 @cindex @acronym{MIME}
10908 Mime is a standard for waving your hands through the air, aimlessly,
10909 while people stand around yawning.
10911 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
10912 while all newsreaders die of fear.
10914 @acronym{MIME} may specify what character set the article uses, the encoding
10915 of the characters, and it also makes it possible to embed pictures and
10916 other naughty stuff in innocent-looking articles.
10918 @vindex gnus-show-mime
10919 @vindex gnus-article-display-method-for-mime
10920 @findex gnus-article-display-mime-message
10921 gnus handles @acronym{MIME} by pushing the articles through
10922 @code{gnus-article-display-method-for-mime}, which is
10923 @code{gnus-article-display-mime-message} by default. This function
10924 calls the @acronym{SEMI} MIME-View program to actually do the work. For
10925 more information on @acronym{SEMI} MIME-View, see its manual page
10926 (however it is not existed yet, sorry).
10928 Set @code{gnus-show-mime} to @code{t} if you want to use
10929 @acronym{MIME} all the time. If you have @code{gnus-show-mime} set,
10930 then you'll see some unfortunate display glitches in the article buffer.
10931 These can't be avoided.
10933 In GNUS or Gnus, it might be best to just use the toggling functions
10934 from the summary buffer to avoid getting nasty surprises. (For instance,
10935 you enter the group @samp{alt.sing-a-long} and, before you know it,
10936 @acronym{MIME} has decoded the sound file in the article and some
10937 horrible sing-a-long song comes screaming out your speakers, and you
10938 can't find the volume button, because there isn't one, and people are
10939 starting to look at you, and you try to stop the program, but you can't,
10940 and you can't find the program to control the volume, and everybody else
10941 in the room suddenly decides to look at you disdainfully, and you'll
10942 feel rather stupid.)
10944 Any similarity to real events and people is purely coincidental. Ahem.
10946 To avoid such kind of situation, gnus stops to use
10947 @code{metamail-buffer}. So now, you can set @code{gnus-show-mime} to
10948 non-@code{nil} every-time, then you can push button in the article
10949 buffer when there are nobody else.
10951 Also @pxref{MIME Commands}.
10954 @node Customizing Articles
10955 @section Customizing Articles
10956 @cindex article customization
10958 A slew of functions for customizing how the articles are to look like
10959 exist. You can call these functions interactively
10960 (@pxref{Article Washing}), or you can have them
10961 called automatically when you select the articles.
10963 To have them called automatically, you should set the corresponding
10964 ``treatment'' variable. For instance, to have headers hidden, you'd set
10965 @code{gnus-treat-hide-headers}. Below is a list of variables that can
10966 be set, but first we discuss the values these variables can have.
10968 Note: Some values, while valid, make little sense. Check the list below
10969 for sensible values.
10973 @code{nil}: Don't do this treatment.
10976 @code{t}: Do this treatment on all body parts.
10979 @code{head}: Do the treatment on the headers.
10982 @code{last}: Do this treatment on the last part.
10985 An integer: Do this treatment on all body parts that have a length less
10989 A list of strings: Do this treatment on all body parts that are in
10990 articles that are read in groups that have names that match one of the
10991 regexps in the list.
10994 A list where the first element is not a string:
10996 The list is evaluated recursively. The first element of the list is a
10997 predicate. The following predicates are recognized: @code{or},
10998 @code{and}, @code{not} and @code{typep}. Here's an example:
11002 (typep "text/x-vcard"))
11006 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
11011 You may have noticed that the word @dfn{part} is used here. This refers
11012 to the fact that some messages are @acronym{MIME} multipart articles that may
11013 be divided into several parts. Articles that are not multiparts are
11014 considered to contain just a single part.
11016 @vindex gnus-article-treat-types
11017 Are the treatments applied to all sorts of multipart parts? Yes, if you
11018 want to, but by default, only @samp{text/plain} parts are given the
11019 treatment. This is controlled by the @code{gnus-article-treat-types}
11020 variable, which is a list of regular expressions that are matched to the
11021 type of the part. This variable is ignored if the value of the
11022 controlling variable is a predicate list, as described above.
11024 The following treatment options are available. The easiest way to
11025 customize this is to examine the @code{gnus-article-treat} customization
11026 group. Values in parenthesis are suggested sensible values. Others are
11027 possible but those listed are probably sufficient for most people.
11030 @item gnus-treat-buttonize (t, integer)
11031 @item gnus-treat-buttonize-head (head)
11033 @xref{Article Buttons}.
11035 @item gnus-treat-capitalize-sentences (t, integer)
11036 @item gnus-treat-overstrike (t, integer)
11037 @item gnus-treat-strip-cr (t, integer)
11038 @item gnus-treat-strip-headers-in-body (t, integer)
11039 @item gnus-treat-strip-leading-blank-lines (t, integer)
11040 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11041 @item gnus-treat-strip-pem (t, last, integer)
11042 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11043 @item gnus-treat-unsplit-urls (t, integer)
11044 @item gnus-treat-wash-html (t, integer)
11045 @item gnus-treat-decode-article-as-default-mime-charset (t, integer)
11047 @xref{Article Washing}.
11049 @item gnus-treat-date-english (head)
11050 @item gnus-treat-date-iso8601 (head)
11051 @item gnus-treat-date-lapsed (head)
11052 @item gnus-treat-date-local (head)
11053 @item gnus-treat-date-original (head)
11054 @item gnus-treat-date-user-defined (head)
11055 @item gnus-treat-date-ut (head)
11057 @xref{Article Date}.
11059 @item gnus-treat-from-picon (head)
11060 @item gnus-treat-mail-picon (head)
11061 @item gnus-treat-newsgroups-picon (head)
11065 @item gnus-treat-display-smileys (t, integer)
11067 @item gnus-treat-body-boundary (head)
11069 @vindex gnus-body-boundary-delimiter
11070 Adds a delimiter between header and body, the string used as delimiter
11071 is controlled by @code{gnus-body-boundary-delimiter}.
11075 @item gnus-treat-display-x-face (head)
11079 @item gnus-treat-display-face (head)
11083 @item gnus-treat-emphasize (t, head, integer)
11084 @item gnus-treat-fill-article (t, integer)
11085 @item gnus-treat-fill-long-lines (t, integer)
11086 @item gnus-treat-hide-boring-headers (head)
11087 @item gnus-treat-hide-citation (t, integer)
11088 @item gnus-treat-hide-citation-maybe (t, integer)
11089 @item gnus-treat-hide-headers (head)
11090 @item gnus-treat-hide-signature (t, last)
11091 @item gnus-treat-strip-banner (t, last)
11092 @item gnus-treat-strip-list-identifiers (head)
11094 @xref{Article Hiding}.
11096 @item gnus-treat-highlight-citation (t, integer)
11097 @item gnus-treat-highlight-headers (head)
11098 @item gnus-treat-highlight-signature (t, last, integer)
11100 @xref{Article Highlighting}.
11102 @item gnus-treat-play-sounds
11103 @item gnus-treat-translate
11104 @item gnus-treat-ansi-sequences (t)
11105 @item gnus-treat-x-pgp-sig (head)
11107 @item gnus-treat-unfold-headers (head)
11108 @item gnus-treat-fold-headers (head)
11109 @item gnus-treat-fold-newsgroups (head)
11110 @item gnus-treat-leading-whitespace (head)
11112 @xref{Article Header}.
11117 @vindex gnus-part-display-hook
11118 You can, of course, write your own functions to be called from
11119 @code{gnus-part-display-hook}. The functions are called narrowed to the
11120 part, and you can do anything you like, pretty much. There is no
11121 information that you have to keep in the buffer---you can change
11125 @node Article Keymap
11126 @section Article Keymap
11128 Most of the keystrokes in the summary buffer can also be used in the
11129 article buffer. They should behave as if you typed them in the summary
11130 buffer, which means that you don't actually have to have a summary
11131 buffer displayed while reading. You can do it all from the article
11134 A few additional keystrokes are available:
11139 @kindex SPACE (Article)
11140 @findex gnus-article-next-page
11141 Scroll forwards one page (@code{gnus-article-next-page}).
11142 This is exactly the same as @kbd{h SPACE h}.
11145 @kindex DEL (Article)
11146 @findex gnus-article-prev-page
11147 Scroll backwards one page (@code{gnus-article-prev-page}).
11148 This is exactly the same as @kbd{h DEL h}.
11151 @kindex C-c ^ (Article)
11152 @findex gnus-article-refer-article
11153 If point is in the neighborhood of a @code{Message-ID} and you press
11154 @kbd{C-c ^}, Gnus will try to get that article from the server
11155 (@code{gnus-article-refer-article}).
11158 @kindex C-c C-m (Article)
11159 @findex gnus-article-mail
11160 Send a reply to the address near point (@code{gnus-article-mail}). If
11161 given a prefix, include the mail.
11164 @kindex s (Article)
11165 @findex gnus-article-show-summary
11166 Reconfigure the buffers so that the summary buffer becomes visible
11167 (@code{gnus-article-show-summary}).
11170 @kindex ? (Article)
11171 @findex gnus-article-describe-briefly
11172 Give a very brief description of the available keystrokes
11173 (@code{gnus-article-describe-briefly}).
11176 @kindex TAB (Article)
11177 @findex gnus-article-next-button
11178 Go to the next button, if any (@code{gnus-article-next-button}). This
11179 only makes sense if you have buttonizing turned on.
11182 @kindex M-TAB (Article)
11183 @findex gnus-article-prev-button
11184 Go to the previous button, if any (@code{gnus-article-prev-button}).
11187 @kindex R (Article)
11188 @findex gnus-article-reply-with-original
11189 Send a reply to the current article and yank the current article
11190 (@code{gnus-article-reply-with-original}). If given a prefix, make a
11191 wide reply. If the region is active, only yank the text in the
11195 @kindex F (Article)
11196 @findex gnus-article-followup-with-original
11197 Send a followup to the current article and yank the current article
11198 (@code{gnus-article-followup-with-original}). If given a prefix, make
11199 a wide reply. If the region is active, only yank the text in the
11207 @section Misc Article
11211 @item gnus-single-article-buffer
11212 @vindex gnus-single-article-buffer
11213 If non-@code{nil}, use the same article buffer for all the groups.
11214 (This is the default.) If @code{nil}, each group will have its own
11217 @vindex gnus-article-decode-hook
11218 @item gnus-article-decode-hook
11219 @cindex @acronym{MIME}
11220 Hook used to decode @acronym{MIME} articles. The default value is
11221 @code{(article-decode-charset article-decode-encoded-words)}
11223 @vindex gnus-article-prepare-hook
11224 @item gnus-article-prepare-hook
11225 This hook is called right after the article has been inserted into the
11226 article buffer. It is mainly intended for functions that do something
11227 depending on the contents; it should probably not be used for changing
11228 the contents of the article buffer.
11230 @item gnus-article-mode-hook
11231 @vindex gnus-article-mode-hook
11232 Hook called in article mode buffers.
11234 @item gnus-article-mode-syntax-table
11235 @vindex gnus-article-mode-syntax-table
11236 Syntax table used in article buffers. It is initialized from
11237 @code{text-mode-syntax-table}.
11239 @vindex gnus-article-over-scroll
11240 @item gnus-article-over-scroll
11241 If non-@code{nil}, allow scrolling the article buffer even when there
11242 no more new text to scroll in. The default is @code{nil}.
11244 @vindex gnus-article-mode-line-format
11245 @item gnus-article-mode-line-format
11246 This variable is a format string along the same lines as
11247 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
11248 Line}). It accepts the same format specifications as that variable,
11249 with two extensions:
11254 The @dfn{wash status} of the article. This is a short string with one
11255 character for each possible article wash operation that may have been
11256 performed. The characters and their meaning:
11261 Displayed when cited text may be hidden in the article buffer.
11264 Displayed when headers are hidden in the article buffer.
11267 Displayed when article is digitally signed or encrypted, and Gnus has
11268 hidden the security headers. (N.B. does not tell anything about
11269 security status, i.e. good or bad signature.)
11272 Displayed when the signature has been hidden in the Article buffer.
11275 Displayed when Gnus has treated overstrike characters in the article buffer.
11278 Displayed when Gnus has treated emphasised strings in the article buffer.
11283 The number of @acronym{MIME} parts in the article.
11287 @vindex gnus-break-pages
11289 @item gnus-break-pages
11290 Controls whether @dfn{page breaking} is to take place. If this variable
11291 is non-@code{nil}, the articles will be divided into pages whenever a
11292 page delimiter appears in the article. If this variable is @code{nil},
11293 paging will not be done.
11295 @item gnus-page-delimiter
11296 @vindex gnus-page-delimiter
11297 This is the delimiter mentioned above. By default, it is @samp{^L}
11301 @cindex internationalized domain names
11302 @vindex gnus-use-idna
11303 @item gnus-use-idna
11304 This variable controls whether Gnus performs IDNA decoding of
11305 internationalized domain names inside @samp{From}, @samp{To} and
11306 @samp{Cc} headers. This requires
11307 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
11308 variable is only enabled if you have installed it.
11313 @node Composing Messages
11314 @chapter Composing Messages
11315 @cindex composing messages
11318 @cindex sending mail
11323 @cindex using s/mime
11324 @cindex using smime
11326 @kindex C-c C-c (Post)
11327 All commands for posting and mailing will put you in a message buffer
11328 where you can edit the article all you like, before you send the
11329 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
11330 Message Manual}. Where the message will be posted/mailed to depends
11331 on your setup (@pxref{Posting Server}).
11334 * Mail:: Mailing and replying.
11335 * Posting Server:: What server should you post and mail via?
11336 * POP before SMTP:: You cannot send a mail unless you read a mail.
11337 * Mail and Post:: Mailing and posting at the same time.
11338 * Archived Messages:: Where Gnus stores the messages you've sent.
11339 * Posting Styles:: An easier way to specify who you are.
11340 * Drafts:: Postponing messages and rejected messages.
11341 * Rejected Articles:: What happens if the server doesn't like your article?
11342 * Signing and encrypting:: How to compose secure messages.
11345 Also @pxref{Canceling and Superseding} for information on how to
11346 remove articles you shouldn't have posted.
11352 Variables for customizing outgoing mail:
11355 @item gnus-uu-digest-headers
11356 @vindex gnus-uu-digest-headers
11357 List of regexps to match headers included in digested messages. The
11358 headers will be included in the sequence they are matched. If
11359 @code{nil} include all headers.
11361 @item gnus-add-to-list
11362 @vindex gnus-add-to-list
11363 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11364 that have none when you do a @kbd{a}.
11366 @item gnus-confirm-mail-reply-to-news
11367 @vindex gnus-confirm-mail-reply-to-news
11368 This can also be a function receiving the group name as the only
11369 parameter which should return non-@code{nil} if a confirmation is
11370 needed, or a regular expression matching group names, where
11371 confirmation is should be asked for.
11373 If you find yourself never wanting to reply to mail, but occasionally
11374 press R anyway, this variable might be for you.
11376 @item gnus-confirm-treat-mail-like-news
11377 @vindex gnus-confirm-treat-mail-like-news
11378 If non-@code{nil}, Gnus also requests confirmation according to
11379 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
11380 useful for treating mailing lists like newsgroups.
11385 @node Posting Server
11386 @section Posting Server
11388 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11389 (extremely intelligent, of course) article, where does it go?
11391 Thank you for asking. I hate you.
11393 It can be quite complicated.
11395 @vindex gnus-post-method
11396 When posting news, Message usually invokes @code{message-send-news}
11397 (@pxref{News Variables, , News Variables, message, Message Manual}).
11398 Normally, Gnus will post using the same select method as you're
11399 reading from (which might be convenient if you're reading lots of
11400 groups from different private servers). However. If the server
11401 you're reading from doesn't allow posting, just reading, you probably
11402 want to use some other server to post your (extremely intelligent and
11403 fabulously interesting) articles. You can then set the
11404 @code{gnus-post-method} to some other method:
11407 (setq gnus-post-method '(nnspool ""))
11410 Now, if you've done this, and then this server rejects your article, or
11411 this server is down, what do you do then? To override this variable you
11412 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11413 the ``current'' server, to get back the default behavior, for posting.
11415 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11416 gnus will prompt you for what method to use for posting.
11418 You can also set @code{gnus-post-method} to a list of select methods.
11419 If that's the case, gnus will always prompt you for what method to use
11422 Finally, if you want to always post using the native select method,
11423 you can set this variable to @code{native}.
11425 When sending mail, Message invokes @code{message-send-mail-function}.
11426 The default function, @code{message-send-mail-with-sendmail}, pipes
11427 your article to the @code{sendmail} binary for further queuing and
11428 sending. When your local system is not configured for sending mail
11429 using @code{sendmail}, and you have access to a remote @acronym{SMTP}
11430 server, you can set @code{message-send-mail-function} to
11431 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11432 package correctly. An example:
11435 (setq message-send-mail-function 'smtpmail-send-it
11436 smtpmail-default-smtp-server "YOUR SMTP HOST")
11437 ;; @r{The following variable needs to be set if you are using smtpmail.el}
11438 ;; @r{distributed with FLIM, lesser than the version 1.14.6.}
11439 (setq smtp-default-server "YOUR SMTP HOST")
11442 To the thing similar to this, there is
11443 @code{message-smtpmail-send-it}. It is useful if your @acronym{ISP}
11444 requires the @acronym{POP}-before-@acronym{SMTP} authentication.
11445 @xref{POP before SMTP}.
11447 Other possible choices for @code{message-send-mail-function} includes
11448 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11449 and @code{feedmail-send-it}.
11451 @node POP before SMTP
11452 @section POP before SMTP
11453 @cindex pop before smtp
11454 @findex message-smtpmail-send-it
11455 @findex mail-source-touch-pop
11457 Does your @acronym{ISP} require the @acronym{POP}-before-@acronym{SMTP}
11458 authentication? It is whether you need to connect to the @acronym{POP}
11459 mail server within a certain time before sending mails. If so, there is
11460 a convenient way. To do that, put the following lines in your
11461 @file{~/.gnus.el} file:
11464 (setq message-send-mail-function 'message-smtpmail-send-it)
11465 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
11469 It means to let Gnus connect to the @acronym{POP} mail server in advance
11470 whenever you send a mail. The @code{mail-source-touch-pop} function
11471 does only a @acronym{POP} authentication according to the value of
11472 @code{mail-sources} without fetching mails, just before sending a mail.
11473 Note that you have to use @code{message-smtpmail-send-it} which runs
11474 @code{message-send-mail-hook} rather than @code{smtpmail-send-it} and
11475 set the value of @code{mail-sources} for a @acronym{POP} connection
11476 correctly. @xref{Mail Sources}.
11478 If you have two or more @acronym{POP} mail servers set in
11479 @code{mail-sources}, you may want to specify one of them to
11480 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
11481 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
11482 is your primary @acronym{POP} mail server (i.e., you are fetching mails
11483 mainly from that server), you can set it permanently as follows:
11486 (setq mail-source-primary-source
11487 '(pop :server "pop3.mail.server"
11488 :password "secret"))
11492 Otherwise, bind it dynamically only when performing the
11493 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
11496 (add-hook 'message-send-mail-hook
11498 (let ((mail-source-primary-source
11499 '(pop :server "pop3.mail.server"
11500 :password "secret")))
11501 (mail-source-touch-pop))))
11504 @node Mail and Post
11505 @section Mail and Post
11507 Here's a list of variables relevant to both mailing and
11511 @item gnus-mailing-list-groups
11512 @findex gnus-mailing-list-groups
11513 @cindex mailing lists
11515 If your news server offers groups that are really mailing lists
11516 gatewayed to the @acronym{NNTP} server, you can read those groups without
11517 problems, but you can't post/followup to them without some difficulty.
11518 One solution is to add a @code{to-address} to the group parameters
11519 (@pxref{Group Parameters}). An easier thing to do is set the
11520 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
11521 really are mailing lists. Then, at least, followups to the mailing
11522 lists will work most of the time. Posting to these groups (@kbd{a}) is
11523 still a pain, though.
11525 @item gnus-user-agent
11526 @vindex gnus-user-agent
11529 This variable controls which information should be exposed in the
11530 User-Agent header. It can be one of the symbols @code{gnus} (show only
11531 Gnus version), @code{emacs-gnus} (show only Emacs and Gnus versions),
11532 @code{emacs-gnus-config} (same as @code{emacs-gnus} plus system
11533 configuration), @code{emacs-gnus-type} (same as @code{emacs-gnus} plus
11534 system type) or a custom string. If you set it to a string, be sure to
11535 use a valid format, see RFC 2616.
11539 You may want to do spell-checking on messages that you send out. Or, if
11540 you don't want to spell-check by hand, you could add automatic
11541 spell-checking via the @code{ispell} package:
11544 @findex ispell-message
11546 (add-hook 'message-send-hook 'ispell-message)
11549 If you want to change the @code{ispell} dictionary based on what group
11550 you're in, you could say something like the following:
11553 (add-hook 'gnus-select-group-hook
11557 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
11558 (ispell-change-dictionary "deutsch"))
11560 (ispell-change-dictionary "english")))))
11563 Modify to suit your needs.
11566 @node Archived Messages
11567 @section Archived Messages
11568 @cindex archived messages
11569 @cindex sent messages
11571 Gnus provides a few different methods for storing the mail and news you
11572 send. The default method is to use the @dfn{archive virtual server} to
11573 store the messages. If you want to disable this completely, the
11574 @code{gnus-message-archive-group} variable should be @code{nil}, which
11577 For archiving interesting messages in a group you read, see the
11578 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
11581 @vindex gnus-message-archive-method
11582 @code{gnus-message-archive-method} says what virtual server gnus is to
11583 use to store sent messages. The default is:
11586 (nnfolder "archive"
11587 (nnfolder-directory "~/Mail/archive")
11588 (nnfolder-active-file "~/Mail/archive/active")
11589 (nnfolder-get-new-mail nil)
11590 (nnfolder-inhibit-expiry t))
11593 You can, however, use any mail select method (@code{nnml},
11594 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
11595 for doing this sort of thing, though. If you don't like the default
11596 directory chosen, you could say something like:
11599 (setq gnus-message-archive-method
11600 '(nnfolder "archive"
11601 (nnfolder-inhibit-expiry t)
11602 (nnfolder-active-file "~/News/sent-mail/active")
11603 (nnfolder-directory "~/News/sent-mail/")))
11606 @vindex gnus-message-archive-group
11608 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11609 to one or more group(s) on that server. Which group to use is
11610 determined by the @code{gnus-message-archive-group} variable.
11612 This variable can be used to do the following:
11616 Messages will be saved in that group.
11618 Note that you can include a select method in the group name, then the
11619 message will not be stored in the select method given by
11620 @code{gnus-message-archive-method}, but in the select method specified
11621 by the group name, instead. Suppose @code{gnus-message-archive-method}
11622 has the default value shown above. Then setting
11623 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11624 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11625 value @code{"nnml:foo"}, then outgoing messages will be stored in
11628 @item a list of strings
11629 Messages will be saved in all those groups.
11631 @item an alist of regexps, functions and forms
11632 When a key ``matches'', the result is used.
11635 No message archiving will take place. This is the default.
11640 Just saving to a single group called @samp{MisK}:
11642 (setq gnus-message-archive-group "MisK")
11645 Saving to two groups, @samp{MisK} and @samp{safe}:
11647 (setq gnus-message-archive-group '("MisK" "safe"))
11650 Save to different groups based on what group you are in:
11652 (setq gnus-message-archive-group
11653 '(("^alt" "sent-to-alt")
11654 ("mail" "sent-to-mail")
11655 (".*" "sent-to-misc")))
11658 More complex stuff:
11660 (setq gnus-message-archive-group
11661 '((if (message-news-p)
11666 How about storing all news messages in one file, but storing all mail
11667 messages in one file per month:
11670 (setq gnus-message-archive-group
11671 '((if (message-news-p)
11673 (concat "mail." (format-time-string "%Y-%m")))))
11676 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11677 @c use a different value for @code{gnus-message-archive-group} there.)
11679 Now, when you send a message off, it will be stored in the appropriate
11680 group. (If you want to disable storing for just one particular message,
11681 you can just remove the @code{Gcc} header that has been inserted.) The
11682 archive group will appear in the group buffer the next time you start
11683 gnus, or the next time you press @kbd{F} in the group buffer. You can
11684 enter it and read the articles in it just like you'd read any other
11685 group. If the group gets really big and annoying, you can simply rename
11686 if (using @kbd{G r} in the group buffer) to something
11687 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
11688 continue to be stored in the old (now empty) group.
11690 That's the default method of archiving sent messages. Gnus offers a
11691 different way for the people who don't like the default method. In that
11692 case you should set @code{gnus-message-archive-group} to @code{nil};
11693 this will disable archiving.
11696 @item gnus-outgoing-message-group
11697 @vindex gnus-outgoing-message-group
11698 All outgoing messages will be put in this group. If you want to store
11699 all your outgoing mail and articles in the group @samp{nnml:archive},
11700 you set this variable to that value. This variable can also be a list of
11703 If you want to have greater control over what group to put each
11704 message in, you can set this variable to a function that checks the
11705 current newsgroup name and then returns a suitable group name (or list
11708 This variable can be used instead of @code{gnus-message-archive-group},
11709 but the latter is the preferred method.
11711 @item gnus-gcc-mark-as-read
11712 @vindex gnus-gcc-mark-as-read
11713 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11715 @item gnus-gcc-externalize-attachments
11716 @vindex gnus-gcc-externalize-attachments
11717 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11718 and matches the Gcc group name, attach files as external parts; if it is
11719 @code{all}, attach local files as external parts; if it is other
11720 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11721 changed in the future.
11726 @node Posting Styles
11727 @section Posting Styles
11728 @cindex posting styles
11731 All them variables, they make my head swim.
11733 So what if you want a different @code{Organization} and signature based
11734 on what groups you post to? And you post both from your home machine
11735 and your work machine, and you want different @code{From} lines, and so
11738 @vindex gnus-posting-styles
11739 One way to do stuff like that is to write clever hooks that change the
11740 variables you need to have changed. That's a bit boring, so somebody
11741 came up with the bright idea of letting the user specify these things in
11742 a handy alist. Here's an example of a @code{gnus-posting-styles}
11747 (signature "Peace and happiness")
11748 (organization "What me?"))
11750 (signature "Death to everybody"))
11751 ("comp.emacs.i-love-it"
11752 (organization "Emacs is it")))
11755 As you might surmise from this example, this alist consists of several
11756 @dfn{styles}. Each style will be applicable if the first element
11757 ``matches'', in some form or other. The entire alist will be iterated
11758 over, from the beginning towards the end, and each match will be
11759 applied, which means that attributes in later styles that match override
11760 the same attributes in earlier matching styles. So
11761 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11762 signature and the @samp{What me?} @code{Organization} header.
11764 The first element in each style is called the @code{match}. If it's a
11765 string, then Gnus will try to regexp match it against the group name.
11766 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
11767 will look in the original article for a header whose name is
11768 @var{match} and compare that @var{regexp}. @var{match} and
11769 @var{regexp} are strings. (The original article is the one you are
11770 replying or following up to. If you are not composing a reply or a
11771 followup, then there is nothing to match against.) If the
11772 @code{match} is a function symbol, that function will be called with
11773 no arguments. If it's a variable symbol, then the variable will be
11774 referenced. If it's a list, then that list will be @code{eval}ed. In
11775 any case, if this returns a non-@code{nil} value, then the style is
11776 said to @dfn{match}.
11778 Each style may contain an arbitrary amount of @dfn{attributes}. Each
11779 attribute consists of a @code{(@var{name} @var{value})} pair. In
11780 addition, you can also use the @code{(@var{name} :file @var{value})}
11781 form or the @code{(@var{name} :value @var{value})} form. Where
11782 @code{:file} signifies @var{value} represents a file name and its
11783 contents should be used as the attribute value, @code{:value} signifies
11784 @var{value} does not represent a file name explicitly. The attribute
11785 name can be one of:
11788 @item @code{signature}
11789 @item @code{signature-file}
11790 @item @code{x-face-file}
11791 @item @code{address}, overriding @code{user-mail-address}
11792 @item @code{name}, overriding @code{(user-full-name)}
11796 The attribute name can also be a string or a symbol. In that case,
11797 this will be used as a header name, and the value will be inserted in
11798 the headers of the article; if the value is @code{nil}, the header
11799 name will be removed. If the attribute name is @code{eval}, the form
11800 is evaluated, and the result is thrown away.
11802 The attribute value can be a string (used verbatim), a function with
11803 zero arguments (the return value will be used), a variable (its value
11804 will be used) or a list (it will be @code{eval}ed and the return value
11805 will be used). The functions and sexps are called/@code{eval}ed in the
11806 message buffer that is being set up. The headers of the current article
11807 are available through the @code{message-reply-headers} variable, which
11808 is a vector of the following headers: number subject from date id
11809 references chars lines xref extra.
11811 @vindex message-reply-headers
11813 If you wish to check whether the message you are about to compose is
11814 meant to be a news article or a mail message, you can check the values
11815 of the @code{message-news-p} and @code{message-mail-p} functions.
11817 @findex message-mail-p
11818 @findex message-news-p
11820 So here's a new example:
11823 (setq gnus-posting-styles
11825 (signature-file "~/.signature")
11827 ("X-Home-Page" (getenv "WWW_HOME"))
11828 (organization "People's Front Against MWM"))
11830 (signature my-funny-signature-randomizer))
11831 ((equal (system-name) "gnarly") ;; @r{A form}
11832 (signature my-quote-randomizer))
11833 (message-news-p ;; @r{A function symbol}
11834 (signature my-news-signature))
11835 (window-system ;; @r{A value symbol}
11836 ("X-Window-System" (format "%s" window-system)))
11837 ;; @r{If I'm replying to Larsi, set the Organization header.}
11838 ((header "from" "larsi.*org")
11839 (Organization "Somewhere, Inc."))
11840 ((posting-from-work-p) ;; @r{A user defined function}
11841 (signature-file "~/.work-signature")
11842 (address "user@@bar.foo")
11843 (body "You are fired.\n\nSincerely, your boss.")
11844 (organization "Important Work, Inc"))
11846 (From (save-excursion
11847 (set-buffer gnus-article-buffer)
11848 (message-fetch-field "to"))))
11850 (signature-file "~/.mail-signature"))))
11853 The @samp{nnml:.*} rule means that you use the @code{To} address as the
11854 @code{From} address in all your outgoing replies, which might be handy
11855 if you fill many roles.
11857 Setting the @code{gnus-named-posting-styles} variable will make
11858 posting-styles allow to have distinctive names. You can specify an
11859 arbitrary posting-style when article posting with @kbd{S P} in the
11860 summary buffer. @code{gnus-named-posting-styles} is an alist which maps
11861 the names to styles. Once a posting-style is added to the alist, we can
11862 import it from @code{gnus-posting-styles}. If an attribute whose name
11863 is @code{import} is found, Gnus will look for the attribute value in
11864 @code{gnus-named-posting-styles} and expand it in place.
11869 (setq gnus-named-posting-styles
11871 (signature-file "~/.signature")
11873 ("X-Home-Page" (getenv "WWW_HOME"))
11874 (organization "People's Front Against MWM"))
11877 (organization "The Church of Emacs"))))
11880 The posting-style named "Emacs" will inherit all the attributes from
11881 "Default" except @code{organization}.
11888 If you are writing a message (mail or news) and suddenly remember that
11889 you have a steak in the oven (or some pesto in the food processor, you
11890 craaazy vegetarians), you'll probably wish there was a method to save
11891 the message you are writing so that you can continue editing it some
11892 other day, and send it when you feel its finished.
11894 Well, don't worry about it. Whenever you start composing a message of
11895 some sort using the gnus mail and post commands, the buffer you get will
11896 automatically associate to an article in a special @dfn{draft} group.
11897 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
11898 article will be saved there. (Auto-save files also go to the draft
11902 @vindex nndraft-directory
11903 The draft group is a special group (which is implemented as an
11904 @code{nndraft} group, if you absolutely have to know) called
11905 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
11906 @code{nndraft} is to store its files. What makes this group special is
11907 that you can't tick any articles in it or mark any articles as
11908 read---all articles in the group are permanently unread.
11910 If the group doesn't exist, it will be created and you'll be subscribed
11911 to it. The only way to make it disappear from the Group buffer is to
11912 unsubscribe it. The special properties of the draft group comes from
11913 a group property (@pxref{Group Parameters}), and if lost the group
11914 behaves like any other group. This means the commands below will not
11915 be available. To restore the special properties of the group, the
11916 simplest way is to kill the group, using @kbd{C-k}, and restart
11917 Gnus. The group is automatically created again with the
11918 correct parameters. The content of the group is not lost.
11920 @c @findex gnus-dissociate-buffer-from-draft
11921 @c @kindex C-c M-d (Mail)
11922 @c @kindex C-c M-d (Post)
11923 @c @findex gnus-associate-buffer-with-draft
11924 @c @kindex C-c C-d (Mail)
11925 @c @kindex C-c C-d (Post)
11926 @c If you're writing some super-secret message that you later want to
11927 @c encode with PGP before sending, you may wish to turn the auto-saving
11928 @c (and association with the draft group) off. You never know who might be
11929 @c interested in reading all your extremely valuable and terribly horrible
11930 @c and interesting secrets. The @kbd{C-c M-d}
11931 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
11932 @c If you change your mind and want to turn the auto-saving back on again,
11933 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
11935 @c @vindex gnus-use-draft
11936 @c To leave association with the draft group off by default, set
11937 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
11939 @findex gnus-draft-edit-message
11940 @kindex D e (Draft)
11941 When you want to continue editing the article, you simply enter the
11942 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
11943 that. You will be placed in a buffer where you left off.
11945 Rejected articles will also be put in this draft group (@pxref{Rejected
11948 @findex gnus-draft-send-all-messages
11949 @kindex D s (Draft)
11950 @findex gnus-draft-send-message
11951 @kindex D S (Draft)
11952 If you have lots of rejected messages you want to post (or mail) without
11953 doing further editing, you can use the @kbd{D s} command
11954 (@code{gnus-draft-send-message}). This command understands the
11955 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
11956 command (@code{gnus-draft-send-all-messages}) will ship off all messages
11959 @findex gnus-draft-toggle-sending
11960 @kindex D t (Draft)
11961 If you have some messages that you wish not to send, you can use the
11962 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
11963 as unsendable. This is a toggling command.
11966 @node Rejected Articles
11967 @section Rejected Articles
11968 @cindex rejected articles
11970 Sometimes a news server will reject an article. Perhaps the server
11971 doesn't like your face. Perhaps it just feels miserable. Perhaps
11972 @emph{there be demons}. Perhaps you have included too much cited text.
11973 Perhaps the disk is full. Perhaps the server is down.
11975 These situations are, of course, totally beyond the control of gnus.
11976 (Gnus, of course, loves the way you look, always feels great, has angels
11977 fluttering around inside of it, doesn't care about how much cited text
11978 you include, never runs full and never goes down.) So gnus saves these
11979 articles until some later time when the server feels better.
11981 The rejected articles will automatically be put in a special draft group
11982 (@pxref{Drafts}). When the server comes back up again, you'd then
11983 typically enter that group and send all the articles off.
11985 @node Signing and encrypting
11986 @section Signing and encrypting
11988 @cindex using s/mime
11989 @cindex using smime
11991 Gnus can digitally sign and encrypt your messages, using vanilla
11992 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
11993 decoding such messages, see the @code{mm-verify-option} and
11994 @code{mm-decrypt-option} options (@pxref{Security}).
11996 @vindex gnus-message-replysign
11997 @vindex gnus-message-replyencrypt
11998 @vindex gnus-message-replysignencrypted
11999 Often, you would like to sign replies to people who send you signed
12000 messages. Even more often, you might want to encrypt messages which
12001 are in reply to encrypted messages. Gnus offers
12002 @code{gnus-message-replysign} to enable the former, and
12003 @code{gnus-message-replyencrypt} for the latter. In addition, setting
12004 @code{gnus-message-replysignencrypted} (on by default) will sign
12005 automatically encrypted messages.
12007 Instructing @acronym{MML} to perform security operations on a
12008 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
12009 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
12014 @kindex C-c C-m s s (Message)
12015 @findex mml-secure-message-sign-smime
12017 Digitally sign current message using @acronym{S/MIME}.
12020 @kindex C-c C-m s o (Message)
12021 @findex mml-secure-message-sign-pgp
12023 Digitally sign current message using @acronym{PGP}.
12026 @kindex C-c C-m s p (Message)
12027 @findex mml-secure-message-sign-pgp
12029 Digitally sign current message using @acronym{PGP/MIME}.
12032 @kindex C-c C-m c s (Message)
12033 @findex mml-secure-message-encrypt-smime
12035 Digitally encrypt current message using @acronym{S/MIME}.
12038 @kindex C-c C-m c o (Message)
12039 @findex mml-secure-message-encrypt-pgp
12041 Digitally encrypt current message using @acronym{PGP}.
12044 @kindex C-c C-m c p (Message)
12045 @findex mml-secure-message-encrypt-pgpmime
12047 Digitally encrypt current message using @acronym{PGP/MIME}.
12050 @kindex C-c C-m C-n (Message)
12051 @findex mml-unsecure-message
12052 Remove security related @acronym{MML} tags from message.
12056 @xref{Security, ,Security, message, Message Manual}, for more information.
12058 @node Select Methods
12059 @chapter Select Methods
12060 @cindex foreign groups
12061 @cindex select methods
12063 A @dfn{foreign group} is a group not read by the usual (or
12064 default) means. It could be, for instance, a group from a different
12065 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12066 personal mail group.
12068 A foreign group (or any group, really) is specified by a @dfn{name} and
12069 a @dfn{select method}. To take the latter first, a select method is a
12070 list where the first element says what back end to use (e.g. @code{nntp},
12071 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12072 name}. There may be additional elements in the select method, where the
12073 value may have special meaning for the back end in question.
12075 One could say that a select method defines a @dfn{virtual server}---so
12076 we do just that (@pxref{Server Buffer}).
12078 The @dfn{name} of the group is the name the back end will recognize the
12081 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12082 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12083 method @code{(nntp "some.where.edu")}. Gnus will call this group
12084 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12085 back end just knows this group as @samp{soc.motss}.
12087 The different methods all have their peculiarities, of course.
12090 * Server Buffer:: Making and editing virtual servers.
12091 * Getting News:: Reading USENET news with Gnus.
12092 * Getting Mail:: Reading your personal mail with Gnus.
12093 * Browsing the Web:: Getting messages from a plethora of Web sources.
12094 * IMAP:: Using Gnus as a @acronym{IMAP} client.
12095 * Other Sources:: Reading directories, files, SOUP packets.
12096 * Combined Groups:: Combining groups into one group.
12097 * Gnus Unplugged:: Reading news and mail offline.
12101 @node Server Buffer
12102 @section Server Buffer
12104 Traditionally, a @dfn{server} is a machine or a piece of software that
12105 one connects to, and then requests information from. Gnus does not
12106 connect directly to any real servers, but does all transactions through
12107 one back end or other. But that's just putting one layer more between
12108 the actual media and Gnus, so we might just as well say that each
12109 back end represents a virtual server.
12111 For instance, the @code{nntp} back end may be used to connect to several
12112 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12113 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12114 use, and what parameters to set by specifying a @dfn{select method}.
12116 These select method specifications can sometimes become quite
12117 complicated---say, for instance, that you want to read from the
12118 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12119 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12120 Anyway, if you had to specify that for each group that used this
12121 server, that would be too much work, so Gnus offers a way of naming
12122 select methods, which is what you do in the server buffer.
12124 To enter the server buffer, use the @kbd{^}
12125 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12128 * Server Buffer Format:: You can customize the look of this buffer.
12129 * Server Commands:: Commands to manipulate servers.
12130 * Example Methods:: Examples server specifications.
12131 * Creating a Virtual Server:: An example session.
12132 * Server Variables:: Which variables to set.
12133 * Servers and Methods:: You can use server names as select methods.
12134 * Unavailable Servers:: Some servers you try to contact may be down.
12137 @vindex gnus-server-mode-hook
12138 @code{gnus-server-mode-hook} is run when creating the server buffer.
12141 @node Server Buffer Format
12142 @subsection Server Buffer Format
12143 @cindex server buffer format
12145 @vindex gnus-server-line-format
12146 You can change the look of the server buffer lines by changing the
12147 @code{gnus-server-line-format} variable. This is a @code{format}-like
12148 variable, with some simple extensions:
12153 How the news is fetched---the back end name.
12156 The name of this server.
12159 Where the news is to be fetched from---the address.
12162 The opened/closed/denied status of the server.
12165 @vindex gnus-server-mode-line-format
12166 The mode line can also be customized by using the
12167 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12168 Formatting}). The following specs are understood:
12178 Also @pxref{Formatting Variables}.
12181 @node Server Commands
12182 @subsection Server Commands
12183 @cindex server commands
12189 @findex gnus-server-add-server
12190 Add a new server (@code{gnus-server-add-server}).
12194 @findex gnus-server-edit-server
12195 Edit a server (@code{gnus-server-edit-server}).
12198 @kindex SPACE (Server)
12199 @findex gnus-server-read-server
12200 Browse the current server (@code{gnus-server-read-server}).
12204 @findex gnus-server-exit
12205 Return to the group buffer (@code{gnus-server-exit}).
12209 @findex gnus-server-kill-server
12210 Kill the current server (@code{gnus-server-kill-server}).
12214 @findex gnus-server-yank-server
12215 Yank the previously killed server (@code{gnus-server-yank-server}).
12219 @findex gnus-server-copy-server
12220 Copy the current server (@code{gnus-server-copy-server}).
12224 @findex gnus-server-list-servers
12225 List all servers (@code{gnus-server-list-servers}).
12229 @findex gnus-server-scan-server
12230 Request that the server scan its sources for new articles
12231 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12236 @findex gnus-server-regenerate-server
12237 Request that the server regenerate all its data structures
12238 (@code{gnus-server-regenerate-server}). This can be useful if you have
12239 a mail back end that has gotten out of sync.
12244 @node Example Methods
12245 @subsection Example Methods
12247 Most select methods are pretty simple and self-explanatory:
12250 (nntp "news.funet.fi")
12253 Reading directly from the spool is even simpler:
12259 As you can see, the first element in a select method is the name of the
12260 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12263 After these two elements, there may be an arbitrary number of
12264 @code{(@var{variable} @var{form})} pairs.
12266 To go back to the first example---imagine that you want to read from
12267 port 15 on that machine. This is what the select method should
12271 (nntp "news.funet.fi" (nntp-port-number 15))
12274 You should read the documentation to each back end to find out what
12275 variables are relevant, but here's an @code{nnmh} example:
12277 @code{nnmh} is a mail back end that reads a spool-like structure. Say
12278 you have two structures that you wish to access: One is your private
12279 mail spool, and the other is a public one. Here's the possible spec for
12283 (nnmh "private" (nnmh-directory "~/private/mail/"))
12286 (This server is then called @samp{private}, but you may have guessed
12289 Here's the method for a public spool:
12293 (nnmh-directory "/usr/information/spool/")
12294 (nnmh-get-new-mail nil))
12300 If you are behind a firewall and only have access to the @acronym{NNTP}
12301 server from the firewall machine, you can instruct Gnus to @code{rlogin}
12302 on the firewall machine and telnet from there to the @acronym{NNTP} server.
12303 Doing this can be rather fiddly, but your virtual server definition
12304 should probably look something like this:
12308 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
12309 (nntp-via-address "the.firewall.machine")
12310 (nntp-address "the.real.nntp.host")
12311 (nntp-end-of-line "\n"))
12314 If you want to use the wonderful @code{ssh} program to provide a
12315 compressed connection over the modem line, you could add the following
12316 configuration to the example above:
12319 (nntp-via-rlogin-command "ssh")
12322 See also @code{nntp-via-rlogin-command-switches}.
12324 If you're behind a firewall, but have direct access to the outside world
12325 through a wrapper command like "runsocks", you could open a socksified
12326 telnet connection to the news server as follows:
12330 (nntp-pre-command "runsocks")
12331 (nntp-open-connection-function nntp-open-via-telnet)
12332 (nntp-address "the.news.server")
12333 (nntp-end-of-line "\n"))
12336 This means that you have to have set up @code{ssh-agent} correctly to
12337 provide automatic authorization, of course. And to get a compressed
12338 connection, you have to have the @samp{Compression} option in the
12339 @code{ssh} @file{config} file.
12342 @node Creating a Virtual Server
12343 @subsection Creating a Virtual Server
12345 If you're saving lots of articles in the cache by using persistent
12346 articles, you may want to create a virtual server to read the cache.
12348 First you need to add a new server. The @kbd{a} command does that. It
12349 would probably be best to use @code{nnml} to read the cache. You
12350 could also use @code{nnspool} or @code{nnmh}, though.
12352 Type @kbd{a nnml RET cache RET}.
12354 You should now have a brand new @code{nnml} virtual server called
12355 @samp{cache}. You now need to edit it to have the right definitions.
12356 Type @kbd{e} to edit the server. You'll be entered into a buffer that
12357 will contain the following:
12367 (nnml-directory "~/News/cache/")
12368 (nnml-active-file "~/News/cache/active"))
12371 Type @kbd{C-c C-c} to return to the server buffer. If you now press
12372 @kbd{RET} over this virtual server, you should be entered into a browse
12373 buffer, and you should be able to enter any of the groups displayed.
12376 @node Server Variables
12377 @subsection Server Variables
12378 @cindex server variables
12379 @cindex server parameters
12381 One sticky point when defining variables (both on back ends and in Emacs
12382 in general) is that some variables are typically initialized from other
12383 variables when the definition of the variables is being loaded. If you
12384 change the ``base'' variable after the variables have been loaded, you
12385 won't change the ``derived'' variables.
12387 This typically affects directory and file variables. For instance,
12388 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
12389 directory variables are initialized from that variable, so
12390 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
12391 new virtual @code{nnml} server, it will @emph{not} suffice to set just
12392 @code{nnml-directory}---you have to explicitly set all the file
12393 variables to be what you want them to be. For a complete list of
12394 variables for each back end, see each back end's section later in this
12395 manual, but here's an example @code{nnml} definition:
12399 (nnml-directory "~/my-mail/")
12400 (nnml-active-file "~/my-mail/active")
12401 (nnml-newsgroups-file "~/my-mail/newsgroups"))
12404 Server variables are often called @dfn{server parameters}.
12406 @node Servers and Methods
12407 @subsection Servers and Methods
12409 Wherever you would normally use a select method
12410 (e.g. @code{gnus-secondary-select-method}, in the group select method,
12411 when browsing a foreign server) you can use a virtual server name
12412 instead. This could potentially save lots of typing. And it's nice all
12416 @node Unavailable Servers
12417 @subsection Unavailable Servers
12419 If a server seems to be unreachable, Gnus will mark that server as
12420 @code{denied}. That means that any subsequent attempt to make contact
12421 with that server will just be ignored. ``It can't be opened,'' Gnus
12422 will tell you, without making the least effort to see whether that is
12423 actually the case or not.
12425 That might seem quite naughty, but it does make sense most of the time.
12426 Let's say you have 10 groups subscribed to on server
12427 @samp{nephelococcygia.com}. This server is located somewhere quite far
12428 away from you and the machine is quite slow, so it takes 1 minute just
12429 to find out that it refuses connection to you today. If Gnus were to
12430 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12431 attempt to do that. Once it has gotten a single ``connection refused'',
12432 it will regard that server as ``down''.
12434 So, what happens if the machine was only feeling unwell temporarily?
12435 How do you test to see whether the machine has come up again?
12437 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12438 with the following commands:
12444 @findex gnus-server-open-server
12445 Try to establish connection to the server on the current line
12446 (@code{gnus-server-open-server}).
12450 @findex gnus-server-close-server
12451 Close the connection (if any) to the server
12452 (@code{gnus-server-close-server}).
12456 @findex gnus-server-deny-server
12457 Mark the current server as unreachable
12458 (@code{gnus-server-deny-server}).
12461 @kindex M-o (Server)
12462 @findex gnus-server-open-all-servers
12463 Open the connections to all servers in the buffer
12464 (@code{gnus-server-open-all-servers}).
12467 @kindex M-c (Server)
12468 @findex gnus-server-close-all-servers
12469 Close the connections to all servers in the buffer
12470 (@code{gnus-server-close-all-servers}).
12474 @findex gnus-server-remove-denials
12475 Remove all marks to whether Gnus was denied connection from any servers
12476 (@code{gnus-server-remove-denials}).
12480 @findex gnus-server-offline-server
12481 Set server status to offline (@code{gnus-server-offline-server}).
12487 @section Getting News
12488 @cindex reading news
12489 @cindex news back ends
12491 A newsreader is normally used for reading news. Gnus currently provides
12492 only two methods of getting news---it can read from an @acronym{NNTP} server,
12493 or it can read from a local spool.
12496 * NNTP:: Reading news from an @acronym{NNTP} server.
12497 * News Spool:: Reading news from the local spool.
12505 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
12506 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
12507 server as the, uhm, address.
12509 If the @acronym{NNTP} server is located at a non-standard port, setting the
12510 third element of the select method to this port number should allow you
12511 to connect to the right port. You'll have to edit the group info for
12512 that (@pxref{Foreign Groups}).
12514 The name of the foreign group can be the same as a native group. In
12515 fact, you can subscribe to the same group from as many different servers
12516 you feel like. There will be no name collisions.
12518 The following variables can be used to create a virtual @code{nntp}
12523 @item nntp-server-opened-hook
12524 @vindex nntp-server-opened-hook
12525 @cindex @sc{mode reader}
12527 @cindex authentification
12528 @cindex nntp authentification
12529 @findex nntp-send-authinfo
12530 @findex nntp-send-mode-reader
12531 is run after a connection has been made. It can be used to send
12532 commands to the @acronym{NNTP} server after it has been contacted. By
12533 default it sends the command @code{MODE READER} to the server with the
12534 @code{nntp-send-mode-reader} function. This function should always be
12535 present in this hook.
12537 @item nntp-authinfo-function
12538 @vindex nntp-authinfo-function
12539 @findex nntp-send-authinfo
12540 @vindex nntp-authinfo-file
12541 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
12542 server. The default function is @code{nntp-send-authinfo}, which looks
12543 through your @file{~/.authinfo} (or whatever you've set the
12544 @code{nntp-authinfo-file} variable to) for applicable entries. If none
12545 are found, it will prompt you for a login name and a password. The
12546 format of the @file{~/.authinfo} file is (almost) the same as the
12547 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
12548 manual page, but here are the salient facts:
12552 The file contains one or more line, each of which define one server.
12555 Each line may contain an arbitrary number of token/value pairs.
12557 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
12558 @samp{default}. In addition Gnus introduces two new tokens, not present
12559 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
12560 @samp{force}. (This is the only way the @file{.authinfo} file format
12561 deviates from the @file{.netrc} file format.) @samp{port} is used to
12562 indicate what port on the server the credentials apply to and
12563 @samp{force} is explained below.
12567 Here's an example file:
12570 machine news.uio.no login larsi password geheimnis
12571 machine nntp.ifi.uio.no login larsi force yes
12574 The token/value pairs may appear in any order; @samp{machine} doesn't
12575 have to be first, for instance.
12577 In this example, both login name and password have been supplied for the
12578 former server, while the latter has only the login name listed, and the
12579 user will be prompted for the password. The latter also has the
12580 @samp{force} tag, which means that the authinfo will be sent to the
12581 @var{nntp} server upon connection; the default (i.e., when there is not
12582 @samp{force} tag) is to not send authinfo to the @var{nntp} server
12583 until the @var{nntp} server asks for it.
12585 You can also add @samp{default} lines that will apply to all servers
12586 that don't have matching @samp{machine} lines.
12592 This will force sending @samp{AUTHINFO} commands to all servers not
12593 previously mentioned.
12595 Remember to not leave the @file{~/.authinfo} file world-readable.
12597 @item nntp-server-action-alist
12598 @vindex nntp-server-action-alist
12599 This is a list of regexps to match on server types and actions to be
12600 taken when matches are made. For instance, if you want Gnus to beep
12601 every time you connect to innd, you could say something like:
12604 (setq nntp-server-action-alist
12605 '(("innd" (ding))))
12608 You probably don't want to do that, though.
12610 The default value is
12613 '(("nntpd 1\\.5\\.11t"
12614 (remove-hook 'nntp-server-opened-hook
12615 'nntp-send-mode-reader)))
12618 This ensures that Gnus doesn't send the @code{MODE READER} command to
12619 nntpd 1.5.11t, since that command chokes that server, I've been told.
12621 @item nntp-maximum-request
12622 @vindex nntp-maximum-request
12623 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
12624 will collect headers by sending a series of @code{head} commands. To
12625 speed things up, the back end sends lots of these commands without
12626 waiting for reply, and then reads all the replies. This is controlled
12627 by the @code{nntp-maximum-request} variable, and is 400 by default. If
12628 your network is buggy, you should set this to 1.
12630 @item nntp-connection-timeout
12631 @vindex nntp-connection-timeout
12632 If you have lots of foreign @code{nntp} groups that you connect to
12633 regularly, you're sure to have problems with @acronym{NNTP} servers not
12634 responding properly, or being too loaded to reply within reasonable
12635 time. This is can lead to awkward problems, which can be helped
12636 somewhat by setting @code{nntp-connection-timeout}. This is an integer
12637 that says how many seconds the @code{nntp} back end should wait for a
12638 connection before giving up. If it is @code{nil}, which is the default,
12639 no timeouts are done.
12641 @c @item nntp-command-timeout
12642 @c @vindex nntp-command-timeout
12643 @c @cindex PPP connections
12644 @c @cindex dynamic IP addresses
12645 @c If you're running Gnus on a machine that has a dynamically assigned
12646 @c address, Gnus may become confused. If the address of your machine
12647 @c changes after connecting to the @acronym{NNTP} server, Gnus will simply sit
12648 @c waiting forever for replies from the server. To help with this
12649 @c unfortunate problem, you can set this command to a number. Gnus will
12650 @c then, if it sits waiting for a reply from the server longer than that
12651 @c number of seconds, shut down the connection, start a new one, and resend
12652 @c the command. This should hopefully be transparent to the user. A
12653 @c likely number is 30 seconds.
12655 @c @item nntp-retry-on-break
12656 @c @vindex nntp-retry-on-break
12657 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
12658 @c hangs. This will have much the same effect as the command timeout
12659 @c described above.
12661 @item nntp-server-hook
12662 @vindex nntp-server-hook
12663 This hook is run as the last step when connecting to an @acronym{NNTP}
12666 @item nntp-buggy-select
12667 @vindex nntp-buggy-select
12668 Set this to non-@code{nil} if your select routine is buggy.
12670 @item nntp-nov-is-evil
12671 @vindex nntp-nov-is-evil
12672 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
12673 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
12676 @item nntp-xover-commands
12677 @vindex nntp-xover-commands
12678 @cindex @acronym{NOV}
12680 List of strings used as commands to fetch @acronym{NOV} lines from a
12681 server. The default value of this variable is @code{("XOVER"
12685 @vindex nntp-nov-gap
12686 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
12687 the server. The server responds with one huge list of lines. However,
12688 if you have read articles 2-5000 in the group, and only want to read
12689 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
12690 lines that you will not need. This variable says how
12691 big a gap between two consecutive articles is allowed to be before the
12692 @code{XOVER} request is split into several request. Note that if your
12693 network is fast, setting this variable to a really small number means
12694 that fetching will probably be slower. If this variable is @code{nil},
12695 @code{nntp} will never split requests. The default is 5.
12697 @item nntp-prepare-server-hook
12698 @vindex nntp-prepare-server-hook
12699 A hook run before attempting to connect to an @acronym{NNTP} server.
12701 @item nntp-warn-about-losing-connection
12702 @vindex nntp-warn-about-losing-connection
12703 If this variable is non-@code{nil}, some noise will be made when a
12704 server closes connection.
12706 @item nntp-record-commands
12707 @vindex nntp-record-commands
12708 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12709 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
12710 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
12711 that doesn't seem to work.
12713 @item nntp-open-connection-function
12714 @vindex nntp-open-connection-function
12715 It is possible to customize how the connection to the nntp server will
12716 be opened. If you specify an @code{nntp-open-connection-function}
12717 parameter, Gnus will use that function to establish the connection.
12718 Five pre-made functions are supplied. These functions can be grouped in
12719 two categories: direct connection functions (three pre-made), and
12720 indirect ones (two pre-made).
12722 @item nntp-prepare-post-hook
12723 @vindex nntp-prepare-post-hook
12724 A hook run just before posting an article. If there is no
12725 @code{Message-ID} header in the article and the news server provides the
12726 recommended ID, it will be added to the article before running this
12727 hook. It is useful to make @code{Cancel-Lock} headers even if you
12728 inhibit Gnus to add a @code{Message-ID} header, you could say:
12731 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12734 Note that not all servers support the recommended ID. This works for
12735 INN versions 2.3.0 and later, for instance.
12737 @item nntp-read-timeout
12738 @vindex nntp-read-timeout
12739 How long nntp should wait between checking for the end of output.
12740 Shorter values mean quicker response, but is more CPU intensive. The
12741 default is 0.1 seconds. If you have a slow line to the server (and
12742 don't like to see Emacs eat your available CPU power), you might set
12745 @item nntp-list-options
12746 @vindex nntp-list-options
12747 List of newsgroup name used for a option of the LIST command to restrict
12748 the listing output to only the specified newsgroups. Each newsgroup name
12749 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
12750 etc. Fortunately, if the server can accept such a option, it will
12751 probably make gnus run faster. You may use it as a server variable as
12755 (setq gnus-select-method
12756 '(nntp "news.somewhere.edu"
12757 (nntp-list-options ("fj.*" "japan.*"))))
12760 @item nntp-options-subscribe
12761 @vindex nntp-options-subscribe
12762 Regexp matching the newsgroup names which will be subscribed
12763 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12764 It may be effective as well as @code{nntp-list-options} even though the
12765 server could not accept a shell-style wildcard as a option of the LIST
12766 command. You may use it as a server variable as follows:
12769 (setq gnus-select-method
12770 '(nntp "news.somewhere.edu"
12771 (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
12774 @item nntp-options-not-subscribe
12775 @vindex nntp-options-not-subscribe
12776 Regexp matching the newsgroup names which will not be subscribed
12777 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12778 It may be effective as well as @code{nntp-list-options} even though the
12779 server could not accept a shell-style wildcard as a option of the LIST
12780 command. You may use it as a server variable as follows:
12783 (setq gnus-select-method
12784 '(nntp "news.somewhere.edu"
12785 (nntp-options-not-subscribe "\\.binaries\\.")))
12790 * Direct Functions:: Connecting directly to the server.
12791 * Indirect Functions:: Connecting indirectly to the server.
12792 * Common Variables:: Understood by several connection functions.
12796 @node Direct Functions
12797 @subsubsection Direct Functions
12798 @cindex direct connection functions
12800 These functions are called direct because they open a direct connection
12801 between your machine and the @acronym{NNTP} server. The behavior of these
12802 functions is also affected by commonly understood variables
12803 (@pxref{Common Variables}).
12806 @findex nntp-open-network-stream
12807 @item nntp-open-network-stream
12808 This is the default, and simply connects to some port or other on the
12811 @findex nntp-open-tls-stream
12812 @item nntp-open-tls-stream
12813 Opens a connection to a server over a @dfn{secure} channel. To use
12814 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
12815 installed. You then define a server as follows:
12818 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
12819 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
12821 (nntp "snews.bar.com"
12822 (nntp-open-connection-function nntp-open-tls-stream)
12823 (nntp-port-number )
12824 (nntp-address "snews.bar.com"))
12827 @findex nntp-open-ssl-stream
12828 @item nntp-open-ssl-stream
12829 Opens a connection to a server over a @dfn{secure} channel. To use
12830 this you must have @uref{http://www.openssl.org, OpenSSL} or
12831 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
12832 then define a server as follows:
12835 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
12836 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
12838 (nntp "snews.bar.com"
12839 (nntp-open-connection-function nntp-open-ssl-stream)
12840 (nntp-port-number 563)
12841 (nntp-address "snews.bar.com"))
12844 @findex nntp-open-telnet-stream
12845 @item nntp-open-telnet-stream
12846 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
12847 it. You might wonder why this function exists, since we have the
12848 default @code{nntp-open-network-stream} which would do the job. (One
12849 of) the reason(s) is that if you are behind a firewall but have direct
12850 connections to the outside world thanks to a command wrapper like
12851 @code{runsocks}, you can use it like this:
12855 (nntp-pre-command "runsocks")
12856 (nntp-open-connection-function nntp-open-telnet-stream)
12857 (nntp-address "the.news.server"))
12860 With the default method, you would need to wrap your whole Emacs
12861 session, which is not a good idea.
12865 @node Indirect Functions
12866 @subsubsection Indirect Functions
12867 @cindex indirect connection functions
12869 These functions are called indirect because they connect to an
12870 intermediate host before actually connecting to the @acronym{NNTP} server.
12871 All of these functions and related variables are also said to belong to
12872 the ``via'' family of connection: they're all prefixed with ``via'' to make
12873 things cleaner. The behavior of these functions is also affected by
12874 commonly understood variables (@pxref{Common Variables}).
12877 @item nntp-open-via-rlogin-and-telnet
12878 @findex nntp-open-via-rlogin-and-telnet
12879 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
12880 to the real @acronym{NNTP} server from there. This is useful for instance if
12881 you need to connect to a firewall machine first.
12883 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
12886 @item nntp-via-rlogin-command
12887 @vindex nntp-via-rlogin-command
12888 Command used to log in on the intermediate host. The default is
12889 @samp{rsh}, but @samp{ssh} is a popular alternative.
12891 @item nntp-via-rlogin-command-switches
12892 @vindex nntp-via-rlogin-command-switches
12893 List of strings to be used as the switches to
12894 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
12895 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
12896 @samp{("-C")} in order to compress all data connections, otherwise set
12897 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
12898 the telnet command requires a pseudo-tty allocation on an intermediate
12902 Note that you may want to change the value for @code{nntp-end-of-line}
12903 to @samp{\n} (@pxref{Common Variables}).
12905 @item nntp-open-via-rlogin-and-netcat
12906 @findex nntp-open-via-rlogin-and-netcat
12907 Does essentially the same, but uses @samp{netcat}
12908 (@uref{http://netcat.sourceforge.net/}) instead of @samp{telnet} to
12909 connect to the real @acronym{NNTP} server from the intermediate host.
12911 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
12914 @item nntp-via-netcat-command
12915 @vindex nntp-via-netcat-command
12916 Command used to connect to the real @acronym{NNTP} server from the
12917 intermediate host. The default is @samp{nc}. You can also use other
12918 programs like @samp{connect}
12919 (@uref{http://www.imasy.or.jp/~gotoh/ssh/connect.html}) instead.
12921 @item nntp-via-netcat-switches
12922 @vindex nntp-via-netcat-switches
12923 List of strings to be used as the switches to the
12924 @code{nntp-via-telnet-command} command. The default is @code{nil}.
12926 @item nntp-via-rlogin-command
12927 Command used to log in on the intermediate host. The default is
12928 @samp{rsh}, but @samp{ssh} is a popular alternative.
12930 @item nntp-via-rlogin-command-switches
12931 List of strings to be used as the switches to
12932 @code{nntp-via-rlogin-command}. The default is @code{nil}.
12935 @item nntp-open-via-telnet-and-telnet
12936 @findex nntp-open-via-telnet-and-telnet
12937 Does essentially also the same, but uses @samp{telnet} instead of
12938 @samp{rlogin} to connect to the intermediate host.
12940 @code{nntp-open-via-telnet-and-telnet}-specific variables:
12943 @item nntp-via-telnet-command
12944 @vindex nntp-via-telnet-command
12945 Command used to @code{telnet} the intermediate host. The default is
12948 @item nntp-via-telnet-switches
12949 @vindex nntp-via-telnet-switches
12950 List of strings to be used as the switches to the
12951 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
12953 @item nntp-via-user-password
12954 @vindex nntp-via-user-password
12955 Password to use when logging in on the intermediate host.
12957 @item nntp-via-envuser
12958 @vindex nntp-via-envuser
12959 If non-@code{nil}, the intermediate @code{telnet} session (client and
12960 server both) will support the @code{ENVIRON} option and not prompt for
12961 login name. This works for Solaris @code{telnet}, for instance.
12963 @item nntp-via-shell-prompt
12964 @vindex nntp-via-shell-prompt
12965 Regexp matching the shell prompt on the intermediate host. The default
12966 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
12968 @item nntp-marks-is-evil
12969 @vindex nntp-marks-is-evil
12970 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
12971 default is @code{nil}.
12973 @item nntp-marks-directory
12974 @vindex nntp-marks-directory
12975 The directory where @sc{marks} for nntp groups will be stored.
12979 Note that you may want to change the value for @code{nntp-end-of-line}
12980 to @samp{\n} (@pxref{Common Variables}).
12984 Here are some additional variables that are understood by all the above
12989 @item nntp-via-user-name
12990 @vindex nntp-via-user-name
12991 User name to use when connecting to the intermediate host.
12993 @item nntp-via-address
12994 @vindex nntp-via-address
12995 Address of the intermediate host to connect to.
13000 @node Common Variables
13001 @subsubsection Common Variables
13003 The following variables affect the behavior of all, or several of the
13004 pre-made connection functions. When not specified, all functions are
13009 @item nntp-pre-command
13010 @vindex nntp-pre-command
13011 A command wrapper to use when connecting through a non native
13012 connection function (all except @code{nntp-open-network-stream},
13013 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}. This is
13014 where you would put a @samp{SOCKS} wrapper for instance.
13017 @vindex nntp-address
13018 The address of the @acronym{NNTP} server.
13020 @item nntp-port-number
13021 @vindex nntp-port-number
13022 Port number to connect to the @acronym{NNTP} server. The default is
13023 @samp{nntp}. If you use @acronym{NNTP} over
13024 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
13025 than named ports (i.e, use @samp{563} instead of @samp{snews} or
13026 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
13027 not work with named ports.
13029 @item nntp-end-of-line
13030 @vindex nntp-end-of-line
13031 String to use as end-of-line marker when talking to the @acronym{NNTP}
13032 server. This is @samp{\r\n} by default, but should be @samp{\n} when
13033 using a non native telnet connection function.
13035 @item nntp-telnet-command
13036 @vindex nntp-telnet-command
13037 Command to use when connecting to the @acronym{NNTP} server through
13038 @samp{telnet}. This is @emph{not} for an intermediate host. This is
13039 just for the real @acronym{NNTP} server. The default is
13042 @item nntp-telnet-switches
13043 @vindex nntp-telnet-switches
13044 A list of switches to pass to @code{nntp-telnet-command}. The default
13051 @subsection News Spool
13055 Subscribing to a foreign group from the local spool is extremely easy,
13056 and might be useful, for instance, to speed up reading groups that
13057 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
13060 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
13061 anything else) as the address.
13063 If you have access to a local spool, you should probably use that as the
13064 native select method (@pxref{Finding the News}). It is normally faster
13065 than using an @code{nntp} select method, but might not be. It depends.
13066 You just have to try to find out what's best at your site.
13070 @item nnspool-inews-program
13071 @vindex nnspool-inews-program
13072 Program used to post an article.
13074 @item nnspool-inews-switches
13075 @vindex nnspool-inews-switches
13076 Parameters given to the inews program when posting an article.
13078 @item nnspool-spool-directory
13079 @vindex nnspool-spool-directory
13080 Where @code{nnspool} looks for the articles. This is normally
13081 @file{/usr/spool/news/}.
13083 @item nnspool-nov-directory
13084 @vindex nnspool-nov-directory
13085 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
13086 @file{/usr/spool/news/over.view/}.
13088 @item nnspool-lib-dir
13089 @vindex nnspool-lib-dir
13090 Where the news lib dir is (@file{/usr/lib/news/} by default).
13092 @item nnspool-active-file
13093 @vindex nnspool-active-file
13094 The name of the active file.
13096 @item nnspool-newsgroups-file
13097 @vindex nnspool-newsgroups-file
13098 The name of the group descriptions file.
13100 @item nnspool-history-file
13101 @vindex nnspool-history-file
13102 The name of the news history file.
13104 @item nnspool-active-times-file
13105 @vindex nnspool-active-times-file
13106 The name of the active date file.
13108 @item nnspool-nov-is-evil
13109 @vindex nnspool-nov-is-evil
13110 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13113 @item nnspool-sift-nov-with-sed
13114 @vindex nnspool-sift-nov-with-sed
13116 If non-@code{nil}, which is the default, use @code{sed} to get the
13117 relevant portion from the overview file. If @code{nil},
13118 @code{nnspool} will load the entire file into a buffer and process it
13125 @section Getting Mail
13126 @cindex reading mail
13129 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13133 * Mail in a Newsreader:: Important introductory notes.
13134 * Getting Started Reading Mail:: A simple cookbook example.
13135 * Splitting Mail:: How to create mail groups.
13136 * Mail Sources:: How to tell Gnus where to get mail from.
13137 * Mail Back End Variables:: Variables for customizing mail handling.
13138 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
13139 * Group Mail Splitting:: Use group customize to drive mail splitting.
13140 * Incorporating Old Mail:: What about the old mail you have?
13141 * Expiring Mail:: Getting rid of unwanted mail.
13142 * Washing Mail:: Removing cruft from the mail you get.
13143 * Duplicates:: Dealing with duplicated mail.
13144 * Not Reading Mail:: Using mail back ends for reading other files.
13145 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
13149 @node Mail in a Newsreader
13150 @subsection Mail in a Newsreader
13152 If you are used to traditional mail readers, but have decided to switch
13153 to reading mail with Gnus, you may find yourself experiencing something
13154 of a culture shock.
13156 Gnus does not behave like traditional mail readers. If you want to make
13157 it behave that way, you can, but it's an uphill battle.
13159 Gnus, by default, handles all its groups using the same approach. This
13160 approach is very newsreaderly---you enter a group, see the new/unread
13161 messages, and when you read the messages, they get marked as read, and
13162 you don't see them any more. (Unless you explicitly ask for them.)
13164 In particular, you do not do anything explicitly to delete messages.
13166 Does this mean that all the messages that have been marked as read are
13167 deleted? How awful!
13169 But, no, it means that old messages are @dfn{expired} according to some
13170 scheme or other. For news messages, the expire process is controlled by
13171 the news administrator; for mail, the expire process is controlled by
13172 you. The expire process for mail is covered in depth in @ref{Expiring
13175 What many Gnus users find, after using it a while for both news and
13176 mail, is that the transport mechanism has very little to do with how
13177 they want to treat a message.
13179 Many people subscribe to several mailing lists. These are transported
13180 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13181 answering, or even reading these messages very carefully. We may not
13182 need to save them because if we should need to read one again, they are
13183 archived somewhere else.
13185 Some people have local news groups which have only a handful of readers.
13186 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13187 to read and answer a large fraction of the messages very carefully in
13188 order to do our work. And there may not be an archive, so we may need
13189 to save the interesting messages the same way we would personal mail.
13191 The important distinction turns out to be not the transport mechanism,
13192 but other factors such as how interested we are in the subject matter,
13193 or how easy it is to retrieve the message if we need to read it again.
13195 Gnus provides many options for sorting mail into ``groups'' which behave
13196 like newsgroups, and for treating each group (whether mail or news)
13199 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13200 that Gnus should grow up and be a male, er, mail reader. It is possible
13201 to whip Gnus into a more mailreaderly being, but, as said before, it's
13202 not easy. People who prefer proper mail readers should try @sc{vm}
13203 instead, which is an excellent, and proper, mail reader.
13205 I don't mean to scare anybody off, but I want to make it clear that you
13206 may be required to learn a new way of thinking about messages. After
13207 you've been subjected to The Gnus Way, you will come to love it. I can
13208 guarantee it. (At least the guy who sold me the Emacs Subliminal
13209 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13210 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13214 @node Getting Started Reading Mail
13215 @subsection Getting Started Reading Mail
13217 It's quite easy to use Gnus to read your new mail. You just plonk the
13218 mail back end of your choice into @code{gnus-secondary-select-methods},
13219 and things will happen automatically.
13221 For instance, if you want to use @code{nnml} (which is a ``one file per
13222 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13225 (setq gnus-secondary-select-methods '((nnml "")))
13228 Now, the next time you start Gnus, this back end will be queried for new
13229 articles, and it will move all the messages in your spool file to its
13230 directory, which is @file{~/Mail/} by default. The new group that will
13231 be created (@samp{mail.misc}) will be subscribed, and you can read it
13232 like any other group.
13234 You will probably want to split the mail into several groups, though:
13237 (setq nnmail-split-methods
13238 '(("junk" "^From:.*Lars Ingebrigtsen")
13239 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13243 This will result in three new @code{nnml} mail groups being created:
13244 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
13245 mail that doesn't fit into the first two groups will be placed in the
13248 This should be sufficient for reading mail with Gnus. You might want to
13249 give the other sections in this part of the manual a perusal, though.
13250 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13253 @node Splitting Mail
13254 @subsection Splitting Mail
13255 @cindex splitting mail
13256 @cindex mail splitting
13257 @cindex mail filtering (splitting)
13259 @vindex nnmail-split-methods
13260 The @code{nnmail-split-methods} variable says how the incoming mail is
13261 to be split into groups.
13264 (setq nnmail-split-methods
13265 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
13266 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
13267 ("mail.other" "")))
13270 This variable is a list of lists, where the first element of each of
13271 these lists is the name of the mail group (they do not have to be called
13272 something beginning with @samp{mail}, by the way), and the second
13273 element is a regular expression used on the header of each mail to
13274 determine if it belongs in this mail group. The first string may
13275 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
13276 insert sub-expressions from the matched text. For instance:
13279 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
13283 In that case, @code{nnmail-split-lowercase-expanded} controls whether
13284 the inserted text should be made lowercase. @xref{Fancy Mail Splitting}.
13286 The second element can also be a function. In that case, it will be
13287 called narrowed to the headers with the first element of the rule as the
13288 argument. It should return a non-@code{nil} value if it thinks that the
13289 mail belongs in that group.
13291 The last of these groups should always be a general one, and the regular
13292 expression should @emph{always} be @samp{*} so that it matches any mails
13293 that haven't been matched by any of the other regexps. (These rules are
13294 processed from the beginning of the alist toward the end. The first
13295 rule to make a match will ``win'', unless you have crossposting enabled.
13296 In that case, all matching rules will ``win''.) When new groups are
13297 created by splitting mail, you may want to run
13298 @code{gnus-group-find-new-groups} to see the new groups.
13300 If you like to tinker with this yourself, you can set this variable to a
13301 function of your choice. This function will be called without any
13302 arguments in a buffer narrowed to the headers of an incoming mail
13303 message. The function should return a list of group names that it
13304 thinks should carry this mail message.
13306 Note that the mail back ends are free to maul the poor, innocent,
13307 incoming headers all they want to. They all add @code{Lines} headers;
13308 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
13309 @code{From<SPACE>} line to something else.
13311 @vindex nnmail-crosspost
13312 The mail back ends all support cross-posting. If several regexps match,
13313 the mail will be ``cross-posted'' to all those groups.
13314 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
13315 that no articles are crossposted to the general (@samp{*}) group.
13317 @vindex nnmail-crosspost-link-function
13320 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
13321 the crossposted articles. However, not all file systems support hard
13322 links. If that's the case for you, set
13323 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
13324 variable is @code{add-name-to-file} by default.)
13326 @kindex M-x nnmail-split-history
13327 @findex nnmail-split-history
13328 If you wish to see where the previous mail split put the messages, you
13329 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
13330 where re-spooling messages would put the messages, you can use
13331 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
13334 @vindex nnmail-split-header-length-limit
13335 Header lines longer than the value of
13336 @code{nnmail-split-header-length-limit} are excluded from the split
13339 @vindex nnmail-mail-splitting-charset
13340 @vindex nnmail-mail-splitting-decodes
13341 By default the splitting codes @acronym{MIME} decodes headers so you
13342 can match on non-@acronym{ASCII} strings. The
13343 @code{nnmail-mail-splitting-charset} variable specifies the default
13344 charset for decoding. The behaviour can be turned off completely by
13345 binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is
13346 useful if you want to match articles based on the raw header data.
13348 @vindex nnmail-resplit-incoming
13349 By default, splitting is performed on all incoming messages. If you
13350 specify a @code{directory} entry for the variable @code{mail-sources}
13351 (@pxref{Mail Source Specifiers}), however, then splitting does
13352 @emph{not} happen by default. You can set the variable
13353 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
13354 splitting happen even in this case. (This variable has no effect on
13355 other kinds of entries.)
13357 Gnus gives you all the opportunity you could possibly want for shooting
13358 yourself in the foot. Let's say you create a group that will contain
13359 all the mail you get from your boss. And then you accidentally
13360 unsubscribe from the group. Gnus will still put all the mail from your
13361 boss in the unsubscribed group, and so, when your boss mails you ``Have
13362 that report ready by Monday or you're fired!'', you'll never see it and,
13363 come Tuesday, you'll still believe that you're gainfully employed while
13364 you really should be out collecting empty bottles to save up for next
13365 month's rent money.
13369 @subsection Mail Sources
13371 Mail can be gotten from many different sources---the mail spool, from
13372 a @acronym{POP} mail server, from a procmail directory, or from a
13373 maildir, for instance.
13376 * Mail Source Specifiers:: How to specify what a mail source is.
13377 * Mail Source Customization:: Some variables that influence things.
13378 * Fetching Mail:: Using the mail source specifiers.
13382 @node Mail Source Specifiers
13383 @subsubsection Mail Source Specifiers
13385 @cindex mail server
13388 @cindex mail source
13390 You tell Gnus how to fetch mail by setting @code{mail-sources}
13391 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
13396 (pop :server "pop3.mailserver.com" :user "myname")
13399 As can be observed, a mail source specifier is a list where the first
13400 element is a @dfn{mail source type}, followed by an arbitrary number of
13401 @dfn{keywords}. Keywords that are not explicitly specified are given
13404 The following mail source types are available:
13408 Get mail from a single file; typically from the mail spool.
13414 The file name. Defaults to the value of the @env{MAIL}
13415 environment variable or the value of @code{rmail-spool-directory}
13416 (usually something like @file{/usr/mail/spool/user-name}).
13420 Script run before/after fetching mail.
13423 An example file mail source:
13426 (file :path "/usr/spool/mail/user-name")
13429 Or using the default file name:
13435 If the mail spool file is not located on the local machine, it's best
13436 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
13437 You can not use ange-ftp file names here---it has no way to lock the
13438 mail spool while moving the mail.
13440 If it's impossible to set up a proper server, you can use ssh instead.
13444 '((file :prescript "ssh host bin/getmail >%t")))
13447 The @samp{getmail} script would look something like the following:
13451 # getmail - move mail from spool to stdout
13454 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
13456 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
13459 Alter this script to fit find the @samp{movemail} you want to use.
13463 @vindex nnmail-scan-directory-mail-source-once
13464 Get mail from several files in a directory. This is typically used
13465 when you have procmail split the incoming mail into several files.
13466 That is, there is a one-to-one correspondence between files in that
13467 directory and groups, so that mail from the file @file{foo.bar.spool}
13468 will be put in the group @code{foo.bar}. (You can change the suffix
13469 to be used instead of @code{.spool}.) Setting
13470 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
13471 Gnus to scan the mail source only once. This is particularly useful
13472 if you want to scan mail groups at a specified level.
13474 @vindex nnmail-resplit-incoming
13475 There is also the variable @code{nnmail-resplit-incoming}, if you set
13476 that to a non-@code{nil} value, then the normal splitting process is
13477 applied to all the files from the directory, @ref{Splitting Mail}.
13483 The name of the directory where the files are. There is no default
13487 Only files ending with this suffix are used. The default is
13491 Only files that have this predicate return non-@code{nil} are returned.
13492 The default is @code{identity}. This is used as an additional
13493 filter---only files that have the right suffix @emph{and} satisfy this
13494 predicate are considered.
13498 Script run before/after fetching mail.
13502 An example directory mail source:
13505 (directory :path "/home/user-name/procmail-dir/"
13510 Get mail from a @acronym{POP} server.
13516 The name of the @acronym{POP} server. The default is taken from the
13517 @env{MAILHOST} environment variable.
13520 The port number of the @acronym{POP} server. This can be a number (eg,
13521 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
13522 string, it should be a service name as listed in @file{/etc/services} on
13523 Unix systems. The default is @samp{"pop3"}. On some systems you might
13524 need to specify it as @samp{"pop-3"} instead.
13527 The user name to give to the @acronym{POP} server. The default is the login
13531 The password to give to the @acronym{POP} server. If not specified,
13532 the user is prompted.
13535 The program to use to fetch mail from the @acronym{POP} server. This
13536 should be a @code{format}-like string. Here's an example:
13539 fetchmail %u@@%s -P %p %t
13542 The valid format specifier characters are:
13546 The name of the file the mail is to be moved to. This must always be
13547 included in this string.
13550 The name of the server.
13553 The port number of the server.
13556 The user name to use.
13559 The password to use.
13562 The values used for these specs are taken from the values you give the
13563 corresponding keywords.
13566 A script to be run before fetching the mail. The syntax is the same as
13567 the @code{:program} keyword. This can also be a function to be run.
13570 A script to be run after fetching the mail. The syntax is the same as
13571 the @code{:program} keyword. This can also be a function to be run.
13574 The function to use to fetch mail from the @acronym{POP} server. The
13575 function is called with one parameter---the name of the file where the
13576 mail should be moved to.
13578 @item :authentication
13579 This can be either the symbol @code{password} or the symbol @code{apop}
13580 and says what authentication scheme to use. The default is
13584 What stream to use for connecting to the server, this can be the symbol
13585 @code{ssl}, the symbol @code{tls} or others. The default is @code{nil}
13586 and use insecure connections. Note that for SSL/TLS, you need external
13587 programs and libraries:
13591 @dfn{ssl:} Connect through SSL@. Requires OpenSSL (the program
13592 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
13593 library @samp{ssl.el}.
13595 @dfn{starttls:} Connect via the STARTTLS extension (similar to SSL)@.
13596 Requires the external library @samp{starttls.el} and program
13601 Non-@code{nil} if mail is to be left on the server and UIDL used for
13602 message retrieval. The default is @code{nil}.
13606 @vindex pop3-movemail
13607 @vindex pop3-leave-mail-on-server
13608 If the @code{:program} and @code{:function} keywords aren't specified,
13609 @code{pop3-movemail} will be used. If the
13610 @code{pop3-leave-mail-on-server} is non-@code{nil} the mail is to be
13611 left on the @acronym{POP} server after fetching when using
13612 @code{pop3-movemail}. Note that POP servers maintain no state
13613 information between sessions, so what the client believes is there and
13614 what is actually there may not match up. If they do not, then the whole
13615 thing can fall apart and leave you with a corrupt mailbox.
13617 Here are some examples. Fetch from the default @acronym{POP} server,
13618 using the default user name, and default fetcher:
13624 Fetch from a named server with a named user and password:
13627 (pop :server "my.pop.server"
13628 :user "user-name" :password "secret")
13631 Use @samp{movemail} to move the mail:
13634 (pop :program "movemail po:%u %t %p")
13638 Get mail from a maildir. This is a type of mailbox that is supported by
13639 at least qmail and postfix, where each file in a special directory
13640 contains exactly one mail.
13646 The name of the directory where the mails are stored. The default is
13647 taken from the @env{MAILDIR} environment variable or
13650 The subdirectories of the Maildir. The default is
13651 @samp{("new" "cur")}.
13653 @c If you sometimes look at your mail through a pop3 daemon before fetching
13654 @c them with Gnus, you may also have to fetch your mails from the
13655 @c @code{cur} directory inside the maildir, like in the first example
13658 You can also get mails from remote hosts (because maildirs don't suffer
13659 from locking problems).
13663 Two example maildir mail sources:
13666 (maildir :path "/home/user-name/Maildir/"
13667 :subdirs ("cur" "new"))
13671 (maildir :path "/user@@remotehost.org:~/Maildir/"
13676 Get mail from a @acronym{IMAP} server. If you don't want to use
13677 @acronym{IMAP} as intended, as a network mail reading protocol (ie
13678 with nnimap), for some reason or other, Gnus let you treat it similar
13679 to a @acronym{POP} server and fetches articles from a given
13680 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
13682 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
13683 may need external programs and libraries, @xref{IMAP}.
13689 The name of the @acronym{IMAP} server. The default is taken from the
13690 @env{MAILHOST} environment variable.
13693 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
13694 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
13697 The user name to give to the @acronym{IMAP} server. The default is the login
13701 The password to give to the @acronym{IMAP} server. If not specified, the user is
13705 What stream to use for connecting to the server, this is one of the
13706 symbols in @code{imap-stream-alist}. Right now, this means
13707 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
13708 @samp{ssl}, @samp{shell} or the default @samp{network}.
13710 @item :authentication
13711 Which authenticator to use for authenticating to the server, this is
13712 one of the symbols in @code{imap-authenticator-alist}. Right now,
13713 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13714 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13717 When using the `shell' :stream, the contents of this variable is
13718 mapped into the @code{imap-shell-program} variable. This should be a
13719 @code{format}-like string (or list of strings). Here's an example:
13725 The valid format specifier characters are:
13729 The name of the server.
13732 User name from @code{imap-default-user}.
13735 The port number of the server.
13738 The values used for these specs are taken from the values you give the
13739 corresponding keywords.
13742 The name of the mailbox to get mail from. The default is @samp{INBOX}
13743 which normally is the mailbox which receive incoming mail.
13746 The predicate used to find articles to fetch. The default, @samp{UNSEEN
13747 UNDELETED}, is probably the best choice for most people, but if you
13748 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
13749 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13750 Then all articles in the mailbox is fetched, no matter what. For a
13751 complete list of predicates, see RFC 2060 section 6.4.4.
13754 How to flag fetched articles on the server, the default @samp{\Deleted}
13755 will mark them as deleted, an alternative would be @samp{\Seen} which
13756 would simply mark them as read. These are the two most likely choices,
13757 but more flags are defined in RFC 2060 section 2.3.2.
13760 If non-@code{nil}, don't remove all articles marked as deleted in the
13761 mailbox after finishing the fetch.
13765 An example @acronym{IMAP} mail source:
13768 (imap :server "mail.mycorp.com"
13770 :fetchflag "\\Seen")
13774 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
13775 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
13776 @uref{http://mail.yahoo.com/}.
13778 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
13779 required for url "4.0pre.46".
13781 WARNING: Mails may be lost. NO WARRANTY.
13787 The type of the webmail server. The default is @code{hotmail}. The
13788 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13791 The user name to give to the webmail server. The default is the login
13795 The password to give to the webmail server. If not specified, the user is
13799 If non-@code{nil}, only fetch unread articles and don't move them to
13800 trash folder after finishing the fetch.
13804 An example webmail source:
13807 (webmail :subtype 'hotmail
13809 :password "secret")
13814 @item Common Keywords
13815 Common keywords can be used in any type of mail source.
13821 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
13822 use directory source to get mail, you can specify it as in this
13827 '((directory :path "/home/pavel/.Spool/"
13832 Gnus will then fetch your mail even when you are unplugged. This is
13833 useful when you use local mail and news.
13838 @subsubsection Function Interface
13840 Some of the above keywords specify a Lisp function to be executed.
13841 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
13842 the value of the keyword while the function is executing. For example,
13843 consider the following mail-source setting:
13846 (setq mail-sources '((pop :user "jrl"
13847 :server "pophost" :function fetchfunc)))
13850 While the function @code{fetchfunc} is executing, the symbol @code{user}
13851 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
13852 @code{"pophost"}. The symbols @code{port}, @code{password},
13853 @code{program}, @code{prescript}, @code{postscript}, @code{function},
13854 and @code{authentication} are also bound (to their default values).
13856 See above for a list of keywords for each type of mail source.
13859 @node Mail Source Customization
13860 @subsubsection Mail Source Customization
13862 The following is a list of variables that influence how the mail is
13863 fetched. You would normally not need to set or change any of these
13867 @item mail-source-crash-box
13868 @vindex mail-source-crash-box
13869 File where mail will be stored while processing it. The default is@*
13870 @file{~/.emacs-mail-crash-box}.
13872 @item mail-source-delete-incoming
13873 @vindex mail-source-delete-incoming
13874 If non-@code{nil}, delete incoming files after handling them. If
13875 @code{t}, delete the files immediately, if @code{nil}, never delete any
13876 files. If a positive number, delete files older than number of days
13877 (This will only happen, when receiving new mail). You may also set
13878 @code{mail-source-delete-incoming} to @code{nil} and call
13879 @code{mail-source-delete-old-incoming} from a hook or interactively.
13881 @item mail-source-delete-old-incoming-confirm
13882 @vindex mail-source-delete-old-incoming-confirm
13883 If non-@code{nil}, ask for for confirmation before deleting old incoming
13884 files. This variable only applies when
13885 @code{mail-source-delete-incoming} is a positive number.
13887 @item mail-source-ignore-errors
13888 @vindex mail-source-ignore-errors
13889 If non-@code{nil}, ignore errors when reading mail from a mail source.
13891 @item mail-source-directory
13892 @vindex mail-source-directory
13893 Directory where incoming mail source files (if any) will be stored. The
13894 default is @file{~/Mail/}. At present, the only thing this is used for
13895 is to say where the incoming files will be stored if the variable
13896 @code{mail-source-delete-incoming} is @code{nil} or a number.
13898 @item mail-source-incoming-file-prefix
13899 @vindex mail-source-incoming-file-prefix
13900 Prefix for file name for storing incoming mail. The default is
13901 @file{Incoming}, in which case files will end up with names like
13902 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
13903 relevant if @code{mail-source-delete-incoming} is @code{nil}.
13905 @item mail-source-default-file-modes
13906 @vindex mail-source-default-file-modes
13907 All new mail files will get this file mode. The default is 384.
13909 @item mail-source-movemail-program
13910 @vindex mail-source-movemail-program
13911 If non-@code{nil}, name of program for fetching new mail. If
13912 @code{nil}, @code{movemail} in @var{exec-directory}.
13917 @node Fetching Mail
13918 @subsubsection Fetching Mail
13920 @vindex mail-sources
13921 @vindex nnmail-spool-file
13922 The way to actually tell Gnus where to get new mail from is to set
13923 @code{mail-sources} to a list of mail source specifiers
13924 (@pxref{Mail Source Specifiers}).
13926 If this variable (and the obsolescent @code{nnmail-spool-file}) is
13927 @code{nil}, the mail back ends will never attempt to fetch mail by
13930 If you want to fetch mail both from your local spool as well as a
13931 @acronym{POP} mail server, you'd say something like:
13936 (pop :server "pop3.mail.server"
13937 :password "secret")))
13940 Or, if you don't want to use any of the keyword defaults:
13944 '((file :path "/var/spool/mail/user-name")
13945 (pop :server "pop3.mail.server"
13948 :password "secret")))
13952 When you use a mail back end, Gnus will slurp all your mail from your
13953 inbox and plonk it down in your home directory. Gnus doesn't move any
13954 mail if you're not using a mail back end---you have to do a lot of magic
13955 invocations first. At the time when you have finished drawing the
13956 pentagram, lightened the candles, and sacrificed the goat, you really
13957 shouldn't be too surprised when Gnus moves your mail.
13961 @node Mail Back End Variables
13962 @subsection Mail Back End Variables
13964 These variables are (for the most part) pertinent to all the various
13968 @vindex nnmail-read-incoming-hook
13969 @item nnmail-read-incoming-hook
13970 The mail back ends all call this hook after reading new mail. You can
13971 use this hook to notify any mail watch programs, if you want to.
13973 @vindex nnmail-split-hook
13974 @item nnmail-split-hook
13975 @findex gnus-article-decode-encoded-words
13976 @cindex RFC 1522 decoding
13977 @cindex RFC 2047 decoding
13978 Hook run in the buffer where the mail headers of each message is kept
13979 just before the splitting based on these headers is done. The hook is
13980 free to modify the buffer contents in any way it sees fit---the buffer
13981 is discarded after the splitting has been done, and no changes performed
13982 in the buffer will show up in any files.
13983 @code{gnus-article-decode-encoded-words} is one likely function to add
13986 @vindex nnmail-pre-get-new-mail-hook
13987 @vindex nnmail-post-get-new-mail-hook
13988 @item nnmail-pre-get-new-mail-hook
13989 @itemx nnmail-post-get-new-mail-hook
13990 These are two useful hooks executed when treating new incoming
13991 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
13992 starting to handle the new mail) and
13993 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
13994 is done). Here's and example of using these two hooks to change the
13995 default file modes the new mail files get:
13998 (add-hook 'nnmail-pre-get-new-mail-hook
13999 (lambda () (set-default-file-modes 511)))
14001 (add-hook 'nnmail-post-get-new-mail-hook
14002 (lambda () (set-default-file-modes 551)))
14005 @item nnmail-use-long-file-names
14006 @vindex nnmail-use-long-file-names
14007 If non-@code{nil}, the mail back ends will use long file and directory
14008 names. Groups like @samp{mail.misc} will end up in directories
14009 (assuming use of @code{nnml} back end) or files (assuming use of
14010 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
14011 the same group will end up in @file{mail/misc}.
14013 @item nnmail-delete-file-function
14014 @vindex nnmail-delete-file-function
14015 @findex delete-file
14016 Function called to delete files. It is @code{delete-file} by default.
14018 @item nnmail-cache-accepted-message-ids
14019 @vindex nnmail-cache-accepted-message-ids
14020 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
14021 the back end (via @code{Gcc}, for instance) into the mail duplication
14022 discovery cache. The default is @code{nil}.
14024 @item nnmail-cache-ignore-groups
14025 @vindex nnmail-cache-ignore-groups
14026 This can be a regular expression or a list of regular expressions.
14027 Group names that match any of the regular expressions will never be
14028 recorded in the @code{Message-ID} cache.
14030 This can be useful, for example, when using Fancy Splitting
14031 (@pxref{Fancy Mail Splitting}) together with the function
14032 @code{nnmail-split-fancy-with-parent}.
14037 @node Fancy Mail Splitting
14038 @subsection Fancy Mail Splitting
14039 @cindex mail splitting
14040 @cindex fancy mail splitting
14042 @vindex nnmail-split-fancy
14043 @findex nnmail-split-fancy
14044 If the rather simple, standard method for specifying how to split mail
14045 doesn't allow you to do what you want, you can set
14046 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
14047 play with the @code{nnmail-split-fancy} variable.
14049 Let's look at an example value of this variable first:
14052 ;; @r{Messages from the mailer daemon are not crossposted to any of}
14053 ;; @r{the ordinary groups. Warnings are put in a separate group}
14054 ;; @r{from real errors.}
14055 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
14057 ;; @r{Non-error messages are crossposted to all relevant}
14058 ;; @r{groups, but we don't crosspost between the group for the}
14059 ;; @r{(ding) list and the group for other (ding) related mail.}
14060 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
14061 ("subject" "ding" "ding.misc"))
14062 ;; @r{Other mailing lists@dots{}}
14063 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
14064 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
14065 ;; @r{Both lists below have the same suffix, so prevent}
14066 ;; @r{cross-posting to mkpkg.list of messages posted only to}
14067 ;; @r{the bugs- list, but allow cross-posting when the}
14068 ;; @r{message was really cross-posted.}
14069 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
14070 (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list")
14071 ;; @r{People@dots{}}
14072 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
14073 ;; @r{Unmatched mail goes to the catch all group.}
14077 This variable has the format of a @dfn{split}. A split is a
14078 (possibly) recursive structure where each split may contain other
14079 splits. Here are the possible split syntaxes:
14084 If the split is a string, that will be taken as a group name. Normal
14085 regexp match expansion will be done. See below for examples.
14087 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split})
14088 If the split is a list, the first element of which is a string, then
14089 store the message as specified by @var{split}, if header @var{field}
14090 (a regexp) contains @var{value} (also a regexp). If @var{restrict}
14091 (yet another regexp) matches some string after @var{field} and before
14092 the end of the matched @var{value}, the @var{split} is ignored. If
14093 none of the @var{restrict} clauses match, @var{split} is processed.
14095 @item (| @var{split} @dots{})
14096 If the split is a list, and the first element is @code{|} (vertical
14097 bar), then process each @var{split} until one of them matches. A
14098 @var{split} is said to match if it will cause the mail message to be
14099 stored in one or more groups.
14101 @item (& @var{split} @dots{})
14102 If the split is a list, and the first element is @code{&}, then
14103 process all @var{split}s in the list.
14106 If the split is the symbol @code{junk}, then don't save (i.e., delete)
14107 this message. Use with extreme caution.
14109 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
14110 If the split is a list, and the first element is @samp{:}, then the
14111 second element will be called as a function with @var{args} given as
14112 arguments. The function should return a @var{split}.
14115 For instance, the following function could be used to split based on the
14116 body of the messages:
14119 (defun split-on-body ()
14123 (goto-char (point-min))
14124 (when (re-search-forward "Some.*string" nil t)
14128 The buffer is narrowed to the message in question when @var{function}
14129 is run. That's why @code{(widen)} needs to be called after
14130 @code{save-excursion} and @code{save-restriction} in the example
14131 above. Also note that with the nnimap back end, message bodies will
14132 not be downloaded by default. You need to set
14133 @code{nnimap-split-download-body} to @code{t} to do that
14134 (@pxref{Splitting in IMAP}).
14136 @item (! @var{func} @var{split})
14137 If the split is a list, and the first element is @code{!}, then
14138 @var{split} will be processed, and @var{func} will be called as a
14139 function with the result of @var{split} as argument. @var{func}
14140 should return a split.
14143 If the split is @code{nil}, it is ignored.
14147 In these splits, @var{field} must match a complete field name.
14148 @var{value} must match a complete word according to the fundamental mode
14149 syntax table. You can use @code{.*} in the regexps to match partial
14150 field names or words. In other words, all @var{value}'s are wrapped in
14151 @samp{\<} and @samp{\>} pairs.
14153 @vindex nnmail-split-abbrev-alist
14154 @var{field} and @var{value} can also be Lisp symbols, in that case
14155 they are expanded as specified by the variable
14156 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
14157 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14158 contains the associated value. Predefined entries in
14159 @code{nnmail-split-abbrev-alist} include:
14163 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14165 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14166 @samp{Resent-To} and @samp{Resent-Cc} fields.
14168 Is the union of the @code{from} and @code{to} entries.
14171 @vindex nnmail-split-fancy-syntax-table
14172 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14173 when all this splitting is performed.
14175 If you want to have Gnus create groups dynamically based on some
14176 information in the headers (i.e., do @code{replace-match}-like
14177 substitutions in the group names), you can say things like:
14180 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14183 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14184 will be filed in @samp{mail.debian.foo}.
14186 If the string contains the element @samp{\&}, then the previously
14187 matched string will be substituted. Similarly, the elements @samp{\\1}
14188 up to @samp{\\9} will be substituted with the text matched by the
14189 groupings 1 through 9.
14191 @vindex nnmail-split-lowercase-expanded
14192 Where @code{nnmail-split-lowercase-expanded} controls whether the
14193 lowercase of the matched string should be used for the substitution.
14194 Setting it as non-@code{nil} is useful to avoid the creation of multiple
14195 groups when users send to an address using different case
14196 (i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value
14199 @vindex nnmail-split-fancy-match-partial-words
14200 @code{nnmail-split-fancy-match-partial-words} controls whether partial
14201 words are matched during fancy splitting.
14203 Normally, regular expressions given in @code{nnmail-split-fancy} are
14204 implicitly surrounded by @code{\<...\>} markers, which are word
14205 delimiters. If this variable is true, they are not implicitly
14206 surrounded by anything.
14209 (any "joe" "joemail")
14212 In this example, messages sent from @samp{joedavis@@foo.org} will
14213 normally not be filed in @samp{joemail}. With
14214 @code{nnmail-split-fancy-match-partial-words} set to t, however, the
14215 match will happen. In effect, the requirement of a word boundary is
14216 removed and instead the match becomes more like a grep.
14218 @findex nnmail-split-fancy-with-parent
14219 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14220 split followups into the same groups their parents are in. Sometimes
14221 you can't make splitting rules for all your mail. For example, your
14222 boss might send you personal mail regarding different projects you are
14223 working on, and as you can't tell your boss to put a distinguishing
14224 string into the subject line, you have to resort to manually moving the
14225 messages into the right group. With this function, you only have to do
14226 it once per thread.
14228 To use this feature, you have to set @code{nnmail-treat-duplicates}
14229 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14230 value. And then you can include @code{nnmail-split-fancy-with-parent}
14231 using the colon feature, like so:
14233 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
14234 nnmail-cache-accepted-message-ids t
14236 '(| (: nnmail-split-fancy-with-parent)
14237 ;; @r{other splits go here}
14241 This feature works as follows: when @code{nnmail-treat-duplicates} is
14242 non-@code{nil}, Gnus records the message id of every message it sees
14243 in the file specified by the variable
14244 @code{nnmail-message-id-cache-file}, together with the group it is in
14245 (the group is omitted for non-mail messages). When mail splitting is
14246 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
14247 at the References (and In-Reply-To) header of each message to split
14248 and searches the file specified by @code{nnmail-message-id-cache-file}
14249 for the message ids. When it has found a parent, it returns the
14250 corresponding group name unless the group name matches the regexp
14251 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
14252 recommended that you set @code{nnmail-message-id-cache-length} to a
14253 somewhat higher number than the default so that the message ids are
14254 still in the cache. (A value of 5000 appears to create a file some
14255 300 kBytes in size.)
14256 @vindex nnmail-cache-accepted-message-ids
14257 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
14258 also records the message ids of moved articles, so that the followup
14259 messages goes into the new group.
14261 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
14262 want certain groups to be recorded in the cache. For example, if all
14263 outgoing messages are written to an ``outgoing'' group, you could set
14264 @code{nnmail-cache-ignore-groups} to match that group name.
14265 Otherwise, answers to all your messages would end up in the
14266 ``outgoing'' group.
14269 @node Group Mail Splitting
14270 @subsection Group Mail Splitting
14271 @cindex mail splitting
14272 @cindex group mail splitting
14274 @findex gnus-group-split
14275 If you subscribe to dozens of mailing lists but you don't want to
14276 maintain mail splitting rules manually, group mail splitting is for you.
14277 You just have to set @code{to-list} and/or @code{to-address} in group
14278 parameters or group customization and set @code{nnmail-split-methods} to
14279 @code{gnus-group-split}. This splitting function will scan all groups
14280 for those parameters and split mail accordingly, i.e., messages posted
14281 from or to the addresses specified in the parameters @code{to-list} or
14282 @code{to-address} of a mail group will be stored in that group.
14284 Sometimes, mailing lists have multiple addresses, and you may want mail
14285 splitting to recognize them all: just set the @code{extra-aliases} group
14286 parameter to the list of additional addresses and it's done. If you'd
14287 rather use a regular expression, set @code{split-regexp}.
14289 All these parameters in a group will be used to create an
14290 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
14291 the @var{value} is a single regular expression that matches
14292 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
14293 matches of @code{split-regexp}, and the @var{split} is the name of the
14294 group. @var{restrict}s are also supported: just set the
14295 @code{split-exclude} parameter to a list of regular expressions.
14297 If you can't get the right split to be generated using all these
14298 parameters, or you just need something fancier, you can set the
14299 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
14300 this case, all other aforementioned parameters will be ignored by
14301 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
14302 @code{nil}, in which case the group will be ignored by
14303 @code{gnus-group-split}.
14305 @vindex gnus-group-split-default-catch-all-group
14306 @code{gnus-group-split} will do cross-posting on all groups that match,
14307 by defining a single @code{&} fancy split containing one split for each
14308 group. If a message doesn't match any split, it will be stored in the
14309 group named in @code{gnus-group-split-default-catch-all-group}, unless
14310 some group has @code{split-spec} set to @code{catch-all}, in which case
14311 that group is used as the catch-all group. Even though this variable is
14312 often used just to name a group, it may also be set to an arbitrarily
14313 complex fancy split (after all, a group name is a fancy split), and this
14314 may be useful to split mail that doesn't go to any mailing list to
14315 personal mail folders. Note that this fancy split is added as the last
14316 element of a @code{|} split list that also contains a @code{&} split
14317 with the rules extracted from group parameters.
14319 It's time for an example. Assume the following group parameters have
14324 ((to-address . "bar@@femail.com")
14325 (split-regexp . ".*@@femail\\.com"))
14327 ((to-list . "foo@@nowhere.gov")
14328 (extra-aliases "foo@@localhost" "foo-redist@@home")
14329 (split-exclude "bugs-foo" "rambling-foo")
14330 (admin-address . "foo-request@@nowhere.gov"))
14332 ((split-spec . catch-all))
14335 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
14336 behave as if @code{nnmail-split-fancy} had been selected and variable
14337 @code{nnmail-split-fancy} had been set as follows:
14340 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
14341 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
14342 - "bugs-foo" - "rambling-foo" "mail.foo"))
14346 @findex gnus-group-split-fancy
14347 If you'd rather not use group splitting for all your mail groups, you
14348 may use it for only some of them, by using @code{nnmail-split-fancy}
14352 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
14355 @var{groups} may be a regular expression or a list of group names whose
14356 parameters will be scanned to generate the output split.
14357 @var{no-crosspost} can be used to disable cross-posting; in this case, a
14358 single @code{|} split will be output. @var{catch-all} is the fall back
14359 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
14360 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
14361 empty string in any selected group, no catch-all split will be issued.
14362 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
14363 this group will override the value of the @var{catch-all} argument.
14365 @findex gnus-group-split-setup
14366 Unfortunately, scanning all groups and their parameters can be quite
14367 slow, especially considering that it has to be done for every message.
14368 But don't despair! The function @code{gnus-group-split-setup} can be
14369 used to enable @code{gnus-group-split} in a much more efficient way. It
14370 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
14371 @code{nnmail-split-fancy} to the split produced by
14372 @code{gnus-group-split-fancy}. Thus, the group parameters are only
14373 scanned once, no matter how many messages are split.
14375 @findex gnus-group-split-update
14376 However, if you change group parameters, you'd have to update
14377 @code{nnmail-split-fancy} manually. You can do it by running
14378 @code{gnus-group-split-update}. If you'd rather have it updated
14379 automatically, just tell @code{gnus-group-split-setup} to do it for
14380 you. For example, add to your @file{~/.gnus.el}:
14383 (gnus-group-split-setup @var{auto-update} @var{catch-all})
14386 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
14387 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
14388 have to worry about updating @code{nnmail-split-fancy} again. If you
14389 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
14390 @code{gnus-group-split-default-catch-all-group} will be set to its
14393 @vindex gnus-group-split-updated-hook
14394 Because you may want to change @code{nnmail-split-fancy} after it is set
14395 by @code{gnus-group-split-update}, this function will run
14396 @code{gnus-group-split-updated-hook} just before finishing.
14398 @node Incorporating Old Mail
14399 @subsection Incorporating Old Mail
14400 @cindex incorporating old mail
14401 @cindex import old mail
14403 Most people have lots of old mail stored in various file formats. If
14404 you have set up Gnus to read mail using one of the spiffy Gnus mail
14405 back ends, you'll probably wish to have that old mail incorporated into
14408 Doing so can be quite easy.
14410 To take an example: You're reading mail using @code{nnml}
14411 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
14412 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
14413 file filled with important, but old, mail. You want to move it into
14414 your @code{nnml} groups.
14420 Go to the group buffer.
14423 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
14424 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
14427 Type @kbd{SPACE} to enter the newly created group.
14430 Type @kbd{M P b} to process-mark all articles in this group's buffer
14431 (@pxref{Setting Process Marks}).
14434 Type @kbd{B r} to respool all the process-marked articles, and answer
14435 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
14438 All the mail messages in the mbox file will now also be spread out over
14439 all your @code{nnml} groups. Try entering them and check whether things
14440 have gone without a glitch. If things look ok, you may consider
14441 deleting the mbox file, but I wouldn't do that unless I was absolutely
14442 sure that all the mail has ended up where it should be.
14444 Respooling is also a handy thing to do if you're switching from one mail
14445 back end to another. Just respool all the mail in the old mail groups
14446 using the new mail back end.
14449 @node Expiring Mail
14450 @subsection Expiring Mail
14451 @cindex article expiry
14453 Traditional mail readers have a tendency to remove mail articles when
14454 you mark them as read, in some way. Gnus takes a fundamentally
14455 different approach to mail reading.
14457 Gnus basically considers mail just to be news that has been received in
14458 a rather peculiar manner. It does not think that it has the power to
14459 actually change the mail, or delete any mail messages. If you enter a
14460 mail group, and mark articles as ``read'', or kill them in some other
14461 fashion, the mail articles will still exist on the system. I repeat:
14462 Gnus will not delete your old, read mail. Unless you ask it to, of
14465 To make Gnus get rid of your unwanted mail, you have to mark the
14466 articles as @dfn{expirable}. (With the default key bindings, this means
14467 that you have to type @kbd{E}.) This does not mean that the articles
14468 will disappear right away, however. In general, a mail article will be
14469 deleted from your system if, 1) it is marked as expirable, AND 2) it is
14470 more than one week old. If you do not mark an article as expirable, it
14471 will remain on your system until hell freezes over. This bears
14472 repeating one more time, with some spurious capitalizations: IF you do
14473 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
14475 You do not have to mark articles as expirable by hand. Gnus provides
14476 two features, called ``auto-expire'' and ``total-expire'', that can help you
14477 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
14478 for you when you select an article. And ``total-expire'' means that Gnus
14479 considers all articles as expirable that are read. So, in addition to
14480 the articles marked @samp{E}, also the articles marked @samp{r},
14481 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
14484 When should either auto-expire or total-expire be used? Most people
14485 who are subscribed to mailing lists split each list into its own group
14486 and then turn on auto-expire or total-expire for those groups.
14487 (@xref{Splitting Mail}, for more information on splitting each list
14488 into its own group.)
14490 Which one is better, auto-expire or total-expire? It's not easy to
14491 answer. Generally speaking, auto-expire is probably faster. Another
14492 advantage of auto-expire is that you get more marks to work with: for
14493 the articles that are supposed to stick around, you can still choose
14494 between tick and dormant and read marks. But with total-expire, you
14495 only have dormant and ticked to choose from. The advantage of
14496 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
14497 Scoring}). Auto-expire works with normal scoring but not with adaptive
14500 @vindex gnus-auto-expirable-newsgroups
14501 Groups that match the regular expression
14502 @code{gnus-auto-expirable-newsgroups} will have all articles that you
14503 read marked as expirable automatically. All articles marked as
14504 expirable have an @samp{E} in the first column in the summary buffer.
14506 By default, if you have auto expiry switched on, Gnus will mark all the
14507 articles you read as expirable, no matter if they were read or unread
14508 before. To avoid having articles marked as read marked as expirable
14509 automatically, you can put something like the following in your
14510 @file{~/.gnus.el} file:
14512 @vindex gnus-mark-article-hook
14514 (remove-hook 'gnus-mark-article-hook
14515 'gnus-summary-mark-read-and-unread-as-read)
14516 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
14519 Note that making a group auto-expirable doesn't mean that all read
14520 articles are expired---only the articles marked as expirable
14521 will be expired. Also note that using the @kbd{d} command won't make
14522 articles expirable---only semi-automatic marking of articles as read will
14523 mark the articles as expirable in auto-expirable groups.
14525 Let's say you subscribe to a couple of mailing lists, and you want the
14526 articles you have read to disappear after a while:
14529 (setq gnus-auto-expirable-newsgroups
14530 "mail.nonsense-list\\|mail.nice-list")
14533 Another way to have auto-expiry happen is to have the element
14534 @code{auto-expire} in the group parameters of the group.
14536 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
14537 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
14538 don't really mix very well.
14540 @vindex nnmail-expiry-wait
14541 The @code{nnmail-expiry-wait} variable supplies the default time an
14542 expirable article has to live. Gnus starts counting days from when the
14543 message @emph{arrived}, not from when it was sent. The default is seven
14546 Gnus also supplies a function that lets you fine-tune how long articles
14547 are to live, based on what group they are in. Let's say you want to
14548 have one month expiry period in the @samp{mail.private} group, a one day
14549 expiry period in the @samp{mail.junk} group, and a six day expiry period
14552 @vindex nnmail-expiry-wait-function
14554 (setq nnmail-expiry-wait-function
14556 (cond ((string= group "mail.private")
14558 ((string= group "mail.junk")
14560 ((string= group "important")
14566 The group names this function is fed are ``unadorned'' group
14567 names---no @samp{nnml:} prefixes and the like.
14569 The @code{nnmail-expiry-wait} variable and
14570 @code{nnmail-expiry-wait-function} function can either be a number (not
14571 necessarily an integer) or one of the symbols @code{immediate} or
14574 You can also use the @code{expiry-wait} group parameter to selectively
14575 change the expiry period (@pxref{Group Parameters}).
14577 @vindex nnmail-expiry-target
14578 The normal action taken when expiring articles is to delete them.
14579 However, in some circumstances it might make more sense to move them
14580 to other groups instead of deleting them. The variable
14581 @code{nnmail-expiry-target} (and the @code{expiry-target} group
14582 parameter) controls this. The variable supplies a default value for
14583 all groups, which can be overridden for specific groups by the group
14584 parameter. default value is @code{delete}, but this can also be a
14585 string (which should be the name of the group the message should be
14586 moved to), or a function (which will be called in a buffer narrowed to
14587 the message in question, and with the name of the group being moved
14588 from as its parameter) which should return a target---either a group
14589 name or @code{delete}.
14591 Here's an example for specifying a group name:
14593 (setq nnmail-expiry-target "nnml:expired")
14596 @findex nnmail-fancy-expiry-target
14597 @vindex nnmail-fancy-expiry-targets
14598 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
14599 expire mail to groups according to the variable
14600 @code{nnmail-fancy-expiry-targets}. Here's an example:
14603 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
14604 nnmail-fancy-expiry-targets
14605 '((to-from "boss" "nnfolder:Work")
14606 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
14607 ("from" ".*" "nnfolder:Archive-%Y")))
14610 With this setup, any mail that has @code{IMPORTANT} in its Subject
14611 header and was sent in the year @code{YYYY} and month @code{MMM}, will
14612 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
14613 From or To header contains the string @code{boss}, it will get expired
14614 to @code{nnfolder:Work}. All other mail will get expired to
14615 @code{nnfolder:Archive-YYYY}.
14617 @vindex nnmail-keep-last-article
14618 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
14619 expire the final article in a mail newsgroup. This is to make life
14620 easier for procmail users.
14622 @vindex gnus-total-expirable-newsgroups
14623 By the way: That line up there, about Gnus never expiring non-expirable
14624 articles, is a lie. If you put @code{total-expire} in the group
14625 parameters, articles will not be marked as expirable, but all read
14626 articles will be put through the expiry process. Use with extreme
14627 caution. Even more dangerous is the
14628 @code{gnus-total-expirable-newsgroups} variable. All groups that match
14629 this regexp will have all read articles put through the expiry process,
14630 which means that @emph{all} old mail articles in the groups in question
14631 will be deleted after a while. Use with extreme caution, and don't come
14632 crying to me when you discover that the regexp you used matched the
14633 wrong group and all your important mail has disappeared. Be a
14634 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
14637 Most people make most of their mail groups total-expirable, though.
14639 @vindex gnus-inhibit-user-auto-expire
14640 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
14641 commands will not mark an article as expirable, even if the group has
14642 auto-expire turned on.
14646 @subsection Washing Mail
14647 @cindex mail washing
14648 @cindex list server brain damage
14649 @cindex incoming mail treatment
14651 Mailers and list servers are notorious for doing all sorts of really,
14652 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
14653 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
14654 end of all lines passing through our server, so let's do that!!!!1!''
14655 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
14656 considered to be self-evident were not discussed. So. Here we are.
14658 Case in point: The German version of Microsoft Exchange adds @samp{AW:
14659 } to the subjects of replies instead of @samp{Re: }. I could pretend to
14660 be shocked and dismayed by this, but I haven't got the energy. It is to
14663 Gnus provides a plethora of functions for washing articles while
14664 displaying them, but it might be nicer to do the filtering before
14665 storing the mail to disk. For that purpose, we have three hooks and
14666 various functions that can be put in these hooks.
14669 @item nnmail-prepare-incoming-hook
14670 @vindex nnmail-prepare-incoming-hook
14671 This hook is called before doing anything with the mail and is meant for
14672 grand, sweeping gestures. It is called in a buffer that contains all
14673 the new, incoming mail. Functions to be used include:
14676 @item nnheader-ms-strip-cr
14677 @findex nnheader-ms-strip-cr
14678 Remove trailing carriage returns from each line. This is default on
14679 Emacs running on MS machines.
14683 @item nnmail-prepare-incoming-header-hook
14684 @vindex nnmail-prepare-incoming-header-hook
14685 This hook is called narrowed to each header. It can be used when
14686 cleaning up the headers. Functions that can be used include:
14689 @item nnmail-remove-leading-whitespace
14690 @findex nnmail-remove-leading-whitespace
14691 Clear leading white space that ``helpful'' listservs have added to the
14692 headers to make them look nice. Aaah.
14694 (Note that this function works on both the header on the body of all
14695 messages, so it is a potentially dangerous function to use (if a body
14696 of a message contains something that looks like a header line). So
14697 rather than fix the bug, it is of course the right solution to make it
14698 into a feature by documenting it.)
14700 @item nnmail-remove-list-identifiers
14701 @findex nnmail-remove-list-identifiers
14702 Some list servers add an identifier---for example, @samp{(idm)}---to the
14703 beginning of all @code{Subject} headers. I'm sure that's nice for
14704 people who use stone age mail readers. This function will remove
14705 strings that match the @code{nnmail-list-identifiers} regexp, which can
14706 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
14709 For instance, if you want to remove the @samp{(idm)} and the
14710 @samp{nagnagnag} identifiers:
14713 (setq nnmail-list-identifiers
14714 '("(idm)" "nagnagnag"))
14717 This can also be done non-destructively with
14718 @code{gnus-list-identifiers}, @xref{Article Hiding}.
14720 @item nnmail-remove-tabs
14721 @findex nnmail-remove-tabs
14722 Translate all @samp{TAB} characters into @samp{SPACE} characters.
14724 @item nnmail-fix-eudora-headers
14725 @findex nnmail-fix-eudora-headers
14727 Eudora produces broken @code{References} headers, but OK
14728 @code{In-Reply-To} headers. This function will get rid of the
14729 @code{References} headers.
14733 @item nnmail-prepare-incoming-message-hook
14734 @vindex nnmail-prepare-incoming-message-hook
14735 This hook is called narrowed to each message. Functions to be used
14739 @item article-de-quoted-unreadable
14740 @findex article-de-quoted-unreadable
14741 Decode Quoted Readable encoding.
14748 @subsection Duplicates
14750 @vindex nnmail-treat-duplicates
14751 @vindex nnmail-message-id-cache-length
14752 @vindex nnmail-message-id-cache-file
14753 @cindex duplicate mails
14754 If you are a member of a couple of mailing lists, you will sometimes
14755 receive two copies of the same mail. This can be quite annoying, so
14756 @code{nnmail} checks for and treats any duplicates it might find. To do
14757 this, it keeps a cache of old @code{Message-ID}s---
14758 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
14759 default. The approximate maximum number of @code{Message-ID}s stored
14760 there is controlled by the @code{nnmail-message-id-cache-length}
14761 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
14762 stored.) If all this sounds scary to you, you can set
14763 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
14764 default), and @code{nnmail} won't delete duplicate mails. Instead it
14765 will insert a warning into the head of the mail saying that it thinks
14766 that this is a duplicate of a different message.
14768 This variable can also be a function. If that's the case, the function
14769 will be called from a buffer narrowed to the message in question with
14770 the @code{Message-ID} as a parameter. The function must return either
14771 @code{nil}, @code{warn}, or @code{delete}.
14773 You can turn this feature off completely by setting the variable to
14776 If you want all the duplicate mails to be put into a special
14777 @dfn{duplicates} group, you could do that using the normal mail split
14781 (setq nnmail-split-fancy
14782 '(| ;; @r{Messages duplicates go to a separate group.}
14783 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14784 ;; @r{Message from daemons, postmaster, and the like to another.}
14785 (any mail "mail.misc")
14786 ;; @r{Other rules.}
14792 (setq nnmail-split-methods
14793 '(("duplicates" "^Gnus-Warning:.*duplicate")
14794 ;; @r{Other rules.}
14798 Here's a neat feature: If you know that the recipient reads her mail
14799 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14800 @code{delete}, you can send her as many insults as you like, just by
14801 using a @code{Message-ID} of a mail that you know that she's already
14802 received. Think of all the fun! She'll never see any of it! Whee!
14805 @node Not Reading Mail
14806 @subsection Not Reading Mail
14808 If you start using any of the mail back ends, they have the annoying
14809 habit of assuming that you want to read mail with them. This might not
14810 be unreasonable, but it might not be what you want.
14812 If you set @code{mail-sources} and @code{nnmail-spool-file} to
14813 @code{nil}, none of the back ends will ever attempt to read incoming
14814 mail, which should help.
14816 @vindex nnbabyl-get-new-mail
14817 @vindex nnmbox-get-new-mail
14818 @vindex nnml-get-new-mail
14819 @vindex nnmh-get-new-mail
14820 @vindex nnfolder-get-new-mail
14821 This might be too much, if, for instance, you are reading mail quite
14822 happily with @code{nnml} and just want to peek at some old Rmail
14823 file you have stashed away with @code{nnbabyl}. All back ends have
14824 variables called back-end-@code{get-new-mail}. If you want to disable
14825 the @code{nnbabyl} mail reading, you edit the virtual server for the
14826 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
14828 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
14829 narrowed to the article to be saved before saving it when reading
14833 @node Choosing a Mail Back End
14834 @subsection Choosing a Mail Back End
14836 Gnus will read the mail spool when you activate a mail group. The mail
14837 file is first copied to your home directory. What happens after that
14838 depends on what format you want to store your mail in.
14840 There are six different mail back ends in the standard Gnus, and more
14841 back ends are available separately. The mail back end most people use
14842 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
14846 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
14847 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
14848 * Mail Spool:: Store your mail in a private spool?
14849 * MH Spool:: An mhspool-like back end.
14850 * Maildir:: Another one-file-per-message format.
14851 * Mail Folders:: Having one file for each group.
14852 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
14856 @node Unix Mail Box
14857 @subsubsection Unix Mail Box
14859 @cindex unix mail box
14861 @vindex nnmbox-active-file
14862 @vindex nnmbox-mbox-file
14863 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
14864 mail. @code{nnmbox} will add extra headers to each mail article to say
14865 which group it belongs in.
14867 Virtual server settings:
14870 @item nnmbox-mbox-file
14871 @vindex nnmbox-mbox-file
14872 The name of the mail box in the user's home directory. Default is
14875 @item nnmbox-active-file
14876 @vindex nnmbox-active-file
14877 The name of the active file for the mail box. Default is
14878 @file{~/.mbox-active}.
14880 @item nnmbox-get-new-mail
14881 @vindex nnmbox-get-new-mail
14882 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
14883 into groups. Default is @code{t}.
14888 @subsubsection Rmail Babyl
14892 @vindex nnbabyl-active-file
14893 @vindex nnbabyl-mbox-file
14894 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
14895 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
14896 mail article to say which group it belongs in.
14898 Virtual server settings:
14901 @item nnbabyl-mbox-file
14902 @vindex nnbabyl-mbox-file
14903 The name of the Rmail mbox file. The default is @file{~/RMAIL}
14905 @item nnbabyl-active-file
14906 @vindex nnbabyl-active-file
14907 The name of the active file for the rmail box. The default is
14908 @file{~/.rmail-active}
14910 @item nnbabyl-get-new-mail
14911 @vindex nnbabyl-get-new-mail
14912 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
14918 @subsubsection Mail Spool
14920 @cindex mail @acronym{NOV} spool
14922 The @dfn{nnml} spool mail format isn't compatible with any other known
14923 format. It should be used with some caution.
14925 @vindex nnml-directory
14926 If you use this back end, Gnus will split all incoming mail into files,
14927 one file for each mail, and put the articles into the corresponding
14928 directories under the directory specified by the @code{nnml-directory}
14929 variable. The default value is @file{~/Mail/}.
14931 You do not have to create any directories beforehand; Gnus will take
14934 If you have a strict limit as to how many files you are allowed to store
14935 in your account, you should not use this back end. As each mail gets its
14936 own file, you might very well occupy thousands of inodes within a few
14937 weeks. If this is no problem for you, and it isn't a problem for you
14938 having your friendly systems administrator walking around, madly,
14939 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
14940 know that this is probably the fastest format to use. You do not have
14941 to trudge through a big mbox file just to read your new mail.
14943 @code{nnml} is probably the slowest back end when it comes to article
14944 splitting. It has to create lots of files, and it also generates
14945 @acronym{NOV} databases for the incoming mails. This makes it possibly the
14946 fastest back end when it comes to reading mail.
14948 @cindex self contained nnml servers
14950 When the marks file is used (which it is by default), @code{nnml}
14951 servers have the property that you may backup them using @code{tar} or
14952 similar, and later be able to restore them into Gnus (by adding the
14953 proper @code{nnml} server) and have all your marks be preserved. Marks
14954 for a group is usually stored in the @code{.marks} file (but see
14955 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
14956 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
14957 to restore the group (after restoring the backup into the nnml
14960 If for some reason you believe your @file{.marks} files are screwed
14961 up, you can just delete them all. Gnus will then correctly regenerate
14962 them next time it starts.
14964 Virtual server settings:
14967 @item nnml-directory
14968 @vindex nnml-directory
14969 All @code{nnml} directories will be placed under this directory. The
14970 default is the value of @code{message-directory} (whose default value
14973 @item nnml-active-file
14974 @vindex nnml-active-file
14975 The active file for the @code{nnml} server. The default is
14976 @file{~/Mail/active}.
14978 @item nnml-newsgroups-file
14979 @vindex nnml-newsgroups-file
14980 The @code{nnml} group descriptions file. @xref{Newsgroups File
14981 Format}. The default is @file{~/Mail/newsgroups}.
14983 @item nnml-get-new-mail
14984 @vindex nnml-get-new-mail
14985 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
14988 @item nnml-nov-is-evil
14989 @vindex nnml-nov-is-evil
14990 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
14991 default is @code{nil}.
14993 @item nnml-nov-file-name
14994 @vindex nnml-nov-file-name
14995 The name of the @acronym{NOV} files. The default is @file{.overview}.
14997 @item nnml-prepare-save-mail-hook
14998 @vindex nnml-prepare-save-mail-hook
14999 Hook run narrowed to an article before saving.
15001 @item nnml-marks-is-evil
15002 @vindex nnml-marks-is-evil
15003 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15004 default is @code{nil}.
15006 @item nnml-marks-file-name
15007 @vindex nnml-marks-file-name
15008 The name of the @dfn{marks} files. The default is @file{.marks}.
15010 @item nnml-use-compressed-files
15011 @vindex nnml-use-compressed-files
15012 If non-@code{nil}, @code{nnml} will allow using compressed message
15017 @findex nnml-generate-nov-databases
15018 If your @code{nnml} groups and @acronym{NOV} files get totally out of
15019 whack, you can do a complete update by typing @kbd{M-x
15020 nnml-generate-nov-databases}. This command will trawl through the
15021 entire @code{nnml} hierarchy, looking at each and every article, so it
15022 might take a while to complete. A better interface to this
15023 functionality can be found in the server buffer (@pxref{Server
15028 @subsubsection MH Spool
15030 @cindex mh-e mail spool
15032 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
15033 @acronym{NOV} databases and it doesn't keep an active file or marks
15034 file. This makes @code{nnmh} a @emph{much} slower back end than
15035 @code{nnml}, but it also makes it easier to write procmail scripts
15038 Virtual server settings:
15041 @item nnmh-directory
15042 @vindex nnmh-directory
15043 All @code{nnmh} directories will be located under this directory. The
15044 default is the value of @code{message-directory} (whose default is
15047 @item nnmh-get-new-mail
15048 @vindex nnmh-get-new-mail
15049 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
15053 @vindex nnmh-be-safe
15054 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
15055 sure that the articles in the folder are actually what Gnus thinks
15056 they are. It will check date stamps and stat everything in sight, so
15057 setting this to @code{t} will mean a serious slow-down. If you never
15058 use anything but Gnus to read the @code{nnmh} articles, you do not
15059 have to set this variable to @code{t}. The default is @code{nil}.
15064 @subsubsection Maildir
15068 @code{nnmaildir} stores mail in the maildir format, with each maildir
15069 corresponding to a group in Gnus. This format is documented here:
15070 @uref{http://cr.yp.to/proto/maildir.html} and here:
15071 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
15072 also stores extra information in the @file{.nnmaildir/} directory
15075 Maildir format was designed to allow concurrent deliveries and
15076 reading, without needing locks. With other back ends, you would have
15077 your mail delivered to a spool of some kind, and then you would
15078 configure Gnus to split mail from that spool into your groups. You
15079 can still do that with @code{nnmaildir}, but the more common
15080 configuration is to have your mail delivered directly to the maildirs
15081 that appear as group in Gnus.
15083 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
15084 never corrupt its data in memory, and @code{SIGKILL} will never
15085 corrupt its data in the filesystem.
15087 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
15088 maildir. So you can copy a whole maildir from one Gnus setup to
15089 another, and you will keep your marks.
15091 Virtual server settings:
15095 For each of your @code{nnmaildir} servers (it's very unlikely that
15096 you'd need more than one), you need to create a directory and populate
15097 it with maildirs or symlinks to maildirs (and nothing else; do not
15098 choose a directory already used for other purposes). Each maildir
15099 will be represented in Gnus as a newsgroup on that server; the
15100 filename of the symlink will be the name of the group. Any filenames
15101 in the directory starting with @samp{.} are ignored. The directory is
15102 scanned when you first start Gnus, and each time you type @kbd{g} in
15103 the group buffer; if any maildirs have been removed or added,
15104 @code{nnmaildir} notices at these times.
15106 The value of the @code{directory} parameter should be a Lisp form
15107 which is processed by @code{eval} and @code{expand-file-name} to get
15108 the path of the directory for this server. The form is @code{eval}ed
15109 only when the server is opened; the resulting string is used until the
15110 server is closed. (If you don't know about forms and @code{eval},
15111 don't worry---a simple string will work.) This parameter is not
15112 optional; you must specify it. I don't recommend using
15113 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
15114 use that directory by default for various things, and may get confused
15115 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
15118 @item target-prefix
15119 This should be a Lisp form which is processed by @code{eval} and
15120 @code{expand-file-name}. The form is @code{eval}ed only when the
15121 server is opened; the resulting string is used until the server is
15124 When you create a group on an @code{nnmaildir} server, the maildir is
15125 created with @code{target-prefix} prepended to its name, and a symlink
15126 pointing to that maildir is created, named with the plain group name.
15127 So if @code{directory} is @code{"~/.nnmaildir"} and
15128 @code{target-prefix} is @code{"../maildirs/"}, then when you create
15129 the group @code{foo}, @code{nnmaildir} will create
15130 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
15131 @file{~/.nnmaildir/foo} as a symlink pointing to
15132 @file{../maildirs/foo}.
15134 You can set @code{target-prefix} to a string without any slashes to
15135 create both maildirs and symlinks in the same @code{directory}; in
15136 this case, any maildirs found in @code{directory} whose names start
15137 with @code{target-prefix} will not be listed as groups (but the
15138 symlinks pointing to them will be).
15140 As a special case, if @code{target-prefix} is @code{""} (the default),
15141 then when you create a group, the maildir will be created in
15142 @code{directory} without a corresponding symlink. Beware that you
15143 cannot use @code{gnus-group-delete-group} on such groups without the
15144 @code{force} argument.
15146 @item directory-files
15147 This should be a function with the same interface as
15148 @code{directory-files} (such as @code{directory-files} itself). It is
15149 used to scan the server's @code{directory} for maildirs. This
15150 parameter is optional; the default is
15151 @code{nnheader-directory-files-safe} if
15152 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15153 @code{directory-files} otherwise.
15154 (@code{nnheader-directory-files-is-safe} is checked only once when the
15155 server is opened; if you want to check it each time the directory is
15156 scanned, you'll have to provide your own function that does that.)
15159 If non-@code{nil}, then after scanning for new mail in the group
15160 maildirs themselves as usual, this server will also incorporate mail
15161 the conventional Gnus way, from @code{mail-sources} according to
15162 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
15163 value is @code{nil}.
15165 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15166 an @code{nnmaildir} group. The results might happen to be useful, but
15167 that would be by chance, not by design, and the results might be
15168 different in the future. If your split rules create new groups,
15169 remember to supply a @code{create-directory} server parameter.
15172 @subsubsection Group parameters
15174 @code{nnmaildir} uses several group parameters. It's safe to ignore
15175 all this; the default behavior for @code{nnmaildir} is the same as the
15176 default behavior for other mail back ends: articles are deleted after
15177 one week, etc. Except for the expiry parameters, all this
15178 functionality is unique to @code{nnmaildir}, so you can ignore it if
15179 you're just trying to duplicate the behavior you already have with
15182 If the value of any of these parameters is a vector, the first element
15183 is evaluated as a Lisp form and the result is used, rather than the
15184 original value. If the value is not a vector, the value itself is
15185 evaluated as a Lisp form. (This is why these parameters use names
15186 different from those of other, similar parameters supported by other
15187 back ends: they have different, though similar, meanings.) (For
15188 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15189 @code{eval} business again; for other values, remember to use an extra
15190 quote and wrap the value in a vector when appropriate.)
15194 An integer specifying the minimum age, in seconds, of an article
15195 before it will be expired, or the symbol @code{never} to specify that
15196 articles should never be expired. If this parameter is not set,
15197 @code{nnmaildir} falls back to the usual
15198 @code{nnmail-expiry-wait}(@code{-function}) variables (overrideable by
15199 the @code{expiry-wait}(@code{-function}) group parameters. If you
15200 wanted a value of 3 days, you could use something like @code{[(* 3 24
15201 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15202 An article's age is measured starting from the article file's
15203 modification time. Normally, this is the same as the article's
15204 delivery time, but editing an article makes it younger. Moving an
15205 article (other than via expiry) may also make an article younger.
15208 If this is set to a string such as a full Gnus group name, like
15210 "backend+server.address.string:group.name"
15212 and if it is not the name of the same group that the parameter belongs
15213 to, then articles will be moved to the specified group during expiry
15214 before being deleted. @emph{If this is set to an @code{nnmaildir}
15215 group, the article will be just as old in the destination group as it
15216 was in the source group.} So be careful with @code{expire-age} in the
15217 destination group. If this is set to the name of the same group that
15218 the parameter belongs to, then the article is not expired at all. If
15219 you use the vector form, the first element is evaluated once for each
15220 article. So that form can refer to
15221 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15222 article. @emph{If this parameter is not set, @code{nnmaildir} does
15223 not fall back to the @code{expiry-target} group parameter or the
15224 @code{nnmail-expiry-target} variable.}
15227 If this is set to @code{t}, @code{nnmaildir} will treat the articles
15228 in this maildir as read-only. This means: articles are not renamed
15229 from @file{new/} into @file{cur/}; articles are only found in
15230 @file{new/}, not @file{cur/}; articles are never deleted; articles
15231 cannot be edited. @file{new/} is expected to be a symlink to the
15232 @file{new/} directory of another maildir---e.g., a system-wide mailbox
15233 containing a mailing list of common interest. Everything in the
15234 maildir outside @file{new/} is @emph{not} treated as read-only, so for
15235 a shared mailbox, you do still need to set up your own maildir (or
15236 have write permission to the shared mailbox); your maildir just won't
15237 contain extra copies of the articles.
15239 @item directory-files
15240 A function with the same interface as @code{directory-files}. It is
15241 used to scan the directories in the maildir corresponding to this
15242 group to find articles. The default is the function specified by the
15243 server's @code{directory-files} parameter.
15245 @item distrust-Lines:
15246 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
15247 article, rather than use the @code{Lines:} header field. If
15248 @code{nil}, the header field will be used if present.
15251 A list of mark symbols, such as @code{['(read expire)]}. Whenever
15252 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15253 say that all articles have these marks, regardless of whether the
15254 marks stored in the filesystem say so. This is a proof-of-concept
15255 feature that will probably be removed eventually; it ought to be done
15256 in Gnus proper, or abandoned if it's not worthwhile.
15259 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
15260 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15261 say that no articles have these marks, regardless of whether the marks
15262 stored in the filesystem say so. @code{never-marks} overrides
15263 @code{always-marks}. This is a proof-of-concept feature that will
15264 probably be removed eventually; it ought to be done in Gnus proper, or
15265 abandoned if it's not worthwhile.
15267 @item nov-cache-size
15268 An integer specifying the size of the @acronym{NOV} memory cache. To
15269 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
15270 for a limited number of articles in each group. (This is probably not
15271 worthwhile, and will probably be removed in the future.) This
15272 parameter's value is noticed only the first time a group is seen after
15273 the server is opened---i.e., when you first start Gnus, typically.
15274 The @acronym{NOV} cache is never resized until the server is closed
15275 and reopened. The default is an estimate of the number of articles
15276 that would be displayed in the summary buffer: a count of articles
15277 that are either marked with @code{tick} or not marked with
15278 @code{read}, plus a little extra.
15281 @subsubsection Article identification
15282 Articles are stored in the @file{cur/} subdirectory of each maildir.
15283 Each article file is named like @code{uniq:info}, where @code{uniq}
15284 contains no colons. @code{nnmaildir} ignores, but preserves, the
15285 @code{:info} part. (Other maildir readers typically use this part of
15286 the filename to store marks.) The @code{uniq} part uniquely
15287 identifies the article, and is used in various places in the
15288 @file{.nnmaildir/} subdirectory of the maildir to store information
15289 about the corresponding article. The full pathname of an article is
15290 available in the variable @code{nnmaildir-article-file-name} after you
15291 request the article in the summary buffer.
15293 @subsubsection NOV data
15294 An article identified by @code{uniq} has its @acronym{NOV} data (used
15295 to generate lines in the summary buffer) stored in
15296 @code{.nnmaildir/nov/uniq}. There is no
15297 @code{nnmaildir-generate-nov-databases} function. (There isn't much
15298 need for it---an article's @acronym{NOV} data is updated automatically
15299 when the article or @code{nnmail-extra-headers} has changed.) You can
15300 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
15301 single article simply by deleting the corresponding @acronym{NOV}
15302 file, but @emph{beware}: this will also cause @code{nnmaildir} to
15303 assign a new article number for this article, which may cause trouble
15304 with @code{seen} marks, the Agent, and the cache.
15306 @subsubsection Article marks
15307 An article identified by @code{uniq} is considered to have the mark
15308 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
15309 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
15310 looks for such files and reports the set of marks it finds. When Gnus
15311 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
15312 creates and deletes the corresponding files as needed. (Actually,
15313 rather than create a new file for each mark, it just creates hard
15314 links to @file{.nnmaildir/markfile}, to save inodes.)
15316 You can invent new marks by creating a new directory in
15317 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
15318 your server, untar it later, and keep your marks. You can add and
15319 remove marks yourself by creating and deleting mark files. If you do
15320 this while Gnus is running and your @code{nnmaildir} server is open,
15321 it's best to exit all summary buffers for @code{nnmaildir} groups and
15322 type @kbd{s} in the group buffer first, and to type @kbd{g} or
15323 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
15324 pick up the changes, and might undo them.
15328 @subsubsection Mail Folders
15330 @cindex mbox folders
15331 @cindex mail folders
15333 @code{nnfolder} is a back end for storing each mail group in a
15334 separate file. Each file is in the standard Un*x mbox format.
15335 @code{nnfolder} will add extra headers to keep track of article
15336 numbers and arrival dates.
15338 @cindex self contained nnfolder servers
15340 When the marks file is used (which it is by default), @code{nnfolder}
15341 servers have the property that you may backup them using @code{tar} or
15342 similar, and later be able to restore them into Gnus (by adding the
15343 proper @code{nnfolder} server) and have all your marks be preserved.
15344 Marks for a group is usually stored in a file named as the mbox file
15345 with @code{.mrk} concatenated to it (but see
15346 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
15347 directory. Individual @code{nnfolder} groups are also possible to
15348 backup, use @kbd{G m} to restore the group (after restoring the backup
15349 into the @code{nnfolder} directory).
15351 Virtual server settings:
15354 @item nnfolder-directory
15355 @vindex nnfolder-directory
15356 All the @code{nnfolder} mail boxes will be stored under this
15357 directory. The default is the value of @code{message-directory}
15358 (whose default is @file{~/Mail})
15360 @item nnfolder-active-file
15361 @vindex nnfolder-active-file
15362 The name of the active file. The default is @file{~/Mail/active}.
15364 @item nnfolder-newsgroups-file
15365 @vindex nnfolder-newsgroups-file
15366 The name of the group descriptions file. @xref{Newsgroups File
15367 Format}. The default is @file{~/Mail/newsgroups}
15369 @item nnfolder-get-new-mail
15370 @vindex nnfolder-get-new-mail
15371 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
15372 default is @code{t}
15374 @item nnfolder-save-buffer-hook
15375 @vindex nnfolder-save-buffer-hook
15376 @cindex backup files
15377 Hook run before saving the folders. Note that Emacs does the normal
15378 backup renaming of files even with the @code{nnfolder} buffers. If
15379 you wish to switch this off, you could say something like the
15380 following in your @file{.emacs} file:
15383 (defun turn-off-backup ()
15384 (set (make-local-variable 'backup-inhibited) t))
15386 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
15389 @item nnfolder-delete-mail-hook
15390 @vindex nnfolder-delete-mail-hook
15391 Hook run in a buffer narrowed to the message that is to be deleted.
15392 This function can be used to copy the message to somewhere else, or to
15393 extract some information from it before removing it.
15395 @item nnfolder-nov-is-evil
15396 @vindex nnfolder-nov-is-evil
15397 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15398 default is @code{nil}.
15400 @item nnfolder-nov-file-suffix
15401 @vindex nnfolder-nov-file-suffix
15402 The extension for @acronym{NOV} files. The default is @file{.nov}.
15404 @item nnfolder-nov-directory
15405 @vindex nnfolder-nov-directory
15406 The directory where the @acronym{NOV} files should be stored. If
15407 @code{nil}, @code{nnfolder-directory} is used.
15409 @item nnfolder-marks-is-evil
15410 @vindex nnfolder-marks-is-evil
15411 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15412 default is @code{nil}.
15414 @item nnfolder-marks-file-suffix
15415 @vindex nnfolder-marks-file-suffix
15416 The extension for @sc{marks} files. The default is @file{.mrk}.
15418 @item nnfolder-marks-directory
15419 @vindex nnfolder-marks-directory
15420 The directory where the @sc{marks} files should be stored. If
15421 @code{nil}, @code{nnfolder-directory} is used.
15426 @findex nnfolder-generate-active-file
15427 @kindex M-x nnfolder-generate-active-file
15428 If you have lots of @code{nnfolder}-like files you'd like to read with
15429 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
15430 command to make @code{nnfolder} aware of all likely files in
15431 @code{nnfolder-directory}. This only works if you use long file names,
15434 @node Comparing Mail Back Ends
15435 @subsubsection Comparing Mail Back Ends
15437 First, just for terminology, the @dfn{back end} is the common word for a
15438 low-level access method---a transport, if you will, by which something
15439 is acquired. The sense is that one's mail has to come from somewhere,
15440 and so selection of a suitable back end is required in order to get that
15441 mail within spitting distance of Gnus.
15443 The same concept exists for Usenet itself: Though access to articles is
15444 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
15445 in the world got at Usenet by running a reader on the machine where the
15446 articles lay (the machine which today we call an @acronym{NNTP} server), and
15447 access was by the reader stepping into the articles' directory spool
15448 area directly. One can still select between either the @code{nntp} or
15449 @code{nnspool} back ends, to select between these methods, if one happens
15450 actually to live on the server (or can see its spool directly, anyway,
15453 The goal in selecting a mail back end is to pick one which
15454 simultaneously represents a suitable way of dealing with the original
15455 format plus leaving mail in a form that is convenient to use in the
15456 future. Here are some high and low points on each:
15461 UNIX systems have historically had a single, very common, and well-
15462 defined format. All messages arrive in a single @dfn{spool file}, and
15463 they are delineated by a line whose regular expression matches
15464 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
15465 to make it clear in this instance that this is not the RFC-specified
15466 @samp{From:} header.) Because Emacs and therefore Gnus emanate
15467 historically from the Unix environment, it is simplest if one does not
15468 mess a great deal with the original mailbox format, so if one chooses
15469 this back end, Gnus' primary activity in getting mail from the real spool
15470 area to Gnus' preferred directory is simply to copy it, with no
15471 (appreciable) format change in the process. It is the ``dumbest'' way
15472 to move mail into availability in the Gnus environment. This makes it
15473 fast to move into place, but slow to parse, when Gnus has to look at
15478 Once upon a time, there was the DEC-10 and DEC-20, running operating
15479 systems called TOPS and related things, and the usual (only?) mail
15480 reading environment was a thing called Babyl. I don't know what format
15481 was used for mail landing on the system, but Babyl had its own internal
15482 format to which mail was converted, primarily involving creating a
15483 spool-file-like entity with a scheme for inserting Babyl-specific
15484 headers and status bits above the top of each message in the file.
15485 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
15486 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
15487 to understand the mail files folks already had in existence. Gnus (and
15488 VM, for that matter) continue to support this format because it's
15489 perceived as having some good qualities in those mailer-specific
15490 headers/status bits stuff. Rmail itself still exists as well, of
15491 course, and is still maintained by Stallman.
15493 Both of the above forms leave your mail in a single file on your
15494 file system, and they must parse that entire file each time you take a
15499 @code{nnml} is the back end which smells the most as though you were
15500 actually operating with an @code{nnspool}-accessed Usenet system. (In
15501 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
15502 lo these years ago.) One's mail is taken from the original spool file,
15503 and is then cut up into individual message files, 1:1. It maintains a
15504 Usenet-style active file (analogous to what one finds in an INN- or
15505 CNews-based news system in (for instance) @file{/var/lib/news/active},
15506 or what is returned via the @samp{NNTP LIST} verb) and also creates
15507 @dfn{overview} files for efficient group entry, as has been defined for
15508 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
15509 due to the creation of lots of files, updates to the @code{nnml} active
15510 file, and additions to overview files on a per-message basis, but it is
15511 extremely fast on access because of what amounts to the indexing support
15512 provided by the active file and overviews.
15514 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
15515 resource which defines available places in the file system to put new
15516 files. Sysadmins take a dim view of heavy inode occupation within
15517 tight, shared file systems. But if you live on a personal machine where
15518 the file system is your own and space is not at a premium, @code{nnml}
15521 It is also problematic using this back end if you are living in a
15522 FAT16-based Windows world, since much space will be wasted on all these
15527 The Rand MH mail-reading system has been around UNIX systems for a very
15528 long time; it operates by splitting one's spool file of messages into
15529 individual files, but with little or no indexing support---@code{nnmh}
15530 is considered to be semantically equivalent to ``@code{nnml} without
15531 active file or overviews''. This is arguably the worst choice, because
15532 one gets the slowness of individual file creation married to the
15533 slowness of access parsing when learning what's new in one's groups.
15537 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
15538 method described above) on a per-group basis. That is, @code{nnmbox}
15539 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
15540 little bit of optimization to this so that each of one's mail groups has
15541 a Unix mail box file. It's faster than @code{nnmbox} because each group
15542 can be parsed separately, and still provides the simple Unix mail box
15543 format requiring minimal effort in moving the mail around. In addition,
15544 it maintains an ``active'' file making it much faster for Gnus to figure
15545 out how many messages there are in each separate group.
15547 If you have groups that are expected to have a massive amount of
15548 messages, @code{nnfolder} is not the best choice, but if you receive
15549 only a moderate amount of mail, @code{nnfolder} is probably the most
15550 friendly mail back end all over.
15554 For configuring expiry and other things, @code{nnmaildir} uses
15555 incompatible group parameters, slightly different from those of other
15558 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
15559 differences. Each message is stored in a separate file, but the
15560 filename is unrelated to the article number in Gnus. @code{nnmaildir}
15561 also stores the equivalent of @code{nnml}'s overview files in one file
15562 per article, so it uses about twice as many inodes as @code{nnml}. (Use
15563 @code{df -i} to see how plentiful your inode supply is.) If this slows
15564 you down or takes up very much space, consider switching to
15565 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
15568 Since maildirs don't require locking for delivery, the maildirs you use
15569 as groups can also be the maildirs your mail is directly delivered to.
15570 This means you can skip Gnus' mail splitting if your mail is already
15571 organized into different mailboxes during delivery. A @code{directory}
15572 entry in @code{mail-sources} would have a similar effect, but would
15573 require one set of mailboxes for spooling deliveries (in mbox format,
15574 thus damaging message bodies), and another set to be used as groups (in
15575 whatever format you like). A maildir has a built-in spool, in the
15576 @code{new/} subdirectory. Beware that currently, mail moved from
15577 @code{new/} to @code{cur/} instead of via mail splitting will not
15578 undergo treatment such as duplicate checking.
15580 @code{nnmaildir} stores article marks for a given group in the
15581 corresponding maildir, in a way designed so that it's easy to manipulate
15582 them from outside Gnus. You can tar up a maildir, unpack it somewhere
15583 else, and still have your marks. @code{nnml} also stores marks, but
15584 it's not as easy to work with them from outside Gnus as with
15587 @code{nnmaildir} uses a significant amount of memory to speed things up.
15588 (It keeps in memory some of the things that @code{nnml} stores in files
15589 and that @code{nnmh} repeatedly parses out of message files.) If this
15590 is a problem for you, you can set the @code{nov-cache-size} group
15591 parameter to something small (0 would probably not work, but 1 probably
15592 would) to make it use less memory. This caching will probably be
15593 removed in the future.
15595 Startup is likely to be slower with @code{nnmaildir} than with other
15596 back ends. Everything else is likely to be faster, depending in part
15597 on your file system.
15599 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
15600 to write an @code{nnmaildir}-derived back end.
15605 @node Browsing the Web
15606 @section Browsing the Web
15608 @cindex browsing the web
15612 Web-based discussion forums are getting more and more popular. On many
15613 subjects, the web-based forums have become the most important forums,
15614 eclipsing the importance of mailing lists and news groups. The reason
15615 is easy to understand---they are friendly to new users; you just point
15616 and click, and there's the discussion. With mailing lists, you have to
15617 go through a cumbersome subscription procedure, and most people don't
15618 even know what a news group is.
15620 The problem with this scenario is that web browsers are not very good at
15621 being newsreaders. They do not keep track of what articles you've read;
15622 they do not allow you to score on subjects you're interested in; they do
15623 not allow off-line browsing; they require you to click around and drive
15624 you mad in the end.
15626 So---if web browsers suck at reading discussion forums, why not use Gnus
15629 Gnus has been getting a bit of a collection of back ends for providing
15630 interfaces to these sources.
15634 * Web Searches:: Creating groups from articles that match a string.
15635 * Slashdot:: Reading the Slashdot comments.
15636 * Ultimate:: The Ultimate Bulletin Board systems.
15637 * Web Archive:: Reading mailing list archived on web.
15638 * RSS:: Reading RDF site summary.
15639 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
15642 All the web sources require Emacs/w3 and the url library to work.
15644 The main caveat with all these web sources is that they probably won't
15645 work for a very long time. Gleaning information from the @acronym{HTML} data
15646 is guesswork at best, and when the layout is altered, the Gnus back end
15647 will fail. If you have reasonably new versions of these back ends,
15648 though, you should be ok.
15650 One thing all these Web methods have in common is that the Web sources
15651 are often down, unavailable or just plain too slow to be fun. In those
15652 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
15653 Unplugged}) handle downloading articles, and then you can read them at
15654 leisure from your local disk. No more World Wide Wait for you.
15656 @node Archiving Mail
15657 @subsection Archiving Mail
15658 @cindex archiving mail
15659 @cindex backup of mail
15661 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
15662 @code{nnmaildir}, now actually store the article marks with each group.
15663 For these servers, archiving and restoring a group while preserving
15664 marks is fairly simple.
15666 (Preserving the group level and group parameters as well still
15667 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
15670 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
15671 server, take a recursive copy of the server directory. There is no need
15672 to shut down Gnus, so archiving may be invoked by @code{cron} or
15673 similar. You restore the data by restoring the directory tree, and
15674 adding a server definition pointing to that directory in Gnus. The
15675 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
15676 might interfere with overwriting data, so you may want to shut down Gnus
15677 before you restore the data.
15679 It is also possible to archive individual @code{nnml},
15680 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
15681 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
15682 directory. For @code{nnfolder} you need to copy both the base folder
15683 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
15684 this example). Restoring the group is done with @kbd{G m} from the Group
15685 buffer. The last step makes Gnus notice the new directory.
15686 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
15687 is unnecessary in that case.
15690 @subsection Web Searches
15695 @cindex Usenet searches
15696 @cindex searching the Usenet
15698 It's, like, too neat to search the Usenet for articles that match a
15699 string, but it, like, totally @emph{sucks}, like, totally, to use one of
15700 those, like, Web browsers, and you, like, have to, rilly, like, look at
15701 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
15702 searches without having to use a browser.
15704 The @code{nnweb} back end allows an easy interface to the mighty search
15705 engine. You create an @code{nnweb} group, enter a search pattern, and
15706 then enter the group and read the articles like you would any normal
15707 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
15708 Groups}) will do this in an easy-to-use fashion.
15710 @code{nnweb} groups don't really lend themselves to being solid
15711 groups---they have a very fleeting idea of article numbers. In fact,
15712 each time you enter an @code{nnweb} group (not even changing the search
15713 pattern), you are likely to get the articles ordered in a different
15714 manner. Not even using duplicate suppression (@pxref{Duplicate
15715 Suppression}) will help, since @code{nnweb} doesn't even know the
15716 @code{Message-ID} of the articles before reading them using some search
15717 engines (Google, for instance). The only possible way to keep track
15718 of which articles you've read is by scoring on the @code{Date}
15719 header---mark all articles posted before the last date you read the
15722 If the search engine changes its output substantially, @code{nnweb}
15723 won't be able to parse it and will fail. One could hardly fault the Web
15724 providers if they were to do this---their @emph{raison d'@^etre} is to
15725 make money off of advertisements, not to provide services to the
15726 community. Since @code{nnweb} washes the ads off all the articles, one
15727 might think that the providers might be somewhat miffed. We'll see.
15729 You must have the @code{url} and @code{w3} package installed to be able
15730 to use @code{nnweb}.
15732 Virtual server variables:
15737 What search engine type is being used. The currently supported types
15738 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
15739 @code{dejanews} is an alias to @code{google}.
15742 @vindex nnweb-search
15743 The search string to feed to the search engine.
15745 @item nnweb-max-hits
15746 @vindex nnweb-max-hits
15747 Advisory maximum number of hits per search to display. The default is
15750 @item nnweb-type-definition
15751 @vindex nnweb-type-definition
15752 Type-to-definition alist. This alist says what @code{nnweb} should do
15753 with the various search engine types. The following elements must be
15758 Function to decode the article and provide something that Gnus
15762 Function to create an article number to message header and URL alist.
15765 Function to send the search string to the search engine.
15768 The address the aforementioned function should send the search string
15772 Format string URL to fetch an article by @code{Message-ID}.
15779 @subsection Slashdot
15783 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
15784 lively discussion following the news articles. @code{nnslashdot} will
15785 let you read this forum in a convenient manner.
15787 The easiest way to read this source is to put something like the
15788 following in your @file{~/.gnus.el} file:
15791 (setq gnus-secondary-select-methods
15792 '((nnslashdot "")))
15795 This will make Gnus query the @code{nnslashdot} back end for new comments
15796 and groups. The @kbd{F} command will subscribe each new news article as
15797 a new Gnus group, and you can read the comments by entering these
15798 groups. (Note that the default subscription method is to subscribe new
15799 groups as zombies. Other methods are available (@pxref{Subscription
15802 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
15803 command is the most handy tool (@pxref{Foreign Groups}).
15805 When following up to @code{nnslashdot} comments (or posting new
15806 comments), some light @acronym{HTML}izations will be performed. In
15807 particular, text quoted with @samp{> } will be quoted with
15808 @samp{blockquote} instead, and signatures will have @samp{br} added to
15809 the end of each line. Other than that, you can just write @acronym{HTML}
15810 directly into the message buffer. Note that Slashdot filters out some
15811 @acronym{HTML} forms.
15813 The following variables can be altered to change its behavior:
15816 @item nnslashdot-threaded
15817 Whether @code{nnslashdot} should display threaded groups or not. The
15818 default is @code{t}. To be able to display threads, @code{nnslashdot}
15819 has to retrieve absolutely all comments in a group upon entry. If a
15820 threaded display is not required, @code{nnslashdot} will only retrieve
15821 the comments that are actually wanted by the user. Threading is nicer,
15822 but much, much slower than unthreaded.
15824 @item nnslashdot-login-name
15825 @vindex nnslashdot-login-name
15826 The login name to use when posting.
15828 @item nnslashdot-password
15829 @vindex nnslashdot-password
15830 The password to use when posting.
15832 @item nnslashdot-directory
15833 @vindex nnslashdot-directory
15834 Where @code{nnslashdot} will store its files. The default is
15835 @file{~/News/slashdot/}.
15837 @item nnslashdot-active-url
15838 @vindex nnslashdot-active-url
15839 The @acronym{URL} format string that will be used to fetch the
15840 information on news articles and comments. The default is@*
15841 @samp{http://slashdot.org/search.pl?section=&min=%d}.
15843 @item nnslashdot-comments-url
15844 @vindex nnslashdot-comments-url
15845 The @acronym{URL} format string that will be used to fetch comments.
15847 @item nnslashdot-article-url
15848 @vindex nnslashdot-article-url
15849 The @acronym{URL} format string that will be used to fetch the news
15850 article. The default is
15851 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
15853 @item nnslashdot-threshold
15854 @vindex nnslashdot-threshold
15855 The score threshold. The default is -1.
15857 @item nnslashdot-group-number
15858 @vindex nnslashdot-group-number
15859 The number of old groups, in addition to the ten latest, to keep
15860 updated. The default is 0.
15867 @subsection Ultimate
15869 @cindex Ultimate Bulletin Board
15871 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
15872 probably the most popular Web bulletin board system used. It has a
15873 quite regular and nice interface, and it's possible to get the
15874 information Gnus needs to keep groups updated.
15876 The easiest way to get started with @code{nnultimate} is to say
15877 something like the following in the group buffer: @kbd{B nnultimate RET
15878 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
15879 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
15880 you're interested in; there's quite a list of them on the Ultimate web
15881 site.) Then subscribe to the groups you're interested in from the
15882 server buffer, and read them from the group buffer.
15884 The following @code{nnultimate} variables can be altered:
15887 @item nnultimate-directory
15888 @vindex nnultimate-directory
15889 The directory where @code{nnultimate} stores its files. The default is@*
15890 @file{~/News/ultimate/}.
15895 @subsection Web Archive
15897 @cindex Web Archive
15899 Some mailing lists only have archives on Web servers, such as
15900 @uref{http://www.egroups.com/} and
15901 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
15902 interface, and it's possible to get the information Gnus needs to keep
15905 @findex gnus-group-make-warchive-group
15906 The easiest way to get started with @code{nnwarchive} is to say
15907 something like the following in the group buffer: @kbd{M-x
15908 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
15909 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
15910 @var{an_egroup} with the mailing list you subscribed, the
15911 @var{your@@email.address} with your email address.), or to browse the
15912 back end by @kbd{B nnwarchive RET mail-archive RET}.
15914 The following @code{nnwarchive} variables can be altered:
15917 @item nnwarchive-directory
15918 @vindex nnwarchive-directory
15919 The directory where @code{nnwarchive} stores its files. The default is@*
15920 @file{~/News/warchive/}.
15922 @item nnwarchive-login
15923 @vindex nnwarchive-login
15924 The account name on the web server.
15926 @item nnwarchive-passwd
15927 @vindex nnwarchive-passwd
15928 The password for your account on the web server.
15936 Some web sites have an RDF Site Summary (@acronym{RSS}).
15937 @acronym{RSS} is a format for summarizing headlines from news related
15938 sites (such as BBC or CNN). But basically anything list-like can be
15939 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
15940 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
15942 @acronym{RSS} has a quite regular and nice interface, and it's
15943 possible to get the information Gnus needs to keep groups updated.
15945 @kindex G R (Summary)
15946 Use @kbd{G R} from the summary buffer to subscribe to a feed---you
15947 will be prompted for the location of the feed.
15949 An easy way to get started with @code{nnrss} is to say something like
15950 the following in the group buffer: @kbd{B nnrss RET y}, then
15951 subscribe to groups.
15954 You can also use the following commands to import and export your
15955 subscriptions from a file in @acronym{OPML} format (Outline Processor
15958 @defun nnrss-opml-import file
15959 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
15963 @defun nnrss-opml-export
15964 Write your current @acronym{RSS} subscriptions to a buffer in
15965 @acronym{OPML} format.
15968 The following @code{nnrss} variables can be altered:
15971 @item nnrss-directory
15972 @vindex nnrss-directory
15973 The directory where @code{nnrss} stores its files. The default is
15974 @file{~/News/rss/}.
15976 @item nnrss-use-local
15977 @vindex nnrss-use-local
15978 @findex nnrss-generate-download-script
15979 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
15980 the feeds from local files in @code{nnrss-directory}. You can use
15981 the command @code{nnrss-generate-download-script} to generate a
15982 download script using @command{wget}.
15985 The following code may be helpful, if you want to show the description in
15986 the summary buffer.
15989 (add-to-list 'nnmail-extra-headers nnrss-description-field)
15990 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
15992 (defun gnus-user-format-function-X (header)
15994 (assq nnrss-description-field (mail-header-extra header))))
15995 (if descr (concat "\n\t" (cdr descr)) "")))
15998 The following code may be useful to open an nnrss url directly from the
16001 (require 'browse-url)
16003 (defun browse-nnrss-url( arg )
16005 (let ((url (assq nnrss-url-field
16008 (assq (gnus-summary-article-number)
16009 gnus-newsgroup-data))))))
16012 (browse-url (cdr url))
16013 (gnus-summary-mark-as-read-forward 1))
16014 (gnus-summary-scroll-up arg))))
16016 (eval-after-load "gnus"
16017 #'(define-key gnus-summary-mode-map
16018 (kbd "<RET>") 'browse-nnrss-url))
16019 (add-to-list 'nnmail-extra-headers nnrss-url-field)
16022 @node Customizing w3
16023 @subsection Customizing w3
16029 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
16030 pages. Emacs/w3 is documented in its own manual, but there are some
16031 things that may be more relevant for Gnus users.
16033 For instance, a common question is how to make Emacs/w3 follow links
16034 using the @code{browse-url} functions (which will call some external web
16035 browser like Netscape). Here's one way:
16038 (eval-after-load "w3"
16040 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
16041 (defun w3-fetch (&optional url target)
16042 (interactive (list (w3-read-url-with-default)))
16043 (if (eq major-mode 'gnus-article-mode)
16045 (w3-fetch-orig url target)))))
16048 Put that in your @file{.emacs} file, and hitting links in w3-rendered
16049 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
16056 @cindex @acronym{IMAP}
16058 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
16059 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
16060 server is much similar to connecting to a news server, you just
16061 specify the network address of the server.
16063 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
16064 everything that @acronym{POP} can, it can hence be viewed as a
16065 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
16066 similar to @acronym{NNTP} being a news storage protocol---however,
16067 @acronym{IMAP} offers more features than @acronym{NNTP} because news
16068 is more or less read-only whereas mail is read-write.
16070 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
16071 entry in @code{mail-sources}. With this, Gnus will fetch mails from
16072 the @acronym{IMAP} server and store them on the local disk. This is
16073 not the usage described in this section---@xref{Mail Sources}.
16075 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
16076 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
16077 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
16078 usage explained in this section.
16080 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
16081 servers might look something like the following. (Note that for
16082 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
16086 (setq gnus-secondary-select-methods
16087 '((nnimap "simpleserver") ; @r{no special configuration}
16088 ; @r{perhaps a ssh port forwarded server:}
16090 (nnimap-address "localhost")
16091 (nnimap-server-port 1430))
16092 ; @r{a UW server running on localhost}
16094 (nnimap-server-port 143)
16095 (nnimap-address "localhost")
16096 (nnimap-list-pattern ("INBOX" "mail/*")))
16097 ; @r{anonymous public cyrus server:}
16098 (nnimap "cyrus.andrew.cmu.edu"
16099 (nnimap-authenticator anonymous)
16100 (nnimap-list-pattern "archive.*")
16101 (nnimap-stream network))
16102 ; @r{a ssl server on a non-standard port:}
16104 (nnimap-address "vic20.somewhere.com")
16105 (nnimap-server-port 9930)
16106 (nnimap-stream ssl))))
16109 After defining the new server, you can subscribe to groups on the
16110 server using normal Gnus commands such as @kbd{U} in the Group Buffer
16111 (@pxref{Subscription Commands}) or via the Server Buffer
16112 (@pxref{Server Buffer}).
16114 The following variables can be used to create a virtual @code{nnimap}
16119 @item nnimap-address
16120 @vindex nnimap-address
16122 The address of the remote @acronym{IMAP} server. Defaults to the virtual
16123 server name if not specified.
16125 @item nnimap-server-port
16126 @vindex nnimap-server-port
16127 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
16129 Note that this should be an integer, example server specification:
16132 (nnimap "mail.server.com"
16133 (nnimap-server-port 4711))
16136 @item nnimap-list-pattern
16137 @vindex nnimap-list-pattern
16138 String or list of strings of mailboxes to limit available groups to.
16139 This is used when the server has very many mailboxes and you're only
16140 interested in a few---some servers export your home directory via
16141 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
16142 @file{~/Mail/*} then.
16144 The string can also be a cons of REFERENCE and the string as above, what
16145 REFERENCE is used for is server specific, but on the University of
16146 Washington server it's a directory that will be concatenated with the
16149 Example server specification:
16152 (nnimap "mail.server.com"
16153 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
16154 ("~friend/Mail/" . "list/*"))))
16157 @item nnimap-stream
16158 @vindex nnimap-stream
16159 The type of stream used to connect to your server. By default, nnimap
16160 will detect and automatically use all of the below, with the exception
16161 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
16162 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
16163 be automatically detected, but it's not widely deployed yet.)
16165 Example server specification:
16168 (nnimap "mail.server.com"
16169 (nnimap-stream ssl))
16172 Please note that the value of @code{nnimap-stream} is a symbol!
16176 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
16177 @samp{gsasl} or @samp{imtest} program.
16179 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
16181 @dfn{starttls:} Connect via the STARTTLS extension (similar to
16182 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
16185 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
16186 @samp{gnutls-cli}).
16188 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
16189 @samp{openssl}) or SSLeay (@samp{s_client}).
16191 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
16193 @dfn{network:} Plain, TCP/IP network connection.
16196 @vindex imap-kerberos4-program
16197 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
16198 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
16199 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
16200 to make @code{imap.el} use a pty instead of a pipe when communicating
16201 with @samp{imtest}. You will then suffer from a line length
16202 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
16203 indefinitely if you have many articles in a mailbox. The variable
16204 @code{imap-kerberos4-program} contain parameters to pass to the imtest
16207 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
16208 needed. It is available from
16209 @uref{http://www.gnu.org/software/gnutls/}.
16211 @vindex imap-gssapi-program
16212 This parameter specifies a list of command lines that invoke a GSSAPI
16213 authenticated @acronym{IMAP} stream in a subshell. They are tried
16214 sequentially until a connection is made, or the list has been
16215 exhausted. By default, @samp{gsasl} from GNU SASL, available from
16216 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
16217 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
16220 @vindex imap-ssl-program
16221 For @acronym{SSL} connections, the OpenSSL program is available from
16222 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
16223 and nnimap support it too---although the most recent versions of
16224 SSLeay, 0.9.x, are known to have serious bugs making it
16225 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
16226 work. The variable @code{imap-ssl-program} contain parameters to pass
16229 @vindex imap-shell-program
16230 @vindex imap-shell-host
16231 For @acronym{IMAP} connections using the @code{shell} stream, the variable
16232 @code{imap-shell-program} specify what program to call.
16234 @item nnimap-authenticator
16235 @vindex nnimap-authenticator
16237 The authenticator used to connect to the server. By default, nnimap
16238 will use the most secure authenticator your server is capable of.
16240 Example server specification:
16243 (nnimap "mail.server.com"
16244 (nnimap-authenticator anonymous))
16247 Please note that the value of @code{nnimap-authenticator} is a symbol!
16251 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
16252 external program @code{gsasl} or @code{imtest}.
16254 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
16257 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
16258 external library @code{digest-md5.el}.
16260 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
16262 @dfn{login:} Plain-text username/password via LOGIN.
16264 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
16267 @item nnimap-expunge-on-close
16269 @vindex nnimap-expunge-on-close
16270 Unlike Parmenides the @acronym{IMAP} designers have decided things that
16271 don't exist actually do exist. More specifically, @acronym{IMAP} has
16272 this concept of marking articles @code{Deleted} which doesn't actually
16273 delete them, and this (marking them @code{Deleted}, that is) is what
16274 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
16277 Since the articles aren't really removed when we mark them with the
16278 @code{Deleted} flag we'll need a way to actually delete them. Feel like
16279 running in circles yet?
16281 Traditionally, nnimap has removed all articles marked as @code{Deleted}
16282 when closing a mailbox but this is now configurable by this server
16285 The possible options are:
16290 The default behavior, delete all articles marked as ``Deleted'' when
16293 Never actually delete articles. Currently there is no way of showing
16294 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
16295 may allow you to do this. If you ever want to run the EXPUNGE command
16296 manually, @xref{Expunging mailboxes}.
16298 When closing mailboxes, nnimap will ask if you wish to expunge deleted
16303 @item nnimap-importantize-dormant
16304 @vindex nnimap-importantize-dormant
16306 If non-@code{nil} (the default), marks dormant articles as ticked (as
16307 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
16308 naturally still (only) be marked as dormant. This is to make dormant
16309 articles stand out, just like ticked articles, in other @acronym{IMAP}
16310 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
16313 Probably the only reason for frobing this would be if you're trying
16314 enable per-user persistent dormant flags, using something like:
16317 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
16318 (format "gnus-dormant-%s" (user-login-name)))
16319 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
16320 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
16323 In this case, you would not want the per-user dormant flag showing up
16324 as ticked for other users.
16326 @item nnimap-expunge-search-string
16328 @vindex nnimap-expunge-search-string
16330 This variable contain the @acronym{IMAP} search command sent to server when
16331 searching for articles eligible for expiring. The default is
16332 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
16333 UID set and the second @code{%s} is replaced by a date.
16335 Probably the only useful value to change this to is
16336 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
16337 messages instead of the internal article date. See section 6.4.4 of
16338 RFC 2060 for more information on valid strings.
16340 @item nnimap-authinfo-file
16341 @vindex nnimap-authinfo-file
16343 A file containing credentials used to log in on servers. The format is
16344 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
16345 variable @code{nntp-authinfo-file} for exact syntax; also see
16346 @ref{NNTP}. An example of an .authinfo line for an IMAP server, is:
16349 machine students.uio.no login larsi password geheimnis port imap
16352 Note that it should be @code{port imap}, or @code{port 143}, if you
16353 use a @code{nnimap-stream} of @code{tls} or @code{ssl}, even if the
16354 actual port number used is port 993 for secured IMAP. For
16355 convenience, Gnus will accept @code{port imaps} as a synonym of
16358 @item nnimap-need-unselect-to-notice-new-mail
16359 @vindex nnimap-need-unselect-to-notice-new-mail
16361 Unselect mailboxes before looking for new mail in them. Some servers
16362 seem to need this under some circumstances; it was reported that
16368 * Splitting in IMAP:: Splitting mail with nnimap.
16369 * Expiring in IMAP:: Expiring mail with nnimap.
16370 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
16371 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
16372 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
16373 * Debugging IMAP:: What to do when things don't work.
16378 @node Splitting in IMAP
16379 @subsection Splitting in IMAP
16380 @cindex splitting imap mail
16382 Splitting is something Gnus users have loved and used for years, and now
16383 the rest of the world is catching up. Yeah, dream on, not many
16384 @acronym{IMAP} servers have server side splitting and those that have
16385 splitting seem to use some non-standard protocol. This means that
16386 @acronym{IMAP} support for Gnus has to do its own splitting.
16390 (Incidentally, people seem to have been dreaming on, and Sieve has
16391 gaining a market share and is supported by several IMAP servers.
16392 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
16394 Here are the variables of interest:
16398 @item nnimap-split-crosspost
16399 @cindex splitting, crosspost
16401 @vindex nnimap-split-crosspost
16403 If non-@code{nil}, do crossposting if several split methods match the
16404 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
16405 found will be used.
16407 Nnmail equivalent: @code{nnmail-crosspost}.
16409 @item nnimap-split-inbox
16410 @cindex splitting, inbox
16412 @vindex nnimap-split-inbox
16414 A string or a list of strings that gives the name(s) of @acronym{IMAP}
16415 mailboxes to split from. Defaults to @code{nil}, which means that
16416 splitting is disabled!
16419 (setq nnimap-split-inbox
16420 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
16423 No nnmail equivalent.
16425 @item nnimap-split-rule
16426 @cindex splitting, rules
16427 @vindex nnimap-split-rule
16429 New mail found in @code{nnimap-split-inbox} will be split according to
16432 This variable contains a list of lists, where the first element in the
16433 sublist gives the name of the @acronym{IMAP} mailbox to move articles
16434 matching the regexp in the second element in the sublist. Got that?
16435 Neither did I, we need examples.
16438 (setq nnimap-split-rule
16440 "^Sender: owner-nnimap@@vic20.globalcom.se")
16441 ("INBOX.junk" "^Subject:.*MAKE MONEY")
16442 ("INBOX.private" "")))
16445 This will put all articles from the nnimap mailing list into mailbox
16446 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
16447 into INBOX.junk and everything else in INBOX.private.
16449 The first string may contain @samp{\\1} forms, like the ones used by
16450 replace-match to insert sub-expressions from the matched text. For
16454 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
16457 The first element can also be the symbol @code{junk} to indicate that
16458 matching messages should simply be deleted. Use with care.
16460 The second element can also be a function. In that case, it will be
16461 called with the first element of the rule as the argument, in a buffer
16462 containing the headers of the article. It should return a
16463 non-@code{nil} value if it thinks that the mail belongs in that group.
16465 Nnmail users might recollect that the last regexp had to be empty to
16466 match all articles (like in the example above). This is not required in
16467 nnimap. Articles not matching any of the regexps will not be moved out
16468 of your inbox. (This might affect performance if you keep lots of
16469 unread articles in your inbox, since the splitting code would go over
16470 them every time you fetch new mail.)
16472 These rules are processed from the beginning of the alist toward the
16473 end. The first rule to make a match will ``win'', unless you have
16474 crossposting enabled. In that case, all matching rules will ``win''.
16476 This variable can also have a function as its value, the function will
16477 be called with the headers narrowed and should return a group where it
16478 thinks the article should be split to. See @code{nnimap-split-fancy}.
16480 The splitting code tries to create mailboxes if it needs to.
16482 To allow for different split rules on different virtual servers, and
16483 even different split rules in different inboxes on the same server,
16484 the syntax of this variable have been extended along the lines of:
16487 (setq nnimap-split-rule
16488 '(("my1server" (".*" (("ding" "ding@@gnus.org")
16489 ("junk" "From:.*Simon"))))
16490 ("my2server" ("INBOX" nnimap-split-fancy))
16491 ("my[34]server" (".*" (("private" "To:.*Simon")
16492 ("junk" my-junk-func))))))
16495 The virtual server name is in fact a regexp, so that the same rules
16496 may apply to several servers. In the example, the servers
16497 @code{my3server} and @code{my4server} both use the same rules.
16498 Similarly, the inbox string is also a regexp. The actual splitting
16499 rules are as before, either a function, or a list with group/regexp or
16500 group/function elements.
16502 Nnmail equivalent: @code{nnmail-split-methods}.
16504 @item nnimap-split-predicate
16506 @vindex nnimap-split-predicate
16508 Mail matching this predicate in @code{nnimap-split-inbox} will be
16509 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
16511 This might be useful if you use another @acronym{IMAP} client to read mail in
16512 your inbox but would like Gnus to split all articles in the inbox
16513 regardless of readedness. Then you might change this to
16516 @item nnimap-split-fancy
16517 @cindex splitting, fancy
16518 @findex nnimap-split-fancy
16519 @vindex nnimap-split-fancy
16521 It's possible to set @code{nnimap-split-rule} to
16522 @code{nnmail-split-fancy} if you want to use fancy
16523 splitting. @xref{Fancy Mail Splitting}.
16525 However, to be able to have different fancy split rules for nnmail and
16526 nnimap back ends you can set @code{nnimap-split-rule} to
16527 @code{nnimap-split-fancy} and define the nnimap specific fancy split
16528 rule in @code{nnimap-split-fancy}.
16533 (setq nnimap-split-rule 'nnimap-split-fancy
16534 nnimap-split-fancy ...)
16537 Nnmail equivalent: @code{nnmail-split-fancy}.
16539 @item nnimap-split-download-body
16540 @findex nnimap-split-download-body
16541 @vindex nnimap-split-download-body
16543 Set to non-@code{nil} to download entire articles during splitting.
16544 This is generally not required, and will slow things down
16545 considerably. You may need it if you want to use an advanced
16546 splitting function that analyses the body to split the article.
16550 @node Expiring in IMAP
16551 @subsection Expiring in IMAP
16552 @cindex expiring imap mail
16554 Even though @code{nnimap} is not a proper @code{nnmail} derived back
16555 end, it supports most features in regular expiring (@pxref{Expiring
16556 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
16557 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
16558 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
16559 follows below are the variables used by the @code{nnimap} expiry
16562 A note on how the expire mark is stored on the @acronym{IMAP} server is
16563 appropriate here as well. The expire mark is translated into a
16564 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
16565 message. This means that likely only Gnus will understand and treat
16566 the @code{gnus-expire} mark properly, although other clients may allow
16567 you to view client specific flags on the message. It also means that
16568 your server must support permanent storage of client specific flags on
16569 messages. Most do, fortunately.
16573 @item nnmail-expiry-wait
16574 @item nnmail-expiry-wait-function
16576 These variables are fully supported. The expire value can be a
16577 number, the symbol @code{immediate} or @code{never}.
16579 @item nnmail-expiry-target
16581 This variable is supported, and internally implemented by calling the
16582 @code{nnmail} functions that handle this. It contains an optimization
16583 that if the destination is a @acronym{IMAP} group on the same server, the
16584 article is copied instead of appended (that is, uploaded again).
16588 @node Editing IMAP ACLs
16589 @subsection Editing IMAP ACLs
16590 @cindex editing imap acls
16591 @cindex Access Control Lists
16592 @cindex Editing @acronym{IMAP} ACLs
16593 @kindex G l (Group)
16594 @findex gnus-group-nnimap-edit-acl
16596 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
16597 limiting (or enabling) other users access to your mail boxes. Not all
16598 @acronym{IMAP} servers support this, this function will give an error if it
16601 To edit an ACL for a mailbox, type @kbd{G l}
16602 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
16603 editing window with detailed instructions.
16605 Some possible uses:
16609 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
16610 on your mailing list mailboxes enables other users on the same server to
16611 follow the list without subscribing to it.
16613 At least with the Cyrus server, you are required to give the user
16614 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
16615 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
16619 @node Expunging mailboxes
16620 @subsection Expunging mailboxes
16624 @cindex manual expunging
16625 @kindex G x (Group)
16626 @findex gnus-group-nnimap-expunge
16628 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
16629 you may want the option of expunging all deleted articles in a mailbox
16630 manually. This is exactly what @kbd{G x} does.
16632 Currently there is no way of showing deleted articles, you can just
16635 @node A note on namespaces
16636 @subsection A note on namespaces
16637 @cindex IMAP namespace
16640 The @acronym{IMAP} protocol has a concept called namespaces, described
16641 by the following text in the RFC:
16644 5.1.2. Mailbox Namespace Naming Convention
16646 By convention, the first hierarchical element of any mailbox name
16647 which begins with "#" identifies the "namespace" of the remainder of
16648 the name. This makes it possible to disambiguate between different
16649 types of mailbox stores, each of which have their own namespaces.
16651 For example, implementations which offer access to USENET
16652 newsgroups MAY use the "#news" namespace to partition the USENET
16653 newsgroup namespace from that of other mailboxes. Thus, the
16654 comp.mail.misc newsgroup would have an mailbox name of
16655 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
16656 to a different object (e.g. a user's private mailbox).
16659 While there is nothing in this text that warrants concern for the
16660 @acronym{IMAP} implementation in Gnus, some servers use namespace
16661 prefixes in a way that does not work with how Gnus uses mailbox names.
16663 Specifically, University of Washington's @acronym{IMAP} server uses
16664 mailbox names like @code{#driver.mbx/read-mail} which are valid only
16665 in the @sc{create} and @sc{append} commands. After the mailbox is
16666 created (or a messages is appended to a mailbox), it must be accessed
16667 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
16668 not make it possible for the user to guarantee that user entered
16669 mailbox names will only be used with the CREATE and APPEND commands,
16670 you should simply not use the namespace prefixed mailbox names in
16673 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
16674 for more information on how to use the prefixes. They are a power
16675 tool and should be used only if you are sure what the effects are.
16677 @node Debugging IMAP
16678 @subsection Debugging IMAP
16679 @cindex IMAP debugging
16680 @cindex protocol dump (IMAP)
16682 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
16683 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
16684 best to fix them right away. If you encounter odd behaviour, chances
16685 are that either the server or Gnus is buggy.
16687 If you are familiar with network protocols in general, you will
16688 probably be able to extract some clues from the protocol dump of the
16689 exchanges between Gnus and the server. Even if you are not familiar
16690 with network protocols, when you include the protocol dump in
16691 @acronym{IMAP}-related bug reports you are helping us with data
16692 critical to solving the problem. Therefore, we strongly encourage you
16693 to include the protocol dump when reporting IMAP bugs in Gnus.
16697 Because the protocol dump, when enabled, generates lots of data, it is
16698 disabled by default. You can enable it by setting @code{imap-log} as
16705 This instructs the @code{imap.el} package to log any exchanges with
16706 the server. The log is stored in the buffer @samp{*imap-log*}. Look
16707 for error messages, which sometimes are tagged with the keyword
16708 @code{BAD}---but when submitting a bug, make sure to include all the
16711 @node Other Sources
16712 @section Other Sources
16714 Gnus can do more than just read news or mail. The methods described
16715 below allow Gnus to view directories and files as if they were
16719 * Directory Groups:: You can read a directory as if it was a newsgroup.
16720 * Anything Groups:: Dired? Who needs dired?
16721 * Document Groups:: Single files can be the basis of a group.
16722 * SOUP:: Reading @sc{soup} packets ``offline''.
16723 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
16727 @node Directory Groups
16728 @subsection Directory Groups
16730 @cindex directory groups
16732 If you have a directory that has lots of articles in separate files in
16733 it, you might treat it as a newsgroup. The files have to have numerical
16736 This might be an opportune moment to mention @code{ange-ftp} (and its
16737 successor @code{efs}), that most wonderful of all wonderful Emacs
16738 packages. When I wrote @code{nndir}, I didn't think much about it---a
16739 back end to read directories. Big deal.
16741 @code{ange-ftp} changes that picture dramatically. For instance, if you
16742 enter the @code{ange-ftp} file name
16743 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
16744 @code{ange-ftp} or @code{efs} will actually allow you to read this
16745 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
16747 @code{nndir} will use @acronym{NOV} files if they are present.
16749 @code{nndir} is a ``read-only'' back end---you can't delete or expire
16750 articles with this method. You can use @code{nnmh} or @code{nnml} for
16751 whatever you use @code{nndir} for, so you could switch to any of those
16752 methods if you feel the need to have a non-read-only @code{nndir}.
16755 @node Anything Groups
16756 @subsection Anything Groups
16759 From the @code{nndir} back end (which reads a single spool-like
16760 directory), it's just a hop and a skip to @code{nneething}, which
16761 pretends that any arbitrary directory is a newsgroup. Strange, but
16764 When @code{nneething} is presented with a directory, it will scan this
16765 directory and assign article numbers to each file. When you enter such
16766 a group, @code{nneething} must create ``headers'' that Gnus can use.
16767 After all, Gnus is a newsreader, in case you're forgetting.
16768 @code{nneething} does this in a two-step process. First, it snoops each
16769 file in question. If the file looks like an article (i.e., the first
16770 few lines look like headers), it will use this as the head. If this is
16771 just some arbitrary file without a head (e.g. a C source file),
16772 @code{nneething} will cobble up a header out of thin air. It will use
16773 file ownership, name and date and do whatever it can with these
16776 All this should happen automatically for you, and you will be presented
16777 with something that looks very much like a newsgroup. Totally like a
16778 newsgroup, to be precise. If you select an article, it will be displayed
16779 in the article buffer, just as usual.
16781 If you select a line that represents a directory, Gnus will pop you into
16782 a new summary buffer for this @code{nneething} group. And so on. You can
16783 traverse the entire disk this way, if you feel like, but remember that
16784 Gnus is not dired, really, and does not intend to be, either.
16786 There are two overall modes to this action---ephemeral or solid. When
16787 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
16788 will not store information on what files you have read, and what files
16789 are new, and so on. If you create a solid @code{nneething} group the
16790 normal way with @kbd{G m}, Gnus will store a mapping table between
16791 article numbers and file names, and you can treat this group like any
16792 other groups. When you activate a solid @code{nneething} group, you will
16793 be told how many unread articles it contains, etc., etc.
16798 @item nneething-map-file-directory
16799 @vindex nneething-map-file-directory
16800 All the mapping files for solid @code{nneething} groups will be stored
16801 in this directory, which defaults to @file{~/.nneething/}.
16803 @item nneething-exclude-files
16804 @vindex nneething-exclude-files
16805 All files that match this regexp will be ignored. Nice to use to exclude
16806 auto-save files and the like, which is what it does by default.
16808 @item nneething-include-files
16809 @vindex nneething-include-files
16810 Regexp saying what files to include in the group. If this variable is
16811 non-@code{nil}, only files matching this regexp will be included.
16813 @item nneething-map-file
16814 @vindex nneething-map-file
16815 Name of the map files.
16819 @node Document Groups
16820 @subsection Document Groups
16822 @cindex documentation group
16825 @code{nndoc} is a cute little thing that will let you read a single file
16826 as a newsgroup. Several files types are supported:
16833 The Babyl (Rmail) mail box.
16838 The standard Unix mbox file.
16840 @cindex MMDF mail box
16842 The MMDF mail box format.
16845 Several news articles appended into a file.
16848 @cindex rnews batch files
16849 The rnews batch transport format.
16850 @cindex forwarded messages
16853 Forwarded articles.
16856 Netscape mail boxes.
16859 @acronym{MIME} multipart messages.
16861 @item standard-digest
16862 The standard (RFC 1153) digest format.
16865 A @acronym{MIME} digest of messages.
16867 @item lanl-gov-announce
16868 Announcement messages from LANL Gov Announce.
16870 @item rfc822-forward
16871 A message forwarded according to RFC822.
16874 The Outlook mail box.
16877 The Outlook Express dbx mail box.
16880 A bounce message from the Exim MTA.
16883 A message forwarded according to informal rules.
16886 An RFC934-forwarded message.
16892 A digest of Clarinet brief news items.
16895 Non-standard digest format---matches most things, but does it badly.
16901 You can also use the special ``file type'' @code{guess}, which means
16902 that @code{nndoc} will try to guess what file type it is looking at.
16903 @code{digest} means that @code{nndoc} should guess what digest type the
16906 @code{nndoc} will not try to change the file or insert any extra headers into
16907 it---it will simply, like, let you use the file as the basis for a
16908 group. And that's it.
16910 If you have some old archived articles that you want to insert into your
16911 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
16912 that. Say you have an old @file{RMAIL} file with mail that you now want
16913 to split into your new @code{nnml} groups. You look at that file using
16914 @code{nndoc} (using the @kbd{G f} command in the group buffer
16915 (@pxref{Foreign Groups})), set the process mark on all the articles in
16916 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
16917 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
16918 file is now also stored in lots of @code{nnml} directories, and you can
16919 delete that pesky @file{RMAIL} file. If you have the guts!
16921 Virtual server variables:
16924 @item nndoc-article-type
16925 @vindex nndoc-article-type
16926 This should be one of @code{mbox}, @code{babyl}, @code{digest},
16927 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
16928 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
16929 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
16930 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
16932 @item nndoc-post-type
16933 @vindex nndoc-post-type
16934 This variable says whether Gnus is to consider the group a news group or
16935 a mail group. There are two valid values: @code{mail} (the default)
16940 * Document Server Internals:: How to add your own document types.
16944 @node Document Server Internals
16945 @subsubsection Document Server Internals
16947 Adding new document types to be recognized by @code{nndoc} isn't
16948 difficult. You just have to whip up a definition of what the document
16949 looks like, write a predicate function to recognize that document type,
16950 and then hook into @code{nndoc}.
16952 First, here's an example document type definition:
16956 (article-begin . "^\^A\^A\^A\^A\n")
16957 (body-end . "^\^A\^A\^A\^A\n"))
16960 The definition is simply a unique @dfn{name} followed by a series of
16961 regexp pseudo-variable settings. Below are the possible
16962 variables---don't be daunted by the number of variables; most document
16963 types can be defined with very few settings:
16966 @item first-article
16967 If present, @code{nndoc} will skip past all text until it finds
16968 something that match this regexp. All text before this will be
16971 @item article-begin
16972 This setting has to be present in all document type definitions. It
16973 says what the beginning of each article looks like.
16975 @item head-begin-function
16976 If present, this should be a function that moves point to the head of
16979 @item nndoc-head-begin
16980 If present, this should be a regexp that matches the head of the
16983 @item nndoc-head-end
16984 This should match the end of the head of the article. It defaults to
16985 @samp{^$}---the empty line.
16987 @item body-begin-function
16988 If present, this function should move point to the beginning of the body
16992 This should match the beginning of the body of the article. It defaults
16995 @item body-end-function
16996 If present, this function should move point to the end of the body of
17000 If present, this should match the end of the body of the article.
17003 If present, this should match the end of the file. All text after this
17004 regexp will be totally ignored.
17008 So, using these variables @code{nndoc} is able to dissect a document
17009 file into a series of articles, each with a head and a body. However, a
17010 few more variables are needed since not all document types are all that
17011 news-like---variables needed to transform the head or the body into
17012 something that's palatable for Gnus:
17015 @item prepare-body-function
17016 If present, this function will be called when requesting an article. It
17017 will be called with point at the start of the body, and is useful if the
17018 document has encoded some parts of its contents.
17020 @item article-transform-function
17021 If present, this function is called when requesting an article. It's
17022 meant to be used for more wide-ranging transformation of both head and
17023 body of the article.
17025 @item generate-head-function
17026 If present, this function is called to generate a head that Gnus can
17027 understand. It is called with the article number as a parameter, and is
17028 expected to generate a nice head for the article in question. It is
17029 called when requesting the headers of all articles.
17033 Let's look at the most complicated example I can come up with---standard
17038 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
17039 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
17040 (prepare-body-function . nndoc-unquote-dashes)
17041 (body-end-function . nndoc-digest-body-end)
17042 (head-end . "^ ?$")
17043 (body-begin . "^ ?\n")
17044 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
17045 (subtype digest guess))
17048 We see that all text before a 70-width line of dashes is ignored; all
17049 text after a line that starts with that @samp{^End of} is also ignored;
17050 each article begins with a 30-width line of dashes; the line separating
17051 the head from the body may contain a single space; and that the body is
17052 run through @code{nndoc-unquote-dashes} before being delivered.
17054 To hook your own document definition into @code{nndoc}, use the
17055 @code{nndoc-add-type} function. It takes two parameters---the first
17056 is the definition itself and the second (optional) parameter says
17057 where in the document type definition alist to put this definition.
17058 The alist is traversed sequentially, and
17059 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
17060 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
17061 @code{mmdf} type, and so on. These type predicates should return
17062 @code{nil} if the document is not of the correct type; @code{t} if it
17063 is of the correct type; and a number if the document might be of the
17064 correct type. A high number means high probability; a low number
17065 means low probability with @samp{0} being the lowest valid number.
17073 In the PC world people often talk about ``offline'' newsreaders. These
17074 are thingies that are combined reader/news transport monstrosities.
17075 With built-in modem programs. Yecchh!
17077 Of course, us Unix Weenie types of human beans use things like
17078 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
17079 transport things like Ghod intended. And then we just use normal
17082 However, it can sometimes be convenient to do something that's a bit
17083 easier on the brain if you have a very slow modem, and you're not really
17084 that interested in doing things properly.
17086 A file format called @sc{soup} has been developed for transporting news
17087 and mail from servers to home machines and back again. It can be a bit
17090 First some terminology:
17095 This is the machine that is connected to the outside world and where you
17096 get news and/or mail from.
17099 This is the machine that you want to do the actual reading and responding
17100 on. It is typically not connected to the rest of the world in any way.
17103 Something that contains messages and/or commands. There are two kinds
17107 @item message packets
17108 These are packets made at the server, and typically contain lots of
17109 messages for you to read. These are called @file{SoupoutX.tgz} by
17110 default, where @var{x} is a number.
17112 @item response packets
17113 These are packets made at the home machine, and typically contains
17114 replies that you've written. These are called @file{SoupinX.tgz} by
17115 default, where @var{x} is a number.
17125 You log in on the server and create a @sc{soup} packet. You can either
17126 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
17127 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
17128 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
17131 You transfer the packet home. Rail, boat, car or modem will do fine.
17134 You put the packet in your home directory.
17137 You fire up Gnus on your home machine using the @code{nnsoup} back end as
17138 the native or secondary server.
17141 You read articles and mail and answer and followup to the things you
17142 want (@pxref{SOUP Replies}).
17145 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
17149 You transfer this packet to the server.
17152 You use Gnus to mail this packet out with the @kbd{G s s} command.
17155 You then repeat until you die.
17159 So you basically have a bipartite system---you use @code{nnsoup} for
17160 reading and Gnus for packing/sending these @sc{soup} packets.
17163 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
17164 * SOUP Groups:: A back end for reading @sc{soup} packets.
17165 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
17169 @node SOUP Commands
17170 @subsubsection SOUP Commands
17172 These are commands for creating and manipulating @sc{soup} packets.
17176 @kindex G s b (Group)
17177 @findex gnus-group-brew-soup
17178 Pack all unread articles in the current group
17179 (@code{gnus-group-brew-soup}). This command understands the
17180 process/prefix convention.
17183 @kindex G s w (Group)
17184 @findex gnus-soup-save-areas
17185 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
17188 @kindex G s s (Group)
17189 @findex gnus-soup-send-replies
17190 Send all replies from the replies packet
17191 (@code{gnus-soup-send-replies}).
17194 @kindex G s p (Group)
17195 @findex gnus-soup-pack-packet
17196 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
17199 @kindex G s r (Group)
17200 @findex nnsoup-pack-replies
17201 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
17204 @kindex O s (Summary)
17205 @findex gnus-soup-add-article
17206 This summary-mode command adds the current article to a @sc{soup} packet
17207 (@code{gnus-soup-add-article}). It understands the process/prefix
17208 convention (@pxref{Process/Prefix}).
17213 There are a few variables to customize where Gnus will put all these
17218 @item gnus-soup-directory
17219 @vindex gnus-soup-directory
17220 Directory where Gnus will save intermediate files while composing
17221 @sc{soup} packets. The default is @file{~/SoupBrew/}.
17223 @item gnus-soup-replies-directory
17224 @vindex gnus-soup-replies-directory
17225 This is what Gnus will use as a temporary directory while sending our
17226 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
17228 @item gnus-soup-prefix-file
17229 @vindex gnus-soup-prefix-file
17230 Name of the file where Gnus stores the last used prefix. The default is
17231 @samp{gnus-prefix}.
17233 @item gnus-soup-packer
17234 @vindex gnus-soup-packer
17235 A format string command for packing a @sc{soup} packet. The default is
17236 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
17238 @item gnus-soup-unpacker
17239 @vindex gnus-soup-unpacker
17240 Format string command for unpacking a @sc{soup} packet. The default is
17241 @samp{gunzip -c %s | tar xvf -}.
17243 @item gnus-soup-packet-directory
17244 @vindex gnus-soup-packet-directory
17245 Where Gnus will look for reply packets. The default is @file{~/}.
17247 @item gnus-soup-packet-regexp
17248 @vindex gnus-soup-packet-regexp
17249 Regular expression matching @sc{soup} reply packets in
17250 @code{gnus-soup-packet-directory}.
17256 @subsubsection SOUP Groups
17259 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
17260 read incoming packets, unpack them, and put them in a directory where
17261 you can read them at leisure.
17263 These are the variables you can use to customize its behavior:
17267 @item nnsoup-tmp-directory
17268 @vindex nnsoup-tmp-directory
17269 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
17270 directory. (@file{/tmp/} by default.)
17272 @item nnsoup-directory
17273 @vindex nnsoup-directory
17274 @code{nnsoup} then moves each message and index file to this directory.
17275 The default is @file{~/SOUP/}.
17277 @item nnsoup-replies-directory
17278 @vindex nnsoup-replies-directory
17279 All replies will be stored in this directory before being packed into a
17280 reply packet. The default is @file{~/SOUP/replies/}.
17282 @item nnsoup-replies-format-type
17283 @vindex nnsoup-replies-format-type
17284 The @sc{soup} format of the replies packets. The default is @samp{?n}
17285 (rnews), and I don't think you should touch that variable. I probably
17286 shouldn't even have documented it. Drats! Too late!
17288 @item nnsoup-replies-index-type
17289 @vindex nnsoup-replies-index-type
17290 The index type of the replies packet. The default is @samp{?n}, which
17291 means ``none''. Don't fiddle with this one either!
17293 @item nnsoup-active-file
17294 @vindex nnsoup-active-file
17295 Where @code{nnsoup} stores lots of information. This is not an ``active
17296 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
17297 this file or mess it up in any way, you're dead. The default is
17298 @file{~/SOUP/active}.
17300 @item nnsoup-packer
17301 @vindex nnsoup-packer
17302 Format string command for packing a reply @sc{soup} packet. The default
17303 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
17305 @item nnsoup-unpacker
17306 @vindex nnsoup-unpacker
17307 Format string command for unpacking incoming @sc{soup} packets. The
17308 default is @samp{gunzip -c %s | tar xvf -}.
17310 @item nnsoup-packet-directory
17311 @vindex nnsoup-packet-directory
17312 Where @code{nnsoup} will look for incoming packets. The default is
17315 @item nnsoup-packet-regexp
17316 @vindex nnsoup-packet-regexp
17317 Regular expression matching incoming @sc{soup} packets. The default is
17320 @item nnsoup-always-save
17321 @vindex nnsoup-always-save
17322 If non-@code{nil}, save the replies buffer after each posted message.
17328 @subsubsection SOUP Replies
17330 Just using @code{nnsoup} won't mean that your postings and mailings end
17331 up in @sc{soup} reply packets automagically. You have to work a bit
17332 more for that to happen.
17334 @findex nnsoup-set-variables
17335 The @code{nnsoup-set-variables} command will set the appropriate
17336 variables to ensure that all your followups and replies end up in the
17339 In specific, this is what it does:
17342 (setq message-send-news-function 'nnsoup-request-post)
17343 (setq message-send-mail-function 'nnsoup-request-mail)
17346 And that's it, really. If you only want news to go into the @sc{soup}
17347 system you just use the first line. If you only want mail to be
17348 @sc{soup}ed you use the second.
17351 @node Mail-To-News Gateways
17352 @subsection Mail-To-News Gateways
17353 @cindex mail-to-news gateways
17356 If your local @code{nntp} server doesn't allow posting, for some reason
17357 or other, you can post using one of the numerous mail-to-news gateways.
17358 The @code{nngateway} back end provides the interface.
17360 Note that you can't read anything from this back end---it can only be
17366 @item nngateway-address
17367 @vindex nngateway-address
17368 This is the address of the mail-to-news gateway.
17370 @item nngateway-header-transformation
17371 @vindex nngateway-header-transformation
17372 News headers often have to be transformed in some odd way or other
17373 for the mail-to-news gateway to accept it. This variable says what
17374 transformation should be called, and defaults to
17375 @code{nngateway-simple-header-transformation}. The function is called
17376 narrowed to the headers to be transformed and with one parameter---the
17379 This default function just inserts a new @code{To} header based on the
17380 @code{Newsgroups} header and the gateway address.
17381 For instance, an article with this @code{Newsgroups} header:
17384 Newsgroups: alt.religion.emacs
17387 will get this @code{To} header inserted:
17390 To: alt-religion-emacs@@GATEWAY
17393 The following pre-defined functions exist:
17395 @findex nngateway-simple-header-transformation
17398 @item nngateway-simple-header-transformation
17399 Creates a @code{To} header that looks like
17400 @var{newsgroup}@@@code{nngateway-address}.
17402 @findex nngateway-mail2news-header-transformation
17404 @item nngateway-mail2news-header-transformation
17405 Creates a @code{To} header that looks like
17406 @code{nngateway-address}.
17414 (setq gnus-post-method
17416 "mail2news@@replay.com"
17417 (nngateway-header-transformation
17418 nngateway-mail2news-header-transformation)))
17421 So, to use this, simply say something like:
17424 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17429 @node Combined Groups
17430 @section Combined Groups
17432 Gnus allows combining a mixture of all the other group types into bigger
17436 * Virtual Groups:: Combining articles from many groups.
17437 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
17441 @node Virtual Groups
17442 @subsection Virtual Groups
17444 @cindex virtual groups
17445 @cindex merging groups
17447 An @dfn{nnvirtual group} is really nothing more than a collection of
17450 For instance, if you are tired of reading many small groups, you can
17451 put them all in one big group, and then grow tired of reading one
17452 big, unwieldy group. The joys of computing!
17454 You specify @code{nnvirtual} as the method. The address should be a
17455 regexp to match component groups.
17457 All marks in the virtual group will stick to the articles in the
17458 component groups. So if you tick an article in a virtual group, the
17459 article will also be ticked in the component group from whence it
17460 came. (And vice versa---marks from the component groups will also be
17461 shown in the virtual group.). To create an empty virtual group, run
17462 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17463 and edit the method regexp with @kbd{M-e}
17464 (@code{gnus-group-edit-group-method})
17466 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17467 newsgroups into one, big, happy newsgroup:
17470 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17473 The component groups can be native or foreign; everything should work
17474 smoothly, but if your computer explodes, it was probably my fault.
17476 Collecting the same group from several servers might actually be a good
17477 idea if users have set the Distribution header to limit distribution.
17478 If you would like to read @samp{soc.motss} both from a server in Japan
17479 and a server in Norway, you could use the following as the group regexp:
17482 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17485 (Remember, though, that if you're creating the group with @kbd{G m}, you
17486 shouldn't double the backslashes, and you should leave off the quote
17487 characters at the beginning and the end of the string.)
17489 This should work kinda smoothly---all articles from both groups should
17490 end up in this one, and there should be no duplicates. Threading (and
17491 the rest) will still work as usual, but there might be problems with the
17492 sequence of articles. Sorting on date might be an option here
17493 (@pxref{Selecting a Group}).
17495 One limitation, however---all groups included in a virtual
17496 group have to be alive (i.e., subscribed or unsubscribed). Killed or
17497 zombie groups can't be component groups for @code{nnvirtual} groups.
17499 @vindex nnvirtual-always-rescan
17500 If the @code{nnvirtual-always-rescan} is non-@code{nil},
17501 @code{nnvirtual} will always scan groups for unread articles when
17502 entering a virtual group. If this variable is @code{nil} (which is the
17503 default) and you read articles in a component group after the virtual
17504 group has been activated, the read articles from the component group
17505 will show up when you enter the virtual group. You'll also see this
17506 effect if you have two virtual groups that have a component group in
17507 common. If that's the case, you should set this variable to @code{t}.
17508 Or you can just tap @code{M-g} on the virtual group every time before
17509 you enter it---it'll have much the same effect.
17511 @code{nnvirtual} can have both mail and news groups as component groups.
17512 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17513 has to ask the back end of the component group the article comes from
17514 whether it is a news or mail back end. However, when you do a @kbd{^},
17515 there is typically no sure way for the component back end to know this,
17516 and in that case @code{nnvirtual} tells Gnus that the article came from a
17517 not-news back end. (Just to be on the safe side.)
17519 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17520 line from the article you respond to in these cases.
17522 @code{nnvirtual} groups do not inherit anything but articles and marks
17523 from component groups---group parameters, for instance, are not
17527 @node Kibozed Groups
17528 @subsection Kibozed Groups
17532 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
17533 (parts of) the news feed''. @code{nnkiboze} is a back end that will
17534 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
17535 down to a halt with useless requests! Oh happiness!
17537 @kindex G k (Group)
17538 To create a kibozed group, use the @kbd{G k} command in the group
17541 The address field of the @code{nnkiboze} method is, as with
17542 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
17543 @code{nnkiboze} group. That's where most similarities between
17544 @code{nnkiboze} and @code{nnvirtual} end.
17546 In addition to this regexp detailing component groups, an
17547 @code{nnkiboze} group must have a score file to say what articles are
17548 to be included in the group (@pxref{Scoring}).
17550 @kindex M-x nnkiboze-generate-groups
17551 @findex nnkiboze-generate-groups
17552 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
17553 @code{nnkiboze} groups you want to have. This command will take time.
17554 Lots of time. Oodles and oodles of time. Gnus has to fetch the
17555 headers from all the articles in all the component groups and run them
17556 through the scoring process to determine if there are any articles in
17557 the groups that are to be part of the @code{nnkiboze} groups.
17559 Please limit the number of component groups by using restrictive
17560 regexps. Otherwise your sysadmin may become annoyed with you, and the
17561 @acronym{NNTP} site may throw you off and never let you back in again.
17562 Stranger things have happened.
17564 @code{nnkiboze} component groups do not have to be alive---they can be dead,
17565 and they can be foreign. No restrictions.
17567 @vindex nnkiboze-directory
17568 The generation of an @code{nnkiboze} group means writing two files in
17569 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
17570 One contains the @acronym{NOV} header lines for all the articles in
17571 the group, and the other is an additional @file{.newsrc} file to store
17572 information on what groups have been searched through to find
17573 component articles.
17575 Articles marked as read in the @code{nnkiboze} group will have
17576 their @acronym{NOV} lines removed from the @acronym{NOV} file.
17579 @node Gnus Unplugged
17580 @section Gnus Unplugged
17585 @cindex Gnus unplugged
17587 In olden times (ca. February '88), people used to run their newsreaders
17588 on big machines with permanent connections to the net. News transport
17589 was dealt with by news servers, and all the newsreaders had to do was to
17590 read news. Believe it or not.
17592 Nowadays most people read news and mail at home, and use some sort of
17593 modem to connect to the net. To avoid running up huge phone bills, it
17594 would be nice to have a way to slurp down all the news and mail, hang up
17595 the phone, read for several hours, and then upload any responses you
17596 have to make. And then you repeat the procedure.
17598 Of course, you can use news servers for doing this as well. I've used
17599 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
17600 for some years, but doing that's a bore. Moving the news server
17601 functionality up to the newsreader makes sense if you're the only person
17602 reading news on a machine.
17604 Setting up Gnus as an ``offline'' newsreader is quite simple. In
17605 fact, you don't have to configure anything as the agent is now enabled
17606 by default (@pxref{Agent Variables, gnus-agent}).
17608 Of course, to use it as such, you have to learn a few new commands.
17611 * Agent Basics:: How it all is supposed to work.
17612 * Agent Categories:: How to tell the Gnus Agent what to download.
17613 * Agent Commands:: New commands for all the buffers.
17614 * Agent Visuals:: Ways that the agent may effect your summary buffer.
17615 * Agent as Cache:: The Agent is a big cache too.
17616 * Agent Expiry:: How to make old articles go away.
17617 * Agent Regeneration:: How to recover from lost connections and other accidents.
17618 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
17619 * Outgoing Messages:: What happens when you post/mail something?
17620 * Agent Variables:: Customizing is fun.
17621 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
17622 * Batching Agents:: How to fetch news from a @code{cron} job.
17623 * Agent Caveats:: What you think it'll do and what it does.
17628 @subsection Agent Basics
17630 First, let's get some terminology out of the way.
17632 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
17633 connection to the net (and notified the Agent that this is the case).
17634 When the connection to the net is up again (and Gnus knows this), the
17635 Agent is @dfn{plugged}.
17637 The @dfn{local} machine is the one you're running on, and which isn't
17638 connected to the net continuously.
17640 @dfn{Downloading} means fetching things from the net to your local
17641 machine. @dfn{Uploading} is doing the opposite.
17643 You know that Gnus gives you all the opportunity you'd ever want for
17644 shooting yourself in the foot. Some people call it flexibility. Gnus
17645 is also customizable to a great extent, which means that the user has a
17646 say on how Gnus behaves. Other newsreaders might unconditionally shoot
17647 you in your foot, but with Gnus, you have a choice!
17649 Gnus is never really in plugged or unplugged state. Rather, it applies
17650 that state to each server individually. This means that some servers
17651 can be plugged while others can be unplugged. Additionally, some
17652 servers can be ignored by the Agent altogether (which means that
17653 they're kinda like plugged always).
17655 So when you unplug the Agent and then wonder why is Gnus opening a
17656 connection to the Net, the next step to do is to look whether all
17657 servers are agentized. If there is an unagentized server, you found
17660 Another thing is the @dfn{offline} state. Sometimes, servers aren't
17661 reachable. When Gnus notices this, it asks you whether you want the
17662 server to be switched to offline state. If you say yes, then the
17663 server will behave somewhat as if it was unplugged, except that Gnus
17664 will ask you whether you want to switch it back online again.
17666 Let's take a typical Gnus session using the Agent.
17671 @findex gnus-unplugged
17672 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
17673 Agent in a disconnected state. You can read all the news that you have
17674 already fetched while in this mode.
17677 You then decide to see whether any new news has arrived. You connect
17678 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
17679 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
17680 as usual. To check for new mail in unplugged mode (@pxref{Mail
17681 Source Specifiers}).
17684 You can then read the new news immediately, or you can download the
17685 news onto your local machine. If you want to do the latter, you press
17686 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
17687 all the eligible articles in all the groups. (To let Gnus know which
17688 articles you want to download, @pxref{Agent Categories}).
17691 After fetching the articles, you press @kbd{J j} to make Gnus become
17692 unplugged again, and you shut down the PPP thing (or whatever). And
17693 then you read the news offline.
17696 And then you go to step 2.
17699 Here are some things you should do the first time (or so) that you use
17705 Decide which servers should be covered by the Agent. If you have a mail
17706 back end, it would probably be nonsensical to have it covered by the
17707 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
17708 @kbd{J a} on the server (or servers) that you wish to have covered by the
17709 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
17710 added servers you do not wish to have covered by the Agent. By default,
17711 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
17712 @code{gnus-secondary-select-methods} are agentized.
17715 Decide on download policy. It's fairly simple once you decide whether
17716 you are going to use agent categories, topic parameters, and/or group
17717 parameters to implement your policy. If you're new to gnus, it
17718 is probably best to start with a category, @xref{Agent Categories}.
17720 Both topic parameters (@pxref{Topic Parameters}) and agent categories
17721 (@pxref{Agent Categories}) provide for setting a policy that applies
17722 to multiple groups. Which you use is entirely up to you. Topic
17723 parameters do override categories so, if you mix the two, you'll have
17724 to take that into account. If you have a few groups that deviate from
17725 your policy, you can use group parameters (@pxref{Group Parameters}) to
17729 Uhm@dots{} that's it.
17733 @node Agent Categories
17734 @subsection Agent Categories
17736 One of the main reasons to integrate the news transport layer into the
17737 newsreader is to allow greater control over what articles to download.
17738 There's not much point in downloading huge amounts of articles, just to
17739 find out that you're not interested in reading any of them. It's better
17740 to be somewhat more conservative in choosing what to download, and then
17741 mark the articles for downloading manually if it should turn out that
17742 you're interested in the articles anyway.
17744 One of the more effective methods for controlling what is to be
17745 downloaded is to create a @dfn{category} and then assign some (or all)
17746 groups to this category. Groups that do not belong in any other
17747 category belong to the @code{default} category. Gnus has its own
17748 buffer for creating and managing categories.
17750 If you prefer, you can also use group parameters (@pxref{Group
17751 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
17752 alternative approach to controlling the agent. The only real
17753 difference is that categories are specific to the agent (so there is
17754 less to learn) while group and topic parameters include the kitchen
17757 Since you can set agent parameters in several different places we have
17758 a rule to decide which source to believe. This rule specifies that
17759 the parameter sources are checked in the following order: group
17760 parameters, topic parameters, agent category, and finally customizable
17761 variables. So you can mix all of these sources to produce a wide range
17762 of behavior, just don't blame me if you don't remember where you put
17766 * Category Syntax:: What a category looks like.
17767 * Category Buffer:: A buffer for maintaining categories.
17768 * Category Variables:: Customize'r'Us.
17772 @node Category Syntax
17773 @subsubsection Category Syntax
17775 A category consists of a name, the list of groups belonging to the
17776 category, and a number of optional parameters that override the
17777 customizable variables. The complete list of agent parameters are
17780 @cindex Agent Parameters
17782 @item agent-cat-name
17783 The name of the category.
17786 The list of groups that are in this category.
17788 @item agent-predicate
17789 A predicate which (generally) gives a rough outline of which articles
17790 are eligible for downloading; and
17792 @item agent-score-file
17793 a score rule which (generally) gives you a finer granularity when
17794 deciding what articles to download. (Note that this @dfn{download
17795 score} is not necessarily related to normal scores.)
17797 @item agent-enable-expiration
17798 a boolean indicating whether the agent should expire old articles in
17799 this group. Most groups should be expired to conserve disk space. In
17800 fact, its probably safe to say that the gnus.* hierarchy contains the
17801 only groups that should not be expired.
17803 @item agent-days-until-old
17804 an integer indicating the number of days that the agent should wait
17805 before deciding that a read article is safe to expire.
17807 @item agent-low-score
17808 an integer that overrides the value of @code{gnus-agent-low-score}.
17810 @item agent-high-score
17811 an integer that overrides the value of @code{gnus-agent-high-score}.
17813 @item agent-length-when-short
17814 an integer that overrides the value of
17815 @code{gnus-agent-short-article}.
17817 @item agent-length-when-long
17818 an integer that overrides the value of @code{gnus-agent-long-article}.
17820 @item agent-enable-undownloaded-faces
17821 a symbol indicating whether the summary buffer should display
17822 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
17823 faces. Any symbol other than @code{nil} will enable the use of
17824 undownloaded faces.
17827 The name of a category can not be changed once the category has been
17830 Each category maintains a list of groups that are exclusive members of
17831 that category. The exclusivity rule is automatically enforced, add a
17832 group to a new category and it is automatically removed from its old
17835 A predicate in its simplest form can be a single predicate such as
17836 @code{true} or @code{false}. These two will download every available
17837 article or nothing respectively. In the case of these two special
17838 predicates an additional score rule is superfluous.
17840 Predicates of @code{high} or @code{low} download articles in respect of
17841 their scores in relationship to @code{gnus-agent-high-score} and
17842 @code{gnus-agent-low-score} as described below.
17844 To gain even finer control of what is to be regarded eligible for
17845 download a predicate can consist of a number of predicates with logical
17846 operators sprinkled in between.
17848 Perhaps some examples are in order.
17850 Here's a simple predicate. (It's the default predicate, in fact, used
17851 for all groups that don't belong to any other category.)
17857 Quite simple, eh? This predicate is true if and only if the article is
17858 short (for some value of ``short'').
17860 Here's a more complex predicate:
17869 This means that an article should be downloaded if it has a high score,
17870 or if the score is not low and the article is not long. You get the
17873 The available logical operators are @code{or}, @code{and} and
17874 @code{not}. (If you prefer, you can use the more ``C''-ish operators
17875 @samp{|}, @code{&} and @code{!} instead.)
17877 The following predicates are pre-defined, but if none of these fit what
17878 you want to do, you can write your own.
17880 When evaluating each of these predicates, the named constant will be
17881 bound to the value determined by calling
17882 @code{gnus-agent-find-parameter} on the appropriate parameter. For
17883 example, gnus-agent-short-article will be bound to
17884 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
17885 means that you can specify a predicate in your category then tune that
17886 predicate to individual groups.
17890 True iff the article is shorter than @code{gnus-agent-short-article}
17891 lines; default 100.
17894 True iff the article is longer than @code{gnus-agent-long-article}
17895 lines; default 200.
17898 True iff the article has a download score less than
17899 @code{gnus-agent-low-score}; default 0.
17902 True iff the article has a download score greater than
17903 @code{gnus-agent-high-score}; default 0.
17906 True iff the Gnus Agent guesses that the article is spam. The
17907 heuristics may change over time, but at present it just computes a
17908 checksum and sees whether articles match.
17917 If you want to create your own predicate function, here's what you have
17918 to know: The functions are called with no parameters, but the
17919 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
17922 For example, you could decide that you don't want to download articles
17923 that were posted more than a certain number of days ago (e.g. posted
17924 more than @code{gnus-agent-expire-days} ago) you might write a function
17925 something along the lines of the following:
17928 (defun my-article-old-p ()
17929 "Say whether an article is old."
17930 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
17931 (- (time-to-days (current-time)) gnus-agent-expire-days)))
17934 with the predicate then defined as:
17937 (not my-article-old-p)
17940 or you could append your predicate to the predefined
17941 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
17945 (require 'gnus-agent)
17946 (setq gnus-category-predicate-alist
17947 (append gnus-category-predicate-alist
17948 '((old . my-article-old-p))))
17951 and simply specify your predicate as:
17957 If/when using something like the above, be aware that there are many
17958 misconfigured systems/mailers out there and so an article's date is not
17959 always a reliable indication of when it was posted. Hell, some people
17960 just don't give a damn.
17962 The above predicates apply to @emph{all} the groups which belong to the
17963 category. However, if you wish to have a specific predicate for an
17964 individual group within a category, or you're just too lazy to set up a
17965 new category, you can enter a group's individual predicate in its group
17966 parameters like so:
17969 (agent-predicate . short)
17972 This is the group/topic parameter equivalent of the agent category default.
17973 Note that when specifying a single word predicate like this, the
17974 @code{agent-predicate} specification must be in dotted pair notation.
17976 The equivalent of the longer example from above would be:
17979 (agent-predicate or high (and (not low) (not long)))
17982 The outer parenthesis required in the category specification are not
17983 entered here as, not being in dotted pair notation, the value of the
17984 predicate is assumed to be a list.
17987 Now, the syntax of the download score is the same as the syntax of
17988 normal score files, except that all elements that require actually
17989 seeing the article itself are verboten. This means that only the
17990 following headers can be scored on: @code{Subject}, @code{From},
17991 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
17992 @code{Lines}, and @code{Xref}.
17994 As with predicates, the specification of the @code{download score rule}
17995 to use in respect of a group can be in either the category definition if
17996 it's to be applicable to all groups in therein, or a group's parameters
17997 if it's to be specific to that group.
17999 In both of these places the @code{download score rule} can take one of
18006 This has the same syntax as a normal Gnus score file except only a
18007 subset of scoring keywords are available as mentioned above.
18013 Category specification
18017 ("Lars Ingebrigtsen" 1000000 nil s))
18023 Group/Topic Parameter specification
18026 (agent-score ("from"
18027 ("Lars Ingebrigtsen" 1000000 nil s))
18032 Again, note the omission of the outermost parenthesis here.
18038 These score files must @emph{only} contain the permitted scoring
18039 keywords stated above.
18045 Category specification
18048 ("~/News/agent.SCORE")
18054 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
18058 Group Parameter specification
18061 (agent-score "~/News/agent.SCORE")
18064 Additional score files can be specified as above. Need I say anything
18069 Use @code{normal} score files
18071 If you don't want to maintain two sets of scoring rules for a group, and
18072 your desired @code{downloading} criteria for a group are the same as your
18073 @code{reading} criteria then you can tell the agent to refer to your
18074 @code{normal} score files when deciding what to download.
18076 These directives in either the category definition or a group's
18077 parameters will cause the agent to read in all the applicable score
18078 files for a group, @emph{filtering out} those sections that do not
18079 relate to one of the permitted subset of scoring keywords.
18083 Category Specification
18090 Group Parameter specification
18093 (agent-score . file)
18098 @node Category Buffer
18099 @subsubsection Category Buffer
18101 You'd normally do all category maintenance from the category buffer.
18102 When you enter it for the first time (with the @kbd{J c} command from
18103 the group buffer), you'll only see the @code{default} category.
18105 The following commands are available in this buffer:
18109 @kindex q (Category)
18110 @findex gnus-category-exit
18111 Return to the group buffer (@code{gnus-category-exit}).
18114 @kindex e (Category)
18115 @findex gnus-category-customize-category
18116 Use a customization buffer to set all of the selected category's
18117 parameters at one time (@code{gnus-category-customize-category}).
18120 @kindex k (Category)
18121 @findex gnus-category-kill
18122 Kill the current category (@code{gnus-category-kill}).
18125 @kindex c (Category)
18126 @findex gnus-category-copy
18127 Copy the current category (@code{gnus-category-copy}).
18130 @kindex a (Category)
18131 @findex gnus-category-add
18132 Add a new category (@code{gnus-category-add}).
18135 @kindex p (Category)
18136 @findex gnus-category-edit-predicate
18137 Edit the predicate of the current category
18138 (@code{gnus-category-edit-predicate}).
18141 @kindex g (Category)
18142 @findex gnus-category-edit-groups
18143 Edit the list of groups belonging to the current category
18144 (@code{gnus-category-edit-groups}).
18147 @kindex s (Category)
18148 @findex gnus-category-edit-score
18149 Edit the download score rule of the current category
18150 (@code{gnus-category-edit-score}).
18153 @kindex l (Category)
18154 @findex gnus-category-list
18155 List all the categories (@code{gnus-category-list}).
18159 @node Category Variables
18160 @subsubsection Category Variables
18163 @item gnus-category-mode-hook
18164 @vindex gnus-category-mode-hook
18165 Hook run in category buffers.
18167 @item gnus-category-line-format
18168 @vindex gnus-category-line-format
18169 Format of the lines in the category buffer (@pxref{Formatting
18170 Variables}). Valid elements are:
18174 The name of the category.
18177 The number of groups in the category.
18180 @item gnus-category-mode-line-format
18181 @vindex gnus-category-mode-line-format
18182 Format of the category mode line (@pxref{Mode Line Formatting}).
18184 @item gnus-agent-short-article
18185 @vindex gnus-agent-short-article
18186 Articles that have fewer lines than this are short. Default 100.
18188 @item gnus-agent-long-article
18189 @vindex gnus-agent-long-article
18190 Articles that have more lines than this are long. Default 200.
18192 @item gnus-agent-low-score
18193 @vindex gnus-agent-low-score
18194 Articles that have a score lower than this have a low score. Default
18197 @item gnus-agent-high-score
18198 @vindex gnus-agent-high-score
18199 Articles that have a score higher than this have a high score. Default
18202 @item gnus-agent-expire-days
18203 @vindex gnus-agent-expire-days
18204 The number of days that a @samp{read} article must stay in the agent's
18205 local disk before becoming eligible for expiration (While the name is
18206 the same, this doesn't mean expiring the article on the server. It
18207 just means deleting the local copy of the article). What is also
18208 important to understand is that the counter starts with the time the
18209 article was written to the local disk and not the time the article was
18213 @item gnus-agent-enable-expiration
18214 @vindex gnus-agent-enable-expiration
18215 Determines whether articles in a group are, by default, expired or
18216 retained indefinitely. The default is @code{ENABLE} which means that
18217 you'll have to disable expiration when desired. On the other hand,
18218 you could set this to @code{DISABLE}. In that case, you would then
18219 have to enable expiration in selected groups.
18224 @node Agent Commands
18225 @subsection Agent Commands
18226 @findex gnus-agent-toggle-plugged
18227 @kindex J j (Agent)
18229 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
18230 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18231 toggles the plugged/unplugged state of the Gnus Agent.
18235 * Group Agent Commands:: Configure groups and fetch their contents.
18236 * Summary Agent Commands:: Manually select then fetch specific articles.
18237 * Server Agent Commands:: Select the servers that are supported by the agent.
18243 @node Group Agent Commands
18244 @subsubsection Group Agent Commands
18248 @kindex J u (Agent Group)
18249 @findex gnus-agent-fetch-groups
18250 Fetch all eligible articles in the current group
18251 (@code{gnus-agent-fetch-groups}).
18254 @kindex J c (Agent Group)
18255 @findex gnus-enter-category-buffer
18256 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18259 @kindex J s (Agent Group)
18260 @findex gnus-agent-fetch-session
18261 Fetch all eligible articles in all groups
18262 (@code{gnus-agent-fetch-session}).
18265 @kindex J S (Agent Group)
18266 @findex gnus-group-send-queue
18267 Send all sendable messages in the queue group
18268 (@code{gnus-group-send-queue}). @xref{Drafts}.
18271 @kindex J a (Agent Group)
18272 @findex gnus-agent-add-group
18273 Add the current group to an Agent category
18274 (@code{gnus-agent-add-group}). This command understands the
18275 process/prefix convention (@pxref{Process/Prefix}).
18278 @kindex J r (Agent Group)
18279 @findex gnus-agent-remove-group
18280 Remove the current group from its category, if any
18281 (@code{gnus-agent-remove-group}). This command understands the
18282 process/prefix convention (@pxref{Process/Prefix}).
18285 @kindex J Y (Agent Group)
18286 @findex gnus-agent-synchronize-flags
18287 Synchronize flags changed while unplugged with remote server, if any.
18293 @node Summary Agent Commands
18294 @subsubsection Summary Agent Commands
18298 @kindex J # (Agent Summary)
18299 @findex gnus-agent-mark-article
18300 Mark the article for downloading (@code{gnus-agent-mark-article}).
18303 @kindex J M-# (Agent Summary)
18304 @findex gnus-agent-unmark-article
18305 Remove the downloading mark from the article
18306 (@code{gnus-agent-unmark-article}).
18310 @kindex @@ (Agent Summary)
18311 @findex gnus-agent-toggle-mark
18312 Toggle whether to download the article
18313 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
18317 @kindex J c (Agent Summary)
18318 @findex gnus-agent-catchup
18319 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18322 @kindex J S (Agent Summary)
18323 @findex gnus-agent-fetch-group
18324 Download all eligible (@pxref{Agent Categories}) articles in this group.
18325 (@code{gnus-agent-fetch-group}).
18328 @kindex J s (Agent Summary)
18329 @findex gnus-agent-fetch-series
18330 Download all processable articles in this group.
18331 (@code{gnus-agent-fetch-series}).
18334 @kindex J u (Agent Summary)
18335 @findex gnus-agent-summary-fetch-group
18336 Download all downloadable articles in the current group
18337 (@code{gnus-agent-summary-fetch-group}).
18342 @node Server Agent Commands
18343 @subsubsection Server Agent Commands
18347 @kindex J a (Agent Server)
18348 @findex gnus-agent-add-server
18349 Add the current server to the list of servers covered by the Gnus Agent
18350 (@code{gnus-agent-add-server}).
18353 @kindex J r (Agent Server)
18354 @findex gnus-agent-remove-server
18355 Remove the current server from the list of servers covered by the Gnus
18356 Agent (@code{gnus-agent-remove-server}).
18361 @node Agent Visuals
18362 @subsection Agent Visuals
18364 If you open a summary while unplugged and, Gnus knows from the group's
18365 active range that there are more articles than the headers currently
18366 stored in the Agent, you may see some articles whose subject looks
18367 something like @samp{[Undownloaded article #####]}. These are
18368 placeholders for the missing headers. Aside from setting a mark,
18369 there is not much that can be done with one of these placeholders.
18370 When Gnus finally gets a chance to fetch the group's headers, the
18371 placeholders will automatically be replaced by the actual headers.
18372 You can configure the summary buffer's maneuvering to skip over the
18373 placeholders if you care (See @code{gnus-auto-goto-ignores}).
18375 While it may be obvious to all, the only headers and articles
18376 available while unplugged are those headers and articles that were
18377 fetched into the Agent while previously plugged. To put it another
18378 way, ``If you forget to fetch something while plugged, you might have a
18379 less than satisfying unplugged session''. For this reason, the Agent
18380 adds two visual effects to your summary buffer. These effects display
18381 the download status of each article so that you always know which
18382 articles will be available when unplugged.
18384 The first visual effect is the @samp{%O} spec. If you customize
18385 @code{gnus-summary-line-format} to include this specifier, you will add
18386 a single character field that indicates an article's download status.
18387 Articles that have been fetched into either the Agent or the Cache,
18388 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
18389 other articles will display @code{gnus-undownloaded-mark} (defaults to
18390 @samp{-}). If you open a group that has not been agentized, a space
18391 (@samp{ }) will be displayed.
18393 The second visual effect are the undownloaded faces. The faces, there
18394 are three indicating the article's score (low, normal, high), seem to
18395 result in a love/hate response from many Gnus users. The problem is
18396 that the face selection is controlled by a list of condition tests and
18397 face names (See @code{gnus-summary-highlight}). Each condition is
18398 tested in the order in which it appears in the list so early
18399 conditions have precedence over later conditions. All of this means
18400 that, if you tick an undownloaded article, the article will continue
18401 to be displayed in the undownloaded face rather than the ticked face.
18403 If you use the Agent as a cache (to avoid downloading the same article
18404 each time you visit it or to minimize your connection time), the
18405 undownloaded face will probably seem like a good idea. The reason
18406 being that you do all of our work (marking, reading, deleting) with
18407 downloaded articles so the normal faces always appear. For those
18408 users using the agent to improve online performance by caching the NOV
18409 database (most users since 5.10.2), the undownloaded faces may appear
18410 to be an absolutely horrible idea. The issue being that, since none
18411 of their articles have been fetched into the Agent, all of the
18412 normal faces will be obscured by the undownloaded faces.
18414 If you would like to use the undownloaded faces, you must enable the
18415 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
18416 group parameter to t. This parameter, like all other agent
18417 parameters, may be set on an Agent Category (@pxref{Agent
18418 Categories}), a Group Topic (@pxref{Topic Parameters}), or an
18419 individual group (@pxref{Group Parameters}).
18421 The one problem common to all users using the agent is how quickly it
18422 can consume disk space. If you using the agent on many groups, it is
18423 even more difficult to effectively recover disk space. One solution
18424 is the @samp{%F} format available in @code{gnus-group-line-format}.
18425 This format will display the actual disk space used by articles
18426 fetched into both the agent and cache. By knowing which groups use
18427 the most space, users know where to focus their efforts when ``agent
18428 expiring'' articles.
18430 @node Agent as Cache
18431 @subsection Agent as Cache
18433 When Gnus is plugged, it is not efficient to download headers or
18434 articles from the server again, if they are already stored in the
18435 Agent. So, Gnus normally only downloads headers once, and stores them
18436 in the Agent. These headers are later used when generating the summary
18437 buffer, regardless of whether you are plugged or unplugged. Articles
18438 are not cached in the Agent by default though (that would potentially
18439 consume lots of disk space), but if you have already downloaded an
18440 article into the Agent, Gnus will not download the article from the
18441 server again but use the locally stored copy instead.
18443 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
18444 @pxref{Agent Variables}) to always download headers and articles while
18445 plugged. Gnus will almost certainly be slower, but it will be kept
18446 synchronized with the server. That last point probably won't make any
18447 sense if you are using a nntp or nnimap back end.
18450 @subsection Agent Expiry
18452 @vindex gnus-agent-expire-days
18453 @findex gnus-agent-expire
18454 @kindex M-x gnus-agent-expire
18455 @kindex M-x gnus-agent-expire-group
18456 @findex gnus-agent-expire-group
18457 @cindex agent expiry
18458 @cindex Gnus agent expiry
18461 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
18462 least it doesn't handle it like other back ends. Instead, there are
18463 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
18464 commands that will expire all read articles that are older than
18465 @code{gnus-agent-expire-days} days. They can be run whenever you feel
18466 that you're running out of space. Neither are particularly fast or
18467 efficient, and it's not a particularly good idea to interrupt them (with
18468 @kbd{C-g} or anything else) once you've started one of them.
18470 Note that other functions, e.g. @code{gnus-request-expire-articles},
18471 might run @code{gnus-agent-expire} for you to keep the agent
18472 synchronized with the group.
18474 The agent parameter @code{agent-enable-expiration} may be used to
18475 prevent expiration in selected groups.
18477 @vindex gnus-agent-expire-all
18478 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
18479 expiration commands will expire all articles---unread, read, ticked
18480 and dormant. If @code{nil} (which is the default), only read articles
18481 are eligible for expiry, and unread, ticked and dormant articles will
18482 be kept indefinitely.
18484 If you find that some articles eligible for expiry are never expired,
18485 perhaps some Gnus Agent files are corrupted. There's are special
18486 commands, @code{gnus-agent-regenerate} and
18487 @code{gnus-agent-regenerate-group}, to fix possible problems.
18489 @node Agent Regeneration
18490 @subsection Agent Regeneration
18492 @cindex agent regeneration
18493 @cindex Gnus agent regeneration
18494 @cindex regeneration
18496 The local data structures used by @code{nnagent} may become corrupted
18497 due to certain exceptional conditions. When this happens,
18498 @code{nnagent} functionality may degrade or even fail. The solution
18499 to this problem is to repair the local data structures by removing all
18500 internal inconsistencies.
18502 For example, if your connection to your server is lost while
18503 downloaded articles into the agent, the local data structures will not
18504 know about articles successfully downloaded prior to the connection
18505 failure. Running @code{gnus-agent-regenerate} or
18506 @code{gnus-agent-regenerate-group} will update the data structures
18507 such that you don't need to download these articles a second time.
18509 @findex gnus-agent-regenerate
18510 @kindex M-x gnus-agent-regenerate
18511 The command @code{gnus-agent-regenerate} will perform
18512 @code{gnus-agent-regenerate-group} on every agentized group. While
18513 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
18514 recommended that you first close all summary buffers.
18516 @findex gnus-agent-regenerate-group
18517 @kindex M-x gnus-agent-regenerate-group
18518 The command @code{gnus-agent-regenerate-group} uses the local copies
18519 of individual articles to repair the local @acronym{NOV}(header) database. It
18520 then updates the internal data structures that document which articles
18521 are stored locally. An optional argument will mark articles in the
18524 @node Agent and IMAP
18525 @subsection Agent and IMAP
18527 The Agent works with any Gnus back end, including nnimap. However,
18528 since there are some conceptual differences between @acronym{NNTP} and
18529 @acronym{IMAP}, this section (should) provide you with some information to
18530 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
18532 The first thing to keep in mind is that all flags (read, ticked, etc)
18533 are kept on the @acronym{IMAP} server, rather than in @file{.newsrc} as is the
18534 case for nntp. Thus Gnus need to remember flag changes when
18535 disconnected, and synchronize these flags when you plug back in.
18537 Gnus keeps track of flag changes when reading nnimap groups under the
18538 Agent. When you plug back in, Gnus will check if you have any changed
18539 any flags and ask if you wish to synchronize these with the server.
18540 The behavior is customizable by @code{gnus-agent-synchronize-flags}.
18542 @vindex gnus-agent-synchronize-flags
18543 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
18544 never automatically synchronize flags. If it is @code{ask}, which is
18545 the default, the Agent will check if you made any changes and if so
18546 ask if you wish to synchronize these when you re-connect. If it has
18547 any other value, all flags will be synchronized automatically.
18549 If you do not wish to synchronize flags automatically when you
18550 re-connect, you can do it manually with the
18551 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
18552 in the group buffer.
18554 Some things are currently not implemented in the Agent that you'd might
18555 expect from a disconnected @acronym{IMAP} client, including:
18560 Copying/moving articles into nnimap groups when unplugged.
18563 Creating/deleting nnimap groups when unplugged.
18567 Technical note: the synchronization algorithm does not work by ``pushing''
18568 all local flags to the server, but rather incrementally update the
18569 server view of flags by changing only those flags that were changed by
18570 the user. Thus, if you set one flag on an article, quit the group and
18571 re-select the group and remove the flag; the flag will be set and
18572 removed from the server when you ``synchronize''. The queued flag
18573 operations can be found in the per-server @code{flags} file in the Agent
18574 directory. It's emptied when you synchronize flags.
18577 @node Outgoing Messages
18578 @subsection Outgoing Messages
18580 By default, when Gnus is unplugged, all outgoing messages (both mail
18581 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
18582 You can view them there after posting, and edit them at will.
18584 You can control the circumstances under which outgoing mail is queued
18585 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
18586 news is always queued when Gnus is unplugged, and never otherwise.
18588 You can send the messages either from the draft group with the special
18589 commands available there, or you can use the @kbd{J S} command in the
18590 group buffer to send all the sendable messages in the draft group.
18591 Posting news will only work when Gnus is plugged, but you can send
18594 If sending mail while unplugged does not work for you and you worry
18595 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
18596 ask you to confirm your action (see
18597 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
18599 @node Agent Variables
18600 @subsection Agent Variables
18605 Is the agent enabled? The default is @code{t}. When first enabled,
18606 the agent will use @code{gnus-agent-auto-agentize-methods} to
18607 automatically mark some back ends as agentized. You may change which
18608 back ends are agentized using the agent commands in the server buffer.
18610 To enter the server buffer, use the @kbd{^}
18611 (@code{gnus-group-enter-server-mode}) command in the group buffer.
18614 @item gnus-agent-directory
18615 @vindex gnus-agent-directory
18616 Where the Gnus Agent will store its files. The default is
18617 @file{~/News/agent/}.
18619 @item gnus-agent-handle-level
18620 @vindex gnus-agent-handle-level
18621 Groups on levels (@pxref{Group Levels}) higher than this variable will
18622 be ignored by the Agent. The default is @code{gnus-level-subscribed},
18623 which means that only subscribed group will be considered by the Agent
18626 @item gnus-agent-plugged-hook
18627 @vindex gnus-agent-plugged-hook
18628 Hook run when connecting to the network.
18630 @item gnus-agent-unplugged-hook
18631 @vindex gnus-agent-unplugged-hook
18632 Hook run when disconnecting from the network.
18634 @item gnus-agent-fetched-hook
18635 @vindex gnus-agent-fetched-hook
18636 Hook run when finished fetching articles.
18638 @item gnus-agent-cache
18639 @vindex gnus-agent-cache
18640 Variable to control whether use the locally stored @acronym{NOV} and
18641 articles when plugged, e.g. essentially using the Agent as a cache.
18642 The default is non-@code{nil}, which means to use the Agent as a cache.
18644 @item gnus-agent-go-online
18645 @vindex gnus-agent-go-online
18646 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
18647 automatically switch offline servers into online status. If it is
18648 @code{ask}, the default, the Agent will ask if you wish to switch
18649 offline servers into online status when you re-connect. If it has any
18650 other value, all offline servers will be automatically switched into
18653 @item gnus-agent-mark-unread-after-downloaded
18654 @vindex gnus-agent-mark-unread-after-downloaded
18655 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
18656 mark articles as unread after downloading. This is usually a safe
18657 thing to do as the newly downloaded article has obviously not been
18658 read. The default is t.
18660 @item gnus-agent-consider-all-articles
18661 @vindex gnus-agent-consider-all-articles
18662 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
18663 agent will let the agent predicate decide whether articles need to be
18664 downloaded or not, for all articles. When @code{nil}, the default,
18665 the agent will only let the predicate decide whether unread articles
18666 are downloaded or not. If you enable this, you may also want to look
18667 into the agent expiry settings (@pxref{Category Variables}), so that
18668 the agent doesn't download articles which the agent will later expire,
18669 over and over again.
18671 @item gnus-agent-max-fetch-size
18672 @vindex gnus-agent-max-fetch-size
18673 The agent fetches articles into a temporary buffer prior to parsing
18674 them into individual files. To avoid exceeding the max. buffer size,
18675 the agent alternates between fetching and parsing until all articles
18676 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
18677 limit to control how often the cycling occurs. A large value improves
18678 performance. A small value minimizes the time lost should the
18679 connection be lost while fetching (You may need to run
18680 @code{gnus-agent-regenerate-group} to update the group's state.
18681 However, all articles parsed prior to loosing the connection will be
18682 available while unplugged). The default is 10M so it is unusual to
18685 @item gnus-server-unopen-status
18686 @vindex gnus-server-unopen-status
18687 Perhaps not an Agent variable, but closely related to the Agent, this
18688 variable says what will happen if Gnus cannot open a server. If the
18689 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
18690 whether to deny the server or whether to unplug the agent. If the
18691 Agent is disabled, Gnus always simply deny the server. Other choices
18692 for this variable include @code{denied} and @code{offline} the latter
18693 is only valid if the Agent is used.
18695 @item gnus-auto-goto-ignores
18696 @vindex gnus-auto-goto-ignores
18697 Another variable that isn't an Agent variable, yet so closely related
18698 that most will look for it here, this variable tells the summary
18699 buffer how to maneuver around undownloaded (only headers stored in the
18700 agent) and unfetched (neither article nor headers stored) articles.
18702 The legal values are @code{nil} (maneuver to any article),
18703 @code{undownloaded} (maneuvering while unplugged ignores articles that
18704 have not been fetched), @code{always-undownloaded} (maneuvering always
18705 ignores articles that have not been fetched), @code{unfetched}
18706 (maneuvering ignores articles whose headers have not been fetched).
18708 @item gnus-agent-queue-mail
18709 @vindex gnus-agent-queue-mail
18710 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
18711 queue mail rather than sending it straight away. When @code{t}, Gnus
18712 will queue mail when unplugged only. When @code{nil}, never queue
18713 mail. The default is @code{t}.
18715 @item gnus-agent-prompt-send-queue
18716 @vindex gnus-agent-prompt-send-queue
18717 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
18718 prompt you to confirm that you really wish to proceed if you hit
18719 @kbd{J S} while unplugged. The default is @code{nil}.
18721 @item gnus-agent-auto-agentize-methods
18722 @vindex gnus-agent-auto-agentize-methods
18723 If you have never used the Agent before (or more technically, if
18724 @file{~/News/agent/lib/servers} does not exist), Gnus will
18725 automatically agentize a few servers for you. This variable control
18726 which back ends should be auto-agentized. It is typically only useful
18727 to agentize remote back ends. The auto-agentizing has the same effect
18728 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
18729 If the file exist, you must manage the servers manually by adding or
18730 removing them, this variable is only applicable the first time you
18731 start Gnus. The default is @samp{(nntp nnimap)}.
18736 @node Example Setup
18737 @subsection Example Setup
18739 If you don't want to read this manual, and you have a fairly standard
18740 setup, you may be able to use something like the following as your
18741 @file{~/.gnus.el} file to get started.
18744 ;;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
18745 ;;; @r{from your ISP's server.}
18746 (setq gnus-select-method '(nntp "news.your-isp.com"))
18748 ;;; @r{Define how Gnus is to read your mail. We read mail from}
18749 ;;; @r{your ISP's @acronym{POP} server.}
18750 (setq mail-sources '((pop :server "pop.your-isp.com")))
18752 ;;; @r{Say how Gnus is to store the mail. We use nnml groups.}
18753 (setq gnus-secondary-select-methods '((nnml "")))
18755 ;;; @r{Make Gnus into an offline newsreader.}
18756 ;;; (gnus-agentize) ; @r{The obsolete setting.}
18757 ;;; (setq gnus-agent t) ; @r{Now the default.}
18760 That should be it, basically. Put that in your @file{~/.gnus.el} file,
18761 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
18764 If this is the first time you've run Gnus, you will be subscribed
18765 automatically to a few default newsgroups. You'll probably want to
18766 subscribe to more groups, and to do that, you have to query the
18767 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
18768 command. This usually takes quite a while, but you only have to do it
18771 After reading and parsing a while, you'll be presented with a list of
18772 groups. Subscribe to the ones you want to read with the @kbd{u}
18773 command. @kbd{l} to make all the killed groups disappear after you've
18774 subscribe to all the groups you want to read. (@kbd{A k} will bring
18775 back all the killed groups.)
18777 You can now read the groups at once, or you can download the articles
18778 with the @kbd{J s} command. And then read the rest of this manual to
18779 find out which of the other gazillion things you want to customize.
18782 @node Batching Agents
18783 @subsection Batching Agents
18784 @findex gnus-agent-batch
18786 Having the Gnus Agent fetch articles (and post whatever messages you've
18787 written) is quite easy once you've gotten things set up properly. The
18788 following shell script will do everything that is necessary:
18790 You can run a complete batch command from the command line with the
18791 following incantation:
18795 emacs -batch -l ~/.emacs -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1
18799 @node Agent Caveats
18800 @subsection Agent Caveats
18802 The Gnus Agent doesn't seem to work like most other offline
18803 newsreaders. Here are some common questions that some imaginary people
18807 @item If I read an article while plugged, do they get entered into the Agent?
18809 @strong{No}. If you want this behaviour, add
18810 @code{gnus-agent-fetch-selected-article} to
18811 @code{gnus-select-article-hook}.
18813 @item If I read an article while plugged, and the article already exists in
18814 the Agent, will it get downloaded once more?
18816 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
18820 In short, when Gnus is unplugged, it only looks into the locally stored
18821 articles; when it's plugged, it talks to your ISP and may also use the
18822 locally stored articles.
18829 Other people use @dfn{kill files}, but we here at Gnus Towers like
18830 scoring better than killing, so we'd rather switch than fight. They do
18831 something completely different as well, so sit up straight and pay
18834 @vindex gnus-summary-mark-below
18835 All articles have a default score (@code{gnus-summary-default-score}),
18836 which is 0 by default. This score may be raised or lowered either
18837 interactively or by score files. Articles that have a score lower than
18838 @code{gnus-summary-mark-below} are marked as read.
18840 Gnus will read any @dfn{score files} that apply to the current group
18841 before generating the summary buffer.
18843 There are several commands in the summary buffer that insert score
18844 entries based on the current article. You can, for instance, ask Gnus to
18845 lower or increase the score of all articles with a certain subject.
18847 There are two sorts of scoring entries: Permanent and temporary.
18848 Temporary score entries are self-expiring entries. Any entries that are
18849 temporary and have not been used for, say, a week, will be removed
18850 silently to help keep the sizes of the score files down.
18853 * Summary Score Commands:: Adding score entries for the current group.
18854 * Group Score Commands:: General score commands.
18855 * Score Variables:: Customize your scoring. (My, what terminology).
18856 * Score File Format:: What a score file may contain.
18857 * Score File Editing:: You can edit score files by hand as well.
18858 * Adaptive Scoring:: Big Sister Gnus knows what you read.
18859 * Home Score File:: How to say where new score entries are to go.
18860 * Followups To Yourself:: Having Gnus notice when people answer you.
18861 * Scoring On Other Headers:: Scoring on non-standard headers.
18862 * Scoring Tips:: How to score effectively.
18863 * Reverse Scoring:: That problem child of old is not problem.
18864 * Global Score Files:: Earth-spanning, ear-splitting score files.
18865 * Kill Files:: They are still here, but they can be ignored.
18866 * Converting Kill Files:: Translating kill files to score files.
18867 * Advanced Scoring:: Using logical expressions to build score rules.
18868 * Score Decays:: It can be useful to let scores wither away.
18872 @node Summary Score Commands
18873 @section Summary Score Commands
18874 @cindex score commands
18876 The score commands that alter score entries do not actually modify real
18877 score files. That would be too inefficient. Gnus maintains a cache of
18878 previously loaded score files, one of which is considered the
18879 @dfn{current score file alist}. The score commands simply insert
18880 entries into this list, and upon group exit, this list is saved.
18882 The current score file is by default the group's local score file, even
18883 if no such score file actually exists. To insert score commands into
18884 some other score file (e.g. @file{all.SCORE}), you must first make this
18885 score file the current one.
18887 General score commands that don't actually change the score file:
18892 @kindex V s (Summary)
18893 @findex gnus-summary-set-score
18894 Set the score of the current article (@code{gnus-summary-set-score}).
18897 @kindex V S (Summary)
18898 @findex gnus-summary-current-score
18899 Display the score of the current article
18900 (@code{gnus-summary-current-score}).
18903 @kindex V t (Summary)
18904 @findex gnus-score-find-trace
18905 Display all score rules that have been used on the current article
18906 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
18907 may type @kbd{e} to edit score file corresponding to the score rule on
18908 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
18909 score file and edit it.
18912 @kindex V w (Summary)
18913 @findex gnus-score-find-favourite-words
18914 List words used in scoring (@code{gnus-score-find-favourite-words}).
18917 @kindex V R (Summary)
18918 @findex gnus-summary-rescore
18919 Run the current summary through the scoring process
18920 (@code{gnus-summary-rescore}). This might be useful if you're playing
18921 around with your score files behind Gnus' back and want to see the
18922 effect you're having.
18925 @kindex V c (Summary)
18926 @findex gnus-score-change-score-file
18927 Make a different score file the current
18928 (@code{gnus-score-change-score-file}).
18931 @kindex V e (Summary)
18932 @findex gnus-score-edit-current-scores
18933 Edit the current score file (@code{gnus-score-edit-current-scores}).
18934 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
18938 @kindex V f (Summary)
18939 @findex gnus-score-edit-file
18940 Edit a score file and make this score file the current one
18941 (@code{gnus-score-edit-file}).
18944 @kindex V F (Summary)
18945 @findex gnus-score-flush-cache
18946 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
18947 after editing score files.
18950 @kindex V C (Summary)
18951 @findex gnus-score-customize
18952 Customize a score file in a visually pleasing manner
18953 (@code{gnus-score-customize}).
18957 The rest of these commands modify the local score file.
18962 @kindex V m (Summary)
18963 @findex gnus-score-set-mark-below
18964 Prompt for a score, and mark all articles with a score below this as
18965 read (@code{gnus-score-set-mark-below}).
18968 @kindex V x (Summary)
18969 @findex gnus-score-set-expunge-below
18970 Prompt for a score, and add a score rule to the current score file to
18971 expunge all articles below this score
18972 (@code{gnus-score-set-expunge-below}).
18975 The keystrokes for actually making score entries follow a very regular
18976 pattern, so there's no need to list all the commands. (Hundreds of
18979 @findex gnus-summary-increase-score
18980 @findex gnus-summary-lower-score
18984 The first key is either @kbd{I} (upper case i) for increasing the score
18985 or @kbd{L} for lowering the score.
18987 The second key says what header you want to score on. The following
18988 keys are available:
18992 Score on the author name.
18995 Score on the subject line.
18998 Score on the @code{Xref} line---i.e., the cross-posting line.
19001 Score on the @code{References} line.
19007 Score on the number of lines.
19010 Score on the @code{Message-ID} header.
19013 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
19014 if your @acronym{NNTP} server tracks additional header data in overviews.
19017 Score on followups---this matches the author name, and adds scores to
19018 the followups to this author. (Using this key leads to the creation of
19019 @file{ADAPT} files.)
19028 Score on thread. (Using this key leads to the creation of @file{ADAPT}
19034 The third key is the match type. Which match types are valid depends on
19035 what headers you are scoring on.
19047 Substring matching.
19050 Fuzzy matching (@pxref{Fuzzy Matching}).
19079 Greater than number.
19084 The fourth and usually final key says whether this is a temporary (i.e.,
19085 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
19086 or whether it is to be done immediately, without adding to the score
19091 Temporary score entry.
19094 Permanent score entry.
19097 Immediately scoring.
19101 If you are scoring on `e' (extra) headers, you will then be prompted for
19102 the header name on which you wish to score. This must be a header named
19103 in gnus-extra-headers, and @samp{TAB} completion is available.
19107 So, let's say you want to increase the score on the current author with
19108 exact matching permanently: @kbd{I a e p}. If you want to lower the
19109 score based on the subject line, using substring matching, and make a
19110 temporary score entry: @kbd{L s s t}. Pretty easy.
19112 To make things a bit more complicated, there are shortcuts. If you use
19113 a capital letter on either the second or third keys, Gnus will use
19114 defaults for the remaining one or two keystrokes. The defaults are
19115 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
19116 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
19118 These functions take both the numerical prefix and the symbolic prefix
19119 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
19120 (or increase) the score of the article. A symbolic prefix of @code{a}
19121 says to use the @file{all.SCORE} file for the command instead of the
19122 current score file.
19124 @vindex gnus-score-mimic-keymap
19125 The @code{gnus-score-mimic-keymap} says whether these commands will
19126 pretend they are keymaps or not.
19129 @node Group Score Commands
19130 @section Group Score Commands
19131 @cindex group score commands
19133 There aren't many of these as yet, I'm afraid.
19138 @kindex W e (Group)
19139 @findex gnus-score-edit-all-score
19140 Edit the apply-to-all-groups all.SCORE file. You will be popped into
19141 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
19144 @kindex W f (Group)
19145 @findex gnus-score-flush-cache
19146 Gnus maintains a cache of score alists to avoid having to reload them
19147 all the time. This command will flush the cache
19148 (@code{gnus-score-flush-cache}).
19152 You can do scoring from the command line by saying something like:
19154 @findex gnus-batch-score
19155 @cindex batch scoring
19157 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
19161 @node Score Variables
19162 @section Score Variables
19163 @cindex score variables
19167 @item gnus-use-scoring
19168 @vindex gnus-use-scoring
19169 If @code{nil}, Gnus will not check for score files, and will not, in
19170 general, do any score-related work. This is @code{t} by default.
19172 @item gnus-kill-killed
19173 @vindex gnus-kill-killed
19174 If this variable is @code{nil}, Gnus will never apply score files to
19175 articles that have already been through the kill process. While this
19176 may save you lots of time, it also means that if you apply a kill file
19177 to a group, and then change the kill file and want to run it over you
19178 group again to kill more articles, it won't work. You have to set this
19179 variable to @code{t} to do that. (It is @code{t} by default.)
19181 @item gnus-kill-files-directory
19182 @vindex gnus-kill-files-directory
19183 All kill and score files will be stored in this directory, which is
19184 initialized from the @env{SAVEDIR} environment variable by default.
19185 This is @file{~/News/} by default.
19187 @item gnus-score-file-suffix
19188 @vindex gnus-score-file-suffix
19189 Suffix to add to the group name to arrive at the score file name
19190 (@file{SCORE} by default.)
19192 @item gnus-score-uncacheable-files
19193 @vindex gnus-score-uncacheable-files
19194 @cindex score cache
19195 All score files are normally cached to avoid excessive re-loading of
19196 score files. However, if this might make your Emacs grow big and
19197 bloated, so this regexp can be used to weed out score files unlikely
19198 to be needed again. It would be a bad idea to deny caching of
19199 @file{all.SCORE}, while it might be a good idea to not cache
19200 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
19201 variable is @samp{ADAPT$} by default, so no adaptive score files will
19204 @item gnus-save-score
19205 @vindex gnus-save-score
19206 If you have really complicated score files, and do lots of batch
19207 scoring, then you might set this variable to @code{t}. This will make
19208 Gnus save the scores into the @file{.newsrc.eld} file.
19210 If you do not set this to @code{t}, then manual scores (like those set
19211 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
19212 across group visits.
19214 @item gnus-score-interactive-default-score
19215 @vindex gnus-score-interactive-default-score
19216 Score used by all the interactive raise/lower commands to raise/lower
19217 score with. Default is 1000, which may seem excessive, but this is to
19218 ensure that the adaptive scoring scheme gets enough room to play with.
19219 We don't want the small changes from the adaptive scoring to overwrite
19220 manually entered data.
19222 @item gnus-summary-default-score
19223 @vindex gnus-summary-default-score
19224 Default score of an article, which is 0 by default.
19226 @item gnus-summary-expunge-below
19227 @vindex gnus-summary-expunge-below
19228 Don't display the summary lines of articles that have scores lower than
19229 this variable. This is @code{nil} by default, which means that no
19230 articles will be hidden. This variable is local to the summary buffers,
19231 and has to be set from @code{gnus-summary-mode-hook}.
19233 @item gnus-score-over-mark
19234 @vindex gnus-score-over-mark
19235 Mark (in the third column) used for articles with a score over the
19236 default. Default is @samp{+}.
19238 @item gnus-score-below-mark
19239 @vindex gnus-score-below-mark
19240 Mark (in the third column) used for articles with a score below the
19241 default. Default is @samp{-}.
19243 @item gnus-score-find-score-files-function
19244 @vindex gnus-score-find-score-files-function
19245 Function used to find score files for the current group. This function
19246 is called with the name of the group as the argument.
19248 Predefined functions available are:
19251 @item gnus-score-find-single
19252 @findex gnus-score-find-single
19253 Only apply the group's own score file.
19255 @item gnus-score-find-bnews
19256 @findex gnus-score-find-bnews
19257 Apply all score files that match, using bnews syntax. This is the
19258 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
19259 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
19260 @file{gnu.all.SCORE} would all apply. In short, the instances of
19261 @samp{all} in the score file names are translated into @samp{.*}, and
19262 then a regexp match is done.
19264 This means that if you have some score entries that you want to apply to
19265 all groups, then you put those entries in the @file{all.SCORE} file.
19267 The score files are applied in a semi-random order, although Gnus will
19268 try to apply the more general score files before the more specific score
19269 files. It does this by looking at the number of elements in the score
19270 file names---discarding the @samp{all} elements.
19272 @item gnus-score-find-hierarchical
19273 @findex gnus-score-find-hierarchical
19274 Apply all score files from all the parent groups. This means that you
19275 can't have score files like @file{all.SCORE}, but you can have
19276 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19280 This variable can also be a list of functions. In that case, all
19281 these functions will be called with the group name as argument, and
19282 all the returned lists of score files will be applied. These
19283 functions can also return lists of lists of score alists directly. In
19284 that case, the functions that return these non-file score alists
19285 should probably be placed before the ``real'' score file functions, to
19286 ensure that the last score file returned is the local score file.
19289 For example, to do hierarchical scoring but use a non-server-specific
19290 overall score file, you could use the value
19292 (list (lambda (group) ("all.SCORE"))
19293 'gnus-score-find-hierarchical)
19296 @item gnus-score-expiry-days
19297 @vindex gnus-score-expiry-days
19298 This variable says how many days should pass before an unused score file
19299 entry is expired. If this variable is @code{nil}, no score file entries
19300 are expired. It's 7 by default.
19302 @item gnus-update-score-entry-dates
19303 @vindex gnus-update-score-entry-dates
19304 If this variable is non-@code{nil}, temporary score entries that have
19305 been triggered (matched) will have their dates updated. (This is how Gnus
19306 controls expiry---all non-matched-entries will become too old while
19307 matched entries will stay fresh and young.) However, if you set this
19308 variable to @code{nil}, even matched entries will grow old and will
19309 have to face that oh-so grim reaper.
19311 @item gnus-score-after-write-file-function
19312 @vindex gnus-score-after-write-file-function
19313 Function called with the name of the score file just written.
19315 @item gnus-score-thread-simplify
19316 @vindex gnus-score-thread-simplify
19317 If this variable is non-@code{nil}, article subjects will be
19318 simplified for subject scoring purposes in the same manner as with
19319 threading---according to the current value of
19320 @code{gnus-simplify-subject-functions}. If the scoring entry uses
19321 @code{substring} or @code{exact} matching, the match will also be
19322 simplified in this manner.
19327 @node Score File Format
19328 @section Score File Format
19329 @cindex score file format
19331 A score file is an @code{emacs-lisp} file that normally contains just a
19332 single form. Casual users are not expected to edit these files;
19333 everything can be changed from the summary buffer.
19335 Anyway, if you'd like to dig into it yourself, here's an example:
19339 ("Lars Ingebrigtsen" -10000)
19341 ("larsi\\|lmi" -50000 nil R))
19343 ("Ding is Badd" nil 728373))
19345 ("alt.politics" -1000 728372 s))
19350 (mark-and-expunge -10)
19354 (files "/hom/larsi/News/gnu.SCORE")
19355 (exclude-files "all.SCORE")
19356 (local (gnus-newsgroup-auto-expire t)
19357 (gnus-summary-make-false-root empty))
19361 This example demonstrates most score file elements. @xref{Advanced
19362 Scoring}, for a different approach.
19364 Even though this looks much like Lisp code, nothing here is actually
19365 @code{eval}ed. The Lisp reader is used to read this form, though, so it
19366 has to be valid syntactically, if not semantically.
19368 Six keys are supported by this alist:
19373 If the key is a string, it is the name of the header to perform the
19374 match on. Scoring can only be performed on these eight headers:
19375 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
19376 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
19377 these headers, there are three strings to tell Gnus to fetch the entire
19378 article and do the match on larger parts of the article: @code{Body}
19379 will perform the match on the body of the article, @code{Head} will
19380 perform the match on the head of the article, and @code{All} will
19381 perform the match on the entire article. Note that using any of these
19382 last three keys will slow down group entry @emph{considerably}. The
19383 final ``header'' you can score on is @code{Followup}. These score
19384 entries will result in new score entries being added for all follow-ups
19385 to articles that matches these score entries.
19387 Following this key is an arbitrary number of score entries, where each
19388 score entry has one to four elements.
19392 The first element is the @dfn{match element}. On most headers this will
19393 be a string, but on the Lines and Chars headers, this must be an
19397 If the second element is present, it should be a number---the @dfn{score
19398 element}. This number should be an integer in the neginf to posinf
19399 interval. This number is added to the score of the article if the match
19400 is successful. If this element is not present, the
19401 @code{gnus-score-interactive-default-score} number will be used
19402 instead. This is 1000 by default.
19405 If the third element is present, it should be a number---the @dfn{date
19406 element}. This date says when the last time this score entry matched,
19407 which provides a mechanism for expiring the score entries. It this
19408 element is not present, the score entry is permanent. The date is
19409 represented by the number of days since December 31, 1 BCE.
19412 If the fourth element is present, it should be a symbol---the @dfn{type
19413 element}. This element specifies what function should be used to see
19414 whether this score entry matches the article. What match types that can
19415 be used depends on what header you wish to perform the match on.
19418 @item From, Subject, References, Xref, Message-ID
19419 For most header types, there are the @code{r} and @code{R} (regexp), as
19420 well as @code{s} and @code{S} (substring) types, and @code{e} and
19421 @code{E} (exact match), and @code{w} (word match) types. If this
19422 element is not present, Gnus will assume that substring matching should
19423 be used. @code{R}, @code{S}, and @code{E} differ from the others in
19424 that the matches will be done in a case-sensitive manner. All these
19425 one-letter types are really just abbreviations for the @code{regexp},
19426 @code{string}, @code{exact}, and @code{word} types, which you can use
19427 instead, if you feel like.
19430 Just as for the standard string overview headers, if you are using
19431 gnus-extra-headers, you can score on these headers' values. In this
19432 case, there is a 5th element in the score entry, being the name of the
19433 header to be scored. The following entry is useful in your
19434 @file{all.SCORE} file in case of spam attacks from a single origin
19435 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
19439 ("111.222.333.444" -1000 nil s
19440 "NNTP-Posting-Host")
19444 These two headers use different match types: @code{<}, @code{>},
19445 @code{=}, @code{>=} and @code{<=}.
19447 These predicates are true if
19450 (PREDICATE HEADER MATCH)
19453 evaluates to non-@code{nil}. For instance, the advanced match
19454 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
19461 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
19462 the match, we get the score added if the article has less than 4 lines.
19463 (It's easy to get confused and think it's the other way around. But
19464 it's not. I think.)
19466 When matching on @code{Lines}, be careful because some back ends (like
19467 @code{nndir}) do not generate @code{Lines} header, so every article ends
19468 up being marked as having 0 lines. This can lead to strange results if
19469 you happen to lower score of the articles with few lines.
19472 For the Date header we have three kinda silly match types:
19473 @code{before}, @code{at} and @code{after}. I can't really imagine this
19474 ever being useful, but, like, it would feel kinda silly not to provide
19475 this function. Just in case. You never know. Better safe than sorry.
19476 Once burnt, twice shy. Don't judge a book by its cover. Never not have
19477 sex on a first date. (I have been told that at least one person, and I
19478 quote, ``found this function indispensable'', however.)
19482 A more useful match type is @code{regexp}. With it, you can match the
19483 date string using a regular expression. The date is normalized to
19484 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
19485 you want to match all articles that have been posted on April 1st in
19486 every year, you could use @samp{....0401.........} as a match string,
19487 for instance. (Note that the date is kept in its original time zone, so
19488 this will match articles that were posted when it was April 1st where
19489 the article was posted from. Time zones are such wholesome fun for the
19492 @item Head, Body, All
19493 These three match keys use the same match types as the @code{From} (etc)
19497 This match key is somewhat special, in that it will match the
19498 @code{From} header, and affect the score of not only the matching
19499 articles, but also all followups to the matching articles. This allows
19500 you e.g. increase the score of followups to your own articles, or
19501 decrease the score of followups to the articles of some known
19502 trouble-maker. Uses the same match types as the @code{From} header
19503 uses. (Using this match key will lead to creation of @file{ADAPT}
19507 This match key works along the same lines as the @code{Followup} match
19508 key. If you say that you want to score on a (sub-)thread started by an
19509 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
19510 match. This will add a new @samp{thread} match for each article that
19511 has @var{x} in its @code{References} header. (These new @samp{thread}
19512 matches will use the @code{Message-ID}s of these matching articles.)
19513 This will ensure that you can raise/lower the score of an entire thread,
19514 even though some articles in the thread may not have complete
19515 @code{References} headers. Note that using this may lead to
19516 undeterministic scores of the articles in the thread. (Using this match
19517 key will lead to creation of @file{ADAPT} files.)
19521 @cindex score file atoms
19523 The value of this entry should be a number. Any articles with a score
19524 lower than this number will be marked as read.
19527 The value of this entry should be a number. Any articles with a score
19528 lower than this number will be removed from the summary buffer.
19530 @item mark-and-expunge
19531 The value of this entry should be a number. Any articles with a score
19532 lower than this number will be marked as read and removed from the
19535 @item thread-mark-and-expunge
19536 The value of this entry should be a number. All articles that belong to
19537 a thread that has a total score below this number will be marked as read
19538 and removed from the summary buffer. @code{gnus-thread-score-function}
19539 says how to compute the total score for a thread.
19542 The value of this entry should be any number of file names. These files
19543 are assumed to be score files as well, and will be loaded the same way
19546 @item exclude-files
19547 The clue of this entry should be any number of files. These files will
19548 not be loaded, even though they would normally be so, for some reason or
19552 The value of this entry will be @code{eval}el. This element will be
19553 ignored when handling global score files.
19556 Read-only score files will not be updated or saved. Global score files
19557 should feature this atom (@pxref{Global Score Files}). (Note:
19558 @dfn{Global} here really means @dfn{global}; not your personal
19559 apply-to-all-groups score files.)
19562 The value of this entry should be a number. Articles that do not have
19563 parents will get this number added to their scores. Imagine you follow
19564 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
19565 will only follow a few of the threads, also want to see any new threads.
19567 You can do this with the following two score file entries:
19571 (mark-and-expunge -100)
19574 When you enter the group the first time, you will only see the new
19575 threads. You then raise the score of the threads that you find
19576 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
19577 rest. Next time you enter the group, you will see new articles in the
19578 interesting threads, plus any new threads.
19580 I.e.---the orphan score atom is for high-volume groups where a few
19581 interesting threads which can't be found automatically by ordinary
19582 scoring rules exist.
19585 This entry controls the adaptive scoring. If it is @code{t}, the
19586 default adaptive scoring rules will be used. If it is @code{ignore}, no
19587 adaptive scoring will be performed on this group. If it is a list, this
19588 list will be used as the adaptive scoring rules. If it isn't present,
19589 or is something other than @code{t} or @code{ignore}, the default
19590 adaptive scoring rules will be used. If you want to use adaptive
19591 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
19592 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
19593 not want adaptive scoring. If you only want adaptive scoring in a few
19594 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
19595 insert @code{(adapt t)} in the score files of the groups where you want
19599 All adaptive score entries will go to the file named by this entry. It
19600 will also be applied when entering the group. This atom might be handy
19601 if you want to adapt on several groups at once, using the same adaptive
19602 file for a number of groups.
19605 @cindex local variables
19606 The value of this entry should be a list of @code{(@var{var}
19607 @var{value})} pairs. Each @var{var} will be made buffer-local to the
19608 current summary buffer, and set to the value specified. This is a
19609 convenient, if somewhat strange, way of setting variables in some
19610 groups if you don't like hooks much. Note that the @var{value} won't
19615 @node Score File Editing
19616 @section Score File Editing
19618 You normally enter all scoring commands from the summary buffer, but you
19619 might feel the urge to edit them by hand as well, so we've supplied you
19620 with a mode for that.
19622 It's simply a slightly customized @code{emacs-lisp} mode, with these
19623 additional commands:
19628 @kindex C-c C-c (Score)
19629 @findex gnus-score-edit-done
19630 Save the changes you have made and return to the summary buffer
19631 (@code{gnus-score-edit-done}).
19634 @kindex C-c C-d (Score)
19635 @findex gnus-score-edit-insert-date
19636 Insert the current date in numerical format
19637 (@code{gnus-score-edit-insert-date}). This is really the day number, if
19638 you were wondering.
19641 @kindex C-c C-p (Score)
19642 @findex gnus-score-pretty-print
19643 The adaptive score files are saved in an unformatted fashion. If you
19644 intend to read one of these files, you want to @dfn{pretty print} it
19645 first. This command (@code{gnus-score-pretty-print}) does that for
19650 Type @kbd{M-x gnus-score-mode} to use this mode.
19652 @vindex gnus-score-mode-hook
19653 @code{gnus-score-menu-hook} is run in score mode buffers.
19655 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
19656 @kbd{V t} to begin editing score files.
19659 @node Adaptive Scoring
19660 @section Adaptive Scoring
19661 @cindex adaptive scoring
19663 If all this scoring is getting you down, Gnus has a way of making it all
19664 happen automatically---as if by magic. Or rather, as if by artificial
19665 stupidity, to be precise.
19667 @vindex gnus-use-adaptive-scoring
19668 When you read an article, or mark an article as read, or kill an
19669 article, you leave marks behind. On exit from the group, Gnus can sniff
19670 these marks and add score elements depending on what marks it finds.
19671 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
19672 @code{t} or @code{(line)}. If you want score adaptively on separate
19673 words appearing in the subjects, you should set this variable to
19674 @code{(word)}. If you want to use both adaptive methods, set this
19675 variable to @code{(word line)}.
19677 @vindex gnus-default-adaptive-score-alist
19678 To give you complete control over the scoring process, you can customize
19679 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
19680 might look something like this:
19683 (setq gnus-default-adaptive-score-alist
19684 '((gnus-unread-mark)
19685 (gnus-ticked-mark (from 4))
19686 (gnus-dormant-mark (from 5))
19687 (gnus-del-mark (from -4) (subject -1))
19688 (gnus-read-mark (from 4) (subject 2))
19689 (gnus-expirable-mark (from -1) (subject -1))
19690 (gnus-killed-mark (from -1) (subject -3))
19691 (gnus-kill-file-mark)
19692 (gnus-ancient-mark)
19693 (gnus-low-score-mark)
19694 (gnus-catchup-mark (from -1) (subject -1))))
19697 As you see, each element in this alist has a mark as a key (either a
19698 variable name or a ``real'' mark---a character). Following this key is
19699 a arbitrary number of header/score pairs. If there are no header/score
19700 pairs following the key, no adaptive scoring will be done on articles
19701 that have that key as the article mark. For instance, articles with
19702 @code{gnus-unread-mark} in the example above will not get adaptive score
19705 Each article can have only one mark, so just a single of these rules
19706 will be applied to each article.
19708 To take @code{gnus-del-mark} as an example---this alist says that all
19709 articles that have that mark (i.e., are marked with @samp{e}) will have a
19710 score entry added to lower based on the @code{From} header by -4, and
19711 lowered by @code{Subject} by -1. Change this to fit your prejudices.
19713 If you have marked 10 articles with the same subject with
19714 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
19715 That means that that subject will get a score of ten times -1, which
19716 should be, unless I'm much mistaken, -10.
19718 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
19719 the read articles will be marked with the @samp{E} mark. This'll
19720 probably make adaptive scoring slightly impossible, so auto-expiring and
19721 adaptive scoring doesn't really mix very well.
19723 The headers you can score on are @code{from}, @code{subject},
19724 @code{message-id}, @code{references}, @code{xref}, @code{lines},
19725 @code{chars} and @code{date}. In addition, you can score on
19726 @code{followup}, which will create an adaptive score entry that matches
19727 on the @code{References} header using the @code{Message-ID} of the
19728 current article, thereby matching the following thread.
19730 If you use this scheme, you should set the score file atom @code{mark}
19731 to something small---like -300, perhaps, to avoid having small random
19732 changes result in articles getting marked as read.
19734 After using adaptive scoring for a week or so, Gnus should start to
19735 become properly trained and enhance the authors you like best, and kill
19736 the authors you like least, without you having to say so explicitly.
19738 You can control what groups the adaptive scoring is to be performed on
19739 by using the score files (@pxref{Score File Format}). This will also
19740 let you use different rules in different groups.
19742 @vindex gnus-adaptive-file-suffix
19743 The adaptive score entries will be put into a file where the name is the
19744 group name with @code{gnus-adaptive-file-suffix} appended. The default
19747 @vindex gnus-adaptive-pretty-print
19748 Adaptive score files can get huge and are not meant to be edited by
19749 human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the
19750 deafult) those files will not be written in a human readable way.
19752 @vindex gnus-score-exact-adapt-limit
19753 When doing adaptive scoring, substring or fuzzy matching would probably
19754 give you the best results in most cases. However, if the header one
19755 matches is short, the possibility for false positives is great, so if
19756 the length of the match is less than
19757 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
19758 this variable is @code{nil}, exact matching will always be used to avoid
19761 @vindex gnus-default-adaptive-word-score-alist
19762 As mentioned above, you can adapt either on individual words or entire
19763 headers. If you adapt on words, the
19764 @code{gnus-default-adaptive-word-score-alist} variable says what score
19765 each instance of a word should add given a mark.
19768 (setq gnus-default-adaptive-word-score-alist
19769 `((,gnus-read-mark . 30)
19770 (,gnus-catchup-mark . -10)
19771 (,gnus-killed-mark . -20)
19772 (,gnus-del-mark . -15)))
19775 This is the default value. If you have adaption on words enabled, every
19776 word that appears in subjects of articles marked with
19777 @code{gnus-read-mark} will result in a score rule that increase the
19778 score with 30 points.
19780 @vindex gnus-default-ignored-adaptive-words
19781 @vindex gnus-ignored-adaptive-words
19782 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
19783 will be ignored. If you wish to add more words to be ignored, use the
19784 @code{gnus-ignored-adaptive-words} list instead.
19786 @vindex gnus-adaptive-word-length-limit
19787 Some may feel that short words shouldn't count when doing adaptive
19788 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
19789 an integer. Words shorter than this number will be ignored. This
19790 variable defaults to @code{nil}.
19792 @vindex gnus-adaptive-word-syntax-table
19793 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
19794 syntax table in effect. It is similar to the standard syntax table, but
19795 it considers numbers to be non-word-constituent characters.
19797 @vindex gnus-adaptive-word-minimum
19798 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
19799 word scoring process will never bring down the score of an article to
19800 below this number. The default is @code{nil}.
19802 @vindex gnus-adaptive-word-no-group-words
19803 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
19804 won't adaptively word score any of the words in the group name. Useful
19805 for groups like @samp{comp.editors.emacs}, where most of the subject
19806 lines contain the word @samp{emacs}.
19808 After using this scheme for a while, it might be nice to write a
19809 @code{gnus-psychoanalyze-user} command to go through the rules and see
19810 what words you like and what words you don't like. Or perhaps not.
19812 Note that the adaptive word scoring thing is highly experimental and is
19813 likely to change in the future. Initial impressions seem to indicate
19814 that it's totally useless as it stands. Some more work (involving more
19815 rigorous statistical methods) will have to be done to make this useful.
19818 @node Home Score File
19819 @section Home Score File
19821 The score file where new score file entries will go is called the
19822 @dfn{home score file}. This is normally (and by default) the score file
19823 for the group itself. For instance, the home score file for
19824 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
19826 However, this may not be what you want. It is often convenient to share
19827 a common home score file among many groups---all @samp{emacs} groups
19828 could perhaps use the same home score file.
19830 @vindex gnus-home-score-file
19831 The variable that controls this is @code{gnus-home-score-file}. It can
19836 A string. Then this file will be used as the home score file for all
19840 A function. The result of this function will be used as the home score
19841 file. The function will be called with the name of the group as the
19845 A list. The elements in this list can be:
19849 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
19850 group name, the @var{file-name} will be used as the home score file.
19853 A function. If the function returns non-@code{nil}, the result will
19854 be used as the home score file.
19857 A string. Use the string as the home score file.
19860 The list will be traversed from the beginning towards the end looking
19865 So, if you want to use just a single score file, you could say:
19868 (setq gnus-home-score-file
19869 "my-total-score-file.SCORE")
19872 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
19873 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
19875 @findex gnus-hierarchial-home-score-file
19877 (setq gnus-home-score-file
19878 'gnus-hierarchial-home-score-file)
19881 This is a ready-made function provided for your convenience.
19882 Other functions include
19885 @item gnus-current-home-score-file
19886 @findex gnus-current-home-score-file
19887 Return the ``current'' regular score file. This will make scoring
19888 commands add entry to the ``innermost'' matching score file.
19892 If you want to have one score file for the @samp{emacs} groups and
19893 another for the @samp{comp} groups, while letting all other groups use
19894 their own home score files:
19897 (setq gnus-home-score-file
19898 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
19899 '(("\\.emacs" "emacs.SCORE")
19900 ;; @r{All the comp groups in one score file}
19901 ("^comp" "comp.SCORE")))
19904 @vindex gnus-home-adapt-file
19905 @code{gnus-home-adapt-file} works exactly the same way as
19906 @code{gnus-home-score-file}, but says what the home adaptive score file
19907 is instead. All new adaptive file entries will go into the file
19908 specified by this variable, and the same syntax is allowed.
19910 In addition to using @code{gnus-home-score-file} and
19911 @code{gnus-home-adapt-file}, you can also use group parameters
19912 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
19913 Parameters}) to achieve much the same. Group and topic parameters take
19914 precedence over this variable.
19917 @node Followups To Yourself
19918 @section Followups To Yourself
19920 Gnus offers two commands for picking out the @code{Message-ID} header in
19921 the current buffer. Gnus will then add a score rule that scores using
19922 this @code{Message-ID} on the @code{References} header of other
19923 articles. This will, in effect, increase the score of all articles that
19924 respond to the article in the current buffer. Quite useful if you want
19925 to easily note when people answer what you've said.
19929 @item gnus-score-followup-article
19930 @findex gnus-score-followup-article
19931 This will add a score to articles that directly follow up your own
19934 @item gnus-score-followup-thread
19935 @findex gnus-score-followup-thread
19936 This will add a score to all articles that appear in a thread ``below''
19940 @vindex message-sent-hook
19941 These two functions are both primarily meant to be used in hooks like
19942 @code{message-sent-hook}, like this:
19944 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
19948 If you look closely at your own @code{Message-ID}, you'll notice that
19949 the first two or three characters are always the same. Here's two of
19953 <x6u3u47icf.fsf@@eyesore.no>
19954 <x6sp9o7ibw.fsf@@eyesore.no>
19957 So ``my'' ident on this machine is @samp{x6}. This can be
19958 exploited---the following rule will raise the score on all followups to
19963 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
19967 Whether it's the first two or first three characters that are ``yours''
19968 is system-dependent.
19971 @node Scoring On Other Headers
19972 @section Scoring On Other Headers
19973 @cindex scoring on other headers
19975 Gnus is quite fast when scoring the ``traditional''
19976 headers---@samp{From}, @samp{Subject} and so on. However, scoring
19977 other headers requires writing a @code{head} scoring rule, which means
19978 that Gnus has to request every single article from the back end to find
19979 matches. This takes a long time in big groups.
19981 Now, there's not much you can do about this for news groups, but for
19982 mail groups, you have greater control. In @ref{To From Newsgroups},
19983 it's explained in greater detail what this mechanism does, but here's
19984 a cookbook example for @code{nnml} on how to allow scoring on the
19985 @samp{To} and @samp{Cc} headers.
19987 Put the following in your @file{~/.gnus.el} file.
19990 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
19991 nnmail-extra-headers gnus-extra-headers)
19994 Restart Gnus and rebuild your @code{nnml} overview files with the
19995 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
19996 time if you have much mail.
19998 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
19999 so: @kbd{I e s p To RET <your name> RET}.
20005 @section Scoring Tips
20006 @cindex scoring tips
20012 @cindex scoring crossposts
20013 If you want to lower the score of crossposts, the line to match on is
20014 the @code{Xref} header.
20016 ("xref" (" talk.politics.misc:" -1000))
20019 @item Multiple crossposts
20020 If you want to lower the score of articles that have been crossposted to
20021 more than, say, 3 groups:
20024 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
20028 @item Matching on the body
20029 This is generally not a very good idea---it takes a very long time.
20030 Gnus actually has to fetch each individual article from the server. But
20031 you might want to anyway, I guess. Even though there are three match
20032 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
20033 and stick with it in each score file. If you use any two, each article
20034 will be fetched @emph{twice}. If you want to match a bit on the
20035 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
20038 @item Marking as read
20039 You will probably want to mark articles that have scores below a certain
20040 number as read. This is most easily achieved by putting the following
20041 in your @file{all.SCORE} file:
20045 You may also consider doing something similar with @code{expunge}.
20047 @item Negated character classes
20048 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
20049 That will match newlines, which might lead to, well, The Unknown. Say
20050 @code{[^abcd\n]*} instead.
20054 @node Reverse Scoring
20055 @section Reverse Scoring
20056 @cindex reverse scoring
20058 If you want to keep just articles that have @samp{Sex with Emacs} in the
20059 subject header, and expunge all other articles, you could put something
20060 like this in your score file:
20064 ("Sex with Emacs" 2))
20069 So, you raise all articles that match @samp{Sex with Emacs} and mark the
20070 rest as read, and expunge them to boot.
20073 @node Global Score Files
20074 @section Global Score Files
20075 @cindex global score files
20077 Sure, other newsreaders have ``global kill files''. These are usually
20078 nothing more than a single kill file that applies to all groups, stored
20079 in the user's home directory. Bah! Puny, weak newsreaders!
20081 What I'm talking about here are Global Score Files. Score files from
20082 all over the world, from users everywhere, uniting all nations in one
20083 big, happy score file union! Ange-score! New and untested!
20085 @vindex gnus-global-score-files
20086 All you have to do to use other people's score files is to set the
20087 @code{gnus-global-score-files} variable. One entry for each score file,
20088 or each score file directory. Gnus will decide by itself what score
20089 files are applicable to which group.
20091 To use the score file
20092 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
20093 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
20097 (setq gnus-global-score-files
20098 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
20099 "/ftp@@ftp.some-where:/pub/score/"))
20102 @findex gnus-score-search-global-directories
20104 Simple, eh? Directory names must end with a @samp{/}. These
20105 directories are typically scanned only once during each Gnus session.
20106 If you feel the need to manually re-scan the remote directories, you can
20107 use the @code{gnus-score-search-global-directories} command.
20109 Note that, at present, using this option will slow down group entry
20110 somewhat. (That is---a lot.)
20112 If you want to start maintaining score files for other people to use,
20113 just put your score file up for anonymous ftp and announce it to the
20114 world. Become a retro-moderator! Participate in the retro-moderator
20115 wars sure to ensue, where retro-moderators battle it out for the
20116 sympathy of the people, luring them to use their score files on false
20117 premises! Yay! The net is saved!
20119 Here are some tips for the would-be retro-moderator, off the top of my
20125 Articles heavily crossposted are probably junk.
20127 To lower a single inappropriate article, lower by @code{Message-ID}.
20129 Particularly brilliant authors can be raised on a permanent basis.
20131 Authors that repeatedly post off-charter for the group can safely be
20132 lowered out of existence.
20134 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
20135 articles completely.
20138 Use expiring score entries to keep the size of the file down. You
20139 should probably have a long expiry period, though, as some sites keep
20140 old articles for a long time.
20143 @dots{} I wonder whether other newsreaders will support global score files
20144 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
20145 Wave, xrn and 1stReader are bound to implement scoring. Should we start
20146 holding our breath yet?
20150 @section Kill Files
20153 Gnus still supports those pesky old kill files. In fact, the kill file
20154 entries can now be expiring, which is something I wrote before Daniel
20155 Quinlan thought of doing score files, so I've left the code in there.
20157 In short, kill processing is a lot slower (and I do mean @emph{a lot})
20158 than score processing, so it might be a good idea to rewrite your kill
20159 files into score files.
20161 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
20162 forms into this file, which means that you can use kill files as some
20163 sort of primitive hook function to be run on group entry, even though
20164 that isn't a very good idea.
20166 Normal kill files look like this:
20169 (gnus-kill "From" "Lars Ingebrigtsen")
20170 (gnus-kill "Subject" "ding")
20174 This will mark every article written by me as read, and remove the
20175 marked articles from the summary buffer. Very useful, you'll agree.
20177 Other programs use a totally different kill file syntax. If Gnus
20178 encounters what looks like a @code{rn} kill file, it will take a stab at
20181 Two summary functions for editing a @sc{gnus} kill file:
20186 @kindex M-k (Summary)
20187 @findex gnus-summary-edit-local-kill
20188 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
20191 @kindex M-K (Summary)
20192 @findex gnus-summary-edit-global-kill
20193 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
20196 Two group mode functions for editing the kill files:
20201 @kindex M-k (Group)
20202 @findex gnus-group-edit-local-kill
20203 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
20206 @kindex M-K (Group)
20207 @findex gnus-group-edit-global-kill
20208 Edit the general kill file (@code{gnus-group-edit-global-kill}).
20211 Kill file variables:
20214 @item gnus-kill-file-name
20215 @vindex gnus-kill-file-name
20216 A kill file for the group @samp{soc.motss} is normally called
20217 @file{soc.motss.KILL}. The suffix appended to the group name to get
20218 this file name is detailed by the @code{gnus-kill-file-name} variable.
20219 The ``global'' kill file (not in the score file sense of ``global'', of
20220 course) is just called @file{KILL}.
20222 @vindex gnus-kill-save-kill-file
20223 @item gnus-kill-save-kill-file
20224 If this variable is non-@code{nil}, Gnus will save the
20225 kill file after processing, which is necessary if you use expiring
20228 @item gnus-apply-kill-hook
20229 @vindex gnus-apply-kill-hook
20230 @findex gnus-apply-kill-file-unless-scored
20231 @findex gnus-apply-kill-file
20232 A hook called to apply kill files to a group. It is
20233 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
20234 kill file if you have a score file for the same group, you can set this
20235 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
20236 kill files to be processed, you should set this variable to @code{nil}.
20238 @item gnus-kill-file-mode-hook
20239 @vindex gnus-kill-file-mode-hook
20240 A hook called in kill-file mode buffers.
20245 @node Converting Kill Files
20246 @section Converting Kill Files
20248 @cindex converting kill files
20250 If you have loads of old kill files, you may want to convert them into
20251 score files. If they are ``regular'', you can use
20252 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
20255 The kill to score conversion package isn't included in Gnus by default.
20256 You can fetch it from
20257 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
20259 If your old kill files are very complex---if they contain more
20260 non-@code{gnus-kill} forms than not, you'll have to convert them by
20261 hand. Or just let them be as they are. Gnus will still use them as
20265 @node Advanced Scoring
20266 @section Advanced Scoring
20268 Scoring on Subjects and From headers is nice enough, but what if you're
20269 really interested in what a person has to say only when she's talking
20270 about a particular subject? Or what if you really don't want to
20271 read what person A has to say when she's following up to person B, but
20272 want to read what she says when she's following up to person C?
20274 By using advanced scoring rules you may create arbitrarily complex
20278 * Advanced Scoring Syntax:: A definition.
20279 * Advanced Scoring Examples:: What they look like.
20280 * Advanced Scoring Tips:: Getting the most out of it.
20284 @node Advanced Scoring Syntax
20285 @subsection Advanced Scoring Syntax
20287 Ordinary scoring rules have a string as the first element in the rule.
20288 Advanced scoring rules have a list as the first element. The second
20289 element is the score to be applied if the first element evaluated to a
20290 non-@code{nil} value.
20292 These lists may consist of three logical operators, one redirection
20293 operator, and various match operators.
20300 This logical operator will evaluate each of its arguments until it finds
20301 one that evaluates to @code{false}, and then it'll stop. If all arguments
20302 evaluate to @code{true} values, then this operator will return
20307 This logical operator will evaluate each of its arguments until it finds
20308 one that evaluates to @code{true}. If no arguments are @code{true},
20309 then this operator will return @code{false}.
20314 This logical operator only takes a single argument. It returns the
20315 logical negation of the value of its argument.
20319 There is an @dfn{indirection operator} that will make its arguments
20320 apply to the ancestors of the current article being scored. For
20321 instance, @code{1-} will make score rules apply to the parent of the
20322 current article. @code{2-} will make score rules apply to the
20323 grandparent of the current article. Alternatively, you can write
20324 @code{^^}, where the number of @code{^}s (carets) says how far back into
20325 the ancestry you want to go.
20327 Finally, we have the match operators. These are the ones that do the
20328 real work. Match operators are header name strings followed by a match
20329 and a match type. A typical match operator looks like @samp{("from"
20330 "Lars Ingebrigtsen" s)}. The header names are the same as when using
20331 simple scoring, and the match types are also the same.
20334 @node Advanced Scoring Examples
20335 @subsection Advanced Scoring Examples
20337 Please note that the following examples are score file rules. To
20338 make a complete score file from them, surround them with another pair
20341 Let's say you want to increase the score of articles written by Lars
20342 when he's talking about Gnus:
20347 ("from" "Lars Ingebrigtsen")
20348 ("subject" "Gnus"))
20355 When he writes long articles, he sometimes has something nice to say:
20359 ("from" "Lars Ingebrigtsen")
20366 However, when he responds to things written by Reig Eigil Logge, you
20367 really don't want to read what he's written:
20371 ("from" "Lars Ingebrigtsen")
20372 (1- ("from" "Reig Eigir Logge")))
20376 Everybody that follows up Redmondo when he writes about disappearing
20377 socks should have their scores raised, but only when they talk about
20378 white socks. However, when Lars talks about socks, it's usually not
20385 ("from" "redmondo@@.*no" r)
20386 ("body" "disappearing.*socks" t)))
20387 (! ("from" "Lars Ingebrigtsen"))
20388 ("body" "white.*socks"))
20392 The possibilities are endless.
20395 @node Advanced Scoring Tips
20396 @subsection Advanced Scoring Tips
20398 The @code{&} and @code{|} logical operators do short-circuit logic.
20399 That is, they stop processing their arguments when it's clear what the
20400 result of the operation will be. For instance, if one of the arguments
20401 of an @code{&} evaluates to @code{false}, there's no point in evaluating
20402 the rest of the arguments. This means that you should put slow matches
20403 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
20404 @samp{subject}) first.
20406 The indirection arguments (@code{1-} and so on) will make their
20407 arguments work on previous generations of the thread. If you say
20418 Then that means ``score on the from header of the grandparent of the
20419 current article''. An indirection is quite fast, but it's better to say:
20425 ("subject" "Gnus")))
20432 (1- ("from" "Lars"))
20433 (1- ("subject" "Gnus")))
20438 @section Score Decays
20439 @cindex score decays
20442 You may find that your scores have a tendency to grow without
20443 bounds, especially if you're using adaptive scoring. If scores get too
20444 big, they lose all meaning---they simply max out and it's difficult to
20445 use them in any sensible way.
20447 @vindex gnus-decay-scores
20448 @findex gnus-decay-score
20449 @vindex gnus-decay-score-function
20450 Gnus provides a mechanism for decaying scores to help with this problem.
20451 When score files are loaded and @code{gnus-decay-scores} is
20452 non-@code{nil}, Gnus will run the score files through the decaying
20453 mechanism thereby lowering the scores of all non-permanent score rules.
20454 The decay itself if performed by the @code{gnus-decay-score-function}
20455 function, which is @code{gnus-decay-score} by default. Here's the
20456 definition of that function:
20459 (defun gnus-decay-score (score)
20460 "Decay SCORE according to `gnus-score-decay-constant'
20461 and `gnus-score-decay-scale'."
20463 (* (if (< score 0) -1 1)
20465 (max gnus-score-decay-constant
20467 gnus-score-decay-scale)))))))
20468 (if (and (featurep 'xemacs)
20469 ;; XEmacs' floor can handle only the floating point
20470 ;; number below the half of the maximum integer.
20471 (> (abs n) (lsh -1 -2)))
20473 (car (split-string (number-to-string n) "\\.")))
20477 @vindex gnus-score-decay-scale
20478 @vindex gnus-score-decay-constant
20479 @code{gnus-score-decay-constant} is 3 by default and
20480 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
20484 Scores between -3 and 3 will be set to 0 when this function is called.
20487 Scores with magnitudes between 3 and 60 will be shrunk by 3.
20490 Scores with magnitudes greater than 60 will be shrunk by 5% of the
20494 If you don't like this decay function, write your own. It is called
20495 with the score to be decayed as its only parameter, and it should return
20496 the new score, which should be an integer.
20498 Gnus will try to decay scores once a day. If you haven't run Gnus for
20499 four days, Gnus will decay the scores four times, for instance.
20504 @include message.texi
20505 @chapter Emacs MIME
20506 @include emacs-mime.texi
20508 @include sieve.texi
20510 @c @include pgg.texi
20512 @c @include sasl.texi
20520 * Process/Prefix:: A convention used by many treatment commands.
20521 * Interactive:: Making Gnus ask you many questions.
20522 * Symbolic Prefixes:: How to supply some Gnus functions with options.
20523 * Formatting Variables:: You can specify what buffers should look like.
20524 * Window Layout:: Configuring the Gnus buffer windows.
20525 * Faces and Fonts:: How to change how faces look.
20526 * Compilation:: How to speed Gnus up.
20527 * Mode Lines:: Displaying information in the mode lines.
20528 * Highlighting and Menus:: Making buffers look all nice and cozy.
20529 * Buttons:: Get tendinitis in ten easy steps!
20530 * Daemons:: Gnus can do things behind your back.
20531 * NoCeM:: How to avoid spam and other fatty foods.
20532 * Undo:: Some actions can be undone.
20533 * Predicate Specifiers:: Specifying predicates.
20534 * Moderation:: What to do if you're a moderator.
20535 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
20536 * Fuzzy Matching:: What's the big fuzz?
20537 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
20538 * Other modes:: Interaction with other modes.
20539 * Various Various:: Things that are really various.
20543 @node Process/Prefix
20544 @section Process/Prefix
20545 @cindex process/prefix convention
20547 Many functions, among them functions for moving, decoding and saving
20548 articles, use what is known as the @dfn{Process/Prefix convention}.
20550 This is a method for figuring out what articles the user wants the
20551 command to be performed on.
20555 If the numeric prefix is N, perform the operation on the next N
20556 articles, starting with the current one. If the numeric prefix is
20557 negative, perform the operation on the previous N articles, starting
20558 with the current one.
20560 @vindex transient-mark-mode
20561 If @code{transient-mark-mode} in non-@code{nil} and the region is
20562 active, all articles in the region will be worked upon.
20564 If there is no numeric prefix, but some articles are marked with the
20565 process mark, perform the operation on the articles marked with
20568 If there is neither a numeric prefix nor any articles marked with the
20569 process mark, just perform the operation on the current article.
20571 Quite simple, really, but it needs to be made clear so that surprises
20574 Commands that react to the process mark will push the current list of
20575 process marked articles onto a stack and will then clear all process
20576 marked articles. You can restore the previous configuration with the
20577 @kbd{M P y} command (@pxref{Setting Process Marks}).
20579 @vindex gnus-summary-goto-unread
20580 One thing that seems to shock & horrify lots of people is that, for
20581 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
20582 Since each @kbd{d} (which marks the current article as read) by default
20583 goes to the next unread article after marking, this means that @kbd{3 d}
20584 will mark the next three unread articles as read, no matter what the
20585 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
20586 @code{nil} for a more straightforward action.
20588 Many commands do not use the process/prefix convention. All commands
20589 that do explicitly say so in this manual. To apply the process/prefix
20590 convention to commands that do not use it, you can use the @kbd{M-&}
20591 command. For instance, to mark all the articles in the group as
20592 expirable, you could say @kbd{M P b M-& E}.
20596 @section Interactive
20597 @cindex interaction
20601 @item gnus-novice-user
20602 @vindex gnus-novice-user
20603 If this variable is non-@code{nil}, you are either a newcomer to the
20604 World of Usenet, or you are very cautious, which is a nice thing to be,
20605 really. You will be given questions of the type ``Are you sure you want
20606 to do this?'' before doing anything dangerous. This is @code{t} by
20609 @item gnus-expert-user
20610 @vindex gnus-expert-user
20611 If this variable is non-@code{nil}, you will seldom be asked any
20612 questions by Gnus. It will simply assume you know what you're doing, no
20613 matter how strange.
20615 @item gnus-interactive-catchup
20616 @vindex gnus-interactive-catchup
20617 Require confirmation before catching up a group if non-@code{nil}. It
20618 is @code{t} by default.
20620 @item gnus-interactive-exit
20621 @vindex gnus-interactive-exit
20622 Require confirmation before exiting Gnus. This variable is @code{t} by
20627 @node Symbolic Prefixes
20628 @section Symbolic Prefixes
20629 @cindex symbolic prefixes
20631 Quite a lot of Emacs commands react to the (numeric) prefix. For
20632 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
20633 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
20634 rule of 900 to the current article.
20636 This is all nice and well, but what if you want to give a command some
20637 additional information? Well, what most commands do is interpret the
20638 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
20639 doesn't want a backup file to be created when saving the current buffer,
20640 for instance. But what if you want to save without making a backup
20641 file, and you want Emacs to flash lights and play a nice tune at the
20642 same time? You can't, and you're probably perfectly happy that way.
20644 @kindex M-i (Summary)
20645 @findex gnus-symbolic-argument
20646 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
20647 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
20648 character typed in is the value. You can stack as many @kbd{M-i}
20649 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
20650 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
20651 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
20652 @code{b}''. You get the drift.
20654 Typing in symbolic prefixes to commands that don't accept them doesn't
20655 hurt, but it doesn't do any good either. Currently not many Gnus
20656 functions make use of the symbolic prefix.
20658 If you're interested in how Gnus implements this, @pxref{Extended
20662 @node Formatting Variables
20663 @section Formatting Variables
20664 @cindex formatting variables
20666 Throughout this manual you've probably noticed lots of variables called
20667 things like @code{gnus-group-line-format} and
20668 @code{gnus-summary-mode-line-format}. These control how Gnus is to
20669 output lines in the various buffers. There's quite a lot of them.
20670 Fortunately, they all use the same syntax, so there's not that much to
20673 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
20674 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
20675 lots of percentages everywhere.
20678 * Formatting Basics:: A formatting variable is basically a format string.
20679 * Mode Line Formatting:: Some rules about mode line formatting variables.
20680 * Advanced Formatting:: Modifying output in various ways.
20681 * User-Defined Specs:: Having Gnus call your own functions.
20682 * Formatting Fonts:: Making the formatting look colorful and nice.
20683 * Positioning Point:: Moving point to a position after an operation.
20684 * Tabulation:: Tabulating your output.
20685 * Wide Characters:: Dealing with wide characters.
20688 Currently Gnus uses the following formatting variables:
20689 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
20690 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
20691 @code{gnus-group-mode-line-format},
20692 @code{gnus-summary-mode-line-format},
20693 @code{gnus-article-mode-line-format},
20694 @code{gnus-server-mode-line-format}, and
20695 @code{gnus-summary-pick-line-format}.
20697 All these format variables can also be arbitrary elisp forms. In that
20698 case, they will be @code{eval}ed to insert the required lines.
20700 @kindex M-x gnus-update-format
20701 @findex gnus-update-format
20702 Gnus includes a command to help you while creating your own format
20703 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
20704 update the spec in question and pop you to a buffer where you can
20705 examine the resulting Lisp code to be run to generate the line.
20709 @node Formatting Basics
20710 @subsection Formatting Basics
20712 Each @samp{%} element will be replaced by some string or other when the
20713 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
20714 spec, and pad with spaces to get a 5-character field''.
20716 As with normal C and Emacs Lisp formatting strings, the numerical
20717 modifier between the @samp{%} and the formatting type character will
20718 @dfn{pad} the output so that it is always at least that long.
20719 @samp{%5y} will make the field always (at least) five characters wide by
20720 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
20723 You may also wish to limit the length of the field to protect against
20724 particularly wide values. For that you can say @samp{%4,6y}, which
20725 means that the field will never be more than 6 characters wide and never
20726 less than 4 characters wide.
20728 Also Gnus supports some extended format specifications, such as
20729 @samp{%&user-date;}.
20732 @node Mode Line Formatting
20733 @subsection Mode Line Formatting
20735 Mode line formatting variables (e.g.,
20736 @code{gnus-summary-mode-line-format}) follow the same rules as other,
20737 buffer line oriented formatting variables (@pxref{Formatting Basics})
20738 with the following two differences:
20743 There must be no newline (@samp{\n}) at the end.
20746 The special @samp{%%b} spec can be used to display the buffer name.
20747 Well, it's no spec at all, really---@samp{%%} is just a way to quote
20748 @samp{%} to allow it to pass through the formatting machinery unmangled,
20749 so that Emacs receives @samp{%b}, which is something the Emacs mode line
20750 display interprets to mean ``show the buffer name''. For a full list of
20751 mode line specs Emacs understands, see the documentation of the
20752 @code{mode-line-format} variable.
20757 @node Advanced Formatting
20758 @subsection Advanced Formatting
20760 It is frequently useful to post-process the fields in some way.
20761 Padding, limiting, cutting off parts and suppressing certain values can
20762 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
20763 look like @samp{%~(cut 3)~(ignore "0")y}.
20765 These are the valid modifiers:
20770 Pad the field to the left with spaces until it reaches the required
20774 Pad the field to the right with spaces until it reaches the required
20779 Cut off characters from the left until it reaches the specified length.
20782 Cut off characters from the right until it reaches the specified
20787 Cut off the specified number of characters from the left.
20790 Cut off the specified number of characters from the right.
20793 Return an empty string if the field is equal to the specified value.
20796 Use the specified form as the field value when the @samp{@@} spec is
20802 "~(form (current-time-string))@@"
20807 Let's take an example. The @samp{%o} spec in the summary mode lines
20808 will return a date in compact ISO8601 format---@samp{19960809T230410}.
20809 This is quite a mouthful, so we want to shave off the century number and
20810 the time, leaving us with a six-character date. That would be
20811 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
20812 maxing, and we need the padding to ensure that the date is never less
20813 than 6 characters to make it look nice in columns.)
20815 Ignoring is done first; then cutting; then maxing; and then as the very
20816 last operation, padding.
20818 @vindex gnus-compile-user-specs
20819 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
20820 default) with your strong personality, and use a lots of these advanced
20821 thingies, you'll find that Gnus gets quite slow. This can be helped
20822 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
20823 the look of your lines.
20824 @xref{Compilation}.
20827 @node User-Defined Specs
20828 @subsection User-Defined Specs
20830 All the specs allow for inserting user defined specifiers---@samp{u}.
20831 The next character in the format string should be a letter. Gnus
20832 will call the function @code{gnus-user-format-function-}@samp{X}, where
20833 @samp{X} is the letter following @samp{%u}. The function will be passed
20834 a single parameter---what the parameter means depends on what buffer
20835 it's being called from. The function should return a string, which will
20836 be inserted into the buffer just like information from any other
20837 specifier. This function may also be called with dummy values, so it
20838 should protect against that.
20840 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
20841 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
20843 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
20844 much the same without defining new functions. Here's an example:
20845 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
20846 given here will be evaluated to yield the current line number, and then
20850 @node Formatting Fonts
20851 @subsection Formatting Fonts
20853 There are specs for highlighting, and these are shared by all the format
20854 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
20855 the special @code{mouse-face} property set, which means that it will be
20856 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
20859 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
20860 normal faces set using @code{gnus-face-0}, which is @code{bold} by
20861 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
20862 and so on. Create as many faces as you wish. The same goes for the
20863 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
20864 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
20866 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
20867 special @code{balloon-help} property set to
20868 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
20869 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
20870 variables should be either strings or symbols naming functions that
20871 return a string. When the mouse passes over text with this property
20872 set, a balloon window will appear and display the string. Please
20873 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
20874 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
20875 XEmacs) for more information on this. (For technical reasons, the
20876 guillemets have been approximated as @samp{<<} and @samp{>>} in this
20879 Here's an alternative recipe for the group buffer:
20882 ;; @r{Create three face types.}
20883 (setq gnus-face-1 'bold)
20884 (setq gnus-face-3 'italic)
20886 ;; @r{We want the article count to be in}
20887 ;; @r{a bold and green face. So we create}
20888 ;; @r{a new face called @code{my-green-bold}.}
20889 (copy-face 'bold 'my-green-bold)
20890 ;; @r{Set the color.}
20891 (set-face-foreground 'my-green-bold "ForestGreen")
20892 (setq gnus-face-2 'my-green-bold)
20894 ;; @r{Set the new & fancy format.}
20895 (setq gnus-group-line-format
20896 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
20899 I'm sure you'll be able to use this scheme to create totally unreadable
20900 and extremely vulgar displays. Have fun!
20902 Note that the @samp{%(} specs (and friends) do not make any sense on the
20903 mode-line variables.
20905 @node Positioning Point
20906 @subsection Positioning Point
20908 Gnus usually moves point to a pre-defined place on each line in most
20909 buffers. By default, point move to the first colon character on the
20910 line. You can customize this behaviour in three different ways.
20912 You can move the colon character to somewhere else on the line.
20914 @findex gnus-goto-colon
20915 You can redefine the function that moves the point to the colon. The
20916 function is called @code{gnus-goto-colon}.
20918 But perhaps the most convenient way to deal with this, if you don't want
20919 to have a colon in your line, is to use the @samp{%*} specifier. If you
20920 put a @samp{%*} somewhere in your format line definition, Gnus will
20925 @subsection Tabulation
20927 You can usually line up your displays by padding and cutting your
20928 strings. However, when combining various strings of different size, it
20929 can often be more convenient to just output the strings, and then worry
20930 about lining up the following text afterwards.
20932 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
20933 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
20935 @samp{%50=} will insert space characters to pad the line up to column
20936 50. If the text is already past column 50, nothing will be inserted.
20937 This is the soft tabulator.
20939 @samp{%-50=} will insert space characters to pad the line up to column
20940 50. If the text is already past column 50, the excess text past column
20941 50 will be removed. This is the hard tabulator.
20944 @node Wide Characters
20945 @subsection Wide Characters
20947 Fixed width fonts in most countries have characters of the same width.
20948 Some countries, however, use Latin characters mixed with wider
20949 characters---most notable East Asian countries.
20951 The problem is that when formatting, Gnus assumes that if a string is 10
20952 characters wide, it'll be 10 Latin characters wide on the screen. In
20953 these countries, that's not true.
20955 @vindex gnus-use-correct-string-widths
20956 To help fix this, you can set @code{gnus-use-correct-string-widths} to
20957 @code{t}. This makes buffer generation slower, but the results will be
20958 prettier. The default value under XEmacs is @code{t} but @code{nil}
20962 @node Window Layout
20963 @section Window Layout
20964 @cindex window layout
20966 No, there's nothing here about X, so be quiet.
20968 @vindex gnus-use-full-window
20969 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
20970 other windows and occupy the entire Emacs screen by itself. It is
20971 @code{t} by default.
20973 Setting this variable to @code{nil} kinda works, but there are
20974 glitches. Use at your own peril.
20976 @vindex gnus-buffer-configuration
20977 @code{gnus-buffer-configuration} describes how much space each Gnus
20978 buffer should be given. Here's an excerpt of this variable:
20981 ((group (vertical 1.0 (group 1.0 point)
20982 (if gnus-carpal (group-carpal 4))))
20983 (article (vertical 1.0 (summary 0.25 point)
20987 This is an alist. The @dfn{key} is a symbol that names some action or
20988 other. For instance, when displaying the group buffer, the window
20989 configuration function will use @code{group} as the key. A full list of
20990 possible names is listed below.
20992 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
20993 should occupy. To take the @code{article} split as an example -
20996 (article (vertical 1.0 (summary 0.25 point)
21000 This @dfn{split} says that the summary buffer should occupy 25% of upper
21001 half of the screen, and that it is placed over the article buffer. As
21002 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
21003 reaching for that calculator there). However, the special number
21004 @code{1.0} is used to signal that this buffer should soak up all the
21005 rest of the space available after the rest of the buffers have taken
21006 whatever they need. There should be only one buffer with the @code{1.0}
21007 size spec per split.
21009 Point will be put in the buffer that has the optional third element
21010 @code{point}. In a @code{frame} split, the last subsplit having a leaf
21011 split where the tag @code{frame-focus} is a member (i.e. is the third or
21012 fourth element in the list, depending on whether the @code{point} tag is
21013 present) gets focus.
21015 Here's a more complicated example:
21018 (article (vertical 1.0 (group 4)
21019 (summary 0.25 point)
21020 (if gnus-carpal (summary-carpal 4))
21024 If the size spec is an integer instead of a floating point number,
21025 then that number will be used to say how many lines a buffer should
21026 occupy, not a percentage.
21028 If the @dfn{split} looks like something that can be @code{eval}ed (to be
21029 precise---if the @code{car} of the split is a function or a subr), this
21030 split will be @code{eval}ed. If the result is non-@code{nil}, it will
21031 be used as a split. This means that there will be three buffers if
21032 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
21035 Not complicated enough for you? Well, try this on for size:
21038 (article (horizontal 1.0
21043 (summary 0.25 point)
21048 Whoops. Two buffers with the mystery 100% tag. And what's that
21049 @code{horizontal} thingie?
21051 If the first element in one of the split is @code{horizontal}, Gnus will
21052 split the window horizontally, giving you two windows side-by-side.
21053 Inside each of these strips you may carry on all you like in the normal
21054 fashion. The number following @code{horizontal} says what percentage of
21055 the screen is to be given to this strip.
21057 For each split, there @emph{must} be one element that has the 100% tag.
21058 The splitting is never accurate, and this buffer will eat any leftover
21059 lines from the splits.
21061 To be slightly more formal, here's a definition of what a valid split
21066 split = frame | horizontal | vertical | buffer | form
21067 frame = "(frame " size *split ")"
21068 horizontal = "(horizontal " size *split ")"
21069 vertical = "(vertical " size *split ")"
21070 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
21071 size = number | frame-params
21072 buf-name = group | article | summary ...
21076 The limitations are that the @code{frame} split can only appear as the
21077 top-level split. @var{form} should be an Emacs Lisp form that should
21078 return a valid split. We see that each split is fully recursive, and
21079 may contain any number of @code{vertical} and @code{horizontal} splits.
21081 @vindex gnus-window-min-width
21082 @vindex gnus-window-min-height
21083 @cindex window height
21084 @cindex window width
21085 Finding the right sizes can be a bit complicated. No window may be less
21086 than @code{gnus-window-min-height} (default 1) characters high, and all
21087 windows must be at least @code{gnus-window-min-width} (default 1)
21088 characters wide. Gnus will try to enforce this before applying the
21089 splits. If you want to use the normal Emacs window width/height limit,
21090 you can just set these two variables to @code{nil}.
21092 If you're not familiar with Emacs terminology, @code{horizontal} and
21093 @code{vertical} splits may work the opposite way of what you'd expect.
21094 Windows inside a @code{horizontal} split are shown side-by-side, and
21095 windows within a @code{vertical} split are shown above each other.
21097 @findex gnus-configure-frame
21098 If you want to experiment with window placement, a good tip is to call
21099 @code{gnus-configure-frame} directly with a split. This is the function
21100 that does all the real work when splitting buffers. Below is a pretty
21101 nonsensical configuration with 5 windows; two for the group buffer and
21102 three for the article buffer. (I said it was nonsensical.) If you
21103 @code{eval} the statement below, you can get an idea of how that would
21104 look straight away, without going through the normal Gnus channels.
21105 Play with it until you're satisfied, and then use
21106 @code{gnus-add-configuration} to add your new creation to the buffer
21107 configuration list.
21110 (gnus-configure-frame
21114 (article 0.3 point))
21122 You might want to have several frames as well. No prob---just use the
21123 @code{frame} split:
21126 (gnus-configure-frame
21129 (summary 0.25 point frame-focus)
21131 (vertical ((height . 5) (width . 15)
21132 (user-position . t)
21133 (left . -1) (top . 1))
21138 This split will result in the familiar summary/article window
21139 configuration in the first (or ``main'') frame, while a small additional
21140 frame will be created where picons will be shown. As you can see,
21141 instead of the normal @code{1.0} top-level spec, each additional split
21142 should have a frame parameter alist as the size spec.
21143 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
21144 Reference Manual}. Under XEmacs, a frame property list will be
21145 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
21147 The list of all possible keys for @code{gnus-buffer-configuration} can
21148 be found in its default value.
21150 Note that the @code{message} key is used for both
21151 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
21152 it is desirable to distinguish between the two, something like this
21156 (message (horizontal 1.0
21157 (vertical 1.0 (message 1.0 point))
21159 (if (buffer-live-p gnus-summary-buffer)
21164 One common desire for a multiple frame split is to have a separate frame
21165 for composing mail and news while leaving the original frame intact. To
21166 accomplish that, something like the following can be done:
21171 (if (not (buffer-live-p gnus-summary-buffer))
21172 (car (cdr (assoc 'group gnus-buffer-configuration)))
21173 (car (cdr (assoc 'summary gnus-buffer-configuration))))
21174 (vertical ((user-position . t) (top . 1) (left . 1)
21175 (name . "Message"))
21176 (message 1.0 point))))
21179 @findex gnus-add-configuration
21180 Since the @code{gnus-buffer-configuration} variable is so long and
21181 complicated, there's a function you can use to ease changing the config
21182 of a single setting: @code{gnus-add-configuration}. If, for instance,
21183 you want to change the @code{article} setting, you could say:
21186 (gnus-add-configuration
21187 '(article (vertical 1.0
21189 (summary .25 point)
21193 You'd typically stick these @code{gnus-add-configuration} calls in your
21194 @file{~/.gnus.el} file or in some startup hook---they should be run after
21195 Gnus has been loaded.
21197 @vindex gnus-always-force-window-configuration
21198 If all windows mentioned in the configuration are already visible, Gnus
21199 won't change the window configuration. If you always want to force the
21200 ``right'' window configuration, you can set
21201 @code{gnus-always-force-window-configuration} to non-@code{nil}.
21203 If you're using tree displays (@pxref{Tree Display}), and the tree
21204 window is displayed vertically next to another window, you may also want
21205 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
21208 @subsection Example Window Configurations
21212 Narrow left hand side occupied by group buffer. Right hand side split
21213 between summary buffer (top one-sixth) and article buffer (bottom).
21228 (gnus-add-configuration
21231 (vertical 25 (group 1.0))
21233 (summary 0.16 point)
21236 (gnus-add-configuration
21239 (vertical 25 (group 1.0))
21240 (vertical 1.0 (summary 1.0 point)))))
21246 @node Faces and Fonts
21247 @section Faces and Fonts
21252 Fiddling with fonts and faces used to be very difficult, but these days
21253 it is very simple. You simply say @kbd{M-x customize-face}, pick out
21254 the face you want to alter, and alter it via the standard Customize
21259 @section Compilation
21260 @cindex compilation
21261 @cindex byte-compilation
21263 @findex gnus-compile
21265 Remember all those line format specification variables?
21266 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
21267 on. By default, T-gnus will use the byte-compiled codes of these
21268 variables and we can keep a slow-down to a minimum. However, if you set
21269 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
21270 unfortunately, changing them will mean a quite significant slow-down.
21271 (The default values of these variables have byte-compiled functions
21272 associated with them, while the user-generated versions do not, of
21275 To help with this, you can run @kbd{M-x gnus-compile} after you've
21276 fiddled around with the variables and feel that you're (kind of)
21277 satisfied. This will result in the new specs being byte-compiled, and
21278 you'll get top speed again. Note that T-gnus will not save these
21279 compiled specs in the @file{.newsrc.eld} file.
21282 @item gnus-compile-user-specs
21283 @vindex gnus-compile-user-specs
21284 If it is non-nil, the user-defined format specs will be byte-compiled
21285 automatically. The default value of this variable is @code{t}. It has
21286 an effect on the values of @code{gnus-*-line-format-spec}.
21291 @section Mode Lines
21294 @vindex gnus-updated-mode-lines
21295 @code{gnus-updated-mode-lines} says what buffers should keep their mode
21296 lines updated. It is a list of symbols. Supported symbols include
21297 @code{group}, @code{article}, @code{summary}, @code{server},
21298 @code{browse}, and @code{tree}. If the corresponding symbol is present,
21299 Gnus will keep that mode line updated with information that may be
21300 pertinent. If this variable is @code{nil}, screen refresh may be
21303 @cindex display-time
21305 @vindex gnus-mode-non-string-length
21306 By default, Gnus displays information on the current article in the mode
21307 lines of the summary and article buffers. The information Gnus wishes
21308 to display (e.g. the subject of the article) is often longer than the
21309 mode lines, and therefore have to be cut off at some point. The
21310 @code{gnus-mode-non-string-length} variable says how long the other
21311 elements on the line is (i.e., the non-info part). If you put
21312 additional elements on the mode line (e.g. a clock), you should modify
21315 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
21317 (add-hook 'display-time-hook
21318 (lambda () (setq gnus-mode-non-string-length
21320 (if line-number-mode 5 0)
21321 (if column-number-mode 4 0)
21322 (length display-time-string)))))
21325 If this variable is @code{nil} (which is the default), the mode line
21326 strings won't be chopped off, and they won't be padded either. Note
21327 that the default is unlikely to be desirable, as even the percentage
21328 complete in the buffer may be crowded off the mode line; the user should
21329 configure this variable appropriately for her configuration.
21332 @node Highlighting and Menus
21333 @section Highlighting and Menus
21335 @cindex highlighting
21338 @vindex gnus-visual
21339 The @code{gnus-visual} variable controls most of the Gnus-prettifying
21340 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
21341 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
21344 This variable can be a list of visual properties that are enabled. The
21345 following elements are valid, and are all included by default:
21348 @item group-highlight
21349 Do highlights in the group buffer.
21350 @item summary-highlight
21351 Do highlights in the summary buffer.
21352 @item article-highlight
21353 Do highlights in the article buffer.
21355 Turn on highlighting in all buffers.
21357 Create menus in the group buffer.
21359 Create menus in the summary buffers.
21361 Create menus in the article buffer.
21363 Create menus in the browse buffer.
21365 Create menus in the server buffer.
21367 Create menus in the score buffers.
21369 Create menus in all buffers.
21372 So if you only want highlighting in the article buffer and menus in all
21373 buffers, you could say something like:
21376 (setq gnus-visual '(article-highlight menu))
21379 If you want highlighting only and no menus whatsoever, you'd say:
21382 (setq gnus-visual '(highlight))
21385 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
21386 in all Gnus buffers.
21388 Other general variables that influence the look of all buffers include:
21391 @item gnus-mouse-face
21392 @vindex gnus-mouse-face
21393 This is the face (i.e., font) used for mouse highlighting in Gnus. No
21394 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
21398 There are hooks associated with the creation of all the different menus:
21402 @item gnus-article-menu-hook
21403 @vindex gnus-article-menu-hook
21404 Hook called after creating the article mode menu.
21406 @item gnus-group-menu-hook
21407 @vindex gnus-group-menu-hook
21408 Hook called after creating the group mode menu.
21410 @item gnus-summary-menu-hook
21411 @vindex gnus-summary-menu-hook
21412 Hook called after creating the summary mode menu.
21414 @item gnus-server-menu-hook
21415 @vindex gnus-server-menu-hook
21416 Hook called after creating the server mode menu.
21418 @item gnus-browse-menu-hook
21419 @vindex gnus-browse-menu-hook
21420 Hook called after creating the browse mode menu.
21422 @item gnus-score-menu-hook
21423 @vindex gnus-score-menu-hook
21424 Hook called after creating the score mode menu.
21435 Those new-fangled @dfn{mouse} contraptions is very popular with the
21436 young, hep kids who don't want to learn the proper way to do things
21437 these days. Why, I remember way back in the summer of '89, when I was
21438 using Emacs on a Tops 20 system. Three hundred users on one single
21439 machine, and every user was running Simula compilers. Bah!
21443 @vindex gnus-carpal
21444 Well, you can make Gnus display bufferfuls of buttons you can click to
21445 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
21446 really. Tell the chiropractor I sent you.
21451 @item gnus-carpal-mode-hook
21452 @vindex gnus-carpal-mode-hook
21453 Hook run in all carpal mode buffers.
21455 @item gnus-carpal-button-face
21456 @vindex gnus-carpal-button-face
21457 Face used on buttons.
21459 @item gnus-carpal-header-face
21460 @vindex gnus-carpal-header-face
21461 Face used on carpal buffer headers.
21463 @item gnus-carpal-group-buffer-buttons
21464 @vindex gnus-carpal-group-buffer-buttons
21465 Buttons in the group buffer.
21467 @item gnus-carpal-summary-buffer-buttons
21468 @vindex gnus-carpal-summary-buffer-buttons
21469 Buttons in the summary buffer.
21471 @item gnus-carpal-server-buffer-buttons
21472 @vindex gnus-carpal-server-buffer-buttons
21473 Buttons in the server buffer.
21475 @item gnus-carpal-browse-buffer-buttons
21476 @vindex gnus-carpal-browse-buffer-buttons
21477 Buttons in the browse buffer.
21480 All the @code{buttons} variables are lists. The elements in these list
21481 are either cons cells where the @code{car} contains a text to be displayed and
21482 the @code{cdr} contains a function symbol, or a simple string.
21490 Gnus, being larger than any program ever written (allegedly), does lots
21491 of strange stuff that you may wish to have done while you're not
21492 present. For instance, you may want it to check for new mail once in a
21493 while. Or you may want it to close down all connections to all servers
21494 when you leave Emacs idle. And stuff like that.
21496 Gnus will let you do stuff like that by defining various
21497 @dfn{handlers}. Each handler consists of three elements: A
21498 @var{function}, a @var{time}, and an @var{idle} parameter.
21500 Here's an example of a handler that closes connections when Emacs has
21501 been idle for thirty minutes:
21504 (gnus-demon-close-connections nil 30)
21507 Here's a handler that scans for @acronym{PGP} headers every hour when
21511 (gnus-demon-scan-pgp 60 t)
21514 This @var{time} parameter and that @var{idle} parameter work together
21515 in a strange, but wonderful fashion. Basically, if @var{idle} is
21516 @code{nil}, then the function will be called every @var{time} minutes.
21518 If @var{idle} is @code{t}, then the function will be called after
21519 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
21520 the function will never be called. But once Emacs goes idle, the
21521 function will be called every @var{time} minutes.
21523 If @var{idle} is a number and @var{time} is a number, the function will
21524 be called every @var{time} minutes only when Emacs has been idle for
21525 @var{idle} minutes.
21527 If @var{idle} is a number and @var{time} is @code{nil}, the function
21528 will be called once every time Emacs has been idle for @var{idle}
21531 And if @var{time} is a string, it should look like @samp{07:31}, and
21532 the function will then be called once every day somewhere near that
21533 time. Modified by the @var{idle} parameter, of course.
21535 @vindex gnus-demon-timestep
21536 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
21537 seconds. This is 60 by default. If you change that variable,
21538 all the timings in the handlers will be affected.)
21540 So, if you want to add a handler, you could put something like this in
21541 your @file{~/.gnus.el} file:
21543 @findex gnus-demon-add-handler
21545 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
21548 @findex gnus-demon-add-nocem
21549 @findex gnus-demon-add-scanmail
21550 @findex gnus-demon-add-rescan
21551 @findex gnus-demon-add-scan-timestamps
21552 @findex gnus-demon-add-disconnection
21553 Some ready-made functions to do this have been created:
21554 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
21555 @code{gnus-demon-add-nntp-close-connection},
21556 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
21557 @code{gnus-demon-add-scanmail}. Just put those functions in your
21558 @file{~/.gnus.el} if you want those abilities.
21560 @findex gnus-demon-init
21561 @findex gnus-demon-cancel
21562 @vindex gnus-demon-handlers
21563 If you add handlers to @code{gnus-demon-handlers} directly, you should
21564 run @code{gnus-demon-init} to make the changes take hold. To cancel all
21565 daemons, you can use the @code{gnus-demon-cancel} function.
21567 Note that adding daemons can be pretty naughty if you over do it. Adding
21568 functions that scan all news and mail from all servers every two seconds
21569 is a sure-fire way of getting booted off any respectable system. So
21578 @dfn{Spamming} is posting the same article lots and lots of times.
21579 Spamming is bad. Spamming is evil.
21581 Spamming is usually canceled within a day or so by various anti-spamming
21582 agencies. These agencies usually also send out @dfn{NoCeM} messages.
21583 NoCeM is pronounced ``no see-'em'', and means what the name
21584 implies---these are messages that make the offending articles, like, go
21587 What use are these NoCeM messages if the articles are canceled anyway?
21588 Some sites do not honor cancel messages and some sites just honor cancels
21589 from a select few people. Then you may wish to make use of the NoCeM
21590 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
21592 Gnus can read and parse the messages in this group automatically, and
21593 this will make spam disappear.
21595 There are some variables to customize, of course:
21598 @item gnus-use-nocem
21599 @vindex gnus-use-nocem
21600 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
21603 @item gnus-nocem-groups
21604 @vindex gnus-nocem-groups
21605 Gnus will look for NoCeM messages in the groups in this list. The
21608 ("news.lists.filters" "news.admin.net-abuse.bulletins"
21609 "alt.nocem.misc" "news.admin.net-abuse.announce")
21612 @item gnus-nocem-issuers
21613 @vindex gnus-nocem-issuers
21614 There are many people issuing NoCeM messages. This list says what
21615 people you want to listen to. The default is
21617 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
21618 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
21620 fine, upstanding citizens all of them.
21622 Known despammers that you can put in this list are listed at@*
21623 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
21625 You do not have to heed NoCeM messages from all these people---just the
21626 ones you want to listen to. You also don't have to accept all NoCeM
21627 messages from the people you like. Each NoCeM message has a @dfn{type}
21628 header that gives the message a (more or less, usually less) rigorous
21629 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
21630 @samp{binary}, and @samp{troll}. To specify this, you have to use
21631 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
21632 Each condition is either a string (which is a regexp that matches types
21633 you want to use) or a list on the form @code{(not @var{string})}, where
21634 @var{string} is a regexp that matches types you don't want to use.
21636 For instance, if you want all NoCeM messages from Chris Lewis except his
21637 @samp{troll} messages, you'd say:
21640 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
21643 On the other hand, if you just want nothing but his @samp{spam} and
21644 @samp{spew} messages, you'd say:
21647 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
21650 The specs are applied left-to-right.
21653 @item gnus-nocem-verifyer
21654 @vindex gnus-nocem-verifyer
21656 This should be a function for verifying that the NoCeM issuer is who she
21657 says she is. The default is @code{mc-verify}, which is a Mailcrypt
21658 function. If this is too slow and you don't care for verification
21659 (which may be dangerous), you can set this variable to @code{nil}.
21661 If you want signed NoCeM messages to be verified and unsigned messages
21662 not to be verified (but used anyway), you could do something like:
21665 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
21667 (defun my-gnus-mc-verify ()
21675 This might be dangerous, though.
21677 @item gnus-nocem-directory
21678 @vindex gnus-nocem-directory
21679 This is where Gnus will store its NoCeM cache files. The default is@*
21680 @file{~/News/NoCeM/}.
21682 @item gnus-nocem-expiry-wait
21683 @vindex gnus-nocem-expiry-wait
21684 The number of days before removing old NoCeM entries from the cache.
21685 The default is 15. If you make it shorter Gnus will be faster, but you
21686 might then see old spam.
21688 @item gnus-nocem-check-from
21689 @vindex gnus-nocem-check-from
21690 Non-@code{nil} means check for valid issuers in message bodies.
21691 Otherwise don't bother fetching articles unless their author matches a
21692 valid issuer; that is much faster if you are selective about the
21695 @item gnus-nocem-check-article-limit
21696 @vindex gnus-nocem-check-article-limit
21697 If non-@code{nil}, the maximum number of articles to check in any NoCeM
21698 group. NoCeM groups can be huge and very slow to process.
21702 Using NoCeM could potentially be a memory hog. If you have many living
21703 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
21704 big. If this is a problem, you should kill off all (or most) of your
21705 unsubscribed groups (@pxref{Subscription Commands}).
21712 It is very useful to be able to undo actions one has done. In normal
21713 Emacs buffers, it's easy enough---you just push the @code{undo} button.
21714 In Gnus buffers, however, it isn't that simple.
21716 The things Gnus displays in its buffer is of no value whatsoever to
21717 Gnus---it's all just data designed to look nice to the user.
21718 Killing a group in the group buffer with @kbd{C-k} makes the line
21719 disappear, but that's just a side-effect of the real action---the
21720 removal of the group in question from the internal Gnus structures.
21721 Undoing something like that can't be done by the normal Emacs
21722 @code{undo} function.
21724 Gnus tries to remedy this somewhat by keeping track of what the user
21725 does and coming up with actions that would reverse the actions the user
21726 takes. When the user then presses the @code{undo} key, Gnus will run
21727 the code to reverse the previous action, or the previous actions.
21728 However, not all actions are easily reversible, so Gnus currently offers
21729 a few key functions to be undoable. These include killing groups,
21730 yanking groups, and changing the list of read articles of groups.
21731 That's it, really. More functions may be added in the future, but each
21732 added function means an increase in data to be stored, so Gnus will
21733 never be totally undoable.
21735 @findex gnus-undo-mode
21736 @vindex gnus-use-undo
21738 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
21739 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
21740 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
21741 command, which should feel kinda like the normal Emacs @code{undo}
21745 @node Predicate Specifiers
21746 @section Predicate Specifiers
21747 @cindex predicate specifiers
21749 Some Gnus variables are @dfn{predicate specifiers}. This is a special
21750 form that allows flexible specification of predicates without having
21751 to type all that much.
21753 These specifiers are lists consisting of functions, symbols and lists.
21758 (or gnus-article-unseen-p
21759 gnus-article-unread-p)
21762 The available symbols are @code{or}, @code{and} and @code{not}. The
21763 functions all take one parameter.
21765 @findex gnus-make-predicate
21766 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
21767 to create a function that can be called. This input parameter to this
21768 function will be passed along to all the functions in the predicate
21773 @section Moderation
21776 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
21777 It is not included in the standard Gnus package. Write a mail to
21778 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
21781 The moderation package is implemented as a minor mode for summary
21785 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
21788 in your @file{~/.gnus.el} file.
21790 If you are the moderator of @samp{rec.zoofle}, this is how it's
21795 You split your incoming mail by matching on
21796 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
21797 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
21800 You enter that group once in a while and post articles using the @kbd{e}
21801 (edit-and-post) or @kbd{s} (just send unedited) commands.
21804 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
21805 articles that weren't approved by you, you can cancel them with the
21809 To use moderation mode in these two groups, say:
21812 (setq gnus-moderated-list
21813 "^nnml:rec.zoofle$\\|^rec.zoofle$")
21817 @node Image Enhancements
21818 @section Image Enhancements
21820 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
21821 support images yet.}, is able to display pictures and stuff, so Gnus has
21822 taken advantage of that.
21825 * X-Face:: Display a funky, teensy black-and-white image.
21826 * Face:: Display a funkier, teensier colored image.
21827 * Smileys:: Show all those happy faces the way they were meant to be shown.
21828 * Picons:: How to display pictures of what you're reading.
21829 * XVarious:: Other XEmacsy Gnusey variables.
21837 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
21838 depth) image that's supposed to represent the author of the message.
21839 It seems to be supported by an ever-growing number of mail and news
21843 @findex gnus-article-display-x-face
21844 @vindex gnus-article-x-face-command
21845 @vindex gnus-article-x-face-too-ugly
21853 Decoding an @code{X-Face} header either requires an Emacs that has
21854 @samp{compface} support (which most XEmacs versions has), or that you
21855 have @samp{compface} installed on your system. If either is true,
21856 Gnus will default to displaying @code{X-Face} headers.
21858 The variable that controls this is the
21859 @code{gnus-article-x-face-command} variable. If this variable is a
21860 string, this string will be executed in a sub-shell. If it is a
21861 function, this function will be called with the face as the argument.
21862 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
21863 the @code{From} header, the face will not be shown.
21865 The default action under Emacs 20 is to fork off the @code{display}
21866 program@footnote{@code{display} is from the ImageMagick package. For
21867 the @code{uncompface} and @code{icontopbm} programs look for a package
21868 like @code{compface} or @code{faces-xface} on a GNU/Linux system.} to
21871 Under XEmacs or Emacs 21+ with suitable image support, the default
21872 action is to display the face before the @code{From} header. (It's
21873 nicer if XEmacs has been compiled with @code{X-Face} support---that
21874 will make display somewhat faster. If there's no native @code{X-Face}
21875 support, Gnus will try to convert the @code{X-Face} header using
21876 external programs from the @code{pbmplus} package and
21877 friends.@footnote{On a GNU/Linux system look for packages with names
21878 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
21880 (Note: @code{x-face} is used in the variable/function names, not
21888 @vindex gnus-x-face
21889 Face to show X-Face. The colors from this face are used as the
21890 foreground and background colors of the displayed X-Faces. The
21891 default colors are black and white.
21893 @item gnus-face-properties-alist
21894 @vindex gnus-face-properties-alist
21895 Alist of image types and properties applied to Face (@pxref{Face}) and
21896 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
21897 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
21898 XEmacs. Here are examples:
21901 ;; Specify the altitude of Face and X-Face images in the From header.
21902 (setq gnus-face-properties-alist
21903 '((pbm . (:face gnus-x-face :ascent 80))
21904 (png . (:ascent 80))))
21906 ;; Show Face and X-Face images as pressed buttons.
21907 (setq gnus-face-properties-alist
21908 '((pbm . (:face gnus-x-face :relief -2))
21909 (png . (:relief -2))))
21912 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
21913 Reference Manual} for the valid properties for various image types.
21914 Currently, @code{pbm} is used for X-Face images and @code{png} is used
21915 for Face images in Emacs. Only the @code{:face} property is effective
21916 on the @code{xface} image type in XEmacs if it is built with the
21917 @samp{libcompface} library.
21920 Gnus provides a few convenience functions and variables to allow
21921 easier insertion of X-Face headers in outgoing messages.
21923 @findex gnus-random-x-face
21924 @vindex gnus-convert-pbm-to-x-face-command
21925 @vindex gnus-x-face-directory
21926 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
21927 @code{gnus-x-face-directory} and picks one at random, and then
21928 converts it to the X-Face format by using the
21929 @code{gnus-convert-pbm-to-x-face-command} shell command. The
21930 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
21931 header data as a string.
21933 @findex gnus-insert-random-x-face-header
21934 @code{gnus-insert-random-x-face-header} calls
21935 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
21936 randomly generated data.
21938 @findex gnus-x-face-from-file
21939 @vindex gnus-convert-image-to-x-face-command
21940 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
21941 converts the file to X-Face format by using the
21942 @code{gnus-convert-image-to-x-face-command} shell command.
21944 Here's how you would typically use the first function. Put something
21945 like the following in your @file{~/.gnus.el} file:
21948 (setq message-required-news-headers
21949 (nconc message-required-news-headers
21950 (list '(X-Face . gnus-random-x-face))))
21953 Using the last function would be something like this:
21956 (setq message-required-news-headers
21957 (nconc message-required-news-headers
21958 (list '(X-Face . (lambda ()
21959 (gnus-x-face-from-file
21960 "~/My-face.gif"))))))
21968 @c #### FIXME: faces and x-faces'implementations should really be harmonized.
21970 @code{Face} headers are essentially a funkier version of @code{X-Face}
21971 ones. They describe a 48x48 pixel colored image that's supposed to
21972 represent the author of the message.
21975 @findex gnus-article-display-face
21976 The contents of a @code{Face} header must be a base64 encoded PNG image.
21977 See @uref{http://quimby.gnus.org/circus/face/} for the precise
21980 The @code{gnus-face-properties-alist} variable affects the appearance of
21981 displayed Face images. @xref{X-Face}.
21983 Gnus provides a few convenience functions and variables to allow
21984 easier insertion of Face headers in outgoing messages.
21986 @findex gnus-convert-png-to-face
21987 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
21988 726 bytes long, and converts it to a face.
21990 @findex gnus-face-from-file
21991 @vindex gnus-convert-image-to-face-command
21992 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
21993 converts the file to Face format by using the
21994 @code{gnus-convert-image-to-face-command} shell command.
21996 Here's how you would typically use this function. Put something like the
21997 following in your @file{~/.gnus.el} file:
22000 (setq message-required-news-headers
22001 (nconc message-required-news-headers
22002 (list '(Face . (lambda ()
22003 (gnus-face-from-file "~/face.jpg"))))))
22008 @subsection Smileys
22013 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
22018 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
22019 currently the only package that uses Smiley, it is documented here.
22021 In short---to use Smiley in Gnus, put the following in your
22022 @file{~/.gnus.el} file:
22025 (setq gnus-treat-display-smileys t)
22028 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
22029 the like---to pictures and displays those instead of the text smiley
22030 faces. The conversion is controlled by a list of regexps that matches
22031 text and maps that to file names.
22033 @vindex smiley-regexp-alist
22034 The alist used is specified by the @code{smiley-regexp-alist}
22035 variable. The first item in each element is the regexp to be matched;
22036 the second element is the regexp match group that is to be replaced by
22037 the picture; and the third element is the name of the file to be
22040 The following variables customize where Smiley will look for these
22045 @item smiley-data-directory
22046 @vindex smiley-data-directory
22047 Where Smiley will look for smiley faces files.
22049 @item gnus-smiley-file-types
22050 @vindex gnus-smiley-file-types
22051 List of suffixes on smiley file names to try.
22065 So@dots{} You want to slow down your news reader even more! This is a
22066 good way to do so. It's also a great way to impress people staring
22067 over your shoulder as you read news.
22069 What are Picons? To quote directly from the Picons Web site:
22078 @dfn{Picons} is short for ``personal icons''. They're small,
22079 constrained images used to represent users and domains on the net,
22080 organized into databases so that the appropriate image for a given
22081 e-mail address can be found. Besides users and domains, there are picon
22082 databases for Usenet newsgroups and weather forecasts. The picons are
22083 in either monochrome @code{XBM} format or color @code{XPM} and
22084 @code{GIF} formats.
22087 @vindex gnus-picon-databases
22088 For instructions on obtaining and installing the picons databases,
22089 point your Web browser at
22090 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
22092 If you are using Debian GNU/Linux, saying @samp{apt-get install
22093 picons.*} will install the picons where Gnus can find them.
22095 To enable displaying picons, simply make sure that
22096 @code{gnus-picon-databases} points to the directory containing the
22099 The following variables offer control over where things are located.
22103 @item gnus-picon-databases
22104 @vindex gnus-picon-databases
22105 The location of the picons database. This is a list of directories
22106 containing the @file{news}, @file{domains}, @file{users} (and so on)
22107 subdirectories. Defaults to @code{("/usr/lib/picon"
22108 "/usr/local/faces")}.
22110 @item gnus-picon-news-directories
22111 @vindex gnus-picon-news-directories
22112 List of subdirectories to search in @code{gnus-picon-databases} for
22113 newsgroups faces. @code{("news")} is the default.
22115 @item gnus-picon-user-directories
22116 @vindex gnus-picon-user-directories
22117 List of subdirectories to search in @code{gnus-picon-databases} for user
22118 faces. @code{("users" "usenix" "local" "misc")} is the default.
22120 @item gnus-picon-domain-directories
22121 @vindex gnus-picon-domain-directories
22122 List of subdirectories to search in @code{gnus-picon-databases} for
22123 domain name faces. Defaults to @code{("domains")}. Some people may
22124 want to add @samp{"unknown"} to this list.
22126 @item gnus-picon-file-types
22127 @vindex gnus-picon-file-types
22128 Ordered list of suffixes on picon file names to try. Defaults to
22129 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
22135 @subsection Various XEmacs Variables
22138 @item gnus-xmas-glyph-directory
22139 @vindex gnus-xmas-glyph-directory
22140 This is where Gnus will look for pictures. Gnus will normally
22141 auto-detect this directory, but you may set it manually if you have an
22142 unusual directory structure.
22144 @item gnus-xmas-logo-color-alist
22145 @vindex gnus-xmas-logo-color-alist
22146 This is an alist where the key is a type symbol and the values are the
22147 foreground and background color of the splash page glyph.
22149 @item gnus-xmas-logo-color-style
22150 @vindex gnus-xmas-logo-color-style
22151 This is the key used to look up the color in the alist described above.
22152 Valid values include @code{flame}, @code{pine}, @code{moss},
22153 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
22154 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
22156 @item gnus-xmas-modeline-glyph
22157 @vindex gnus-xmas-modeline-glyph
22158 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
22163 @subsubsection Toolbar
22167 @item gnus-use-toolbar
22168 @vindex gnus-use-toolbar
22169 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
22170 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
22171 @code{right-toolbar}, or @code{left-toolbar}.
22173 @item gnus-group-toolbar
22174 @vindex gnus-group-toolbar
22175 The toolbar in the group buffer.
22177 @item gnus-summary-toolbar
22178 @vindex gnus-summary-toolbar
22179 The toolbar in the summary buffer.
22181 @item gnus-summary-mail-toolbar
22182 @vindex gnus-summary-mail-toolbar
22183 The toolbar in the summary buffer of mail groups.
22194 @node Fuzzy Matching
22195 @section Fuzzy Matching
22196 @cindex fuzzy matching
22198 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
22199 things like scoring, thread gathering and thread comparison.
22201 As opposed to regular expression matching, fuzzy matching is very fuzzy.
22202 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
22203 means, and the implementation has changed over time.
22205 Basically, it tries to remove all noise from lines before comparing.
22206 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
22207 out of the strings before comparing the results. This often leads to
22208 adequate results---even when faced with strings generated by text
22209 manglers masquerading as newsreaders.
22212 @node Thwarting Email Spam
22213 @section Thwarting Email Spam
22217 @cindex unsolicited commercial email
22219 In these last days of the Usenet, commercial vultures are hanging about
22220 and grepping through news like crazy to find email addresses they can
22221 foist off their scams and products to. As a reaction to this, many
22222 people have started putting nonsense addresses into their @code{From}
22223 lines. I think this is counterproductive---it makes it difficult for
22224 people to send you legitimate mail in response to things you write, as
22225 well as making it difficult to see who wrote what. This rewriting may
22226 perhaps be a bigger menace than the unsolicited commercial email itself
22229 The biggest problem I have with email spam is that it comes in under
22230 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
22231 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
22232 mail group, only to find two pyramid schemes, seven advertisements
22233 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
22234 and one mail asking me to repent and find some god.
22236 This is annoying. Here's what you can do about it.
22239 * The problem of spam:: Some background, and some solutions
22240 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
22241 * SpamAssassin:: How to use external anti-spam tools.
22242 * Hashcash:: Reduce spam by burning CPU time.
22243 * Filtering Spam Using The Spam ELisp Package::
22244 * Filtering Spam Using Statistics with spam-stat::
22247 @node The problem of spam
22248 @subsection The problem of spam
22250 @cindex spam filtering approaches
22251 @cindex filtering approaches, spam
22253 @cindex unsolicited commercial email
22255 First, some background on spam.
22257 If you have access to e-mail, you are familiar with spam (technically
22258 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
22259 exists because e-mail delivery is very cheap compared to paper mail,
22260 so only a very small percentage of people need to respond to an UCE to
22261 make it worthwhile to the advertiser. Ironically, one of the most
22262 common spams is the one offering a database of e-mail addresses for
22263 further spamming. Senders of spam are usually called @emph{spammers},
22264 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
22265 @emph{morons} are in common use as well.
22267 Spam comes from a wide variety of sources. It is simply impossible to
22268 dispose of all spam without discarding useful messages. A good
22269 example is the TMDA system, which requires senders
22270 unknown to you to confirm themselves as legitimate senders before
22271 their e-mail can reach you. Without getting into the technical side
22272 of TMDA, a downside is clearly that e-mail from legitimate sources may
22273 be discarded if those sources can't or won't confirm themselves
22274 through the TMDA system. Another problem with TMDA is that it
22275 requires its users to have a basic understanding of e-mail delivery
22278 The simplest approach to filtering spam is filtering, at the mail
22279 server or when you sort through incoming mail. If you get 200 spam
22280 messages per day from @samp{random-address@@vmadmin.com}, you block
22281 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
22282 discard all messages with @samp{VIAGRA} in the message. If you get
22283 lots of spam from Bulgaria, for example, you try to filter all mail
22284 from Bulgarian IPs.
22286 This, unfortunately, is a great way to discard legitimate e-mail. The
22287 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
22288 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
22289 you should be obvious, so don't do it if you have the choice.
22291 In another instance, the very informative and useful RISKS digest has
22292 been blocked by overzealous mail filters because it @strong{contained}
22293 words that were common in spam messages. Nevertheless, in isolated
22294 cases, with great care, direct filtering of mail can be useful.
22296 Another approach to filtering e-mail is the distributed spam
22297 processing, for instance DCC implements such a system. In essence,
22298 @var{N} systems around the world agree that a machine @var{X} in
22299 Ghana, Estonia, or California is sending out spam e-mail, and these
22300 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
22301 database. The criteria for spam detection vary---it may be the number
22302 of messages sent, the content of the messages, and so on. When a user
22303 of the distributed processing system wants to find out if a message is
22304 spam, he consults one of those @var{N} systems.
22306 Distributed spam processing works very well against spammers that send
22307 a large number of messages at once, but it requires the user to set up
22308 fairly complicated checks. There are commercial and free distributed
22309 spam processing systems. Distributed spam processing has its risks as
22310 well. For instance legitimate e-mail senders have been accused of
22311 sending spam, and their web sites and mailing lists have been shut
22312 down for some time because of the incident.
22314 The statistical approach to spam filtering is also popular. It is
22315 based on a statistical analysis of previous spam messages. Usually
22316 the analysis is a simple word frequency count, with perhaps pairs of
22317 words or 3-word combinations thrown into the mix. Statistical
22318 analysis of spam works very well in most of the cases, but it can
22319 classify legitimate e-mail as spam in some cases. It takes time to
22320 run the analysis, the full message must be analyzed, and the user has
22321 to store the database of spam analyses. Statistical analysis on the
22322 server is gaining popularity. This has the advantage of letting the
22323 user Just Read Mail, but has the disadvantage that it's harder to tell
22324 the server that it has misclassified mail.
22326 Fighting spam is not easy, no matter what anyone says. There is no
22327 magic switch that will distinguish Viagra ads from Mom's e-mails.
22328 Even people are having a hard time telling spam apart from non-spam,
22329 because spammers are actively looking to fool us into thinking they
22330 are Mom, essentially. Spamming is irritating, irresponsible, and
22331 idiotic behavior from a bunch of people who think the world owes them
22332 a favor. We hope the following sections will help you in fighting the
22335 @node Anti-Spam Basics
22336 @subsection Anti-Spam Basics
22340 @cindex unsolicited commercial email
22342 One way of dealing with spam is having Gnus split out all spam into a
22343 @samp{spam} mail group (@pxref{Splitting Mail}).
22345 First, pick one (1) valid mail address that you can be reached at, and
22346 put it in your @code{From} header of all your news articles. (I've
22347 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
22348 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
22349 sysadmin whether your sendmail installation accepts keywords in the local
22350 part of the mail address.)
22353 (setq message-default-news-headers
22354 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
22357 Then put the following split rule in @code{nnmail-split-fancy}
22358 (@pxref{Fancy Mail Splitting}):
22362 (to "larsi@@trym.ifi.uio.no"
22363 (| ("subject" "re:.*" "misc")
22364 ("references" ".*@@.*" "misc")
22369 This says that all mail to this address is suspect, but if it has a
22370 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
22371 header, it's probably ok. All the rest goes to the @samp{spam} group.
22372 (This idea probably comes from Tim Pierce.)
22374 In addition, many mail spammers talk directly to your @acronym{SMTP} server
22375 and do not include your email address explicitly in the @code{To}
22376 header. Why they do this is unknown---perhaps it's to thwart this
22377 thwarting scheme? In any case, this is trivial to deal with---you just
22378 put anything not addressed to you in the @samp{spam} group by ending
22379 your fancy split rule in this way:
22384 (to "larsi" "misc")
22388 In my experience, this will sort virtually everything into the right
22389 group. You still have to check the @samp{spam} group from time to time to
22390 check for legitimate mail, though. If you feel like being a good net
22391 citizen, you can even send off complaints to the proper authorities on
22392 each unsolicited commercial email---at your leisure.
22394 This works for me. It allows people an easy way to contact me (they can
22395 just press @kbd{r} in the usual way), and I'm not bothered at all with
22396 spam. It's a win-win situation. Forging @code{From} headers to point
22397 to non-existent domains is yucky, in my opinion.
22399 Be careful with this approach. Spammers are wise to it.
22403 @subsection SpamAssassin, Vipul's Razor, DCC, etc
22404 @cindex SpamAssassin
22405 @cindex Vipul's Razor
22408 The days where the hints in the previous section were sufficient in
22409 avoiding spam are coming to an end. There are many tools out there
22410 that claim to reduce the amount of spam you get. This section could
22411 easily become outdated fast, as new products replace old, but
22412 fortunately most of these tools seem to have similar interfaces. Even
22413 though this section will use SpamAssassin as an example, it should be
22414 easy to adapt it to most other tools.
22416 Note that this section does not involve the @code{spam.el} package,
22417 which is discussed in the next section. If you don't care for all
22418 the features of @code{spam.el}, you can make do with these simple
22421 If the tool you are using is not installed on the mail server, you
22422 need to invoke it yourself. Ideas on how to use the
22423 @code{:postscript} mail source parameter (@pxref{Mail Source
22424 Specifiers}) follow.
22428 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
22432 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
22435 Once you manage to process your incoming spool somehow, thus making
22436 the mail contain e.g.@: a header indicating it is spam, you are ready to
22437 filter it out. Using normal split methods (@pxref{Splitting Mail}):
22440 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
22444 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
22447 (setq nnmail-split-methods 'nnmail-split-fancy
22448 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
22452 Some people might not like the idea of piping the mail through various
22453 programs using a @code{:prescript} (if some program is buggy, you
22454 might lose all mail). If you are one of them, another solution is to
22455 call the external tools during splitting. Example fancy split method:
22458 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
22460 (defun kevin-spamassassin ()
22464 (if (eq 1 (call-process-region (point-min) (point-max)
22465 "spamc" nil nil nil "-c"))
22469 Note that with the nnimap back end, message bodies will not be
22470 downloaded by default. You need to set
22471 @code{nnimap-split-download-body} to @code{t} to do that
22472 (@pxref{Splitting in IMAP}).
22474 That is about it. As some spam is likely to get through anyway, you
22475 might want to have a nifty function to call when you happen to read
22476 spam. And here is the nifty function:
22479 (defun my-gnus-raze-spam ()
22480 "Submit SPAM to Vipul's Razor, then mark it as expirable."
22482 (gnus-summary-show-raw-article)
22483 (gnus-summary-save-in-pipe "razor-report -f -d")
22484 (gnus-summary-mark-as-expirable 1))
22488 @subsection Hashcash
22491 A novel technique to fight spam is to require senders to do something
22492 costly and demonstrably unique for each message they send. This has
22493 the obvious drawback that you cannot rely on everyone in the world
22494 using this technique, since it is not part of the Internet standards,
22495 but it may be useful in smaller communities.
22497 While the tools in the previous section work well in practice, they
22498 work only because the tools are constantly maintained and updated as
22499 new form of spam appears. This means that a small percentage of spam
22500 will always get through. It also means that somewhere, someone needs
22501 to read lots of spam to update these tools. Hashcash avoids that, but
22502 instead prefers that everyone you contact through e-mail supports the
22503 scheme. You can view the two approaches as pragmatic vs dogmatic.
22504 The approaches have their own advantages and disadvantages, but as
22505 often in the real world, a combination of them is stronger than either
22506 one of them separately.
22509 The ``something costly'' is to burn CPU time, more specifically to
22510 compute a hash collision up to a certain number of bits. The
22511 resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header.
22512 For more details, and for the external application @code{hashcash} you
22513 need to install to use this feature, see
22514 @uref{http://www.hashcash.org/}. Even more information can be found
22515 at @uref{http://www.camram.org/}.
22517 If you wish to generate hashcash for each message you send, you can
22518 customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail
22519 Headers,message, The Message Manual}), as in:
22522 (setq message-generate-hashcash t)
22525 You will need to set up some additional variables as well:
22529 @item hashcash-default-payment
22530 @vindex hashcash-default-payment
22531 This variable indicates the default number of bits the hash collision
22532 should consist of. By default this is 20. Suggested useful values
22535 @item hashcash-payment-alist
22536 @vindex hashcash-payment-alist
22537 Some receivers may require you to spend burn more CPU time than the
22538 default. This variable contains a list of @samp{(@var{addr}
22539 @var{amount})} cells, where @var{addr} is the receiver (email address
22540 or newsgroup) and @var{amount} is the number of bits in the collision
22541 that is needed. It can also contain @samp{(@var{addr} @var{string}
22542 @var{amount})} cells, where the @var{string} is the string to use
22543 (normally the email address or newsgroup name is used).
22545 @item hashcash-path
22546 @vindex hashcash-path
22547 Where the @code{hashcash} binary is installed. This variable should
22548 be automatically set by @code{executable-find}, but if it's @code{nil}
22549 (usually because the @code{hashcash} binary is not in your path)
22550 you'll get a warning when you check hashcash payments and an error
22551 when you generate hashcash payments.
22555 Gnus can verify hashcash cookies, although this can also be done by
22556 hand customized mail filtering scripts. To verify a hashcash cookie
22557 in a message, use the @code{mail-check-payment} function in the
22558 @code{hashcash.el} library. You can also use the @code{spam.el}
22559 package with the @code{spam-use-hashcash} back end to validate hashcash
22560 cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam
22561 Hashcash Payments}).
22563 @node Filtering Spam Using The Spam ELisp Package
22564 @subsection Filtering Spam Using The Spam ELisp Package
22565 @cindex spam filtering
22568 The idea behind @code{spam.el} is to have a control center for spam detection
22569 and filtering in Gnus. To that end, @code{spam.el} does two things: it
22570 filters new mail, and it analyzes mail known to be spam or ham.
22571 @dfn{Ham} is the name used throughout @code{spam.el} to indicate
22574 Make sure you read the section on the @code{spam.el} sequence of
22575 events. See @xref{Spam ELisp Package Sequence of Events}.
22577 To use @code{spam.el}, you @strong{must} run the function
22578 @code{spam-initialize} to autoload @code{spam.el} and to install the
22579 @code{spam.el} hooks. There is one exception: if you use the
22580 @code{spam-use-stat} (@pxref{spam-stat spam filtering}) setting, you
22581 should turn it on before @code{spam-initialize}:
22584 (setq spam-use-stat t) ;; if needed
22588 So, what happens when you load @code{spam.el}?
22590 First, some hooks will get installed by @code{spam-initialize}. There
22591 are some hooks for @code{spam-stat} so it can save its databases, and
22592 there are hooks so interesting things will happen when you enter and
22593 leave a group. More on the sequence of events later (@pxref{Spam
22594 ELisp Package Sequence of Events}).
22596 You get the following keyboard commands:
22606 @findex gnus-summary-mark-as-spam
22607 @code{gnus-summary-mark-as-spam}.
22609 Mark current article as spam, showing it with the @samp{$} mark.
22610 Whenever you see a spam article, make sure to mark its summary line
22611 with @kbd{M-d} before leaving the group. This is done automatically
22612 for unread articles in @emph{spam} groups.
22618 @findex spam-bogofilter-score
22619 @code{spam-bogofilter-score}.
22621 You must have Bogofilter installed for that command to work properly.
22627 Also, when you load @code{spam.el}, you will be able to customize its
22628 variables. Try @code{customize-group} on the @samp{spam} variable
22632 * Spam ELisp Package Sequence of Events::
22633 * Spam ELisp Package Filtering of Incoming Mail::
22634 * Spam ELisp Package Global Variables::
22635 * Spam ELisp Package Sorting and Score Display in Summary Buffer::
22636 * Spam ELisp Package Configuration Examples::
22637 * Blacklists and Whitelists::
22638 * BBDB Whitelists::
22639 * Gmane Spam Reporting::
22640 * Anti-spam Hashcash Payments::
22642 * Regular Expressions Header Matching::
22644 * SpamAssassin back end::
22645 * ifile spam filtering::
22646 * spam-stat spam filtering::
22648 * Extending the Spam ELisp package::
22651 @node Spam ELisp Package Sequence of Events
22652 @subsubsection Spam ELisp Package Sequence of Events
22653 @cindex spam filtering
22654 @cindex spam filtering sequence of events
22656 You must read this section to understand how @code{spam.el} works.
22657 Do not skip, speed-read, or glance through this section.
22659 There are two @emph{contact points}, if you will, between
22660 @code{spam.el} and the rest of Gnus: checking new mail for spam, and
22663 Getting new mail in Gnus is done in one of two ways. You can either
22664 split your incoming mail or you can classify new articles as ham or
22665 spam when you enter the group.
22667 Splitting incoming mail is better suited to mail back ends such as
22668 @code{nnml} or @code{nnimap} where new mail appears in a single file
22669 called a @dfn{Spool File}. See @xref{Spam ELisp Package Filtering of
22672 @vindex gnus-spam-autodetect
22673 @vindex gnus-spam-autodetect-methods
22674 For back ends such as @code{nntp} there is no incoming mail spool, so
22675 an alternate mechanism must be used. This may also happen for
22676 back ends where the server is in charge of splitting incoming mail, and
22677 Gnus does not do further splitting. The @code{spam-autodetect} and
22678 @code{spam-autodetect-methods} group parameters (accessible with
22679 @kbd{G c} and @kbd{G p} as usual), and the corresponding variables
22680 @code{gnus-spam-autodetect} and @code{gnus-spam-autodetect-methods}
22681 (accessible with @kbd{M-x customize-variable} as usual) can help.
22683 When @code{spam-autodetect} is used (you can turn it on for a
22684 group/topic or wholesale by regular expression matches, as needed), it
22685 hooks into the process of entering a group. Thus, entering a group
22686 with unseen or unread articles becomes the substitute for checking
22687 incoming mail. Whether only unseen articles or all unread articles
22688 will be processed is determined by the
22689 @code{spam-autodetect-recheck-messages}. When set to @code{t}, unread
22690 messages will be rechecked. You should probably stick with the
22691 default of only checking unseen messages.
22693 @code{spam-autodetect} grants the user at once more and less control
22694 of spam filtering. The user will have more control over each group's
22695 spam methods, so for instance the @samp{ding} group may have
22696 @code{spam-use-BBDB} as the autodetection method, while the
22697 @samp{suspect} group may have the @code{spam-use-blacklist} and
22698 @code{spam-use-bogofilter} methods enabled. Every article detected to
22699 be spam will be marked with the spam mark @samp{$} and processed on
22700 exit from the group as normal spam. The user has less control over
22701 the @emph{sequence} of checks, as he might with @code{spam-split}.
22703 When the newly split mail goes into groups, or messages are
22704 autodetected to be ham or spam, those groups must be exited (after
22705 entering, if needed) for further spam processing to happen. It
22706 matters whether the group is considered a ham group, a spam group, or
22707 is unclassified, based on its @code{spam-content} parameter
22708 (@pxref{Spam ELisp Package Global Variables}). Spam groups have the
22709 additional characteristic that, when entered, any unseen or unread
22710 articles (depending on the @code{spam-mark-only-unseen-as-spam}
22711 variable) will be marked as spam. Thus, mail split into a spam group
22712 gets automatically marked as spam when you enter the group.
22714 Thus, when you exit a group, the @code{spam-processors} are applied,
22715 if any are set, and the processed mail is moved to the
22716 @code{ham-process-destination} or the @code{spam-process-destination}
22717 depending on the article's classification. If the
22718 @code{ham-process-destination} or the @code{spam-process-destination},
22719 whichever is appropriate, are @code{nil}, the article is left in the
22722 If a spam is found in any group (this can be changed to only non-spam
22723 groups with @code{spam-move-spam-nonspam-groups-only}), it is
22724 processed by the active @code{spam-processors} (@pxref{Spam ELisp
22725 Package Global Variables}) when the group is exited. Furthermore, the
22726 spam is moved to the @code{spam-process-destination} (@pxref{Spam
22727 ELisp Package Global Variables}) for further training or deletion.
22728 You have to load the @code{gnus-registry.el} package and enable the
22729 @code{spam-log-to-registry} variable if you want spam to be processed
22730 no more than once. Thus, spam is detected and processed everywhere,
22731 which is what most people want. If the
22732 @code{spam-process-destination} is @code{nil}, the spam is marked as
22733 expired, which is usually the right thing to do.
22735 If spam can not be moved---because of a read-only back end such as
22736 @acronym{NNTP}, for example, it will be copied.
22738 If a ham mail is found in a ham group, as determined by the
22739 @code{ham-marks} parameter, it is processed as ham by the active ham
22740 @code{spam-processor} when the group is exited. With the variables
22741 @code{spam-process-ham-in-spam-groups} and
22742 @code{spam-process-ham-in-nonham-groups} the behavior can be further
22743 altered so ham found anywhere can be processed. You have to load the
22744 @code{gnus-registry.el} package and enable the
22745 @code{spam-log-to-registry} variable if you want ham to be processed
22746 no more than once. Thus, ham is detected and processed only when
22747 necessary, which is what most people want. More on this in
22748 @xref{Spam ELisp Package Configuration Examples}.
22750 If ham can not be moved---because of a read-only back end such as
22751 @acronym{NNTP}, for example, it will be copied.
22753 If all this seems confusing, don't worry. Soon it will be as natural
22754 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
22755 50 years in the future yet. Just trust us, it's not so bad.
22757 @node Spam ELisp Package Filtering of Incoming Mail
22758 @subsubsection Spam ELisp Package Filtering of Incoming Mail
22759 @cindex spam filtering
22760 @cindex spam filtering incoming mail
22763 To use the @code{spam.el} facilities for incoming mail filtering, you
22764 must add the following to your fancy split list
22765 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
22771 Note that the fancy split may be called @code{nnmail-split-fancy} or
22772 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
22773 nnimap back ends to retrieve your mail.
22775 Also, @code{spam-split} will not modify incoming mail in any way.
22777 The @code{spam-split} function will process incoming mail and send the
22778 mail considered to be spam into the group name given by the variable
22779 @code{spam-split-group}. By default that group name is @samp{spam},
22780 but you can customize @code{spam-split-group}. Make sure the contents
22781 of @code{spam-split-group} are an @emph{unqualified} group name, for
22782 instance in an @code{nnimap} server @samp{your-server} the value
22783 @samp{spam} will turn out to be @samp{nnimap+your-server:spam}. The
22784 value @samp{nnimap+server:spam}, therefore, is wrong and will
22785 actually give you the group
22786 @samp{nnimap+your-server:nnimap+server:spam} which may or may not
22787 work depending on your server's tolerance for strange group names.
22789 You can also give @code{spam-split} a parameter,
22790 e.g. @code{spam-use-regex-headers} or @code{"maybe-spam"}. Why is
22793 Take these split rules (with @code{spam-use-regex-headers} and
22794 @code{spam-use-blackholes} set):
22797 nnimap-split-fancy '(|
22798 (any "ding" "ding")
22800 ;; @r{default mailbox}
22804 Now, the problem is that you want all ding messages to make it to the
22805 ding folder. But that will let obvious spam (for example, spam
22806 detected by SpamAssassin, and @code{spam-use-regex-headers}) through,
22807 when it's sent to the ding list. On the other hand, some messages to
22808 the ding list are from a mail server in the blackhole list, so the
22809 invocation of @code{spam-split} can't be before the ding rule.
22811 You can let SpamAssassin headers supersede ding rules, but all other
22812 @code{spam-split} rules (including a second invocation of the
22813 regex-headers check) will be after the ding rule:
22818 ;; @r{all spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
22819 (: spam-split "regex-spam" 'spam-use-regex-headers)
22820 (any "ding" "ding")
22821 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
22823 ;; @r{default mailbox}
22827 This lets you invoke specific @code{spam-split} checks depending on
22828 your particular needs, and to target the results of those checks to a
22829 particular spam group. You don't have to throw all mail into all the
22830 spam tests. Another reason why this is nice is that messages to
22831 mailing lists you have rules for don't have to have resource-intensive
22832 blackhole checks performed on them. You could also specify different
22833 spam checks for your nnmail split vs. your nnimap split. Go crazy.
22835 You should still have specific checks such as
22836 @code{spam-use-regex-headers} set to @code{t}, even if you
22837 specifically invoke @code{spam-split} with the check. The reason is
22838 that when loading @code{spam.el}, some conditional loading is done
22839 depending on what @code{spam-use-xyz} variables you have set. This
22840 is usually not critical, though.
22842 @emph{Note for IMAP users}
22844 The boolean variable @code{nnimap-split-download-body} needs to be
22845 set, if you want to split based on the whole message instead of just
22846 the headers. By default, the nnimap back end will only retrieve the
22847 message headers. If you use a @emph{statistical} filter,
22848 e.g. @code{spam-check-bogofilter}, @code{spam-check-ifile}, or
22849 @code{spam-check-stat} (the splitters that can benefit from the full
22850 message body), this variable will be set automatically. It is not set
22851 for non-statistical back ends by default because it will slow
22852 @acronym{IMAP} down.
22854 @xref{Splitting in IMAP}.
22856 @node Spam ELisp Package Global Variables
22857 @subsubsection Spam ELisp Package Global Variables
22858 @cindex spam filtering
22859 @cindex spam filtering variables
22860 @cindex spam variables
22863 @vindex gnus-spam-process-newsgroups
22864 The concepts of ham processors and spam processors are very important.
22865 Ham processors and spam processors for a group can be set with the
22866 @code{spam-process} group parameter, or the
22867 @code{gnus-spam-process-newsgroups} variable. Ham processors take
22868 mail known to be non-spam (@emph{ham}) and process it in some way so
22869 that later similar mail will also be considered non-spam. Spam
22870 processors take mail known to be spam and process it so similar spam
22871 will be detected later.
22873 The format of the spam or ham processor entry used to be a symbol,
22874 but now it is a @sc{cons} cell. See the individual spam processor entries
22875 for more information.
22877 @vindex gnus-spam-newsgroup-contents
22878 Gnus learns from the spam you get. You have to collect your spam in
22879 one or more spam groups, and set or customize the variable
22880 @code{spam-junk-mailgroups} as appropriate. You can also declare
22881 groups to contain spam by setting their group parameter
22882 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
22883 by customizing the corresponding variable
22884 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
22885 parameter and the @code{gnus-spam-newsgroup-contents} variable can
22886 also be used to declare groups as @emph{ham} groups if you set their
22887 classification to @code{gnus-group-spam-classification-ham}. If
22888 groups are not classified by means of @code{spam-junk-mailgroups},
22889 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
22890 considered @emph{unclassified}. All groups are unclassified by
22893 @vindex gnus-spam-mark
22895 In spam groups, all messages are considered to be spam by default:
22896 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
22897 group. If you have seen a message, had it marked as spam, then
22898 unmarked it, it won't be marked as spam when you enter the group
22899 thereafter. You can disable that behavior, so all unread messages
22900 will get the @samp{$} mark, if you set the
22901 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
22902 should remove the @samp{$} mark when you are in the group summary
22903 buffer for every message that is not spam after all. To remove the
22904 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
22905 @kbd{d} for declaring it read the non-spam way. When you leave a
22906 group, all spam-marked (@samp{$}) articles are sent to a spam
22907 processor which will study them as spam samples.
22909 Messages may also be deleted in various other ways, and unless
22910 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
22911 and @samp{r} for default read or explicit delete, marks @samp{X} and
22912 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
22913 low scores, are all considered to be associated with articles which
22914 are not spam. This assumption might be false, in particular if you
22915 use kill files or score files as means for detecting genuine spam, you
22916 should then adjust the @code{ham-marks} group parameter.
22919 You can customize this group or topic parameter to be the list of
22920 marks you want to consider ham. By default, the list contains the
22921 deleted, read, killed, kill-filed, and low-score marks (the idea is
22922 that these articles have been read, but are not spam). It can be
22923 useful to also include the tick mark in the ham marks. It is not
22924 recommended to make the unread mark a ham mark, because it normally
22925 indicates a lack of classification. But you can do it, and we'll be
22930 You can customize this group or topic parameter to be the list of
22931 marks you want to consider spam. By default, the list contains only
22932 the spam mark. It is not recommended to change that, but you can if
22933 you really want to.
22936 When you leave @emph{any} group, regardless of its
22937 @code{spam-contents} classification, all spam-marked articles are sent
22938 to a spam processor, which will study these as spam samples. If you
22939 explicit kill a lot, you might sometimes end up with articles marked
22940 @samp{K} which you never saw, and which might accidentally contain
22941 spam. Best is to make sure that real spam is marked with @samp{$},
22944 @vindex gnus-ham-process-destinations
22945 When you leave a @emph{spam} group, all spam-marked articles are
22946 marked as expired after processing with the spam processor. This is
22947 not done for @emph{unclassified} or @emph{ham} groups. Also, any
22948 @strong{ham} articles in a spam group will be moved to a location
22949 determined by either the @code{ham-process-destination} group
22950 parameter or a match in the @code{gnus-ham-process-destinations}
22951 variable, which is a list of regular expressions matched with group
22952 names (it's easiest to customize this variable with @kbd{M-x
22953 customize-variable @key{RET} gnus-ham-process-destinations}). Each
22954 group name list is a standard Lisp list, if you prefer to customize
22955 the variable manually. If the @code{ham-process-destination}
22956 parameter is not set, ham articles are left in place. If the
22957 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
22958 set, the ham articles are marked as unread before being moved.
22960 If ham can not be moved---because of a read-only back end such as
22961 @acronym{NNTP}, for example, it will be copied.
22963 Note that you can use multiples destinations per group or regular
22964 expression! This enables you to send your ham to a regular mail
22965 group and to a @emph{ham training} group.
22967 When you leave a @emph{ham} group, all ham-marked articles are sent to
22968 a ham processor, which will study these as non-spam samples.
22970 @vindex spam-process-ham-in-spam-groups
22971 By default the variable @code{spam-process-ham-in-spam-groups} is
22972 @code{nil}. Set it to @code{t} if you want ham found in spam groups
22973 to be processed. Normally this is not done, you are expected instead
22974 to send your ham to a ham group and process it there.
22976 @vindex spam-process-ham-in-nonham-groups
22977 By default the variable @code{spam-process-ham-in-nonham-groups} is
22978 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
22979 or unclassified) groups to be processed. Normally this is not done,
22980 you are expected instead to send your ham to a ham group and process
22983 @vindex gnus-spam-process-destinations
22984 When you leave a @emph{ham} or @emph{unclassified} group, all
22985 @strong{spam} articles are moved to a location determined by either
22986 the @code{spam-process-destination} group parameter or a match in the
22987 @code{gnus-spam-process-destinations} variable, which is a list of
22988 regular expressions matched with group names (it's easiest to
22989 customize this variable with @kbd{M-x customize-variable @key{RET}
22990 gnus-spam-process-destinations}). Each group name list is a standard
22991 Lisp list, if you prefer to customize the variable manually. If the
22992 @code{spam-process-destination} parameter is not set, the spam
22993 articles are only expired. The group name is fully qualified, meaning
22994 that if you see @samp{nntp:servername} before the group name in the
22995 group buffer then you need it here as well.
22997 If spam can not be moved---because of a read-only back end such as
22998 @acronym{NNTP}, for example, it will be copied.
23000 Note that you can use multiples destinations per group or regular
23001 expression! This enables you to send your spam to multiple @emph{spam
23004 @vindex spam-log-to-registry
23005 The problem with processing ham and spam is that Gnus doesn't track
23006 this processing by default. Enable the @code{spam-log-to-registry}
23007 variable so @code{spam.el} will use @code{gnus-registry.el} to track
23008 what articles have been processed, and avoid processing articles
23009 multiple times. Keep in mind that if you limit the number of registry
23010 entries, this won't work as well as it does without a limit.
23012 @vindex spam-mark-only-unseen-as-spam
23013 Set this variable if you want only unseen articles in spam groups to
23014 be marked as spam. By default, it is set. If you set it to
23015 @code{nil}, unread articles will also be marked as spam.
23017 @vindex spam-mark-ham-unread-before-move-from-spam-group
23018 Set this variable if you want ham to be unmarked before it is moved
23019 out of the spam group. This is very useful when you use something
23020 like the tick mark @samp{!} to mark ham---the article will be placed
23021 in your @code{ham-process-destination}, unmarked as if it came fresh
23022 from the mail server.
23024 @vindex spam-autodetect-recheck-messages
23025 When autodetecting spam, this variable tells @code{spam.el} whether
23026 only unseen articles or all unread articles should be checked for
23027 spam. It is recommended that you leave it off.
23029 @node Spam ELisp Package Sorting and Score Display in Summary Buffer
23030 @subsubsection Spam ELisp Package Sorting and Score Display in Summary Buffer
23031 @cindex spam scoring
23032 @cindex spam sorting
23033 @cindex spam score summary buffer
23034 @cindex spam sort summary buffer
23037 You can display the spam score of articles in your summary buffer, and
23038 you can sort articles by their spam score.
23040 First you need to decide which back end you will be using. If you use
23041 the @code{spam-use-spamassassin},
23042 @code{spam-use-spamassassin-headers}, or @code{spam-use-regex-headers}
23043 back end, the @code{X-Spam-Status} header will be used. If you use
23044 @code{spam-use-bogofilter}, the @code{X-Bogosity} header will be used.
23045 If you use @code{spam-use-crm114}, any header that matches the CRM114
23046 score format will be used. As long as you set the appropriate back end
23047 variable to t @emph{before} you load @code{spam.el}, you will be
23048 fine. @code{spam.el} will automatically add the right header to the
23049 internal Gnus list of required headers.
23051 To show the spam score in your summary buffer, add this line to your
23052 @code{gnus.el} file (note @code{spam.el} does not do that by default
23053 so it won't override any existing @code{S} formats you may have).
23056 (defalias 'gnus-user-format-function-S 'spam-user-format-function-S)
23059 Now just set your summary line format to use @code{%uS}. Here's an
23060 example that formats the spam score in a 5-character field:
23063 (setq gnus-summary-line-format
23064 "%U%R %10&user-date; $%5uS %6k %B %(%4L: %*%-25,25a%) %s \n")
23067 Finally, to sort by spam status, either do it globally:
23071 gnus-show-threads nil
23072 gnus-article-sort-functions
23073 '(spam-article-sort-by-spam-status))
23076 or per group (@pxref{Sorting the Summary Buffer}).
23078 @node Spam ELisp Package Configuration Examples
23079 @subsubsection Spam ELisp Package Configuration Examples
23080 @cindex spam filtering
23081 @cindex spam filtering configuration examples
23082 @cindex spam configuration examples
23085 @subsubheading Ted's setup
23087 From Ted Zlatanov <tzz@@lifelogs.com>.
23089 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
23090 ;; @r{see @file{gnus-registry.el} for more information}
23091 (gnus-registry-initialize)
23094 ;; @r{I like @kbd{C-s} for marking spam}
23095 (define-key gnus-summary-mode-map "\C-s" 'gnus-summary-mark-as-spam)
23098 spam-log-to-registry t ; @r{for spam autodetection}
23100 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
23101 ;; @r{all groups with @samp{spam} in the name contain spam}
23102 gnus-spam-newsgroup-contents
23103 '(("spam" gnus-group-spam-classification-spam))
23104 ;; @r{see documentation for these}
23105 spam-move-spam-nonspam-groups-only nil
23106 spam-mark-only-unseen-as-spam t
23107 spam-mark-ham-unread-before-move-from-spam-group t
23108 nnimap-split-rule 'nnimap-split-fancy
23109 ;; @r{understand what this does before you copy it to your own setup!}
23110 nnimap-split-fancy '(|
23111 ;; @r{trace references to parents and put in their group}
23112 (: gnus-registry-split-fancy-with-parent)
23113 ;; @r{this will catch server-side SpamAssassin tags}
23114 (: spam-split 'spam-use-regex-headers)
23115 (any "ding" "ding")
23116 ;; @r{note that spam by default will go to @samp{spam}}
23118 ;; @r{default mailbox}
23121 ;; @r{my parameters, set with @kbd{G p}}
23123 ;; @r{all nnml groups, and all nnimap groups except}
23124 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
23125 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
23126 ;; @r{because it must have been detected manually}
23128 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23130 ;; @r{all @acronym{NNTP} groups}
23131 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
23132 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
23133 ;; @r{send all spam to the training group}
23134 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23136 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
23137 ((spam-autodetect . t))
23139 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
23141 ;; @r{this is a spam group}
23142 ((spam-contents gnus-group-spam-classification-spam)
23144 ;; @r{any spam (which happens when I enter for all unseen messages,}
23145 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
23146 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
23148 (spam-process-destination "nnimap+mail.lifelogs.com:train")
23150 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
23151 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
23153 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
23154 "nnimap+mail.lifelogs.com:trainham")
23155 ;; @r{in this group, only @samp{!} marks are ham}
23157 (gnus-ticked-mark))
23158 ;; @r{remembers senders in the blacklist on the way out---this is}
23159 ;; @r{definitely not needed, it just makes me feel better}
23160 (spam-process (gnus-group-spam-exit-processor-blacklist)))
23162 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
23163 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
23164 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
23168 @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server
23169 From Reiner Steib <reiner.steib@@gmx.de>.
23171 My provider has set up bogofilter (in combination with @acronym{DCC}) on
23172 the mail server (@acronym{IMAP}). Recognized spam goes to
23173 @samp{spam.detected}, the rest goes through the normal filter rules,
23174 i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
23175 positives or negatives is done by copying or moving the article to
23176 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
23177 the server feeds those to bogofilter with the suitable ham or spam
23178 options and deletes them from the @samp{training.ham} and
23179 @samp{training.spam} folders.
23181 With the following entries in @code{gnus-parameters}, @code{spam.el}
23182 does most of the job for me:
23185 ("nnimap:spam\\.detected"
23186 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
23187 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
23188 (spam-contents gnus-group-spam-classification-spam))
23189 ("nnimap:\\(INBOX\\|other-folders\\)"
23190 (spam-process-destination . "nnimap:training.spam")
23191 (spam-contents gnus-group-spam-classification-ham))
23196 @item @b{The Spam folder:}
23198 In the folder @samp{spam.detected}, I have to check for false positives
23199 (i.e. legitimate mails, that were wrongly judged as spam by
23200 bogofilter or DCC).
23202 Because of the @code{gnus-group-spam-classification-spam} entry, all
23203 messages are marked as spam (with @code{$}). When I find a false
23204 positive, I mark the message with some other ham mark (@code{ham-marks},
23205 @ref{Spam ELisp Package Global Variables}). On group exit, those
23206 messages are copied to both groups, @samp{INBOX} (where I want to have
23207 the article) and @samp{training.ham} (for training bogofilter) and
23208 deleted from the @samp{spam.detected} folder.
23210 The @code{gnus-article-sort-by-chars} entry simplifies detection of
23211 false positives for me. I receive lots of worms (sweN, @dots{}), that all
23212 have a similar size. Grouping them by size (i.e. chars) makes finding
23213 other false positives easier. (Of course worms aren't @i{spam}
23214 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
23215 an excellent tool for filtering those unwanted mails for me.)
23217 @item @b{Ham folders:}
23219 In my ham folders, I just hit @kbd{S x}
23220 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
23221 mail (false negative). On group exit, those messages are moved to
23222 @samp{training.ham}.
23225 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
23227 From Reiner Steib <reiner.steib@@gmx.de>.
23229 With following entry in @code{gnus-parameters}, @kbd{S x}
23230 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
23231 groups as spam and reports the to Gmane at group exit:
23235 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
23238 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
23239 because I don't read the groups directly from news.gmane.org, but
23240 through my local news server (leafnode). I.e. the article numbers are
23241 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
23242 the @code{X-Report-Spam} header to find the correct number.
23244 @node Blacklists and Whitelists
23245 @subsubsection Blacklists and Whitelists
23246 @cindex spam filtering
23247 @cindex whitelists, spam filtering
23248 @cindex blacklists, spam filtering
23251 @defvar spam-use-blacklist
23253 Set this variable to @code{t} if you want to use blacklists when
23254 splitting incoming mail. Messages whose senders are in the blacklist
23255 will be sent to the @code{spam-split-group}. This is an explicit
23256 filter, meaning that it acts only on mail senders @emph{declared} to
23261 @defvar spam-use-whitelist
23263 Set this variable to @code{t} if you want to use whitelists when
23264 splitting incoming mail. Messages whose senders are not in the
23265 whitelist will be sent to the next spam-split rule. This is an
23266 explicit filter, meaning that unless someone is in the whitelist, their
23267 messages are not assumed to be spam or ham.
23271 @defvar spam-use-whitelist-exclusive
23273 Set this variable to @code{t} if you want to use whitelists as an
23274 implicit filter, meaning that every message will be considered spam
23275 unless the sender is in the whitelist. Use with care.
23279 @defvar gnus-group-spam-exit-processor-blacklist
23281 Add this symbol to a group's @code{spam-process} parameter by
23282 customizing the group parameters or the
23283 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23284 added to a group's @code{spam-process} parameter, the senders of
23285 spam-marked articles will be added to the blacklist.
23289 Instead of the obsolete
23290 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
23291 that you use @code{'(spam spam-use-blacklist)}. Everything will work
23292 the same way, we promise.
23296 @defvar gnus-group-ham-exit-processor-whitelist
23298 Add this symbol to a group's @code{spam-process} parameter by
23299 customizing the group parameters or the
23300 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23301 added to a group's @code{spam-process} parameter, the senders of
23302 ham-marked articles in @emph{ham} groups will be added to the
23307 Instead of the obsolete
23308 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
23309 that you use @code{'(ham spam-use-whitelist)}. Everything will work
23310 the same way, we promise.
23314 Blacklists are lists of regular expressions matching addresses you
23315 consider to be spam senders. For instance, to block mail from any
23316 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
23317 blacklist. You start out with an empty blacklist. Blacklist entries
23318 use the Emacs regular expression syntax.
23320 Conversely, whitelists tell Gnus what addresses are considered
23321 legitimate. All messages from whitelisted addresses are considered
23322 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
23323 Emacs regular expression syntax.
23325 The blacklist and whitelist file locations can be customized with the
23326 @code{spam-directory} variable (@file{~/News/spam} by default), or
23327 the @code{spam-whitelist} and @code{spam-blacklist} variables
23328 directly. The whitelist and blacklist files will by default be in the
23329 @code{spam-directory} directory, named @file{whitelist} and
23330 @file{blacklist} respectively.
23332 @node BBDB Whitelists
23333 @subsubsection BBDB Whitelists
23334 @cindex spam filtering
23335 @cindex BBDB whitelists, spam filtering
23336 @cindex BBDB, spam filtering
23339 @defvar spam-use-BBDB
23341 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
23342 Whitelists}), but uses the BBDB as the source of whitelisted
23343 addresses, without regular expressions. You must have the BBDB loaded
23344 for @code{spam-use-BBDB} to work properly. Messages whose senders are
23345 not in the BBDB will be sent to the next spam-split rule. This is an
23346 explicit filter, meaning that unless someone is in the BBDB, their
23347 messages are not assumed to be spam or ham.
23351 @defvar spam-use-BBDB-exclusive
23353 Set this variable to @code{t} if you want to use the BBDB as an
23354 implicit filter, meaning that every message will be considered spam
23355 unless the sender is in the BBDB. Use with care. Only sender
23356 addresses in the BBDB will be allowed through; all others will be
23357 classified as spammers.
23359 While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias
23360 for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is
23361 @emph{not} a separate back end. If you set
23362 @code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting
23367 @defvar gnus-group-ham-exit-processor-BBDB
23369 Add this symbol to a group's @code{spam-process} parameter by
23370 customizing the group parameters or the
23371 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23372 added to a group's @code{spam-process} parameter, the senders of
23373 ham-marked articles in @emph{ham} groups will be added to the
23378 Instead of the obsolete
23379 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
23380 that you use @code{'(ham spam-use-BBDB)}. Everything will work
23381 the same way, we promise.
23385 @node Gmane Spam Reporting
23386 @subsubsection Gmane Spam Reporting
23387 @cindex spam reporting
23388 @cindex Gmane, spam reporting
23389 @cindex Gmane, spam reporting
23392 @defvar gnus-group-spam-exit-processor-report-gmane
23394 Add this symbol to a group's @code{spam-process} parameter by
23395 customizing the group parameters or the
23396 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23397 added to a group's @code{spam-process} parameter, the spam-marked
23398 articles groups will be reported to the Gmane administrators via a
23401 Gmane can be found at @uref{http://gmane.org}.
23405 Instead of the obsolete
23406 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
23407 that you use @code{'(spam spam-use-gmane)}. Everything will work the
23408 same way, we promise.
23412 @defvar spam-report-gmane-use-article-number
23414 This variable is @code{t} by default. Set it to @code{nil} if you are
23415 running your own news server, for instance, and the local article
23416 numbers don't correspond to the Gmane article numbers. When
23417 @code{spam-report-gmane-use-article-number} is @code{nil},
23418 @code{spam-report.el} will use the @code{X-Report-Spam} header that
23423 @node Anti-spam Hashcash Payments
23424 @subsubsection Anti-spam Hashcash Payments
23425 @cindex spam filtering
23426 @cindex hashcash, spam filtering
23429 @defvar spam-use-hashcash
23431 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
23432 Whitelists}), but uses hashcash tokens for whitelisting messages
23433 instead of the sender address. Messages without a hashcash payment
23434 token will be sent to the next spam-split rule. This is an explicit
23435 filter, meaning that unless a hashcash token is found, the messages
23436 are not assumed to be spam or ham.
23441 @subsubsection Blackholes
23442 @cindex spam filtering
23443 @cindex blackholes, spam filtering
23446 @defvar spam-use-blackholes
23448 This option is disabled by default. You can let Gnus consult the
23449 blackhole-type distributed spam processing systems (DCC, for instance)
23450 when you set this option. The variable @code{spam-blackhole-servers}
23451 holds the list of blackhole servers Gnus will consult. The current
23452 list is fairly comprehensive, but make sure to let us know if it
23453 contains outdated servers.
23455 The blackhole check uses the @code{dig.el} package, but you can tell
23456 @code{spam.el} to use @code{dns.el} instead for better performance if
23457 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
23458 this time to set @code{spam-use-dig} to @code{nil} despite the
23459 possible performance improvements, because some users may be unable to
23460 use it, but you can try it and see if it works for you.
23464 @defvar spam-blackhole-servers
23466 The list of servers to consult for blackhole checks.
23470 @defvar spam-blackhole-good-server-regex
23472 A regular expression for IPs that should not be checked against the
23473 blackhole server list. When set to @code{nil}, it has no effect.
23477 @defvar spam-use-dig
23479 Use the @code{dig.el} package instead of the @code{dns.el} package.
23480 The default setting of @code{t} is recommended.
23484 Blackhole checks are done only on incoming mail. There is no spam or
23485 ham processor for blackholes.
23487 @node Regular Expressions Header Matching
23488 @subsubsection Regular Expressions Header Matching
23489 @cindex spam filtering
23490 @cindex regular expressions header matching, spam filtering
23493 @defvar spam-use-regex-headers
23495 This option is disabled by default. You can let Gnus check the
23496 message headers against lists of regular expressions when you set this
23497 option. The variables @code{spam-regex-headers-spam} and
23498 @code{spam-regex-headers-ham} hold the list of regular expressions.
23499 Gnus will check against the message headers to determine if the
23500 message is spam or ham, respectively.
23504 @defvar spam-regex-headers-spam
23506 The list of regular expressions that, when matched in the headers of
23507 the message, positively identify it as spam.
23511 @defvar spam-regex-headers-ham
23513 The list of regular expressions that, when matched in the headers of
23514 the message, positively identify it as ham.
23518 Regular expression header checks are done only on incoming mail.
23519 There is no specific spam or ham processor for regular expressions.
23522 @subsubsection Bogofilter
23523 @cindex spam filtering
23524 @cindex bogofilter, spam filtering
23527 @defvar spam-use-bogofilter
23529 Set this variable if you want @code{spam-split} to use Eric Raymond's
23532 With a minimum of care for associating the @samp{$} mark for spam
23533 articles only, Bogofilter training all gets fairly automatic. You
23534 should do this until you get a few hundreds of articles in each
23535 category, spam or not. The command @kbd{S t} in summary mode, either
23536 for debugging or for curiosity, shows the @emph{spamicity} score of
23537 the current article (between 0.0 and 1.0).
23539 Bogofilter determines if a message is spam based on a specific
23540 threshold. That threshold can be customized, consult the Bogofilter
23543 If the @code{bogofilter} executable is not in your path, Bogofilter
23544 processing will be turned off.
23546 You should not enable this if you use @code{spam-use-bogofilter-headers}.
23550 @defvar spam-use-bogofilter-headers
23552 Set this variable if you want @code{spam-split} to use Eric Raymond's
23553 speedy Bogofilter, looking only at the message headers. It works
23554 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
23555 must be in the message already. Normally you would do this with a
23556 procmail recipe or something similar; consult the Bogofilter
23557 installation documents for details.
23559 You should not enable this if you use @code{spam-use-bogofilter}.
23563 @defvar gnus-group-spam-exit-processor-bogofilter
23564 Add this symbol to a group's @code{spam-process} parameter by
23565 customizing the group parameters or the
23566 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23567 added to a group's @code{spam-process} parameter, spam-marked articles
23568 will be added to the Bogofilter spam database.
23572 Instead of the obsolete
23573 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
23574 that you use @code{'(spam spam-use-bogofilter)}. Everything will work
23575 the same way, we promise.
23578 @defvar gnus-group-ham-exit-processor-bogofilter
23579 Add this symbol to a group's @code{spam-process} parameter by
23580 customizing the group parameters or the
23581 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23582 added to a group's @code{spam-process} parameter, the ham-marked
23583 articles in @emph{ham} groups will be added to the Bogofilter database
23584 of non-spam messages.
23588 Instead of the obsolete
23589 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
23590 that you use @code{'(ham spam-use-bogofilter)}. Everything will work
23591 the same way, we promise.
23594 @defvar spam-bogofilter-database-directory
23596 This is the directory where Bogofilter will store its databases. It
23597 is not specified by default, so Bogofilter will use its own default
23598 database directory.
23602 The Bogofilter mail classifier is similar to @command{ifile} in intent and
23603 purpose. A ham and a spam processor are provided, plus the
23604 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
23605 variables to indicate to spam-split that Bogofilter should either be
23606 used, or has already been used on the article. The 0.9.2.1 version of
23607 Bogofilter was used to test this functionality.
23609 @node SpamAssassin back end
23610 @subsubsection SpamAssassin back end
23611 @cindex spam filtering
23612 @cindex spamassassin, spam filtering
23615 @defvar spam-use-spamassassin
23617 Set this variable if you want @code{spam-split} to use SpamAssassin.
23619 SpamAssassin assigns a score to each article based on a set of rules
23620 and tests, including a Bayesian filter. The Bayesian filter can be
23621 trained by associating the @samp{$} mark for spam articles. The
23622 spam score can be viewed by using the command @kbd{S t} in summary
23625 If you set this variable, each article will be processed by
23626 SpamAssassin when @code{spam-split} is called. If your mail is
23627 preprocessed by SpamAssassin, and you want to just use the
23628 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
23631 You should not enable this is you use
23632 @code{spam-use-spamassassin-headers}.
23636 @defvar spam-use-spamassassin-headers
23638 Set this variable if your mail is preprocessed by SpamAssassin and
23639 want @code{spam-split} to split based on the SpamAssassin headers.
23641 You should not enable this is you use @code{spam-use-spamassassin}.
23645 @defvar spam-spamassassin-path
23647 This variable points to the SpamAssassin executable. If you have
23648 @code{spamd} running, you can set this variable to the @code{spamc}
23649 executable for faster processing. See the SpamAssassin documentation
23650 for more information on @code{spamd}/@code{spamc}.
23654 SpamAssassin is a powerful and flexible spam filter that uses a wide
23655 variety of tests to identify spam. A ham and a spam processors are
23656 provided, plus the @code{spam-use-spamassassin} and
23657 @code{spam-use-spamassassin-headers} variables to indicate to
23658 spam-split that SpamAssassin should be either used, or has already
23659 been used on the article. The 2.63 version of SpamAssassin was used
23660 to test this functionality.
23662 @node ifile spam filtering
23663 @subsubsection ifile spam filtering
23664 @cindex spam filtering
23665 @cindex ifile, spam filtering
23668 @defvar spam-use-ifile
23670 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
23671 statistical analyzer similar to Bogofilter.
23675 @defvar spam-ifile-all-categories
23677 Enable this variable if you want @code{spam-use-ifile} to give you all
23678 the ifile categories, not just spam/non-spam. If you use this, make
23679 sure you train ifile as described in its documentation.
23683 @defvar spam-ifile-spam-category
23685 This is the category of spam messages as far as ifile is concerned.
23686 The actual string used is irrelevant, but you probably want to leave
23687 the default value of @samp{spam}.
23690 @defvar spam-ifile-database-path
23692 This is the filename for the ifile database. It is not specified by
23693 default, so ifile will use its own default database name.
23697 The ifile mail classifier is similar to Bogofilter in intent and
23698 purpose. A ham and a spam processor are provided, plus the
23699 @code{spam-use-ifile} variable to indicate to spam-split that ifile
23700 should be used. The 1.2.1 version of ifile was used to test this
23703 @node spam-stat spam filtering
23704 @subsubsection spam-stat spam filtering
23705 @cindex spam filtering
23706 @cindex spam-stat, spam filtering
23710 @xref{Filtering Spam Using Statistics with spam-stat}.
23712 @defvar spam-use-stat
23714 Enable this variable if you want @code{spam-split} to use
23715 spam-stat.el, an Emacs Lisp statistical analyzer.
23719 @defvar gnus-group-spam-exit-processor-stat
23720 Add this symbol to a group's @code{spam-process} parameter by
23721 customizing the group parameters or the
23722 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23723 added to a group's @code{spam-process} parameter, the spam-marked
23724 articles will be added to the spam-stat database of spam messages.
23728 Instead of the obsolete
23729 @code{gnus-group-spam-exit-processor-stat}, it is recommended
23730 that you use @code{'(spam spam-use-stat)}. Everything will work
23731 the same way, we promise.
23734 @defvar gnus-group-ham-exit-processor-stat
23735 Add this symbol to a group's @code{spam-process} parameter by
23736 customizing the group parameters or the
23737 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23738 added to a group's @code{spam-process} parameter, the ham-marked
23739 articles in @emph{ham} groups will be added to the spam-stat database
23740 of non-spam messages.
23744 Instead of the obsolete
23745 @code{gnus-group-ham-exit-processor-stat}, it is recommended
23746 that you use @code{'(ham spam-use-stat)}. Everything will work
23747 the same way, we promise.
23750 This enables @code{spam.el} to cooperate with @file{spam-stat.el}.
23751 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
23752 which unlike ifile or Bogofilter does not require external programs.
23753 A spam and a ham processor, and the @code{spam-use-stat} variable for
23754 @code{spam-split} are provided.
23757 @subsubsection Using SpamOracle with Gnus
23758 @cindex spam filtering
23762 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
23763 statistical mail filtering tool written by Xavier Leroy and needs to be
23764 installed separately.
23766 There are several ways to use SpamOracle with Gnus. In all cases, your
23767 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
23768 then enter an @samp{X-Spam} header indicating whether it regards the
23769 mail as a spam mail or not.
23771 One possibility is to run SpamOracle as a @code{:prescript} from the
23772 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
23773 the advantage that the user can see the @emph{X-Spam} headers.
23775 The easiest method is to make @code{spam.el} (@pxref{Filtering Spam
23776 Using The Spam ELisp Package}) call SpamOracle.
23778 @vindex spam-use-spamoracle
23779 To enable SpamOracle usage by @code{spam.el}, set the variable
23780 @code{spam-use-spamoracle} to @code{t} and configure the
23781 @code{nnmail-split-fancy} or @code{nnimap-split-fancy} as described in
23782 the section @xref{Filtering Spam Using The Spam ELisp Package}. In
23783 this example the @samp{INBOX} of an nnimap server is filtered using
23784 SpamOracle. Mails recognized as spam mails will be moved to
23785 @code{spam-split-group}, @samp{Junk} in this case. Ham messages stay
23789 (setq spam-use-spamoracle t
23790 spam-split-group "Junk"
23791 nnimap-split-inbox '("INBOX")
23792 nnimap-split-rule 'nnimap-split-fancy
23793 nnimap-split-fancy '(| (: spam-split) "INBOX"))
23796 @defvar spam-use-spamoracle
23797 Set to @code{t} if you want Gnus to enable spam filtering using
23801 @defvar spam-spamoracle-binary
23802 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
23803 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
23807 @defvar spam-spamoracle-database
23808 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
23809 store its analyses. This is controlled by the variable
23810 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
23811 the default SpamOracle database will be used. In case you want your
23812 database to live somewhere special, set
23813 @code{spam-spamoracle-database} to this path.
23816 SpamOracle employs a statistical algorithm to determine whether a
23817 message is spam or ham. In order to get good results, meaning few
23818 false hits or misses, SpamOracle needs training. SpamOracle learns the
23819 characteristics of your spam mails. Using the @emph{add} mode
23820 (training mode) one has to feed good (ham) and spam mails to
23821 SpamOracle. This can be done by pressing @kbd{|} in the Summary buffer
23822 and pipe the mail to a SpamOracle process or using @code{spam.el}'s
23823 spam- and ham-processors, which is much more convenient. For a
23824 detailed description of spam- and ham-processors, @xref{Filtering Spam
23825 Using The Spam ELisp Package}.
23827 @defvar gnus-group-spam-exit-processor-spamoracle
23828 Add this symbol to a group's @code{spam-process} parameter by
23829 customizing the group parameter or the
23830 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23831 to a group's @code{spam-process} parameter, spam-marked articles will be
23832 sent to SpamOracle as spam samples.
23836 Instead of the obsolete
23837 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
23838 that you use @code{'(spam spam-use-spamoracle)}. Everything will work
23839 the same way, we promise.
23842 @defvar gnus-group-ham-exit-processor-spamoracle
23843 Add this symbol to a group's @code{spam-process} parameter by
23844 customizing the group parameter or the
23845 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23846 to a group's @code{spam-process} parameter, the ham-marked articles in
23847 @emph{ham} groups will be sent to the SpamOracle as samples of ham
23852 Instead of the obsolete
23853 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
23854 that you use @code{'(ham spam-use-spamoracle)}. Everything will work
23855 the same way, we promise.
23858 @emph{Example:} These are the Group Parameters of a group that has been
23859 classified as a ham group, meaning that it should only contain ham
23862 ((spam-contents gnus-group-spam-classification-ham)
23863 (spam-process ((ham spam-use-spamoracle)
23864 (spam spam-use-spamoracle))))
23866 For this group the @code{spam-use-spamoracle} is installed for both
23867 ham and spam processing. If the group contains spam message
23868 (e.g. because SpamOracle has not had enough sample messages yet) and
23869 the user marks some messages as spam messages, these messages will be
23870 processed by SpamOracle. The processor sends the messages to
23871 SpamOracle as new samples for spam.
23873 @node Extending the Spam ELisp package
23874 @subsubsection Extending the Spam ELisp package
23875 @cindex spam filtering
23876 @cindex spam elisp package, extending
23877 @cindex extending the spam elisp package
23879 Say you want to add a new back end called blackbox. For filtering
23880 incoming mail, provide the following:
23888 (defvar spam-use-blackbox nil
23889 "True if blackbox should be used.")
23892 Write @code{spam-check-blackbox} if Blackbox can check incoming mail.
23894 Write @code{spam-blackbox-register-routine} and
23895 @code{spam-blackbox-unregister-routine} using the bogofilter
23896 register/unregister routines as a start, or other restister/unregister
23897 routines more appropriate to Blackbox, if Blackbox can
23898 register/unregister spam and ham.
23903 The @code{spam-check-blackbox} function should return @samp{nil} or
23904 @code{spam-split-group}, observing the other conventions. See the
23905 existing @code{spam-check-*} functions for examples of what you can
23906 do, and stick to the template unless you fully understand the reasons
23911 For processing spam and ham messages, provide the following:
23918 Note you don't have to provide a spam or a ham processor. Only
23919 provide them if Blackbox supports spam or ham processing.
23921 Also, ham and spam processors are being phased out as single
23922 variables. Instead the form @code{'(spam spam-use-blackbox)} or
23923 @code{'(ham spam-use-blackbox)} is favored. For now, spam/ham
23924 processor variables are still around but they won't be for long.
23927 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
23928 "The Blackbox summary exit spam processor.
23929 Only applicable to spam groups.")
23931 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
23932 "The whitelist summary exit ham processor.
23933 Only applicable to non-spam (unclassified and ham) groups.")
23942 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
23943 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
23945 to the @code{spam-process} group parameter in @code{gnus.el}. Make
23946 sure you do it twice, once for the parameter and once for the
23947 variable customization.
23951 (variable-item spam-use-blackbox)
23953 to the @code{spam-autodetect-methods} group parameter in
23954 @code{gnus.el} if Blackbox can check incoming mail for spam contents.
23956 Finally, use the appropriate @code{spam-install-*-backend} function in
23957 @code{spam.el}. Here are the available functions.
23963 @code{spam-install-backend-alias}
23965 This function will simply install an alias for a back end that does
23966 everything like the original back end. It is currently only used to
23967 make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}.
23970 @code{spam-install-nocheck-backend}
23972 This function installs a back end that has no check function, but can
23973 register/unregister ham or spam. The @code{spam-use-gmane} back end is
23977 @code{spam-install-checkonly-backend}
23979 This function will install a back end that can only check incoming mail
23980 for spam contents. It can't register or unregister messages.
23981 @code{spam-use-blackholes} and @code{spam-use-hashcash} are such
23985 @code{spam-install-statistical-checkonly-backend}
23987 This function installs a statistical back end (one which requires the
23988 full body of a message to check it) that can only check incoming mail
23989 for contents. @code{spam-use-regex-body} is such a filter.
23992 @code{spam-install-statistical-backend}
23994 This function install a statistical back end with incoming checks and
23995 registration/unregistration routines. @code{spam-use-bogofilter} is
23999 @code{spam-install-backend}
24001 This is the most normal back end installation, where a back end that can
24002 check and register/unregister messages is set up without statistical
24003 abilities. The @code{spam-use-BBDB} is such a back end.
24006 @code{spam-install-mover-backend}
24008 Mover back ends are internal to @code{spam.el} and specifically move
24009 articles around when the summary is exited. You will very probably
24010 never install such a back end.
24016 @node Filtering Spam Using Statistics with spam-stat
24017 @subsection Filtering Spam Using Statistics with spam-stat
24018 @cindex Paul Graham
24019 @cindex Graham, Paul
24020 @cindex naive Bayesian spam filtering
24021 @cindex Bayesian spam filtering, naive
24022 @cindex spam filtering, naive Bayesian
24024 Paul Graham has written an excellent essay about spam filtering using
24025 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
24026 Spam}. In it he describes the inherent deficiency of rule-based
24027 filtering as used by SpamAssassin, for example: Somebody has to write
24028 the rules, and everybody else has to install these rules. You are
24029 always late. It would be much better, he argues, to filter mail based
24030 on whether it somehow resembles spam or non-spam. One way to measure
24031 this is word distribution. He then goes on to describe a solution
24032 that checks whether a new mail resembles any of your other spam mails
24035 The basic idea is this: Create a two collections of your mail, one
24036 with spam, one with non-spam. Count how often each word appears in
24037 either collection, weight this by the total number of mails in the
24038 collections, and store this information in a dictionary. For every
24039 word in a new mail, determine its probability to belong to a spam or a
24040 non-spam mail. Use the 15 most conspicuous words, compute the total
24041 probability of the mail being spam. If this probability is higher
24042 than a certain threshold, the mail is considered to be spam.
24044 Gnus supports this kind of filtering. But it needs some setting up.
24045 First, you need two collections of your mail, one with spam, one with
24046 non-spam. Then you need to create a dictionary using these two
24047 collections, and save it. And last but not least, you need to use
24048 this dictionary in your fancy mail splitting rules.
24051 * Creating a spam-stat dictionary::
24052 * Splitting mail using spam-stat::
24053 * Low-level interface to the spam-stat dictionary::
24056 @node Creating a spam-stat dictionary
24057 @subsubsection Creating a spam-stat dictionary
24059 Before you can begin to filter spam based on statistics, you must
24060 create these statistics based on two mail collections, one with spam,
24061 one with non-spam. These statistics are then stored in a dictionary
24062 for later use. In order for these statistics to be meaningful, you
24063 need several hundred emails in both collections.
24065 Gnus currently supports only the nnml back end for automated dictionary
24066 creation. The nnml back end stores all mails in a directory, one file
24067 per mail. Use the following:
24069 @defun spam-stat-process-spam-directory
24070 Create spam statistics for every file in this directory. Every file
24071 is treated as one spam mail.
24074 @defun spam-stat-process-non-spam-directory
24075 Create non-spam statistics for every file in this directory. Every
24076 file is treated as one non-spam mail.
24079 Usually you would call @code{spam-stat-process-spam-directory} on a
24080 directory such as @file{~/Mail/mail/spam} (this usually corresponds
24081 the the group @samp{nnml:mail.spam}), and you would call
24082 @code{spam-stat-process-non-spam-directory} on a directory such as
24083 @file{~/Mail/mail/misc} (this usually corresponds the the group
24084 @samp{nnml:mail.misc}).
24086 When you are using @acronym{IMAP}, you won't have the mails available
24087 locally, so that will not work. One solution is to use the Gnus Agent
24088 to cache the articles. Then you can use directories such as
24089 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
24090 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
24093 This variable holds the hash-table with all the statistics---the
24094 dictionary we have been talking about. For every word in either
24095 collection, this hash-table stores a vector describing how often the
24096 word appeared in spam and often it appeared in non-spam mails.
24099 If you want to regenerate the statistics from scratch, you need to
24100 reset the dictionary.
24102 @defun spam-stat-reset
24103 Reset the @code{spam-stat} hash-table, deleting all the statistics.
24106 When you are done, you must save the dictionary. The dictionary may
24107 be rather large. If you will not update the dictionary incrementally
24108 (instead, you will recreate it once a month, for example), then you
24109 can reduce the size of the dictionary by deleting all words that did
24110 not appear often enough or that do not clearly belong to only spam or
24111 only non-spam mails.
24113 @defun spam-stat-reduce-size
24114 Reduce the size of the dictionary. Use this only if you do not want
24115 to update the dictionary incrementally.
24118 @defun spam-stat-save
24119 Save the dictionary.
24122 @defvar spam-stat-file
24123 The filename used to store the dictionary. This defaults to
24124 @file{~/.spam-stat.el}.
24127 @node Splitting mail using spam-stat
24128 @subsubsection Splitting mail using spam-stat
24130 In order to use @code{spam-stat} to split your mail, you need to add the
24131 following to your @file{~/.gnus.el} file:
24134 (require 'spam-stat)
24138 This will load the necessary Gnus code, and the dictionary you
24141 Next, you need to adapt your fancy splitting rules: You need to
24142 determine how to use @code{spam-stat}. The following examples are for
24143 the nnml back end. Using the nnimap back end works just as well. Just
24144 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
24146 In the simplest case, you only have two groups, @samp{mail.misc} and
24147 @samp{mail.spam}. The following expression says that mail is either
24148 spam or it should go into @samp{mail.misc}. If it is spam, then
24149 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
24152 (setq nnmail-split-fancy
24153 `(| (: spam-stat-split-fancy)
24157 @defvar spam-stat-split-fancy-spam-group
24158 The group to use for spam. Default is @samp{mail.spam}.
24161 If you also filter mail with specific subjects into other groups, use
24162 the following expression. Only mails not matching the regular
24163 expression are considered potential spam.
24166 (setq nnmail-split-fancy
24167 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
24168 (: spam-stat-split-fancy)
24172 If you want to filter for spam first, then you must be careful when
24173 creating the dictionary. Note that @code{spam-stat-split-fancy} must
24174 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
24175 non-spam, therefore both should be in your collection of non-spam
24176 mails, when creating the dictionary!
24179 (setq nnmail-split-fancy
24180 `(| (: spam-stat-split-fancy)
24181 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24185 You can combine this with traditional filtering. Here, we move all
24186 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
24187 @code{spam-stat-split-fancy} will never see them, the mails in
24188 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
24189 nor in your collection of non-spam mails, when creating the
24193 (setq nnmail-split-fancy
24194 `(| ("Content-Type" "text/html" "mail.spam.filtered")
24195 (: spam-stat-split-fancy)
24196 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24201 @node Low-level interface to the spam-stat dictionary
24202 @subsubsection Low-level interface to the spam-stat dictionary
24204 The main interface to using @code{spam-stat}, are the following functions:
24206 @defun spam-stat-buffer-is-spam
24207 Called in a buffer, that buffer is considered to be a new spam mail.
24208 Use this for new mail that has not been processed before.
24211 @defun spam-stat-buffer-is-no-spam
24212 Called in a buffer, that buffer is considered to be a new non-spam
24213 mail. Use this for new mail that has not been processed before.
24216 @defun spam-stat-buffer-change-to-spam
24217 Called in a buffer, that buffer is no longer considered to be normal
24218 mail but spam. Use this to change the status of a mail that has
24219 already been processed as non-spam.
24222 @defun spam-stat-buffer-change-to-non-spam
24223 Called in a buffer, that buffer is no longer considered to be spam but
24224 normal mail. Use this to change the status of a mail that has already
24225 been processed as spam.
24228 @defun spam-stat-save
24229 Save the hash table to the file. The filename used is stored in the
24230 variable @code{spam-stat-file}.
24233 @defun spam-stat-load
24234 Load the hash table from a file. The filename used is stored in the
24235 variable @code{spam-stat-file}.
24238 @defun spam-stat-score-word
24239 Return the spam score for a word.
24242 @defun spam-stat-score-buffer
24243 Return the spam score for a buffer.
24246 @defun spam-stat-split-fancy
24247 Use this function for fancy mail splitting. Add the rule @samp{(:
24248 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
24251 Make sure you load the dictionary before using it. This requires the
24252 following in your @file{~/.gnus.el} file:
24255 (require 'spam-stat)
24259 Typical test will involve calls to the following functions:
24262 Reset: (setq spam-stat (make-hash-table :test 'equal))
24263 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24264 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24265 Save table: (spam-stat-save)
24266 File size: (nth 7 (file-attributes spam-stat-file))
24267 Number of words: (hash-table-count spam-stat)
24268 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24269 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24270 Reduce table size: (spam-stat-reduce-size)
24271 Save table: (spam-stat-save)
24272 File size: (nth 7 (file-attributes spam-stat-file))
24273 Number of words: (hash-table-count spam-stat)
24274 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24275 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24278 Here is how you would create your dictionary:
24281 Reset: (setq spam-stat (make-hash-table :test 'equal))
24282 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24283 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24284 Repeat for any other non-spam group you need...
24285 Reduce table size: (spam-stat-reduce-size)
24286 Save table: (spam-stat-save)
24290 @section Interaction with other modes
24295 @code{gnus-dired-minor-mode} provided some useful functions for dired
24296 buffers. It is enabled with
24298 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
24303 @findex gnus-dired-attach
24304 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
24305 You will be prompted for a message buffer.
24308 @findex gnus-dired-find-file-mailcap
24309 Visit a file according to the appropriate mailcap entry
24310 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
24314 @findex gnus-dired-print
24315 Print file according to the mailcap entry (@code{gnus-dired-print}). If
24316 there is no print command, print in a PostScript image.
24319 @node Various Various
24320 @section Various Various
24326 @item gnus-home-directory
24327 @vindex gnus-home-directory
24328 All Gnus file and directory variables will be initialized from this
24329 variable, which defaults to @file{~/}.
24331 @item gnus-directory
24332 @vindex gnus-directory
24333 Most Gnus storage file and directory variables will be initialized from
24334 this variable, which defaults to the @env{SAVEDIR} environment
24335 variable, or @file{~/News/} if that variable isn't set.
24337 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
24338 This means that other directory variables that are initialized from this
24339 variable won't be set properly if you set this variable in
24340 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
24342 @item gnus-default-directory
24343 @vindex gnus-default-directory
24344 Not related to the above variable at all---this variable says what the
24345 default directory of all Gnus buffers should be. If you issue commands
24346 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
24347 default directory. If this variable is @code{nil} (which is the
24348 default), the default directory will be the default directory of the
24349 buffer you were in when you started Gnus.
24352 @vindex gnus-verbose
24353 This variable is an integer between zero and ten. The higher the value,
24354 the more messages will be displayed. If this variable is zero, Gnus
24355 will never flash any messages, if it is seven (which is the default),
24356 most important messages will be shown, and if it is ten, Gnus won't ever
24357 shut up, but will flash so many messages it will make your head swim.
24359 @item gnus-verbose-backends
24360 @vindex gnus-verbose-backends
24361 This variable works the same way as @code{gnus-verbose}, but it applies
24362 to the Gnus back ends instead of Gnus proper.
24364 @item nnheader-max-head-length
24365 @vindex nnheader-max-head-length
24366 When the back ends read straight heads of articles, they all try to read
24367 as little as possible. This variable (default 4096) specifies
24368 the absolute max length the back ends will try to read before giving up
24369 on finding a separator line between the head and the body. If this
24370 variable is @code{nil}, there is no upper read bound. If it is
24371 @code{t}, the back ends won't try to read the articles piece by piece,
24372 but read the entire articles. This makes sense with some versions of
24373 @code{ange-ftp} or @code{efs}.
24375 @item nnheader-head-chop-length
24376 @vindex nnheader-head-chop-length
24377 This variable (default 2048) says how big a piece of each article to
24378 read when doing the operation described above.
24380 @item nnheader-file-name-translation-alist
24381 @vindex nnheader-file-name-translation-alist
24383 @cindex invalid characters in file names
24384 @cindex characters in file names
24385 This is an alist that says how to translate characters in file names.
24386 For instance, if @samp{:} is invalid as a file character in file names
24387 on your system (you OS/2 user you), you could say something like:
24391 (setq nnheader-file-name-translation-alist
24396 In fact, this is the default value for this variable on OS/2 and MS
24397 Windows (phooey) systems.
24399 @item gnus-hidden-properties
24400 @vindex gnus-hidden-properties
24401 This is a list of properties to use to hide ``invisible'' text. It is
24402 @code{(invisible t intangible t)} by default on most systems, which
24403 makes invisible text invisible and intangible.
24405 @item gnus-parse-headers-hook
24406 @vindex gnus-parse-headers-hook
24407 A hook called before parsing headers. It can be used, for instance, to
24408 gather statistics on the headers fetched, or perhaps you'd like to prune
24409 some headers. I don't see why you'd want that, though.
24411 @item gnus-shell-command-separator
24412 @vindex gnus-shell-command-separator
24413 String used to separate two shell commands. The default is @samp{;}.
24415 @item gnus-invalid-group-regexp
24416 @vindex gnus-invalid-group-regexp
24418 Regexp to match ``invalid'' group names when querying user for a group
24419 name. The default value catches some @strong{really} invalid group
24420 names who could possibly mess up Gnus internally (like allowing
24421 @samp{:} in a group name, which is normally used to delimit method and
24424 @acronym{IMAP} users might want to allow @samp{/} in group names though.
24432 Well, that's the manual---you can get on with your life now. Keep in
24433 touch. Say hello to your cats from me.
24435 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
24437 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
24443 Not because of victories @*
24446 but for the common sunshine,@*
24448 the largess of the spring.
24452 but for the day's work done@*
24453 as well as I was able;@*
24454 not for a seat upon the dais@*
24455 but at the common table.@*
24460 @chapter Appendices
24463 * XEmacs:: Requirements for installing under XEmacs.
24464 * History:: How Gnus got where it is today.
24465 * On Writing Manuals:: Why this is not a beginner's guide.
24466 * Terminology:: We use really difficult, like, words here.
24467 * Customization:: Tailoring Gnus to your needs.
24468 * Troubleshooting:: What you might try if things do not work.
24469 * Gnus Reference Guide:: Rilly, rilly technical stuff.
24470 * Emacs for Heathens:: A short introduction to Emacsian terms.
24471 * Frequently Asked Questions:: The Gnus FAQ
24478 @cindex installing under XEmacs
24480 XEmacs is distributed as a collection of packages. You should install
24481 whatever packages the Gnus XEmacs package requires. The current
24482 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
24483 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
24484 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{w3},
24485 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
24492 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
24493 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
24495 If you want to investigate the person responsible for this outrage,
24496 you can point your (feh!) web browser to
24497 @uref{http://quimby.gnus.org/}. This is also the primary
24498 distribution point for the new and spiffy versions of Gnus, and is
24499 known as The Site That Destroys Newsrcs And Drives People Mad.
24501 During the first extended alpha period of development, the new Gnus was
24502 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
24503 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
24504 (Besides, the ``Gnus'' in this abbreviation should probably be
24505 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
24506 appropriate name, don't you think?)
24508 In any case, after spending all that energy on coming up with a new and
24509 spunky name, we decided that the name was @emph{too} spunky, so we
24510 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
24511 ``@sc{gnus}''. New vs. old.
24514 * Gnus Versions:: What Gnus versions have been released.
24515 * Other Gnus Versions:: Other Gnus versions that also have been released.
24516 * Why?:: What's the point of Gnus?
24517 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
24518 * Conformity:: Gnus tries to conform to all standards.
24519 * Emacsen:: Gnus can be run on a few modern Emacsen.
24520 * Gnus Development:: How Gnus is developed.
24521 * Contributors:: Oodles of people.
24522 * New Features:: Pointers to some of the new stuff in Gnus.
24526 @node Gnus Versions
24527 @subsection Gnus Versions
24529 @cindex September Gnus
24531 @cindex Quassia Gnus
24532 @cindex Pterodactyl Gnus
24535 @cindex Gnus versions
24537 The first ``proper'' release of Gnus 5 was done in November 1995 when it
24538 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
24539 plus 15 Gnus 5.0 releases).
24541 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
24542 releases)) was released under the name ``Gnus 5.2'' (40 releases).
24544 On July 28th 1996 work on Red Gnus was begun, and it was released on
24545 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
24547 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
24548 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
24550 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
24551 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
24554 On the 26th of October 2000, Oort Gnus was begun.
24556 If you happen upon a version of Gnus that has a prefixed name --
24557 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
24558 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
24559 that you're frightened. Back away. Slowly. Whatever you do, don't
24560 run. Walk away, calmly, until you're out of its reach. Find a proper
24561 released version of Gnus and snuggle up to that instead.
24564 @node Other Gnus Versions
24565 @subsection Other Gnus Versions
24568 In addition to the versions of Gnus which have had their releases
24569 coordinated by Lars, one major development has been Semi-gnus from
24570 Japan. It's based on a library called @acronym{SEMI}, which provides
24571 @acronym{MIME} capabilities.
24573 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
24574 Collectively, they are called ``Semi-gnus'', and different strains are
24575 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
24576 @acronym{MIME} and multilingualization things, especially important for
24583 What's the point of Gnus?
24585 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
24586 newsreader, that lets you do anything you can think of. That was my
24587 original motivation, but while working on Gnus, it has become clear to
24588 me that this generation of newsreaders really belong in the stone age.
24589 Newsreaders haven't developed much since the infancy of the net. If the
24590 volume continues to rise with the current rate of increase, all current
24591 newsreaders will be pretty much useless. How do you deal with
24592 newsgroups that have thousands of new articles each day? How do you
24593 keep track of millions of people who post?
24595 Gnus offers no real solutions to these questions, but I would very much
24596 like to see Gnus being used as a testing ground for new methods of
24597 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
24598 to separate the newsreader from the back ends, Gnus now offers a simple
24599 interface for anybody who wants to write new back ends for fetching mail
24600 and news from different sources. I have added hooks for customizations
24601 everywhere I could imagine it being useful. By doing so, I'm inviting
24602 every one of you to explore and invent.
24604 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
24605 @kbd{C-u 100 M-x all-hail-xemacs}.
24608 @node Compatibility
24609 @subsection Compatibility
24611 @cindex compatibility
24612 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
24613 bindings have been kept. More key bindings have been added, of course,
24614 but only in one or two obscure cases have old bindings been changed.
24619 @center In a cloud bones of steel.
24623 All commands have kept their names. Some internal functions have changed
24626 The @code{gnus-uu} package has changed drastically. @xref{Decoding
24629 One major compatibility question is the presence of several summary
24630 buffers. All variables relevant while reading a group are
24631 buffer-local to the summary buffer they belong in. Although many
24632 important variables have their values copied into their global
24633 counterparts whenever a command is executed in the summary buffer, this
24634 change might lead to incorrect values being used unless you are careful.
24636 All code that relies on knowledge of @sc{gnus} internals will probably
24637 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
24638 changing it in any way, as a matter of fact) is strictly verboten. Gnus
24639 maintains a hash table that points to the entries in this alist (which
24640 speeds up many functions), and changing the alist directly will lead to
24644 @cindex highlighting
24645 Old hilit19 code does not work at all. In fact, you should probably
24646 remove all hilit code from all Gnus hooks
24647 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
24648 Gnus provides various integrated functions for highlighting. These are
24649 faster and more accurate. To make life easier for everybody, Gnus will
24650 by default remove all hilit calls from all hilit hooks. Uncleanliness!
24653 Packages like @code{expire-kill} will no longer work. As a matter of
24654 fact, you should probably remove all old @sc{gnus} packages (and other
24655 code) when you start using Gnus. More likely than not, Gnus already
24656 does what you have written code to make @sc{gnus} do. (Snicker.)
24658 Even though old methods of doing things are still supported, only the
24659 new methods are documented in this manual. If you detect a new method of
24660 doing something while reading this manual, that does not mean you have
24661 to stop doing it the old way.
24663 Gnus understands all @sc{gnus} startup files.
24665 @kindex M-x gnus-bug
24667 @cindex reporting bugs
24669 Overall, a casual user who hasn't written much code that depends on
24670 @sc{gnus} internals should suffer no problems. If problems occur,
24671 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
24673 @vindex gnus-bug-create-help-buffer
24674 If you are in the habit of sending bug reports @emph{very} often, you
24675 may find the helpful help buffer annoying after a while. If so, set
24676 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
24681 @subsection Conformity
24683 No rebels without a clue here, ma'am. We conform to all standards known
24684 to (wo)man. Except for those standards and/or conventions we disagree
24692 There are no known breaches of this standard.
24696 There are no known breaches of this standard, either.
24698 @item Son-of-RFC 1036
24699 @cindex Son-of-RFC 1036
24700 We do have some breaches to this one.
24706 These are considered to be ``vanity headers'', while I consider them
24707 to be consumer information. After seeing so many badly formatted
24708 articles coming from @code{tin} and @code{Netscape} I know not to use
24709 either of those for posting articles. I would not have known that if
24710 it wasn't for the @code{X-Newsreader} header.
24715 USEFOR is an IETF working group writing a successor to RFC 1036, based
24716 on Son-of-RFC 1036. They have produced a number of drafts proposing
24717 various changes to the format of news articles. The Gnus towers will
24718 look into implementing the changes when the draft is accepted as an RFC.
24720 @item MIME - RFC 2045-2049 etc
24721 @cindex @acronym{MIME}
24722 All the various @acronym{MIME} RFCs are supported.
24724 @item Disposition Notifications - RFC 2298
24725 Message Mode is able to request notifications from the receiver.
24727 @item PGP - RFC 1991 and RFC 2440
24730 RFC 1991 is the original @acronym{PGP} message specification,
24731 published as an informational RFC. RFC 2440 was the follow-up, now
24732 called Open PGP, and put on the Standards Track. Both document a
24733 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
24734 encoding (signing and encryption) and decoding (verification and
24737 @item PGP/MIME - RFC 2015/3156
24738 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
24739 1991) describes the @acronym{MIME}-wrapping around the RF 1991/2440 format.
24740 Gnus supports both encoding and decoding.
24742 @item S/MIME - RFC 2633
24743 RFC 2633 describes the @acronym{S/MIME} format.
24745 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
24746 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
24747 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
24748 authentication for @acronym{IMAP}. RFC 2086 describes access control
24749 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
24750 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
24751 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
24752 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
24756 If you ever notice Gnus acting non-compliant with regards to the texts
24757 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
24762 @subsection Emacsen
24768 Gnus should work on:
24776 XEmacs 21.4 and up.
24780 This Gnus version will absolutely not work on any Emacsen older than
24781 that. Not reliably, at least. Older versions of Gnus may work on older
24782 Emacs versions. However, T-gnus does support ``Mule 2.3 based on Emacs
24783 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
24784 See the file ``README'' in the T-gnus distribution for more details.
24786 There are some vague differences between Gnus on the various
24787 platforms---XEmacs features more graphics (a logo and a toolbar)---but
24788 other than that, things should look pretty much the same under all
24792 @node Gnus Development
24793 @subsection Gnus Development
24795 Gnus is developed in a two-phased cycle. The first phase involves much
24796 discussion on the @samp{ding@@gnus.org} mailing list, where people
24797 propose changes and new features, post patches and new back ends. This
24798 phase is called the @dfn{alpha} phase, since the Gnusae released in this
24799 phase are @dfn{alpha releases}, or (perhaps more commonly in other
24800 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
24801 unstable and should not be used by casual users. Gnus alpha releases
24802 have names like ``Red Gnus'' and ``Quassia Gnus''.
24804 After futzing around for 50-100 alpha releases, Gnus is declared
24805 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
24806 and is called things like ``Gnus 5.6.32'' instead. Normal people are
24807 supposed to be able to use these, and these are mostly discussed on the
24808 @samp{gnu.emacs.gnus} newsgroup.
24811 @vindex mail-source-delete-incoming
24812 Some variable defaults differ between alpha Gnusae and released Gnusae.
24813 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
24814 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
24815 lossage of mail if an alpha release hiccups while handling the mail.
24817 The division of discussion between the ding mailing list and the Gnus
24818 newsgroup is not purely based on publicity concerns. It's true that
24819 having people write about the horrible things that an alpha Gnus release
24820 can do (sometimes) in a public forum may scare people off, but more
24821 importantly, talking about new experimental features that have been
24822 introduced may confuse casual users. New features are frequently
24823 introduced, fiddled with, and judged to be found wanting, and then
24824 either discarded or totally rewritten. People reading the mailing list
24825 usually keep up with these rapid changes, while people on the newsgroup
24826 can't be assumed to do so.
24831 @subsection Contributors
24832 @cindex contributors
24834 The new Gnus version couldn't have been done without the help of all the
24835 people on the (ding) mailing list. Every day for over a year I have
24836 gotten billions of nice bug reports from them, filling me with joy,
24837 every single one of them. Smooches. The people on the list have been
24838 tried beyond endurance, what with my ``oh, that's a neat idea <type
24839 type>, yup, I'll release it right away <ship off> no wait, that doesn't
24840 work at all <type type>, yup, I'll ship that one off right away <ship
24841 off> no, wait, that absolutely does not work'' policy for releases.
24842 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
24843 ``worser''? ``much worser''? ``worsest''?)
24845 I would like to take this opportunity to thank the Academy for@dots{} oops,
24851 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
24854 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
24855 nnwarchive and many, many other things connected with @acronym{MIME} and
24856 other types of en/decoding, as well as general bug fixing, new
24857 functionality and stuff.
24860 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
24861 well as numerous other things).
24864 Luis Fernandes---design and graphics.
24867 Joe Reiss---creator of the smiley faces.
24870 Justin Sheehy---the @acronym{FAQ} maintainer.
24873 Erik Naggum---help, ideas, support, code and stuff.
24876 Wes Hardaker---@file{gnus-picon.el} and the manual section on
24877 @dfn{picons} (@pxref{Picons}).
24880 Kim-Minh Kaplan---further work on the picon code.
24883 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
24886 Sudish Joseph---innumerable bug fixes.
24889 Ilja Weis---@file{gnus-topic.el}.
24892 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
24895 Vladimir Alexiev---the refcard and reference booklets.
24898 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
24899 distribution by Felix Lee and JWZ.
24902 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
24905 Peter Mutsaers---orphan article scoring code.
24908 Ken Raeburn---POP mail support.
24911 Hallvard B Furuseth---various bits and pieces, especially dealing with
24915 Brian Edmonds---@file{gnus-bbdb.el}.
24918 David Moore---rewrite of @file{nnvirtual.el} and many other things.
24921 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
24924 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
24925 well as autoconf support.
24929 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
24930 Borges, and Jost Krieger proof-reading parts of the manual.
24932 The following people have contributed many patches and suggestions:
24947 Jason L. Tibbitts, III,
24949 Katsumi Yamaoka, @c Yamaoka
24953 Also thanks to the following for patches and stuff:
24963 Alexei V. Barantsev,
24978 Massimo Campostrini,
24983 Jae-you Chung, @c ?
24984 James H. Cloos, Jr.,
24988 Andrew J. Cosgriff,
24991 Geoffrey T. Dairiki,
24997 Michael Welsh Duggan,
25002 Enami Tsugutomo, @c Enami
25006 Nelson Jose dos Santos Ferreira,
25014 Arne Georg Gleditsch,
25016 Michelangelo Grigni,
25020 Kenichi Handa, @c Handa
25022 Yoshiki Hayashi, @c Hayashi
25024 Hisashige Kenji, @c Hisashige
25031 Fran@,{c}ois Felix Ingrand,
25032 Tatsuya Ichikawa, @c Ichikawa
25033 Ishikawa Ichiro, @c Ishikawa
25035 Iwamuro Motonori, @c Iwamuro
25045 Peter Skov Knudsen,
25046 Shuhei Kobayashi, @c Kobayashi
25048 Koseki Yoshinori, @c Koseki
25049 Thor Kristoffersen,
25052 Seokchan Lee, @c Lee
25070 Morioka Tomohiko, @c Morioka
25071 Erik Toubro Nielsen,
25078 Masaharu Onishi, @c Onishi
25083 Jens-Ulrik Holger Petersen,
25087 John McClary Prevost,
25093 Lars Balker Rasmussen,
25098 Christian von Roques,
25101 Wolfgang Rupprecht,
25108 Philippe Schnoebelen,
25110 Randal L. Schwartz,
25124 Kiyokazu Suto, @c Suto
25129 Tozawa Akihiko, @c Tozawa
25149 For a full overview of what each person has done, the ChangeLogs
25150 included in the Gnus alpha distributions should give ample reading
25151 (550kB and counting).
25153 Apologies to everybody that I've forgotten, of which there are many, I'm
25156 Gee, that's quite a list of people. I guess that must mean that there
25157 actually are people who are using Gnus. Who'd'a thunk it!
25161 @subsection New Features
25162 @cindex new features
25165 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
25166 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
25167 * Red Gnus:: Third time best---Gnus 5.4/5.5.
25168 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
25169 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
25170 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
25171 * No Gnus:: Lars, FIXME!
25174 These lists are, of course, just @emph{short} overviews of the
25175 @emph{most} important new features. No, really. There are tons more.
25176 Yes, we have feeping creaturism in full effect.
25179 @subsubsection (ding) Gnus
25181 New features in Gnus 5.0/5.1:
25186 The look of all buffers can be changed by setting format-like variables
25187 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
25190 Local spool and several @acronym{NNTP} servers can be used at once
25191 (@pxref{Select Methods}).
25194 You can combine groups into virtual groups (@pxref{Virtual Groups}).
25197 You can read a number of different mail formats (@pxref{Getting Mail}).
25198 All the mail back ends implement a convenient mail expiry scheme
25199 (@pxref{Expiring Mail}).
25202 Gnus can use various strategies for gathering threads that have lost
25203 their roots (thereby gathering loose sub-threads into one thread) or it
25204 can go back and retrieve enough headers to build a complete thread
25205 (@pxref{Customizing Threading}).
25208 Killed groups can be displayed in the group buffer, and you can read
25209 them as well (@pxref{Listing Groups}).
25212 Gnus can do partial group updates---you do not have to retrieve the
25213 entire active file just to check for new articles in a few groups
25214 (@pxref{The Active File}).
25217 Gnus implements a sliding scale of subscribedness to groups
25218 (@pxref{Group Levels}).
25221 You can score articles according to any number of criteria
25222 (@pxref{Scoring}). You can even get Gnus to find out how to score
25223 articles for you (@pxref{Adaptive Scoring}).
25226 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
25227 manner, so it should be difficult to lose much data on what you have
25228 read if your machine should go down (@pxref{Auto Save}).
25231 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
25232 cluttering up the @file{.emacs} file.
25235 You can set the process mark on both groups and articles and perform
25236 operations on all the marked items (@pxref{Process/Prefix}).
25239 You can grep through a subset of groups and create a group from the
25240 results (@pxref{Kibozed Groups}).
25243 You can list subsets of groups according to, well, anything
25244 (@pxref{Listing Groups}).
25247 You can browse foreign servers and subscribe to groups from those
25248 servers (@pxref{Browse Foreign Server}).
25251 Gnus can fetch articles, asynchronously, on a second connection to the
25252 server (@pxref{Asynchronous Fetching}).
25255 You can cache articles locally (@pxref{Article Caching}).
25258 The uudecode functions have been expanded and generalized
25259 (@pxref{Decoding Articles}).
25262 You can still post uuencoded articles, which was a little-known feature
25263 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
25266 Fetching parents (and other articles) now actually works without
25267 glitches (@pxref{Finding the Parent}).
25270 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
25273 Digests (and other files) can be used as the basis for groups
25274 (@pxref{Document Groups}).
25277 Articles can be highlighted and customized (@pxref{Customizing
25281 URLs and other external references can be buttonized (@pxref{Article
25285 You can do lots of strange stuff with the Gnus window & frame
25286 configuration (@pxref{Window Layout}).
25289 You can click on buttons instead of using the keyboard
25295 @node September Gnus
25296 @subsubsection September Gnus
25300 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
25304 New features in Gnus 5.2/5.3:
25309 A new message composition mode is used. All old customization variables
25310 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
25314 Gnus is now able to generate @dfn{sparse} threads---threads where
25315 missing articles are represented by empty nodes (@pxref{Customizing
25319 (setq gnus-build-sparse-threads 'some)
25323 Outgoing articles are stored on a special archive server
25324 (@pxref{Archived Messages}).
25327 Partial thread regeneration now happens when articles are
25331 Gnus can make use of GroupLens predictions.
25334 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
25337 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
25340 (setq gnus-use-trees t)
25344 An @code{nn}-like pick-and-read minor mode is available for the summary
25345 buffers (@pxref{Pick and Read}).
25348 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
25352 In binary groups you can use a special binary minor mode (@pxref{Binary
25356 Groups can be grouped in a folding topic hierarchy (@pxref{Group
25360 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
25364 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
25367 Groups can now have a score, and bubbling based on entry frequency
25368 is possible (@pxref{Group Score}).
25371 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
25375 Groups can be process-marked, and commands can be performed on
25376 groups of groups (@pxref{Marking Groups}).
25379 Caching is possible in virtual groups.
25382 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
25383 news batches, ClariNet briefs collections, and just about everything
25384 else (@pxref{Document Groups}).
25387 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
25391 The Gnus cache is much faster.
25394 Groups can be sorted according to many criteria (@pxref{Sorting
25398 New group parameters have been introduced to set list-addresses and
25399 expiry times (@pxref{Group Parameters}).
25402 All formatting specs allow specifying faces to be used
25403 (@pxref{Formatting Fonts}).
25406 There are several more commands for setting/removing/acting on process
25407 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
25410 The summary buffer can be limited to show parts of the available
25411 articles based on a wide range of criteria. These commands have been
25412 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
25415 Articles can be made persistent with the @kbd{*} command
25416 (@pxref{Persistent Articles}).
25419 All functions for hiding article elements are now toggles.
25422 Article headers can be buttonized (@pxref{Article Washing}).
25425 All mail back ends support fetching articles by @code{Message-ID}.
25428 Duplicate mail can now be treated properly (@pxref{Duplicates}).
25431 All summary mode commands are available directly from the article
25432 buffer (@pxref{Article Keymap}).
25435 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
25439 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
25442 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
25447 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
25450 (setq gnus-use-nocem t)
25454 Groups can be made permanently visible (@pxref{Listing Groups}).
25457 (setq gnus-permanently-visible-groups "^nnml:")
25461 Many new hooks have been introduced to make customizing easier.
25464 Gnus respects the @code{Mail-Copies-To} header.
25467 Threads can be gathered by looking at the @code{References} header
25468 (@pxref{Customizing Threading}).
25471 (setq gnus-summary-thread-gathering-function
25472 'gnus-gather-threads-by-references)
25476 Read articles can be stored in a special backlog buffer to avoid
25477 refetching (@pxref{Article Backlog}).
25480 (setq gnus-keep-backlog 50)
25484 A clean copy of the current article is always stored in a separate
25485 buffer to allow easier treatment.
25488 Gnus can suggest where to save articles (@pxref{Saving Articles}).
25491 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
25495 (setq gnus-prompt-before-saving t)
25499 @code{gnus-uu} can view decoded files asynchronously while fetching
25500 articles (@pxref{Other Decode Variables}).
25503 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
25507 Filling in the article buffer now works properly on cited text
25508 (@pxref{Article Washing}).
25511 Hiding cited text adds buttons to toggle hiding, and how much
25512 cited text to hide is now customizable (@pxref{Article Hiding}).
25515 (setq gnus-cited-lines-visible 2)
25519 Boring headers can be hidden (@pxref{Article Hiding}).
25522 Default scoring values can now be set from the menu bar.
25525 Further syntax checking of outgoing articles have been added.
25531 @subsubsection Red Gnus
25533 New features in Gnus 5.4/5.5:
25537 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
25544 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
25547 Article prefetching functionality has been moved up into
25548 Gnus (@pxref{Asynchronous Fetching}).
25551 Scoring can now be performed with logical operators like @code{and},
25552 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
25556 Article washing status can be displayed in the
25557 article mode line (@pxref{Misc Article}).
25560 @file{gnus.el} has been split into many smaller files.
25563 Suppression of duplicate articles based on Message-ID can be done
25564 (@pxref{Duplicate Suppression}).
25567 (setq gnus-suppress-duplicates t)
25571 New variables for specifying what score and adapt files are to be
25572 considered home score and adapt files (@pxref{Home Score File}) have
25576 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
25577 Server Internals}).
25580 Groups can inherit group parameters from parent topics (@pxref{Topic
25584 Article editing has been revamped and is now actually usable.
25587 Signatures can be recognized in more intelligent fashions
25588 (@pxref{Article Signature}).
25591 Summary pick mode has been made to look more @code{nn}-like. Line
25592 numbers are displayed and the @kbd{.} command can be used to pick
25593 articles (@code{Pick and Read}).
25596 Commands for moving the @file{.newsrc.eld} from one server to
25597 another have been added (@pxref{Changing Servers}).
25600 There's a way now to specify that ``uninteresting'' fields be suppressed
25601 when generating lines in buffers (@pxref{Advanced Formatting}).
25604 Several commands in the group buffer can be undone with @kbd{C-M-_}
25608 Scoring can be done on words using the new score type @code{w}
25609 (@pxref{Score File Format}).
25612 Adaptive scoring can be done on a Subject word-by-word basis
25613 (@pxref{Adaptive Scoring}).
25616 (setq gnus-use-adaptive-scoring '(word))
25620 Scores can be decayed (@pxref{Score Decays}).
25623 (setq gnus-decay-scores t)
25627 Scoring can be performed using a regexp on the Date header. The Date is
25628 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
25631 A new command has been added to remove all data on articles from
25632 the native server (@pxref{Changing Servers}).
25635 A new command for reading collections of documents
25636 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
25637 (@pxref{Really Various Summary Commands}).
25640 Process mark sets can be pushed and popped (@pxref{Setting Process
25644 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
25645 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
25648 A new back end for reading searches from Web search engines
25649 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
25650 (@pxref{Web Searches}).
25653 Groups inside topics can now be sorted using the standard sorting
25654 functions, and each topic can be sorted independently (@pxref{Topic
25658 Subsets of the groups can be sorted independently (@code{Sorting
25662 Cached articles can be pulled into the groups (@pxref{Summary Generation
25666 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
25671 Score files are now applied in a more reliable order (@pxref{Score
25675 Reports on where mail messages end up can be generated (@pxref{Splitting
25679 More hooks and functions have been added to remove junk from incoming
25680 mail before saving the mail (@pxref{Washing Mail}).
25683 Emphasized text can be properly fontisized:
25689 @subsubsection Quassia Gnus
25691 New features in Gnus 5.6:
25696 New functionality for using Gnus as an offline newsreader has been
25697 added. A plethora of new commands and modes have been added.
25698 @xref{Gnus Unplugged}, for the full story.
25701 The @code{nndraft} back end has returned, but works differently than
25702 before. All Message buffers are now also articles in the @code{nndraft}
25703 group, which is created automatically.
25706 @code{gnus-alter-header-function} can now be used to alter header
25710 @code{gnus-summary-goto-article} now accept Message-ID's.
25713 A new Message command for deleting text in the body of a message
25714 outside the region: @kbd{C-c C-v}.
25717 You can now post to component group in @code{nnvirtual} groups with
25721 @code{nntp-rlogin-program}---new variable to ease customization.
25724 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
25725 re-highlighting of the article buffer.
25728 New element in @code{gnus-boring-article-headers}---@code{long-to}.
25731 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
25735 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
25736 @kbd{a} to add the score rule to the @file{all.SCORE} file.
25739 @code{gnus-simplify-subject-functions} variable to allow greater
25740 control over simplification.
25743 @kbd{A T}---new command for fetching the current thread.
25746 @kbd{/ T}---new command for including the current thread in the
25750 @kbd{M-RET} is a new Message command for breaking cited text.
25753 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
25756 The @code{custom-face-lookup} function has been removed.
25757 If you used this function in your initialization files, you must
25758 rewrite them to use @code{face-spec-set} instead.
25761 Canceling now uses the current select method. Symbolic prefix
25762 @kbd{a} forces normal posting method.
25765 New command to translate M******** sm*rtq**t*s into proper
25769 For easier debugging of @code{nntp}, you can set
25770 @code{nntp-record-commands} to a non-@code{nil} value.
25773 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
25774 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
25777 A command for editing group parameters from the summary buffer
25781 A history of where mails have been split is available.
25784 A new article date command has been added---@code{article-date-iso8601}.
25787 Subjects can be simplified when threading by setting
25788 @code{gnus-score-thread-simplify}.
25791 A new function for citing in Message has been
25792 added---@code{message-cite-original-without-signature}.
25795 @code{article-strip-all-blank-lines}---new article command.
25798 A new Message command to kill to the end of the article has
25802 A minimum adaptive score can be specified by using the
25803 @code{gnus-adaptive-word-minimum} variable.
25806 The ``lapsed date'' article header can be kept continually
25807 updated by the @code{gnus-start-date-timer} command.
25810 Web listserv archives can be read with the @code{nnlistserv} back end.
25813 Old dejanews archives can now be read by @code{nnweb}.
25817 @node Pterodactyl Gnus
25818 @subsubsection Pterodactyl Gnus
25820 New features in Gnus 5.8:
25825 The mail-fetching functions have changed. See the manual for the
25826 many details. In particular, all procmail fetching variables are gone.
25828 If you used procmail like in
25831 (setq nnmail-use-procmail t)
25832 (setq nnmail-spool-file 'procmail)
25833 (setq nnmail-procmail-directory "~/mail/incoming/")
25834 (setq nnmail-procmail-suffix "\\.in")
25837 this now has changed to
25841 '((directory :path "~/mail/incoming/"
25845 @xref{Mail Source Specifiers}.
25848 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
25849 Gnus, and adds a slew of new commands. See the manual for details.
25852 Gnus has also been multilingualized. This also affects too
25853 many parts of Gnus to summarize here, and adds many new variables.
25856 @code{gnus-auto-select-first} can now be a function to be
25857 called to position point.
25860 The user can now decide which extra headers should be included in
25861 summary buffers and @acronym{NOV} files.
25864 @code{gnus-article-display-hook} has been removed. Instead, a number
25865 of variables starting with @code{gnus-treat-} have been added.
25868 The Gnus posting styles have been redone again and now works in a
25869 subtly different manner.
25872 New web-based back ends have been added: @code{nnslashdot},
25873 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
25874 again, to keep up with ever-changing layouts.
25877 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
25882 @subsubsection Oort Gnus
25885 New features in Gnus 5.10:
25890 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
25891 (@code{gnus-article-reply-with-original}) only yank the text in the
25892 region if the region is active.
25895 @code{gnus-group-read-ephemeral-group} can be called interactively,
25899 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
25900 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
25903 The revised Gnus @acronym{FAQ} is included in the manual,
25904 @xref{Frequently Asked Questions}.
25907 Upgrading from previous (stable) version if you have used Oort.
25909 If you have tried Oort (the unstable Gnus branch leading to this
25910 release) but went back to a stable version, be careful when upgrading to
25911 this version. In particular, you will probably want to remove all
25912 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
25913 read from your @file{.newsrc.eld} instead of from the
25914 @file{.marks}/@file{.mrk} file where this release store flags. See a
25915 later entry for more information about marks. Note that downgrading
25916 isn't save in general.
25921 More buttons for URLs, mail addresses, Message-IDs, Info links, man
25922 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
25923 variables @code{gnus-button-@var{*}-level} can be used to control the
25924 appearance of all article buttons. @xref{Article Button Levels}.
25929 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
25930 bindings in dired buffers to send a file as an attachment, open a file
25931 using the appropriate mailcap entry, and print a file using the mailcap
25935 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
25938 Single-part yenc encoded attachments can be decoded.
25943 The picons code has been reimplemented to work in GNU Emacs---some of
25944 the previous options have been removed or renamed.
25946 Picons are small ``personal icons'' representing users, domain and
25947 newsgroups, which can be displayed in the Article buffer.
25951 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
25952 boundary line is drawn at the end of the headers.
25955 Retrieval of charters and control messages
25957 There are new commands for fetching newsgroup charters (@kbd{H c}) and
25958 control messages (@kbd{H C}).
25963 You can delay the sending of a message with @kbd{C-c C-j} in the Message
25964 buffer. The messages are delivered at specified time. This is useful
25965 for sending yourself reminders. @xref{Delayed Articles}.
25968 If @code{auto-compression-mode} is enabled, attachments are automatically
25969 decompressed when activated.
25972 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
25973 the nnml back end allows compressed message files.
25976 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
25979 The Summary Buffer uses an arrow in the fringe to indicate the current
25980 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
25983 Warn about email replies to news
25985 Do you often find yourself replying to news by email by mistake? Then
25986 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
25990 If the new option @code{gnus-summary-display-while-building} is
25991 non-@code{nil}, the summary buffer is shown and updated as it's being
25995 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
25996 opposed to old but unread messages).
25999 The new option @code{gnus-gcc-mark-as-read} automatically marks
26000 Gcc articles as read.
26003 The nndoc back end now supports mailman digests and exim bounces.
26006 Gnus supports RFC 2369 mailing list headers, and adds a number of
26007 related commands in mailing list groups. @xref{Mailing List}.
26010 The Date header can be displayed in a format that can be read aloud
26011 in English. @xref{Article Date}.
26014 The envelope sender address can be customized when using Sendmail.
26015 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
26018 diffs are automatically highlighted in groups matching
26019 @code{mm-uu-diff-groups-regexp}
26022 @acronym{TLS} wrapper shipped with Gnus
26024 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
26025 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
26026 @acronym{TLS}/@acronym{SSL} support via (external third party)
26027 @file{ssl.el} and OpenSSL still works.
26030 New @file{make.bat} for compiling and installing Gnus under MS Windows
26032 Use @file{make.bat} if you want to install Gnus under MS Windows, the
26033 first argument to the batch-program should be the directory where
26034 @file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want
26035 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
26036 the second parameter.
26038 @file{make.bat} has been rewritten from scratch, it now features
26039 automatic recognition of XEmacs and GNU Emacs, generates
26040 @file{gnus-load.el}, checks if errors occur while compilation and
26041 generation of info files and reports them at the end of the build
26042 process. It now uses @code{makeinfo} if it is available and falls
26043 back to @file{infohack.el} otherwise. @file{make.bat} should now
26044 install all files which are necessary to run Gnus and be generally a
26045 complete replacement for the @code{configure; make; make install}
26046 cycle used under Unix systems.
26048 The new @file{make.bat} makes @file{make-x.bat} superfluous, so it has
26052 Support for non-@acronym{ASCII} domain names
26054 Message supports non-@acronym{ASCII} domain names in From:, To: and
26055 Cc: and will query you whether to perform encoding when you try to
26056 send a message. The variable @code{message-use-idna} controls this.
26057 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
26058 and Cc: when you view a message. The variable @code{gnus-use-idna}
26062 Better handling of Microsoft citation styles
26064 Gnus now tries to recognize the mangled header block that some Microsoft
26065 mailers use to indicate that the rest of the message is a citation, even
26066 though it is not quoted in any way. The variable
26067 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
26071 @code{gnus-article-skip-boring}
26073 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
26074 not scroll down to show you a page that contains only boring text,
26075 which by default means cited text and signature. You can customize
26076 what is skippable using @code{gnus-article-boring-faces}.
26078 This feature is especially useful if you read many articles that
26079 consist of a little new content at the top with a long, untrimmed
26080 message cited below.
26083 The format spec @code{%C} for positioning point has changed to @code{%*}.
26086 The new variable @code{gnus-parameters} can be used to set group parameters.
26088 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
26089 the parameters in @file{~/.newsrc.eld}, but via this variable you can
26090 enjoy the powers of customize, and simplified backups since you set the
26091 variable in @file{~/.emacs} instead of @file{~/.newsrc.eld}. The
26092 variable maps regular expressions matching group names to group
26095 (setq gnus-parameters
26097 (gnus-show-threads nil)
26098 (gnus-use-scoring nil))
26099 ("^nnimap:\\(foo.bar\\)$"
26100 (to-group . "\\1"))))
26104 Smileys (@samp{:-)}, @samp{;-)} etc) are now iconized for Emacs too.
26106 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.emacs} to
26110 Gnus no longer generate the Sender: header automatically.
26112 Earlier it was generated iff the user configurable email address was
26113 different from the Gnus guessed default user address. As the guessing
26114 algorithm is rarely correct these days, and (more controversially) the
26115 only use of the Sender: header was to check if you are entitled to
26116 cancel/supersede news (which is now solved by Cancel Locks instead,
26117 see another entry), generation of the header has been disabled by
26118 default. See the variables @code{message-required-headers},
26119 @code{message-required-news-headers}, and
26120 @code{message-required-mail-headers}.
26123 Features from third party @file{message-utils.el} added to @file{message.el}.
26125 Message now asks if you wish to remove @samp{(was: <old subject>)} from
26126 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
26127 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
26128 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
26129 appropriate headers and a note in the body for cross-postings and
26130 followups (see the variables @code{message-cross-post-@var{*}}).
26133 References and X-Draft-Headers are no longer generated when you start
26134 composing messages and @code{message-generate-headers-first} is
26138 Improved anti-spam features.
26140 Gnus is now able to take out spam from your mail and news streams
26141 using a wide variety of programs and filter rules. Among the supported
26142 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
26143 for easy use of external packages such as SpamAssassin and Hashcash
26144 are also new. @xref{Thwarting Email Spam}.
26147 Easy inclusion of X-Faces headers.
26150 Face headers handling.
26153 In the summary buffer, the new command @kbd{/ N} inserts new messages
26154 and @kbd{/ o} inserts old messages.
26157 Gnus decodes morse encoded messages if you press @kbd{W m}.
26160 Unread count correct in nnimap groups.
26162 The estimated number of unread articles in the group buffer should now
26163 be correct for nnimap groups. This is achieved by calling
26164 @code{nnimap-fixup-unread-after-getting-new-news} from the
26165 @code{gnus-setup-news-hook} (called on startup) and
26166 @code{gnus-after-getting-new-news-hook}. (called after getting new
26167 mail). If you have modified those variables from the default, you may
26168 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
26169 you were happy with the estimate and want to save some (minimal) time
26170 when getting new mail, remove the function.
26173 Group Carbon Copy (GCC) quoting
26175 To support groups that contains SPC and other weird characters, groups
26176 are quoted before they are placed in the Gcc: header. This means
26177 variables such as @code{gnus-message-archive-group} should no longer
26178 contain quote characters to make groups containing SPC work. Also, if
26179 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
26180 into two groups) you must change it to return the list
26181 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
26182 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
26183 was incorrect earlier, it just didn't generate any problems since it
26184 was inserted directly.
26187 @file{~/News/overview/} not used.
26189 As a result of the following change, the @file{~/News/overview/}
26190 directory is not used any more. You can safely delete the entire
26196 The Gnus Agent has seen a major updated and is now enabled by default,
26197 and all nntp and nnimap servers from @code{gnus-select-method} and
26198 @code{gnus-secondary-select-method} are agentized by default. Earlier
26199 only the server in @code{gnus-select-method} was agentized by the
26200 default, and the agent was disabled by default. When the agent is
26201 enabled, headers are now also retrieved from the Agent cache instead
26202 of the back ends when possible. Earlier this only happened in the
26203 unplugged state. You can enroll or remove servers with @kbd{J a} and
26204 @kbd{J r} in the server buffer. Gnus will not download articles into
26205 the Agent cache, unless you instruct it to do so, though, by using
26206 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
26207 behaviour of having the Agent disabled with @code{(setq gnus-agent
26208 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
26209 is not needed any more.
26212 @code{gnus-summary-line-format}
26214 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
26215 %s\n}. Moreover @code{gnus-extra-headers},
26216 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
26217 changed their default so that the users name will be replaced by the
26218 recipient's name or the group name posting to for @acronym{NNTP}
26222 @file{deuglify.el} (@code{gnus-article-outlook-deuglify-article})
26224 A new file from Raymond Scholz @email{rscholz@@zonix.de} for deuglifying
26225 broken Outlook (Express) articles.
26228 @code{(require 'gnus-load)}
26230 If you use a stand-alone Gnus distribution, you'd better add
26231 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
26232 lisp directory into load-path.
26234 File @file{gnus-load.el} contains autoload commands, functions and variables,
26235 some of which may not be included in distributions of Emacsen.
26238 @code{gnus-slave-unplugged}
26240 A new command which starts Gnus offline in slave mode.
26243 @code{message-insinuate-rmail}
26245 Adding @code{(message-insinuate-rmail)} and @code{(setq
26246 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
26247 compose, reply and forward messages in message-mode, where you can
26248 enjoy the power of @acronym{MML}.
26251 @code{message-minibuffer-local-map}
26253 The line below enables BBDB in resending a message:
26255 (define-key message-minibuffer-local-map [(tab)]
26256 'bbdb-complete-name)
26260 Externalizing and deleting of attachments.
26262 If @code{gnus-gcc-externalize-attachments} or
26263 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
26264 local files as external parts.
26266 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
26267 on @acronym{MIME} buttons) saves a part and replaces the part with an
26268 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
26269 @acronym{MIME} buttons) removes a part. It works only on back ends
26270 that support editing.
26273 @code{gnus-default-charset}
26275 The default value is determined from the
26276 @code{current-language-environment} variable, instead of
26277 @code{iso-8859-1}. Also the @samp{.*} item in
26278 @code{gnus-group-charset-alist} is removed.
26281 @code{gnus-posting-styles}
26283 Add a new format of match like
26285 ((header "to" "larsi.*org")
26286 (Organization "Somewhere, Inc."))
26288 The old format like the lines below is obsolete, but still accepted.
26290 (header "to" "larsi.*org"
26291 (Organization "Somewhere, Inc."))
26295 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
26297 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
26298 added into these two variables. If you customized those, perhaps you
26299 need add those two headers too.
26302 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
26304 If one reads an article while plugged, and the article already exists
26305 in the Agent, it won't get downloaded once more. @code{(setq
26306 gnus-agent-cache nil)} reverts to the old behavior.
26309 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
26310 composing messages, it is enabled by @code{use-hard-newlines}.
26311 Decoding format=flowed was present but not documented in earlier
26315 Gnus supports the generation of RFC 2298 Disposition Notification requests.
26317 This is invoked with the @kbd{C-c M-n} key binding from message mode.
26320 Gnus supports Maildir groups.
26322 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
26325 Printing capabilities are enhanced.
26327 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
26328 Article buffers. Also, each individual @acronym{MIME} part can be
26329 printed using @kbd{p} on the @acronym{MIME} button.
26332 Message supports the Importance: (RFC 2156) header.
26334 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
26338 Gnus supports Cancel Locks in News.
26340 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
26341 used to determine if you wrote an article or not (for canceling and
26342 superseding). Gnus generates a random password string the first time
26343 you post a message, and saves it in your @file{~/.emacs} using the Custom
26344 system. While the variable is called @code{canlock-password}, it is not
26345 security sensitive data. Publishing your canlock string on the web
26346 will not allow anyone to be able to anything she could not already do.
26347 The behaviour can be changed by customizing @code{message-insert-canlock}.
26350 Gnus supports server-side mail filtering using Sieve.
26352 Sieve rules can be added as Group Parameters for groups, and the
26353 complete Sieve script is generated using @kbd{D g} from the Group
26354 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
26355 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
26356 manual @ref{Top, , Top, sieve, Emacs Sieve}.
26359 Extended format specs.
26361 Format spec @samp{%&user-date;} is added into
26362 @code{gnus-summary-line-format-alist}. Also, user defined extended
26363 format specs are supported. The extended format specs look like
26364 @samp{%u&foo;}, which invokes function
26365 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
26366 escape character, old user defined format @samp{%u&} is no longer supported.
26369 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
26371 It was aliased to @kbd{Y c}
26372 (@code{gnus-summary-insert-cached-articles}). The new function filters
26373 out other articles.
26375 @item Some limiting commands accept a @kbd{C-u} prefix to negate the match.
26377 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
26378 s}, @kbd{/ a}, and @kbd{/ x}
26379 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
26380 result will be to display all articles that do not match the expression.
26383 Group names are treated as UTF-8 by default.
26385 This is supposedly what USEFOR wanted to migrate to. See
26386 @code{gnus-group-name-charset-group-alist} and
26387 @code{gnus-group-name-charset-method-alist} for customization.
26390 The nnml and nnfolder back ends store marks for each groups.
26392 This makes it possible to take backup of nnml/nnfolder servers/groups
26393 separately of @file{~/.newsrc.eld}, while preserving marks. It also
26394 makes it possible to share articles and marks between users (without
26395 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
26396 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
26397 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
26398 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
26399 another machine, Gnus will automatically use the @file{.marks} or
26400 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
26401 The new server variables @code{nnml-marks-is-evil} and
26402 @code{nnfolder-marks-is-evil} can be used to disable this feature.
26405 The menu bar item (in Group and Summary buffer) named ``Misc'' has
26406 been renamed to ``Gnus''.
26409 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
26410 renamed to ``Attachments''. Note that this menu also contains security
26411 related stuff, like signing and encryption (@pxref{Security, Security,,
26412 message, Message Manual}).
26415 @code{gnus-group-charset-alist} and
26416 @code{gnus-group-ignored-charsets-alist}.
26418 The regexps in these variables are compared with full group names
26419 instead of real group names in 5.8. Users who customize these
26420 variables should change those regexps accordingly. For example:
26422 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
26426 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
26427 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
26429 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
26430 additional Lisp libraries. This add several menu items to the
26431 Attachments menu, and @kbd{C-c RET} key bindings, when composing
26432 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
26435 Gnus inlines external parts (message/external).
26438 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
26441 This change was made to avoid conflict with the standard binding of
26442 @code{back-to-indentation}, which is also useful in message mode.
26445 The default for @code{message-forward-show-mml} changed to symbol @code{best}.
26447 The behaviour for the @code{best} value is to show @acronym{MML} (i.e.,
26448 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
26449 used when forwarding signed or encrypted messages, as the conversion
26450 invalidate the digital signature.
26454 @subsubsection No Gnus
26457 New features in No Gnus:
26458 @c FIXME: Gnus 5.12?
26460 @include gnus-news.texi
26466 @section The Manual
26470 This manual was generated from a TeXinfo file and then run through
26471 either @code{texi2dvi}
26473 or my own home-brewed TeXinfo to \LaTeX\ transformer,
26474 and then run through @code{latex} and @code{dvips}
26476 to get what you hold in your hands now.
26478 The following conventions have been used:
26483 This is a @samp{string}
26486 This is a @kbd{keystroke}
26489 This is a @file{file}
26492 This is a @code{symbol}
26496 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
26500 (setq flargnoze "yes")
26503 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
26506 (setq flumphel 'yes)
26509 @samp{yes} and @code{yes} are two @emph{very} different things---don't
26510 ever get them confused.
26514 Of course, everything in this manual is of vital interest, so you should
26515 read it all. Several times. However, if you feel like skimming the
26516 manual, look for that gnu head you should see in the margin over
26517 there---it means that what's being discussed is of more importance than
26518 the rest of the stuff. (On the other hand, if everything is infinitely
26519 important, how can anything be more important than that? Just one more
26520 of the mysteries of this world, I guess.)
26526 @node On Writing Manuals
26527 @section On Writing Manuals
26529 I guess most manuals are written after-the-fact; documenting a program
26530 that's already there. This is not how this manual is written. When
26531 implementing something, I write the manual entry for that something
26532 straight away. I then see that it's difficult to explain the
26533 functionality, so I write how it's supposed to be, and then I change the
26534 implementation. Writing the documentation and writing the code goes
26537 This, of course, means that this manual has no, or little, flow. It
26538 documents absolutely everything in Gnus, but often not where you're
26539 looking for it. It is a reference manual, and not a guide to how to get
26542 That would be a totally different book, that should be written using the
26543 reference manual as source material. It would look quite differently.
26548 @section Terminology
26550 @cindex terminology
26555 This is what you are supposed to use this thing for---reading news.
26556 News is generally fetched from a nearby @acronym{NNTP} server, and is
26557 generally publicly available to everybody. If you post news, the entire
26558 world is likely to read just what you have written, and they'll all
26559 snigger mischievously. Behind your back.
26563 Everything that's delivered to you personally is mail. Some news/mail
26564 readers (like Gnus) blur the distinction between mail and news, but
26565 there is a difference. Mail is private. News is public. Mailing is
26566 not posting, and replying is not following up.
26570 Send a mail to the person who has written what you are reading.
26574 Post an article to the current newsgroup responding to the article you
26579 Gnus considers mail and news to be mostly the same, really. The only
26580 difference is how to access the actual articles. News articles are
26581 commonly fetched via the protocol @acronym{NNTP}, whereas mail
26582 messages could be read from a file on the local disk. The internal
26583 architecture of Gnus thus comprises a ``front end'' and a number of
26584 ``back ends''. Internally, when you enter a group (by hitting
26585 @key{RET}, say), you thereby invoke a function in the front end in
26586 Gnus. The front end then ``talks'' to a back end and says things like
26587 ``Give me the list of articles in the foo group'' or ``Show me article
26590 So a back end mainly defines either a protocol (the @code{nntp} back
26591 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
26592 accesses mail via @acronym{IMAP}) or a file format and directory
26593 layout (the @code{nnspool} back end accesses news via the common
26594 ``spool directory'' format, the @code{nnml} back end access mail via a
26595 file format and directory layout that's quite similar).
26597 Gnus does not handle the underlying media, so to speak---this is all
26598 done by the back ends. A back end is a collection of functions to
26599 access the articles.
26601 However, sometimes the term ``back end'' is also used where ``server''
26602 would have been more appropriate. And then there is the term ``select
26603 method'' which can mean either. The Gnus terminology can be quite
26608 Gnus will always use one method (and back end) as the @dfn{native}, or
26609 default, way of getting news.
26613 You can also have any number of foreign groups active at the same time.
26614 These are groups that use non-native non-secondary back ends for getting
26619 Secondary back ends are somewhere half-way between being native and being
26620 foreign, but they mostly act like they are native.
26624 A message that has been posted as news.
26627 @cindex mail message
26628 A message that has been mailed.
26632 A mail message or news article
26636 The top part of a message, where administrative information (etc.) is
26641 The rest of an article. Everything not in the head is in the
26646 A line from the head of an article.
26650 A collection of such lines, or a collection of heads. Or even a
26651 collection of @acronym{NOV} lines.
26653 @item @acronym{NOV}
26654 @cindex @acronym{NOV}
26655 When Gnus enters a group, it asks the back end for the headers of all
26656 unread articles in the group. Most servers support the News OverView
26657 format, which is more compact and much faster to read and parse than the
26658 normal @sc{head} format.
26662 Each group is subscribed at some @dfn{level} or other (1-9). The ones
26663 that have a lower level are ``more'' subscribed than the groups with a
26664 higher level. In fact, groups on levels 1-5 are considered
26665 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
26666 are @dfn{killed}. Commands for listing groups and scanning for new
26667 articles will all use the numeric prefix as @dfn{working level}.
26669 @item killed groups
26670 @cindex killed groups
26671 No information on killed groups is stored or updated, which makes killed
26672 groups much easier to handle than subscribed groups.
26674 @item zombie groups
26675 @cindex zombie groups
26676 Just like killed groups, only slightly less dead.
26679 @cindex active file
26680 The news server has to keep track of what articles it carries, and what
26681 groups exist. All this information in stored in the active file, which
26682 is rather large, as you might surmise.
26685 @cindex bogus groups
26686 A group that exists in the @file{.newsrc} file, but isn't known to the
26687 server (i.e., it isn't in the active file), is a @emph{bogus group}.
26688 This means that the group probably doesn't exist (any more).
26691 @cindex activating groups
26692 The act of asking the server for info on a group and computing the
26693 number of unread articles is called @dfn{activating the group}.
26694 Un-activated groups are listed with @samp{*} in the group buffer.
26698 A machine one can connect to and get news (or mail) from.
26700 @item select method
26701 @cindex select method
26702 A structure that specifies the back end, the server and the virtual
26705 @item virtual server
26706 @cindex virtual server
26707 A named select method. Since a select method defines all there is to
26708 know about connecting to a (physical) server, taking the thing as a
26709 whole is a virtual server.
26713 Taking a buffer and running it through a filter of some sort. The
26714 result will (more often than not) be cleaner and more pleasing than the
26717 @item ephemeral groups
26718 @cindex ephemeral groups
26719 @cindex temporary groups
26720 Most groups store data on what articles you have read. @dfn{Ephemeral}
26721 groups are groups that will have no data stored---when you exit the
26722 group, it'll disappear into the aether.
26725 @cindex solid groups
26726 This is the opposite of ephemeral groups. All groups listed in the
26727 group buffer are solid groups.
26729 @item sparse articles
26730 @cindex sparse articles
26731 These are article placeholders shown in the summary buffer when
26732 @code{gnus-build-sparse-threads} has been switched on.
26736 To put responses to articles directly after the articles they respond
26737 to---in a hierarchical fashion.
26741 @cindex thread root
26742 The first article in a thread is the root. It is the ancestor of all
26743 articles in the thread.
26747 An article that has responses.
26751 An article that responds to a different article---its parent.
26755 A collection of messages in one file. The most common digest format is
26756 specified by RFC 1153.
26759 @cindex splitting, terminolgy
26760 @cindex mail sorting
26761 @cindex mail filtering (splitting)
26762 The action of sorting your emails according to certain rules. Sometimes
26763 incorrectly called mail filtering.
26769 @node Customization
26770 @section Customization
26771 @cindex general customization
26773 All variables are properly documented elsewhere in this manual. This
26774 section is designed to give general pointers on how to customize Gnus
26775 for some quite common situations.
26778 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
26779 * Slow Terminal Connection:: You run a remote Emacs.
26780 * Little Disk Space:: You feel that having large setup files is icky.
26781 * Slow Machine:: You feel like buying a faster machine.
26785 @node Slow/Expensive Connection
26786 @subsection Slow/Expensive NNTP Connection
26788 If you run Emacs on a machine locally, and get your news from a machine
26789 over some very thin strings, you want to cut down on the amount of data
26790 Gnus has to get from the @acronym{NNTP} server.
26794 @item gnus-read-active-file
26795 Set this to @code{nil}, which will inhibit Gnus from requesting the
26796 entire active file from the server. This file is often v. large. You
26797 also have to set @code{gnus-check-new-newsgroups} and
26798 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
26799 doesn't suddenly decide to fetch the active file anyway.
26801 @item gnus-nov-is-evil
26802 This one has to be @code{nil}. If not, grabbing article headers from
26803 the @acronym{NNTP} server will not be very fast. Not all @acronym{NNTP} servers
26804 support @sc{xover}; Gnus will detect this by itself.
26808 @node Slow Terminal Connection
26809 @subsection Slow Terminal Connection
26811 Let's say you use your home computer for dialing up the system that runs
26812 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
26813 possible) the amount of data sent over the wires.
26817 @item gnus-auto-center-summary
26818 Set this to @code{nil} to inhibit Gnus from re-centering the summary
26819 buffer all the time. If it is @code{vertical}, do only vertical
26820 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
26821 horizontal and vertical recentering.
26823 @item gnus-visible-headers
26824 Cut down on the headers included in the articles to the
26825 minimum. You can, in fact, make do without them altogether---most of the
26826 useful data is in the summary buffer, anyway. Set this variable to
26827 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
26829 Set this hook to all the available hiding commands:
26831 (setq gnus-treat-hide-headers 'head
26832 gnus-treat-hide-signature t
26833 gnus-treat-hide-citation t)
26836 @item gnus-use-full-window
26837 By setting this to @code{nil}, you can make all the windows smaller.
26838 While this doesn't really cut down much generally, it means that you
26839 have to see smaller portions of articles before deciding that you didn't
26840 want to read them anyway.
26842 @item gnus-thread-hide-subtree
26843 If this is non-@code{nil}, all threads in the summary buffer will be
26847 @item gnus-updated-mode-lines
26848 If this is @code{nil}, Gnus will not put information in the buffer mode
26849 lines, which might save some time.
26853 @node Little Disk Space
26854 @subsection Little Disk Space
26857 The startup files can get rather large, so you may want to cut their
26858 sizes a bit if you are running out of space.
26862 @item gnus-save-newsrc-file
26863 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
26864 only save @file{.newsrc.eld}. This means that you will not be able to
26865 use any other newsreaders than Gnus. This variable is @code{t} by
26868 @item gnus-read-newsrc-file
26869 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
26870 only read @file{.newsrc.eld}. This means that you will not be able to
26871 use any other newsreaders than Gnus. This variable is @code{t} by
26874 @item gnus-save-killed-list
26875 If this is @code{nil}, Gnus will not save the list of dead groups. You
26876 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
26877 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
26878 variable to @code{nil}. This variable is @code{t} by default.
26884 @subsection Slow Machine
26885 @cindex slow machine
26887 If you have a slow machine, or are just really impatient, there are a
26888 few things you can do to make Gnus run faster.
26890 Set @code{gnus-check-new-newsgroups} and
26891 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
26893 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
26894 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
26895 summary buffer faster.
26899 @node Troubleshooting
26900 @section Troubleshooting
26901 @cindex troubleshooting
26903 Gnus works @emph{so} well straight out of the box---I can't imagine any
26911 Make sure your computer is switched on.
26914 Make sure that you really load the current Gnus version. If you have
26915 been running @sc{gnus}, you need to exit Emacs and start it up again before
26919 Try doing an @kbd{M-x gnus-version}. If you get something that looks
26920 like @samp{T-gnus 6.17.* (based on Gnus v5.10.*; for SEMI 1.1*, FLIM
26921 1.1*)} you have the right files loaded. Otherwise you have some old
26922 @file{.el} files lying around. Delete these.
26925 Read the help group (@kbd{G h} in the group buffer) for a
26926 @acronym{FAQ} and a how-to.
26929 @vindex max-lisp-eval-depth
26930 Gnus works on many recursive structures, and in some extreme (and very
26931 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
26932 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
26933 something like that.
26936 If all else fails, report the problem as a bug.
26939 @cindex reporting bugs
26941 @kindex M-x gnus-bug
26943 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
26944 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
26945 me the backtrace. I will fix bugs, but I can only fix them if you send
26946 me a precise description as to how to reproduce the bug.
26948 You really can never be too detailed in a bug report. Always use the
26949 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
26950 a 10Kb mail each time you use it, and even if you have sent me your
26951 environment 500 times before. I don't care. I want the full info each
26954 It is also important to remember that I have no memory whatsoever. If
26955 you send a bug report, and I send you a reply, and then you just send
26956 back ``No, it's not! Moron!'', I will have no idea what you are
26957 insulting me about. Always over-explain everything. It's much easier
26958 for all of us---if I don't have all the information I need, I will just
26959 mail you and ask for more info, and everything takes more time.
26961 If the problem you're seeing is very visual, and you can't quite explain
26962 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
26963 it somewhere it can be reached, and include the URL of the picture in
26967 If you would like to contribute a patch to fix bugs or make
26968 improvements, please produce the patch using @samp{diff -u}.
26971 If you want to debug your problem further before reporting, possibly
26972 in order to solve the problem yourself and send a patch, you can use
26973 edebug. Debugging Lisp code is documented in the Elisp manual
26974 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
26975 Lisp Reference Manual}). To get you started with edebug, consider if
26976 you discover some weird behaviour when pressing @kbd{c}, the first
26977 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
26978 the documentation buffer that leads you to the function definition,
26979 then press @kbd{M-x edebug-defun RET} with point inside that function,
26980 return to Gnus and press @kbd{c} to invoke the code. You will be
26981 placed in the lisp buffer and can single step using @kbd{SPC} and
26982 evaluate expressions using @kbd{M-:} or inspect variables using
26983 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
26984 @kbd{c} or @kbd{g}.
26989 Sometimes, a problem do not directly generate an elisp error but
26990 manifests itself by causing Gnus to be very slow. In these cases, you
26991 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
26992 slow, and then try to analyze the backtrace (repeating the procedure
26993 helps isolating the real problem areas).
26995 A fancier approach is to use the elisp profiler, ELP. The profiler is
26996 (or should be) fully documented elsewhere, but to get you started
26997 there are a few steps that need to be followed. First, instrument the
26998 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
26999 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
27000 RET message}. Then perform the operation that is slow and press
27001 @kbd{M-x elp-results}. You will then see which operations that takes
27002 time, and can debug them further. If the entire operation takes much
27003 longer than the time spent in the slowest function in the profiler
27004 output, you probably profiled the wrong part of Gnus. To reset
27005 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
27006 elp-restore-all} is supposed to remove profiling, but given the
27007 complexities and dynamic code generation in Gnus, it might not always
27010 @cindex gnu.emacs.gnus
27011 @cindex ding mailing list
27012 If you just need help, you are better off asking on
27013 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
27014 @email{ding@@gnus.org, the ding mailing list}. Write to
27015 @email{ding-request@@gnus.org} to subscribe.
27019 @node Gnus Reference Guide
27020 @section Gnus Reference Guide
27022 It is my hope that other people will figure out smart stuff that Gnus
27023 can do, and that other people will write those smart things as well. To
27024 facilitate that I thought it would be a good idea to describe the inner
27025 workings of Gnus. And some of the not-so-inner workings, while I'm at
27028 You can never expect the internals of a program not to change, but I
27029 will be defining (in some details) the interface between Gnus and its
27030 back ends (this is written in stone), the format of the score files
27031 (ditto), data structures (some are less likely to change than others)
27032 and general methods of operation.
27035 * Gnus Utility Functions:: Common functions and variable to use.
27036 * Back End Interface:: How Gnus communicates with the servers.
27037 * Score File Syntax:: A BNF definition of the score file standard.
27038 * Headers:: How Gnus stores headers internally.
27039 * Ranges:: A handy format for storing mucho numbers.
27040 * Group Info:: The group info format.
27041 * Extended Interactive:: Symbolic prefixes and stuff.
27042 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
27043 * Various File Formats:: Formats of files that Gnus use.
27047 @node Gnus Utility Functions
27048 @subsection Gnus Utility Functions
27049 @cindex Gnus utility functions
27050 @cindex utility functions
27052 @cindex internal variables
27054 When writing small functions to be run from hooks (and stuff), it's
27055 vital to have access to the Gnus internal functions and variables.
27056 Below is a list of the most common ones.
27060 @item gnus-newsgroup-name
27061 @vindex gnus-newsgroup-name
27062 This variable holds the name of the current newsgroup.
27064 @item gnus-find-method-for-group
27065 @findex gnus-find-method-for-group
27066 A function that returns the select method for @var{group}.
27068 @item gnus-group-real-name
27069 @findex gnus-group-real-name
27070 Takes a full (prefixed) Gnus group name, and returns the unprefixed
27073 @item gnus-group-prefixed-name
27074 @findex gnus-group-prefixed-name
27075 Takes an unprefixed group name and a select method, and returns the full
27076 (prefixed) Gnus group name.
27078 @item gnus-get-info
27079 @findex gnus-get-info
27080 Returns the group info list for @var{group}.
27082 @item gnus-group-unread
27083 @findex gnus-group-unread
27084 The number of unread articles in @var{group}, or @code{t} if that is
27088 @findex gnus-active
27089 The active entry for @var{group}.
27091 @item gnus-set-active
27092 @findex gnus-set-active
27093 Set the active entry for @var{group}.
27095 @item gnus-add-current-to-buffer-list
27096 @findex gnus-add-current-to-buffer-list
27097 Adds the current buffer to the list of buffers to be killed on Gnus
27100 @item gnus-continuum-version
27101 @findex gnus-continuum-version
27102 Takes a Gnus version string as a parameter and returns a floating point
27103 number. Earlier versions will always get a lower number than later
27106 @item gnus-group-read-only-p
27107 @findex gnus-group-read-only-p
27108 Says whether @var{group} is read-only or not.
27110 @item gnus-news-group-p
27111 @findex gnus-news-group-p
27112 Says whether @var{group} came from a news back end.
27114 @item gnus-ephemeral-group-p
27115 @findex gnus-ephemeral-group-p
27116 Says whether @var{group} is ephemeral or not.
27118 @item gnus-server-to-method
27119 @findex gnus-server-to-method
27120 Returns the select method corresponding to @var{server}.
27122 @item gnus-server-equal
27123 @findex gnus-server-equal
27124 Says whether two virtual servers are equal.
27126 @item gnus-group-native-p
27127 @findex gnus-group-native-p
27128 Says whether @var{group} is native or not.
27130 @item gnus-group-secondary-p
27131 @findex gnus-group-secondary-p
27132 Says whether @var{group} is secondary or not.
27134 @item gnus-group-foreign-p
27135 @findex gnus-group-foreign-p
27136 Says whether @var{group} is foreign or not.
27138 @item gnus-group-find-parameter
27139 @findex gnus-group-find-parameter
27140 Returns the parameter list of @var{group}. If given a second parameter,
27141 returns the value of that parameter for @var{group}.
27143 @item gnus-group-set-parameter
27144 @findex gnus-group-set-parameter
27145 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
27147 @item gnus-narrow-to-body
27148 @findex gnus-narrow-to-body
27149 Narrows the current buffer to the body of the article.
27151 @item gnus-check-backend-function
27152 @findex gnus-check-backend-function
27153 Takes two parameters, @var{function} and @var{group}. If the back end
27154 @var{group} comes from supports @var{function}, return non-@code{nil}.
27157 (gnus-check-backend-function "request-scan" "nnml:misc")
27161 @item gnus-read-method
27162 @findex gnus-read-method
27163 Prompts the user for a select method.
27168 @node Back End Interface
27169 @subsection Back End Interface
27171 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
27172 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
27173 server is a @dfn{back end} and some @dfn{back end variables}. As examples
27174 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
27175 examples of the latter we have @code{nntp-port-number} and
27176 @code{nnmbox-directory}.
27178 When Gnus asks for information from a back end---say @code{nntp}---on
27179 something, it will normally include a virtual server name in the
27180 function parameters. (If not, the back end should use the ``current''
27181 virtual server.) For instance, @code{nntp-request-list} takes a virtual
27182 server as its only (optional) parameter. If this virtual server hasn't
27183 been opened, the function should fail.
27185 Note that a virtual server name has no relation to some physical server
27186 name. Take this example:
27190 (nntp-address "ifi.uio.no")
27191 (nntp-port-number 4324))
27194 Here the virtual server name is @samp{odd-one} while the name of
27195 the physical server is @samp{ifi.uio.no}.
27197 The back ends should be able to switch between several virtual servers.
27198 The standard back ends implement this by keeping an alist of virtual
27199 server environments that they pull down/push up when needed.
27201 There are two groups of interface functions: @dfn{required functions},
27202 which must be present, and @dfn{optional functions}, which Gnus will
27203 always check for presence before attempting to call 'em.
27205 All these functions are expected to return data in the buffer
27206 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
27207 unfortunately named, but we'll have to live with it. When I talk about
27208 @dfn{resulting data}, I always refer to the data in that buffer. When I
27209 talk about @dfn{return value}, I talk about the function value returned by
27210 the function call. Functions that fail should return @code{nil} as the
27213 Some back ends could be said to be @dfn{server-forming} back ends, and
27214 some might be said not to be. The latter are back ends that generally
27215 only operate on one group at a time, and have no concept of ``server''
27216 ---they have a group, and they deliver info on that group and nothing
27219 Gnus identifies each message by way of group name and article number. A
27220 few remarks about these article numbers might be useful. First of all,
27221 the numbers are positive integers. Secondly, it is normally not
27222 possible for later articles to ``re-use'' older article numbers without
27223 confusing Gnus. That is, if a group has ever contained a message
27224 numbered 42, then no other message may get that number, or Gnus will get
27225 mightily confused.@footnote{See the function
27226 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
27227 Third, article numbers must be assigned in order of arrival in the
27228 group; this is not necessarily the same as the date of the message.
27230 The previous paragraph already mentions all the ``hard'' restrictions that
27231 article numbers must fulfill. But it seems that it might be useful to
27232 assign @emph{consecutive} article numbers, for Gnus gets quite confused
27233 if there are holes in the article numbering sequence. However, due to
27234 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
27235 also useful for the article numbers to start at 1 to avoid running out
27236 of numbers as long as possible.
27238 Note that by convention, back ends are named @code{nnsomething}, but
27239 Gnus also comes with some @code{nnnotbackends}, such as
27240 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
27242 In the examples and definitions I will refer to the imaginary back end
27245 @cindex @code{nnchoke}
27248 * Required Back End Functions:: Functions that must be implemented.
27249 * Optional Back End Functions:: Functions that need not be implemented.
27250 * Error Messaging:: How to get messages and report errors.
27251 * Writing New Back Ends:: Extending old back ends.
27252 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
27253 * Mail-like Back Ends:: Some tips on mail back ends.
27257 @node Required Back End Functions
27258 @subsubsection Required Back End Functions
27262 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
27264 @var{articles} is either a range of article numbers or a list of
27265 @code{Message-ID}s. Current back ends do not fully support either---only
27266 sequences (lists) of article numbers, and most back ends do not support
27267 retrieval of @code{Message-ID}s. But they should try for both.
27269 The result data should either be HEADs or @acronym{NOV} lines, and the result
27270 value should either be @code{headers} or @code{nov} to reflect this.
27271 This might later be expanded to @code{various}, which will be a mixture
27272 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
27274 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
27275 headers'', in some meaning of the word. This is generally done by
27276 fetching (at most) @var{fetch-old} extra headers less than the smallest
27277 article number in @code{articles}, and filling the gaps as well. The
27278 presence of this parameter can be ignored if the back end finds it
27279 cumbersome to follow the request. If this is non-@code{nil} and not a
27280 number, do maximum fetches.
27282 Here's an example HEAD:
27285 221 1056 Article retrieved.
27286 Path: ifi.uio.no!sturles
27287 From: sturles@@ifi.uio.no (Sturle Sunde)
27288 Newsgroups: ifi.discussion
27289 Subject: Re: Something very droll
27290 Date: 27 Oct 1994 14:02:57 +0100
27291 Organization: Dept. of Informatics, University of Oslo, Norway
27293 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
27294 References: <38jdmq$4qu@@visbur.ifi.uio.no>
27295 NNTP-Posting-Host: holmenkollen.ifi.uio.no
27299 So a @code{headers} return value would imply that there's a number of
27300 these in the data buffer.
27302 Here's a BNF definition of such a buffer:
27306 head = error / valid-head
27307 error-message = [ "4" / "5" ] 2number " " <error message> eol
27308 valid-head = valid-message *header "." eol
27309 valid-message = "221 " <number> " Article retrieved." eol
27310 header = <text> eol
27314 (The version of BNF used here is the one used in RFC822.)
27316 If the return value is @code{nov}, the data buffer should contain
27317 @dfn{network overview database} lines. These are basically fields
27321 nov-buffer = *nov-line
27322 nov-line = field 7*8[ <TAB> field ] eol
27323 field = <text except TAB>
27326 For a closer look at what should be in those fields,
27330 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
27332 @var{server} is here the virtual server name. @var{definitions} is a
27333 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
27335 If the server can't be opened, no error should be signaled. The back end
27336 may then choose to refuse further attempts at connecting to this
27337 server. In fact, it should do so.
27339 If the server is opened already, this function should return a
27340 non-@code{nil} value. There should be no data returned.
27343 @item (nnchoke-close-server &optional SERVER)
27345 Close connection to @var{server} and free all resources connected
27346 to it. Return @code{nil} if the server couldn't be closed for some
27349 There should be no data returned.
27352 @item (nnchoke-request-close)
27354 Close connection to all servers and free all resources that the back end
27355 have reserved. All buffers that have been created by that back end
27356 should be killed. (Not the @code{nntp-server-buffer}, though.) This
27357 function is generally only called when Gnus is shutting down.
27359 There should be no data returned.
27362 @item (nnchoke-server-opened &optional SERVER)
27364 If @var{server} is the current virtual server, and the connection to the
27365 physical server is alive, then this function should return a
27366 non-@code{nil} value. This function should under no circumstances
27367 attempt to reconnect to a server we have lost connection to.
27369 There should be no data returned.
27372 @item (nnchoke-status-message &optional SERVER)
27374 This function should return the last error message from @var{server}.
27376 There should be no data returned.
27379 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
27381 The result data from this function should be the article specified by
27382 @var{article}. This might either be a @code{Message-ID} or a number.
27383 It is optional whether to implement retrieval by @code{Message-ID}, but
27384 it would be nice if that were possible.
27386 If @var{to-buffer} is non-@code{nil}, the result data should be returned
27387 in this buffer instead of the normal data buffer. This is to make it
27388 possible to avoid copying large amounts of data from one buffer to
27389 another, while Gnus mainly requests articles to be inserted directly
27390 into its article buffer.
27392 If it is at all possible, this function should return a cons cell where
27393 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
27394 the article number. This will enable Gnus to find out what the real
27395 group and article numbers are when fetching articles by
27396 @code{Message-ID}. If this isn't possible, @code{t} should be returned
27397 on successful article retrieval.
27400 @item (nnchoke-request-group GROUP &optional SERVER FAST)
27402 Get data on @var{group}. This function also has the side effect of
27403 making @var{group} the current group.
27405 If @var{fast}, don't bother to return useful data, just make @var{group}
27408 Here's an example of some result data and a definition of the same:
27411 211 56 1000 1059 ifi.discussion
27414 The first number is the status, which should be 211. Next is the
27415 total number of articles in the group, the lowest article number, the
27416 highest article number, and finally the group name. Note that the total
27417 number of articles may be less than one might think while just
27418 considering the highest and lowest article numbers, but some articles
27419 may have been canceled. Gnus just discards the total-number, so
27420 whether one should take the bother to generate it properly (if that is a
27421 problem) is left as an exercise to the reader. If the group contains no
27422 articles, the lowest article number should be reported as 1 and the
27426 group-status = [ error / info ] eol
27427 error = [ "4" / "5" ] 2<number> " " <Error message>
27428 info = "211 " 3* [ <number> " " ] <string>
27432 @item (nnchoke-close-group GROUP &optional SERVER)
27434 Close @var{group} and free any resources connected to it. This will be
27435 a no-op on most back ends.
27437 There should be no data returned.
27440 @item (nnchoke-request-list &optional SERVER)
27442 Return a list of all groups available on @var{server}. And that means
27445 Here's an example from a server that only carries two groups:
27448 ifi.test 0000002200 0000002000 y
27449 ifi.discussion 3324 3300 n
27452 On each line we have a group name, then the highest article number in
27453 that group, the lowest article number, and finally a flag. If the group
27454 contains no articles, the lowest article number should be reported as 1
27455 and the highest as 0.
27458 active-file = *active-line
27459 active-line = name " " <number> " " <number> " " flags eol
27461 flags = "n" / "y" / "m" / "x" / "j" / "=" name
27464 The flag says whether the group is read-only (@samp{n}), is moderated
27465 (@samp{m}), is dead (@samp{x}), is aliased to some other group
27466 (@samp{=other-group}) or none of the above (@samp{y}).
27469 @item (nnchoke-request-post &optional SERVER)
27471 This function should post the current buffer. It might return whether
27472 the posting was successful or not, but that's not required. If, for
27473 instance, the posting is done asynchronously, it has generally not been
27474 completed by the time this function concludes. In that case, this
27475 function should set up some kind of sentinel to beep the user loud and
27476 clear if the posting could not be completed.
27478 There should be no result data from this function.
27483 @node Optional Back End Functions
27484 @subsubsection Optional Back End Functions
27488 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
27490 @var{groups} is a list of groups, and this function should request data
27491 on all those groups. How it does it is of no concern to Gnus, but it
27492 should attempt to do this in a speedy fashion.
27494 The return value of this function can be either @code{active} or
27495 @code{group}, which says what the format of the result data is. The
27496 former is in the same format as the data from
27497 @code{nnchoke-request-list}, while the latter is a buffer full of lines
27498 in the same format as @code{nnchoke-request-group} gives.
27501 group-buffer = *active-line / *group-status
27505 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
27507 A Gnus group info (@pxref{Group Info}) is handed to the back end for
27508 alterations. This comes in handy if the back end really carries all
27509 the information (as is the case with virtual and imap groups). This
27510 function should destructively alter the info to suit its needs, and
27511 should return a non-@code{nil} value.
27513 There should be no result data from this function.
27516 @item (nnchoke-request-type GROUP &optional ARTICLE)
27518 When the user issues commands for ``sending news'' (@kbd{F} in the
27519 summary buffer, for instance), Gnus has to know whether the article the
27520 user is following up on is news or mail. This function should return
27521 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
27522 is mail and @code{unknown} if the type can't be decided. (The
27523 @var{article} parameter is necessary in @code{nnvirtual} groups which
27524 might very well combine mail groups and news groups.) Both @var{group}
27525 and @var{article} may be @code{nil}.
27527 There should be no result data from this function.
27530 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
27532 Set/remove/add marks on articles. Normally Gnus handles the article
27533 marks (such as read, ticked, expired etc) internally, and store them in
27534 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
27535 all information about the articles on the server, so Gnus need to
27536 propagate the mark information to the server.
27538 @var{action} is a list of mark setting requests, having this format:
27541 (RANGE ACTION MARK)
27544 @var{range} is a range of articles you wish to update marks on.
27545 @var{action} is @code{add} or @code{del}, used to add marks or remove
27546 marks (preserving all marks not mentioned). @var{mark} is a list of
27547 marks; where each mark is a symbol. Currently used marks are
27548 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
27549 @code{dormant}, @code{save}, @code{download}, @code{unsend},
27550 @code{forward} and @code{recent}, but your back end should, if
27551 possible, not limit itself to these.
27553 Given contradictory actions, the last action in the list should be the
27554 effective one. That is, if your action contains a request to add the
27555 @code{tick} mark on article 1 and, later in the list, a request to
27556 remove the mark on the same article, the mark should in fact be removed.
27558 An example action list:
27561 (((5 12 30) 'del '(tick))
27562 ((10 . 90) 'add '(read expire))
27563 ((92 94) 'del '(read)))
27566 The function should return a range of articles it wasn't able to set the
27567 mark on (currently not used for anything).
27569 There should be no result data from this function.
27571 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
27573 If the user tries to set a mark that the back end doesn't like, this
27574 function may change the mark. Gnus will use whatever this function
27575 returns as the mark for @var{article} instead of the original
27576 @var{mark}. If the back end doesn't care, it must return the original
27577 @var{mark}, and not @code{nil} or any other type of garbage.
27579 The only use for this I can see is what @code{nnvirtual} does with
27580 it---if a component group is auto-expirable, marking an article as read
27581 in the virtual group should result in the article being marked as
27584 There should be no result data from this function.
27587 @item (nnchoke-request-scan &optional GROUP SERVER)
27589 This function may be called at any time (by Gnus or anything else) to
27590 request that the back end check for incoming articles, in one way or
27591 another. A mail back end will typically read the spool file or query
27592 the @acronym{POP} server when this function is invoked. The
27593 @var{group} doesn't have to be heeded---if the back end decides that
27594 it is too much work just scanning for a single group, it may do a
27595 total scan of all groups. It would be nice, however, to keep things
27596 local if that's practical.
27598 There should be no result data from this function.
27601 @item (nnchoke-request-group-description GROUP &optional SERVER)
27603 The result data from this function should be a description of
27607 description-line = name <TAB> description eol
27609 description = <text>
27612 @item (nnchoke-request-list-newsgroups &optional SERVER)
27614 The result data from this function should be the description of all
27615 groups available on the server.
27618 description-buffer = *description-line
27622 @item (nnchoke-request-newgroups DATE &optional SERVER)
27624 The result data from this function should be all groups that were
27625 created after @samp{date}, which is in normal human-readable date format
27626 (i.e., the date format used in mail and news headers, and returned by
27627 the function @code{message-make-date} by default). The data should be
27628 in the active buffer format.
27630 It is okay for this function to return ``too many'' groups; some back ends
27631 might find it cheaper to return the full list of groups, rather than
27632 just the new groups. But don't do this for back ends with many groups.
27633 Normally, if the user creates the groups herself, there won't be too
27634 many groups, so @code{nnml} and the like are probably safe. But for
27635 back ends like @code{nntp}, where the groups have been created by the
27636 server, it is quite likely that there can be many groups.
27639 @item (nnchoke-request-create-group GROUP &optional SERVER)
27641 This function should create an empty group with name @var{group}.
27643 There should be no return data.
27646 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
27648 This function should run the expiry process on all articles in the
27649 @var{articles} range (which is currently a simple list of article
27650 numbers.) It is left up to the back end to decide how old articles
27651 should be before they are removed by this function. If @var{force} is
27652 non-@code{nil}, all @var{articles} should be deleted, no matter how new
27655 This function should return a list of articles that it did not/was not
27658 There should be no result data returned.
27661 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
27663 This function should move @var{article} (which is a number) from
27664 @var{group} by calling @var{accept-form}.
27666 This function should ready the article in question for moving by
27667 removing any header lines it has added to the article, and generally
27668 should ``tidy up'' the article. Then it should @code{eval}
27669 @var{accept-form} in the buffer where the ``tidy'' article is. This
27670 will do the actual copying. If this @code{eval} returns a
27671 non-@code{nil} value, the article should be removed.
27673 If @var{last} is @code{nil}, that means that there is a high likelihood
27674 that there will be more requests issued shortly, so that allows some
27677 The function should return a cons where the @code{car} is the group name and
27678 the @code{cdr} is the article number that the article was entered as.
27680 The group should exist before the back end is asked to accept the
27681 article for that group.
27683 There should be no data returned.
27686 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
27688 This function takes the current buffer and inserts it into @var{group}.
27689 If @var{last} in @code{nil}, that means that there will be more calls to
27690 this function in short order.
27692 The function should return a cons where the @code{car} is the group name and
27693 the @code{cdr} is the article number that the article was entered as.
27695 There should be no data returned.
27698 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
27700 This function should remove @var{article} (which is a number) from
27701 @var{group} and insert @var{buffer} there instead.
27703 There should be no data returned.
27706 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
27708 This function should delete @var{group}. If @var{force}, it should
27709 really delete all the articles in the group, and then delete the group
27710 itself. (If there is such a thing as ``the group itself''.)
27712 There should be no data returned.
27715 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
27717 This function should rename @var{group} into @var{new-name}. All
27718 articles in @var{group} should move to @var{new-name}.
27720 There should be no data returned.
27725 @node Error Messaging
27726 @subsubsection Error Messaging
27728 @findex nnheader-report
27729 @findex nnheader-get-report
27730 The back ends should use the function @code{nnheader-report} to report
27731 error conditions---they should not raise errors when they aren't able to
27732 perform a request. The first argument to this function is the back end
27733 symbol, and the rest are interpreted as arguments to @code{format} if
27734 there are multiple of them, or just a string if there is one of them.
27735 This function must always returns @code{nil}.
27738 (nnheader-report 'nnchoke "You did something totally bogus")
27740 (nnheader-report 'nnchoke "Could not request group %s" group)
27743 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
27744 @code{nil} back from a server, and this function returns the most
27745 recently reported message for the back end in question. This function
27746 takes one argument---the server symbol.
27748 Internally, these functions access @var{back-end}@code{-status-string},
27749 so the @code{nnchoke} back end will have its error message stored in
27750 @code{nnchoke-status-string}.
27753 @node Writing New Back Ends
27754 @subsubsection Writing New Back Ends
27756 Many back ends are quite similar. @code{nnml} is just like
27757 @code{nnspool}, but it allows you to edit the articles on the server.
27758 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
27759 and it doesn't maintain overview databases. @code{nndir} is just like
27760 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
27763 It would make sense if it were possible to ``inherit'' functions from
27764 back ends when writing new back ends. And, indeed, you can do that if you
27765 want to. (You don't have to if you don't want to, of course.)
27767 All the back ends declare their public variables and functions by using a
27768 package called @code{nnoo}.
27770 To inherit functions from other back ends (and allow other back ends to
27771 inherit functions from the current back end), you should use the
27777 This macro declares the first parameter to be a child of the subsequent
27778 parameters. For instance:
27781 (nnoo-declare nndir
27785 @code{nndir} has declared here that it intends to inherit functions from
27786 both @code{nnml} and @code{nnmh}.
27789 This macro is equivalent to @code{defvar}, but registers the variable as
27790 a public server variable. Most state-oriented variables should be
27791 declared with @code{defvoo} instead of @code{defvar}.
27793 In addition to the normal @code{defvar} parameters, it takes a list of
27794 variables in the parent back ends to map the variable to when executing
27795 a function in those back ends.
27798 (defvoo nndir-directory nil
27799 "Where nndir will look for groups."
27800 nnml-current-directory nnmh-current-directory)
27803 This means that @code{nnml-current-directory} will be set to
27804 @code{nndir-directory} when an @code{nnml} function is called on behalf
27805 of @code{nndir}. (The same with @code{nnmh}.)
27807 @item nnoo-define-basics
27808 This macro defines some common functions that almost all back ends should
27812 (nnoo-define-basics nndir)
27816 This macro is just like @code{defun} and takes the same parameters. In
27817 addition to doing the normal @code{defun} things, it registers the
27818 function as being public so that other back ends can inherit it.
27820 @item nnoo-map-functions
27821 This macro allows mapping of functions from the current back end to
27822 functions from the parent back ends.
27825 (nnoo-map-functions nndir
27826 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27827 (nnmh-request-article 0 nndir-current-group 0 0))
27830 This means that when @code{nndir-retrieve-headers} is called, the first,
27831 third, and fourth parameters will be passed on to
27832 @code{nnml-retrieve-headers}, while the second parameter is set to the
27833 value of @code{nndir-current-group}.
27836 This macro allows importing functions from back ends. It should be the
27837 last thing in the source file, since it will only define functions that
27838 haven't already been defined.
27844 nnmh-request-newgroups)
27848 This means that calls to @code{nndir-request-list} should just be passed
27849 on to @code{nnmh-request-list}, while all public functions from
27850 @code{nnml} that haven't been defined in @code{nndir} yet should be
27855 Below is a slightly shortened version of the @code{nndir} back end.
27858 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
27859 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
27863 (require 'nnheader)
27867 (eval-when-compile (require 'cl))
27869 (nnoo-declare nndir
27872 (defvoo nndir-directory nil
27873 "Where nndir will look for groups."
27874 nnml-current-directory nnmh-current-directory)
27876 (defvoo nndir-nov-is-evil nil
27877 "*Non-nil means that nndir will never retrieve NOV headers."
27880 (defvoo nndir-current-group ""
27882 nnml-current-group nnmh-current-group)
27883 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
27884 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
27886 (defvoo nndir-status-string "" nil nnmh-status-string)
27887 (defconst nndir-version "nndir 1.0")
27889 ;;; @r{Interface functions.}
27891 (nnoo-define-basics nndir)
27893 (deffoo nndir-open-server (server &optional defs)
27894 (setq nndir-directory
27895 (or (cadr (assq 'nndir-directory defs))
27897 (unless (assq 'nndir-directory defs)
27898 (push `(nndir-directory ,server) defs))
27899 (push `(nndir-current-group
27900 ,(file-name-nondirectory
27901 (directory-file-name nndir-directory)))
27903 (push `(nndir-top-directory
27904 ,(file-name-directory (directory-file-name nndir-directory)))
27906 (nnoo-change-server 'nndir server defs))
27908 (nnoo-map-functions nndir
27909 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27910 (nnmh-request-article 0 nndir-current-group 0 0)
27911 (nnmh-request-group nndir-current-group 0 0)
27912 (nnmh-close-group nndir-current-group 0))
27916 nnmh-status-message
27918 nnmh-request-newgroups))
27924 @node Hooking New Back Ends Into Gnus
27925 @subsubsection Hooking New Back Ends Into Gnus
27927 @vindex gnus-valid-select-methods
27928 @findex gnus-declare-backend
27929 Having Gnus start using your new back end is rather easy---you just
27930 declare it with the @code{gnus-declare-backend} functions. This will
27931 enter the back end into the @code{gnus-valid-select-methods} variable.
27933 @code{gnus-declare-backend} takes two parameters---the back end name and
27934 an arbitrary number of @dfn{abilities}.
27939 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
27942 The above line would then go in the @file{nnchoke.el} file.
27944 The abilities can be:
27948 This is a mailish back end---followups should (probably) go via mail.
27950 This is a newsish back end---followups should (probably) go via news.
27952 This back end supports both mail and news.
27954 This is neither a post nor mail back end---it's something completely
27957 It supports respooling---or rather, it is able to modify its source
27958 articles and groups.
27960 The name of the server should be in the virtual server name. This is
27961 true for almost all back ends.
27962 @item prompt-address
27963 The user should be prompted for an address when doing commands like
27964 @kbd{B} in the group buffer. This is true for back ends like
27965 @code{nntp}, but not @code{nnmbox}, for instance.
27969 @node Mail-like Back Ends
27970 @subsubsection Mail-like Back Ends
27972 One of the things that separate the mail back ends from the rest of the
27973 back ends is the heavy dependence by most of the mail back ends on
27974 common functions in @file{nnmail.el}. For instance, here's the
27975 definition of @code{nnml-request-scan}:
27978 (deffoo nnml-request-scan (&optional group server)
27979 (setq nnml-article-file-alist nil)
27980 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
27983 It simply calls @code{nnmail-get-new-mail} with a few parameters,
27984 and @code{nnmail} takes care of all the moving and splitting of the
27987 This function takes four parameters.
27991 This should be a symbol to designate which back end is responsible for
27994 @item exit-function
27995 This function should be called after the splitting has been performed.
27997 @item temp-directory
27998 Where the temporary files should be stored.
28001 This optional argument should be a group name if the splitting is to be
28002 performed for one group only.
28005 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
28006 save each article. @var{back-end}@code{-active-number} will be called to
28007 find the article number assigned to this article.
28009 The function also uses the following variables:
28010 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
28011 this back end); and @var{back-end}@code{-group-alist} and
28012 @var{back-end}@code{-active-file} to generate the new active file.
28013 @var{back-end}@code{-group-alist} should be a group-active alist, like
28017 (("a-group" (1 . 10))
28018 ("some-group" (34 . 39)))
28022 @node Score File Syntax
28023 @subsection Score File Syntax
28025 Score files are meant to be easily parseable, but yet extremely
28026 mallable. It was decided that something that had the same read syntax
28027 as an Emacs Lisp list would fit that spec.
28029 Here's a typical score file:
28033 ("win95" -10000 nil s)
28040 BNF definition of a score file:
28043 score-file = "" / "(" *element ")"
28044 element = rule / atom
28045 rule = string-rule / number-rule / date-rule
28046 string-rule = "(" quote string-header quote space *string-match ")"
28047 number-rule = "(" quote number-header quote space *number-match ")"
28048 date-rule = "(" quote date-header quote space *date-match ")"
28050 string-header = "subject" / "from" / "references" / "message-id" /
28051 "xref" / "body" / "head" / "all" / "followup"
28052 number-header = "lines" / "chars"
28053 date-header = "date"
28054 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
28055 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
28056 score = "nil" / <integer>
28057 date = "nil" / <natural number>
28058 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
28059 "r" / "regex" / "R" / "Regex" /
28060 "e" / "exact" / "E" / "Exact" /
28061 "f" / "fuzzy" / "F" / "Fuzzy"
28062 number-match = "(" <integer> [ "" / [ space score [ "" /
28063 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
28064 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
28065 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
28066 space date [ "" / [ space date-match-t ] ] ] ] ")"
28067 date-match-t = "nil" / "at" / "before" / "after"
28068 atom = "(" [ required-atom / optional-atom ] ")"
28069 required-atom = mark / expunge / mark-and-expunge / files /
28070 exclude-files / read-only / touched
28071 optional-atom = adapt / local / eval
28072 mark = "mark" space nil-or-number
28073 nil-or-number = "nil" / <integer>
28074 expunge = "expunge" space nil-or-number
28075 mark-and-expunge = "mark-and-expunge" space nil-or-number
28076 files = "files" *[ space <string> ]
28077 exclude-files = "exclude-files" *[ space <string> ]
28078 read-only = "read-only" [ space "nil" / space "t" ]
28079 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
28080 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
28081 local = "local" *[ space "(" <string> space <form> ")" ]
28082 eval = "eval" space <form>
28083 space = *[ " " / <TAB> / <NEWLINE> ]
28086 Any unrecognized elements in a score file should be ignored, but not
28089 As you can see, white space is needed, but the type and amount of white
28090 space is irrelevant. This means that formatting of the score file is
28091 left up to the programmer---if it's simpler to just spew it all out on
28092 one looong line, then that's ok.
28094 The meaning of the various atoms are explained elsewhere in this
28095 manual (@pxref{Score File Format}).
28099 @subsection Headers
28101 Internally Gnus uses a format for storing article headers that
28102 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
28103 almost suspect that the author looked at the @acronym{NOV} specification and
28104 just shamelessly @emph{stole} the entire thing, and one would be right.
28106 @dfn{Header} is a severely overloaded term. ``Header'' is used in
28107 RFC 1036 to talk about lines in the head of an article (e.g.,
28108 @code{From}). It is used by many people as a synonym for
28109 ``head''---``the header and the body''. (That should be avoided, in my
28110 opinion.) And Gnus uses a format internally that it calls ``header'',
28111 which is what I'm talking about here. This is a 9-element vector,
28112 basically, with each header (ouch) having one slot.
28114 These slots are, in order: @code{number}, @code{subject}, @code{from},
28115 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
28116 @code{xref}, and @code{extra}. There are macros for accessing and
28117 setting these slots---they all have predictable names beginning with
28118 @code{mail-header-} and @code{mail-header-set-}, respectively.
28120 All these slots contain strings, except the @code{extra} slot, which
28121 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
28127 @sc{gnus} introduced a concept that I found so useful that I've started
28128 using it a lot and have elaborated on it greatly.
28130 The question is simple: If you have a large amount of objects that are
28131 identified by numbers (say, articles, to take a @emph{wild} example)
28132 that you want to qualify as being ``included'', a normal sequence isn't
28133 very useful. (A 200,000 length sequence is a bit long-winded.)
28135 The solution is as simple as the question: You just collapse the
28139 (1 2 3 4 5 6 10 11 12)
28142 is transformed into
28145 ((1 . 6) (10 . 12))
28148 To avoid having those nasty @samp{(13 . 13)} elements to denote a
28149 lonesome object, a @samp{13} is a valid element:
28152 ((1 . 6) 7 (10 . 12))
28155 This means that comparing two ranges to find out whether they are equal
28156 is slightly tricky:
28159 ((1 . 5) 7 8 (10 . 12))
28165 ((1 . 5) (7 . 8) (10 . 12))
28168 are equal. In fact, any non-descending list is a range:
28174 is a perfectly valid range, although a pretty long-winded one. This is
28181 and is equal to the previous range.
28183 Here's a BNF definition of ranges. Of course, one must remember the
28184 semantic requirement that the numbers are non-descending. (Any number
28185 of repetition of the same number is allowed, but apt to disappear in
28189 range = simple-range / normal-range
28190 simple-range = "(" number " . " number ")"
28191 normal-range = "(" start-contents ")"
28192 contents = "" / simple-range *[ " " contents ] /
28193 number *[ " " contents ]
28196 Gnus currently uses ranges to keep track of read articles and article
28197 marks. I plan on implementing a number of range operators in C if The
28198 Powers That Be are willing to let me. (I haven't asked yet, because I
28199 need to do some more thinking on what operators I need to make life
28200 totally range-based without ever having to convert back to normal
28205 @subsection Group Info
28207 Gnus stores all permanent info on groups in a @dfn{group info} list.
28208 This list is from three to six elements (or more) long and exhaustively
28209 describes the group.
28211 Here are two example group infos; one is a very simple group while the
28212 second is a more complex one:
28215 ("no.group" 5 ((1 . 54324)))
28217 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
28218 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
28220 ((auto-expire . t) (to-address . "ding@@gnus.org")))
28223 The first element is the @dfn{group name}---as Gnus knows the group,
28224 anyway. The second element is the @dfn{subscription level}, which
28225 normally is a small integer. (It can also be the @dfn{rank}, which is a
28226 cons cell where the @code{car} is the level and the @code{cdr} is the
28227 score.) The third element is a list of ranges of read articles. The
28228 fourth element is a list of lists of article marks of various kinds.
28229 The fifth element is the select method (or virtual server, if you like).
28230 The sixth element is a list of @dfn{group parameters}, which is what
28231 this section is about.
28233 Any of the last three elements may be missing if they are not required.
28234 In fact, the vast majority of groups will normally only have the first
28235 three elements, which saves quite a lot of cons cells.
28237 Here's a BNF definition of the group info format:
28240 info = "(" group space ralevel space read
28241 [ "" / [ space marks-list [ "" / [ space method [ "" /
28242 space parameters ] ] ] ] ] ")"
28243 group = quote <string> quote
28244 ralevel = rank / level
28245 level = <integer in the range of 1 to inf>
28246 rank = "(" level "." score ")"
28247 score = <integer in the range of 1 to inf>
28249 marks-lists = nil / "(" *marks ")"
28250 marks = "(" <string> range ")"
28251 method = "(" <string> *elisp-forms ")"
28252 parameters = "(" *elisp-forms ")"
28255 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
28256 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
28259 If you have a Gnus info and want to access the elements, Gnus offers a
28260 series of macros for getting/setting these elements.
28263 @item gnus-info-group
28264 @itemx gnus-info-set-group
28265 @findex gnus-info-group
28266 @findex gnus-info-set-group
28267 Get/set the group name.
28269 @item gnus-info-rank
28270 @itemx gnus-info-set-rank
28271 @findex gnus-info-rank
28272 @findex gnus-info-set-rank
28273 Get/set the group rank (@pxref{Group Score}).
28275 @item gnus-info-level
28276 @itemx gnus-info-set-level
28277 @findex gnus-info-level
28278 @findex gnus-info-set-level
28279 Get/set the group level.
28281 @item gnus-info-score
28282 @itemx gnus-info-set-score
28283 @findex gnus-info-score
28284 @findex gnus-info-set-score
28285 Get/set the group score (@pxref{Group Score}).
28287 @item gnus-info-read
28288 @itemx gnus-info-set-read
28289 @findex gnus-info-read
28290 @findex gnus-info-set-read
28291 Get/set the ranges of read articles.
28293 @item gnus-info-marks
28294 @itemx gnus-info-set-marks
28295 @findex gnus-info-marks
28296 @findex gnus-info-set-marks
28297 Get/set the lists of ranges of marked articles.
28299 @item gnus-info-method
28300 @itemx gnus-info-set-method
28301 @findex gnus-info-method
28302 @findex gnus-info-set-method
28303 Get/set the group select method.
28305 @item gnus-info-params
28306 @itemx gnus-info-set-params
28307 @findex gnus-info-params
28308 @findex gnus-info-set-params
28309 Get/set the group parameters.
28312 All the getter functions take one parameter---the info list. The setter
28313 functions take two parameters---the info list and the new value.
28315 The last three elements in the group info aren't mandatory, so it may be
28316 necessary to extend the group info before setting the element. If this
28317 is necessary, you can just pass on a non-@code{nil} third parameter to
28318 the three final setter functions to have this happen automatically.
28321 @node Extended Interactive
28322 @subsection Extended Interactive
28323 @cindex interactive
28324 @findex gnus-interactive
28326 Gnus extends the standard Emacs @code{interactive} specification
28327 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
28328 Prefixes}). Here's an example of how this is used:
28331 (defun gnus-summary-increase-score (&optional score symp)
28332 (interactive (gnus-interactive "P\ny"))
28337 The best thing to do would have been to implement
28338 @code{gnus-interactive} as a macro which would have returned an
28339 @code{interactive} form, but this isn't possible since Emacs checks
28340 whether a function is interactive or not by simply doing an @code{assq}
28341 on the lambda form. So, instead we have @code{gnus-interactive}
28342 function that takes a string and returns values that are usable to
28343 @code{interactive}.
28345 This function accepts (almost) all normal @code{interactive} specs, but
28350 @vindex gnus-current-prefix-symbol
28351 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
28355 @vindex gnus-current-prefix-symbols
28356 A list of the current symbolic prefixes---the
28357 @code{gnus-current-prefix-symbol} variable.
28360 The current article number---the @code{gnus-summary-article-number}
28364 The current article header---the @code{gnus-summary-article-header}
28368 The current group name---the @code{gnus-group-group-name}
28374 @node Emacs/XEmacs Code
28375 @subsection Emacs/XEmacs Code
28379 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
28380 platforms must be the primary one. I chose Emacs. Not because I don't
28381 like XEmacs or Mule, but because it comes first alphabetically.
28383 This means that Gnus will byte-compile under Emacs with nary a warning,
28384 while XEmacs will pump out gigabytes of warnings while byte-compiling.
28385 As I use byte-compilation warnings to help me root out trivial errors in
28386 Gnus, that's very useful.
28388 I've also consistently used Emacs function interfaces, but have used
28389 Gnusey aliases for the functions. To take an example: Emacs defines a
28390 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
28391 function. I then define a function called @code{gnus-run-at-time} that
28392 takes the same parameters as the Emacs @code{run-at-time}. When running
28393 Gnus under Emacs, the former function is just an alias for the latter.
28394 However, when running under XEmacs, the former is an alias for the
28395 following function:
28398 (defun gnus-xmas-run-at-time (time repeat function &rest args)
28402 (,function ,@@args))
28406 This sort of thing has been done for bunches of functions. Gnus does
28407 not redefine any native Emacs functions while running under XEmacs---it
28408 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
28411 In the cases where the XEmacs function interface was obviously cleaner,
28412 I used it instead. For example @code{gnus-region-active-p} is an alias
28413 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
28415 Of course, I could have chosen XEmacs as my native platform and done
28416 mapping functions the other way around. But I didn't. The performance
28417 hit these indirections impose on Gnus under XEmacs should be slight.
28420 @node Various File Formats
28421 @subsection Various File Formats
28424 * Active File Format:: Information on articles and groups available.
28425 * Newsgroups File Format:: Group descriptions.
28429 @node Active File Format
28430 @subsubsection Active File Format
28432 The active file lists all groups available on the server in
28433 question. It also lists the highest and lowest current article numbers
28436 Here's an excerpt from a typical active file:
28439 soc.motss 296030 293865 y
28440 alt.binaries.pictures.fractals 3922 3913 n
28441 comp.sources.unix 1605 1593 m
28442 comp.binaries.ibm.pc 5097 5089 y
28443 no.general 1000 900 y
28446 Here's a pseudo-BNF definition of this file:
28449 active = *group-line
28450 group-line = group spc high-number spc low-number spc flag <NEWLINE>
28451 group = <non-white-space string>
28453 high-number = <non-negative integer>
28454 low-number = <positive integer>
28455 flag = "y" / "n" / "m" / "j" / "x" / "=" group
28458 For a full description of this file, see the manual pages for
28459 @samp{innd}, in particular @samp{active(5)}.
28462 @node Newsgroups File Format
28463 @subsubsection Newsgroups File Format
28465 The newsgroups file lists groups along with their descriptions. Not all
28466 groups on the server have to be listed, and not all groups in the file
28467 have to exist on the server. The file is meant purely as information to
28470 The format is quite simple; a group name, a tab, and the description.
28471 Here's the definition:
28475 line = group tab description <NEWLINE>
28476 group = <non-white-space string>
28478 description = <string>
28483 @node Emacs for Heathens
28484 @section Emacs for Heathens
28486 Believe it or not, but some people who use Gnus haven't really used
28487 Emacs much before they embarked on their journey on the Gnus Love Boat.
28488 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
28489 region'', and ``set @code{gnus-flargblossen} to an alist where the key
28490 is a regexp that is used for matching on the group name'' are magical
28491 phrases with little or no meaning, then this appendix is for you. If
28492 you are already familiar with Emacs, just ignore this and go fondle your
28496 * Keystrokes:: Entering text and executing commands.
28497 * Emacs Lisp:: The built-in Emacs programming language.
28502 @subsection Keystrokes
28506 Q: What is an experienced Emacs user?
28509 A: A person who wishes that the terminal had pedals.
28512 Yes, when you use Emacs, you are apt to use the control key, the shift
28513 key and the meta key a lot. This is very annoying to some people
28514 (notably @code{vi}le users), and the rest of us just love the hell out
28515 of it. Just give up and submit. Emacs really does stand for
28516 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
28517 may have heard from other disreputable sources (like the Emacs author).
28519 The shift keys are normally located near your pinky fingers, and are
28520 normally used to get capital letters and stuff. You probably use it all
28521 the time. The control key is normally marked ``CTRL'' or something like
28522 that. The meta key is, funnily enough, never marked as such on any
28523 keyboard. The one I'm currently at has a key that's marked ``Alt'',
28524 which is the meta key on this keyboard. It's usually located somewhere
28525 to the left hand side of the keyboard, usually on the bottom row.
28527 Now, us Emacs people don't say ``press the meta-control-m key'',
28528 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
28529 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
28530 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
28531 down the control key, and hold it down while you press @kbd{k}''.
28532 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
28533 the control key and then press @kbd{k}''. Simple, ay?
28535 This is somewhat complicated by the fact that not all keyboards have a
28536 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
28537 means ``press escape, release escape, press @kbd{k}''. That's much more
28538 work than if you have a meta key, so if that's the case, I respectfully
28539 suggest you get a real keyboard with a meta key. You can't live without
28545 @subsection Emacs Lisp
28547 Emacs is the King of Editors because it's really a Lisp interpreter.
28548 Each and every key you tap runs some Emacs Lisp code snippet, and since
28549 Emacs Lisp is an interpreted language, that means that you can configure
28550 any key to run any arbitrary code. You just, like, do it.
28552 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
28553 functions. (These are byte-compiled for speed, but it's still
28554 interpreted.) If you decide that you don't like the way Gnus does
28555 certain things, it's trivial to have it do something a different way.
28556 (Well, at least if you know how to write Lisp code.) However, that's
28557 beyond the scope of this manual, so we are simply going to talk about
28558 some common constructs that you normally use in your @file{.emacs} file
28561 If you want to set the variable @code{gnus-florgbnize} to four (4), you
28562 write the following:
28565 (setq gnus-florgbnize 4)
28568 This function (really ``special form'') @code{setq} is the one that can
28569 set a variable to some value. This is really all you need to know. Now
28570 you can go and fill your @file{.emacs} file with lots of these to change
28573 If you have put that thing in your @file{.emacs} file, it will be read
28574 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
28575 start Emacs. If you want to change the variable right away, simply say
28576 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
28577 previous ``form'', which is a simple @code{setq} statement here.
28579 Go ahead---just try it, if you're located at your Emacs. After you
28580 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
28581 is the return value of the form you @code{eval}ed.
28585 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
28589 (setq gnus-read-active-file 'some)
28592 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
28593 @samp{nntp.ifi.uio.no}'', that means:
28596 (setq gnus-nntp-server "nntp.ifi.uio.no")
28599 So be careful not to mix up strings (the latter) with symbols (the
28600 former). The manual is unambiguous, but it can be confusing.
28603 @include gnus-faq.texi
28623 @c Local Variables:
28625 @c coding: iso-8859-1