4 @settitle T-gnus 6.17 Manual
9 @documentencoding ISO-8859-1
12 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
13 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.2 or
18 any later version published by the Free Software Foundation; with no
19 Invariant Sections, with the Front-Cover texts being ``A GNU
20 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
21 license is included in the section entitled ``GNU Free Documentation
22 License'' in the Emacs manual.
24 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
25 this GNU Manual, like GNU software. Copies published by the Free
26 Software Foundation raise funds for GNU development.''
28 This document is part of a collection distributed under the GNU Free
29 Documentation License. If you want to distribute this document
30 separately from the collection, you can do so by adding a copy of the
31 license to the document, as described in section 6 of the license.
37 \documentclass[twoside,a4paper,openright,11pt]{book}
38 \usepackage[latin1]{inputenc}
39 \usepackage{pagestyle}
42 \input{gnusconfig.tex}
44 \ifx\pdfoutput\undefined
46 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
54 \newcommand{\gnusversionname}{T-gnus v6.17}
55 \newcommand{\gnuschaptername}{}
56 \newcommand{\gnussectionname}{}
58 \newcommand{\gnusbackslash}{/}
60 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
61 \ifx\pdfoutput\undefined
62 \newcommand{\gnusuref}[1]{\gnustt{#1}}
64 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
66 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
67 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
69 \newcommand{\gnuskindex}[1]{\index{#1}}
70 \newcommand{\gnusindex}[1]{\index{#1}}
72 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
73 \newcommand{\gnuscode}[1]{\gnustt{#1}}
74 \newcommand{\gnusasis}[1]{\gnustt{#1}}
75 \newcommand{\gnusurl}[1]{\gnustt{#1}}
76 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
77 \newcommand{\gnusenv}[1]{\gnustt{#1}}
78 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
79 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
80 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
81 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
82 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
83 \newcommand{\gnusdfn}[1]{\textit{#1}}
84 \newcommand{\gnusi}[1]{\textit{#1}}
85 \newcommand{\gnusr}[1]{\textrm{#1}}
86 \newcommand{\gnusstrong}[1]{\textbf{#1}}
87 \newcommand{\gnusemph}[1]{\textit{#1}}
88 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
89 \newcommand{\gnussc}[1]{\textsc{#1}}
90 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
91 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
92 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
93 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
94 \newcommand{\gnusacronym}[1]{\textsc{#1}}
95 \newcommand{\gnusemail}[1]{\textit{#1}}
97 \newcommand{\gnusbullet}{{${\bullet}$}}
98 \newcommand{\gnusdollar}{\$}
99 \newcommand{\gnusampersand}{\&}
100 \newcommand{\gnuspercent}{\%}
101 \newcommand{\gnushash}{\#}
102 \newcommand{\gnushat}{\symbol{"5E}}
103 \newcommand{\gnusunderline}{\symbol{"5F}}
104 \newcommand{\gnusnot}{$\neg$}
105 \newcommand{\gnustilde}{\symbol{"7E}}
106 \newcommand{\gnusless}{{$<$}}
107 \newcommand{\gnusgreater}{{$>$}}
108 \newcommand{\gnusbraceleft}{{$>$}}
109 \newcommand{\gnusbraceright}{{$>$}}
111 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
112 \newcommand{\gnusinteresting}{
113 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
116 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
118 \newcommand{\gnuspagechapter}[1]{
122 \newdimen{\gnusdimen}
125 \newcommand{\gnuschapter}[2]{
127 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
129 \renewcommand{\gnussectionname}{}
130 \renewcommand{\gnuschaptername}{#2}
131 \thispagestyle{empty}
133 \begin{picture}(500,500)(0,0)
134 \put(480,350){\makebox(0,0)[tr]{#1}}
135 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
140 \newcommand{\gnusfigure}[3]{
142 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
149 \newcommand{\gnusicon}[1]{
150 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
153 \newcommand{\gnuspicon}[1]{
154 \margindex{\epsfig{figure=#1,width=2cm}}
157 \newcommand{\gnusxface}[2]{
158 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
161 \newcommand{\gnussmiley}[2]{
162 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
165 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
167 \newcommand{\gnussection}[1]{
168 \renewcommand{\gnussectionname}{#1}
172 \newenvironment{codelist}%
177 \newenvironment{asislist}%
182 \newenvironment{kbdlist}%
188 \newenvironment{dfnlist}%
193 \newenvironment{stronglist}%
198 \newenvironment{samplist}%
203 \newenvironment{varlist}%
208 \newenvironment{emphlist}%
213 \newlength\gnusheadtextwidth
214 \setlength{\gnusheadtextwidth}{\headtextwidth}
215 \addtolength{\gnusheadtextwidth}{1cm}
217 \newpagestyle{gnuspreamble}%
222 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
226 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
235 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
237 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
242 \newpagestyle{gnusindex}%
247 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
251 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
259 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
261 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
271 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
275 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
283 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
285 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
290 \pagenumbering{roman}
291 \pagestyle{gnuspreamble}
302 %\addtolength{\oddsidemargin}{-5cm}
303 %\addtolength{\evensidemargin}{-5cm}
305 \addtolength{\textheight}{2cm}
307 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
310 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
313 \gnusauthor{by Lars Magne Ingebrigtsen}
320 \thispagestyle{empty}
334 * Gnus: (gnus). The newsreader Gnus.
339 @setchapternewpage odd
344 @title T-gnus 6.17 Manual
346 @author by Lars Magne Ingebrigtsen
348 @vskip 0pt plus 1filll
354 @top The gnus Newsreader
358 You can read news (and mail) from within Emacs by using T-gnus. The news
359 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
360 spool or your mbox file. All at the same time, if you want to push your
363 T-gnus provides @acronym{MIME} features based on @acronym{SEMI} API. So
364 T-gnus supports your right to read strange messages including big images
365 or other various kinds of formats. T-gnus also supports
366 internationalization/localization and multiscript features based on MULE
367 API. So T-gnus does not discriminate various language communities. Oh,
368 if you are a Klingon, please wait Unicode Next Generation.
370 This manual corresponds to T-gnus 6.17.
381 Gnus is the advanced, self-documenting, customizable, extensible
382 unreal-time newsreader for GNU Emacs.
384 Oops. That sounds oddly familiar, so let's start over again to avoid
385 being accused of plagiarism:
387 Gnus is a message-reading laboratory. It will let you look at just
388 about anything as if it were a newsgroup. You can read mail with it,
389 you can browse directories with it, you can @code{ftp} with it---you
390 can even read news with it!
392 Gnus tries to empower people who read news the same way Emacs empowers
393 people who edit text. Gnus sets no limits to what the user should be
394 allowed to do. Users are encouraged to extend gnus to make it behave
395 like they want it to behave. A program should not control people;
396 people should be empowered to do what they want by using (or abusing)
402 * Starting Up:: Finding news can be a pain.
403 * Group Buffer:: Selecting, subscribing and killing groups.
404 * Summary Buffer:: Reading, saving and posting articles.
405 * Article Buffer:: Displaying and handling articles.
406 * Composing Messages:: Information on sending mail and news.
407 * Select Methods:: Gnus reads all messages from various select methods.
408 * Scoring:: Assigning values to articles.
409 * Various:: General purpose settings.
410 * The End:: Farewell and goodbye.
411 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
412 * Index:: Variable, function and concept index.
413 * Key Index:: Key Index.
415 Other related manuals
417 * Message:(message). Composing messages.
418 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
419 * Sieve:(sieve). Managing Sieve scripts in Emacs.
420 * PGG:(pgg). @acronym{PGP/MIME} with Gnus.
421 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
424 --- The Detailed Node Listing ---
428 * Finding the News:: Choosing a method for getting news.
429 * The First Time:: What does Gnus do the first time you start it?
430 * The Server is Down:: How can I read my mail then?
431 * Slave Gnusae:: You can have more than one Gnus active at a time.
432 * Fetching a Group:: Starting Gnus just to read a group.
433 * New Groups:: What is Gnus supposed to do with new groups?
434 * Changing Servers:: You may want to move from one server to another.
435 * Startup Files:: Those pesky startup files---@file{.newsrc}.
436 * Auto Save:: Recovering from a crash.
437 * The Active File:: Reading the active file over a slow line Takes Time.
438 * Startup Variables:: Other variables you might change.
442 * Checking New Groups:: Determining what groups are new.
443 * Subscription Methods:: What Gnus should do with new groups.
444 * Filtering New Groups:: Making Gnus ignore certain new groups.
448 * Group Buffer Format:: Information listed and how you can change it.
449 * Group Maneuvering:: Commands for moving in the group buffer.
450 * Selecting a Group:: Actually reading news.
451 * Subscription Commands:: Unsubscribing, killing, subscribing.
452 * Group Data:: Changing the info for a group.
453 * Group Levels:: Levels? What are those, then?
454 * Group Score:: A mechanism for finding out what groups you like.
455 * Marking Groups:: You can mark groups for later processing.
456 * Foreign Groups:: Creating and editing groups.
457 * Group Parameters:: Each group may have different parameters set.
458 * Listing Groups:: Gnus can list various subsets of the groups.
459 * Sorting Groups:: Re-arrange the group order.
460 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
461 * Browse Foreign Server:: You can browse a server. See what it has to offer.
462 * Exiting Gnus:: Stop reading news and get some work done.
463 * Group Topics:: A folding group mode divided into topics.
464 * Misc Group Stuff:: Other stuff that you can to do.
468 * Group Line Specification:: Deciding how the group buffer is to look.
469 * Group Mode Line Specification:: The group buffer mode line.
470 * Group Highlighting:: Having nice colors in the group buffer.
474 * Topic Commands:: Interactive E-Z commands.
475 * Topic Variables:: How to customize the topics the Lisp Way.
476 * Topic Sorting:: Sorting each topic individually.
477 * Topic Topology:: A map of the world.
478 * Topic Parameters:: Parameters that apply to all groups in a topic.
482 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
483 * Group Information:: Information and help on groups and Gnus.
484 * Group Timestamp:: Making Gnus keep track of when you last read a group.
485 * File Commands:: Reading and writing the Gnus files.
486 * Sieve Commands:: Managing Sieve scripts.
490 * Summary Buffer Format:: Deciding how the summary buffer is to look.
491 * Summary Maneuvering:: Moving around the summary buffer.
492 * Choosing Articles:: Reading articles.
493 * Paging the Article:: Scrolling the current article.
494 * Reply Followup and Post:: Posting articles.
495 * Delayed Articles:: Send articles at a later time.
496 * Marking Articles:: Marking articles as read, expirable, etc.
497 * Limiting:: You can limit the summary buffer.
498 * Threading:: How threads are made.
499 * Sorting the Summary Buffer:: How articles and threads are sorted.
500 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
501 * Article Caching:: You may store articles in a cache.
502 * Persistent Articles:: Making articles expiry-resistant.
503 * Article Backlog:: Having already read articles hang around.
504 * Saving Articles:: Ways of customizing article saving.
505 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
506 * Article Treatment:: The article buffer can be mangled at will.
507 * MIME Commands:: Doing MIMEy things with the articles.
508 * Charsets:: Character set issues.
509 * Article Commands:: Doing various things with the article buffer.
510 * Summary Sorting:: Sorting the summary buffer in various ways.
511 * Finding the Parent:: No child support? Get the parent.
512 * Alternative Approaches:: Reading using non-default summaries.
513 * Tree Display:: A more visual display of threads.
514 * Mail Group Commands:: Some commands can only be used in mail groups.
515 * Various Summary Stuff:: What didn't fit anywhere else.
516 * Exiting the Summary Buffer:: Returning to the Group buffer,
517 or reselecting the current group.
518 * Crosspost Handling:: How crossposted articles are dealt with.
519 * Duplicate Suppression:: An alternative when crosspost handling fails.
520 * Security:: Decrypt and Verify.
521 * Mailing List:: Mailing list minor mode.
523 Summary Buffer Format
525 * Summary Buffer Lines:: You can specify how summary lines should look.
526 * To From Newsgroups:: How to not display your own name.
527 * Summary Buffer Mode Line:: You can say how the mode line should look.
528 * Summary Highlighting:: Making the summary buffer all pretty and nice.
532 * Choosing Commands:: Commands for choosing articles.
533 * Choosing Variables:: Variables that influence these commands.
535 Reply, Followup and Post
537 * Summary Mail Commands:: Sending mail.
538 * Summary Post Commands:: Sending news.
539 * Summary Message Commands:: Other Message-related commands.
540 * Canceling and Superseding::
544 * Unread Articles:: Marks for unread articles.
545 * Read Articles:: Marks for read articles.
546 * Other Marks:: Marks that do not affect readedness.
547 * Setting Marks:: How to set and remove marks.
548 * Generic Marking Commands:: How to customize the marking.
549 * Setting Process Marks:: How to mark articles for later processing.
553 * Customizing Threading:: Variables you can change to affect the threading.
554 * Thread Commands:: Thread based commands in the summary buffer.
556 Customizing Threading
558 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
559 * Filling In Threads:: Making the threads displayed look fuller.
560 * More Threading:: Even more variables for fiddling with threads.
561 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
565 * Uuencoded Articles:: Uudecode articles.
566 * Shell Archives:: Unshar articles.
567 * PostScript Files:: Split PostScript.
568 * Other Files:: Plain save and binhex.
569 * Decoding Variables:: Variables for a happy decoding.
570 * Viewing Files:: You want to look at the result of the decoding?
574 * Rule Variables:: Variables that say how a file is to be viewed.
575 * Other Decode Variables:: Other decode variables.
576 * Uuencoding and Posting:: Variables for customizing uuencoding.
580 * Article Highlighting:: You want to make the article look like fruit salad.
581 * Article Fontisizing:: Making emphasized text look nice.
582 * Article Hiding:: You also want to make certain info go away.
583 * Article Washing:: Lots of way-neat functions to make life better.
584 * Article Header:: Doing various header transformations.
585 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
586 * Article Button Levels:: Controlling appearance of buttons.
587 * Article Date:: Grumble, UT!
588 * Article Display:: Display various stuff---X-Face, Picons, Smileys
589 * Article Signature:: What is a signature?
590 * Article Miscellanea:: Various other stuff.
592 Alternative Approaches
594 * Pick and Read:: First mark articles and then read them.
595 * Binary Groups:: Auto-decode all articles.
597 Various Summary Stuff
599 * Summary Group Information:: Information oriented commands.
600 * Searching for Articles:: Multiple article commands.
601 * Summary Generation Commands::
602 * Really Various Summary Commands:: Those pesky non-conformant commands.
606 * Hiding Headers:: Deciding what headers should be displayed.
607 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
608 * Customizing Articles:: Tailoring the look of the articles.
609 * Article Keymap:: Keystrokes available in the article buffer.
610 * Misc Article:: Other stuff.
614 * Mail:: Mailing and replying.
615 * Posting Server:: What server should you post and mail via?
616 * POP before SMTP:: You cannot send a mail unless you read a mail.
617 * Mail and Post:: Mailing and posting at the same time.
618 * Archived Messages:: Where Gnus stores the messages you've sent.
619 * Posting Styles:: An easier way to specify who you are.
620 * Drafts:: Postponing messages and rejected messages.
621 * Rejected Articles:: What happens if the server doesn't like your article?
622 * Signing and encrypting:: How to compose secure messages.
626 * Server Buffer:: Making and editing virtual servers.
627 * Getting News:: Reading USENET news with Gnus.
628 * Getting Mail:: Reading your personal mail with Gnus.
629 * Browsing the Web:: Getting messages from a plethora of Web sources.
630 * IMAP:: Using Gnus as a @acronym{IMAP} client.
631 * Other Sources:: Reading directories, files, SOUP packets.
632 * Combined Groups:: Combining groups into one group.
633 * Email Based Diary:: Using mails to manage diary events in Gnus.
634 * Gnus Unplugged:: Reading news and mail offline.
638 * Server Buffer Format:: You can customize the look of this buffer.
639 * Server Commands:: Commands to manipulate servers.
640 * Example Methods:: Examples server specifications.
641 * Creating a Virtual Server:: An example session.
642 * Server Variables:: Which variables to set.
643 * Servers and Methods:: You can use server names as select methods.
644 * Unavailable Servers:: Some servers you try to contact may be down.
648 * NNTP:: Reading news from an @acronym{NNTP} server.
649 * News Spool:: Reading news from the local spool.
653 * Direct Functions:: Connecting directly to the server.
654 * Indirect Functions:: Connecting indirectly to the server.
655 * Common Variables:: Understood by several connection functions.
656 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
660 * Mail in a Newsreader:: Important introductory notes.
661 * Getting Started Reading Mail:: A simple cookbook example.
662 * Splitting Mail:: How to create mail groups.
663 * Mail Sources:: How to tell Gnus where to get mail from.
664 * Mail Back End Variables:: Variables for customizing mail handling.
665 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
666 * Group Mail Splitting:: Use group customize to drive mail splitting.
667 * Incorporating Old Mail:: What about the old mail you have?
668 * Expiring Mail:: Getting rid of unwanted mail.
669 * Washing Mail:: Removing cruft from the mail you get.
670 * Duplicates:: Dealing with duplicated mail.
671 * Not Reading Mail:: Using mail back ends for reading other files.
672 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
676 * Mail Source Specifiers:: How to specify what a mail source is.
677 * Mail Source Customization:: Some variables that influence things.
678 * Fetching Mail:: Using the mail source specifiers.
680 Choosing a Mail Back End
682 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
683 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
684 * Mail Spool:: Store your mail in a private spool?
685 * MH Spool:: An mhspool-like back end.
686 * Maildir:: Another one-file-per-message format.
687 * Mail Folders:: Having one file for each group.
688 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
693 * Web Searches:: Creating groups from articles that match a string.
694 * Slashdot:: Reading the Slashdot comments.
695 * Ultimate:: The Ultimate Bulletin Board systems.
696 * Web Archive:: Reading mailing list archived on web.
697 * RSS:: Reading RDF site summary.
698 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
702 * Splitting in IMAP:: Splitting mail with nnimap.
703 * Expiring in IMAP:: Expiring mail with nnimap.
704 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
705 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
706 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
707 * Debugging IMAP:: What to do when things don't work.
711 * Directory Groups:: You can read a directory as if it was a newsgroup.
712 * Anything Groups:: Dired? Who needs dired?
713 * Document Groups:: Single files can be the basis of a group.
714 * SOUP:: Reading @sc{soup} packets ``offline''.
715 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
719 * Document Server Internals:: How to add your own document types.
723 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
724 * SOUP Groups:: A back end for reading @sc{soup} packets.
725 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
729 * Virtual Groups:: Combining articles from many groups.
730 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
734 * The NNDiary Back End:: Basic setup and usage.
735 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
736 * Sending or Not Sending:: A final note on sending diary messages.
740 * Diary Messages:: What makes a message valid for nndiary.
741 * Running NNDiary:: NNDiary has two modes of operation.
742 * Customizing NNDiary:: Bells and whistles.
744 The Gnus Diary Library
746 * Diary Summary Line Format:: A nicer summary buffer line format.
747 * Diary Articles Sorting:: A nicer way to sort messages.
748 * Diary Headers Generation:: Not doing it manually.
749 * Diary Group Parameters:: Not handling them manually.
753 * Agent Basics:: How it all is supposed to work.
754 * Agent Categories:: How to tell the Gnus Agent what to download.
755 * Agent Commands:: New commands for all the buffers.
756 * Agent Visuals:: Ways that the agent may effect your summary buffer.
757 * Agent as Cache:: The Agent is a big cache too.
758 * Agent Expiry:: How to make old articles go away.
759 * Agent Regeneration:: How to recover from lost connections and other accidents.
760 * Agent and flags:: How the Agent maintains flags.
761 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
762 * Outgoing Messages:: What happens when you post/mail something?
763 * Agent Variables:: Customizing is fun.
764 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
765 * Batching Agents:: How to fetch news from a @code{cron} job.
766 * Agent Caveats:: What you think it'll do and what it does.
770 * Category Syntax:: What a category looks like.
771 * Category Buffer:: A buffer for maintaining categories.
772 * Category Variables:: Customize'r'Us.
776 * Group Agent Commands:: Configure groups and fetch their contents.
777 * Summary Agent Commands:: Manually select then fetch specific articles.
778 * Server Agent Commands:: Select the servers that are supported by the agent.
782 * Summary Score Commands:: Adding score entries for the current group.
783 * Group Score Commands:: General score commands.
784 * Score Variables:: Customize your scoring. (My, what terminology).
785 * Score File Format:: What a score file may contain.
786 * Score File Editing:: You can edit score files by hand as well.
787 * Adaptive Scoring:: Big Sister Gnus knows what you read.
788 * Home Score File:: How to say where new score entries are to go.
789 * Followups To Yourself:: Having Gnus notice when people answer you.
790 * Scoring On Other Headers:: Scoring on non-standard headers.
791 * Scoring Tips:: How to score effectively.
792 * Reverse Scoring:: That problem child of old is not problem.
793 * Global Score Files:: Earth-spanning, ear-splitting score files.
794 * Kill Files:: They are still here, but they can be ignored.
795 * Converting Kill Files:: Translating kill files to score files.
796 * Advanced Scoring:: Using logical expressions to build score rules.
797 * Score Decays:: It can be useful to let scores wither away.
801 * Advanced Scoring Syntax:: A definition.
802 * Advanced Scoring Examples:: What they look like.
803 * Advanced Scoring Tips:: Getting the most out of it.
807 * Process/Prefix:: A convention used by many treatment commands.
808 * Interactive:: Making Gnus ask you many questions.
809 * Symbolic Prefixes:: How to supply some Gnus functions with options.
810 * Formatting Variables:: You can specify what buffers should look like.
811 * Window Layout:: Configuring the Gnus buffer windows.
812 * Faces and Fonts:: How to change how faces look.
813 * Compilation:: How to speed Gnus up.
814 * Mode Lines:: Displaying information in the mode lines.
815 * Highlighting and Menus:: Making buffers look all nice and cozy.
816 * Buttons:: Get tendinitis in ten easy steps!
817 * Daemons:: Gnus can do things behind your back.
818 * NoCeM:: How to avoid spam and other fatty foods.
819 * Undo:: Some actions can be undone.
820 * Predicate Specifiers:: Specifying predicates.
821 * Moderation:: What to do if you're a moderator.
822 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
823 * Fuzzy Matching:: What's the big fuzz?
824 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
825 * Other modes:: Interaction with other modes.
826 * Various Various:: Things that are really various.
830 * Formatting Basics:: A formatting variable is basically a format string.
831 * Mode Line Formatting:: Some rules about mode line formatting variables.
832 * Advanced Formatting:: Modifying output in various ways.
833 * User-Defined Specs:: Having Gnus call your own functions.
834 * Formatting Fonts:: Making the formatting look colorful and nice.
835 * Positioning Point:: Moving point to a position after an operation.
836 * Tabulation:: Tabulating your output.
837 * Wide Characters:: Dealing with wide characters.
841 * X-Face:: Display a funky, teensy black-and-white image.
842 * Face:: Display a funkier, teensier colored image.
843 * Smileys:: Show all those happy faces the way they were meant to be shown.
844 * Picons:: How to display pictures of what you're reading.
845 * XVarious:: Other XEmacsy Gnusey variables.
849 * The problem of spam:: Some background, and some solutions
850 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
851 * SpamAssassin:: How to use external anti-spam tools.
852 * Hashcash:: Reduce spam by burning CPU time.
853 * Filtering Spam Using The Spam ELisp Package::
854 * Filtering Spam Using Statistics with spam-stat::
856 Filtering Spam Using The Spam ELisp Package
858 * Spam ELisp Package Sequence of Events::
859 * Spam ELisp Package Filtering of Incoming Mail::
860 * Spam ELisp Package Global Variables::
861 * Spam ELisp Package Configuration Examples::
862 * Blacklists and Whitelists::
864 * Gmane Spam Reporting::
865 * Anti-spam Hashcash Payments::
867 * Regular Expressions Header Matching::
869 * SpamAssassin back end::
870 * ifile spam filtering::
871 * spam-stat spam filtering::
873 * Extending the Spam ELisp package::
875 Filtering Spam Using Statistics with spam-stat
877 * Creating a spam-stat dictionary::
878 * Splitting mail using spam-stat::
879 * Low-level interface to the spam-stat dictionary::
883 * XEmacs:: Requirements for installing under XEmacs.
884 * History:: How Gnus got where it is today.
885 * On Writing Manuals:: Why this is not a beginner's guide.
886 * Terminology:: We use really difficult, like, words here.
887 * Customization:: Tailoring Gnus to your needs.
888 * Troubleshooting:: What you might try if things do not work.
889 * Gnus Reference Guide:: Rilly, rilly technical stuff.
890 * Emacs for Heathens:: A short introduction to Emacsian terms.
891 * Frequently Asked Questions:: The Gnus FAQ
895 * Gnus Versions:: What Gnus versions have been released.
896 * Other Gnus Versions:: Other Gnus versions that also have been released.
897 * Why?:: What's the point of Gnus?
898 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
899 * Conformity:: Gnus tries to conform to all standards.
900 * Emacsen:: Gnus can be run on a few modern Emacsen.
901 * Gnus Development:: How Gnus is developed.
902 * Contributors:: Oodles of people.
903 * New Features:: Pointers to some of the new stuff in Gnus.
907 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
908 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
909 * Red Gnus:: Third time best---Gnus 5.4/5.5.
910 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
911 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
912 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
913 * No Gnus:: Very punny.
917 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
918 * Slow Terminal Connection:: You run a remote Emacs.
919 * Little Disk Space:: You feel that having large setup files is icky.
920 * Slow Machine:: You feel like buying a faster machine.
924 * Gnus Utility Functions:: Common functions and variable to use.
925 * Back End Interface:: How Gnus communicates with the servers.
926 * Score File Syntax:: A BNF definition of the score file standard.
927 * Headers:: How Gnus stores headers internally.
928 * Ranges:: A handy format for storing mucho numbers.
929 * Group Info:: The group info format.
930 * Extended Interactive:: Symbolic prefixes and stuff.
931 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
932 * Various File Formats:: Formats of files that Gnus use.
936 * Required Back End Functions:: Functions that must be implemented.
937 * Optional Back End Functions:: Functions that need not be implemented.
938 * Error Messaging:: How to get messages and report errors.
939 * Writing New Back Ends:: Extending old back ends.
940 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
941 * Mail-like Back Ends:: Some tips on mail back ends.
945 * Active File Format:: Information on articles and groups available.
946 * Newsgroups File Format:: Group descriptions.
950 * Keystrokes:: Entering text and executing commands.
951 * Emacs Lisp:: The built-in Emacs programming language.
957 @chapter Starting gnus
962 If your system administrator has set things up properly, starting gnus
963 and reading news is extremely easy---you just type @kbd{M-x gnus} in
966 @findex gnus-other-frame
967 @kindex M-x gnus-other-frame
968 If you want to start gnus in a different frame, you can use the command
969 @kbd{M-x gnus-other-frame} instead.
971 If things do not go smoothly at startup, you have to twiddle some
972 variables in your @file{~/.gnus.el} file. This file is similar to
973 @file{~/.emacs}, but is read when Gnus starts.
975 If you puzzle at any terms used in this manual, please refer to the
976 terminology section (@pxref{Terminology}).
979 * Finding the News:: Choosing a method for getting news.
980 * The First Time:: What does Gnus do the first time you start it?
981 * The Server is Down:: How can I read my mail then?
982 * Slave Gnusae:: You can have more than one Gnus active at a time.
983 * New Groups:: What is Gnus supposed to do with new groups?
984 * Changing Servers:: You may want to move from one server to another.
985 * Startup Files:: Those pesky startup files---@file{.newsrc}.
986 * Auto Save:: Recovering from a crash.
987 * The Active File:: Reading the active file over a slow line Takes Time.
988 * Startup Variables:: Other variables you might change.
992 @node Finding the News
993 @section Finding the News
996 @vindex gnus-select-method
998 The @code{gnus-select-method} variable says where gnus should look for
999 news. This variable should be a list where the first element says
1000 @dfn{how} and the second element says @dfn{where}. This method is your
1001 native method. All groups not fetched with this method are
1004 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
1005 you want to get your daily dosage of news from, you'd say:
1008 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1011 If you want to read directly from the local spool, say:
1014 (setq gnus-select-method '(nnspool ""))
1017 If you can use a local spool, you probably should, as it will almost
1018 certainly be much faster. But do not use the local spool if your
1019 server is running Leafnode (which is a simple, standalone private news
1020 server); in this case, use @code{(nntp "localhost")}.
1022 @vindex gnus-nntpserver-file
1024 @cindex @acronym{NNTP} server
1025 If this variable is not set, gnus will take a look at the
1026 @env{NNTPSERVER} environment variable. If that variable isn't set,
1027 gnus will see whether @code{gnus-nntpserver-file}
1028 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1029 If that fails as well, gnus will try to use the machine running Emacs
1030 as an @acronym{NNTP} server. That's a long shot, though.
1032 @vindex gnus-nntp-server
1033 If @code{gnus-nntp-server} is set, this variable will override
1034 @code{gnus-select-method}. You should therefore set
1035 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1037 @vindex gnus-secondary-servers
1038 @vindex gnus-nntp-server
1039 You can also make gnus prompt you interactively for the name of an
1040 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1041 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
1042 in the @code{gnus-secondary-servers} list (if any). You can also just
1043 type in the name of any server you feel like visiting. (Note that this
1044 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1045 gnus} later in the same Emacs session, Gnus will contact the same
1048 @findex gnus-group-browse-foreign-server
1050 However, if you use one @acronym{NNTP} server regularly and are just
1051 interested in a couple of groups from a different server, you would be
1052 better served by using the @kbd{B} command in the group buffer. It will
1053 let you have a look at what groups are available, and you can subscribe
1054 to any of the groups you want to. This also makes @file{.newsrc}
1055 maintenance much tidier. @xref{Foreign Groups}.
1057 @vindex gnus-secondary-select-methods
1059 A slightly different approach to foreign groups is to set the
1060 @code{gnus-secondary-select-methods} variable. The select methods
1061 listed in this variable are in many ways just as native as the
1062 @code{gnus-select-method} server. They will also be queried for active
1063 files during startup (if that's required), and new newsgroups that
1064 appear on these servers will be subscribed (or not) just as native
1067 For instance, if you use the @code{nnmbox} back end to read your mail,
1068 you would typically set this variable to
1071 (setq gnus-secondary-select-methods '((nnmbox "")))
1074 Note: the @acronym{NNTP} back end stores marks in marks files
1075 (@pxref{NNTP marks}). This feature makes it easy to share marks between
1076 several Gnus installations, but may slow down things a bit when fetching
1077 new articles. @xref{NNTP marks}, for more information.
1080 @node The First Time
1081 @section The First Time
1082 @cindex first time usage
1084 If no startup files exist (@pxref{Startup Files}), gnus will try to
1085 determine what groups should be subscribed by default.
1087 @vindex gnus-default-subscribed-newsgroups
1088 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1089 will subscribe you to just those groups in that list, leaving the rest
1090 killed. Your system administrator should have set this variable to
1093 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1094 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1095 here as @dfn{whatever Lars thinks you should read}.)
1097 You'll also be subscribed to the gnus documentation group, which should
1098 help you with most common problems.
1100 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1101 use the normal functions for handling new groups, and not do anything
1105 @node The Server is Down
1106 @section The Server is Down
1107 @cindex server errors
1109 If the default server is down, gnus will understandably have some
1110 problems starting. However, if you have some mail groups in addition to
1111 the news groups, you may want to start gnus anyway.
1113 Gnus, being the trusting sort of program, will ask whether to proceed
1114 without a native select method if that server can't be contacted. This
1115 will happen whether the server doesn't actually exist (i.e., you have
1116 given the wrong address) or the server has just momentarily taken ill
1117 for some reason or other. If you decide to continue and have no foreign
1118 groups, you'll find it difficult to actually do anything in the group
1119 buffer. But, hey, that's your problem. Blllrph!
1121 @findex gnus-no-server
1122 @kindex M-x gnus-no-server
1124 If you know that the server is definitely down, or you just want to read
1125 your mail without bothering with the server at all, you can use the
1126 @code{gnus-no-server} command to start gnus. That might come in handy
1127 if you're in a hurry as well. This command will not attempt to contact
1128 your primary server---instead, it will just activate all groups on level
1129 1 and 2. (You should preferably keep no native groups on those two
1130 levels.) Also @pxref{Group Levels}.
1134 @section Slave Gnusae
1137 You might want to run more than one Emacs with more than one gnus at the
1138 same time. If you are using different @file{.newsrc} files (e.g., if you
1139 are using the two different gnusae to read from two different servers),
1140 that is no problem whatsoever. You just do it.
1142 The problem appears when you want to run two Gnusae that use the same
1143 @file{.newsrc} file.
1145 To work around that problem some, we here at the Think-Tank at the gnus
1146 Towers have come up with a new concept: @dfn{Masters} and
1147 @dfn{slaves}. (We have applied for a patent on this concept, and have
1148 taken out a copyright on those words. If you wish to use those words in
1149 conjunction with each other, you have to send $1 per usage instance to
1150 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1151 Applications}) will be much more expensive, of course.)
1154 Anyway, you start one gnus up the normal way with @kbd{M-x gnus} (or
1155 however you do it). Each subsequent slave gnusae should be started with
1156 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1157 files, but instead save @dfn{slave files} that contain information only
1158 on what groups have been read in the slave session. When a master gnus
1159 starts, it will read (and delete) these slave files, incorporating all
1160 information from them. (The slave files will be read in the sequence
1161 they were created, so the latest changes will have precedence.)
1163 Information from the slave files has, of course, precedence over the
1164 information in the normal (i.e., master) @file{.newsrc} file.
1166 If the @file{.newsrc*} files have not been saved in the master when the
1167 slave starts, you may be prompted as to whether to read an auto-save
1168 file. If you answer ``yes'', the unsaved changes to the master will be
1169 incorporated into the slave. If you answer ``no'', the slave may see some
1170 messages as unread that have been read in the master.
1177 @cindex subscription
1179 @vindex gnus-check-new-newsgroups
1180 If you are satisfied that you really never want to see any new groups,
1181 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1182 also save you some time at startup. Even if this variable is
1183 @code{nil}, you can always subscribe to the new groups just by pressing
1184 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1185 is @code{ask-server} by default. If you set this variable to
1186 @code{always}, then Gnus will query the back ends for new groups even
1187 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1190 * Checking New Groups:: Determining what groups are new.
1191 * Subscription Methods:: What Gnus should do with new groups.
1192 * Filtering New Groups:: Making Gnus ignore certain new groups.
1196 @node Checking New Groups
1197 @subsection Checking New Groups
1199 Gnus normally determines whether a group is new or not by comparing the
1200 list of groups from the active file(s) with the lists of subscribed and
1201 dead groups. This isn't a particularly fast method. If
1202 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1203 server for new groups since the last time. This is both faster and
1204 cheaper. This also means that you can get rid of the list of killed
1205 groups altogether, so you may set @code{gnus-save-killed-list} to
1206 @code{nil}, which will save time both at startup, at exit, and all over.
1207 Saves disk space, too. Why isn't this the default, then?
1208 Unfortunately, not all servers support this command.
1210 I bet I know what you're thinking now: How do I find out whether my
1211 server supports @code{ask-server}? No? Good, because I don't have a
1212 fail-safe answer. I would suggest just setting this variable to
1213 @code{ask-server} and see whether any new groups appear within the next
1214 few days. If any do, then it works. If none do, then it doesn't
1215 work. I could write a function to make gnus guess whether the server
1216 supports @code{ask-server}, but it would just be a guess. So I won't.
1217 You could @code{telnet} to the server and say @code{HELP} and see
1218 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1219 it does, then it might work. (But there are servers that lists
1220 @samp{NEWGROUPS} without supporting the function properly.)
1222 This variable can also be a list of select methods. If so, gnus will
1223 issue an @code{ask-server} command to each of the select methods, and
1224 subscribe them (or not) using the normal methods. This might be handy
1225 if you are monitoring a few servers for new groups. A side effect is
1226 that startup will take much longer, so you can meditate while waiting.
1227 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1230 @node Subscription Methods
1231 @subsection Subscription Methods
1233 @vindex gnus-subscribe-newsgroup-method
1234 What gnus does when it encounters a new group is determined by the
1235 @code{gnus-subscribe-newsgroup-method} variable.
1237 This variable should contain a function. This function will be called
1238 with the name of the new group as the only parameter.
1240 Some handy pre-fab functions are:
1244 @item gnus-subscribe-zombies
1245 @vindex gnus-subscribe-zombies
1246 Make all new groups zombies. This is the default. You can browse the
1247 zombies later (with @kbd{A z}) and either kill them all off properly
1248 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1250 @item gnus-subscribe-randomly
1251 @vindex gnus-subscribe-randomly
1252 Subscribe all new groups in arbitrary order. This really means that all
1253 new groups will be added at ``the top'' of the group buffer.
1255 @item gnus-subscribe-alphabetically
1256 @vindex gnus-subscribe-alphabetically
1257 Subscribe all new groups in alphabetical order.
1259 @item gnus-subscribe-hierarchically
1260 @vindex gnus-subscribe-hierarchically
1261 Subscribe all new groups hierarchically. The difference between this
1262 function and @code{gnus-subscribe-alphabetically} is slight.
1263 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1264 alphabetical fashion, while this function will enter groups into its
1265 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1266 @samp{comp} hierarchy, this function will not mess that configuration
1267 up. Or something like that.
1269 @item gnus-subscribe-interactively
1270 @vindex gnus-subscribe-interactively
1271 Subscribe new groups interactively. This means that gnus will ask
1272 you about @strong{all} new groups. The groups you choose to subscribe
1273 to will be subscribed hierarchically.
1275 @item gnus-subscribe-killed
1276 @vindex gnus-subscribe-killed
1277 Kill all new groups.
1279 @item gnus-subscribe-topics
1280 @vindex gnus-subscribe-topics
1281 Put the groups into the topic that has a matching @code{subscribe} topic
1282 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1283 topic parameter that looks like
1289 will mean that all groups that match that regex will be subscribed under
1292 If no topics match the groups, the groups will be subscribed in the
1297 @vindex gnus-subscribe-hierarchical-interactive
1298 A closely related variable is
1299 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1300 mouthful.) If this variable is non-@code{nil}, gnus will ask you in a
1301 hierarchical fashion whether to subscribe to new groups or not. Gnus
1302 will ask you for each sub-hierarchy whether you want to descend the
1305 One common mistake is to set the variable a few paragraphs above
1306 (@code{gnus-subscribe-newsgroup-method}) to
1307 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1308 will not work. This is ga-ga. So don't do it.
1311 @node Filtering New Groups
1312 @subsection Filtering New Groups
1314 A nice and portable way to control which new newsgroups should be
1315 subscribed (or ignored) is to put an @dfn{options} line at the start of
1316 the @file{.newsrc} file. Here's an example:
1319 options -n !alt.all !rec.all sci.all
1322 @vindex gnus-subscribe-options-newsgroup-method
1323 This line obviously belongs to a serious-minded intellectual scientific
1324 person (or she may just be plain old boring), because it says that all
1325 groups that have names beginning with @samp{alt} and @samp{rec} should
1326 be ignored, and all groups with names beginning with @samp{sci} should
1327 be subscribed. Gnus will not use the normal subscription method for
1328 subscribing these groups.
1329 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1330 variable defaults to @code{gnus-subscribe-alphabetically}.
1332 @vindex gnus-options-not-subscribe
1333 @vindex gnus-options-subscribe
1334 If you don't want to mess with your @file{.newsrc} file, you can just
1335 set the two variables @code{gnus-options-subscribe} and
1336 @code{gnus-options-not-subscribe}. These two variables do exactly the
1337 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1338 and if the new group matches the former, it will be unconditionally
1339 subscribed, and if it matches the latter, it will be ignored.
1341 @vindex gnus-auto-subscribed-groups
1342 Yet another variable that meddles here is
1343 @code{gnus-auto-subscribed-groups}. It works exactly like
1344 @code{gnus-options-subscribe}, and is therefore really superfluous,
1345 but I thought it would be nice to have two of these. This variable is
1346 more meant for setting some ground rules, while the other variable is
1347 used more for user fiddling. By default this variable makes all new
1348 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1349 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1350 subscribed. If you don't like that, just set this variable to
1353 New groups that match this regexp are subscribed using
1354 @code{gnus-subscribe-options-newsgroup-method}.
1357 @node Changing Servers
1358 @section Changing Servers
1359 @cindex changing servers
1361 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1362 This happens very rarely, but perhaps you change jobs, or one server is
1363 very flaky and you want to use another.
1365 Changing the server is pretty easy, right? You just change
1366 @code{gnus-select-method} to point to the new server?
1370 Article numbers are not (in any way) kept synchronized between different
1371 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1372 you have read is by keeping track of article numbers. So when you
1373 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1376 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1377 file from one server to another. They all have one thing in
1378 common---they take a looong time to run. You don't want to use these
1379 functions more than absolutely necessary.
1381 @kindex M-x gnus-change-server
1382 @findex gnus-change-server
1383 If you have access to both servers, Gnus can request the headers for all
1384 the articles you have read and compare @code{Message-ID}s and map the
1385 article numbers of the read articles and article marks. The @kbd{M-x
1386 gnus-change-server} command will do this for all your native groups. It
1387 will prompt for the method you want to move to.
1389 @kindex M-x gnus-group-move-group-to-server
1390 @findex gnus-group-move-group-to-server
1391 You can also move individual groups with the @kbd{M-x
1392 gnus-group-move-group-to-server} command. This is useful if you want to
1393 move a (foreign) group from one server to another.
1395 @kindex M-x gnus-group-clear-data-on-native-groups
1396 @findex gnus-group-clear-data-on-native-groups
1397 If you don't have access to both the old and new server, all your marks
1398 and read ranges have become worthless. You can use the @kbd{M-x
1399 gnus-group-clear-data-on-native-groups} command to clear out all data
1400 that you have on your native groups. Use with caution.
1402 @kindex M-x gnus-group-clear-data
1403 @findex gnus-group-clear-data
1404 Clear the data from the current group only---nix out marks and the
1405 list of read articles (@code{gnus-group-clear-data}).
1407 After changing servers, you @strong{must} move the cache hierarchy away,
1408 since the cached articles will have wrong article numbers, which will
1409 affect which articles Gnus thinks are read.
1410 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1411 to have it done automatically; for @code{gnus-group-clear-data}, you
1412 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1413 cache for all groups).
1417 @section Startup Files
1418 @cindex startup files
1423 Most common Unix news readers use a shared startup file called
1424 @file{.newsrc}. This file contains all the information about what
1425 groups are subscribed, and which articles in these groups have been
1428 Things got a bit more complicated with @sc{gnus}. In addition to
1429 keeping the @file{.newsrc} file updated, it also used a file called
1430 @file{.newsrc.el} for storing all the information that didn't fit into
1431 the @file{.newsrc} file. (Actually, it also duplicated everything in
1432 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1433 files was the most recently saved, which enabled people to swap between
1434 @sc{gnus} and other newsreaders.
1436 That was kinda silly, so Gnus went one better: In addition to the
1437 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1438 @file{.newsrc.eld}. It will read whichever of these files that are most
1439 recent, but it will never write a @file{.newsrc.el} file. You should
1440 never delete the @file{.newsrc.eld} file---it contains much information
1441 not stored in the @file{.newsrc} file.
1443 @vindex gnus-save-newsrc-file
1444 @vindex gnus-read-newsrc-file
1445 You can turn off writing the @file{.newsrc} file by setting
1446 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1447 the file and save some space, as well as exiting from gnus faster.
1448 However, this will make it impossible to use other newsreaders than
1449 gnus. But hey, who would want to, right? Similarly, setting
1450 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1451 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which can be
1452 convenient if you use a different news reader occasionally, and you
1453 want to read a different subset of the available groups with that
1456 @vindex gnus-save-killed-list
1457 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1458 will not save the list of killed groups to the startup file. This will
1459 save both time (when starting and quitting) and space (on disk). It
1460 will also mean that Gnus has no record of what groups are new or old,
1461 so the automatic new groups subscription methods become meaningless.
1462 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1463 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1464 Groups}). This variable can also be a regular expression. If that's
1465 the case, remove all groups that do not match this regexp before
1466 saving. This can be useful in certain obscure situations that involve
1467 several servers where not all servers support @code{ask-server}.
1469 @vindex gnus-startup-file
1470 @vindex gnus-backup-startup-file
1471 @vindex version-control
1472 The @code{gnus-startup-file} variable says where the startup files are.
1473 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1474 file being whatever that one is, with a @samp{.eld} appended.
1475 If you want version control for this file, set
1476 @code{gnus-backup-startup-file}. It respects the same values as the
1477 @code{version-control} variable.
1479 @vindex gnus-save-newsrc-hook
1480 @vindex gnus-save-quick-newsrc-hook
1481 @vindex gnus-save-standard-newsrc-hook
1482 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1483 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1484 saving the @file{.newsrc.eld} file, and
1485 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1486 @file{.newsrc} file. The latter two are commonly used to turn version
1487 control on or off. Version control is on by default when saving the
1488 startup files. If you want to turn backup creation off, say something like:
1491 (defun turn-off-backup ()
1492 (set (make-local-variable 'backup-inhibited) t))
1494 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1495 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1498 @vindex gnus-init-file
1499 @vindex gnus-site-init-file
1500 When Gnus starts, it will read the @code{gnus-site-init-file}
1501 (@file{.../site-lisp/gnus-init} by default) and @code{gnus-init-file}
1502 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1503 and can be used to avoid cluttering your @file{~/.emacs} and
1504 @file{site-init} files with Gnus stuff. Gnus will also check for files
1505 with the same names as these, but with @file{.elc} and @file{.el}
1506 suffixes. In other words, if you have set @code{gnus-init-file} to
1507 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1508 and finally @file{~/.gnus} (in this order). If Emacs was invoked with
1509 the @option{-q} or @option{--no-init-file} options (@pxref{Initial
1510 Options, ,Initial Options, emacs, The Emacs Manual}), Gnus doesn't read
1511 @code{gnus-init-file}.
1516 @cindex dribble file
1519 Whenever you do something that changes the gnus data (reading articles,
1520 catching up, killing/subscribing groups), the change is added to a
1521 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1522 Emacs way. If your Emacs should crash before you have saved the
1523 @file{.newsrc} files, all changes you have made can be recovered from
1526 If gnus detects this file at startup, it will ask the user whether to
1527 read it. The auto save file is deleted whenever the real startup file is
1530 @vindex gnus-use-dribble-file
1531 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1532 maintain a dribble buffer. The default is @code{t}.
1534 @vindex gnus-dribble-directory
1535 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1536 this variable is @code{nil}, which it is by default, gnus will dribble
1537 into the directory where the @file{.newsrc} file is located. (This is
1538 normally the user's home directory.) The dribble file will get the same
1539 file permissions as the @file{.newsrc} file.
1541 @vindex gnus-always-read-dribble-file
1542 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1543 read the dribble file on startup without querying the user.
1546 @node The Active File
1547 @section The Active File
1549 @cindex ignored groups
1551 When gnus starts, or indeed whenever it tries to determine whether new
1552 articles have arrived, it reads the active file. This is a very large
1553 file that lists all the active groups and articles on the server.
1555 @vindex gnus-ignored-newsgroups
1556 Before examining the active file, gnus deletes all lines that match the
1557 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1558 any groups with bogus names, but you can use this variable to make gnus
1559 ignore hierarchies you aren't ever interested in. However, this is not
1560 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1561 Groups} for an overview of other variables that can be used instead.
1564 @c @code{nil} by default, and will slow down active file handling somewhat
1565 @c if you set it to anything else.
1567 @vindex gnus-read-active-file
1569 The active file can be rather Huge, so if you have a slow network, you
1570 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1571 reading the active file. This variable is @code{some} by default.
1573 Gnus will try to make do by getting information just on the groups that
1574 you actually subscribe to.
1576 Note that if you subscribe to lots and lots of groups, setting this
1577 variable to @code{nil} will probably make gnus slower, not faster. At
1578 present, having this variable @code{nil} will slow gnus down
1579 considerably, unless you read news over a 2400 baud modem.
1581 This variable can also have the value @code{some}. Gnus will then
1582 attempt to read active info only on the subscribed groups. On some
1583 servers this is quite fast (on sparkling, brand new INN servers that
1584 support the @code{LIST ACTIVE group} command), on others this isn't fast
1585 at all. In any case, @code{some} should be faster than @code{nil}, and
1586 is certainly faster than @code{t} over slow lines.
1588 Some news servers (old versions of Leafnode and old versions of INN, for
1589 instance) do not support the @code{LIST ACTIVE group}. For these
1590 servers, @code{nil} is probably the most efficient value for this
1593 If this variable is @code{nil}, gnus will ask for group info in total
1594 lock-step, which isn't very fast. If it is @code{some} and you use an
1595 @acronym{NNTP} server, gnus will pump out commands as fast as it can, and
1596 read all the replies in one swoop. This will normally result in better
1597 performance, but if the server does not support the aforementioned
1598 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1600 If you think that starting up Gnus takes too long, try all the three
1601 different values for this variable and see what works best for you.
1603 In any case, if you use @code{some} or @code{nil}, you should definitely
1604 kill all groups that you aren't interested in to speed things up.
1606 Note that this variable also affects active file retrieval from
1607 secondary select methods.
1610 @node Startup Variables
1611 @section Startup Variables
1615 @item gnus-load-hook
1616 @vindex gnus-load-hook
1617 A hook run while gnus is being loaded. Note that this hook will
1618 normally be run just once in each Emacs session, no matter how many
1619 times you start gnus.
1621 @item gnus-before-startup-hook
1622 @vindex gnus-before-startup-hook
1623 A hook run after starting up gnus successfully.
1625 @item gnus-startup-hook
1626 @vindex gnus-startup-hook
1627 A hook run as the very last thing after starting up gnus
1629 @item gnus-started-hook
1630 @vindex gnus-started-hook
1631 A hook that is run as the very last thing after starting up gnus
1634 @item gnus-setup-news-hook
1635 @vindex gnus-setup-news-hook
1636 A hook that is run after reading the @file{.newsrc} file(s), but before
1637 generating the group buffer.
1639 @item gnus-check-bogus-newsgroups
1640 @vindex gnus-check-bogus-newsgroups
1641 If non-@code{nil}, gnus will check for and delete all bogus groups at
1642 startup. A @dfn{bogus group} is a group that you have in your
1643 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1644 bogus groups can take quite a while, so to save time and resources it's
1645 best to leave this option off, and do the checking for bogus groups once
1646 in a while from the group buffer instead (@pxref{Group Maintenance}).
1648 @item gnus-inhibit-startup-message
1649 @vindex gnus-inhibit-startup-message
1650 If non-@code{nil}, the startup message won't be displayed. That way,
1651 your boss might not notice as easily that you are reading news instead
1652 of doing your job. Note that this variable is used before
1653 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1655 @item gnus-no-groups-message
1656 @vindex gnus-no-groups-message
1657 Message displayed by gnus when no groups are available.
1659 @item gnus-play-startup-jingle
1660 @vindex gnus-play-startup-jingle
1661 If non-@code{nil}, play the gnus jingle at startup.
1663 @item gnus-startup-jingle
1664 @vindex gnus-startup-jingle
1665 Jingle to be played if the above variable is non-@code{nil}. The
1666 default is @samp{Tuxedomoon.Jingle4.au}.
1672 @chapter Group Buffer
1673 @cindex group buffer
1675 @c Alex Schroeder suggests to rearrange this as follows:
1677 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1678 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1679 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1680 @c 7. Group Score, 8. Group Buffer Format
1681 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1682 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1683 @c <kensanata> First, "Gnus considers groups... (default 9)."
1684 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1685 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1686 @c <kensanata> Then expand the next paragraph or add some more to it.
1687 @c This short one sentence explains levels 1 and 2, therefore I understand
1688 @c that I should keep important news at 3 and boring news at 4.
1689 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1690 @c Maybe keep those that you don't want to read temporarily at 6,
1691 @c those that you never want to read at 8, those that offend your
1692 @c human rights at 9...
1695 The @dfn{group buffer} lists all (or parts) of the available groups. It
1696 is the first buffer shown when gnus starts, and will never be killed as
1697 long as gnus is active.
1701 \gnusfigure{The Group Buffer}{320}{
1702 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1703 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1704 \put(120,38){\vector(1,2){10}}
1705 \put(40,60){\makebox(0,0)[r]{Mode line}}
1706 \put(40,58){\vector(1,0){30}}
1707 \put(200,28){\makebox(0,0)[t]{Native select method}}
1708 \put(200,26){\vector(-1,2){15}}
1714 * Group Buffer Format:: Information listed and how you can change it.
1715 * Group Maneuvering:: Commands for moving in the group buffer.
1716 * Selecting a Group:: Actually reading news.
1717 * Subscription Commands:: Unsubscribing, killing, subscribing.
1718 * Group Data:: Changing the info for a group.
1719 * Group Levels:: Levels? What are those, then?
1720 * Group Score:: A mechanism for finding out what groups you like.
1721 * Marking Groups:: You can mark groups for later processing.
1722 * Foreign Groups:: Creating and editing groups.
1723 * Group Parameters:: Each group may have different parameters set.
1724 * Listing Groups:: Gnus can list various subsets of the groups.
1725 * Sorting Groups:: Re-arrange the group order.
1726 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1727 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1728 * Exiting Gnus:: Stop reading news and get some work done.
1729 * Group Topics:: A folding group mode divided into topics.
1730 * Misc Group Stuff:: Other stuff that you can to do.
1734 @node Group Buffer Format
1735 @section Group Buffer Format
1738 * Group Line Specification:: Deciding how the group buffer is to look.
1739 * Group Mode Line Specification:: The group buffer mode line.
1740 * Group Highlighting:: Having nice colors in the group buffer.
1744 @node Group Line Specification
1745 @subsection Group Line Specification
1746 @cindex group buffer format
1748 The default format of the group buffer is nice and dull, but you can
1749 make it as exciting and ugly as you feel like.
1751 Here's a couple of example group lines:
1754 25: news.announce.newusers
1755 * 0: alt.fan.andrea-dworkin
1760 You can see that there are 25 unread articles in
1761 @samp{news.announce.newusers}. There are no unread articles, but some
1762 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1763 asterisk at the beginning of the line?).
1765 @vindex gnus-group-line-format
1766 You can change that format to whatever you want by fiddling with the
1767 @code{gnus-group-line-format} variable. This variable works along the
1768 lines of a @code{format} specification, which is pretty much the same as
1769 a @code{printf} specifications, for those of you who use (feh!) C.
1770 @xref{Formatting Variables}.
1772 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1774 There should always be a colon on the line; the cursor always moves to
1775 the colon after performing an operation. @xref{Positioning
1776 Point}. Nothing else is required---not even the group name. All
1777 displayed text is just window dressing, and is never examined by Gnus.
1778 Gnus stores all real information it needs using text properties.
1780 (Note that if you make a really strange, wonderful, spreadsheet-like
1781 layout, everybody will believe you are hard at work with the accounting
1782 instead of wasting time reading news.)
1784 Here's a list of all available format characters:
1789 An asterisk if the group only has marked articles.
1792 Whether the group is subscribed.
1795 Level of subscribedness.
1798 Number of unread articles.
1801 Number of dormant articles.
1804 Number of ticked articles.
1807 Number of read articles.
1810 Number of unseen articles.
1813 Estimated total number of articles. (This is really @var{max-number}
1814 minus @var{min-number} plus 1.)
1816 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1817 efficient access to @var{max-number} and @var{min-number} but getting
1818 the true unread message count is not possible efficiently. For
1819 hysterical raisins, even the mail back ends, where the true number of
1820 unread messages might be available efficiently, use the same limited
1821 interface. To remove this restriction from Gnus means that the back
1822 end interface has to be changed, which is not an easy job. If you
1823 want to work on this, please contact the Gnus mailing list.
1826 Number of unread, unticked, non-dormant articles.
1829 Number of ticked and dormant articles.
1838 Group comment (@pxref{Group Parameters}) or group name if there is no
1839 comment element in the group parameters.
1842 Newsgroup description. You need to read the group descriptions
1843 before these will appear, and to do that, you either have to set
1844 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1848 @samp{m} if moderated.
1851 @samp{(m)} if moderated.
1857 If the summary buffer for the group is open or not.
1863 A string that looks like @samp{<%s:%n>} if a foreign select method is
1867 Indentation based on the level of the topic (@pxref{Group Topics}).
1870 @vindex gnus-group-uncollapsed-levels
1871 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1872 variable says how many levels to leave at the end of the group name.
1873 The default is 1---this will mean that group names like
1874 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1877 @vindex gnus-new-mail-mark
1879 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1883 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1886 A string that says when you last read the group (@pxref{Group
1890 The disk space used by the articles fetched by both the cache and
1891 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1892 megabytes(M), or gigabytes(G) to minimize the column width. A format
1893 of %7F is sufficient for a fixed-width column.
1896 User defined specifier. The next character in the format string should
1897 be a letter. Gnus will call the function
1898 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1899 following @samp{%u}. The function will be passed a single dummy
1900 parameter as argument. The function should return a string, which will
1901 be inserted into the buffer just like information from any other
1906 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1907 if no info is available---for instance, if it is a non-activated foreign
1908 group, or a bogus native group.
1911 @node Group Mode Line Specification
1912 @subsection Group Mode Line Specification
1913 @cindex group mode line
1915 @vindex gnus-group-mode-line-format
1916 The mode line can be changed by setting
1917 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1918 doesn't understand that many format specifiers:
1922 The native news server.
1924 The native select method.
1928 @node Group Highlighting
1929 @subsection Group Highlighting
1930 @cindex highlighting
1931 @cindex group highlighting
1933 @vindex gnus-group-highlight
1934 Highlighting in the group buffer is controlled by the
1935 @code{gnus-group-highlight} variable. This is an alist with elements
1936 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1937 something non-@code{nil}, the @var{face} will be used on the line.
1939 Here's an example value for this variable that might look nice if the
1943 (cond (window-system
1944 (setq custom-background-mode 'light)
1945 (defface my-group-face-1
1946 '((t (:foreground "Red" :bold t))) "First group face")
1947 (defface my-group-face-2
1948 '((t (:foreground "DarkSeaGreen4" :bold t)))
1949 "Second group face")
1950 (defface my-group-face-3
1951 '((t (:foreground "Green4" :bold t))) "Third group face")
1952 (defface my-group-face-4
1953 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1954 (defface my-group-face-5
1955 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1957 (setq gnus-group-highlight
1958 '(((> unread 200) . my-group-face-1)
1959 ((and (< level 3) (zerop unread)) . my-group-face-2)
1960 ((< level 3) . my-group-face-3)
1961 ((zerop unread) . my-group-face-4)
1962 (t . my-group-face-5)))
1965 Also @pxref{Faces and Fonts}.
1967 Variables that are dynamically bound when the forms are evaluated
1974 The number of unread articles in the group.
1978 Whether the group is a mail group.
1980 The level of the group.
1982 The score of the group.
1984 The number of ticked articles in the group.
1986 The total number of articles in the group. Or rather,
1987 @var{max-number} minus @var{min-number} plus one.
1989 When using the topic minor mode, this variable is bound to the current
1990 topic being inserted.
1993 When the forms are @code{eval}ed, point is at the beginning of the line
1994 of the group in question, so you can use many of the normal gnus
1995 functions for snarfing info on the group.
1997 @vindex gnus-group-update-hook
1998 @findex gnus-group-highlight-line
1999 @code{gnus-group-update-hook} is called when a group line is changed.
2000 It will not be called when @code{gnus-visual} is @code{nil}. This hook
2001 calls @code{gnus-group-highlight-line} by default.
2004 @node Group Maneuvering
2005 @section Group Maneuvering
2006 @cindex group movement
2008 All movement commands understand the numeric prefix and will behave as
2009 expected, hopefully.
2015 @findex gnus-group-next-unread-group
2016 Go to the next group that has unread articles
2017 (@code{gnus-group-next-unread-group}).
2023 @findex gnus-group-prev-unread-group
2024 Go to the previous group that has unread articles
2025 (@code{gnus-group-prev-unread-group}).
2029 @findex gnus-group-next-group
2030 Go to the next group (@code{gnus-group-next-group}).
2034 @findex gnus-group-prev-group
2035 Go to the previous group (@code{gnus-group-prev-group}).
2039 @findex gnus-group-next-unread-group-same-level
2040 Go to the next unread group on the same (or lower) level
2041 (@code{gnus-group-next-unread-group-same-level}).
2045 @findex gnus-group-prev-unread-group-same-level
2046 Go to the previous unread group on the same (or lower) level
2047 (@code{gnus-group-prev-unread-group-same-level}).
2050 Three commands for jumping to groups:
2056 @findex gnus-group-jump-to-group
2057 Jump to a group (and make it visible if it isn't already)
2058 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2063 @findex gnus-group-best-unread-group
2064 Jump to the unread group with the lowest level
2065 (@code{gnus-group-best-unread-group}).
2069 @findex gnus-group-first-unread-group
2070 Jump to the first group with unread articles
2071 (@code{gnus-group-first-unread-group}).
2074 @vindex gnus-group-goto-unread
2075 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2076 commands will move to the next group, not the next unread group. Even
2077 the commands that say they move to the next unread group. The default
2081 @node Selecting a Group
2082 @section Selecting a Group
2083 @cindex group selection
2088 @kindex SPACE (Group)
2089 @findex gnus-group-read-group
2090 Select the current group, switch to the summary buffer and display the
2091 first unread article (@code{gnus-group-read-group}). If there are no
2092 unread articles in the group, or if you give a non-numerical prefix to
2093 this command, gnus will offer to fetch all the old articles in this
2094 group from the server. If you give a numerical prefix @var{n}, @var{n}
2095 determines the number of articles Gnus will fetch. If @var{n} is
2096 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2097 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2099 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2100 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2101 - 4 2 SPC} fetches the 42 oldest ones.
2103 When you are in the group (in the Summary buffer), you can type
2104 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2109 @findex gnus-group-select-group
2110 Select the current group and switch to the summary buffer
2111 (@code{gnus-group-select-group}). Takes the same arguments as
2112 @code{gnus-group-read-group}---the only difference is that this command
2113 does not display the first unread article automatically upon group
2117 @kindex M-RET (Group)
2118 @findex gnus-group-quick-select-group
2119 This does the same as the command above, but tries to do it with the
2120 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2121 scoring/killing will be performed, there will be no highlights and no
2122 expunging. This might be useful if you're in a real hurry and have to
2123 enter some humongous group. If you give a 0 prefix to this command
2124 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
2125 which is useful if you want to toggle threading before generating the
2126 summary buffer (@pxref{Summary Generation Commands}).
2129 @kindex M-SPACE (Group)
2130 @findex gnus-group-visible-select-group
2131 This is yet one more command that does the same as the @kbd{RET}
2132 command, but this one does it without expunging and hiding dormants
2133 (@code{gnus-group-visible-select-group}).
2136 @kindex C-M-RET (Group)
2137 @findex gnus-group-select-group-ephemerally
2138 Finally, this command selects the current group ephemerally without
2139 doing any processing of its contents
2140 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2141 turned off. Everything you do in the group after selecting it in this
2142 manner will have no permanent effects.
2146 @vindex gnus-large-newsgroup
2147 The @code{gnus-large-newsgroup} variable says what Gnus should
2148 consider to be a big group. If it is @code{nil}, no groups are
2149 considered big. The default value is 200. If the group has more
2150 (unread and/or ticked) articles than this, gnus will query the user
2151 before entering the group. The user can then specify how many
2152 articles should be fetched from the server. If the user specifies a
2153 negative number (@var{-n}), the @var{n} oldest articles will be
2154 fetched. If it is positive, the @var{n} articles that have arrived
2155 most recently will be fetched.
2157 @vindex gnus-large-ephemeral-newsgroup
2158 @code{gnus-large-ephemeral-newsgroup} is the same as
2159 @code{gnus-large-newsgroup}, but is only used for ephemeral
2162 @vindex gnus-select-group-hook
2163 @vindex gnus-auto-select-first
2164 @vindex gnus-auto-select-subject
2165 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2166 automatically when entering a group with the @kbd{SPACE} command.
2167 Which article this is is controlled by the
2168 @code{gnus-auto-select-subject} variable. Valid values for this
2174 Place point on the subject line of the first unread article.
2177 Place point on the subject line of the first article.
2180 Place point on the subject line of the first unseen article.
2182 @item unseen-or-unread
2183 Place point on the subject line of the first unseen article, and if
2184 there is no such article, place point on the subject line of the first
2188 Place point on the subject line of the highest-scored unread article.
2192 This variable can also be a function. In that case, that function
2193 will be called to place point on a subject line.
2195 If you want to prevent automatic selection in some group (say, in a
2196 binary group with Huge articles) you can set the
2197 @code{gnus-auto-select-first} variable to @code{nil} in
2198 @code{gnus-select-group-hook}, which is called when a group is
2202 @node Subscription Commands
2203 @section Subscription Commands
2204 @cindex subscription
2212 @findex gnus-group-unsubscribe-current-group
2213 @c @icon{gnus-group-unsubscribe}
2214 Toggle subscription to the current group
2215 (@code{gnus-group-unsubscribe-current-group}).
2221 @findex gnus-group-unsubscribe-group
2222 Prompt for a group to subscribe, and then subscribe it. If it was
2223 subscribed already, unsubscribe it instead
2224 (@code{gnus-group-unsubscribe-group}).
2230 @findex gnus-group-kill-group
2231 @c @icon{gnus-group-kill-group}
2232 Kill the current group (@code{gnus-group-kill-group}).
2238 @findex gnus-group-yank-group
2239 Yank the last killed group (@code{gnus-group-yank-group}).
2242 @kindex C-x C-t (Group)
2243 @findex gnus-group-transpose-groups
2244 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2245 really a subscription command, but you can use it instead of a
2246 kill-and-yank sequence sometimes.
2252 @findex gnus-group-kill-region
2253 Kill all groups in the region (@code{gnus-group-kill-region}).
2257 @findex gnus-group-kill-all-zombies
2258 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2261 @kindex S C-k (Group)
2262 @findex gnus-group-kill-level
2263 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2264 These groups can't be yanked back after killing, so this command should
2265 be used with some caution. The only time where this command comes in
2266 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2267 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2268 kill off all unsubscribed groups that do not have message numbers in the
2269 @file{.newsrc} file.
2273 Also @pxref{Group Levels}.
2283 @findex gnus-group-catchup-current
2284 @vindex gnus-group-catchup-group-hook
2285 @c @icon{gnus-group-catchup-current}
2286 Mark all unticked articles in this group as read
2287 (@code{gnus-group-catchup-current}).
2288 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2293 @findex gnus-group-catchup-current-all
2294 Mark all articles in this group, even the ticked ones, as read
2295 (@code{gnus-group-catchup-current-all}).
2299 @findex gnus-group-clear-data
2300 Clear the data from the current group---nix out marks and the list of
2301 read articles (@code{gnus-group-clear-data}).
2303 @item M-x gnus-group-clear-data-on-native-groups
2304 @kindex M-x gnus-group-clear-data-on-native-groups
2305 @findex gnus-group-clear-data-on-native-groups
2306 If you have switched from one @acronym{NNTP} server to another, all your marks
2307 and read ranges have become worthless. You can use this command to
2308 clear out all data that you have on your native groups. Use with
2315 @section Group Levels
2319 All groups have a level of @dfn{subscribedness}. For instance, if a
2320 group is on level 2, it is more subscribed than a group on level 5. You
2321 can ask gnus to just list groups on a given level or lower
2322 (@pxref{Listing Groups}), or to just check for new articles in groups on
2323 a given level or lower (@pxref{Scanning New Messages}).
2325 Remember: The higher the level of the group, the less important it is.
2331 @findex gnus-group-set-current-level
2332 Set the level of the current group. If a numeric prefix is given, the
2333 next @var{n} groups will have their levels set. The user will be
2334 prompted for a level.
2337 @vindex gnus-level-killed
2338 @vindex gnus-level-zombie
2339 @vindex gnus-level-unsubscribed
2340 @vindex gnus-level-subscribed
2341 Gnus considers groups from levels 1 to
2342 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2343 @code{gnus-level-subscribed} (exclusive) and
2344 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2345 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2346 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2347 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2348 same, but zombie and killed groups have no information on what articles
2349 you have read, etc, stored. This distinction between dead and living
2350 groups isn't done because it is nice or clever, it is done purely for
2351 reasons of efficiency.
2353 It is recommended that you keep all your mail groups (if any) on quite
2354 low levels (e.g. 1 or 2).
2356 Maybe the following description of the default behavior of Gnus helps to
2357 understand what these levels are all about. By default, Gnus shows you
2358 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2359 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2360 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2361 groups are hidden, in a way.
2363 Zombie and killed groups are similar to unsubscribed groups in that they
2364 are hidden by default. But they are different from subscribed and
2365 unsubscribed groups in that Gnus doesn't ask the news server for
2366 information (number of messages, number of unread messages) on zombie
2367 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2368 aren't interested in. If most groups are killed, Gnus is faster.
2370 Why does Gnus distinguish between zombie and killed groups? Well, when
2371 a new group arrives on the server, Gnus by default makes it a zombie
2372 group. This means that you are normally not bothered with new groups,
2373 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2374 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2375 list of killed groups.)
2377 If you want to play with the level variables, you should show some care.
2378 Set them once, and don't touch them ever again. Better yet, don't touch
2379 them at all unless you know exactly what you're doing.
2381 @vindex gnus-level-default-unsubscribed
2382 @vindex gnus-level-default-subscribed
2383 Two closely related variables are @code{gnus-level-default-subscribed}
2384 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2385 which are the levels that new groups will be put on if they are
2386 (un)subscribed. These two variables should, of course, be inside the
2387 relevant valid ranges.
2389 @vindex gnus-keep-same-level
2390 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2391 will only move to groups of the same level (or lower). In
2392 particular, going from the last article in one group to the next group
2393 will go to the next group of the same level (or lower). This might be
2394 handy if you want to read the most important groups before you read the
2397 If this variable is @code{best}, Gnus will make the next newsgroup the
2398 one with the best level.
2400 @vindex gnus-group-default-list-level
2401 All groups with a level less than or equal to
2402 @code{gnus-group-default-list-level} will be listed in the group buffer
2405 @vindex gnus-group-list-inactive-groups
2406 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2407 groups will be listed along with the unread groups. This variable is
2408 @code{t} by default. If it is @code{nil}, inactive groups won't be
2411 @vindex gnus-group-use-permanent-levels
2412 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2413 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2414 use this level as the ``work'' level.
2416 @vindex gnus-activate-level
2417 Gnus will normally just activate (i. e., query the server about) groups
2418 on level @code{gnus-activate-level} or less. If you don't want to
2419 activate unsubscribed groups, for instance, you might set this variable
2420 to 5. The default is 6.
2424 @section Group Score
2429 You would normally keep important groups on high levels, but that scheme
2430 is somewhat restrictive. Don't you wish you could have Gnus sort the
2431 group buffer according to how often you read groups, perhaps? Within
2434 This is what @dfn{group score} is for. You can have Gnus assign a score
2435 to each group through the mechanism described below. You can then sort
2436 the group buffer based on this score. Alternatively, you can sort on
2437 score and then level. (Taken together, the level and the score is
2438 called the @dfn{rank} of the group. A group that is on level 4 and has
2439 a score of 1 has a higher rank than a group on level 5 that has a score
2440 of 300. (The level is the most significant part and the score is the
2441 least significant part.))
2443 @findex gnus-summary-bubble-group
2444 If you want groups you read often to get higher scores than groups you
2445 read seldom you can add the @code{gnus-summary-bubble-group} function to
2446 the @code{gnus-summary-exit-hook} hook. This will result (after
2447 sorting) in a bubbling sort of action. If you want to see that in
2448 action after each summary exit, you can add
2449 @code{gnus-group-sort-groups-by-rank} or
2450 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2451 slow things down somewhat.
2454 @node Marking Groups
2455 @section Marking Groups
2456 @cindex marking groups
2458 If you want to perform some command on several groups, and they appear
2459 subsequently in the group buffer, you would normally just give a
2460 numerical prefix to the command. Most group commands will then do your
2461 bidding on those groups.
2463 However, if the groups are not in sequential order, you can still
2464 perform a command on several groups. You simply mark the groups first
2465 with the process mark and then execute the command.
2473 @findex gnus-group-mark-group
2474 Set the mark on the current group (@code{gnus-group-mark-group}).
2480 @findex gnus-group-unmark-group
2481 Remove the mark from the current group
2482 (@code{gnus-group-unmark-group}).
2486 @findex gnus-group-unmark-all-groups
2487 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2491 @findex gnus-group-mark-region
2492 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2496 @findex gnus-group-mark-buffer
2497 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2501 @findex gnus-group-mark-regexp
2502 Mark all groups that match some regular expression
2503 (@code{gnus-group-mark-regexp}).
2506 Also @pxref{Process/Prefix}.
2508 @findex gnus-group-universal-argument
2509 If you want to execute some command on all groups that have been marked
2510 with the process mark, you can use the @kbd{M-&}
2511 (@code{gnus-group-universal-argument}) command. It will prompt you for
2512 the command to be executed.
2515 @node Foreign Groups
2516 @section Foreign Groups
2517 @cindex foreign groups
2519 Below are some group mode commands for making and editing general foreign
2520 groups, as well as commands to ease the creation of a few
2521 special-purpose groups. All these commands insert the newly created
2522 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2529 @findex gnus-group-make-group
2530 @cindex making groups
2531 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2532 for a name, a method and possibly an @dfn{address}. For an easier way
2533 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2537 @findex gnus-group-read-ephemeral-group
2538 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2539 will prompt you for a name, a method and an @dfn{address}.
2543 @findex gnus-group-rename-group
2544 @cindex renaming groups
2545 Rename the current group to something else
2546 (@code{gnus-group-rename-group}). This is valid only on some
2547 groups---mail groups mostly. This command might very well be quite slow
2553 @findex gnus-group-customize
2554 Customize the group parameters (@code{gnus-group-customize}).
2558 @findex gnus-group-edit-group-method
2559 @cindex renaming groups
2560 Enter a buffer where you can edit the select method of the current
2561 group (@code{gnus-group-edit-group-method}).
2565 @findex gnus-group-edit-group-parameters
2566 Enter a buffer where you can edit the group parameters
2567 (@code{gnus-group-edit-group-parameters}).
2571 @findex gnus-group-edit-group
2572 Enter a buffer where you can edit the group info
2573 (@code{gnus-group-edit-group}).
2577 @findex gnus-group-make-directory-group
2579 Make a directory group (@pxref{Directory Groups}). You will be prompted
2580 for a directory name (@code{gnus-group-make-directory-group}).
2585 @findex gnus-group-make-help-group
2586 Make the gnus help group (@code{gnus-group-make-help-group}).
2590 @cindex (ding) archive
2591 @cindex archive group
2592 @findex gnus-group-make-archive-group
2593 @vindex gnus-group-archive-directory
2594 @vindex gnus-group-recent-archive-directory
2595 Make a gnus archive group (@code{gnus-group-make-archive-group}). By
2596 default a group pointing to the most recent articles will be created
2597 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2598 group will be created from @code{gnus-group-archive-directory}.
2602 @findex gnus-group-make-kiboze-group
2604 Make a kiboze group. You will be prompted for a name, for a regexp to
2605 match groups to be ``included'' in the kiboze group, and a series of
2606 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2607 @xref{Kibozed Groups}.
2611 @findex gnus-group-enter-directory
2613 Read an arbitrary directory as if it were a newsgroup with the
2614 @code{nneething} back end (@code{gnus-group-enter-directory}).
2615 @xref{Anything Groups}.
2619 @findex gnus-group-make-doc-group
2620 @cindex ClariNet Briefs
2622 Make a group based on some file or other
2623 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2624 command, you will be prompted for a file name and a file type.
2625 Currently supported types are @code{mbox}, @code{babyl},
2626 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2627 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2628 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2629 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2630 you run this command without a prefix, Gnus will guess at the file
2631 type. @xref{Document Groups}.
2635 @vindex gnus-useful-groups
2636 @findex gnus-group-make-useful-group
2637 Create one of the groups mentioned in @code{gnus-useful-groups}
2638 (@code{gnus-group-make-useful-group}).
2642 @findex gnus-group-make-web-group
2646 Make an ephemeral group based on a web search
2647 (@code{gnus-group-make-web-group}). If you give a prefix to this
2648 command, make a solid group instead. You will be prompted for the
2649 search engine type and the search string. Valid search engine types
2650 include @code{google}, @code{dejanews}, and @code{gmane}.
2651 @xref{Web Searches}.
2653 If you use the @code{google} search engine, you can limit the search
2654 to a particular group by using a match string like
2655 @samp{shaving group:alt.sysadmin.recovery}.
2659 @findex gnus-group-make-rss-group
2660 Make a group based on an @acronym{RSS} feed
2661 (@code{gnus-group-make-rss-group}). You will be prompted for an URL.
2665 @kindex G DEL (Group)
2666 @findex gnus-group-delete-group
2667 This function will delete the current group
2668 (@code{gnus-group-delete-group}). If given a prefix, this function will
2669 actually delete all the articles in the group, and forcibly remove the
2670 group itself from the face of the Earth. Use a prefix only if you are
2671 absolutely sure of what you are doing. This command can't be used on
2672 read-only groups (like @code{nntp} groups), though.
2676 @findex gnus-group-make-empty-virtual
2677 Make a new, fresh, empty @code{nnvirtual} group
2678 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2682 @findex gnus-group-add-to-virtual
2683 Add the current group to an @code{nnvirtual} group
2684 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2687 @xref{Select Methods}, for more information on the various select
2690 @vindex gnus-activate-foreign-newsgroups
2691 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2692 gnus will check all foreign groups with this level or lower at startup.
2693 This might take quite a while, especially if you subscribe to lots of
2694 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2695 @code{gnus-activate-level} also affects activation of foreign
2699 @node Group Parameters
2700 @section Group Parameters
2701 @cindex group parameters
2703 The group parameters store information local to a particular group.
2704 Here's an example group parameter list:
2707 ((to-address . "ding@@gnus.org")
2711 We see that each element consists of a ``dotted pair''---the thing before
2712 the dot is the key, while the thing after the dot is the value. All the
2713 parameters have this form @emph{except} local variable specs, which are
2714 not dotted pairs, but proper lists.
2716 Some parameters have correspondent customizable variables, each of which
2717 is an alist of regexps and values.
2719 The following group parameters can be used:
2724 Address used by when doing followups and new posts.
2727 (to-address . "some@@where.com")
2730 This is primarily useful in mail groups that represent closed mailing
2731 lists---mailing lists where it's expected that everybody that writes to
2732 the mailing list is subscribed to it. Since using this parameter
2733 ensures that the mail only goes to the mailing list itself, it means
2734 that members won't receive two copies of your followups.
2736 Using @code{to-address} will actually work whether the group is foreign
2737 or not. Let's say there's a group on the server that is called
2738 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2739 the articles from a mail-to-news gateway. Posting directly to this
2740 group is therefore impossible---you have to send mail to the mailing
2741 list address instead.
2743 See also @code{gnus-parameter-to-address-alist}.
2747 Address used when doing @kbd{a} in that group.
2750 (to-list . "some@@where.com")
2753 It is totally ignored
2754 when doing a followup---except that if it is present in a news group,
2755 you'll get mail group semantics when doing @kbd{f}.
2757 If you do an @kbd{a} command in a mail group and you have neither a
2758 @code{to-list} group parameter nor a @code{to-address} group parameter,
2759 then a @code{to-list} group parameter will be added automatically upon
2760 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2761 @vindex gnus-add-to-list
2763 @findex gnus-mailing-list-mode
2764 @cindex mail list groups
2765 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2766 entering summary buffer.
2768 See also @code{gnus-parameter-to-list-alist}.
2773 @cindex Mail-Followup-To
2774 @findex gnus-find-subscribed-addresses
2775 If this parameter is set to @code{t}, Gnus will consider the
2776 to-address and to-list parameters for this group as addresses of
2777 mailing lists you are subscribed to. Giving Gnus this information is
2778 (only) a first step in getting it to generate correct Mail-Followup-To
2779 headers for your posts to these lists. The second step is to put the
2780 following in your @file{.gnus.el}
2783 (setq message-subscribed-address-functions
2784 '(gnus-find-subscribed-addresses))
2787 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2788 a complete treatment of available MFT support.
2792 If the group parameter list has the element @code{(visible . t)},
2793 that group will always be visible in the Group buffer, regardless
2794 of whether it has any unread articles.
2796 @item broken-reply-to
2797 @cindex broken-reply-to
2798 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2799 headers in this group are to be ignored, and for the header to be hidden
2800 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2801 can be useful if you're reading a mailing list group where the listserv
2802 has inserted @code{Reply-To} headers that point back to the listserv
2803 itself. That is broken behavior. So there!
2807 Elements like @code{(to-group . "some.group.name")} means that all
2808 posts in that group will be sent to @code{some.group.name}.
2812 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2813 will treat all responses as if they were responses to news articles.
2814 This can be useful if you have a mail group that's really a mirror of a
2819 If @code{(gcc-self . t)} is present in the group parameter list, newly
2820 composed messages will be @code{Gcc}'d to the current group. If
2821 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2822 generated, if @code{(gcc-self . "string")} is present, this string will
2823 be inserted literally as a @code{gcc} header. This parameter takes
2824 precedence over any default @code{Gcc} rules as described later
2825 (@pxref{Archived Messages}).
2827 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2828 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2829 doesn't accept articles.
2833 If the group parameter has an element that looks like @code{(auto-expire
2834 . t)}, all articles read will be marked as expirable. For an
2835 alternative approach, @pxref{Expiring Mail}.
2837 See also @code{gnus-auto-expirable-newsgroups}.
2840 @cindex total-expire
2841 If the group parameter has an element that looks like
2842 @code{(total-expire . t)}, all read articles will be put through the
2843 expiry process, even if they are not marked as expirable. Use with
2844 caution. Unread, ticked and dormant articles are not eligible for
2847 See also @code{gnus-total-expirable-newsgroups}.
2851 @vindex nnmail-expiry-wait-function
2852 If the group parameter has an element that looks like
2853 @code{(expiry-wait . 10)}, this value will override any
2854 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2855 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2856 can either be a number of days (not necessarily an integer) or the
2857 symbols @code{never} or @code{immediate}.
2860 @cindex expiry-target
2861 Where expired messages end up. This parameter overrides
2862 @code{nnmail-expiry-target}.
2865 @cindex score file group parameter
2866 Elements that look like @code{(score-file . "file")} will make
2867 @file{file} into the current score file for the group in question. All
2868 interactive score entries will be put into this file.
2871 @cindex adapt file group parameter
2872 Elements that look like @code{(adapt-file . "file")} will make
2873 @file{file} into the current adaptive file for the group in question.
2874 All adaptive score entries will be put into this file.
2877 @cindex admin-address
2878 When unsubscribing from a mailing list you should never send the
2879 unsubscription notice to the mailing list itself. Instead, you'd send
2880 messages to the administrative address. This parameter allows you to
2881 put the admin address somewhere convenient.
2885 Elements that look like @code{(display . MODE)} say which articles to
2886 display on entering the group. Valid values are:
2890 Display all articles, both read and unread.
2893 Display the last @var{integer} articles in the group. This is the same as
2894 entering the group with @kbd{C-u @var{integer}}.
2897 Display the default visible articles, which normally includes unread and
2901 Display articles that satisfy a predicate.
2903 Here are some examples:
2907 Display only unread articles.
2910 Display everything except expirable articles.
2912 @item [and (not reply) (not expire)]
2913 Display everything except expirable and articles you've already
2917 The available operators are @code{not}, @code{and} and @code{or}.
2918 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2919 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2920 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2921 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2925 The @code{display} parameter works by limiting the summary buffer to
2926 the subset specified. You can pop the limit by using the @kbd{/ w}
2927 command (@pxref{Limiting}).
2931 Elements that look like @code{(comment . "This is a comment")} are
2932 arbitrary comments on the group. You can display comments in the
2933 group line (@pxref{Group Line Specification}).
2937 Elements that look like @code{(charset . iso-8859-1)} will make
2938 @code{iso-8859-1} the default charset; that is, the charset that will be
2939 used for all articles that do not specify a charset.
2941 See also @code{gnus-group-charset-alist}.
2943 @item ignored-charsets
2944 @cindex ignored-charset
2945 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2946 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2947 default charset will be used for decoding articles.
2949 See also @code{gnus-group-ignored-charsets-alist}.
2952 @cindex posting-style
2953 You can store additional posting style information for this group
2954 here (@pxref{Posting Styles}). The format is that of an entry in the
2955 @code{gnus-posting-styles} alist, except that there's no regexp matching
2956 the group name (of course). Style elements in this group parameter will
2957 take precedence over the ones found in @code{gnus-posting-styles}.
2959 For instance, if you want a funky name and signature in this group only,
2960 instead of hacking @code{gnus-posting-styles}, you could put something
2961 like this in the group parameters:
2966 ("X-My-Header" "Funky Value")
2967 (signature "Funky Signature"))
2972 If it is set, the value is used as the method for posting message
2973 instead of @code{gnus-post-method}.
2977 An item like @code{(banner . @var{regexp})} causes any part of an article
2978 that matches the regular expression @var{regexp} to be stripped. Instead of
2979 @var{regexp}, you can also use the symbol @code{signature} which strips the
2980 last signature or any of the elements of the alist
2981 @code{gnus-article-banner-alist}.
2985 This parameter contains a Sieve test that should match incoming mail
2986 that should be placed in this group. From this group parameter, a
2987 Sieve @samp{IF} control structure is generated, having the test as the
2988 condition and @samp{fileinto "group.name";} as the body.
2990 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
2991 address "sender" "sieve-admin@@extundo.com")} group parameter, when
2992 translating the group parameter into a Sieve script (@pxref{Sieve
2993 Commands}) the following Sieve code is generated:
2996 if address "sender" "sieve-admin@@extundo.com" @{
2997 fileinto "INBOX.list.sieve";
3001 To generate tests for multiple email-addresses use a group parameter
3002 like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}.
3003 When generating a sieve script (@pxref{Sieve Commands}) Sieve code
3004 like the following is generated:
3007 if address "sender" ["name@@one.org", "else@@two.org"] @{
3008 fileinto "INBOX.list.sieve";
3012 See @pxref{Sieve Commands} for commands and variables that might be of
3013 interest in relation to the sieve parameter.
3015 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3016 Top, sieve, Emacs Sieve}.
3018 @item (agent parameters)
3019 If the agent has been enabled, you can set any of the its parameters
3020 to control the behavior of the agent in individual groups. See Agent
3021 Parameters in @ref{Category Syntax}. Most users will choose to set
3022 agent parameters in either an agent category or group topic to
3023 minimize the configuration effort.
3025 @item (@var{variable} @var{form})
3026 You can use the group parameters to set variables local to the group you
3027 are entering. If you want to turn threading off in @samp{news.answers},
3028 you could put @code{(gnus-show-threads nil)} in the group parameters of
3029 that group. @code{gnus-show-threads} will be made into a local variable
3030 in the summary buffer you enter, and the form @code{nil} will be
3031 @code{eval}ed there.
3033 Note that this feature sets the variable locally to the summary buffer.
3034 But some variables are evaluated in the article buffer, or in the
3035 message buffer (of a reply or followup or otherwise newly created
3036 message). As a workaround, it might help to add the variable in
3037 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3038 Stuff}. So if you want to set @code{message-from-style} via the group
3039 parameters, then you may need the following statement elsewhere in your
3040 @file{~/.gnus} file:
3043 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3046 @vindex gnus-list-identifiers
3047 A use for this feature is to remove a mailing list identifier tag in
3048 the subject fields of articles. E.g. if the news group
3051 nntp+news.gnus.org:gmane.text.docbook.apps
3054 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3055 tag can be removed from the article subjects in the summary buffer for
3056 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3057 into the group parameters for the group.
3059 This can also be used as a group-specific hook function. If you want to
3060 hear a beep when you enter a group, you could put something like
3061 @code{(dummy-variable (ding))} in the parameters of that group.
3062 @code{dummy-variable} will be set to the (meaningless) result of the
3065 Alternatively, since the VARIABLE becomes local to the group, this
3066 pattern can be used to temporarily change a hook. For example, if the
3067 following is added to a group parameter
3070 (gnus-summary-prepared-hook
3071 '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3074 when the group is entered, the 'd' key will not mark the article as
3079 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3080 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3081 presents you with a Customize-like interface. The latter helps avoid
3082 silly Lisp errors.) You might also be interested in reading about topic
3083 parameters (@pxref{Topic Parameters}).
3085 @vindex gnus-parameters
3086 Group parameters can be set via the @code{gnus-parameters} variable too.
3087 But some variables, such as @code{visible}, have no effect. For
3091 (setq gnus-parameters
3093 (gnus-show-threads nil)
3094 (gnus-use-scoring nil)
3095 (gnus-summary-line-format
3096 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3100 ("^nnimap:\\(foo.bar\\)$"
3104 (gnus-use-scoring t))
3108 (broken-reply-to . t))))
3111 String value of parameters will be subjected to regexp substitution, as
3112 the @code{to-group} example shows.
3114 @vindex gnus-parameters-case-fold-search
3115 By default, whether comparing the group name and one of those regexps
3116 specified in @code{gnus-parameters} is done in a case-sensitive manner
3117 or a case-insensitive manner depends on the value of
3118 @code{case-fold-search} at the time when the comparison is done. The
3119 value of @code{case-fold-search} is typically @code{t}; it means, for
3120 example, the element @code{("INBOX\\.FOO" (total-expire . t))} might be
3121 applied to both the @samp{INBOX.FOO} group and the @samp{INBOX.foo}
3122 group. If you want to make those regexps always case-sensitive, set the
3123 value of the @code{gnus-parameters-case-fold-search} variable to
3124 @code{nil}. Otherwise, set it to @code{t} if you want to compare them
3125 always in a case-insensitive manner.
3127 You can define different sorting to different groups via
3128 @code{gnus-parameters}. Here is an example to sort an @acronym{NNTP}
3129 group by reverse date to see the latest news at the top and an
3130 @acronym{RSS} group by subject. In this example, the first group is the
3131 Debian daily news group @code{gmane.linux.debian.user.news} from
3132 news.gmane.org. The @acronym{RSS} group corresponds to the Debian
3133 weekly news RSS feed
3134 @url{http://packages.debian.org/unstable/newpkg_main.en.rdf},
3140 '(("nntp.*gmane\\.debian\\.user\\.news"
3141 (gnus-show-threads nil)
3142 (gnus-article-sort-functions '((not gnus-article-sort-by-date)))
3143 (gnus-use-adaptive-scoring nil)
3144 (gnus-use-scoring nil))
3146 (gnus-show-threads nil)
3147 (gnus-article-sort-functions 'gnus-article-sort-by-subject)
3148 (gnus-use-adaptive-scoring nil)
3149 (gnus-use-scoring t)
3150 (gnus-score-find-score-files-function 'gnus-score-find-single)
3151 (gnus-summary-line-format "%U%R%z%d %I%(%[ %s %]%)\n"))))
3155 @node Listing Groups
3156 @section Listing Groups
3157 @cindex group listing
3159 These commands all list various slices of the groups available.
3167 @findex gnus-group-list-groups
3168 List all groups that have unread articles
3169 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3170 command will list only groups of level ARG and lower. By default, it
3171 only lists groups of level five (i.e.,
3172 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3179 @findex gnus-group-list-all-groups
3180 List all groups, whether they have unread articles or not
3181 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3182 this command will list only groups of level ARG and lower. By default,
3183 it lists groups of level seven or lower (i.e., just subscribed and
3184 unsubscribed groups).
3188 @findex gnus-group-list-level
3189 List all unread groups on a specific level
3190 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3191 with no unread articles.
3195 @findex gnus-group-list-killed
3196 List all killed groups (@code{gnus-group-list-killed}). If given a
3197 prefix argument, really list all groups that are available, but aren't
3198 currently (un)subscribed. This could entail reading the active file
3203 @findex gnus-group-list-zombies
3204 List all zombie groups (@code{gnus-group-list-zombies}).
3208 @findex gnus-group-list-matching
3209 List all unread, subscribed groups with names that match a regexp
3210 (@code{gnus-group-list-matching}).
3214 @findex gnus-group-list-all-matching
3215 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3219 @findex gnus-group-list-active
3220 List absolutely all groups in the active file(s) of the
3221 server(s) you are connected to (@code{gnus-group-list-active}). This
3222 might very well take quite a while. It might actually be a better idea
3223 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3224 thing to match on. Also note that this command may list groups that
3225 don't exist (yet)---these will be listed as if they were killed groups.
3226 Take the output with some grains of salt.
3230 @findex gnus-group-apropos
3231 List all groups that have names that match a regexp
3232 (@code{gnus-group-apropos}).
3236 @findex gnus-group-description-apropos
3237 List all groups that have names or descriptions that match a regexp
3238 (@code{gnus-group-description-apropos}).
3242 @findex gnus-group-list-cached
3243 List all groups with cached articles (@code{gnus-group-list-cached}).
3247 @findex gnus-group-list-dormant
3248 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3252 @findex gnus-group-list-limit
3253 List groups limited within the current selection
3254 (@code{gnus-group-list-limit}).
3258 @findex gnus-group-list-flush
3259 Flush groups from the current selection (@code{gnus-group-list-flush}).
3263 @findex gnus-group-list-plus
3264 List groups plus the current selection (@code{gnus-group-list-plus}).
3268 @vindex gnus-permanently-visible-groups
3269 @cindex visible group parameter
3270 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3271 always be shown, whether they have unread articles or not. You can also
3272 add the @code{visible} element to the group parameters in question to
3273 get the same effect.
3275 @vindex gnus-list-groups-with-ticked-articles
3276 Groups that have just ticked articles in it are normally listed in the
3277 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3278 @code{nil}, these groups will be treated just like totally empty
3279 groups. It is @code{t} by default.
3282 @node Sorting Groups
3283 @section Sorting Groups
3284 @cindex sorting groups
3286 @kindex C-c C-s (Group)
3287 @findex gnus-group-sort-groups
3288 @vindex gnus-group-sort-function
3289 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3290 group buffer according to the function(s) given by the
3291 @code{gnus-group-sort-function} variable. Available sorting functions
3296 @item gnus-group-sort-by-alphabet
3297 @findex gnus-group-sort-by-alphabet
3298 Sort the group names alphabetically. This is the default.
3300 @item gnus-group-sort-by-real-name
3301 @findex gnus-group-sort-by-real-name
3302 Sort the group alphabetically on the real (unprefixed) group names.
3304 @item gnus-group-sort-by-level
3305 @findex gnus-group-sort-by-level
3306 Sort by group level.
3308 @item gnus-group-sort-by-score
3309 @findex gnus-group-sort-by-score
3310 Sort by group score. @xref{Group Score}.
3312 @item gnus-group-sort-by-rank
3313 @findex gnus-group-sort-by-rank
3314 Sort by group score and then the group level. The level and the score
3315 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3317 @item gnus-group-sort-by-unread
3318 @findex gnus-group-sort-by-unread
3319 Sort by number of unread articles.
3321 @item gnus-group-sort-by-method
3322 @findex gnus-group-sort-by-method
3323 Sort alphabetically on the select method.
3325 @item gnus-group-sort-by-server
3326 @findex gnus-group-sort-by-server
3327 Sort alphabetically on the Gnus server name.
3332 @code{gnus-group-sort-function} can also be a list of sorting
3333 functions. In that case, the most significant sort key function must be
3337 There are also a number of commands for sorting directly according to
3338 some sorting criteria:
3342 @kindex G S a (Group)
3343 @findex gnus-group-sort-groups-by-alphabet
3344 Sort the group buffer alphabetically by group name
3345 (@code{gnus-group-sort-groups-by-alphabet}).
3348 @kindex G S u (Group)
3349 @findex gnus-group-sort-groups-by-unread
3350 Sort the group buffer by the number of unread articles
3351 (@code{gnus-group-sort-groups-by-unread}).
3354 @kindex G S l (Group)
3355 @findex gnus-group-sort-groups-by-level
3356 Sort the group buffer by group level
3357 (@code{gnus-group-sort-groups-by-level}).
3360 @kindex G S v (Group)
3361 @findex gnus-group-sort-groups-by-score
3362 Sort the group buffer by group score
3363 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3366 @kindex G S r (Group)
3367 @findex gnus-group-sort-groups-by-rank
3368 Sort the group buffer by group rank
3369 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3372 @kindex G S m (Group)
3373 @findex gnus-group-sort-groups-by-method
3374 Sort the group buffer alphabetically by back end name@*
3375 (@code{gnus-group-sort-groups-by-method}).
3378 @kindex G S n (Group)
3379 @findex gnus-group-sort-groups-by-real-name
3380 Sort the group buffer alphabetically by real (unprefixed) group name
3381 (@code{gnus-group-sort-groups-by-real-name}).
3385 All the commands below obey the process/prefix convention
3386 (@pxref{Process/Prefix}).
3388 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3389 commands will sort in reverse order.
3391 You can also sort a subset of the groups:
3395 @kindex G P a (Group)
3396 @findex gnus-group-sort-selected-groups-by-alphabet
3397 Sort the groups alphabetically by group name
3398 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3401 @kindex G P u (Group)
3402 @findex gnus-group-sort-selected-groups-by-unread
3403 Sort the groups by the number of unread articles
3404 (@code{gnus-group-sort-selected-groups-by-unread}).
3407 @kindex G P l (Group)
3408 @findex gnus-group-sort-selected-groups-by-level
3409 Sort the groups by group level
3410 (@code{gnus-group-sort-selected-groups-by-level}).
3413 @kindex G P v (Group)
3414 @findex gnus-group-sort-selected-groups-by-score
3415 Sort the groups by group score
3416 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3419 @kindex G P r (Group)
3420 @findex gnus-group-sort-selected-groups-by-rank
3421 Sort the groups by group rank
3422 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3425 @kindex G P m (Group)
3426 @findex gnus-group-sort-selected-groups-by-method
3427 Sort the groups alphabetically by back end name@*
3428 (@code{gnus-group-sort-selected-groups-by-method}).
3431 @kindex G P n (Group)
3432 @findex gnus-group-sort-selected-groups-by-real-name
3433 Sort the groups alphabetically by real (unprefixed) group name
3434 (@code{gnus-group-sort-selected-groups-by-real-name}).
3437 @kindex G P s (Group)
3438 @findex gnus-group-sort-selected-groups
3439 Sort the groups according to @code{gnus-group-sort-function}.
3443 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3447 @node Group Maintenance
3448 @section Group Maintenance
3449 @cindex bogus groups
3454 @findex gnus-group-check-bogus-groups
3455 Find bogus groups and delete them
3456 (@code{gnus-group-check-bogus-groups}).
3460 @findex gnus-group-find-new-groups
3461 Find new groups and process them (@code{gnus-group-find-new-groups}).
3462 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3463 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3464 to query the server for new groups, and subscribe the new groups as
3468 @kindex C-c C-x (Group)
3469 @findex gnus-group-expire-articles
3470 Run all expirable articles in the current group through the expiry
3471 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3472 all expirable articles in the group that have been around for a while.
3473 (@pxref{Expiring Mail}).
3476 @kindex C-c C-M-x (Group)
3477 @findex gnus-group-expire-all-groups
3478 Run all expirable articles in all groups through the expiry process
3479 (@code{gnus-group-expire-all-groups}).
3484 @node Browse Foreign Server
3485 @section Browse Foreign Server
3486 @cindex foreign servers
3487 @cindex browsing servers
3492 @findex gnus-group-browse-foreign-server
3493 You will be queried for a select method and a server name. Gnus will
3494 then attempt to contact this server and let you browse the groups there
3495 (@code{gnus-group-browse-foreign-server}).
3498 @findex gnus-browse-mode
3499 A new buffer with a list of available groups will appear. This buffer
3500 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3501 a lot) like a normal group buffer.
3503 Here's a list of keystrokes available in the browse mode:
3508 @findex gnus-group-next-group
3509 Go to the next group (@code{gnus-group-next-group}).
3513 @findex gnus-group-prev-group
3514 Go to the previous group (@code{gnus-group-prev-group}).
3517 @kindex SPACE (Browse)
3518 @findex gnus-browse-read-group
3519 Enter the current group and display the first article
3520 (@code{gnus-browse-read-group}).
3523 @kindex RET (Browse)
3524 @findex gnus-browse-select-group
3525 Enter the current group (@code{gnus-browse-select-group}).
3529 @findex gnus-browse-unsubscribe-current-group
3530 Unsubscribe to the current group, or, as will be the case here,
3531 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3537 @findex gnus-browse-exit
3538 Exit browse mode (@code{gnus-browse-exit}).
3542 @findex gnus-browse-describe-group
3543 Describe the current group (@code{gnus-browse-describe-group}).
3547 @findex gnus-browse-describe-briefly
3548 Describe browse mode briefly (well, there's not much to describe, is
3549 there) (@code{gnus-browse-describe-briefly}).
3554 @section Exiting gnus
3555 @cindex exiting gnus
3557 Yes, gnus is ex(c)iting.
3562 @findex gnus-group-suspend
3563 Suspend gnus (@code{gnus-group-suspend}). This doesn't really exit gnus,
3564 but it kills all buffers except the Group buffer. I'm not sure why this
3565 is a gain, but then who am I to judge?
3569 @findex gnus-group-exit
3570 @c @icon{gnus-group-exit}
3571 Quit gnus (@code{gnus-group-exit}).
3575 @findex gnus-group-quit
3576 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3577 The dribble file will be saved, though (@pxref{Auto Save}).
3580 @vindex gnus-exit-gnus-hook
3581 @vindex gnus-suspend-gnus-hook
3582 @vindex gnus-after-exiting-gnus-hook
3583 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3584 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3585 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3591 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3592 numbly heavy and herself fall into a hazy trance as the boy sitting
3593 behind her drew repeated lines with his pencil across the back of her
3599 @section Group Topics
3602 If you read lots and lots of groups, it might be convenient to group
3603 them hierarchically according to topics. You put your Emacs groups over
3604 here, your sex groups over there, and the rest (what, two groups or so?)
3605 you put in some misc section that you never bother with anyway. You can
3606 even group the Emacs sex groups as a sub-topic to either the Emacs
3607 groups or the sex groups---or both! Go wild!
3611 \gnusfigure{Group Topics}{400}{
3612 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3623 2: alt.religion.emacs
3626 0: comp.talk.emacs.recovery
3628 8: comp.binaries.fractals
3629 13: comp.sources.unix
3632 @findex gnus-topic-mode
3634 To get this @emph{fab} functionality you simply turn on (ooh!) the
3635 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3636 is a toggling command.)
3638 Go ahead, just try it. I'll still be here when you get back. La de
3639 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3640 Yes, and now press @kbd{l}. There. All your groups are now listed
3641 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3644 If you want this permanently enabled, you should add that minor mode to
3645 the hook for the group mode. Put the following line in your
3646 @file{~/.gnus.el} file:
3649 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3653 * Topic Commands:: Interactive E-Z commands.
3654 * Topic Variables:: How to customize the topics the Lisp Way.
3655 * Topic Sorting:: Sorting each topic individually.
3656 * Topic Topology:: A map of the world.
3657 * Topic Parameters:: Parameters that apply to all groups in a topic.
3661 @node Topic Commands
3662 @subsection Topic Commands
3663 @cindex topic commands
3665 When the topic minor mode is turned on, a new @kbd{T} submap will be
3666 available. In addition, a few of the standard keys change their
3667 definitions slightly.
3669 In general, the following kinds of operations are possible on topics.
3670 First of all, you want to create topics. Secondly, you want to put
3671 groups in topics and to move them around until you have an order you
3672 like. The third kind of operation is to show/hide parts of the whole
3673 shebang. You might want to hide a topic including its subtopics and
3674 groups, to get a better overview of the other groups.
3676 Here is a list of the basic keys that you might need to set up topics
3683 @findex gnus-topic-create-topic
3684 Prompt for a new topic name and create it
3685 (@code{gnus-topic-create-topic}).
3689 @kindex T TAB (Topic)
3691 @findex gnus-topic-indent
3692 ``Indent'' the current topic so that it becomes a sub-topic of the
3693 previous topic (@code{gnus-topic-indent}). If given a prefix,
3694 ``un-indent'' the topic instead.
3697 @kindex M-TAB (Topic)
3698 @findex gnus-topic-unindent
3699 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3700 parent of its current parent (@code{gnus-topic-unindent}).
3704 The following two keys can be used to move groups and topics around.
3705 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3706 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3707 kill and yank rather than cut and paste.
3713 @findex gnus-topic-kill-group
3714 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3715 topic will be removed along with the topic.
3719 @findex gnus-topic-yank-group
3720 Yank the previously killed group or topic
3721 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3724 So, to move a topic to the beginning of the list of topics, just hit
3725 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3726 move the cursor to the beginning of the buffer (just below the ``Gnus''
3727 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3728 paste. Like I said -- E-Z.
3730 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3731 you can move topics around as well as groups.
3735 After setting up the topics the way you like them, you might wish to
3736 hide a topic, or to show it again. That's why we have the following
3743 @findex gnus-topic-select-group
3745 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3746 When you perform this command on a group, you'll enter the group, as
3747 usual. When done on a topic line, the topic will be folded (if it was
3748 visible) or unfolded (if it was folded already). So it's basically a
3749 toggling command on topics. In addition, if you give a numerical
3750 prefix, group on that level (and lower) will be displayed.
3754 Now for a list of other commands, in no particular order.
3760 @findex gnus-topic-move-group
3761 Move the current group to some other topic
3762 (@code{gnus-topic-move-group}). This command uses the process/prefix
3763 convention (@pxref{Process/Prefix}).
3767 @findex gnus-topic-jump-to-topic
3768 Go to a topic (@code{gnus-topic-jump-to-topic}).
3772 @findex gnus-topic-copy-group
3773 Copy the current group to some other topic
3774 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3775 convention (@pxref{Process/Prefix}).
3779 @findex gnus-topic-hide-topic
3780 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3781 a prefix, hide the topic permanently.
3785 @findex gnus-topic-show-topic
3786 Show the current topic (@code{gnus-topic-show-topic}). If given
3787 a prefix, show the topic permanently.
3791 @findex gnus-topic-remove-group
3792 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3793 This command is mainly useful if you have the same group in several
3794 topics and wish to remove it from one of the topics. You may also
3795 remove a group from all topics, but in that case, Gnus will add it to
3796 the root topic the next time you start Gnus. In fact, all new groups
3797 (which, naturally, don't belong to any topic) will show up in the root
3800 This command uses the process/prefix convention
3801 (@pxref{Process/Prefix}).
3805 @findex gnus-topic-move-matching
3806 Move all groups that match some regular expression to a topic
3807 (@code{gnus-topic-move-matching}).
3811 @findex gnus-topic-copy-matching
3812 Copy all groups that match some regular expression to a topic
3813 (@code{gnus-topic-copy-matching}).
3817 @findex gnus-topic-toggle-display-empty-topics
3818 Toggle hiding empty topics
3819 (@code{gnus-topic-toggle-display-empty-topics}).
3823 @findex gnus-topic-mark-topic
3824 Mark all groups in the current topic with the process mark
3825 (@code{gnus-topic-mark-topic}). This command works recursively on
3826 sub-topics unless given a prefix.
3829 @kindex T M-# (Topic)
3830 @findex gnus-topic-unmark-topic
3831 Remove the process mark from all groups in the current topic
3832 (@code{gnus-topic-unmark-topic}). This command works recursively on
3833 sub-topics unless given a prefix.
3836 @kindex C-c C-x (Topic)
3837 @findex gnus-topic-expire-articles
3838 Run all expirable articles in the current group or topic through the
3839 expiry process (if any)
3840 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3844 @findex gnus-topic-rename
3845 Rename a topic (@code{gnus-topic-rename}).
3848 @kindex T DEL (Topic)
3849 @findex gnus-topic-delete
3850 Delete an empty topic (@code{gnus-topic-delete}).
3854 @findex gnus-topic-list-active
3855 List all groups that gnus knows about in a topics-ified way
3856 (@code{gnus-topic-list-active}).
3859 @kindex T M-n (Topic)
3860 @findex gnus-topic-goto-next-topic
3861 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3864 @kindex T M-p (Topic)
3865 @findex gnus-topic-goto-previous-topic
3866 Go to the previous topic (@code{gnus-topic-goto-previous-topic}).
3870 @findex gnus-topic-edit-parameters
3871 @cindex group parameters
3872 @cindex topic parameters
3874 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3875 @xref{Topic Parameters}.
3880 @node Topic Variables
3881 @subsection Topic Variables
3882 @cindex topic variables
3884 The previous section told you how to tell Gnus which topics to display.
3885 This section explains how to tell Gnus what to display about each topic.
3887 @vindex gnus-topic-line-format
3888 The topic lines themselves are created according to the
3889 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3902 Number of groups in the topic.
3904 Number of unread articles in the topic.
3906 Number of unread articles in the topic and all its subtopics.
3909 @vindex gnus-topic-indent-level
3910 Each sub-topic (and the groups in the sub-topics) will be indented with
3911 @code{gnus-topic-indent-level} times the topic level number of spaces.
3914 @vindex gnus-topic-mode-hook
3915 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3917 @vindex gnus-topic-display-empty-topics
3918 The @code{gnus-topic-display-empty-topics} says whether to display even
3919 topics that have no unread articles in them. The default is @code{t}.
3923 @subsection Topic Sorting
3924 @cindex topic sorting
3926 You can sort the groups in each topic individually with the following
3932 @kindex T S a (Topic)
3933 @findex gnus-topic-sort-groups-by-alphabet
3934 Sort the current topic alphabetically by group name
3935 (@code{gnus-topic-sort-groups-by-alphabet}).
3938 @kindex T S u (Topic)
3939 @findex gnus-topic-sort-groups-by-unread
3940 Sort the current topic by the number of unread articles
3941 (@code{gnus-topic-sort-groups-by-unread}).
3944 @kindex T S l (Topic)
3945 @findex gnus-topic-sort-groups-by-level
3946 Sort the current topic by group level
3947 (@code{gnus-topic-sort-groups-by-level}).
3950 @kindex T S v (Topic)
3951 @findex gnus-topic-sort-groups-by-score
3952 Sort the current topic by group score
3953 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3956 @kindex T S r (Topic)
3957 @findex gnus-topic-sort-groups-by-rank
3958 Sort the current topic by group rank
3959 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3962 @kindex T S m (Topic)
3963 @findex gnus-topic-sort-groups-by-method
3964 Sort the current topic alphabetically by back end name
3965 (@code{gnus-topic-sort-groups-by-method}).
3968 @kindex T S e (Topic)
3969 @findex gnus-topic-sort-groups-by-server
3970 Sort the current topic alphabetically by server name
3971 (@code{gnus-topic-sort-groups-by-server}).
3974 @kindex T S s (Topic)
3975 @findex gnus-topic-sort-groups
3976 Sort the current topic according to the function(s) given by the
3977 @code{gnus-group-sort-function} variable
3978 (@code{gnus-topic-sort-groups}).
3982 When given a prefix argument, all these commands will sort in reverse
3983 order. @xref{Sorting Groups}, for more information about group
3987 @node Topic Topology
3988 @subsection Topic Topology
3989 @cindex topic topology
3992 So, let's have a look at an example group buffer:
3999 2: alt.religion.emacs
4002 0: comp.talk.emacs.recovery
4004 8: comp.binaries.fractals
4005 13: comp.sources.unix
4009 So, here we have one top-level topic (@samp{Gnus}), two topics under
4010 that, and one sub-topic under one of the sub-topics. (There is always
4011 just one (1) top-level topic). This topology can be expressed as
4016 (("Emacs -- I wuw it!" visible)
4017 (("Naughty Emacs" visible)))
4021 @vindex gnus-topic-topology
4022 This is in fact how the variable @code{gnus-topic-topology} would look
4023 for the display above. That variable is saved in the @file{.newsrc.eld}
4024 file, and shouldn't be messed with manually---unless you really want
4025 to. Since this variable is read from the @file{.newsrc.eld} file,
4026 setting it in any other startup files will have no effect.
4028 This topology shows what topics are sub-topics of what topics (right),
4029 and which topics are visible. Two settings are currently
4030 allowed---@code{visible} and @code{invisible}.
4033 @node Topic Parameters
4034 @subsection Topic Parameters
4035 @cindex topic parameters
4037 All groups in a topic will inherit group parameters from the parent
4038 (and ancestor) topic parameters. All valid group parameters are valid
4039 topic parameters (@pxref{Group Parameters}). When the agent is
4040 enabled, all agent parameters (See Agent Parameters in @ref{Category
4041 Syntax}) are also valid topic parameters.
4043 In addition, the following parameters are only valid as topic
4048 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4049 @code{subscribe} topic parameter says what groups go in what topic. Its
4050 value should be a regexp to match the groups that should go in that
4053 @item subscribe-level
4054 When subscribing new groups by topic (see the @code{subscribe} parameter),
4055 the group will be subscribed with the level specified in the
4056 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4060 Group parameters (of course) override topic parameters, and topic
4061 parameters in sub-topics override topic parameters in super-topics. You
4062 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4063 verb, although you may feel free to disagree with me here.)
4070 2: alt.religion.emacs
4074 0: comp.talk.emacs.recovery
4076 8: comp.binaries.fractals
4077 13: comp.sources.unix
4082 The @samp{Emacs} topic has the topic parameter @code{(score-file
4083 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4084 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4085 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4086 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4087 . "religion.SCORE")}.
4089 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4090 will get the @file{relief.SCORE} home score file. If you enter the same
4091 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4092 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4093 get the @file{religion.SCORE} home score file.
4095 This seems rather simple and self-evident, doesn't it? Well, yes. But
4096 there are some problems, especially with the @code{total-expiry}
4097 parameter. Say you have a mail group in two topics; one with
4098 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4099 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4100 of these topics you mean to expire articles from, so anything may
4101 happen. In fact, I hereby declare that it is @dfn{undefined} what
4102 happens. You just have to be careful if you do stuff like that.
4105 @node Misc Group Stuff
4106 @section Misc Group Stuff
4109 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4110 * Group Information:: Information and help on groups and Gnus.
4111 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4112 * File Commands:: Reading and writing the Gnus files.
4113 * Sieve Commands:: Managing Sieve scripts.
4120 @findex gnus-group-enter-server-mode
4121 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4122 @xref{Server Buffer}.
4126 @findex gnus-group-post-news
4127 Start composing a message (a news by default)
4128 (@code{gnus-group-post-news}). If given a prefix, post to the group
4129 under the point. If the prefix is 1, prompt for a group to post to.
4130 Contrary to what the name of this function suggests, the prepared
4131 article might be a mail instead of a news, if a mail group is specified
4132 with the prefix argument. @xref{Composing Messages}.
4136 @findex gnus-group-mail
4137 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4138 use the posting style of the group under the point. If the prefix is 1,
4139 prompt for a group name to find the posting style.
4140 @xref{Composing Messages}.
4144 @findex gnus-group-news
4145 Start composing a news (@code{gnus-group-news}). If given a prefix,
4146 post to the group under the point. If the prefix is 1, prompt
4147 for group to post to. @xref{Composing Messages}.
4149 This function actually prepares a news even when using mail groups.
4150 This is useful for ``posting'' messages to mail groups without actually
4151 sending them over the network: they're just saved directly to the group
4152 in question. The corresponding back end must have a request-post method
4153 for this to work though.
4157 Variables for the group buffer:
4161 @item gnus-group-mode-hook
4162 @vindex gnus-group-mode-hook
4163 is called after the group buffer has been
4166 @item gnus-group-prepare-hook
4167 @vindex gnus-group-prepare-hook
4168 is called after the group buffer is
4169 generated. It may be used to modify the buffer in some strange,
4172 @item gnus-group-prepared-hook
4173 @vindex gnus-group-prepare-hook
4174 is called as the very last thing after the group buffer has been
4175 generated. It may be used to move point around, for instance.
4177 @item gnus-permanently-visible-groups
4178 @vindex gnus-permanently-visible-groups
4179 Groups matching this regexp will always be listed in the group buffer,
4180 whether they are empty or not.
4182 @item gnus-group-name-charset-method-alist
4183 @vindex gnus-group-name-charset-method-alist
4184 An alist of method and the charset for group names. It is used to show
4185 non-@acronym{ASCII} group names.
4189 (setq gnus-group-name-charset-method-alist
4190 '(((nntp "news.com.cn") . cn-gb-2312)))
4193 @item gnus-group-name-charset-group-alist
4194 @cindex UTF-8 group names
4195 @vindex gnus-group-name-charset-group-alist
4196 An alist of regexp of group name and the charset for group names. It
4197 is used to show non-@acronym{ASCII} group names. @code{((".*"
4198 utf-8))} is the default value if UTF-8 is supported, otherwise the
4199 default is @code{nil}.
4203 (setq gnus-group-name-charset-group-alist
4204 '(("\\.com\\.cn:" . cn-gb-2312)))
4209 @node Scanning New Messages
4210 @subsection Scanning New Messages
4211 @cindex new messages
4212 @cindex scanning new news
4218 @findex gnus-group-get-new-news
4219 @c @icon{gnus-group-get-new-news}
4220 Check the server(s) for new articles. If the numerical prefix is used,
4221 this command will check only groups of level @var{arg} and lower
4222 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4223 command will force a total re-reading of the active file(s) from the
4228 @findex gnus-group-get-new-news-this-group
4229 @vindex gnus-goto-next-group-when-activating
4230 @c @icon{gnus-group-get-new-news-this-group}
4231 Check whether new articles have arrived in the current group
4232 (@code{gnus-group-get-new-news-this-group}).
4233 @code{gnus-goto-next-group-when-activating} says whether this command is
4234 to move point to the next group or not. It is @code{t} by default.
4236 @findex gnus-activate-all-groups
4237 @cindex activating groups
4239 @kindex C-c M-g (Group)
4240 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4245 @findex gnus-group-restart
4246 Restart gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4247 file(s), closes the connection to all servers, clears up all run-time
4248 gnus variables, and then starts gnus all over again.
4252 @vindex gnus-get-new-news-hook
4253 @code{gnus-get-new-news-hook} is run just before checking for new news.
4255 @vindex gnus-after-getting-new-news-hook
4256 @code{gnus-after-getting-new-news-hook} is run after checking for new
4260 @node Group Information
4261 @subsection Group Information
4262 @cindex group information
4263 @cindex information on groups
4270 @findex gnus-group-fetch-faq
4271 @vindex gnus-group-faq-directory
4274 Try to fetch the @acronym{FAQ} for the current group
4275 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4276 from @code{gnus-group-faq-directory}, which is usually a directory on
4277 a remote machine. This variable can also be a list of directories.
4278 In that case, giving a prefix to this command will allow you to choose
4279 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4280 used for fetching the file.
4282 If fetching from the first site is unsuccessful, gnus will attempt to go
4283 through @code{gnus-group-faq-directory} and try to open them one by one.
4287 @findex gnus-group-fetch-charter
4288 @vindex gnus-group-charter-alist
4290 Try to open the charter for the current group in a web browser
4291 (@code{gnus-group-fetch-charter}). Query for a group if given a
4294 Gnus will use @code{gnus-group-charter-alist} to find the location of
4295 the charter. If no location is known, Gnus will fetch the control
4296 messages for the group, which in some cases includes the charter.
4300 @findex gnus-group-fetch-control
4301 @vindex gnus-group-fetch-control-use-browse-url
4302 @cindex control message
4303 Fetch the control messages for the group from the archive at
4304 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4305 group if given a prefix argument.
4307 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4308 Gnus will open the control messages in a browser using
4309 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4310 and displayed in an ephemeral group.
4312 Note that the control messages are compressed. To use this command
4313 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4314 Files, ,Compressed Files, emacs, The Emacs Manual}).
4318 @c @icon{gnus-group-describe-group}
4320 @kindex C-c C-d (Group)
4321 @cindex describing groups
4322 @cindex group description
4323 @findex gnus-group-describe-group
4324 Describe the current group (@code{gnus-group-describe-group}). If given
4325 a prefix, force Gnus to re-read the description from the server.
4329 @findex gnus-group-describe-all-groups
4330 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4331 prefix, force gnus to re-read the description file from the server.
4338 @findex gnus-version
4339 Display current gnus version numbers (@code{gnus-version}).
4343 @findex gnus-group-describe-briefly
4344 Give a very short help message (@code{gnus-group-describe-briefly}).
4347 @kindex C-c C-i (Group)
4350 @findex gnus-info-find-node
4351 Go to the gnus info node (@code{gnus-info-find-node}).
4355 @node Group Timestamp
4356 @subsection Group Timestamp
4358 @cindex group timestamps
4360 It can be convenient to let gnus keep track of when you last read a
4361 group. To set the ball rolling, you should add
4362 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4365 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4368 After doing this, each time you enter a group, it'll be recorded.
4370 This information can be displayed in various ways---the easiest is to
4371 use the @samp{%d} spec in the group line format:
4374 (setq gnus-group-line-format
4375 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4378 This will result in lines looking like:
4381 * 0: mail.ding 19961002T012943
4382 0: custom 19961002T012713
4385 As you can see, the date is displayed in compact ISO 8601 format. This
4386 may be a bit too much, so to just display the date, you could say
4390 (setq gnus-group-line-format
4391 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4394 If you would like greater control of the time format, you can use a
4395 user-defined format spec. Something like the following should do the
4399 (setq gnus-group-line-format
4400 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4401 (defun gnus-user-format-function-d (headers)
4402 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4404 (format-time-string "%b %d %H:%M" time)
4410 @subsection File Commands
4411 @cindex file commands
4417 @findex gnus-group-read-init-file
4418 @vindex gnus-init-file
4419 @cindex reading init file
4420 Re-read the init file (@code{gnus-init-file}, which defaults to
4421 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4425 @findex gnus-group-save-newsrc
4426 @cindex saving .newsrc
4427 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4428 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4429 file(s) whether Gnus thinks it is necessary or not.
4432 @c @kindex Z (Group)
4433 @c @findex gnus-group-clear-dribble
4434 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4439 @node Sieve Commands
4440 @subsection Sieve Commands
4441 @cindex group sieve commands
4443 Sieve is a server-side mail filtering language. In Gnus you can use
4444 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4445 sieve rules that should apply to each group. Gnus provides two
4446 commands to translate all these group parameters into a proper Sieve
4447 script that can be transfered to the server somehow.
4449 @vindex gnus-sieve-file
4450 @vindex gnus-sieve-region-start
4451 @vindex gnus-sieve-region-end
4452 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4453 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4454 between two delimiters, @code{gnus-sieve-region-start} and
4455 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4456 outside these delimiters that will not be removed the next time you
4457 regenerate the Sieve script.
4459 @vindex gnus-sieve-crosspost
4460 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4461 is generated. If it is non-@code{nil} (the default) articles is
4462 placed in all groups that have matching rules, otherwise the article
4463 is only placed in the group with the first matching rule. For
4464 example, the group parameter @samp{(sieve address "sender"
4465 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4466 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4467 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4468 except that the line containing the call to @code{stop} is removed.)
4471 if address "sender" "owner-ding@@hpc.uh.edu" @{
4472 fileinto "INBOX.ding";
4477 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4483 @findex gnus-sieve-generate
4484 @vindex gnus-sieve-file
4485 @cindex generating sieve script
4486 Regenerate a Sieve script from the @code{sieve} group parameters and
4487 put you into the @code{gnus-sieve-file} without saving it.
4491 @findex gnus-sieve-update
4492 @vindex gnus-sieve-file
4493 @cindex updating sieve script
4494 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4495 @code{sieve} group parameters, save the file and upload it to the
4496 server using the @code{sieveshell} program.
4501 @node Summary Buffer
4502 @chapter Summary Buffer
4503 @cindex summary buffer
4505 A line for each article is displayed in the summary buffer. You can
4506 move around, read articles, post articles and reply to articles.
4508 The most common way to a summary buffer is to select a group from the
4509 group buffer (@pxref{Selecting a Group}).
4511 You can have as many summary buffers open as you wish.
4514 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4515 * Summary Maneuvering:: Moving around the summary buffer.
4516 * Choosing Articles:: Reading articles.
4517 * Paging the Article:: Scrolling the current article.
4518 * Reply Followup and Post:: Posting articles.
4519 * Delayed Articles:: Send articles at a later time.
4520 * Marking Articles:: Marking articles as read, expirable, etc.
4521 * Limiting:: You can limit the summary buffer.
4522 * Threading:: How threads are made.
4523 * Sorting the Summary Buffer:: How articles and threads are sorted.
4524 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4525 * Article Caching:: You may store articles in a cache.
4526 * Persistent Articles:: Making articles expiry-resistant.
4527 * Article Backlog:: Having already read articles hang around.
4528 * Saving Articles:: Ways of customizing article saving.
4529 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4530 * Article Treatment:: The article buffer can be mangled at will.
4531 * MIME Commands:: Doing MIMEy things with the articles.
4532 * Charsets:: Character set issues.
4533 * Article Commands:: Doing various things with the article buffer.
4534 * Summary Sorting:: Sorting the summary buffer in various ways.
4535 * Finding the Parent:: No child support? Get the parent.
4536 * Alternative Approaches:: Reading using non-default summaries.
4537 * Tree Display:: A more visual display of threads.
4538 * Mail Group Commands:: Some commands can only be used in mail groups.
4539 * Various Summary Stuff:: What didn't fit anywhere else.
4540 * Exiting the Summary Buffer:: Returning to the Group buffer,
4541 or reselecting the current group.
4542 * Crosspost Handling:: How crossposted articles are dealt with.
4543 * Duplicate Suppression:: An alternative when crosspost handling fails.
4544 * Security:: Decrypt and Verify.
4545 * Mailing List:: Mailing list minor mode.
4549 @node Summary Buffer Format
4550 @section Summary Buffer Format
4551 @cindex summary buffer format
4555 \gnusfigure{The Summary Buffer}{180}{
4556 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4557 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4563 * Summary Buffer Lines:: You can specify how summary lines should look.
4564 * To From Newsgroups:: How to not display your own name.
4565 * Summary Buffer Mode Line:: You can say how the mode line should look.
4566 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4569 @findex mail-extract-address-components
4570 @findex gnus-extract-address-components
4571 @vindex gnus-extract-address-components
4572 Gnus will use the value of the @code{gnus-extract-address-components}
4573 variable as a function for getting the name and address parts of a
4574 @code{From} header. Three pre-defined functions exist:
4575 @code{gnus-extract-address-components}, which is the default, quite
4576 fast, and too simplistic solution;
4577 @code{mail-extract-address-components}, which works nicely, but is
4578 slower; and @code{std11-extract-address-components}, which works very
4579 nicely, but is slower. The default function will return the wrong
4580 answer in 5% of the cases. If this is unacceptable to you, use the
4581 other function instead:
4584 (setq gnus-extract-address-components
4585 'mail-extract-address-components)
4588 @vindex gnus-summary-same-subject
4589 @code{gnus-summary-same-subject} is a string indicating that the current
4590 article has the same subject as the previous. This string will be used
4591 with those specs that require it. The default is @code{""}.
4594 @node Summary Buffer Lines
4595 @subsection Summary Buffer Lines
4597 @vindex gnus-summary-line-format
4598 You can change the format of the lines in the summary buffer by changing
4599 the @code{gnus-summary-line-format} variable. It works along the same
4600 lines as a normal @code{format} string, with some extensions
4601 (@pxref{Formatting Variables}).
4603 There should always be a colon or a point position marker on the line;
4604 the cursor always moves to the point position marker or the colon after
4605 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4606 possible to change this. Just write a new function
4607 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4608 @xref{Positioning Point}.
4610 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4612 The following format specification characters and extended format
4613 specification(s) are understood:
4619 Subject string. List identifiers stripped,
4620 @code{gnus-list-identifies}. @xref{Article Hiding}.
4622 Subject if the article is the root of the thread or the previous article
4623 had a different subject, @code{gnus-summary-same-subject} otherwise.
4624 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4626 Full @code{From} header.
4628 The name (from the @code{From} header).
4630 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4633 The name (from the @code{From} header). This differs from the @code{n}
4634 spec in that it uses the function designated by the
4635 @code{gnus-extract-address-components} variable, which is slower, but
4636 may be more thorough.
4638 The address (from the @code{From} header). This works the same way as
4641 Number of lines in the article.
4643 Number of characters in the article. This specifier is not supported
4644 in some methods (like nnfolder).
4646 Pretty-printed version of the number of characters in the article;
4647 for example, @samp{1.2k} or @samp{0.4M}.
4649 Indentation based on thread level (@pxref{Customizing Threading}).
4651 A complex trn-style thread tree, showing response-connecting trace
4652 lines. A thread could be drawn like this:
4665 You can customize the appearance with the following options. Note
4666 that it is possible to make the thread display look really neat by
4667 replacing the default @acronym{ASCII} characters with graphic
4668 line-drawing glyphs.
4670 @item gnus-sum-thread-tree-root
4671 @vindex gnus-sum-thread-tree-root
4672 Used for the root of a thread. If @code{nil}, use subject
4673 instead. The default is @samp{> }.
4675 @item gnus-sum-thread-tree-false-root
4676 @vindex gnus-sum-thread-tree-false-root
4677 Used for the false root of a thread (@pxref{Loose Threads}). If
4678 @code{nil}, use subject instead. The default is @samp{> }.
4680 @item gnus-sum-thread-tree-single-indent
4681 @vindex gnus-sum-thread-tree-single-indent
4682 Used for a thread with just one message. If @code{nil}, use subject
4683 instead. The default is @samp{}.
4685 @item gnus-sum-thread-tree-vertical
4686 @vindex gnus-sum-thread-tree-vertical
4687 Used for drawing a vertical line. The default is @samp{| }.
4689 @item gnus-sum-thread-tree-indent
4690 @vindex gnus-sum-thread-tree-indent
4691 Used for indenting. The default is @samp{ }.
4693 @item gnus-sum-thread-tree-leaf-with-other
4694 @vindex gnus-sum-thread-tree-leaf-with-other
4695 Used for a leaf with brothers. The default is @samp{+-> }.
4697 @item gnus-sum-thread-tree-single-leaf
4698 @vindex gnus-sum-thread-tree-single-leaf
4699 Used for a leaf without brothers. The default is @samp{\-> }
4704 Nothing if the article is a root and lots of spaces if it isn't (it
4705 pushes everything after it off the screen).
4707 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4708 for adopted articles (@pxref{Customizing Threading}).
4710 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4711 for adopted articles.
4713 One space for each thread level.
4715 Twenty minus thread level spaces.
4717 Unread. @xref{Read Articles}.
4720 This misleadingly named specifier is the @dfn{secondary mark}. This
4721 mark will say whether the article has been replied to, has been cached,
4722 or has been saved. @xref{Other Marks}.
4725 Score as a number (@pxref{Scoring}).
4727 @vindex gnus-summary-zcore-fuzz
4728 Zcore, @samp{+} if above the default level and @samp{-} if below the
4729 default level. If the difference between
4730 @code{gnus-summary-default-score} and the score is less than
4731 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4739 The @code{Date} in @code{DD-MMM} format.
4741 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4747 Number of articles in the current sub-thread. Using this spec will slow
4748 down summary buffer generation somewhat.
4750 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4751 article has any children.
4757 Age sensitive date format. Various date format is defined in
4758 @code{gnus-user-date-format-alist}.
4760 User defined specifier. The next character in the format string should
4761 be a letter. Gnus will call the function
4762 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4763 following @samp{%u}. The function will be passed the current header as
4764 argument. The function should return a string, which will be inserted
4765 into the summary just like information from any other summary specifier.
4768 Text between @samp{%(} and @samp{%)} will be highlighted with
4769 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4770 There can only be one such area.
4772 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4773 have to be handled with care. For reasons of efficiency, gnus will
4774 compute what column these characters will end up in, and ``hard-code''
4775 that. This means that it is invalid to have these specs after a
4776 variable-length spec. Well, you might not be arrested, but your summary
4777 buffer will look strange, which is bad enough.
4779 The smart choice is to have these specs as far to the left as possible.
4780 (Isn't that the case with everything, though? But I digress.)
4782 This restriction may disappear in later versions of gnus.
4785 @node To From Newsgroups
4786 @subsection To From Newsgroups
4790 In some groups (particularly in archive groups), the @code{From} header
4791 isn't very interesting, since all the articles there are written by
4792 you. To display the information in the @code{To} or @code{Newsgroups}
4793 headers instead, you need to decide three things: What information to
4794 gather; where to display it; and when to display it.
4798 @vindex gnus-extra-headers
4799 The reading of extra header information is controlled by the
4800 @code{gnus-extra-headers}. This is a list of header symbols. For
4804 (setq gnus-extra-headers
4805 '(To Newsgroups X-Newsreader))
4808 This will result in Gnus trying to obtain these three headers, and
4809 storing it in header structures for later easy retrieval.
4812 @findex gnus-extra-header
4813 The value of these extra headers can be accessed via the
4814 @code{gnus-extra-header} function. Here's a format line spec that will
4815 access the @code{X-Newsreader} header:
4818 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4822 @vindex gnus-ignored-from-addresses
4823 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4824 summary line spec returns the @code{To}, @code{Newsreader} or
4825 @code{From} header. If this regexp matches the contents of the
4826 @code{From} header, the value of the @code{To} or @code{Newsreader}
4827 headers are used instead.
4829 To distinguish regular articles from those where the @code{From} field
4830 has been swapped, a string is prefixed to the @code{To} or
4831 @code{Newsgroups} header in the summary line. By default the string is
4832 @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can
4833 customize these strings with @code{gnus-summary-to-prefix} and
4834 @code{gnus-summary-newsgroup-prefix}.
4838 @vindex nnmail-extra-headers
4839 A related variable is @code{nnmail-extra-headers}, which controls when
4840 to include extra headers when generating overview (@acronym{NOV}) files.
4841 If you have old overview files, you should regenerate them after
4842 changing this variable, by entering the server buffer using @kbd{^},
4843 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
4846 @vindex gnus-summary-line-format
4847 You also have to instruct Gnus to display the data by changing the
4848 @code{%n} spec to the @code{%f} spec in the
4849 @code{gnus-summary-line-format} variable.
4851 In summary, you'd typically put something like the following in
4855 (setq gnus-extra-headers
4857 (setq nnmail-extra-headers gnus-extra-headers)
4858 (setq gnus-summary-line-format
4859 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4860 (setq gnus-ignored-from-addresses
4864 (The values listed above are the default values in Gnus. Alter them
4867 A note for news server administrators, or for users who wish to try to
4868 convince their news server administrator to provide some additional
4871 The above is mostly useful for mail groups, where you have control over
4872 the @acronym{NOV} files that are created. However, if you can persuade your
4873 nntp admin to add (in the usual implementation, notably INN):
4879 to the end of her @file{overview.fmt} file, then you can use that just
4880 as you would the extra headers from the mail groups.
4883 @node Summary Buffer Mode Line
4884 @subsection Summary Buffer Mode Line
4886 @vindex gnus-summary-mode-line-format
4887 You can also change the format of the summary mode bar (@pxref{Mode Line
4888 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4889 like. The default is @samp{Gnus: %%b [%A] %Z}.
4891 Here are the elements you can play with:
4897 Unprefixed group name.
4899 Current article number.
4901 Current article score.
4905 Number of unread articles in this group.
4907 Number of unread articles in this group that aren't displayed in the
4910 A string with the number of unread and unselected articles represented
4911 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4912 articles, and just as @samp{<%U more>} if there are just unread articles
4913 and no unselected ones.
4915 Shortish group name. For instance, @samp{rec.arts.anime} will be
4916 shortened to @samp{r.a.anime}.
4918 Subject of the current article.
4920 User-defined spec (@pxref{User-Defined Specs}).
4922 Name of the current score file (@pxref{Scoring}).
4924 Number of dormant articles (@pxref{Unread Articles}).
4926 Number of ticked articles (@pxref{Unread Articles}).
4928 Number of articles that have been marked as read in this session.
4930 Number of articles expunged by the score files.
4934 @node Summary Highlighting
4935 @subsection Summary Highlighting
4939 @item gnus-visual-mark-article-hook
4940 @vindex gnus-visual-mark-article-hook
4941 This hook is run after selecting an article. It is meant to be used for
4942 highlighting the article in some way. It is not run if
4943 @code{gnus-visual} is @code{nil}.
4945 @item gnus-summary-update-hook
4946 @vindex gnus-summary-update-hook
4947 This hook is called when a summary line is changed. It is not run if
4948 @code{gnus-visual} is @code{nil}.
4950 @item gnus-summary-selected-face
4951 @vindex gnus-summary-selected-face
4952 This is the face (or @dfn{font} as some people call it) used to
4953 highlight the current article in the summary buffer.
4955 @item gnus-summary-highlight
4956 @vindex gnus-summary-highlight
4957 Summary lines are highlighted according to this variable, which is a
4958 list where the elements are of the format @code{(@var{form}
4959 . @var{face})}. If you would, for instance, like ticked articles to be
4960 italic and high-scored articles to be bold, you could set this variable
4963 (((eq mark gnus-ticked-mark) . italic)
4964 ((> score default) . bold))
4966 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4967 @var{face} will be applied to the line.
4971 @node Summary Maneuvering
4972 @section Summary Maneuvering
4973 @cindex summary movement
4975 All the straight movement commands understand the numeric prefix and
4976 behave pretty much as you'd expect.
4978 None of these commands select articles.
4983 @kindex M-n (Summary)
4984 @kindex G M-n (Summary)
4985 @findex gnus-summary-next-unread-subject
4986 Go to the next summary line of an unread article
4987 (@code{gnus-summary-next-unread-subject}).
4991 @kindex M-p (Summary)
4992 @kindex G M-p (Summary)
4993 @findex gnus-summary-prev-unread-subject
4994 Go to the previous summary line of an unread article
4995 (@code{gnus-summary-prev-unread-subject}).
4998 @kindex G g (Summary)
4999 @findex gnus-summary-goto-subject
5000 Ask for an article number and then go to the summary line of that article
5001 without displaying the article (@code{gnus-summary-goto-subject}).
5004 If gnus asks you to press a key to confirm going to the next group, you
5005 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
5006 buffer, searching for the next group to read without actually returning
5007 to the group buffer.
5009 Variables related to summary movement:
5013 @vindex gnus-auto-select-next
5014 @item gnus-auto-select-next
5015 If you issue one of the movement commands (like @kbd{n}) and there are
5016 no more unread articles after the current one, gnus will offer to go to
5017 the next group. If this variable is @code{t} and the next group is
5018 empty, gnus will exit summary mode and return to the group buffer. If
5019 this variable is neither @code{t} nor @code{nil}, gnus will select the
5020 next group with unread articles. As a special case, if this variable
5021 is @code{quietly}, Gnus will select the next group without asking for
5022 confirmation. If this variable is @code{almost-quietly}, the same
5023 will happen only if you are located on the last article in the group.
5024 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
5025 command will go to the next group without confirmation. Also
5026 @pxref{Group Levels}.
5028 @item gnus-auto-select-same
5029 @vindex gnus-auto-select-same
5030 If non-@code{nil}, all the movement commands will try to go to the next
5031 article with the same subject as the current. (@dfn{Same} here might
5032 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
5033 for details (@pxref{Customizing Threading}).) If there are no more
5034 articles with the same subject, go to the first unread article.
5036 This variable is not particularly useful if you use a threaded display.
5038 @item gnus-summary-check-current
5039 @vindex gnus-summary-check-current
5040 If non-@code{nil}, all the ``unread'' movement commands will not proceed
5041 to the next (or previous) article if the current article is unread.
5042 Instead, they will choose the current article.
5044 @item gnus-auto-center-summary
5045 @vindex gnus-auto-center-summary
5046 If non-@code{nil}, gnus will keep the point in the summary buffer
5047 centered at all times. This makes things quite tidy, but if you have a
5048 slow network connection, or simply do not like this un-Emacsism, you can
5049 set this variable to @code{nil} to get the normal Emacs scrolling
5050 action. This will also inhibit horizontal re-centering of the summary
5051 buffer, which might make it more inconvenient to read extremely long
5054 This variable can also be a number. In that case, center the window at
5055 the given number of lines from the top.
5060 @node Choosing Articles
5061 @section Choosing Articles
5062 @cindex selecting articles
5065 * Choosing Commands:: Commands for choosing articles.
5066 * Choosing Variables:: Variables that influence these commands.
5070 @node Choosing Commands
5071 @subsection Choosing Commands
5073 None of the following movement commands understand the numeric prefix,
5074 and they all select and display an article.
5076 If you want to fetch new articles or redisplay the group, see
5077 @ref{Exiting the Summary Buffer}.
5081 @kindex SPACE (Summary)
5082 @findex gnus-summary-next-page
5083 Select the current article, or, if that one's read already, the next
5084 unread article (@code{gnus-summary-next-page}).
5086 If you have an article window open already and you press @kbd{SPACE}
5087 again, the article will be scrolled. This lets you conveniently
5088 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5093 @kindex G n (Summary)
5094 @findex gnus-summary-next-unread-article
5095 @c @icon{gnus-summary-next-unread}
5096 Go to next unread article (@code{gnus-summary-next-unread-article}).
5101 @findex gnus-summary-prev-unread-article
5102 @c @icon{gnus-summary-prev-unread}
5103 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5108 @kindex G N (Summary)
5109 @findex gnus-summary-next-article
5110 Go to the next article (@code{gnus-summary-next-article}).
5115 @kindex G P (Summary)
5116 @findex gnus-summary-prev-article
5117 Go to the previous article (@code{gnus-summary-prev-article}).
5120 @kindex G C-n (Summary)
5121 @findex gnus-summary-next-same-subject
5122 Go to the next article with the same subject
5123 (@code{gnus-summary-next-same-subject}).
5126 @kindex G C-p (Summary)
5127 @findex gnus-summary-prev-same-subject
5128 Go to the previous article with the same subject
5129 (@code{gnus-summary-prev-same-subject}).
5133 @kindex G f (Summary)
5135 @findex gnus-summary-first-unread-article
5136 Go to the first unread article
5137 (@code{gnus-summary-first-unread-article}).
5141 @kindex G b (Summary)
5143 @findex gnus-summary-best-unread-article
5144 Go to the unread article with the highest score
5145 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5146 go to the first unread article that has a score over the default score.
5151 @kindex G l (Summary)
5152 @findex gnus-summary-goto-last-article
5153 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5156 @kindex G o (Summary)
5157 @findex gnus-summary-pop-article
5159 @cindex article history
5160 Pop an article off the summary history and go to this article
5161 (@code{gnus-summary-pop-article}). This command differs from the
5162 command above in that you can pop as many previous articles off the
5163 history as you like, while @kbd{l} toggles the two last read articles.
5164 For a somewhat related issue (if you use these commands a lot),
5165 @pxref{Article Backlog}.
5170 @kindex G j (Summary)
5171 @findex gnus-summary-goto-article
5172 Ask for an article number or @code{Message-ID}, and then go to that
5173 article (@code{gnus-summary-goto-article}).
5178 @node Choosing Variables
5179 @subsection Choosing Variables
5181 Some variables relevant for moving and selecting articles:
5184 @item gnus-auto-extend-newsgroup
5185 @vindex gnus-auto-extend-newsgroup
5186 All the movement commands will try to go to the previous (or next)
5187 article, even if that article isn't displayed in the Summary buffer if
5188 this variable is non-@code{nil}. Gnus will then fetch the article from
5189 the server and display it in the article buffer.
5191 @item gnus-select-article-hook
5192 @vindex gnus-select-article-hook
5193 This hook is called whenever an article is selected. The default is
5194 @code{nil}. If you would like each article to be saved in the Agent as
5195 you read it, putting @code{gnus-agent-fetch-selected-article} on this
5198 @item gnus-mark-article-hook
5199 @vindex gnus-mark-article-hook
5200 @findex gnus-summary-mark-unread-as-read
5201 @findex gnus-summary-mark-read-and-unread-as-read
5202 @findex gnus-unread-mark
5203 This hook is called whenever an article is selected. It is intended to
5204 be used for marking articles as read. The default value is
5205 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5206 mark of almost any article you read to @code{gnus-read-mark}. The only
5207 articles not affected by this function are ticked, dormant, and
5208 expirable articles. If you'd instead like to just have unread articles
5209 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5210 instead. It will leave marks like @code{gnus-low-score-mark},
5211 @code{gnus-del-mark} (and so on) alone.
5216 @node Paging the Article
5217 @section Scrolling the Article
5218 @cindex article scrolling
5223 @kindex SPACE (Summary)
5224 @findex gnus-summary-next-page
5225 Pressing @kbd{SPACE} will scroll the current article forward one page,
5226 or, if you have come to the end of the current article, will choose the
5227 next article (@code{gnus-summary-next-page}).
5229 @vindex gnus-article-boring-faces
5230 @vindex gnus-article-skip-boring
5231 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5232 the article consists only of citations and signature, then it will be
5233 skipped; the next article will be shown instead. You can customize
5234 what is considered uninteresting with
5235 @code{gnus-article-boring-faces}. You can manually view the article's
5236 pages, no matter how boring, using @kbd{C-M-v}.
5239 @kindex DEL (Summary)
5240 @findex gnus-summary-prev-page
5241 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5244 @kindex RET (Summary)
5245 @findex gnus-summary-scroll-up
5246 Scroll the current article one line forward
5247 (@code{gnus-summary-scroll-up}).
5250 @kindex M-RET (Summary)
5251 @findex gnus-summary-scroll-down
5252 Scroll the current article one line backward
5253 (@code{gnus-summary-scroll-down}).
5257 @kindex A g (Summary)
5259 @findex gnus-summary-show-article
5260 @vindex gnus-summary-show-article-charset-alist
5261 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5262 given a prefix, fetch the current article, but don't run any of the
5263 article treatment functions. This will give you a ``raw'' article, just
5264 the way it came from the server.
5266 If given a numerical prefix, you can do semi-manual charset stuff.
5267 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5268 encoded in the @code{cn-gb-2312} charset. If you have
5271 (setq gnus-summary-show-article-charset-alist
5276 then you can say @kbd{C-u 1 g} to get the same effect.
5281 @kindex A < (Summary)
5282 @findex gnus-summary-beginning-of-article
5283 Scroll to the beginning of the article
5284 (@code{gnus-summary-beginning-of-article}).
5289 @kindex A > (Summary)
5290 @findex gnus-summary-end-of-article
5291 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5295 @kindex A s (Summary)
5297 @findex gnus-summary-isearch-article
5298 Perform an isearch in the article buffer
5299 (@code{gnus-summary-isearch-article}).
5303 @findex gnus-summary-select-article-buffer
5304 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5309 @node Reply Followup and Post
5310 @section Reply, Followup and Post
5313 * Summary Mail Commands:: Sending mail.
5314 * Summary Post Commands:: Sending news.
5315 * Summary Message Commands:: Other Message-related commands.
5316 * Canceling and Superseding::
5320 @node Summary Mail Commands
5321 @subsection Summary Mail Commands
5323 @cindex composing mail
5325 Commands for composing a mail message:
5331 @kindex S r (Summary)
5333 @findex gnus-summary-reply
5334 @c @icon{gnus-summary-mail-reply}
5335 @c @icon{gnus-summary-reply}
5336 Mail a reply to the author of the current article
5337 (@code{gnus-summary-reply}).
5342 @kindex S R (Summary)
5343 @findex gnus-summary-reply-with-original
5344 @c @icon{gnus-summary-reply-with-original}
5345 Mail a reply to the author of the current article and include the
5346 original message (@code{gnus-summary-reply-with-original}). This
5347 command uses the process/prefix convention.
5350 @kindex S w (Summary)
5351 @findex gnus-summary-wide-reply
5352 Mail a wide reply to the author of the current article
5353 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5354 goes out to all people listed in the @code{To}, @code{From} (or
5355 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5356 present, that's used instead.
5359 @kindex S W (Summary)
5360 @findex gnus-summary-wide-reply-with-original
5361 Mail a wide reply to the current article and include the original
5362 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5363 the process/prefix convention.
5366 @kindex S v (Summary)
5367 @findex gnus-summary-very-wide-reply
5368 Mail a very wide reply to the author of the current article
5369 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5370 that goes out to all people listed in the @code{To}, @code{From} (or
5371 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5372 articles. This command uses the process/prefix convention.
5375 @kindex S V (Summary)
5376 @findex gnus-summary-very-wide-reply-with-original
5377 Mail a very wide reply to the author of the current article and include the
5378 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5379 command uses the process/prefix convention.
5382 @kindex S B r (Summary)
5383 @findex gnus-summary-reply-broken-reply-to
5384 Mail a reply to the author of the current article but ignore the
5385 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5386 If you need this because a mailing list incorrectly sets a
5387 @code{Reply-To} header pointing to the list, you probably want to set
5388 the @code{broken-reply-to} group parameter instead, so things will work
5389 correctly. @xref{Group Parameters}.
5392 @kindex S B R (Summary)
5393 @findex gnus-summary-reply-broken-reply-to-with-original
5394 Mail a reply to the author of the current article and include the
5395 original message but ignore the @code{Reply-To} field
5396 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5400 @kindex S o m (Summary)
5401 @kindex C-c C-f (Summary)
5402 @findex gnus-summary-mail-forward
5403 @c @icon{gnus-summary-mail-forward}
5404 Forward the current article to some other person
5405 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
5406 headers of the forwarded article.
5411 @kindex S m (Summary)
5412 @findex gnus-summary-mail-other-window
5413 @c @icon{gnus-summary-mail-originate}
5414 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5415 the posting style of the current group. If given a prefix, disable that.
5416 If the prefix is 1, prompt for a group name to find the posting style.
5421 @kindex S i (Summary)
5422 @findex gnus-summary-news-other-window
5423 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5424 post to the current group. If given a prefix, disable that. If the
5425 prefix is 1, prompt for a group to post to.
5427 This function actually prepares a news even when using mail groups.
5428 This is useful for ``posting'' messages to mail groups without actually
5429 sending them over the network: they're just saved directly to the group
5430 in question. The corresponding back end must have a request-post method
5431 for this to work though.
5434 @kindex S D b (Summary)
5435 @findex gnus-summary-resend-bounced-mail
5436 @cindex bouncing mail
5437 If you have sent a mail, but the mail was bounced back to you for some
5438 reason (wrong address, transient failure), you can use this command to
5439 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5440 will be popped into a mail buffer where you can edit the headers before
5441 sending the mail off again. If you give a prefix to this command, and
5442 the bounced mail is a reply to some other mail, gnus will try to fetch
5443 that mail and display it for easy perusal of its headers. This might
5444 very well fail, though.
5447 @kindex S D r (Summary)
5448 @findex gnus-summary-resend-message
5449 Not to be confused with the previous command,
5450 @code{gnus-summary-resend-message} will prompt you for an address to
5451 send the current message off to, and then send it to that place. The
5452 headers of the message won't be altered---but lots of headers that say
5453 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5454 means that you actually send a mail to someone that has a @code{To}
5455 header that (probably) points to yourself. This will confuse people.
5456 So, natcherly you'll only do that if you're really eVIl.
5458 This command is mainly used if you have several accounts and want to
5459 ship a mail to a different account of yours. (If you're both
5460 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5461 to the @code{root} account, you may want to resend it to
5462 @code{postmaster}. Ordnung muss sein!
5464 This command understands the process/prefix convention
5465 (@pxref{Process/Prefix}).
5468 @kindex S D e (Summary)
5469 @findex gnus-summary-resend-message-edit
5471 Like the previous command, but will allow you to edit the message as
5472 if it were a new message before resending.
5475 @kindex S O m (Summary)
5476 @findex gnus-summary-digest-mail-forward
5477 Digest the current series (@pxref{Decoding Articles}) and forward the
5478 result using mail (@code{gnus-summary-digest-mail-forward}). This
5479 command uses the process/prefix convention (@pxref{Process/Prefix}).
5482 @kindex S M-c (Summary)
5483 @findex gnus-summary-mail-crosspost-complaint
5484 @cindex crossposting
5485 @cindex excessive crossposting
5486 Send a complaint about excessive crossposting to the author of the
5487 current article (@code{gnus-summary-mail-crosspost-complaint}).
5489 @findex gnus-crosspost-complaint
5490 This command is provided as a way to fight back against the current
5491 crossposting pandemic that's sweeping Usenet. It will compose a reply
5492 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5493 command understands the process/prefix convention
5494 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5498 Also @xref{Header Commands, ,Header Commands, message, The Message
5499 Manual}, for more information.
5502 @node Summary Post Commands
5503 @subsection Summary Post Commands
5505 @cindex composing news
5507 Commands for posting a news article:
5513 @kindex S p (Summary)
5514 @findex gnus-summary-post-news
5515 @c @icon{gnus-summary-post-news}
5516 Prepare for posting an article (@code{gnus-summary-post-news}). By
5517 default, post to the current group. If given a prefix, disable that.
5518 If the prefix is 1, prompt for another group instead.
5523 @kindex S f (Summary)
5524 @findex gnus-summary-followup
5525 @c @icon{gnus-summary-followup}
5526 Post a followup to the current article (@code{gnus-summary-followup}).
5530 @kindex S F (Summary)
5532 @c @icon{gnus-summary-followup-with-original}
5533 @findex gnus-summary-followup-with-original
5534 Post a followup to the current article and include the original message
5535 (@code{gnus-summary-followup-with-original}). This command uses the
5536 process/prefix convention.
5539 @kindex S n (Summary)
5540 @findex gnus-summary-followup-to-mail
5541 Post a followup to the current article via news, even if you got the
5542 message through mail (@code{gnus-summary-followup-to-mail}).
5545 @kindex S N (Summary)
5546 @findex gnus-summary-followup-to-mail-with-original
5547 Post a followup to the current article via news, even if you got the
5548 message through mail and include the original message
5549 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5550 the process/prefix convention.
5553 @kindex S o p (Summary)
5554 @findex gnus-summary-post-forward
5555 Forward the current article to a newsgroup
5556 (@code{gnus-summary-post-forward}). If given a prefix, include the full
5557 headers of the forwarded article.
5560 @kindex S O p (Summary)
5561 @findex gnus-summary-digest-post-forward
5563 @cindex making digests
5564 Digest the current series and forward the result to a newsgroup
5565 (@code{gnus-summary-digest-post-forward}). This command uses the
5566 process/prefix convention.
5569 @kindex S u (Summary)
5570 @findex gnus-uu-post-news
5571 @c @icon{gnus-uu-post-news}
5572 Uuencode a file, split it into parts, and post it as a series
5573 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5576 Also @xref{Header Commands, ,Header Commands, message, The Message
5577 Manual}, for more information.
5580 @node Summary Message Commands
5581 @subsection Summary Message Commands
5585 @kindex S y (Summary)
5586 @findex gnus-summary-yank-message
5587 Yank the current article into an already existing Message composition
5588 buffer (@code{gnus-summary-yank-message}). This command prompts for
5589 what message buffer you want to yank into, and understands the
5590 process/prefix convention (@pxref{Process/Prefix}).
5595 @node Canceling and Superseding
5596 @subsection Canceling Articles
5597 @cindex canceling articles
5598 @cindex superseding articles
5600 Have you ever written something, and then decided that you really,
5601 really, really wish you hadn't posted that?
5603 Well, you can't cancel mail, but you can cancel posts.
5605 @findex gnus-summary-cancel-article
5607 @c @icon{gnus-summary-cancel-article}
5608 Find the article you wish to cancel (you can only cancel your own
5609 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5610 c} (@code{gnus-summary-cancel-article}). Your article will be
5611 canceled---machines all over the world will be deleting your article.
5612 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5614 Be aware, however, that not all sites honor cancels, so your article may
5615 live on here and there, while most sites will delete the article in
5618 Gnus will use the ``current'' select method when canceling. If you
5619 want to use the standard posting method, use the @samp{a} symbolic
5620 prefix (@pxref{Symbolic Prefixes}).
5622 Gnus ensures that only you can cancel your own messages using a
5623 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5624 message, Message Manual}).
5626 If you discover that you have made some mistakes and want to do some
5627 corrections, you can post a @dfn{superseding} article that will replace
5628 your original article.
5630 @findex gnus-summary-supersede-article
5632 Go to the original article and press @kbd{S s}
5633 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5634 where you can edit the article all you want before sending it off the
5637 The same goes for superseding as for canceling, only more so: Some
5638 sites do not honor superseding. On those sites, it will appear that you
5639 have posted almost the same article twice.
5641 If you have just posted the article, and change your mind right away,
5642 there is a trick you can use to cancel/supersede the article without
5643 waiting for the article to appear on your site first. You simply return
5644 to the post buffer (which is called @code{*sent ...*}). There you will
5645 find the article you just posted, with all the headers intact. Change
5646 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5647 header by substituting one of those words for the word
5648 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5649 you would do normally. The previous article will be
5650 canceled/superseded.
5652 Just remember, kids: There is no 'c' in 'supersede'.
5654 @node Delayed Articles
5655 @section Delayed Articles
5656 @cindex delayed sending
5657 @cindex send delayed
5659 Sometimes, you might wish to delay the sending of a message. For
5660 example, you might wish to arrange for a message to turn up just in time
5661 to remind your about the birthday of your Significant Other. For this,
5662 there is the @code{gnus-delay} package. Setup is simple:
5665 (gnus-delay-initialize)
5668 @findex gnus-delay-article
5669 Normally, to send a message you use the @kbd{C-c C-c} command from
5670 Message mode. To delay a message, use @kbd{C-c C-j}
5671 (@code{gnus-delay-article}) instead. This will ask you for how long the
5672 message should be delayed. Possible answers are:
5676 A time span. Consists of an integer and a letter. For example,
5677 @code{42d} means to delay for 42 days. Available letters are @code{m}
5678 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5679 (months) and @code{Y} (years).
5682 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5683 delayed until that day, at a specific time (eight o'clock by default).
5684 See also @code{gnus-delay-default-hour}.
5687 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5688 stuff. The deadline will be at that time today, except if that time has
5689 already passed, then it's at the given time tomorrow. So if it's ten
5690 o'clock in the morning and you specify @code{11:15}, then the deadline
5691 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5692 that means a time tomorrow.
5695 The action of the @code{gnus-delay-article} command is influenced by a
5696 couple of variables:
5699 @item gnus-delay-default-hour
5700 @vindex gnus-delay-default-hour
5701 When you specify a specific date, the message will be due on that hour
5702 on the given date. Possible values are integers 0 through 23.
5704 @item gnus-delay-default-delay
5705 @vindex gnus-delay-default-delay
5706 This is a string and gives the default delay. It can be of any of the
5707 formats described above.
5709 @item gnus-delay-group
5710 @vindex gnus-delay-group
5711 Delayed articles will be kept in this group on the drafts server until
5712 they are due. You probably don't need to change this. The default
5713 value is @code{"delayed"}.
5715 @item gnus-delay-header
5716 @vindex gnus-delay-header
5717 The deadline for each article will be stored in a header. This variable
5718 is a string and gives the header name. You probably don't need to
5719 change this. The default value is @code{"X-Gnus-Delayed"}.
5722 The way delaying works is like this: when you use the
5723 @code{gnus-delay-article} command, you give a certain delay. Gnus
5724 calculates the deadline of the message and stores it in the
5725 @code{X-Gnus-Delayed} header and puts the message in the
5726 @code{nndraft:delayed} group.
5728 @findex gnus-delay-send-queue
5729 And whenever you get new news, Gnus looks through the group for articles
5730 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5731 function for this. By default, this function is added to the hook
5732 @code{gnus-get-new-news-hook}. But of course, you can change this.
5733 Maybe you want to use the demon to send drafts? Just tell the demon to
5734 execute the @code{gnus-delay-send-queue} function.
5737 @item gnus-delay-initialize
5738 @findex gnus-delay-initialize
5740 By default, this function installs @code{gnus-delay-send-queue} in
5741 @code{gnus-get-new-news-hook}. But it accepts the optional second
5742 argument @code{no-check}. If it is non-@code{nil},
5743 @code{gnus-get-new-news-hook} is not changed. The optional first
5744 argument is ignored.
5746 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5747 Presumably, you want to use the demon for sending due delayed articles.
5748 Just don't forget to set that up :-)
5752 @node Marking Articles
5753 @section Marking Articles
5754 @cindex article marking
5755 @cindex article ticking
5758 There are several marks you can set on an article.
5760 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5761 neologism ohoy!) of the article. Alphabetic marks generally mean
5762 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5764 In addition, you also have marks that do not affect readedness.
5767 There's a plethora of commands for manipulating these marks.
5771 * Unread Articles:: Marks for unread articles.
5772 * Read Articles:: Marks for read articles.
5773 * Other Marks:: Marks that do not affect readedness.
5774 * Setting Marks:: How to set and remove marks.
5775 * Generic Marking Commands:: How to customize the marking.
5776 * Setting Process Marks:: How to mark articles for later processing.
5780 @node Unread Articles
5781 @subsection Unread Articles
5783 The following marks mark articles as (kinda) unread, in one form or
5788 @vindex gnus-ticked-mark
5789 Marked as ticked (@code{gnus-ticked-mark}).
5791 @dfn{Ticked articles} are articles that will remain visible always. If
5792 you see an article that you find interesting, or you want to put off
5793 reading it, or replying to it, until sometime later, you'd typically
5794 tick it. However, articles can be expired (from news servers by the
5795 news server software, Gnus itself never expires ticked messages), so if
5796 you want to keep an article forever, you'll have to make it persistent
5797 (@pxref{Persistent Articles}).
5800 @vindex gnus-dormant-mark
5801 Marked as dormant (@code{gnus-dormant-mark}).
5803 @dfn{Dormant articles} will only appear in the summary buffer if there
5804 are followups to it. If you want to see them even if they don't have
5805 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5806 Otherwise (except for the visibility issue), they are just like ticked
5810 @vindex gnus-unread-mark
5811 Marked as unread (@code{gnus-unread-mark}).
5813 @dfn{Unread articles} are articles that haven't been read at all yet.
5818 @subsection Read Articles
5819 @cindex expirable mark
5821 All the following marks mark articles as read.
5826 @vindex gnus-del-mark
5827 These are articles that the user has marked as read with the @kbd{d}
5828 command manually, more or less (@code{gnus-del-mark}).
5831 @vindex gnus-read-mark
5832 Articles that have actually been read (@code{gnus-read-mark}).
5835 @vindex gnus-ancient-mark
5836 Articles that were marked as read in previous sessions and are now
5837 @dfn{old} (@code{gnus-ancient-mark}).
5840 @vindex gnus-killed-mark
5841 Marked as killed (@code{gnus-killed-mark}).
5844 @vindex gnus-kill-file-mark
5845 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5848 @vindex gnus-low-score-mark
5849 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5852 @vindex gnus-catchup-mark
5853 Marked as read by a catchup (@code{gnus-catchup-mark}).
5856 @vindex gnus-canceled-mark
5857 Canceled article (@code{gnus-canceled-mark})
5860 @vindex gnus-souped-mark
5861 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5864 @vindex gnus-sparse-mark
5865 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5869 @vindex gnus-duplicate-mark
5870 Article marked as read by duplicate suppression
5871 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5875 All these marks just mean that the article is marked as read, really.
5876 They are interpreted differently when doing adaptive scoring, though.
5878 One more special mark, though:
5882 @vindex gnus-expirable-mark
5883 Marked as expirable (@code{gnus-expirable-mark}).
5885 Marking articles as @dfn{expirable} (or have them marked as such
5886 automatically) doesn't make much sense in normal groups---a user doesn't
5887 control expiring of news articles, but in mail groups, for instance,
5888 articles marked as @dfn{expirable} can be deleted by gnus at
5894 @subsection Other Marks
5895 @cindex process mark
5898 There are some marks that have nothing to do with whether the article is
5904 You can set a bookmark in the current article. Say you are reading a
5905 long thesis on cats' urinary tracts, and have to go home for dinner
5906 before you've finished reading the thesis. You can then set a bookmark
5907 in the article, and gnus will jump to this bookmark the next time it
5908 encounters the article. @xref{Setting Marks}.
5911 @vindex gnus-replied-mark
5912 All articles that you have replied to or made a followup to (i.e., have
5913 answered) will be marked with an @samp{A} in the second column
5914 (@code{gnus-replied-mark}).
5917 @vindex gnus-forwarded-mark
5918 All articles that you have forwarded will be marked with an @samp{F} in
5919 the second column (@code{gnus-forwarded-mark}).
5922 @vindex gnus-cached-mark
5923 Articles stored in the article cache will be marked with an @samp{*} in
5924 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5927 @vindex gnus-saved-mark
5928 Articles ``saved'' (in some manner or other; not necessarily
5929 religiously) are marked with an @samp{S} in the second column
5930 (@code{gnus-saved-mark}).
5933 @vindex gnus-recent-mark
5934 Articles that according to the server haven't been shown to the user
5935 before are marked with a @samp{N} in the second column
5936 (@code{gnus-recent-mark}). Note that not all servers support this
5937 mark, in which case it simply never appears. Compare with
5938 @code{gnus-unseen-mark}.
5941 @vindex gnus-unseen-mark
5942 Articles that haven't been seen before in Gnus by the user are marked
5943 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5944 Compare with @code{gnus-recent-mark}.
5947 @vindex gnus-downloaded-mark
5948 When using the Gnus agent (@pxref{Agent Basics}), articles may be
5949 downloaded for unplugged (offline) viewing. If you are using the
5950 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
5951 (The variable @code{gnus-downloaded-mark} controls which character to
5955 @vindex gnus-undownloaded-mark
5956 When using the Gnus agent (@pxref{Agent Basics}), some articles might
5957 not have been downloaded. Such articles cannot be viewed while you
5958 are unplugged (offline). If you are using the @samp{%O} spec, these
5959 articles get the @samp{-} mark in that spec. (The variable
5960 @code{gnus-undownloaded-mark} controls which character to use.)
5963 @vindex gnus-downloadable-mark
5964 The Gnus agent (@pxref{Agent Basics}) downloads some articles
5965 automatically, but it is also possible to explicitly mark articles for
5966 download, even if they would not be downloaded automatically. Such
5967 explicitly-marked articles get the @samp{%} mark in the first column.
5968 (The variable @code{gnus-downloadable-mark} controls which character to
5972 @vindex gnus-not-empty-thread-mark
5973 @vindex gnus-empty-thread-mark
5974 If the @samp{%e} spec is used, the presence of threads or not will be
5975 marked with @code{gnus-not-empty-thread-mark} and
5976 @code{gnus-empty-thread-mark} in the third column, respectively.
5979 @vindex gnus-process-mark
5980 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5981 variety of commands react to the presence of the process mark. For
5982 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5983 all articles that have been marked with the process mark. Articles
5984 marked with the process mark have a @samp{#} in the second column.
5988 You might have noticed that most of these ``non-readedness'' marks
5989 appear in the second column by default. So if you have a cached, saved,
5990 replied article that you have process-marked, what will that look like?
5992 Nothing much. The precedence rules go as follows: process -> cache ->
5993 replied -> saved. So if the article is in the cache and is replied,
5994 you'll only see the cache mark and not the replied mark.
5998 @subsection Setting Marks
5999 @cindex setting marks
6001 All the marking commands understand the numeric prefix.
6006 @kindex M c (Summary)
6007 @kindex M-u (Summary)
6008 @findex gnus-summary-clear-mark-forward
6009 @cindex mark as unread
6010 Clear all readedness-marks from the current article
6011 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
6017 @kindex M t (Summary)
6018 @findex gnus-summary-tick-article-forward
6019 Tick the current article (@code{gnus-summary-tick-article-forward}).
6020 @xref{Article Caching}.
6025 @kindex M ? (Summary)
6026 @findex gnus-summary-mark-as-dormant
6027 Mark the current article as dormant
6028 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
6032 @kindex M d (Summary)
6034 @findex gnus-summary-mark-as-read-forward
6035 Mark the current article as read
6036 (@code{gnus-summary-mark-as-read-forward}).
6040 @findex gnus-summary-mark-as-read-backward
6041 Mark the current article as read and move point to the previous line
6042 (@code{gnus-summary-mark-as-read-backward}).
6047 @kindex M k (Summary)
6048 @findex gnus-summary-kill-same-subject-and-select
6049 Mark all articles that have the same subject as the current one as read,
6050 and then select the next unread article
6051 (@code{gnus-summary-kill-same-subject-and-select}).
6055 @kindex M K (Summary)
6056 @kindex C-k (Summary)
6057 @findex gnus-summary-kill-same-subject
6058 Mark all articles that have the same subject as the current one as read
6059 (@code{gnus-summary-kill-same-subject}).
6062 @kindex M C (Summary)
6063 @findex gnus-summary-catchup
6064 @c @icon{gnus-summary-catchup}
6065 Mark all unread articles as read (@code{gnus-summary-catchup}).
6068 @kindex M C-c (Summary)
6069 @findex gnus-summary-catchup-all
6070 Mark all articles in the group as read---even the ticked and dormant
6071 articles (@code{gnus-summary-catchup-all}).
6074 @kindex M H (Summary)
6075 @findex gnus-summary-catchup-to-here
6076 Catchup the current group to point (before the point)
6077 (@code{gnus-summary-catchup-to-here}).
6080 @kindex M h (Summary)
6081 @findex gnus-summary-catchup-from-here
6082 Catchup the current group from point (after the point)
6083 (@code{gnus-summary-catchup-from-here}).
6086 @kindex C-w (Summary)
6087 @findex gnus-summary-mark-region-as-read
6088 Mark all articles between point and mark as read
6089 (@code{gnus-summary-mark-region-as-read}).
6092 @kindex M V k (Summary)
6093 @findex gnus-summary-kill-below
6094 Kill all articles with scores below the default score (or below the
6095 numeric prefix) (@code{gnus-summary-kill-below}).
6099 @kindex M e (Summary)
6101 @findex gnus-summary-mark-as-expirable
6102 Mark the current article as expirable
6103 (@code{gnus-summary-mark-as-expirable}).
6106 @kindex M b (Summary)
6107 @findex gnus-summary-set-bookmark
6108 Set a bookmark in the current article
6109 (@code{gnus-summary-set-bookmark}).
6112 @kindex M B (Summary)
6113 @findex gnus-summary-remove-bookmark
6114 Remove the bookmark from the current article
6115 (@code{gnus-summary-remove-bookmark}).
6118 @kindex M V c (Summary)
6119 @findex gnus-summary-clear-above
6120 Clear all marks from articles with scores over the default score (or
6121 over the numeric prefix) (@code{gnus-summary-clear-above}).
6124 @kindex M V u (Summary)
6125 @findex gnus-summary-tick-above
6126 Tick all articles with scores over the default score (or over the
6127 numeric prefix) (@code{gnus-summary-tick-above}).
6130 @kindex M V m (Summary)
6131 @findex gnus-summary-mark-above
6132 Prompt for a mark, and mark all articles with scores over the default
6133 score (or over the numeric prefix) with this mark
6134 (@code{gnus-summary-clear-above}).
6137 @vindex gnus-summary-goto-unread
6138 The @code{gnus-summary-goto-unread} variable controls what action should
6139 be taken after setting a mark. If non-@code{nil}, point will move to
6140 the next/previous unread article. If @code{nil}, point will just move
6141 one line up or down. As a special case, if this variable is
6142 @code{never}, all the marking commands as well as other commands (like
6143 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6144 The default is @code{t}.
6147 @node Generic Marking Commands
6148 @subsection Generic Marking Commands
6150 Some people would like the command that ticks an article (@kbd{!}) go to
6151 the next article. Others would like it to go to the next unread
6152 article. Yet others would like it to stay on the current article. And
6153 even though I haven't heard of anybody wanting it to go to the
6154 previous (unread) article, I'm sure there are people that want that as
6157 Multiply these five behaviors with five different marking commands, and
6158 you get a potentially complex set of variable to control what each
6161 To sidestep that mess, Gnus provides commands that do all these
6162 different things. They can be found on the @kbd{M M} map in the summary
6163 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6164 to list in this manual.
6166 While you can use these commands directly, most users would prefer
6167 altering the summary mode keymap. For instance, if you would like the
6168 @kbd{!} command to go to the next article instead of the next unread
6169 article, you could say something like:
6173 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6174 (defun my-alter-summary-map ()
6175 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6183 (defun my-alter-summary-map ()
6184 (local-set-key "!" "MM!n"))
6188 @node Setting Process Marks
6189 @subsection Setting Process Marks
6190 @cindex setting process marks
6192 Process marks are displayed as @code{#} in the summary buffer, and are
6193 used for marking articles in such a way that other commands will
6194 process these articles. For instance, if you process mark four
6195 articles and then use the @kbd{*} command, Gnus will enter these four
6196 commands into the cache. For more information,
6197 @pxref{Process/Prefix}.
6204 @kindex M P p (Summary)
6205 @findex gnus-summary-mark-as-processable
6206 Mark the current article with the process mark
6207 (@code{gnus-summary-mark-as-processable}).
6208 @findex gnus-summary-unmark-as-processable
6212 @kindex M P u (Summary)
6213 @kindex M-# (Summary)
6214 Remove the process mark, if any, from the current article
6215 (@code{gnus-summary-unmark-as-processable}).
6218 @kindex M P U (Summary)
6219 @findex gnus-summary-unmark-all-processable
6220 Remove the process mark from all articles
6221 (@code{gnus-summary-unmark-all-processable}).
6224 @kindex M P i (Summary)
6225 @findex gnus-uu-invert-processable
6226 Invert the list of process marked articles
6227 (@code{gnus-uu-invert-processable}).
6230 @kindex M P R (Summary)
6231 @findex gnus-uu-mark-by-regexp
6232 Mark articles that have a @code{Subject} header that matches a regular
6233 expression (@code{gnus-uu-mark-by-regexp}).
6236 @kindex M P G (Summary)
6237 @findex gnus-uu-unmark-by-regexp
6238 Unmark articles that have a @code{Subject} header that matches a regular
6239 expression (@code{gnus-uu-unmark-by-regexp}).
6242 @kindex M P r (Summary)
6243 @findex gnus-uu-mark-region
6244 Mark articles in region (@code{gnus-uu-mark-region}).
6247 @kindex M P g (Summary)
6248 @findex gnus-uu-unmark-region
6249 Unmark articles in region (@code{gnus-uu-unmark-region}).
6252 @kindex M P t (Summary)
6253 @findex gnus-uu-mark-thread
6254 Mark all articles in the current (sub)thread
6255 (@code{gnus-uu-mark-thread}).
6258 @kindex M P T (Summary)
6259 @findex gnus-uu-unmark-thread
6260 Unmark all articles in the current (sub)thread
6261 (@code{gnus-uu-unmark-thread}).
6264 @kindex M P v (Summary)
6265 @findex gnus-uu-mark-over
6266 Mark all articles that have a score above the prefix argument
6267 (@code{gnus-uu-mark-over}).
6270 @kindex M P s (Summary)
6271 @findex gnus-uu-mark-series
6272 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6275 @kindex M P S (Summary)
6276 @findex gnus-uu-mark-sparse
6277 Mark all series that have already had some articles marked
6278 (@code{gnus-uu-mark-sparse}).
6281 @kindex M P a (Summary)
6282 @findex gnus-uu-mark-all
6283 Mark all articles in series order (@code{gnus-uu-mark-all}).
6286 @kindex M P b (Summary)
6287 @findex gnus-uu-mark-buffer
6288 Mark all articles in the buffer in the order they appear
6289 (@code{gnus-uu-mark-buffer}).
6292 @kindex M P k (Summary)
6293 @findex gnus-summary-kill-process-mark
6294 Push the current process mark set onto the stack and unmark all articles
6295 (@code{gnus-summary-kill-process-mark}).
6298 @kindex M P y (Summary)
6299 @findex gnus-summary-yank-process-mark
6300 Pop the previous process mark set from the stack and restore it
6301 (@code{gnus-summary-yank-process-mark}).
6304 @kindex M P w (Summary)
6305 @findex gnus-summary-save-process-mark
6306 Push the current process mark set onto the stack
6307 (@code{gnus-summary-save-process-mark}).
6311 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6312 set process marks based on article body contents.
6319 It can be convenient to limit the summary buffer to just show some
6320 subset of the articles currently in the group. The effect most limit
6321 commands have is to remove a few (or many) articles from the summary
6324 All limiting commands work on subsets of the articles already fetched
6325 from the servers. None of these commands query the server for
6326 additional articles.
6332 @kindex / / (Summary)
6333 @findex gnus-summary-limit-to-subject
6334 Limit the summary buffer to articles that match some subject
6335 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6339 @kindex / a (Summary)
6340 @findex gnus-summary-limit-to-author
6341 Limit the summary buffer to articles that match some author
6342 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6346 @kindex / R (Summary)
6347 @findex gnus-summary-limit-to-recipient
6348 Limit the summary buffer to articles that match some recipient
6349 (@code{gnus-summary-limit-to-recipient}). If given a prefix, exclude
6353 @kindex / x (Summary)
6354 @findex gnus-summary-limit-to-extra
6355 Limit the summary buffer to articles that match one of the ``extra''
6356 headers (@pxref{To From Newsgroups})
6357 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6362 @kindex / u (Summary)
6364 @findex gnus-summary-limit-to-unread
6365 Limit the summary buffer to articles not marked as read
6366 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6367 buffer to articles strictly unread. This means that ticked and
6368 dormant articles will also be excluded.
6371 @kindex / m (Summary)
6372 @findex gnus-summary-limit-to-marks
6373 Ask for a mark and then limit to all articles that have been marked
6374 with that mark (@code{gnus-summary-limit-to-marks}).
6377 @kindex / t (Summary)
6378 @findex gnus-summary-limit-to-age
6379 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6380 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6381 articles younger than that number of days.
6384 @kindex / n (Summary)
6385 @findex gnus-summary-limit-to-articles
6386 Limit the summary buffer to the current article
6387 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
6388 convention (@pxref{Process/Prefix}).
6391 @kindex / w (Summary)
6392 @findex gnus-summary-pop-limit
6393 Pop the previous limit off the stack and restore it
6394 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6398 @kindex / . (Summary)
6399 @findex gnus-summary-limit-to-unseen
6400 Limit the summary buffer to the unseen articles
6401 (@code{gnus-summary-limit-to-unseen}).
6404 @kindex / v (Summary)
6405 @findex gnus-summary-limit-to-score
6406 Limit the summary buffer to articles that have a score at or above some
6407 score (@code{gnus-summary-limit-to-score}).
6410 @kindex / p (Summary)
6411 @findex gnus-summary-limit-to-display-predicate
6412 Limit the summary buffer to articles that satisfy the @code{display}
6413 group parameter predicate
6414 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6415 Parameters}, for more on this predicate.
6418 @kindex / r (Summary)
6419 @findex gnus-summary-limit-to-replied
6420 Limit the summary buffer to replied articles
6421 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6426 @kindex M S (Summary)
6427 @kindex / E (Summary)
6428 @findex gnus-summary-limit-include-expunged
6429 Include all expunged articles in the limit
6430 (@code{gnus-summary-limit-include-expunged}).
6433 @kindex / D (Summary)
6434 @findex gnus-summary-limit-include-dormant
6435 Include all dormant articles in the limit
6436 (@code{gnus-summary-limit-include-dormant}).
6439 @kindex / * (Summary)
6440 @findex gnus-summary-limit-include-cached
6441 Include all cached articles in the limit
6442 (@code{gnus-summary-limit-include-cached}).
6445 @kindex / d (Summary)
6446 @findex gnus-summary-limit-exclude-dormant
6447 Exclude all dormant articles from the limit
6448 (@code{gnus-summary-limit-exclude-dormant}).
6451 @kindex / M (Summary)
6452 @findex gnus-summary-limit-exclude-marks
6453 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6456 @kindex / T (Summary)
6457 @findex gnus-summary-limit-include-thread
6458 Include all the articles in the current thread in the limit.
6461 @kindex / c (Summary)
6462 @findex gnus-summary-limit-exclude-childless-dormant
6463 Exclude all dormant articles that have no children from the limit@*
6464 (@code{gnus-summary-limit-exclude-childless-dormant}).
6467 @kindex / C (Summary)
6468 @findex gnus-summary-limit-mark-excluded-as-read
6469 Mark all excluded unread articles as read
6470 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6471 also mark excluded ticked and dormant articles as read.
6474 @kindex / N (Summary)
6475 @findex gnus-summary-insert-new-articles
6476 Insert all new articles in the summary buffer. It scans for new emails
6477 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6480 @kindex / o (Summary)
6481 @findex gnus-summary-insert-old-articles
6482 Insert all old articles in the summary buffer. If given a numbered
6483 prefix, fetch this number of articles.
6491 @cindex article threading
6493 Gnus threads articles by default. @dfn{To thread} is to put responses
6494 to articles directly after the articles they respond to---in a
6495 hierarchical fashion.
6497 Threading is done by looking at the @code{References} headers of the
6498 articles. In a perfect world, this would be enough to build pretty
6499 trees, but unfortunately, the @code{References} header is often broken
6500 or simply missing. Weird news propagation exacerbates the problem,
6501 so one has to employ other heuristics to get pleasing results. A
6502 plethora of approaches exists, as detailed in horrible detail in
6503 @ref{Customizing Threading}.
6505 First, a quick overview of the concepts:
6509 The top-most article in a thread; the first article in the thread.
6512 A tree-like article structure.
6515 A small(er) section of this tree-like structure.
6518 Threads often lose their roots due to article expiry, or due to the root
6519 already having been read in a previous session, and not displayed in the
6520 summary buffer. We then typically have many sub-threads that really
6521 belong to one thread, but are without connecting roots. These are
6522 called loose threads.
6524 @item thread gathering
6525 An attempt to gather loose threads into bigger threads.
6527 @item sparse threads
6528 A thread where the missing articles have been ``guessed'' at, and are
6529 displayed as empty lines in the summary buffer.
6535 * Customizing Threading:: Variables you can change to affect the threading.
6536 * Thread Commands:: Thread based commands in the summary buffer.
6540 @node Customizing Threading
6541 @subsection Customizing Threading
6542 @cindex customizing threading
6545 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6546 * Filling In Threads:: Making the threads displayed look fuller.
6547 * More Threading:: Even more variables for fiddling with threads.
6548 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6553 @subsubsection Loose Threads
6556 @cindex loose threads
6559 @item gnus-summary-make-false-root
6560 @vindex gnus-summary-make-false-root
6561 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
6562 and create a dummy root at the top. (Wait a minute. Root at the top?
6563 Yup.) Loose subtrees occur when the real root has expired, or you've
6564 read or killed the root in a previous session.
6566 When there is no real root of a thread, gnus will have to fudge
6567 something. This variable says what fudging method gnus should use.
6568 There are four possible values:
6572 \gnusfigure{The Summary Buffer}{390}{
6573 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6574 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6575 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6576 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6581 @cindex adopting articles
6586 Gnus will make the first of the orphaned articles the parent. This
6587 parent will adopt all the other articles. The adopted articles will be
6588 marked as such by pointy brackets (@samp{<>}) instead of the standard
6589 square brackets (@samp{[]}). This is the default method.
6592 @vindex gnus-summary-dummy-line-format
6593 @vindex gnus-summary-make-false-root-always
6594 Gnus will create a dummy summary line that will pretend to be the
6595 parent. This dummy line does not correspond to any real article, so
6596 selecting it will just select the first real article after the dummy
6597 article. @code{gnus-summary-dummy-line-format} is used to specify the
6598 format of the dummy roots. It accepts only one format spec: @samp{S},
6599 which is the subject of the article. @xref{Formatting Variables}.
6600 If you want all threads to have a dummy root, even the non-gathered
6601 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6604 Gnus won't actually make any article the parent, but simply leave the
6605 subject field of all orphans except the first empty. (Actually, it will
6606 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6610 Don't make any article parent at all. Just gather the threads and
6611 display them after one another.
6614 Don't gather loose threads.
6617 @item gnus-summary-gather-subject-limit
6618 @vindex gnus-summary-gather-subject-limit
6619 Loose threads are gathered by comparing subjects of articles. If this
6620 variable is @code{nil}, gnus requires an exact match between the
6621 subjects of the loose threads before gathering them into one big
6622 super-thread. This might be too strict a requirement, what with the
6623 presence of stupid newsreaders that chop off long subject lines. If
6624 you think so, set this variable to, say, 20 to require that only the
6625 first 20 characters of the subjects have to match. If you set this
6626 variable to a really low number, you'll find that gnus will gather
6627 everything in sight into one thread, which isn't very helpful.
6629 @cindex fuzzy article gathering
6630 If you set this variable to the special value @code{fuzzy}, gnus will
6631 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6634 @item gnus-simplify-subject-fuzzy-regexp
6635 @vindex gnus-simplify-subject-fuzzy-regexp
6636 This can either be a regular expression or list of regular expressions
6637 that match strings that will be removed from subjects if fuzzy subject
6638 simplification is used.
6640 @item gnus-simplify-ignored-prefixes
6641 @vindex gnus-simplify-ignored-prefixes
6642 If you set @code{gnus-summary-gather-subject-limit} to something as low
6643 as 10, you might consider setting this variable to something sensible:
6645 @c Written by Michael Ernst <mernst@cs.rice.edu>
6647 (setq gnus-simplify-ignored-prefixes
6653 "wanted" "followup" "summary\\( of\\)?"
6654 "help" "query" "problem" "question"
6655 "answer" "reference" "announce"
6656 "How can I" "How to" "Comparison of"
6661 (mapconcat 'identity
6662 '("for" "for reference" "with" "about")
6664 "\\)?\\]?:?[ \t]*"))
6667 All words that match this regexp will be removed before comparing two
6670 @item gnus-simplify-subject-functions
6671 @vindex gnus-simplify-subject-functions
6672 If non-@code{nil}, this variable overrides
6673 @code{gnus-summary-gather-subject-limit}. This variable should be a
6674 list of functions to apply to the @code{Subject} string iteratively to
6675 arrive at the simplified version of the string.
6677 Useful functions to put in this list include:
6680 @item gnus-simplify-subject-re
6681 @findex gnus-simplify-subject-re
6682 Strip the leading @samp{Re:}.
6684 @item gnus-simplify-subject-fuzzy
6685 @findex gnus-simplify-subject-fuzzy
6688 @item gnus-simplify-whitespace
6689 @findex gnus-simplify-whitespace
6690 Remove excessive whitespace.
6692 @item gnus-simplify-all-whitespace
6693 @findex gnus-simplify-all-whitespace
6694 Remove all whitespace.
6697 You may also write your own functions, of course.
6700 @item gnus-summary-gather-exclude-subject
6701 @vindex gnus-summary-gather-exclude-subject
6702 Since loose thread gathering is done on subjects only, that might lead
6703 to many false hits, especially with certain common subjects like
6704 @samp{} and @samp{(none)}. To make the situation slightly better,
6705 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6706 what subjects should be excluded from the gathering process.@*
6707 The default is @samp{^ *$\\|^(none)$}.
6709 @item gnus-summary-thread-gathering-function
6710 @vindex gnus-summary-thread-gathering-function
6711 Gnus gathers threads by looking at @code{Subject} headers. This means
6712 that totally unrelated articles may end up in the same ``thread'', which
6713 is confusing. An alternate approach is to look at all the
6714 @code{Message-ID}s in all the @code{References} headers to find matches.
6715 This will ensure that no gathered threads ever include unrelated
6716 articles, but it also means that people who have posted with broken
6717 newsreaders won't be gathered properly. The choice is yours---plague or
6721 @item gnus-gather-threads-by-subject
6722 @findex gnus-gather-threads-by-subject
6723 This function is the default gathering function and looks at
6724 @code{Subject}s exclusively.
6726 @item gnus-gather-threads-by-references
6727 @findex gnus-gather-threads-by-references
6728 This function looks at @code{References} headers exclusively.
6731 If you want to test gathering by @code{References}, you could say
6735 (setq gnus-summary-thread-gathering-function
6736 'gnus-gather-threads-by-references)
6742 @node Filling In Threads
6743 @subsubsection Filling In Threads
6746 @item gnus-fetch-old-headers
6747 @vindex gnus-fetch-old-headers
6748 If non-@code{nil}, gnus will attempt to build old threads by fetching
6749 more old headers---headers to articles marked as read. If you would
6750 like to display as few summary lines as possible, but still connect as
6751 many loose threads as possible, you should set this variable to
6752 @code{some} or a number. If you set it to a number, no more than that
6753 number of extra old headers will be fetched. In either case, fetching
6754 old headers only works if the back end you are using carries overview
6755 files---this would normally be @code{nntp}, @code{nnspool},
6756 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
6757 the thread has been expired by the server, there's not much Gnus can
6760 This variable can also be set to @code{invisible}. This won't have any
6761 visible effects, but is useful if you use the @kbd{A T} command a lot
6762 (@pxref{Finding the Parent}).
6764 @item gnus-fetch-old-ephemeral-headers
6765 @vindex gnus-fetch-old-ephemeral-headers
6766 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
6769 @item gnus-build-sparse-threads
6770 @vindex gnus-build-sparse-threads
6771 Fetching old headers can be slow. A low-rent similar effect can be
6772 gotten by setting this variable to @code{some}. Gnus will then look at
6773 the complete @code{References} headers of all articles and try to string
6774 together articles that belong in the same thread. This will leave
6775 @dfn{gaps} in the threading display where gnus guesses that an article
6776 is missing from the thread. (These gaps appear like normal summary
6777 lines. If you select a gap, gnus will try to fetch the article in
6778 question.) If this variable is @code{t}, gnus will display all these
6779 ``gaps'' without regard for whether they are useful for completing the
6780 thread or not. Finally, if this variable is @code{more}, gnus won't cut
6781 off sparse leaf nodes that don't lead anywhere. This variable is
6782 @code{nil} by default.
6784 @item gnus-read-all-available-headers
6785 @vindex gnus-read-all-available-headers
6786 This is a rather obscure variable that few will find useful. It's
6787 intended for those non-news newsgroups where the back end has to fetch
6788 quite a lot to present the summary buffer, and where it's impossible to
6789 go back to parents of articles. This is mostly the case in the
6790 web-based groups, like the @code{nnultimate} groups.
6792 If you don't use those, then it's safe to leave this as the default
6793 @code{nil}. If you want to use this variable, it should be a regexp
6794 that matches the group name, or @code{t} for all groups.
6799 @node More Threading
6800 @subsubsection More Threading
6803 @item gnus-show-threads
6804 @vindex gnus-show-threads
6805 If this variable is @code{nil}, no threading will be done, and all of
6806 the rest of the variables here will have no effect. Turning threading
6807 off will speed group selection up a bit, but it is sure to make reading
6808 slower and more awkward.
6810 @item gnus-thread-hide-subtree
6811 @vindex gnus-thread-hide-subtree
6812 If non-@code{nil}, all threads will be hidden when the summary buffer is
6815 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6816 Available predicates are @code{gnus-article-unread-p} and
6817 @code{gnus-article-unseen-p}.
6822 (setq gnus-thread-hide-subtree
6823 '(or gnus-article-unread-p
6824 gnus-article-unseen-p))
6827 (It's a pretty nonsensical example, since all unseen articles are also
6828 unread, but you get my drift.)
6831 @item gnus-thread-expunge-below
6832 @vindex gnus-thread-expunge-below
6833 All threads that have a total score (as defined by
6834 @code{gnus-thread-score-function}) less than this number will be
6835 expunged. This variable is @code{nil} by default, which means that no
6836 threads are expunged.
6838 @item gnus-thread-hide-killed
6839 @vindex gnus-thread-hide-killed
6840 if you kill a thread and this variable is non-@code{nil}, the subtree
6843 @item gnus-thread-ignore-subject
6844 @vindex gnus-thread-ignore-subject
6845 Sometimes somebody changes the subject in the middle of a thread. If
6846 this variable is non-@code{nil}, which is the default, the subject
6847 change is ignored. If it is @code{nil}, a change in the subject will
6848 result in a new thread.
6850 @item gnus-thread-indent-level
6851 @vindex gnus-thread-indent-level
6852 This is a number that says how much each sub-thread should be indented.
6855 @item gnus-sort-gathered-threads-function
6856 @vindex gnus-sort-gathered-threads-function
6857 Sometimes, particularly with mailing lists, the order in which mails
6858 arrive locally is not necessarily the same as the order in which they
6859 arrived on the mailing list. Consequently, when sorting sub-threads
6860 using the default @code{gnus-thread-sort-by-number}, responses can end
6861 up appearing before the article to which they are responding to.
6862 Setting this variable to an alternate value
6863 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6864 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6865 more logical sub-thread ordering in such instances.
6870 @node Low-Level Threading
6871 @subsubsection Low-Level Threading
6875 @item gnus-parse-headers-hook
6876 @vindex gnus-parse-headers-hook
6877 Hook run before parsing any headers. The default value is
6878 @code{(gnus-set-summary-default-charset)}, which sets up local value of
6879 @code{default-mime-charset} in summary buffer based on variable
6880 @code{gnus-newsgroup-default-charset-alist}.
6882 @item gnus-alter-header-function
6883 @vindex gnus-alter-header-function
6884 If non-@code{nil}, this function will be called to allow alteration of
6885 article header structures. The function is called with one parameter,
6886 the article header vector, which it may alter in any way. For instance,
6887 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6888 in systematic ways (by adding prefixes and such), you can use this
6889 variable to un-scramble the @code{Message-ID}s so that they are more
6890 meaningful. Here's one example:
6893 (setq gnus-alter-header-function 'my-alter-message-id)
6895 (defun my-alter-message-id (header)
6896 (let ((id (mail-header-id header)))
6898 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6900 (concat (match-string 1 id) "@@" (match-string 2 id))
6907 @node Thread Commands
6908 @subsection Thread Commands
6909 @cindex thread commands
6915 @kindex T k (Summary)
6916 @kindex C-M-k (Summary)
6917 @findex gnus-summary-kill-thread
6918 Mark all articles in the current (sub-)thread as read
6919 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
6920 remove all marks instead. If the prefix argument is negative, tick
6925 @kindex T l (Summary)
6926 @kindex C-M-l (Summary)
6927 @findex gnus-summary-lower-thread
6928 Lower the score of the current (sub-)thread
6929 (@code{gnus-summary-lower-thread}).
6932 @kindex T i (Summary)
6933 @findex gnus-summary-raise-thread
6934 Increase the score of the current (sub-)thread
6935 (@code{gnus-summary-raise-thread}).
6938 @kindex T # (Summary)
6939 @findex gnus-uu-mark-thread
6940 Set the process mark on the current (sub-)thread
6941 (@code{gnus-uu-mark-thread}).
6944 @kindex T M-# (Summary)
6945 @findex gnus-uu-unmark-thread
6946 Remove the process mark from the current (sub-)thread
6947 (@code{gnus-uu-unmark-thread}).
6950 @kindex T T (Summary)
6951 @findex gnus-summary-toggle-threads
6952 Toggle threading (@code{gnus-summary-toggle-threads}).
6955 @kindex T s (Summary)
6956 @findex gnus-summary-show-thread
6957 Expose the (sub-)thread hidden under the current article, if any@*
6958 (@code{gnus-summary-show-thread}).
6961 @kindex T h (Summary)
6962 @findex gnus-summary-hide-thread
6963 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6966 @kindex T S (Summary)
6967 @findex gnus-summary-show-all-threads
6968 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6971 @kindex T H (Summary)
6972 @findex gnus-summary-hide-all-threads
6973 Hide all threads (@code{gnus-summary-hide-all-threads}).
6976 @kindex T t (Summary)
6977 @findex gnus-summary-rethread-current
6978 Re-thread the current article's thread
6979 (@code{gnus-summary-rethread-current}). This works even when the
6980 summary buffer is otherwise unthreaded.
6983 @kindex T ^ (Summary)
6984 @findex gnus-summary-reparent-thread
6985 Make the current article the child of the marked (or previous) article
6986 (@code{gnus-summary-reparent-thread}).
6990 The following commands are thread movement commands. They all
6991 understand the numeric prefix.
6996 @kindex T n (Summary)
6998 @kindex C-M-n (Summary)
7000 @kindex M-down (Summary)
7001 @findex gnus-summary-next-thread
7002 Go to the next thread (@code{gnus-summary-next-thread}).
7005 @kindex T p (Summary)
7007 @kindex C-M-p (Summary)
7009 @kindex M-up (Summary)
7010 @findex gnus-summary-prev-thread
7011 Go to the previous thread (@code{gnus-summary-prev-thread}).
7014 @kindex T d (Summary)
7015 @findex gnus-summary-down-thread
7016 Descend the thread (@code{gnus-summary-down-thread}).
7019 @kindex T u (Summary)
7020 @findex gnus-summary-up-thread
7021 Ascend the thread (@code{gnus-summary-up-thread}).
7024 @kindex T o (Summary)
7025 @findex gnus-summary-top-thread
7026 Go to the top of the thread (@code{gnus-summary-top-thread}).
7029 @vindex gnus-thread-operation-ignore-subject
7030 If you ignore subject while threading, you'll naturally end up with
7031 threads that have several different subjects in them. If you then issue
7032 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
7033 wish to kill the entire thread, but just those parts of the thread that
7034 have the same subject as the current article. If you like this idea,
7035 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
7036 is non-@code{nil} (which it is by default), subjects will be ignored
7037 when doing thread commands. If this variable is @code{nil}, articles in
7038 the same thread with different subjects will not be included in the
7039 operation in question. If this variable is @code{fuzzy}, only articles
7040 that have subjects fuzzily equal will be included (@pxref{Fuzzy
7044 @node Sorting the Summary Buffer
7045 @section Sorting the Summary Buffer
7047 @findex gnus-thread-sort-by-total-score
7048 @findex gnus-thread-sort-by-date
7049 @findex gnus-thread-sort-by-date-reverse
7050 @findex gnus-thread-sort-by-score
7051 @findex gnus-thread-sort-by-subject
7052 @findex gnus-thread-sort-by-author
7053 @findex gnus-thread-sort-by-recipient
7054 @findex gnus-thread-sort-by-number
7055 @findex gnus-thread-sort-by-random
7056 @vindex gnus-thread-sort-functions
7057 @findex gnus-thread-sort-by-most-recent-number
7058 @findex gnus-thread-sort-by-most-recent-date
7059 If you are using a threaded summary display, you can sort the threads by
7060 setting @code{gnus-thread-sort-functions}, which can be either a single
7061 function, a list of functions, or a list containing functions and
7062 @code{(not some-function)} elements.
7064 By default, sorting is done on article numbers. Ready-made sorting
7065 predicate functions include @code{gnus-thread-sort-by-number},
7066 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-recipient},
7067 @code{gnus-thread-sort-by-subject},
7068 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-date-reverse},
7069 @code{gnus-thread-sort-by-score},
7070 @code{gnus-thread-sort-by-most-recent-number},
7071 @code{gnus-thread-sort-by-most-recent-date},
7072 @code{gnus-thread-sort-by-random} and
7073 @code{gnus-thread-sort-by-total-score}.
7075 Each function takes two threads and returns non-@code{nil} if the first
7076 thread should be sorted before the other. Note that sorting really is
7077 normally done by looking only at the roots of each thread.
7079 If you use more than one function, the primary sort key should be the
7080 last function in the list. You should probably always include
7081 @code{gnus-thread-sort-by-number} in the list of sorting
7082 functions---preferably first. This will ensure that threads that are
7083 equal with respect to the other sort criteria will be displayed in
7084 ascending article order.
7086 If you would like to sort by reverse score, then by subject, and finally
7087 by number, you could do something like:
7090 (setq gnus-thread-sort-functions
7091 '(gnus-thread-sort-by-number
7092 gnus-thread-sort-by-subject
7093 (not gnus-thread-sort-by-total-score)))
7096 The threads that have highest score will be displayed first in the
7097 summary buffer. When threads have the same score, they will be sorted
7098 alphabetically. The threads that have the same score and the same
7099 subject will be sorted by number, which is (normally) the sequence in
7100 which the articles arrived.
7102 If you want to sort by score and then reverse arrival order, you could
7106 (setq gnus-thread-sort-functions
7107 '((not gnus-thread-sort-by-number)
7108 gnus-thread-sort-by-score))
7111 @vindex gnus-thread-score-function
7112 The function in the @code{gnus-thread-score-function} variable (default
7113 @code{+}) is used for calculating the total score of a thread. Useful
7114 functions might be @code{max}, @code{min}, or squared means, or whatever
7117 @findex gnus-article-sort-functions
7118 @findex gnus-article-sort-by-date
7119 @findex gnus-article-sort-by-score
7120 @findex gnus-article-sort-by-subject
7121 @findex gnus-article-sort-by-author
7122 @findex gnus-article-sort-by-random
7123 @findex gnus-article-sort-by-number
7124 If you are using an unthreaded display for some strange reason or
7125 other, you have to fiddle with the @code{gnus-article-sort-functions}
7126 variable. It is very similar to the
7127 @code{gnus-thread-sort-functions}, except that it uses slightly
7128 different functions for article comparison. Available sorting
7129 predicate functions are @code{gnus-article-sort-by-number},
7130 @code{gnus-article-sort-by-author},
7131 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7132 @code{gnus-article-sort-by-random}, and
7133 @code{gnus-article-sort-by-score}.
7135 If you want to sort an unthreaded summary display by subject, you could
7139 (setq gnus-article-sort-functions
7140 '(gnus-article-sort-by-number
7141 gnus-article-sort-by-subject))
7144 You can define group specific sorting via @code{gnus-parameters},
7145 @xref{Group Parameters}.
7148 @node Asynchronous Fetching
7149 @section Asynchronous Article Fetching
7150 @cindex asynchronous article fetching
7151 @cindex article pre-fetch
7154 If you read your news from an @acronym{NNTP} server that's far away, the
7155 network latencies may make reading articles a chore. You have to wait
7156 for a while after pressing @kbd{n} to go to the next article before the
7157 article appears. Why can't gnus just go ahead and fetch the article
7158 while you are reading the previous one? Why not, indeed.
7160 First, some caveats. There are some pitfalls to using asynchronous
7161 article fetching, especially the way gnus does it.
7163 Let's say you are reading article 1, which is short, and article 2 is
7164 quite long, and you are not interested in reading that. Gnus does not
7165 know this, so it goes ahead and fetches article 2. You decide to read
7166 article 3, but since gnus is in the process of fetching article 2, the
7167 connection is blocked.
7169 To avoid these situations, gnus will open two (count 'em two)
7170 connections to the server. Some people may think this isn't a very nice
7171 thing to do, but I don't see any real alternatives. Setting up that
7172 extra connection takes some time, so gnus startup will be slower.
7174 Gnus will fetch more articles than you will read. This will mean that
7175 the link between your machine and the @acronym{NNTP} server will become more
7176 loaded than if you didn't use article pre-fetch. The server itself will
7177 also become more loaded---both with the extra article requests, and the
7180 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7183 @vindex gnus-asynchronous
7184 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7185 happen automatically.
7187 @vindex gnus-use-article-prefetch
7188 You can control how many articles are to be pre-fetched by setting
7189 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7190 that when you read an article in the group, the back end will pre-fetch
7191 the next 30 articles. If this variable is @code{t}, the back end will
7192 pre-fetch all the articles it can without bound. If it is
7193 @code{nil}, no pre-fetching will be done.
7195 @vindex gnus-async-prefetch-article-p
7196 @findex gnus-async-read-p
7197 There are probably some articles that you don't want to pre-fetch---read
7198 articles, for instance. The @code{gnus-async-prefetch-article-p}
7199 variable controls whether an article is to be pre-fetched. This
7200 function should return non-@code{nil} when the article in question is
7201 to be pre-fetched. The default is @code{gnus-async-read-p}, which
7202 returns @code{nil} on read articles. The function is called with an
7203 article data structure as the only parameter.
7205 If, for instance, you wish to pre-fetch only unread articles shorter
7206 than 100 lines, you could say something like:
7209 (defun my-async-short-unread-p (data)
7210 "Return non-nil for short, unread articles."
7211 (and (gnus-data-unread-p data)
7212 (< (mail-header-lines (gnus-data-header data))
7215 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7218 These functions will be called many, many times, so they should
7219 preferably be short and sweet to avoid slowing down gnus too much.
7220 It's probably a good idea to byte-compile things like this.
7222 @vindex gnus-prefetched-article-deletion-strategy
7223 Articles have to be removed from the asynch buffer sooner or later. The
7224 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7225 articles. This is a list that may contain the following elements:
7229 Remove articles when they are read.
7232 Remove articles when exiting the group.
7235 The default value is @code{(read exit)}.
7237 @c @vindex gnus-use-header-prefetch
7238 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7239 @c from the next group.
7242 @node Article Caching
7243 @section Article Caching
7244 @cindex article caching
7247 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7248 consider turning article caching on. Each article will then be stored
7249 locally under your home directory. As you may surmise, this could
7250 potentially use @emph{huge} amounts of disk space, as well as eat up all
7251 your inodes so fast it will make your head swim. In vodka.
7253 Used carefully, though, it could be just an easier way to save articles.
7255 @vindex gnus-use-long-file-name
7256 @vindex gnus-cache-directory
7257 @vindex gnus-use-cache
7258 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7259 all articles ticked or marked as dormant will then be copied
7260 over to your local cache (@code{gnus-cache-directory}). Whether this
7261 cache is flat or hierarchical is controlled by the
7262 @code{gnus-use-long-file-name} variable, as usual.
7264 When re-selecting a ticked or dormant article, it will be fetched from the
7265 cache instead of from the server. As articles in your cache will never
7266 expire, this might serve as a method of saving articles while still
7267 keeping them where they belong. Just mark all articles you want to save
7268 as dormant, and don't worry.
7270 When an article is marked as read, is it removed from the cache.
7272 @vindex gnus-cache-remove-articles
7273 @vindex gnus-cache-enter-articles
7274 The entering/removal of articles from the cache is controlled by the
7275 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7276 variables. Both are lists of symbols. The first is @code{(ticked
7277 dormant)} by default, meaning that ticked and dormant articles will be
7278 put in the cache. The latter is @code{(read)} by default, meaning that
7279 articles marked as read are removed from the cache. Possibly
7280 symbols in these two lists are @code{ticked}, @code{dormant},
7281 @code{unread} and @code{read}.
7283 @findex gnus-jog-cache
7284 So where does the massive article-fetching and storing come into the
7285 picture? The @code{gnus-jog-cache} command will go through all
7286 subscribed newsgroups, request all unread articles, score them, and
7287 store them in the cache. You should only ever, ever ever ever, use this
7288 command if 1) your connection to the @acronym{NNTP} server is really, really,
7289 really slow and 2) you have a really, really, really huge disk.
7290 Seriously. One way to cut down on the number of articles downloaded is
7291 to score unwanted articles down and have them marked as read. They will
7292 not then be downloaded by this command.
7294 @vindex gnus-uncacheable-groups
7295 @vindex gnus-cacheable-groups
7296 It is likely that you do not want caching on all groups. For instance,
7297 if your @code{nnml} mail is located under your home directory, it makes no
7298 sense to cache it somewhere else under your home directory. Unless you
7299 feel that it's neat to use twice as much space.
7301 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7302 regexp of groups to cache, @samp{^nntp} for instance, or set the
7303 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7304 Both variables are @code{nil} by default. If a group matches both
7305 variables, the group is not cached.
7307 @findex gnus-cache-generate-nov-databases
7308 @findex gnus-cache-generate-active
7309 @vindex gnus-cache-active-file
7310 The cache stores information on what articles it contains in its active
7311 file (@code{gnus-cache-active-file}). If this file (or any other parts
7312 of the cache) becomes all messed up for some reason or other, gnus
7313 offers two functions that will try to set things right. @kbd{M-x
7314 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7315 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7318 @findex gnus-cache-move-cache
7319 @code{gnus-cache-move-cache} will move your whole
7320 @code{gnus-cache-directory} to some other location. You get asked to
7321 where, isn't that cool?
7323 @node Persistent Articles
7324 @section Persistent Articles
7325 @cindex persistent articles
7327 Closely related to article caching, we have @dfn{persistent articles}.
7328 In fact, it's just a different way of looking at caching, and much more
7329 useful in my opinion.
7331 Say you're reading a newsgroup, and you happen on to some valuable gem
7332 that you want to keep and treasure forever. You'd normally just save it
7333 (using one of the many saving commands) in some file. The problem with
7334 that is that it's just, well, yucky. Ideally you'd prefer just having
7335 the article remain in the group where you found it forever; untouched by
7336 the expiry going on at the news server.
7338 This is what a @dfn{persistent article} is---an article that just won't
7339 be deleted. It's implemented using the normal cache functions, but
7340 you use two explicit commands for managing persistent articles:
7346 @findex gnus-cache-enter-article
7347 Make the current article persistent (@code{gnus-cache-enter-article}).
7350 @kindex M-* (Summary)
7351 @findex gnus-cache-remove-article
7352 Remove the current article from the persistent articles
7353 (@code{gnus-cache-remove-article}). This will normally delete the
7357 Both these commands understand the process/prefix convention.
7359 To avoid having all ticked articles (and stuff) entered into the cache,
7360 you should set @code{gnus-use-cache} to @code{passive} if you're just
7361 interested in persistent articles:
7364 (setq gnus-use-cache 'passive)
7368 @node Article Backlog
7369 @section Article Backlog
7371 @cindex article backlog
7373 If you have a slow connection, but the idea of using caching seems
7374 unappealing to you (and it is, really), you can help the situation some
7375 by switching on the @dfn{backlog}. This is where gnus will buffer
7376 already read articles so that it doesn't have to re-fetch articles
7377 you've already read. This only helps if you are in the habit of
7378 re-selecting articles you've recently read, of course. If you never do
7379 that, turning the backlog on will slow gnus down a little bit, and
7380 increase memory usage some.
7382 @vindex gnus-keep-backlog
7383 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
7384 at most @var{n} old articles in a buffer for later re-fetching. If this
7385 variable is non-@code{nil} and is not a number, gnus will store
7386 @emph{all} read articles, which means that your Emacs will grow without
7387 bound before exploding and taking your machine down with you. I put
7388 that in there just to keep y'all on your toes.
7390 The default value is 20.
7393 @node Saving Articles
7394 @section Saving Articles
7395 @cindex saving articles
7397 Gnus can save articles in a number of ways. Below is the documentation
7398 for saving articles in a fairly straight-forward fashion (i.e., little
7399 processing of the article is done before it is saved). For a different
7400 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7401 (@pxref{Decoding Articles}).
7403 For the commands listed here, the target is a file. If you want to
7404 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7405 command (@pxref{Mail Group Commands}).
7407 @vindex gnus-save-all-headers
7408 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
7409 unwanted headers before saving the article.
7411 @vindex gnus-saved-headers
7412 If the preceding variable is @code{nil}, all headers that match the
7413 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7414 deleted before saving.
7420 @kindex O o (Summary)
7422 @findex gnus-summary-save-article
7423 @c @icon{gnus-summary-save-article}
7424 Save the current article using the default article saver
7425 (@code{gnus-summary-save-article}).
7428 @kindex O m (Summary)
7429 @findex gnus-summary-save-article-mail
7430 Save the current article in mail format
7431 (@code{gnus-summary-save-article-mail}).
7434 @kindex O r (Summary)
7435 @findex gnus-summary-save-article-rmail
7436 Save the current article in Rmail format
7437 (@code{gnus-summary-save-article-rmail}).
7440 @kindex O f (Summary)
7441 @findex gnus-summary-save-article-file
7442 @c @icon{gnus-summary-save-article-file}
7443 Save the current article in plain file format
7444 (@code{gnus-summary-save-article-file}).
7447 @kindex O F (Summary)
7448 @findex gnus-summary-write-article-file
7449 Write the current article in plain file format, overwriting any previous
7450 file contents (@code{gnus-summary-write-article-file}).
7453 @kindex O b (Summary)
7454 @findex gnus-summary-save-article-body-file
7455 Save the current article body in plain file format
7456 (@code{gnus-summary-save-article-body-file}).
7459 @kindex O h (Summary)
7460 @findex gnus-summary-save-article-folder
7461 Save the current article in mh folder format
7462 (@code{gnus-summary-save-article-folder}).
7465 @kindex O v (Summary)
7466 @findex gnus-summary-save-article-vm
7467 Save the current article in a VM folder
7468 (@code{gnus-summary-save-article-vm}).
7472 @kindex O p (Summary)
7474 @findex gnus-summary-pipe-output
7475 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7476 the current article to a process (@code{gnus-summary-pipe-output}).
7477 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7478 complete headers in the piped output.
7481 @kindex O P (Summary)
7482 @findex gnus-summary-muttprint
7483 @vindex gnus-summary-muttprint-program
7484 Save the current article into muttprint. That is, print it using the
7485 external program @uref{http://muttprint.sourceforge.net/,
7486 Muttprint}. The program name and options to use is controlled by the
7487 variable @code{gnus-summary-muttprint-program}.
7488 (@code{gnus-summary-muttprint}).
7492 @vindex gnus-prompt-before-saving
7493 All these commands use the process/prefix convention
7494 (@pxref{Process/Prefix}). If you save bunches of articles using these
7495 functions, you might get tired of being prompted for files to save each
7496 and every article in. The prompting action is controlled by
7497 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7498 default, giving you that excessive prompting action you know and
7499 loathe. If you set this variable to @code{t} instead, you'll be prompted
7500 just once for each series of articles you save. If you like to really
7501 have Gnus do all your thinking for you, you can even set this variable
7502 to @code{nil}, which means that you will never be prompted for files to
7503 save articles in. Gnus will simply save all the articles in the default
7507 @vindex gnus-default-article-saver
7508 You can customize the @code{gnus-default-article-saver} variable to make
7509 gnus do what you want it to. You can use any of the six ready-made
7510 functions below, or you can create your own.
7514 @item gnus-summary-save-in-rmail
7515 @findex gnus-summary-save-in-rmail
7516 @vindex gnus-rmail-save-name
7517 @findex gnus-plain-save-name
7518 This is the default format, @dfn{Babyl}. Uses the function in the
7519 @code{gnus-rmail-save-name} variable to get a file name to save the
7520 article in. The default is @code{gnus-plain-save-name}.
7522 @item gnus-summary-save-in-mail
7523 @findex gnus-summary-save-in-mail
7524 @vindex gnus-mail-save-name
7525 Save in a Unix mail (mbox) file. Uses the function in the
7526 @code{gnus-mail-save-name} variable to get a file name to save the
7527 article in. The default is @code{gnus-plain-save-name}.
7529 @item gnus-summary-save-in-file
7530 @findex gnus-summary-save-in-file
7531 @vindex gnus-file-save-name
7532 @findex gnus-numeric-save-name
7533 Append the article straight to an ordinary file. Uses the function in
7534 the @code{gnus-file-save-name} variable to get a file name to save the
7535 article in. The default is @code{gnus-numeric-save-name}.
7537 @item gnus-summary-write-to-file
7538 @findex gnus-summary-write-to-file
7539 Write the article straight to an ordinary file. The file is
7540 overwritten if it exists. Uses the function in the
7541 @code{gnus-file-save-name} variable to get a file name to save the
7542 article in. The default is @code{gnus-numeric-save-name}.
7544 @item gnus-summary-save-body-in-file
7545 @findex gnus-summary-save-body-in-file
7546 Append the article body to an ordinary file. Uses the function in the
7547 @code{gnus-file-save-name} variable to get a file name to save the
7548 article in. The default is @code{gnus-numeric-save-name}.
7550 @item gnus-summary-save-in-folder
7551 @findex gnus-summary-save-in-folder
7552 @findex gnus-folder-save-name
7553 @findex gnus-Folder-save-name
7554 @vindex gnus-folder-save-name
7557 Save the article to an MH folder using @code{rcvstore} from the MH
7558 library. Uses the function in the @code{gnus-folder-save-name} variable
7559 to get a file name to save the article in. The default is
7560 @code{gnus-folder-save-name}, but you can also use
7561 @code{gnus-Folder-save-name}, which creates capitalized names.
7563 @item gnus-summary-save-in-vm
7564 @findex gnus-summary-save-in-vm
7565 Save the article in a VM folder. You have to have the VM mail
7566 reader to use this setting.
7569 @vindex gnus-article-save-directory
7570 All of these functions, except for the last one, will save the article
7571 in the @code{gnus-article-save-directory}, which is initialized from the
7572 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7575 As you can see above, the functions use different functions to find a
7576 suitable name of a file to save the article in. Below is a list of
7577 available functions that generate names:
7581 @item gnus-Numeric-save-name
7582 @findex gnus-Numeric-save-name
7583 File names like @file{~/News/Alt.andrea-dworkin/45}.
7585 @item gnus-numeric-save-name
7586 @findex gnus-numeric-save-name
7587 File names like @file{~/News/alt.andrea-dworkin/45}.
7589 @item gnus-Plain-save-name
7590 @findex gnus-Plain-save-name
7591 File names like @file{~/News/Alt.andrea-dworkin}.
7593 @item gnus-plain-save-name
7594 @findex gnus-plain-save-name
7595 File names like @file{~/News/alt.andrea-dworkin}.
7597 @item gnus-sender-save-name
7598 @findex gnus-sender-save-name
7599 File names like @file{~/News/larsi}.
7602 @vindex gnus-split-methods
7603 You can have gnus suggest where to save articles by plonking a regexp into
7604 the @code{gnus-split-methods} alist. For instance, if you would like to
7605 save articles related to gnus in the file @file{gnus-stuff}, and articles
7606 related to VM in @file{vm-stuff}, you could set this variable to something
7610 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7611 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7612 (my-choosing-function "../other-dir/my-stuff")
7613 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7616 We see that this is a list where each element is a list that has two
7617 elements---the @dfn{match} and the @dfn{file}. The match can either be
7618 a string (in which case it is used as a regexp to match on the article
7619 head); it can be a symbol (which will be called as a function with the
7620 group name as a parameter); or it can be a list (which will be
7621 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7622 the @dfn{file} will be used as a default prompt. In addition, the
7623 result of the operation itself will be used if the function or form
7624 called returns a string or a list of strings.
7626 You basically end up with a list of file names that might be used when
7627 saving the current article. (All ``matches'' will be used.) You will
7628 then be prompted for what you really want to use as a name, with file
7629 name completion over the results from applying this variable.
7631 This variable is @code{((gnus-article-archive-name))} by default, which
7632 means that gnus will look at the articles it saves for an
7633 @code{Archive-name} line and use that as a suggestion for the file
7636 Here's an example function to clean up file names somewhat. If you have
7637 lots of mail groups called things like
7638 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7639 these group names before creating the file name to save to. The
7640 following will do just that:
7643 (defun my-save-name (group)
7644 (when (string-match "^nnml:mail." group)
7645 (substring group (match-end 0))))
7647 (setq gnus-split-methods
7648 '((gnus-article-archive-name)
7653 @vindex gnus-use-long-file-name
7654 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7655 @code{nil}, all the preceding functions will replace all periods
7656 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7657 the functions will generate hierarchies of directories instead of having
7658 all the files in the top level directory
7659 (@file{~/News/alt/andrea-dworkin} instead of
7660 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7661 on most systems. However, for historical reasons, this is @code{nil} on
7662 Xenix and usg-unix-v machines by default.
7664 This function also affects kill and score file names. If this variable
7665 is a list, and the list contains the element @code{not-score}, long file
7666 names will not be used for score files, if it contains the element
7667 @code{not-save}, long file names will not be used for saving, and if it
7668 contains the element @code{not-kill}, long file names will not be used
7671 If you'd like to save articles in a hierarchy that looks something like
7675 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
7676 (setq gnus-default-article-saver
7677 'gnus-summary-save-in-file) ; @r{no encoding}
7680 Then just save with @kbd{o}. You'd then read this hierarchy with
7681 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7682 the top level directory as the argument (@file{~/News/}). Then just walk
7683 around to the groups/directories with @code{nneething}.
7686 @node Decoding Articles
7687 @section Decoding Articles
7688 @cindex decoding articles
7690 Sometime users post articles (or series of articles) that have been
7691 encoded in some way or other. Gnus can decode them for you.
7694 * Uuencoded Articles:: Uudecode articles.
7695 * Shell Archives:: Unshar articles.
7696 * PostScript Files:: Split PostScript.
7697 * Other Files:: Plain save and binhex.
7698 * Decoding Variables:: Variables for a happy decoding.
7699 * Viewing Files:: You want to look at the result of the decoding?
7703 @cindex article series
7704 All these functions use the process/prefix convention
7705 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7706 the extension that a ``single article'' means ``a single series''. Gnus
7707 can find out by itself what articles belong to a series, decode all the
7708 articles and unpack/view/save the resulting file(s).
7710 Gnus guesses what articles are in the series according to the following
7711 simplish rule: The subjects must be (nearly) identical, except for the
7712 last two numbers of the line. (Spaces are largely ignored, however.)
7714 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
7715 will find all the articles that match the regexp @samp{^cat.gif
7716 ([0-9]+/[0-9]+).*$}.
7718 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7719 series}, will not be properly recognized by any of the automatic viewing
7720 commands, and you have to mark the articles manually with @kbd{#}.
7723 @node Uuencoded Articles
7724 @subsection Uuencoded Articles
7726 @cindex uuencoded articles
7731 @kindex X u (Summary)
7732 @findex gnus-uu-decode-uu
7733 @c @icon{gnus-uu-decode-uu}
7734 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7737 @kindex X U (Summary)
7738 @findex gnus-uu-decode-uu-and-save
7739 Uudecodes and saves the current series
7740 (@code{gnus-uu-decode-uu-and-save}).
7743 @kindex X v u (Summary)
7744 @findex gnus-uu-decode-uu-view
7745 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7748 @kindex X v U (Summary)
7749 @findex gnus-uu-decode-uu-and-save-view
7750 Uudecodes, views and saves the current series
7751 (@code{gnus-uu-decode-uu-and-save-view}).
7755 Remember that these all react to the presence of articles marked with
7756 the process mark. If, for instance, you'd like to decode and save an
7757 entire newsgroup, you'd typically do @kbd{M P a}
7758 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7759 (@code{gnus-uu-decode-uu-and-save}).
7761 All this is very much different from how @code{gnus-uu} worked with
7762 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7763 the sun. This version of @code{gnus-uu} generally assumes that you mark
7764 articles in some way (@pxref{Setting Process Marks}) and then press
7767 @vindex gnus-uu-notify-files
7768 Note: When trying to decode articles that have names matching
7769 @code{gnus-uu-notify-files}, which is hard-coded to
7770 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7771 automatically post an article on @samp{comp.unix.wizards} saying that
7772 you have just viewed the file in question. This feature can't be turned
7776 @node Shell Archives
7777 @subsection Shell Archives
7779 @cindex shell archives
7780 @cindex shared articles
7782 Shell archives (``shar files'') used to be a popular way to distribute
7783 sources, but it isn't used all that much today. In any case, we have
7784 some commands to deal with these:
7789 @kindex X s (Summary)
7790 @findex gnus-uu-decode-unshar
7791 Unshars the current series (@code{gnus-uu-decode-unshar}).
7794 @kindex X S (Summary)
7795 @findex gnus-uu-decode-unshar-and-save
7796 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7799 @kindex X v s (Summary)
7800 @findex gnus-uu-decode-unshar-view
7801 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7804 @kindex X v S (Summary)
7805 @findex gnus-uu-decode-unshar-and-save-view
7806 Unshars, views and saves the current series
7807 (@code{gnus-uu-decode-unshar-and-save-view}).
7811 @node PostScript Files
7812 @subsection PostScript Files
7818 @kindex X p (Summary)
7819 @findex gnus-uu-decode-postscript
7820 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7823 @kindex X P (Summary)
7824 @findex gnus-uu-decode-postscript-and-save
7825 Unpack and save the current PostScript series
7826 (@code{gnus-uu-decode-postscript-and-save}).
7829 @kindex X v p (Summary)
7830 @findex gnus-uu-decode-postscript-view
7831 View the current PostScript series
7832 (@code{gnus-uu-decode-postscript-view}).
7835 @kindex X v P (Summary)
7836 @findex gnus-uu-decode-postscript-and-save-view
7837 View and save the current PostScript series
7838 (@code{gnus-uu-decode-postscript-and-save-view}).
7843 @subsection Other Files
7847 @kindex X o (Summary)
7848 @findex gnus-uu-decode-save
7849 Save the current series
7850 (@code{gnus-uu-decode-save}).
7853 @kindex X b (Summary)
7854 @findex gnus-uu-decode-binhex
7855 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7856 doesn't really work yet.
7860 @node Decoding Variables
7861 @subsection Decoding Variables
7863 Adjective, not verb.
7866 * Rule Variables:: Variables that say how a file is to be viewed.
7867 * Other Decode Variables:: Other decode variables.
7868 * Uuencoding and Posting:: Variables for customizing uuencoding.
7872 @node Rule Variables
7873 @subsubsection Rule Variables
7874 @cindex rule variables
7876 Gnus uses @dfn{rule variables} to decide how to view a file. All these
7877 variables are of the form
7880 (list '(regexp1 command2)
7887 @item gnus-uu-user-view-rules
7888 @vindex gnus-uu-user-view-rules
7890 This variable is consulted first when viewing files. If you wish to use,
7891 for instance, @code{sox} to convert an @file{.au} sound file, you could
7894 (setq gnus-uu-user-view-rules
7895 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7898 @item gnus-uu-user-view-rules-end
7899 @vindex gnus-uu-user-view-rules-end
7900 This variable is consulted if gnus couldn't make any matches from the
7901 user and default view rules.
7903 @item gnus-uu-user-archive-rules
7904 @vindex gnus-uu-user-archive-rules
7905 This variable can be used to say what commands should be used to unpack
7910 @node Other Decode Variables
7911 @subsubsection Other Decode Variables
7914 @vindex gnus-uu-grabbed-file-functions
7916 @item gnus-uu-grabbed-file-functions
7917 All functions in this list will be called right after each file has been
7918 successfully decoded---so that you can move or view files right away,
7919 and don't have to wait for all files to be decoded before you can do
7920 anything. Ready-made functions you can put in this list are:
7924 @item gnus-uu-grab-view
7925 @findex gnus-uu-grab-view
7928 @item gnus-uu-grab-move
7929 @findex gnus-uu-grab-move
7930 Move the file (if you're using a saving function.)
7933 @item gnus-uu-be-dangerous
7934 @vindex gnus-uu-be-dangerous
7935 Specifies what to do if unusual situations arise during decoding. If
7936 @code{nil}, be as conservative as possible. If @code{t}, ignore things
7937 that didn't work, and overwrite existing files. Otherwise, ask each
7940 @item gnus-uu-ignore-files-by-name
7941 @vindex gnus-uu-ignore-files-by-name
7942 Files with name matching this regular expression won't be viewed.
7944 @item gnus-uu-ignore-files-by-type
7945 @vindex gnus-uu-ignore-files-by-type
7946 Files with a @acronym{MIME} type matching this variable won't be viewed.
7947 Note that Gnus tries to guess what type the file is based on the name.
7948 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
7951 @item gnus-uu-tmp-dir
7952 @vindex gnus-uu-tmp-dir
7953 Where @code{gnus-uu} does its work.
7955 @item gnus-uu-do-not-unpack-archives
7956 @vindex gnus-uu-do-not-unpack-archives
7957 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7958 looking for files to display.
7960 @item gnus-uu-view-and-save
7961 @vindex gnus-uu-view-and-save
7962 Non-@code{nil} means that the user will always be asked to save a file
7965 @item gnus-uu-ignore-default-view-rules
7966 @vindex gnus-uu-ignore-default-view-rules
7967 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7970 @item gnus-uu-ignore-default-archive-rules
7971 @vindex gnus-uu-ignore-default-archive-rules
7972 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7975 @item gnus-uu-kill-carriage-return
7976 @vindex gnus-uu-kill-carriage-return
7977 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7980 @item gnus-uu-unmark-articles-not-decoded
7981 @vindex gnus-uu-unmark-articles-not-decoded
7982 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7983 decoded articles as unread.
7985 @item gnus-uu-correct-stripped-uucode
7986 @vindex gnus-uu-correct-stripped-uucode
7987 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7988 uuencoded files that have had trailing spaces deleted.
7990 @item gnus-uu-pre-uudecode-hook
7991 @vindex gnus-uu-pre-uudecode-hook
7992 Hook run before sending a message to @code{uudecode}.
7994 @item gnus-uu-view-with-metamail
7995 @vindex gnus-uu-view-with-metamail
7997 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7998 commands defined by the rule variables and just fudge a @acronym{MIME}
7999 content type based on the file name. The result will be fed to
8000 @code{metamail} for viewing.
8002 @item gnus-uu-save-in-digest
8003 @vindex gnus-uu-save-in-digest
8004 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
8005 decoding, will save in digests. If this variable is @code{nil},
8006 @code{gnus-uu} will just save everything in a file without any
8007 embellishments. The digesting almost conforms to RFC 1153---no easy way
8008 to specify any meaningful volume and issue numbers were found, so I
8009 simply dropped them.
8014 @node Uuencoding and Posting
8015 @subsubsection Uuencoding and Posting
8019 @item gnus-uu-post-include-before-composing
8020 @vindex gnus-uu-post-include-before-composing
8021 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
8022 before you compose the article. If this variable is @code{t}, you can
8023 either include an encoded file with @kbd{C-c C-i} or have one included
8024 for you when you post the article.
8026 @item gnus-uu-post-length
8027 @vindex gnus-uu-post-length
8028 Maximum length of an article. The encoded file will be split into how
8029 many articles it takes to post the entire file.
8031 @item gnus-uu-post-threaded
8032 @vindex gnus-uu-post-threaded
8033 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
8034 thread. This may not be smart, as no other decoder I have seen is able
8035 to follow threads when collecting uuencoded articles. (Well, I have
8036 seen one package that does that---@code{gnus-uu}, but somehow, I don't
8037 think that counts@dots{}) Default is @code{nil}.
8039 @item gnus-uu-post-separate-description
8040 @vindex gnus-uu-post-separate-description
8041 Non-@code{nil} means that the description will be posted in a separate
8042 article. The first article will typically be numbered (0/x). If this
8043 variable is @code{nil}, the description the user enters will be included
8044 at the beginning of the first article, which will be numbered (1/x).
8045 Default is @code{t}.
8051 @subsection Viewing Files
8052 @cindex viewing files
8053 @cindex pseudo-articles
8055 After decoding, if the file is some sort of archive, gnus will attempt
8056 to unpack the archive and see if any of the files in the archive can be
8057 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
8058 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
8059 uncompress and de-tar the main file, and then view the two pictures.
8060 This unpacking process is recursive, so if the archive contains archives
8061 of archives, it'll all be unpacked.
8063 Finally, gnus will normally insert a @dfn{pseudo-article} for each
8064 extracted file into the summary buffer. If you go to these
8065 ``articles'', you will be prompted for a command to run (usually Gnus
8066 will make a suggestion), and then the command will be run.
8068 @vindex gnus-view-pseudo-asynchronously
8069 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
8070 until the viewing is done before proceeding.
8072 @vindex gnus-view-pseudos
8073 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8074 the pseudo-articles into the summary buffer, but view them
8075 immediately. If this variable is @code{not-confirm}, the user won't even
8076 be asked for a confirmation before viewing is done.
8078 @vindex gnus-view-pseudos-separately
8079 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8080 pseudo-article will be created for each file to be viewed. If
8081 @code{nil}, all files that use the same viewing command will be given as
8082 a list of parameters to that command.
8084 @vindex gnus-insert-pseudo-articles
8085 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8086 pseudo-articles when decoding. It is @code{t} by default.
8088 So; there you are, reading your @emph{pseudo-articles} in your
8089 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8090 Why isn't anything real anymore? How did we get here?
8093 @node Article Treatment
8094 @section Article Treatment
8096 Reading through this huge manual, you may have quite forgotten that the
8097 object of newsreaders is to actually, like, read what people have
8098 written. Reading articles. Unfortunately, people are quite bad at
8099 writing, so there are tons of functions and variables to make reading
8100 these articles easier.
8103 * Article Highlighting:: You want to make the article look like fruit salad.
8104 * Article Fontisizing:: Making emphasized text look nice.
8105 * Article Hiding:: You also want to make certain info go away.
8106 * Article Washing:: Lots of way-neat functions to make life better.
8107 * Article Header:: Doing various header transformations.
8108 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8109 * Article Button Levels:: Controlling appearance of buttons.
8110 * Article Date:: Grumble, UT!
8111 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8112 * Article Signature:: What is a signature?
8113 * Article Miscellanea:: Various other stuff.
8117 @node Article Highlighting
8118 @subsection Article Highlighting
8119 @cindex highlighting
8121 Not only do you want your article buffer to look like fruit salad, but
8122 you want it to look like technicolor fruit salad.
8127 @kindex W H a (Summary)
8128 @findex gnus-article-highlight
8129 @findex gnus-article-maybe-highlight
8130 Do much highlighting of the current article
8131 (@code{gnus-article-highlight}). This function highlights header, cited
8132 text, the signature, and adds buttons to the body and the head.
8135 @kindex W H h (Summary)
8136 @findex gnus-article-highlight-headers
8137 @vindex gnus-header-face-alist
8138 Highlight the headers (@code{gnus-article-highlight-headers}). The
8139 highlighting will be done according to the @code{gnus-header-face-alist}
8140 variable, which is a list where each element has the form
8141 @code{(@var{regexp} @var{name} @var{content})}.
8142 @var{regexp} is a regular expression for matching the
8143 header, @var{name} is the face used for highlighting the header name
8144 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8145 the header value. The first match made will be used. Note that
8146 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8149 @kindex W H c (Summary)
8150 @findex gnus-article-highlight-citation
8151 Highlight cited text (@code{gnus-article-highlight-citation}).
8153 Some variables to customize the citation highlights:
8156 @vindex gnus-cite-parse-max-size
8158 @item gnus-cite-parse-max-size
8159 If the article size if bigger than this variable (which is 25000 by
8160 default), no citation highlighting will be performed.
8162 @item gnus-cite-max-prefix
8163 @vindex gnus-cite-max-prefix
8164 Maximum possible length for a citation prefix (default 20).
8166 @item gnus-cite-face-list
8167 @vindex gnus-cite-face-list
8168 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8169 When there are citations from multiple articles in the same message,
8170 gnus will try to give each citation from each article its own face.
8171 This should make it easier to see who wrote what.
8173 @item gnus-supercite-regexp
8174 @vindex gnus-supercite-regexp
8175 Regexp matching normal Supercite attribution lines.
8177 @item gnus-supercite-secondary-regexp
8178 @vindex gnus-supercite-secondary-regexp
8179 Regexp matching mangled Supercite attribution lines.
8181 @item gnus-cite-minimum-match-count
8182 @vindex gnus-cite-minimum-match-count
8183 Minimum number of identical prefixes we have to see before we believe
8184 that it's a citation.
8186 @item gnus-cite-attribution-prefix
8187 @vindex gnus-cite-attribution-prefix
8188 Regexp matching the beginning of an attribution line.
8190 @item gnus-cite-attribution-suffix
8191 @vindex gnus-cite-attribution-suffix
8192 Regexp matching the end of an attribution line.
8194 @item gnus-cite-attribution-face
8195 @vindex gnus-cite-attribution-face
8196 Face used for attribution lines. It is merged with the face for the
8197 cited text belonging to the attribution.
8199 @item gnus-cite-ignore-quoted-from
8200 @vindex gnus-cite-ignore-quoted-from
8201 If non-@code{nil}, no citation highlighting will be performed on lines
8202 beginning with @samp{>From }. Those lines may have been quoted by MTAs
8203 in order not to mix up with the envelope From line. The default value
8210 @kindex W H s (Summary)
8211 @vindex gnus-signature-separator
8212 @vindex gnus-signature-face
8213 @findex gnus-article-highlight-signature
8214 Highlight the signature (@code{gnus-article-highlight-signature}).
8215 Everything after @code{gnus-signature-separator} (@pxref{Article
8216 Signature}) in an article will be considered a signature and will be
8217 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8222 @xref{Customizing Articles}, for how to highlight articles automatically.
8225 @node Article Fontisizing
8226 @subsection Article Fontisizing
8228 @cindex article emphasis
8230 @findex gnus-article-emphasize
8231 @kindex W e (Summary)
8232 People commonly add emphasis to words in news articles by writing things
8233 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8234 this look nicer by running the article through the @kbd{W e}
8235 (@code{gnus-article-emphasize}) command.
8237 @vindex gnus-emphasis-alist
8238 How the emphasis is computed is controlled by the
8239 @code{gnus-emphasis-alist} variable. This is an alist where the first
8240 element is a regular expression to be matched. The second is a number
8241 that says what regular expression grouping is used to find the entire
8242 emphasized word. The third is a number that says what regexp grouping
8243 should be displayed and highlighted. (The text between these two
8244 groupings will be hidden.) The fourth is the face used for
8248 (setq gnus-emphasis-alist
8249 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8250 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8259 @vindex gnus-emphasis-underline
8260 @vindex gnus-emphasis-bold
8261 @vindex gnus-emphasis-italic
8262 @vindex gnus-emphasis-underline-bold
8263 @vindex gnus-emphasis-underline-italic
8264 @vindex gnus-emphasis-bold-italic
8265 @vindex gnus-emphasis-underline-bold-italic
8266 By default, there are seven rules, and they use the following faces:
8267 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8268 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8269 @code{gnus-emphasis-underline-italic},
8270 @code{gnus-emphasis-underline-bold}, and
8271 @code{gnus-emphasis-underline-bold-italic}.
8273 If you want to change these faces, you can either use @kbd{M-x
8274 customize}, or you can use @code{copy-face}. For instance, if you want
8275 to make @code{gnus-emphasis-italic} use a red face instead, you could
8279 (copy-face 'red 'gnus-emphasis-italic)
8282 @vindex gnus-group-highlight-words-alist
8284 If you want to highlight arbitrary words, you can use the
8285 @code{gnus-group-highlight-words-alist} variable, which uses the same
8286 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8287 parameter (@pxref{Group Parameters}) can also be used.
8289 @xref{Customizing Articles}, for how to fontize articles automatically.
8292 @node Article Hiding
8293 @subsection Article Hiding
8294 @cindex article hiding
8296 Or rather, hiding certain things in each article. There usually is much
8297 too much cruft in most articles.
8302 @kindex W W a (Summary)
8303 @findex gnus-article-hide
8304 Do quite a lot of hiding on the article buffer
8305 (@kbd{gnus-article-hide}). In particular, this function will hide
8306 headers, @acronym{PGP}, cited text and the signature.
8309 @kindex W W h (Summary)
8310 @findex gnus-article-hide-headers
8311 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8315 @kindex W W b (Summary)
8316 @findex gnus-article-hide-boring-headers
8317 Hide headers that aren't particularly interesting
8318 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8321 @kindex W W s (Summary)
8322 @findex gnus-article-hide-signature
8323 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8327 @kindex W W l (Summary)
8328 @findex gnus-article-hide-list-identifiers
8329 @vindex gnus-list-identifiers
8330 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8331 are strings some mailing list servers add to the beginning of all
8332 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8333 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8334 may not contain @code{\\(..\\)}.
8338 @item gnus-list-identifiers
8339 @vindex gnus-list-identifiers
8340 A regular expression that matches list identifiers to be removed from
8341 subject. This can also be a list of regular expressions.
8346 @kindex W W P (Summary)
8347 @findex gnus-article-hide-pem
8348 Hide @acronym{PEM} (privacy enhanced messages) cruft
8349 (@code{gnus-article-hide-pem}).
8352 @kindex W W B (Summary)
8353 @findex gnus-article-strip-banner
8354 @vindex gnus-article-banner-alist
8355 @vindex gnus-article-address-banner-alist
8358 @cindex stripping advertisements
8359 @cindex advertisements
8360 Strip the banner specified by the @code{banner} group parameter
8361 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8362 annoying banners and/or signatures that some mailing lists and moderated
8363 groups adds to all the messages. The way to use this function is to add
8364 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8365 group you want banners stripped from. The parameter either be a string,
8366 which will be interpreted as a regular expression matching text to be
8367 removed, or the symbol @code{signature}, meaning that the (last)
8368 signature should be removed, or other symbol, meaning that the
8369 corresponding regular expression in @code{gnus-article-banner-alist} is
8372 Regardless of a group, you can hide things like advertisements only when
8373 the sender of an article has a certain mail address specified in
8374 @code{gnus-article-address-banner-alist}.
8378 @item gnus-article-address-banner-alist
8379 @vindex gnus-article-address-banner-alist
8380 Alist of mail addresses and banners. Each element has the form
8381 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8382 matching a mail address in the From header, @var{banner} is one of a
8383 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8384 a regexp and @code{nil}. If @var{address} matches author's mail
8385 address, it will remove things like advertisements. For example, if a
8386 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8387 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8388 sends, you can use the following element to remove them:
8391 ("@@yoo-hoo\\.co\\.jp\\'" .
8392 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8398 @kindex W W c (Summary)
8399 @findex gnus-article-hide-citation
8400 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8401 customizing the hiding:
8405 @item gnus-cited-opened-text-button-line-format
8406 @itemx gnus-cited-closed-text-button-line-format
8407 @vindex gnus-cited-closed-text-button-line-format
8408 @vindex gnus-cited-opened-text-button-line-format
8409 Gnus adds buttons to show where the cited text has been hidden, and to
8410 allow toggle hiding the text. The format of the variable is specified
8411 by these format-like variable (@pxref{Formatting Variables}). These
8416 Starting point of the hidden text.
8418 Ending point of the hidden text.
8420 Number of characters in the hidden region.
8422 Number of lines of hidden text.
8425 @item gnus-cited-lines-visible
8426 @vindex gnus-cited-lines-visible
8427 The number of lines at the beginning of the cited text to leave
8428 shown. This can also be a cons cell with the number of lines at the top
8429 and bottom of the text, respectively, to remain visible.
8434 @kindex W W C-c (Summary)
8435 @findex gnus-article-hide-citation-maybe
8437 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8438 following two variables:
8441 @item gnus-cite-hide-percentage
8442 @vindex gnus-cite-hide-percentage
8443 If the cited text is of a bigger percentage than this variable (default
8444 50), hide the cited text.
8446 @item gnus-cite-hide-absolute
8447 @vindex gnus-cite-hide-absolute
8448 The cited text must have at least this length (default 10) before it
8453 @kindex W W C (Summary)
8454 @findex gnus-article-hide-citation-in-followups
8455 Hide cited text in articles that aren't roots
8456 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8457 useful as an interactive command, but might be a handy function to stick
8458 have happen automatically (@pxref{Customizing Articles}).
8462 All these ``hiding'' commands are toggles, but if you give a negative
8463 prefix to these commands, they will show what they have previously
8464 hidden. If you give a positive prefix, they will always hide.
8466 Also @pxref{Article Highlighting} for further variables for
8467 citation customization.
8469 @xref{Customizing Articles}, for how to hide article elements
8473 @node Article Washing
8474 @subsection Article Washing
8476 @cindex article washing
8478 We call this ``article washing'' for a really good reason. Namely, the
8479 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8481 @dfn{Washing} is defined by us as ``changing something from something to
8482 something else'', but normally results in something looking better.
8485 @xref{Customizing Articles}, if you want to change how Gnus displays
8486 articles by default.
8491 This is not really washing, it's sort of the opposite of washing. If
8492 you type this, you see the article exactly as it exists on disk or on
8496 Force redisplaying of the current article
8497 (@code{gnus-summary-show-article}). This is also not really washing.
8498 If you type this, you see the article without any previously applied
8499 interactive Washing functions but with all default treatments
8500 (@pxref{Customizing Articles}).
8503 @kindex W l (Summary)
8504 @findex gnus-summary-stop-page-breaking
8505 Remove page breaks from the current article
8506 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8510 @kindex W r (Summary)
8511 @findex gnus-summary-caesar-message
8512 @c @icon{gnus-summary-caesar-message}
8513 Do a Caesar rotate (rot13) on the article buffer
8514 (@code{gnus-summary-caesar-message}).
8515 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8516 (Typically offensive jokes and such.)
8518 It's commonly called ``rot13'' because each letter is rotated 13
8519 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8520 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8521 is rumored to have employed this form of, uh, somewhat weak encryption.
8524 @kindex W m (Summary)
8525 @findex gnus-summary-morse-message
8526 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8529 @kindex W i (Summary)
8530 @findex gnus-summary-idna-message
8531 Decode IDNA encoded domain names in the current articles. IDNA
8532 encoded domain names looks like @samp{xn--bar}. If a string remain
8533 unencoded after running invoking this, it is likely an invalid IDNA
8534 string (@samp{xn--bar} is invalid). You must have GNU Libidn
8535 (@url{http://www.gnu.org/software/libidn/}) installed for this command
8540 @kindex W t (Summary)
8542 @findex gnus-summary-toggle-header
8543 Toggle whether to display all headers in the article buffer
8544 (@code{gnus-summary-toggle-header}).
8547 @kindex W v (Summary)
8548 @findex gnus-summary-verbose-headers
8549 Toggle whether to display all headers in the article buffer permanently
8550 (@code{gnus-summary-verbose-headers}).
8553 @kindex W m (Summary)
8554 @findex gnus-summary-toggle-mime
8555 Toggle whether to run the article through @acronym{MIME} before
8556 displaying (@code{gnus-summary-toggle-mime}).
8559 @kindex W o (Summary)
8560 @findex gnus-article-treat-overstrike
8561 Treat overstrike (@code{gnus-article-treat-overstrike}).
8564 @kindex W d (Summary)
8565 @findex gnus-article-treat-dumbquotes
8566 @vindex gnus-article-dumbquotes-map
8568 @cindex M****s*** sm*rtq**t*s
8570 Treat M****s*** sm*rtq**t*s according to
8571 @code{gnus-article-dumbquotes-map}
8572 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8573 whether a character is a sm*rtq**t* or not, so it should only be used
8576 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8577 an attempt to provide more quoting characters. If you see something
8578 like @code{\222} or @code{\264} where you're expecting some kind of
8579 apostrophe or quotation mark, then try this wash.
8582 @kindex W Y f (Summary)
8583 @findex gnus-article-outlook-deuglify-article
8584 @cindex Outlook Express
8585 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8586 unwrap lines, repair attribution and rearrange citation.
8587 (@code{gnus-article-outlook-deuglify-article}).
8590 @kindex W Y u (Summary)
8591 @findex gnus-article-outlook-unwrap-lines
8592 @vindex gnus-outlook-deuglify-unwrap-min
8593 @vindex gnus-outlook-deuglify-unwrap-max
8594 Unwrap lines that appear to be wrapped citation lines. You can control
8595 what lines will be unwrapped by frobbing
8596 @code{gnus-outlook-deuglify-unwrap-min} and
8597 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8598 maximum length of an unwrapped citation line.
8599 (@code{gnus-article-outlook-unwrap-lines}).
8602 @kindex W Y a (Summary)
8603 @findex gnus-article-outlook-repair-attribution
8604 Repair a broken attribution line.@*
8605 (@code{gnus-article-outlook-repair-attribution}).
8608 @kindex W Y c (Summary)
8609 @findex gnus-article-outlook-rearrange-citation
8610 Repair broken citations by rearranging the text.
8611 (@code{gnus-article-outlook-rearrange-citation}).
8614 @kindex W w (Summary)
8615 @findex gnus-article-fill-cited-article
8616 Do word wrap (@code{gnus-article-fill-cited-article}).
8618 You can give the command a numerical prefix to specify the width to use
8622 @kindex W Q (Summary)
8623 @findex gnus-article-fill-long-lines
8624 Fill long lines (@code{gnus-article-fill-long-lines}).
8627 @kindex W C (Summary)
8628 @findex gnus-article-capitalize-sentences
8629 Capitalize the first word in each sentence
8630 (@code{gnus-article-capitalize-sentences}).
8633 @kindex W c (Summary)
8634 @findex gnus-article-remove-cr
8635 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8636 (this takes care of DOS line endings), and then translate any remaining
8637 CRs into LF (this takes care of Mac line endings)
8638 (@code{gnus-article-remove-cr}).
8640 @kindex W q (Summary)
8641 @findex gnus-article-de-quoted-unreadable
8642 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8643 Quoted-Printable is one common @acronym{MIME} encoding employed when
8644 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8645 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
8646 which doesn't look very readable to me. Note that this is usually
8647 done automatically by Gnus if the message in question has a
8648 @code{Content-Transfer-Encoding} header that says that this encoding
8649 has been done. If a prefix is given, a charset will be asked for.
8652 @kindex W 6 (Summary)
8653 @findex gnus-article-de-base64-unreadable
8654 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8655 one common @acronym{MIME} encoding employed when sending
8656 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8657 usually done automatically by Gnus if the message in question has a
8658 @code{Content-Transfer-Encoding} header that says that this encoding
8659 has been done. If a prefix is given, a charset will be asked for.
8662 @kindex W Z (Summary)
8663 @findex gnus-article-decode-HZ
8664 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8665 common encoding employed when sending Chinese articles. It typically
8666 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8669 @kindex W A (Summary)
8670 @findex gnus-article-treat-ansi-sequences
8671 @cindex @acronym{ANSI} control sequences
8672 Translate @acronym{ANSI} SGR control sequences into overlays or
8673 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
8674 sequences are used in some Chinese hierarchies for highlighting.
8677 @kindex W u (Summary)
8678 @findex gnus-article-unsplit-urls
8679 Remove newlines from within URLs. Some mailers insert newlines into
8680 outgoing email messages to keep lines short. This reformatting can
8681 split long URLs onto multiple lines. Repair those URLs by removing
8682 the newlines (@code{gnus-article-unsplit-urls}).
8685 @kindex W h (Summary)
8686 @findex gnus-article-wash-html
8687 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
8688 usually done automatically by Gnus if the message in question has a
8689 @code{Content-Type} header that says that the message is @acronym{HTML}.
8691 If a prefix is given, a charset will be asked for. If it is a number,
8692 the charset defined in @code{gnus-summary-show-article-charset-alist}
8693 (@pxref{Paging the Article}) will be used.
8695 @vindex gnus-article-wash-function
8696 The default is to use the function specified by
8697 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
8698 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8699 @acronym{HTML}, but this is controlled by the
8700 @code{gnus-article-wash-function} variable. Pre-defined functions you
8708 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
8710 @item w3m-standalone
8711 Use @uref{http://w3m.sourceforge.net/, w3m}.
8714 Use @uref{http://links.sf.net/, Links}.
8717 Use @uref{http://lynx.isc.org/, Lynx}.
8720 Use html2text---a simple @acronym{HTML} converter included with Gnus.
8725 @kindex W b (Summary)
8726 @findex gnus-article-add-buttons
8727 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8728 @xref{Article Buttons}.
8731 @kindex W B (Summary)
8732 @findex gnus-article-add-buttons-to-head
8733 Add clickable buttons to the article headers
8734 (@code{gnus-article-add-buttons-to-head}).
8737 @kindex W p (Summary)
8738 @findex gnus-article-verify-x-pgp-sig
8739 Verify a signed control message
8740 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
8741 @code{newgroup} and @code{checkgroups} are usually signed by the
8742 hierarchy maintainer. You need to add the @acronym{PGP} public key of
8743 the maintainer to your keyring to verify the
8744 message.@footnote{@acronym{PGP} keys for many hierarchies are
8745 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8748 @kindex W s (Summary)
8749 @findex gnus-summary-force-verify-and-decrypt
8750 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
8751 @acronym{S/MIME}) message
8752 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8755 @kindex W a (Summary)
8756 @findex gnus-article-strip-headers-in-body
8757 Strip headers like the @code{X-No-Archive} header from the beginning of
8758 article bodies (@code{gnus-article-strip-headers-in-body}).
8761 @kindex W E l (Summary)
8762 @findex gnus-article-strip-leading-blank-lines
8763 Remove all blank lines from the beginning of the article
8764 (@code{gnus-article-strip-leading-blank-lines}).
8767 @kindex W E m (Summary)
8768 @findex gnus-article-strip-multiple-blank-lines
8769 Replace all blank lines with empty lines and then all multiple empty
8770 lines with a single empty line.
8771 (@code{gnus-article-strip-multiple-blank-lines}).
8774 @kindex W E t (Summary)
8775 @findex gnus-article-remove-trailing-blank-lines
8776 Remove all blank lines at the end of the article
8777 (@code{gnus-article-remove-trailing-blank-lines}).
8780 @kindex W E a (Summary)
8781 @findex gnus-article-strip-blank-lines
8782 Do all the three commands above
8783 (@code{gnus-article-strip-blank-lines}).
8786 @kindex W E A (Summary)
8787 @findex gnus-article-strip-all-blank-lines
8788 Remove all blank lines
8789 (@code{gnus-article-strip-all-blank-lines}).
8792 @kindex W E s (Summary)
8793 @findex gnus-article-strip-leading-space
8794 Remove all white space from the beginning of all lines of the article
8795 body (@code{gnus-article-strip-leading-space}).
8798 @kindex W E e (Summary)
8799 @findex gnus-article-strip-trailing-space
8800 Remove all white space from the end of all lines of the article
8801 body (@code{gnus-article-strip-trailing-space}).
8805 @xref{Customizing Articles}, for how to wash articles automatically.
8808 @node Article Header
8809 @subsection Article Header
8811 These commands perform various transformations of article header.
8816 @kindex W G u (Summary)
8817 @findex gnus-article-treat-unfold-headers
8818 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8821 @kindex W G n (Summary)
8822 @findex gnus-article-treat-fold-newsgroups
8823 Fold the @code{Newsgroups} and @code{Followup-To} headers
8824 (@code{gnus-article-treat-fold-newsgroups}).
8827 @kindex W G f (Summary)
8828 @findex gnus-article-treat-fold-headers
8829 Fold all the message headers
8830 (@code{gnus-article-treat-fold-headers}).
8833 @kindex W E w (Summary)
8834 @findex gnus-article-remove-leading-whitespace
8835 Remove excessive whitespace from all headers
8836 (@code{gnus-article-remove-leading-whitespace}).
8841 @node Article Buttons
8842 @subsection Article Buttons
8845 People often include references to other stuff in articles, and it would
8846 be nice if Gnus could just fetch whatever it is that people talk about
8847 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8848 button on these references.
8850 @vindex gnus-button-man-handler
8851 Gnus adds @dfn{buttons} to certain standard references by default:
8852 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
8853 Emacs or Gnus related references. This is controlled by two variables,
8854 one that handles article bodies and one that handles article heads:
8858 @item gnus-button-alist
8859 @vindex gnus-button-alist
8860 This is an alist where each entry has this form:
8863 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8869 All text that match this regular expression (case insensitive) will be
8870 considered an external reference. Here's a typical regexp that matches
8871 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
8872 variable containing a regexp, useful variables to use include
8873 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
8876 Gnus has to know which parts of the matches is to be highlighted. This
8877 is a number that says what sub-expression of the regexp is to be
8878 highlighted. If you want it all highlighted, you use 0 here.
8881 This form will be @code{eval}ed, and if the result is non-@code{nil},
8882 this is considered a match. This is useful if you want extra sifting to
8883 avoid false matches. Often variables named
8884 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
8885 Levels}, but any other form may be used too.
8887 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
8890 This function will be called when you click on this button.
8893 As with @var{button-par}, this is a sub-expression number, but this one
8894 says which part of the match is to be sent as data to @var{function}.
8898 So the full entry for buttonizing URLs is then
8901 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8904 @item gnus-header-button-alist
8905 @vindex gnus-header-button-alist
8906 This is just like the other alist, except that it is applied to the
8907 article head only, and that each entry has an additional element that is
8908 used to say what headers to apply the buttonize coding to:
8911 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8914 @var{header} is a regular expression.
8917 @subsubsection Related variables and functions
8920 @item gnus-button-@var{*}-level
8921 @xref{Article Button Levels}.
8923 @c Stuff related to gnus-button-browse-level
8925 @item gnus-button-url-regexp
8926 @vindex gnus-button-url-regexp
8927 A regular expression that matches embedded URLs. It is used in the
8928 default values of the variables above.
8930 @c Stuff related to gnus-button-man-level
8932 @item gnus-button-man-handler
8933 @vindex gnus-button-man-handler
8934 The function to use for displaying man pages. It must take at least one
8935 argument with a string naming the man page.
8937 @c Stuff related to gnus-button-message-level
8939 @item gnus-button-mid-or-mail-regexp
8940 @vindex gnus-button-mid-or-mail-regexp
8941 Regular expression that matches a message ID or a mail address.
8943 @item gnus-button-prefer-mid-or-mail
8944 @vindex gnus-button-prefer-mid-or-mail
8945 This variable determines what to do when the button on a string as
8946 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
8947 message ID or a mail address. If it is one of the symbols @code{mid} or
8948 @code{mail}, Gnus will always assume that the string is a message ID or
8949 a mail address, respectively. If this variable is set to the symbol
8950 @code{ask}, always query the user what do do. If it is a function, this
8951 function will be called with the string as its only argument. The
8952 function must return @code{mid}, @code{mail}, @code{invalid} or
8953 @code{ask}. The default value is the function
8954 @code{gnus-button-mid-or-mail-heuristic}.
8956 @item gnus-button-mid-or-mail-heuristic
8957 @findex gnus-button-mid-or-mail-heuristic
8958 Function that guesses whether its argument is a message ID or a mail
8959 address. Returns @code{mid} if it's a message IDs, @code{mail} if
8960 it's a mail address, @code{ask} if unsure and @code{invalid} if the
8963 @item gnus-button-mid-or-mail-heuristic-alist
8964 @vindex gnus-button-mid-or-mail-heuristic-alist
8965 An alist of @code{(RATE . REGEXP)} pairs used by the function
8966 @code{gnus-button-mid-or-mail-heuristic}.
8968 @c Stuff related to gnus-button-tex-level
8970 @item gnus-button-ctan-handler
8971 @findex gnus-button-ctan-handler
8972 The function to use for displaying CTAN links. It must take one
8973 argument, the string naming the URL.
8976 @vindex gnus-ctan-url
8977 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
8978 by @code{gnus-button-ctan-handler}.
8982 @item gnus-article-button-face
8983 @vindex gnus-article-button-face
8984 Face used on buttons.
8986 @item gnus-article-mouse-face
8987 @vindex gnus-article-mouse-face
8988 Face used when the mouse cursor is over a button.
8992 @xref{Customizing Articles}, for how to buttonize articles automatically.
8995 @node Article Button Levels
8996 @subsection Article button levels
8997 @cindex button levels
8998 The higher the value of the variables @code{gnus-button-@var{*}-level},
8999 the more buttons will appear. If the level is zero, no corresponding
9000 buttons are displayed. With the default value (which is 5) you should
9001 already see quite a lot of buttons. With higher levels, you will see
9002 more buttons, but you may also get more false positives. To avoid them,
9003 you can set the variables @code{gnus-button-@var{*}-level} local to
9004 specific groups (@pxref{Group Parameters}). Here's an example for the
9005 variable @code{gnus-parameters}:
9008 ;; @r{increase @code{gnus-button-*-level} in some groups:}
9009 (setq gnus-parameters
9010 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
9011 ("\\<unix\\>" (gnus-button-man-level 10))
9012 ("\\<tex\\>" (gnus-button-tex-level 10))))
9017 @item gnus-button-browse-level
9018 @vindex gnus-button-browse-level
9019 Controls the display of references to message IDs, mail addresses and
9020 news URLs. Related variables and functions include
9021 @code{gnus-button-url-regexp}, @code{browse-url}, and
9022 @code{browse-url-browser-function}.
9024 @item gnus-button-emacs-level
9025 @vindex gnus-button-emacs-level
9026 Controls the display of Emacs or Gnus references. Related functions are
9027 @code{gnus-button-handle-custom},
9028 @code{gnus-button-handle-describe-function},
9029 @code{gnus-button-handle-describe-variable},
9030 @code{gnus-button-handle-symbol},
9031 @code{gnus-button-handle-describe-key},
9032 @code{gnus-button-handle-apropos},
9033 @code{gnus-button-handle-apropos-command},
9034 @code{gnus-button-handle-apropos-variable},
9035 @code{gnus-button-handle-apropos-documentation}, and
9036 @code{gnus-button-handle-library}.
9038 @item gnus-button-man-level
9039 @vindex gnus-button-man-level
9040 Controls the display of references to (Unix) man pages.
9041 See @code{gnus-button-man-handler}.
9043 @item gnus-button-message-level
9044 @vindex gnus-button-message-level
9045 Controls the display of message IDs, mail addresses and news URLs.
9046 Related variables and functions include
9047 @code{gnus-button-mid-or-mail-regexp},
9048 @code{gnus-button-prefer-mid-or-mail},
9049 @code{gnus-button-mid-or-mail-heuristic}, and
9050 @code{gnus-button-mid-or-mail-heuristic-alist}.
9052 @item gnus-button-tex-level
9053 @vindex gnus-button-tex-level
9054 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
9055 URLs. See the variables @code{gnus-ctan-url},
9056 @code{gnus-button-ctan-handler},
9057 @code{gnus-button-ctan-directory-regexp}, and
9058 @code{gnus-button-handle-ctan-bogus-regexp}.
9064 @subsection Article Date
9066 The date is most likely generated in some obscure timezone you've never
9067 heard of, so it's quite nice to be able to find out what the time was
9068 when the article was sent.
9073 @kindex W T u (Summary)
9074 @findex gnus-article-date-ut
9075 Display the date in UT (aka. GMT, aka ZULU)
9076 (@code{gnus-article-date-ut}).
9079 @kindex W T i (Summary)
9080 @findex gnus-article-date-iso8601
9082 Display the date in international format, aka. ISO 8601
9083 (@code{gnus-article-date-iso8601}).
9086 @kindex W T l (Summary)
9087 @findex gnus-article-date-local
9088 Display the date in the local timezone (@code{gnus-article-date-local}).
9091 @kindex W T p (Summary)
9092 @findex gnus-article-date-english
9093 Display the date in a format that's easily pronounceable in English
9094 (@code{gnus-article-date-english}).
9097 @kindex W T s (Summary)
9098 @vindex gnus-article-time-format
9099 @findex gnus-article-date-user
9100 @findex format-time-string
9101 Display the date using a user-defined format
9102 (@code{gnus-article-date-user}). The format is specified by the
9103 @code{gnus-article-time-format} variable, and is a string that's passed
9104 to @code{format-time-string}. See the documentation of that variable
9105 for a list of possible format specs.
9108 @kindex W T e (Summary)
9109 @findex gnus-article-date-lapsed
9110 @findex gnus-start-date-timer
9111 @findex gnus-stop-date-timer
9112 Say how much time has elapsed between the article was posted and now
9113 (@code{gnus-article-date-lapsed}). It looks something like:
9116 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9119 @vindex gnus-article-date-lapsed-new-header
9120 The value of @code{gnus-article-date-lapsed-new-header} determines
9121 whether this header will just be added below the old Date one, or will
9124 An advantage of using Gnus to read mail is that it converts simple bugs
9125 into wonderful absurdities.
9127 If you want to have this line updated continually, you can put
9130 (gnus-start-date-timer)
9133 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9134 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9138 @kindex W T o (Summary)
9139 @findex gnus-article-date-original
9140 Display the original date (@code{gnus-article-date-original}). This can
9141 be useful if you normally use some other conversion function and are
9142 worried that it might be doing something totally wrong. Say, claiming
9143 that the article was posted in 1854. Although something like that is
9144 @emph{totally} impossible. Don't you trust me? *titter*
9148 @xref{Customizing Articles}, for how to display the date in your
9149 preferred format automatically.
9152 @node Article Display
9153 @subsection Article Display
9158 These commands add various frivolous display gimmicks to the article
9159 buffer in Emacs versions that support them.
9161 @code{X-Face} headers are small black-and-white images supplied by the
9162 message headers (@pxref{X-Face}).
9164 @code{Face} headers are small colored images supplied by the message
9165 headers (@pxref{Face}).
9167 Smileys are those little @samp{:-)} symbols that people like to litter
9168 their messages with (@pxref{Smileys}).
9170 Picons, on the other hand, reside on your own system, and Gnus will
9171 try to match the headers to what you have (@pxref{Picons}).
9173 All these functions are toggles---if the elements already exist,
9178 @kindex W D x (Summary)
9179 @findex gnus-article-display-x-face
9180 Display an @code{X-Face} in the @code{From} header.
9181 (@code{gnus-article-display-x-face}).
9184 @kindex W D d (Summary)
9185 @findex gnus-article-display-face
9186 Display a @code{Face} in the @code{From} header.
9187 (@code{gnus-article-display-face}).
9190 @kindex W D s (Summary)
9191 @findex gnus-treat-smiley
9192 Display smileys (@code{gnus-treat-smiley}).
9195 @kindex W D f (Summary)
9196 @findex gnus-treat-from-picon
9197 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9200 @kindex W D m (Summary)
9201 @findex gnus-treat-mail-picon
9202 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9203 (@code{gnus-treat-mail-picon}).
9206 @kindex W D n (Summary)
9207 @findex gnus-treat-newsgroups-picon
9208 Piconify all news headers (i. e., @code{Newsgroups} and
9209 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9212 @kindex W D D (Summary)
9213 @findex gnus-article-remove-images
9214 Remove all images from the article buffer
9215 (@code{gnus-article-remove-images}).
9221 @node Article Signature
9222 @subsection Article Signature
9224 @cindex article signature
9226 @vindex gnus-signature-separator
9227 Each article is divided into two parts---the head and the body. The
9228 body can be divided into a signature part and a text part. The variable
9229 that says what is to be considered a signature is
9230 @code{gnus-signature-separator}. This is normally the standard
9231 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9232 non-standard signature separators, so this variable can also be a list
9233 of regular expressions to be tested, one by one. (Searches are done
9234 from the end of the body towards the beginning.) One likely value is:
9237 (setq gnus-signature-separator
9238 '("^-- $" ; @r{The standard}
9239 "^-- *$" ; @r{A common mangling}
9240 "^-------*$" ; @r{Many people just use a looong}
9241 ; @r{line of dashes. Shame!}
9242 "^ *--------*$" ; @r{Double-shame!}
9243 "^________*$" ; @r{Underscores are also popular}
9244 "^========*$")) ; @r{Pervert!}
9247 The more permissive you are, the more likely it is that you'll get false
9250 @vindex gnus-signature-limit
9251 @code{gnus-signature-limit} provides a limit to what is considered a
9252 signature when displaying articles.
9256 If it is an integer, no signature may be longer (in characters) than
9259 If it is a floating point number, no signature may be longer (in lines)
9262 If it is a function, the function will be called without any parameters,
9263 and if it returns @code{nil}, there is no signature in the buffer.
9265 If it is a string, it will be used as a regexp. If it matches, the text
9266 in question is not a signature.
9269 This variable can also be a list where the elements may be of the types
9270 listed above. Here's an example:
9273 (setq gnus-signature-limit
9274 '(200.0 "^---*Forwarded article"))
9277 This means that if there are more than 200 lines after the signature
9278 separator, or the text after the signature separator is matched by
9279 the regular expression @samp{^---*Forwarded article}, then it isn't a
9280 signature after all.
9283 @node Article Miscellanea
9284 @subsection Article Miscellanea
9288 @kindex A t (Summary)
9289 @findex gnus-article-babel
9290 Translate the article from one language to another
9291 (@code{gnus-article-babel}).
9297 @section MIME Commands
9298 @cindex MIME decoding
9300 @cindex viewing attachments
9302 The following commands all understand the numerical prefix. For
9303 instance, @kbd{3 K v} means ``view the third @acronym{MIME} part''.
9309 @kindex K v (Summary)
9310 View the @acronym{MIME} part.
9313 @kindex K o (Summary)
9314 Save the @acronym{MIME} part.
9317 @kindex K O (Summary)
9318 Prompt for a file name, then save the @acronym{MIME} part and strip it
9319 from the article. The stripped @acronym{MIME} object will be referred
9320 via the message/external-body @acronym{MIME} type.
9323 @kindex K r (Summary)
9324 Replace the @acronym{MIME} part with an external body.
9327 @kindex K d (Summary)
9328 Delete the @acronym{MIME} part and add some information about the
9332 @kindex K c (Summary)
9333 Copy the @acronym{MIME} part.
9336 @kindex K e (Summary)
9337 View the @acronym{MIME} part externally.
9340 @kindex K i (Summary)
9341 View the @acronym{MIME} part internally.
9344 @kindex K | (Summary)
9345 Pipe the @acronym{MIME} part to an external command.
9348 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9353 @kindex K b (Summary)
9354 Make all the @acronym{MIME} parts have buttons in front of them. This is
9355 mostly useful if you wish to save (or perform other actions) on inlined
9359 @kindex K m (Summary)
9360 @findex gnus-summary-repair-multipart
9361 Some multipart messages are transmitted with missing or faulty headers.
9362 This command will attempt to ``repair'' these messages so that they can
9363 be viewed in a more pleasant manner
9364 (@code{gnus-summary-repair-multipart}).
9367 @kindex X m (Summary)
9368 @findex gnus-summary-save-parts
9369 Save all parts matching a @acronym{MIME} type to a directory
9370 (@code{gnus-summary-save-parts}). Understands the process/prefix
9371 convention (@pxref{Process/Prefix}).
9374 @kindex M-t (Summary)
9375 @findex gnus-summary-toggle-display-buttonized
9376 Toggle the buttonized display of the article buffer
9377 (@code{gnus-summary-toggle-display-buttonized}).
9380 @kindex W M w (Summary)
9381 @findex gnus-article-decode-mime-words
9382 Decode RFC 2047-encoded words in the article headers
9383 (@code{gnus-article-decode-mime-words}).
9386 @kindex W M c (Summary)
9387 @findex gnus-article-decode-charset
9388 Decode encoded article bodies as well as charsets
9389 (@code{gnus-article-decode-charset}).
9391 This command looks in the @code{Content-Type} header to determine the
9392 charset. If there is no such header in the article, you can give it a
9393 prefix, which will prompt for the charset to decode as. In regional
9394 groups where people post using some common encoding (but do not
9395 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9396 parameter to the required charset (@pxref{Group Parameters}).
9399 @kindex W M v (Summary)
9400 @findex gnus-mime-view-all-parts
9401 View all the @acronym{MIME} parts in the current article
9402 (@code{gnus-mime-view-all-parts}).
9409 @item gnus-ignored-mime-types
9410 @vindex gnus-ignored-mime-types
9411 This is a list of regexps. @acronym{MIME} types that match a regexp from
9412 this list will be completely ignored by Gnus. The default value is
9415 To have all Vcards be ignored, you'd say something like this:
9418 (setq gnus-ignored-mime-types
9422 @item gnus-article-loose-mime
9423 @vindex gnus-article-loose-mime
9424 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9425 before interpreting the message as a @acronym{MIME} message. This helps
9426 when reading messages from certain broken mail user agents. The
9427 default is @code{nil}.
9429 @item gnus-article-emulate-mime
9430 @vindex gnus-article-emulate-mime
9431 There are other, non-@acronym{MIME} encoding methods used. The most common
9432 is @samp{uuencode}, but yEncode is also getting to be popular. If
9433 this variable is non-@code{nil}, Gnus will look in message bodies to
9434 see if it finds these encodings, and if so, it'll run them through the
9435 Gnus @acronym{MIME} machinery. The default is @code{t}.
9437 @item gnus-unbuttonized-mime-types
9438 @vindex gnus-unbuttonized-mime-types
9439 This is a list of regexps. @acronym{MIME} types that match a regexp from
9440 this list won't have @acronym{MIME} buttons inserted unless they aren't
9441 displayed or this variable is overridden by
9442 @code{gnus-buttonized-mime-types}. The default value is
9443 @code{(".*/.*")}. This variable is only used when
9444 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9446 @item gnus-buttonized-mime-types
9447 @vindex gnus-buttonized-mime-types
9448 This is a list of regexps. @acronym{MIME} types that match a regexp from
9449 this list will have @acronym{MIME} buttons inserted unless they aren't
9450 displayed. This variable overrides
9451 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9452 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9455 To see e.g. security buttons but no other buttons, you could set this
9456 variable to @code{("multipart/signed")} and leave
9457 @code{gnus-unbuttonized-mime-types} at the default value.
9459 You could also add @code{"multipart/alternative"} to this list to
9460 display radio buttons that allow you to choose one of two media types
9461 those mails include. See also @code{mm-discouraged-alternatives}
9462 (@pxref{Display Customization, ,Display Customization, emacs-mime, The
9463 Emacs MIME Manual}).
9465 @item gnus-inhibit-mime-unbuttonizing
9466 @vindex gnus-inhibit-mime-unbuttonizing
9467 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9468 default value is @code{nil}.
9470 @item gnus-article-mime-part-function
9471 @vindex gnus-article-mime-part-function
9472 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9473 handle as the parameter. The function is meant to be used to allow
9474 users to gather information from the article (e. g., add Vcard info to
9475 the bbdb database) or to do actions based on parts (e. g., automatically
9476 save all jpegs into some directory).
9478 Here's an example function the does the latter:
9481 (defun my-save-all-jpeg-parts (handle)
9482 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9484 (insert (mm-get-part handle))
9485 (write-region (point-min) (point-max)
9486 (read-file-name "Save jpeg to: ")))))
9487 (setq gnus-article-mime-part-function
9488 'my-save-all-jpeg-parts)
9491 @vindex gnus-mime-multipart-functions
9492 @item gnus-mime-multipart-functions
9493 Alist of @acronym{MIME} multipart types and functions to handle them.
9495 @vindex gnus-mime-display-multipart-alternative-as-mixed
9496 @item gnus-mime-display-multipart-alternative-as-mixed
9497 Display "multipart/alternative" parts as "multipart/mixed".
9499 @vindex gnus-mime-display-multipart-related-as-mixed
9500 @item gnus-mime-display-multipart-related-as-mixed
9501 Display "multipart/related" parts as "multipart/mixed".
9503 If displaying "text/html" is discouraged, see
9504 @code{mm-discouraged-alternatives}, images or other material inside a
9505 "multipart/related" part might be overlooked when this variable is
9506 @code{nil}. @ref{Display Customization, Display Customization, ,
9507 emacs-mime, Emacs-Mime Manual}.
9509 @vindex gnus-mime-display-multipart-as-mixed
9510 @item gnus-mime-display-multipart-as-mixed
9511 Display "multipart" parts as "multipart/mixed". If @code{t}, it
9512 overrides @code{nil} values of
9513 @code{gnus-mime-display-multipart-alternative-as-mixed} and
9514 @code{gnus-mime-display-multipart-related-as-mixed}.
9516 @vindex mm-file-name-rewrite-functions
9517 @item mm-file-name-rewrite-functions
9518 List of functions used for rewriting file names of @acronym{MIME} parts.
9519 Each function takes a file name as input and returns a file name.
9521 Ready-made functions include@*
9522 @code{mm-file-name-delete-whitespace},
9523 @code{mm-file-name-trim-whitespace},
9524 @code{mm-file-name-collapse-whitespace}, and
9525 @code{mm-file-name-replace-whitespace}. The later uses the value of
9526 the variable @code{mm-file-name-replace-whitespace} to replace each
9527 whitespace character in a file name with that string; default value
9528 is @code{"_"} (a single underscore).
9529 @findex mm-file-name-delete-whitespace
9530 @findex mm-file-name-trim-whitespace
9531 @findex mm-file-name-collapse-whitespace
9532 @findex mm-file-name-replace-whitespace
9533 @vindex mm-file-name-replace-whitespace
9535 The standard functions @code{capitalize}, @code{downcase},
9536 @code{upcase}, and @code{upcase-initials} may be useful, too.
9538 Everybody knows that whitespace characters in file names are evil,
9539 except those who don't know. If you receive lots of attachments from
9540 such unenlightened users, you can make live easier by adding
9543 (setq mm-file-name-rewrite-functions
9544 '(mm-file-name-trim-whitespace
9545 mm-file-name-collapse-whitespace
9546 mm-file-name-replace-whitespace))
9550 to your @file{~/.gnus.el} file.
9559 People use different charsets, and we have @acronym{MIME} to let us know what
9560 charsets they use. Or rather, we wish we had. Many people use
9561 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9562 just send out messages without saying what character sets they use. To
9563 help a bit with this, some local news hierarchies have policies that say
9564 what character set is the default. For instance, the @samp{fj}
9565 hierarchy uses @code{iso-2022-jp}.
9567 @vindex gnus-group-charset-alist
9568 This knowledge is encoded in the @code{gnus-group-charset-alist}
9569 variable, which is an alist of regexps (use the first item to match full
9570 group names) and default charsets to be used when reading these groups.
9572 @vindex gnus-newsgroup-ignored-charsets
9573 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9574 aren't. These blithely mark messages as being in @code{iso-8859-1}
9575 even if they really are in @code{koi-8}. To help here, the
9576 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9577 charsets that are listed here will be ignored. The variable can be
9578 set on a group-by-group basis using the group parameters (@pxref{Group
9579 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9580 which includes values some agents insist on having in there.
9582 @vindex gnus-group-posting-charset-alist
9583 When posting, @code{gnus-group-posting-charset-alist} is used to
9584 determine which charsets should not be encoded using the @acronym{MIME}
9585 encodings. For instance, some hierarchies discourage using
9586 quoted-printable header encoding.
9588 This variable is an alist of regexps and permitted unencoded charsets
9589 for posting. Each element of the alist has the form @code{(}@var{test
9590 header body-list}@code{)}, where:
9594 is either a regular expression matching the newsgroup header or a
9597 is the charset which may be left unencoded in the header (@code{nil}
9598 means encode all charsets),
9600 is a list of charsets which may be encoded using 8bit content-transfer
9601 encoding in the body, or one of the special values @code{nil} (always
9602 encode using quoted-printable) or @code{t} (always use 8bit).
9609 @cindex coding system aliases
9610 @cindex preferred charset
9612 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
9613 The Emacs MIME Manual}, for additional variables that control which
9614 MIME charsets are used when sending messages.
9616 Other charset tricks that may be useful, although not Gnus-specific:
9618 If there are several @acronym{MIME} charsets that encode the same Emacs
9619 charset, you can choose what charset to use by saying the following:
9622 (put-charset-property 'cyrillic-iso8859-5
9623 'preferred-coding-system 'koi8-r)
9626 This means that Russian will be encoded using @code{koi8-r} instead of
9627 the default @code{iso-8859-5} @acronym{MIME} charset.
9629 If you want to read messages in @code{koi8-u}, you can cheat and say
9632 (define-coding-system-alias 'koi8-u 'koi8-r)
9635 This will almost do the right thing.
9637 And finally, to read charsets like @code{windows-1251}, you can say
9641 (codepage-setup 1251)
9642 (define-coding-system-alias 'windows-1251 'cp1251)
9646 @node Article Commands
9647 @section Article Commands
9654 @kindex A P (Summary)
9655 @vindex gnus-ps-print-hook
9656 @findex gnus-summary-print-article
9657 Generate and print a PostScript image of the article buffer
9658 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9659 be run just before printing the buffer. An alternative way to print
9660 article is to use Muttprint (@pxref{Saving Articles}).
9665 @node Summary Sorting
9666 @section Summary Sorting
9667 @cindex summary sorting
9669 You can have the summary buffer sorted in various ways, even though I
9670 can't really see why you'd want that.
9675 @kindex C-c C-s C-n (Summary)
9676 @findex gnus-summary-sort-by-number
9677 Sort by article number (@code{gnus-summary-sort-by-number}).
9680 @kindex C-c C-s C-a (Summary)
9681 @findex gnus-summary-sort-by-author
9682 Sort by author (@code{gnus-summary-sort-by-author}).
9685 @kindex C-c C-s C-t (Summary)
9686 @findex gnus-summary-sort-by-recipient
9687 Sort by recipient (@code{gnus-summary-sort-by-recipient}).
9690 @kindex C-c C-s C-s (Summary)
9691 @findex gnus-summary-sort-by-subject
9692 Sort by subject (@code{gnus-summary-sort-by-subject}).
9695 @kindex C-c C-s C-d (Summary)
9696 @findex gnus-summary-sort-by-date
9697 Sort by date (@code{gnus-summary-sort-by-date}).
9700 @kindex C-c C-s C-l (Summary)
9701 @findex gnus-summary-sort-by-lines
9702 Sort by lines (@code{gnus-summary-sort-by-lines}).
9705 @kindex C-c C-s C-c (Summary)
9706 @findex gnus-summary-sort-by-chars
9707 Sort by article length (@code{gnus-summary-sort-by-chars}).
9710 @kindex C-c C-s C-i (Summary)
9711 @findex gnus-summary-sort-by-score
9712 Sort by score (@code{gnus-summary-sort-by-score}).
9715 @kindex C-c C-s C-r (Summary)
9716 @findex gnus-summary-sort-by-random
9717 Randomize (@code{gnus-summary-sort-by-random}).
9720 @kindex C-c C-s C-o (Summary)
9721 @findex gnus-summary-sort-by-original
9722 Sort using the default sorting method
9723 (@code{gnus-summary-sort-by-original}).
9726 These functions will work both when you use threading and when you don't
9727 use threading. In the latter case, all summary lines will be sorted,
9728 line by line. In the former case, sorting will be done on a
9729 root-by-root basis, which might not be what you were looking for. To
9730 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9734 @node Finding the Parent
9735 @section Finding the Parent
9736 @cindex parent articles
9737 @cindex referring articles
9742 @findex gnus-summary-refer-parent-article
9743 If you'd like to read the parent of the current article, and it is not
9744 displayed in the summary buffer, you might still be able to. That is,
9745 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
9746 and the @code{References} in the current article are not mangled, you
9747 can just press @kbd{^} or @kbd{A r}
9748 (@code{gnus-summary-refer-parent-article}). If everything goes well,
9749 you'll get the parent. If the parent is already displayed in the
9750 summary buffer, point will just move to this article.
9752 If given a positive numerical prefix, fetch that many articles back into
9753 the ancestry. If given a negative numerical prefix, fetch just that
9754 ancestor. So if you say @kbd{3 ^}, gnus will fetch the parent, the
9755 grandparent and the grandgrandparent of the current article. If you say
9756 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
9760 @findex gnus-summary-refer-references
9761 @kindex A R (Summary)
9762 Fetch all articles mentioned in the @code{References} header of the
9763 article (@code{gnus-summary-refer-references}).
9766 @findex gnus-summary-refer-thread
9767 @kindex A T (Summary)
9768 Display the full thread where the current article appears
9769 (@code{gnus-summary-refer-thread}). This command has to fetch all the
9770 headers in the current group to work, so it usually takes a while. If
9771 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9772 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
9773 visible effects normally, but it'll make this command work a whole lot
9774 faster. Of course, it'll make group entry somewhat slow.
9776 @vindex gnus-refer-thread-limit
9777 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9778 articles before the first displayed in the current group) headers to
9779 fetch when doing this command. The default is 200. If @code{t}, all
9780 the available headers will be fetched. This variable can be overridden
9781 by giving the @kbd{A T} command a numerical prefix.
9784 @findex gnus-summary-refer-article
9785 @kindex M-^ (Summary)
9787 @cindex fetching by Message-ID
9788 You can also ask Gnus for an arbitrary article, no matter what group it
9789 belongs to. @kbd{M-^} (@code{gnus-summary-refer-article}) will ask you
9790 for a @code{Message-ID}, which is one of those long, hard-to-read
9791 thingies that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.
9792 You have to get it all exactly right. No fuzzy searches, I'm afraid.
9794 Gnus looks for the @code{Message-ID} in the headers that have already
9795 been fetched, but also tries all the select methods specified by
9796 @code{gnus-refer-article-method} if it is not found.
9799 @vindex gnus-refer-article-method
9800 If the group you are reading is located on a back end that does not
9801 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9802 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
9803 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
9804 updating the spool you are reading from, but that's not really
9807 It can also be a list of select methods, as well as the special symbol
9808 @code{current}, which means to use the current select method. If it
9809 is a list, Gnus will try all the methods in the list until it finds a
9812 Here's an example setting that will first try the current method, and
9813 then ask Google if that fails:
9816 (setq gnus-refer-article-method
9818 (nnweb "google" (nnweb-type google))))
9821 Most of the mail back ends support fetching by @code{Message-ID}, but
9822 do not do a particularly excellent job at it. That is, @code{nnmbox},
9823 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
9824 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
9825 only able to locate articles that have been posted to the current
9826 group. (Anything else would be too time consuming.) @code{nnmh} does
9827 not support this at all.
9830 @node Alternative Approaches
9831 @section Alternative Approaches
9833 Different people like to read news using different methods. This being
9834 gnus, we offer a small selection of minor modes for the summary buffers.
9837 * Pick and Read:: First mark articles and then read them.
9838 * Binary Groups:: Auto-decode all articles.
9843 @subsection Pick and Read
9844 @cindex pick and read
9846 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9847 a two-phased reading interface. The user first marks in a summary
9848 buffer the articles she wants to read. Then she starts reading the
9849 articles with just an article buffer displayed.
9851 @findex gnus-pick-mode
9852 @kindex M-x gnus-pick-mode
9853 Gnus provides a summary buffer minor mode that allows
9854 this---@code{gnus-pick-mode}. This basically means that a few process
9855 mark commands become one-keystroke commands to allow easy marking, and
9856 it provides one additional command for switching to the summary buffer.
9858 Here are the available keystrokes when using pick mode:
9863 @findex gnus-pick-article-or-thread
9864 Pick the article or thread on the current line
9865 (@code{gnus-pick-article-or-thread}). If the variable
9866 @code{gnus-thread-hide-subtree} is true, then this key selects the
9867 entire thread when used at the first article of the thread. Otherwise,
9868 it selects just the article. If given a numerical prefix, go to that
9869 thread or article and pick it. (The line number is normally displayed
9870 at the beginning of the summary pick lines.)
9873 @kindex SPACE (Pick)
9874 @findex gnus-pick-next-page
9875 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
9876 at the end of the buffer, start reading the picked articles.
9880 @findex gnus-pick-unmark-article-or-thread.
9881 Unpick the thread or article
9882 (@code{gnus-pick-unmark-article-or-thread}). If the variable
9883 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9884 thread if used at the first article of the thread. Otherwise it unpicks
9885 just the article. You can give this key a numerical prefix to unpick
9886 the thread or article at that line.
9890 @findex gnus-pick-start-reading
9891 @vindex gnus-pick-display-summary
9892 Start reading the picked articles (@code{gnus-pick-start-reading}). If
9893 given a prefix, mark all unpicked articles as read first. If
9894 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9895 will still be visible when you are reading.
9899 All the normal summary mode commands are still available in the
9900 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
9901 which is mapped to the same function
9902 @code{gnus-summary-tick-article-forward}.
9904 If this sounds like a good idea to you, you could say:
9907 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9910 @vindex gnus-pick-mode-hook
9911 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9913 @vindex gnus-mark-unpicked-articles-as-read
9914 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9915 all unpicked articles as read. The default is @code{nil}.
9917 @vindex gnus-summary-pick-line-format
9918 The summary line format in pick mode is slightly different from the
9919 standard format. At the beginning of each line the line number is
9920 displayed. The pick mode line format is controlled by the
9921 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9922 Variables}). It accepts the same format specs that
9923 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9927 @subsection Binary Groups
9928 @cindex binary groups
9930 @findex gnus-binary-mode
9931 @kindex M-x gnus-binary-mode
9932 If you spend much time in binary groups, you may grow tired of hitting
9933 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
9934 is a minor mode for summary buffers that makes all ordinary Gnus article
9935 selection functions uudecode series of articles and display the result
9936 instead of just displaying the articles the normal way.
9939 @findex gnus-binary-show-article
9940 The only way, in fact, to see the actual articles is the @kbd{g}
9941 command, when you have turned on this mode
9942 (@code{gnus-binary-show-article}).
9944 @vindex gnus-binary-mode-hook
9945 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9949 @section Tree Display
9952 @vindex gnus-use-trees
9953 If you don't like the normal gnus summary display, you might try setting
9954 @code{gnus-use-trees} to @code{t}. This will create (by default) an
9955 additional @dfn{tree buffer}. You can execute all summary mode commands
9958 There are a few variables to customize the tree display, of course:
9961 @item gnus-tree-mode-hook
9962 @vindex gnus-tree-mode-hook
9963 A hook called in all tree mode buffers.
9965 @item gnus-tree-mode-line-format
9966 @vindex gnus-tree-mode-line-format
9967 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9968 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
9969 of valid specs, @pxref{Summary Buffer Mode Line}.
9971 @item gnus-selected-tree-face
9972 @vindex gnus-selected-tree-face
9973 Face used for highlighting the selected article in the tree buffer. The
9974 default is @code{modeline}.
9976 @item gnus-tree-line-format
9977 @vindex gnus-tree-line-format
9978 A format string for the tree nodes. The name is a bit of a misnomer,
9979 though---it doesn't define a line, but just the node. The default value
9980 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9981 the name of the poster. It is vital that all nodes are of the same
9982 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9988 The name of the poster.
9990 The @code{From} header.
9992 The number of the article.
9994 The opening bracket.
9996 The closing bracket.
10001 @xref{Formatting Variables}.
10003 Variables related to the display are:
10006 @item gnus-tree-brackets
10007 @vindex gnus-tree-brackets
10008 This is used for differentiating between ``real'' articles and
10009 ``sparse'' articles. The format is
10011 ((@var{real-open} . @var{real-close})
10012 (@var{sparse-open} . @var{sparse-close})
10013 (@var{dummy-open} . @var{dummy-close}))
10015 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
10017 @item gnus-tree-parent-child-edges
10018 @vindex gnus-tree-parent-child-edges
10019 This is a list that contains the characters used for connecting parent
10020 nodes to their children. The default is @code{(?- ?\\ ?|)}.
10024 @item gnus-tree-minimize-window
10025 @vindex gnus-tree-minimize-window
10026 If this variable is non-@code{nil}, gnus will try to keep the tree
10027 buffer as small as possible to allow more room for the other gnus
10028 windows. If this variable is a number, the tree buffer will never be
10029 higher than that number. The default is @code{t}. Note that if you
10030 have several windows displayed side-by-side in a frame and the tree
10031 buffer is one of these, minimizing the tree window will also resize all
10032 other windows displayed next to it.
10034 You may also wish to add the following hook to keep the window minimized
10038 (add-hook 'gnus-configure-windows-hook
10039 'gnus-tree-perhaps-minimize)
10042 @item gnus-generate-tree-function
10043 @vindex gnus-generate-tree-function
10044 @findex gnus-generate-horizontal-tree
10045 @findex gnus-generate-vertical-tree
10046 The function that actually generates the thread tree. Two predefined
10047 functions are available: @code{gnus-generate-horizontal-tree} and
10048 @code{gnus-generate-vertical-tree} (which is the default).
10052 Here's an example from a horizontal tree buffer:
10055 @{***@}-(***)-[odd]-[Gun]
10065 Here's the same thread displayed in a vertical tree buffer:
10070 |--------------------------\-----\-----\
10071 (***) [Bjo] [Gun] [Gun]
10073 [odd] [Jan] [odd] (***) [Jor]
10075 [Gun] [Eri] [Eri] [odd]
10081 If you're using horizontal trees, it might be nice to display the trees
10082 side-by-side with the summary buffer. You could add something like the
10083 following to your @file{~/.gnus.el} file:
10086 (setq gnus-use-trees t
10087 gnus-generate-tree-function 'gnus-generate-horizontal-tree
10088 gnus-tree-minimize-window nil)
10089 (gnus-add-configuration
10093 (summary 0.75 point)
10098 @xref{Window Layout}.
10101 @node Mail Group Commands
10102 @section Mail Group Commands
10103 @cindex mail group commands
10105 Some commands only make sense in mail groups. If these commands are
10106 invalid in the current group, they will raise a hell and let you know.
10108 All these commands (except the expiry and edit commands) use the
10109 process/prefix convention (@pxref{Process/Prefix}).
10114 @kindex B e (Summary)
10115 @findex gnus-summary-expire-articles
10116 Run all expirable articles in the current group through the expiry
10117 process (@code{gnus-summary-expire-articles}). That is, delete all
10118 expirable articles in the group that have been around for a while.
10119 (@pxref{Expiring Mail}).
10122 @kindex B C-M-e (Summary)
10123 @findex gnus-summary-expire-articles-now
10124 Delete all the expirable articles in the group
10125 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
10126 articles eligible for expiry in the current group will
10127 disappear forever into that big @file{/dev/null} in the sky.
10130 @kindex B DEL (Summary)
10131 @findex gnus-summary-delete-article
10132 @c @icon{gnus-summary-mail-delete}
10133 Delete the mail article. This is ``delete'' as in ``delete it from your
10134 disk forever and ever, never to return again.'' Use with caution.
10135 (@code{gnus-summary-delete-article}).
10138 @kindex B m (Summary)
10140 @findex gnus-summary-move-article
10141 @vindex gnus-preserve-marks
10142 Move the article from one mail group to another
10143 (@code{gnus-summary-move-article}). Marks will be preserved if
10144 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10147 @kindex B c (Summary)
10149 @findex gnus-summary-copy-article
10150 @c @icon{gnus-summary-mail-copy}
10151 Copy the article from one group (mail group or not) to a mail group
10152 (@code{gnus-summary-copy-article}). Marks will be preserved if
10153 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10156 @kindex B B (Summary)
10157 @cindex crosspost mail
10158 @findex gnus-summary-crosspost-article
10159 Crosspost the current article to some other group
10160 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10161 the article in the other group, and the Xref headers of the article will
10162 be properly updated.
10165 @kindex B i (Summary)
10166 @findex gnus-summary-import-article
10167 Import an arbitrary file into the current mail newsgroup
10168 (@code{gnus-summary-import-article}). You will be prompted for a file
10169 name, a @code{From} header and a @code{Subject} header.
10172 @kindex B I (Summary)
10173 @findex gnus-summary-create-article
10174 Create an empty article in the current mail newsgroups
10175 (@code{gnus-summary-create-article}). You will be prompted for a
10176 @code{From} header and a @code{Subject} header.
10179 @kindex B r (Summary)
10180 @findex gnus-summary-respool-article
10181 @vindex gnus-summary-respool-default-method
10182 Respool the mail article (@code{gnus-summary-respool-article}).
10183 @code{gnus-summary-respool-default-method} will be used as the default
10184 select method when respooling. This variable is @code{nil} by default,
10185 which means that the current group select method will be used instead.
10186 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10187 (which is the default).
10191 @kindex B w (Summary)
10192 @kindex e (Summary)
10193 @findex gnus-summary-edit-article
10194 @kindex C-c C-c (Article)
10195 @findex gnus-summary-edit-article-done
10196 Edit the current article (@code{gnus-summary-edit-article}). To finish
10197 editing and make the changes permanent, type @kbd{C-c C-c}
10198 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10199 @kbd{C-c C-c} command, gnus won't re-highlight the article.
10202 @kindex B q (Summary)
10203 @findex gnus-summary-respool-query
10204 If you want to re-spool an article, you might be curious as to what group
10205 the article will end up in before you do the re-spooling. This command
10206 will tell you (@code{gnus-summary-respool-query}).
10209 @kindex B t (Summary)
10210 @findex gnus-summary-respool-trace
10211 Similarly, this command will display all fancy splitting patterns used
10212 when respooling, if any (@code{gnus-summary-respool-trace}).
10215 @kindex B p (Summary)
10216 @findex gnus-summary-article-posted-p
10217 Some people have a tendency to send you ``courtesy'' copies when they
10218 follow up to articles you have posted. These usually have a
10219 @code{Newsgroups} header in them, but not always. This command
10220 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10221 article from your news server (or rather, from
10222 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10223 report back whether it found the article or not. Even if it says that
10224 it didn't find the article, it may have been posted anyway---mail
10225 propagation is much faster than news propagation, and the news copy may
10226 just not have arrived yet.
10229 @kindex K E (Summary)
10230 @findex gnus-article-encrypt-body
10231 @vindex gnus-article-encrypt-protocol
10232 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10233 The body is encrypted with the encryption protocol specified by the
10234 variable @code{gnus-article-encrypt-protocol}.
10238 @vindex gnus-move-split-methods
10239 @cindex moving articles
10240 If you move (or copy) articles regularly, you might wish to have gnus
10241 suggest where to put the articles. @code{gnus-move-split-methods} is a
10242 variable that uses the same syntax as @code{gnus-split-methods}
10243 (@pxref{Saving Articles}). You may customize that variable to create
10244 suggestions you find reasonable. (Note that
10245 @code{gnus-move-split-methods} uses group names where
10246 @code{gnus-split-methods} uses file names.)
10249 (setq gnus-move-split-methods
10250 '(("^From:.*Lars Magne" "nnml:junk")
10251 ("^Subject:.*gnus" "nnfolder:important")
10252 (".*" "nnml:misc")))
10256 @node Various Summary Stuff
10257 @section Various Summary Stuff
10260 * Summary Group Information:: Information oriented commands.
10261 * Searching for Articles:: Multiple article commands.
10262 * Summary Generation Commands::
10263 * Really Various Summary Commands:: Those pesky non-conformant commands.
10267 @vindex gnus-summary-display-while-building
10268 @item gnus-summary-display-while-building
10269 If non-@code{nil}, show and update the summary buffer as it's being
10270 built. If @code{t}, update the buffer after every line is inserted.
10271 If the value is an integer, @var{n}, update the display every @var{n}
10272 lines. The default is @code{nil}.
10274 @vindex gnus-summary-display-arrow
10275 @item gnus-summary-display-arrow
10276 If non-@code{nil}, display an arrow in the fringe to indicate the
10279 @vindex gnus-summary-mode-hook
10280 @item gnus-summary-mode-hook
10281 This hook is called when creating a summary mode buffer.
10283 @vindex gnus-summary-generate-hook
10284 @item gnus-summary-generate-hook
10285 This is called as the last thing before doing the threading and the
10286 generation of the summary buffer. It's quite convenient for customizing
10287 the threading variables based on what data the newsgroup has. This hook
10288 is called from the summary buffer after most summary buffer variables
10291 @vindex gnus-summary-prepare-hook
10292 @item gnus-summary-prepare-hook
10293 It is called after the summary buffer has been generated. You might use
10294 it to, for instance, highlight lines or modify the look of the buffer in
10295 some other ungodly manner. I don't care.
10297 @vindex gnus-summary-prepared-hook
10298 @item gnus-summary-prepared-hook
10299 A hook called as the very last thing after the summary buffer has been
10302 @vindex gnus-summary-ignore-duplicates
10303 @item gnus-summary-ignore-duplicates
10304 When gnus discovers two articles that have the same @code{Message-ID},
10305 it has to do something drastic. No articles are allowed to have the
10306 same @code{Message-ID}, but this may happen when reading mail from some
10307 sources. Gnus allows you to customize what happens with this variable.
10308 If it is @code{nil} (which is the default), gnus will rename the
10309 @code{Message-ID} (for display purposes only) and display the article as
10310 any other article. If this variable is @code{t}, it won't display the
10311 article---it'll be as if it never existed.
10313 @vindex gnus-alter-articles-to-read-function
10314 @item gnus-alter-articles-to-read-function
10315 This function, which takes two parameters (the group name and the list
10316 of articles to be selected), is called to allow the user to alter the
10317 list of articles to be selected.
10319 For instance, the following function adds the list of cached articles to
10320 the list in one particular group:
10323 (defun my-add-cached-articles (group articles)
10324 (if (string= group "some.group")
10325 (append gnus-newsgroup-cached articles)
10329 @vindex gnus-newsgroup-variables
10330 @item gnus-newsgroup-variables
10331 A list of newsgroup (summary buffer) local variables, or cons of
10332 variables and their default expressions to be evalled (when the default
10333 values are not @code{nil}), that should be made global while the summary
10336 Note: The default expressions will be evaluated (using function
10337 @code{eval}) before assignment to the local variable rather than just
10338 assigned to it. If the default expression is the symbol @code{global},
10339 that symbol will not be evaluated but the global value of the local
10340 variable will be used instead.
10342 These variables can be used to set variables in the group parameters
10343 while still allowing them to affect operations done in other
10344 buffers. For example:
10347 (setq gnus-newsgroup-variables
10348 '(message-use-followup-to
10349 (gnus-visible-headers .
10350 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10353 Also @pxref{Group Parameters}.
10357 @node Summary Group Information
10358 @subsection Summary Group Information
10363 @kindex H f (Summary)
10364 @findex gnus-summary-fetch-faq
10365 @vindex gnus-group-faq-directory
10366 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10367 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10368 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10369 is usually a directory on a remote machine. This variable can also be
10370 a list of directories. In that case, giving a prefix to this command
10371 will allow you to choose between the various sites. @code{ange-ftp}
10372 or @code{efs} will probably be used for fetching the file.
10375 @kindex H d (Summary)
10376 @findex gnus-summary-describe-group
10377 Give a brief description of the current group
10378 (@code{gnus-summary-describe-group}). If given a prefix, force
10379 rereading the description from the server.
10382 @kindex H h (Summary)
10383 @findex gnus-summary-describe-briefly
10384 Give an extremely brief description of the most important summary
10385 keystrokes (@code{gnus-summary-describe-briefly}).
10388 @kindex H i (Summary)
10389 @findex gnus-info-find-node
10390 Go to the gnus info node (@code{gnus-info-find-node}).
10394 @node Searching for Articles
10395 @subsection Searching for Articles
10400 @kindex M-s (Summary)
10401 @findex gnus-summary-search-article-forward
10402 Search through all subsequent (raw) articles for a regexp
10403 (@code{gnus-summary-search-article-forward}).
10406 @kindex M-r (Summary)
10407 @findex gnus-summary-search-article-backward
10408 Search through all previous (raw) articles for a regexp
10409 (@code{gnus-summary-search-article-backward}).
10412 @kindex & (Summary)
10413 @findex gnus-summary-execute-command
10414 This command will prompt you for a header, a regular expression to match
10415 on this field, and a command to be executed if the match is made
10416 (@code{gnus-summary-execute-command}). If the header is an empty
10417 string, the match is done on the entire article. If given a prefix,
10418 search backward instead.
10420 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10421 all articles that have heads or bodies that match @samp{some.*string}.
10424 @kindex M-& (Summary)
10425 @findex gnus-summary-universal-argument
10426 Perform any operation on all articles that have been marked with
10427 the process mark (@code{gnus-summary-universal-argument}).
10430 @node Summary Generation Commands
10431 @subsection Summary Generation Commands
10436 @kindex Y g (Summary)
10437 @findex gnus-summary-prepare
10438 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10441 @kindex Y c (Summary)
10442 @findex gnus-summary-insert-cached-articles
10443 Pull all cached articles (for the current group) into the summary buffer
10444 (@code{gnus-summary-insert-cached-articles}).
10447 @kindex Y d (Summary)
10448 @findex gnus-summary-insert-dormant-articles
10449 Pull all dormant articles (for the current group) into the summary buffer
10450 (@code{gnus-summary-insert-dormant-articles}).
10455 @node Really Various Summary Commands
10456 @subsection Really Various Summary Commands
10462 @kindex C-d (Summary)
10463 @kindex A D (Summary)
10464 @findex gnus-summary-enter-digest-group
10465 If the current article is a collection of other articles (for instance,
10466 a digest), you might use this command to enter a group based on the that
10467 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10468 guess what article type is currently displayed unless you give a prefix
10469 to this command, which forces a ``digest'' interpretation. Basically,
10470 whenever you see a message that is a collection of other messages of
10471 some format, you @kbd{C-d} and read these messages in a more convenient
10475 @kindex C-M-d (Summary)
10476 @findex gnus-summary-read-document
10477 This command is very similar to the one above, but lets you gather
10478 several documents into one biiig group
10479 (@code{gnus-summary-read-document}). It does this by opening several
10480 @code{nndoc} groups for each document, and then opening an
10481 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10482 command understands the process/prefix convention
10483 (@pxref{Process/Prefix}).
10486 @kindex C-t (Summary)
10487 @findex gnus-summary-toggle-truncation
10488 Toggle truncation of summary lines
10489 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10490 line centering function in the summary buffer, so it's not a good idea
10491 to have truncation switched off while reading articles.
10494 @kindex = (Summary)
10495 @findex gnus-summary-expand-window
10496 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10497 If given a prefix, force an @code{article} window configuration.
10500 @kindex C-M-e (Summary)
10501 @findex gnus-summary-edit-parameters
10502 Edit the group parameters (@pxref{Group Parameters}) of the current
10503 group (@code{gnus-summary-edit-parameters}).
10506 @kindex C-M-a (Summary)
10507 @findex gnus-summary-customize-parameters
10508 Customize the group parameters (@pxref{Group Parameters}) of the current
10509 group (@code{gnus-summary-customize-parameters}).
10514 @node Exiting the Summary Buffer
10515 @section Exiting the Summary Buffer
10516 @cindex summary exit
10517 @cindex exiting groups
10519 Exiting from the summary buffer will normally update all info on the
10520 group and return you to the group buffer.
10527 @kindex Z Z (Summary)
10528 @kindex Z Q (Summary)
10529 @kindex q (Summary)
10530 @findex gnus-summary-exit
10531 @vindex gnus-summary-exit-hook
10532 @vindex gnus-summary-prepare-exit-hook
10533 @vindex gnus-group-no-more-groups-hook
10534 @c @icon{gnus-summary-exit}
10535 Exit the current group and update all information on the group
10536 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10537 called before doing much of the exiting, which calls
10538 @code{gnus-summary-expire-articles} by default.
10539 @code{gnus-summary-exit-hook} is called after finishing the exit
10540 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10541 group mode having no more (unread) groups.
10545 @kindex Z E (Summary)
10546 @kindex Q (Summary)
10547 @findex gnus-summary-exit-no-update
10548 Exit the current group without updating any information on the group
10549 (@code{gnus-summary-exit-no-update}).
10553 @kindex Z c (Summary)
10554 @kindex c (Summary)
10555 @findex gnus-summary-catchup-and-exit
10556 @c @icon{gnus-summary-catchup-and-exit}
10557 Mark all unticked articles in the group as read and then exit
10558 (@code{gnus-summary-catchup-and-exit}).
10561 @kindex Z C (Summary)
10562 @findex gnus-summary-catchup-all-and-exit
10563 Mark all articles, even the ticked ones, as read and then exit
10564 (@code{gnus-summary-catchup-all-and-exit}).
10567 @kindex Z n (Summary)
10568 @findex gnus-summary-catchup-and-goto-next-group
10569 Mark all articles as read and go to the next group
10570 (@code{gnus-summary-catchup-and-goto-next-group}).
10573 @kindex Z p (Summary)
10574 @findex gnus-summary-catchup-and-goto-prev-group
10575 Mark all articles as read and go to the previous group
10576 (@code{gnus-summary-catchup-and-goto-prev-group}).
10580 @kindex Z R (Summary)
10581 @kindex C-x C-s (Summary)
10582 @findex gnus-summary-reselect-current-group
10583 Exit this group, and then enter it again
10584 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10585 all articles, both read and unread.
10589 @kindex Z G (Summary)
10590 @kindex M-g (Summary)
10591 @findex gnus-summary-rescan-group
10592 @c @icon{gnus-summary-mail-get}
10593 Exit the group, check for new articles in the group, and select the
10594 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10595 articles, both read and unread.
10598 @kindex Z N (Summary)
10599 @findex gnus-summary-next-group
10600 Exit the group and go to the next group
10601 (@code{gnus-summary-next-group}).
10604 @kindex Z P (Summary)
10605 @findex gnus-summary-prev-group
10606 Exit the group and go to the previous group
10607 (@code{gnus-summary-prev-group}).
10610 @kindex Z s (Summary)
10611 @findex gnus-summary-save-newsrc
10612 Save the current number of read/marked articles in the dribble buffer
10613 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10614 given a prefix, also save the @file{.newsrc} file(s). Using this
10615 command will make exit without updating (the @kbd{Q} command) worthless.
10618 @vindex gnus-exit-group-hook
10619 @code{gnus-exit-group-hook} is called when you exit the current group
10620 with an ``updating'' exit. For instance @kbd{Q}
10621 (@code{gnus-summary-exit-no-update}) does not call this hook.
10623 @findex gnus-summary-wake-up-the-dead
10624 @findex gnus-dead-summary-mode
10625 @vindex gnus-kill-summary-on-exit
10626 If you're in the habit of exiting groups, and then changing your mind
10627 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10628 If you do that, gnus won't kill the summary buffer when you exit it.
10629 (Quelle surprise!) Instead it will change the name of the buffer to
10630 something like @samp{*Dead Summary ... *} and install a minor mode
10631 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
10632 buffer, you'll find that all keys are mapped to a function called
10633 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
10634 summary buffer will result in a live, normal summary buffer.
10636 There will never be more than one dead summary buffer at any one time.
10638 @vindex gnus-use-cross-reference
10639 The data on the current group will be updated (which articles you have
10640 read, which articles you have replied to, etc.) when you exit the
10641 summary buffer. If the @code{gnus-use-cross-reference} variable is
10642 @code{t} (which is the default), articles that are cross-referenced to
10643 this group and are marked as read, will also be marked as read in the
10644 other subscribed groups they were cross-posted to. If this variable is
10645 neither @code{nil} nor @code{t}, the article will be marked as read in
10646 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10649 @node Crosspost Handling
10650 @section Crosspost Handling
10654 Marking cross-posted articles as read ensures that you'll never have to
10655 read the same article more than once. Unless, of course, somebody has
10656 posted it to several groups separately. Posting the same article to
10657 several groups (not cross-posting) is called @dfn{spamming}, and you are
10658 by law required to send nasty-grams to anyone who perpetrates such a
10659 heinous crime. You may want to try NoCeM handling to filter out spam
10662 Remember: Cross-posting is kinda ok, but posting the same article
10663 separately to several groups is not. Massive cross-posting (aka.
10664 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10665 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10666 excessive crossposting (@pxref{Summary Mail Commands}).
10668 @cindex cross-posting
10670 @cindex @acronym{NOV}
10671 One thing that may cause Gnus to not do the cross-posting thing
10672 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
10673 (which is very nice, because it speeds things up considerably) which
10674 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
10675 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
10676 even with @sc{xover} by registering the @code{Xref} lines of all
10677 articles you actually read, but if you kill the articles, or just mark
10678 them as read without reading them, Gnus will not get a chance to snoop
10679 the @code{Xref} lines out of these articles, and will be unable to use
10680 the cross reference mechanism.
10682 @cindex LIST overview.fmt
10683 @cindex overview.fmt
10684 To check whether your @acronym{NNTP} server includes the @code{Xref} header
10685 in its overview files, try @samp{telnet your.nntp.server nntp},
10686 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10687 overview.fmt}. This may not work, but if it does, and the last line you
10688 get does not read @samp{Xref:full}, then you should shout and whine at
10689 your news admin until she includes the @code{Xref} header in the
10692 @vindex gnus-nov-is-evil
10693 If you want Gnus to get the @code{Xref}s right all the time, you have to
10694 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10699 For an alternative approach, @pxref{Duplicate Suppression}.
10702 @node Duplicate Suppression
10703 @section Duplicate Suppression
10705 By default, gnus tries to make sure that you don't have to read the same
10706 article more than once by utilizing the crossposting mechanism
10707 (@pxref{Crosspost Handling}). However, that simple and efficient
10708 approach may not work satisfactory for some users for various
10713 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
10714 is evil and not very common.
10717 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
10718 @file{.overview} data bases. This is evil and all too common, alas.
10721 You may be reading the same group (or several related groups) from
10722 different @acronym{NNTP} servers.
10725 You may be getting mail that duplicates articles posted to groups.
10728 I'm sure there are other situations where @code{Xref} handling fails as
10729 well, but these four are the most common situations.
10731 If, and only if, @code{Xref} handling fails for you, then you may
10732 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
10733 will remember the @code{Message-ID}s of all articles you have read or
10734 otherwise marked as read, and then, as if by magic, mark them as read
10735 all subsequent times you see them---in @emph{all} groups. Using this
10736 mechanism is quite likely to be somewhat inefficient, but not overly
10737 so. It's certainly preferable to reading the same articles more than
10740 Duplicate suppression is not a very subtle instrument. It's more like a
10741 sledge hammer than anything else. It works in a very simple
10742 fashion---if you have marked an article as read, it adds this Message-ID
10743 to a cache. The next time it sees this Message-ID, it will mark the
10744 article as read with the @samp{M} mark. It doesn't care what group it
10745 saw the article in.
10748 @item gnus-suppress-duplicates
10749 @vindex gnus-suppress-duplicates
10750 If non-@code{nil}, suppress duplicates.
10752 @item gnus-save-duplicate-list
10753 @vindex gnus-save-duplicate-list
10754 If non-@code{nil}, save the list of duplicates to a file. This will
10755 make startup and shutdown take longer, so the default is @code{nil}.
10756 However, this means that only duplicate articles read in a single gnus
10757 session are suppressed.
10759 @item gnus-duplicate-list-length
10760 @vindex gnus-duplicate-list-length
10761 This variable says how many @code{Message-ID}s to keep in the duplicate
10762 suppression list. The default is 10000.
10764 @item gnus-duplicate-file
10765 @vindex gnus-duplicate-file
10766 The name of the file to store the duplicate suppression list in. The
10767 default is @file{~/News/suppression}.
10770 If you have a tendency to stop and start gnus often, setting
10771 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
10772 you leave gnus running for weeks on end, you may have it @code{nil}. On
10773 the other hand, saving the list makes startup and shutdown much slower,
10774 so that means that if you stop and start gnus often, you should set
10775 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
10776 to you to figure out, I think.
10781 Gnus is able to verify signed messages or decrypt encrypted messages.
10782 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
10783 and @acronym{S/MIME}, however you need some external programs to get
10788 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
10789 install an OpenPGP implementation such as GnuPG. The Lisp interface
10790 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
10791 Manual}), but Mailcrypt and gpg.el are also supported.
10794 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
10795 or newer is recommended.
10799 More information on how to set things up can be found in the message
10800 manual (@pxref{Security, ,Security, message, Message Manual}).
10803 @item mm-verify-option
10804 @vindex mm-verify-option
10805 Option of verifying signed parts. @code{never}, not verify;
10806 @code{always}, always verify; @code{known}, only verify known
10807 protocols. Otherwise, ask user.
10809 @item mm-decrypt-option
10810 @vindex mm-decrypt-option
10811 Option of decrypting encrypted parts. @code{never}, no decryption;
10812 @code{always}, always decrypt; @code{known}, only decrypt known
10813 protocols. Otherwise, ask user.
10816 @vindex mml1991-use
10817 Symbol indicating elisp interface to OpenPGP implementation for
10818 @acronym{PGP} messages. The default is @code{pgg}, but
10819 @code{mailcrypt} and @code{gpg} are also supported although
10823 @vindex mml2015-use
10824 Symbol indicating elisp interface to OpenPGP implementation for
10825 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
10826 @code{mailcrypt} and @code{gpg} are also supported although
10831 @cindex snarfing keys
10832 @cindex importing PGP keys
10833 @cindex PGP key ring import
10834 Snarfing OpenPGP keys (i.e., importing keys from articles into your
10835 key ring) is not supported explicitly through a menu item or command,
10836 rather Gnus do detect and label keys as @samp{application/pgp-keys},
10837 allowing you to specify whatever action you think is appropriate
10838 through the usual @acronym{MIME} infrastructure. You can use a
10839 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
10840 Emacs MIME Manual}) such as the following to import keys using GNU
10841 Privacy Guard when you click on the @acronym{MIME} button
10842 (@pxref{Using MIME}).
10845 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
10848 This happens to also be the default action defined in
10849 @code{mailcap-mime-data}.
10852 @section Mailing List
10853 @cindex mailing list
10856 @kindex A M (summary)
10857 @findex gnus-mailing-list-insinuate
10858 Gnus understands some mailing list fields of RFC 2369. To enable it,
10859 add a @code{to-list} group parameter (@pxref{Group Parameters}),
10860 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10863 That enables the following commands to the summary buffer:
10868 @kindex C-c C-n h (Summary)
10869 @findex gnus-mailing-list-help
10870 Send a message to fetch mailing list help, if List-Help field exists.
10873 @kindex C-c C-n s (Summary)
10874 @findex gnus-mailing-list-subscribe
10875 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10878 @kindex C-c C-n u (Summary)
10879 @findex gnus-mailing-list-unsubscribe
10880 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10884 @kindex C-c C-n p (Summary)
10885 @findex gnus-mailing-list-post
10886 Post to the mailing list, if List-Post field exists.
10889 @kindex C-c C-n o (Summary)
10890 @findex gnus-mailing-list-owner
10891 Send a message to the mailing list owner, if List-Owner field exists.
10894 @kindex C-c C-n a (Summary)
10895 @findex gnus-mailing-list-archive
10896 Browse the mailing list archive, if List-Archive field exists.
10901 @node Article Buffer
10902 @chapter Article Buffer
10903 @cindex article buffer
10905 The articles are displayed in the article buffer, of which there is only
10906 one. All the summary buffers share the same article buffer unless you
10907 tell gnus otherwise.
10910 * Hiding Headers:: Deciding what headers should be displayed.
10911 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
10912 * Customizing Articles:: Tailoring the look of the articles.
10913 * Article Keymap:: Keystrokes available in the article buffer.
10914 * Misc Article:: Other stuff.
10918 @node Hiding Headers
10919 @section Hiding Headers
10920 @cindex hiding headers
10921 @cindex deleting headers
10923 The top section of each article is the @dfn{head}. (The rest is the
10924 @dfn{body}, but you may have guessed that already.)
10926 @vindex gnus-show-all-headers
10927 There is a lot of useful information in the head: the name of the person
10928 who wrote the article, the date it was written and the subject of the
10929 article. That's well and nice, but there's also lots of information
10930 most people do not want to see---what systems the article has passed
10931 through before reaching you, the @code{Message-ID}, the
10932 @code{References}, etc. ad nauseam---and you'll probably want to get rid
10933 of some of those lines. If you want to keep all those lines in the
10934 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10936 Gnus provides you with two variables for sifting headers:
10940 @item gnus-visible-headers
10941 @vindex gnus-visible-headers
10942 If this variable is non-@code{nil}, it should be a regular expression
10943 that says what headers you wish to keep in the article buffer. All
10944 headers that do not match this variable will be hidden.
10946 For instance, if you only want to see the name of the person who wrote
10947 the article and the subject, you'd say:
10950 (setq gnus-visible-headers "^From:\\|^Subject:")
10953 This variable can also be a list of regexps to match headers to
10956 @item gnus-ignored-headers
10957 @vindex gnus-ignored-headers
10958 This variable is the reverse of @code{gnus-visible-headers}. If this
10959 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10960 should be a regular expression that matches all lines that you want to
10961 hide. All lines that do not match this variable will remain visible.
10963 For instance, if you just want to get rid of the @code{References} field
10964 and the @code{Xref} field, you might say:
10967 (setq gnus-ignored-headers "^References:\\|^Xref:")
10970 This variable can also be a list of regexps to match headers to
10973 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10974 variable will have no effect.
10978 @vindex gnus-sorted-header-list
10979 Gnus can also sort the headers for you. (It does this by default.) You
10980 can control the sorting by setting the @code{gnus-sorted-header-list}
10981 variable. It is a list of regular expressions that says in what order
10982 the headers are to be displayed.
10984 For instance, if you want the name of the author of the article first,
10985 and then the subject, you might say something like:
10988 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10991 Any headers that are to remain visible, but are not listed in this
10992 variable, will be displayed in random order after all the headers listed in this variable.
10994 @findex gnus-article-hide-boring-headers
10995 @vindex gnus-boring-article-headers
10996 You can hide further boring headers by setting
10997 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
10998 does depends on the @code{gnus-boring-article-headers} variable. It's a
10999 list, but this list doesn't actually contain header names. Instead it
11000 lists various @dfn{boring conditions} that Gnus can check and remove
11003 These conditions are:
11006 Remove all empty headers.
11008 Remove the @code{Followup-To} header if it is identical to the
11009 @code{Newsgroups} header.
11011 Remove the @code{Reply-To} header if it lists the same addresses as
11012 the @code{From} header, or if the @code{broken-reply-to} group
11015 Remove the @code{Newsgroups} header if it only contains the current group
11018 Remove the @code{To} header if it only contains the address identical to
11019 the current group's @code{to-address} parameter.
11021 Remove the @code{To} header if it only contains the address identical to
11022 the current group's @code{to-list} parameter.
11024 Remove the @code{CC} header if it only contains the address identical to
11025 the current group's @code{to-list} parameter.
11027 Remove the @code{Date} header if the article is less than three days
11030 Remove the @code{To} header if it is very long.
11032 Remove all @code{To} headers if there are more than one.
11035 To include these three elements, you could say something like:
11038 (setq gnus-boring-article-headers
11039 '(empty followup-to reply-to))
11042 This is also the default value for this variable.
11046 @section Using MIME
11047 @cindex @acronym{MIME}
11049 Mime is a standard for waving your hands through the air, aimlessly,
11050 while people stand around yawning.
11052 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
11053 while all newsreaders die of fear.
11055 @acronym{MIME} may specify what character set the article uses, the encoding
11056 of the characters, and it also makes it possible to embed pictures and
11057 other naughty stuff in innocent-looking articles.
11059 @vindex gnus-show-mime
11060 @vindex gnus-article-display-method-for-mime
11061 @findex gnus-article-display-mime-message
11062 gnus handles @acronym{MIME} by pushing the articles through
11063 @code{gnus-article-display-method-for-mime}, which is
11064 @code{gnus-article-display-mime-message} by default. This function
11065 calls the @acronym{SEMI} MIME-View program to actually do the work. For
11066 more information on @acronym{SEMI} MIME-View, see its manual page
11067 (however it is not existed yet, sorry).
11069 Set @code{gnus-show-mime} to @code{t} if you want to use
11070 @acronym{MIME} all the time. If you have @code{gnus-show-mime} set,
11071 then you'll see some unfortunate display glitches in the article buffer.
11072 These can't be avoided.
11074 In GNUS or Gnus, it might be best to just use the toggling functions
11075 from the summary buffer to avoid getting nasty surprises. (For instance,
11076 you enter the group @samp{alt.sing-a-long} and, before you know it,
11077 @acronym{MIME} has decoded the sound file in the article and some
11078 horrible sing-a-long song comes screaming out your speakers, and you
11079 can't find the volume button, because there isn't one, and people are
11080 starting to look at you, and you try to stop the program, but you can't,
11081 and you can't find the program to control the volume, and everybody else
11082 in the room suddenly decides to look at you disdainfully, and you'll
11083 feel rather stupid.)
11085 Any similarity to real events and people is purely coincidental. Ahem.
11087 To avoid such kind of situation, gnus stops to use
11088 @code{metamail-buffer}. So now, you can set @code{gnus-show-mime} to
11089 non-@code{nil} every-time, then you can push button in the article
11090 buffer when there are nobody else.
11092 Also @pxref{MIME Commands}.
11095 @node Customizing Articles
11096 @section Customizing Articles
11097 @cindex article customization
11099 A slew of functions for customizing how the articles are to look like
11100 exist. You can call these functions interactively
11101 (@pxref{Article Washing}), or you can have them
11102 called automatically when you select the articles.
11104 To have them called automatically, you should set the corresponding
11105 ``treatment'' variable. For instance, to have headers hidden, you'd set
11106 @code{gnus-treat-hide-headers}. Below is a list of variables that can
11107 be set, but first we discuss the values these variables can have.
11109 Note: Some values, while valid, make little sense. Check the list below
11110 for sensible values.
11114 @code{nil}: Don't do this treatment.
11117 @code{t}: Do this treatment on all body parts.
11120 @code{head}: Do the treatment on the headers.
11123 @code{first}: Do this treatment on the first body part.
11126 @code{last}: Do this treatment on the last body part.
11129 An integer: Do this treatment on all body parts that have a length less
11133 A list of strings: Do this treatment on all body parts that are in
11134 articles that are read in groups that have names that match one of the
11135 regexps in the list.
11138 A list where the first element is not a string:
11140 The list is evaluated recursively. The first element of the list is a
11141 predicate. The following predicates are recognized: @code{or},
11142 @code{and}, @code{not} and @code{typep}. Here's an example:
11146 (typep "text/x-vcard"))
11150 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
11155 You may have noticed that the word @dfn{part} is used here. This refers
11156 to the fact that some messages are @acronym{MIME} multipart articles that may
11157 be divided into several parts. Articles that are not multiparts are
11158 considered to contain just a single part.
11160 @vindex gnus-article-treat-types
11161 Are the treatments applied to all sorts of multipart parts? Yes, if you
11162 want to, but by default, only @samp{text/plain} parts are given the
11163 treatment. This is controlled by the @code{gnus-article-treat-types}
11164 variable, which is a list of regular expressions that are matched to the
11165 type of the part. This variable is ignored if the value of the
11166 controlling variable is a predicate list, as described above.
11168 The following treatment options are available. The easiest way to
11169 customize this is to examine the @code{gnus-article-treat} customization
11170 group. Values in parenthesis are suggested sensible values. Others are
11171 possible but those listed are probably sufficient for most people.
11174 @item gnus-treat-buttonize (t, integer)
11175 @item gnus-treat-buttonize-head (head)
11177 @xref{Article Buttons}.
11179 @item gnus-treat-capitalize-sentences (t, integer)
11180 @item gnus-treat-overstrike (t, integer)
11181 @item gnus-treat-strip-cr (t, integer)
11182 @item gnus-treat-strip-headers-in-body (t, integer)
11183 @item gnus-treat-strip-leading-blank-lines (t, first, integer)
11184 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11185 @item gnus-treat-strip-pem (t, last, integer)
11186 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11187 @item gnus-treat-unsplit-urls (t, integer)
11188 @item gnus-treat-wash-html (t, integer)
11189 @item gnus-treat-decode-article-as-default-mime-charset (t, integer)
11191 @xref{Article Washing}.
11193 @item gnus-treat-date-english (head)
11194 @item gnus-treat-date-iso8601 (head)
11195 @item gnus-treat-date-lapsed (head)
11196 @item gnus-treat-date-local (head)
11197 @item gnus-treat-date-original (head)
11198 @item gnus-treat-date-user-defined (head)
11199 @item gnus-treat-date-ut (head)
11201 @xref{Article Date}.
11203 @item gnus-treat-from-picon (head)
11204 @item gnus-treat-mail-picon (head)
11205 @item gnus-treat-newsgroups-picon (head)
11209 @item gnus-treat-display-smileys (t, integer)
11211 @item gnus-treat-body-boundary (head)
11213 @vindex gnus-body-boundary-delimiter
11214 Adds a delimiter between header and body, the string used as delimiter
11215 is controlled by @code{gnus-body-boundary-delimiter}.
11219 @item gnus-treat-display-x-face (head)
11223 @item gnus-treat-display-face (head)
11227 @item gnus-treat-emphasize (t, head, integer)
11228 @item gnus-treat-fill-article (t, integer)
11229 @item gnus-treat-fill-long-lines (t, integer)
11230 @item gnus-treat-hide-boring-headers (head)
11231 @item gnus-treat-hide-citation (t, integer)
11232 @item gnus-treat-hide-citation-maybe (t, integer)
11233 @item gnus-treat-hide-headers (head)
11234 @item gnus-treat-hide-signature (t, last)
11235 @item gnus-treat-strip-banner (t, last)
11236 @item gnus-treat-strip-list-identifiers (head)
11238 @xref{Article Hiding}.
11240 @item gnus-treat-highlight-citation (t, integer)
11241 @item gnus-treat-highlight-headers (head)
11242 @item gnus-treat-highlight-signature (t, last, integer)
11244 @xref{Article Highlighting}.
11246 @item gnus-treat-play-sounds
11247 @item gnus-treat-translate
11248 @item gnus-treat-ansi-sequences (t)
11249 @item gnus-treat-x-pgp-sig (head)
11251 @item gnus-treat-unfold-headers (head)
11252 @item gnus-treat-fold-headers (head)
11253 @item gnus-treat-fold-newsgroups (head)
11254 @item gnus-treat-leading-whitespace (head)
11256 @xref{Article Header}.
11261 @vindex gnus-part-display-hook
11262 You can, of course, write your own functions to be called from
11263 @code{gnus-part-display-hook}. The functions are called narrowed to the
11264 part, and you can do anything you like, pretty much. There is no
11265 information that you have to keep in the buffer---you can change
11269 @node Article Keymap
11270 @section Article Keymap
11272 Most of the keystrokes in the summary buffer can also be used in the
11273 article buffer. They should behave as if you typed them in the summary
11274 buffer, which means that you don't actually have to have a summary
11275 buffer displayed while reading. You can do it all from the article
11278 A few additional keystrokes are available:
11283 @kindex SPACE (Article)
11284 @findex gnus-article-next-page
11285 Scroll forwards one page (@code{gnus-article-next-page}).
11286 This is exactly the same as @kbd{h SPACE h}.
11289 @kindex DEL (Article)
11290 @findex gnus-article-prev-page
11291 Scroll backwards one page (@code{gnus-article-prev-page}).
11292 This is exactly the same as @kbd{h DEL h}.
11295 @kindex C-c ^ (Article)
11296 @findex gnus-article-refer-article
11297 If point is in the neighborhood of a @code{Message-ID} and you press
11298 @kbd{C-c ^}, Gnus will try to get that article from the server
11299 (@code{gnus-article-refer-article}).
11302 @kindex C-c C-m (Article)
11303 @findex gnus-article-mail
11304 Send a reply to the address near point (@code{gnus-article-mail}). If
11305 given a prefix, include the mail.
11308 @kindex s (Article)
11309 @findex gnus-article-show-summary
11310 Reconfigure the buffers so that the summary buffer becomes visible
11311 (@code{gnus-article-show-summary}).
11314 @kindex ? (Article)
11315 @findex gnus-article-describe-briefly
11316 Give a very brief description of the available keystrokes
11317 (@code{gnus-article-describe-briefly}).
11320 @kindex TAB (Article)
11321 @findex gnus-article-next-button
11322 Go to the next button, if any (@code{gnus-article-next-button}). This
11323 only makes sense if you have buttonizing turned on.
11326 @kindex M-TAB (Article)
11327 @findex gnus-article-prev-button
11328 Go to the previous button, if any (@code{gnus-article-prev-button}).
11331 @kindex R (Article)
11332 @findex gnus-article-reply-with-original
11333 Send a reply to the current article and yank the current article
11334 (@code{gnus-article-reply-with-original}). If given a prefix, make a
11335 wide reply. If the region is active, only yank the text in the
11339 @kindex F (Article)
11340 @findex gnus-article-followup-with-original
11341 Send a followup to the current article and yank the current article
11342 (@code{gnus-article-followup-with-original}). If given a prefix, make
11343 a wide reply. If the region is active, only yank the text in the
11351 @section Misc Article
11355 @item gnus-single-article-buffer
11356 @vindex gnus-single-article-buffer
11357 If non-@code{nil}, use the same article buffer for all the groups.
11358 (This is the default.) If @code{nil}, each group will have its own
11361 @vindex gnus-article-decode-hook
11362 @item gnus-article-decode-hook
11363 @cindex @acronym{MIME}
11364 Hook used to decode @acronym{MIME} articles. The default value is
11365 @code{(article-decode-charset article-decode-encoded-words)}
11367 @vindex gnus-article-prepare-hook
11368 @item gnus-article-prepare-hook
11369 This hook is called right after the article has been inserted into the
11370 article buffer. It is mainly intended for functions that do something
11371 depending on the contents; it should probably not be used for changing
11372 the contents of the article buffer.
11374 @item gnus-article-mode-hook
11375 @vindex gnus-article-mode-hook
11376 Hook called in article mode buffers.
11378 @item gnus-article-mode-syntax-table
11379 @vindex gnus-article-mode-syntax-table
11380 Syntax table used in article buffers. It is initialized from
11381 @code{text-mode-syntax-table}.
11383 @vindex gnus-article-over-scroll
11384 @item gnus-article-over-scroll
11385 If non-@code{nil}, allow scrolling the article buffer even when there
11386 no more new text to scroll in. The default is @code{nil}.
11388 @vindex gnus-article-mode-line-format
11389 @item gnus-article-mode-line-format
11390 This variable is a format string along the same lines as
11391 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
11392 Line}). It accepts the same format specifications as that variable,
11393 with two extensions:
11398 The @dfn{wash status} of the article. This is a short string with one
11399 character for each possible article wash operation that may have been
11400 performed. The characters and their meaning:
11405 Displayed when cited text may be hidden in the article buffer.
11408 Displayed when headers are hidden in the article buffer.
11411 Displayed when article is digitally signed or encrypted, and Gnus has
11412 hidden the security headers. (N.B. does not tell anything about
11413 security status, i.e. good or bad signature.)
11416 Displayed when the signature has been hidden in the Article buffer.
11419 Displayed when Gnus has treated overstrike characters in the article buffer.
11422 Displayed when Gnus has treated emphasised strings in the article buffer.
11427 The number of @acronym{MIME} parts in the article.
11431 @vindex gnus-break-pages
11433 @item gnus-break-pages
11434 Controls whether @dfn{page breaking} is to take place. If this variable
11435 is non-@code{nil}, the articles will be divided into pages whenever a
11436 page delimiter appears in the article. If this variable is @code{nil},
11437 paging will not be done.
11439 @item gnus-page-delimiter
11440 @vindex gnus-page-delimiter
11441 This is the delimiter mentioned above. By default, it is @samp{^L}
11445 @cindex internationalized domain names
11446 @vindex gnus-use-idna
11447 @item gnus-use-idna
11448 This variable controls whether Gnus performs IDNA decoding of
11449 internationalized domain names inside @samp{From}, @samp{To} and
11450 @samp{Cc} headers. @xref{IDNA, ,IDNA,message, The Message Manual},
11451 for how to compose such messages. This requires
11452 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
11453 variable is only enabled if you have installed it.
11458 @node Composing Messages
11459 @chapter Composing Messages
11460 @cindex composing messages
11463 @cindex sending mail
11468 @cindex using s/mime
11469 @cindex using smime
11471 @kindex C-c C-c (Post)
11472 All commands for posting and mailing will put you in a message buffer
11473 where you can edit the article all you like, before you send the
11474 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
11475 Message Manual}. Where the message will be posted/mailed to depends
11476 on your setup (@pxref{Posting Server}).
11479 * Mail:: Mailing and replying.
11480 * Posting Server:: What server should you post and mail via?
11481 * POP before SMTP:: You cannot send a mail unless you read a mail.
11482 * Mail and Post:: Mailing and posting at the same time.
11483 * Archived Messages:: Where Gnus stores the messages you've sent.
11484 * Posting Styles:: An easier way to specify who you are.
11485 * Drafts:: Postponing messages and rejected messages.
11486 * Rejected Articles:: What happens if the server doesn't like your article?
11487 * Signing and encrypting:: How to compose secure messages.
11490 Also @pxref{Canceling and Superseding} for information on how to
11491 remove articles you shouldn't have posted.
11497 Variables for customizing outgoing mail:
11500 @item gnus-uu-digest-headers
11501 @vindex gnus-uu-digest-headers
11502 List of regexps to match headers included in digested messages. The
11503 headers will be included in the sequence they are matched. If
11504 @code{nil} include all headers.
11506 @item gnus-add-to-list
11507 @vindex gnus-add-to-list
11508 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11509 that have none when you do a @kbd{a}.
11511 @item gnus-confirm-mail-reply-to-news
11512 @vindex gnus-confirm-mail-reply-to-news
11513 If non-@code{nil}, Gnus will ask you for a confirmation when you are
11514 about to reply to news articles by mail. If it is @code{nil}, nothing
11515 interferes in what you want to do. This can also be a function
11516 receiving the group name as the only parameter which should return
11517 non-@code{nil} if a confirmation is needed, or a regular expression
11518 matching group names, where confirmation should be asked for.
11520 If you find yourself never wanting to reply to mail, but occasionally
11521 press R anyway, this variable might be for you.
11523 @item gnus-confirm-treat-mail-like-news
11524 @vindex gnus-confirm-treat-mail-like-news
11525 If non-@code{nil}, Gnus also requests confirmation according to
11526 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
11527 useful for treating mailing lists like newsgroups.
11532 @node Posting Server
11533 @section Posting Server
11535 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11536 (extremely intelligent, of course) article, where does it go?
11538 Thank you for asking. I hate you.
11540 It can be quite complicated.
11542 @vindex gnus-post-method
11543 When posting news, Message usually invokes @code{message-send-news}
11544 (@pxref{News Variables, , News Variables, message, Message Manual}).
11545 Normally, Gnus will post using the same select method as you're
11546 reading from (which might be convenient if you're reading lots of
11547 groups from different private servers). However. If the server
11548 you're reading from doesn't allow posting, just reading, you probably
11549 want to use some other server to post your (extremely intelligent and
11550 fabulously interesting) articles. You can then set the
11551 @code{gnus-post-method} to some other method:
11554 (setq gnus-post-method '(nnspool ""))
11557 Now, if you've done this, and then this server rejects your article, or
11558 this server is down, what do you do then? To override this variable you
11559 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11560 the ``current'' server, to get back the default behavior, for posting.
11562 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11563 gnus will prompt you for what method to use for posting.
11565 You can also set @code{gnus-post-method} to a list of select methods.
11566 If that's the case, gnus will always prompt you for what method to use
11569 Finally, if you want to always post using the native select method,
11570 you can set this variable to @code{native}.
11572 When sending mail, Message invokes @code{message-send-mail-function}.
11573 The default function, @code{message-send-mail-with-sendmail}, pipes
11574 your article to the @code{sendmail} binary for further queuing and
11575 sending. When your local system is not configured for sending mail
11576 using @code{sendmail}, and you have access to a remote @acronym{SMTP}
11577 server, you can set @code{message-send-mail-function} to
11578 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11579 package correctly. An example:
11582 (setq message-send-mail-function 'smtpmail-send-it
11583 smtpmail-default-smtp-server "YOUR SMTP HOST")
11584 ;; @r{The following variable needs to be set if you are using smtpmail.el}
11585 ;; @r{distributed with FLIM, lesser than the version 1.14.6.}
11586 (setq smtp-default-server "YOUR SMTP HOST")
11589 To the thing similar to this, there is
11590 @code{message-smtpmail-send-it}. It is useful if your @acronym{ISP}
11591 requires the @acronym{POP}-before-@acronym{SMTP} authentication.
11592 @xref{POP before SMTP}.
11594 Other possible choices for @code{message-send-mail-function} includes
11595 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11596 and @code{feedmail-send-it}.
11598 @node POP before SMTP
11599 @section POP before SMTP
11600 @cindex pop before smtp
11601 @findex message-smtpmail-send-it
11602 @findex mail-source-touch-pop
11604 Does your @acronym{ISP} require the @acronym{POP}-before-@acronym{SMTP}
11605 authentication? It is whether you need to connect to the @acronym{POP}
11606 mail server within a certain time before sending mails. If so, there is
11607 a convenient way. To do that, put the following lines in your
11608 @file{~/.gnus.el} file:
11611 (setq message-send-mail-function 'message-smtpmail-send-it)
11612 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
11616 It means to let Gnus connect to the @acronym{POP} mail server in advance
11617 whenever you send a mail. The @code{mail-source-touch-pop} function
11618 does only a @acronym{POP} authentication according to the value of
11619 @code{mail-sources} without fetching mails, just before sending a mail.
11620 Note that you have to use @code{message-smtpmail-send-it} which runs
11621 @code{message-send-mail-hook} rather than @code{smtpmail-send-it} and
11622 set the value of @code{mail-sources} for a @acronym{POP} connection
11623 correctly. @xref{Mail Sources}.
11625 If you have two or more @acronym{POP} mail servers set in
11626 @code{mail-sources}, you may want to specify one of them to
11627 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
11628 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
11629 is your primary @acronym{POP} mail server (i.e., you are fetching mails
11630 mainly from that server), you can set it permanently as follows:
11633 (setq mail-source-primary-source
11634 '(pop :server "pop3.mail.server"
11635 :password "secret"))
11639 Otherwise, bind it dynamically only when performing the
11640 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
11643 (add-hook 'message-send-mail-hook
11645 (let ((mail-source-primary-source
11646 '(pop :server "pop3.mail.server"
11647 :password "secret")))
11648 (mail-source-touch-pop))))
11651 @node Mail and Post
11652 @section Mail and Post
11654 Here's a list of variables relevant to both mailing and
11658 @item gnus-mailing-list-groups
11659 @findex gnus-mailing-list-groups
11660 @cindex mailing lists
11662 If your news server offers groups that are really mailing lists
11663 gatewayed to the @acronym{NNTP} server, you can read those groups without
11664 problems, but you can't post/followup to them without some difficulty.
11665 One solution is to add a @code{to-address} to the group parameters
11666 (@pxref{Group Parameters}). An easier thing to do is set the
11667 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
11668 really are mailing lists. Then, at least, followups to the mailing
11669 lists will work most of the time. Posting to these groups (@kbd{a}) is
11670 still a pain, though.
11672 @item gnus-user-agent
11673 @vindex gnus-user-agent
11676 This variable controls which information should be exposed in the
11677 User-Agent header. It can be one of the symbols @code{gnus} (show only
11678 Gnus version), @code{emacs-gnus} (show only Emacs and Gnus versions),
11679 @code{emacs-gnus-config} (same as @code{emacs-gnus} plus system
11680 configuration), @code{emacs-gnus-type} (same as @code{emacs-gnus} plus
11681 system type) or a custom string. If you set it to a string, be sure to
11682 use a valid format, see RFC 2616.
11686 You may want to do spell-checking on messages that you send out. Or, if
11687 you don't want to spell-check by hand, you could add automatic
11688 spell-checking via the @code{ispell} package:
11691 @findex ispell-message
11693 (add-hook 'message-send-hook 'ispell-message)
11696 If you want to change the @code{ispell} dictionary based on what group
11697 you're in, you could say something like the following:
11700 (add-hook 'gnus-select-group-hook
11704 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
11705 (ispell-change-dictionary "deutsch"))
11707 (ispell-change-dictionary "english")))))
11710 Modify to suit your needs.
11713 @node Archived Messages
11714 @section Archived Messages
11715 @cindex archived messages
11716 @cindex sent messages
11718 Gnus provides a few different methods for storing the mail and news you
11719 send. The default method is to use the @dfn{archive virtual server} to
11720 store the messages. If you want to disable this completely, the
11721 @code{gnus-message-archive-group} variable should be @code{nil}, which
11724 For archiving interesting messages in a group you read, see the
11725 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
11728 @vindex gnus-message-archive-method
11729 @code{gnus-message-archive-method} says what virtual server gnus is to
11730 use to store sent messages. The default is:
11733 (nnfolder "archive"
11734 (nnfolder-directory "~/Mail/archive")
11735 (nnfolder-active-file "~/Mail/archive/active")
11736 (nnfolder-get-new-mail nil)
11737 (nnfolder-inhibit-expiry t))
11740 You can, however, use any mail select method (@code{nnml},
11741 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
11742 for doing this sort of thing, though. If you don't like the default
11743 directory chosen, you could say something like:
11746 (setq gnus-message-archive-method
11747 '(nnfolder "archive"
11748 (nnfolder-inhibit-expiry t)
11749 (nnfolder-active-file "~/News/sent-mail/active")
11750 (nnfolder-directory "~/News/sent-mail/")))
11753 @vindex gnus-message-archive-group
11755 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11756 to one or more group(s) on that server. Which group to use is
11757 determined by the @code{gnus-message-archive-group} variable.
11759 This variable can be used to do the following:
11763 Messages will be saved in that group.
11765 Note that you can include a select method in the group name, then the
11766 message will not be stored in the select method given by
11767 @code{gnus-message-archive-method}, but in the select method specified
11768 by the group name, instead. Suppose @code{gnus-message-archive-method}
11769 has the default value shown above. Then setting
11770 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11771 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11772 value @code{"nnml:foo"}, then outgoing messages will be stored in
11775 @item a list of strings
11776 Messages will be saved in all those groups.
11778 @item an alist of regexps, functions and forms
11779 When a key ``matches'', the result is used.
11782 No message archiving will take place. This is the default.
11787 Just saving to a single group called @samp{MisK}:
11789 (setq gnus-message-archive-group "MisK")
11792 Saving to two groups, @samp{MisK} and @samp{safe}:
11794 (setq gnus-message-archive-group '("MisK" "safe"))
11797 Save to different groups based on what group you are in:
11799 (setq gnus-message-archive-group
11800 '(("^alt" "sent-to-alt")
11801 ("mail" "sent-to-mail")
11802 (".*" "sent-to-misc")))
11805 More complex stuff:
11807 (setq gnus-message-archive-group
11808 '((if (message-news-p)
11813 How about storing all news messages in one file, but storing all mail
11814 messages in one file per month:
11817 (setq gnus-message-archive-group
11818 '((if (message-news-p)
11820 (concat "mail." (format-time-string "%Y-%m")))))
11823 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11824 @c use a different value for @code{gnus-message-archive-group} there.)
11826 Now, when you send a message off, it will be stored in the appropriate
11827 group. (If you want to disable storing for just one particular message,
11828 you can just remove the @code{Gcc} header that has been inserted.) The
11829 archive group will appear in the group buffer the next time you start
11830 gnus, or the next time you press @kbd{F} in the group buffer. You can
11831 enter it and read the articles in it just like you'd read any other
11832 group. If the group gets really big and annoying, you can simply rename
11833 if (using @kbd{G r} in the group buffer) to something
11834 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
11835 continue to be stored in the old (now empty) group.
11837 That's the default method of archiving sent messages. Gnus offers a
11838 different way for the people who don't like the default method. In that
11839 case you should set @code{gnus-message-archive-group} to @code{nil};
11840 this will disable archiving.
11843 @item gnus-outgoing-message-group
11844 @vindex gnus-outgoing-message-group
11845 All outgoing messages will be put in this group. If you want to store
11846 all your outgoing mail and articles in the group @samp{nnml:archive},
11847 you set this variable to that value. This variable can also be a list of
11850 If you want to have greater control over what group to put each
11851 message in, you can set this variable to a function that checks the
11852 current newsgroup name and then returns a suitable group name (or list
11855 This variable can be used instead of @code{gnus-message-archive-group},
11856 but the latter is the preferred method.
11858 @item gnus-gcc-mark-as-read
11859 @vindex gnus-gcc-mark-as-read
11860 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11862 @item gnus-gcc-externalize-attachments
11863 @vindex gnus-gcc-externalize-attachments
11864 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11865 and matches the Gcc group name, attach files as external parts; if it is
11866 @code{all}, attach local files as external parts; if it is other
11867 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11868 changed in the future.
11873 @node Posting Styles
11874 @section Posting Styles
11875 @cindex posting styles
11878 All them variables, they make my head swim.
11880 So what if you want a different @code{Organization} and signature based
11881 on what groups you post to? And you post both from your home machine
11882 and your work machine, and you want different @code{From} lines, and so
11885 @vindex gnus-posting-styles
11886 One way to do stuff like that is to write clever hooks that change the
11887 variables you need to have changed. That's a bit boring, so somebody
11888 came up with the bright idea of letting the user specify these things in
11889 a handy alist. Here's an example of a @code{gnus-posting-styles}
11894 (signature "Peace and happiness")
11895 (organization "What me?"))
11897 (signature "Death to everybody"))
11898 ("comp.emacs.i-love-it"
11899 (organization "Emacs is it")))
11902 As you might surmise from this example, this alist consists of several
11903 @dfn{styles}. Each style will be applicable if the first element
11904 ``matches'', in some form or other. The entire alist will be iterated
11905 over, from the beginning towards the end, and each match will be
11906 applied, which means that attributes in later styles that match override
11907 the same attributes in earlier matching styles. So
11908 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11909 signature and the @samp{What me?} @code{Organization} header.
11911 The first element in each style is called the @code{match}. If it's a
11912 string, then Gnus will try to regexp match it against the group name.
11913 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
11914 will look in the original article for a header whose name is
11915 @var{match} and compare that @var{regexp}. @var{match} and
11916 @var{regexp} are strings. (The original article is the one you are
11917 replying or following up to. If you are not composing a reply or a
11918 followup, then there is nothing to match against.) If the
11919 @code{match} is a function symbol, that function will be called with
11920 no arguments. If it's a variable symbol, then the variable will be
11921 referenced. If it's a list, then that list will be @code{eval}ed. In
11922 any case, if this returns a non-@code{nil} value, then the style is
11923 said to @dfn{match}.
11925 Each style may contain an arbitrary amount of @dfn{attributes}. Each
11926 attribute consists of a @code{(@var{name} @var{value})} pair. In
11927 addition, you can also use the @code{(@var{name} :file @var{value})}
11928 form or the @code{(@var{name} :value @var{value})} form. Where
11929 @code{:file} signifies @var{value} represents a file name and its
11930 contents should be used as the attribute value, @code{:value} signifies
11931 @var{value} does not represent a file name explicitly. The attribute
11932 name can be one of:
11935 @item @code{signature}
11936 @item @code{signature-file}
11937 @item @code{x-face-file}
11938 @item @code{address}, overriding @code{user-mail-address}
11939 @item @code{name}, overriding @code{(user-full-name)}
11943 The attribute name can also be a string or a symbol. In that case,
11944 this will be used as a header name, and the value will be inserted in
11945 the headers of the article; if the value is @code{nil}, the header
11946 name will be removed. If the attribute name is @code{eval}, the form
11947 is evaluated, and the result is thrown away.
11949 The attribute value can be a string (used verbatim), a function with
11950 zero arguments (the return value will be used), a variable (its value
11951 will be used) or a list (it will be @code{eval}ed and the return value
11952 will be used). The functions and sexps are called/@code{eval}ed in the
11953 message buffer that is being set up. The headers of the current article
11954 are available through the @code{message-reply-headers} variable, which
11955 is a vector of the following headers: number subject from date id
11956 references chars lines xref extra.
11958 @vindex message-reply-headers
11960 If you wish to check whether the message you are about to compose is
11961 meant to be a news article or a mail message, you can check the values
11962 of the @code{message-news-p} and @code{message-mail-p} functions.
11964 @findex message-mail-p
11965 @findex message-news-p
11967 So here's a new example:
11970 (setq gnus-posting-styles
11972 (signature-file "~/.signature")
11974 (x-face-file "~/.xface")
11975 (x-url (getenv "WWW_HOME"))
11976 (organization "People's Front Against MWM"))
11978 (signature my-funny-signature-randomizer))
11979 ((equal (system-name) "gnarly") ;; @r{A form}
11980 (signature my-quote-randomizer))
11981 (message-news-p ;; @r{A function symbol}
11982 (signature my-news-signature))
11983 (window-system ;; @r{A value symbol}
11984 ("X-Window-System" (format "%s" window-system)))
11985 ;; @r{If I'm replying to Larsi, set the Organization header.}
11986 ((header "from" "larsi.*org")
11987 (Organization "Somewhere, Inc."))
11988 ((posting-from-work-p) ;; @r{A user defined function}
11989 (signature-file "~/.work-signature")
11990 (address "user@@bar.foo")
11991 (body "You are fired.\n\nSincerely, your boss.")
11992 (organization "Important Work, Inc"))
11994 (From (save-excursion
11995 (set-buffer gnus-article-buffer)
11996 (message-fetch-field "to"))))
11998 (signature-file "~/.mail-signature"))))
12001 The @samp{nnml:.*} rule means that you use the @code{To} address as the
12002 @code{From} address in all your outgoing replies, which might be handy
12003 if you fill many roles.
12005 Setting the @code{gnus-named-posting-styles} variable will make
12006 posting-styles allow to have distinctive names. You can specify an
12007 arbitrary posting-style when article posting with @kbd{S P} in the
12008 summary buffer. @code{gnus-named-posting-styles} is an alist which maps
12009 the names to styles. Once a posting-style is added to the alist, we can
12010 import it from @code{gnus-posting-styles}. If an attribute whose name
12011 is @code{import} is found, Gnus will look for the attribute value in
12012 @code{gnus-named-posting-styles} and expand it in place.
12017 (setq gnus-named-posting-styles
12019 (signature-file "~/.signature")
12021 ("X-Home-Page" (getenv "WWW_HOME"))
12022 (organization "People's Front Against MWM"))
12025 (organization "The Church of Emacs"))))
12028 The posting-style named "Emacs" will inherit all the attributes from
12029 "Default" except @code{organization}.
12036 If you are writing a message (mail or news) and suddenly remember that
12037 you have a steak in the oven (or some pesto in the food processor, you
12038 craaazy vegetarians), you'll probably wish there was a method to save
12039 the message you are writing so that you can continue editing it some
12040 other day, and send it when you feel its finished.
12042 Well, don't worry about it. Whenever you start composing a message of
12043 some sort using the gnus mail and post commands, the buffer you get will
12044 automatically associate to an article in a special @dfn{draft} group.
12045 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
12046 article will be saved there. (Auto-save files also go to the draft
12050 @vindex nndraft-directory
12051 The draft group is a special group (which is implemented as an
12052 @code{nndraft} group, if you absolutely have to know) called
12053 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
12054 @code{nndraft} is to store its files. What makes this group special is
12055 that you can't tick any articles in it or mark any articles as
12056 read---all articles in the group are permanently unread.
12058 If the group doesn't exist, it will be created and you'll be subscribed
12059 to it. The only way to make it disappear from the Group buffer is to
12060 unsubscribe it. The special properties of the draft group comes from
12061 a group property (@pxref{Group Parameters}), and if lost the group
12062 behaves like any other group. This means the commands below will not
12063 be available. To restore the special properties of the group, the
12064 simplest way is to kill the group, using @kbd{C-k}, and restart
12065 Gnus. The group is automatically created again with the
12066 correct parameters. The content of the group is not lost.
12068 @c @findex gnus-dissociate-buffer-from-draft
12069 @c @kindex C-c M-d (Mail)
12070 @c @kindex C-c M-d (Post)
12071 @c @findex gnus-associate-buffer-with-draft
12072 @c @kindex C-c C-d (Mail)
12073 @c @kindex C-c C-d (Post)
12074 @c If you're writing some super-secret message that you later want to
12075 @c encode with PGP before sending, you may wish to turn the auto-saving
12076 @c (and association with the draft group) off. You never know who might be
12077 @c interested in reading all your extremely valuable and terribly horrible
12078 @c and interesting secrets. The @kbd{C-c M-d}
12079 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
12080 @c If you change your mind and want to turn the auto-saving back on again,
12081 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
12083 @c @vindex gnus-use-draft
12084 @c To leave association with the draft group off by default, set
12085 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
12087 @findex gnus-draft-edit-message
12088 @kindex D e (Draft)
12089 When you want to continue editing the article, you simply enter the
12090 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
12091 that. You will be placed in a buffer where you left off.
12093 Rejected articles will also be put in this draft group (@pxref{Rejected
12096 @findex gnus-draft-send-all-messages
12097 @kindex D s (Draft)
12098 @findex gnus-draft-send-message
12099 @kindex D S (Draft)
12100 If you have lots of rejected messages you want to post (or mail) without
12101 doing further editing, you can use the @kbd{D s} command
12102 (@code{gnus-draft-send-message}). This command understands the
12103 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
12104 command (@code{gnus-draft-send-all-messages}) will ship off all messages
12107 @findex gnus-draft-toggle-sending
12108 @kindex D t (Draft)
12109 If you have some messages that you wish not to send, you can use the
12110 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
12111 as unsendable. This is a toggling command.
12114 @node Rejected Articles
12115 @section Rejected Articles
12116 @cindex rejected articles
12118 Sometimes a news server will reject an article. Perhaps the server
12119 doesn't like your face. Perhaps it just feels miserable. Perhaps
12120 @emph{there be demons}. Perhaps you have included too much cited text.
12121 Perhaps the disk is full. Perhaps the server is down.
12123 These situations are, of course, totally beyond the control of gnus.
12124 (Gnus, of course, loves the way you look, always feels great, has angels
12125 fluttering around inside of it, doesn't care about how much cited text
12126 you include, never runs full and never goes down.) So gnus saves these
12127 articles until some later time when the server feels better.
12129 The rejected articles will automatically be put in a special draft group
12130 (@pxref{Drafts}). When the server comes back up again, you'd then
12131 typically enter that group and send all the articles off.
12133 @node Signing and encrypting
12134 @section Signing and encrypting
12136 @cindex using s/mime
12137 @cindex using smime
12139 Gnus can digitally sign and encrypt your messages, using vanilla
12140 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
12141 decoding such messages, see the @code{mm-verify-option} and
12142 @code{mm-decrypt-option} options (@pxref{Security}).
12144 @vindex gnus-message-replysign
12145 @vindex gnus-message-replyencrypt
12146 @vindex gnus-message-replysignencrypted
12147 Often, you would like to sign replies to people who send you signed
12148 messages. Even more often, you might want to encrypt messages which
12149 are in reply to encrypted messages. Gnus offers
12150 @code{gnus-message-replysign} to enable the former, and
12151 @code{gnus-message-replyencrypt} for the latter. In addition, setting
12152 @code{gnus-message-replysignencrypted} (on by default) will sign
12153 automatically encrypted messages.
12155 Instructing @acronym{MML} to perform security operations on a
12156 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
12157 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
12162 @kindex C-c C-m s s (Message)
12163 @findex mml-secure-message-sign-smime
12165 Digitally sign current message using @acronym{S/MIME}.
12168 @kindex C-c C-m s o (Message)
12169 @findex mml-secure-message-sign-pgp
12171 Digitally sign current message using @acronym{PGP}.
12174 @kindex C-c C-m s p (Message)
12175 @findex mml-secure-message-sign-pgp
12177 Digitally sign current message using @acronym{PGP/MIME}.
12180 @kindex C-c C-m c s (Message)
12181 @findex mml-secure-message-encrypt-smime
12183 Digitally encrypt current message using @acronym{S/MIME}.
12186 @kindex C-c C-m c o (Message)
12187 @findex mml-secure-message-encrypt-pgp
12189 Digitally encrypt current message using @acronym{PGP}.
12192 @kindex C-c C-m c p (Message)
12193 @findex mml-secure-message-encrypt-pgpmime
12195 Digitally encrypt current message using @acronym{PGP/MIME}.
12198 @kindex C-c C-m C-n (Message)
12199 @findex mml-unsecure-message
12200 Remove security related @acronym{MML} tags from message.
12204 @xref{Security, ,Security, message, Message Manual}, for more information.
12206 @node Select Methods
12207 @chapter Select Methods
12208 @cindex foreign groups
12209 @cindex select methods
12211 A @dfn{foreign group} is a group not read by the usual (or
12212 default) means. It could be, for instance, a group from a different
12213 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12214 personal mail group.
12216 A foreign group (or any group, really) is specified by a @dfn{name} and
12217 a @dfn{select method}. To take the latter first, a select method is a
12218 list where the first element says what back end to use (e.g. @code{nntp},
12219 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12220 name}. There may be additional elements in the select method, where the
12221 value may have special meaning for the back end in question.
12223 One could say that a select method defines a @dfn{virtual server}---so
12224 we do just that (@pxref{Server Buffer}).
12226 The @dfn{name} of the group is the name the back end will recognize the
12229 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12230 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12231 method @code{(nntp "some.where.edu")}. Gnus will call this group
12232 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12233 back end just knows this group as @samp{soc.motss}.
12235 The different methods all have their peculiarities, of course.
12238 * Server Buffer:: Making and editing virtual servers.
12239 * Getting News:: Reading USENET news with Gnus.
12240 * Getting Mail:: Reading your personal mail with Gnus.
12241 * Browsing the Web:: Getting messages from a plethora of Web sources.
12242 * IMAP:: Using Gnus as a @acronym{IMAP} client.
12243 * Other Sources:: Reading directories, files, SOUP packets.
12244 * Combined Groups:: Combining groups into one group.
12245 * Email Based Diary:: Using mails to manage diary events in Gnus.
12246 * Gnus Unplugged:: Reading news and mail offline.
12250 @node Server Buffer
12251 @section Server Buffer
12253 Traditionally, a @dfn{server} is a machine or a piece of software that
12254 one connects to, and then requests information from. Gnus does not
12255 connect directly to any real servers, but does all transactions through
12256 one back end or other. But that's just putting one layer more between
12257 the actual media and Gnus, so we might just as well say that each
12258 back end represents a virtual server.
12260 For instance, the @code{nntp} back end may be used to connect to several
12261 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12262 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12263 use, and what parameters to set by specifying a @dfn{select method}.
12265 These select method specifications can sometimes become quite
12266 complicated---say, for instance, that you want to read from the
12267 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12268 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12269 Anyway, if you had to specify that for each group that used this
12270 server, that would be too much work, so Gnus offers a way of naming
12271 select methods, which is what you do in the server buffer.
12273 To enter the server buffer, use the @kbd{^}
12274 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12277 * Server Buffer Format:: You can customize the look of this buffer.
12278 * Server Commands:: Commands to manipulate servers.
12279 * Example Methods:: Examples server specifications.
12280 * Creating a Virtual Server:: An example session.
12281 * Server Variables:: Which variables to set.
12282 * Servers and Methods:: You can use server names as select methods.
12283 * Unavailable Servers:: Some servers you try to contact may be down.
12286 @vindex gnus-server-mode-hook
12287 @code{gnus-server-mode-hook} is run when creating the server buffer.
12290 @node Server Buffer Format
12291 @subsection Server Buffer Format
12292 @cindex server buffer format
12294 @vindex gnus-server-line-format
12295 You can change the look of the server buffer lines by changing the
12296 @code{gnus-server-line-format} variable. This is a @code{format}-like
12297 variable, with some simple extensions:
12302 How the news is fetched---the back end name.
12305 The name of this server.
12308 Where the news is to be fetched from---the address.
12311 The opened/closed/denied status of the server.
12314 Whether this server is agentized.
12317 @vindex gnus-server-mode-line-format
12318 The mode line can also be customized by using the
12319 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12320 Formatting}). The following specs are understood:
12330 Also @pxref{Formatting Variables}.
12333 @node Server Commands
12334 @subsection Server Commands
12335 @cindex server commands
12341 @findex gnus-server-add-server
12342 Add a new server (@code{gnus-server-add-server}).
12346 @findex gnus-server-edit-server
12347 Edit a server (@code{gnus-server-edit-server}).
12350 @kindex SPACE (Server)
12351 @findex gnus-server-read-server
12352 Browse the current server (@code{gnus-server-read-server}).
12356 @findex gnus-server-exit
12357 Return to the group buffer (@code{gnus-server-exit}).
12361 @findex gnus-server-kill-server
12362 Kill the current server (@code{gnus-server-kill-server}).
12366 @findex gnus-server-yank-server
12367 Yank the previously killed server (@code{gnus-server-yank-server}).
12371 @findex gnus-server-copy-server
12372 Copy the current server (@code{gnus-server-copy-server}).
12376 @findex gnus-server-list-servers
12377 List all servers (@code{gnus-server-list-servers}).
12381 @findex gnus-server-scan-server
12382 Request that the server scan its sources for new articles
12383 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12388 @findex gnus-server-regenerate-server
12389 Request that the server regenerate all its data structures
12390 (@code{gnus-server-regenerate-server}). This can be useful if you have
12391 a mail back end that has gotten out of sync.
12396 @node Example Methods
12397 @subsection Example Methods
12399 Most select methods are pretty simple and self-explanatory:
12402 (nntp "news.funet.fi")
12405 Reading directly from the spool is even simpler:
12411 As you can see, the first element in a select method is the name of the
12412 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12415 After these two elements, there may be an arbitrary number of
12416 @code{(@var{variable} @var{form})} pairs.
12418 To go back to the first example---imagine that you want to read from
12419 port 15 on that machine. This is what the select method should
12423 (nntp "news.funet.fi" (nntp-port-number 15))
12426 You should read the documentation to each back end to find out what
12427 variables are relevant, but here's an @code{nnmh} example:
12429 @code{nnmh} is a mail back end that reads a spool-like structure. Say
12430 you have two structures that you wish to access: One is your private
12431 mail spool, and the other is a public one. Here's the possible spec for
12435 (nnmh "private" (nnmh-directory "~/private/mail/"))
12438 (This server is then called @samp{private}, but you may have guessed
12441 Here's the method for a public spool:
12445 (nnmh-directory "/usr/information/spool/")
12446 (nnmh-get-new-mail nil))
12452 If you are behind a firewall and only have access to the @acronym{NNTP}
12453 server from the firewall machine, you can instruct Gnus to @code{rlogin}
12454 on the firewall machine and telnet from there to the @acronym{NNTP} server.
12455 Doing this can be rather fiddly, but your virtual server definition
12456 should probably look something like this:
12460 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
12461 (nntp-via-address "the.firewall.machine")
12462 (nntp-address "the.real.nntp.host")
12463 (nntp-end-of-line "\n"))
12466 If you want to use the wonderful @code{ssh} program to provide a
12467 compressed connection over the modem line, you could add the following
12468 configuration to the example above:
12471 (nntp-via-rlogin-command "ssh")
12474 See also @code{nntp-via-rlogin-command-switches}. Here's an example for
12475 an indirect connection:
12477 (setq gnus-select-method
12479 (nntp-address "news.server.example")
12480 (nntp-via-user-name "intermediate_user_name")
12481 (nntp-via-address "intermediate.host.example")
12482 (nntp-via-rlogin-command "ssh")
12483 (nntp-end-of-line "\n")
12484 (nntp-via-rlogin-command-switches ("-C" "-t" "-e" "none"))
12485 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)))
12488 If you're behind a firewall, but have direct access to the outside world
12489 through a wrapper command like "runsocks", you could open a socksified
12490 telnet connection to the news server as follows:
12494 (nntp-pre-command "runsocks")
12495 (nntp-open-connection-function nntp-open-via-telnet)
12496 (nntp-address "the.news.server")
12497 (nntp-end-of-line "\n"))
12500 This means that you have to have set up @code{ssh-agent} correctly to
12501 provide automatic authorization, of course. And to get a compressed
12502 connection, you have to have the @samp{Compression} option in the
12503 @code{ssh} @file{config} file.
12506 @node Creating a Virtual Server
12507 @subsection Creating a Virtual Server
12509 If you're saving lots of articles in the cache by using persistent
12510 articles, you may want to create a virtual server to read the cache.
12512 First you need to add a new server. The @kbd{a} command does that. It
12513 would probably be best to use @code{nnml} to read the cache. You
12514 could also use @code{nnspool} or @code{nnmh}, though.
12516 Type @kbd{a nnml RET cache RET}.
12518 You should now have a brand new @code{nnml} virtual server called
12519 @samp{cache}. You now need to edit it to have the right definitions.
12520 Type @kbd{e} to edit the server. You'll be entered into a buffer that
12521 will contain the following:
12531 (nnml-directory "~/News/cache/")
12532 (nnml-active-file "~/News/cache/active"))
12535 Type @kbd{C-c C-c} to return to the server buffer. If you now press
12536 @kbd{RET} over this virtual server, you should be entered into a browse
12537 buffer, and you should be able to enter any of the groups displayed.
12540 @node Server Variables
12541 @subsection Server Variables
12542 @cindex server variables
12543 @cindex server parameters
12545 One sticky point when defining variables (both on back ends and in Emacs
12546 in general) is that some variables are typically initialized from other
12547 variables when the definition of the variables is being loaded. If you
12548 change the ``base'' variable after the variables have been loaded, you
12549 won't change the ``derived'' variables.
12551 This typically affects directory and file variables. For instance,
12552 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
12553 directory variables are initialized from that variable, so
12554 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
12555 new virtual @code{nnml} server, it will @emph{not} suffice to set just
12556 @code{nnml-directory}---you have to explicitly set all the file
12557 variables to be what you want them to be. For a complete list of
12558 variables for each back end, see each back end's section later in this
12559 manual, but here's an example @code{nnml} definition:
12563 (nnml-directory "~/my-mail/")
12564 (nnml-active-file "~/my-mail/active")
12565 (nnml-newsgroups-file "~/my-mail/newsgroups"))
12568 Server variables are often called @dfn{server parameters}.
12570 @node Servers and Methods
12571 @subsection Servers and Methods
12573 Wherever you would normally use a select method
12574 (e.g. @code{gnus-secondary-select-method}, in the group select method,
12575 when browsing a foreign server) you can use a virtual server name
12576 instead. This could potentially save lots of typing. And it's nice all
12580 @node Unavailable Servers
12581 @subsection Unavailable Servers
12583 If a server seems to be unreachable, Gnus will mark that server as
12584 @code{denied}. That means that any subsequent attempt to make contact
12585 with that server will just be ignored. ``It can't be opened,'' Gnus
12586 will tell you, without making the least effort to see whether that is
12587 actually the case or not.
12589 That might seem quite naughty, but it does make sense most of the time.
12590 Let's say you have 10 groups subscribed to on server
12591 @samp{nephelococcygia.com}. This server is located somewhere quite far
12592 away from you and the machine is quite slow, so it takes 1 minute just
12593 to find out that it refuses connection to you today. If Gnus were to
12594 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12595 attempt to do that. Once it has gotten a single ``connection refused'',
12596 it will regard that server as ``down''.
12598 So, what happens if the machine was only feeling unwell temporarily?
12599 How do you test to see whether the machine has come up again?
12601 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12602 with the following commands:
12608 @findex gnus-server-open-server
12609 Try to establish connection to the server on the current line
12610 (@code{gnus-server-open-server}).
12614 @findex gnus-server-close-server
12615 Close the connection (if any) to the server
12616 (@code{gnus-server-close-server}).
12620 @findex gnus-server-deny-server
12621 Mark the current server as unreachable
12622 (@code{gnus-server-deny-server}).
12625 @kindex M-o (Server)
12626 @findex gnus-server-open-all-servers
12627 Open the connections to all servers in the buffer
12628 (@code{gnus-server-open-all-servers}).
12631 @kindex M-c (Server)
12632 @findex gnus-server-close-all-servers
12633 Close the connections to all servers in the buffer
12634 (@code{gnus-server-close-all-servers}).
12638 @findex gnus-server-remove-denials
12639 Remove all marks to whether Gnus was denied connection from any servers
12640 (@code{gnus-server-remove-denials}).
12644 @findex gnus-server-offline-server
12645 Set server status to offline (@code{gnus-server-offline-server}).
12651 @section Getting News
12652 @cindex reading news
12653 @cindex news back ends
12655 A newsreader is normally used for reading news. Gnus currently provides
12656 only two methods of getting news---it can read from an @acronym{NNTP} server,
12657 or it can read from a local spool.
12660 * NNTP:: Reading news from an @acronym{NNTP} server.
12661 * News Spool:: Reading news from the local spool.
12669 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
12670 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
12671 server as the, uhm, address.
12673 If the @acronym{NNTP} server is located at a non-standard port, setting the
12674 third element of the select method to this port number should allow you
12675 to connect to the right port. You'll have to edit the group info for
12676 that (@pxref{Foreign Groups}).
12678 The name of the foreign group can be the same as a native group. In
12679 fact, you can subscribe to the same group from as many different servers
12680 you feel like. There will be no name collisions.
12682 The following variables can be used to create a virtual @code{nntp}
12687 @item nntp-server-opened-hook
12688 @vindex nntp-server-opened-hook
12689 @cindex @sc{mode reader}
12691 @cindex authentification
12692 @cindex nntp authentification
12693 @findex nntp-send-authinfo
12694 @findex nntp-send-mode-reader
12695 is run after a connection has been made. It can be used to send
12696 commands to the @acronym{NNTP} server after it has been contacted. By
12697 default it sends the command @code{MODE READER} to the server with the
12698 @code{nntp-send-mode-reader} function. This function should always be
12699 present in this hook.
12701 @item nntp-authinfo-function
12702 @vindex nntp-authinfo-function
12703 @findex nntp-send-authinfo
12704 @vindex nntp-authinfo-file
12705 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
12706 server. The default function is @code{nntp-send-authinfo}, which looks
12707 through your @file{~/.authinfo} (or whatever you've set the
12708 @code{nntp-authinfo-file} variable to) for applicable entries. If none
12709 are found, it will prompt you for a login name and a password. The
12710 format of the @file{~/.authinfo} file is (almost) the same as the
12711 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
12712 manual page, but here are the salient facts:
12716 The file contains one or more line, each of which define one server.
12719 Each line may contain an arbitrary number of token/value pairs.
12721 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
12722 @samp{default}. In addition Gnus introduces two new tokens, not present
12723 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
12724 @samp{force}. (This is the only way the @file{.authinfo} file format
12725 deviates from the @file{.netrc} file format.) @samp{port} is used to
12726 indicate what port on the server the credentials apply to and
12727 @samp{force} is explained below.
12731 Here's an example file:
12734 machine news.uio.no login larsi password geheimnis
12735 machine nntp.ifi.uio.no login larsi force yes
12738 The token/value pairs may appear in any order; @samp{machine} doesn't
12739 have to be first, for instance.
12741 In this example, both login name and password have been supplied for the
12742 former server, while the latter has only the login name listed, and the
12743 user will be prompted for the password. The latter also has the
12744 @samp{force} tag, which means that the authinfo will be sent to the
12745 @var{nntp} server upon connection; the default (i.e., when there is not
12746 @samp{force} tag) is to not send authinfo to the @var{nntp} server
12747 until the @var{nntp} server asks for it.
12749 You can also add @samp{default} lines that will apply to all servers
12750 that don't have matching @samp{machine} lines.
12756 This will force sending @samp{AUTHINFO} commands to all servers not
12757 previously mentioned.
12759 Remember to not leave the @file{~/.authinfo} file world-readable.
12761 @item nntp-server-action-alist
12762 @vindex nntp-server-action-alist
12763 This is a list of regexps to match on server types and actions to be
12764 taken when matches are made. For instance, if you want Gnus to beep
12765 every time you connect to innd, you could say something like:
12768 (setq nntp-server-action-alist
12769 '(("innd" (ding))))
12772 You probably don't want to do that, though.
12774 The default value is
12777 '(("nntpd 1\\.5\\.11t"
12778 (remove-hook 'nntp-server-opened-hook
12779 'nntp-send-mode-reader)))
12782 This ensures that Gnus doesn't send the @code{MODE READER} command to
12783 nntpd 1.5.11t, since that command chokes that server, I've been told.
12785 @item nntp-maximum-request
12786 @vindex nntp-maximum-request
12787 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
12788 will collect headers by sending a series of @code{head} commands. To
12789 speed things up, the back end sends lots of these commands without
12790 waiting for reply, and then reads all the replies. This is controlled
12791 by the @code{nntp-maximum-request} variable, and is 400 by default. If
12792 your network is buggy, you should set this to 1.
12794 @item nntp-connection-timeout
12795 @vindex nntp-connection-timeout
12796 If you have lots of foreign @code{nntp} groups that you connect to
12797 regularly, you're sure to have problems with @acronym{NNTP} servers not
12798 responding properly, or being too loaded to reply within reasonable
12799 time. This is can lead to awkward problems, which can be helped
12800 somewhat by setting @code{nntp-connection-timeout}. This is an integer
12801 that says how many seconds the @code{nntp} back end should wait for a
12802 connection before giving up. If it is @code{nil}, which is the default,
12803 no timeouts are done.
12805 @item nntp-nov-is-evil
12806 @vindex nntp-nov-is-evil
12807 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
12808 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
12811 @item nntp-xover-commands
12812 @vindex nntp-xover-commands
12813 @cindex @acronym{NOV}
12815 List of strings used as commands to fetch @acronym{NOV} lines from a
12816 server. The default value of this variable is @code{("XOVER"
12820 @vindex nntp-nov-gap
12821 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
12822 the server. The server responds with one huge list of lines. However,
12823 if you have read articles 2-5000 in the group, and only want to read
12824 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
12825 lines that you will not need. This variable says how
12826 big a gap between two consecutive articles is allowed to be before the
12827 @code{XOVER} request is split into several request. Note that if your
12828 network is fast, setting this variable to a really small number means
12829 that fetching will probably be slower. If this variable is @code{nil},
12830 @code{nntp} will never split requests. The default is 5.
12832 @item nntp-prepare-server-hook
12833 @vindex nntp-prepare-server-hook
12834 A hook run before attempting to connect to an @acronym{NNTP} server.
12836 @item nntp-record-commands
12837 @vindex nntp-record-commands
12838 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12839 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
12840 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
12841 that doesn't seem to work.
12843 @item nntp-open-connection-function
12844 @vindex nntp-open-connection-function
12845 It is possible to customize how the connection to the nntp server will
12846 be opened. If you specify an @code{nntp-open-connection-function}
12847 parameter, Gnus will use that function to establish the connection.
12848 Seven pre-made functions are supplied. These functions can be grouped
12849 in two categories: direct connection functions (four pre-made), and
12850 indirect ones (three pre-made).
12852 @item nntp-prepare-post-hook
12853 @vindex nntp-prepare-post-hook
12854 A hook run just before posting an article. If there is no
12855 @code{Message-ID} header in the article and the news server provides the
12856 recommended ID, it will be added to the article before running this
12857 hook. It is useful to make @code{Cancel-Lock} headers even if you
12858 inhibit Gnus to add a @code{Message-ID} header, you could say:
12861 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12864 Note that not all servers support the recommended ID. This works for
12865 INN versions 2.3.0 and later, for instance.
12867 @item nntp-list-options
12868 @vindex nntp-list-options
12869 List of newsgroup name used for a option of the LIST command to restrict
12870 the listing output to only the specified newsgroups. Each newsgroup name
12871 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
12872 etc. Fortunately, if the server can accept such a option, it will
12873 probably make gnus run faster. You may use it as a server variable as
12877 (setq gnus-select-method
12878 '(nntp "news.somewhere.edu"
12879 (nntp-list-options ("fj.*" "japan.*"))))
12882 @item nntp-options-subscribe
12883 @vindex nntp-options-subscribe
12884 Regexp matching the newsgroup names which will be subscribed
12885 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12886 It may be effective as well as @code{nntp-list-options} even though the
12887 server could not accept a shell-style wildcard as a option of the LIST
12888 command. You may use it as a server variable as follows:
12891 (setq gnus-select-method
12892 '(nntp "news.somewhere.edu"
12893 (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
12896 @item nntp-options-not-subscribe
12897 @vindex nntp-options-not-subscribe
12898 Regexp matching the newsgroup names which will not be subscribed
12899 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12900 It may be effective as well as @code{nntp-list-options} even though the
12901 server could not accept a shell-style wildcard as a option of the LIST
12902 command. You may use it as a server variable as follows:
12905 (setq gnus-select-method
12906 '(nntp "news.somewhere.edu"
12907 (nntp-options-not-subscribe "\\.binaries\\.")))
12912 * Direct Functions:: Connecting directly to the server.
12913 * Indirect Functions:: Connecting indirectly to the server.
12914 * Common Variables:: Understood by several connection functions.
12915 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
12919 @node Direct Functions
12920 @subsubsection Direct Functions
12921 @cindex direct connection functions
12923 These functions are called direct because they open a direct connection
12924 between your machine and the @acronym{NNTP} server. The behavior of these
12925 functions is also affected by commonly understood variables
12926 (@pxref{Common Variables}).
12929 @findex nntp-open-network-stream
12930 @item nntp-open-network-stream
12931 This is the default, and simply connects to some port or other on the
12934 @findex nntp-open-tls-stream
12935 @item nntp-open-tls-stream
12936 Opens a connection to a server over a @dfn{secure} channel. To use
12937 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
12938 installed. You then define a server as follows:
12941 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
12942 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
12944 (nntp "snews.bar.com"
12945 (nntp-open-connection-function nntp-open-tls-stream)
12946 (nntp-port-number )
12947 (nntp-address "snews.bar.com"))
12950 @findex nntp-open-ssl-stream
12951 @item nntp-open-ssl-stream
12952 Opens a connection to a server over a @dfn{secure} channel. To use
12953 this you must have @uref{http://www.openssl.org, OpenSSL} or
12954 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
12955 then define a server as follows:
12958 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
12959 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
12961 (nntp "snews.bar.com"
12962 (nntp-open-connection-function nntp-open-ssl-stream)
12963 (nntp-port-number 563)
12964 (nntp-address "snews.bar.com"))
12967 @findex nntp-open-telnet-stream
12968 @item nntp-open-telnet-stream
12969 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
12970 it. You might wonder why this function exists, since we have the
12971 default @code{nntp-open-network-stream} which would do the job. (One
12972 of) the reason(s) is that if you are behind a firewall but have direct
12973 connections to the outside world thanks to a command wrapper like
12974 @code{runsocks}, you can use it like this:
12978 (nntp-pre-command "runsocks")
12979 (nntp-open-connection-function nntp-open-telnet-stream)
12980 (nntp-address "the.news.server"))
12983 With the default method, you would need to wrap your whole Emacs
12984 session, which is not a good idea.
12988 @node Indirect Functions
12989 @subsubsection Indirect Functions
12990 @cindex indirect connection functions
12992 These functions are called indirect because they connect to an
12993 intermediate host before actually connecting to the @acronym{NNTP} server.
12994 All of these functions and related variables are also said to belong to
12995 the ``via'' family of connection: they're all prefixed with ``via'' to make
12996 things cleaner. The behavior of these functions is also affected by
12997 commonly understood variables (@pxref{Common Variables}).
13000 @item nntp-open-via-rlogin-and-telnet
13001 @findex nntp-open-via-rlogin-and-telnet
13002 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
13003 to the real @acronym{NNTP} server from there. This is useful for instance if
13004 you need to connect to a firewall machine first.
13006 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
13009 @item nntp-via-rlogin-command
13010 @vindex nntp-via-rlogin-command
13011 Command used to log in on the intermediate host. The default is
13012 @samp{rsh}, but @samp{ssh} is a popular alternative.
13014 @item nntp-via-rlogin-command-switches
13015 @vindex nntp-via-rlogin-command-switches
13016 List of strings to be used as the switches to
13017 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
13018 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
13019 @samp{("-C")} in order to compress all data connections, otherwise set
13020 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
13021 the telnet command requires a pseudo-tty allocation on an intermediate
13025 Note that you may want to change the value for @code{nntp-end-of-line}
13026 to @samp{\n} (@pxref{Common Variables}).
13028 @item nntp-open-via-rlogin-and-netcat
13029 @findex nntp-open-via-rlogin-and-netcat
13030 Does essentially the same, but uses @samp{netcat}
13031 (@uref{http://netcat.sourceforge.net/}) instead of @samp{telnet} to
13032 connect to the real @acronym{NNTP} server from the intermediate host.
13034 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
13037 @item nntp-via-netcat-command
13038 @vindex nntp-via-netcat-command
13039 Command used to connect to the real @acronym{NNTP} server from the
13040 intermediate host. The default is @samp{nc}. You can also use other
13041 programs like @samp{connect}
13042 (@uref{http://www.imasy.or.jp/~gotoh/ssh/connect.html}) instead.
13044 @item nntp-via-netcat-switches
13045 @vindex nntp-via-netcat-switches
13046 List of strings to be used as the switches to the
13047 @code{nntp-via-telnet-command} command. The default is @code{nil}.
13049 @item nntp-via-rlogin-command
13050 Command used to log in on the intermediate host. The default is
13051 @samp{rsh}, but @samp{ssh} is a popular alternative.
13053 @item nntp-via-rlogin-command-switches
13054 List of strings to be used as the switches to
13055 @code{nntp-via-rlogin-command}. The default is @code{nil}.
13058 @item nntp-open-via-telnet-and-telnet
13059 @findex nntp-open-via-telnet-and-telnet
13060 Does essentially the same, but uses @samp{telnet} instead of
13061 @samp{rlogin} to connect to the intermediate host.
13063 @code{nntp-open-via-telnet-and-telnet}-specific variables:
13066 @item nntp-via-telnet-command
13067 @vindex nntp-via-telnet-command
13068 Command used to @code{telnet} the intermediate host. The default is
13071 @item nntp-via-telnet-switches
13072 @vindex nntp-via-telnet-switches
13073 List of strings to be used as the switches to the
13074 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
13076 @item nntp-via-user-password
13077 @vindex nntp-via-user-password
13078 Password to use when logging in on the intermediate host.
13080 @item nntp-via-envuser
13081 @vindex nntp-via-envuser
13082 If non-@code{nil}, the intermediate @code{telnet} session (client and
13083 server both) will support the @code{ENVIRON} option and not prompt for
13084 login name. This works for Solaris @code{telnet}, for instance.
13086 @item nntp-via-shell-prompt
13087 @vindex nntp-via-shell-prompt
13088 Regexp matching the shell prompt on the intermediate host. The default
13089 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
13093 Note that you may want to change the value for @code{nntp-end-of-line}
13094 to @samp{\n} (@pxref{Common Variables}).
13098 Here are some additional variables that are understood by all the above
13103 @item nntp-via-user-name
13104 @vindex nntp-via-user-name
13105 User name to use when connecting to the intermediate host.
13107 @item nntp-via-address
13108 @vindex nntp-via-address
13109 Address of the intermediate host to connect to.
13114 @node Common Variables
13115 @subsubsection Common Variables
13117 The following variables affect the behavior of all, or several of the
13118 pre-made connection functions. When not specified, all functions are
13119 affected (the values of the following variables will be used as the
13120 default if each virtual @code{nntp} server doesn't specify those server
13121 variables individually).
13125 @item nntp-pre-command
13126 @vindex nntp-pre-command
13127 A command wrapper to use when connecting through a non native
13128 connection function (all except @code{nntp-open-network-stream},
13129 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}). This is
13130 where you would put a @samp{SOCKS} wrapper for instance.
13133 @vindex nntp-address
13134 The address of the @acronym{NNTP} server.
13136 @item nntp-port-number
13137 @vindex nntp-port-number
13138 Port number to connect to the @acronym{NNTP} server. The default is
13139 @samp{nntp}. If you use @acronym{NNTP} over
13140 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
13141 than named ports (i.e, use @samp{563} instead of @samp{snews} or
13142 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
13143 not work with named ports.
13145 @item nntp-end-of-line
13146 @vindex nntp-end-of-line
13147 String to use as end-of-line marker when talking to the @acronym{NNTP}
13148 server. This is @samp{\r\n} by default, but should be @samp{\n} when
13149 using a non native telnet connection function.
13151 @item nntp-telnet-command
13152 @vindex nntp-telnet-command
13153 Command to use when connecting to the @acronym{NNTP} server through
13154 @samp{telnet}. This is @emph{not} for an intermediate host. This is
13155 just for the real @acronym{NNTP} server. The default is
13158 @item nntp-telnet-switches
13159 @vindex nntp-telnet-switches
13160 A list of switches to pass to @code{nntp-telnet-command}. The default
13166 @subsubsection NNTP marks
13167 @cindex storing NNTP marks
13169 Gnus stores marks (@pxref{Marking Articles}) for @acronym{NNTP}
13170 servers in marks files. A marks file records what marks you have set
13171 in a group and each file is specific to the corresponding server.
13172 Marks files are stored in @file{~/News/marks}
13173 (@code{nntp-marks-directory}) under a classic hierarchy resembling
13174 that of a news server, for example marks for the group
13175 @samp{gmane.discuss} on the news.gmane.org server will be stored in
13176 the file @file{~/News/marks/news.gmane.org/gmane/discuss/.marks}.
13178 Marks files are useful because you can copy the @file{~/News/marks}
13179 directory (using rsync, scp or whatever) to another Gnus installation,
13180 and it will realize what articles you have read and marked. The data
13181 in @file{~/News/marks} has priority over the same data in
13182 @file{~/.newsrc.eld}.
13184 Note that marks files are very much server-specific: Gnus remembers
13185 the article numbers so if you don't use the same servers on both
13186 installations things are most likely to break (most @acronym{NNTP}
13187 servers do not use the same article numbers as any other server).
13188 However, if you use servers A, B, C on one installation and servers A,
13189 D, E on the other, you can sync the marks files for A and then you'll
13190 get synchronization for that server between the two installations.
13192 Using @acronym{NNTP} marks can possibly incur a performance penalty so
13193 if Gnus feels sluggish, try setting the @code{nntp-marks-is-evil}
13194 variable to @code{t}. Marks will then be stored in @file{~/.newsrc.eld}.
13200 @item nntp-marks-is-evil
13201 @vindex nntp-marks-is-evil
13202 If non-@code{nil}, this back end will ignore any marks files. The
13203 default is @code{nil}.
13205 @item nntp-marks-directory
13206 @vindex nntp-marks-directory
13207 The directory where marks for nntp groups will be stored.
13213 @subsection News Spool
13217 Subscribing to a foreign group from the local spool is extremely easy,
13218 and might be useful, for instance, to speed up reading groups that
13219 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
13222 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
13223 anything else) as the address.
13225 If you have access to a local spool, you should probably use that as the
13226 native select method (@pxref{Finding the News}). It is normally faster
13227 than using an @code{nntp} select method, but might not be. It depends.
13228 You just have to try to find out what's best at your site.
13232 @item nnspool-inews-program
13233 @vindex nnspool-inews-program
13234 Program used to post an article.
13236 @item nnspool-inews-switches
13237 @vindex nnspool-inews-switches
13238 Parameters given to the inews program when posting an article.
13240 @item nnspool-spool-directory
13241 @vindex nnspool-spool-directory
13242 Where @code{nnspool} looks for the articles. This is normally
13243 @file{/usr/spool/news/}.
13245 @item nnspool-nov-directory
13246 @vindex nnspool-nov-directory
13247 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
13248 @file{/usr/spool/news/over.view/}.
13250 @item nnspool-lib-dir
13251 @vindex nnspool-lib-dir
13252 Where the news lib dir is (@file{/usr/lib/news/} by default).
13254 @item nnspool-active-file
13255 @vindex nnspool-active-file
13256 The name of the active file.
13258 @item nnspool-newsgroups-file
13259 @vindex nnspool-newsgroups-file
13260 The name of the group descriptions file.
13262 @item nnspool-history-file
13263 @vindex nnspool-history-file
13264 The name of the news history file.
13266 @item nnspool-active-times-file
13267 @vindex nnspool-active-times-file
13268 The name of the active date file.
13270 @item nnspool-nov-is-evil
13271 @vindex nnspool-nov-is-evil
13272 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13275 @item nnspool-sift-nov-with-sed
13276 @vindex nnspool-sift-nov-with-sed
13278 If non-@code{nil}, which is the default, use @code{sed} to get the
13279 relevant portion from the overview file. If @code{nil},
13280 @code{nnspool} will load the entire file into a buffer and process it
13287 @section Getting Mail
13288 @cindex reading mail
13291 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13295 * Mail in a Newsreader:: Important introductory notes.
13296 * Getting Started Reading Mail:: A simple cookbook example.
13297 * Splitting Mail:: How to create mail groups.
13298 * Mail Sources:: How to tell Gnus where to get mail from.
13299 * Mail Back End Variables:: Variables for customizing mail handling.
13300 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
13301 * Group Mail Splitting:: Use group customize to drive mail splitting.
13302 * Incorporating Old Mail:: What about the old mail you have?
13303 * Expiring Mail:: Getting rid of unwanted mail.
13304 * Washing Mail:: Removing cruft from the mail you get.
13305 * Duplicates:: Dealing with duplicated mail.
13306 * Not Reading Mail:: Using mail back ends for reading other files.
13307 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
13311 @node Mail in a Newsreader
13312 @subsection Mail in a Newsreader
13314 If you are used to traditional mail readers, but have decided to switch
13315 to reading mail with Gnus, you may find yourself experiencing something
13316 of a culture shock.
13318 Gnus does not behave like traditional mail readers. If you want to make
13319 it behave that way, you can, but it's an uphill battle.
13321 Gnus, by default, handles all its groups using the same approach. This
13322 approach is very newsreaderly---you enter a group, see the new/unread
13323 messages, and when you read the messages, they get marked as read, and
13324 you don't see them any more. (Unless you explicitly ask for them.)
13326 In particular, you do not do anything explicitly to delete messages.
13328 Does this mean that all the messages that have been marked as read are
13329 deleted? How awful!
13331 But, no, it means that old messages are @dfn{expired} according to some
13332 scheme or other. For news messages, the expire process is controlled by
13333 the news administrator; for mail, the expire process is controlled by
13334 you. The expire process for mail is covered in depth in @ref{Expiring
13337 What many Gnus users find, after using it a while for both news and
13338 mail, is that the transport mechanism has very little to do with how
13339 they want to treat a message.
13341 Many people subscribe to several mailing lists. These are transported
13342 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13343 answering, or even reading these messages very carefully. We may not
13344 need to save them because if we should need to read one again, they are
13345 archived somewhere else.
13347 Some people have local news groups which have only a handful of readers.
13348 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13349 to read and answer a large fraction of the messages very carefully in
13350 order to do our work. And there may not be an archive, so we may need
13351 to save the interesting messages the same way we would personal mail.
13353 The important distinction turns out to be not the transport mechanism,
13354 but other factors such as how interested we are in the subject matter,
13355 or how easy it is to retrieve the message if we need to read it again.
13357 Gnus provides many options for sorting mail into ``groups'' which behave
13358 like newsgroups, and for treating each group (whether mail or news)
13361 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13362 that Gnus should grow up and be a male, er, mail reader. It is possible
13363 to whip Gnus into a more mailreaderly being, but, as said before, it's
13364 not easy. People who prefer proper mail readers should try @sc{vm}
13365 instead, which is an excellent, and proper, mail reader.
13367 I don't mean to scare anybody off, but I want to make it clear that you
13368 may be required to learn a new way of thinking about messages. After
13369 you've been subjected to The Gnus Way, you will come to love it. I can
13370 guarantee it. (At least the guy who sold me the Emacs Subliminal
13371 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13372 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13376 @node Getting Started Reading Mail
13377 @subsection Getting Started Reading Mail
13379 It's quite easy to use Gnus to read your new mail. You just plonk the
13380 mail back end of your choice into @code{gnus-secondary-select-methods},
13381 and things will happen automatically.
13383 For instance, if you want to use @code{nnml} (which is a ``one file per
13384 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13387 (setq gnus-secondary-select-methods '((nnml "")))
13390 Now, the next time you start Gnus, this back end will be queried for new
13391 articles, and it will move all the messages in your spool file to its
13392 directory, which is @file{~/Mail/} by default. The new group that will
13393 be created (@samp{mail.misc}) will be subscribed, and you can read it
13394 like any other group.
13396 You will probably want to split the mail into several groups, though:
13399 (setq nnmail-split-methods
13400 '(("junk" "^From:.*Lars Ingebrigtsen")
13401 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13405 This will result in three new @code{nnml} mail groups being created:
13406 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
13407 mail that doesn't fit into the first two groups will be placed in the
13410 This should be sufficient for reading mail with Gnus. You might want to
13411 give the other sections in this part of the manual a perusal, though.
13412 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13415 @node Splitting Mail
13416 @subsection Splitting Mail
13417 @cindex splitting mail
13418 @cindex mail splitting
13419 @cindex mail filtering (splitting)
13421 @vindex nnmail-split-methods
13422 The @code{nnmail-split-methods} variable says how the incoming mail is
13423 to be split into groups.
13426 (setq nnmail-split-methods
13427 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
13428 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
13429 ("mail.other" "")))
13432 This variable is a list of lists, where the first element of each of
13433 these lists is the name of the mail group (they do not have to be called
13434 something beginning with @samp{mail}, by the way), and the second
13435 element is a regular expression used on the header of each mail to
13436 determine if it belongs in this mail group. The first string may
13437 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
13438 insert sub-expressions from the matched text. For instance:
13441 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
13445 In that case, @code{nnmail-split-lowercase-expanded} controls whether
13446 the inserted text should be made lowercase. @xref{Fancy Mail Splitting}.
13448 The second element can also be a function. In that case, it will be
13449 called narrowed to the headers with the first element of the rule as the
13450 argument. It should return a non-@code{nil} value if it thinks that the
13451 mail belongs in that group.
13453 @cindex @samp{bogus} group
13454 The last of these groups should always be a general one, and the regular
13455 expression should @emph{always} be @samp{""} so that it matches any mails
13456 that haven't been matched by any of the other regexps. (These rules are
13457 processed from the beginning of the alist toward the end. The first rule
13458 to make a match will ``win'', unless you have crossposting enabled. In
13459 that case, all matching rules will ``win''.) If no rule matched, the mail
13460 will end up in the @samp{bogus} group. When new groups are created by
13461 splitting mail, you may want to run @code{gnus-group-find-new-groups} to
13462 see the new groups. This also applies to the @samp{bogus} group.
13464 If you like to tinker with this yourself, you can set this variable to a
13465 function of your choice. This function will be called without any
13466 arguments in a buffer narrowed to the headers of an incoming mail
13467 message. The function should return a list of group names that it
13468 thinks should carry this mail message.
13470 Note that the mail back ends are free to maul the poor, innocent,
13471 incoming headers all they want to. They all add @code{Lines} headers;
13472 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
13473 @code{From<SPACE>} line to something else.
13475 @vindex nnmail-crosspost
13476 The mail back ends all support cross-posting. If several regexps match,
13477 the mail will be ``cross-posted'' to all those groups.
13478 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
13479 that no articles are crossposted to the general (@samp{""}) group.
13481 @vindex nnmail-crosspost-link-function
13484 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
13485 the crossposted articles. However, not all file systems support hard
13486 links. If that's the case for you, set
13487 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
13488 variable is @code{add-name-to-file} by default.)
13490 @kindex M-x nnmail-split-history
13491 @findex nnmail-split-history
13492 If you wish to see where the previous mail split put the messages, you
13493 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
13494 where re-spooling messages would put the messages, you can use
13495 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
13498 @vindex nnmail-split-header-length-limit
13499 Header lines longer than the value of
13500 @code{nnmail-split-header-length-limit} are excluded from the split
13503 @vindex nnmail-mail-splitting-charset
13504 @vindex nnmail-mail-splitting-decodes
13505 By default the splitting codes @acronym{MIME} decodes headers so you
13506 can match on non-@acronym{ASCII} strings. The
13507 @code{nnmail-mail-splitting-charset} variable specifies the default
13508 charset for decoding. The behavior can be turned off completely by
13509 binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is
13510 useful if you want to match articles based on the raw header data.
13512 @vindex nnmail-resplit-incoming
13513 By default, splitting is performed on all incoming messages. If you
13514 specify a @code{directory} entry for the variable @code{mail-sources}
13515 (@pxref{Mail Source Specifiers}), however, then splitting does
13516 @emph{not} happen by default. You can set the variable
13517 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
13518 splitting happen even in this case. (This variable has no effect on
13519 other kinds of entries.)
13521 Gnus gives you all the opportunity you could possibly want for shooting
13522 yourself in the foot. Let's say you create a group that will contain
13523 all the mail you get from your boss. And then you accidentally
13524 unsubscribe from the group. Gnus will still put all the mail from your
13525 boss in the unsubscribed group, and so, when your boss mails you ``Have
13526 that report ready by Monday or you're fired!'', you'll never see it and,
13527 come Tuesday, you'll still believe that you're gainfully employed while
13528 you really should be out collecting empty bottles to save up for next
13529 month's rent money.
13533 @subsection Mail Sources
13535 Mail can be gotten from many different sources---the mail spool, from
13536 a @acronym{POP} mail server, from a procmail directory, or from a
13537 maildir, for instance.
13540 * Mail Source Specifiers:: How to specify what a mail source is.
13541 * Mail Source Customization:: Some variables that influence things.
13542 * Fetching Mail:: Using the mail source specifiers.
13546 @node Mail Source Specifiers
13547 @subsubsection Mail Source Specifiers
13549 @cindex mail server
13552 @cindex mail source
13554 You tell Gnus how to fetch mail by setting @code{mail-sources}
13555 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
13560 (pop :server "pop3.mailserver.com" :user "myname")
13563 As can be observed, a mail source specifier is a list where the first
13564 element is a @dfn{mail source type}, followed by an arbitrary number of
13565 @dfn{keywords}. Keywords that are not explicitly specified are given
13568 The following mail source types are available:
13572 Get mail from a single file; typically from the mail spool.
13578 The file name. Defaults to the value of the @env{MAIL}
13579 environment variable or the value of @code{rmail-spool-directory}
13580 (usually something like @file{/usr/mail/spool/user-name}).
13584 Script run before/after fetching mail.
13587 An example file mail source:
13590 (file :path "/usr/spool/mail/user-name")
13593 Or using the default file name:
13599 If the mail spool file is not located on the local machine, it's best
13600 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
13601 You can not use ange-ftp file names here---it has no way to lock the
13602 mail spool while moving the mail.
13604 If it's impossible to set up a proper server, you can use ssh instead.
13608 '((file :prescript "ssh host bin/getmail >%t")))
13611 The @samp{getmail} script would look something like the following:
13615 # getmail - move mail from spool to stdout
13618 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
13620 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
13623 Alter this script to fit find the @samp{movemail} you want to use.
13627 @vindex nnmail-scan-directory-mail-source-once
13628 Get mail from several files in a directory. This is typically used
13629 when you have procmail split the incoming mail into several files.
13630 That is, there is a one-to-one correspondence between files in that
13631 directory and groups, so that mail from the file @file{foo.bar.spool}
13632 will be put in the group @code{foo.bar}. (You can change the suffix
13633 to be used instead of @code{.spool}.) Setting
13634 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
13635 Gnus to scan the mail source only once. This is particularly useful
13636 if you want to scan mail groups at a specified level.
13638 @vindex nnmail-resplit-incoming
13639 There is also the variable @code{nnmail-resplit-incoming}, if you set
13640 that to a non-@code{nil} value, then the normal splitting process is
13641 applied to all the files from the directory, @ref{Splitting Mail}.
13647 The name of the directory where the files are. There is no default
13651 Only files ending with this suffix are used. The default is
13655 Only files that have this predicate return non-@code{nil} are returned.
13656 The default is @code{identity}. This is used as an additional
13657 filter---only files that have the right suffix @emph{and} satisfy this
13658 predicate are considered.
13662 Script run before/after fetching mail.
13666 An example directory mail source:
13669 (directory :path "/home/user-name/procmail-dir/"
13674 Get mail from a @acronym{POP} server.
13680 The name of the @acronym{POP} server. The default is taken from the
13681 @env{MAILHOST} environment variable.
13684 The port number of the @acronym{POP} server. This can be a number (eg,
13685 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
13686 string, it should be a service name as listed in @file{/etc/services} on
13687 Unix systems. The default is @samp{"pop3"}. On some systems you might
13688 need to specify it as @samp{"pop-3"} instead.
13691 The user name to give to the @acronym{POP} server. The default is the login
13695 The password to give to the @acronym{POP} server. If not specified,
13696 the user is prompted.
13699 The program to use to fetch mail from the @acronym{POP} server. This
13700 should be a @code{format}-like string. Here's an example:
13703 fetchmail %u@@%s -P %p %t
13706 The valid format specifier characters are:
13710 The name of the file the mail is to be moved to. This must always be
13711 included in this string.
13714 The name of the server.
13717 The port number of the server.
13720 The user name to use.
13723 The password to use.
13726 The values used for these specs are taken from the values you give the
13727 corresponding keywords.
13730 A script to be run before fetching the mail. The syntax is the same as
13731 the @code{:program} keyword. This can also be a function to be run.
13734 A script to be run after fetching the mail. The syntax is the same as
13735 the @code{:program} keyword. This can also be a function to be run.
13738 The function to use to fetch mail from the @acronym{POP} server. The
13739 function is called with one parameter---the name of the file where the
13740 mail should be moved to.
13742 @item :authentication
13743 This can be either the symbol @code{password} or the symbol @code{apop}
13744 and says what authentication scheme to use. The default is
13748 What stream to use for connecting to the server, this can be the symbol
13749 @code{ssl}, the symbol @code{tls} or others. The default is @code{nil}
13750 and use insecure connections. Note that for SSL/TLS, you need external
13751 programs and libraries:
13755 @dfn{ssl:} Connect through SSL@. Requires OpenSSL (the program
13756 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
13757 library @samp{ssl.el}.
13759 @dfn{starttls:} Connect via the STARTTLS extension (similar to SSL)@.
13760 Requires the external library @samp{starttls.el} and program
13765 Non-@code{nil} if mail is to be left on the server and UIDL used for
13766 message retrieval. The default is @code{nil}.
13770 @vindex pop3-movemail
13771 @vindex pop3-leave-mail-on-server
13772 If the @code{:program} and @code{:function} keywords aren't specified,
13773 @code{pop3-movemail} will be used. If the
13774 @code{pop3-leave-mail-on-server} is non-@code{nil} the mail is to be
13775 left on the @acronym{POP} server after fetching when using
13776 @code{pop3-movemail}. Note that POP servers maintain no state
13777 information between sessions, so what the client believes is there and
13778 what is actually there may not match up. If they do not, then the whole
13779 thing can fall apart and leave you with a corrupt mailbox.
13781 Here are some examples. Fetch from the default @acronym{POP} server,
13782 using the default user name, and default fetcher:
13788 Fetch from a named server with a named user and password:
13791 (pop :server "my.pop.server"
13792 :user "user-name" :password "secret")
13795 Use @samp{movemail} to move the mail:
13798 (pop :program "movemail po:%u %t %p")
13802 Get mail from a maildir. This is a type of mailbox that is supported by
13803 at least qmail and postfix, where each file in a special directory
13804 contains exactly one mail.
13810 The name of the directory where the mails are stored. The default is
13811 taken from the @env{MAILDIR} environment variable or
13814 The subdirectories of the Maildir. The default is
13815 @samp{("new" "cur")}.
13817 @c If you sometimes look at your mail through a pop3 daemon before fetching
13818 @c them with Gnus, you may also have to fetch your mails from the
13819 @c @code{cur} directory inside the maildir, like in the first example
13822 You can also get mails from remote hosts (because maildirs don't suffer
13823 from locking problems).
13827 Two example maildir mail sources:
13830 (maildir :path "/home/user-name/Maildir/"
13831 :subdirs ("cur" "new"))
13835 (maildir :path "/user@@remotehost.org:~/Maildir/"
13840 Get mail from a @acronym{IMAP} server. If you don't want to use
13841 @acronym{IMAP} as intended, as a network mail reading protocol (ie
13842 with nnimap), for some reason or other, Gnus let you treat it similar
13843 to a @acronym{POP} server and fetches articles from a given
13844 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
13846 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
13847 may need external programs and libraries, @xref{IMAP}.
13853 The name of the @acronym{IMAP} server. The default is taken from the
13854 @env{MAILHOST} environment variable.
13857 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
13858 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
13861 The user name to give to the @acronym{IMAP} server. The default is the login
13865 The password to give to the @acronym{IMAP} server. If not specified, the user is
13869 What stream to use for connecting to the server, this is one of the
13870 symbols in @code{imap-stream-alist}. Right now, this means
13871 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
13872 @samp{ssl}, @samp{shell} or the default @samp{network}.
13874 @item :authentication
13875 Which authenticator to use for authenticating to the server, this is
13876 one of the symbols in @code{imap-authenticator-alist}. Right now,
13877 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13878 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13881 When using the `shell' :stream, the contents of this variable is
13882 mapped into the @code{imap-shell-program} variable. This should be a
13883 @code{format}-like string (or list of strings). Here's an example:
13889 The valid format specifier characters are:
13893 The name of the server.
13896 User name from @code{imap-default-user}.
13899 The port number of the server.
13902 The values used for these specs are taken from the values you give the
13903 corresponding keywords.
13906 The name of the mailbox to get mail from. The default is @samp{INBOX}
13907 which normally is the mailbox which receive incoming mail.
13910 The predicate used to find articles to fetch. The default, @samp{UNSEEN
13911 UNDELETED}, is probably the best choice for most people, but if you
13912 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
13913 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13914 Then all articles in the mailbox is fetched, no matter what. For a
13915 complete list of predicates, see RFC 2060 section 6.4.4.
13918 How to flag fetched articles on the server, the default @samp{\Deleted}
13919 will mark them as deleted, an alternative would be @samp{\Seen} which
13920 would simply mark them as read. These are the two most likely choices,
13921 but more flags are defined in RFC 2060 section 2.3.2.
13924 If non-@code{nil}, don't remove all articles marked as deleted in the
13925 mailbox after finishing the fetch.
13929 An example @acronym{IMAP} mail source:
13932 (imap :server "mail.mycorp.com"
13934 :fetchflag "\\Seen")
13938 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
13939 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
13940 @uref{http://mail.yahoo.com/}.
13942 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
13943 required for url "4.0pre.46".
13945 WARNING: Mails may be lost. NO WARRANTY.
13951 The type of the webmail server. The default is @code{hotmail}. The
13952 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13955 The user name to give to the webmail server. The default is the login
13959 The password to give to the webmail server. If not specified, the user is
13963 If non-@code{nil}, only fetch unread articles and don't move them to
13964 trash folder after finishing the fetch.
13968 An example webmail source:
13971 (webmail :subtype 'hotmail
13973 :password "secret")
13978 @item Common Keywords
13979 Common keywords can be used in any type of mail source.
13985 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
13986 use directory source to get mail, you can specify it as in this
13991 '((directory :path "/home/pavel/.Spool/"
13996 Gnus will then fetch your mail even when you are unplugged. This is
13997 useful when you use local mail and news.
14002 @subsubsection Function Interface
14004 Some of the above keywords specify a Lisp function to be executed.
14005 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
14006 the value of the keyword while the function is executing. For example,
14007 consider the following mail-source setting:
14010 (setq mail-sources '((pop :user "jrl"
14011 :server "pophost" :function fetchfunc)))
14014 While the function @code{fetchfunc} is executing, the symbol @code{user}
14015 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
14016 @code{"pophost"}. The symbols @code{port}, @code{password},
14017 @code{program}, @code{prescript}, @code{postscript}, @code{function},
14018 and @code{authentication} are also bound (to their default values).
14020 See above for a list of keywords for each type of mail source.
14023 @node Mail Source Customization
14024 @subsubsection Mail Source Customization
14026 The following is a list of variables that influence how the mail is
14027 fetched. You would normally not need to set or change any of these
14031 @item mail-source-crash-box
14032 @vindex mail-source-crash-box
14033 File where mail will be stored while processing it. The default is@*
14034 @file{~/.emacs-mail-crash-box}.
14036 @item mail-source-delete-incoming
14037 @vindex mail-source-delete-incoming
14038 If non-@code{nil}, delete incoming files after handling them. If
14039 @code{t}, delete the files immediately, if @code{nil}, never delete any
14040 files. If a positive number, delete files older than number of days
14041 (This will only happen, when receiving new mail). You may also set
14042 @code{mail-source-delete-incoming} to @code{nil} and call
14043 @code{mail-source-delete-old-incoming} from a hook or interactively.
14045 @item mail-source-delete-old-incoming-confirm
14046 @vindex mail-source-delete-old-incoming-confirm
14047 If non-@code{nil}, ask for for confirmation before deleting old incoming
14048 files. This variable only applies when
14049 @code{mail-source-delete-incoming} is a positive number.
14051 @item mail-source-ignore-errors
14052 @vindex mail-source-ignore-errors
14053 If non-@code{nil}, ignore errors when reading mail from a mail source.
14055 @item mail-source-directory
14056 @vindex mail-source-directory
14057 Directory where incoming mail source files (if any) will be stored. The
14058 default is @file{~/Mail/}. At present, the only thing this is used for
14059 is to say where the incoming files will be stored if the variable
14060 @code{mail-source-delete-incoming} is @code{nil} or a number.
14062 @item mail-source-incoming-file-prefix
14063 @vindex mail-source-incoming-file-prefix
14064 Prefix for file name for storing incoming mail. The default is
14065 @file{Incoming}, in which case files will end up with names like
14066 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
14067 relevant if @code{mail-source-delete-incoming} is @code{nil} or a
14070 @item mail-source-default-file-modes
14071 @vindex mail-source-default-file-modes
14072 All new mail files will get this file mode. The default is 384.
14074 @item mail-source-movemail-program
14075 @vindex mail-source-movemail-program
14076 If non-@code{nil}, name of program for fetching new mail. If
14077 @code{nil}, @code{movemail} in @var{exec-directory}.
14082 @node Fetching Mail
14083 @subsubsection Fetching Mail
14085 @vindex mail-sources
14086 @vindex nnmail-spool-file
14087 The way to actually tell Gnus where to get new mail from is to set
14088 @code{mail-sources} to a list of mail source specifiers
14089 (@pxref{Mail Source Specifiers}).
14091 If this variable (and the obsolescent @code{nnmail-spool-file}) is
14092 @code{nil}, the mail back ends will never attempt to fetch mail by
14095 If you want to fetch mail both from your local spool as well as a
14096 @acronym{POP} mail server, you'd say something like:
14101 (pop :server "pop3.mail.server"
14102 :password "secret")))
14105 Or, if you don't want to use any of the keyword defaults:
14109 '((file :path "/var/spool/mail/user-name")
14110 (pop :server "pop3.mail.server"
14113 :password "secret")))
14117 When you use a mail back end, Gnus will slurp all your mail from your
14118 inbox and plonk it down in your home directory. Gnus doesn't move any
14119 mail if you're not using a mail back end---you have to do a lot of magic
14120 invocations first. At the time when you have finished drawing the
14121 pentagram, lightened the candles, and sacrificed the goat, you really
14122 shouldn't be too surprised when Gnus moves your mail.
14126 @node Mail Back End Variables
14127 @subsection Mail Back End Variables
14129 These variables are (for the most part) pertinent to all the various
14133 @vindex nnmail-read-incoming-hook
14134 @item nnmail-read-incoming-hook
14135 The mail back ends all call this hook after reading new mail. You can
14136 use this hook to notify any mail watch programs, if you want to.
14138 @vindex nnmail-split-hook
14139 @item nnmail-split-hook
14140 @findex gnus-article-decode-encoded-words
14141 @cindex RFC 1522 decoding
14142 @cindex RFC 2047 decoding
14143 Hook run in the buffer where the mail headers of each message is kept
14144 just before the splitting based on these headers is done. The hook is
14145 free to modify the buffer contents in any way it sees fit---the buffer
14146 is discarded after the splitting has been done, and no changes performed
14147 in the buffer will show up in any files.
14148 @code{gnus-article-decode-encoded-words} is one likely function to add
14151 @vindex nnmail-pre-get-new-mail-hook
14152 @vindex nnmail-post-get-new-mail-hook
14153 @item nnmail-pre-get-new-mail-hook
14154 @itemx nnmail-post-get-new-mail-hook
14155 These are two useful hooks executed when treating new incoming
14156 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
14157 starting to handle the new mail) and
14158 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
14159 is done). Here's and example of using these two hooks to change the
14160 default file modes the new mail files get:
14163 (add-hook 'nnmail-pre-get-new-mail-hook
14164 (lambda () (set-default-file-modes 511)))
14166 (add-hook 'nnmail-post-get-new-mail-hook
14167 (lambda () (set-default-file-modes 551)))
14170 @item nnmail-use-long-file-names
14171 @vindex nnmail-use-long-file-names
14172 If non-@code{nil}, the mail back ends will use long file and directory
14173 names. Groups like @samp{mail.misc} will end up in directories
14174 (assuming use of @code{nnml} back end) or files (assuming use of
14175 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
14176 the same group will end up in @file{mail/misc}.
14178 @item nnmail-delete-file-function
14179 @vindex nnmail-delete-file-function
14180 @findex delete-file
14181 Function called to delete files. It is @code{delete-file} by default.
14183 @item nnmail-cache-accepted-message-ids
14184 @vindex nnmail-cache-accepted-message-ids
14185 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
14186 the back end (via @code{Gcc}, for instance) into the mail duplication
14187 discovery cache. The default is @code{nil}.
14189 @item nnmail-cache-ignore-groups
14190 @vindex nnmail-cache-ignore-groups
14191 This can be a regular expression or a list of regular expressions.
14192 Group names that match any of the regular expressions will never be
14193 recorded in the @code{Message-ID} cache.
14195 This can be useful, for example, when using Fancy Splitting
14196 (@pxref{Fancy Mail Splitting}) together with the function
14197 @code{nnmail-split-fancy-with-parent}.
14202 @node Fancy Mail Splitting
14203 @subsection Fancy Mail Splitting
14204 @cindex mail splitting
14205 @cindex fancy mail splitting
14207 @vindex nnmail-split-fancy
14208 @findex nnmail-split-fancy
14209 If the rather simple, standard method for specifying how to split mail
14210 doesn't allow you to do what you want, you can set
14211 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
14212 play with the @code{nnmail-split-fancy} variable.
14214 Let's look at an example value of this variable first:
14217 ;; @r{Messages from the mailer daemon are not crossposted to any of}
14218 ;; @r{the ordinary groups. Warnings are put in a separate group}
14219 ;; @r{from real errors.}
14220 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
14222 ;; @r{Non-error messages are crossposted to all relevant}
14223 ;; @r{groups, but we don't crosspost between the group for the}
14224 ;; @r{(ding) list and the group for other (ding) related mail.}
14225 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
14226 ("subject" "ding" "ding.misc"))
14227 ;; @r{Other mailing lists@dots{}}
14228 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
14229 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
14230 ;; @r{Both lists below have the same suffix, so prevent}
14231 ;; @r{cross-posting to mkpkg.list of messages posted only to}
14232 ;; @r{the bugs- list, but allow cross-posting when the}
14233 ;; @r{message was really cross-posted.}
14234 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
14235 (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list")
14236 ;; @r{People@dots{}}
14237 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
14238 ;; @r{Unmatched mail goes to the catch all group.}
14242 This variable has the format of a @dfn{split}. A split is a
14243 (possibly) recursive structure where each split may contain other
14244 splits. Here are the possible split syntaxes:
14249 If the split is a string, that will be taken as a group name. Normal
14250 regexp match expansion will be done. See below for examples.
14252 @c Don't fold this line.
14253 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split} [@var{invert-partial}])
14254 The split can be a list containing at least three elements. If the
14255 first element @var{field} (a regexp matching a header) contains
14256 @var{value} (also a regexp) then store the message as specified by
14259 If @var{restrict} (yet another regexp) matches some string after
14260 @var{field} and before the end of the matched @var{value}, the
14261 @var{split} is ignored. If none of the @var{restrict} clauses match,
14262 @var{split} is processed.
14264 The last element @var{invert-partial} is optional. If it is
14265 non-@code{nil}, the match-partial-words behavior controlled by the
14266 variable @code{nnmail-split-fancy-match-partial-words} (see below) is
14267 be inverted. (New in Gnus 5.10.7)
14269 @item (| @var{split} @dots{})
14270 If the split is a list, and the first element is @code{|} (vertical
14271 bar), then process each @var{split} until one of them matches. A
14272 @var{split} is said to match if it will cause the mail message to be
14273 stored in one or more groups.
14275 @item (& @var{split} @dots{})
14276 If the split is a list, and the first element is @code{&}, then
14277 process all @var{split}s in the list.
14280 If the split is the symbol @code{junk}, then don't save (i.e., delete)
14281 this message. Use with extreme caution.
14283 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
14284 If the split is a list, and the first element is @samp{:}, then the
14285 second element will be called as a function with @var{args} given as
14286 arguments. The function should return a @var{split}.
14289 For instance, the following function could be used to split based on the
14290 body of the messages:
14293 (defun split-on-body ()
14297 (goto-char (point-min))
14298 (when (re-search-forward "Some.*string" nil t)
14302 The buffer is narrowed to the message in question when @var{function}
14303 is run. That's why @code{(widen)} needs to be called after
14304 @code{save-excursion} and @code{save-restriction} in the example
14305 above. Also note that with the nnimap back end, message bodies will
14306 not be downloaded by default. You need to set
14307 @code{nnimap-split-download-body} to @code{t} to do that
14308 (@pxref{Splitting in IMAP}).
14310 @item (! @var{func} @var{split})
14311 If the split is a list, and the first element is @code{!}, then
14312 @var{split} will be processed, and @var{func} will be called as a
14313 function with the result of @var{split} as argument. @var{func}
14314 should return a split.
14317 If the split is @code{nil}, it is ignored.
14321 In these splits, @var{field} must match a complete field name.
14323 Normally, @var{value} in these splits must match a complete @emph{word}
14324 according to the fundamental mode syntax table. In other words, all
14325 @var{value}'s will be implicitly surrounded by @code{\<...\>} markers,
14326 which are word delimiters. Therefore, if you use the following split,
14330 (any "joe" "joemail")
14334 messages sent from @samp{joedavis@@foo.org} will normally not be filed
14335 in @samp{joemail}. If you want to alter this behavior, you can use any
14336 of the following three ways:
14340 @vindex nnmail-split-fancy-match-partial-words
14341 You can set the @code{nnmail-split-fancy-match-partial-words} variable
14342 to non-@code{nil} in order to ignore word boundaries and instead the
14343 match becomes more like a grep. This variable controls whether partial
14344 words are matched during fancy splitting. The default value is
14347 Note that it influences all @var{value}'s in your split rules.
14350 @var{value} beginning with @code{.*} ignores word boundaries in front of
14351 a word. Similarly, if @var{value} ends with @code{.*}, word boundaries
14352 in the rear of a word will be ignored. For example, the @var{value}
14353 @code{"@@example\\.com"} does not match @samp{foo@@example.com} but
14354 @code{".*@@example\\.com"} does.
14357 You can set the @var{invert-partial} flag in your split rules of the
14358 @samp{(@var{field} @var{value} @dots{})} types, aforementioned in this
14359 section. If the flag is set, word boundaries on both sides of a word
14360 are ignored even if @code{nnmail-split-fancy-match-partial-words} is
14361 @code{nil}. Contrarily, if the flag is set, word boundaries are not
14362 ignored even if @code{nnmail-split-fancy-match-partial-words} is
14363 non-@code{nil}. (New in Gnus 5.10.7)
14366 @vindex nnmail-split-abbrev-alist
14367 @var{field} and @var{value} can also be Lisp symbols, in that case
14368 they are expanded as specified by the variable
14369 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
14370 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14371 contains the associated value. Predefined entries in
14372 @code{nnmail-split-abbrev-alist} include:
14376 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14378 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14379 @samp{Resent-To} and @samp{Resent-Cc} fields.
14381 Is the union of the @code{from} and @code{to} entries.
14384 @vindex nnmail-split-fancy-syntax-table
14385 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14386 when all this splitting is performed.
14388 If you want to have Gnus create groups dynamically based on some
14389 information in the headers (i.e., do @code{replace-match}-like
14390 substitutions in the group names), you can say things like:
14393 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14396 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14397 will be filed in @samp{mail.debian.foo}.
14399 If the string contains the element @samp{\&}, then the previously
14400 matched string will be substituted. Similarly, the elements @samp{\\1}
14401 up to @samp{\\9} will be substituted with the text matched by the
14402 groupings 1 through 9.
14404 @vindex nnmail-split-lowercase-expanded
14405 Where @code{nnmail-split-lowercase-expanded} controls whether the
14406 lowercase of the matched string should be used for the substitution.
14407 Setting it as non-@code{nil} is useful to avoid the creation of multiple
14408 groups when users send to an address using different case
14409 (i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value
14412 @findex nnmail-split-fancy-with-parent
14413 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14414 split followups into the same groups their parents are in. Sometimes
14415 you can't make splitting rules for all your mail. For example, your
14416 boss might send you personal mail regarding different projects you are
14417 working on, and as you can't tell your boss to put a distinguishing
14418 string into the subject line, you have to resort to manually moving the
14419 messages into the right group. With this function, you only have to do
14420 it once per thread.
14422 To use this feature, you have to set @code{nnmail-treat-duplicates}
14423 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14424 value. And then you can include @code{nnmail-split-fancy-with-parent}
14425 using the colon feature, like so:
14427 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
14428 nnmail-cache-accepted-message-ids t
14430 '(| (: nnmail-split-fancy-with-parent)
14431 ;; @r{other splits go here}
14435 This feature works as follows: when @code{nnmail-treat-duplicates} is
14436 non-@code{nil}, Gnus records the message id of every message it sees
14437 in the file specified by the variable
14438 @code{nnmail-message-id-cache-file}, together with the group it is in
14439 (the group is omitted for non-mail messages). When mail splitting is
14440 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
14441 at the References (and In-Reply-To) header of each message to split
14442 and searches the file specified by @code{nnmail-message-id-cache-file}
14443 for the message ids. When it has found a parent, it returns the
14444 corresponding group name unless the group name matches the regexp
14445 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
14446 recommended that you set @code{nnmail-message-id-cache-length} to a
14447 somewhat higher number than the default so that the message ids are
14448 still in the cache. (A value of 5000 appears to create a file some
14449 300 kBytes in size.)
14450 @vindex nnmail-cache-accepted-message-ids
14451 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
14452 also records the message ids of moved articles, so that the followup
14453 messages goes into the new group.
14455 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
14456 want certain groups to be recorded in the cache. For example, if all
14457 outgoing messages are written to an ``outgoing'' group, you could set
14458 @code{nnmail-cache-ignore-groups} to match that group name.
14459 Otherwise, answers to all your messages would end up in the
14460 ``outgoing'' group.
14463 @node Group Mail Splitting
14464 @subsection Group Mail Splitting
14465 @cindex mail splitting
14466 @cindex group mail splitting
14468 @findex gnus-group-split
14469 If you subscribe to dozens of mailing lists but you don't want to
14470 maintain mail splitting rules manually, group mail splitting is for you.
14471 You just have to set @code{to-list} and/or @code{to-address} in group
14472 parameters or group customization and set @code{nnmail-split-methods} to
14473 @code{gnus-group-split}. This splitting function will scan all groups
14474 for those parameters and split mail accordingly, i.e., messages posted
14475 from or to the addresses specified in the parameters @code{to-list} or
14476 @code{to-address} of a mail group will be stored in that group.
14478 Sometimes, mailing lists have multiple addresses, and you may want mail
14479 splitting to recognize them all: just set the @code{extra-aliases} group
14480 parameter to the list of additional addresses and it's done. If you'd
14481 rather use a regular expression, set @code{split-regexp}.
14483 All these parameters in a group will be used to create an
14484 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
14485 the @var{value} is a single regular expression that matches
14486 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
14487 matches of @code{split-regexp}, and the @var{split} is the name of the
14488 group. @var{restrict}s are also supported: just set the
14489 @code{split-exclude} parameter to a list of regular expressions.
14491 If you can't get the right split to be generated using all these
14492 parameters, or you just need something fancier, you can set the
14493 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
14494 this case, all other aforementioned parameters will be ignored by
14495 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
14496 @code{nil}, in which case the group will be ignored by
14497 @code{gnus-group-split}.
14499 @vindex gnus-group-split-default-catch-all-group
14500 @code{gnus-group-split} will do cross-posting on all groups that match,
14501 by defining a single @code{&} fancy split containing one split for each
14502 group. If a message doesn't match any split, it will be stored in the
14503 group named in @code{gnus-group-split-default-catch-all-group}, unless
14504 some group has @code{split-spec} set to @code{catch-all}, in which case
14505 that group is used as the catch-all group. Even though this variable is
14506 often used just to name a group, it may also be set to an arbitrarily
14507 complex fancy split (after all, a group name is a fancy split), and this
14508 may be useful to split mail that doesn't go to any mailing list to
14509 personal mail folders. Note that this fancy split is added as the last
14510 element of a @code{|} split list that also contains a @code{&} split
14511 with the rules extracted from group parameters.
14513 It's time for an example. Assume the following group parameters have
14518 ((to-address . "bar@@femail.com")
14519 (split-regexp . ".*@@femail\\.com"))
14521 ((to-list . "foo@@nowhere.gov")
14522 (extra-aliases "foo@@localhost" "foo-redist@@home")
14523 (split-exclude "bugs-foo" "rambling-foo")
14524 (admin-address . "foo-request@@nowhere.gov"))
14526 ((split-spec . catch-all))
14529 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
14530 behave as if @code{nnmail-split-fancy} had been selected and variable
14531 @code{nnmail-split-fancy} had been set as follows:
14534 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
14535 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
14536 - "bugs-foo" - "rambling-foo" "mail.foo"))
14540 @findex gnus-group-split-fancy
14541 If you'd rather not use group splitting for all your mail groups, you
14542 may use it for only some of them, by using @code{nnmail-split-fancy}
14546 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
14549 @var{groups} may be a regular expression or a list of group names whose
14550 parameters will be scanned to generate the output split.
14551 @var{no-crosspost} can be used to disable cross-posting; in this case, a
14552 single @code{|} split will be output. @var{catch-all} is the fall back
14553 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
14554 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
14555 empty string in any selected group, no catch-all split will be issued.
14556 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
14557 this group will override the value of the @var{catch-all} argument.
14559 @findex gnus-group-split-setup
14560 Unfortunately, scanning all groups and their parameters can be quite
14561 slow, especially considering that it has to be done for every message.
14562 But don't despair! The function @code{gnus-group-split-setup} can be
14563 used to enable @code{gnus-group-split} in a much more efficient way. It
14564 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
14565 @code{nnmail-split-fancy} to the split produced by
14566 @code{gnus-group-split-fancy}. Thus, the group parameters are only
14567 scanned once, no matter how many messages are split.
14569 @findex gnus-group-split-update
14570 However, if you change group parameters, you'd have to update
14571 @code{nnmail-split-fancy} manually. You can do it by running
14572 @code{gnus-group-split-update}. If you'd rather have it updated
14573 automatically, just tell @code{gnus-group-split-setup} to do it for
14574 you. For example, add to your @file{~/.gnus.el}:
14577 (gnus-group-split-setup @var{auto-update} @var{catch-all})
14580 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
14581 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
14582 have to worry about updating @code{nnmail-split-fancy} again. If you
14583 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
14584 @code{gnus-group-split-default-catch-all-group} will be set to its
14587 @vindex gnus-group-split-updated-hook
14588 Because you may want to change @code{nnmail-split-fancy} after it is set
14589 by @code{gnus-group-split-update}, this function will run
14590 @code{gnus-group-split-updated-hook} just before finishing.
14592 @node Incorporating Old Mail
14593 @subsection Incorporating Old Mail
14594 @cindex incorporating old mail
14595 @cindex import old mail
14597 Most people have lots of old mail stored in various file formats. If
14598 you have set up Gnus to read mail using one of the spiffy Gnus mail
14599 back ends, you'll probably wish to have that old mail incorporated into
14602 Doing so can be quite easy.
14604 To take an example: You're reading mail using @code{nnml}
14605 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
14606 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
14607 file filled with important, but old, mail. You want to move it into
14608 your @code{nnml} groups.
14614 Go to the group buffer.
14617 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
14618 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
14621 Type @kbd{SPACE} to enter the newly created group.
14624 Type @kbd{M P b} to process-mark all articles in this group's buffer
14625 (@pxref{Setting Process Marks}).
14628 Type @kbd{B r} to respool all the process-marked articles, and answer
14629 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
14632 All the mail messages in the mbox file will now also be spread out over
14633 all your @code{nnml} groups. Try entering them and check whether things
14634 have gone without a glitch. If things look ok, you may consider
14635 deleting the mbox file, but I wouldn't do that unless I was absolutely
14636 sure that all the mail has ended up where it should be.
14638 Respooling is also a handy thing to do if you're switching from one mail
14639 back end to another. Just respool all the mail in the old mail groups
14640 using the new mail back end.
14643 @node Expiring Mail
14644 @subsection Expiring Mail
14645 @cindex article expiry
14647 Traditional mail readers have a tendency to remove mail articles when
14648 you mark them as read, in some way. Gnus takes a fundamentally
14649 different approach to mail reading.
14651 Gnus basically considers mail just to be news that has been received in
14652 a rather peculiar manner. It does not think that it has the power to
14653 actually change the mail, or delete any mail messages. If you enter a
14654 mail group, and mark articles as ``read'', or kill them in some other
14655 fashion, the mail articles will still exist on the system. I repeat:
14656 Gnus will not delete your old, read mail. Unless you ask it to, of
14659 To make Gnus get rid of your unwanted mail, you have to mark the
14660 articles as @dfn{expirable}. (With the default key bindings, this means
14661 that you have to type @kbd{E}.) This does not mean that the articles
14662 will disappear right away, however. In general, a mail article will be
14663 deleted from your system if, 1) it is marked as expirable, AND 2) it is
14664 more than one week old. If you do not mark an article as expirable, it
14665 will remain on your system until hell freezes over. This bears
14666 repeating one more time, with some spurious capitalizations: IF you do
14667 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
14669 You do not have to mark articles as expirable by hand. Gnus provides
14670 two features, called ``auto-expire'' and ``total-expire'', that can help you
14671 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
14672 for you when you select an article. And ``total-expire'' means that Gnus
14673 considers all articles as expirable that are read. So, in addition to
14674 the articles marked @samp{E}, also the articles marked @samp{r},
14675 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
14678 When should either auto-expire or total-expire be used? Most people
14679 who are subscribed to mailing lists split each list into its own group
14680 and then turn on auto-expire or total-expire for those groups.
14681 (@xref{Splitting Mail}, for more information on splitting each list
14682 into its own group.)
14684 Which one is better, auto-expire or total-expire? It's not easy to
14685 answer. Generally speaking, auto-expire is probably faster. Another
14686 advantage of auto-expire is that you get more marks to work with: for
14687 the articles that are supposed to stick around, you can still choose
14688 between tick and dormant and read marks. But with total-expire, you
14689 only have dormant and ticked to choose from. The advantage of
14690 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
14691 Scoring}). Auto-expire works with normal scoring but not with adaptive
14694 @vindex gnus-auto-expirable-newsgroups
14695 Groups that match the regular expression
14696 @code{gnus-auto-expirable-newsgroups} will have all articles that you
14697 read marked as expirable automatically. All articles marked as
14698 expirable have an @samp{E} in the first column in the summary buffer.
14700 By default, if you have auto expiry switched on, Gnus will mark all the
14701 articles you read as expirable, no matter if they were read or unread
14702 before. To avoid having articles marked as read marked as expirable
14703 automatically, you can put something like the following in your
14704 @file{~/.gnus.el} file:
14706 @vindex gnus-mark-article-hook
14708 (remove-hook 'gnus-mark-article-hook
14709 'gnus-summary-mark-read-and-unread-as-read)
14710 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
14713 Note that making a group auto-expirable doesn't mean that all read
14714 articles are expired---only the articles marked as expirable
14715 will be expired. Also note that using the @kbd{d} command won't make
14716 articles expirable---only semi-automatic marking of articles as read will
14717 mark the articles as expirable in auto-expirable groups.
14719 Let's say you subscribe to a couple of mailing lists, and you want the
14720 articles you have read to disappear after a while:
14723 (setq gnus-auto-expirable-newsgroups
14724 "mail.nonsense-list\\|mail.nice-list")
14727 Another way to have auto-expiry happen is to have the element
14728 @code{auto-expire} in the group parameters of the group.
14730 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
14731 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
14732 don't really mix very well.
14734 @vindex nnmail-expiry-wait
14735 The @code{nnmail-expiry-wait} variable supplies the default time an
14736 expirable article has to live. Gnus starts counting days from when the
14737 message @emph{arrived}, not from when it was sent. The default is seven
14740 Gnus also supplies a function that lets you fine-tune how long articles
14741 are to live, based on what group they are in. Let's say you want to
14742 have one month expiry period in the @samp{mail.private} group, a one day
14743 expiry period in the @samp{mail.junk} group, and a six day expiry period
14746 @vindex nnmail-expiry-wait-function
14748 (setq nnmail-expiry-wait-function
14750 (cond ((string= group "mail.private")
14752 ((string= group "mail.junk")
14754 ((string= group "important")
14760 The group names this function is fed are ``unadorned'' group
14761 names---no @samp{nnml:} prefixes and the like.
14763 The @code{nnmail-expiry-wait} variable and
14764 @code{nnmail-expiry-wait-function} function can either be a number (not
14765 necessarily an integer) or one of the symbols @code{immediate} or
14768 You can also use the @code{expiry-wait} group parameter to selectively
14769 change the expiry period (@pxref{Group Parameters}).
14771 @vindex nnmail-expiry-target
14772 The normal action taken when expiring articles is to delete them.
14773 However, in some circumstances it might make more sense to move them
14774 to other groups instead of deleting them. The variable
14775 @code{nnmail-expiry-target} (and the @code{expiry-target} group
14776 parameter) controls this. The variable supplies a default value for
14777 all groups, which can be overridden for specific groups by the group
14778 parameter. default value is @code{delete}, but this can also be a
14779 string (which should be the name of the group the message should be
14780 moved to), or a function (which will be called in a buffer narrowed to
14781 the message in question, and with the name of the group being moved
14782 from as its parameter) which should return a target---either a group
14783 name or @code{delete}.
14785 Here's an example for specifying a group name:
14787 (setq nnmail-expiry-target "nnml:expired")
14790 @findex nnmail-fancy-expiry-target
14791 @vindex nnmail-fancy-expiry-targets
14792 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
14793 expire mail to groups according to the variable
14794 @code{nnmail-fancy-expiry-targets}. Here's an example:
14797 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
14798 nnmail-fancy-expiry-targets
14799 '((to-from "boss" "nnfolder:Work")
14800 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
14801 ("from" ".*" "nnfolder:Archive-%Y")))
14804 With this setup, any mail that has @code{IMPORTANT} in its Subject
14805 header and was sent in the year @code{YYYY} and month @code{MMM}, will
14806 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
14807 From or To header contains the string @code{boss}, it will get expired
14808 to @code{nnfolder:Work}. All other mail will get expired to
14809 @code{nnfolder:Archive-YYYY}.
14811 @vindex nnmail-keep-last-article
14812 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
14813 expire the final article in a mail newsgroup. This is to make life
14814 easier for procmail users.
14816 @vindex gnus-total-expirable-newsgroups
14817 By the way: That line up there, about Gnus never expiring non-expirable
14818 articles, is a lie. If you put @code{total-expire} in the group
14819 parameters, articles will not be marked as expirable, but all read
14820 articles will be put through the expiry process. Use with extreme
14821 caution. Even more dangerous is the
14822 @code{gnus-total-expirable-newsgroups} variable. All groups that match
14823 this regexp will have all read articles put through the expiry process,
14824 which means that @emph{all} old mail articles in the groups in question
14825 will be deleted after a while. Use with extreme caution, and don't come
14826 crying to me when you discover that the regexp you used matched the
14827 wrong group and all your important mail has disappeared. Be a
14828 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
14831 Most people make most of their mail groups total-expirable, though.
14833 @vindex gnus-inhibit-user-auto-expire
14834 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
14835 commands will not mark an article as expirable, even if the group has
14836 auto-expire turned on.
14840 @subsection Washing Mail
14841 @cindex mail washing
14842 @cindex list server brain damage
14843 @cindex incoming mail treatment
14845 Mailers and list servers are notorious for doing all sorts of really,
14846 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
14847 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
14848 end of all lines passing through our server, so let's do that!!!!1!''
14849 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
14850 considered to be self-evident were not discussed. So. Here we are.
14852 Case in point: The German version of Microsoft Exchange adds @samp{AW:
14853 } to the subjects of replies instead of @samp{Re: }. I could pretend to
14854 be shocked and dismayed by this, but I haven't got the energy. It is to
14857 Gnus provides a plethora of functions for washing articles while
14858 displaying them, but it might be nicer to do the filtering before
14859 storing the mail to disk. For that purpose, we have three hooks and
14860 various functions that can be put in these hooks.
14863 @item nnmail-prepare-incoming-hook
14864 @vindex nnmail-prepare-incoming-hook
14865 This hook is called before doing anything with the mail and is meant for
14866 grand, sweeping gestures. It is called in a buffer that contains all
14867 the new, incoming mail. Functions to be used include:
14870 @item nnheader-ms-strip-cr
14871 @findex nnheader-ms-strip-cr
14872 Remove trailing carriage returns from each line. This is default on
14873 Emacs running on MS machines.
14877 @item nnmail-prepare-incoming-header-hook
14878 @vindex nnmail-prepare-incoming-header-hook
14879 This hook is called narrowed to each header. It can be used when
14880 cleaning up the headers. Functions that can be used include:
14883 @item nnmail-remove-leading-whitespace
14884 @findex nnmail-remove-leading-whitespace
14885 Clear leading white space that ``helpful'' listservs have added to the
14886 headers to make them look nice. Aaah.
14888 (Note that this function works on both the header on the body of all
14889 messages, so it is a potentially dangerous function to use (if a body
14890 of a message contains something that looks like a header line). So
14891 rather than fix the bug, it is of course the right solution to make it
14892 into a feature by documenting it.)
14894 @item nnmail-remove-list-identifiers
14895 @findex nnmail-remove-list-identifiers
14896 Some list servers add an identifier---for example, @samp{(idm)}---to the
14897 beginning of all @code{Subject} headers. I'm sure that's nice for
14898 people who use stone age mail readers. This function will remove
14899 strings that match the @code{nnmail-list-identifiers} regexp, which can
14900 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
14903 For instance, if you want to remove the @samp{(idm)} and the
14904 @samp{nagnagnag} identifiers:
14907 (setq nnmail-list-identifiers
14908 '("(idm)" "nagnagnag"))
14911 This can also be done non-destructively with
14912 @code{gnus-list-identifiers}, @xref{Article Hiding}.
14914 @item nnmail-remove-tabs
14915 @findex nnmail-remove-tabs
14916 Translate all @samp{TAB} characters into @samp{SPACE} characters.
14918 @item nnmail-fix-eudora-headers
14919 @findex nnmail-fix-eudora-headers
14921 Eudora produces broken @code{References} headers, but OK
14922 @code{In-Reply-To} headers. This function will get rid of the
14923 @code{References} headers.
14927 @item nnmail-prepare-incoming-message-hook
14928 @vindex nnmail-prepare-incoming-message-hook
14929 This hook is called narrowed to each message. Functions to be used
14933 @item article-de-quoted-unreadable
14934 @findex article-de-quoted-unreadable
14935 Decode Quoted Readable encoding.
14942 @subsection Duplicates
14944 @vindex nnmail-treat-duplicates
14945 @vindex nnmail-message-id-cache-length
14946 @vindex nnmail-message-id-cache-file
14947 @cindex duplicate mails
14948 If you are a member of a couple of mailing lists, you will sometimes
14949 receive two copies of the same mail. This can be quite annoying, so
14950 @code{nnmail} checks for and treats any duplicates it might find. To do
14951 this, it keeps a cache of old @code{Message-ID}s---
14952 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
14953 default. The approximate maximum number of @code{Message-ID}s stored
14954 there is controlled by the @code{nnmail-message-id-cache-length}
14955 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
14956 stored.) If all this sounds scary to you, you can set
14957 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
14958 default), and @code{nnmail} won't delete duplicate mails. Instead it
14959 will insert a warning into the head of the mail saying that it thinks
14960 that this is a duplicate of a different message.
14962 This variable can also be a function. If that's the case, the function
14963 will be called from a buffer narrowed to the message in question with
14964 the @code{Message-ID} as a parameter. The function must return either
14965 @code{nil}, @code{warn}, or @code{delete}.
14967 You can turn this feature off completely by setting the variable to
14970 If you want all the duplicate mails to be put into a special
14971 @dfn{duplicates} group, you could do that using the normal mail split
14975 (setq nnmail-split-fancy
14976 '(| ;; @r{Messages duplicates go to a separate group.}
14977 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14978 ;; @r{Message from daemons, postmaster, and the like to another.}
14979 (any mail "mail.misc")
14980 ;; @r{Other rules.}
14986 (setq nnmail-split-methods
14987 '(("duplicates" "^Gnus-Warning:.*duplicate")
14988 ;; @r{Other rules.}
14992 Here's a neat feature: If you know that the recipient reads her mail
14993 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14994 @code{delete}, you can send her as many insults as you like, just by
14995 using a @code{Message-ID} of a mail that you know that she's already
14996 received. Think of all the fun! She'll never see any of it! Whee!
14999 @node Not Reading Mail
15000 @subsection Not Reading Mail
15002 If you start using any of the mail back ends, they have the annoying
15003 habit of assuming that you want to read mail with them. This might not
15004 be unreasonable, but it might not be what you want.
15006 If you set @code{mail-sources} and @code{nnmail-spool-file} to
15007 @code{nil}, none of the back ends will ever attempt to read incoming
15008 mail, which should help.
15010 @vindex nnbabyl-get-new-mail
15011 @vindex nnmbox-get-new-mail
15012 @vindex nnml-get-new-mail
15013 @vindex nnmh-get-new-mail
15014 @vindex nnfolder-get-new-mail
15015 This might be too much, if, for instance, you are reading mail quite
15016 happily with @code{nnml} and just want to peek at some old Rmail
15017 file you have stashed away with @code{nnbabyl}. All back ends have
15018 variables called back-end-@code{get-new-mail}. If you want to disable
15019 the @code{nnbabyl} mail reading, you edit the virtual server for the
15020 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
15022 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
15023 narrowed to the article to be saved before saving it when reading
15027 @node Choosing a Mail Back End
15028 @subsection Choosing a Mail Back End
15030 Gnus will read the mail spool when you activate a mail group. The mail
15031 file is first copied to your home directory. What happens after that
15032 depends on what format you want to store your mail in.
15034 There are six different mail back ends in the standard Gnus, and more
15035 back ends are available separately. The mail back end most people use
15036 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
15040 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
15041 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
15042 * Mail Spool:: Store your mail in a private spool?
15043 * MH Spool:: An mhspool-like back end.
15044 * Maildir:: Another one-file-per-message format.
15045 * Mail Folders:: Having one file for each group.
15046 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
15050 @node Unix Mail Box
15051 @subsubsection Unix Mail Box
15053 @cindex unix mail box
15055 @vindex nnmbox-active-file
15056 @vindex nnmbox-mbox-file
15057 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
15058 mail. @code{nnmbox} will add extra headers to each mail article to say
15059 which group it belongs in.
15061 Virtual server settings:
15064 @item nnmbox-mbox-file
15065 @vindex nnmbox-mbox-file
15066 The name of the mail box in the user's home directory. Default is
15069 @item nnmbox-active-file
15070 @vindex nnmbox-active-file
15071 The name of the active file for the mail box. Default is
15072 @file{~/.mbox-active}.
15074 @item nnmbox-get-new-mail
15075 @vindex nnmbox-get-new-mail
15076 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
15077 into groups. Default is @code{t}.
15082 @subsubsection Rmail Babyl
15086 @vindex nnbabyl-active-file
15087 @vindex nnbabyl-mbox-file
15088 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
15089 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
15090 mail article to say which group it belongs in.
15092 Virtual server settings:
15095 @item nnbabyl-mbox-file
15096 @vindex nnbabyl-mbox-file
15097 The name of the Rmail mbox file. The default is @file{~/RMAIL}
15099 @item nnbabyl-active-file
15100 @vindex nnbabyl-active-file
15101 The name of the active file for the rmail box. The default is
15102 @file{~/.rmail-active}
15104 @item nnbabyl-get-new-mail
15105 @vindex nnbabyl-get-new-mail
15106 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
15112 @subsubsection Mail Spool
15114 @cindex mail @acronym{NOV} spool
15116 The @dfn{nnml} spool mail format isn't compatible with any other known
15117 format. It should be used with some caution.
15119 @vindex nnml-directory
15120 If you use this back end, Gnus will split all incoming mail into files,
15121 one file for each mail, and put the articles into the corresponding
15122 directories under the directory specified by the @code{nnml-directory}
15123 variable. The default value is @file{~/Mail/}.
15125 You do not have to create any directories beforehand; Gnus will take
15128 If you have a strict limit as to how many files you are allowed to store
15129 in your account, you should not use this back end. As each mail gets its
15130 own file, you might very well occupy thousands of inodes within a few
15131 weeks. If this is no problem for you, and it isn't a problem for you
15132 having your friendly systems administrator walking around, madly,
15133 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
15134 know that this is probably the fastest format to use. You do not have
15135 to trudge through a big mbox file just to read your new mail.
15137 @code{nnml} is probably the slowest back end when it comes to article
15138 splitting. It has to create lots of files, and it also generates
15139 @acronym{NOV} databases for the incoming mails. This makes it possibly the
15140 fastest back end when it comes to reading mail.
15142 @cindex self contained nnml servers
15144 When the marks file is used (which it is by default), @code{nnml}
15145 servers have the property that you may backup them using @code{tar} or
15146 similar, and later be able to restore them into Gnus (by adding the
15147 proper @code{nnml} server) and have all your marks be preserved. Marks
15148 for a group are usually stored in the @code{.marks} file (but see
15149 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
15150 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
15151 to restore the group (after restoring the backup into the nnml
15154 If for some reason you believe your @file{.marks} files are screwed
15155 up, you can just delete them all. Gnus will then correctly regenerate
15156 them next time it starts.
15158 Virtual server settings:
15161 @item nnml-directory
15162 @vindex nnml-directory
15163 All @code{nnml} directories will be placed under this directory. The
15164 default is the value of @code{message-directory} (whose default value
15167 @item nnml-active-file
15168 @vindex nnml-active-file
15169 The active file for the @code{nnml} server. The default is
15170 @file{~/Mail/active}.
15172 @item nnml-newsgroups-file
15173 @vindex nnml-newsgroups-file
15174 The @code{nnml} group descriptions file. @xref{Newsgroups File
15175 Format}. The default is @file{~/Mail/newsgroups}.
15177 @item nnml-get-new-mail
15178 @vindex nnml-get-new-mail
15179 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
15182 @item nnml-nov-is-evil
15183 @vindex nnml-nov-is-evil
15184 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15185 default is @code{nil}.
15187 @item nnml-nov-file-name
15188 @vindex nnml-nov-file-name
15189 The name of the @acronym{NOV} files. The default is @file{.overview}.
15191 @item nnml-prepare-save-mail-hook
15192 @vindex nnml-prepare-save-mail-hook
15193 Hook run narrowed to an article before saving.
15195 @item nnml-marks-is-evil
15196 @vindex nnml-marks-is-evil
15197 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15198 default is @code{nil}.
15200 @item nnml-marks-file-name
15201 @vindex nnml-marks-file-name
15202 The name of the @dfn{marks} files. The default is @file{.marks}.
15204 @item nnml-use-compressed-files
15205 @vindex nnml-use-compressed-files
15206 If non-@code{nil}, @code{nnml} will allow using compressed message
15207 files. This requires @code{auto-compression-mode} to be enabled
15208 (@pxref{Compressed Files, ,Compressed Files, emacs, The Emacs Manual}).
15209 If the value of @code{nnml-use-compressed-files} is a string, it is used
15210 as the file extension specifying the comression program. You can set it
15211 to @samp{.bz2} if your Emacs supports it. A value of @code{t} is
15212 equivalent to @samp{.gz}.
15214 @item nnml-compressed-files-size-threshold
15215 @vindex nnml-compressed-files-size-threshold
15216 Default size threshold for compressed message files. Message files with
15217 bodies larger than that many characters will be automatically compressed
15218 if @code{nnml-use-compressed-files} is non-@code{nil}.
15222 @findex nnml-generate-nov-databases
15223 If your @code{nnml} groups and @acronym{NOV} files get totally out of
15224 whack, you can do a complete update by typing @kbd{M-x
15225 nnml-generate-nov-databases}. This command will trawl through the
15226 entire @code{nnml} hierarchy, looking at each and every article, so it
15227 might take a while to complete. A better interface to this
15228 functionality can be found in the server buffer (@pxref{Server
15233 @subsubsection MH Spool
15235 @cindex mh-e mail spool
15237 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
15238 @acronym{NOV} databases and it doesn't keep an active file or marks
15239 file. This makes @code{nnmh} a @emph{much} slower back end than
15240 @code{nnml}, but it also makes it easier to write procmail scripts
15243 Virtual server settings:
15246 @item nnmh-directory
15247 @vindex nnmh-directory
15248 All @code{nnmh} directories will be located under this directory. The
15249 default is the value of @code{message-directory} (whose default is
15252 @item nnmh-get-new-mail
15253 @vindex nnmh-get-new-mail
15254 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
15258 @vindex nnmh-be-safe
15259 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
15260 sure that the articles in the folder are actually what Gnus thinks
15261 they are. It will check date stamps and stat everything in sight, so
15262 setting this to @code{t} will mean a serious slow-down. If you never
15263 use anything but Gnus to read the @code{nnmh} articles, you do not
15264 have to set this variable to @code{t}. The default is @code{nil}.
15269 @subsubsection Maildir
15273 @code{nnmaildir} stores mail in the maildir format, with each maildir
15274 corresponding to a group in Gnus. This format is documented here:
15275 @uref{http://cr.yp.to/proto/maildir.html} and here:
15276 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
15277 also stores extra information in the @file{.nnmaildir/} directory
15280 Maildir format was designed to allow concurrent deliveries and
15281 reading, without needing locks. With other back ends, you would have
15282 your mail delivered to a spool of some kind, and then you would
15283 configure Gnus to split mail from that spool into your groups. You
15284 can still do that with @code{nnmaildir}, but the more common
15285 configuration is to have your mail delivered directly to the maildirs
15286 that appear as group in Gnus.
15288 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
15289 never corrupt its data in memory, and @code{SIGKILL} will never
15290 corrupt its data in the filesystem.
15292 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
15293 maildir. So you can copy a whole maildir from one Gnus setup to
15294 another, and you will keep your marks.
15296 Virtual server settings:
15300 For each of your @code{nnmaildir} servers (it's very unlikely that
15301 you'd need more than one), you need to create a directory and populate
15302 it with maildirs or symlinks to maildirs (and nothing else; do not
15303 choose a directory already used for other purposes). Each maildir
15304 will be represented in Gnus as a newsgroup on that server; the
15305 filename of the symlink will be the name of the group. Any filenames
15306 in the directory starting with @samp{.} are ignored. The directory is
15307 scanned when you first start Gnus, and each time you type @kbd{g} in
15308 the group buffer; if any maildirs have been removed or added,
15309 @code{nnmaildir} notices at these times.
15311 The value of the @code{directory} parameter should be a Lisp form
15312 which is processed by @code{eval} and @code{expand-file-name} to get
15313 the path of the directory for this server. The form is @code{eval}ed
15314 only when the server is opened; the resulting string is used until the
15315 server is closed. (If you don't know about forms and @code{eval},
15316 don't worry---a simple string will work.) This parameter is not
15317 optional; you must specify it. I don't recommend using
15318 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
15319 use that directory by default for various things, and may get confused
15320 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
15323 @item target-prefix
15324 This should be a Lisp form which is processed by @code{eval} and
15325 @code{expand-file-name}. The form is @code{eval}ed only when the
15326 server is opened; the resulting string is used until the server is
15329 When you create a group on an @code{nnmaildir} server, the maildir is
15330 created with @code{target-prefix} prepended to its name, and a symlink
15331 pointing to that maildir is created, named with the plain group name.
15332 So if @code{directory} is @code{"~/.nnmaildir"} and
15333 @code{target-prefix} is @code{"../maildirs/"}, then when you create
15334 the group @code{foo}, @code{nnmaildir} will create
15335 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
15336 @file{~/.nnmaildir/foo} as a symlink pointing to
15337 @file{../maildirs/foo}.
15339 You can set @code{target-prefix} to a string without any slashes to
15340 create both maildirs and symlinks in the same @code{directory}; in
15341 this case, any maildirs found in @code{directory} whose names start
15342 with @code{target-prefix} will not be listed as groups (but the
15343 symlinks pointing to them will be).
15345 As a special case, if @code{target-prefix} is @code{""} (the default),
15346 then when you create a group, the maildir will be created in
15347 @code{directory} without a corresponding symlink. Beware that you
15348 cannot use @code{gnus-group-delete-group} on such groups without the
15349 @code{force} argument.
15351 @item directory-files
15352 This should be a function with the same interface as
15353 @code{directory-files} (such as @code{directory-files} itself). It is
15354 used to scan the server's @code{directory} for maildirs. This
15355 parameter is optional; the default is
15356 @code{nnheader-directory-files-safe} if
15357 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15358 @code{directory-files} otherwise.
15359 (@code{nnheader-directory-files-is-safe} is checked only once when the
15360 server is opened; if you want to check it each time the directory is
15361 scanned, you'll have to provide your own function that does that.)
15364 If non-@code{nil}, then after scanning for new mail in the group
15365 maildirs themselves as usual, this server will also incorporate mail
15366 the conventional Gnus way, from @code{mail-sources} according to
15367 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
15368 value is @code{nil}.
15370 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15371 an @code{nnmaildir} group. The results might happen to be useful, but
15372 that would be by chance, not by design, and the results might be
15373 different in the future. If your split rules create new groups,
15374 remember to supply a @code{create-directory} server parameter.
15377 @subsubsection Group parameters
15379 @code{nnmaildir} uses several group parameters. It's safe to ignore
15380 all this; the default behavior for @code{nnmaildir} is the same as the
15381 default behavior for other mail back ends: articles are deleted after
15382 one week, etc. Except for the expiry parameters, all this
15383 functionality is unique to @code{nnmaildir}, so you can ignore it if
15384 you're just trying to duplicate the behavior you already have with
15387 If the value of any of these parameters is a vector, the first element
15388 is evaluated as a Lisp form and the result is used, rather than the
15389 original value. If the value is not a vector, the value itself is
15390 evaluated as a Lisp form. (This is why these parameters use names
15391 different from those of other, similar parameters supported by other
15392 back ends: they have different, though similar, meanings.) (For
15393 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15394 @code{eval} business again; for other values, remember to use an extra
15395 quote and wrap the value in a vector when appropriate.)
15399 An integer specifying the minimum age, in seconds, of an article
15400 before it will be expired, or the symbol @code{never} to specify that
15401 articles should never be expired. If this parameter is not set,
15402 @code{nnmaildir} falls back to the usual
15403 @code{nnmail-expiry-wait}(@code{-function}) variables (the
15404 @code{expiry-wait} group parameter overrides @code{nnmail-expiry-wait}
15405 and makes @code{nnmail-expiry-wait-function} ineffective). If you
15406 wanted a value of 3 days, you could use something like @code{[(* 3 24
15407 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15408 An article's age is measured starting from the article file's
15409 modification time. Normally, this is the same as the article's
15410 delivery time, but editing an article makes it younger. Moving an
15411 article (other than via expiry) may also make an article younger.
15414 If this is set to a string such as a full Gnus group name, like
15416 "backend+server.address.string:group.name"
15418 and if it is not the name of the same group that the parameter belongs
15419 to, then articles will be moved to the specified group during expiry
15420 before being deleted. @emph{If this is set to an @code{nnmaildir}
15421 group, the article will be just as old in the destination group as it
15422 was in the source group.} So be careful with @code{expire-age} in the
15423 destination group. If this is set to the name of the same group that
15424 the parameter belongs to, then the article is not expired at all. If
15425 you use the vector form, the first element is evaluated once for each
15426 article. So that form can refer to
15427 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15428 article. @emph{Even if this parameter is not set, @code{nnmaildir}
15429 does not fall back to the @code{expiry-target} group parameter or the
15430 @code{nnmail-expiry-target} variable.}
15433 If this is set to @code{t}, @code{nnmaildir} will treat the articles
15434 in this maildir as read-only. This means: articles are not renamed
15435 from @file{new/} into @file{cur/}; articles are only found in
15436 @file{new/}, not @file{cur/}; articles are never deleted; articles
15437 cannot be edited. @file{new/} is expected to be a symlink to the
15438 @file{new/} directory of another maildir---e.g., a system-wide mailbox
15439 containing a mailing list of common interest. Everything in the
15440 maildir outside @file{new/} is @emph{not} treated as read-only, so for
15441 a shared mailbox, you do still need to set up your own maildir (or
15442 have write permission to the shared mailbox); your maildir just won't
15443 contain extra copies of the articles.
15445 @item directory-files
15446 A function with the same interface as @code{directory-files}. It is
15447 used to scan the directories in the maildir corresponding to this
15448 group to find articles. The default is the function specified by the
15449 server's @code{directory-files} parameter.
15451 @item distrust-Lines:
15452 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
15453 article, rather than use the @code{Lines:} header field. If
15454 @code{nil}, the header field will be used if present.
15457 A list of mark symbols, such as @code{['(read expire)]}. Whenever
15458 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15459 say that all articles have these marks, regardless of whether the
15460 marks stored in the filesystem say so. This is a proof-of-concept
15461 feature that will probably be removed eventually; it ought to be done
15462 in Gnus proper, or abandoned if it's not worthwhile.
15465 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
15466 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15467 say that no articles have these marks, regardless of whether the marks
15468 stored in the filesystem say so. @code{never-marks} overrides
15469 @code{always-marks}. This is a proof-of-concept feature that will
15470 probably be removed eventually; it ought to be done in Gnus proper, or
15471 abandoned if it's not worthwhile.
15473 @item nov-cache-size
15474 An integer specifying the size of the @acronym{NOV} memory cache. To
15475 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
15476 for a limited number of articles in each group. (This is probably not
15477 worthwhile, and will probably be removed in the future.) This
15478 parameter's value is noticed only the first time a group is seen after
15479 the server is opened---i.e., when you first start Gnus, typically.
15480 The @acronym{NOV} cache is never resized until the server is closed
15481 and reopened. The default is an estimate of the number of articles
15482 that would be displayed in the summary buffer: a count of articles
15483 that are either marked with @code{tick} or not marked with
15484 @code{read}, plus a little extra.
15487 @subsubsection Article identification
15488 Articles are stored in the @file{cur/} subdirectory of each maildir.
15489 Each article file is named like @code{uniq:info}, where @code{uniq}
15490 contains no colons. @code{nnmaildir} ignores, but preserves, the
15491 @code{:info} part. (Other maildir readers typically use this part of
15492 the filename to store marks.) The @code{uniq} part uniquely
15493 identifies the article, and is used in various places in the
15494 @file{.nnmaildir/} subdirectory of the maildir to store information
15495 about the corresponding article. The full pathname of an article is
15496 available in the variable @code{nnmaildir-article-file-name} after you
15497 request the article in the summary buffer.
15499 @subsubsection NOV data
15500 An article identified by @code{uniq} has its @acronym{NOV} data (used
15501 to generate lines in the summary buffer) stored in
15502 @code{.nnmaildir/nov/uniq}. There is no
15503 @code{nnmaildir-generate-nov-databases} function. (There isn't much
15504 need for it---an article's @acronym{NOV} data is updated automatically
15505 when the article or @code{nnmail-extra-headers} has changed.) You can
15506 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
15507 single article simply by deleting the corresponding @acronym{NOV}
15508 file, but @emph{beware}: this will also cause @code{nnmaildir} to
15509 assign a new article number for this article, which may cause trouble
15510 with @code{seen} marks, the Agent, and the cache.
15512 @subsubsection Article marks
15513 An article identified by @code{uniq} is considered to have the mark
15514 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
15515 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
15516 looks for such files and reports the set of marks it finds. When Gnus
15517 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
15518 creates and deletes the corresponding files as needed. (Actually,
15519 rather than create a new file for each mark, it just creates hard
15520 links to @file{.nnmaildir/markfile}, to save inodes.)
15522 You can invent new marks by creating a new directory in
15523 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
15524 your server, untar it later, and keep your marks. You can add and
15525 remove marks yourself by creating and deleting mark files. If you do
15526 this while Gnus is running and your @code{nnmaildir} server is open,
15527 it's best to exit all summary buffers for @code{nnmaildir} groups and
15528 type @kbd{s} in the group buffer first, and to type @kbd{g} or
15529 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
15530 pick up the changes, and might undo them.
15534 @subsubsection Mail Folders
15536 @cindex mbox folders
15537 @cindex mail folders
15539 @code{nnfolder} is a back end for storing each mail group in a
15540 separate file. Each file is in the standard Un*x mbox format.
15541 @code{nnfolder} will add extra headers to keep track of article
15542 numbers and arrival dates.
15544 @cindex self contained nnfolder servers
15546 When the marks file is used (which it is by default), @code{nnfolder}
15547 servers have the property that you may backup them using @code{tar} or
15548 similar, and later be able to restore them into Gnus (by adding the
15549 proper @code{nnfolder} server) and have all your marks be preserved.
15550 Marks for a group are usually stored in a file named as the mbox file
15551 with @code{.mrk} concatenated to it (but see
15552 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
15553 directory. Individual @code{nnfolder} groups are also possible to
15554 backup, use @kbd{G m} to restore the group (after restoring the backup
15555 into the @code{nnfolder} directory).
15557 Virtual server settings:
15560 @item nnfolder-directory
15561 @vindex nnfolder-directory
15562 All the @code{nnfolder} mail boxes will be stored under this
15563 directory. The default is the value of @code{message-directory}
15564 (whose default is @file{~/Mail})
15566 @item nnfolder-active-file
15567 @vindex nnfolder-active-file
15568 The name of the active file. The default is @file{~/Mail/active}.
15570 @item nnfolder-newsgroups-file
15571 @vindex nnfolder-newsgroups-file
15572 The name of the group descriptions file. @xref{Newsgroups File
15573 Format}. The default is @file{~/Mail/newsgroups}
15575 @item nnfolder-get-new-mail
15576 @vindex nnfolder-get-new-mail
15577 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
15578 default is @code{t}
15580 @item nnfolder-save-buffer-hook
15581 @vindex nnfolder-save-buffer-hook
15582 @cindex backup files
15583 Hook run before saving the folders. Note that Emacs does the normal
15584 backup renaming of files even with the @code{nnfolder} buffers. If
15585 you wish to switch this off, you could say something like the
15586 following in your @file{.emacs} file:
15589 (defun turn-off-backup ()
15590 (set (make-local-variable 'backup-inhibited) t))
15592 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
15595 @item nnfolder-delete-mail-hook
15596 @vindex nnfolder-delete-mail-hook
15597 Hook run in a buffer narrowed to the message that is to be deleted.
15598 This function can be used to copy the message to somewhere else, or to
15599 extract some information from it before removing it.
15601 @item nnfolder-nov-is-evil
15602 @vindex nnfolder-nov-is-evil
15603 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15604 default is @code{nil}.
15606 @item nnfolder-nov-file-suffix
15607 @vindex nnfolder-nov-file-suffix
15608 The extension for @acronym{NOV} files. The default is @file{.nov}.
15610 @item nnfolder-nov-directory
15611 @vindex nnfolder-nov-directory
15612 The directory where the @acronym{NOV} files should be stored. If
15613 @code{nil}, @code{nnfolder-directory} is used.
15615 @item nnfolder-marks-is-evil
15616 @vindex nnfolder-marks-is-evil
15617 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15618 default is @code{nil}.
15620 @item nnfolder-marks-file-suffix
15621 @vindex nnfolder-marks-file-suffix
15622 The extension for @sc{marks} files. The default is @file{.mrk}.
15624 @item nnfolder-marks-directory
15625 @vindex nnfolder-marks-directory
15626 The directory where the @sc{marks} files should be stored. If
15627 @code{nil}, @code{nnfolder-directory} is used.
15632 @findex nnfolder-generate-active-file
15633 @kindex M-x nnfolder-generate-active-file
15634 If you have lots of @code{nnfolder}-like files you'd like to read with
15635 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
15636 command to make @code{nnfolder} aware of all likely files in
15637 @code{nnfolder-directory}. This only works if you use long file names,
15640 @node Comparing Mail Back Ends
15641 @subsubsection Comparing Mail Back Ends
15643 First, just for terminology, the @dfn{back end} is the common word for a
15644 low-level access method---a transport, if you will, by which something
15645 is acquired. The sense is that one's mail has to come from somewhere,
15646 and so selection of a suitable back end is required in order to get that
15647 mail within spitting distance of Gnus.
15649 The same concept exists for Usenet itself: Though access to articles is
15650 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
15651 in the world got at Usenet by running a reader on the machine where the
15652 articles lay (the machine which today we call an @acronym{NNTP} server), and
15653 access was by the reader stepping into the articles' directory spool
15654 area directly. One can still select between either the @code{nntp} or
15655 @code{nnspool} back ends, to select between these methods, if one happens
15656 actually to live on the server (or can see its spool directly, anyway,
15659 The goal in selecting a mail back end is to pick one which
15660 simultaneously represents a suitable way of dealing with the original
15661 format plus leaving mail in a form that is convenient to use in the
15662 future. Here are some high and low points on each:
15667 UNIX systems have historically had a single, very common, and well-
15668 defined format. All messages arrive in a single @dfn{spool file}, and
15669 they are delineated by a line whose regular expression matches
15670 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
15671 to make it clear in this instance that this is not the RFC-specified
15672 @samp{From:} header.) Because Emacs and therefore Gnus emanate
15673 historically from the Unix environment, it is simplest if one does not
15674 mess a great deal with the original mailbox format, so if one chooses
15675 this back end, Gnus' primary activity in getting mail from the real spool
15676 area to Gnus' preferred directory is simply to copy it, with no
15677 (appreciable) format change in the process. It is the ``dumbest'' way
15678 to move mail into availability in the Gnus environment. This makes it
15679 fast to move into place, but slow to parse, when Gnus has to look at
15684 Once upon a time, there was the DEC-10 and DEC-20, running operating
15685 systems called TOPS and related things, and the usual (only?) mail
15686 reading environment was a thing called Babyl. I don't know what format
15687 was used for mail landing on the system, but Babyl had its own internal
15688 format to which mail was converted, primarily involving creating a
15689 spool-file-like entity with a scheme for inserting Babyl-specific
15690 headers and status bits above the top of each message in the file.
15691 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
15692 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
15693 to understand the mail files folks already had in existence. Gnus (and
15694 VM, for that matter) continue to support this format because it's
15695 perceived as having some good qualities in those mailer-specific
15696 headers/status bits stuff. Rmail itself still exists as well, of
15697 course, and is still maintained by Stallman.
15699 Both of the above forms leave your mail in a single file on your
15700 file system, and they must parse that entire file each time you take a
15705 @code{nnml} is the back end which smells the most as though you were
15706 actually operating with an @code{nnspool}-accessed Usenet system. (In
15707 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
15708 lo these years ago.) One's mail is taken from the original spool file,
15709 and is then cut up into individual message files, 1:1. It maintains a
15710 Usenet-style active file (analogous to what one finds in an INN- or
15711 CNews-based news system in (for instance) @file{/var/lib/news/active},
15712 or what is returned via the @samp{NNTP LIST} verb) and also creates
15713 @dfn{overview} files for efficient group entry, as has been defined for
15714 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
15715 due to the creation of lots of files, updates to the @code{nnml} active
15716 file, and additions to overview files on a per-message basis, but it is
15717 extremely fast on access because of what amounts to the indexing support
15718 provided by the active file and overviews.
15720 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
15721 resource which defines available places in the file system to put new
15722 files. Sysadmins take a dim view of heavy inode occupation within
15723 tight, shared file systems. But if you live on a personal machine where
15724 the file system is your own and space is not at a premium, @code{nnml}
15727 It is also problematic using this back end if you are living in a
15728 FAT16-based Windows world, since much space will be wasted on all these
15733 The Rand MH mail-reading system has been around UNIX systems for a very
15734 long time; it operates by splitting one's spool file of messages into
15735 individual files, but with little or no indexing support---@code{nnmh}
15736 is considered to be semantically equivalent to ``@code{nnml} without
15737 active file or overviews''. This is arguably the worst choice, because
15738 one gets the slowness of individual file creation married to the
15739 slowness of access parsing when learning what's new in one's groups.
15743 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
15744 method described above) on a per-group basis. That is, @code{nnmbox}
15745 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
15746 little bit of optimization to this so that each of one's mail groups has
15747 a Unix mail box file. It's faster than @code{nnmbox} because each group
15748 can be parsed separately, and still provides the simple Unix mail box
15749 format requiring minimal effort in moving the mail around. In addition,
15750 it maintains an ``active'' file making it much faster for Gnus to figure
15751 out how many messages there are in each separate group.
15753 If you have groups that are expected to have a massive amount of
15754 messages, @code{nnfolder} is not the best choice, but if you receive
15755 only a moderate amount of mail, @code{nnfolder} is probably the most
15756 friendly mail back end all over.
15760 For configuring expiry and other things, @code{nnmaildir} uses
15761 incompatible group parameters, slightly different from those of other
15764 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
15765 differences. Each message is stored in a separate file, but the
15766 filename is unrelated to the article number in Gnus. @code{nnmaildir}
15767 also stores the equivalent of @code{nnml}'s overview files in one file
15768 per article, so it uses about twice as many inodes as @code{nnml}. (Use
15769 @code{df -i} to see how plentiful your inode supply is.) If this slows
15770 you down or takes up very much space, consider switching to
15771 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
15774 Since maildirs don't require locking for delivery, the maildirs you use
15775 as groups can also be the maildirs your mail is directly delivered to.
15776 This means you can skip Gnus' mail splitting if your mail is already
15777 organized into different mailboxes during delivery. A @code{directory}
15778 entry in @code{mail-sources} would have a similar effect, but would
15779 require one set of mailboxes for spooling deliveries (in mbox format,
15780 thus damaging message bodies), and another set to be used as groups (in
15781 whatever format you like). A maildir has a built-in spool, in the
15782 @code{new/} subdirectory. Beware that currently, mail moved from
15783 @code{new/} to @code{cur/} instead of via mail splitting will not
15784 undergo treatment such as duplicate checking.
15786 @code{nnmaildir} stores article marks for a given group in the
15787 corresponding maildir, in a way designed so that it's easy to manipulate
15788 them from outside Gnus. You can tar up a maildir, unpack it somewhere
15789 else, and still have your marks. @code{nnml} also stores marks, but
15790 it's not as easy to work with them from outside Gnus as with
15793 @code{nnmaildir} uses a significant amount of memory to speed things up.
15794 (It keeps in memory some of the things that @code{nnml} stores in files
15795 and that @code{nnmh} repeatedly parses out of message files.) If this
15796 is a problem for you, you can set the @code{nov-cache-size} group
15797 parameter to something small (0 would probably not work, but 1 probably
15798 would) to make it use less memory. This caching will probably be
15799 removed in the future.
15801 Startup is likely to be slower with @code{nnmaildir} than with other
15802 back ends. Everything else is likely to be faster, depending in part
15803 on your file system.
15805 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
15806 to write an @code{nnmaildir}-derived back end.
15811 @node Browsing the Web
15812 @section Browsing the Web
15814 @cindex browsing the web
15818 Web-based discussion forums are getting more and more popular. On many
15819 subjects, the web-based forums have become the most important forums,
15820 eclipsing the importance of mailing lists and news groups. The reason
15821 is easy to understand---they are friendly to new users; you just point
15822 and click, and there's the discussion. With mailing lists, you have to
15823 go through a cumbersome subscription procedure, and most people don't
15824 even know what a news group is.
15826 The problem with this scenario is that web browsers are not very good at
15827 being newsreaders. They do not keep track of what articles you've read;
15828 they do not allow you to score on subjects you're interested in; they do
15829 not allow off-line browsing; they require you to click around and drive
15830 you mad in the end.
15832 So---if web browsers suck at reading discussion forums, why not use Gnus
15835 Gnus has been getting a bit of a collection of back ends for providing
15836 interfaces to these sources.
15840 * Web Searches:: Creating groups from articles that match a string.
15841 * Slashdot:: Reading the Slashdot comments.
15842 * Ultimate:: The Ultimate Bulletin Board systems.
15843 * Web Archive:: Reading mailing list archived on web.
15844 * RSS:: Reading RDF site summary.
15845 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
15848 All the web sources require Emacs/W3 and the url library or those
15849 alternatives to work.
15851 The main caveat with all these web sources is that they probably won't
15852 work for a very long time. Gleaning information from the @acronym{HTML} data
15853 is guesswork at best, and when the layout is altered, the Gnus back end
15854 will fail. If you have reasonably new versions of these back ends,
15855 though, you should be ok.
15857 One thing all these Web methods have in common is that the Web sources
15858 are often down, unavailable or just plain too slow to be fun. In those
15859 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
15860 Unplugged}) handle downloading articles, and then you can read them at
15861 leisure from your local disk. No more World Wide Wait for you.
15863 @node Archiving Mail
15864 @subsection Archiving Mail
15865 @cindex archiving mail
15866 @cindex backup of mail
15868 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
15869 @code{nnmaildir}, now actually store the article marks with each group.
15870 For these servers, archiving and restoring a group while preserving
15871 marks is fairly simple.
15873 (Preserving the group level and group parameters as well still
15874 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
15877 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
15878 server, take a recursive copy of the server directory. There is no need
15879 to shut down Gnus, so archiving may be invoked by @code{cron} or
15880 similar. You restore the data by restoring the directory tree, and
15881 adding a server definition pointing to that directory in Gnus. The
15882 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
15883 might interfere with overwriting data, so you may want to shut down Gnus
15884 before you restore the data.
15886 It is also possible to archive individual @code{nnml},
15887 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
15888 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
15889 directory. For @code{nnfolder} you need to copy both the base folder
15890 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
15891 this example). Restoring the group is done with @kbd{G m} from the Group
15892 buffer. The last step makes Gnus notice the new directory.
15893 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
15894 is unnecessary in that case.
15897 @subsection Web Searches
15902 @cindex Usenet searches
15903 @cindex searching the Usenet
15905 It's, like, too neat to search the Usenet for articles that match a
15906 string, but it, like, totally @emph{sucks}, like, totally, to use one of
15907 those, like, Web browsers, and you, like, have to, rilly, like, look at
15908 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
15909 searches without having to use a browser.
15911 The @code{nnweb} back end allows an easy interface to the mighty search
15912 engine. You create an @code{nnweb} group, enter a search pattern, and
15913 then enter the group and read the articles like you would any normal
15914 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
15915 Groups}) will do this in an easy-to-use fashion.
15917 @code{nnweb} groups don't really lend themselves to being solid
15918 groups---they have a very fleeting idea of article numbers. In fact,
15919 each time you enter an @code{nnweb} group (not even changing the search
15920 pattern), you are likely to get the articles ordered in a different
15921 manner. Not even using duplicate suppression (@pxref{Duplicate
15922 Suppression}) will help, since @code{nnweb} doesn't even know the
15923 @code{Message-ID} of the articles before reading them using some search
15924 engines (Google, for instance). The only possible way to keep track
15925 of which articles you've read is by scoring on the @code{Date}
15926 header---mark all articles posted before the last date you read the
15929 If the search engine changes its output substantially, @code{nnweb}
15930 won't be able to parse it and will fail. One could hardly fault the Web
15931 providers if they were to do this---their @emph{raison d'@^etre} is to
15932 make money off of advertisements, not to provide services to the
15933 community. Since @code{nnweb} washes the ads off all the articles, one
15934 might think that the providers might be somewhat miffed. We'll see.
15936 You must have the @code{url} and @code{W3} package or those alternatives
15937 (try @code{customize-group} on the @samp{mm-url} variable group)
15938 installed to be able to use @code{nnweb}.
15940 Virtual server variables:
15945 What search engine type is being used. The currently supported types
15946 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
15947 @code{dejanews} is an alias to @code{google}.
15950 @vindex nnweb-search
15951 The search string to feed to the search engine.
15953 @item nnweb-max-hits
15954 @vindex nnweb-max-hits
15955 Advisory maximum number of hits per search to display. The default is
15958 @item nnweb-type-definition
15959 @vindex nnweb-type-definition
15960 Type-to-definition alist. This alist says what @code{nnweb} should do
15961 with the various search engine types. The following elements must be
15966 Function to decode the article and provide something that Gnus
15970 Function to create an article number to message header and URL alist.
15973 Function to send the search string to the search engine.
15976 The address the aforementioned function should send the search string
15980 Format string URL to fetch an article by @code{Message-ID}.
15987 @subsection Slashdot
15991 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
15992 lively discussion following the news articles. @code{nnslashdot} will
15993 let you read this forum in a convenient manner.
15995 The easiest way to read this source is to put something like the
15996 following in your @file{~/.gnus.el} file:
15999 (setq gnus-secondary-select-methods
16000 '((nnslashdot "")))
16003 This will make Gnus query the @code{nnslashdot} back end for new comments
16004 and groups. The @kbd{F} command will subscribe each new news article as
16005 a new Gnus group, and you can read the comments by entering these
16006 groups. (Note that the default subscription method is to subscribe new
16007 groups as zombies. Other methods are available (@pxref{Subscription
16010 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
16011 command is the most handy tool (@pxref{Foreign Groups}).
16013 When following up to @code{nnslashdot} comments (or posting new
16014 comments), some light @acronym{HTML}izations will be performed. In
16015 particular, text quoted with @samp{> } will be quoted with
16016 @samp{blockquote} instead, and signatures will have @samp{br} added to
16017 the end of each line. Other than that, you can just write @acronym{HTML}
16018 directly into the message buffer. Note that Slashdot filters out some
16019 @acronym{HTML} forms.
16021 The following variables can be altered to change its behavior:
16024 @item nnslashdot-threaded
16025 Whether @code{nnslashdot} should display threaded groups or not. The
16026 default is @code{t}. To be able to display threads, @code{nnslashdot}
16027 has to retrieve absolutely all comments in a group upon entry. If a
16028 threaded display is not required, @code{nnslashdot} will only retrieve
16029 the comments that are actually wanted by the user. Threading is nicer,
16030 but much, much slower than unthreaded.
16032 @item nnslashdot-login-name
16033 @vindex nnslashdot-login-name
16034 The login name to use when posting.
16036 @item nnslashdot-password
16037 @vindex nnslashdot-password
16038 The password to use when posting.
16040 @item nnslashdot-directory
16041 @vindex nnslashdot-directory
16042 Where @code{nnslashdot} will store its files. The default is
16043 @file{~/News/slashdot/}.
16045 @item nnslashdot-active-url
16046 @vindex nnslashdot-active-url
16047 The @acronym{URL} format string that will be used to fetch the
16048 information on news articles and comments. The default is@*
16049 @samp{http://slashdot.org/search.pl?section=&min=%d}.
16051 @item nnslashdot-comments-url
16052 @vindex nnslashdot-comments-url
16053 The @acronym{URL} format string that will be used to fetch comments.
16055 @item nnslashdot-article-url
16056 @vindex nnslashdot-article-url
16057 The @acronym{URL} format string that will be used to fetch the news
16058 article. The default is
16059 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
16061 @item nnslashdot-threshold
16062 @vindex nnslashdot-threshold
16063 The score threshold. The default is -1.
16065 @item nnslashdot-group-number
16066 @vindex nnslashdot-group-number
16067 The number of old groups, in addition to the ten latest, to keep
16068 updated. The default is 0.
16075 @subsection Ultimate
16077 @cindex Ultimate Bulletin Board
16079 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
16080 probably the most popular Web bulletin board system used. It has a
16081 quite regular and nice interface, and it's possible to get the
16082 information Gnus needs to keep groups updated.
16084 The easiest way to get started with @code{nnultimate} is to say
16085 something like the following in the group buffer: @kbd{B nnultimate RET
16086 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
16087 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
16088 you're interested in; there's quite a list of them on the Ultimate web
16089 site.) Then subscribe to the groups you're interested in from the
16090 server buffer, and read them from the group buffer.
16092 The following @code{nnultimate} variables can be altered:
16095 @item nnultimate-directory
16096 @vindex nnultimate-directory
16097 The directory where @code{nnultimate} stores its files. The default is@*
16098 @file{~/News/ultimate/}.
16103 @subsection Web Archive
16105 @cindex Web Archive
16107 Some mailing lists only have archives on Web servers, such as
16108 @uref{http://www.egroups.com/} and
16109 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
16110 interface, and it's possible to get the information Gnus needs to keep
16113 @findex gnus-group-make-warchive-group
16114 The easiest way to get started with @code{nnwarchive} is to say
16115 something like the following in the group buffer: @kbd{M-x
16116 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
16117 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
16118 @var{an_egroup} with the mailing list you subscribed, the
16119 @var{your@@email.address} with your email address.), or to browse the
16120 back end by @kbd{B nnwarchive RET mail-archive RET}.
16122 The following @code{nnwarchive} variables can be altered:
16125 @item nnwarchive-directory
16126 @vindex nnwarchive-directory
16127 The directory where @code{nnwarchive} stores its files. The default is@*
16128 @file{~/News/warchive/}.
16130 @item nnwarchive-login
16131 @vindex nnwarchive-login
16132 The account name on the web server.
16134 @item nnwarchive-passwd
16135 @vindex nnwarchive-passwd
16136 The password for your account on the web server.
16144 Some web sites have an RDF Site Summary (@acronym{RSS}).
16145 @acronym{RSS} is a format for summarizing headlines from news related
16146 sites (such as BBC or CNN). But basically anything list-like can be
16147 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
16148 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
16150 @acronym{RSS} has a quite regular and nice interface, and it's
16151 possible to get the information Gnus needs to keep groups updated.
16153 Note: you had better use Emacs which supports the @code{utf-8} coding
16154 system because @acronym{RSS} uses UTF-8 for encoding non-@acronym{ASCII}
16155 text by default. It is also used by default for non-@acronym{ASCII}
16158 @kindex G R (Group)
16159 Use @kbd{G R} from the group buffer to subscribe to a feed---you will be
16160 prompted for the location, the title and the description of the feed.
16161 The title, which allows any characters, will be used for the group name
16162 and the name of the group data file. The description can be omitted.
16164 An easy way to get started with @code{nnrss} is to say something like
16165 the following in the group buffer: @kbd{B nnrss RET RET y}, then
16166 subscribe to groups.
16168 The @code{nnrss} back end saves the group data file in
16169 @code{nnrss-directory} (see below) for each @code{nnrss} group. File
16170 names containing non-@acronym{ASCII} characters will be encoded by the
16171 coding system specified with the @code{nnmail-pathname-coding-system}
16172 variable. If it is @code{nil}, in Emacs the coding system defaults to
16173 the value of @code{default-file-name-coding-system}. If you are using
16174 XEmacs and want to use non-@acronym{ASCII} group names, you should set
16175 the value for the @code{nnmail-pathname-coding-system} variable properly.
16177 The @code{nnrss} back end generates @samp{multipart/alternative}
16178 @acronym{MIME} articles in which each contains a @samp{text/plain} part
16179 and a @samp{text/html} part.
16182 You can also use the following commands to import and export your
16183 subscriptions from a file in @acronym{OPML} format (Outline Processor
16186 @defun nnrss-opml-import file
16187 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
16191 @defun nnrss-opml-export
16192 Write your current @acronym{RSS} subscriptions to a buffer in
16193 @acronym{OPML} format.
16196 The following @code{nnrss} variables can be altered:
16199 @item nnrss-directory
16200 @vindex nnrss-directory
16201 The directory where @code{nnrss} stores its files. The default is
16202 @file{~/News/rss/}.
16204 @item nnrss-file-coding-system
16205 @vindex nnrss-file-coding-system
16206 The coding system used when reading and writing the @code{nnrss} groups
16207 data files. The default is the value of
16208 @code{mm-universal-coding-system} (which defaults to @code{emacs-mule}
16209 in Emacs or @code{escape-quoted} in XEmacs).
16211 @item nnrss-use-local
16212 @vindex nnrss-use-local
16213 @findex nnrss-generate-download-script
16214 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
16215 the feeds from local files in @code{nnrss-directory}. You can use
16216 the command @code{nnrss-generate-download-script} to generate a
16217 download script using @command{wget}.
16219 @item nnrss-wash-html-in-text-plain-parts
16220 Non-@code{nil} means that @code{nnrss} renders text in @samp{text/plain}
16221 parts as @acronym{HTML}. The function specified by the
16222 @code{mm-text-html-renderer} variable (@pxref{Display Customization,
16223 ,Display Customization, emacs-mime, The Emacs MIME Manual}) will be used
16224 to render text. If it is @code{nil}, which is the default, text will
16225 simply be folded. Leave it @code{nil} if you prefer to see
16226 @samp{text/html} parts.
16229 The following code may be helpful, if you want to show the description in
16230 the summary buffer.
16233 (add-to-list 'nnmail-extra-headers nnrss-description-field)
16234 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
16236 (defun gnus-user-format-function-X (header)
16238 (assq nnrss-description-field (mail-header-extra header))))
16239 (if descr (concat "\n\t" (cdr descr)) "")))
16242 The following code may be useful to open an nnrss url directly from the
16246 (require 'browse-url)
16248 (defun browse-nnrss-url( arg )
16250 (let ((url (assq nnrss-url-field
16253 (assq (gnus-summary-article-number)
16254 gnus-newsgroup-data))))))
16257 (browse-url (cdr url))
16258 (gnus-summary-mark-as-read-forward 1))
16259 (gnus-summary-scroll-up arg))))
16261 (eval-after-load "gnus"
16262 #'(define-key gnus-summary-mode-map
16263 (kbd "<RET>") 'browse-nnrss-url))
16264 (add-to-list 'nnmail-extra-headers nnrss-url-field)
16267 Even if you have added @code{"text/html"} to the
16268 @code{mm-discouraged-alternatives} variable (@pxref{Display
16269 Customization, ,Display Customization, emacs-mime, The Emacs MIME
16270 Manual}) since you don't want to see @acronym{HTML} parts, it might be
16271 more useful especially in @code{nnrss} groups to display
16272 @samp{text/html} parts. Here's an example of setting
16273 @code{mm-discouraged-alternatives} as a group parameter (@pxref{Group
16274 Parameters}) in order to display @samp{text/html} parts only in
16275 @code{nnrss} groups:
16278 ;; @r{Set the default value of @code{mm-discouraged-alternatives}.}
16279 (eval-after-load "gnus-sum"
16281 'gnus-newsgroup-variables
16282 '(mm-discouraged-alternatives
16283 . '("text/html" "image/.*"))))
16285 ;; @r{Display @samp{text/html} parts in @code{nnrss} groups.}
16288 '("\\`nnrss:" (mm-discouraged-alternatives nil)))
16292 @node Customizing W3
16293 @subsection Customizing W3
16299 Gnus uses the url library to fetch web pages and Emacs/W3 (or those
16300 alternatives) to display web pages. Emacs/W3 is documented in its own
16301 manual, but there are some things that may be more relevant for Gnus
16304 For instance, a common question is how to make Emacs/W3 follow links
16305 using the @code{browse-url} functions (which will call some external web
16306 browser like Netscape). Here's one way:
16309 (eval-after-load "w3"
16311 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
16312 (defun w3-fetch (&optional url target)
16313 (interactive (list (w3-read-url-with-default)))
16314 (if (eq major-mode 'gnus-article-mode)
16316 (w3-fetch-orig url target)))))
16319 Put that in your @file{.emacs} file, and hitting links in W3-rendered
16320 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
16327 @cindex @acronym{IMAP}
16329 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
16330 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
16331 server is much similar to connecting to a news server, you just
16332 specify the network address of the server.
16334 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
16335 everything that @acronym{POP} can, it can hence be viewed as a
16336 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
16337 similar to @acronym{NNTP} being a news storage protocol---however,
16338 @acronym{IMAP} offers more features than @acronym{NNTP} because news
16339 is more or less read-only whereas mail is read-write.
16341 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
16342 entry in @code{mail-sources}. With this, Gnus will fetch mails from
16343 the @acronym{IMAP} server and store them on the local disk. This is
16344 not the usage described in this section---@xref{Mail Sources}.
16346 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
16347 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
16348 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
16349 usage explained in this section.
16351 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
16352 servers might look something like the following. (Note that for
16353 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
16357 (setq gnus-secondary-select-methods
16358 '((nnimap "simpleserver") ; @r{no special configuration}
16359 ; @r{perhaps a ssh port forwarded server:}
16361 (nnimap-address "localhost")
16362 (nnimap-server-port 1430))
16363 ; @r{a UW server running on localhost}
16365 (nnimap-server-port 143)
16366 (nnimap-address "localhost")
16367 (nnimap-list-pattern ("INBOX" "mail/*")))
16368 ; @r{anonymous public cyrus server:}
16369 (nnimap "cyrus.andrew.cmu.edu"
16370 (nnimap-authenticator anonymous)
16371 (nnimap-list-pattern "archive.*")
16372 (nnimap-stream network))
16373 ; @r{a ssl server on a non-standard port:}
16375 (nnimap-address "vic20.somewhere.com")
16376 (nnimap-server-port 9930)
16377 (nnimap-stream ssl))))
16380 After defining the new server, you can subscribe to groups on the
16381 server using normal Gnus commands such as @kbd{U} in the Group Buffer
16382 (@pxref{Subscription Commands}) or via the Server Buffer
16383 (@pxref{Server Buffer}).
16385 The following variables can be used to create a virtual @code{nnimap}
16390 @item nnimap-address
16391 @vindex nnimap-address
16393 The address of the remote @acronym{IMAP} server. Defaults to the virtual
16394 server name if not specified.
16396 @item nnimap-server-port
16397 @vindex nnimap-server-port
16398 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
16400 Note that this should be an integer, example server specification:
16403 (nnimap "mail.server.com"
16404 (nnimap-server-port 4711))
16407 @item nnimap-list-pattern
16408 @vindex nnimap-list-pattern
16409 String or list of strings of mailboxes to limit available groups to.
16410 This is used when the server has very many mailboxes and you're only
16411 interested in a few---some servers export your home directory via
16412 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
16413 @file{~/Mail/*} then.
16415 The string can also be a cons of REFERENCE and the string as above, what
16416 REFERENCE is used for is server specific, but on the University of
16417 Washington server it's a directory that will be concatenated with the
16420 Example server specification:
16423 (nnimap "mail.server.com"
16424 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
16425 ("~friend/Mail/" . "list/*"))))
16428 @item nnimap-stream
16429 @vindex nnimap-stream
16430 The type of stream used to connect to your server. By default, nnimap
16431 will detect and automatically use all of the below, with the exception
16432 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
16433 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
16434 be automatically detected, but it's not widely deployed yet.)
16436 Example server specification:
16439 (nnimap "mail.server.com"
16440 (nnimap-stream ssl))
16443 Please note that the value of @code{nnimap-stream} is a symbol!
16447 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
16448 @samp{gsasl} or @samp{imtest} program.
16450 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
16452 @dfn{starttls:} Connect via the STARTTLS extension (similar to
16453 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
16456 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
16457 @samp{gnutls-cli}).
16459 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
16460 @samp{openssl}) or SSLeay (@samp{s_client}).
16462 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
16464 @dfn{network:} Plain, TCP/IP network connection.
16467 @vindex imap-kerberos4-program
16468 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
16469 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
16470 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
16471 to make @code{imap.el} use a pty instead of a pipe when communicating
16472 with @samp{imtest}. You will then suffer from a line length
16473 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
16474 indefinitely if you have many articles in a mailbox. The variable
16475 @code{imap-kerberos4-program} contain parameters to pass to the imtest
16478 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
16479 needed. It is available from
16480 @uref{http://www.gnu.org/software/gnutls/}.
16482 @vindex imap-gssapi-program
16483 This parameter specifies a list of command lines that invoke a GSSAPI
16484 authenticated @acronym{IMAP} stream in a subshell. They are tried
16485 sequentially until a connection is made, or the list has been
16486 exhausted. By default, @samp{gsasl} from GNU SASL, available from
16487 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
16488 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
16491 @vindex imap-ssl-program
16492 For @acronym{SSL} connections, the OpenSSL program is available from
16493 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
16494 and nnimap support it too---although the most recent versions of
16495 SSLeay, 0.9.x, are known to have serious bugs making it
16496 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
16497 work. The variable @code{imap-ssl-program} contain parameters to pass
16500 @vindex imap-shell-program
16501 @vindex imap-shell-host
16502 For @acronym{IMAP} connections using the @code{shell} stream, the variable
16503 @code{imap-shell-program} specify what program to call.
16505 @item nnimap-authenticator
16506 @vindex nnimap-authenticator
16508 The authenticator used to connect to the server. By default, nnimap
16509 will use the most secure authenticator your server is capable of.
16511 Example server specification:
16514 (nnimap "mail.server.com"
16515 (nnimap-authenticator anonymous))
16518 Please note that the value of @code{nnimap-authenticator} is a symbol!
16522 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
16523 external program @code{gsasl} or @code{imtest}.
16525 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
16528 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
16529 external library @code{digest-md5.el}.
16531 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
16533 @dfn{login:} Plain-text username/password via LOGIN.
16535 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
16538 @item nnimap-expunge-on-close
16540 @vindex nnimap-expunge-on-close
16541 Unlike Parmenides the @acronym{IMAP} designers have decided things that
16542 don't exist actually do exist. More specifically, @acronym{IMAP} has
16543 this concept of marking articles @code{Deleted} which doesn't actually
16544 delete them, and this (marking them @code{Deleted}, that is) is what
16545 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
16548 Since the articles aren't really removed when we mark them with the
16549 @code{Deleted} flag we'll need a way to actually delete them. Feel like
16550 running in circles yet?
16552 Traditionally, nnimap has removed all articles marked as @code{Deleted}
16553 when closing a mailbox but this is now configurable by this server
16556 The possible options are:
16561 The default behavior, delete all articles marked as ``Deleted'' when
16564 Never actually delete articles. Currently there is no way of showing
16565 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
16566 may allow you to do this. If you ever want to run the EXPUNGE command
16567 manually, @xref{Expunging mailboxes}.
16569 When closing mailboxes, nnimap will ask if you wish to expunge deleted
16574 @item nnimap-importantize-dormant
16575 @vindex nnimap-importantize-dormant
16577 If non-@code{nil} (the default), marks dormant articles as ticked (as
16578 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
16579 naturally still (only) be marked as dormant. This is to make dormant
16580 articles stand out, just like ticked articles, in other @acronym{IMAP}
16581 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
16584 Probably the only reason for frobing this would be if you're trying
16585 enable per-user persistent dormant flags, using something like:
16588 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
16589 (format "gnus-dormant-%s" (user-login-name)))
16590 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
16591 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
16594 In this case, you would not want the per-user dormant flag showing up
16595 as ticked for other users.
16597 @item nnimap-expunge-search-string
16599 @vindex nnimap-expunge-search-string
16601 This variable contain the @acronym{IMAP} search command sent to server when
16602 searching for articles eligible for expiring. The default is
16603 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
16604 UID set and the second @code{%s} is replaced by a date.
16606 Probably the only useful value to change this to is
16607 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
16608 messages instead of the internal article date. See section 6.4.4 of
16609 RFC 2060 for more information on valid strings.
16611 @item nnimap-authinfo-file
16612 @vindex nnimap-authinfo-file
16614 A file containing credentials used to log in on servers. The format is
16615 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
16616 variable @code{nntp-authinfo-file} for exact syntax; also see
16617 @ref{NNTP}. An example of an .authinfo line for an IMAP server, is:
16620 machine students.uio.no login larsi password geheimnis port imap
16623 Note that it should be @code{port imap}, or @code{port 143}, if you
16624 use a @code{nnimap-stream} of @code{tls} or @code{ssl}, even if the
16625 actual port number used is port 993 for secured IMAP. For
16626 convenience, Gnus will accept @code{port imaps} as a synonym of
16629 @item nnimap-need-unselect-to-notice-new-mail
16630 @vindex nnimap-need-unselect-to-notice-new-mail
16632 Unselect mailboxes before looking for new mail in them. Some servers
16633 seem to need this under some circumstances; it was reported that
16639 * Splitting in IMAP:: Splitting mail with nnimap.
16640 * Expiring in IMAP:: Expiring mail with nnimap.
16641 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
16642 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
16643 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
16644 * Debugging IMAP:: What to do when things don't work.
16649 @node Splitting in IMAP
16650 @subsection Splitting in IMAP
16651 @cindex splitting imap mail
16653 Splitting is something Gnus users have loved and used for years, and now
16654 the rest of the world is catching up. Yeah, dream on, not many
16655 @acronym{IMAP} servers have server side splitting and those that have
16656 splitting seem to use some non-standard protocol. This means that
16657 @acronym{IMAP} support for Gnus has to do its own splitting.
16661 (Incidentally, people seem to have been dreaming on, and Sieve has
16662 gaining a market share and is supported by several IMAP servers.
16663 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
16665 Here are the variables of interest:
16669 @item nnimap-split-crosspost
16670 @cindex splitting, crosspost
16672 @vindex nnimap-split-crosspost
16674 If non-@code{nil}, do crossposting if several split methods match the
16675 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
16676 found will be used.
16678 Nnmail equivalent: @code{nnmail-crosspost}.
16680 @item nnimap-split-inbox
16681 @cindex splitting, inbox
16683 @vindex nnimap-split-inbox
16685 A string or a list of strings that gives the name(s) of @acronym{IMAP}
16686 mailboxes to split from. Defaults to @code{nil}, which means that
16687 splitting is disabled!
16690 (setq nnimap-split-inbox
16691 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
16694 No nnmail equivalent.
16696 @item nnimap-split-rule
16697 @cindex splitting, rules
16698 @vindex nnimap-split-rule
16700 New mail found in @code{nnimap-split-inbox} will be split according to
16703 This variable contains a list of lists, where the first element in the
16704 sublist gives the name of the @acronym{IMAP} mailbox to move articles
16705 matching the regexp in the second element in the sublist. Got that?
16706 Neither did I, we need examples.
16709 (setq nnimap-split-rule
16711 "^Sender: owner-nnimap@@vic20.globalcom.se")
16712 ("INBOX.junk" "^Subject:.*MAKE MONEY")
16713 ("INBOX.private" "")))
16716 This will put all articles from the nnimap mailing list into mailbox
16717 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
16718 into INBOX.junk and everything else in INBOX.private.
16720 The first string may contain @samp{\\1} forms, like the ones used by
16721 replace-match to insert sub-expressions from the matched text. For
16725 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
16728 The first element can also be the symbol @code{junk} to indicate that
16729 matching messages should simply be deleted. Use with care.
16731 The second element can also be a function. In that case, it will be
16732 called with the first element of the rule as the argument, in a buffer
16733 containing the headers of the article. It should return a
16734 non-@code{nil} value if it thinks that the mail belongs in that group.
16736 Nnmail users might recollect that the last regexp had to be empty to
16737 match all articles (like in the example above). This is not required in
16738 nnimap. Articles not matching any of the regexps will not be moved out
16739 of your inbox. (This might affect performance if you keep lots of
16740 unread articles in your inbox, since the splitting code would go over
16741 them every time you fetch new mail.)
16743 These rules are processed from the beginning of the alist toward the
16744 end. The first rule to make a match will ``win'', unless you have
16745 crossposting enabled. In that case, all matching rules will ``win''.
16747 This variable can also have a function as its value, the function will
16748 be called with the headers narrowed and should return a group where it
16749 thinks the article should be split to. See @code{nnimap-split-fancy}.
16751 The splitting code tries to create mailboxes if it needs to.
16753 To allow for different split rules on different virtual servers, and
16754 even different split rules in different inboxes on the same server,
16755 the syntax of this variable have been extended along the lines of:
16758 (setq nnimap-split-rule
16759 '(("my1server" (".*" (("ding" "ding@@gnus.org")
16760 ("junk" "From:.*Simon"))))
16761 ("my2server" ("INBOX" nnimap-split-fancy))
16762 ("my[34]server" (".*" (("private" "To:.*Simon")
16763 ("junk" my-junk-func))))))
16766 The virtual server name is in fact a regexp, so that the same rules
16767 may apply to several servers. In the example, the servers
16768 @code{my3server} and @code{my4server} both use the same rules.
16769 Similarly, the inbox string is also a regexp. The actual splitting
16770 rules are as before, either a function, or a list with group/regexp or
16771 group/function elements.
16773 Nnmail equivalent: @code{nnmail-split-methods}.
16775 @item nnimap-split-predicate
16777 @vindex nnimap-split-predicate
16779 Mail matching this predicate in @code{nnimap-split-inbox} will be
16780 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
16782 This might be useful if you use another @acronym{IMAP} client to read mail in
16783 your inbox but would like Gnus to split all articles in the inbox
16784 regardless of readedness. Then you might change this to
16787 @item nnimap-split-fancy
16788 @cindex splitting, fancy
16789 @findex nnimap-split-fancy
16790 @vindex nnimap-split-fancy
16792 It's possible to set @code{nnimap-split-rule} to
16793 @code{nnmail-split-fancy} if you want to use fancy
16794 splitting. @xref{Fancy Mail Splitting}.
16796 However, to be able to have different fancy split rules for nnmail and
16797 nnimap back ends you can set @code{nnimap-split-rule} to
16798 @code{nnimap-split-fancy} and define the nnimap specific fancy split
16799 rule in @code{nnimap-split-fancy}.
16804 (setq nnimap-split-rule 'nnimap-split-fancy
16805 nnimap-split-fancy ...)
16808 Nnmail equivalent: @code{nnmail-split-fancy}.
16810 @item nnimap-split-download-body
16811 @findex nnimap-split-download-body
16812 @vindex nnimap-split-download-body
16814 Set to non-@code{nil} to download entire articles during splitting.
16815 This is generally not required, and will slow things down
16816 considerably. You may need it if you want to use an advanced
16817 splitting function that analyzes the body to split the article.
16821 @node Expiring in IMAP
16822 @subsection Expiring in IMAP
16823 @cindex expiring imap mail
16825 Even though @code{nnimap} is not a proper @code{nnmail} derived back
16826 end, it supports most features in regular expiring (@pxref{Expiring
16827 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
16828 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
16829 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
16830 follows below are the variables used by the @code{nnimap} expiry
16833 A note on how the expire mark is stored on the @acronym{IMAP} server is
16834 appropriate here as well. The expire mark is translated into a
16835 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
16836 message. This means that likely only Gnus will understand and treat
16837 the @code{gnus-expire} mark properly, although other clients may allow
16838 you to view client specific flags on the message. It also means that
16839 your server must support permanent storage of client specific flags on
16840 messages. Most do, fortunately.
16844 @item nnmail-expiry-wait
16845 @item nnmail-expiry-wait-function
16847 These variables are fully supported. The expire value can be a
16848 number, the symbol @code{immediate} or @code{never}.
16850 @item nnmail-expiry-target
16852 This variable is supported, and internally implemented by calling the
16853 @code{nnmail} functions that handle this. It contains an optimization
16854 that if the destination is a @acronym{IMAP} group on the same server, the
16855 article is copied instead of appended (that is, uploaded again).
16859 @node Editing IMAP ACLs
16860 @subsection Editing IMAP ACLs
16861 @cindex editing imap acls
16862 @cindex Access Control Lists
16863 @cindex Editing @acronym{IMAP} ACLs
16864 @kindex G l (Group)
16865 @findex gnus-group-nnimap-edit-acl
16867 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
16868 limiting (or enabling) other users access to your mail boxes. Not all
16869 @acronym{IMAP} servers support this, this function will give an error if it
16872 To edit an ACL for a mailbox, type @kbd{G l}
16873 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
16874 editing window with detailed instructions.
16876 Some possible uses:
16880 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
16881 on your mailing list mailboxes enables other users on the same server to
16882 follow the list without subscribing to it.
16884 At least with the Cyrus server, you are required to give the user
16885 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
16886 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
16890 @node Expunging mailboxes
16891 @subsection Expunging mailboxes
16895 @cindex manual expunging
16896 @kindex G x (Group)
16897 @findex gnus-group-nnimap-expunge
16899 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
16900 you may want the option of expunging all deleted articles in a mailbox
16901 manually. This is exactly what @kbd{G x} does.
16903 Currently there is no way of showing deleted articles, you can just
16906 @node A note on namespaces
16907 @subsection A note on namespaces
16908 @cindex IMAP namespace
16911 The @acronym{IMAP} protocol has a concept called namespaces, described
16912 by the following text in the RFC2060:
16915 5.1.2. Mailbox Namespace Naming Convention
16917 By convention, the first hierarchical element of any mailbox name
16918 which begins with "#" identifies the "namespace" of the remainder of
16919 the name. This makes it possible to disambiguate between different
16920 types of mailbox stores, each of which have their own namespaces.
16922 For example, implementations which offer access to USENET
16923 newsgroups MAY use the "#news" namespace to partition the USENET
16924 newsgroup namespace from that of other mailboxes. Thus, the
16925 comp.mail.misc newsgroup would have an mailbox name of
16926 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
16927 to a different object (e.g. a user's private mailbox).
16930 While there is nothing in this text that warrants concern for the
16931 @acronym{IMAP} implementation in Gnus, some servers use namespace
16932 prefixes in a way that does not work with how Gnus uses mailbox names.
16934 Specifically, University of Washington's @acronym{IMAP} server uses
16935 mailbox names like @code{#driver.mbx/read-mail} which are valid only
16936 in the @sc{create} and @sc{append} commands. After the mailbox is
16937 created (or a messages is appended to a mailbox), it must be accessed
16938 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
16939 not make it possible for the user to guarantee that user entered
16940 mailbox names will only be used with the CREATE and APPEND commands,
16941 you should simply not use the namespace prefixed mailbox names in
16944 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
16945 for more information on how to use the prefixes. They are a power
16946 tool and should be used only if you are sure what the effects are.
16948 @node Debugging IMAP
16949 @subsection Debugging IMAP
16950 @cindex IMAP debugging
16951 @cindex protocol dump (IMAP)
16953 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
16954 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
16955 best to fix them right away. If you encounter odd behavior, chances
16956 are that either the server or Gnus is buggy.
16958 If you are familiar with network protocols in general, you will
16959 probably be able to extract some clues from the protocol dump of the
16960 exchanges between Gnus and the server. Even if you are not familiar
16961 with network protocols, when you include the protocol dump in
16962 @acronym{IMAP}-related bug reports you are helping us with data
16963 critical to solving the problem. Therefore, we strongly encourage you
16964 to include the protocol dump when reporting IMAP bugs in Gnus.
16968 Because the protocol dump, when enabled, generates lots of data, it is
16969 disabled by default. You can enable it by setting @code{imap-log} as
16976 This instructs the @code{imap.el} package to log any exchanges with
16977 the server. The log is stored in the buffer @samp{*imap-log*}. Look
16978 for error messages, which sometimes are tagged with the keyword
16979 @code{BAD}---but when submitting a bug, make sure to include all the
16982 @node Other Sources
16983 @section Other Sources
16985 Gnus can do more than just read news or mail. The methods described
16986 below allow Gnus to view directories and files as if they were
16990 * Directory Groups:: You can read a directory as if it was a newsgroup.
16991 * Anything Groups:: Dired? Who needs dired?
16992 * Document Groups:: Single files can be the basis of a group.
16993 * SOUP:: Reading @sc{soup} packets ``offline''.
16994 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
16998 @node Directory Groups
16999 @subsection Directory Groups
17001 @cindex directory groups
17003 If you have a directory that has lots of articles in separate files in
17004 it, you might treat it as a newsgroup. The files have to have numerical
17007 This might be an opportune moment to mention @code{ange-ftp} (and its
17008 successor @code{efs}), that most wonderful of all wonderful Emacs
17009 packages. When I wrote @code{nndir}, I didn't think much about it---a
17010 back end to read directories. Big deal.
17012 @code{ange-ftp} changes that picture dramatically. For instance, if you
17013 enter the @code{ange-ftp} file name
17014 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
17015 @code{ange-ftp} or @code{efs} will actually allow you to read this
17016 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
17018 @code{nndir} will use @acronym{NOV} files if they are present.
17020 @code{nndir} is a ``read-only'' back end---you can't delete or expire
17021 articles with this method. You can use @code{nnmh} or @code{nnml} for
17022 whatever you use @code{nndir} for, so you could switch to any of those
17023 methods if you feel the need to have a non-read-only @code{nndir}.
17026 @node Anything Groups
17027 @subsection Anything Groups
17030 From the @code{nndir} back end (which reads a single spool-like
17031 directory), it's just a hop and a skip to @code{nneething}, which
17032 pretends that any arbitrary directory is a newsgroup. Strange, but
17035 When @code{nneething} is presented with a directory, it will scan this
17036 directory and assign article numbers to each file. When you enter such
17037 a group, @code{nneething} must create ``headers'' that Gnus can use.
17038 After all, Gnus is a newsreader, in case you're forgetting.
17039 @code{nneething} does this in a two-step process. First, it snoops each
17040 file in question. If the file looks like an article (i.e., the first
17041 few lines look like headers), it will use this as the head. If this is
17042 just some arbitrary file without a head (e.g. a C source file),
17043 @code{nneething} will cobble up a header out of thin air. It will use
17044 file ownership, name and date and do whatever it can with these
17047 All this should happen automatically for you, and you will be presented
17048 with something that looks very much like a newsgroup. Totally like a
17049 newsgroup, to be precise. If you select an article, it will be displayed
17050 in the article buffer, just as usual.
17052 If you select a line that represents a directory, Gnus will pop you into
17053 a new summary buffer for this @code{nneething} group. And so on. You can
17054 traverse the entire disk this way, if you feel like, but remember that
17055 Gnus is not dired, really, and does not intend to be, either.
17057 There are two overall modes to this action---ephemeral or solid. When
17058 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
17059 will not store information on what files you have read, and what files
17060 are new, and so on. If you create a solid @code{nneething} group the
17061 normal way with @kbd{G m}, Gnus will store a mapping table between
17062 article numbers and file names, and you can treat this group like any
17063 other groups. When you activate a solid @code{nneething} group, you will
17064 be told how many unread articles it contains, etc., etc.
17069 @item nneething-map-file-directory
17070 @vindex nneething-map-file-directory
17071 All the mapping files for solid @code{nneething} groups will be stored
17072 in this directory, which defaults to @file{~/.nneething/}.
17074 @item nneething-exclude-files
17075 @vindex nneething-exclude-files
17076 All files that match this regexp will be ignored. Nice to use to exclude
17077 auto-save files and the like, which is what it does by default.
17079 @item nneething-include-files
17080 @vindex nneething-include-files
17081 Regexp saying what files to include in the group. If this variable is
17082 non-@code{nil}, only files matching this regexp will be included.
17084 @item nneething-map-file
17085 @vindex nneething-map-file
17086 Name of the map files.
17090 @node Document Groups
17091 @subsection Document Groups
17093 @cindex documentation group
17096 @code{nndoc} is a cute little thing that will let you read a single file
17097 as a newsgroup. Several files types are supported:
17103 The Babyl (Rmail) mail box.
17108 The standard Unix mbox file.
17110 @cindex MMDF mail box
17112 The MMDF mail box format.
17115 Several news articles appended into a file.
17117 @cindex rnews batch files
17119 The rnews batch transport format.
17122 Netscape mail boxes.
17125 @acronym{MIME} multipart messages.
17127 @item standard-digest
17128 The standard (RFC 1153) digest format.
17131 A @acronym{MIME} digest of messages.
17133 @item lanl-gov-announce
17134 Announcement messages from LANL Gov Announce.
17136 @cindex forwarded messages
17137 @item rfc822-forward
17138 A message forwarded according to RFC822.
17141 The Outlook mail box.
17144 The Outlook Express dbx mail box.
17147 A bounce message from the Exim MTA.
17150 A message forwarded according to informal rules.
17153 An RFC934-forwarded message.
17159 A digest of Clarinet brief news items.
17162 Non-standard digest format---matches most things, but does it badly.
17168 You can also use the special ``file type'' @code{guess}, which means
17169 that @code{nndoc} will try to guess what file type it is looking at.
17170 @code{digest} means that @code{nndoc} should guess what digest type the
17173 @code{nndoc} will not try to change the file or insert any extra headers into
17174 it---it will simply, like, let you use the file as the basis for a
17175 group. And that's it.
17177 If you have some old archived articles that you want to insert into your
17178 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
17179 that. Say you have an old @file{RMAIL} file with mail that you now want
17180 to split into your new @code{nnml} groups. You look at that file using
17181 @code{nndoc} (using the @kbd{G f} command in the group buffer
17182 (@pxref{Foreign Groups})), set the process mark on all the articles in
17183 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
17184 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
17185 file is now also stored in lots of @code{nnml} directories, and you can
17186 delete that pesky @file{RMAIL} file. If you have the guts!
17188 Virtual server variables:
17191 @item nndoc-article-type
17192 @vindex nndoc-article-type
17193 This should be one of @code{mbox}, @code{babyl}, @code{digest},
17194 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
17195 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
17196 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
17197 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
17199 @item nndoc-post-type
17200 @vindex nndoc-post-type
17201 This variable says whether Gnus is to consider the group a news group or
17202 a mail group. There are two valid values: @code{mail} (the default)
17207 * Document Server Internals:: How to add your own document types.
17211 @node Document Server Internals
17212 @subsubsection Document Server Internals
17214 Adding new document types to be recognized by @code{nndoc} isn't
17215 difficult. You just have to whip up a definition of what the document
17216 looks like, write a predicate function to recognize that document type,
17217 and then hook into @code{nndoc}.
17219 First, here's an example document type definition:
17223 (article-begin . "^\^A\^A\^A\^A\n")
17224 (body-end . "^\^A\^A\^A\^A\n"))
17227 The definition is simply a unique @dfn{name} followed by a series of
17228 regexp pseudo-variable settings. Below are the possible
17229 variables---don't be daunted by the number of variables; most document
17230 types can be defined with very few settings:
17233 @item first-article
17234 If present, @code{nndoc} will skip past all text until it finds
17235 something that match this regexp. All text before this will be
17238 @item article-begin
17239 This setting has to be present in all document type definitions. It
17240 says what the beginning of each article looks like. To do more
17241 complicated things that cannot be dealt with a simple regexp, you can
17242 use @code{article-begin-function} instead of this.
17244 @item article-begin-function
17245 If present, this should be a function that moves point to the beginning
17246 of each article. This setting overrides @code{article-begin}.
17249 If present, this should be a regexp that matches the head of the
17250 article. To do more complicated things that cannot be dealt with a
17251 simple regexp, you can use @code{head-begin-function} instead of this.
17253 @item head-begin-function
17254 If present, this should be a function that moves point to the head of
17255 the article. This setting overrides @code{head-begin}.
17258 This should match the end of the head of the article. It defaults to
17259 @samp{^$}---the empty line.
17262 This should match the beginning of the body of the article. It defaults
17263 to @samp{^\n}. To do more complicated things that cannot be dealt with
17264 a simple regexp, you can use @code{body-begin-function} instead of this.
17266 @item body-begin-function
17267 If present, this function should move point to the beginning of the body
17268 of the article. This setting overrides @code{body-begin}.
17271 If present, this should match the end of the body of the article. To do
17272 more complicated things that cannot be dealt with a simple regexp, you
17273 can use @code{body-end-function} instead of this.
17275 @item body-end-function
17276 If present, this function should move point to the end of the body of
17277 the article. This setting overrides @code{body-end}.
17280 If present, this should match the beginning of the file. All text
17281 before this regexp will be totally ignored.
17284 If present, this should match the end of the file. All text after this
17285 regexp will be totally ignored.
17289 So, using these variables @code{nndoc} is able to dissect a document
17290 file into a series of articles, each with a head and a body. However, a
17291 few more variables are needed since not all document types are all that
17292 news-like---variables needed to transform the head or the body into
17293 something that's palatable for Gnus:
17296 @item prepare-body-function
17297 If present, this function will be called when requesting an article. It
17298 will be called with point at the start of the body, and is useful if the
17299 document has encoded some parts of its contents.
17301 @item article-transform-function
17302 If present, this function is called when requesting an article. It's
17303 meant to be used for more wide-ranging transformation of both head and
17304 body of the article.
17306 @item generate-head-function
17307 If present, this function is called to generate a head that Gnus can
17308 understand. It is called with the article number as a parameter, and is
17309 expected to generate a nice head for the article in question. It is
17310 called when requesting the headers of all articles.
17312 @item generate-article-function
17313 If present, this function is called to generate an entire article that
17314 Gnus can understand. It is called with the article number as a
17315 parameter when requesting all articles.
17317 @item dissection-function
17318 If present, this function is called to dissect a document by itself,
17319 overriding @code{first-article}, @code{article-begin},
17320 @code{article-begin-function}, @code{head-begin},
17321 @code{head-begin-function}, @code{head-end}, @code{body-begin},
17322 @code{body-begin-function}, @code{body-end}, @code{body-end-function},
17323 @code{file-begin}, and @code{file-end}.
17327 Let's look at the most complicated example I can come up with---standard
17332 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
17333 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
17334 (prepare-body-function . nndoc-unquote-dashes)
17335 (body-end-function . nndoc-digest-body-end)
17336 (head-end . "^ ?$")
17337 (body-begin . "^ ?\n")
17338 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
17339 (subtype digest guess))
17342 We see that all text before a 70-width line of dashes is ignored; all
17343 text after a line that starts with that @samp{^End of} is also ignored;
17344 each article begins with a 30-width line of dashes; the line separating
17345 the head from the body may contain a single space; and that the body is
17346 run through @code{nndoc-unquote-dashes} before being delivered.
17348 To hook your own document definition into @code{nndoc}, use the
17349 @code{nndoc-add-type} function. It takes two parameters---the first
17350 is the definition itself and the second (optional) parameter says
17351 where in the document type definition alist to put this definition.
17352 The alist is traversed sequentially, and
17353 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
17354 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
17355 @code{mmdf} type, and so on. These type predicates should return
17356 @code{nil} if the document is not of the correct type; @code{t} if it
17357 is of the correct type; and a number if the document might be of the
17358 correct type. A high number means high probability; a low number
17359 means low probability with @samp{0} being the lowest valid number.
17367 In the PC world people often talk about ``offline'' newsreaders. These
17368 are thingies that are combined reader/news transport monstrosities.
17369 With built-in modem programs. Yecchh!
17371 Of course, us Unix Weenie types of human beans use things like
17372 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
17373 transport things like Ghod intended. And then we just use normal
17376 However, it can sometimes be convenient to do something that's a bit
17377 easier on the brain if you have a very slow modem, and you're not really
17378 that interested in doing things properly.
17380 A file format called @sc{soup} has been developed for transporting news
17381 and mail from servers to home machines and back again. It can be a bit
17384 First some terminology:
17389 This is the machine that is connected to the outside world and where you
17390 get news and/or mail from.
17393 This is the machine that you want to do the actual reading and responding
17394 on. It is typically not connected to the rest of the world in any way.
17397 Something that contains messages and/or commands. There are two kinds
17401 @item message packets
17402 These are packets made at the server, and typically contain lots of
17403 messages for you to read. These are called @file{SoupoutX.tgz} by
17404 default, where @var{x} is a number.
17406 @item response packets
17407 These are packets made at the home machine, and typically contains
17408 replies that you've written. These are called @file{SoupinX.tgz} by
17409 default, where @var{x} is a number.
17419 You log in on the server and create a @sc{soup} packet. You can either
17420 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
17421 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
17422 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
17425 You transfer the packet home. Rail, boat, car or modem will do fine.
17428 You put the packet in your home directory.
17431 You fire up Gnus on your home machine using the @code{nnsoup} back end as
17432 the native or secondary server.
17435 You read articles and mail and answer and followup to the things you
17436 want (@pxref{SOUP Replies}).
17439 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
17443 You transfer this packet to the server.
17446 You use Gnus to mail this packet out with the @kbd{G s s} command.
17449 You then repeat until you die.
17453 So you basically have a bipartite system---you use @code{nnsoup} for
17454 reading and Gnus for packing/sending these @sc{soup} packets.
17457 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
17458 * SOUP Groups:: A back end for reading @sc{soup} packets.
17459 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
17463 @node SOUP Commands
17464 @subsubsection SOUP Commands
17466 These are commands for creating and manipulating @sc{soup} packets.
17470 @kindex G s b (Group)
17471 @findex gnus-group-brew-soup
17472 Pack all unread articles in the current group
17473 (@code{gnus-group-brew-soup}). This command understands the
17474 process/prefix convention.
17477 @kindex G s w (Group)
17478 @findex gnus-soup-save-areas
17479 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
17482 @kindex G s s (Group)
17483 @findex gnus-soup-send-replies
17484 Send all replies from the replies packet
17485 (@code{gnus-soup-send-replies}).
17488 @kindex G s p (Group)
17489 @findex gnus-soup-pack-packet
17490 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
17493 @kindex G s r (Group)
17494 @findex nnsoup-pack-replies
17495 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
17498 @kindex O s (Summary)
17499 @findex gnus-soup-add-article
17500 This summary-mode command adds the current article to a @sc{soup} packet
17501 (@code{gnus-soup-add-article}). It understands the process/prefix
17502 convention (@pxref{Process/Prefix}).
17507 There are a few variables to customize where Gnus will put all these
17512 @item gnus-soup-directory
17513 @vindex gnus-soup-directory
17514 Directory where Gnus will save intermediate files while composing
17515 @sc{soup} packets. The default is @file{~/SoupBrew/}.
17517 @item gnus-soup-replies-directory
17518 @vindex gnus-soup-replies-directory
17519 This is what Gnus will use as a temporary directory while sending our
17520 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
17522 @item gnus-soup-prefix-file
17523 @vindex gnus-soup-prefix-file
17524 Name of the file where Gnus stores the last used prefix. The default is
17525 @samp{gnus-prefix}.
17527 @item gnus-soup-packer
17528 @vindex gnus-soup-packer
17529 A format string command for packing a @sc{soup} packet. The default is
17530 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
17532 @item gnus-soup-unpacker
17533 @vindex gnus-soup-unpacker
17534 Format string command for unpacking a @sc{soup} packet. The default is
17535 @samp{gunzip -c %s | tar xvf -}.
17537 @item gnus-soup-packet-directory
17538 @vindex gnus-soup-packet-directory
17539 Where Gnus will look for reply packets. The default is @file{~/}.
17541 @item gnus-soup-packet-regexp
17542 @vindex gnus-soup-packet-regexp
17543 Regular expression matching @sc{soup} reply packets in
17544 @code{gnus-soup-packet-directory}.
17550 @subsubsection SOUP Groups
17553 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
17554 read incoming packets, unpack them, and put them in a directory where
17555 you can read them at leisure.
17557 These are the variables you can use to customize its behavior:
17561 @item nnsoup-tmp-directory
17562 @vindex nnsoup-tmp-directory
17563 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
17564 directory. (@file{/tmp/} by default.)
17566 @item nnsoup-directory
17567 @vindex nnsoup-directory
17568 @code{nnsoup} then moves each message and index file to this directory.
17569 The default is @file{~/SOUP/}.
17571 @item nnsoup-replies-directory
17572 @vindex nnsoup-replies-directory
17573 All replies will be stored in this directory before being packed into a
17574 reply packet. The default is @file{~/SOUP/replies/}.
17576 @item nnsoup-replies-format-type
17577 @vindex nnsoup-replies-format-type
17578 The @sc{soup} format of the replies packets. The default is @samp{?n}
17579 (rnews), and I don't think you should touch that variable. I probably
17580 shouldn't even have documented it. Drats! Too late!
17582 @item nnsoup-replies-index-type
17583 @vindex nnsoup-replies-index-type
17584 The index type of the replies packet. The default is @samp{?n}, which
17585 means ``none''. Don't fiddle with this one either!
17587 @item nnsoup-active-file
17588 @vindex nnsoup-active-file
17589 Where @code{nnsoup} stores lots of information. This is not an ``active
17590 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
17591 this file or mess it up in any way, you're dead. The default is
17592 @file{~/SOUP/active}.
17594 @item nnsoup-packer
17595 @vindex nnsoup-packer
17596 Format string command for packing a reply @sc{soup} packet. The default
17597 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
17599 @item nnsoup-unpacker
17600 @vindex nnsoup-unpacker
17601 Format string command for unpacking incoming @sc{soup} packets. The
17602 default is @samp{gunzip -c %s | tar xvf -}.
17604 @item nnsoup-packet-directory
17605 @vindex nnsoup-packet-directory
17606 Where @code{nnsoup} will look for incoming packets. The default is
17609 @item nnsoup-packet-regexp
17610 @vindex nnsoup-packet-regexp
17611 Regular expression matching incoming @sc{soup} packets. The default is
17614 @item nnsoup-always-save
17615 @vindex nnsoup-always-save
17616 If non-@code{nil}, save the replies buffer after each posted message.
17622 @subsubsection SOUP Replies
17624 Just using @code{nnsoup} won't mean that your postings and mailings end
17625 up in @sc{soup} reply packets automagically. You have to work a bit
17626 more for that to happen.
17628 @findex nnsoup-set-variables
17629 The @code{nnsoup-set-variables} command will set the appropriate
17630 variables to ensure that all your followups and replies end up in the
17633 In specific, this is what it does:
17636 (setq message-send-news-function 'nnsoup-request-post)
17637 (setq message-send-mail-function 'nnsoup-request-mail)
17640 And that's it, really. If you only want news to go into the @sc{soup}
17641 system you just use the first line. If you only want mail to be
17642 @sc{soup}ed you use the second.
17645 @node Mail-To-News Gateways
17646 @subsection Mail-To-News Gateways
17647 @cindex mail-to-news gateways
17650 If your local @code{nntp} server doesn't allow posting, for some reason
17651 or other, you can post using one of the numerous mail-to-news gateways.
17652 The @code{nngateway} back end provides the interface.
17654 Note that you can't read anything from this back end---it can only be
17660 @item nngateway-address
17661 @vindex nngateway-address
17662 This is the address of the mail-to-news gateway.
17664 @item nngateway-header-transformation
17665 @vindex nngateway-header-transformation
17666 News headers often have to be transformed in some odd way or other
17667 for the mail-to-news gateway to accept it. This variable says what
17668 transformation should be called, and defaults to
17669 @code{nngateway-simple-header-transformation}. The function is called
17670 narrowed to the headers to be transformed and with one parameter---the
17673 This default function just inserts a new @code{To} header based on the
17674 @code{Newsgroups} header and the gateway address.
17675 For instance, an article with this @code{Newsgroups} header:
17678 Newsgroups: alt.religion.emacs
17681 will get this @code{To} header inserted:
17684 To: alt-religion-emacs@@GATEWAY
17687 The following pre-defined functions exist:
17689 @findex nngateway-simple-header-transformation
17692 @item nngateway-simple-header-transformation
17693 Creates a @code{To} header that looks like
17694 @var{newsgroup}@@@code{nngateway-address}.
17696 @findex nngateway-mail2news-header-transformation
17698 @item nngateway-mail2news-header-transformation
17699 Creates a @code{To} header that looks like
17700 @code{nngateway-address}.
17708 (setq gnus-post-method
17710 "mail2news@@replay.com"
17711 (nngateway-header-transformation
17712 nngateway-mail2news-header-transformation)))
17715 So, to use this, simply say something like:
17718 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17723 @node Combined Groups
17724 @section Combined Groups
17726 Gnus allows combining a mixture of all the other group types into bigger
17730 * Virtual Groups:: Combining articles from many groups.
17731 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
17735 @node Virtual Groups
17736 @subsection Virtual Groups
17738 @cindex virtual groups
17739 @cindex merging groups
17741 An @dfn{nnvirtual group} is really nothing more than a collection of
17744 For instance, if you are tired of reading many small groups, you can
17745 put them all in one big group, and then grow tired of reading one
17746 big, unwieldy group. The joys of computing!
17748 You specify @code{nnvirtual} as the method. The address should be a
17749 regexp to match component groups.
17751 All marks in the virtual group will stick to the articles in the
17752 component groups. So if you tick an article in a virtual group, the
17753 article will also be ticked in the component group from whence it
17754 came. (And vice versa---marks from the component groups will also be
17755 shown in the virtual group.). To create an empty virtual group, run
17756 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17757 and edit the method regexp with @kbd{M-e}
17758 (@code{gnus-group-edit-group-method})
17760 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17761 newsgroups into one, big, happy newsgroup:
17764 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17767 The component groups can be native or foreign; everything should work
17768 smoothly, but if your computer explodes, it was probably my fault.
17770 Collecting the same group from several servers might actually be a good
17771 idea if users have set the Distribution header to limit distribution.
17772 If you would like to read @samp{soc.motss} both from a server in Japan
17773 and a server in Norway, you could use the following as the group regexp:
17776 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17779 (Remember, though, that if you're creating the group with @kbd{G m}, you
17780 shouldn't double the backslashes, and you should leave off the quote
17781 characters at the beginning and the end of the string.)
17783 This should work kinda smoothly---all articles from both groups should
17784 end up in this one, and there should be no duplicates. Threading (and
17785 the rest) will still work as usual, but there might be problems with the
17786 sequence of articles. Sorting on date might be an option here
17787 (@pxref{Selecting a Group}).
17789 One limitation, however---all groups included in a virtual
17790 group have to be alive (i.e., subscribed or unsubscribed). Killed or
17791 zombie groups can't be component groups for @code{nnvirtual} groups.
17793 @vindex nnvirtual-always-rescan
17794 If the @code{nnvirtual-always-rescan} is non-@code{nil},
17795 @code{nnvirtual} will always scan groups for unread articles when
17796 entering a virtual group. If this variable is @code{nil} (which is the
17797 default) and you read articles in a component group after the virtual
17798 group has been activated, the read articles from the component group
17799 will show up when you enter the virtual group. You'll also see this
17800 effect if you have two virtual groups that have a component group in
17801 common. If that's the case, you should set this variable to @code{t}.
17802 Or you can just tap @code{M-g} on the virtual group every time before
17803 you enter it---it'll have much the same effect.
17805 @code{nnvirtual} can have both mail and news groups as component groups.
17806 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17807 has to ask the back end of the component group the article comes from
17808 whether it is a news or mail back end. However, when you do a @kbd{^},
17809 there is typically no sure way for the component back end to know this,
17810 and in that case @code{nnvirtual} tells Gnus that the article came from a
17811 not-news back end. (Just to be on the safe side.)
17813 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17814 line from the article you respond to in these cases.
17816 @code{nnvirtual} groups do not inherit anything but articles and marks
17817 from component groups---group parameters, for instance, are not
17821 @node Kibozed Groups
17822 @subsection Kibozed Groups
17826 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
17827 (parts of) the news feed''. @code{nnkiboze} is a back end that will
17828 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
17829 down to a halt with useless requests! Oh happiness!
17831 @kindex G k (Group)
17832 To create a kibozed group, use the @kbd{G k} command in the group
17835 The address field of the @code{nnkiboze} method is, as with
17836 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
17837 @code{nnkiboze} group. That's where most similarities between
17838 @code{nnkiboze} and @code{nnvirtual} end.
17840 In addition to this regexp detailing component groups, an
17841 @code{nnkiboze} group must have a score file to say what articles are
17842 to be included in the group (@pxref{Scoring}).
17844 @kindex M-x nnkiboze-generate-groups
17845 @findex nnkiboze-generate-groups
17846 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
17847 @code{nnkiboze} groups you want to have. This command will take time.
17848 Lots of time. Oodles and oodles of time. Gnus has to fetch the
17849 headers from all the articles in all the component groups and run them
17850 through the scoring process to determine if there are any articles in
17851 the groups that are to be part of the @code{nnkiboze} groups.
17853 Please limit the number of component groups by using restrictive
17854 regexps. Otherwise your sysadmin may become annoyed with you, and the
17855 @acronym{NNTP} site may throw you off and never let you back in again.
17856 Stranger things have happened.
17858 @code{nnkiboze} component groups do not have to be alive---they can be dead,
17859 and they can be foreign. No restrictions.
17861 @vindex nnkiboze-directory
17862 The generation of an @code{nnkiboze} group means writing two files in
17863 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
17864 One contains the @acronym{NOV} header lines for all the articles in
17865 the group, and the other is an additional @file{.newsrc} file to store
17866 information on what groups have been searched through to find
17867 component articles.
17869 Articles marked as read in the @code{nnkiboze} group will have
17870 their @acronym{NOV} lines removed from the @acronym{NOV} file.
17873 @node Email Based Diary
17874 @section Email Based Diary
17876 @cindex email based diary
17879 This section describes a special mail back end called @code{nndiary},
17880 and its companion library @code{gnus-diary}. It is ``special'' in the
17881 sense that it is not meant to be one of the standard alternatives for
17882 reading mail with Gnus. See @ref{Choosing a Mail Back End} for that.
17883 Instead, it is used to treat @emph{some} of your mails in a special way,
17884 namely, as event reminders.
17886 Here is a typical scenario:
17890 You've got a date with Andy Mc Dowell or Bruce Willis (select according
17891 to your sexual preference) in one month. You don't want to forget it.
17893 So you send a ``reminder'' message (actually, a diary one) to yourself.
17895 You forget all about it and keep on getting and reading new mail, as usual.
17897 From time to time, as you type `g' in the group buffer and as the date
17898 is getting closer, the message will pop up again to remind you of your
17899 appointment, just as if it were new and unread.
17901 Read your ``new'' messages, this one included, and start dreaming again
17902 of the night you're gonna have.
17904 Once the date is over (you actually fell asleep just after dinner), the
17905 message will be automatically deleted if it is marked as expirable.
17908 The Gnus Diary back end has the ability to handle regular appointments
17909 (that wouldn't ever be deleted) as well as punctual ones, operates as a
17910 real mail back end and is configurable in many ways. All of this is
17911 explained in the sections below.
17914 * The NNDiary Back End:: Basic setup and usage.
17915 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
17916 * Sending or Not Sending:: A final note on sending diary messages.
17920 @node The NNDiary Back End
17921 @subsection The NNDiary Back End
17923 @cindex the nndiary back end
17925 @code{nndiary} is a back end very similar to @code{nnml} (@pxref{Mail
17926 Spool}). Actually, it could appear as a mix of @code{nnml} and
17927 @code{nndraft}. If you know @code{nnml}, you're already familiar with
17928 the message storing scheme of @code{nndiary}: one file per message, one
17929 directory per group.
17931 Before anything, there is one requirement to be able to run
17932 @code{nndiary} properly: you @emph{must} use the group timestamp feature
17933 of Gnus. This adds a timestamp to each group's parameters. @ref{Group
17934 Timestamp} to see how it's done.
17937 * Diary Messages:: What makes a message valid for nndiary.
17938 * Running NNDiary:: NNDiary has two modes of operation.
17939 * Customizing NNDiary:: Bells and whistles.
17942 @node Diary Messages
17943 @subsubsection Diary Messages
17944 @cindex nndiary messages
17945 @cindex nndiary mails
17947 @code{nndiary} messages are just normal ones, except for the mandatory
17948 presence of 7 special headers. These headers are of the form
17949 @code{X-Diary-<something>}, @code{<something>} being one of
17950 @code{Minute}, @code{Hour}, @code{Dom}, @code{Month}, @code{Year},
17951 @code{Time-Zone} and @code{Dow}. @code{Dom} means ``Day of Month'', and
17952 @code{dow} means ``Day of Week''. These headers actually behave like
17953 crontab specifications and define the event date(s):
17957 For all headers except the @code{Time-Zone} one, a header value is
17958 either a star (meaning all possible values), or a list of fields
17959 (separated by a comma).
17961 A field is either an integer, or a range.
17963 A range is two integers separated by a dash.
17965 Possible integer values are 0--59 for @code{Minute}, 0--23 for
17966 @code{Hour}, 1--31 for @code{Dom}, 1--12 for @code{Month}, above 1971
17967 for @code{Year} and 0--6 for @code{Dow} (0 meaning Sunday).
17969 As a special case, a star in either @code{Dom} or @code{Dow} doesn't
17970 mean ``all possible values'', but ``use only the other field''. Note
17971 that if both are star'ed, the use of either one gives the same result.
17973 The @code{Time-Zone} header is special in that it can only have one
17974 value (@code{GMT}, for instance). A star doesn't mean ``all possible
17975 values'' (because it makes no sense), but ``the current local time
17976 zone''. Most of the time, you'll be using a star here. However, for a
17977 list of available time zone values, see the variable
17978 @code{nndiary-headers}.
17981 As a concrete example, here are the diary headers to add to your message
17982 for specifying ``Each Monday and each 1st of month, at 12:00, 20:00,
17983 21:00, 22:00, 23:00 and 24:00, from 1999 to 2010'' (I'll let you find
17988 X-Diary-Hour: 12, 20-24
17991 X-Diary-Year: 1999-2010
17993 X-Diary-Time-Zone: *
17996 @node Running NNDiary
17997 @subsubsection Running NNDiary
17998 @cindex running nndiary
17999 @cindex nndiary operation modes
18001 @code{nndiary} has two modes of operation: ``traditional'' (the default)
18002 and ``autonomous''. In traditional mode, @code{nndiary} does not get new
18003 mail by itself. You have to move (@kbd{B m}) or copy (@kbd{B c}) mails
18004 from your primary mail back end to nndiary groups in order to handle them
18005 as diary messages. In autonomous mode, @code{nndiary} retrieves its own
18006 mail and handles it independently from your primary mail back end.
18008 One should note that Gnus is not inherently designed to allow several
18009 ``master'' mail back ends at the same time. However, this does make
18010 sense with @code{nndiary}: you really want to send and receive diary
18011 messages to your diary groups directly. So, @code{nndiary} supports
18012 being sort of a ``second primary mail back end'' (to my knowledge, it is
18013 the only back end offering this feature). However, there is a limitation
18014 (which I hope to fix some day): respooling doesn't work in autonomous
18017 In order to use @code{nndiary} in autonomous mode, you have several
18022 Allow @code{nndiary} to retrieve new mail by itself. Put the following
18023 line in your @file{gnusrc} file:
18026 (setq nndiary-get-new-mail t)
18029 You must arrange for diary messages (those containing @code{X-Diary-*}
18030 headers) to be split in a private folder @emph{before} Gnus treat them.
18031 Again, this is needed because Gnus cannot (yet ?) properly handle
18032 multiple primary mail back ends. Getting those messages from a separate
18033 source will compensate this misfeature to some extent.
18035 As an example, here's my procmailrc entry to store diary files in
18036 @file{~/.nndiary} (the default @code{nndiary} mail source file):
18045 Once this is done, you might want to customize the following two options
18046 that affect the diary mail retrieval and splitting processes:
18048 @defvar nndiary-mail-sources
18049 This is the diary-specific replacement for the standard
18050 @code{mail-sources} variable. It obeys the same syntax, and defaults to
18051 @code{(file :path "~/.nndiary")}.
18054 @defvar nndiary-split-methods
18055 This is the diary-specific replacement for the standard
18056 @code{nnmail-split-methods} variable. It obeys the same syntax.
18059 Finally, you may add a permanent @code{nndiary} virtual server
18060 (something like @code{(nndiary "diary")} should do) to your
18061 @code{gnus-secondary-select-methods}.
18063 Hopefully, almost everything (see the TODO section in
18064 @file{nndiary.el}) will work as expected when you restart Gnus: in
18065 autonomous mode, typing @kbd{g} and @kbd{M-g} in the group buffer, will
18066 also get your new diary mails and split them according to your
18067 diary-specific rules, @kbd{F} will find your new diary groups etc.
18069 @node Customizing NNDiary
18070 @subsubsection Customizing NNDiary
18071 @cindex customizing nndiary
18072 @cindex nndiary customization
18074 Now that @code{nndiary} is up and running, it's time to customize it.
18075 The custom group is called @code{nndiary} (no, really ?!). You should
18076 browse it to figure out which options you'd like to tweak. The following
18077 two variables are probably the only ones you will want to change:
18079 @defvar nndiary-reminders
18080 This is the list of times when you want to be reminded of your
18081 appointements (e.g. 3 weeks before, then 2 days before, then 1 hour
18082 before and that's it). Remember that ``being reminded'' means that the
18083 diary message will pop up as brand new and unread again when you get new
18087 @defvar nndiary-week-starts-on-monday
18088 Rather self-explanatory. Otherwise, Sunday is assumed (this is the
18093 @node The Gnus Diary Library
18094 @subsection The Gnus Diary Library
18096 @cindex the gnus diary library
18098 Using @code{nndiary} manually (I mean, writing the headers by hand and
18099 so on) would be rather boring. Fortunately, there is a library called
18100 @code{gnus-diary} written on top of @code{nndiary}, that does many
18101 useful things for you.
18103 In order to use it, add the following line to your @file{gnusrc} file:
18106 (require 'gnus-diary)
18109 Also, you shouldn't use any @code{gnus-user-format-function-[d|D]}
18110 (@pxref{Summary Buffer Lines}). @code{gnus-diary} provides both of these
18111 (sorry if you used them before).
18115 * Diary Summary Line Format:: A nicer summary buffer line format.
18116 * Diary Articles Sorting:: A nicer way to sort messages.
18117 * Diary Headers Generation:: Not doing it manually.
18118 * Diary Group Parameters:: Not handling them manually.
18121 @node Diary Summary Line Format
18122 @subsubsection Diary Summary Line Format
18123 @cindex diary summary buffer line
18124 @cindex diary summary line format
18126 Displaying diary messages in standard summary line format (usually
18127 something like @samp{From Joe: Subject}) is pretty useless. Most of
18128 the time, you're the one who wrote the message, and you mostly want to
18129 see the event's date.
18131 @code{gnus-diary} provides two supplemental user formats to be used in
18132 summary line formats. @code{D} corresponds to a formatted time string
18133 for the next occurrence of the event (e.g. ``Sat, Sep 22 01, 12:00''),
18134 while @code{d} corresponds to an approximative remaining time until the
18135 next occurrence of the event (e.g. ``in 6 months, 1 week'').
18137 For example, here's how Joe's birthday is displayed in my
18138 @code{nndiary+diary:birthdays} summary buffer (note that the message is
18139 expirable, but will never be deleted, as it specifies a periodic event):
18142 E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week)
18145 In order to get something like the above, you would normally add the
18146 following line to your diary groups'parameters:
18149 (gnus-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n")
18152 However, @code{gnus-diary} does it automatically (@pxref{Diary Group
18153 Parameters}). You can however customize the provided summary line format
18154 with the following user options:
18156 @defvar gnus-diary-summary-line-format
18157 Defines the summary line format used for diary groups (@pxref{Summary
18158 Buffer Lines}). @code{gnus-diary} uses it to automatically update the
18159 diary groups'parameters.
18162 @defvar gnus-diary-time-format
18163 Defines the format to display dates in diary summary buffers. This is
18164 used by the @code{D} user format. See the docstring for details.
18167 @defvar gnus-diary-delay-format-function
18168 Defines the format function to use for displaying delays (remaining
18169 times) in diary summary buffers. This is used by the @code{d} user
18170 format. There are currently built-in functions for English and French;
18171 you can also define your own. See the docstring for details.
18174 @node Diary Articles Sorting
18175 @subsubsection Diary Articles Sorting
18176 @cindex diary articles sorting
18177 @cindex diary summary lines sorting
18178 @findex gnus-summary-sort-by-schedule
18179 @findex gnus-thread-sort-by-schedule
18180 @findex gnus-article-sort-by-schedule
18182 @code{gnus-diary} provides new sorting functions (@pxref{Sorting the
18183 Summary Buffer} ) called @code{gnus-summary-sort-by-schedule},
18184 @code{gnus-thread-sort-by-schedule} and
18185 @code{gnus-article-sort-by-schedule}. These functions let you organize
18186 your diary summary buffers from the closest event to the farthest one.
18188 @code{gnus-diary} automatically installs
18189 @code{gnus-summary-sort-by-schedule} as a menu item in the summary
18190 buffer's ``sort'' menu, and the two others as the primary (hence
18191 default) sorting functions in the group parameters (@pxref{Diary Group
18194 @node Diary Headers Generation
18195 @subsubsection Diary Headers Generation
18196 @cindex diary headers generation
18197 @findex gnus-diary-check-message
18199 @code{gnus-diary} provides a function called
18200 @code{gnus-diary-check-message} to help you handle the @code{X-Diary-*}
18201 headers. This function ensures that the current message contains all the
18202 required diary headers, and prompts you for values or corrections if
18205 This function is hooked into the @code{nndiary} back end, so that
18206 moving or copying an article to a diary group will trigger it
18207 automatically. It is also bound to @kbd{C-c D c} in @code{message-mode}
18208 and @code{article-edit-mode} in order to ease the process of converting
18209 a usual mail to a diary one.
18211 This function takes a prefix argument which will force prompting of
18212 all diary headers, regardless of their presence or validity. That way,
18213 you can very easily reschedule an already valid diary message, for
18216 @node Diary Group Parameters
18217 @subsubsection Diary Group Parameters
18218 @cindex diary group parameters
18220 When you create a new diary group, or visit one, @code{gnus-diary}
18221 automatically checks your group parameters and if needed, sets the
18222 summary line format to the diary-specific value, installs the
18223 diary-specific sorting functions, and also adds the different
18224 @code{X-Diary-*} headers to the group's posting-style. It is then easier
18225 to send a diary message, because if you use @kbd{C-u a} or @kbd{C-u m}
18226 on a diary group to prepare a message, these headers will be inserted
18227 automatically (although not filled with proper values yet).
18229 @node Sending or Not Sending
18230 @subsection Sending or Not Sending
18232 Well, assuming you've read of of the above, here are two final notes on
18233 mail sending with @code{nndiary}:
18237 @code{nndiary} is a @emph{real} mail back end. You really send real diary
18238 messsages for real. This means for instance that you can give
18239 appointements to anybody (provided they use Gnus and @code{nndiary}) by
18240 sending the diary message to them as well.
18242 However, since @code{nndiary} also has a @code{request-post} method, you
18243 can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the
18244 message won't actually be sent; just stored locally in the group. This
18245 comes in very handy for private appointments.
18248 @node Gnus Unplugged
18249 @section Gnus Unplugged
18254 @cindex Gnus unplugged
18256 In olden times (ca. February '88), people used to run their newsreaders
18257 on big machines with permanent connections to the net. News transport
18258 was dealt with by news servers, and all the newsreaders had to do was to
18259 read news. Believe it or not.
18261 Nowadays most people read news and mail at home, and use some sort of
18262 modem to connect to the net. To avoid running up huge phone bills, it
18263 would be nice to have a way to slurp down all the news and mail, hang up
18264 the phone, read for several hours, and then upload any responses you
18265 have to make. And then you repeat the procedure.
18267 Of course, you can use news servers for doing this as well. I've used
18268 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
18269 for some years, but doing that's a bore. Moving the news server
18270 functionality up to the newsreader makes sense if you're the only person
18271 reading news on a machine.
18273 Setting up Gnus as an ``offline'' newsreader is quite simple. In
18274 fact, you don't have to configure anything as the agent is now enabled
18275 by default (@pxref{Agent Variables, gnus-agent}).
18277 Of course, to use it as such, you have to learn a few new commands.
18280 * Agent Basics:: How it all is supposed to work.
18281 * Agent Categories:: How to tell the Gnus Agent what to download.
18282 * Agent Commands:: New commands for all the buffers.
18283 * Agent Visuals:: Ways that the agent may effect your summary buffer.
18284 * Agent as Cache:: The Agent is a big cache too.
18285 * Agent Expiry:: How to make old articles go away.
18286 * Agent Regeneration:: How to recover from lost connections and other accidents.
18287 * Agent and flags:: How the Agent maintains flags.
18288 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
18289 * Outgoing Messages:: What happens when you post/mail something?
18290 * Agent Variables:: Customizing is fun.
18291 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
18292 * Batching Agents:: How to fetch news from a @code{cron} job.
18293 * Agent Caveats:: What you think it'll do and what it does.
18298 @subsection Agent Basics
18300 First, let's get some terminology out of the way.
18302 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
18303 connection to the net (and notified the Agent that this is the case).
18304 When the connection to the net is up again (and Gnus knows this), the
18305 Agent is @dfn{plugged}.
18307 The @dfn{local} machine is the one you're running on, and which isn't
18308 connected to the net continuously.
18310 @dfn{Downloading} means fetching things from the net to your local
18311 machine. @dfn{Uploading} is doing the opposite.
18313 You know that Gnus gives you all the opportunity you'd ever want for
18314 shooting yourself in the foot. Some people call it flexibility. Gnus
18315 is also customizable to a great extent, which means that the user has a
18316 say on how Gnus behaves. Other newsreaders might unconditionally shoot
18317 you in your foot, but with Gnus, you have a choice!
18319 Gnus is never really in plugged or unplugged state. Rather, it applies
18320 that state to each server individually. This means that some servers
18321 can be plugged while others can be unplugged. Additionally, some
18322 servers can be ignored by the Agent altogether (which means that
18323 they're kinda like plugged always).
18325 So when you unplug the Agent and then wonder why is Gnus opening a
18326 connection to the Net, the next step to do is to look whether all
18327 servers are agentized. If there is an unagentized server, you found
18330 Another thing is the @dfn{offline} state. Sometimes, servers aren't
18331 reachable. When Gnus notices this, it asks you whether you want the
18332 server to be switched to offline state. If you say yes, then the
18333 server will behave somewhat as if it was unplugged, except that Gnus
18334 will ask you whether you want to switch it back online again.
18336 Let's take a typical Gnus session using the Agent.
18341 @findex gnus-unplugged
18342 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
18343 Agent in a disconnected state. You can read all the news that you have
18344 already fetched while in this mode.
18347 You then decide to see whether any new news has arrived. You connect
18348 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
18349 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
18350 as usual. To check for new mail in unplugged mode (@pxref{Mail
18351 Source Specifiers}).
18354 You can then read the new news immediately, or you can download the
18355 news onto your local machine. If you want to do the latter, you press
18356 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
18357 all the eligible articles in all the groups. (To let Gnus know which
18358 articles you want to download, @pxref{Agent Categories}).
18361 After fetching the articles, you press @kbd{J j} to make Gnus become
18362 unplugged again, and you shut down the PPP thing (or whatever). And
18363 then you read the news offline.
18366 And then you go to step 2.
18369 Here are some things you should do the first time (or so) that you use
18375 Decide which servers should be covered by the Agent. If you have a mail
18376 back end, it would probably be nonsensical to have it covered by the
18377 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
18378 @kbd{J a} on the server (or servers) that you wish to have covered by the
18379 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
18380 added servers you do not wish to have covered by the Agent. By default,
18381 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
18382 @code{gnus-secondary-select-methods} are agentized.
18385 Decide on download policy. It's fairly simple once you decide whether
18386 you are going to use agent categories, topic parameters, and/or group
18387 parameters to implement your policy. If you're new to gnus, it
18388 is probably best to start with a category, @xref{Agent Categories}.
18390 Both topic parameters (@pxref{Topic Parameters}) and agent categories
18391 (@pxref{Agent Categories}) provide for setting a policy that applies
18392 to multiple groups. Which you use is entirely up to you. Topic
18393 parameters do override categories so, if you mix the two, you'll have
18394 to take that into account. If you have a few groups that deviate from
18395 your policy, you can use group parameters (@pxref{Group Parameters}) to
18399 Uhm@dots{} that's it.
18403 @node Agent Categories
18404 @subsection Agent Categories
18406 One of the main reasons to integrate the news transport layer into the
18407 newsreader is to allow greater control over what articles to download.
18408 There's not much point in downloading huge amounts of articles, just to
18409 find out that you're not interested in reading any of them. It's better
18410 to be somewhat more conservative in choosing what to download, and then
18411 mark the articles for downloading manually if it should turn out that
18412 you're interested in the articles anyway.
18414 One of the more effective methods for controlling what is to be
18415 downloaded is to create a @dfn{category} and then assign some (or all)
18416 groups to this category. Groups that do not belong in any other
18417 category belong to the @code{default} category. Gnus has its own
18418 buffer for creating and managing categories.
18420 If you prefer, you can also use group parameters (@pxref{Group
18421 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
18422 alternative approach to controlling the agent. The only real
18423 difference is that categories are specific to the agent (so there is
18424 less to learn) while group and topic parameters include the kitchen
18427 Since you can set agent parameters in several different places we have
18428 a rule to decide which source to believe. This rule specifies that
18429 the parameter sources are checked in the following order: group
18430 parameters, topic parameters, agent category, and finally customizable
18431 variables. So you can mix all of these sources to produce a wide range
18432 of behavior, just don't blame me if you don't remember where you put
18436 * Category Syntax:: What a category looks like.
18437 * Category Buffer:: A buffer for maintaining categories.
18438 * Category Variables:: Customize'r'Us.
18442 @node Category Syntax
18443 @subsubsection Category Syntax
18445 A category consists of a name, the list of groups belonging to the
18446 category, and a number of optional parameters that override the
18447 customizable variables. The complete list of agent parameters are
18450 @cindex Agent Parameters
18453 The list of groups that are in this category.
18455 @item agent-predicate
18456 A predicate which (generally) gives a rough outline of which articles
18457 are eligible for downloading; and
18460 a score rule which (generally) gives you a finer granularity when
18461 deciding what articles to download. (Note that this @dfn{download
18462 score} is not necessarily related to normal scores.)
18464 @item agent-enable-expiration
18465 a boolean indicating whether the agent should expire old articles in
18466 this group. Most groups should be expired to conserve disk space. In
18467 fact, its probably safe to say that the gnus.* hierarchy contains the
18468 only groups that should not be expired.
18470 @item agent-days-until-old
18471 an integer indicating the number of days that the agent should wait
18472 before deciding that a read article is safe to expire.
18474 @item agent-low-score
18475 an integer that overrides the value of @code{gnus-agent-low-score}.
18477 @item agent-high-score
18478 an integer that overrides the value of @code{gnus-agent-high-score}.
18480 @item agent-short-article
18481 an integer that overrides the value of
18482 @code{gnus-agent-short-article}.
18484 @item agent-long-article
18485 an integer that overrides the value of @code{gnus-agent-long-article}.
18487 @item agent-enable-undownloaded-faces
18488 a symbol indicating whether the summary buffer should display
18489 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
18490 faces. Any symbol other than @code{nil} will enable the use of
18491 undownloaded faces.
18494 The name of a category can not be changed once the category has been
18497 Each category maintains a list of groups that are exclusive members of
18498 that category. The exclusivity rule is automatically enforced, add a
18499 group to a new category and it is automatically removed from its old
18502 A predicate in its simplest form can be a single predicate such as
18503 @code{true} or @code{false}. These two will download every available
18504 article or nothing respectively. In the case of these two special
18505 predicates an additional score rule is superfluous.
18507 Predicates of @code{high} or @code{low} download articles in respect of
18508 their scores in relationship to @code{gnus-agent-high-score} and
18509 @code{gnus-agent-low-score} as described below.
18511 To gain even finer control of what is to be regarded eligible for
18512 download a predicate can consist of a number of predicates with logical
18513 operators sprinkled in between.
18515 Perhaps some examples are in order.
18517 Here's a simple predicate. (It's the default predicate, in fact, used
18518 for all groups that don't belong to any other category.)
18524 Quite simple, eh? This predicate is true if and only if the article is
18525 short (for some value of ``short'').
18527 Here's a more complex predicate:
18536 This means that an article should be downloaded if it has a high score,
18537 or if the score is not low and the article is not long. You get the
18540 The available logical operators are @code{or}, @code{and} and
18541 @code{not}. (If you prefer, you can use the more ``C''-ish operators
18542 @samp{|}, @code{&} and @code{!} instead.)
18544 The following predicates are pre-defined, but if none of these fit what
18545 you want to do, you can write your own.
18547 When evaluating each of these predicates, the named constant will be
18548 bound to the value determined by calling
18549 @code{gnus-agent-find-parameter} on the appropriate parameter. For
18550 example, gnus-agent-short-article will be bound to
18551 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
18552 means that you can specify a predicate in your category then tune that
18553 predicate to individual groups.
18557 True iff the article is shorter than @code{gnus-agent-short-article}
18558 lines; default 100.
18561 True iff the article is longer than @code{gnus-agent-long-article}
18562 lines; default 200.
18565 True iff the article has a download score less than
18566 @code{gnus-agent-low-score}; default 0.
18569 True iff the article has a download score greater than
18570 @code{gnus-agent-high-score}; default 0.
18573 True iff the Gnus Agent guesses that the article is spam. The
18574 heuristics may change over time, but at present it just computes a
18575 checksum and sees whether articles match.
18584 If you want to create your own predicate function, here's what you have
18585 to know: The functions are called with no parameters, but the
18586 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
18589 For example, you could decide that you don't want to download articles
18590 that were posted more than a certain number of days ago (e.g. posted
18591 more than @code{gnus-agent-expire-days} ago) you might write a function
18592 something along the lines of the following:
18595 (defun my-article-old-p ()
18596 "Say whether an article is old."
18597 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
18598 (- (time-to-days (current-time)) gnus-agent-expire-days)))
18601 with the predicate then defined as:
18604 (not my-article-old-p)
18607 or you could append your predicate to the predefined
18608 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
18612 (require 'gnus-agent)
18613 (setq gnus-category-predicate-alist
18614 (append gnus-category-predicate-alist
18615 '((old . my-article-old-p))))
18618 and simply specify your predicate as:
18624 If/when using something like the above, be aware that there are many
18625 misconfigured systems/mailers out there and so an article's date is not
18626 always a reliable indication of when it was posted. Hell, some people
18627 just don't give a damn.
18629 The above predicates apply to @emph{all} the groups which belong to the
18630 category. However, if you wish to have a specific predicate for an
18631 individual group within a category, or you're just too lazy to set up a
18632 new category, you can enter a group's individual predicate in its group
18633 parameters like so:
18636 (agent-predicate . short)
18639 This is the group/topic parameter equivalent of the agent category default.
18640 Note that when specifying a single word predicate like this, the
18641 @code{agent-predicate} specification must be in dotted pair notation.
18643 The equivalent of the longer example from above would be:
18646 (agent-predicate or high (and (not low) (not long)))
18649 The outer parenthesis required in the category specification are not
18650 entered here as, not being in dotted pair notation, the value of the
18651 predicate is assumed to be a list.
18654 Now, the syntax of the download score is the same as the syntax of
18655 normal score files, except that all elements that require actually
18656 seeing the article itself are verboten. This means that only the
18657 following headers can be scored on: @code{Subject}, @code{From},
18658 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
18659 @code{Lines}, and @code{Xref}.
18661 As with predicates, the specification of the @code{download score rule}
18662 to use in respect of a group can be in either the category definition if
18663 it's to be applicable to all groups in therein, or a group's parameters
18664 if it's to be specific to that group.
18666 In both of these places the @code{download score rule} can take one of
18673 This has the same syntax as a normal Gnus score file except only a
18674 subset of scoring keywords are available as mentioned above.
18680 Category specification
18684 ("Lars Ingebrigtsen" 1000000 nil s))
18690 Group/Topic Parameter specification
18693 (agent-score ("from"
18694 ("Lars Ingebrigtsen" 1000000 nil s))
18699 Again, note the omission of the outermost parenthesis here.
18705 These score files must @emph{only} contain the permitted scoring
18706 keywords stated above.
18712 Category specification
18715 ("~/News/agent.SCORE")
18721 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
18725 Group Parameter specification
18728 (agent-score "~/News/agent.SCORE")
18731 Additional score files can be specified as above. Need I say anything
18736 Use @code{normal} score files
18738 If you don't want to maintain two sets of scoring rules for a group, and
18739 your desired @code{downloading} criteria for a group are the same as your
18740 @code{reading} criteria then you can tell the agent to refer to your
18741 @code{normal} score files when deciding what to download.
18743 These directives in either the category definition or a group's
18744 parameters will cause the agent to read in all the applicable score
18745 files for a group, @emph{filtering out} those sections that do not
18746 relate to one of the permitted subset of scoring keywords.
18750 Category Specification
18757 Group Parameter specification
18760 (agent-score . file)
18765 @node Category Buffer
18766 @subsubsection Category Buffer
18768 You'd normally do all category maintenance from the category buffer.
18769 When you enter it for the first time (with the @kbd{J c} command from
18770 the group buffer), you'll only see the @code{default} category.
18772 The following commands are available in this buffer:
18776 @kindex q (Category)
18777 @findex gnus-category-exit
18778 Return to the group buffer (@code{gnus-category-exit}).
18781 @kindex e (Category)
18782 @findex gnus-category-customize-category
18783 Use a customization buffer to set all of the selected category's
18784 parameters at one time (@code{gnus-category-customize-category}).
18787 @kindex k (Category)
18788 @findex gnus-category-kill
18789 Kill the current category (@code{gnus-category-kill}).
18792 @kindex c (Category)
18793 @findex gnus-category-copy
18794 Copy the current category (@code{gnus-category-copy}).
18797 @kindex a (Category)
18798 @findex gnus-category-add
18799 Add a new category (@code{gnus-category-add}).
18802 @kindex p (Category)
18803 @findex gnus-category-edit-predicate
18804 Edit the predicate of the current category
18805 (@code{gnus-category-edit-predicate}).
18808 @kindex g (Category)
18809 @findex gnus-category-edit-groups
18810 Edit the list of groups belonging to the current category
18811 (@code{gnus-category-edit-groups}).
18814 @kindex s (Category)
18815 @findex gnus-category-edit-score
18816 Edit the download score rule of the current category
18817 (@code{gnus-category-edit-score}).
18820 @kindex l (Category)
18821 @findex gnus-category-list
18822 List all the categories (@code{gnus-category-list}).
18826 @node Category Variables
18827 @subsubsection Category Variables
18830 @item gnus-category-mode-hook
18831 @vindex gnus-category-mode-hook
18832 Hook run in category buffers.
18834 @item gnus-category-line-format
18835 @vindex gnus-category-line-format
18836 Format of the lines in the category buffer (@pxref{Formatting
18837 Variables}). Valid elements are:
18841 The name of the category.
18844 The number of groups in the category.
18847 @item gnus-category-mode-line-format
18848 @vindex gnus-category-mode-line-format
18849 Format of the category mode line (@pxref{Mode Line Formatting}).
18851 @item gnus-agent-short-article
18852 @vindex gnus-agent-short-article
18853 Articles that have fewer lines than this are short. Default 100.
18855 @item gnus-agent-long-article
18856 @vindex gnus-agent-long-article
18857 Articles that have more lines than this are long. Default 200.
18859 @item gnus-agent-low-score
18860 @vindex gnus-agent-low-score
18861 Articles that have a score lower than this have a low score. Default
18864 @item gnus-agent-high-score
18865 @vindex gnus-agent-high-score
18866 Articles that have a score higher than this have a high score. Default
18869 @item gnus-agent-expire-days
18870 @vindex gnus-agent-expire-days
18871 The number of days that a @samp{read} article must stay in the agent's
18872 local disk before becoming eligible for expiration (While the name is
18873 the same, this doesn't mean expiring the article on the server. It
18874 just means deleting the local copy of the article). What is also
18875 important to understand is that the counter starts with the time the
18876 article was written to the local disk and not the time the article was
18880 @item gnus-agent-enable-expiration
18881 @vindex gnus-agent-enable-expiration
18882 Determines whether articles in a group are, by default, expired or
18883 retained indefinitely. The default is @code{ENABLE} which means that
18884 you'll have to disable expiration when desired. On the other hand,
18885 you could set this to @code{DISABLE}. In that case, you would then
18886 have to enable expiration in selected groups.
18891 @node Agent Commands
18892 @subsection Agent Commands
18893 @findex gnus-agent-toggle-plugged
18894 @kindex J j (Agent)
18896 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
18897 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18898 toggles the plugged/unplugged state of the Gnus Agent.
18902 * Group Agent Commands:: Configure groups and fetch their contents.
18903 * Summary Agent Commands:: Manually select then fetch specific articles.
18904 * Server Agent Commands:: Select the servers that are supported by the agent.
18910 @node Group Agent Commands
18911 @subsubsection Group Agent Commands
18915 @kindex J u (Agent Group)
18916 @findex gnus-agent-fetch-groups
18917 Fetch all eligible articles in the current group
18918 (@code{gnus-agent-fetch-groups}).
18921 @kindex J c (Agent Group)
18922 @findex gnus-enter-category-buffer
18923 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18926 @kindex J s (Agent Group)
18927 @findex gnus-agent-fetch-session
18928 Fetch all eligible articles in all groups
18929 (@code{gnus-agent-fetch-session}).
18932 @kindex J S (Agent Group)
18933 @findex gnus-group-send-queue
18934 Send all sendable messages in the queue group
18935 (@code{gnus-group-send-queue}). @xref{Drafts}.
18938 @kindex J a (Agent Group)
18939 @findex gnus-agent-add-group
18940 Add the current group to an Agent category
18941 (@code{gnus-agent-add-group}). This command understands the
18942 process/prefix convention (@pxref{Process/Prefix}).
18945 @kindex J r (Agent Group)
18946 @findex gnus-agent-remove-group
18947 Remove the current group from its category, if any
18948 (@code{gnus-agent-remove-group}). This command understands the
18949 process/prefix convention (@pxref{Process/Prefix}).
18952 @kindex J Y (Agent Group)
18953 @findex gnus-agent-synchronize-flags
18954 Synchronize flags changed while unplugged with remote server, if any.
18960 @node Summary Agent Commands
18961 @subsubsection Summary Agent Commands
18965 @kindex J # (Agent Summary)
18966 @findex gnus-agent-mark-article
18967 Mark the article for downloading (@code{gnus-agent-mark-article}).
18970 @kindex J M-# (Agent Summary)
18971 @findex gnus-agent-unmark-article
18972 Remove the downloading mark from the article
18973 (@code{gnus-agent-unmark-article}).
18977 @kindex @@ (Agent Summary)
18978 @findex gnus-agent-toggle-mark
18979 Toggle whether to download the article
18980 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
18984 @kindex J c (Agent Summary)
18985 @findex gnus-agent-catchup
18986 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18989 @kindex J S (Agent Summary)
18990 @findex gnus-agent-fetch-group
18991 Download all eligible (@pxref{Agent Categories}) articles in this group.
18992 (@code{gnus-agent-fetch-group}).
18995 @kindex J s (Agent Summary)
18996 @findex gnus-agent-summary-fetch-series
18997 Download all processable articles in this group.
18998 (@code{gnus-agent-summary-fetch-series}).
19001 @kindex J u (Agent Summary)
19002 @findex gnus-agent-summary-fetch-group
19003 Download all downloadable articles in the current group
19004 (@code{gnus-agent-summary-fetch-group}).
19009 @node Server Agent Commands
19010 @subsubsection Server Agent Commands
19014 @kindex J a (Agent Server)
19015 @findex gnus-agent-add-server
19016 Add the current server to the list of servers covered by the Gnus Agent
19017 (@code{gnus-agent-add-server}).
19020 @kindex J r (Agent Server)
19021 @findex gnus-agent-remove-server
19022 Remove the current server from the list of servers covered by the Gnus
19023 Agent (@code{gnus-agent-remove-server}).
19028 @node Agent Visuals
19029 @subsection Agent Visuals
19031 If you open a summary while unplugged and, Gnus knows from the group's
19032 active range that there are more articles than the headers currently
19033 stored in the Agent, you may see some articles whose subject looks
19034 something like @samp{[Undownloaded article #####]}. These are
19035 placeholders for the missing headers. Aside from setting a mark,
19036 there is not much that can be done with one of these placeholders.
19037 When Gnus finally gets a chance to fetch the group's headers, the
19038 placeholders will automatically be replaced by the actual headers.
19039 You can configure the summary buffer's maneuvering to skip over the
19040 placeholders if you care (See @code{gnus-auto-goto-ignores}).
19042 While it may be obvious to all, the only headers and articles
19043 available while unplugged are those headers and articles that were
19044 fetched into the Agent while previously plugged. To put it another
19045 way, ``If you forget to fetch something while plugged, you might have a
19046 less than satisfying unplugged session''. For this reason, the Agent
19047 adds two visual effects to your summary buffer. These effects display
19048 the download status of each article so that you always know which
19049 articles will be available when unplugged.
19051 The first visual effect is the @samp{%O} spec. If you customize
19052 @code{gnus-summary-line-format} to include this specifier, you will add
19053 a single character field that indicates an article's download status.
19054 Articles that have been fetched into either the Agent or the Cache,
19055 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
19056 other articles will display @code{gnus-undownloaded-mark} (defaults to
19057 @samp{-}). If you open a group that has not been agentized, a space
19058 (@samp{ }) will be displayed.
19060 The second visual effect are the undownloaded faces. The faces, there
19061 are three indicating the article's score (low, normal, high), seem to
19062 result in a love/hate response from many Gnus users. The problem is
19063 that the face selection is controlled by a list of condition tests and
19064 face names (See @code{gnus-summary-highlight}). Each condition is
19065 tested in the order in which it appears in the list so early
19066 conditions have precedence over later conditions. All of this means
19067 that, if you tick an undownloaded article, the article will continue
19068 to be displayed in the undownloaded face rather than the ticked face.
19070 If you use the Agent as a cache (to avoid downloading the same article
19071 each time you visit it or to minimize your connection time), the
19072 undownloaded face will probably seem like a good idea. The reason
19073 being that you do all of our work (marking, reading, deleting) with
19074 downloaded articles so the normal faces always appear. For those
19075 users using the agent to improve online performance by caching the NOV
19076 database (most users since 5.10.2), the undownloaded faces may appear
19077 to be an absolutely horrible idea. The issue being that, since none
19078 of their articles have been fetched into the Agent, all of the
19079 normal faces will be obscured by the undownloaded faces.
19081 If you would like to use the undownloaded faces, you must enable the
19082 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
19083 group parameter to @code{t}. This parameter, like all other agent
19084 parameters, may be set on an Agent Category (@pxref{Agent Categories}),
19085 a Group Topic (@pxref{Topic Parameters}), or an individual group
19086 (@pxref{Group Parameters}).
19088 The one problem common to all users using the agent is how quickly it
19089 can consume disk space. If you using the agent on many groups, it is
19090 even more difficult to effectively recover disk space. One solution
19091 is the @samp{%F} format available in @code{gnus-group-line-format}.
19092 This format will display the actual disk space used by articles
19093 fetched into both the agent and cache. By knowing which groups use
19094 the most space, users know where to focus their efforts when ``agent
19095 expiring'' articles.
19097 @node Agent as Cache
19098 @subsection Agent as Cache
19100 When Gnus is plugged, it is not efficient to download headers or
19101 articles from the server again, if they are already stored in the
19102 Agent. So, Gnus normally only downloads headers once, and stores them
19103 in the Agent. These headers are later used when generating the summary
19104 buffer, regardless of whether you are plugged or unplugged. Articles
19105 are not cached in the Agent by default though (that would potentially
19106 consume lots of disk space), but if you have already downloaded an
19107 article into the Agent, Gnus will not download the article from the
19108 server again but use the locally stored copy instead.
19110 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
19111 @pxref{Agent Variables}) to always download headers and articles while
19112 plugged. Gnus will almost certainly be slower, but it will be kept
19113 synchronized with the server. That last point probably won't make any
19114 sense if you are using a nntp or nnimap back end.
19117 @subsection Agent Expiry
19119 @vindex gnus-agent-expire-days
19120 @findex gnus-agent-expire
19121 @kindex M-x gnus-agent-expire
19122 @kindex M-x gnus-agent-expire-group
19123 @findex gnus-agent-expire-group
19124 @cindex agent expiry
19125 @cindex Gnus agent expiry
19128 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
19129 least it doesn't handle it like other back ends. Instead, there are
19130 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
19131 commands that will expire all read articles that are older than
19132 @code{gnus-agent-expire-days} days. They can be run whenever you feel
19133 that you're running out of space. Neither are particularly fast or
19134 efficient, and it's not a particularly good idea to interrupt them (with
19135 @kbd{C-g} or anything else) once you've started one of them.
19137 Note that other functions, e.g. @code{gnus-request-expire-articles},
19138 might run @code{gnus-agent-expire} for you to keep the agent
19139 synchronized with the group.
19141 The agent parameter @code{agent-enable-expiration} may be used to
19142 prevent expiration in selected groups.
19144 @vindex gnus-agent-expire-all
19145 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
19146 expiration commands will expire all articles---unread, read, ticked
19147 and dormant. If @code{nil} (which is the default), only read articles
19148 are eligible for expiry, and unread, ticked and dormant articles will
19149 be kept indefinitely.
19151 If you find that some articles eligible for expiry are never expired,
19152 perhaps some Gnus Agent files are corrupted. There's are special
19153 commands, @code{gnus-agent-regenerate} and
19154 @code{gnus-agent-regenerate-group}, to fix possible problems.
19156 @node Agent Regeneration
19157 @subsection Agent Regeneration
19159 @cindex agent regeneration
19160 @cindex Gnus agent regeneration
19161 @cindex regeneration
19163 The local data structures used by @code{nnagent} may become corrupted
19164 due to certain exceptional conditions. When this happens,
19165 @code{nnagent} functionality may degrade or even fail. The solution
19166 to this problem is to repair the local data structures by removing all
19167 internal inconsistencies.
19169 For example, if your connection to your server is lost while
19170 downloaded articles into the agent, the local data structures will not
19171 know about articles successfully downloaded prior to the connection
19172 failure. Running @code{gnus-agent-regenerate} or
19173 @code{gnus-agent-regenerate-group} will update the data structures
19174 such that you don't need to download these articles a second time.
19176 @findex gnus-agent-regenerate
19177 @kindex M-x gnus-agent-regenerate
19178 The command @code{gnus-agent-regenerate} will perform
19179 @code{gnus-agent-regenerate-group} on every agentized group. While
19180 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
19181 recommended that you first close all summary buffers.
19183 @findex gnus-agent-regenerate-group
19184 @kindex M-x gnus-agent-regenerate-group
19185 The command @code{gnus-agent-regenerate-group} uses the local copies
19186 of individual articles to repair the local @acronym{NOV}(header) database. It
19187 then updates the internal data structures that document which articles
19188 are stored locally. An optional argument will mark articles in the
19191 @node Agent and flags
19192 @subsection Agent and flags
19194 The Agent works with any Gnus back end including those, such as
19195 nnimap, that store flags (read, ticked, etc) on the server. Sadly,
19196 the Agent does not actually know which backends keep their flags in
19197 the backend server rather than in @file{.newsrc}. This means that the
19198 Agent, while unplugged or disconnected, will always record all changes
19199 to the flags in its own files.
19201 When you plug back in, Gnus will then check to see if you have any
19202 changed any flags and ask if you wish to synchronize these with the
19203 server. This behavior is customizable by @code{gnus-agent-synchronize-flags}.
19205 @vindex gnus-agent-synchronize-flags
19206 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19207 never automatically synchronize flags. If it is @code{ask}, which is
19208 the default, the Agent will check if you made any changes and if so
19209 ask if you wish to synchronize these when you re-connect. If it has
19210 any other value, all flags will be synchronized automatically.
19212 If you do not wish to synchronize flags automatically when you
19213 re-connect, you can do it manually with the
19214 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
19215 in the group buffer.
19217 Technical note: the synchronization algorithm does not work by ``pushing''
19218 all local flags to the server, but rather by incrementally updated the
19219 server view of flags by changing only those flags that were changed by
19220 the user. Thus, if you set one flag on an article, quit the group then
19221 re-select the group and remove the flag; the flag will be set and
19222 removed from the server when you ``synchronize''. The queued flag
19223 operations can be found in the per-server @code{flags} file in the Agent
19224 directory. It's emptied when you synchronize flags.
19226 @node Agent and IMAP
19227 @subsection Agent and IMAP
19229 The Agent works with any Gnus back end, including nnimap. However,
19230 since there are some conceptual differences between @acronym{NNTP} and
19231 @acronym{IMAP}, this section (should) provide you with some information to
19232 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
19234 Some things are currently not implemented in the Agent that you'd might
19235 expect from a disconnected @acronym{IMAP} client, including:
19240 Copying/moving articles into nnimap groups when unplugged.
19243 Creating/deleting nnimap groups when unplugged.
19247 @node Outgoing Messages
19248 @subsection Outgoing Messages
19250 By default, when Gnus is unplugged, all outgoing messages (both mail
19251 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
19252 You can view them there after posting, and edit them at will.
19254 You can control the circumstances under which outgoing mail is queued
19255 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
19256 news is always queued when Gnus is unplugged, and never otherwise.
19258 You can send the messages either from the draft group with the special
19259 commands available there, or you can use the @kbd{J S} command in the
19260 group buffer to send all the sendable messages in the draft group.
19261 Posting news will only work when Gnus is plugged, but you can send
19264 If sending mail while unplugged does not work for you and you worry
19265 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
19266 ask you to confirm your action (see
19267 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
19269 @node Agent Variables
19270 @subsection Agent Variables
19275 Is the agent enabled? The default is @code{t}. When first enabled,
19276 the agent will use @code{gnus-agent-auto-agentize-methods} to
19277 automatically mark some back ends as agentized. You may change which
19278 back ends are agentized using the agent commands in the server buffer.
19280 To enter the server buffer, use the @kbd{^}
19281 (@code{gnus-group-enter-server-mode}) command in the group buffer.
19284 @item gnus-agent-directory
19285 @vindex gnus-agent-directory
19286 Where the Gnus Agent will store its files. The default is
19287 @file{~/News/agent/}.
19289 @item gnus-agent-handle-level
19290 @vindex gnus-agent-handle-level
19291 Groups on levels (@pxref{Group Levels}) higher than this variable will
19292 be ignored by the Agent. The default is @code{gnus-level-subscribed},
19293 which means that only subscribed group will be considered by the Agent
19296 @item gnus-agent-plugged-hook
19297 @vindex gnus-agent-plugged-hook
19298 Hook run when connecting to the network.
19300 @item gnus-agent-unplugged-hook
19301 @vindex gnus-agent-unplugged-hook
19302 Hook run when disconnecting from the network.
19304 @item gnus-agent-fetched-hook
19305 @vindex gnus-agent-fetched-hook
19306 Hook run when finished fetching articles.
19308 @item gnus-agent-cache
19309 @vindex gnus-agent-cache
19310 Variable to control whether use the locally stored @acronym{NOV} and
19311 articles when plugged, e.g. essentially using the Agent as a cache.
19312 The default is non-@code{nil}, which means to use the Agent as a cache.
19314 @item gnus-agent-go-online
19315 @vindex gnus-agent-go-online
19316 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
19317 automatically switch offline servers into online status. If it is
19318 @code{ask}, the default, the Agent will ask if you wish to switch
19319 offline servers into online status when you re-connect. If it has any
19320 other value, all offline servers will be automatically switched into
19323 @item gnus-agent-mark-unread-after-downloaded
19324 @vindex gnus-agent-mark-unread-after-downloaded
19325 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
19326 mark articles as unread after downloading. This is usually a safe
19327 thing to do as the newly downloaded article has obviously not been
19328 read. The default is @code{t}.
19330 @item gnus-agent-synchronize-flags
19331 @vindex gnus-agent-synchronize-flags
19332 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19333 never automatically synchronize flags. If it is @code{ask}, which is
19334 the default, the Agent will check if you made any changes and if so
19335 ask if you wish to synchronize these when you re-connect. If it has
19336 any other value, all flags will be synchronized automatically.
19338 @item gnus-agent-consider-all-articles
19339 @vindex gnus-agent-consider-all-articles
19340 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
19341 agent will let the agent predicate decide whether articles need to be
19342 downloaded or not, for all articles. When @code{nil}, the default,
19343 the agent will only let the predicate decide whether unread articles
19344 are downloaded or not. If you enable this, you may also want to look
19345 into the agent expiry settings (@pxref{Category Variables}), so that
19346 the agent doesn't download articles which the agent will later expire,
19347 over and over again.
19349 @item gnus-agent-max-fetch-size
19350 @vindex gnus-agent-max-fetch-size
19351 The agent fetches articles into a temporary buffer prior to parsing
19352 them into individual files. To avoid exceeding the max. buffer size,
19353 the agent alternates between fetching and parsing until all articles
19354 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
19355 limit to control how often the cycling occurs. A large value improves
19356 performance. A small value minimizes the time lost should the
19357 connection be lost while fetching (You may need to run
19358 @code{gnus-agent-regenerate-group} to update the group's state.
19359 However, all articles parsed prior to loosing the connection will be
19360 available while unplugged). The default is 10M so it is unusual to
19363 @item gnus-server-unopen-status
19364 @vindex gnus-server-unopen-status
19365 Perhaps not an Agent variable, but closely related to the Agent, this
19366 variable says what will happen if Gnus cannot open a server. If the
19367 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
19368 whether to deny the server or whether to unplug the agent. If the
19369 Agent is disabled, Gnus always simply deny the server. Other choices
19370 for this variable include @code{denied} and @code{offline} the latter
19371 is only valid if the Agent is used.
19373 @item gnus-auto-goto-ignores
19374 @vindex gnus-auto-goto-ignores
19375 Another variable that isn't an Agent variable, yet so closely related
19376 that most will look for it here, this variable tells the summary
19377 buffer how to maneuver around undownloaded (only headers stored in the
19378 agent) and unfetched (neither article nor headers stored) articles.
19380 The valid values are @code{nil} (maneuver to any article),
19381 @code{undownloaded} (maneuvering while unplugged ignores articles that
19382 have not been fetched), @code{always-undownloaded} (maneuvering always
19383 ignores articles that have not been fetched), @code{unfetched}
19384 (maneuvering ignores articles whose headers have not been fetched).
19386 @item gnus-agent-queue-mail
19387 @vindex gnus-agent-queue-mail
19388 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
19389 queue mail rather than sending it straight away. When @code{t}, Gnus
19390 will queue mail when unplugged only. When @code{nil}, never queue
19391 mail. The default is @code{t}.
19393 @item gnus-agent-prompt-send-queue
19394 @vindex gnus-agent-prompt-send-queue
19395 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
19396 prompt you to confirm that you really wish to proceed if you hit
19397 @kbd{J S} while unplugged. The default is @code{nil}.
19399 @item gnus-agent-auto-agentize-methods
19400 @vindex gnus-agent-auto-agentize-methods
19401 If you have never used the Agent before (or more technically, if
19402 @file{~/News/agent/lib/servers} does not exist), Gnus will
19403 automatically agentize a few servers for you. This variable control
19404 which back ends should be auto-agentized. It is typically only useful
19405 to agentize remote back ends. The auto-agentizing has the same effect
19406 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
19407 If the file exist, you must manage the servers manually by adding or
19408 removing them, this variable is only applicable the first time you
19409 start Gnus. The default is @samp{(nntp nnimap)}.
19414 @node Example Setup
19415 @subsection Example Setup
19417 If you don't want to read this manual, and you have a fairly standard
19418 setup, you may be able to use something like the following as your
19419 @file{~/.gnus.el} file to get started.
19422 ;;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
19423 ;;; @r{from your ISP's server.}
19424 (setq gnus-select-method '(nntp "news.your-isp.com"))
19426 ;;; @r{Define how Gnus is to read your mail. We read mail from}
19427 ;;; @r{your ISP's @acronym{POP} server.}
19428 (setq mail-sources '((pop :server "pop.your-isp.com")))
19430 ;;; @r{Say how Gnus is to store the mail. We use nnml groups.}
19431 (setq gnus-secondary-select-methods '((nnml "")))
19433 ;;; @r{Make Gnus into an offline newsreader.}
19434 ;;; (gnus-agentize) ; @r{The obsolete setting.}
19435 ;;; (setq gnus-agent t) ; @r{Now the default.}
19438 That should be it, basically. Put that in your @file{~/.gnus.el} file,
19439 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
19442 If this is the first time you've run Gnus, you will be subscribed
19443 automatically to a few default newsgroups. You'll probably want to
19444 subscribe to more groups, and to do that, you have to query the
19445 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
19446 command. This usually takes quite a while, but you only have to do it
19449 After reading and parsing a while, you'll be presented with a list of
19450 groups. Subscribe to the ones you want to read with the @kbd{u}
19451 command. @kbd{l} to make all the killed groups disappear after you've
19452 subscribe to all the groups you want to read. (@kbd{A k} will bring
19453 back all the killed groups.)
19455 You can now read the groups at once, or you can download the articles
19456 with the @kbd{J s} command. And then read the rest of this manual to
19457 find out which of the other gazillion things you want to customize.
19460 @node Batching Agents
19461 @subsection Batching Agents
19462 @findex gnus-agent-batch
19464 Having the Gnus Agent fetch articles (and post whatever messages you've
19465 written) is quite easy once you've gotten things set up properly. The
19466 following shell script will do everything that is necessary:
19468 You can run a complete batch command from the command line with the
19469 following incantation:
19473 emacs -batch -l ~/.emacs -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1
19477 @node Agent Caveats
19478 @subsection Agent Caveats
19480 The Gnus Agent doesn't seem to work like most other offline
19481 newsreaders. Here are some common questions that some imaginary people
19485 @item If I read an article while plugged, do they get entered into the Agent?
19487 @strong{No}. If you want this behavior, add
19488 @code{gnus-agent-fetch-selected-article} to
19489 @code{gnus-select-article-hook}.
19491 @item If I read an article while plugged, and the article already exists in
19492 the Agent, will it get downloaded once more?
19494 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
19498 In short, when Gnus is unplugged, it only looks into the locally stored
19499 articles; when it's plugged, it talks to your ISP and may also use the
19500 locally stored articles.
19507 Other people use @dfn{kill files}, but we here at Gnus Towers like
19508 scoring better than killing, so we'd rather switch than fight. They do
19509 something completely different as well, so sit up straight and pay
19512 @vindex gnus-summary-mark-below
19513 All articles have a default score (@code{gnus-summary-default-score}),
19514 which is 0 by default. This score may be raised or lowered either
19515 interactively or by score files. Articles that have a score lower than
19516 @code{gnus-summary-mark-below} are marked as read.
19518 Gnus will read any @dfn{score files} that apply to the current group
19519 before generating the summary buffer.
19521 There are several commands in the summary buffer that insert score
19522 entries based on the current article. You can, for instance, ask Gnus to
19523 lower or increase the score of all articles with a certain subject.
19525 There are two sorts of scoring entries: Permanent and temporary.
19526 Temporary score entries are self-expiring entries. Any entries that are
19527 temporary and have not been used for, say, a week, will be removed
19528 silently to help keep the sizes of the score files down.
19531 * Summary Score Commands:: Adding score entries for the current group.
19532 * Group Score Commands:: General score commands.
19533 * Score Variables:: Customize your scoring. (My, what terminology).
19534 * Score File Format:: What a score file may contain.
19535 * Score File Editing:: You can edit score files by hand as well.
19536 * Adaptive Scoring:: Big Sister Gnus knows what you read.
19537 * Home Score File:: How to say where new score entries are to go.
19538 * Followups To Yourself:: Having Gnus notice when people answer you.
19539 * Scoring On Other Headers:: Scoring on non-standard headers.
19540 * Scoring Tips:: How to score effectively.
19541 * Reverse Scoring:: That problem child of old is not problem.
19542 * Global Score Files:: Earth-spanning, ear-splitting score files.
19543 * Kill Files:: They are still here, but they can be ignored.
19544 * Converting Kill Files:: Translating kill files to score files.
19545 * Advanced Scoring:: Using logical expressions to build score rules.
19546 * Score Decays:: It can be useful to let scores wither away.
19550 @node Summary Score Commands
19551 @section Summary Score Commands
19552 @cindex score commands
19554 The score commands that alter score entries do not actually modify real
19555 score files. That would be too inefficient. Gnus maintains a cache of
19556 previously loaded score files, one of which is considered the
19557 @dfn{current score file alist}. The score commands simply insert
19558 entries into this list, and upon group exit, this list is saved.
19560 The current score file is by default the group's local score file, even
19561 if no such score file actually exists. To insert score commands into
19562 some other score file (e.g. @file{all.SCORE}), you must first make this
19563 score file the current one.
19565 General score commands that don't actually change the score file:
19570 @kindex V s (Summary)
19571 @findex gnus-summary-set-score
19572 Set the score of the current article (@code{gnus-summary-set-score}).
19575 @kindex V S (Summary)
19576 @findex gnus-summary-current-score
19577 Display the score of the current article
19578 (@code{gnus-summary-current-score}).
19581 @kindex V t (Summary)
19582 @findex gnus-score-find-trace
19583 Display all score rules that have been used on the current article
19584 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
19585 may type @kbd{e} to edit score file corresponding to the score rule on
19586 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
19587 score file and edit it.
19590 @kindex V w (Summary)
19591 @findex gnus-score-find-favourite-words
19592 List words used in scoring (@code{gnus-score-find-favourite-words}).
19595 @kindex V R (Summary)
19596 @findex gnus-summary-rescore
19597 Run the current summary through the scoring process
19598 (@code{gnus-summary-rescore}). This might be useful if you're playing
19599 around with your score files behind Gnus' back and want to see the
19600 effect you're having.
19603 @kindex V c (Summary)
19604 @findex gnus-score-change-score-file
19605 Make a different score file the current
19606 (@code{gnus-score-change-score-file}).
19609 @kindex V e (Summary)
19610 @findex gnus-score-edit-current-scores
19611 Edit the current score file (@code{gnus-score-edit-current-scores}).
19612 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
19616 @kindex V f (Summary)
19617 @findex gnus-score-edit-file
19618 Edit a score file and make this score file the current one
19619 (@code{gnus-score-edit-file}).
19622 @kindex V F (Summary)
19623 @findex gnus-score-flush-cache
19624 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
19625 after editing score files.
19628 @kindex V C (Summary)
19629 @findex gnus-score-customize
19630 Customize a score file in a visually pleasing manner
19631 (@code{gnus-score-customize}).
19635 The rest of these commands modify the local score file.
19640 @kindex V m (Summary)
19641 @findex gnus-score-set-mark-below
19642 Prompt for a score, and mark all articles with a score below this as
19643 read (@code{gnus-score-set-mark-below}).
19646 @kindex V x (Summary)
19647 @findex gnus-score-set-expunge-below
19648 Prompt for a score, and add a score rule to the current score file to
19649 expunge all articles below this score
19650 (@code{gnus-score-set-expunge-below}).
19653 The keystrokes for actually making score entries follow a very regular
19654 pattern, so there's no need to list all the commands. (Hundreds of
19657 @findex gnus-summary-increase-score
19658 @findex gnus-summary-lower-score
19662 The first key is either @kbd{I} (upper case i) for increasing the score
19663 or @kbd{L} for lowering the score.
19665 The second key says what header you want to score on. The following
19666 keys are available:
19670 Score on the author name.
19673 Score on the subject line.
19676 Score on the @code{Xref} line---i.e., the cross-posting line.
19679 Score on the @code{References} line.
19685 Score on the number of lines.
19688 Score on the @code{Message-ID} header.
19691 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
19692 if your @acronym{NNTP} server tracks additional header data in overviews.
19695 Score on followups---this matches the author name, and adds scores to
19696 the followups to this author. (Using this key leads to the creation of
19697 @file{ADAPT} files.)
19706 Score on thread. (Using this key leads to the creation of @file{ADAPT}
19712 The third key is the match type. Which match types are valid depends on
19713 what headers you are scoring on.
19725 Substring matching.
19728 Fuzzy matching (@pxref{Fuzzy Matching}).
19757 Greater than number.
19762 The fourth and usually final key says whether this is a temporary (i.e.,
19763 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
19764 or whether it is to be done immediately, without adding to the score
19769 Temporary score entry.
19772 Permanent score entry.
19775 Immediately scoring.
19779 If you are scoring on `e' (extra) headers, you will then be prompted for
19780 the header name on which you wish to score. This must be a header named
19781 in gnus-extra-headers, and @samp{TAB} completion is available.
19785 So, let's say you want to increase the score on the current author with
19786 exact matching permanently: @kbd{I a e p}. If you want to lower the
19787 score based on the subject line, using substring matching, and make a
19788 temporary score entry: @kbd{L s s t}. Pretty easy.
19790 To make things a bit more complicated, there are shortcuts. If you use
19791 a capital letter on either the second or third keys, Gnus will use
19792 defaults for the remaining one or two keystrokes. The defaults are
19793 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
19794 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
19796 These functions take both the numerical prefix and the symbolic prefix
19797 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
19798 (or increase) the score of the article. A symbolic prefix of @code{a}
19799 says to use the @file{all.SCORE} file for the command instead of the
19800 current score file.
19802 @vindex gnus-score-mimic-keymap
19803 The @code{gnus-score-mimic-keymap} says whether these commands will
19804 pretend they are keymaps or not.
19807 @node Group Score Commands
19808 @section Group Score Commands
19809 @cindex group score commands
19811 There aren't many of these as yet, I'm afraid.
19816 @kindex W e (Group)
19817 @findex gnus-score-edit-all-score
19818 Edit the apply-to-all-groups all.SCORE file. You will be popped into
19819 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
19822 @kindex W f (Group)
19823 @findex gnus-score-flush-cache
19824 Gnus maintains a cache of score alists to avoid having to reload them
19825 all the time. This command will flush the cache
19826 (@code{gnus-score-flush-cache}).
19830 You can do scoring from the command line by saying something like:
19832 @findex gnus-batch-score
19833 @cindex batch scoring
19835 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
19839 @node Score Variables
19840 @section Score Variables
19841 @cindex score variables
19845 @item gnus-use-scoring
19846 @vindex gnus-use-scoring
19847 If @code{nil}, Gnus will not check for score files, and will not, in
19848 general, do any score-related work. This is @code{t} by default.
19850 @item gnus-kill-killed
19851 @vindex gnus-kill-killed
19852 If this variable is @code{nil}, Gnus will never apply score files to
19853 articles that have already been through the kill process. While this
19854 may save you lots of time, it also means that if you apply a kill file
19855 to a group, and then change the kill file and want to run it over you
19856 group again to kill more articles, it won't work. You have to set this
19857 variable to @code{t} to do that. (It is @code{t} by default.)
19859 @item gnus-kill-files-directory
19860 @vindex gnus-kill-files-directory
19861 All kill and score files will be stored in this directory, which is
19862 initialized from the @env{SAVEDIR} environment variable by default.
19863 This is @file{~/News/} by default.
19865 @item gnus-score-file-suffix
19866 @vindex gnus-score-file-suffix
19867 Suffix to add to the group name to arrive at the score file name
19868 (@file{SCORE} by default.)
19870 @item gnus-score-uncacheable-files
19871 @vindex gnus-score-uncacheable-files
19872 @cindex score cache
19873 All score files are normally cached to avoid excessive re-loading of
19874 score files. However, if this might make your Emacs grow big and
19875 bloated, so this regexp can be used to weed out score files unlikely
19876 to be needed again. It would be a bad idea to deny caching of
19877 @file{all.SCORE}, while it might be a good idea to not cache
19878 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
19879 variable is @samp{ADAPT$} by default, so no adaptive score files will
19882 @item gnus-save-score
19883 @vindex gnus-save-score
19884 If you have really complicated score files, and do lots of batch
19885 scoring, then you might set this variable to @code{t}. This will make
19886 Gnus save the scores into the @file{.newsrc.eld} file.
19888 If you do not set this to @code{t}, then manual scores (like those set
19889 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
19890 across group visits.
19892 @item gnus-score-interactive-default-score
19893 @vindex gnus-score-interactive-default-score
19894 Score used by all the interactive raise/lower commands to raise/lower
19895 score with. Default is 1000, which may seem excessive, but this is to
19896 ensure that the adaptive scoring scheme gets enough room to play with.
19897 We don't want the small changes from the adaptive scoring to overwrite
19898 manually entered data.
19900 @item gnus-summary-default-score
19901 @vindex gnus-summary-default-score
19902 Default score of an article, which is 0 by default.
19904 @item gnus-summary-expunge-below
19905 @vindex gnus-summary-expunge-below
19906 Don't display the summary lines of articles that have scores lower than
19907 this variable. This is @code{nil} by default, which means that no
19908 articles will be hidden. This variable is local to the summary buffers,
19909 and has to be set from @code{gnus-summary-mode-hook}.
19911 @item gnus-score-over-mark
19912 @vindex gnus-score-over-mark
19913 Mark (in the third column) used for articles with a score over the
19914 default. Default is @samp{+}.
19916 @item gnus-score-below-mark
19917 @vindex gnus-score-below-mark
19918 Mark (in the third column) used for articles with a score below the
19919 default. Default is @samp{-}.
19921 @item gnus-score-find-score-files-function
19922 @vindex gnus-score-find-score-files-function
19923 Function used to find score files for the current group. This function
19924 is called with the name of the group as the argument.
19926 Predefined functions available are:
19929 @item gnus-score-find-single
19930 @findex gnus-score-find-single
19931 Only apply the group's own score file.
19933 @item gnus-score-find-bnews
19934 @findex gnus-score-find-bnews
19935 Apply all score files that match, using bnews syntax. This is the
19936 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
19937 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
19938 @file{gnu.all.SCORE} would all apply. In short, the instances of
19939 @samp{all} in the score file names are translated into @samp{.*}, and
19940 then a regexp match is done.
19942 This means that if you have some score entries that you want to apply to
19943 all groups, then you put those entries in the @file{all.SCORE} file.
19945 The score files are applied in a semi-random order, although Gnus will
19946 try to apply the more general score files before the more specific score
19947 files. It does this by looking at the number of elements in the score
19948 file names---discarding the @samp{all} elements.
19950 @item gnus-score-find-hierarchical
19951 @findex gnus-score-find-hierarchical
19952 Apply all score files from all the parent groups. This means that you
19953 can't have score files like @file{all.SCORE}, but you can have
19954 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19958 This variable can also be a list of functions. In that case, all
19959 these functions will be called with the group name as argument, and
19960 all the returned lists of score files will be applied. These
19961 functions can also return lists of lists of score alists directly. In
19962 that case, the functions that return these non-file score alists
19963 should probably be placed before the ``real'' score file functions, to
19964 ensure that the last score file returned is the local score file.
19967 For example, to do hierarchical scoring but use a non-server-specific
19968 overall score file, you could use the value
19970 (list (lambda (group) ("all.SCORE"))
19971 'gnus-score-find-hierarchical)
19974 @item gnus-score-expiry-days
19975 @vindex gnus-score-expiry-days
19976 This variable says how many days should pass before an unused score file
19977 entry is expired. If this variable is @code{nil}, no score file entries
19978 are expired. It's 7 by default.
19980 @item gnus-update-score-entry-dates
19981 @vindex gnus-update-score-entry-dates
19982 If this variable is non-@code{nil}, temporary score entries that have
19983 been triggered (matched) will have their dates updated. (This is how Gnus
19984 controls expiry---all non-matched-entries will become too old while
19985 matched entries will stay fresh and young.) However, if you set this
19986 variable to @code{nil}, even matched entries will grow old and will
19987 have to face that oh-so grim reaper.
19989 @item gnus-score-after-write-file-function
19990 @vindex gnus-score-after-write-file-function
19991 Function called with the name of the score file just written.
19993 @item gnus-score-thread-simplify
19994 @vindex gnus-score-thread-simplify
19995 If this variable is non-@code{nil}, article subjects will be
19996 simplified for subject scoring purposes in the same manner as with
19997 threading---according to the current value of
19998 @code{gnus-simplify-subject-functions}. If the scoring entry uses
19999 @code{substring} or @code{exact} matching, the match will also be
20000 simplified in this manner.
20005 @node Score File Format
20006 @section Score File Format
20007 @cindex score file format
20009 A score file is an @code{emacs-lisp} file that normally contains just a
20010 single form. Casual users are not expected to edit these files;
20011 everything can be changed from the summary buffer.
20013 Anyway, if you'd like to dig into it yourself, here's an example:
20017 ("Lars Ingebrigtsen" -10000)
20019 ("larsi\\|lmi" -50000 nil R))
20021 ("Ding is Badd" nil 728373))
20023 ("alt.politics" -1000 728372 s))
20028 (mark-and-expunge -10)
20032 (files "/hom/larsi/News/gnu.SCORE")
20033 (exclude-files "all.SCORE")
20034 (local (gnus-newsgroup-auto-expire t)
20035 (gnus-summary-make-false-root empty))
20039 This example demonstrates most score file elements. @xref{Advanced
20040 Scoring}, for a different approach.
20042 Even though this looks much like Lisp code, nothing here is actually
20043 @code{eval}ed. The Lisp reader is used to read this form, though, so it
20044 has to be valid syntactically, if not semantically.
20046 Six keys are supported by this alist:
20051 If the key is a string, it is the name of the header to perform the
20052 match on. Scoring can only be performed on these eight headers:
20053 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
20054 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
20055 these headers, there are three strings to tell Gnus to fetch the entire
20056 article and do the match on larger parts of the article: @code{Body}
20057 will perform the match on the body of the article, @code{Head} will
20058 perform the match on the head of the article, and @code{All} will
20059 perform the match on the entire article. Note that using any of these
20060 last three keys will slow down group entry @emph{considerably}. The
20061 final ``header'' you can score on is @code{Followup}. These score
20062 entries will result in new score entries being added for all follow-ups
20063 to articles that matches these score entries.
20065 Following this key is an arbitrary number of score entries, where each
20066 score entry has one to four elements.
20070 The first element is the @dfn{match element}. On most headers this will
20071 be a string, but on the Lines and Chars headers, this must be an
20075 If the second element is present, it should be a number---the @dfn{score
20076 element}. This number should be an integer in the neginf to posinf
20077 interval. This number is added to the score of the article if the match
20078 is successful. If this element is not present, the
20079 @code{gnus-score-interactive-default-score} number will be used
20080 instead. This is 1000 by default.
20083 If the third element is present, it should be a number---the @dfn{date
20084 element}. This date says when the last time this score entry matched,
20085 which provides a mechanism for expiring the score entries. It this
20086 element is not present, the score entry is permanent. The date is
20087 represented by the number of days since December 31, 1 BCE.
20090 If the fourth element is present, it should be a symbol---the @dfn{type
20091 element}. This element specifies what function should be used to see
20092 whether this score entry matches the article. What match types that can
20093 be used depends on what header you wish to perform the match on.
20096 @item From, Subject, References, Xref, Message-ID
20097 For most header types, there are the @code{r} and @code{R} (regexp), as
20098 well as @code{s} and @code{S} (substring) types, and @code{e} and
20099 @code{E} (exact match), and @code{w} (word match) types. If this
20100 element is not present, Gnus will assume that substring matching should
20101 be used. @code{R}, @code{S}, and @code{E} differ from the others in
20102 that the matches will be done in a case-sensitive manner. All these
20103 one-letter types are really just abbreviations for the @code{regexp},
20104 @code{string}, @code{exact}, and @code{word} types, which you can use
20105 instead, if you feel like.
20108 Just as for the standard string overview headers, if you are using
20109 gnus-extra-headers, you can score on these headers' values. In this
20110 case, there is a 5th element in the score entry, being the name of the
20111 header to be scored. The following entry is useful in your
20112 @file{all.SCORE} file in case of spam attacks from a single origin
20113 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
20117 ("111.222.333.444" -1000 nil s
20118 "NNTP-Posting-Host")
20122 These two headers use different match types: @code{<}, @code{>},
20123 @code{=}, @code{>=} and @code{<=}.
20125 These predicates are true if
20128 (PREDICATE HEADER MATCH)
20131 evaluates to non-@code{nil}. For instance, the advanced match
20132 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
20139 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
20140 the match, we get the score added if the article has less than 4 lines.
20141 (It's easy to get confused and think it's the other way around. But
20142 it's not. I think.)
20144 When matching on @code{Lines}, be careful because some back ends (like
20145 @code{nndir}) do not generate @code{Lines} header, so every article ends
20146 up being marked as having 0 lines. This can lead to strange results if
20147 you happen to lower score of the articles with few lines.
20150 For the Date header we have three kinda silly match types:
20151 @code{before}, @code{at} and @code{after}. I can't really imagine this
20152 ever being useful, but, like, it would feel kinda silly not to provide
20153 this function. Just in case. You never know. Better safe than sorry.
20154 Once burnt, twice shy. Don't judge a book by its cover. Never not have
20155 sex on a first date. (I have been told that at least one person, and I
20156 quote, ``found this function indispensable'', however.)
20160 A more useful match type is @code{regexp}. With it, you can match the
20161 date string using a regular expression. The date is normalized to
20162 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
20163 you want to match all articles that have been posted on April 1st in
20164 every year, you could use @samp{....0401.........} as a match string,
20165 for instance. (Note that the date is kept in its original time zone, so
20166 this will match articles that were posted when it was April 1st where
20167 the article was posted from. Time zones are such wholesome fun for the
20170 @item Head, Body, All
20171 These three match keys use the same match types as the @code{From} (etc)
20175 This match key is somewhat special, in that it will match the
20176 @code{From} header, and affect the score of not only the matching
20177 articles, but also all followups to the matching articles. This allows
20178 you e.g. increase the score of followups to your own articles, or
20179 decrease the score of followups to the articles of some known
20180 trouble-maker. Uses the same match types as the @code{From} header
20181 uses. (Using this match key will lead to creation of @file{ADAPT}
20185 This match key works along the same lines as the @code{Followup} match
20186 key. If you say that you want to score on a (sub-)thread started by an
20187 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
20188 match. This will add a new @samp{thread} match for each article that
20189 has @var{x} in its @code{References} header. (These new @samp{thread}
20190 matches will use the @code{Message-ID}s of these matching articles.)
20191 This will ensure that you can raise/lower the score of an entire thread,
20192 even though some articles in the thread may not have complete
20193 @code{References} headers. Note that using this may lead to
20194 undeterministic scores of the articles in the thread. (Using this match
20195 key will lead to creation of @file{ADAPT} files.)
20199 @cindex score file atoms
20201 The value of this entry should be a number. Any articles with a score
20202 lower than this number will be marked as read.
20205 The value of this entry should be a number. Any articles with a score
20206 lower than this number will be removed from the summary buffer.
20208 @item mark-and-expunge
20209 The value of this entry should be a number. Any articles with a score
20210 lower than this number will be marked as read and removed from the
20213 @item thread-mark-and-expunge
20214 The value of this entry should be a number. All articles that belong to
20215 a thread that has a total score below this number will be marked as read
20216 and removed from the summary buffer. @code{gnus-thread-score-function}
20217 says how to compute the total score for a thread.
20220 The value of this entry should be any number of file names. These files
20221 are assumed to be score files as well, and will be loaded the same way
20224 @item exclude-files
20225 The clue of this entry should be any number of files. These files will
20226 not be loaded, even though they would normally be so, for some reason or
20230 The value of this entry will be @code{eval}el. This element will be
20231 ignored when handling global score files.
20234 Read-only score files will not be updated or saved. Global score files
20235 should feature this atom (@pxref{Global Score Files}). (Note:
20236 @dfn{Global} here really means @dfn{global}; not your personal
20237 apply-to-all-groups score files.)
20240 The value of this entry should be a number. Articles that do not have
20241 parents will get this number added to their scores. Imagine you follow
20242 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
20243 will only follow a few of the threads, also want to see any new threads.
20245 You can do this with the following two score file entries:
20249 (mark-and-expunge -100)
20252 When you enter the group the first time, you will only see the new
20253 threads. You then raise the score of the threads that you find
20254 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
20255 rest. Next time you enter the group, you will see new articles in the
20256 interesting threads, plus any new threads.
20258 I.e.---the orphan score atom is for high-volume groups where a few
20259 interesting threads which can't be found automatically by ordinary
20260 scoring rules exist.
20263 This entry controls the adaptive scoring. If it is @code{t}, the
20264 default adaptive scoring rules will be used. If it is @code{ignore}, no
20265 adaptive scoring will be performed on this group. If it is a list, this
20266 list will be used as the adaptive scoring rules. If it isn't present,
20267 or is something other than @code{t} or @code{ignore}, the default
20268 adaptive scoring rules will be used. If you want to use adaptive
20269 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
20270 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
20271 not want adaptive scoring. If you only want adaptive scoring in a few
20272 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
20273 insert @code{(adapt t)} in the score files of the groups where you want
20277 All adaptive score entries will go to the file named by this entry. It
20278 will also be applied when entering the group. This atom might be handy
20279 if you want to adapt on several groups at once, using the same adaptive
20280 file for a number of groups.
20283 @cindex local variables
20284 The value of this entry should be a list of @code{(@var{var}
20285 @var{value})} pairs. Each @var{var} will be made buffer-local to the
20286 current summary buffer, and set to the value specified. This is a
20287 convenient, if somewhat strange, way of setting variables in some
20288 groups if you don't like hooks much. Note that the @var{value} won't
20293 @node Score File Editing
20294 @section Score File Editing
20296 You normally enter all scoring commands from the summary buffer, but you
20297 might feel the urge to edit them by hand as well, so we've supplied you
20298 with a mode for that.
20300 It's simply a slightly customized @code{emacs-lisp} mode, with these
20301 additional commands:
20306 @kindex C-c C-c (Score)
20307 @findex gnus-score-edit-done
20308 Save the changes you have made and return to the summary buffer
20309 (@code{gnus-score-edit-done}).
20312 @kindex C-c C-d (Score)
20313 @findex gnus-score-edit-insert-date
20314 Insert the current date in numerical format
20315 (@code{gnus-score-edit-insert-date}). This is really the day number, if
20316 you were wondering.
20319 @kindex C-c C-p (Score)
20320 @findex gnus-score-pretty-print
20321 The adaptive score files are saved in an unformatted fashion. If you
20322 intend to read one of these files, you want to @dfn{pretty print} it
20323 first. This command (@code{gnus-score-pretty-print}) does that for
20328 Type @kbd{M-x gnus-score-mode} to use this mode.
20330 @vindex gnus-score-mode-hook
20331 @code{gnus-score-menu-hook} is run in score mode buffers.
20333 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
20334 @kbd{V t} to begin editing score files.
20337 @node Adaptive Scoring
20338 @section Adaptive Scoring
20339 @cindex adaptive scoring
20341 If all this scoring is getting you down, Gnus has a way of making it all
20342 happen automatically---as if by magic. Or rather, as if by artificial
20343 stupidity, to be precise.
20345 @vindex gnus-use-adaptive-scoring
20346 When you read an article, or mark an article as read, or kill an
20347 article, you leave marks behind. On exit from the group, Gnus can sniff
20348 these marks and add score elements depending on what marks it finds.
20349 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
20350 @code{t} or @code{(line)}. If you want score adaptively on separate
20351 words appearing in the subjects, you should set this variable to
20352 @code{(word)}. If you want to use both adaptive methods, set this
20353 variable to @code{(word line)}.
20355 @vindex gnus-default-adaptive-score-alist
20356 To give you complete control over the scoring process, you can customize
20357 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
20358 might look something like this:
20361 (setq gnus-default-adaptive-score-alist
20362 '((gnus-unread-mark)
20363 (gnus-ticked-mark (from 4))
20364 (gnus-dormant-mark (from 5))
20365 (gnus-del-mark (from -4) (subject -1))
20366 (gnus-read-mark (from 4) (subject 2))
20367 (gnus-expirable-mark (from -1) (subject -1))
20368 (gnus-killed-mark (from -1) (subject -3))
20369 (gnus-kill-file-mark)
20370 (gnus-ancient-mark)
20371 (gnus-low-score-mark)
20372 (gnus-catchup-mark (from -1) (subject -1))))
20375 As you see, each element in this alist has a mark as a key (either a
20376 variable name or a ``real'' mark---a character). Following this key is
20377 a arbitrary number of header/score pairs. If there are no header/score
20378 pairs following the key, no adaptive scoring will be done on articles
20379 that have that key as the article mark. For instance, articles with
20380 @code{gnus-unread-mark} in the example above will not get adaptive score
20383 Each article can have only one mark, so just a single of these rules
20384 will be applied to each article.
20386 To take @code{gnus-del-mark} as an example---this alist says that all
20387 articles that have that mark (i.e., are marked with @samp{e}) will have a
20388 score entry added to lower based on the @code{From} header by -4, and
20389 lowered by @code{Subject} by -1. Change this to fit your prejudices.
20391 If you have marked 10 articles with the same subject with
20392 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
20393 That means that that subject will get a score of ten times -1, which
20394 should be, unless I'm much mistaken, -10.
20396 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
20397 the read articles will be marked with the @samp{E} mark. This'll
20398 probably make adaptive scoring slightly impossible, so auto-expiring and
20399 adaptive scoring doesn't really mix very well.
20401 The headers you can score on are @code{from}, @code{subject},
20402 @code{message-id}, @code{references}, @code{xref}, @code{lines},
20403 @code{chars} and @code{date}. In addition, you can score on
20404 @code{followup}, which will create an adaptive score entry that matches
20405 on the @code{References} header using the @code{Message-ID} of the
20406 current article, thereby matching the following thread.
20408 If you use this scheme, you should set the score file atom @code{mark}
20409 to something small---like -300, perhaps, to avoid having small random
20410 changes result in articles getting marked as read.
20412 After using adaptive scoring for a week or so, Gnus should start to
20413 become properly trained and enhance the authors you like best, and kill
20414 the authors you like least, without you having to say so explicitly.
20416 You can control what groups the adaptive scoring is to be performed on
20417 by using the score files (@pxref{Score File Format}). This will also
20418 let you use different rules in different groups.
20420 @vindex gnus-adaptive-file-suffix
20421 The adaptive score entries will be put into a file where the name is the
20422 group name with @code{gnus-adaptive-file-suffix} appended. The default
20425 @vindex gnus-adaptive-pretty-print
20426 Adaptive score files can get huge and are not meant to be edited by
20427 human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the
20428 deafult) those files will not be written in a human readable way.
20430 @vindex gnus-score-exact-adapt-limit
20431 When doing adaptive scoring, substring or fuzzy matching would probably
20432 give you the best results in most cases. However, if the header one
20433 matches is short, the possibility for false positives is great, so if
20434 the length of the match is less than
20435 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
20436 this variable is @code{nil}, exact matching will always be used to avoid
20439 @vindex gnus-default-adaptive-word-score-alist
20440 As mentioned above, you can adapt either on individual words or entire
20441 headers. If you adapt on words, the
20442 @code{gnus-default-adaptive-word-score-alist} variable says what score
20443 each instance of a word should add given a mark.
20446 (setq gnus-default-adaptive-word-score-alist
20447 `((,gnus-read-mark . 30)
20448 (,gnus-catchup-mark . -10)
20449 (,gnus-killed-mark . -20)
20450 (,gnus-del-mark . -15)))
20453 This is the default value. If you have adaption on words enabled, every
20454 word that appears in subjects of articles marked with
20455 @code{gnus-read-mark} will result in a score rule that increase the
20456 score with 30 points.
20458 @vindex gnus-default-ignored-adaptive-words
20459 @vindex gnus-ignored-adaptive-words
20460 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
20461 will be ignored. If you wish to add more words to be ignored, use the
20462 @code{gnus-ignored-adaptive-words} list instead.
20464 @vindex gnus-adaptive-word-length-limit
20465 Some may feel that short words shouldn't count when doing adaptive
20466 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
20467 an integer. Words shorter than this number will be ignored. This
20468 variable defaults to @code{nil}.
20470 @vindex gnus-adaptive-word-syntax-table
20471 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
20472 syntax table in effect. It is similar to the standard syntax table, but
20473 it considers numbers to be non-word-constituent characters.
20475 @vindex gnus-adaptive-word-minimum
20476 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
20477 word scoring process will never bring down the score of an article to
20478 below this number. The default is @code{nil}.
20480 @vindex gnus-adaptive-word-no-group-words
20481 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
20482 won't adaptively word score any of the words in the group name. Useful
20483 for groups like @samp{comp.editors.emacs}, where most of the subject
20484 lines contain the word @samp{emacs}.
20486 After using this scheme for a while, it might be nice to write a
20487 @code{gnus-psychoanalyze-user} command to go through the rules and see
20488 what words you like and what words you don't like. Or perhaps not.
20490 Note that the adaptive word scoring thing is highly experimental and is
20491 likely to change in the future. Initial impressions seem to indicate
20492 that it's totally useless as it stands. Some more work (involving more
20493 rigorous statistical methods) will have to be done to make this useful.
20496 @node Home Score File
20497 @section Home Score File
20499 The score file where new score file entries will go is called the
20500 @dfn{home score file}. This is normally (and by default) the score file
20501 for the group itself. For instance, the home score file for
20502 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
20504 However, this may not be what you want. It is often convenient to share
20505 a common home score file among many groups---all @samp{emacs} groups
20506 could perhaps use the same home score file.
20508 @vindex gnus-home-score-file
20509 The variable that controls this is @code{gnus-home-score-file}. It can
20514 A string. Then this file will be used as the home score file for all
20518 A function. The result of this function will be used as the home score
20519 file. The function will be called with the name of the group as the
20523 A list. The elements in this list can be:
20527 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
20528 group name, the @var{file-name} will be used as the home score file.
20531 A function. If the function returns non-@code{nil}, the result will
20532 be used as the home score file. The function will be called with the
20533 name of the group as the parameter.
20536 A string. Use the string as the home score file.
20539 The list will be traversed from the beginning towards the end looking
20544 So, if you want to use just a single score file, you could say:
20547 (setq gnus-home-score-file
20548 "my-total-score-file.SCORE")
20551 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
20552 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
20554 @findex gnus-hierarchial-home-score-file
20556 (setq gnus-home-score-file
20557 'gnus-hierarchial-home-score-file)
20560 This is a ready-made function provided for your convenience.
20561 Other functions include
20564 @item gnus-current-home-score-file
20565 @findex gnus-current-home-score-file
20566 Return the ``current'' regular score file. This will make scoring
20567 commands add entry to the ``innermost'' matching score file.
20571 If you want to have one score file for the @samp{emacs} groups and
20572 another for the @samp{comp} groups, while letting all other groups use
20573 their own home score files:
20576 (setq gnus-home-score-file
20577 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
20578 '(("\\.emacs" "emacs.SCORE")
20579 ;; @r{All the comp groups in one score file}
20580 ("^comp" "comp.SCORE")))
20583 @vindex gnus-home-adapt-file
20584 @code{gnus-home-adapt-file} works exactly the same way as
20585 @code{gnus-home-score-file}, but says what the home adaptive score file
20586 is instead. All new adaptive file entries will go into the file
20587 specified by this variable, and the same syntax is allowed.
20589 In addition to using @code{gnus-home-score-file} and
20590 @code{gnus-home-adapt-file}, you can also use group parameters
20591 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
20592 Parameters}) to achieve much the same. Group and topic parameters take
20593 precedence over this variable.
20596 @node Followups To Yourself
20597 @section Followups To Yourself
20599 Gnus offers two commands for picking out the @code{Message-ID} header in
20600 the current buffer. Gnus will then add a score rule that scores using
20601 this @code{Message-ID} on the @code{References} header of other
20602 articles. This will, in effect, increase the score of all articles that
20603 respond to the article in the current buffer. Quite useful if you want
20604 to easily note when people answer what you've said.
20608 @item gnus-score-followup-article
20609 @findex gnus-score-followup-article
20610 This will add a score to articles that directly follow up your own
20613 @item gnus-score-followup-thread
20614 @findex gnus-score-followup-thread
20615 This will add a score to all articles that appear in a thread ``below''
20619 @vindex message-sent-hook
20620 These two functions are both primarily meant to be used in hooks like
20621 @code{message-sent-hook}, like this:
20623 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
20627 If you look closely at your own @code{Message-ID}, you'll notice that
20628 the first two or three characters are always the same. Here's two of
20632 <x6u3u47icf.fsf@@eyesore.no>
20633 <x6sp9o7ibw.fsf@@eyesore.no>
20636 So ``my'' ident on this machine is @samp{x6}. This can be
20637 exploited---the following rule will raise the score on all followups to
20642 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
20646 Whether it's the first two or first three characters that are ``yours''
20647 is system-dependent.
20650 @node Scoring On Other Headers
20651 @section Scoring On Other Headers
20652 @cindex scoring on other headers
20654 Gnus is quite fast when scoring the ``traditional''
20655 headers---@samp{From}, @samp{Subject} and so on. However, scoring
20656 other headers requires writing a @code{head} scoring rule, which means
20657 that Gnus has to request every single article from the back end to find
20658 matches. This takes a long time in big groups.
20660 Now, there's not much you can do about this for news groups, but for
20661 mail groups, you have greater control. In @ref{To From Newsgroups},
20662 it's explained in greater detail what this mechanism does, but here's
20663 a cookbook example for @code{nnml} on how to allow scoring on the
20664 @samp{To} and @samp{Cc} headers.
20666 Put the following in your @file{~/.gnus.el} file.
20669 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
20670 nnmail-extra-headers gnus-extra-headers)
20673 Restart Gnus and rebuild your @code{nnml} overview files with the
20674 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
20675 time if you have much mail.
20677 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
20678 so: @kbd{I e s p To RET <your name> RET}.
20684 @section Scoring Tips
20685 @cindex scoring tips
20691 @cindex scoring crossposts
20692 If you want to lower the score of crossposts, the line to match on is
20693 the @code{Xref} header.
20695 ("xref" (" talk.politics.misc:" -1000))
20698 @item Multiple crossposts
20699 If you want to lower the score of articles that have been crossposted to
20700 more than, say, 3 groups:
20703 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
20707 @item Matching on the body
20708 This is generally not a very good idea---it takes a very long time.
20709 Gnus actually has to fetch each individual article from the server. But
20710 you might want to anyway, I guess. Even though there are three match
20711 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
20712 and stick with it in each score file. If you use any two, each article
20713 will be fetched @emph{twice}. If you want to match a bit on the
20714 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
20717 @item Marking as read
20718 You will probably want to mark articles that have scores below a certain
20719 number as read. This is most easily achieved by putting the following
20720 in your @file{all.SCORE} file:
20724 You may also consider doing something similar with @code{expunge}.
20726 @item Negated character classes
20727 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
20728 That will match newlines, which might lead to, well, The Unknown. Say
20729 @code{[^abcd\n]*} instead.
20733 @node Reverse Scoring
20734 @section Reverse Scoring
20735 @cindex reverse scoring
20737 If you want to keep just articles that have @samp{Sex with Emacs} in the
20738 subject header, and expunge all other articles, you could put something
20739 like this in your score file:
20743 ("Sex with Emacs" 2))
20748 So, you raise all articles that match @samp{Sex with Emacs} and mark the
20749 rest as read, and expunge them to boot.
20752 @node Global Score Files
20753 @section Global Score Files
20754 @cindex global score files
20756 Sure, other newsreaders have ``global kill files''. These are usually
20757 nothing more than a single kill file that applies to all groups, stored
20758 in the user's home directory. Bah! Puny, weak newsreaders!
20760 What I'm talking about here are Global Score Files. Score files from
20761 all over the world, from users everywhere, uniting all nations in one
20762 big, happy score file union! Ange-score! New and untested!
20764 @vindex gnus-global-score-files
20765 All you have to do to use other people's score files is to set the
20766 @code{gnus-global-score-files} variable. One entry for each score file,
20767 or each score file directory. Gnus will decide by itself what score
20768 files are applicable to which group.
20770 To use the score file
20771 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
20772 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
20776 (setq gnus-global-score-files
20777 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
20778 "/ftp@@ftp.some-where:/pub/score/"))
20781 @findex gnus-score-search-global-directories
20783 Simple, eh? Directory names must end with a @samp{/}. These
20784 directories are typically scanned only once during each Gnus session.
20785 If you feel the need to manually re-scan the remote directories, you can
20786 use the @code{gnus-score-search-global-directories} command.
20788 Note that, at present, using this option will slow down group entry
20789 somewhat. (That is---a lot.)
20791 If you want to start maintaining score files for other people to use,
20792 just put your score file up for anonymous ftp and announce it to the
20793 world. Become a retro-moderator! Participate in the retro-moderator
20794 wars sure to ensue, where retro-moderators battle it out for the
20795 sympathy of the people, luring them to use their score files on false
20796 premises! Yay! The net is saved!
20798 Here are some tips for the would-be retro-moderator, off the top of my
20804 Articles heavily crossposted are probably junk.
20806 To lower a single inappropriate article, lower by @code{Message-ID}.
20808 Particularly brilliant authors can be raised on a permanent basis.
20810 Authors that repeatedly post off-charter for the group can safely be
20811 lowered out of existence.
20813 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
20814 articles completely.
20817 Use expiring score entries to keep the size of the file down. You
20818 should probably have a long expiry period, though, as some sites keep
20819 old articles for a long time.
20822 @dots{} I wonder whether other newsreaders will support global score files
20823 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
20824 Wave, xrn and 1stReader are bound to implement scoring. Should we start
20825 holding our breath yet?
20829 @section Kill Files
20832 Gnus still supports those pesky old kill files. In fact, the kill file
20833 entries can now be expiring, which is something I wrote before Daniel
20834 Quinlan thought of doing score files, so I've left the code in there.
20836 In short, kill processing is a lot slower (and I do mean @emph{a lot})
20837 than score processing, so it might be a good idea to rewrite your kill
20838 files into score files.
20840 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
20841 forms into this file, which means that you can use kill files as some
20842 sort of primitive hook function to be run on group entry, even though
20843 that isn't a very good idea.
20845 Normal kill files look like this:
20848 (gnus-kill "From" "Lars Ingebrigtsen")
20849 (gnus-kill "Subject" "ding")
20853 This will mark every article written by me as read, and remove the
20854 marked articles from the summary buffer. Very useful, you'll agree.
20856 Other programs use a totally different kill file syntax. If Gnus
20857 encounters what looks like a @code{rn} kill file, it will take a stab at
20860 Two summary functions for editing a @sc{gnus} kill file:
20865 @kindex M-k (Summary)
20866 @findex gnus-summary-edit-local-kill
20867 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
20870 @kindex M-K (Summary)
20871 @findex gnus-summary-edit-global-kill
20872 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
20875 Two group mode functions for editing the kill files:
20880 @kindex M-k (Group)
20881 @findex gnus-group-edit-local-kill
20882 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
20885 @kindex M-K (Group)
20886 @findex gnus-group-edit-global-kill
20887 Edit the general kill file (@code{gnus-group-edit-global-kill}).
20890 Kill file variables:
20893 @item gnus-kill-file-name
20894 @vindex gnus-kill-file-name
20895 A kill file for the group @samp{soc.motss} is normally called
20896 @file{soc.motss.KILL}. The suffix appended to the group name to get
20897 this file name is detailed by the @code{gnus-kill-file-name} variable.
20898 The ``global'' kill file (not in the score file sense of ``global'', of
20899 course) is just called @file{KILL}.
20901 @vindex gnus-kill-save-kill-file
20902 @item gnus-kill-save-kill-file
20903 If this variable is non-@code{nil}, Gnus will save the
20904 kill file after processing, which is necessary if you use expiring
20907 @item gnus-apply-kill-hook
20908 @vindex gnus-apply-kill-hook
20909 @findex gnus-apply-kill-file-unless-scored
20910 @findex gnus-apply-kill-file
20911 A hook called to apply kill files to a group. It is
20912 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
20913 kill file if you have a score file for the same group, you can set this
20914 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
20915 kill files to be processed, you should set this variable to @code{nil}.
20917 @item gnus-kill-file-mode-hook
20918 @vindex gnus-kill-file-mode-hook
20919 A hook called in kill-file mode buffers.
20924 @node Converting Kill Files
20925 @section Converting Kill Files
20927 @cindex converting kill files
20929 If you have loads of old kill files, you may want to convert them into
20930 score files. If they are ``regular'', you can use
20931 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
20934 The kill to score conversion package isn't included in Gnus by default.
20935 You can fetch it from
20936 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
20938 If your old kill files are very complex---if they contain more
20939 non-@code{gnus-kill} forms than not, you'll have to convert them by
20940 hand. Or just let them be as they are. Gnus will still use them as
20944 @node Advanced Scoring
20945 @section Advanced Scoring
20947 Scoring on Subjects and From headers is nice enough, but what if you're
20948 really interested in what a person has to say only when she's talking
20949 about a particular subject? Or what if you really don't want to
20950 read what person A has to say when she's following up to person B, but
20951 want to read what she says when she's following up to person C?
20953 By using advanced scoring rules you may create arbitrarily complex
20957 * Advanced Scoring Syntax:: A definition.
20958 * Advanced Scoring Examples:: What they look like.
20959 * Advanced Scoring Tips:: Getting the most out of it.
20963 @node Advanced Scoring Syntax
20964 @subsection Advanced Scoring Syntax
20966 Ordinary scoring rules have a string as the first element in the rule.
20967 Advanced scoring rules have a list as the first element. The second
20968 element is the score to be applied if the first element evaluated to a
20969 non-@code{nil} value.
20971 These lists may consist of three logical operators, one redirection
20972 operator, and various match operators.
20979 This logical operator will evaluate each of its arguments until it finds
20980 one that evaluates to @code{false}, and then it'll stop. If all arguments
20981 evaluate to @code{true} values, then this operator will return
20986 This logical operator will evaluate each of its arguments until it finds
20987 one that evaluates to @code{true}. If no arguments are @code{true},
20988 then this operator will return @code{false}.
20993 This logical operator only takes a single argument. It returns the
20994 logical negation of the value of its argument.
20998 There is an @dfn{indirection operator} that will make its arguments
20999 apply to the ancestors of the current article being scored. For
21000 instance, @code{1-} will make score rules apply to the parent of the
21001 current article. @code{2-} will make score rules apply to the
21002 grandparent of the current article. Alternatively, you can write
21003 @code{^^}, where the number of @code{^}s (carets) says how far back into
21004 the ancestry you want to go.
21006 Finally, we have the match operators. These are the ones that do the
21007 real work. Match operators are header name strings followed by a match
21008 and a match type. A typical match operator looks like @samp{("from"
21009 "Lars Ingebrigtsen" s)}. The header names are the same as when using
21010 simple scoring, and the match types are also the same.
21013 @node Advanced Scoring Examples
21014 @subsection Advanced Scoring Examples
21016 Please note that the following examples are score file rules. To
21017 make a complete score file from them, surround them with another pair
21020 Let's say you want to increase the score of articles written by Lars
21021 when he's talking about Gnus:
21026 ("from" "Lars Ingebrigtsen")
21027 ("subject" "Gnus"))
21034 When he writes long articles, he sometimes has something nice to say:
21038 ("from" "Lars Ingebrigtsen")
21045 However, when he responds to things written by Reig Eigil Logge, you
21046 really don't want to read what he's written:
21050 ("from" "Lars Ingebrigtsen")
21051 (1- ("from" "Reig Eigir Logge")))
21055 Everybody that follows up Redmondo when he writes about disappearing
21056 socks should have their scores raised, but only when they talk about
21057 white socks. However, when Lars talks about socks, it's usually not
21064 ("from" "redmondo@@.*no" r)
21065 ("body" "disappearing.*socks" t)))
21066 (! ("from" "Lars Ingebrigtsen"))
21067 ("body" "white.*socks"))
21071 Suppose you're reading a high volume group and you're only interested
21072 in replies. The plan is to score down all articles that don't have
21073 subject that begin with "Re:", "Fw:" or "Fwd:" and then score up all
21074 parents of articles that have subjects that begin with reply marks.
21077 ((! ("subject" "re:\\|fwd?:" r))
21079 ((1- ("subject" "re:\\|fwd?:" r))
21083 The possibilities are endless.
21085 @node Advanced Scoring Tips
21086 @subsection Advanced Scoring Tips
21088 The @code{&} and @code{|} logical operators do short-circuit logic.
21089 That is, they stop processing their arguments when it's clear what the
21090 result of the operation will be. For instance, if one of the arguments
21091 of an @code{&} evaluates to @code{false}, there's no point in evaluating
21092 the rest of the arguments. This means that you should put slow matches
21093 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
21094 @samp{subject}) first.
21096 The indirection arguments (@code{1-} and so on) will make their
21097 arguments work on previous generations of the thread. If you say
21108 Then that means ``score on the from header of the grandparent of the
21109 current article''. An indirection is quite fast, but it's better to say:
21115 ("subject" "Gnus")))
21122 (1- ("from" "Lars"))
21123 (1- ("subject" "Gnus")))
21128 @section Score Decays
21129 @cindex score decays
21132 You may find that your scores have a tendency to grow without
21133 bounds, especially if you're using adaptive scoring. If scores get too
21134 big, they lose all meaning---they simply max out and it's difficult to
21135 use them in any sensible way.
21137 @vindex gnus-decay-scores
21138 @findex gnus-decay-score
21139 @vindex gnus-decay-score-function
21140 Gnus provides a mechanism for decaying scores to help with this problem.
21141 When score files are loaded and @code{gnus-decay-scores} is
21142 non-@code{nil}, Gnus will run the score files through the decaying
21143 mechanism thereby lowering the scores of all non-permanent score rules.
21144 If @code{gnus-decay-scores} is a regexp, only score files matching this
21145 regexp are treated. E.g. you may set it to @samp{\\.ADAPT\\'} if only
21146 @emph{adaptive} score files should be decayed. The decay itself if
21147 performed by the @code{gnus-decay-score-function} function, which is
21148 @code{gnus-decay-score} by default. Here's the definition of that
21152 (defun gnus-decay-score (score)
21153 "Decay SCORE according to `gnus-score-decay-constant'
21154 and `gnus-score-decay-scale'."
21156 (* (if (< score 0) -1 1)
21158 (max gnus-score-decay-constant
21160 gnus-score-decay-scale)))))))
21161 (if (and (featurep 'xemacs)
21162 ;; XEmacs' floor can handle only the floating point
21163 ;; number below the half of the maximum integer.
21164 (> (abs n) (lsh -1 -2)))
21166 (car (split-string (number-to-string n) "\\.")))
21170 @vindex gnus-score-decay-scale
21171 @vindex gnus-score-decay-constant
21172 @code{gnus-score-decay-constant} is 3 by default and
21173 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
21177 Scores between -3 and 3 will be set to 0 when this function is called.
21180 Scores with magnitudes between 3 and 60 will be shrunk by 3.
21183 Scores with magnitudes greater than 60 will be shrunk by 5% of the
21187 If you don't like this decay function, write your own. It is called
21188 with the score to be decayed as its only parameter, and it should return
21189 the new score, which should be an integer.
21191 Gnus will try to decay scores once a day. If you haven't run Gnus for
21192 four days, Gnus will decay the scores four times, for instance.
21197 @include message.texi
21198 @chapter Emacs MIME
21199 @include emacs-mime.texi
21201 @include sieve.texi
21203 @c @include pgg.texi
21205 @c @include sasl.texi
21213 * Process/Prefix:: A convention used by many treatment commands.
21214 * Interactive:: Making Gnus ask you many questions.
21215 * Symbolic Prefixes:: How to supply some Gnus functions with options.
21216 * Formatting Variables:: You can specify what buffers should look like.
21217 * Window Layout:: Configuring the Gnus buffer windows.
21218 * Faces and Fonts:: How to change how faces look.
21219 * Compilation:: How to speed Gnus up.
21220 * Mode Lines:: Displaying information in the mode lines.
21221 * Highlighting and Menus:: Making buffers look all nice and cozy.
21222 * Buttons:: Get tendinitis in ten easy steps!
21223 * Daemons:: Gnus can do things behind your back.
21224 * NoCeM:: How to avoid spam and other fatty foods.
21225 * Undo:: Some actions can be undone.
21226 * Predicate Specifiers:: Specifying predicates.
21227 * Moderation:: What to do if you're a moderator.
21228 * Fetching a Group:: Starting Gnus just to read a group.
21229 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
21230 * Fuzzy Matching:: What's the big fuzz?
21231 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
21232 * Other modes:: Interaction with other modes.
21233 * Various Various:: Things that are really various.
21237 @node Process/Prefix
21238 @section Process/Prefix
21239 @cindex process/prefix convention
21241 Many functions, among them functions for moving, decoding and saving
21242 articles, use what is known as the @dfn{Process/Prefix convention}.
21244 This is a method for figuring out what articles the user wants the
21245 command to be performed on.
21249 If the numeric prefix is N, perform the operation on the next N
21250 articles, starting with the current one. If the numeric prefix is
21251 negative, perform the operation on the previous N articles, starting
21252 with the current one.
21254 @vindex transient-mark-mode
21255 If @code{transient-mark-mode} in non-@code{nil} and the region is
21256 active, all articles in the region will be worked upon.
21258 If there is no numeric prefix, but some articles are marked with the
21259 process mark, perform the operation on the articles marked with
21262 If there is neither a numeric prefix nor any articles marked with the
21263 process mark, just perform the operation on the current article.
21265 Quite simple, really, but it needs to be made clear so that surprises
21268 Commands that react to the process mark will push the current list of
21269 process marked articles onto a stack and will then clear all process
21270 marked articles. You can restore the previous configuration with the
21271 @kbd{M P y} command (@pxref{Setting Process Marks}).
21273 @vindex gnus-summary-goto-unread
21274 One thing that seems to shock & horrify lots of people is that, for
21275 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
21276 Since each @kbd{d} (which marks the current article as read) by default
21277 goes to the next unread article after marking, this means that @kbd{3 d}
21278 will mark the next three unread articles as read, no matter what the
21279 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
21280 @code{nil} for a more straightforward action.
21282 Many commands do not use the process/prefix convention. All commands
21283 that do explicitly say so in this manual. To apply the process/prefix
21284 convention to commands that do not use it, you can use the @kbd{M-&}
21285 command. For instance, to mark all the articles in the group as
21286 expirable, you could say @kbd{M P b M-& E}.
21290 @section Interactive
21291 @cindex interaction
21295 @item gnus-novice-user
21296 @vindex gnus-novice-user
21297 If this variable is non-@code{nil}, you are either a newcomer to the
21298 World of Usenet, or you are very cautious, which is a nice thing to be,
21299 really. You will be given questions of the type ``Are you sure you want
21300 to do this?'' before doing anything dangerous. This is @code{t} by
21303 @item gnus-expert-user
21304 @vindex gnus-expert-user
21305 If this variable is non-@code{nil}, you will seldom be asked any
21306 questions by Gnus. It will simply assume you know what you're doing, no
21307 matter how strange.
21309 @item gnus-interactive-catchup
21310 @vindex gnus-interactive-catchup
21311 Require confirmation before catching up a group if non-@code{nil}. It
21312 is @code{t} by default.
21314 @item gnus-interactive-exit
21315 @vindex gnus-interactive-exit
21316 Require confirmation before exiting Gnus. This variable is @code{t} by
21321 @node Symbolic Prefixes
21322 @section Symbolic Prefixes
21323 @cindex symbolic prefixes
21325 Quite a lot of Emacs commands react to the (numeric) prefix. For
21326 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
21327 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
21328 rule of 900 to the current article.
21330 This is all nice and well, but what if you want to give a command some
21331 additional information? Well, what most commands do is interpret the
21332 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
21333 doesn't want a backup file to be created when saving the current buffer,
21334 for instance. But what if you want to save without making a backup
21335 file, and you want Emacs to flash lights and play a nice tune at the
21336 same time? You can't, and you're probably perfectly happy that way.
21338 @kindex M-i (Summary)
21339 @findex gnus-symbolic-argument
21340 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
21341 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
21342 character typed in is the value. You can stack as many @kbd{M-i}
21343 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
21344 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
21345 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
21346 @code{b}''. You get the drift.
21348 Typing in symbolic prefixes to commands that don't accept them doesn't
21349 hurt, but it doesn't do any good either. Currently not many Gnus
21350 functions make use of the symbolic prefix.
21352 If you're interested in how Gnus implements this, @pxref{Extended
21356 @node Formatting Variables
21357 @section Formatting Variables
21358 @cindex formatting variables
21360 Throughout this manual you've probably noticed lots of variables called
21361 things like @code{gnus-group-line-format} and
21362 @code{gnus-summary-mode-line-format}. These control how Gnus is to
21363 output lines in the various buffers. There's quite a lot of them.
21364 Fortunately, they all use the same syntax, so there's not that much to
21367 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
21368 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
21369 lots of percentages everywhere.
21372 * Formatting Basics:: A formatting variable is basically a format string.
21373 * Mode Line Formatting:: Some rules about mode line formatting variables.
21374 * Advanced Formatting:: Modifying output in various ways.
21375 * User-Defined Specs:: Having Gnus call your own functions.
21376 * Formatting Fonts:: Making the formatting look colorful and nice.
21377 * Positioning Point:: Moving point to a position after an operation.
21378 * Tabulation:: Tabulating your output.
21379 * Wide Characters:: Dealing with wide characters.
21382 Currently Gnus uses the following formatting variables:
21383 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
21384 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
21385 @code{gnus-group-mode-line-format},
21386 @code{gnus-summary-mode-line-format},
21387 @code{gnus-article-mode-line-format},
21388 @code{gnus-server-mode-line-format}, and
21389 @code{gnus-summary-pick-line-format}.
21391 All these format variables can also be arbitrary elisp forms. In that
21392 case, they will be @code{eval}ed to insert the required lines.
21394 @kindex M-x gnus-update-format
21395 @findex gnus-update-format
21396 Gnus includes a command to help you while creating your own format
21397 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
21398 update the spec in question and pop you to a buffer where you can
21399 examine the resulting Lisp code to be run to generate the line.
21403 @node Formatting Basics
21404 @subsection Formatting Basics
21406 Each @samp{%} element will be replaced by some string or other when the
21407 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
21408 spec, and pad with spaces to get a 5-character field''.
21410 As with normal C and Emacs Lisp formatting strings, the numerical
21411 modifier between the @samp{%} and the formatting type character will
21412 @dfn{pad} the output so that it is always at least that long.
21413 @samp{%5y} will make the field always (at least) five characters wide by
21414 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
21417 You may also wish to limit the length of the field to protect against
21418 particularly wide values. For that you can say @samp{%4,6y}, which
21419 means that the field will never be more than 6 characters wide and never
21420 less than 4 characters wide.
21422 Also Gnus supports some extended format specifications, such as
21423 @samp{%&user-date;}.
21426 @node Mode Line Formatting
21427 @subsection Mode Line Formatting
21429 Mode line formatting variables (e.g.,
21430 @code{gnus-summary-mode-line-format}) follow the same rules as other,
21431 buffer line oriented formatting variables (@pxref{Formatting Basics})
21432 with the following two differences:
21437 There must be no newline (@samp{\n}) at the end.
21440 The special @samp{%%b} spec can be used to display the buffer name.
21441 Well, it's no spec at all, really---@samp{%%} is just a way to quote
21442 @samp{%} to allow it to pass through the formatting machinery unmangled,
21443 so that Emacs receives @samp{%b}, which is something the Emacs mode line
21444 display interprets to mean ``show the buffer name''. For a full list of
21445 mode line specs Emacs understands, see the documentation of the
21446 @code{mode-line-format} variable.
21451 @node Advanced Formatting
21452 @subsection Advanced Formatting
21454 It is frequently useful to post-process the fields in some way.
21455 Padding, limiting, cutting off parts and suppressing certain values can
21456 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
21457 look like @samp{%~(cut 3)~(ignore "0")y}.
21459 These are the valid modifiers:
21464 Pad the field to the left with spaces until it reaches the required
21468 Pad the field to the right with spaces until it reaches the required
21473 Cut off characters from the left until it reaches the specified length.
21476 Cut off characters from the right until it reaches the specified
21481 Cut off the specified number of characters from the left.
21484 Cut off the specified number of characters from the right.
21487 Return an empty string if the field is equal to the specified value.
21490 Use the specified form as the field value when the @samp{@@} spec is
21496 "~(form (current-time-string))@@"
21501 Let's take an example. The @samp{%o} spec in the summary mode lines
21502 will return a date in compact ISO8601 format---@samp{19960809T230410}.
21503 This is quite a mouthful, so we want to shave off the century number and
21504 the time, leaving us with a six-character date. That would be
21505 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
21506 maxing, and we need the padding to ensure that the date is never less
21507 than 6 characters to make it look nice in columns.)
21509 Ignoring is done first; then cutting; then maxing; and then as the very
21510 last operation, padding.
21512 @vindex gnus-compile-user-specs
21513 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
21514 default) with your strong personality, and use a lots of these advanced
21515 thingies, you'll find that Gnus gets quite slow. This can be helped
21516 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
21517 the look of your lines.
21518 @xref{Compilation}.
21521 @node User-Defined Specs
21522 @subsection User-Defined Specs
21524 All the specs allow for inserting user defined specifiers---@samp{u}.
21525 The next character in the format string should be a letter. Gnus
21526 will call the function @code{gnus-user-format-function-}@samp{X}, where
21527 @samp{X} is the letter following @samp{%u}. The function will be passed
21528 a single parameter---what the parameter means depends on what buffer
21529 it's being called from. The function should return a string, which will
21530 be inserted into the buffer just like information from any other
21531 specifier. This function may also be called with dummy values, so it
21532 should protect against that.
21534 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
21535 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
21537 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
21538 much the same without defining new functions. Here's an example:
21539 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
21540 given here will be evaluated to yield the current line number, and then
21544 @node Formatting Fonts
21545 @subsection Formatting Fonts
21547 There are specs for highlighting, and these are shared by all the format
21548 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
21549 the special @code{mouse-face} property set, which means that it will be
21550 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
21553 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
21554 normal faces set using @code{gnus-face-0}, which is @code{bold} by
21555 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
21556 and so on. Create as many faces as you wish. The same goes for the
21557 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
21558 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
21560 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
21561 special @code{balloon-help} property set to
21562 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
21563 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
21564 variables should be either strings or symbols naming functions that
21565 return a string. When the mouse passes over text with this property
21566 set, a balloon window will appear and display the string. Please
21567 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
21568 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
21569 XEmacs) for more information on this. (For technical reasons, the
21570 guillemets have been approximated as @samp{<<} and @samp{>>} in this
21573 Here's an alternative recipe for the group buffer:
21576 ;; @r{Create three face types.}
21577 (setq gnus-face-1 'bold)
21578 (setq gnus-face-3 'italic)
21580 ;; @r{We want the article count to be in}
21581 ;; @r{a bold and green face. So we create}
21582 ;; @r{a new face called @code{my-green-bold}.}
21583 (copy-face 'bold 'my-green-bold)
21584 ;; @r{Set the color.}
21585 (set-face-foreground 'my-green-bold "ForestGreen")
21586 (setq gnus-face-2 'my-green-bold)
21588 ;; @r{Set the new & fancy format.}
21589 (setq gnus-group-line-format
21590 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
21593 I'm sure you'll be able to use this scheme to create totally unreadable
21594 and extremely vulgar displays. Have fun!
21596 Note that the @samp{%(} specs (and friends) do not make any sense on the
21597 mode-line variables.
21599 @node Positioning Point
21600 @subsection Positioning Point
21602 Gnus usually moves point to a pre-defined place on each line in most
21603 buffers. By default, point move to the first colon character on the
21604 line. You can customize this behavior in three different ways.
21606 You can move the colon character to somewhere else on the line.
21608 @findex gnus-goto-colon
21609 You can redefine the function that moves the point to the colon. The
21610 function is called @code{gnus-goto-colon}.
21612 But perhaps the most convenient way to deal with this, if you don't want
21613 to have a colon in your line, is to use the @samp{%*} specifier. If you
21614 put a @samp{%*} somewhere in your format line definition, Gnus will
21619 @subsection Tabulation
21621 You can usually line up your displays by padding and cutting your
21622 strings. However, when combining various strings of different size, it
21623 can often be more convenient to just output the strings, and then worry
21624 about lining up the following text afterwards.
21626 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
21627 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
21629 @samp{%50=} will insert space characters to pad the line up to column
21630 50. If the text is already past column 50, nothing will be inserted.
21631 This is the soft tabulator.
21633 @samp{%-50=} will insert space characters to pad the line up to column
21634 50. If the text is already past column 50, the excess text past column
21635 50 will be removed. This is the hard tabulator.
21638 @node Wide Characters
21639 @subsection Wide Characters
21641 Fixed width fonts in most countries have characters of the same width.
21642 Some countries, however, use Latin characters mixed with wider
21643 characters---most notable East Asian countries.
21645 The problem is that when formatting, Gnus assumes that if a string is 10
21646 characters wide, it'll be 10 Latin characters wide on the screen. In
21647 these countries, that's not true.
21649 @vindex gnus-use-correct-string-widths
21650 To help fix this, you can set @code{gnus-use-correct-string-widths} to
21651 @code{t}. This makes buffer generation slower, but the results will be
21652 prettier. The default value under XEmacs is @code{t} but @code{nil}
21656 @node Window Layout
21657 @section Window Layout
21658 @cindex window layout
21660 No, there's nothing here about X, so be quiet.
21662 @vindex gnus-use-full-window
21663 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
21664 other windows and occupy the entire Emacs screen by itself. It is
21665 @code{t} by default.
21667 Setting this variable to @code{nil} kinda works, but there are
21668 glitches. Use at your own peril.
21670 @vindex gnus-buffer-configuration
21671 @code{gnus-buffer-configuration} describes how much space each Gnus
21672 buffer should be given. Here's an excerpt of this variable:
21675 ((group (vertical 1.0 (group 1.0 point)
21676 (if gnus-carpal (group-carpal 4))))
21677 (article (vertical 1.0 (summary 0.25 point)
21681 This is an alist. The @dfn{key} is a symbol that names some action or
21682 other. For instance, when displaying the group buffer, the window
21683 configuration function will use @code{group} as the key. A full list of
21684 possible names is listed below.
21686 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
21687 should occupy. To take the @code{article} split as an example -
21690 (article (vertical 1.0 (summary 0.25 point)
21694 This @dfn{split} says that the summary buffer should occupy 25% of upper
21695 half of the screen, and that it is placed over the article buffer. As
21696 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
21697 reaching for that calculator there). However, the special number
21698 @code{1.0} is used to signal that this buffer should soak up all the
21699 rest of the space available after the rest of the buffers have taken
21700 whatever they need. There should be only one buffer with the @code{1.0}
21701 size spec per split.
21703 Point will be put in the buffer that has the optional third element
21704 @code{point}. In a @code{frame} split, the last subsplit having a leaf
21705 split where the tag @code{frame-focus} is a member (i.e. is the third or
21706 fourth element in the list, depending on whether the @code{point} tag is
21707 present) gets focus.
21709 Here's a more complicated example:
21712 (article (vertical 1.0 (group 4)
21713 (summary 0.25 point)
21714 (if gnus-carpal (summary-carpal 4))
21718 If the size spec is an integer instead of a floating point number,
21719 then that number will be used to say how many lines a buffer should
21720 occupy, not a percentage.
21722 If the @dfn{split} looks like something that can be @code{eval}ed (to be
21723 precise---if the @code{car} of the split is a function or a subr), this
21724 split will be @code{eval}ed. If the result is non-@code{nil}, it will
21725 be used as a split. This means that there will be three buffers if
21726 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
21729 Not complicated enough for you? Well, try this on for size:
21732 (article (horizontal 1.0
21737 (summary 0.25 point)
21742 Whoops. Two buffers with the mystery 100% tag. And what's that
21743 @code{horizontal} thingie?
21745 If the first element in one of the split is @code{horizontal}, Gnus will
21746 split the window horizontally, giving you two windows side-by-side.
21747 Inside each of these strips you may carry on all you like in the normal
21748 fashion. The number following @code{horizontal} says what percentage of
21749 the screen is to be given to this strip.
21751 For each split, there @emph{must} be one element that has the 100% tag.
21752 The splitting is never accurate, and this buffer will eat any leftover
21753 lines from the splits.
21755 To be slightly more formal, here's a definition of what a valid split
21760 split = frame | horizontal | vertical | buffer | form
21761 frame = "(frame " size *split ")"
21762 horizontal = "(horizontal " size *split ")"
21763 vertical = "(vertical " size *split ")"
21764 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
21765 size = number | frame-params
21766 buf-name = group | article | summary ...
21770 The limitations are that the @code{frame} split can only appear as the
21771 top-level split. @var{form} should be an Emacs Lisp form that should
21772 return a valid split. We see that each split is fully recursive, and
21773 may contain any number of @code{vertical} and @code{horizontal} splits.
21775 @vindex gnus-window-min-width
21776 @vindex gnus-window-min-height
21777 @cindex window height
21778 @cindex window width
21779 Finding the right sizes can be a bit complicated. No window may be less
21780 than @code{gnus-window-min-height} (default 1) characters high, and all
21781 windows must be at least @code{gnus-window-min-width} (default 1)
21782 characters wide. Gnus will try to enforce this before applying the
21783 splits. If you want to use the normal Emacs window width/height limit,
21784 you can just set these two variables to @code{nil}.
21786 If you're not familiar with Emacs terminology, @code{horizontal} and
21787 @code{vertical} splits may work the opposite way of what you'd expect.
21788 Windows inside a @code{horizontal} split are shown side-by-side, and
21789 windows within a @code{vertical} split are shown above each other.
21791 @findex gnus-configure-frame
21792 If you want to experiment with window placement, a good tip is to call
21793 @code{gnus-configure-frame} directly with a split. This is the function
21794 that does all the real work when splitting buffers. Below is a pretty
21795 nonsensical configuration with 5 windows; two for the group buffer and
21796 three for the article buffer. (I said it was nonsensical.) If you
21797 @code{eval} the statement below, you can get an idea of how that would
21798 look straight away, without going through the normal Gnus channels.
21799 Play with it until you're satisfied, and then use
21800 @code{gnus-add-configuration} to add your new creation to the buffer
21801 configuration list.
21804 (gnus-configure-frame
21808 (article 0.3 point))
21816 You might want to have several frames as well. No prob---just use the
21817 @code{frame} split:
21820 (gnus-configure-frame
21823 (summary 0.25 point frame-focus)
21825 (vertical ((height . 5) (width . 15)
21826 (user-position . t)
21827 (left . -1) (top . 1))
21832 This split will result in the familiar summary/article window
21833 configuration in the first (or ``main'') frame, while a small additional
21834 frame will be created where picons will be shown. As you can see,
21835 instead of the normal @code{1.0} top-level spec, each additional split
21836 should have a frame parameter alist as the size spec.
21837 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
21838 Reference Manual}. Under XEmacs, a frame property list will be
21839 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
21841 The list of all possible keys for @code{gnus-buffer-configuration} can
21842 be found in its default value.
21844 Note that the @code{message} key is used for both
21845 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
21846 it is desirable to distinguish between the two, something like this
21850 (message (horizontal 1.0
21851 (vertical 1.0 (message 1.0 point))
21853 (if (buffer-live-p gnus-summary-buffer)
21858 One common desire for a multiple frame split is to have a separate frame
21859 for composing mail and news while leaving the original frame intact. To
21860 accomplish that, something like the following can be done:
21865 (if (not (buffer-live-p gnus-summary-buffer))
21866 (car (cdr (assoc 'group gnus-buffer-configuration)))
21867 (car (cdr (assoc 'summary gnus-buffer-configuration))))
21868 (vertical ((user-position . t) (top . 1) (left . 1)
21869 (name . "Message"))
21870 (message 1.0 point))))
21873 @findex gnus-add-configuration
21874 Since the @code{gnus-buffer-configuration} variable is so long and
21875 complicated, there's a function you can use to ease changing the config
21876 of a single setting: @code{gnus-add-configuration}. If, for instance,
21877 you want to change the @code{article} setting, you could say:
21880 (gnus-add-configuration
21881 '(article (vertical 1.0
21883 (summary .25 point)
21887 You'd typically stick these @code{gnus-add-configuration} calls in your
21888 @file{~/.gnus.el} file or in some startup hook---they should be run after
21889 Gnus has been loaded.
21891 @vindex gnus-always-force-window-configuration
21892 If all windows mentioned in the configuration are already visible, Gnus
21893 won't change the window configuration. If you always want to force the
21894 ``right'' window configuration, you can set
21895 @code{gnus-always-force-window-configuration} to non-@code{nil}.
21897 If you're using tree displays (@pxref{Tree Display}), and the tree
21898 window is displayed vertically next to another window, you may also want
21899 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
21902 @subsection Example Window Configurations
21906 Narrow left hand side occupied by group buffer. Right hand side split
21907 between summary buffer (top one-sixth) and article buffer (bottom).
21922 (gnus-add-configuration
21925 (vertical 25 (group 1.0))
21927 (summary 0.16 point)
21930 (gnus-add-configuration
21933 (vertical 25 (group 1.0))
21934 (vertical 1.0 (summary 1.0 point)))))
21940 @node Faces and Fonts
21941 @section Faces and Fonts
21946 Fiddling with fonts and faces used to be very difficult, but these days
21947 it is very simple. You simply say @kbd{M-x customize-face}, pick out
21948 the face you want to alter, and alter it via the standard Customize
21953 @section Compilation
21954 @cindex compilation
21955 @cindex byte-compilation
21957 @findex gnus-compile
21959 Remember all those line format specification variables?
21960 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
21961 on. By default, T-gnus will use the byte-compiled codes of these
21962 variables and we can keep a slow-down to a minimum. However, if you set
21963 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
21964 unfortunately, changing them will mean a quite significant slow-down.
21965 (The default values of these variables have byte-compiled functions
21966 associated with them, while the user-generated versions do not, of
21969 To help with this, you can run @kbd{M-x gnus-compile} after you've
21970 fiddled around with the variables and feel that you're (kind of)
21971 satisfied. This will result in the new specs being byte-compiled, and
21972 you'll get top speed again. Note that T-gnus will not save these
21973 compiled specs in the @file{.newsrc.eld} file.
21976 @item gnus-compile-user-specs
21977 @vindex gnus-compile-user-specs
21978 If it is non-nil, the user-defined format specs will be byte-compiled
21979 automatically. The default value of this variable is @code{t}. It has
21980 an effect on the values of @code{gnus-*-line-format-spec}.
21985 @section Mode Lines
21988 @vindex gnus-updated-mode-lines
21989 @code{gnus-updated-mode-lines} says what buffers should keep their mode
21990 lines updated. It is a list of symbols. Supported symbols include
21991 @code{group}, @code{article}, @code{summary}, @code{server},
21992 @code{browse}, and @code{tree}. If the corresponding symbol is present,
21993 Gnus will keep that mode line updated with information that may be
21994 pertinent. If this variable is @code{nil}, screen refresh may be
21997 @cindex display-time
21999 @vindex gnus-mode-non-string-length
22000 By default, Gnus displays information on the current article in the mode
22001 lines of the summary and article buffers. The information Gnus wishes
22002 to display (e.g. the subject of the article) is often longer than the
22003 mode lines, and therefore have to be cut off at some point. The
22004 @code{gnus-mode-non-string-length} variable says how long the other
22005 elements on the line is (i.e., the non-info part). If you put
22006 additional elements on the mode line (e.g. a clock), you should modify
22009 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
22011 (add-hook 'display-time-hook
22012 (lambda () (setq gnus-mode-non-string-length
22014 (if line-number-mode 5 0)
22015 (if column-number-mode 4 0)
22016 (length display-time-string)))))
22019 If this variable is @code{nil} (which is the default), the mode line
22020 strings won't be chopped off, and they won't be padded either. Note
22021 that the default is unlikely to be desirable, as even the percentage
22022 complete in the buffer may be crowded off the mode line; the user should
22023 configure this variable appropriately for her configuration.
22026 @node Highlighting and Menus
22027 @section Highlighting and Menus
22029 @cindex highlighting
22032 @vindex gnus-visual
22033 The @code{gnus-visual} variable controls most of the Gnus-prettifying
22034 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
22035 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
22038 This variable can be a list of visual properties that are enabled. The
22039 following elements are valid, and are all included by default:
22042 @item group-highlight
22043 Do highlights in the group buffer.
22044 @item summary-highlight
22045 Do highlights in the summary buffer.
22046 @item article-highlight
22047 Do highlights in the article buffer.
22049 Turn on highlighting in all buffers.
22051 Create menus in the group buffer.
22053 Create menus in the summary buffers.
22055 Create menus in the article buffer.
22057 Create menus in the browse buffer.
22059 Create menus in the server buffer.
22061 Create menus in the score buffers.
22063 Create menus in all buffers.
22066 So if you only want highlighting in the article buffer and menus in all
22067 buffers, you could say something like:
22070 (setq gnus-visual '(article-highlight menu))
22073 If you want highlighting only and no menus whatsoever, you'd say:
22076 (setq gnus-visual '(highlight))
22079 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
22080 in all Gnus buffers.
22082 Other general variables that influence the look of all buffers include:
22085 @item gnus-mouse-face
22086 @vindex gnus-mouse-face
22087 This is the face (i.e., font) used for mouse highlighting in Gnus. No
22088 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
22092 There are hooks associated with the creation of all the different menus:
22096 @item gnus-article-menu-hook
22097 @vindex gnus-article-menu-hook
22098 Hook called after creating the article mode menu.
22100 @item gnus-group-menu-hook
22101 @vindex gnus-group-menu-hook
22102 Hook called after creating the group mode menu.
22104 @item gnus-summary-menu-hook
22105 @vindex gnus-summary-menu-hook
22106 Hook called after creating the summary mode menu.
22108 @item gnus-server-menu-hook
22109 @vindex gnus-server-menu-hook
22110 Hook called after creating the server mode menu.
22112 @item gnus-browse-menu-hook
22113 @vindex gnus-browse-menu-hook
22114 Hook called after creating the browse mode menu.
22116 @item gnus-score-menu-hook
22117 @vindex gnus-score-menu-hook
22118 Hook called after creating the score mode menu.
22129 Those new-fangled @dfn{mouse} contraptions is very popular with the
22130 young, hep kids who don't want to learn the proper way to do things
22131 these days. Why, I remember way back in the summer of '89, when I was
22132 using Emacs on a Tops 20 system. Three hundred users on one single
22133 machine, and every user was running Simula compilers. Bah!
22137 @vindex gnus-carpal
22138 Well, you can make Gnus display bufferfuls of buttons you can click to
22139 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
22140 really. Tell the chiropractor I sent you.
22145 @item gnus-carpal-mode-hook
22146 @vindex gnus-carpal-mode-hook
22147 Hook run in all carpal mode buffers.
22149 @item gnus-carpal-button-face
22150 @vindex gnus-carpal-button-face
22151 Face used on buttons.
22153 @item gnus-carpal-header-face
22154 @vindex gnus-carpal-header-face
22155 Face used on carpal buffer headers.
22157 @item gnus-carpal-group-buffer-buttons
22158 @vindex gnus-carpal-group-buffer-buttons
22159 Buttons in the group buffer.
22161 @item gnus-carpal-summary-buffer-buttons
22162 @vindex gnus-carpal-summary-buffer-buttons
22163 Buttons in the summary buffer.
22165 @item gnus-carpal-server-buffer-buttons
22166 @vindex gnus-carpal-server-buffer-buttons
22167 Buttons in the server buffer.
22169 @item gnus-carpal-browse-buffer-buttons
22170 @vindex gnus-carpal-browse-buffer-buttons
22171 Buttons in the browse buffer.
22174 All the @code{buttons} variables are lists. The elements in these list
22175 are either cons cells where the @code{car} contains a text to be displayed and
22176 the @code{cdr} contains a function symbol, or a simple string.
22184 Gnus, being larger than any program ever written (allegedly), does lots
22185 of strange stuff that you may wish to have done while you're not
22186 present. For instance, you may want it to check for new mail once in a
22187 while. Or you may want it to close down all connections to all servers
22188 when you leave Emacs idle. And stuff like that.
22190 Gnus will let you do stuff like that by defining various
22191 @dfn{handlers}. Each handler consists of three elements: A
22192 @var{function}, a @var{time}, and an @var{idle} parameter.
22194 Here's an example of a handler that closes connections when Emacs has
22195 been idle for thirty minutes:
22198 (gnus-demon-close-connections nil 30)
22201 Here's a handler that scans for @acronym{PGP} headers every hour when
22205 (gnus-demon-scan-pgp 60 t)
22208 This @var{time} parameter and that @var{idle} parameter work together
22209 in a strange, but wonderful fashion. Basically, if @var{idle} is
22210 @code{nil}, then the function will be called every @var{time} minutes.
22212 If @var{idle} is @code{t}, then the function will be called after
22213 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
22214 the function will never be called. But once Emacs goes idle, the
22215 function will be called every @var{time} minutes.
22217 If @var{idle} is a number and @var{time} is a number, the function will
22218 be called every @var{time} minutes only when Emacs has been idle for
22219 @var{idle} minutes.
22221 If @var{idle} is a number and @var{time} is @code{nil}, the function
22222 will be called once every time Emacs has been idle for @var{idle}
22225 And if @var{time} is a string, it should look like @samp{07:31}, and
22226 the function will then be called once every day somewhere near that
22227 time. Modified by the @var{idle} parameter, of course.
22229 @vindex gnus-demon-timestep
22230 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
22231 seconds. This is 60 by default. If you change that variable,
22232 all the timings in the handlers will be affected.)
22234 So, if you want to add a handler, you could put something like this in
22235 your @file{~/.gnus.el} file:
22237 @findex gnus-demon-add-handler
22239 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
22242 @findex gnus-demon-add-nocem
22243 @findex gnus-demon-add-scanmail
22244 @findex gnus-demon-add-rescan
22245 @findex gnus-demon-add-scan-timestamps
22246 @findex gnus-demon-add-disconnection
22247 Some ready-made functions to do this have been created:
22248 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
22249 @code{gnus-demon-add-nntp-close-connection},
22250 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
22251 @code{gnus-demon-add-scanmail}. Just put those functions in your
22252 @file{~/.gnus.el} if you want those abilities.
22254 @findex gnus-demon-init
22255 @findex gnus-demon-cancel
22256 @vindex gnus-demon-handlers
22257 If you add handlers to @code{gnus-demon-handlers} directly, you should
22258 run @code{gnus-demon-init} to make the changes take hold. To cancel all
22259 daemons, you can use the @code{gnus-demon-cancel} function.
22261 Note that adding daemons can be pretty naughty if you over do it. Adding
22262 functions that scan all news and mail from all servers every two seconds
22263 is a sure-fire way of getting booted off any respectable system. So
22272 @dfn{Spamming} is posting the same article lots and lots of times.
22273 Spamming is bad. Spamming is evil.
22275 Spamming is usually canceled within a day or so by various anti-spamming
22276 agencies. These agencies usually also send out @dfn{NoCeM} messages.
22277 NoCeM is pronounced ``no see-'em'', and means what the name
22278 implies---these are messages that make the offending articles, like, go
22281 What use are these NoCeM messages if the articles are canceled anyway?
22282 Some sites do not honor cancel messages and some sites just honor cancels
22283 from a select few people. Then you may wish to make use of the NoCeM
22284 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
22286 Gnus can read and parse the messages in this group automatically, and
22287 this will make spam disappear.
22289 There are some variables to customize, of course:
22292 @item gnus-use-nocem
22293 @vindex gnus-use-nocem
22294 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
22297 You can also set this variable to a positive number as a group level.
22298 In that case, Gnus scans NoCeM messages when checking new news if this
22299 value is not exceeding a group level that you specify as the prefix
22300 argument to some commands, e.g. @code{gnus},
22301 @code{gnus-group-get-new-news}, etc. Otherwise, Gnus does not scan
22302 NoCeM messages if you specify a group level to those commands. For
22303 example, if you use 1 or 2 on the mail groups and the levels on the news
22304 groups remain the default, 3 is the best choice.
22306 @item gnus-nocem-groups
22307 @vindex gnus-nocem-groups
22308 Gnus will look for NoCeM messages in the groups in this list. The
22311 ("news.lists.filters" "news.admin.net-abuse.bulletins"
22312 "alt.nocem.misc" "news.admin.net-abuse.announce")
22315 @item gnus-nocem-issuers
22316 @vindex gnus-nocem-issuers
22317 There are many people issuing NoCeM messages. This list says what
22318 people you want to listen to. The default is
22320 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
22321 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
22323 fine, upstanding citizens all of them.
22325 Known despammers that you can put in this list are listed at@*
22326 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
22328 You do not have to heed NoCeM messages from all these people---just the
22329 ones you want to listen to. You also don't have to accept all NoCeM
22330 messages from the people you like. Each NoCeM message has a @dfn{type}
22331 header that gives the message a (more or less, usually less) rigorous
22332 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
22333 @samp{binary}, and @samp{troll}. To specify this, you have to use
22334 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
22335 Each condition is either a string (which is a regexp that matches types
22336 you want to use) or a list on the form @code{(not @var{string})}, where
22337 @var{string} is a regexp that matches types you don't want to use.
22339 For instance, if you want all NoCeM messages from Chris Lewis except his
22340 @samp{troll} messages, you'd say:
22343 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
22346 On the other hand, if you just want nothing but his @samp{spam} and
22347 @samp{spew} messages, you'd say:
22350 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
22353 The specs are applied left-to-right.
22356 @item gnus-nocem-verifyer
22357 @vindex gnus-nocem-verifyer
22358 @findex pgg-verify-region
22359 This should be a function for verifying that the NoCeM issuer is who she
22360 says she is. The default is the function using @code{pgg-verify-region}
22365 (pgg-verify-region (point-min) (point-max)))
22368 It returns non-@code{nil} if the verification is successful, otherwise
22369 (including the case the NoCeM message was not signed) returns
22370 @code{nil}. If this is too slow and you don't care for verification
22371 (which may be dangerous), you can set this variable to @code{nil}.
22373 Formerly the default was @code{mc-verify}, which is a Mailcrypt
22374 function. While you can still use it, you can change it into the
22375 default function running with GnuPG if you are willing to add the
22376 @acronym{PGP} public keys to GnuPG's keyring.
22378 @item gnus-nocem-directory
22379 @vindex gnus-nocem-directory
22380 This is where Gnus will store its NoCeM cache files. The default is@*
22381 @file{~/News/NoCeM/}.
22383 @item gnus-nocem-expiry-wait
22384 @vindex gnus-nocem-expiry-wait
22385 The number of days before removing old NoCeM entries from the cache.
22386 The default is 15. If you make it shorter Gnus will be faster, but you
22387 might then see old spam.
22389 @item gnus-nocem-check-from
22390 @vindex gnus-nocem-check-from
22391 Non-@code{nil} means check for valid issuers in message bodies.
22392 Otherwise don't bother fetching articles unless their author matches a
22393 valid issuer; that is much faster if you are selective about the
22396 @item gnus-nocem-check-article-limit
22397 @vindex gnus-nocem-check-article-limit
22398 If non-@code{nil}, the maximum number of articles to check in any NoCeM
22399 group. NoCeM groups can be huge and very slow to process.
22403 Using NoCeM could potentially be a memory hog. If you have many living
22404 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
22405 big. If this is a problem, you should kill off all (or most) of your
22406 unsubscribed groups (@pxref{Subscription Commands}).
22413 It is very useful to be able to undo actions one has done. In normal
22414 Emacs buffers, it's easy enough---you just push the @code{undo} button.
22415 In Gnus buffers, however, it isn't that simple.
22417 The things Gnus displays in its buffer is of no value whatsoever to
22418 Gnus---it's all just data designed to look nice to the user.
22419 Killing a group in the group buffer with @kbd{C-k} makes the line
22420 disappear, but that's just a side-effect of the real action---the
22421 removal of the group in question from the internal Gnus structures.
22422 Undoing something like that can't be done by the normal Emacs
22423 @code{undo} function.
22425 Gnus tries to remedy this somewhat by keeping track of what the user
22426 does and coming up with actions that would reverse the actions the user
22427 takes. When the user then presses the @code{undo} key, Gnus will run
22428 the code to reverse the previous action, or the previous actions.
22429 However, not all actions are easily reversible, so Gnus currently offers
22430 a few key functions to be undoable. These include killing groups,
22431 yanking groups, and changing the list of read articles of groups.
22432 That's it, really. More functions may be added in the future, but each
22433 added function means an increase in data to be stored, so Gnus will
22434 never be totally undoable.
22436 @findex gnus-undo-mode
22437 @vindex gnus-use-undo
22439 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
22440 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
22441 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
22442 command, which should feel kinda like the normal Emacs @code{undo}
22446 @node Predicate Specifiers
22447 @section Predicate Specifiers
22448 @cindex predicate specifiers
22450 Some Gnus variables are @dfn{predicate specifiers}. This is a special
22451 form that allows flexible specification of predicates without having
22452 to type all that much.
22454 These specifiers are lists consisting of functions, symbols and lists.
22459 (or gnus-article-unseen-p
22460 gnus-article-unread-p)
22463 The available symbols are @code{or}, @code{and} and @code{not}. The
22464 functions all take one parameter.
22466 @findex gnus-make-predicate
22467 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
22468 to create a function that can be called. This input parameter to this
22469 function will be passed along to all the functions in the predicate
22474 @section Moderation
22477 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
22478 It is not included in the standard Gnus package. Write a mail to
22479 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
22482 The moderation package is implemented as a minor mode for summary
22486 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
22489 in your @file{~/.gnus.el} file.
22491 If you are the moderator of @samp{rec.zoofle}, this is how it's
22496 You split your incoming mail by matching on
22497 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
22498 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
22501 You enter that group once in a while and post articles using the @kbd{e}
22502 (edit-and-post) or @kbd{s} (just send unedited) commands.
22505 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
22506 articles that weren't approved by you, you can cancel them with the
22510 To use moderation mode in these two groups, say:
22513 (setq gnus-moderated-list
22514 "^nnml:rec.zoofle$\\|^rec.zoofle$")
22518 @node Fetching a Group
22519 @section Fetching a Group
22520 @cindex fetching a group
22522 @findex gnus-fetch-group
22523 It is sometimes convenient to be able to just say ``I want to read this
22524 group and I don't care whether Gnus has been started or not''. This is
22525 perhaps more useful for people who write code than for users, but the
22526 command @code{gnus-fetch-group} provides this functionality in any case.
22527 It takes the group name as a parameter.
22530 @node Image Enhancements
22531 @section Image Enhancements
22533 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
22534 support images yet.}, is able to display pictures and stuff, so Gnus has
22535 taken advantage of that.
22538 * X-Face:: Display a funky, teensy black-and-white image.
22539 * Face:: Display a funkier, teensier colored image.
22540 * Smileys:: Show all those happy faces the way they were meant to be shown.
22541 * Picons:: How to display pictures of what you're reading.
22542 * XVarious:: Other XEmacsy Gnusey variables.
22550 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
22551 depth) image that's supposed to represent the author of the message.
22552 It seems to be supported by an ever-growing number of mail and news
22556 @findex gnus-article-display-x-face
22557 @vindex gnus-article-x-face-command
22558 @vindex gnus-article-x-face-too-ugly
22566 Decoding an @code{X-Face} header either requires an Emacs that has
22567 @samp{compface} support (which most XEmacs versions has), or that you
22568 have @samp{compface} installed on your system. If either is true,
22569 Gnus will default to displaying @code{X-Face} headers.
22571 The variable that controls this is the
22572 @code{gnus-article-x-face-command} variable. If this variable is a
22573 string, this string will be executed in a sub-shell. If it is a
22574 function, this function will be called with the face as the argument.
22575 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
22576 the @code{From} header, the face will not be shown.
22578 The default action under Emacs without image support is to fork off the
22579 @code{display} program@footnote{@code{display} is from the ImageMagick
22580 package. For the @code{uncompface} and @code{icontopbm} programs look
22581 for a package like @code{compface} or @code{faces-xface} on a GNU/Linux
22582 system.} to view the face.
22584 Under XEmacs or Emacs 21+ with suitable image support, the default
22585 action is to display the face before the @code{From} header. (It's
22586 nicer if XEmacs has been compiled with @code{X-Face} support---that
22587 will make display somewhat faster. If there's no native @code{X-Face}
22588 support, Gnus will try to convert the @code{X-Face} header using
22589 external programs from the @code{pbmplus} package and
22590 friends.@footnote{On a GNU/Linux system look for packages with names
22591 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
22593 (Note: @code{x-face} is used in the variable/function names, not
22601 @vindex gnus-x-face
22602 Face to show X-Face. The colors from this face are used as the
22603 foreground and background colors of the displayed X-Faces. The
22604 default colors are black and white.
22606 @item gnus-face-properties-alist
22607 @vindex gnus-face-properties-alist
22608 Alist of image types and properties applied to Face (@pxref{Face}) and
22609 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
22610 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
22611 XEmacs. Here are examples:
22614 ;; Specify the altitude of Face and X-Face images in the From header.
22615 (setq gnus-face-properties-alist
22616 '((pbm . (:face gnus-x-face :ascent 80))
22617 (png . (:ascent 80))))
22619 ;; Show Face and X-Face images as pressed buttons.
22620 (setq gnus-face-properties-alist
22621 '((pbm . (:face gnus-x-face :relief -2))
22622 (png . (:relief -2))))
22625 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
22626 Reference Manual} for the valid properties for various image types.
22627 Currently, @code{pbm} is used for X-Face images and @code{png} is used
22628 for Face images in Emacs. Only the @code{:face} property is effective
22629 on the @code{xface} image type in XEmacs if it is built with the
22630 @samp{libcompface} library.
22633 If you use posting styles, you can use an @code{x-face-file} entry in
22634 @code{gnus-posting-styles}, @xref{Posting Styles}. If you don't, Gnus
22635 provides a few convenience functions and variables to allow easier
22636 insertion of X-Face headers in outgoing messages.
22638 @findex gnus-random-x-face
22639 @vindex gnus-convert-pbm-to-x-face-command
22640 @vindex gnus-x-face-directory
22641 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
22642 @code{gnus-x-face-directory} and picks one at random, and then
22643 converts it to the X-Face format by using the
22644 @code{gnus-convert-pbm-to-x-face-command} shell command. The
22645 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
22646 header data as a string.
22648 @findex gnus-insert-random-x-face-header
22649 @code{gnus-insert-random-x-face-header} calls
22650 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
22651 randomly generated data.
22653 @findex gnus-x-face-from-file
22654 @vindex gnus-convert-image-to-x-face-command
22655 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
22656 converts the file to X-Face format by using the
22657 @code{gnus-convert-image-to-x-face-command} shell command.
22659 Here's how you would typically use the first function. Put something
22660 like the following in your @file{~/.gnus.el} file:
22663 (setq message-required-news-headers
22664 (nconc message-required-news-headers
22665 (list '(X-Face . gnus-random-x-face))))
22668 Using the last function would be something like this:
22671 (setq message-required-news-headers
22672 (nconc message-required-news-headers
22673 (list '(X-Face . (lambda ()
22674 (gnus-x-face-from-file
22675 "~/My-face.gif"))))))
22683 @c #### FIXME: faces and x-faces'implementations should really be harmonized.
22685 @code{Face} headers are essentially a funkier version of @code{X-Face}
22686 ones. They describe a 48x48 pixel colored image that's supposed to
22687 represent the author of the message.
22690 @findex gnus-article-display-face
22691 The contents of a @code{Face} header must be a base64 encoded PNG image.
22692 See @uref{http://quimby.gnus.org/circus/face/} for the precise
22695 The @code{gnus-face-properties-alist} variable affects the appearance of
22696 displayed Face images. @xref{X-Face}.
22698 Gnus provides a few convenience functions and variables to allow
22699 easier insertion of Face headers in outgoing messages.
22701 @findex gnus-convert-png-to-face
22702 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
22703 726 bytes long, and converts it to a face.
22705 @findex gnus-face-from-file
22706 @vindex gnus-convert-image-to-face-command
22707 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
22708 converts the file to Face format by using the
22709 @code{gnus-convert-image-to-face-command} shell command.
22711 Here's how you would typically use this function. Put something like the
22712 following in your @file{~/.gnus.el} file:
22715 (setq message-required-news-headers
22716 (nconc message-required-news-headers
22717 (list '(Face . (lambda ()
22718 (gnus-face-from-file "~/face.jpg"))))))
22723 @subsection Smileys
22728 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
22733 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
22734 currently the only package that uses Smiley, it is documented here.
22736 In short---to use Smiley in Gnus, put the following in your
22737 @file{~/.gnus.el} file:
22740 (setq gnus-treat-display-smileys t)
22743 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
22744 the like---to pictures and displays those instead of the text smiley
22745 faces. The conversion is controlled by a list of regexps that matches
22746 text and maps that to file names.
22748 @vindex smiley-regexp-alist
22749 The alist used is specified by the @code{smiley-regexp-alist}
22750 variable. The first item in each element is the regexp to be matched;
22751 the second element is the regexp match group that is to be replaced by
22752 the picture; and the third element is the name of the file to be
22755 The following variables customize where Smiley will look for these
22760 @item smiley-data-directory
22761 @vindex smiley-data-directory
22762 Where Smiley will look for smiley faces files.
22764 @item gnus-smiley-file-types
22765 @vindex gnus-smiley-file-types
22766 List of suffixes on smiley file names to try.
22780 So@dots{} You want to slow down your news reader even more! This is a
22781 good way to do so. It's also a great way to impress people staring
22782 over your shoulder as you read news.
22784 What are Picons? To quote directly from the Picons Web site:
22793 @dfn{Picons} is short for ``personal icons''. They're small,
22794 constrained images used to represent users and domains on the net,
22795 organized into databases so that the appropriate image for a given
22796 e-mail address can be found. Besides users and domains, there are picon
22797 databases for Usenet newsgroups and weather forecasts. The picons are
22798 in either monochrome @code{XBM} format or color @code{XPM} and
22799 @code{GIF} formats.
22802 @vindex gnus-picon-databases
22803 For instructions on obtaining and installing the picons databases,
22804 point your Web browser at
22805 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
22807 If you are using Debian GNU/Linux, saying @samp{apt-get install
22808 picons.*} will install the picons where Gnus can find them.
22810 To enable displaying picons, simply make sure that
22811 @code{gnus-picon-databases} points to the directory containing the
22814 @vindex gnus-picon-style
22815 The variable @code{gnus-picon-style} controls how picons are displayed.
22816 If @code{inline}, the textual representation is replaced. If
22817 @code{right}, picons are added right to the textual representation.
22819 The following variables offer control over where things are located.
22823 @item gnus-picon-databases
22824 @vindex gnus-picon-databases
22825 The location of the picons database. This is a list of directories
22826 containing the @file{news}, @file{domains}, @file{users} (and so on)
22827 subdirectories. Defaults to @code{("/usr/lib/picon"
22828 "/usr/local/faces")}.
22830 @item gnus-picon-news-directories
22831 @vindex gnus-picon-news-directories
22832 List of subdirectories to search in @code{gnus-picon-databases} for
22833 newsgroups faces. @code{("news")} is the default.
22835 @item gnus-picon-user-directories
22836 @vindex gnus-picon-user-directories
22837 List of subdirectories to search in @code{gnus-picon-databases} for user
22838 faces. @code{("users" "usenix" "local" "misc")} is the default.
22840 @item gnus-picon-domain-directories
22841 @vindex gnus-picon-domain-directories
22842 List of subdirectories to search in @code{gnus-picon-databases} for
22843 domain name faces. Defaults to @code{("domains")}. Some people may
22844 want to add @samp{"unknown"} to this list.
22846 @item gnus-picon-file-types
22847 @vindex gnus-picon-file-types
22848 Ordered list of suffixes on picon file names to try. Defaults to
22849 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
22855 @subsection Various XEmacs Variables
22858 @item gnus-xmas-glyph-directory
22859 @vindex gnus-xmas-glyph-directory
22860 This is where Gnus will look for pictures. Gnus will normally
22861 auto-detect this directory, but you may set it manually if you have an
22862 unusual directory structure.
22864 @item gnus-xmas-modeline-glyph
22865 @vindex gnus-xmas-modeline-glyph
22866 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
22871 @subsubsection Toolbar
22875 @item gnus-use-toolbar
22876 @vindex gnus-use-toolbar
22877 This variable specifies the position to display the toolbar. If
22878 @code{nil}, don't display toolbars. If it is non-@code{nil}, it should
22879 be one of the symbols @code{default}, @code{top}, @code{bottom},
22880 @code{right}, and @code{left}. @code{default} means to use the default
22881 toolbar, the rest mean to display the toolbar on the place which those
22882 names show. The default is @code{default}.
22884 @item gnus-toolbar-thickness
22885 @vindex gnus-toolbar-thickness
22886 Cons of the height and the width specifying the thickness of a toolbar.
22887 The height is used for the toolbar displayed on the top or the bottom,
22888 the width is used for the toolbar displayed on the right or the left.
22889 The default is that of the default toolbar.
22891 @item gnus-group-toolbar
22892 @vindex gnus-group-toolbar
22893 The toolbar in the group buffer.
22895 @item gnus-summary-toolbar
22896 @vindex gnus-summary-toolbar
22897 The toolbar in the summary buffer.
22899 @item gnus-summary-mail-toolbar
22900 @vindex gnus-summary-mail-toolbar
22901 The toolbar in the summary buffer of mail groups.
22912 @node Fuzzy Matching
22913 @section Fuzzy Matching
22914 @cindex fuzzy matching
22916 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
22917 things like scoring, thread gathering and thread comparison.
22919 As opposed to regular expression matching, fuzzy matching is very fuzzy.
22920 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
22921 means, and the implementation has changed over time.
22923 Basically, it tries to remove all noise from lines before comparing.
22924 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
22925 out of the strings before comparing the results. This often leads to
22926 adequate results---even when faced with strings generated by text
22927 manglers masquerading as newsreaders.
22930 @node Thwarting Email Spam
22931 @section Thwarting Email Spam
22935 @cindex unsolicited commercial email
22937 In these last days of the Usenet, commercial vultures are hanging about
22938 and grepping through news like crazy to find email addresses they can
22939 foist off their scams and products to. As a reaction to this, many
22940 people have started putting nonsense addresses into their @code{From}
22941 lines. I think this is counterproductive---it makes it difficult for
22942 people to send you legitimate mail in response to things you write, as
22943 well as making it difficult to see who wrote what. This rewriting may
22944 perhaps be a bigger menace than the unsolicited commercial email itself
22947 The biggest problem I have with email spam is that it comes in under
22948 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
22949 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
22950 mail group, only to find two pyramid schemes, seven advertisements
22951 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
22952 and one mail asking me to repent and find some god.
22954 This is annoying. Here's what you can do about it.
22957 * The problem of spam:: Some background, and some solutions
22958 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
22959 * SpamAssassin:: How to use external anti-spam tools.
22960 * Hashcash:: Reduce spam by burning CPU time.
22961 * Filtering Spam Using The Spam ELisp Package::
22962 * Filtering Spam Using Statistics with spam-stat::
22965 @node The problem of spam
22966 @subsection The problem of spam
22968 @cindex spam filtering approaches
22969 @cindex filtering approaches, spam
22971 @cindex unsolicited commercial email
22973 First, some background on spam.
22975 If you have access to e-mail, you are familiar with spam (technically
22976 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
22977 exists because e-mail delivery is very cheap compared to paper mail,
22978 so only a very small percentage of people need to respond to an UCE to
22979 make it worthwhile to the advertiser. Ironically, one of the most
22980 common spams is the one offering a database of e-mail addresses for
22981 further spamming. Senders of spam are usually called @emph{spammers},
22982 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
22983 @emph{morons} are in common use as well.
22985 Spam comes from a wide variety of sources. It is simply impossible to
22986 dispose of all spam without discarding useful messages. A good
22987 example is the TMDA system, which requires senders
22988 unknown to you to confirm themselves as legitimate senders before
22989 their e-mail can reach you. Without getting into the technical side
22990 of TMDA, a downside is clearly that e-mail from legitimate sources may
22991 be discarded if those sources can't or won't confirm themselves
22992 through the TMDA system. Another problem with TMDA is that it
22993 requires its users to have a basic understanding of e-mail delivery
22996 The simplest approach to filtering spam is filtering, at the mail
22997 server or when you sort through incoming mail. If you get 200 spam
22998 messages per day from @samp{random-address@@vmadmin.com}, you block
22999 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
23000 discard all messages with @samp{VIAGRA} in the message. If you get
23001 lots of spam from Bulgaria, for example, you try to filter all mail
23002 from Bulgarian IPs.
23004 This, unfortunately, is a great way to discard legitimate e-mail. The
23005 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
23006 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
23007 you should be obvious, so don't do it if you have the choice.
23009 In another instance, the very informative and useful RISKS digest has
23010 been blocked by overzealous mail filters because it @strong{contained}
23011 words that were common in spam messages. Nevertheless, in isolated
23012 cases, with great care, direct filtering of mail can be useful.
23014 Another approach to filtering e-mail is the distributed spam
23015 processing, for instance DCC implements such a system. In essence,
23016 @var{N} systems around the world agree that a machine @var{X} in
23017 Ghana, Estonia, or California is sending out spam e-mail, and these
23018 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
23019 database. The criteria for spam detection vary---it may be the number
23020 of messages sent, the content of the messages, and so on. When a user
23021 of the distributed processing system wants to find out if a message is
23022 spam, he consults one of those @var{N} systems.
23024 Distributed spam processing works very well against spammers that send
23025 a large number of messages at once, but it requires the user to set up
23026 fairly complicated checks. There are commercial and free distributed
23027 spam processing systems. Distributed spam processing has its risks as
23028 well. For instance legitimate e-mail senders have been accused of
23029 sending spam, and their web sites and mailing lists have been shut
23030 down for some time because of the incident.
23032 The statistical approach to spam filtering is also popular. It is
23033 based on a statistical analysis of previous spam messages. Usually
23034 the analysis is a simple word frequency count, with perhaps pairs of
23035 words or 3-word combinations thrown into the mix. Statistical
23036 analysis of spam works very well in most of the cases, but it can
23037 classify legitimate e-mail as spam in some cases. It takes time to
23038 run the analysis, the full message must be analyzed, and the user has
23039 to store the database of spam analyses. Statistical analysis on the
23040 server is gaining popularity. This has the advantage of letting the
23041 user Just Read Mail, but has the disadvantage that it's harder to tell
23042 the server that it has misclassified mail.
23044 Fighting spam is not easy, no matter what anyone says. There is no
23045 magic switch that will distinguish Viagra ads from Mom's e-mails.
23046 Even people are having a hard time telling spam apart from non-spam,
23047 because spammers are actively looking to fool us into thinking they
23048 are Mom, essentially. Spamming is irritating, irresponsible, and
23049 idiotic behavior from a bunch of people who think the world owes them
23050 a favor. We hope the following sections will help you in fighting the
23053 @node Anti-Spam Basics
23054 @subsection Anti-Spam Basics
23058 @cindex unsolicited commercial email
23060 One way of dealing with spam is having Gnus split out all spam into a
23061 @samp{spam} mail group (@pxref{Splitting Mail}).
23063 First, pick one (1) valid mail address that you can be reached at, and
23064 put it in your @code{From} header of all your news articles. (I've
23065 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
23066 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
23067 sysadmin whether your sendmail installation accepts keywords in the local
23068 part of the mail address.)
23071 (setq message-default-news-headers
23072 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
23075 Then put the following split rule in @code{nnmail-split-fancy}
23076 (@pxref{Fancy Mail Splitting}):
23080 (to "larsi@@trym.ifi.uio.no"
23081 (| ("subject" "re:.*" "misc")
23082 ("references" ".*@@.*" "misc")
23087 This says that all mail to this address is suspect, but if it has a
23088 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
23089 header, it's probably ok. All the rest goes to the @samp{spam} group.
23090 (This idea probably comes from Tim Pierce.)
23092 In addition, many mail spammers talk directly to your @acronym{SMTP} server
23093 and do not include your email address explicitly in the @code{To}
23094 header. Why they do this is unknown---perhaps it's to thwart this
23095 thwarting scheme? In any case, this is trivial to deal with---you just
23096 put anything not addressed to you in the @samp{spam} group by ending
23097 your fancy split rule in this way:
23102 (to "larsi" "misc")
23106 In my experience, this will sort virtually everything into the right
23107 group. You still have to check the @samp{spam} group from time to time to
23108 check for legitimate mail, though. If you feel like being a good net
23109 citizen, you can even send off complaints to the proper authorities on
23110 each unsolicited commercial email---at your leisure.
23112 This works for me. It allows people an easy way to contact me (they can
23113 just press @kbd{r} in the usual way), and I'm not bothered at all with
23114 spam. It's a win-win situation. Forging @code{From} headers to point
23115 to non-existent domains is yucky, in my opinion.
23117 Be careful with this approach. Spammers are wise to it.
23121 @subsection SpamAssassin, Vipul's Razor, DCC, etc
23122 @cindex SpamAssassin
23123 @cindex Vipul's Razor
23126 The days where the hints in the previous section were sufficient in
23127 avoiding spam are coming to an end. There are many tools out there
23128 that claim to reduce the amount of spam you get. This section could
23129 easily become outdated fast, as new products replace old, but
23130 fortunately most of these tools seem to have similar interfaces. Even
23131 though this section will use SpamAssassin as an example, it should be
23132 easy to adapt it to most other tools.
23134 Note that this section does not involve the @code{spam.el} package,
23135 which is discussed in the next section. If you don't care for all
23136 the features of @code{spam.el}, you can make do with these simple
23139 If the tool you are using is not installed on the mail server, you
23140 need to invoke it yourself. Ideas on how to use the
23141 @code{:postscript} mail source parameter (@pxref{Mail Source
23142 Specifiers}) follow.
23146 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
23150 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
23153 Once you manage to process your incoming spool somehow, thus making
23154 the mail contain e.g.@: a header indicating it is spam, you are ready to
23155 filter it out. Using normal split methods (@pxref{Splitting Mail}):
23158 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
23162 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
23165 (setq nnmail-split-methods 'nnmail-split-fancy
23166 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
23170 Some people might not like the idea of piping the mail through various
23171 programs using a @code{:prescript} (if some program is buggy, you
23172 might lose all mail). If you are one of them, another solution is to
23173 call the external tools during splitting. Example fancy split method:
23176 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
23178 (defun kevin-spamassassin ()
23182 (if (eq 1 (call-process-region (point-min) (point-max)
23183 "spamc" nil nil nil "-c"))
23187 Note that with the nnimap back end, message bodies will not be
23188 downloaded by default. You need to set
23189 @code{nnimap-split-download-body} to @code{t} to do that
23190 (@pxref{Splitting in IMAP}).
23192 That is about it. As some spam is likely to get through anyway, you
23193 might want to have a nifty function to call when you happen to read
23194 spam. And here is the nifty function:
23197 (defun my-gnus-raze-spam ()
23198 "Submit SPAM to Vipul's Razor, then mark it as expirable."
23200 (gnus-summary-show-raw-article)
23201 (gnus-summary-save-in-pipe "razor-report -f -d")
23202 (gnus-summary-mark-as-expirable 1))
23206 @subsection Hashcash
23209 A novel technique to fight spam is to require senders to do something
23210 costly and demonstrably unique for each message they send. This has
23211 the obvious drawback that you cannot rely on everyone in the world
23212 using this technique, since it is not part of the Internet standards,
23213 but it may be useful in smaller communities.
23215 While the tools in the previous section work well in practice, they
23216 work only because the tools are constantly maintained and updated as
23217 new form of spam appears. This means that a small percentage of spam
23218 will always get through. It also means that somewhere, someone needs
23219 to read lots of spam to update these tools. Hashcash avoids that, but
23220 instead prefers that everyone you contact through e-mail supports the
23221 scheme. You can view the two approaches as pragmatic vs dogmatic.
23222 The approaches have their own advantages and disadvantages, but as
23223 often in the real world, a combination of them is stronger than either
23224 one of them separately.
23227 The ``something costly'' is to burn CPU time, more specifically to
23228 compute a hash collision up to a certain number of bits. The
23229 resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header.
23230 For more details, and for the external application @code{hashcash} you
23231 need to install to use this feature, see
23232 @uref{http://www.hashcash.org/}. Even more information can be found
23233 at @uref{http://www.camram.org/}.
23235 If you wish to generate hashcash for each message you send, you can
23236 customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail
23237 Headers,message, The Message Manual}), as in:
23240 (setq message-generate-hashcash t)
23243 You will need to set up some additional variables as well:
23247 @item hashcash-default-payment
23248 @vindex hashcash-default-payment
23249 This variable indicates the default number of bits the hash collision
23250 should consist of. By default this is 20. Suggested useful values
23253 @item hashcash-payment-alist
23254 @vindex hashcash-payment-alist
23255 Some receivers may require you to spend burn more CPU time than the
23256 default. This variable contains a list of @samp{(@var{addr}
23257 @var{amount})} cells, where @var{addr} is the receiver (email address
23258 or newsgroup) and @var{amount} is the number of bits in the collision
23259 that is needed. It can also contain @samp{(@var{addr} @var{string}
23260 @var{amount})} cells, where the @var{string} is the string to use
23261 (normally the email address or newsgroup name is used).
23263 @item hashcash-path
23264 @vindex hashcash-path
23265 Where the @code{hashcash} binary is installed. This variable should
23266 be automatically set by @code{executable-find}, but if it's @code{nil}
23267 (usually because the @code{hashcash} binary is not in your path)
23268 you'll get a warning when you check hashcash payments and an error
23269 when you generate hashcash payments.
23273 Gnus can verify hashcash cookies, although this can also be done by
23274 hand customized mail filtering scripts. To verify a hashcash cookie
23275 in a message, use the @code{mail-check-payment} function in the
23276 @code{hashcash.el} library. You can also use the @code{spam.el}
23277 package with the @code{spam-use-hashcash} back end to validate hashcash
23278 cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam
23279 Hashcash Payments}).
23281 @node Filtering Spam Using The Spam ELisp Package
23282 @subsection Filtering Spam Using The Spam ELisp Package
23283 @cindex spam filtering
23286 The idea behind @code{spam.el} is to have a control center for spam detection
23287 and filtering in Gnus. To that end, @code{spam.el} does two things: it
23288 filters new mail, and it analyzes mail known to be spam or ham.
23289 @dfn{Ham} is the name used throughout @code{spam.el} to indicate
23292 Make sure you read the section on the @code{spam.el} sequence of
23293 events. See @xref{Spam ELisp Package Sequence of Events}.
23295 @cindex spam-initialize
23296 To use @code{spam.el}, you @strong{must} run the function
23297 @code{spam-initialize} to autoload @file{spam.el} and to install the
23298 @code{spam.el} hooks. There is one exception: if you use the
23299 @code{spam-use-stat} (@pxref{spam-stat spam filtering}) setting, you
23300 should turn it on before @code{spam-initialize}:
23303 (setq spam-use-stat t) ;; if needed
23307 So, what happens when you load @file{spam.el}?
23309 First, some hooks will get installed by @code{spam-initialize}. There
23310 are some hooks for @code{spam-stat} so it can save its databases, and
23311 there are hooks so interesting things will happen when you enter and
23312 leave a group. More on the sequence of events later (@pxref{Spam
23313 ELisp Package Sequence of Events}).
23315 You get the following keyboard commands:
23325 @findex gnus-summary-mark-as-spam
23326 @code{gnus-summary-mark-as-spam}.
23328 Mark current article as spam, showing it with the @samp{$} mark.
23329 Whenever you see a spam article, make sure to mark its summary line
23330 with @kbd{M-d} before leaving the group. This is done automatically
23331 for unread articles in @emph{spam} groups.
23337 @findex spam-bogofilter-score
23338 @code{spam-bogofilter-score}.
23340 You must have Bogofilter installed for that command to work properly.
23346 Also, when you load @file{spam.el}, you will be able to customize its
23347 variables. Try @code{customize-group} on the @samp{spam} variable
23351 * Spam ELisp Package Sequence of Events::
23352 * Spam ELisp Package Filtering of Incoming Mail::
23353 * Spam ELisp Package Global Variables::
23354 * Spam ELisp Package Sorting and Score Display in Summary Buffer::
23355 * Spam ELisp Package Configuration Examples::
23356 * Blacklists and Whitelists::
23357 * BBDB Whitelists::
23358 * Gmane Spam Reporting::
23359 * Anti-spam Hashcash Payments::
23361 * Regular Expressions Header Matching::
23363 * SpamAssassin back end::
23364 * ifile spam filtering::
23365 * spam-stat spam filtering::
23367 * Extending the Spam ELisp package::
23370 @node Spam ELisp Package Sequence of Events
23371 @subsubsection Spam ELisp Package Sequence of Events
23372 @cindex spam filtering
23373 @cindex spam filtering sequence of events
23375 You must read this section to understand how @code{spam.el} works.
23376 Do not skip, speed-read, or glance through this section.
23378 There are two @emph{contact points}, if you will, between
23379 @code{spam.el} and the rest of Gnus: checking new mail for spam, and
23382 Getting new mail in Gnus is done in one of two ways. You can either
23383 split your incoming mail or you can classify new articles as ham or
23384 spam when you enter the group.
23386 Splitting incoming mail is better suited to mail back ends such as
23387 @code{nnml} or @code{nnimap} where new mail appears in a single file
23388 called a @dfn{Spool File}. See @xref{Spam ELisp Package Filtering of
23391 @vindex gnus-spam-autodetect
23392 @vindex gnus-spam-autodetect-methods
23393 For back ends such as @code{nntp} there is no incoming mail spool, so
23394 an alternate mechanism must be used. This may also happen for
23395 back ends where the server is in charge of splitting incoming mail, and
23396 Gnus does not do further splitting. The @code{spam-autodetect} and
23397 @code{spam-autodetect-methods} group parameters (accessible with
23398 @kbd{G c} and @kbd{G p} as usual), and the corresponding variables
23399 @code{gnus-spam-autodetect} and @code{gnus-spam-autodetect-methods}
23400 (accessible with @kbd{M-x customize-variable} as usual) can help.
23402 When @code{spam-autodetect} is used (you can turn it on for a
23403 group/topic or wholesale by regular expression matches, as needed), it
23404 hooks into the process of entering a group. Thus, entering a group
23405 with unseen or unread articles becomes the substitute for checking
23406 incoming mail. Whether only unseen articles or all unread articles
23407 will be processed is determined by the
23408 @code{spam-autodetect-recheck-messages}. When set to @code{t}, unread
23409 messages will be rechecked. You should probably stick with the
23410 default of only checking unseen messages.
23412 @code{spam-autodetect} grants the user at once more and less control
23413 of spam filtering. The user will have more control over each group's
23414 spam methods, so for instance the @samp{ding} group may have
23415 @code{spam-use-BBDB} as the autodetection method, while the
23416 @samp{suspect} group may have the @code{spam-use-blacklist} and
23417 @code{spam-use-bogofilter} methods enabled. Every article detected to
23418 be spam will be marked with the spam mark @samp{$} and processed on
23419 exit from the group as normal spam. The user has less control over
23420 the @emph{sequence} of checks, as he might with @code{spam-split}.
23422 When the newly split mail goes into groups, or messages are
23423 autodetected to be ham or spam, those groups must be exited (after
23424 entering, if needed) for further spam processing to happen. It
23425 matters whether the group is considered a ham group, a spam group, or
23426 is unclassified, based on its @code{spam-content} parameter
23427 (@pxref{Spam ELisp Package Global Variables}). Spam groups have the
23428 additional characteristic that, when entered, any unseen or unread
23429 articles (depending on the @code{spam-mark-only-unseen-as-spam}
23430 variable) will be marked as spam. Thus, mail split into a spam group
23431 gets automatically marked as spam when you enter the group.
23433 Thus, when you exit a group, the @code{spam-processors} are applied,
23434 if any are set, and the processed mail is moved to the
23435 @code{ham-process-destination} or the @code{spam-process-destination}
23436 depending on the article's classification. If the
23437 @code{ham-process-destination} or the @code{spam-process-destination},
23438 whichever is appropriate, are @code{nil}, the article is left in the
23441 If a spam is found in any group (this can be changed to only non-spam
23442 groups with @code{spam-move-spam-nonspam-groups-only}), it is
23443 processed by the active @code{spam-processors} (@pxref{Spam ELisp
23444 Package Global Variables}) when the group is exited. Furthermore, the
23445 spam is moved to the @code{spam-process-destination} (@pxref{Spam
23446 ELisp Package Global Variables}) for further training or deletion.
23447 You have to load the @code{gnus-registry.el} package and enable the
23448 @code{spam-log-to-registry} variable if you want spam to be processed
23449 no more than once. Thus, spam is detected and processed everywhere,
23450 which is what most people want. If the
23451 @code{spam-process-destination} is @code{nil}, the spam is marked as
23452 expired, which is usually the right thing to do.
23454 If spam can not be moved---because of a read-only back end such as
23455 @acronym{NNTP}, for example, it will be copied.
23457 If a ham mail is found in a ham group, as determined by the
23458 @code{ham-marks} parameter, it is processed as ham by the active ham
23459 @code{spam-processor} when the group is exited. With the variables
23460 @code{spam-process-ham-in-spam-groups} and
23461 @code{spam-process-ham-in-nonham-groups} the behavior can be further
23462 altered so ham found anywhere can be processed. You have to load the
23463 @code{gnus-registry.el} package and enable the
23464 @code{spam-log-to-registry} variable if you want ham to be processed
23465 no more than once. Thus, ham is detected and processed only when
23466 necessary, which is what most people want. More on this in
23467 @xref{Spam ELisp Package Configuration Examples}.
23469 If ham can not be moved---because of a read-only back end such as
23470 @acronym{NNTP}, for example, it will be copied.
23472 If all this seems confusing, don't worry. Soon it will be as natural
23473 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
23474 50 years in the future yet. Just trust us, it's not so bad.
23476 @node Spam ELisp Package Filtering of Incoming Mail
23477 @subsubsection Spam ELisp Package Filtering of Incoming Mail
23478 @cindex spam filtering
23479 @cindex spam filtering incoming mail
23482 To use the @code{spam.el} facilities for incoming mail filtering, you
23483 must add the following to your fancy split list
23484 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
23490 Note that the fancy split may be called @code{nnmail-split-fancy} or
23491 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
23492 nnimap back ends to retrieve your mail.
23494 Also, @code{spam-split} will not modify incoming mail in any way.
23496 The @code{spam-split} function will process incoming mail and send the
23497 mail considered to be spam into the group name given by the variable
23498 @code{spam-split-group}. By default that group name is @samp{spam},
23499 but you can customize @code{spam-split-group}. Make sure the contents
23500 of @code{spam-split-group} are an @emph{unqualified} group name, for
23501 instance in an @code{nnimap} server @samp{your-server} the value
23502 @samp{spam} will turn out to be @samp{nnimap+your-server:spam}. The
23503 value @samp{nnimap+server:spam}, therefore, is wrong and will
23504 actually give you the group
23505 @samp{nnimap+your-server:nnimap+server:spam} which may or may not
23506 work depending on your server's tolerance for strange group names.
23508 You can also give @code{spam-split} a parameter,
23509 e.g. @code{spam-use-regex-headers} or @code{"maybe-spam"}. Why is
23512 Take these split rules (with @code{spam-use-regex-headers} and
23513 @code{spam-use-blackholes} set):
23516 nnimap-split-fancy '(|
23517 (any "ding" "ding")
23519 ;; @r{default mailbox}
23523 Now, the problem is that you want all ding messages to make it to the
23524 ding folder. But that will let obvious spam (for example, spam
23525 detected by SpamAssassin, and @code{spam-use-regex-headers}) through,
23526 when it's sent to the ding list. On the other hand, some messages to
23527 the ding list are from a mail server in the blackhole list, so the
23528 invocation of @code{spam-split} can't be before the ding rule.
23530 You can let SpamAssassin headers supersede ding rules, but all other
23531 @code{spam-split} rules (including a second invocation of the
23532 regex-headers check) will be after the ding rule:
23537 ;; @r{all spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
23538 (: spam-split "regex-spam" 'spam-use-regex-headers)
23539 (any "ding" "ding")
23540 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
23542 ;; @r{default mailbox}
23546 This lets you invoke specific @code{spam-split} checks depending on
23547 your particular needs, and to target the results of those checks to a
23548 particular spam group. You don't have to throw all mail into all the
23549 spam tests. Another reason why this is nice is that messages to
23550 mailing lists you have rules for don't have to have resource-intensive
23551 blackhole checks performed on them. You could also specify different
23552 spam checks for your nnmail split vs. your nnimap split. Go crazy.
23554 You should still have specific checks such as
23555 @code{spam-use-regex-headers} set to @code{t}, even if you
23556 specifically invoke @code{spam-split} with the check. The reason is
23557 that when loading @file{spam.el}, some conditional loading is done
23558 depending on what @code{spam-use-xyz} variables you have set. This
23559 is usually not critical, though.
23561 @emph{Note for IMAP users}
23563 The boolean variable @code{nnimap-split-download-body} needs to be
23564 set, if you want to split based on the whole message instead of just
23565 the headers. By default, the nnimap back end will only retrieve the
23566 message headers. If you use a @emph{statistical} filter,
23567 e.g. @code{spam-check-bogofilter}, @code{spam-check-ifile}, or
23568 @code{spam-check-stat} (the splitters that can benefit from the full
23569 message body), this variable will be set automatically. It is not set
23570 for non-statistical back ends by default because it will slow
23571 @acronym{IMAP} down.
23573 @xref{Splitting in IMAP}.
23575 @node Spam ELisp Package Global Variables
23576 @subsubsection Spam ELisp Package Global Variables
23577 @cindex spam filtering
23578 @cindex spam filtering variables
23579 @cindex spam variables
23582 @vindex gnus-spam-process-newsgroups
23583 The concepts of ham processors and spam processors are very important.
23584 Ham processors and spam processors for a group can be set with the
23585 @code{spam-process} group parameter, or the
23586 @code{gnus-spam-process-newsgroups} variable. Ham processors take
23587 mail known to be non-spam (@emph{ham}) and process it in some way so
23588 that later similar mail will also be considered non-spam. Spam
23589 processors take mail known to be spam and process it so similar spam
23590 will be detected later.
23592 The format of the spam or ham processor entry used to be a symbol,
23593 but now it is a @sc{cons} cell. See the individual spam processor entries
23594 for more information.
23596 @vindex gnus-spam-newsgroup-contents
23597 Gnus learns from the spam you get. You have to collect your spam in
23598 one or more spam groups, and set or customize the variable
23599 @code{spam-junk-mailgroups} as appropriate. You can also declare
23600 groups to contain spam by setting their group parameter
23601 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
23602 by customizing the corresponding variable
23603 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
23604 parameter and the @code{gnus-spam-newsgroup-contents} variable can
23605 also be used to declare groups as @emph{ham} groups if you set their
23606 classification to @code{gnus-group-spam-classification-ham}. If
23607 groups are not classified by means of @code{spam-junk-mailgroups},
23608 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
23609 considered @emph{unclassified}. All groups are unclassified by
23612 @vindex gnus-spam-mark
23614 In spam groups, all messages are considered to be spam by default:
23615 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
23616 group. If you have seen a message, had it marked as spam, then
23617 unmarked it, it won't be marked as spam when you enter the group
23618 thereafter. You can disable that behavior, so all unread messages
23619 will get the @samp{$} mark, if you set the
23620 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
23621 should remove the @samp{$} mark when you are in the group summary
23622 buffer for every message that is not spam after all. To remove the
23623 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
23624 @kbd{d} for declaring it read the non-spam way. When you leave a
23625 group, all spam-marked (@samp{$}) articles are sent to a spam
23626 processor which will study them as spam samples.
23628 Messages may also be deleted in various other ways, and unless
23629 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
23630 and @samp{r} for default read or explicit delete, marks @samp{X} and
23631 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
23632 low scores, are all considered to be associated with articles which
23633 are not spam. This assumption might be false, in particular if you
23634 use kill files or score files as means for detecting genuine spam, you
23635 should then adjust the @code{ham-marks} group parameter.
23638 You can customize this group or topic parameter to be the list of
23639 marks you want to consider ham. By default, the list contains the
23640 deleted, read, killed, kill-filed, and low-score marks (the idea is
23641 that these articles have been read, but are not spam). It can be
23642 useful to also include the tick mark in the ham marks. It is not
23643 recommended to make the unread mark a ham mark, because it normally
23644 indicates a lack of classification. But you can do it, and we'll be
23649 You can customize this group or topic parameter to be the list of
23650 marks you want to consider spam. By default, the list contains only
23651 the spam mark. It is not recommended to change that, but you can if
23652 you really want to.
23655 When you leave @emph{any} group, regardless of its
23656 @code{spam-contents} classification, all spam-marked articles are sent
23657 to a spam processor, which will study these as spam samples. If you
23658 explicit kill a lot, you might sometimes end up with articles marked
23659 @samp{K} which you never saw, and which might accidentally contain
23660 spam. Best is to make sure that real spam is marked with @samp{$},
23663 @vindex gnus-ham-process-destinations
23664 When you leave a @emph{spam} group, all spam-marked articles are
23665 marked as expired after processing with the spam processor. This is
23666 not done for @emph{unclassified} or @emph{ham} groups. Also, any
23667 @strong{ham} articles in a spam group will be moved to a location
23668 determined by either the @code{ham-process-destination} group
23669 parameter or a match in the @code{gnus-ham-process-destinations}
23670 variable, which is a list of regular expressions matched with group
23671 names (it's easiest to customize this variable with @kbd{M-x
23672 customize-variable @key{RET} gnus-ham-process-destinations}). Each
23673 group name list is a standard Lisp list, if you prefer to customize
23674 the variable manually. If the @code{ham-process-destination}
23675 parameter is not set, ham articles are left in place. If the
23676 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
23677 set, the ham articles are marked as unread before being moved.
23679 If ham can not be moved---because of a read-only back end such as
23680 @acronym{NNTP}, for example, it will be copied.
23682 Note that you can use multiples destinations per group or regular
23683 expression! This enables you to send your ham to a regular mail
23684 group and to a @emph{ham training} group.
23686 When you leave a @emph{ham} group, all ham-marked articles are sent to
23687 a ham processor, which will study these as non-spam samples.
23689 @vindex spam-process-ham-in-spam-groups
23690 By default the variable @code{spam-process-ham-in-spam-groups} is
23691 @code{nil}. Set it to @code{t} if you want ham found in spam groups
23692 to be processed. Normally this is not done, you are expected instead
23693 to send your ham to a ham group and process it there.
23695 @vindex spam-process-ham-in-nonham-groups
23696 By default the variable @code{spam-process-ham-in-nonham-groups} is
23697 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
23698 or unclassified) groups to be processed. Normally this is not done,
23699 you are expected instead to send your ham to a ham group and process
23702 @vindex gnus-spam-process-destinations
23703 When you leave a @emph{ham} or @emph{unclassified} group, all
23704 @strong{spam} articles are moved to a location determined by either
23705 the @code{spam-process-destination} group parameter or a match in the
23706 @code{gnus-spam-process-destinations} variable, which is a list of
23707 regular expressions matched with group names (it's easiest to
23708 customize this variable with @kbd{M-x customize-variable @key{RET}
23709 gnus-spam-process-destinations}). Each group name list is a standard
23710 Lisp list, if you prefer to customize the variable manually. If the
23711 @code{spam-process-destination} parameter is not set, the spam
23712 articles are only expired. The group name is fully qualified, meaning
23713 that if you see @samp{nntp:servername} before the group name in the
23714 group buffer then you need it here as well.
23716 If spam can not be moved---because of a read-only back end such as
23717 @acronym{NNTP}, for example, it will be copied.
23719 Note that you can use multiples destinations per group or regular
23720 expression! This enables you to send your spam to multiple @emph{spam
23723 @vindex spam-log-to-registry
23724 The problem with processing ham and spam is that Gnus doesn't track
23725 this processing by default. Enable the @code{spam-log-to-registry}
23726 variable so @code{spam.el} will use @code{gnus-registry.el} to track
23727 what articles have been processed, and avoid processing articles
23728 multiple times. Keep in mind that if you limit the number of registry
23729 entries, this won't work as well as it does without a limit.
23731 @vindex spam-mark-only-unseen-as-spam
23732 Set this variable if you want only unseen articles in spam groups to
23733 be marked as spam. By default, it is set. If you set it to
23734 @code{nil}, unread articles will also be marked as spam.
23736 @vindex spam-mark-ham-unread-before-move-from-spam-group
23737 Set this variable if you want ham to be unmarked before it is moved
23738 out of the spam group. This is very useful when you use something
23739 like the tick mark @samp{!} to mark ham---the article will be placed
23740 in your @code{ham-process-destination}, unmarked as if it came fresh
23741 from the mail server.
23743 @vindex spam-autodetect-recheck-messages
23744 When autodetecting spam, this variable tells @code{spam.el} whether
23745 only unseen articles or all unread articles should be checked for
23746 spam. It is recommended that you leave it off.
23748 @node Spam ELisp Package Sorting and Score Display in Summary Buffer
23749 @subsubsection Spam ELisp Package Sorting and Score Display in Summary Buffer
23750 @cindex spam scoring
23751 @cindex spam sorting
23752 @cindex spam score summary buffer
23753 @cindex spam sort summary buffer
23756 You can display the spam score of articles in your summary buffer, and
23757 you can sort articles by their spam score.
23759 First you need to decide which back end you will be using. If you use
23760 the @code{spam-use-spamassassin},
23761 @code{spam-use-spamassassin-headers}, or @code{spam-use-regex-headers}
23762 back end, the @code{X-Spam-Status} header will be used. If you use
23763 @code{spam-use-bogofilter}, the @code{X-Bogosity} header will be used.
23764 If you use @code{spam-use-crm114}, any header that matches the CRM114
23765 score format will be used. As long as you set the appropriate back end
23766 variable to t @emph{before} you load @file{spam.el}, you will be
23767 fine. @code{spam.el} will automatically add the right header to the
23768 internal Gnus list of required headers.
23770 To show the spam score in your summary buffer, add this line to your
23771 @code{gnus.el} file (note @code{spam.el} does not do that by default
23772 so it won't override any existing @code{S} formats you may have).
23775 (defalias 'gnus-user-format-function-S 'spam-user-format-function-S)
23778 Now just set your summary line format to use @code{%uS}. Here's an
23779 example that formats the spam score in a 5-character field:
23782 (setq gnus-summary-line-format
23783 "%U%R %10&user-date; $%5uS %6k %B %(%4L: %*%-25,25a%) %s \n")
23786 Finally, to sort by spam status, either do it globally:
23790 gnus-show-threads nil
23791 gnus-article-sort-functions
23792 '(spam-article-sort-by-spam-status))
23795 or per group (@pxref{Sorting the Summary Buffer}).
23797 @node Spam ELisp Package Configuration Examples
23798 @subsubsection Spam ELisp Package Configuration Examples
23799 @cindex spam filtering
23800 @cindex spam filtering configuration examples
23801 @cindex spam configuration examples
23804 @subsubheading Ted's setup
23806 From Ted Zlatanov <tzz@@lifelogs.com>.
23808 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
23809 ;; @r{see @file{gnus-registry.el} for more information}
23810 (gnus-registry-initialize)
23813 ;; @r{I like @kbd{C-s} for marking spam}
23814 (define-key gnus-summary-mode-map "\C-s" 'gnus-summary-mark-as-spam)
23817 spam-log-to-registry t ; @r{for spam autodetection}
23819 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
23820 ;; @r{all groups with @samp{spam} in the name contain spam}
23821 gnus-spam-newsgroup-contents
23822 '(("spam" gnus-group-spam-classification-spam))
23823 ;; @r{see documentation for these}
23824 spam-move-spam-nonspam-groups-only nil
23825 spam-mark-only-unseen-as-spam t
23826 spam-mark-ham-unread-before-move-from-spam-group t
23827 nnimap-split-rule 'nnimap-split-fancy
23828 ;; @r{understand what this does before you copy it to your own setup!}
23829 nnimap-split-fancy '(|
23830 ;; @r{trace references to parents and put in their group}
23831 (: gnus-registry-split-fancy-with-parent)
23832 ;; @r{this will catch server-side SpamAssassin tags}
23833 (: spam-split 'spam-use-regex-headers)
23834 (any "ding" "ding")
23835 ;; @r{note that spam by default will go to @samp{spam}}
23837 ;; @r{default mailbox}
23840 ;; @r{my parameters, set with @kbd{G p}}
23842 ;; @r{all nnml groups, and all nnimap groups except}
23843 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
23844 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
23845 ;; @r{because it must have been detected manually}
23847 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23849 ;; @r{all @acronym{NNTP} groups}
23850 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
23851 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
23852 ;; @r{send all spam to the training group}
23853 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23855 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
23856 ((spam-autodetect . t))
23858 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
23860 ;; @r{this is a spam group}
23861 ((spam-contents gnus-group-spam-classification-spam)
23863 ;; @r{any spam (which happens when I enter for all unseen messages,}
23864 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
23865 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
23867 (spam-process-destination "nnimap+mail.lifelogs.com:train")
23869 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
23870 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
23872 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
23873 "nnimap+mail.lifelogs.com:trainham")
23874 ;; @r{in this group, only @samp{!} marks are ham}
23876 (gnus-ticked-mark))
23877 ;; @r{remembers senders in the blacklist on the way out---this is}
23878 ;; @r{definitely not needed, it just makes me feel better}
23879 (spam-process (gnus-group-spam-exit-processor-blacklist)))
23881 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
23882 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
23883 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
23887 @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server
23888 From Reiner Steib <reiner.steib@@gmx.de>.
23890 My provider has set up bogofilter (in combination with @acronym{DCC}) on
23891 the mail server (@acronym{IMAP}). Recognized spam goes to
23892 @samp{spam.detected}, the rest goes through the normal filter rules,
23893 i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
23894 positives or negatives is done by copying or moving the article to
23895 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
23896 the server feeds those to bogofilter with the suitable ham or spam
23897 options and deletes them from the @samp{training.ham} and
23898 @samp{training.spam} folders.
23900 With the following entries in @code{gnus-parameters}, @code{spam.el}
23901 does most of the job for me:
23904 ("nnimap:spam\\.detected"
23905 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
23906 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
23907 (spam-contents gnus-group-spam-classification-spam))
23908 ("nnimap:\\(INBOX\\|other-folders\\)"
23909 (spam-process-destination . "nnimap:training.spam")
23910 (spam-contents gnus-group-spam-classification-ham))
23915 @item @b{The Spam folder:}
23917 In the folder @samp{spam.detected}, I have to check for false positives
23918 (i.e. legitimate mails, that were wrongly judged as spam by
23919 bogofilter or DCC).
23921 Because of the @code{gnus-group-spam-classification-spam} entry, all
23922 messages are marked as spam (with @code{$}). When I find a false
23923 positive, I mark the message with some other ham mark (@code{ham-marks},
23924 @ref{Spam ELisp Package Global Variables}). On group exit, those
23925 messages are copied to both groups, @samp{INBOX} (where I want to have
23926 the article) and @samp{training.ham} (for training bogofilter) and
23927 deleted from the @samp{spam.detected} folder.
23929 The @code{gnus-article-sort-by-chars} entry simplifies detection of
23930 false positives for me. I receive lots of worms (sweN, @dots{}), that all
23931 have a similar size. Grouping them by size (i.e. chars) makes finding
23932 other false positives easier. (Of course worms aren't @i{spam}
23933 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
23934 an excellent tool for filtering those unwanted mails for me.)
23936 @item @b{Ham folders:}
23938 In my ham folders, I just hit @kbd{S x}
23939 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
23940 mail (false negative). On group exit, those messages are moved to
23941 @samp{training.spam}.
23944 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
23946 From Reiner Steib <reiner.steib@@gmx.de>.
23948 With following entry in @code{gnus-parameters}, @kbd{S x}
23949 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
23950 groups as spam and reports the to Gmane at group exit:
23954 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
23957 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
23958 because I don't read the groups directly from news.gmane.org, but
23959 through my local news server (leafnode). I.e. the article numbers are
23960 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
23961 the @code{X-Report-Spam} header to find the correct number.
23963 @node Blacklists and Whitelists
23964 @subsubsection Blacklists and Whitelists
23965 @cindex spam filtering
23966 @cindex whitelists, spam filtering
23967 @cindex blacklists, spam filtering
23970 @defvar spam-use-blacklist
23972 Set this variable to @code{t} if you want to use blacklists when
23973 splitting incoming mail. Messages whose senders are in the blacklist
23974 will be sent to the @code{spam-split-group}. This is an explicit
23975 filter, meaning that it acts only on mail senders @emph{declared} to
23980 @defvar spam-use-whitelist
23982 Set this variable to @code{t} if you want to use whitelists when
23983 splitting incoming mail. Messages whose senders are not in the
23984 whitelist will be sent to the next spam-split rule. This is an
23985 explicit filter, meaning that unless someone is in the whitelist, their
23986 messages are not assumed to be spam or ham.
23990 @defvar spam-use-whitelist-exclusive
23992 Set this variable to @code{t} if you want to use whitelists as an
23993 implicit filter, meaning that every message will be considered spam
23994 unless the sender is in the whitelist. Use with care.
23998 @defvar gnus-group-spam-exit-processor-blacklist
24000 Add this symbol to a group's @code{spam-process} parameter by
24001 customizing the group parameters or the
24002 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24003 added to a group's @code{spam-process} parameter, the senders of
24004 spam-marked articles will be added to the blacklist.
24008 Instead of the obsolete
24009 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
24010 that you use @code{(spam spam-use-blacklist)}. Everything will work
24011 the same way, we promise.
24015 @defvar gnus-group-ham-exit-processor-whitelist
24017 Add this symbol to a group's @code{spam-process} parameter by
24018 customizing the group parameters or the
24019 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24020 added to a group's @code{spam-process} parameter, the senders of
24021 ham-marked articles in @emph{ham} groups will be added to the
24026 Instead of the obsolete
24027 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
24028 that you use @code{(ham spam-use-whitelist)}. Everything will work
24029 the same way, we promise.
24033 Blacklists are lists of regular expressions matching addresses you
24034 consider to be spam senders. For instance, to block mail from any
24035 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
24036 blacklist. You start out with an empty blacklist. Blacklist entries
24037 use the Emacs regular expression syntax.
24039 Conversely, whitelists tell Gnus what addresses are considered
24040 legitimate. All messages from whitelisted addresses are considered
24041 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
24042 Emacs regular expression syntax.
24044 The blacklist and whitelist file locations can be customized with the
24045 @code{spam-directory} variable (@file{~/News/spam} by default), or
24046 the @code{spam-whitelist} and @code{spam-blacklist} variables
24047 directly. The whitelist and blacklist files will by default be in the
24048 @code{spam-directory} directory, named @file{whitelist} and
24049 @file{blacklist} respectively.
24051 @node BBDB Whitelists
24052 @subsubsection BBDB Whitelists
24053 @cindex spam filtering
24054 @cindex BBDB whitelists, spam filtering
24055 @cindex BBDB, spam filtering
24058 @defvar spam-use-BBDB
24060 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
24061 Whitelists}), but uses the BBDB as the source of whitelisted
24062 addresses, without regular expressions. You must have the BBDB loaded
24063 for @code{spam-use-BBDB} to work properly. Messages whose senders are
24064 not in the BBDB will be sent to the next spam-split rule. This is an
24065 explicit filter, meaning that unless someone is in the BBDB, their
24066 messages are not assumed to be spam or ham.
24070 @defvar spam-use-BBDB-exclusive
24072 Set this variable to @code{t} if you want to use the BBDB as an
24073 implicit filter, meaning that every message will be considered spam
24074 unless the sender is in the BBDB. Use with care. Only sender
24075 addresses in the BBDB will be allowed through; all others will be
24076 classified as spammers.
24078 While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias
24079 for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is
24080 @emph{not} a separate back end. If you set
24081 @code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting
24086 @defvar gnus-group-ham-exit-processor-BBDB
24088 Add this symbol to a group's @code{spam-process} parameter by
24089 customizing the group parameters or the
24090 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24091 added to a group's @code{spam-process} parameter, the senders of
24092 ham-marked articles in @emph{ham} groups will be added to the
24097 Instead of the obsolete
24098 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
24099 that you use @code{(ham spam-use-BBDB)}. Everything will work
24100 the same way, we promise.
24104 @node Gmane Spam Reporting
24105 @subsubsection Gmane Spam Reporting
24106 @cindex spam reporting
24107 @cindex Gmane, spam reporting
24108 @cindex Gmane, spam reporting
24111 @defvar gnus-group-spam-exit-processor-report-gmane
24113 Add this symbol to a group's @code{spam-process} parameter by
24114 customizing the group parameters or the
24115 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24116 added to a group's @code{spam-process} parameter, the spam-marked
24117 articles groups will be reported to the Gmane administrators via a
24120 Gmane can be found at @uref{http://gmane.org}.
24124 Instead of the obsolete
24125 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
24126 that you use @code{(spam spam-use-gmane)}. Everything will work the
24127 same way, we promise.
24131 @defvar spam-report-gmane-use-article-number
24133 This variable is @code{t} by default. Set it to @code{nil} if you are
24134 running your own news server, for instance, and the local article
24135 numbers don't correspond to the Gmane article numbers. When
24136 @code{spam-report-gmane-use-article-number} is @code{nil},
24137 @code{spam-report.el} will fetch the number from the article headers.
24141 @defvar spam-report-user-mail-address
24143 Mail address exposed in the User-Agent spam reports to Gmane. It allows
24144 the Gmane administrators to contact you in case of misreports. The
24145 default is @code{user-mail-address}.
24149 @node Anti-spam Hashcash Payments
24150 @subsubsection Anti-spam Hashcash Payments
24151 @cindex spam filtering
24152 @cindex hashcash, spam filtering
24155 @defvar spam-use-hashcash
24157 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
24158 Whitelists}), but uses hashcash tokens for whitelisting messages
24159 instead of the sender address. Messages without a hashcash payment
24160 token will be sent to the next spam-split rule. This is an explicit
24161 filter, meaning that unless a hashcash token is found, the messages
24162 are not assumed to be spam or ham.
24167 @subsubsection Blackholes
24168 @cindex spam filtering
24169 @cindex blackholes, spam filtering
24172 @defvar spam-use-blackholes
24174 This option is disabled by default. You can let Gnus consult the
24175 blackhole-type distributed spam processing systems (DCC, for instance)
24176 when you set this option. The variable @code{spam-blackhole-servers}
24177 holds the list of blackhole servers Gnus will consult. The current
24178 list is fairly comprehensive, but make sure to let us know if it
24179 contains outdated servers.
24181 The blackhole check uses the @code{dig.el} package, but you can tell
24182 @code{spam.el} to use @code{dns.el} instead for better performance if
24183 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
24184 this time to set @code{spam-use-dig} to @code{nil} despite the
24185 possible performance improvements, because some users may be unable to
24186 use it, but you can try it and see if it works for you.
24190 @defvar spam-blackhole-servers
24192 The list of servers to consult for blackhole checks.
24196 @defvar spam-blackhole-good-server-regex
24198 A regular expression for IPs that should not be checked against the
24199 blackhole server list. When set to @code{nil}, it has no effect.
24203 @defvar spam-use-dig
24205 Use the @code{dig.el} package instead of the @code{dns.el} package.
24206 The default setting of @code{t} is recommended.
24210 Blackhole checks are done only on incoming mail. There is no spam or
24211 ham processor for blackholes.
24213 @node Regular Expressions Header Matching
24214 @subsubsection Regular Expressions Header Matching
24215 @cindex spam filtering
24216 @cindex regular expressions header matching, spam filtering
24219 @defvar spam-use-regex-headers
24221 This option is disabled by default. You can let Gnus check the
24222 message headers against lists of regular expressions when you set this
24223 option. The variables @code{spam-regex-headers-spam} and
24224 @code{spam-regex-headers-ham} hold the list of regular expressions.
24225 Gnus will check against the message headers to determine if the
24226 message is spam or ham, respectively.
24230 @defvar spam-regex-headers-spam
24232 The list of regular expressions that, when matched in the headers of
24233 the message, positively identify it as spam.
24237 @defvar spam-regex-headers-ham
24239 The list of regular expressions that, when matched in the headers of
24240 the message, positively identify it as ham.
24244 Regular expression header checks are done only on incoming mail.
24245 There is no specific spam or ham processor for regular expressions.
24248 @subsubsection Bogofilter
24249 @cindex spam filtering
24250 @cindex bogofilter, spam filtering
24253 @defvar spam-use-bogofilter
24255 Set this variable if you want @code{spam-split} to use Eric Raymond's
24258 With a minimum of care for associating the @samp{$} mark for spam
24259 articles only, Bogofilter training all gets fairly automatic. You
24260 should do this until you get a few hundreds of articles in each
24261 category, spam or not. The command @kbd{S t} in summary mode, either
24262 for debugging or for curiosity, shows the @emph{spamicity} score of
24263 the current article (between 0.0 and 1.0).
24265 Bogofilter determines if a message is spam based on a specific
24266 threshold. That threshold can be customized, consult the Bogofilter
24269 If the @code{bogofilter} executable is not in your path, Bogofilter
24270 processing will be turned off.
24272 You should not enable this if you use @code{spam-use-bogofilter-headers}.
24276 @defvar spam-use-bogofilter-headers
24278 Set this variable if you want @code{spam-split} to use Eric Raymond's
24279 speedy Bogofilter, looking only at the message headers. It works
24280 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
24281 must be in the message already. Normally you would do this with a
24282 procmail recipe or something similar; consult the Bogofilter
24283 installation documents for details.
24285 You should not enable this if you use @code{spam-use-bogofilter}.
24289 @defvar gnus-group-spam-exit-processor-bogofilter
24290 Add this symbol to a group's @code{spam-process} parameter by
24291 customizing the group parameters or the
24292 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24293 added to a group's @code{spam-process} parameter, spam-marked articles
24294 will be added to the Bogofilter spam database.
24298 Instead of the obsolete
24299 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
24300 that you use @code{(spam spam-use-bogofilter)}. Everything will work
24301 the same way, we promise.
24304 @defvar gnus-group-ham-exit-processor-bogofilter
24305 Add this symbol to a group's @code{spam-process} parameter by
24306 customizing the group parameters or the
24307 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24308 added to a group's @code{spam-process} parameter, the ham-marked
24309 articles in @emph{ham} groups will be added to the Bogofilter database
24310 of non-spam messages.
24314 Instead of the obsolete
24315 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
24316 that you use @code{(ham spam-use-bogofilter)}. Everything will work
24317 the same way, we promise.
24320 @defvar spam-bogofilter-database-directory
24322 This is the directory where Bogofilter will store its databases. It
24323 is not specified by default, so Bogofilter will use its own default
24324 database directory.
24328 The Bogofilter mail classifier is similar to @command{ifile} in intent and
24329 purpose. A ham and a spam processor are provided, plus the
24330 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
24331 variables to indicate to spam-split that Bogofilter should either be
24332 used, or has already been used on the article. The 0.9.2.1 version of
24333 Bogofilter was used to test this functionality.
24335 @node SpamAssassin back end
24336 @subsubsection SpamAssassin back end
24337 @cindex spam filtering
24338 @cindex spamassassin, spam filtering
24341 @defvar spam-use-spamassassin
24343 Set this variable if you want @code{spam-split} to use SpamAssassin.
24345 SpamAssassin assigns a score to each article based on a set of rules
24346 and tests, including a Bayesian filter. The Bayesian filter can be
24347 trained by associating the @samp{$} mark for spam articles. The
24348 spam score can be viewed by using the command @kbd{S t} in summary
24351 If you set this variable, each article will be processed by
24352 SpamAssassin when @code{spam-split} is called. If your mail is
24353 preprocessed by SpamAssassin, and you want to just use the
24354 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
24357 You should not enable this is you use
24358 @code{spam-use-spamassassin-headers}.
24362 @defvar spam-use-spamassassin-headers
24364 Set this variable if your mail is preprocessed by SpamAssassin and
24365 want @code{spam-split} to split based on the SpamAssassin headers.
24367 You should not enable this is you use @code{spam-use-spamassassin}.
24371 @defvar spam-spamassassin-path
24373 This variable points to the SpamAssassin executable. If you have
24374 @code{spamd} running, you can set this variable to the @code{spamc}
24375 executable for faster processing. See the SpamAssassin documentation
24376 for more information on @code{spamd}/@code{spamc}.
24380 SpamAssassin is a powerful and flexible spam filter that uses a wide
24381 variety of tests to identify spam. A ham and a spam processors are
24382 provided, plus the @code{spam-use-spamassassin} and
24383 @code{spam-use-spamassassin-headers} variables to indicate to
24384 spam-split that SpamAssassin should be either used, or has already
24385 been used on the article. The 2.63 version of SpamAssassin was used
24386 to test this functionality.
24388 @node ifile spam filtering
24389 @subsubsection ifile spam filtering
24390 @cindex spam filtering
24391 @cindex ifile, spam filtering
24394 @defvar spam-use-ifile
24396 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
24397 statistical analyzer similar to Bogofilter.
24401 @defvar spam-ifile-all-categories
24403 Enable this variable if you want @code{spam-use-ifile} to give you all
24404 the ifile categories, not just spam/non-spam. If you use this, make
24405 sure you train ifile as described in its documentation.
24409 @defvar spam-ifile-spam-category
24411 This is the category of spam messages as far as ifile is concerned.
24412 The actual string used is irrelevant, but you probably want to leave
24413 the default value of @samp{spam}.
24416 @defvar spam-ifile-database-path
24418 This is the filename for the ifile database. It is not specified by
24419 default, so ifile will use its own default database name.
24423 The ifile mail classifier is similar to Bogofilter in intent and
24424 purpose. A ham and a spam processor are provided, plus the
24425 @code{spam-use-ifile} variable to indicate to spam-split that ifile
24426 should be used. The 1.2.1 version of ifile was used to test this
24429 @node spam-stat spam filtering
24430 @subsubsection spam-stat spam filtering
24431 @cindex spam filtering
24432 @cindex spam-stat, spam filtering
24436 @xref{Filtering Spam Using Statistics with spam-stat}.
24438 @defvar spam-use-stat
24440 Enable this variable if you want @code{spam-split} to use
24441 spam-stat.el, an Emacs Lisp statistical analyzer.
24445 @defvar gnus-group-spam-exit-processor-stat
24446 Add this symbol to a group's @code{spam-process} parameter by
24447 customizing the group parameters or the
24448 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24449 added to a group's @code{spam-process} parameter, the spam-marked
24450 articles will be added to the spam-stat database of spam messages.
24454 Instead of the obsolete
24455 @code{gnus-group-spam-exit-processor-stat}, it is recommended
24456 that you use @code{(spam spam-use-stat)}. Everything will work
24457 the same way, we promise.
24460 @defvar gnus-group-ham-exit-processor-stat
24461 Add this symbol to a group's @code{spam-process} parameter by
24462 customizing the group parameters or the
24463 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24464 added to a group's @code{spam-process} parameter, the ham-marked
24465 articles in @emph{ham} groups will be added to the spam-stat database
24466 of non-spam messages.
24470 Instead of the obsolete
24471 @code{gnus-group-ham-exit-processor-stat}, it is recommended
24472 that you use @code{(ham spam-use-stat)}. Everything will work
24473 the same way, we promise.
24476 This enables @code{spam.el} to cooperate with @file{spam-stat.el}.
24477 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
24478 which unlike ifile or Bogofilter does not require external programs.
24479 A spam and a ham processor, and the @code{spam-use-stat} variable for
24480 @code{spam-split} are provided.
24483 @subsubsection Using SpamOracle with Gnus
24484 @cindex spam filtering
24488 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
24489 statistical mail filtering tool written by Xavier Leroy and needs to be
24490 installed separately.
24492 There are several ways to use SpamOracle with Gnus. In all cases, your
24493 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
24494 then enter an @samp{X-Spam} header indicating whether it regards the
24495 mail as a spam mail or not.
24497 One possibility is to run SpamOracle as a @code{:prescript} from the
24498 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
24499 the advantage that the user can see the @emph{X-Spam} headers.
24501 The easiest method is to make @code{spam.el} (@pxref{Filtering Spam
24502 Using The Spam ELisp Package}) call SpamOracle.
24504 @vindex spam-use-spamoracle
24505 To enable SpamOracle usage by @code{spam.el}, set the variable
24506 @code{spam-use-spamoracle} to @code{t} and configure the
24507 @code{nnmail-split-fancy} or @code{nnimap-split-fancy} as described in
24508 the section @xref{Filtering Spam Using The Spam ELisp Package}. In
24509 this example the @samp{INBOX} of an nnimap server is filtered using
24510 SpamOracle. Mails recognized as spam mails will be moved to
24511 @code{spam-split-group}, @samp{Junk} in this case. Ham messages stay
24515 (setq spam-use-spamoracle t
24516 spam-split-group "Junk"
24517 nnimap-split-inbox '("INBOX")
24518 nnimap-split-rule 'nnimap-split-fancy
24519 nnimap-split-fancy '(| (: spam-split) "INBOX"))
24522 @defvar spam-use-spamoracle
24523 Set to @code{t} if you want Gnus to enable spam filtering using
24527 @defvar spam-spamoracle-binary
24528 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
24529 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
24533 @defvar spam-spamoracle-database
24534 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
24535 store its analyses. This is controlled by the variable
24536 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
24537 the default SpamOracle database will be used. In case you want your
24538 database to live somewhere special, set
24539 @code{spam-spamoracle-database} to this path.
24542 SpamOracle employs a statistical algorithm to determine whether a
24543 message is spam or ham. In order to get good results, meaning few
24544 false hits or misses, SpamOracle needs training. SpamOracle learns the
24545 characteristics of your spam mails. Using the @emph{add} mode
24546 (training mode) one has to feed good (ham) and spam mails to
24547 SpamOracle. This can be done by pressing @kbd{|} in the Summary buffer
24548 and pipe the mail to a SpamOracle process or using @code{spam.el}'s
24549 spam- and ham-processors, which is much more convenient. For a
24550 detailed description of spam- and ham-processors, @xref{Filtering Spam
24551 Using The Spam ELisp Package}.
24553 @defvar gnus-group-spam-exit-processor-spamoracle
24554 Add this symbol to a group's @code{spam-process} parameter by
24555 customizing the group parameter or the
24556 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
24557 to a group's @code{spam-process} parameter, spam-marked articles will be
24558 sent to SpamOracle as spam samples.
24562 Instead of the obsolete
24563 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
24564 that you use @code{(spam spam-use-spamoracle)}. Everything will work
24565 the same way, we promise.
24568 @defvar gnus-group-ham-exit-processor-spamoracle
24569 Add this symbol to a group's @code{spam-process} parameter by
24570 customizing the group parameter or the
24571 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
24572 to a group's @code{spam-process} parameter, the ham-marked articles in
24573 @emph{ham} groups will be sent to the SpamOracle as samples of ham
24578 Instead of the obsolete
24579 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
24580 that you use @code{(ham spam-use-spamoracle)}. Everything will work
24581 the same way, we promise.
24584 @emph{Example:} These are the Group Parameters of a group that has been
24585 classified as a ham group, meaning that it should only contain ham
24588 ((spam-contents gnus-group-spam-classification-ham)
24589 (spam-process ((ham spam-use-spamoracle)
24590 (spam spam-use-spamoracle))))
24592 For this group the @code{spam-use-spamoracle} is installed for both
24593 ham and spam processing. If the group contains spam message
24594 (e.g. because SpamOracle has not had enough sample messages yet) and
24595 the user marks some messages as spam messages, these messages will be
24596 processed by SpamOracle. The processor sends the messages to
24597 SpamOracle as new samples for spam.
24599 @node Extending the Spam ELisp package
24600 @subsubsection Extending the Spam ELisp package
24601 @cindex spam filtering
24602 @cindex spam elisp package, extending
24603 @cindex extending the spam elisp package
24605 Say you want to add a new back end called blackbox. For filtering
24606 incoming mail, provide the following:
24614 (defvar spam-use-blackbox nil
24615 "True if blackbox should be used.")
24618 Write @code{spam-check-blackbox} if Blackbox can check incoming mail.
24620 Write @code{spam-blackbox-register-routine} and
24621 @code{spam-blackbox-unregister-routine} using the bogofilter
24622 register/unregister routines as a start, or other restister/unregister
24623 routines more appropriate to Blackbox, if Blackbox can
24624 register/unregister spam and ham.
24629 The @code{spam-check-blackbox} function should return @samp{nil} or
24630 @code{spam-split-group}, observing the other conventions. See the
24631 existing @code{spam-check-*} functions for examples of what you can
24632 do, and stick to the template unless you fully understand the reasons
24637 For processing spam and ham messages, provide the following:
24644 Note you don't have to provide a spam or a ham processor. Only
24645 provide them if Blackbox supports spam or ham processing.
24647 Also, ham and spam processors are being phased out as single
24648 variables. Instead the form @code{(spam spam-use-blackbox)} or
24649 @code{(ham spam-use-blackbox)} is favored. For now, spam/ham
24650 processor variables are still around but they won't be for long.
24653 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
24654 "The Blackbox summary exit spam processor.
24655 Only applicable to spam groups.")
24657 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
24658 "The whitelist summary exit ham processor.
24659 Only applicable to non-spam (unclassified and ham) groups.")
24668 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
24669 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
24671 to the @code{spam-process} group parameter in @code{gnus.el}. Make
24672 sure you do it twice, once for the parameter and once for the
24673 variable customization.
24677 (variable-item spam-use-blackbox)
24679 to the @code{spam-autodetect-methods} group parameter in
24680 @code{gnus.el} if Blackbox can check incoming mail for spam contents.
24682 Finally, use the appropriate @code{spam-install-*-backend} function in
24683 @code{spam.el}. Here are the available functions.
24689 @code{spam-install-backend-alias}
24691 This function will simply install an alias for a back end that does
24692 everything like the original back end. It is currently only used to
24693 make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}.
24696 @code{spam-install-nocheck-backend}
24698 This function installs a back end that has no check function, but can
24699 register/unregister ham or spam. The @code{spam-use-gmane} back end is
24703 @code{spam-install-checkonly-backend}
24705 This function will install a back end that can only check incoming mail
24706 for spam contents. It can't register or unregister messages.
24707 @code{spam-use-blackholes} and @code{spam-use-hashcash} are such
24711 @code{spam-install-statistical-checkonly-backend}
24713 This function installs a statistical back end (one which requires the
24714 full body of a message to check it) that can only check incoming mail
24715 for contents. @code{spam-use-regex-body} is such a filter.
24718 @code{spam-install-statistical-backend}
24720 This function install a statistical back end with incoming checks and
24721 registration/unregistration routines. @code{spam-use-bogofilter} is
24725 @code{spam-install-backend}
24727 This is the most normal back end installation, where a back end that can
24728 check and register/unregister messages is set up without statistical
24729 abilities. The @code{spam-use-BBDB} is such a back end.
24732 @code{spam-install-mover-backend}
24734 Mover back ends are internal to @code{spam.el} and specifically move
24735 articles around when the summary is exited. You will very probably
24736 never install such a back end.
24742 @node Filtering Spam Using Statistics with spam-stat
24743 @subsection Filtering Spam Using Statistics with spam-stat
24744 @cindex Paul Graham
24745 @cindex Graham, Paul
24746 @cindex naive Bayesian spam filtering
24747 @cindex Bayesian spam filtering, naive
24748 @cindex spam filtering, naive Bayesian
24750 Paul Graham has written an excellent essay about spam filtering using
24751 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
24752 Spam}. In it he describes the inherent deficiency of rule-based
24753 filtering as used by SpamAssassin, for example: Somebody has to write
24754 the rules, and everybody else has to install these rules. You are
24755 always late. It would be much better, he argues, to filter mail based
24756 on whether it somehow resembles spam or non-spam. One way to measure
24757 this is word distribution. He then goes on to describe a solution
24758 that checks whether a new mail resembles any of your other spam mails
24761 The basic idea is this: Create a two collections of your mail, one
24762 with spam, one with non-spam. Count how often each word appears in
24763 either collection, weight this by the total number of mails in the
24764 collections, and store this information in a dictionary. For every
24765 word in a new mail, determine its probability to belong to a spam or a
24766 non-spam mail. Use the 15 most conspicuous words, compute the total
24767 probability of the mail being spam. If this probability is higher
24768 than a certain threshold, the mail is considered to be spam.
24770 Gnus supports this kind of filtering. But it needs some setting up.
24771 First, you need two collections of your mail, one with spam, one with
24772 non-spam. Then you need to create a dictionary using these two
24773 collections, and save it. And last but not least, you need to use
24774 this dictionary in your fancy mail splitting rules.
24777 * Creating a spam-stat dictionary::
24778 * Splitting mail using spam-stat::
24779 * Low-level interface to the spam-stat dictionary::
24782 @node Creating a spam-stat dictionary
24783 @subsubsection Creating a spam-stat dictionary
24785 Before you can begin to filter spam based on statistics, you must
24786 create these statistics based on two mail collections, one with spam,
24787 one with non-spam. These statistics are then stored in a dictionary
24788 for later use. In order for these statistics to be meaningful, you
24789 need several hundred emails in both collections.
24791 Gnus currently supports only the nnml back end for automated dictionary
24792 creation. The nnml back end stores all mails in a directory, one file
24793 per mail. Use the following:
24795 @defun spam-stat-process-spam-directory
24796 Create spam statistics for every file in this directory. Every file
24797 is treated as one spam mail.
24800 @defun spam-stat-process-non-spam-directory
24801 Create non-spam statistics for every file in this directory. Every
24802 file is treated as one non-spam mail.
24805 Usually you would call @code{spam-stat-process-spam-directory} on a
24806 directory such as @file{~/Mail/mail/spam} (this usually corresponds
24807 the the group @samp{nnml:mail.spam}), and you would call
24808 @code{spam-stat-process-non-spam-directory} on a directory such as
24809 @file{~/Mail/mail/misc} (this usually corresponds the the group
24810 @samp{nnml:mail.misc}).
24812 When you are using @acronym{IMAP}, you won't have the mails available
24813 locally, so that will not work. One solution is to use the Gnus Agent
24814 to cache the articles. Then you can use directories such as
24815 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
24816 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
24819 This variable holds the hash-table with all the statistics---the
24820 dictionary we have been talking about. For every word in either
24821 collection, this hash-table stores a vector describing how often the
24822 word appeared in spam and often it appeared in non-spam mails.
24825 If you want to regenerate the statistics from scratch, you need to
24826 reset the dictionary.
24828 @defun spam-stat-reset
24829 Reset the @code{spam-stat} hash-table, deleting all the statistics.
24832 When you are done, you must save the dictionary. The dictionary may
24833 be rather large. If you will not update the dictionary incrementally
24834 (instead, you will recreate it once a month, for example), then you
24835 can reduce the size of the dictionary by deleting all words that did
24836 not appear often enough or that do not clearly belong to only spam or
24837 only non-spam mails.
24839 @defun spam-stat-reduce-size
24840 Reduce the size of the dictionary. Use this only if you do not want
24841 to update the dictionary incrementally.
24844 @defun spam-stat-save
24845 Save the dictionary.
24848 @defvar spam-stat-file
24849 The filename used to store the dictionary. This defaults to
24850 @file{~/.spam-stat.el}.
24853 @node Splitting mail using spam-stat
24854 @subsubsection Splitting mail using spam-stat
24856 In order to use @code{spam-stat} to split your mail, you need to add the
24857 following to your @file{~/.gnus.el} file:
24860 (require 'spam-stat)
24864 This will load the necessary Gnus code, and the dictionary you
24867 Next, you need to adapt your fancy splitting rules: You need to
24868 determine how to use @code{spam-stat}. The following examples are for
24869 the nnml back end. Using the nnimap back end works just as well. Just
24870 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
24872 In the simplest case, you only have two groups, @samp{mail.misc} and
24873 @samp{mail.spam}. The following expression says that mail is either
24874 spam or it should go into @samp{mail.misc}. If it is spam, then
24875 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
24878 (setq nnmail-split-fancy
24879 `(| (: spam-stat-split-fancy)
24883 @defvar spam-stat-split-fancy-spam-group
24884 The group to use for spam. Default is @samp{mail.spam}.
24887 If you also filter mail with specific subjects into other groups, use
24888 the following expression. Only mails not matching the regular
24889 expression are considered potential spam.
24892 (setq nnmail-split-fancy
24893 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
24894 (: spam-stat-split-fancy)
24898 If you want to filter for spam first, then you must be careful when
24899 creating the dictionary. Note that @code{spam-stat-split-fancy} must
24900 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
24901 non-spam, therefore both should be in your collection of non-spam
24902 mails, when creating the dictionary!
24905 (setq nnmail-split-fancy
24906 `(| (: spam-stat-split-fancy)
24907 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24911 You can combine this with traditional filtering. Here, we move all
24912 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
24913 @code{spam-stat-split-fancy} will never see them, the mails in
24914 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
24915 nor in your collection of non-spam mails, when creating the
24919 (setq nnmail-split-fancy
24920 `(| ("Content-Type" "text/html" "mail.spam.filtered")
24921 (: spam-stat-split-fancy)
24922 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24927 @node Low-level interface to the spam-stat dictionary
24928 @subsubsection Low-level interface to the spam-stat dictionary
24930 The main interface to using @code{spam-stat}, are the following functions:
24932 @defun spam-stat-buffer-is-spam
24933 Called in a buffer, that buffer is considered to be a new spam mail.
24934 Use this for new mail that has not been processed before.
24937 @defun spam-stat-buffer-is-no-spam
24938 Called in a buffer, that buffer is considered to be a new non-spam
24939 mail. Use this for new mail that has not been processed before.
24942 @defun spam-stat-buffer-change-to-spam
24943 Called in a buffer, that buffer is no longer considered to be normal
24944 mail but spam. Use this to change the status of a mail that has
24945 already been processed as non-spam.
24948 @defun spam-stat-buffer-change-to-non-spam
24949 Called in a buffer, that buffer is no longer considered to be spam but
24950 normal mail. Use this to change the status of a mail that has already
24951 been processed as spam.
24954 @defun spam-stat-save
24955 Save the hash table to the file. The filename used is stored in the
24956 variable @code{spam-stat-file}.
24959 @defun spam-stat-load
24960 Load the hash table from a file. The filename used is stored in the
24961 variable @code{spam-stat-file}.
24964 @defun spam-stat-score-word
24965 Return the spam score for a word.
24968 @defun spam-stat-score-buffer
24969 Return the spam score for a buffer.
24972 @defun spam-stat-split-fancy
24973 Use this function for fancy mail splitting. Add the rule @samp{(:
24974 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
24977 Make sure you load the dictionary before using it. This requires the
24978 following in your @file{~/.gnus.el} file:
24981 (require 'spam-stat)
24985 Typical test will involve calls to the following functions:
24988 Reset: (setq spam-stat (make-hash-table :test 'equal))
24989 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24990 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24991 Save table: (spam-stat-save)
24992 File size: (nth 7 (file-attributes spam-stat-file))
24993 Number of words: (hash-table-count spam-stat)
24994 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24995 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24996 Reduce table size: (spam-stat-reduce-size)
24997 Save table: (spam-stat-save)
24998 File size: (nth 7 (file-attributes spam-stat-file))
24999 Number of words: (hash-table-count spam-stat)
25000 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25001 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25004 Here is how you would create your dictionary:
25007 Reset: (setq spam-stat (make-hash-table :test 'equal))
25008 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25009 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25010 Repeat for any other non-spam group you need...
25011 Reduce table size: (spam-stat-reduce-size)
25012 Save table: (spam-stat-save)
25016 @section Interaction with other modes
25021 @code{gnus-dired-minor-mode} provided some useful functions for dired
25022 buffers. It is enabled with
25024 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
25029 @findex gnus-dired-attach
25030 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
25031 You will be prompted for a message buffer.
25034 @findex gnus-dired-find-file-mailcap
25035 Visit a file according to the appropriate mailcap entry
25036 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
25040 @findex gnus-dired-print
25041 Print file according to the mailcap entry (@code{gnus-dired-print}). If
25042 there is no print command, print in a PostScript image.
25045 @node Various Various
25046 @section Various Various
25052 @item gnus-home-directory
25053 @vindex gnus-home-directory
25054 All Gnus file and directory variables will be initialized from this
25055 variable, which defaults to @file{~/}.
25057 @item gnus-directory
25058 @vindex gnus-directory
25059 Most Gnus storage file and directory variables will be initialized from
25060 this variable, which defaults to the @env{SAVEDIR} environment
25061 variable, or @file{~/News/} if that variable isn't set.
25063 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
25064 This means that other directory variables that are initialized from this
25065 variable won't be set properly if you set this variable in
25066 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
25068 @item gnus-default-directory
25069 @vindex gnus-default-directory
25070 Not related to the above variable at all---this variable says what the
25071 default directory of all Gnus buffers should be. If you issue commands
25072 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
25073 default directory. If this variable is @code{nil} (which is the
25074 default), the default directory will be the default directory of the
25075 buffer you were in when you started Gnus.
25078 @vindex gnus-verbose
25079 This variable is an integer between zero and ten. The higher the value,
25080 the more messages will be displayed. If this variable is zero, Gnus
25081 will never flash any messages, if it is seven (which is the default),
25082 most important messages will be shown, and if it is ten, Gnus won't ever
25083 shut up, but will flash so many messages it will make your head swim.
25085 @item gnus-verbose-backends
25086 @vindex gnus-verbose-backends
25087 This variable works the same way as @code{gnus-verbose}, but it applies
25088 to the Gnus back ends instead of Gnus proper.
25090 @item nnheader-max-head-length
25091 @vindex nnheader-max-head-length
25092 When the back ends read straight heads of articles, they all try to read
25093 as little as possible. This variable (default 8192) specifies
25094 the absolute max length the back ends will try to read before giving up
25095 on finding a separator line between the head and the body. If this
25096 variable is @code{nil}, there is no upper read bound. If it is
25097 @code{t}, the back ends won't try to read the articles piece by piece,
25098 but read the entire articles. This makes sense with some versions of
25099 @code{ange-ftp} or @code{efs}.
25101 @item nnheader-head-chop-length
25102 @vindex nnheader-head-chop-length
25103 This variable (default 2048) says how big a piece of each article to
25104 read when doing the operation described above.
25106 @item nnheader-file-name-translation-alist
25107 @vindex nnheader-file-name-translation-alist
25109 @cindex invalid characters in file names
25110 @cindex characters in file names
25111 This is an alist that says how to translate characters in file names.
25112 For instance, if @samp{:} is invalid as a file character in file names
25113 on your system (you OS/2 user you), you could say something like:
25117 (setq nnheader-file-name-translation-alist
25122 In fact, this is the default value for this variable on OS/2 and MS
25123 Windows (phooey) systems.
25125 @item gnus-hidden-properties
25126 @vindex gnus-hidden-properties
25127 This is a list of properties to use to hide ``invisible'' text. It is
25128 @code{(invisible t intangible t)} by default on most systems, which
25129 makes invisible text invisible and intangible.
25131 @item gnus-parse-headers-hook
25132 @vindex gnus-parse-headers-hook
25133 A hook called before parsing headers. It can be used, for instance, to
25134 gather statistics on the headers fetched, or perhaps you'd like to prune
25135 some headers. I don't see why you'd want that, though.
25137 @item gnus-shell-command-separator
25138 @vindex gnus-shell-command-separator
25139 String used to separate two shell commands. The default is @samp{;}.
25141 @item gnus-invalid-group-regexp
25142 @vindex gnus-invalid-group-regexp
25144 Regexp to match ``invalid'' group names when querying user for a group
25145 name. The default value catches some @strong{really} invalid group
25146 names who could possibly mess up Gnus internally (like allowing
25147 @samp{:} in a group name, which is normally used to delimit method and
25150 @acronym{IMAP} users might want to allow @samp{/} in group names though.
25158 Well, that's the manual---you can get on with your life now. Keep in
25159 touch. Say hello to your cats from me.
25161 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
25163 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
25169 Not because of victories @*
25172 but for the common sunshine,@*
25174 the largess of the spring.
25178 but for the day's work done@*
25179 as well as I was able;@*
25180 not for a seat upon the dais@*
25181 but at the common table.@*
25186 @chapter Appendices
25189 * XEmacs:: Requirements for installing under XEmacs.
25190 * History:: How Gnus got where it is today.
25191 * On Writing Manuals:: Why this is not a beginner's guide.
25192 * Terminology:: We use really difficult, like, words here.
25193 * Customization:: Tailoring Gnus to your needs.
25194 * Troubleshooting:: What you might try if things do not work.
25195 * Gnus Reference Guide:: Rilly, rilly technical stuff.
25196 * Emacs for Heathens:: A short introduction to Emacsian terms.
25197 * Frequently Asked Questions:: The Gnus FAQ
25204 @cindex installing under XEmacs
25206 XEmacs is distributed as a collection of packages. You should install
25207 whatever packages the Gnus XEmacs package requires. The current
25208 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
25209 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
25210 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{W3},
25211 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
25218 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
25219 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
25221 If you want to investigate the person responsible for this outrage,
25222 you can point your (feh!) web browser to
25223 @uref{http://quimby.gnus.org/}. This is also the primary
25224 distribution point for the new and spiffy versions of Gnus, and is
25225 known as The Site That Destroys Newsrcs And Drives People Mad.
25227 During the first extended alpha period of development, the new Gnus was
25228 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
25229 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
25230 (Besides, the ``Gnus'' in this abbreviation should probably be
25231 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
25232 appropriate name, don't you think?)
25234 In any case, after spending all that energy on coming up with a new and
25235 spunky name, we decided that the name was @emph{too} spunky, so we
25236 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
25237 ``@sc{gnus}''. New vs. old.
25240 * Gnus Versions:: What Gnus versions have been released.
25241 * Other Gnus Versions:: Other Gnus versions that also have been released.
25242 * Why?:: What's the point of Gnus?
25243 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
25244 * Conformity:: Gnus tries to conform to all standards.
25245 * Emacsen:: Gnus can be run on a few modern Emacsen.
25246 * Gnus Development:: How Gnus is developed.
25247 * Contributors:: Oodles of people.
25248 * New Features:: Pointers to some of the new stuff in Gnus.
25252 @node Gnus Versions
25253 @subsection Gnus Versions
25255 @cindex September Gnus
25257 @cindex Quassia Gnus
25258 @cindex Pterodactyl Gnus
25261 @cindex Gnus versions
25263 The first ``proper'' release of Gnus 5 was done in November 1995 when it
25264 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
25265 plus 15 Gnus 5.0 releases).
25267 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
25268 releases)) was released under the name ``Gnus 5.2'' (40 releases).
25270 On July 28th 1996 work on Red Gnus was begun, and it was released on
25271 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
25273 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
25274 It was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
25276 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
25277 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
25280 On the 26th of October 2000, Oort Gnus was begun and was released as
25281 Gnus 5.10 on May 1st 2003 (24 releases).
25283 On the January 4th 2004, No Gnus was begun.
25285 If you happen upon a version of Gnus that has a prefixed name --
25286 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
25287 ``Pterodactyl Gnus'', ``Oort Gnus'', ``No Gnus'' -- don't panic.
25288 Don't let it know that you're frightened. Back away. Slowly. Whatever
25289 you do, don't run. Walk away, calmly, until you're out of its reach.
25290 Find a proper released version of Gnus and snuggle up to that instead.
25293 @node Other Gnus Versions
25294 @subsection Other Gnus Versions
25297 In addition to the versions of Gnus which have had their releases
25298 coordinated by Lars, one major development has been Semi-gnus from
25299 Japan. It's based on a library called @acronym{SEMI}, which provides
25300 @acronym{MIME} capabilities.
25302 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
25303 Collectively, they are called ``Semi-gnus'', and different strains are
25304 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
25305 @acronym{MIME} and multilingualization things, especially important for
25312 What's the point of Gnus?
25314 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
25315 newsreader, that lets you do anything you can think of. That was my
25316 original motivation, but while working on Gnus, it has become clear to
25317 me that this generation of newsreaders really belong in the stone age.
25318 Newsreaders haven't developed much since the infancy of the net. If the
25319 volume continues to rise with the current rate of increase, all current
25320 newsreaders will be pretty much useless. How do you deal with
25321 newsgroups that have thousands of new articles each day? How do you
25322 keep track of millions of people who post?
25324 Gnus offers no real solutions to these questions, but I would very much
25325 like to see Gnus being used as a testing ground for new methods of
25326 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
25327 to separate the newsreader from the back ends, Gnus now offers a simple
25328 interface for anybody who wants to write new back ends for fetching mail
25329 and news from different sources. I have added hooks for customizations
25330 everywhere I could imagine it being useful. By doing so, I'm inviting
25331 every one of you to explore and invent.
25333 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
25334 @kbd{C-u 100 M-x all-hail-xemacs}.
25337 @node Compatibility
25338 @subsection Compatibility
25340 @cindex compatibility
25341 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
25342 bindings have been kept. More key bindings have been added, of course,
25343 but only in one or two obscure cases have old bindings been changed.
25348 @center In a cloud bones of steel.
25352 All commands have kept their names. Some internal functions have changed
25355 The @code{gnus-uu} package has changed drastically. @xref{Decoding
25358 One major compatibility question is the presence of several summary
25359 buffers. All variables relevant while reading a group are
25360 buffer-local to the summary buffer they belong in. Although many
25361 important variables have their values copied into their global
25362 counterparts whenever a command is executed in the summary buffer, this
25363 change might lead to incorrect values being used unless you are careful.
25365 All code that relies on knowledge of @sc{gnus} internals will probably
25366 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
25367 changing it in any way, as a matter of fact) is strictly verboten. Gnus
25368 maintains a hash table that points to the entries in this alist (which
25369 speeds up many functions), and changing the alist directly will lead to
25373 @cindex highlighting
25374 Old hilit19 code does not work at all. In fact, you should probably
25375 remove all hilit code from all Gnus hooks
25376 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
25377 Gnus provides various integrated functions for highlighting. These are
25378 faster and more accurate. To make life easier for everybody, Gnus will
25379 by default remove all hilit calls from all hilit hooks. Uncleanliness!
25382 Packages like @code{expire-kill} will no longer work. As a matter of
25383 fact, you should probably remove all old @sc{gnus} packages (and other
25384 code) when you start using Gnus. More likely than not, Gnus already
25385 does what you have written code to make @sc{gnus} do. (Snicker.)
25387 Even though old methods of doing things are still supported, only the
25388 new methods are documented in this manual. If you detect a new method of
25389 doing something while reading this manual, that does not mean you have
25390 to stop doing it the old way.
25392 Gnus understands all @sc{gnus} startup files.
25394 @kindex M-x gnus-bug
25396 @cindex reporting bugs
25398 Overall, a casual user who hasn't written much code that depends on
25399 @sc{gnus} internals should suffer no problems. If problems occur,
25400 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
25402 @vindex gnus-bug-create-help-buffer
25403 If you are in the habit of sending bug reports @emph{very} often, you
25404 may find the helpful help buffer annoying after a while. If so, set
25405 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
25410 @subsection Conformity
25412 No rebels without a clue here, ma'am. We conform to all standards known
25413 to (wo)man. Except for those standards and/or conventions we disagree
25421 There are no known breaches of this standard.
25425 There are no known breaches of this standard, either.
25427 @item Son-of-RFC 1036
25428 @cindex Son-of-RFC 1036
25429 We do have some breaches to this one.
25435 These are considered to be ``vanity headers'', while I consider them
25436 to be consumer information. After seeing so many badly formatted
25437 articles coming from @code{tin} and @code{Netscape} I know not to use
25438 either of those for posting articles. I would not have known that if
25439 it wasn't for the @code{X-Newsreader} header.
25444 USEFOR is an IETF working group writing a successor to RFC 1036, based
25445 on Son-of-RFC 1036. They have produced a number of drafts proposing
25446 various changes to the format of news articles. The Gnus towers will
25447 look into implementing the changes when the draft is accepted as an RFC.
25449 @item MIME - RFC 2045-2049 etc
25450 @cindex @acronym{MIME}
25451 All the various @acronym{MIME} RFCs are supported.
25453 @item Disposition Notifications - RFC 2298
25454 Message Mode is able to request notifications from the receiver.
25456 @item PGP - RFC 1991 and RFC 2440
25459 RFC 1991 is the original @acronym{PGP} message specification,
25460 published as an informational RFC. RFC 2440 was the follow-up, now
25461 called Open PGP, and put on the Standards Track. Both document a
25462 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
25463 encoding (signing and encryption) and decoding (verification and
25466 @item PGP/MIME - RFC 2015/3156
25467 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
25468 1991) describes the @acronym{MIME}-wrapping around the RFC 1991/2440 format.
25469 Gnus supports both encoding and decoding.
25471 @item S/MIME - RFC 2633
25472 RFC 2633 describes the @acronym{S/MIME} format.
25474 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
25475 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
25476 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
25477 authentication for @acronym{IMAP}. RFC 2086 describes access control
25478 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
25479 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
25480 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
25481 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
25485 If you ever notice Gnus acting non-compliant with regards to the texts
25486 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
25491 @subsection Emacsen
25497 Gnus should work on:
25505 XEmacs 21.4 and up.
25509 This Gnus version will absolutely not work on any Emacsen older than
25510 that. Not reliably, at least. Older versions of Gnus may work on older
25511 Emacs versions. However, T-gnus does support ``Mule 2.3 based on Emacs
25512 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
25513 See the file ``README'' in the T-gnus distribution for more details.
25515 There are some vague differences between Gnus on the various
25516 platforms---XEmacs features more graphics (a logo and a toolbar)---but
25517 other than that, things should look pretty much the same under all
25521 @node Gnus Development
25522 @subsection Gnus Development
25524 Gnus is developed in a two-phased cycle. The first phase involves much
25525 discussion on the @samp{ding@@gnus.org} mailing list, where people
25526 propose changes and new features, post patches and new back ends. This
25527 phase is called the @dfn{alpha} phase, since the Gnusae released in this
25528 phase are @dfn{alpha releases}, or (perhaps more commonly in other
25529 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
25530 unstable and should not be used by casual users. Gnus alpha releases
25531 have names like ``Red Gnus'' and ``Quassia Gnus''.
25533 After futzing around for 50-100 alpha releases, Gnus is declared
25534 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
25535 and is called things like ``Gnus 5.6.32'' instead. Normal people are
25536 supposed to be able to use these, and these are mostly discussed on the
25537 @samp{gnu.emacs.gnus} newsgroup.
25540 @vindex mail-source-delete-incoming
25541 Some variable defaults differ between alpha Gnusae and released Gnusae.
25542 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
25543 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
25544 lossage of mail if an alpha release hiccups while handling the mail.
25546 The division of discussion between the ding mailing list and the Gnus
25547 newsgroup is not purely based on publicity concerns. It's true that
25548 having people write about the horrible things that an alpha Gnus release
25549 can do (sometimes) in a public forum may scare people off, but more
25550 importantly, talking about new experimental features that have been
25551 introduced may confuse casual users. New features are frequently
25552 introduced, fiddled with, and judged to be found wanting, and then
25553 either discarded or totally rewritten. People reading the mailing list
25554 usually keep up with these rapid changes, while people on the newsgroup
25555 can't be assumed to do so.
25560 @subsection Contributors
25561 @cindex contributors
25563 The new Gnus version couldn't have been done without the help of all the
25564 people on the (ding) mailing list. Every day for over a year I have
25565 gotten billions of nice bug reports from them, filling me with joy,
25566 every single one of them. Smooches. The people on the list have been
25567 tried beyond endurance, what with my ``oh, that's a neat idea <type
25568 type>, yup, I'll release it right away <ship off> no wait, that doesn't
25569 work at all <type type>, yup, I'll ship that one off right away <ship
25570 off> no, wait, that absolutely does not work'' policy for releases.
25571 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
25572 ``worser''? ``much worser''? ``worsest''?)
25574 I would like to take this opportunity to thank the Academy for@dots{} oops,
25580 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
25583 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
25584 nnwarchive and many, many other things connected with @acronym{MIME} and
25585 other types of en/decoding, as well as general bug fixing, new
25586 functionality and stuff.
25589 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
25590 well as numerous other things).
25593 Luis Fernandes---design and graphics.
25596 Joe Reiss---creator of the smiley faces.
25599 Justin Sheehy---the @acronym{FAQ} maintainer.
25602 Erik Naggum---help, ideas, support, code and stuff.
25605 Wes Hardaker---@file{gnus-picon.el} and the manual section on
25606 @dfn{picons} (@pxref{Picons}).
25609 Kim-Minh Kaplan---further work on the picon code.
25612 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
25615 Sudish Joseph---innumerable bug fixes.
25618 Ilja Weis---@file{gnus-topic.el}.
25621 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
25624 Vladimir Alexiev---the refcard and reference booklets.
25627 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
25628 distribution by Felix Lee and JWZ.
25631 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
25634 Peter Mutsaers---orphan article scoring code.
25637 Ken Raeburn---POP mail support.
25640 Hallvard B Furuseth---various bits and pieces, especially dealing with
25644 Brian Edmonds---@file{gnus-bbdb.el}.
25647 David Moore---rewrite of @file{nnvirtual.el} and many other things.
25650 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
25653 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
25654 well as autoconf support.
25658 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
25659 Borges, and Jost Krieger proof-reading parts of the manual.
25661 The following people have contributed many patches and suggestions:
25676 Jason L. Tibbitts, III,
25678 Katsumi Yamaoka, @c Yamaoka
25682 Also thanks to the following for patches and stuff:
25692 Alexei V. Barantsev,
25707 Massimo Campostrini,
25712 Jae-you Chung, @c ?
25713 James H. Cloos, Jr.,
25717 Andrew J. Cosgriff,
25720 Geoffrey T. Dairiki,
25726 Michael Welsh Duggan,
25731 Enami Tsugutomo, @c Enami
25735 Nelson Jose dos Santos Ferreira,
25743 Arne Georg Gleditsch,
25745 Michelangelo Grigni,
25749 Kenichi Handa, @c Handa
25751 Yoshiki Hayashi, @c Hayashi
25753 Hisashige Kenji, @c Hisashige
25760 Fran@,{c}ois Felix Ingrand,
25761 Tatsuya Ichikawa, @c Ichikawa
25762 Ishikawa Ichiro, @c Ishikawa
25764 Iwamuro Motonori, @c Iwamuro
25774 Peter Skov Knudsen,
25775 Shuhei Kobayashi, @c Kobayashi
25777 Koseki Yoshinori, @c Koseki
25778 Thor Kristoffersen,
25781 Seokchan Lee, @c Lee
25799 Morioka Tomohiko, @c Morioka
25800 Erik Toubro Nielsen,
25807 Masaharu Onishi, @c Onishi
25812 Jens-Ulrik Holger Petersen,
25816 John McClary Prevost,
25822 Lars Balker Rasmussen,
25827 Christian von Roques,
25830 Wolfgang Rupprecht,
25837 Philippe Schnoebelen,
25839 Randal L. Schwartz,
25853 Kiyokazu Suto, @c Suto
25858 Tozawa Akihiko, @c Tozawa
25878 For a full overview of what each person has done, the ChangeLogs
25879 included in the Gnus alpha distributions should give ample reading
25880 (550kB and counting).
25882 Apologies to everybody that I've forgotten, of which there are many, I'm
25885 Gee, that's quite a list of people. I guess that must mean that there
25886 actually are people who are using Gnus. Who'd'a thunk it!
25890 @subsection New Features
25891 @cindex new features
25894 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
25895 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
25896 * Red Gnus:: Third time best---Gnus 5.4/5.5.
25897 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
25898 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
25899 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
25900 * No Gnus:: Very punny.
25903 These lists are, of course, just @emph{short} overviews of the
25904 @emph{most} important new features. No, really. There are tons more.
25905 Yes, we have feeping creaturism in full effect.
25908 @subsubsection (ding) Gnus
25910 New features in Gnus 5.0/5.1:
25915 The look of all buffers can be changed by setting format-like variables
25916 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
25919 Local spool and several @acronym{NNTP} servers can be used at once
25920 (@pxref{Select Methods}).
25923 You can combine groups into virtual groups (@pxref{Virtual Groups}).
25926 You can read a number of different mail formats (@pxref{Getting Mail}).
25927 All the mail back ends implement a convenient mail expiry scheme
25928 (@pxref{Expiring Mail}).
25931 Gnus can use various strategies for gathering threads that have lost
25932 their roots (thereby gathering loose sub-threads into one thread) or it
25933 can go back and retrieve enough headers to build a complete thread
25934 (@pxref{Customizing Threading}).
25937 Killed groups can be displayed in the group buffer, and you can read
25938 them as well (@pxref{Listing Groups}).
25941 Gnus can do partial group updates---you do not have to retrieve the
25942 entire active file just to check for new articles in a few groups
25943 (@pxref{The Active File}).
25946 Gnus implements a sliding scale of subscribedness to groups
25947 (@pxref{Group Levels}).
25950 You can score articles according to any number of criteria
25951 (@pxref{Scoring}). You can even get Gnus to find out how to score
25952 articles for you (@pxref{Adaptive Scoring}).
25955 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
25956 manner, so it should be difficult to lose much data on what you have
25957 read if your machine should go down (@pxref{Auto Save}).
25960 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
25961 cluttering up the @file{.emacs} file.
25964 You can set the process mark on both groups and articles and perform
25965 operations on all the marked items (@pxref{Process/Prefix}).
25968 You can grep through a subset of groups and create a group from the
25969 results (@pxref{Kibozed Groups}).
25972 You can list subsets of groups according to, well, anything
25973 (@pxref{Listing Groups}).
25976 You can browse foreign servers and subscribe to groups from those
25977 servers (@pxref{Browse Foreign Server}).
25980 Gnus can fetch articles, asynchronously, on a second connection to the
25981 server (@pxref{Asynchronous Fetching}).
25984 You can cache articles locally (@pxref{Article Caching}).
25987 The uudecode functions have been expanded and generalized
25988 (@pxref{Decoding Articles}).
25991 You can still post uuencoded articles, which was a little-known feature
25992 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
25995 Fetching parents (and other articles) now actually works without
25996 glitches (@pxref{Finding the Parent}).
25999 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
26002 Digests (and other files) can be used as the basis for groups
26003 (@pxref{Document Groups}).
26006 Articles can be highlighted and customized (@pxref{Customizing
26010 URLs and other external references can be buttonized (@pxref{Article
26014 You can do lots of strange stuff with the Gnus window & frame
26015 configuration (@pxref{Window Layout}).
26018 You can click on buttons instead of using the keyboard
26024 @node September Gnus
26025 @subsubsection September Gnus
26029 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
26033 New features in Gnus 5.2/5.3:
26038 A new message composition mode is used. All old customization variables
26039 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
26043 Gnus is now able to generate @dfn{sparse} threads---threads where
26044 missing articles are represented by empty nodes (@pxref{Customizing
26048 (setq gnus-build-sparse-threads 'some)
26052 Outgoing articles are stored on a special archive server
26053 (@pxref{Archived Messages}).
26056 Partial thread regeneration now happens when articles are
26060 Gnus can make use of GroupLens predictions.
26063 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
26066 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
26069 (setq gnus-use-trees t)
26073 An @code{nn}-like pick-and-read minor mode is available for the summary
26074 buffers (@pxref{Pick and Read}).
26077 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
26081 In binary groups you can use a special binary minor mode (@pxref{Binary
26085 Groups can be grouped in a folding topic hierarchy (@pxref{Group
26089 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
26093 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
26096 Groups can now have a score, and bubbling based on entry frequency
26097 is possible (@pxref{Group Score}).
26100 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
26104 Groups can be process-marked, and commands can be performed on
26105 groups of groups (@pxref{Marking Groups}).
26108 Caching is possible in virtual groups.
26111 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
26112 news batches, ClariNet briefs collections, and just about everything
26113 else (@pxref{Document Groups}).
26116 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
26120 The Gnus cache is much faster.
26123 Groups can be sorted according to many criteria (@pxref{Sorting
26127 New group parameters have been introduced to set list-addresses and
26128 expiry times (@pxref{Group Parameters}).
26131 All formatting specs allow specifying faces to be used
26132 (@pxref{Formatting Fonts}).
26135 There are several more commands for setting/removing/acting on process
26136 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
26139 The summary buffer can be limited to show parts of the available
26140 articles based on a wide range of criteria. These commands have been
26141 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
26144 Articles can be made persistent with the @kbd{*} command
26145 (@pxref{Persistent Articles}).
26148 All functions for hiding article elements are now toggles.
26151 Article headers can be buttonized (@pxref{Article Washing}).
26154 All mail back ends support fetching articles by @code{Message-ID}.
26157 Duplicate mail can now be treated properly (@pxref{Duplicates}).
26160 All summary mode commands are available directly from the article
26161 buffer (@pxref{Article Keymap}).
26164 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
26168 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
26171 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
26176 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
26179 (setq gnus-use-nocem t)
26183 Groups can be made permanently visible (@pxref{Listing Groups}).
26186 (setq gnus-permanently-visible-groups "^nnml:")
26190 Many new hooks have been introduced to make customizing easier.
26193 Gnus respects the @code{Mail-Copies-To} header.
26196 Threads can be gathered by looking at the @code{References} header
26197 (@pxref{Customizing Threading}).
26200 (setq gnus-summary-thread-gathering-function
26201 'gnus-gather-threads-by-references)
26205 Read articles can be stored in a special backlog buffer to avoid
26206 refetching (@pxref{Article Backlog}).
26209 (setq gnus-keep-backlog 50)
26213 A clean copy of the current article is always stored in a separate
26214 buffer to allow easier treatment.
26217 Gnus can suggest where to save articles (@pxref{Saving Articles}).
26220 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
26224 (setq gnus-prompt-before-saving t)
26228 @code{gnus-uu} can view decoded files asynchronously while fetching
26229 articles (@pxref{Other Decode Variables}).
26232 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
26236 Filling in the article buffer now works properly on cited text
26237 (@pxref{Article Washing}).
26240 Hiding cited text adds buttons to toggle hiding, and how much
26241 cited text to hide is now customizable (@pxref{Article Hiding}).
26244 (setq gnus-cited-lines-visible 2)
26248 Boring headers can be hidden (@pxref{Article Hiding}).
26251 Default scoring values can now be set from the menu bar.
26254 Further syntax checking of outgoing articles have been added.
26260 @subsubsection Red Gnus
26262 New features in Gnus 5.4/5.5:
26266 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
26273 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
26276 Article prefetching functionality has been moved up into
26277 Gnus (@pxref{Asynchronous Fetching}).
26280 Scoring can now be performed with logical operators like @code{and},
26281 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
26285 Article washing status can be displayed in the
26286 article mode line (@pxref{Misc Article}).
26289 @file{gnus.el} has been split into many smaller files.
26292 Suppression of duplicate articles based on Message-ID can be done
26293 (@pxref{Duplicate Suppression}).
26296 (setq gnus-suppress-duplicates t)
26300 New variables for specifying what score and adapt files are to be
26301 considered home score and adapt files (@pxref{Home Score File}) have
26305 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
26306 Server Internals}).
26309 Groups can inherit group parameters from parent topics (@pxref{Topic
26313 Article editing has been revamped and is now actually usable.
26316 Signatures can be recognized in more intelligent fashions
26317 (@pxref{Article Signature}).
26320 Summary pick mode has been made to look more @code{nn}-like. Line
26321 numbers are displayed and the @kbd{.} command can be used to pick
26322 articles (@code{Pick and Read}).
26325 Commands for moving the @file{.newsrc.eld} from one server to
26326 another have been added (@pxref{Changing Servers}).
26329 There's a way now to specify that ``uninteresting'' fields be suppressed
26330 when generating lines in buffers (@pxref{Advanced Formatting}).
26333 Several commands in the group buffer can be undone with @kbd{C-M-_}
26337 Scoring can be done on words using the new score type @code{w}
26338 (@pxref{Score File Format}).
26341 Adaptive scoring can be done on a Subject word-by-word basis
26342 (@pxref{Adaptive Scoring}).
26345 (setq gnus-use-adaptive-scoring '(word))
26349 Scores can be decayed (@pxref{Score Decays}).
26352 (setq gnus-decay-scores t)
26356 Scoring can be performed using a regexp on the Date header. The Date is
26357 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
26360 A new command has been added to remove all data on articles from
26361 the native server (@pxref{Changing Servers}).
26364 A new command for reading collections of documents
26365 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
26366 (@pxref{Really Various Summary Commands}).
26369 Process mark sets can be pushed and popped (@pxref{Setting Process
26373 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
26374 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
26377 A new back end for reading searches from Web search engines
26378 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
26379 (@pxref{Web Searches}).
26382 Groups inside topics can now be sorted using the standard sorting
26383 functions, and each topic can be sorted independently (@pxref{Topic
26387 Subsets of the groups can be sorted independently (@code{Sorting
26391 Cached articles can be pulled into the groups (@pxref{Summary Generation
26395 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
26400 Score files are now applied in a more reliable order (@pxref{Score
26404 Reports on where mail messages end up can be generated (@pxref{Splitting
26408 More hooks and functions have been added to remove junk from incoming
26409 mail before saving the mail (@pxref{Washing Mail}).
26412 Emphasized text can be properly fontisized:
26418 @subsubsection Quassia Gnus
26420 New features in Gnus 5.6:
26425 New functionality for using Gnus as an offline newsreader has been
26426 added. A plethora of new commands and modes have been added.
26427 @xref{Gnus Unplugged}, for the full story.
26430 The @code{nndraft} back end has returned, but works differently than
26431 before. All Message buffers are now also articles in the @code{nndraft}
26432 group, which is created automatically.
26435 @code{gnus-alter-header-function} can now be used to alter header
26439 @code{gnus-summary-goto-article} now accept Message-ID's.
26442 A new Message command for deleting text in the body of a message
26443 outside the region: @kbd{C-c C-v}.
26446 You can now post to component group in @code{nnvirtual} groups with
26450 @code{nntp-rlogin-program}---new variable to ease customization.
26453 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
26454 re-highlighting of the article buffer.
26457 New element in @code{gnus-boring-article-headers}---@code{long-to}.
26460 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
26464 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
26465 @kbd{a} to add the score rule to the @file{all.SCORE} file.
26468 @code{gnus-simplify-subject-functions} variable to allow greater
26469 control over simplification.
26472 @kbd{A T}---new command for fetching the current thread.
26475 @kbd{/ T}---new command for including the current thread in the
26479 @kbd{M-RET} is a new Message command for breaking cited text.
26482 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
26485 The @code{custom-face-lookup} function has been removed.
26486 If you used this function in your initialization files, you must
26487 rewrite them to use @code{face-spec-set} instead.
26490 Canceling now uses the current select method. Symbolic prefix
26491 @kbd{a} forces normal posting method.
26494 New command to translate M******** sm*rtq**t*s into proper
26498 For easier debugging of @code{nntp}, you can set
26499 @code{nntp-record-commands} to a non-@code{nil} value.
26502 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
26503 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
26506 A command for editing group parameters from the summary buffer
26510 A history of where mails have been split is available.
26513 A new article date command has been added---@code{article-date-iso8601}.
26516 Subjects can be simplified when threading by setting
26517 @code{gnus-score-thread-simplify}.
26520 A new function for citing in Message has been
26521 added---@code{message-cite-original-without-signature}.
26524 @code{article-strip-all-blank-lines}---new article command.
26527 A new Message command to kill to the end of the article has
26531 A minimum adaptive score can be specified by using the
26532 @code{gnus-adaptive-word-minimum} variable.
26535 The ``lapsed date'' article header can be kept continually
26536 updated by the @code{gnus-start-date-timer} command.
26539 Web listserv archives can be read with the @code{nnlistserv} back end.
26542 Old dejanews archives can now be read by @code{nnweb}.
26546 @node Pterodactyl Gnus
26547 @subsubsection Pterodactyl Gnus
26549 New features in Gnus 5.8:
26554 The mail-fetching functions have changed. See the manual for the
26555 many details. In particular, all procmail fetching variables are gone.
26557 If you used procmail like in
26560 (setq nnmail-use-procmail t)
26561 (setq nnmail-spool-file 'procmail)
26562 (setq nnmail-procmail-directory "~/mail/incoming/")
26563 (setq nnmail-procmail-suffix "\\.in")
26566 this now has changed to
26570 '((directory :path "~/mail/incoming/"
26574 @xref{Mail Source Specifiers}.
26577 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
26578 Gnus, and adds a slew of new commands. See the manual for details.
26581 Gnus has also been multilingualized. This also affects too
26582 many parts of Gnus to summarize here, and adds many new variables.
26585 @code{gnus-auto-select-first} can now be a function to be
26586 called to position point.
26589 The user can now decide which extra headers should be included in
26590 summary buffers and @acronym{NOV} files.
26593 @code{gnus-article-display-hook} has been removed. Instead, a number
26594 of variables starting with @code{gnus-treat-} have been added.
26597 The Gnus posting styles have been redone again and now works in a
26598 subtly different manner.
26601 New web-based back ends have been added: @code{nnslashdot},
26602 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
26603 again, to keep up with ever-changing layouts.
26606 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
26611 @subsubsection Oort Gnus
26614 New features in Gnus 5.10:
26619 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
26620 (@code{gnus-article-reply-with-original}) only yank the text in the
26621 region if the region is active.
26624 @code{gnus-group-read-ephemeral-group} can be called interactively,
26628 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
26629 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
26632 The revised Gnus @acronym{FAQ} is included in the manual,
26633 @xref{Frequently Asked Questions}.
26636 Upgrading from previous (stable) version if you have used Oort.
26638 If you have tried Oort (the unstable Gnus branch leading to this
26639 release) but went back to a stable version, be careful when upgrading to
26640 this version. In particular, you will probably want to remove all
26641 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
26642 read from your @file{.newsrc.eld} instead of from the
26643 @file{.marks}/@file{.mrk} file where this release store flags. See a
26644 later entry for more information about marks. Note that downgrading
26645 isn't save in general.
26650 More buttons for URLs, mail addresses, Message-IDs, Info links, man
26651 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
26652 variables @code{gnus-button-@var{*}-level} can be used to control the
26653 appearance of all article buttons. @xref{Article Button Levels}.
26658 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
26659 bindings in dired buffers to send a file as an attachment, open a file
26660 using the appropriate mailcap entry, and print a file using the mailcap
26664 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
26667 Single-part yenc encoded attachments can be decoded.
26672 The picons code has been reimplemented to work in GNU Emacs---some of
26673 the previous options have been removed or renamed.
26675 Picons are small ``personal icons'' representing users, domain and
26676 newsgroups, which can be displayed in the Article buffer.
26680 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
26681 boundary line is drawn at the end of the headers.
26684 Retrieval of charters and control messages
26686 There are new commands for fetching newsgroup charters (@kbd{H c}) and
26687 control messages (@kbd{H C}).
26692 You can delay the sending of a message with @kbd{C-c C-j} in the Message
26693 buffer. The messages are delivered at specified time. This is useful
26694 for sending yourself reminders. @xref{Delayed Articles}.
26697 If @code{auto-compression-mode} is enabled, attachments are automatically
26698 decompressed when activated.
26701 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
26702 the nnml back end allows compressed message files.
26705 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
26708 The Summary Buffer uses an arrow in the fringe to indicate the current
26709 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
26712 Warn about email replies to news
26714 Do you often find yourself replying to news by email by mistake? Then
26715 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
26719 If the new option @code{gnus-summary-display-while-building} is
26720 non-@code{nil}, the summary buffer is shown and updated as it's being
26724 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
26725 opposed to old but unread messages).
26728 The new option @code{gnus-gcc-mark-as-read} automatically marks
26729 Gcc articles as read.
26732 The nndoc back end now supports mailman digests and exim bounces.
26735 Gnus supports RFC 2369 mailing list headers, and adds a number of
26736 related commands in mailing list groups. @xref{Mailing List}.
26739 The Date header can be displayed in a format that can be read aloud
26740 in English. @xref{Article Date}.
26743 The envelope sender address can be customized when using Sendmail.
26744 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
26747 diffs are automatically highlighted in groups matching
26748 @code{mm-uu-diff-groups-regexp}
26751 @acronym{TLS} wrapper shipped with Gnus
26753 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
26754 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
26755 @acronym{TLS}/@acronym{SSL} support via (external third party)
26756 @file{ssl.el} and OpenSSL still works.
26759 New @file{make.bat} for compiling and installing Gnus under MS Windows
26761 Use @file{make.bat} if you want to install Gnus under MS Windows, the
26762 first argument to the batch-program should be the directory where
26763 @file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want
26764 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
26765 the second parameter.
26767 @file{make.bat} has been rewritten from scratch, it now features
26768 automatic recognition of XEmacs and GNU Emacs, generates
26769 @file{gnus-load.el}, checks if errors occur while compilation and
26770 generation of info files and reports them at the end of the build
26771 process. It now uses @code{makeinfo} if it is available and falls
26772 back to @file{infohack.el} otherwise. @file{make.bat} should now
26773 install all files which are necessary to run Gnus and be generally a
26774 complete replacement for the @code{configure; make; make install}
26775 cycle used under Unix systems.
26777 The new @file{make.bat} makes @file{make-x.bat} superfluous, so it has
26781 Support for non-@acronym{ASCII} domain names
26783 Message supports non-@acronym{ASCII} domain names in From:, To: and
26784 Cc: and will query you whether to perform encoding when you try to
26785 send a message. The variable @code{message-use-idna} controls this.
26786 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
26787 and Cc: when you view a message. The variable @code{gnus-use-idna}
26791 Better handling of Microsoft citation styles
26793 Gnus now tries to recognize the mangled header block that some Microsoft
26794 mailers use to indicate that the rest of the message is a citation, even
26795 though it is not quoted in any way. The variable
26796 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
26800 @code{gnus-article-skip-boring}
26802 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
26803 not scroll down to show you a page that contains only boring text,
26804 which by default means cited text and signature. You can customize
26805 what is skippable using @code{gnus-article-boring-faces}.
26807 This feature is especially useful if you read many articles that
26808 consist of a little new content at the top with a long, untrimmed
26809 message cited below.
26812 The format spec @code{%C} for positioning point has changed to @code{%*}.
26815 The new variable @code{gnus-parameters} can be used to set group parameters.
26817 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
26818 the parameters in @file{~/.newsrc.eld}, but via this variable you can
26819 enjoy the powers of customize, and simplified backups since you set the
26820 variable in @file{~/.gnus.el} instead of @file{~/.newsrc.eld}. The
26821 variable maps regular expressions matching group names to group
26824 (setq gnus-parameters
26826 (gnus-show-threads nil)
26827 (gnus-use-scoring nil))
26828 ("^nnimap:\\(foo.bar\\)$"
26829 (to-group . "\\1"))))
26833 Smileys (@samp{:-)}, @samp{;-)} etc) are now iconized for Emacs too.
26835 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.gnus.el} to
26839 Gnus no longer generate the Sender: header automatically.
26841 Earlier it was generated iff the user configurable email address was
26842 different from the Gnus guessed default user address. As the guessing
26843 algorithm is rarely correct these days, and (more controversially) the
26844 only use of the Sender: header was to check if you are entitled to
26845 cancel/supersede news (which is now solved by Cancel Locks instead,
26846 see another entry), generation of the header has been disabled by
26847 default. See the variables @code{message-required-headers},
26848 @code{message-required-news-headers}, and
26849 @code{message-required-mail-headers}.
26852 Features from third party @file{message-utils.el} added to @file{message.el}.
26854 Message now asks if you wish to remove @samp{(was: <old subject>)} from
26855 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
26856 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
26857 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
26858 appropriate headers and a note in the body for cross-postings and
26859 followups (see the variables @code{message-cross-post-@var{*}}).
26862 References and X-Draft-From headers are no longer generated when you
26863 start composing messages and @code{message-generate-headers-first} is
26867 Improved anti-spam features.
26869 Gnus is now able to take out spam from your mail and news streams
26870 using a wide variety of programs and filter rules. Among the supported
26871 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
26872 for easy use of external packages such as SpamAssassin and Hashcash
26873 are also new. @xref{Thwarting Email Spam}.
26876 Easy inclusion of X-Faces headers.
26879 Face headers handling.
26882 In the summary buffer, the new command @kbd{/ N} inserts new messages
26883 and @kbd{/ o} inserts old messages.
26886 Gnus decodes morse encoded messages if you press @kbd{W m}.
26889 Unread count correct in nnimap groups.
26891 The estimated number of unread articles in the group buffer should now
26892 be correct for nnimap groups. This is achieved by calling
26893 @code{nnimap-fixup-unread-after-getting-new-news} from the
26894 @code{gnus-setup-news-hook} (called on startup) and
26895 @code{gnus-after-getting-new-news-hook}. (called after getting new
26896 mail). If you have modified those variables from the default, you may
26897 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
26898 you were happy with the estimate and want to save some (minimal) time
26899 when getting new mail, remove the function.
26902 Group Carbon Copy (GCC) quoting
26904 To support groups that contains SPC and other weird characters, groups
26905 are quoted before they are placed in the Gcc: header. This means
26906 variables such as @code{gnus-message-archive-group} should no longer
26907 contain quote characters to make groups containing SPC work. Also, if
26908 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
26909 into two groups) you must change it to return the list
26910 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
26911 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
26912 was incorrect earlier, it just didn't generate any problems since it
26913 was inserted directly.
26916 @file{~/News/overview/} not used.
26918 As a result of the following change, the @file{~/News/overview/}
26919 directory is not used any more. You can safely delete the entire
26925 The Gnus Agent has seen a major updated and is now enabled by default,
26926 and all nntp and nnimap servers from @code{gnus-select-method} and
26927 @code{gnus-secondary-select-method} are agentized by default. Earlier
26928 only the server in @code{gnus-select-method} was agentized by the
26929 default, and the agent was disabled by default. When the agent is
26930 enabled, headers are now also retrieved from the Agent cache instead
26931 of the back ends when possible. Earlier this only happened in the
26932 unplugged state. You can enroll or remove servers with @kbd{J a} and
26933 @kbd{J r} in the server buffer. Gnus will not download articles into
26934 the Agent cache, unless you instruct it to do so, though, by using
26935 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
26936 behavior of having the Agent disabled with @code{(setq gnus-agent
26937 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
26938 is not needed any more.
26941 @code{gnus-summary-line-format}
26943 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
26944 %s\n}. Moreover @code{gnus-extra-headers},
26945 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
26946 changed their default so that the users name will be replaced by the
26947 recipient's name or the group name posting to for @acronym{NNTP}
26951 @file{deuglify.el} (@code{gnus-article-outlook-deuglify-article})
26953 A new file from Raymond Scholz @email{rscholz@@zonix.de} for deuglifying
26954 broken Outlook (Express) articles.
26956 @c FIXME: `gnus-load' is mentioned in README, which is not included in
26957 @c CVS. We should find a better place for this item.
26959 @code{(require 'gnus-load)}
26961 If you use a stand-alone Gnus distribution, you'd better add
26962 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
26963 lisp directory into load-path.
26965 File @file{gnus-load.el} contains autoload commands, functions and variables,
26966 some of which may not be included in distributions of Emacsen.
26969 @code{gnus-slave-unplugged}
26971 A new command which starts Gnus offline in slave mode.
26974 @code{message-insinuate-rmail}
26976 Adding @code{(message-insinuate-rmail)} and @code{(setq
26977 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
26978 compose, reply and forward messages in message-mode, where you can
26979 enjoy the power of @acronym{MML}.
26982 @code{message-minibuffer-local-map}
26984 The line below enables BBDB in resending a message:
26986 (define-key message-minibuffer-local-map [(tab)]
26987 'bbdb-complete-name)
26991 Externalizing and deleting of attachments.
26993 If @code{gnus-gcc-externalize-attachments} or
26994 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
26995 local files as external parts.
26997 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
26998 on @acronym{MIME} buttons) saves a part and replaces the part with an
26999 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
27000 @acronym{MIME} buttons) removes a part. It works only on back ends
27001 that support editing.
27004 @code{gnus-default-charset}
27006 The default value is determined from the
27007 @code{current-language-environment} variable, instead of
27008 @code{iso-8859-1}. Also the @samp{.*} item in
27009 @code{gnus-group-charset-alist} is removed.
27012 @code{gnus-posting-styles}
27014 Add a new format of match like
27016 ((header "to" "larsi.*org")
27017 (Organization "Somewhere, Inc."))
27019 The old format like the lines below is obsolete, but still accepted.
27021 (header "to" "larsi.*org"
27022 (Organization "Somewhere, Inc."))
27026 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
27028 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
27029 added into these two variables. If you customized those, perhaps you
27030 need add those two headers too.
27033 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
27035 If one reads an article while plugged, and the article already exists
27036 in the Agent, it won't get downloaded once more. @code{(setq
27037 gnus-agent-cache nil)} reverts to the old behavior.
27040 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
27041 composing messages, it is enabled by @code{use-hard-newlines}.
27042 Decoding format=flowed was present but not documented in earlier
27046 The option @code{mm-fill-flowed} can be used to disable treatment of
27047 ``format=flowed'' messages. Also, flowed text is disabled when sending
27048 inline PGP signed messages. (New in Gnus 5.10.7)
27051 Gnus supports the generation of RFC 2298 Disposition Notification requests.
27053 This is invoked with the @kbd{C-c M-n} key binding from message mode.
27056 Gnus supports Maildir groups.
27058 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
27061 Printing capabilities are enhanced.
27063 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
27064 Article buffers. Also, each individual @acronym{MIME} part can be
27065 printed using @kbd{p} on the @acronym{MIME} button.
27068 Message supports the Importance: (RFC 2156) header.
27070 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
27074 Gnus supports Cancel Locks in News.
27076 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
27077 used to determine if you wrote an article or not (for canceling and
27078 superseding). Gnus generates a random password string the first time
27079 you post a message, and saves it in your @file{~/.emacs} using the Custom
27080 system. While the variable is called @code{canlock-password}, it is not
27081 security sensitive data. Publishing your canlock string on the web
27082 will not allow anyone to be able to anything she could not already do.
27083 The behavior can be changed by customizing @code{message-insert-canlock}.
27086 Gnus supports server-side mail filtering using Sieve.
27088 Sieve rules can be added as Group Parameters for groups, and the
27089 complete Sieve script is generated using @kbd{D g} from the Group
27090 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
27091 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
27092 manual @ref{Top, , Top, sieve, Emacs Sieve}.
27095 Extended format specs.
27097 Format spec @samp{%&user-date;} is added into
27098 @code{gnus-summary-line-format-alist}. Also, user defined extended
27099 format specs are supported. The extended format specs look like
27100 @samp{%u&foo;}, which invokes function
27101 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
27102 escape character, old user defined format @samp{%u&} is no longer supported.
27105 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
27107 It was aliased to @kbd{Y c}
27108 (@code{gnus-summary-insert-cached-articles}). The new function filters
27109 out other articles.
27112 Some limiting commands accept a @kbd{C-u} prefix to negate the match.
27114 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
27115 s}, @kbd{/ a}, and @kbd{/ x}
27116 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
27117 result will be to display all articles that do not match the expression.
27120 Group names are treated as UTF-8 by default.
27122 This is supposedly what USEFOR wanted to migrate to. See
27123 @code{gnus-group-name-charset-group-alist} and
27124 @code{gnus-group-name-charset-method-alist} for customization.
27127 The nnml and nnfolder back ends store marks for each groups.
27129 This makes it possible to take backup of nnml/nnfolder servers/groups
27130 separately of @file{~/.newsrc.eld}, while preserving marks. It also
27131 makes it possible to share articles and marks between users (without
27132 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
27133 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
27134 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
27135 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
27136 another machine, Gnus will automatically use the @file{.marks} or
27137 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
27138 The new server variables @code{nnml-marks-is-evil} and
27139 @code{nnfolder-marks-is-evil} can be used to disable this feature.
27142 The menu bar item (in Group and Summary buffer) named ``Misc'' has
27143 been renamed to ``Gnus''.
27146 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
27147 renamed to ``Attachments''. Note that this menu also contains security
27148 related stuff, like signing and encryption (@pxref{Security, Security,,
27149 message, Message Manual}).
27152 @code{gnus-group-charset-alist} and
27153 @code{gnus-group-ignored-charsets-alist}.
27155 The regexps in these variables are compared with full group names
27156 instead of real group names in 5.8. Users who customize these
27157 variables should change those regexps accordingly. For example:
27159 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
27163 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
27164 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
27166 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
27167 additional Lisp libraries. This add several menu items to the
27168 Attachments menu, and @kbd{C-c RET} key bindings, when composing
27169 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
27172 Gnus inlines external parts (message/external).
27175 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
27178 This change was made to avoid conflict with the standard binding of
27179 @code{back-to-indentation}, which is also useful in message mode.
27182 The default for @code{message-forward-show-mml} changed to symbol @code{best}.
27184 The behavior for the @code{best} value is to show @acronym{MML} (i.e.,
27185 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
27186 used when forwarding signed or encrypted messages, as the conversion
27187 invalidate the digital signature.
27191 @subsubsection No Gnus
27194 New features in No Gnus:
27195 @c FIXME: Gnus 5.12?
27197 @include gnus-news.texi
27203 @section The Manual
27207 This manual was generated from a TeXinfo file and then run through
27208 either @code{texi2dvi}
27210 or my own home-brewed TeXinfo to \LaTeX\ transformer,
27211 and then run through @code{latex} and @code{dvips}
27213 to get what you hold in your hands now.
27215 The following conventions have been used:
27220 This is a @samp{string}
27223 This is a @kbd{keystroke}
27226 This is a @file{file}
27229 This is a @code{symbol}
27233 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
27237 (setq flargnoze "yes")
27240 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
27243 (setq flumphel 'yes)
27246 @samp{yes} and @code{yes} are two @emph{very} different things---don't
27247 ever get them confused.
27251 Of course, everything in this manual is of vital interest, so you should
27252 read it all. Several times. However, if you feel like skimming the
27253 manual, look for that gnu head you should see in the margin over
27254 there---it means that what's being discussed is of more importance than
27255 the rest of the stuff. (On the other hand, if everything is infinitely
27256 important, how can anything be more important than that? Just one more
27257 of the mysteries of this world, I guess.)
27263 @node On Writing Manuals
27264 @section On Writing Manuals
27266 I guess most manuals are written after-the-fact; documenting a program
27267 that's already there. This is not how this manual is written. When
27268 implementing something, I write the manual entry for that something
27269 straight away. I then see that it's difficult to explain the
27270 functionality, so I write how it's supposed to be, and then I change the
27271 implementation. Writing the documentation and writing the code goes
27274 This, of course, means that this manual has no, or little, flow. It
27275 documents absolutely everything in Gnus, but often not where you're
27276 looking for it. It is a reference manual, and not a guide to how to get
27279 That would be a totally different book, that should be written using the
27280 reference manual as source material. It would look quite differently.
27285 @section Terminology
27287 @cindex terminology
27292 This is what you are supposed to use this thing for---reading news.
27293 News is generally fetched from a nearby @acronym{NNTP} server, and is
27294 generally publicly available to everybody. If you post news, the entire
27295 world is likely to read just what you have written, and they'll all
27296 snigger mischievously. Behind your back.
27300 Everything that's delivered to you personally is mail. Some news/mail
27301 readers (like Gnus) blur the distinction between mail and news, but
27302 there is a difference. Mail is private. News is public. Mailing is
27303 not posting, and replying is not following up.
27307 Send a mail to the person who has written what you are reading.
27311 Post an article to the current newsgroup responding to the article you
27316 Gnus considers mail and news to be mostly the same, really. The only
27317 difference is how to access the actual articles. News articles are
27318 commonly fetched via the protocol @acronym{NNTP}, whereas mail
27319 messages could be read from a file on the local disk. The internal
27320 architecture of Gnus thus comprises a ``front end'' and a number of
27321 ``back ends''. Internally, when you enter a group (by hitting
27322 @key{RET}, say), you thereby invoke a function in the front end in
27323 Gnus. The front end then ``talks'' to a back end and says things like
27324 ``Give me the list of articles in the foo group'' or ``Show me article
27327 So a back end mainly defines either a protocol (the @code{nntp} back
27328 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
27329 accesses mail via @acronym{IMAP}) or a file format and directory
27330 layout (the @code{nnspool} back end accesses news via the common
27331 ``spool directory'' format, the @code{nnml} back end access mail via a
27332 file format and directory layout that's quite similar).
27334 Gnus does not handle the underlying media, so to speak---this is all
27335 done by the back ends. A back end is a collection of functions to
27336 access the articles.
27338 However, sometimes the term ``back end'' is also used where ``server''
27339 would have been more appropriate. And then there is the term ``select
27340 method'' which can mean either. The Gnus terminology can be quite
27345 Gnus will always use one method (and back end) as the @dfn{native}, or
27346 default, way of getting news.
27350 You can also have any number of foreign groups active at the same time.
27351 These are groups that use non-native non-secondary back ends for getting
27356 Secondary back ends are somewhere half-way between being native and being
27357 foreign, but they mostly act like they are native.
27361 A message that has been posted as news.
27364 @cindex mail message
27365 A message that has been mailed.
27369 A mail message or news article
27373 The top part of a message, where administrative information (etc.) is
27378 The rest of an article. Everything not in the head is in the
27383 A line from the head of an article.
27387 A collection of such lines, or a collection of heads. Or even a
27388 collection of @acronym{NOV} lines.
27390 @item @acronym{NOV}
27391 @cindex @acronym{NOV}
27392 When Gnus enters a group, it asks the back end for the headers of all
27393 unread articles in the group. Most servers support the News OverView
27394 format, which is more compact and much faster to read and parse than the
27395 normal @sc{head} format.
27399 Each group is subscribed at some @dfn{level} or other (1-9). The ones
27400 that have a lower level are ``more'' subscribed than the groups with a
27401 higher level. In fact, groups on levels 1-5 are considered
27402 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
27403 are @dfn{killed}. Commands for listing groups and scanning for new
27404 articles will all use the numeric prefix as @dfn{working level}.
27406 @item killed groups
27407 @cindex killed groups
27408 No information on killed groups is stored or updated, which makes killed
27409 groups much easier to handle than subscribed groups.
27411 @item zombie groups
27412 @cindex zombie groups
27413 Just like killed groups, only slightly less dead.
27416 @cindex active file
27417 The news server has to keep track of what articles it carries, and what
27418 groups exist. All this information in stored in the active file, which
27419 is rather large, as you might surmise.
27422 @cindex bogus groups
27423 A group that exists in the @file{.newsrc} file, but isn't known to the
27424 server (i.e., it isn't in the active file), is a @emph{bogus group}.
27425 This means that the group probably doesn't exist (any more).
27428 @cindex activating groups
27429 The act of asking the server for info on a group and computing the
27430 number of unread articles is called @dfn{activating the group}.
27431 Un-activated groups are listed with @samp{*} in the group buffer.
27435 News servers store their articles locally in one fashion or other.
27436 One old-fashioned storage method is to have just one file per
27437 article. That's called a ``traditional spool''.
27441 A machine one can connect to and get news (or mail) from.
27443 @item select method
27444 @cindex select method
27445 A structure that specifies the back end, the server and the virtual
27448 @item virtual server
27449 @cindex virtual server
27450 A named select method. Since a select method defines all there is to
27451 know about connecting to a (physical) server, taking the thing as a
27452 whole is a virtual server.
27456 Taking a buffer and running it through a filter of some sort. The
27457 result will (more often than not) be cleaner and more pleasing than the
27460 @item ephemeral groups
27461 @cindex ephemeral groups
27462 @cindex temporary groups
27463 Most groups store data on what articles you have read. @dfn{Ephemeral}
27464 groups are groups that will have no data stored---when you exit the
27465 group, it'll disappear into the aether.
27468 @cindex solid groups
27469 This is the opposite of ephemeral groups. All groups listed in the
27470 group buffer are solid groups.
27472 @item sparse articles
27473 @cindex sparse articles
27474 These are article placeholders shown in the summary buffer when
27475 @code{gnus-build-sparse-threads} has been switched on.
27479 To put responses to articles directly after the articles they respond
27480 to---in a hierarchical fashion.
27484 @cindex thread root
27485 The first article in a thread is the root. It is the ancestor of all
27486 articles in the thread.
27490 An article that has responses.
27494 An article that responds to a different article---its parent.
27498 A collection of messages in one file. The most common digest format is
27499 specified by RFC 1153.
27502 @cindex splitting, terminolgy
27503 @cindex mail sorting
27504 @cindex mail filtering (splitting)
27505 The action of sorting your emails according to certain rules. Sometimes
27506 incorrectly called mail filtering.
27512 @node Customization
27513 @section Customization
27514 @cindex general customization
27516 All variables are properly documented elsewhere in this manual. This
27517 section is designed to give general pointers on how to customize Gnus
27518 for some quite common situations.
27521 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
27522 * Slow Terminal Connection:: You run a remote Emacs.
27523 * Little Disk Space:: You feel that having large setup files is icky.
27524 * Slow Machine:: You feel like buying a faster machine.
27528 @node Slow/Expensive Connection
27529 @subsection Slow/Expensive NNTP Connection
27531 If you run Emacs on a machine locally, and get your news from a machine
27532 over some very thin strings, you want to cut down on the amount of data
27533 Gnus has to get from the @acronym{NNTP} server.
27537 @item gnus-read-active-file
27538 Set this to @code{nil}, which will inhibit Gnus from requesting the
27539 entire active file from the server. This file is often very large. You
27540 also have to set @code{gnus-check-new-newsgroups} and
27541 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
27542 doesn't suddenly decide to fetch the active file anyway.
27544 @item gnus-nov-is-evil
27545 This one has to be @code{nil}. If not, grabbing article headers from
27546 the @acronym{NNTP} server will not be very fast. Not all @acronym{NNTP} servers
27547 support @sc{xover}; Gnus will detect this by itself.
27551 @node Slow Terminal Connection
27552 @subsection Slow Terminal Connection
27554 Let's say you use your home computer for dialing up the system that runs
27555 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
27556 possible) the amount of data sent over the wires.
27560 @item gnus-auto-center-summary
27561 Set this to @code{nil} to inhibit Gnus from re-centering the summary
27562 buffer all the time. If it is @code{vertical}, do only vertical
27563 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
27564 horizontal and vertical recentering.
27566 @item gnus-visible-headers
27567 Cut down on the headers included in the articles to the
27568 minimum. You can, in fact, make do without them altogether---most of the
27569 useful data is in the summary buffer, anyway. Set this variable to
27570 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
27572 Use the following to enable all the available hiding features:
27574 (setq gnus-treat-hide-headers 'head
27575 gnus-treat-hide-signature t
27576 gnus-treat-hide-citation t)
27579 @item gnus-use-full-window
27580 By setting this to @code{nil}, you can make all the windows smaller.
27581 While this doesn't really cut down much generally, it means that you
27582 have to see smaller portions of articles before deciding that you didn't
27583 want to read them anyway.
27585 @item gnus-thread-hide-subtree
27586 If this is non-@code{nil}, all threads in the summary buffer will be
27590 @item gnus-updated-mode-lines
27591 If this is @code{nil}, Gnus will not put information in the buffer mode
27592 lines, which might save some time.
27596 @node Little Disk Space
27597 @subsection Little Disk Space
27600 The startup files can get rather large, so you may want to cut their
27601 sizes a bit if you are running out of space.
27605 @item gnus-save-newsrc-file
27606 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
27607 only save @file{.newsrc.eld}. This means that you will not be able to
27608 use any other newsreaders than Gnus. This variable is @code{t} by
27611 @item gnus-read-newsrc-file
27612 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
27613 only read @file{.newsrc.eld}. This means that you will not be able to
27614 use any other newsreaders than Gnus. This variable is @code{t} by
27617 @item gnus-save-killed-list
27618 If this is @code{nil}, Gnus will not save the list of dead groups. You
27619 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
27620 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
27621 variable to @code{nil}. This variable is @code{t} by default.
27627 @subsection Slow Machine
27628 @cindex slow machine
27630 If you have a slow machine, or are just really impatient, there are a
27631 few things you can do to make Gnus run faster.
27633 Set @code{gnus-check-new-newsgroups} and
27634 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
27636 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
27637 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
27638 summary buffer faster.
27642 @node Troubleshooting
27643 @section Troubleshooting
27644 @cindex troubleshooting
27646 Gnus works @emph{so} well straight out of the box---I can't imagine any
27654 Make sure your computer is switched on.
27657 Make sure that you really load the current Gnus version. If you have
27658 been running @sc{gnus}, you need to exit Emacs and start it up again before
27662 Try doing an @kbd{M-x gnus-version}. If you get something that looks
27663 like @samp{T-gnus 6.17.* (based on Gnus v5.10.*; for SEMI 1.1*, FLIM
27664 1.1*)} you have the right files loaded. Otherwise you have some old
27665 @file{.el} files lying around. Delete these.
27668 Read the help group (@kbd{G h} in the group buffer) for a
27669 @acronym{FAQ} and a how-to.
27672 @vindex max-lisp-eval-depth
27673 Gnus works on many recursive structures, and in some extreme (and very
27674 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
27675 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
27676 something like that.
27679 If all else fails, report the problem as a bug.
27682 @cindex reporting bugs
27684 @kindex M-x gnus-bug
27686 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
27687 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
27688 me the backtrace. I will fix bugs, but I can only fix them if you send
27689 me a precise description as to how to reproduce the bug.
27691 You really can never be too detailed in a bug report. Always use the
27692 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
27693 a 10Kb mail each time you use it, and even if you have sent me your
27694 environment 500 times before. I don't care. I want the full info each
27697 It is also important to remember that I have no memory whatsoever. If
27698 you send a bug report, and I send you a reply, and then you just send
27699 back ``No, it's not! Moron!'', I will have no idea what you are
27700 insulting me about. Always over-explain everything. It's much easier
27701 for all of us---if I don't have all the information I need, I will just
27702 mail you and ask for more info, and everything takes more time.
27704 If the problem you're seeing is very visual, and you can't quite explain
27705 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
27706 it somewhere it can be reached, and include the URL of the picture in
27710 If you would like to contribute a patch to fix bugs or make
27711 improvements, please produce the patch using @samp{diff -u}.
27714 If you want to debug your problem further before reporting, possibly
27715 in order to solve the problem yourself and send a patch, you can use
27716 edebug. Debugging Lisp code is documented in the Elisp manual
27717 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
27718 Lisp Reference Manual}). To get you started with edebug, consider if
27719 you discover some weird behavior when pressing @kbd{c}, the first
27720 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
27721 the documentation buffer that leads you to the function definition,
27722 then press @kbd{M-x edebug-defun RET} with point inside that function,
27723 return to Gnus and press @kbd{c} to invoke the code. You will be
27724 placed in the lisp buffer and can single step using @kbd{SPC} and
27725 evaluate expressions using @kbd{M-:} or inspect variables using
27726 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
27727 @kbd{c} or @kbd{g}.
27732 Sometimes, a problem do not directly generate an elisp error but
27733 manifests itself by causing Gnus to be very slow. In these cases, you
27734 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
27735 slow, and then try to analyze the backtrace (repeating the procedure
27736 helps isolating the real problem areas).
27738 A fancier approach is to use the elisp profiler, ELP. The profiler is
27739 (or should be) fully documented elsewhere, but to get you started
27740 there are a few steps that need to be followed. First, instrument the
27741 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
27742 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
27743 RET message}. Then perform the operation that is slow and press
27744 @kbd{M-x elp-results}. You will then see which operations that takes
27745 time, and can debug them further. If the entire operation takes much
27746 longer than the time spent in the slowest function in the profiler
27747 output, you probably profiled the wrong part of Gnus. To reset
27748 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
27749 elp-restore-all} is supposed to remove profiling, but given the
27750 complexities and dynamic code generation in Gnus, it might not always
27753 @cindex gnu.emacs.gnus
27754 @cindex ding mailing list
27755 If you just need help, you are better off asking on
27756 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
27757 @email{ding@@gnus.org, the ding mailing list}. Write to
27758 @email{ding-request@@gnus.org} to subscribe.
27762 @node Gnus Reference Guide
27763 @section Gnus Reference Guide
27765 It is my hope that other people will figure out smart stuff that Gnus
27766 can do, and that other people will write those smart things as well. To
27767 facilitate that I thought it would be a good idea to describe the inner
27768 workings of Gnus. And some of the not-so-inner workings, while I'm at
27771 You can never expect the internals of a program not to change, but I
27772 will be defining (in some details) the interface between Gnus and its
27773 back ends (this is written in stone), the format of the score files
27774 (ditto), data structures (some are less likely to change than others)
27775 and general methods of operation.
27778 * Gnus Utility Functions:: Common functions and variable to use.
27779 * Back End Interface:: How Gnus communicates with the servers.
27780 * Score File Syntax:: A BNF definition of the score file standard.
27781 * Headers:: How Gnus stores headers internally.
27782 * Ranges:: A handy format for storing mucho numbers.
27783 * Group Info:: The group info format.
27784 * Extended Interactive:: Symbolic prefixes and stuff.
27785 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
27786 * Various File Formats:: Formats of files that Gnus use.
27790 @node Gnus Utility Functions
27791 @subsection Gnus Utility Functions
27792 @cindex Gnus utility functions
27793 @cindex utility functions
27795 @cindex internal variables
27797 When writing small functions to be run from hooks (and stuff), it's
27798 vital to have access to the Gnus internal functions and variables.
27799 Below is a list of the most common ones.
27803 @item gnus-newsgroup-name
27804 @vindex gnus-newsgroup-name
27805 This variable holds the name of the current newsgroup.
27807 @item gnus-find-method-for-group
27808 @findex gnus-find-method-for-group
27809 A function that returns the select method for @var{group}.
27811 @item gnus-group-real-name
27812 @findex gnus-group-real-name
27813 Takes a full (prefixed) Gnus group name, and returns the unprefixed
27816 @item gnus-group-prefixed-name
27817 @findex gnus-group-prefixed-name
27818 Takes an unprefixed group name and a select method, and returns the full
27819 (prefixed) Gnus group name.
27821 @item gnus-get-info
27822 @findex gnus-get-info
27823 Returns the group info list for @var{group}.
27825 @item gnus-group-unread
27826 @findex gnus-group-unread
27827 The number of unread articles in @var{group}, or @code{t} if that is
27831 @findex gnus-active
27832 The active entry for @var{group}.
27834 @item gnus-set-active
27835 @findex gnus-set-active
27836 Set the active entry for @var{group}.
27838 @item gnus-add-current-to-buffer-list
27839 @findex gnus-add-current-to-buffer-list
27840 Adds the current buffer to the list of buffers to be killed on Gnus
27843 @item gnus-continuum-version
27844 @findex gnus-continuum-version
27845 Takes a Gnus version string as a parameter and returns a floating point
27846 number. Earlier versions will always get a lower number than later
27849 @item gnus-group-read-only-p
27850 @findex gnus-group-read-only-p
27851 Says whether @var{group} is read-only or not.
27853 @item gnus-news-group-p
27854 @findex gnus-news-group-p
27855 Says whether @var{group} came from a news back end.
27857 @item gnus-ephemeral-group-p
27858 @findex gnus-ephemeral-group-p
27859 Says whether @var{group} is ephemeral or not.
27861 @item gnus-server-to-method
27862 @findex gnus-server-to-method
27863 Returns the select method corresponding to @var{server}.
27865 @item gnus-server-equal
27866 @findex gnus-server-equal
27867 Says whether two virtual servers are equal.
27869 @item gnus-group-native-p
27870 @findex gnus-group-native-p
27871 Says whether @var{group} is native or not.
27873 @item gnus-group-secondary-p
27874 @findex gnus-group-secondary-p
27875 Says whether @var{group} is secondary or not.
27877 @item gnus-group-foreign-p
27878 @findex gnus-group-foreign-p
27879 Says whether @var{group} is foreign or not.
27881 @item gnus-group-find-parameter
27882 @findex gnus-group-find-parameter
27883 Returns the parameter list of @var{group}. If given a second parameter,
27884 returns the value of that parameter for @var{group}.
27886 @item gnus-group-set-parameter
27887 @findex gnus-group-set-parameter
27888 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
27890 @item gnus-narrow-to-body
27891 @findex gnus-narrow-to-body
27892 Narrows the current buffer to the body of the article.
27894 @item gnus-check-backend-function
27895 @findex gnus-check-backend-function
27896 Takes two parameters, @var{function} and @var{group}. If the back end
27897 @var{group} comes from supports @var{function}, return non-@code{nil}.
27900 (gnus-check-backend-function "request-scan" "nnml:misc")
27904 @item gnus-read-method
27905 @findex gnus-read-method
27906 Prompts the user for a select method.
27911 @node Back End Interface
27912 @subsection Back End Interface
27914 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
27915 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
27916 server is a @dfn{back end} and some @dfn{back end variables}. As examples
27917 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
27918 examples of the latter we have @code{nntp-port-number} and
27919 @code{nnmbox-directory}.
27921 When Gnus asks for information from a back end---say @code{nntp}---on
27922 something, it will normally include a virtual server name in the
27923 function parameters. (If not, the back end should use the ``current''
27924 virtual server.) For instance, @code{nntp-request-list} takes a virtual
27925 server as its only (optional) parameter. If this virtual server hasn't
27926 been opened, the function should fail.
27928 Note that a virtual server name has no relation to some physical server
27929 name. Take this example:
27933 (nntp-address "ifi.uio.no")
27934 (nntp-port-number 4324))
27937 Here the virtual server name is @samp{odd-one} while the name of
27938 the physical server is @samp{ifi.uio.no}.
27940 The back ends should be able to switch between several virtual servers.
27941 The standard back ends implement this by keeping an alist of virtual
27942 server environments that they pull down/push up when needed.
27944 There are two groups of interface functions: @dfn{required functions},
27945 which must be present, and @dfn{optional functions}, which Gnus will
27946 always check for presence before attempting to call 'em.
27948 All these functions are expected to return data in the buffer
27949 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
27950 unfortunately named, but we'll have to live with it. When I talk about
27951 @dfn{resulting data}, I always refer to the data in that buffer. When I
27952 talk about @dfn{return value}, I talk about the function value returned by
27953 the function call. Functions that fail should return @code{nil} as the
27956 Some back ends could be said to be @dfn{server-forming} back ends, and
27957 some might be said not to be. The latter are back ends that generally
27958 only operate on one group at a time, and have no concept of ``server''
27959 ---they have a group, and they deliver info on that group and nothing
27962 Gnus identifies each message by way of group name and article number. A
27963 few remarks about these article numbers might be useful. First of all,
27964 the numbers are positive integers. Secondly, it is normally not
27965 possible for later articles to ``re-use'' older article numbers without
27966 confusing Gnus. That is, if a group has ever contained a message
27967 numbered 42, then no other message may get that number, or Gnus will get
27968 mightily confused.@footnote{See the function
27969 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
27970 Third, article numbers must be assigned in order of arrival in the
27971 group; this is not necessarily the same as the date of the message.
27973 The previous paragraph already mentions all the ``hard'' restrictions that
27974 article numbers must fulfill. But it seems that it might be useful to
27975 assign @emph{consecutive} article numbers, for Gnus gets quite confused
27976 if there are holes in the article numbering sequence. However, due to
27977 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
27978 also useful for the article numbers to start at 1 to avoid running out
27979 of numbers as long as possible.
27981 Note that by convention, back ends are named @code{nnsomething}, but
27982 Gnus also comes with some @code{nnnotbackends}, such as
27983 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
27985 In the examples and definitions I will refer to the imaginary back end
27988 @cindex @code{nnchoke}
27991 * Required Back End Functions:: Functions that must be implemented.
27992 * Optional Back End Functions:: Functions that need not be implemented.
27993 * Error Messaging:: How to get messages and report errors.
27994 * Writing New Back Ends:: Extending old back ends.
27995 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
27996 * Mail-like Back Ends:: Some tips on mail back ends.
28000 @node Required Back End Functions
28001 @subsubsection Required Back End Functions
28005 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
28007 @var{articles} is either a range of article numbers or a list of
28008 @code{Message-ID}s. Current back ends do not fully support either---only
28009 sequences (lists) of article numbers, and most back ends do not support
28010 retrieval of @code{Message-ID}s. But they should try for both.
28012 The result data should either be HEADs or @acronym{NOV} lines, and the result
28013 value should either be @code{headers} or @code{nov} to reflect this.
28014 This might later be expanded to @code{various}, which will be a mixture
28015 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
28017 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
28018 headers'', in some meaning of the word. This is generally done by
28019 fetching (at most) @var{fetch-old} extra headers less than the smallest
28020 article number in @code{articles}, and filling the gaps as well. The
28021 presence of this parameter can be ignored if the back end finds it
28022 cumbersome to follow the request. If this is non-@code{nil} and not a
28023 number, do maximum fetches.
28025 Here's an example HEAD:
28028 221 1056 Article retrieved.
28029 Path: ifi.uio.no!sturles
28030 From: sturles@@ifi.uio.no (Sturle Sunde)
28031 Newsgroups: ifi.discussion
28032 Subject: Re: Something very droll
28033 Date: 27 Oct 1994 14:02:57 +0100
28034 Organization: Dept. of Informatics, University of Oslo, Norway
28036 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
28037 References: <38jdmq$4qu@@visbur.ifi.uio.no>
28038 NNTP-Posting-Host: holmenkollen.ifi.uio.no
28042 So a @code{headers} return value would imply that there's a number of
28043 these in the data buffer.
28045 Here's a BNF definition of such a buffer:
28049 head = error / valid-head
28050 error-message = [ "4" / "5" ] 2number " " <error message> eol
28051 valid-head = valid-message *header "." eol
28052 valid-message = "221 " <number> " Article retrieved." eol
28053 header = <text> eol
28057 (The version of BNF used here is the one used in RFC822.)
28059 If the return value is @code{nov}, the data buffer should contain
28060 @dfn{network overview database} lines. These are basically fields
28064 nov-buffer = *nov-line
28065 nov-line = field 7*8[ <TAB> field ] eol
28066 field = <text except TAB>
28069 For a closer look at what should be in those fields,
28073 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
28075 @var{server} is here the virtual server name. @var{definitions} is a
28076 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
28078 If the server can't be opened, no error should be signaled. The back end
28079 may then choose to refuse further attempts at connecting to this
28080 server. In fact, it should do so.
28082 If the server is opened already, this function should return a
28083 non-@code{nil} value. There should be no data returned.
28086 @item (nnchoke-close-server &optional SERVER)
28088 Close connection to @var{server} and free all resources connected
28089 to it. Return @code{nil} if the server couldn't be closed for some
28092 There should be no data returned.
28095 @item (nnchoke-request-close)
28097 Close connection to all servers and free all resources that the back end
28098 have reserved. All buffers that have been created by that back end
28099 should be killed. (Not the @code{nntp-server-buffer}, though.) This
28100 function is generally only called when Gnus is shutting down.
28102 There should be no data returned.
28105 @item (nnchoke-server-opened &optional SERVER)
28107 If @var{server} is the current virtual server, and the connection to the
28108 physical server is alive, then this function should return a
28109 non-@code{nil} value. This function should under no circumstances
28110 attempt to reconnect to a server we have lost connection to.
28112 There should be no data returned.
28115 @item (nnchoke-status-message &optional SERVER)
28117 This function should return the last error message from @var{server}.
28119 There should be no data returned.
28122 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
28124 The result data from this function should be the article specified by
28125 @var{article}. This might either be a @code{Message-ID} or a number.
28126 It is optional whether to implement retrieval by @code{Message-ID}, but
28127 it would be nice if that were possible.
28129 If @var{to-buffer} is non-@code{nil}, the result data should be returned
28130 in this buffer instead of the normal data buffer. This is to make it
28131 possible to avoid copying large amounts of data from one buffer to
28132 another, while Gnus mainly requests articles to be inserted directly
28133 into its article buffer.
28135 If it is at all possible, this function should return a cons cell where
28136 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
28137 the article number. This will enable Gnus to find out what the real
28138 group and article numbers are when fetching articles by
28139 @code{Message-ID}. If this isn't possible, @code{t} should be returned
28140 on successful article retrieval.
28143 @item (nnchoke-request-group GROUP &optional SERVER FAST)
28145 Get data on @var{group}. This function also has the side effect of
28146 making @var{group} the current group.
28148 If @var{fast}, don't bother to return useful data, just make @var{group}
28151 Here's an example of some result data and a definition of the same:
28154 211 56 1000 1059 ifi.discussion
28157 The first number is the status, which should be 211. Next is the
28158 total number of articles in the group, the lowest article number, the
28159 highest article number, and finally the group name. Note that the total
28160 number of articles may be less than one might think while just
28161 considering the highest and lowest article numbers, but some articles
28162 may have been canceled. Gnus just discards the total-number, so
28163 whether one should take the bother to generate it properly (if that is a
28164 problem) is left as an exercise to the reader. If the group contains no
28165 articles, the lowest article number should be reported as 1 and the
28169 group-status = [ error / info ] eol
28170 error = [ "4" / "5" ] 2<number> " " <Error message>
28171 info = "211 " 3* [ <number> " " ] <string>
28175 @item (nnchoke-close-group GROUP &optional SERVER)
28177 Close @var{group} and free any resources connected to it. This will be
28178 a no-op on most back ends.
28180 There should be no data returned.
28183 @item (nnchoke-request-list &optional SERVER)
28185 Return a list of all groups available on @var{server}. And that means
28188 Here's an example from a server that only carries two groups:
28191 ifi.test 0000002200 0000002000 y
28192 ifi.discussion 3324 3300 n
28195 On each line we have a group name, then the highest article number in
28196 that group, the lowest article number, and finally a flag. If the group
28197 contains no articles, the lowest article number should be reported as 1
28198 and the highest as 0.
28201 active-file = *active-line
28202 active-line = name " " <number> " " <number> " " flags eol
28204 flags = "n" / "y" / "m" / "x" / "j" / "=" name
28207 The flag says whether the group is read-only (@samp{n}), is moderated
28208 (@samp{m}), is dead (@samp{x}), is aliased to some other group
28209 (@samp{=other-group}) or none of the above (@samp{y}).
28212 @item (nnchoke-request-post &optional SERVER)
28214 This function should post the current buffer. It might return whether
28215 the posting was successful or not, but that's not required. If, for
28216 instance, the posting is done asynchronously, it has generally not been
28217 completed by the time this function concludes. In that case, this
28218 function should set up some kind of sentinel to beep the user loud and
28219 clear if the posting could not be completed.
28221 There should be no result data from this function.
28226 @node Optional Back End Functions
28227 @subsubsection Optional Back End Functions
28231 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
28233 @var{groups} is a list of groups, and this function should request data
28234 on all those groups. How it does it is of no concern to Gnus, but it
28235 should attempt to do this in a speedy fashion.
28237 The return value of this function can be either @code{active} or
28238 @code{group}, which says what the format of the result data is. The
28239 former is in the same format as the data from
28240 @code{nnchoke-request-list}, while the latter is a buffer full of lines
28241 in the same format as @code{nnchoke-request-group} gives.
28244 group-buffer = *active-line / *group-status
28248 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
28250 A Gnus group info (@pxref{Group Info}) is handed to the back end for
28251 alterations. This comes in handy if the back end really carries all
28252 the information (as is the case with virtual and imap groups). This
28253 function should destructively alter the info to suit its needs, and
28254 should return a non-@code{nil} value (exceptionally,
28255 @code{nntp-request-update-info} always returns @code{nil} not to waste
28256 the network resources).
28258 There should be no result data from this function.
28261 @item (nnchoke-request-type GROUP &optional ARTICLE)
28263 When the user issues commands for ``sending news'' (@kbd{F} in the
28264 summary buffer, for instance), Gnus has to know whether the article the
28265 user is following up on is news or mail. This function should return
28266 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
28267 is mail and @code{unknown} if the type can't be decided. (The
28268 @var{article} parameter is necessary in @code{nnvirtual} groups which
28269 might very well combine mail groups and news groups.) Both @var{group}
28270 and @var{article} may be @code{nil}.
28272 There should be no result data from this function.
28275 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
28277 Set/remove/add marks on articles. Normally Gnus handles the article
28278 marks (such as read, ticked, expired etc) internally, and store them in
28279 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
28280 all information about the articles on the server, so Gnus need to
28281 propagate the mark information to the server.
28283 @var{action} is a list of mark setting requests, having this format:
28286 (RANGE ACTION MARK)
28289 @var{range} is a range of articles you wish to update marks on.
28290 @var{action} is @code{add} or @code{del}, used to add marks or remove
28291 marks (preserving all marks not mentioned). @var{mark} is a list of
28292 marks; where each mark is a symbol. Currently used marks are
28293 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
28294 @code{dormant}, @code{save}, @code{download}, @code{unsend},
28295 @code{forward} and @code{recent}, but your back end should, if
28296 possible, not limit itself to these.
28298 Given contradictory actions, the last action in the list should be the
28299 effective one. That is, if your action contains a request to add the
28300 @code{tick} mark on article 1 and, later in the list, a request to
28301 remove the mark on the same article, the mark should in fact be removed.
28303 An example action list:
28306 (((5 12 30) 'del '(tick))
28307 ((10 . 90) 'add '(read expire))
28308 ((92 94) 'del '(read)))
28311 The function should return a range of articles it wasn't able to set the
28312 mark on (currently not used for anything).
28314 There should be no result data from this function.
28316 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
28318 If the user tries to set a mark that the back end doesn't like, this
28319 function may change the mark. Gnus will use whatever this function
28320 returns as the mark for @var{article} instead of the original
28321 @var{mark}. If the back end doesn't care, it must return the original
28322 @var{mark}, and not @code{nil} or any other type of garbage.
28324 The only use for this I can see is what @code{nnvirtual} does with
28325 it---if a component group is auto-expirable, marking an article as read
28326 in the virtual group should result in the article being marked as
28329 There should be no result data from this function.
28332 @item (nnchoke-request-scan &optional GROUP SERVER)
28334 This function may be called at any time (by Gnus or anything else) to
28335 request that the back end check for incoming articles, in one way or
28336 another. A mail back end will typically read the spool file or query
28337 the @acronym{POP} server when this function is invoked. The
28338 @var{group} doesn't have to be heeded---if the back end decides that
28339 it is too much work just scanning for a single group, it may do a
28340 total scan of all groups. It would be nice, however, to keep things
28341 local if that's practical.
28343 There should be no result data from this function.
28346 @item (nnchoke-request-group-description GROUP &optional SERVER)
28348 The result data from this function should be a description of
28352 description-line = name <TAB> description eol
28354 description = <text>
28357 @item (nnchoke-request-list-newsgroups &optional SERVER)
28359 The result data from this function should be the description of all
28360 groups available on the server.
28363 description-buffer = *description-line
28367 @item (nnchoke-request-newgroups DATE &optional SERVER)
28369 The result data from this function should be all groups that were
28370 created after @samp{date}, which is in normal human-readable date format
28371 (i.e., the date format used in mail and news headers, and returned by
28372 the function @code{message-make-date} by default). The data should be
28373 in the active buffer format.
28375 It is okay for this function to return ``too many'' groups; some back ends
28376 might find it cheaper to return the full list of groups, rather than
28377 just the new groups. But don't do this for back ends with many groups.
28378 Normally, if the user creates the groups herself, there won't be too
28379 many groups, so @code{nnml} and the like are probably safe. But for
28380 back ends like @code{nntp}, where the groups have been created by the
28381 server, it is quite likely that there can be many groups.
28384 @item (nnchoke-request-create-group GROUP &optional SERVER)
28386 This function should create an empty group with name @var{group}.
28388 There should be no return data.
28391 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
28393 This function should run the expiry process on all articles in the
28394 @var{articles} range (which is currently a simple list of article
28395 numbers.) It is left up to the back end to decide how old articles
28396 should be before they are removed by this function. If @var{force} is
28397 non-@code{nil}, all @var{articles} should be deleted, no matter how new
28400 This function should return a list of articles that it did not/was not
28403 There should be no result data returned.
28406 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
28408 This function should move @var{article} (which is a number) from
28409 @var{group} by calling @var{accept-form}.
28411 This function should ready the article in question for moving by
28412 removing any header lines it has added to the article, and generally
28413 should ``tidy up'' the article. Then it should @code{eval}
28414 @var{accept-form} in the buffer where the ``tidy'' article is. This
28415 will do the actual copying. If this @code{eval} returns a
28416 non-@code{nil} value, the article should be removed.
28418 If @var{last} is @code{nil}, that means that there is a high likelihood
28419 that there will be more requests issued shortly, so that allows some
28422 The function should return a cons where the @code{car} is the group name and
28423 the @code{cdr} is the article number that the article was entered as.
28425 The group should exist before the back end is asked to accept the
28426 article for that group.
28428 There should be no data returned.
28431 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
28433 This function takes the current buffer and inserts it into @var{group}.
28434 If @var{last} in @code{nil}, that means that there will be more calls to
28435 this function in short order.
28437 The function should return a cons where the @code{car} is the group name and
28438 the @code{cdr} is the article number that the article was entered as.
28440 There should be no data returned.
28443 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
28445 This function should remove @var{article} (which is a number) from
28446 @var{group} and insert @var{buffer} there instead.
28448 There should be no data returned.
28451 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
28453 This function should delete @var{group}. If @var{force}, it should
28454 really delete all the articles in the group, and then delete the group
28455 itself. (If there is such a thing as ``the group itself''.)
28457 There should be no data returned.
28460 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
28462 This function should rename @var{group} into @var{new-name}. All
28463 articles in @var{group} should move to @var{new-name}.
28465 There should be no data returned.
28470 @node Error Messaging
28471 @subsubsection Error Messaging
28473 @findex nnheader-report
28474 @findex nnheader-get-report
28475 The back ends should use the function @code{nnheader-report} to report
28476 error conditions---they should not raise errors when they aren't able to
28477 perform a request. The first argument to this function is the back end
28478 symbol, and the rest are interpreted as arguments to @code{format} if
28479 there are multiple of them, or just a string if there is one of them.
28480 This function must always returns @code{nil}.
28483 (nnheader-report 'nnchoke "You did something totally bogus")
28485 (nnheader-report 'nnchoke "Could not request group %s" group)
28488 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
28489 @code{nil} back from a server, and this function returns the most
28490 recently reported message for the back end in question. This function
28491 takes one argument---the server symbol.
28493 Internally, these functions access @var{back-end}@code{-status-string},
28494 so the @code{nnchoke} back end will have its error message stored in
28495 @code{nnchoke-status-string}.
28498 @node Writing New Back Ends
28499 @subsubsection Writing New Back Ends
28501 Many back ends are quite similar. @code{nnml} is just like
28502 @code{nnspool}, but it allows you to edit the articles on the server.
28503 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
28504 and it doesn't maintain overview databases. @code{nndir} is just like
28505 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
28508 It would make sense if it were possible to ``inherit'' functions from
28509 back ends when writing new back ends. And, indeed, you can do that if you
28510 want to. (You don't have to if you don't want to, of course.)
28512 All the back ends declare their public variables and functions by using a
28513 package called @code{nnoo}.
28515 To inherit functions from other back ends (and allow other back ends to
28516 inherit functions from the current back end), you should use the
28522 This macro declares the first parameter to be a child of the subsequent
28523 parameters. For instance:
28526 (nnoo-declare nndir
28530 @code{nndir} has declared here that it intends to inherit functions from
28531 both @code{nnml} and @code{nnmh}.
28534 This macro is equivalent to @code{defvar}, but registers the variable as
28535 a public server variable. Most state-oriented variables should be
28536 declared with @code{defvoo} instead of @code{defvar}.
28538 In addition to the normal @code{defvar} parameters, it takes a list of
28539 variables in the parent back ends to map the variable to when executing
28540 a function in those back ends.
28543 (defvoo nndir-directory nil
28544 "Where nndir will look for groups."
28545 nnml-current-directory nnmh-current-directory)
28548 This means that @code{nnml-current-directory} will be set to
28549 @code{nndir-directory} when an @code{nnml} function is called on behalf
28550 of @code{nndir}. (The same with @code{nnmh}.)
28552 @item nnoo-define-basics
28553 This macro defines some common functions that almost all back ends should
28557 (nnoo-define-basics nndir)
28561 This macro is just like @code{defun} and takes the same parameters. In
28562 addition to doing the normal @code{defun} things, it registers the
28563 function as being public so that other back ends can inherit it.
28565 @item nnoo-map-functions
28566 This macro allows mapping of functions from the current back end to
28567 functions from the parent back ends.
28570 (nnoo-map-functions nndir
28571 (nnml-retrieve-headers 0 nndir-current-group 0 0)
28572 (nnmh-request-article 0 nndir-current-group 0 0))
28575 This means that when @code{nndir-retrieve-headers} is called, the first,
28576 third, and fourth parameters will be passed on to
28577 @code{nnml-retrieve-headers}, while the second parameter is set to the
28578 value of @code{nndir-current-group}.
28581 This macro allows importing functions from back ends. It should be the
28582 last thing in the source file, since it will only define functions that
28583 haven't already been defined.
28589 nnmh-request-newgroups)
28593 This means that calls to @code{nndir-request-list} should just be passed
28594 on to @code{nnmh-request-list}, while all public functions from
28595 @code{nnml} that haven't been defined in @code{nndir} yet should be
28600 Below is a slightly shortened version of the @code{nndir} back end.
28603 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
28604 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
28608 (require 'nnheader)
28612 (eval-when-compile (require 'cl))
28614 (nnoo-declare nndir
28617 (defvoo nndir-directory nil
28618 "Where nndir will look for groups."
28619 nnml-current-directory nnmh-current-directory)
28621 (defvoo nndir-nov-is-evil nil
28622 "*Non-nil means that nndir will never retrieve NOV headers."
28625 (defvoo nndir-current-group ""
28627 nnml-current-group nnmh-current-group)
28628 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
28629 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
28631 (defvoo nndir-status-string "" nil nnmh-status-string)
28632 (defconst nndir-version "nndir 1.0")
28634 ;;; @r{Interface functions.}
28636 (nnoo-define-basics nndir)
28638 (deffoo nndir-open-server (server &optional defs)
28639 (setq nndir-directory
28640 (or (cadr (assq 'nndir-directory defs))
28642 (unless (assq 'nndir-directory defs)
28643 (push `(nndir-directory ,server) defs))
28644 (push `(nndir-current-group
28645 ,(file-name-nondirectory
28646 (directory-file-name nndir-directory)))
28648 (push `(nndir-top-directory
28649 ,(file-name-directory (directory-file-name nndir-directory)))
28651 (nnoo-change-server 'nndir server defs))
28653 (nnoo-map-functions nndir
28654 (nnml-retrieve-headers 0 nndir-current-group 0 0)
28655 (nnmh-request-article 0 nndir-current-group 0 0)
28656 (nnmh-request-group nndir-current-group 0 0)
28657 (nnmh-close-group nndir-current-group 0))
28661 nnmh-status-message
28663 nnmh-request-newgroups))
28669 @node Hooking New Back Ends Into Gnus
28670 @subsubsection Hooking New Back Ends Into Gnus
28672 @vindex gnus-valid-select-methods
28673 @findex gnus-declare-backend
28674 Having Gnus start using your new back end is rather easy---you just
28675 declare it with the @code{gnus-declare-backend} functions. This will
28676 enter the back end into the @code{gnus-valid-select-methods} variable.
28678 @code{gnus-declare-backend} takes two parameters---the back end name and
28679 an arbitrary number of @dfn{abilities}.
28684 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
28687 The above line would then go in the @file{nnchoke.el} file.
28689 The abilities can be:
28693 This is a mailish back end---followups should (probably) go via mail.
28695 This is a newsish back end---followups should (probably) go via news.
28697 This back end supports both mail and news.
28699 This is neither a post nor mail back end---it's something completely
28702 It supports respooling---or rather, it is able to modify its source
28703 articles and groups.
28705 The name of the server should be in the virtual server name. This is
28706 true for almost all back ends.
28707 @item prompt-address
28708 The user should be prompted for an address when doing commands like
28709 @kbd{B} in the group buffer. This is true for back ends like
28710 @code{nntp}, but not @code{nnmbox}, for instance.
28714 @node Mail-like Back Ends
28715 @subsubsection Mail-like Back Ends
28717 One of the things that separate the mail back ends from the rest of the
28718 back ends is the heavy dependence by most of the mail back ends on
28719 common functions in @file{nnmail.el}. For instance, here's the
28720 definition of @code{nnml-request-scan}:
28723 (deffoo nnml-request-scan (&optional group server)
28724 (setq nnml-article-file-alist nil)
28725 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
28728 It simply calls @code{nnmail-get-new-mail} with a few parameters,
28729 and @code{nnmail} takes care of all the moving and splitting of the
28732 This function takes four parameters.
28736 This should be a symbol to designate which back end is responsible for
28739 @item exit-function
28740 This function should be called after the splitting has been performed.
28742 @item temp-directory
28743 Where the temporary files should be stored.
28746 This optional argument should be a group name if the splitting is to be
28747 performed for one group only.
28750 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
28751 save each article. @var{back-end}@code{-active-number} will be called to
28752 find the article number assigned to this article.
28754 The function also uses the following variables:
28755 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
28756 this back end); and @var{back-end}@code{-group-alist} and
28757 @var{back-end}@code{-active-file} to generate the new active file.
28758 @var{back-end}@code{-group-alist} should be a group-active alist, like
28762 (("a-group" (1 . 10))
28763 ("some-group" (34 . 39)))
28767 @node Score File Syntax
28768 @subsection Score File Syntax
28770 Score files are meant to be easily parseable, but yet extremely
28771 mallable. It was decided that something that had the same read syntax
28772 as an Emacs Lisp list would fit that spec.
28774 Here's a typical score file:
28778 ("win95" -10000 nil s)
28785 BNF definition of a score file:
28788 score-file = "" / "(" *element ")"
28789 element = rule / atom
28790 rule = string-rule / number-rule / date-rule
28791 string-rule = "(" quote string-header quote space *string-match ")"
28792 number-rule = "(" quote number-header quote space *number-match ")"
28793 date-rule = "(" quote date-header quote space *date-match ")"
28795 string-header = "subject" / "from" / "references" / "message-id" /
28796 "xref" / "body" / "head" / "all" / "followup"
28797 number-header = "lines" / "chars"
28798 date-header = "date"
28799 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
28800 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
28801 score = "nil" / <integer>
28802 date = "nil" / <natural number>
28803 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
28804 "r" / "regex" / "R" / "Regex" /
28805 "e" / "exact" / "E" / "Exact" /
28806 "f" / "fuzzy" / "F" / "Fuzzy"
28807 number-match = "(" <integer> [ "" / [ space score [ "" /
28808 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
28809 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
28810 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
28811 space date [ "" / [ space date-match-t ] ] ] ] ")"
28812 date-match-t = "nil" / "at" / "before" / "after"
28813 atom = "(" [ required-atom / optional-atom ] ")"
28814 required-atom = mark / expunge / mark-and-expunge / files /
28815 exclude-files / read-only / touched
28816 optional-atom = adapt / local / eval
28817 mark = "mark" space nil-or-number
28818 nil-or-number = "nil" / <integer>
28819 expunge = "expunge" space nil-or-number
28820 mark-and-expunge = "mark-and-expunge" space nil-or-number
28821 files = "files" *[ space <string> ]
28822 exclude-files = "exclude-files" *[ space <string> ]
28823 read-only = "read-only" [ space "nil" / space "t" ]
28824 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
28825 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
28826 local = "local" *[ space "(" <string> space <form> ")" ]
28827 eval = "eval" space <form>
28828 space = *[ " " / <TAB> / <NEWLINE> ]
28831 Any unrecognized elements in a score file should be ignored, but not
28834 As you can see, white space is needed, but the type and amount of white
28835 space is irrelevant. This means that formatting of the score file is
28836 left up to the programmer---if it's simpler to just spew it all out on
28837 one looong line, then that's ok.
28839 The meaning of the various atoms are explained elsewhere in this
28840 manual (@pxref{Score File Format}).
28844 @subsection Headers
28846 Internally Gnus uses a format for storing article headers that
28847 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
28848 almost suspect that the author looked at the @acronym{NOV} specification and
28849 just shamelessly @emph{stole} the entire thing, and one would be right.
28851 @dfn{Header} is a severely overloaded term. ``Header'' is used in
28852 RFC 1036 to talk about lines in the head of an article (e.g.,
28853 @code{From}). It is used by many people as a synonym for
28854 ``head''---``the header and the body''. (That should be avoided, in my
28855 opinion.) And Gnus uses a format internally that it calls ``header'',
28856 which is what I'm talking about here. This is a 9-element vector,
28857 basically, with each header (ouch) having one slot.
28859 These slots are, in order: @code{number}, @code{subject}, @code{from},
28860 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
28861 @code{xref}, and @code{extra}. There are macros for accessing and
28862 setting these slots---they all have predictable names beginning with
28863 @code{mail-header-} and @code{mail-header-set-}, respectively.
28865 All these slots contain strings, except the @code{extra} slot, which
28866 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
28872 @sc{gnus} introduced a concept that I found so useful that I've started
28873 using it a lot and have elaborated on it greatly.
28875 The question is simple: If you have a large amount of objects that are
28876 identified by numbers (say, articles, to take a @emph{wild} example)
28877 that you want to qualify as being ``included'', a normal sequence isn't
28878 very useful. (A 200,000 length sequence is a bit long-winded.)
28880 The solution is as simple as the question: You just collapse the
28884 (1 2 3 4 5 6 10 11 12)
28887 is transformed into
28890 ((1 . 6) (10 . 12))
28893 To avoid having those nasty @samp{(13 . 13)} elements to denote a
28894 lonesome object, a @samp{13} is a valid element:
28897 ((1 . 6) 7 (10 . 12))
28900 This means that comparing two ranges to find out whether they are equal
28901 is slightly tricky:
28904 ((1 . 5) 7 8 (10 . 12))
28910 ((1 . 5) (7 . 8) (10 . 12))
28913 are equal. In fact, any non-descending list is a range:
28919 is a perfectly valid range, although a pretty long-winded one. This is
28926 and is equal to the previous range.
28928 Here's a BNF definition of ranges. Of course, one must remember the
28929 semantic requirement that the numbers are non-descending. (Any number
28930 of repetition of the same number is allowed, but apt to disappear in
28934 range = simple-range / normal-range
28935 simple-range = "(" number " . " number ")"
28936 normal-range = "(" start-contents ")"
28937 contents = "" / simple-range *[ " " contents ] /
28938 number *[ " " contents ]
28941 Gnus currently uses ranges to keep track of read articles and article
28942 marks. I plan on implementing a number of range operators in C if The
28943 Powers That Be are willing to let me. (I haven't asked yet, because I
28944 need to do some more thinking on what operators I need to make life
28945 totally range-based without ever having to convert back to normal
28950 @subsection Group Info
28952 Gnus stores all permanent info on groups in a @dfn{group info} list.
28953 This list is from three to six elements (or more) long and exhaustively
28954 describes the group.
28956 Here are two example group infos; one is a very simple group while the
28957 second is a more complex one:
28960 ("no.group" 5 ((1 . 54324)))
28962 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
28963 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
28965 ((auto-expire . t) (to-address . "ding@@gnus.org")))
28968 The first element is the @dfn{group name}---as Gnus knows the group,
28969 anyway. The second element is the @dfn{subscription level}, which
28970 normally is a small integer. (It can also be the @dfn{rank}, which is a
28971 cons cell where the @code{car} is the level and the @code{cdr} is the
28972 score.) The third element is a list of ranges of read articles. The
28973 fourth element is a list of lists of article marks of various kinds.
28974 The fifth element is the select method (or virtual server, if you like).
28975 The sixth element is a list of @dfn{group parameters}, which is what
28976 this section is about.
28978 Any of the last three elements may be missing if they are not required.
28979 In fact, the vast majority of groups will normally only have the first
28980 three elements, which saves quite a lot of cons cells.
28982 Here's a BNF definition of the group info format:
28985 info = "(" group space ralevel space read
28986 [ "" / [ space marks-list [ "" / [ space method [ "" /
28987 space parameters ] ] ] ] ] ")"
28988 group = quote <string> quote
28989 ralevel = rank / level
28990 level = <integer in the range of 1 to inf>
28991 rank = "(" level "." score ")"
28992 score = <integer in the range of 1 to inf>
28994 marks-lists = nil / "(" *marks ")"
28995 marks = "(" <string> range ")"
28996 method = "(" <string> *elisp-forms ")"
28997 parameters = "(" *elisp-forms ")"
29000 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
29001 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
29004 If you have a Gnus info and want to access the elements, Gnus offers a
29005 series of macros for getting/setting these elements.
29008 @item gnus-info-group
29009 @itemx gnus-info-set-group
29010 @findex gnus-info-group
29011 @findex gnus-info-set-group
29012 Get/set the group name.
29014 @item gnus-info-rank
29015 @itemx gnus-info-set-rank
29016 @findex gnus-info-rank
29017 @findex gnus-info-set-rank
29018 Get/set the group rank (@pxref{Group Score}).
29020 @item gnus-info-level
29021 @itemx gnus-info-set-level
29022 @findex gnus-info-level
29023 @findex gnus-info-set-level
29024 Get/set the group level.
29026 @item gnus-info-score
29027 @itemx gnus-info-set-score
29028 @findex gnus-info-score
29029 @findex gnus-info-set-score
29030 Get/set the group score (@pxref{Group Score}).
29032 @item gnus-info-read
29033 @itemx gnus-info-set-read
29034 @findex gnus-info-read
29035 @findex gnus-info-set-read
29036 Get/set the ranges of read articles.
29038 @item gnus-info-marks
29039 @itemx gnus-info-set-marks
29040 @findex gnus-info-marks
29041 @findex gnus-info-set-marks
29042 Get/set the lists of ranges of marked articles.
29044 @item gnus-info-method
29045 @itemx gnus-info-set-method
29046 @findex gnus-info-method
29047 @findex gnus-info-set-method
29048 Get/set the group select method.
29050 @item gnus-info-params
29051 @itemx gnus-info-set-params
29052 @findex gnus-info-params
29053 @findex gnus-info-set-params
29054 Get/set the group parameters.
29057 All the getter functions take one parameter---the info list. The setter
29058 functions take two parameters---the info list and the new value.
29060 The last three elements in the group info aren't mandatory, so it may be
29061 necessary to extend the group info before setting the element. If this
29062 is necessary, you can just pass on a non-@code{nil} third parameter to
29063 the three final setter functions to have this happen automatically.
29066 @node Extended Interactive
29067 @subsection Extended Interactive
29068 @cindex interactive
29069 @findex gnus-interactive
29071 Gnus extends the standard Emacs @code{interactive} specification
29072 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
29073 Prefixes}). Here's an example of how this is used:
29076 (defun gnus-summary-increase-score (&optional score symp)
29077 (interactive (gnus-interactive "P\ny"))
29082 The best thing to do would have been to implement
29083 @code{gnus-interactive} as a macro which would have returned an
29084 @code{interactive} form, but this isn't possible since Emacs checks
29085 whether a function is interactive or not by simply doing an @code{assq}
29086 on the lambda form. So, instead we have @code{gnus-interactive}
29087 function that takes a string and returns values that are usable to
29088 @code{interactive}.
29090 This function accepts (almost) all normal @code{interactive} specs, but
29095 @vindex gnus-current-prefix-symbol
29096 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
29100 @vindex gnus-current-prefix-symbols
29101 A list of the current symbolic prefixes---the
29102 @code{gnus-current-prefix-symbol} variable.
29105 The current article number---the @code{gnus-summary-article-number}
29109 The current article header---the @code{gnus-summary-article-header}
29113 The current group name---the @code{gnus-group-group-name}
29119 @node Emacs/XEmacs Code
29120 @subsection Emacs/XEmacs Code
29124 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
29125 platforms must be the primary one. I chose Emacs. Not because I don't
29126 like XEmacs or Mule, but because it comes first alphabetically.
29128 This means that Gnus will byte-compile under Emacs with nary a warning,
29129 while XEmacs will pump out gigabytes of warnings while byte-compiling.
29130 As I use byte-compilation warnings to help me root out trivial errors in
29131 Gnus, that's very useful.
29133 I've also consistently used Emacs function interfaces, but have used
29134 Gnusey aliases for the functions. To take an example: Emacs defines a
29135 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
29136 function. I then define a function called @code{gnus-run-at-time} that
29137 takes the same parameters as the Emacs @code{run-at-time}. When running
29138 Gnus under Emacs, the former function is just an alias for the latter.
29139 However, when running under XEmacs, the former is an alias for the
29140 following function:
29143 (defun gnus-xmas-run-at-time (time repeat function &rest args)
29147 (,function ,@@args))
29151 This sort of thing has been done for bunches of functions. Gnus does
29152 not redefine any native Emacs functions while running under XEmacs---it
29153 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
29156 In the cases where the XEmacs function interface was obviously cleaner,
29157 I used it instead. For example @code{gnus-region-active-p} is an alias
29158 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
29160 Of course, I could have chosen XEmacs as my native platform and done
29161 mapping functions the other way around. But I didn't. The performance
29162 hit these indirections impose on Gnus under XEmacs should be slight.
29165 @node Various File Formats
29166 @subsection Various File Formats
29169 * Active File Format:: Information on articles and groups available.
29170 * Newsgroups File Format:: Group descriptions.
29174 @node Active File Format
29175 @subsubsection Active File Format
29177 The active file lists all groups available on the server in
29178 question. It also lists the highest and lowest current article numbers
29181 Here's an excerpt from a typical active file:
29184 soc.motss 296030 293865 y
29185 alt.binaries.pictures.fractals 3922 3913 n
29186 comp.sources.unix 1605 1593 m
29187 comp.binaries.ibm.pc 5097 5089 y
29188 no.general 1000 900 y
29191 Here's a pseudo-BNF definition of this file:
29194 active = *group-line
29195 group-line = group spc high-number spc low-number spc flag <NEWLINE>
29196 group = <non-white-space string>
29198 high-number = <non-negative integer>
29199 low-number = <positive integer>
29200 flag = "y" / "n" / "m" / "j" / "x" / "=" group
29203 For a full description of this file, see the manual pages for
29204 @samp{innd}, in particular @samp{active(5)}.
29207 @node Newsgroups File Format
29208 @subsubsection Newsgroups File Format
29210 The newsgroups file lists groups along with their descriptions. Not all
29211 groups on the server have to be listed, and not all groups in the file
29212 have to exist on the server. The file is meant purely as information to
29215 The format is quite simple; a group name, a tab, and the description.
29216 Here's the definition:
29220 line = group tab description <NEWLINE>
29221 group = <non-white-space string>
29223 description = <string>
29228 @node Emacs for Heathens
29229 @section Emacs for Heathens
29231 Believe it or not, but some people who use Gnus haven't really used
29232 Emacs much before they embarked on their journey on the Gnus Love Boat.
29233 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
29234 region'', and ``set @code{gnus-flargblossen} to an alist where the key
29235 is a regexp that is used for matching on the group name'' are magical
29236 phrases with little or no meaning, then this appendix is for you. If
29237 you are already familiar with Emacs, just ignore this and go fondle your
29241 * Keystrokes:: Entering text and executing commands.
29242 * Emacs Lisp:: The built-in Emacs programming language.
29247 @subsection Keystrokes
29251 Q: What is an experienced Emacs user?
29254 A: A person who wishes that the terminal had pedals.
29257 Yes, when you use Emacs, you are apt to use the control key, the shift
29258 key and the meta key a lot. This is very annoying to some people
29259 (notably @code{vi}le users), and the rest of us just love the hell out
29260 of it. Just give up and submit. Emacs really does stand for
29261 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
29262 may have heard from other disreputable sources (like the Emacs author).
29264 The shift keys are normally located near your pinky fingers, and are
29265 normally used to get capital letters and stuff. You probably use it all
29266 the time. The control key is normally marked ``CTRL'' or something like
29267 that. The meta key is, funnily enough, never marked as such on any
29268 keyboard. The one I'm currently at has a key that's marked ``Alt'',
29269 which is the meta key on this keyboard. It's usually located somewhere
29270 to the left hand side of the keyboard, usually on the bottom row.
29272 Now, us Emacs people don't say ``press the meta-control-m key'',
29273 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
29274 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
29275 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
29276 down the control key, and hold it down while you press @kbd{k}''.
29277 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
29278 the control key and then press @kbd{k}''. Simple, ay?
29280 This is somewhat complicated by the fact that not all keyboards have a
29281 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
29282 means ``press escape, release escape, press @kbd{k}''. That's much more
29283 work than if you have a meta key, so if that's the case, I respectfully
29284 suggest you get a real keyboard with a meta key. You can't live without
29290 @subsection Emacs Lisp
29292 Emacs is the King of Editors because it's really a Lisp interpreter.
29293 Each and every key you tap runs some Emacs Lisp code snippet, and since
29294 Emacs Lisp is an interpreted language, that means that you can configure
29295 any key to run any arbitrary code. You just, like, do it.
29297 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
29298 functions. (These are byte-compiled for speed, but it's still
29299 interpreted.) If you decide that you don't like the way Gnus does
29300 certain things, it's trivial to have it do something a different way.
29301 (Well, at least if you know how to write Lisp code.) However, that's
29302 beyond the scope of this manual, so we are simply going to talk about
29303 some common constructs that you normally use in your @file{~/.gnus.el}
29304 file to customize Gnus. (You can also use the @file{~/.emacs} file, but
29305 in order to set things of Gnus up, it is much better to use the
29306 @file{~/.gnus.el} file, @xref{Startup Files}.)
29308 If you want to set the variable @code{gnus-florgbnize} to four (4), you
29309 write the following:
29312 (setq gnus-florgbnize 4)
29315 This function (really ``special form'') @code{setq} is the one that can
29316 set a variable to some value. This is really all you need to know. Now
29317 you can go and fill your @file{~/.gnus.el} file with lots of these to
29318 change how Gnus works.
29320 If you have put that thing in your @file{~/.gnus.el} file, it will be
29321 read and @code{eval}ed (which is Lisp-ese for ``run'') the next time you
29322 start Gnus. If you want to change the variable right away, simply say
29323 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
29324 previous ``form'', which is a simple @code{setq} statement here.
29326 Go ahead---just try it, if you're located at your Emacs. After you
29327 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
29328 is the return value of the form you @code{eval}ed.
29332 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
29336 (setq gnus-read-active-file 'some)
29339 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
29340 @samp{nntp.ifi.uio.no}'', that means:
29343 (setq gnus-nntp-server "nntp.ifi.uio.no")
29346 So be careful not to mix up strings (the latter) with symbols (the
29347 former). The manual is unambiguous, but it can be confusing.
29350 @include gnus-faq.texi
29370 @c Local Variables:
29372 @c coding: iso-8859-1