9 @documentencoding ISO-8859-1
12 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
13 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.2 or
18 any later version published by the Free Software Foundation; with no
19 Invariant Sections, with the Front-Cover texts being ``A GNU
20 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
21 license is included in the section entitled ``GNU Free Documentation
22 License'' in the Emacs manual.
24 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
25 this GNU Manual, like GNU software. Copies published by the Free
26 Software Foundation raise funds for GNU development.''
28 This document is part of a collection distributed under the GNU Free
29 Documentation License. If you want to distribute this document
30 separately from the collection, you can do so by adding a copy of the
31 license to the document, as described in section 6 of the license.
37 \documentclass[twoside,a4paper,openright,11pt]{book}
38 \usepackage[latin1]{inputenc}
39 \usepackage{pagestyle}
42 \input{gnusconfig.tex}
44 \ifx\pdfoutput\undefined
46 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
54 % Adjust ../Makefile.in if you change the following line:
55 \newcommand{\gnusversionname}{No Gnus v0.7}
56 \newcommand{\gnuschaptername}{}
57 \newcommand{\gnussectionname}{}
59 \newcommand{\gnusbackslash}{/}
61 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
62 \ifx\pdfoutput\undefined
63 \newcommand{\gnusuref}[1]{\gnustt{#1}}
65 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
67 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
68 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
70 \newcommand{\gnuskindex}[1]{\index{#1}}
71 \newcommand{\gnusindex}[1]{\index{#1}}
73 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
74 \newcommand{\gnuscode}[1]{\gnustt{#1}}
75 \newcommand{\gnusasis}[1]{\gnustt{#1}}
76 \newcommand{\gnusurl}[1]{\gnustt{#1}}
77 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
78 \newcommand{\gnusenv}[1]{\gnustt{#1}}
79 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
80 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
81 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
82 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
83 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
84 \newcommand{\gnusdfn}[1]{\textit{#1}}
85 \newcommand{\gnusi}[1]{\textit{#1}}
86 \newcommand{\gnusr}[1]{\textrm{#1}}
87 \newcommand{\gnusstrong}[1]{\textbf{#1}}
88 \newcommand{\gnusemph}[1]{\textit{#1}}
89 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
90 \newcommand{\gnussc}[1]{\textsc{#1}}
91 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
92 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
93 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
94 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
95 \newcommand{\gnusacronym}[1]{\textsc{#1}}
96 \newcommand{\gnusemail}[1]{\textit{#1}}
98 \newcommand{\gnusbullet}{{${\bullet}$}}
99 \newcommand{\gnusdollar}{\$}
100 \newcommand{\gnusampersand}{\&}
101 \newcommand{\gnuspercent}{\%}
102 \newcommand{\gnushash}{\#}
103 \newcommand{\gnushat}{\symbol{"5E}}
104 \newcommand{\gnusunderline}{\symbol{"5F}}
105 \newcommand{\gnusnot}{$\neg$}
106 \newcommand{\gnustilde}{\symbol{"7E}}
107 \newcommand{\gnusless}{{$<$}}
108 \newcommand{\gnusgreater}{{$>$}}
109 \newcommand{\gnusbraceleft}{{$>$}}
110 \newcommand{\gnusbraceright}{{$>$}}
112 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
113 \newcommand{\gnusinteresting}{
114 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
117 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
119 \newcommand{\gnuspagechapter}[1]{
123 \newdimen{\gnusdimen}
126 \newcommand{\gnuschapter}[2]{
128 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
130 \renewcommand{\gnussectionname}{}
131 \renewcommand{\gnuschaptername}{#2}
132 \thispagestyle{empty}
134 \begin{picture}(500,500)(0,0)
135 \put(480,350){\makebox(0,0)[tr]{#1}}
136 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
141 \newcommand{\gnusfigure}[3]{
143 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
150 \newcommand{\gnusicon}[1]{
151 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
154 \newcommand{\gnuspicon}[1]{
155 \margindex{\epsfig{figure=#1,width=2cm}}
158 \newcommand{\gnusxface}[2]{
159 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
162 \newcommand{\gnussmiley}[2]{
163 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
166 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
168 \newcommand{\gnussection}[1]{
169 \renewcommand{\gnussectionname}{#1}
173 \newenvironment{codelist}%
178 \newenvironment{asislist}%
183 \newenvironment{kbdlist}%
189 \newenvironment{dfnlist}%
194 \newenvironment{stronglist}%
199 \newenvironment{samplist}%
204 \newenvironment{varlist}%
209 \newenvironment{emphlist}%
214 \newlength\gnusheadtextwidth
215 \setlength{\gnusheadtextwidth}{\headtextwidth}
216 \addtolength{\gnusheadtextwidth}{1cm}
218 \newpagestyle{gnuspreamble}%
223 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
227 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
236 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
238 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
243 \newpagestyle{gnusindex}%
248 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
252 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
260 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
262 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
272 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
276 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
284 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
286 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
291 \pagenumbering{roman}
292 \pagestyle{gnuspreamble}
303 %\addtolength{\oddsidemargin}{-5cm}
304 %\addtolength{\evensidemargin}{-5cm}
306 \addtolength{\textheight}{2cm}
308 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
311 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
314 \gnusauthor{by Lars Magne Ingebrigtsen}
321 \thispagestyle{empty}
335 * Gnus: (gnus). The newsreader Gnus.
340 @setchapternewpage odd
347 @author by Lars Magne Ingebrigtsen
349 @vskip 0pt plus 1filll
355 @top The Gnus Newsreader
359 You can read news (and mail) from within Emacs by using Gnus. The news
360 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
361 spool or your mbox file. All at the same time, if you want to push your
364 @c Adjust ../Makefile.in if you change the following line:
365 This manual corresponds to No Gnus v0.7.
376 Gnus is the advanced, self-documenting, customizable, extensible
377 unreal-time newsreader for GNU Emacs.
379 Oops. That sounds oddly familiar, so let's start over again to avoid
380 being accused of plagiarism:
382 Gnus is a message-reading laboratory. It will let you look at just
383 about anything as if it were a newsgroup. You can read mail with it,
384 you can browse directories with it, you can @code{ftp} with it---you
385 can even read news with it!
387 Gnus tries to empower people who read news the same way Emacs empowers
388 people who edit text. Gnus sets no limits to what the user should be
389 allowed to do. Users are encouraged to extend Gnus to make it behave
390 like they want it to behave. A program should not control people;
391 people should be empowered to do what they want by using (or abusing)
397 * Starting Up:: Finding news can be a pain.
398 * Group Buffer:: Selecting, subscribing and killing groups.
399 * Summary Buffer:: Reading, saving and posting articles.
400 * Article Buffer:: Displaying and handling articles.
401 * Composing Messages:: Information on sending mail and news.
402 * Select Methods:: Gnus reads all messages from various select methods.
403 * Scoring:: Assigning values to articles.
404 * Various:: General purpose settings.
405 * The End:: Farewell and goodbye.
406 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
407 * GNU Free Documentation License:: The license for this documentation.
408 * Index:: Variable, function and concept index.
409 * Key Index:: Key Index.
411 Other related manuals
413 * Message:(message). Composing messages.
414 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
415 * Sieve:(sieve). Managing Sieve scripts in Emacs.
416 * PGG:(pgg). @acronym{PGP/MIME} with Gnus.
417 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
420 --- The Detailed Node Listing ---
424 * Finding the News:: Choosing a method for getting news.
425 * The First Time:: What does Gnus do the first time you start it?
426 * The Server is Down:: How can I read my mail then?
427 * Slave Gnusae:: You can have more than one Gnus active at a time.
428 * Fetching a Group:: Starting Gnus just to read a group.
429 * New Groups:: What is Gnus supposed to do with new groups?
430 * Changing Servers:: You may want to move from one server to another.
431 * Startup Files:: Those pesky startup files---@file{.newsrc}.
432 * Auto Save:: Recovering from a crash.
433 * The Active File:: Reading the active file over a slow line Takes Time.
434 * Startup Variables:: Other variables you might change.
438 * Checking New Groups:: Determining what groups are new.
439 * Subscription Methods:: What Gnus should do with new groups.
440 * Filtering New Groups:: Making Gnus ignore certain new groups.
444 * Group Buffer Format:: Information listed and how you can change it.
445 * Group Maneuvering:: Commands for moving in the group buffer.
446 * Selecting a Group:: Actually reading news.
447 * Subscription Commands:: Unsubscribing, killing, subscribing.
448 * Group Data:: Changing the info for a group.
449 * Group Levels:: Levels? What are those, then?
450 * Group Score:: A mechanism for finding out what groups you like.
451 * Marking Groups:: You can mark groups for later processing.
452 * Foreign Groups:: Creating and editing groups.
453 * Group Parameters:: Each group may have different parameters set.
454 * Listing Groups:: Gnus can list various subsets of the groups.
455 * Sorting Groups:: Re-arrange the group order.
456 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
457 * Browse Foreign Server:: You can browse a server. See what it has to offer.
458 * Exiting Gnus:: Stop reading news and get some work done.
459 * Group Topics:: A folding group mode divided into topics.
460 * Misc Group Stuff:: Other stuff that you can to do.
464 * Group Line Specification:: Deciding how the group buffer is to look.
465 * Group Mode Line Specification:: The group buffer mode line.
466 * Group Highlighting:: Having nice colors in the group buffer.
470 * Topic Commands:: Interactive E-Z commands.
471 * Topic Variables:: How to customize the topics the Lisp Way.
472 * Topic Sorting:: Sorting each topic individually.
473 * Topic Topology:: A map of the world.
474 * Topic Parameters:: Parameters that apply to all groups in a topic.
478 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
479 * Group Information:: Information and help on groups and Gnus.
480 * Group Timestamp:: Making Gnus keep track of when you last read a group.
481 * File Commands:: Reading and writing the Gnus files.
482 * Sieve Commands:: Managing Sieve scripts.
486 * Summary Buffer Format:: Deciding how the summary buffer is to look.
487 * Summary Maneuvering:: Moving around the summary buffer.
488 * Choosing Articles:: Reading articles.
489 * Paging the Article:: Scrolling the current article.
490 * Reply Followup and Post:: Posting articles.
491 * Delayed Articles:: Send articles at a later time.
492 * Marking Articles:: Marking articles as read, expirable, etc.
493 * Limiting:: You can limit the summary buffer.
494 * Threading:: How threads are made.
495 * Sorting the Summary Buffer:: How articles and threads are sorted.
496 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
497 * Article Caching:: You may store articles in a cache.
498 * Persistent Articles:: Making articles expiry-resistant.
499 * Article Backlog:: Having already read articles hang around.
500 * Saving Articles:: Ways of customizing article saving.
501 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
502 * Article Treatment:: The article buffer can be mangled at will.
503 * MIME Commands:: Doing MIMEy things with the articles.
504 * Charsets:: Character set issues.
505 * Article Commands:: Doing various things with the article buffer.
506 * Summary Sorting:: Sorting the summary buffer in various ways.
507 * Finding the Parent:: No child support? Get the parent.
508 * Alternative Approaches:: Reading using non-default summaries.
509 * Tree Display:: A more visual display of threads.
510 * Mail Group Commands:: Some commands can only be used in mail groups.
511 * Various Summary Stuff:: What didn't fit anywhere else.
512 * Exiting the Summary Buffer:: Returning to the Group buffer,
513 or reselecting the current group.
514 * Crosspost Handling:: How crossposted articles are dealt with.
515 * Duplicate Suppression:: An alternative when crosspost handling fails.
516 * Security:: Decrypt and Verify.
517 * Mailing List:: Mailing list minor mode.
519 Summary Buffer Format
521 * Summary Buffer Lines:: You can specify how summary lines should look.
522 * To From Newsgroups:: How to not display your own name.
523 * Summary Buffer Mode Line:: You can say how the mode line should look.
524 * Summary Highlighting:: Making the summary buffer all pretty and nice.
528 * Choosing Commands:: Commands for choosing articles.
529 * Choosing Variables:: Variables that influence these commands.
531 Reply, Followup and Post
533 * Summary Mail Commands:: Sending mail.
534 * Summary Post Commands:: Sending news.
535 * Summary Message Commands:: Other Message-related commands.
536 * Canceling and Superseding::
540 * Unread Articles:: Marks for unread articles.
541 * Read Articles:: Marks for read articles.
542 * Other Marks:: Marks that do not affect readedness.
543 * Setting Marks:: How to set and remove marks.
544 * Generic Marking Commands:: How to customize the marking.
545 * Setting Process Marks:: How to mark articles for later processing.
549 * Customizing Threading:: Variables you can change to affect the threading.
550 * Thread Commands:: Thread based commands in the summary buffer.
552 Customizing Threading
554 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
555 * Filling In Threads:: Making the threads displayed look fuller.
556 * More Threading:: Even more variables for fiddling with threads.
557 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
561 * Uuencoded Articles:: Uudecode articles.
562 * Shell Archives:: Unshar articles.
563 * PostScript Files:: Split PostScript.
564 * Other Files:: Plain save and binhex.
565 * Decoding Variables:: Variables for a happy decoding.
566 * Viewing Files:: You want to look at the result of the decoding?
570 * Rule Variables:: Variables that say how a file is to be viewed.
571 * Other Decode Variables:: Other decode variables.
572 * Uuencoding and Posting:: Variables for customizing uuencoding.
576 * Article Highlighting:: You want to make the article look like fruit salad.
577 * Article Fontisizing:: Making emphasized text look nice.
578 * Article Hiding:: You also want to make certain info go away.
579 * Article Washing:: Lots of way-neat functions to make life better.
580 * Article Header:: Doing various header transformations.
581 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
582 * Article Button Levels:: Controlling appearance of buttons.
583 * Article Date:: Grumble, UT!
584 * Article Display:: Display various stuff---X-Face, Picons, Smileys
585 * Article Signature:: What is a signature?
586 * Article Miscellanea:: Various other stuff.
588 Alternative Approaches
590 * Pick and Read:: First mark articles and then read them.
591 * Binary Groups:: Auto-decode all articles.
593 Various Summary Stuff
595 * Summary Group Information:: Information oriented commands.
596 * Searching for Articles:: Multiple article commands.
597 * Summary Generation Commands::
598 * Really Various Summary Commands:: Those pesky non-conformant commands.
602 * Hiding Headers:: Deciding what headers should be displayed.
603 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
604 * Customizing Articles:: Tailoring the look of the articles.
605 * Article Keymap:: Keystrokes available in the article buffer.
606 * Misc Article:: Other stuff.
610 * Mail:: Mailing and replying.
611 * Posting Server:: What server should you post and mail via?
612 * POP before SMTP:: You cannot send a mail unless you read a mail.
613 * Mail and Post:: Mailing and posting at the same time.
614 * Archived Messages:: Where Gnus stores the messages you've sent.
615 * Posting Styles:: An easier way to specify who you are.
616 * Drafts:: Postponing messages and rejected messages.
617 * Rejected Articles:: What happens if the server doesn't like your article?
618 * Signing and encrypting:: How to compose secure messages.
622 * Server Buffer:: Making and editing virtual servers.
623 * Getting News:: Reading USENET news with Gnus.
624 * Getting Mail:: Reading your personal mail with Gnus.
625 * Browsing the Web:: Getting messages from a plethora of Web sources.
626 * IMAP:: Using Gnus as a @acronym{IMAP} client.
627 * Other Sources:: Reading directories, files, SOUP packets.
628 * Combined Groups:: Combining groups into one group.
629 * Email Based Diary:: Using mails to manage diary events in Gnus.
630 * Gnus Unplugged:: Reading news and mail offline.
634 * Server Buffer Format:: You can customize the look of this buffer.
635 * Server Commands:: Commands to manipulate servers.
636 * Example Methods:: Examples server specifications.
637 * Creating a Virtual Server:: An example session.
638 * Server Variables:: Which variables to set.
639 * Servers and Methods:: You can use server names as select methods.
640 * Unavailable Servers:: Some servers you try to contact may be down.
644 * NNTP:: Reading news from an @acronym{NNTP} server.
645 * News Spool:: Reading news from the local spool.
649 * Direct Functions:: Connecting directly to the server.
650 * Indirect Functions:: Connecting indirectly to the server.
651 * Common Variables:: Understood by several connection functions.
652 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
656 * Mail in a Newsreader:: Important introductory notes.
657 * Getting Started Reading Mail:: A simple cookbook example.
658 * Splitting Mail:: How to create mail groups.
659 * Mail Sources:: How to tell Gnus where to get mail from.
660 * Mail Back End Variables:: Variables for customizing mail handling.
661 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
662 * Group Mail Splitting:: Use group customize to drive mail splitting.
663 * Incorporating Old Mail:: What about the old mail you have?
664 * Expiring Mail:: Getting rid of unwanted mail.
665 * Washing Mail:: Removing cruft from the mail you get.
666 * Duplicates:: Dealing with duplicated mail.
667 * Not Reading Mail:: Using mail back ends for reading other files.
668 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
672 * Mail Source Specifiers:: How to specify what a mail source is.
673 * Mail Source Customization:: Some variables that influence things.
674 * Fetching Mail:: Using the mail source specifiers.
676 Choosing a Mail Back End
678 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
679 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
680 * Mail Spool:: Store your mail in a private spool?
681 * MH Spool:: An mhspool-like back end.
682 * Maildir:: Another one-file-per-message format.
683 * Mail Folders:: Having one file for each group.
684 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
689 * Web Searches:: Creating groups from articles that match a string.
690 * Slashdot:: Reading the Slashdot comments.
691 * Ultimate:: The Ultimate Bulletin Board systems.
692 * Web Archive:: Reading mailing list archived on web.
693 * RSS:: Reading RDF site summary.
694 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
698 * Splitting in IMAP:: Splitting mail with nnimap.
699 * Expiring in IMAP:: Expiring mail with nnimap.
700 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
701 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
702 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
703 * Debugging IMAP:: What to do when things don't work.
707 * Directory Groups:: You can read a directory as if it was a newsgroup.
708 * Anything Groups:: Dired? Who needs dired?
709 * Document Groups:: Single files can be the basis of a group.
710 * SOUP:: Reading @sc{soup} packets ``offline''.
711 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
715 * Document Server Internals:: How to add your own document types.
719 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
720 * SOUP Groups:: A back end for reading @sc{soup} packets.
721 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
725 * Virtual Groups:: Combining articles from many groups.
726 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
730 * The NNDiary Back End:: Basic setup and usage.
731 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
732 * Sending or Not Sending:: A final note on sending diary messages.
736 * Diary Messages:: What makes a message valid for nndiary.
737 * Running NNDiary:: NNDiary has two modes of operation.
738 * Customizing NNDiary:: Bells and whistles.
740 The Gnus Diary Library
742 * Diary Summary Line Format:: A nicer summary buffer line format.
743 * Diary Articles Sorting:: A nicer way to sort messages.
744 * Diary Headers Generation:: Not doing it manually.
745 * Diary Group Parameters:: Not handling them manually.
749 * Agent Basics:: How it all is supposed to work.
750 * Agent Categories:: How to tell the Gnus Agent what to download.
751 * Agent Commands:: New commands for all the buffers.
752 * Agent Visuals:: Ways that the agent may effect your summary buffer.
753 * Agent as Cache:: The Agent is a big cache too.
754 * Agent Expiry:: How to make old articles go away.
755 * Agent Regeneration:: How to recover from lost connections and other accidents.
756 * Agent and flags:: How the Agent maintains flags.
757 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
758 * Outgoing Messages:: What happens when you post/mail something?
759 * Agent Variables:: Customizing is fun.
760 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
761 * Batching Agents:: How to fetch news from a @code{cron} job.
762 * Agent Caveats:: What you think it'll do and what it does.
766 * Category Syntax:: What a category looks like.
767 * Category Buffer:: A buffer for maintaining categories.
768 * Category Variables:: Customize'r'Us.
772 * Group Agent Commands:: Configure groups and fetch their contents.
773 * Summary Agent Commands:: Manually select then fetch specific articles.
774 * Server Agent Commands:: Select the servers that are supported by the agent.
778 * Summary Score Commands:: Adding score entries for the current group.
779 * Group Score Commands:: General score commands.
780 * Score Variables:: Customize your scoring. (My, what terminology).
781 * Score File Format:: What a score file may contain.
782 * Score File Editing:: You can edit score files by hand as well.
783 * Adaptive Scoring:: Big Sister Gnus knows what you read.
784 * Home Score File:: How to say where new score entries are to go.
785 * Followups To Yourself:: Having Gnus notice when people answer you.
786 * Scoring On Other Headers:: Scoring on non-standard headers.
787 * Scoring Tips:: How to score effectively.
788 * Reverse Scoring:: That problem child of old is not problem.
789 * Global Score Files:: Earth-spanning, ear-splitting score files.
790 * Kill Files:: They are still here, but they can be ignored.
791 * Converting Kill Files:: Translating kill files to score files.
792 * Advanced Scoring:: Using logical expressions to build score rules.
793 * Score Decays:: It can be useful to let scores wither away.
797 * Advanced Scoring Syntax:: A definition.
798 * Advanced Scoring Examples:: What they look like.
799 * Advanced Scoring Tips:: Getting the most out of it.
803 * Process/Prefix:: A convention used by many treatment commands.
804 * Interactive:: Making Gnus ask you many questions.
805 * Symbolic Prefixes:: How to supply some Gnus functions with options.
806 * Formatting Variables:: You can specify what buffers should look like.
807 * Window Layout:: Configuring the Gnus buffer windows.
808 * Faces and Fonts:: How to change how faces look.
809 * Compilation:: How to speed Gnus up.
810 * Mode Lines:: Displaying information in the mode lines.
811 * Highlighting and Menus:: Making buffers look all nice and cozy.
812 * Buttons:: Get tendinitis in ten easy steps!
813 * Daemons:: Gnus can do things behind your back.
814 * NoCeM:: How to avoid spam and other fatty foods.
815 * Undo:: Some actions can be undone.
816 * Predicate Specifiers:: Specifying predicates.
817 * Moderation:: What to do if you're a moderator.
818 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
819 * Fuzzy Matching:: What's the big fuzz?
820 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
821 * Spam Package:: A package for filtering and processing spam.
822 * Other modes:: Interaction with other modes.
823 * Various Various:: Things that are really various.
827 * Formatting Basics:: A formatting variable is basically a format string.
828 * Mode Line Formatting:: Some rules about mode line formatting variables.
829 * Advanced Formatting:: Modifying output in various ways.
830 * User-Defined Specs:: Having Gnus call your own functions.
831 * Formatting Fonts:: Making the formatting look colorful and nice.
832 * Positioning Point:: Moving point to a position after an operation.
833 * Tabulation:: Tabulating your output.
834 * Wide Characters:: Dealing with wide characters.
838 * X-Face:: Display a funky, teensy black-and-white image.
839 * Face:: Display a funkier, teensier colored image.
840 * Smileys:: Show all those happy faces the way they were
842 * Picons:: How to display pictures of what you're reading.
843 * XVarious:: Other XEmacsy Gnusey variables.
847 * The problem of spam:: Some background, and some solutions
848 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
849 * SpamAssassin:: How to use external anti-spam tools.
850 * Hashcash:: Reduce spam by burning CPU time.
854 * Spam Package Introduction::
855 * Filtering Incoming Mail::
856 * Detecting Spam in Groups::
857 * Spam and Ham Processors::
858 * Spam Package Configuration Examples::
860 * Extending the Spam package::
861 * Spam Statistics Package::
863 Spam Statistics Package
865 * Creating a spam-stat dictionary::
866 * Splitting mail using spam-stat::
867 * Low-level interface to the spam-stat dictionary::
871 * XEmacs:: Requirements for installing under XEmacs.
872 * History:: How Gnus got where it is today.
873 * On Writing Manuals:: Why this is not a beginner's guide.
874 * Terminology:: We use really difficult, like, words here.
875 * Customization:: Tailoring Gnus to your needs.
876 * Troubleshooting:: What you might try if things do not work.
877 * Gnus Reference Guide:: Rilly, rilly technical stuff.
878 * Emacs for Heathens:: A short introduction to Emacsian terms.
879 * Frequently Asked Questions:: The Gnus FAQ
883 * Gnus Versions:: What Gnus versions have been released.
884 * Other Gnus Versions:: Other Gnus versions that also have been released.
885 * Why?:: What's the point of Gnus?
886 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
887 * Conformity:: Gnus tries to conform to all standards.
888 * Emacsen:: Gnus can be run on a few modern Emacsen.
889 * Gnus Development:: How Gnus is developed.
890 * Contributors:: Oodles of people.
891 * New Features:: Pointers to some of the new stuff in Gnus.
895 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
896 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
897 * Red Gnus:: Third time best---Gnus 5.4/5.5.
898 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
899 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
900 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
901 * No Gnus:: Very punny.
905 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
906 * Slow Terminal Connection:: You run a remote Emacs.
907 * Little Disk Space:: You feel that having large setup files is icky.
908 * Slow Machine:: You feel like buying a faster machine.
912 * Gnus Utility Functions:: Common functions and variable to use.
913 * Back End Interface:: How Gnus communicates with the servers.
914 * Score File Syntax:: A BNF definition of the score file standard.
915 * Headers:: How Gnus stores headers internally.
916 * Ranges:: A handy format for storing mucho numbers.
917 * Group Info:: The group info format.
918 * Extended Interactive:: Symbolic prefixes and stuff.
919 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
920 * Various File Formats:: Formats of files that Gnus use.
924 * Required Back End Functions:: Functions that must be implemented.
925 * Optional Back End Functions:: Functions that need not be implemented.
926 * Error Messaging:: How to get messages and report errors.
927 * Writing New Back Ends:: Extending old back ends.
928 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
929 * Mail-like Back Ends:: Some tips on mail back ends.
933 * Active File Format:: Information on articles and groups available.
934 * Newsgroups File Format:: Group descriptions.
938 * Keystrokes:: Entering text and executing commands.
939 * Emacs Lisp:: The built-in Emacs programming language.
945 @chapter Starting Gnus
948 If you are haven't used Emacs much before using Gnus, read @ref{Emacs
953 If your system administrator has set things up properly, starting Gnus
954 and reading news is extremely easy---you just type @kbd{M-x gnus} in
955 your Emacs. If not, you should customize the variable
956 @code{gnus-select-method} as described in @ref{Finding the News}. For a
957 minimal setup for posting should also customize the variables
958 @code{user-full-name} and @code{user-mail-address}.
960 @findex gnus-other-frame
961 @kindex M-x gnus-other-frame
962 If you want to start Gnus in a different frame, you can use the command
963 @kbd{M-x gnus-other-frame} instead.
965 If things do not go smoothly at startup, you have to twiddle some
966 variables in your @file{~/.gnus.el} file. This file is similar to
967 @file{~/.emacs}, but is read when Gnus starts.
969 If you puzzle at any terms used in this manual, please refer to the
970 terminology section (@pxref{Terminology}).
973 * Finding the News:: Choosing a method for getting news.
974 * The First Time:: What does Gnus do the first time you start it?
975 * The Server is Down:: How can I read my mail then?
976 * Slave Gnusae:: You can have more than one Gnus active at a time.
977 * New Groups:: What is Gnus supposed to do with new groups?
978 * Changing Servers:: You may want to move from one server to another.
979 * Startup Files:: Those pesky startup files---@file{.newsrc}.
980 * Auto Save:: Recovering from a crash.
981 * The Active File:: Reading the active file over a slow line Takes Time.
982 * Startup Variables:: Other variables you might change.
986 @node Finding the News
987 @section Finding the News
990 @vindex gnus-select-method
992 The @code{gnus-select-method} variable says where Gnus should look for
993 news. This variable should be a list where the first element says
994 @dfn{how} and the second element says @dfn{where}. This method is your
995 native method. All groups not fetched with this method are
998 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
999 you want to get your daily dosage of news from, you'd say:
1002 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1005 If you want to read directly from the local spool, say:
1008 (setq gnus-select-method '(nnspool ""))
1011 If you can use a local spool, you probably should, as it will almost
1012 certainly be much faster. But do not use the local spool if your
1013 server is running Leafnode (which is a simple, standalone private news
1014 server); in this case, use @code{(nntp "localhost")}.
1016 @vindex gnus-nntpserver-file
1018 @cindex @acronym{NNTP} server
1019 If this variable is not set, Gnus will take a look at the
1020 @env{NNTPSERVER} environment variable. If that variable isn't set,
1021 Gnus will see whether @code{gnus-nntpserver-file}
1022 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1023 If that fails as well, Gnus will try to use the machine running Emacs
1024 as an @acronym{NNTP} server. That's a long shot, though.
1026 @vindex gnus-nntp-server
1027 If @code{gnus-nntp-server} is set, this variable will override
1028 @code{gnus-select-method}. You should therefore set
1029 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1031 @vindex gnus-secondary-servers
1032 @vindex gnus-nntp-server
1033 You can also make Gnus prompt you interactively for the name of an
1034 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1035 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
1036 in the @code{gnus-secondary-servers} list (if any). You can also just
1037 type in the name of any server you feel like visiting. (Note that this
1038 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1039 gnus} later in the same Emacs session, Gnus will contact the same
1042 @findex gnus-group-browse-foreign-server
1044 However, if you use one @acronym{NNTP} server regularly and are just
1045 interested in a couple of groups from a different server, you would be
1046 better served by using the @kbd{B} command in the group buffer. It will
1047 let you have a look at what groups are available, and you can subscribe
1048 to any of the groups you want to. This also makes @file{.newsrc}
1049 maintenance much tidier. @xref{Foreign Groups}.
1051 @vindex gnus-secondary-select-methods
1053 A slightly different approach to foreign groups is to set the
1054 @code{gnus-secondary-select-methods} variable. The select methods
1055 listed in this variable are in many ways just as native as the
1056 @code{gnus-select-method} server. They will also be queried for active
1057 files during startup (if that's required), and new newsgroups that
1058 appear on these servers will be subscribed (or not) just as native
1061 For instance, if you use the @code{nnmbox} back end to read your mail,
1062 you would typically set this variable to
1065 (setq gnus-secondary-select-methods '((nnmbox "")))
1068 Note: the @acronym{NNTP} back end stores marks in marks files
1069 (@pxref{NNTP marks}). This feature makes it easy to share marks between
1070 several Gnus installations, but may slow down things a bit when fetching
1071 new articles. @xref{NNTP marks}, for more information.
1074 @node The First Time
1075 @section The First Time
1076 @cindex first time usage
1078 If no startup files exist (@pxref{Startup Files}), Gnus will try to
1079 determine what groups should be subscribed by default.
1081 @vindex gnus-default-subscribed-newsgroups
1082 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
1083 will subscribe you to just those groups in that list, leaving the rest
1084 killed. Your system administrator should have set this variable to
1087 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1088 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1089 here as @dfn{whatever Lars thinks you should read}.)
1091 You'll also be subscribed to the Gnus documentation group, which should
1092 help you with most common problems.
1094 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1095 use the normal functions for handling new groups, and not do anything
1099 @node The Server is Down
1100 @section The Server is Down
1101 @cindex server errors
1103 If the default server is down, Gnus will understandably have some
1104 problems starting. However, if you have some mail groups in addition to
1105 the news groups, you may want to start Gnus anyway.
1107 Gnus, being the trusting sort of program, will ask whether to proceed
1108 without a native select method if that server can't be contacted. This
1109 will happen whether the server doesn't actually exist (i.e., you have
1110 given the wrong address) or the server has just momentarily taken ill
1111 for some reason or other. If you decide to continue and have no foreign
1112 groups, you'll find it difficult to actually do anything in the group
1113 buffer. But, hey, that's your problem. Blllrph!
1115 @findex gnus-no-server
1116 @kindex M-x gnus-no-server
1118 If you know that the server is definitely down, or you just want to read
1119 your mail without bothering with the server at all, you can use the
1120 @code{gnus-no-server} command to start Gnus. That might come in handy
1121 if you're in a hurry as well. This command will not attempt to contact
1122 your primary server---instead, it will just activate all groups on level
1123 1 and 2. (You should preferably keep no native groups on those two
1124 levels.) Also @pxref{Group Levels}.
1128 @section Slave Gnusae
1131 You might want to run more than one Emacs with more than one Gnus at the
1132 same time. If you are using different @file{.newsrc} files (e.g., if you
1133 are using the two different Gnusae to read from two different servers),
1134 that is no problem whatsoever. You just do it.
1136 The problem appears when you want to run two Gnusae that use the same
1137 @file{.newsrc} file.
1139 To work around that problem some, we here at the Think-Tank at the Gnus
1140 Towers have come up with a new concept: @dfn{Masters} and
1141 @dfn{slaves}. (We have applied for a patent on this concept, and have
1142 taken out a copyright on those words. If you wish to use those words in
1143 conjunction with each other, you have to send $1 per usage instance to
1144 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1145 Applications}) will be much more expensive, of course.)
1148 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1149 however you do it). Each subsequent slave Gnusae should be started with
1150 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1151 files, but instead save @dfn{slave files} that contain information only
1152 on what groups have been read in the slave session. When a master Gnus
1153 starts, it will read (and delete) these slave files, incorporating all
1154 information from them. (The slave files will be read in the sequence
1155 they were created, so the latest changes will have precedence.)
1157 Information from the slave files has, of course, precedence over the
1158 information in the normal (i.e., master) @file{.newsrc} file.
1160 If the @file{.newsrc*} files have not been saved in the master when the
1161 slave starts, you may be prompted as to whether to read an auto-save
1162 file. If you answer ``yes'', the unsaved changes to the master will be
1163 incorporated into the slave. If you answer ``no'', the slave may see some
1164 messages as unread that have been read in the master.
1171 @cindex subscription
1173 @vindex gnus-check-new-newsgroups
1174 If you are satisfied that you really never want to see any new groups,
1175 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1176 also save you some time at startup. Even if this variable is
1177 @code{nil}, you can always subscribe to the new groups just by pressing
1178 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1179 is @code{ask-server} by default. If you set this variable to
1180 @code{always}, then Gnus will query the back ends for new groups even
1181 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1184 * Checking New Groups:: Determining what groups are new.
1185 * Subscription Methods:: What Gnus should do with new groups.
1186 * Filtering New Groups:: Making Gnus ignore certain new groups.
1190 @node Checking New Groups
1191 @subsection Checking New Groups
1193 Gnus normally determines whether a group is new or not by comparing the
1194 list of groups from the active file(s) with the lists of subscribed and
1195 dead groups. This isn't a particularly fast method. If
1196 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1197 server for new groups since the last time. This is both faster and
1198 cheaper. This also means that you can get rid of the list of killed
1199 groups altogether, so you may set @code{gnus-save-killed-list} to
1200 @code{nil}, which will save time both at startup, at exit, and all over.
1201 Saves disk space, too. Why isn't this the default, then?
1202 Unfortunately, not all servers support this command.
1204 I bet I know what you're thinking now: How do I find out whether my
1205 server supports @code{ask-server}? No? Good, because I don't have a
1206 fail-safe answer. I would suggest just setting this variable to
1207 @code{ask-server} and see whether any new groups appear within the next
1208 few days. If any do, then it works. If none do, then it doesn't
1209 work. I could write a function to make Gnus guess whether the server
1210 supports @code{ask-server}, but it would just be a guess. So I won't.
1211 You could @code{telnet} to the server and say @code{HELP} and see
1212 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1213 it does, then it might work. (But there are servers that lists
1214 @samp{NEWGROUPS} without supporting the function properly.)
1216 This variable can also be a list of select methods. If so, Gnus will
1217 issue an @code{ask-server} command to each of the select methods, and
1218 subscribe them (or not) using the normal methods. This might be handy
1219 if you are monitoring a few servers for new groups. A side effect is
1220 that startup will take much longer, so you can meditate while waiting.
1221 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1224 @node Subscription Methods
1225 @subsection Subscription Methods
1227 @vindex gnus-subscribe-newsgroup-method
1228 What Gnus does when it encounters a new group is determined by the
1229 @code{gnus-subscribe-newsgroup-method} variable.
1231 This variable should contain a function. This function will be called
1232 with the name of the new group as the only parameter.
1234 Some handy pre-fab functions are:
1238 @item gnus-subscribe-zombies
1239 @vindex gnus-subscribe-zombies
1240 Make all new groups zombies. This is the default. You can browse the
1241 zombies later (with @kbd{A z}) and either kill them all off properly
1242 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1244 @item gnus-subscribe-randomly
1245 @vindex gnus-subscribe-randomly
1246 Subscribe all new groups in arbitrary order. This really means that all
1247 new groups will be added at ``the top'' of the group buffer.
1249 @item gnus-subscribe-alphabetically
1250 @vindex gnus-subscribe-alphabetically
1251 Subscribe all new groups in alphabetical order.
1253 @item gnus-subscribe-hierarchically
1254 @vindex gnus-subscribe-hierarchically
1255 Subscribe all new groups hierarchically. The difference between this
1256 function and @code{gnus-subscribe-alphabetically} is slight.
1257 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1258 alphabetical fashion, while this function will enter groups into its
1259 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1260 @samp{comp} hierarchy, this function will not mess that configuration
1261 up. Or something like that.
1263 @item gnus-subscribe-interactively
1264 @vindex gnus-subscribe-interactively
1265 Subscribe new groups interactively. This means that Gnus will ask
1266 you about @strong{all} new groups. The groups you choose to subscribe
1267 to will be subscribed hierarchically.
1269 @item gnus-subscribe-killed
1270 @vindex gnus-subscribe-killed
1271 Kill all new groups.
1273 @item gnus-subscribe-topics
1274 @vindex gnus-subscribe-topics
1275 Put the groups into the topic that has a matching @code{subscribe} topic
1276 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1277 topic parameter that looks like
1283 will mean that all groups that match that regex will be subscribed under
1286 If no topics match the groups, the groups will be subscribed in the
1291 @vindex gnus-subscribe-hierarchical-interactive
1292 A closely related variable is
1293 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1294 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1295 hierarchical fashion whether to subscribe to new groups or not. Gnus
1296 will ask you for each sub-hierarchy whether you want to descend the
1299 One common mistake is to set the variable a few paragraphs above
1300 (@code{gnus-subscribe-newsgroup-method}) to
1301 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1302 will not work. This is ga-ga. So don't do it.
1305 @node Filtering New Groups
1306 @subsection Filtering New Groups
1308 A nice and portable way to control which new newsgroups should be
1309 subscribed (or ignored) is to put an @dfn{options} line at the start of
1310 the @file{.newsrc} file. Here's an example:
1313 options -n !alt.all !rec.all sci.all
1316 @vindex gnus-subscribe-options-newsgroup-method
1317 This line obviously belongs to a serious-minded intellectual scientific
1318 person (or she may just be plain old boring), because it says that all
1319 groups that have names beginning with @samp{alt} and @samp{rec} should
1320 be ignored, and all groups with names beginning with @samp{sci} should
1321 be subscribed. Gnus will not use the normal subscription method for
1322 subscribing these groups.
1323 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1324 variable defaults to @code{gnus-subscribe-alphabetically}.
1326 @vindex gnus-options-not-subscribe
1327 @vindex gnus-options-subscribe
1328 If you don't want to mess with your @file{.newsrc} file, you can just
1329 set the two variables @code{gnus-options-subscribe} and
1330 @code{gnus-options-not-subscribe}. These two variables do exactly the
1331 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1332 and if the new group matches the former, it will be unconditionally
1333 subscribed, and if it matches the latter, it will be ignored.
1335 @vindex gnus-auto-subscribed-groups
1336 Yet another variable that meddles here is
1337 @code{gnus-auto-subscribed-groups}. It works exactly like
1338 @code{gnus-options-subscribe}, and is therefore really superfluous,
1339 but I thought it would be nice to have two of these. This variable is
1340 more meant for setting some ground rules, while the other variable is
1341 used more for user fiddling. By default this variable makes all new
1342 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1343 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1344 subscribed. If you don't like that, just set this variable to
1347 New groups that match this regexp are subscribed using
1348 @code{gnus-subscribe-options-newsgroup-method}.
1351 @node Changing Servers
1352 @section Changing Servers
1353 @cindex changing servers
1355 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1356 This happens very rarely, but perhaps you change jobs, or one server is
1357 very flaky and you want to use another.
1359 Changing the server is pretty easy, right? You just change
1360 @code{gnus-select-method} to point to the new server?
1364 Article numbers are not (in any way) kept synchronized between different
1365 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1366 you have read is by keeping track of article numbers. So when you
1367 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1370 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1371 file from one server to another. They all have one thing in
1372 common---they take a looong time to run. You don't want to use these
1373 functions more than absolutely necessary.
1375 @kindex M-x gnus-change-server
1376 @findex gnus-change-server
1377 If you have access to both servers, Gnus can request the headers for all
1378 the articles you have read and compare @code{Message-ID}s and map the
1379 article numbers of the read articles and article marks. The @kbd{M-x
1380 gnus-change-server} command will do this for all your native groups. It
1381 will prompt for the method you want to move to.
1383 @kindex M-x gnus-group-move-group-to-server
1384 @findex gnus-group-move-group-to-server
1385 You can also move individual groups with the @kbd{M-x
1386 gnus-group-move-group-to-server} command. This is useful if you want to
1387 move a (foreign) group from one server to another.
1389 @kindex M-x gnus-group-clear-data-on-native-groups
1390 @findex gnus-group-clear-data-on-native-groups
1391 If you don't have access to both the old and new server, all your marks
1392 and read ranges have become worthless. You can use the @kbd{M-x
1393 gnus-group-clear-data-on-native-groups} command to clear out all data
1394 that you have on your native groups. Use with caution.
1396 @kindex M-x gnus-group-clear-data
1397 @findex gnus-group-clear-data
1398 Clear the data from the current group only---nix out marks and the
1399 list of read articles (@code{gnus-group-clear-data}).
1401 After changing servers, you @strong{must} move the cache hierarchy away,
1402 since the cached articles will have wrong article numbers, which will
1403 affect which articles Gnus thinks are read.
1404 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1405 to have it done automatically; for @code{gnus-group-clear-data}, you
1406 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1407 cache for all groups).
1411 @section Startup Files
1412 @cindex startup files
1417 Most common Unix news readers use a shared startup file called
1418 @file{.newsrc}. This file contains all the information about what
1419 groups are subscribed, and which articles in these groups have been
1422 Things got a bit more complicated with @sc{gnus}. In addition to
1423 keeping the @file{.newsrc} file updated, it also used a file called
1424 @file{.newsrc.el} for storing all the information that didn't fit into
1425 the @file{.newsrc} file. (Actually, it also duplicated everything in
1426 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1427 files was the most recently saved, which enabled people to swap between
1428 @sc{gnus} and other newsreaders.
1430 That was kinda silly, so Gnus went one better: In addition to the
1431 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1432 @file{.newsrc.eld}. It will read whichever of these files that are most
1433 recent, but it will never write a @file{.newsrc.el} file. You should
1434 never delete the @file{.newsrc.eld} file---it contains much information
1435 not stored in the @file{.newsrc} file.
1437 @vindex gnus-save-newsrc-file
1438 @vindex gnus-read-newsrc-file
1439 You can turn off writing the @file{.newsrc} file by setting
1440 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1441 the file and save some space, as well as exiting from Gnus faster.
1442 However, this will make it impossible to use other newsreaders than
1443 Gnus. But hey, who would want to, right? Similarly, setting
1444 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1445 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which can be
1446 convenient if you use a different news reader occasionally, and you
1447 want to read a different subset of the available groups with that
1450 @vindex gnus-save-killed-list
1451 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1452 will not save the list of killed groups to the startup file. This will
1453 save both time (when starting and quitting) and space (on disk). It
1454 will also mean that Gnus has no record of what groups are new or old,
1455 so the automatic new groups subscription methods become meaningless.
1456 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1457 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1458 Groups}). This variable can also be a regular expression. If that's
1459 the case, remove all groups that do not match this regexp before
1460 saving. This can be useful in certain obscure situations that involve
1461 several servers where not all servers support @code{ask-server}.
1463 @vindex gnus-startup-file
1464 @vindex gnus-backup-startup-file
1465 @vindex version-control
1466 The @code{gnus-startup-file} variable says where the startup files are.
1467 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1468 file being whatever that one is, with a @samp{.eld} appended.
1469 If you want version control for this file, set
1470 @code{gnus-backup-startup-file}. It respects the same values as the
1471 @code{version-control} variable.
1473 @vindex gnus-save-newsrc-hook
1474 @vindex gnus-save-quick-newsrc-hook
1475 @vindex gnus-save-standard-newsrc-hook
1476 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1477 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1478 saving the @file{.newsrc.eld} file, and
1479 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1480 @file{.newsrc} file. The latter two are commonly used to turn version
1481 control on or off. Version control is on by default when saving the
1482 startup files. If you want to turn backup creation off, say something like:
1485 (defun turn-off-backup ()
1486 (set (make-local-variable 'backup-inhibited) t))
1488 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1489 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1492 @vindex gnus-init-file
1493 @vindex gnus-site-init-file
1494 When Gnus starts, it will read the @code{gnus-site-init-file}
1495 (@file{.../site-lisp/gnus-init} by default) and @code{gnus-init-file}
1496 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1497 and can be used to avoid cluttering your @file{~/.emacs} and
1498 @file{site-init} files with Gnus stuff. Gnus will also check for files
1499 with the same names as these, but with @file{.elc} and @file{.el}
1500 suffixes. In other words, if you have set @code{gnus-init-file} to
1501 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1502 and finally @file{~/.gnus} (in this order). If Emacs was invoked with
1503 the @option{-q} or @option{--no-init-file} options (@pxref{Initial
1504 Options, ,Initial Options, emacs, The Emacs Manual}), Gnus doesn't read
1505 @code{gnus-init-file}.
1510 @cindex dribble file
1513 Whenever you do something that changes the Gnus data (reading articles,
1514 catching up, killing/subscribing groups), the change is added to a
1515 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1516 Emacs way. If your Emacs should crash before you have saved the
1517 @file{.newsrc} files, all changes you have made can be recovered from
1520 If Gnus detects this file at startup, it will ask the user whether to
1521 read it. The auto save file is deleted whenever the real startup file is
1524 @vindex gnus-use-dribble-file
1525 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1526 maintain a dribble buffer. The default is @code{t}.
1528 @vindex gnus-dribble-directory
1529 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1530 this variable is @code{nil}, which it is by default, Gnus will dribble
1531 into the directory where the @file{.newsrc} file is located. (This is
1532 normally the user's home directory.) The dribble file will get the same
1533 file permissions as the @file{.newsrc} file.
1535 @vindex gnus-always-read-dribble-file
1536 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1537 read the dribble file on startup without querying the user.
1540 @node The Active File
1541 @section The Active File
1543 @cindex ignored groups
1545 When Gnus starts, or indeed whenever it tries to determine whether new
1546 articles have arrived, it reads the active file. This is a very large
1547 file that lists all the active groups and articles on the server.
1549 @vindex gnus-ignored-newsgroups
1550 Before examining the active file, Gnus deletes all lines that match the
1551 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1552 any groups with bogus names, but you can use this variable to make Gnus
1553 ignore hierarchies you aren't ever interested in. However, this is not
1554 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1555 Groups} for an overview of other variables that can be used instead.
1558 @c @code{nil} by default, and will slow down active file handling somewhat
1559 @c if you set it to anything else.
1561 @vindex gnus-read-active-file
1563 The active file can be rather Huge, so if you have a slow network, you
1564 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1565 reading the active file. This variable is @code{some} by default.
1567 Gnus will try to make do by getting information just on the groups that
1568 you actually subscribe to.
1570 Note that if you subscribe to lots and lots of groups, setting this
1571 variable to @code{nil} will probably make Gnus slower, not faster. At
1572 present, having this variable @code{nil} will slow Gnus down
1573 considerably, unless you read news over a 2400 baud modem.
1575 This variable can also have the value @code{some}. Gnus will then
1576 attempt to read active info only on the subscribed groups. On some
1577 servers this is quite fast (on sparkling, brand new INN servers that
1578 support the @code{LIST ACTIVE group} command), on others this isn't fast
1579 at all. In any case, @code{some} should be faster than @code{nil}, and
1580 is certainly faster than @code{t} over slow lines.
1582 Some news servers (old versions of Leafnode and old versions of INN, for
1583 instance) do not support the @code{LIST ACTIVE group}. For these
1584 servers, @code{nil} is probably the most efficient value for this
1587 If this variable is @code{nil}, Gnus will ask for group info in total
1588 lock-step, which isn't very fast. If it is @code{some} and you use an
1589 @acronym{NNTP} server, Gnus will pump out commands as fast as it can, and
1590 read all the replies in one swoop. This will normally result in better
1591 performance, but if the server does not support the aforementioned
1592 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1594 If you think that starting up Gnus takes too long, try all the three
1595 different values for this variable and see what works best for you.
1597 In any case, if you use @code{some} or @code{nil}, you should definitely
1598 kill all groups that you aren't interested in to speed things up.
1600 Note that this variable also affects active file retrieval from
1601 secondary select methods.
1604 @node Startup Variables
1605 @section Startup Variables
1609 @item gnus-load-hook
1610 @vindex gnus-load-hook
1611 A hook run while Gnus is being loaded. Note that this hook will
1612 normally be run just once in each Emacs session, no matter how many
1613 times you start Gnus.
1615 @item gnus-before-startup-hook
1616 @vindex gnus-before-startup-hook
1617 A hook run after starting up Gnus successfully.
1619 @item gnus-startup-hook
1620 @vindex gnus-startup-hook
1621 A hook run as the very last thing after starting up Gnus
1623 @item gnus-started-hook
1624 @vindex gnus-started-hook
1625 A hook that is run as the very last thing after starting up Gnus
1628 @item gnus-setup-news-hook
1629 @vindex gnus-setup-news-hook
1630 A hook that is run after reading the @file{.newsrc} file(s), but before
1631 generating the group buffer.
1633 @item gnus-check-bogus-newsgroups
1634 @vindex gnus-check-bogus-newsgroups
1635 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1636 startup. A @dfn{bogus group} is a group that you have in your
1637 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1638 bogus groups can take quite a while, so to save time and resources it's
1639 best to leave this option off, and do the checking for bogus groups once
1640 in a while from the group buffer instead (@pxref{Group Maintenance}).
1642 @item gnus-inhibit-startup-message
1643 @vindex gnus-inhibit-startup-message
1644 If non-@code{nil}, the startup message won't be displayed. That way,
1645 your boss might not notice as easily that you are reading news instead
1646 of doing your job. Note that this variable is used before
1647 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1649 @item gnus-no-groups-message
1650 @vindex gnus-no-groups-message
1651 Message displayed by Gnus when no groups are available.
1653 @item gnus-play-startup-jingle
1654 @vindex gnus-play-startup-jingle
1655 If non-@code{nil}, play the Gnus jingle at startup.
1657 @item gnus-startup-jingle
1658 @vindex gnus-startup-jingle
1659 Jingle to be played if the above variable is non-@code{nil}. The
1660 default is @samp{Tuxedomoon.Jingle4.au}.
1666 @chapter Group Buffer
1667 @cindex group buffer
1669 @c Alex Schroeder suggests to rearrange this as follows:
1671 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1672 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1673 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1674 @c 7. Group Score, 8. Group Buffer Format
1675 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1676 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1677 @c <kensanata> First, "Gnus considers groups... (default 9)."
1678 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1679 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1680 @c <kensanata> Then expand the next paragraph or add some more to it.
1681 @c This short one sentence explains levels 1 and 2, therefore I understand
1682 @c that I should keep important news at 3 and boring news at 4.
1683 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1684 @c Maybe keep those that you don't want to read temporarily at 6,
1685 @c those that you never want to read at 8, those that offend your
1686 @c human rights at 9...
1689 The @dfn{group buffer} lists all (or parts) of the available groups. It
1690 is the first buffer shown when Gnus starts, and will never be killed as
1691 long as Gnus is active.
1695 \gnusfigure{The Group Buffer}{320}{
1696 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1697 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1698 \put(120,38){\vector(1,2){10}}
1699 \put(40,60){\makebox(0,0)[r]{Mode line}}
1700 \put(40,58){\vector(1,0){30}}
1701 \put(200,28){\makebox(0,0)[t]{Native select method}}
1702 \put(200,26){\vector(-1,2){15}}
1708 * Group Buffer Format:: Information listed and how you can change it.
1709 * Group Maneuvering:: Commands for moving in the group buffer.
1710 * Selecting a Group:: Actually reading news.
1711 * Subscription Commands:: Unsubscribing, killing, subscribing.
1712 * Group Data:: Changing the info for a group.
1713 * Group Levels:: Levels? What are those, then?
1714 * Group Score:: A mechanism for finding out what groups you like.
1715 * Marking Groups:: You can mark groups for later processing.
1716 * Foreign Groups:: Creating and editing groups.
1717 * Group Parameters:: Each group may have different parameters set.
1718 * Listing Groups:: Gnus can list various subsets of the groups.
1719 * Sorting Groups:: Re-arrange the group order.
1720 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1721 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1722 * Exiting Gnus:: Stop reading news and get some work done.
1723 * Group Topics:: A folding group mode divided into topics.
1724 * Misc Group Stuff:: Other stuff that you can to do.
1728 @node Group Buffer Format
1729 @section Group Buffer Format
1732 * Group Line Specification:: Deciding how the group buffer is to look.
1733 * Group Mode Line Specification:: The group buffer mode line.
1734 * Group Highlighting:: Having nice colors in the group buffer.
1737 You can customize the Group Mode tool bar, see @kbd{M-x
1738 customize-apropos RET gnus-group-tool-bar}. This feature is only
1741 The tool bar icons are now (de)activated correctly depending on the
1742 cursor position. Therefore, moving around in the Group Buffer is
1743 slower. You can disable this via the variable
1744 @code{gnus-group-update-tool-bar}. Its default value depends on your
1747 @node Group Line Specification
1748 @subsection Group Line Specification
1749 @cindex group buffer format
1751 The default format of the group buffer is nice and dull, but you can
1752 make it as exciting and ugly as you feel like.
1754 Here's a couple of example group lines:
1757 25: news.announce.newusers
1758 * 0: alt.fan.andrea-dworkin
1763 You can see that there are 25 unread articles in
1764 @samp{news.announce.newusers}. There are no unread articles, but some
1765 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1766 asterisk at the beginning of the line?).
1768 @vindex gnus-group-line-format
1769 You can change that format to whatever you want by fiddling with the
1770 @code{gnus-group-line-format} variable. This variable works along the
1771 lines of a @code{format} specification, which is pretty much the same as
1772 a @code{printf} specifications, for those of you who use (feh!) C.
1773 @xref{Formatting Variables}.
1775 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1777 There should always be a colon on the line; the cursor always moves to
1778 the colon after performing an operation. @xref{Positioning
1779 Point}. Nothing else is required---not even the group name. All
1780 displayed text is just window dressing, and is never examined by Gnus.
1781 Gnus stores all real information it needs using text properties.
1783 (Note that if you make a really strange, wonderful, spreadsheet-like
1784 layout, everybody will believe you are hard at work with the accounting
1785 instead of wasting time reading news.)
1787 Here's a list of all available format characters:
1792 An asterisk if the group only has marked articles.
1795 Whether the group is subscribed.
1798 Level of subscribedness.
1801 Number of unread articles.
1804 Number of dormant articles.
1807 Number of ticked articles.
1810 Number of read articles.
1813 Number of unseen articles.
1816 Estimated total number of articles. (This is really @var{max-number}
1817 minus @var{min-number} plus 1.)
1819 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1820 efficient access to @var{max-number} and @var{min-number} but getting
1821 the true unread message count is not possible efficiently. For
1822 hysterical raisins, even the mail back ends, where the true number of
1823 unread messages might be available efficiently, use the same limited
1824 interface. To remove this restriction from Gnus means that the back
1825 end interface has to be changed, which is not an easy job.
1827 The nnml backend (@pxref{Mail Spool}) has a feature called ``group
1828 compaction'' which circumvents this deficiency: the idea is to
1829 renumber all articles from 1, removing all gaps between numbers, hence
1830 getting a correct total count. Other backends may support this in the
1831 future. In order to keep your total article count relatively up to
1832 date, you might want to compact your groups (or even directly your
1833 server) from time to time. @xref{Misc Group Stuff}, @xref{Server Commands}.
1836 Number of unread, unticked, non-dormant articles.
1839 Number of ticked and dormant articles.
1848 Group comment (@pxref{Group Parameters}) or group name if there is no
1849 comment element in the group parameters.
1852 Newsgroup description. You need to read the group descriptions
1853 before these will appear, and to do that, you either have to set
1854 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1858 @samp{m} if moderated.
1861 @samp{(m)} if moderated.
1867 If the summary buffer for the group is open or not.
1873 A string that looks like @samp{<%s:%n>} if a foreign select method is
1877 Indentation based on the level of the topic (@pxref{Group Topics}).
1880 @vindex gnus-group-uncollapsed-levels
1881 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1882 variable says how many levels to leave at the end of the group name.
1883 The default is 1---this will mean that group names like
1884 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1887 @vindex gnus-new-mail-mark
1889 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1893 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1896 A string that says when you last read the group (@pxref{Group
1900 The disk space used by the articles fetched by both the cache and
1901 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1902 megabytes(M), or gigabytes(G) to minimize the column width. A format
1903 of %7F is sufficient for a fixed-width column.
1906 User defined specifier. The next character in the format string should
1907 be a letter. Gnus will call the function
1908 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1909 following @samp{%u}. The function will be passed a single dummy
1910 parameter as argument. The function should return a string, which will
1911 be inserted into the buffer just like information from any other
1916 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1917 if no info is available---for instance, if it is a non-activated foreign
1918 group, or a bogus native group.
1921 @node Group Mode Line Specification
1922 @subsection Group Mode Line Specification
1923 @cindex group mode line
1925 @vindex gnus-group-mode-line-format
1926 The mode line can be changed by setting
1927 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1928 doesn't understand that many format specifiers:
1932 The native news server.
1934 The native select method.
1938 @node Group Highlighting
1939 @subsection Group Highlighting
1940 @cindex highlighting
1941 @cindex group highlighting
1943 @vindex gnus-group-highlight
1944 Highlighting in the group buffer is controlled by the
1945 @code{gnus-group-highlight} variable. This is an alist with elements
1946 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1947 something non-@code{nil}, the @var{face} will be used on the line.
1949 Here's an example value for this variable that might look nice if the
1953 (cond (window-system
1954 (setq custom-background-mode 'light)
1955 (defface my-group-face-1
1956 '((t (:foreground "Red" :bold t))) "First group face")
1957 (defface my-group-face-2
1958 '((t (:foreground "DarkSeaGreen4" :bold t)))
1959 "Second group face")
1960 (defface my-group-face-3
1961 '((t (:foreground "Green4" :bold t))) "Third group face")
1962 (defface my-group-face-4
1963 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1964 (defface my-group-face-5
1965 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1967 (setq gnus-group-highlight
1968 '(((> unread 200) . my-group-face-1)
1969 ((and (< level 3) (zerop unread)) . my-group-face-2)
1970 ((< level 3) . my-group-face-3)
1971 ((zerop unread) . my-group-face-4)
1972 (t . my-group-face-5)))
1975 Also @pxref{Faces and Fonts}.
1977 Variables that are dynamically bound when the forms are evaluated
1984 The number of unread articles in the group.
1988 Whether the group is a mail group.
1990 The level of the group.
1992 The score of the group.
1994 The number of ticked articles in the group.
1996 The total number of articles in the group. Or rather,
1997 @var{max-number} minus @var{min-number} plus one.
1999 When using the topic minor mode, this variable is bound to the current
2000 topic being inserted.
2003 When the forms are @code{eval}ed, point is at the beginning of the line
2004 of the group in question, so you can use many of the normal Gnus
2005 functions for snarfing info on the group.
2007 @vindex gnus-group-update-hook
2008 @findex gnus-group-highlight-line
2009 @code{gnus-group-update-hook} is called when a group line is changed.
2010 It will not be called when @code{gnus-visual} is @code{nil}. This hook
2011 calls @code{gnus-group-highlight-line} by default.
2014 @node Group Maneuvering
2015 @section Group Maneuvering
2016 @cindex group movement
2018 All movement commands understand the numeric prefix and will behave as
2019 expected, hopefully.
2025 @findex gnus-group-next-unread-group
2026 Go to the next group that has unread articles
2027 (@code{gnus-group-next-unread-group}).
2033 @findex gnus-group-prev-unread-group
2034 Go to the previous group that has unread articles
2035 (@code{gnus-group-prev-unread-group}).
2039 @findex gnus-group-next-group
2040 Go to the next group (@code{gnus-group-next-group}).
2044 @findex gnus-group-prev-group
2045 Go to the previous group (@code{gnus-group-prev-group}).
2049 @findex gnus-group-next-unread-group-same-level
2050 Go to the next unread group on the same (or lower) level
2051 (@code{gnus-group-next-unread-group-same-level}).
2055 @findex gnus-group-prev-unread-group-same-level
2056 Go to the previous unread group on the same (or lower) level
2057 (@code{gnus-group-prev-unread-group-same-level}).
2060 Three commands for jumping to groups:
2066 @findex gnus-group-jump-to-group
2067 Jump to a group (and make it visible if it isn't already)
2068 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2073 @findex gnus-group-best-unread-group
2074 Jump to the unread group with the lowest level
2075 (@code{gnus-group-best-unread-group}).
2079 @findex gnus-group-first-unread-group
2080 Jump to the first group with unread articles
2081 (@code{gnus-group-first-unread-group}).
2084 @vindex gnus-group-goto-unread
2085 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2086 commands will move to the next group, not the next unread group. Even
2087 the commands that say they move to the next unread group. The default
2091 @node Selecting a Group
2092 @section Selecting a Group
2093 @cindex group selection
2098 @kindex SPACE (Group)
2099 @findex gnus-group-read-group
2100 Select the current group, switch to the summary buffer and display the
2101 first unread article (@code{gnus-group-read-group}). If there are no
2102 unread articles in the group, or if you give a non-numerical prefix to
2103 this command, Gnus will offer to fetch all the old articles in this
2104 group from the server. If you give a numerical prefix @var{n}, @var{n}
2105 determines the number of articles Gnus will fetch. If @var{n} is
2106 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2107 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2109 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2110 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2111 - 4 2 SPC} fetches the 42 oldest ones.
2113 When you are in the group (in the Summary buffer), you can type
2114 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2119 @findex gnus-group-select-group
2120 Select the current group and switch to the summary buffer
2121 (@code{gnus-group-select-group}). Takes the same arguments as
2122 @code{gnus-group-read-group}---the only difference is that this command
2123 does not display the first unread article automatically upon group
2127 @kindex M-RET (Group)
2128 @findex gnus-group-quick-select-group
2129 This does the same as the command above, but tries to do it with the
2130 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2131 scoring/killing will be performed, there will be no highlights and no
2132 expunging. This might be useful if you're in a real hurry and have to
2133 enter some humongous group. If you give a 0 prefix to this command
2134 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
2135 which is useful if you want to toggle threading before generating the
2136 summary buffer (@pxref{Summary Generation Commands}).
2139 @kindex M-SPACE (Group)
2140 @findex gnus-group-visible-select-group
2141 This is yet one more command that does the same as the @kbd{RET}
2142 command, but this one does it without expunging and hiding dormants
2143 (@code{gnus-group-visible-select-group}).
2146 @kindex C-M-RET (Group)
2147 @findex gnus-group-select-group-ephemerally
2148 Finally, this command selects the current group ephemerally without
2149 doing any processing of its contents
2150 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2151 turned off. Everything you do in the group after selecting it in this
2152 manner will have no permanent effects.
2156 @vindex gnus-large-newsgroup
2157 The @code{gnus-large-newsgroup} variable says what Gnus should
2158 consider to be a big group. If it is @code{nil}, no groups are
2159 considered big. The default value is 200. If the group has more
2160 (unread and/or ticked) articles than this, Gnus will query the user
2161 before entering the group. The user can then specify how many
2162 articles should be fetched from the server. If the user specifies a
2163 negative number (@var{-n}), the @var{n} oldest articles will be
2164 fetched. If it is positive, the @var{n} articles that have arrived
2165 most recently will be fetched.
2167 @vindex gnus-large-ephemeral-newsgroup
2168 @code{gnus-large-ephemeral-newsgroup} is the same as
2169 @code{gnus-large-newsgroup}, but is only used for ephemeral
2172 @vindex gnus-select-group-hook
2173 @vindex gnus-auto-select-first
2174 @vindex gnus-auto-select-subject
2175 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2176 automatically when entering a group with the @kbd{SPACE} command.
2177 Which article this is is controlled by the
2178 @code{gnus-auto-select-subject} variable. Valid values for this
2184 Place point on the subject line of the first unread article.
2187 Place point on the subject line of the first article.
2190 Place point on the subject line of the first unseen article.
2192 @item unseen-or-unread
2193 Place point on the subject line of the first unseen article, and if
2194 there is no such article, place point on the subject line of the first
2198 Place point on the subject line of the highest-scored unread article.
2202 This variable can also be a function. In that case, that function
2203 will be called to place point on a subject line.
2205 If you want to prevent automatic selection in some group (say, in a
2206 binary group with Huge articles) you can set the
2207 @code{gnus-auto-select-first} variable to @code{nil} in
2208 @code{gnus-select-group-hook}, which is called when a group is
2212 @node Subscription Commands
2213 @section Subscription Commands
2214 @cindex subscription
2222 @findex gnus-group-unsubscribe-current-group
2223 @c @icon{gnus-group-unsubscribe}
2224 Toggle subscription to the current group
2225 (@code{gnus-group-unsubscribe-current-group}).
2231 @findex gnus-group-unsubscribe-group
2232 Prompt for a group to subscribe, and then subscribe it. If it was
2233 subscribed already, unsubscribe it instead
2234 (@code{gnus-group-unsubscribe-group}).
2240 @findex gnus-group-kill-group
2241 @c @icon{gnus-group-kill-group}
2242 Kill the current group (@code{gnus-group-kill-group}).
2248 @findex gnus-group-yank-group
2249 Yank the last killed group (@code{gnus-group-yank-group}).
2252 @kindex C-x C-t (Group)
2253 @findex gnus-group-transpose-groups
2254 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2255 really a subscription command, but you can use it instead of a
2256 kill-and-yank sequence sometimes.
2262 @findex gnus-group-kill-region
2263 Kill all groups in the region (@code{gnus-group-kill-region}).
2267 @findex gnus-group-kill-all-zombies
2268 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2271 @kindex S C-k (Group)
2272 @findex gnus-group-kill-level
2273 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2274 These groups can't be yanked back after killing, so this command should
2275 be used with some caution. The only time where this command comes in
2276 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2277 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2278 kill off all unsubscribed groups that do not have message numbers in the
2279 @file{.newsrc} file.
2283 Also @pxref{Group Levels}.
2293 @findex gnus-group-catchup-current
2294 @vindex gnus-group-catchup-group-hook
2295 @c @icon{gnus-group-catchup-current}
2296 Mark all unticked articles in this group as read
2297 (@code{gnus-group-catchup-current}).
2298 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2303 @findex gnus-group-catchup-current-all
2304 Mark all articles in this group, even the ticked ones, as read
2305 (@code{gnus-group-catchup-current-all}).
2309 @findex gnus-group-clear-data
2310 Clear the data from the current group---nix out marks and the list of
2311 read articles (@code{gnus-group-clear-data}).
2313 @item M-x gnus-group-clear-data-on-native-groups
2314 @kindex M-x gnus-group-clear-data-on-native-groups
2315 @findex gnus-group-clear-data-on-native-groups
2316 If you have switched from one @acronym{NNTP} server to another, all your marks
2317 and read ranges have become worthless. You can use this command to
2318 clear out all data that you have on your native groups. Use with
2325 @section Group Levels
2329 All groups have a level of @dfn{subscribedness}. For instance, if a
2330 group is on level 2, it is more subscribed than a group on level 5. You
2331 can ask Gnus to just list groups on a given level or lower
2332 (@pxref{Listing Groups}), or to just check for new articles in groups on
2333 a given level or lower (@pxref{Scanning New Messages}).
2335 Remember: The higher the level of the group, the less important it is.
2341 @findex gnus-group-set-current-level
2342 Set the level of the current group. If a numeric prefix is given, the
2343 next @var{n} groups will have their levels set. The user will be
2344 prompted for a level.
2347 @vindex gnus-level-killed
2348 @vindex gnus-level-zombie
2349 @vindex gnus-level-unsubscribed
2350 @vindex gnus-level-subscribed
2351 Gnus considers groups from levels 1 to
2352 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2353 @code{gnus-level-subscribed} (exclusive) and
2354 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2355 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2356 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2357 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2358 same, but zombie and killed groups have no information on what articles
2359 you have read, etc, stored. This distinction between dead and living
2360 groups isn't done because it is nice or clever, it is done purely for
2361 reasons of efficiency.
2363 It is recommended that you keep all your mail groups (if any) on quite
2364 low levels (e.g. 1 or 2).
2366 Maybe the following description of the default behavior of Gnus helps to
2367 understand what these levels are all about. By default, Gnus shows you
2368 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2369 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2370 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2371 groups are hidden, in a way.
2373 Zombie and killed groups are similar to unsubscribed groups in that they
2374 are hidden by default. But they are different from subscribed and
2375 unsubscribed groups in that Gnus doesn't ask the news server for
2376 information (number of messages, number of unread messages) on zombie
2377 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2378 aren't interested in. If most groups are killed, Gnus is faster.
2380 Why does Gnus distinguish between zombie and killed groups? Well, when
2381 a new group arrives on the server, Gnus by default makes it a zombie
2382 group. This means that you are normally not bothered with new groups,
2383 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2384 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2385 list of killed groups.)
2387 If you want to play with the level variables, you should show some care.
2388 Set them once, and don't touch them ever again. Better yet, don't touch
2389 them at all unless you know exactly what you're doing.
2391 @vindex gnus-level-default-unsubscribed
2392 @vindex gnus-level-default-subscribed
2393 Two closely related variables are @code{gnus-level-default-subscribed}
2394 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2395 which are the levels that new groups will be put on if they are
2396 (un)subscribed. These two variables should, of course, be inside the
2397 relevant valid ranges.
2399 @vindex gnus-keep-same-level
2400 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2401 will only move to groups of the same level (or lower). In
2402 particular, going from the last article in one group to the next group
2403 will go to the next group of the same level (or lower). This might be
2404 handy if you want to read the most important groups before you read the
2407 If this variable is @code{best}, Gnus will make the next newsgroup the
2408 one with the best level.
2410 @vindex gnus-group-default-list-level
2411 All groups with a level less than or equal to
2412 @code{gnus-group-default-list-level} will be listed in the group buffer
2415 @vindex gnus-group-list-inactive-groups
2416 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2417 groups will be listed along with the unread groups. This variable is
2418 @code{t} by default. If it is @code{nil}, inactive groups won't be
2421 @vindex gnus-group-use-permanent-levels
2422 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2423 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2424 use this level as the ``work'' level.
2426 @vindex gnus-activate-level
2427 Gnus will normally just activate (i. e., query the server about) groups
2428 on level @code{gnus-activate-level} or less. If you don't want to
2429 activate unsubscribed groups, for instance, you might set this variable
2430 to 5. The default is 6.
2434 @section Group Score
2439 You would normally keep important groups on high levels, but that scheme
2440 is somewhat restrictive. Don't you wish you could have Gnus sort the
2441 group buffer according to how often you read groups, perhaps? Within
2444 This is what @dfn{group score} is for. You can have Gnus assign a score
2445 to each group through the mechanism described below. You can then sort
2446 the group buffer based on this score. Alternatively, you can sort on
2447 score and then level. (Taken together, the level and the score is
2448 called the @dfn{rank} of the group. A group that is on level 4 and has
2449 a score of 1 has a higher rank than a group on level 5 that has a score
2450 of 300. (The level is the most significant part and the score is the
2451 least significant part.))
2453 @findex gnus-summary-bubble-group
2454 If you want groups you read often to get higher scores than groups you
2455 read seldom you can add the @code{gnus-summary-bubble-group} function to
2456 the @code{gnus-summary-exit-hook} hook. This will result (after
2457 sorting) in a bubbling sort of action. If you want to see that in
2458 action after each summary exit, you can add
2459 @code{gnus-group-sort-groups-by-rank} or
2460 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2461 slow things down somewhat.
2464 @node Marking Groups
2465 @section Marking Groups
2466 @cindex marking groups
2468 If you want to perform some command on several groups, and they appear
2469 subsequently in the group buffer, you would normally just give a
2470 numerical prefix to the command. Most group commands will then do your
2471 bidding on those groups.
2473 However, if the groups are not in sequential order, you can still
2474 perform a command on several groups. You simply mark the groups first
2475 with the process mark and then execute the command.
2483 @findex gnus-group-mark-group
2484 Set the mark on the current group (@code{gnus-group-mark-group}).
2490 @findex gnus-group-unmark-group
2491 Remove the mark from the current group
2492 (@code{gnus-group-unmark-group}).
2496 @findex gnus-group-unmark-all-groups
2497 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2501 @findex gnus-group-mark-region
2502 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2506 @findex gnus-group-mark-buffer
2507 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2511 @findex gnus-group-mark-regexp
2512 Mark all groups that match some regular expression
2513 (@code{gnus-group-mark-regexp}).
2516 Also @pxref{Process/Prefix}.
2518 @findex gnus-group-universal-argument
2519 If you want to execute some command on all groups that have been marked
2520 with the process mark, you can use the @kbd{M-&}
2521 (@code{gnus-group-universal-argument}) command. It will prompt you for
2522 the command to be executed.
2525 @node Foreign Groups
2526 @section Foreign Groups
2527 @cindex foreign groups
2529 Below are some group mode commands for making and editing general foreign
2530 groups, as well as commands to ease the creation of a few
2531 special-purpose groups. All these commands insert the newly created
2532 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2535 Changes from the group editing commands are stored in
2536 @file{~/.newsrc.eld} (@code{gnus-startup-file}). An alternative is the
2537 variable @code{gnus-parameters}, @xref{Group Parameters}.
2543 @findex gnus-group-make-group
2544 @cindex making groups
2545 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2546 for a name, a method and possibly an @dfn{address}. For an easier way
2547 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2551 @findex gnus-group-read-ephemeral-group
2552 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2553 will prompt you for a name, a method and an @dfn{address}.
2557 @findex gnus-group-rename-group
2558 @cindex renaming groups
2559 Rename the current group to something else
2560 (@code{gnus-group-rename-group}). This is valid only on some
2561 groups---mail groups mostly. This command might very well be quite slow
2567 @findex gnus-group-customize
2568 Customize the group parameters (@code{gnus-group-customize}).
2572 @findex gnus-group-edit-group-method
2573 @cindex renaming groups
2574 Enter a buffer where you can edit the select method of the current
2575 group (@code{gnus-group-edit-group-method}).
2579 @findex gnus-group-edit-group-parameters
2580 Enter a buffer where you can edit the group parameters
2581 (@code{gnus-group-edit-group-parameters}).
2585 @findex gnus-group-edit-group
2586 Enter a buffer where you can edit the group info
2587 (@code{gnus-group-edit-group}).
2591 @findex gnus-group-make-directory-group
2593 Make a directory group (@pxref{Directory Groups}). You will be prompted
2594 for a directory name (@code{gnus-group-make-directory-group}).
2599 @findex gnus-group-make-help-group
2600 Make the Gnus help group (@code{gnus-group-make-help-group}).
2604 @cindex (ding) archive
2605 @cindex archive group
2606 @findex gnus-group-make-archive-group
2607 @vindex gnus-group-archive-directory
2608 @vindex gnus-group-recent-archive-directory
2609 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
2610 default a group pointing to the most recent articles will be created
2611 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2612 group will be created from @code{gnus-group-archive-directory}.
2616 @findex gnus-group-make-kiboze-group
2618 Make a kiboze group. You will be prompted for a name, for a regexp to
2619 match groups to be ``included'' in the kiboze group, and a series of
2620 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2621 @xref{Kibozed Groups}.
2625 @findex gnus-group-enter-directory
2627 Read an arbitrary directory as if it were a newsgroup with the
2628 @code{nneething} back end (@code{gnus-group-enter-directory}).
2629 @xref{Anything Groups}.
2633 @findex gnus-group-make-doc-group
2634 @cindex ClariNet Briefs
2636 Make a group based on some file or other
2637 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2638 command, you will be prompted for a file name and a file type.
2639 Currently supported types are @code{mbox}, @code{babyl},
2640 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2641 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2642 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2643 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2644 you run this command without a prefix, Gnus will guess at the file
2645 type. @xref{Document Groups}.
2649 @vindex gnus-useful-groups
2650 @findex gnus-group-make-useful-group
2651 Create one of the groups mentioned in @code{gnus-useful-groups}
2652 (@code{gnus-group-make-useful-group}).
2656 @findex gnus-group-make-web-group
2660 Make an ephemeral group based on a web search
2661 (@code{gnus-group-make-web-group}). If you give a prefix to this
2662 command, make a solid group instead. You will be prompted for the
2663 search engine type and the search string. Valid search engine types
2664 include @code{google}, @code{dejanews}, and @code{gmane}.
2665 @xref{Web Searches}.
2667 If you use the @code{google} search engine, you can limit the search
2668 to a particular group by using a match string like
2669 @samp{shaving group:alt.sysadmin.recovery}.
2673 @findex gnus-group-make-rss-group
2674 Make a group based on an @acronym{RSS} feed
2675 (@code{gnus-group-make-rss-group}). You will be prompted for an URL.
2679 @kindex G DEL (Group)
2680 @findex gnus-group-delete-group
2681 This function will delete the current group
2682 (@code{gnus-group-delete-group}). If given a prefix, this function will
2683 actually delete all the articles in the group, and forcibly remove the
2684 group itself from the face of the Earth. Use a prefix only if you are
2685 absolutely sure of what you are doing. This command can't be used on
2686 read-only groups (like @code{nntp} groups), though.
2690 @findex gnus-group-make-empty-virtual
2691 Make a new, fresh, empty @code{nnvirtual} group
2692 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2696 @findex gnus-group-add-to-virtual
2697 Add the current group to an @code{nnvirtual} group
2698 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2701 @xref{Select Methods}, for more information on the various select
2704 @vindex gnus-activate-foreign-newsgroups
2705 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2706 Gnus will check all foreign groups with this level or lower at startup.
2707 This might take quite a while, especially if you subscribe to lots of
2708 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2709 @code{gnus-activate-level} also affects activation of foreign
2713 @node Group Parameters
2714 @section Group Parameters
2715 @cindex group parameters
2717 The group parameters store information local to a particular group.
2718 Here's an example group parameter list:
2721 ((to-address . "ding@@gnus.org")
2725 We see that each element consists of a ``dotted pair''---the thing before
2726 the dot is the key, while the thing after the dot is the value. All the
2727 parameters have this form @emph{except} local variable specs, which are
2728 not dotted pairs, but proper lists.
2730 Some parameters have correspondent customizable variables, each of which
2731 is an alist of regexps and values.
2733 The following group parameters can be used:
2738 Address used by when doing followups and new posts.
2741 (to-address . "some@@where.com")
2744 This is primarily useful in mail groups that represent closed mailing
2745 lists---mailing lists where it's expected that everybody that writes to
2746 the mailing list is subscribed to it. Since using this parameter
2747 ensures that the mail only goes to the mailing list itself, it means
2748 that members won't receive two copies of your followups.
2750 Using @code{to-address} will actually work whether the group is foreign
2751 or not. Let's say there's a group on the server that is called
2752 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2753 the articles from a mail-to-news gateway. Posting directly to this
2754 group is therefore impossible---you have to send mail to the mailing
2755 list address instead.
2757 See also @code{gnus-parameter-to-address-alist}.
2761 Address used when doing @kbd{a} in that group.
2764 (to-list . "some@@where.com")
2767 It is totally ignored
2768 when doing a followup---except that if it is present in a news group,
2769 you'll get mail group semantics when doing @kbd{f}.
2771 If you do an @kbd{a} command in a mail group and you have neither a
2772 @code{to-list} group parameter nor a @code{to-address} group parameter,
2773 then a @code{to-list} group parameter will be added automatically upon
2774 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2775 @vindex gnus-add-to-list
2777 @findex gnus-mailing-list-mode
2778 @cindex mail list groups
2779 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2780 entering summary buffer.
2782 See also @code{gnus-parameter-to-list-alist}.
2787 @cindex Mail-Followup-To
2788 @findex gnus-find-subscribed-addresses
2789 If this parameter is set to @code{t}, Gnus will consider the
2790 to-address and to-list parameters for this group as addresses of
2791 mailing lists you are subscribed to. Giving Gnus this information is
2792 (only) a first step in getting it to generate correct Mail-Followup-To
2793 headers for your posts to these lists. The second step is to put the
2794 following in your @file{.gnus.el}
2797 (setq message-subscribed-address-functions
2798 '(gnus-find-subscribed-addresses))
2801 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2802 a complete treatment of available MFT support.
2806 If the group parameter list has the element @code{(visible . t)},
2807 that group will always be visible in the Group buffer, regardless
2808 of whether it has any unread articles.
2810 This parameter cannot be set via @code{gnus-parameters}. See
2811 @code{gnus-permanently-visible-groups} as an alternative.
2813 @item broken-reply-to
2814 @cindex broken-reply-to
2815 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2816 headers in this group are to be ignored, and for the header to be hidden
2817 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2818 can be useful if you're reading a mailing list group where the listserv
2819 has inserted @code{Reply-To} headers that point back to the listserv
2820 itself. That is broken behavior. So there!
2824 Elements like @code{(to-group . "some.group.name")} means that all
2825 posts in that group will be sent to @code{some.group.name}.
2829 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2830 will treat all responses as if they were responses to news articles.
2831 This can be useful if you have a mail group that's really a mirror of a
2836 If @code{(gcc-self . t)} is present in the group parameter list, newly
2837 composed messages will be @code{Gcc}'d to the current group. If
2838 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2839 generated, if @code{(gcc-self . "string")} is present, this string will
2840 be inserted literally as a @code{gcc} header. This parameter takes
2841 precedence over any default @code{Gcc} rules as described later
2842 (@pxref{Archived Messages}).
2844 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2845 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2846 doesn't accept articles.
2850 @cindex expiring mail
2851 If the group parameter has an element that looks like @code{(auto-expire
2852 . t)}, all articles read will be marked as expirable. For an
2853 alternative approach, @pxref{Expiring Mail}.
2855 See also @code{gnus-auto-expirable-newsgroups}.
2858 @cindex total-expire
2859 @cindex expiring mail
2860 If the group parameter has an element that looks like
2861 @code{(total-expire . t)}, all read articles will be put through the
2862 expiry process, even if they are not marked as expirable. Use with
2863 caution. Unread, ticked and dormant articles are not eligible for
2866 See also @code{gnus-total-expirable-newsgroups}.
2870 @vindex nnmail-expiry-wait-function
2871 If the group parameter has an element that looks like
2872 @code{(expiry-wait . 10)}, this value will override any
2873 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2874 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2875 can either be a number of days (not necessarily an integer) or the
2876 symbols @code{never} or @code{immediate}.
2879 @cindex expiry-target
2880 Where expired messages end up. This parameter overrides
2881 @code{nnmail-expiry-target}.
2884 @cindex score file group parameter
2885 Elements that look like @code{(score-file . "file")} will make
2886 @file{file} into the current score file for the group in question. All
2887 interactive score entries will be put into this file.
2890 @cindex adapt file group parameter
2891 Elements that look like @code{(adapt-file . "file")} will make
2892 @file{file} into the current adaptive file for the group in question.
2893 All adaptive score entries will be put into this file.
2896 @cindex admin-address
2897 When unsubscribing from a mailing list you should never send the
2898 unsubscription notice to the mailing list itself. Instead, you'd send
2899 messages to the administrative address. This parameter allows you to
2900 put the admin address somewhere convenient.
2904 Elements that look like @code{(display . MODE)} say which articles to
2905 display on entering the group. Valid values are:
2909 Display all articles, both read and unread.
2912 Display the last @var{integer} articles in the group. This is the same as
2913 entering the group with @kbd{C-u @var{integer}}.
2916 Display the default visible articles, which normally includes unread and
2920 Display articles that satisfy a predicate.
2922 Here are some examples:
2926 Display only unread articles.
2929 Display everything except expirable articles.
2931 @item [and (not reply) (not expire)]
2932 Display everything except expirable and articles you've already
2936 The available operators are @code{not}, @code{and} and @code{or}.
2937 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2938 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2939 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2940 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2944 The @code{display} parameter works by limiting the summary buffer to
2945 the subset specified. You can pop the limit by using the @kbd{/ w}
2946 command (@pxref{Limiting}).
2950 Elements that look like @code{(comment . "This is a comment")} are
2951 arbitrary comments on the group. You can display comments in the
2952 group line (@pxref{Group Line Specification}).
2956 Elements that look like @code{(charset . iso-8859-1)} will make
2957 @code{iso-8859-1} the default charset; that is, the charset that will be
2958 used for all articles that do not specify a charset.
2960 See also @code{gnus-group-charset-alist}.
2962 @item ignored-charsets
2963 @cindex ignored-charset
2964 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2965 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2966 default charset will be used for decoding articles.
2968 See also @code{gnus-group-ignored-charsets-alist}.
2971 @cindex posting-style
2972 You can store additional posting style information for this group
2973 here (@pxref{Posting Styles}). The format is that of an entry in the
2974 @code{gnus-posting-styles} alist, except that there's no regexp matching
2975 the group name (of course). Style elements in this group parameter will
2976 take precedence over the ones found in @code{gnus-posting-styles}.
2978 For instance, if you want a funky name and signature in this group only,
2979 instead of hacking @code{gnus-posting-styles}, you could put something
2980 like this in the group parameters:
2985 ("X-My-Header" "Funky Value")
2986 (signature "Funky Signature"))
2989 If you're using topics to organize your group buffer
2990 (@pxref{Group Topics}), note that posting styles can also be set in
2991 the topics parameters. Posting styles in topic parameters apply to all
2992 groups in this topic. More precisely, the posting-style settings for a
2993 group result from the hierarchical merging of all posting-style
2994 entries in the parameters of this group and all the topics it belongs
3000 If it is set, the value is used as the method for posting message
3001 instead of @code{gnus-post-method}.
3005 An item like @code{(banner . @var{regexp})} causes any part of an article
3006 that matches the regular expression @var{regexp} to be stripped. Instead of
3007 @var{regexp}, you can also use the symbol @code{signature} which strips the
3008 last signature or any of the elements of the alist
3009 @code{gnus-article-banner-alist}.
3013 This parameter contains a Sieve test that should match incoming mail
3014 that should be placed in this group. From this group parameter, a
3015 Sieve @samp{IF} control structure is generated, having the test as the
3016 condition and @samp{fileinto "group.name";} as the body.
3018 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
3019 address "sender" "sieve-admin@@extundo.com")} group parameter, when
3020 translating the group parameter into a Sieve script (@pxref{Sieve
3021 Commands}) the following Sieve code is generated:
3024 if address "sender" "sieve-admin@@extundo.com" @{
3025 fileinto "INBOX.list.sieve";
3029 To generate tests for multiple email-addresses use a group parameter
3030 like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}.
3031 When generating a sieve script (@pxref{Sieve Commands}) Sieve code
3032 like the following is generated:
3035 if address "sender" ["name@@one.org", "else@@two.org"] @{
3036 fileinto "INBOX.list.sieve";
3040 See @pxref{Sieve Commands} for commands and variables that might be of
3041 interest in relation to the sieve parameter.
3043 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3044 Top, sieve, Emacs Sieve}.
3046 @item (agent parameters)
3047 If the agent has been enabled, you can set any of the its parameters
3048 to control the behavior of the agent in individual groups. See Agent
3049 Parameters in @ref{Category Syntax}. Most users will choose to set
3050 agent parameters in either an agent category or group topic to
3051 minimize the configuration effort.
3053 @item (@var{variable} @var{form})
3054 You can use the group parameters to set variables local to the group you
3055 are entering. If you want to turn threading off in @samp{news.answers},
3056 you could put @code{(gnus-show-threads nil)} in the group parameters of
3057 that group. @code{gnus-show-threads} will be made into a local variable
3058 in the summary buffer you enter, and the form @code{nil} will be
3059 @code{eval}ed there.
3061 Note that this feature sets the variable locally to the summary buffer.
3062 But some variables are evaluated in the article buffer, or in the
3063 message buffer (of a reply or followup or otherwise newly created
3064 message). As a workaround, it might help to add the variable in
3065 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3066 Stuff}. So if you want to set @code{message-from-style} via the group
3067 parameters, then you may need the following statement elsewhere in your
3068 @file{~/.gnus} file:
3071 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3074 @vindex gnus-list-identifiers
3075 A use for this feature is to remove a mailing list identifier tag in
3076 the subject fields of articles. E.g. if the news group
3079 nntp+news.gnus.org:gmane.text.docbook.apps
3082 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3083 tag can be removed from the article subjects in the summary buffer for
3084 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3085 into the group parameters for the group.
3087 This can also be used as a group-specific hook function. If you want to
3088 hear a beep when you enter a group, you could put something like
3089 @code{(dummy-variable (ding))} in the parameters of that group.
3090 @code{dummy-variable} will be set to the (meaningless) result of the
3093 Alternatively, since the VARIABLE becomes local to the group, this
3094 pattern can be used to temporarily change a hook. For example, if the
3095 following is added to a group parameter
3098 (gnus-summary-prepared-hook
3099 '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3102 when the group is entered, the 'd' key will not mark the article as
3107 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3108 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3109 presents you with a Customize-like interface. The latter helps avoid
3110 silly Lisp errors.) You might also be interested in reading about topic
3111 parameters (@pxref{Topic Parameters}).
3113 @vindex gnus-parameters
3114 Group parameters can be set via the @code{gnus-parameters} variable too.
3115 But some variables, such as @code{visible}, have no effect (For this
3116 case see @code{gnus-permanently-visible-groups} as an alternative.).
3120 (setq gnus-parameters
3122 (gnus-show-threads nil)
3123 (gnus-use-scoring nil)
3124 (gnus-summary-line-format
3125 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3129 ("^nnimap:\\(foo.bar\\)$"
3133 (gnus-use-scoring t))
3137 (broken-reply-to . t))))
3140 String value of parameters will be subjected to regexp substitution, as
3141 the @code{to-group} example shows.
3143 @vindex gnus-parameters-case-fold-search
3144 By default, whether comparing the group name and one of those regexps
3145 specified in @code{gnus-parameters} is done in a case-sensitive manner
3146 or a case-insensitive manner depends on the value of
3147 @code{case-fold-search} at the time when the comparison is done. The
3148 value of @code{case-fold-search} is typically @code{t}; it means, for
3149 example, the element @code{("INBOX\\.FOO" (total-expire . t))} might be
3150 applied to both the @samp{INBOX.FOO} group and the @samp{INBOX.foo}
3151 group. If you want to make those regexps always case-sensitive, set the
3152 value of the @code{gnus-parameters-case-fold-search} variable to
3153 @code{nil}. Otherwise, set it to @code{t} if you want to compare them
3154 always in a case-insensitive manner.
3156 You can define different sorting to different groups via
3157 @code{gnus-parameters}. Here is an example to sort an @acronym{NNTP}
3158 group by reverse date to see the latest news at the top and an
3159 @acronym{RSS} group by subject. In this example, the first group is the
3160 Debian daily news group @code{gmane.linux.debian.user.news} from
3161 news.gmane.org. The @acronym{RSS} group corresponds to the Debian
3162 weekly news RSS feed
3163 @url{http://packages.debian.org/unstable/newpkg_main.en.rdf},
3169 '(("nntp.*gmane\\.debian\\.user\\.news"
3170 (gnus-show-threads nil)
3171 (gnus-article-sort-functions '((not gnus-article-sort-by-date)))
3172 (gnus-use-adaptive-scoring nil)
3173 (gnus-use-scoring nil))
3175 (gnus-show-threads nil)
3176 (gnus-article-sort-functions 'gnus-article-sort-by-subject)
3177 (gnus-use-adaptive-scoring nil)
3178 (gnus-use-scoring t)
3179 (gnus-score-find-score-files-function 'gnus-score-find-single)
3180 (gnus-summary-line-format "%U%R%z%d %I%(%[ %s %]%)\n"))))
3184 @node Listing Groups
3185 @section Listing Groups
3186 @cindex group listing
3188 These commands all list various slices of the groups available.
3196 @findex gnus-group-list-groups
3197 List all groups that have unread articles
3198 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3199 command will list only groups of level ARG and lower. By default, it
3200 only lists groups of level five (i.e.,
3201 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3208 @findex gnus-group-list-all-groups
3209 List all groups, whether they have unread articles or not
3210 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3211 this command will list only groups of level ARG and lower. By default,
3212 it lists groups of level seven or lower (i.e., just subscribed and
3213 unsubscribed groups).
3217 @findex gnus-group-list-level
3218 List all unread groups on a specific level
3219 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3220 with no unread articles.
3224 @findex gnus-group-list-killed
3225 List all killed groups (@code{gnus-group-list-killed}). If given a
3226 prefix argument, really list all groups that are available, but aren't
3227 currently (un)subscribed. This could entail reading the active file
3232 @findex gnus-group-list-zombies
3233 List all zombie groups (@code{gnus-group-list-zombies}).
3237 @findex gnus-group-list-matching
3238 List all unread, subscribed groups with names that match a regexp
3239 (@code{gnus-group-list-matching}).
3243 @findex gnus-group-list-all-matching
3244 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3248 @findex gnus-group-list-active
3249 List absolutely all groups in the active file(s) of the
3250 server(s) you are connected to (@code{gnus-group-list-active}). This
3251 might very well take quite a while. It might actually be a better idea
3252 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3253 thing to match on. Also note that this command may list groups that
3254 don't exist (yet)---these will be listed as if they were killed groups.
3255 Take the output with some grains of salt.
3259 @findex gnus-group-apropos
3260 List all groups that have names that match a regexp
3261 (@code{gnus-group-apropos}).
3265 @findex gnus-group-description-apropos
3266 List all groups that have names or descriptions that match a regexp
3267 (@code{gnus-group-description-apropos}).
3271 @findex gnus-group-list-cached
3272 List all groups with cached articles (@code{gnus-group-list-cached}).
3276 @findex gnus-group-list-dormant
3277 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3281 @findex gnus-group-list-limit
3282 List groups limited within the current selection
3283 (@code{gnus-group-list-limit}).
3287 @findex gnus-group-list-flush
3288 Flush groups from the current selection (@code{gnus-group-list-flush}).
3292 @findex gnus-group-list-plus
3293 List groups plus the current selection (@code{gnus-group-list-plus}).
3297 @vindex gnus-permanently-visible-groups
3298 @cindex visible group parameter
3299 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3300 always be shown, whether they have unread articles or not. You can also
3301 add the @code{visible} element to the group parameters in question to
3302 get the same effect.
3304 @vindex gnus-list-groups-with-ticked-articles
3305 Groups that have just ticked articles in it are normally listed in the
3306 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3307 @code{nil}, these groups will be treated just like totally empty
3308 groups. It is @code{t} by default.
3311 @node Sorting Groups
3312 @section Sorting Groups
3313 @cindex sorting groups
3315 @kindex C-c C-s (Group)
3316 @findex gnus-group-sort-groups
3317 @vindex gnus-group-sort-function
3318 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3319 group buffer according to the function(s) given by the
3320 @code{gnus-group-sort-function} variable. Available sorting functions
3325 @item gnus-group-sort-by-alphabet
3326 @findex gnus-group-sort-by-alphabet
3327 Sort the group names alphabetically. This is the default.
3329 @item gnus-group-sort-by-real-name
3330 @findex gnus-group-sort-by-real-name
3331 Sort the group alphabetically on the real (unprefixed) group names.
3333 @item gnus-group-sort-by-level
3334 @findex gnus-group-sort-by-level
3335 Sort by group level.
3337 @item gnus-group-sort-by-score
3338 @findex gnus-group-sort-by-score
3339 Sort by group score. @xref{Group Score}.
3341 @item gnus-group-sort-by-rank
3342 @findex gnus-group-sort-by-rank
3343 Sort by group score and then the group level. The level and the score
3344 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3346 @item gnus-group-sort-by-unread
3347 @findex gnus-group-sort-by-unread
3348 Sort by number of unread articles.
3350 @item gnus-group-sort-by-method
3351 @findex gnus-group-sort-by-method
3352 Sort alphabetically on the select method.
3354 @item gnus-group-sort-by-server
3355 @findex gnus-group-sort-by-server
3356 Sort alphabetically on the Gnus server name.
3361 @code{gnus-group-sort-function} can also be a list of sorting
3362 functions. In that case, the most significant sort key function must be
3366 There are also a number of commands for sorting directly according to
3367 some sorting criteria:
3371 @kindex G S a (Group)
3372 @findex gnus-group-sort-groups-by-alphabet
3373 Sort the group buffer alphabetically by group name
3374 (@code{gnus-group-sort-groups-by-alphabet}).
3377 @kindex G S u (Group)
3378 @findex gnus-group-sort-groups-by-unread
3379 Sort the group buffer by the number of unread articles
3380 (@code{gnus-group-sort-groups-by-unread}).
3383 @kindex G S l (Group)
3384 @findex gnus-group-sort-groups-by-level
3385 Sort the group buffer by group level
3386 (@code{gnus-group-sort-groups-by-level}).
3389 @kindex G S v (Group)
3390 @findex gnus-group-sort-groups-by-score
3391 Sort the group buffer by group score
3392 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3395 @kindex G S r (Group)
3396 @findex gnus-group-sort-groups-by-rank
3397 Sort the group buffer by group rank
3398 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3401 @kindex G S m (Group)
3402 @findex gnus-group-sort-groups-by-method
3403 Sort the group buffer alphabetically by back end name@*
3404 (@code{gnus-group-sort-groups-by-method}).
3407 @kindex G S n (Group)
3408 @findex gnus-group-sort-groups-by-real-name
3409 Sort the group buffer alphabetically by real (unprefixed) group name
3410 (@code{gnus-group-sort-groups-by-real-name}).
3414 All the commands below obey the process/prefix convention
3415 (@pxref{Process/Prefix}).
3417 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3418 commands will sort in reverse order.
3420 You can also sort a subset of the groups:
3424 @kindex G P a (Group)
3425 @findex gnus-group-sort-selected-groups-by-alphabet
3426 Sort the groups alphabetically by group name
3427 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3430 @kindex G P u (Group)
3431 @findex gnus-group-sort-selected-groups-by-unread
3432 Sort the groups by the number of unread articles
3433 (@code{gnus-group-sort-selected-groups-by-unread}).
3436 @kindex G P l (Group)
3437 @findex gnus-group-sort-selected-groups-by-level
3438 Sort the groups by group level
3439 (@code{gnus-group-sort-selected-groups-by-level}).
3442 @kindex G P v (Group)
3443 @findex gnus-group-sort-selected-groups-by-score
3444 Sort the groups by group score
3445 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3448 @kindex G P r (Group)
3449 @findex gnus-group-sort-selected-groups-by-rank
3450 Sort the groups by group rank
3451 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3454 @kindex G P m (Group)
3455 @findex gnus-group-sort-selected-groups-by-method
3456 Sort the groups alphabetically by back end name@*
3457 (@code{gnus-group-sort-selected-groups-by-method}).
3460 @kindex G P n (Group)
3461 @findex gnus-group-sort-selected-groups-by-real-name
3462 Sort the groups alphabetically by real (unprefixed) group name
3463 (@code{gnus-group-sort-selected-groups-by-real-name}).
3466 @kindex G P s (Group)
3467 @findex gnus-group-sort-selected-groups
3468 Sort the groups according to @code{gnus-group-sort-function}.
3472 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3476 @node Group Maintenance
3477 @section Group Maintenance
3478 @cindex bogus groups
3483 @findex gnus-group-check-bogus-groups
3484 Find bogus groups and delete them
3485 (@code{gnus-group-check-bogus-groups}).
3489 @findex gnus-group-find-new-groups
3490 Find new groups and process them (@code{gnus-group-find-new-groups}).
3491 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3492 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3493 to query the server for new groups, and subscribe the new groups as
3497 @kindex C-c C-x (Group)
3498 @findex gnus-group-expire-articles
3499 @cindex expiring mail
3500 Run all expirable articles in the current group through the expiry
3501 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3502 all expirable articles in the group that have been around for a while.
3503 (@pxref{Expiring Mail}).
3506 @kindex C-c C-M-x (Group)
3507 @findex gnus-group-expire-all-groups
3508 @cindex expiring mail
3509 Run all expirable articles in all groups through the expiry process
3510 (@code{gnus-group-expire-all-groups}).
3515 @node Browse Foreign Server
3516 @section Browse Foreign Server
3517 @cindex foreign servers
3518 @cindex browsing servers
3523 @findex gnus-group-browse-foreign-server
3524 You will be queried for a select method and a server name. Gnus will
3525 then attempt to contact this server and let you browse the groups there
3526 (@code{gnus-group-browse-foreign-server}).
3529 @findex gnus-browse-mode
3530 A new buffer with a list of available groups will appear. This buffer
3531 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3532 a lot) like a normal group buffer.
3534 Here's a list of keystrokes available in the browse mode:
3539 @findex gnus-group-next-group
3540 Go to the next group (@code{gnus-group-next-group}).
3544 @findex gnus-group-prev-group
3545 Go to the previous group (@code{gnus-group-prev-group}).
3548 @kindex SPACE (Browse)
3549 @findex gnus-browse-read-group
3550 Enter the current group and display the first article
3551 (@code{gnus-browse-read-group}).
3554 @kindex RET (Browse)
3555 @findex gnus-browse-select-group
3556 Enter the current group (@code{gnus-browse-select-group}).
3560 @findex gnus-browse-unsubscribe-current-group
3561 Unsubscribe to the current group, or, as will be the case here,
3562 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3568 @findex gnus-browse-exit
3569 Exit browse mode (@code{gnus-browse-exit}).
3573 @findex gnus-browse-describe-group
3574 Describe the current group (@code{gnus-browse-describe-group}).
3578 @findex gnus-browse-describe-briefly
3579 Describe browse mode briefly (well, there's not much to describe, is
3580 there) (@code{gnus-browse-describe-briefly}).
3585 @section Exiting Gnus
3586 @cindex exiting Gnus
3588 Yes, Gnus is ex(c)iting.
3593 @findex gnus-group-suspend
3594 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3595 but it kills all buffers except the Group buffer. I'm not sure why this
3596 is a gain, but then who am I to judge?
3600 @findex gnus-group-exit
3601 @c @icon{gnus-group-exit}
3602 Quit Gnus (@code{gnus-group-exit}).
3606 @findex gnus-group-quit
3607 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3608 The dribble file will be saved, though (@pxref{Auto Save}).
3611 @vindex gnus-exit-gnus-hook
3612 @vindex gnus-suspend-gnus-hook
3613 @vindex gnus-after-exiting-gnus-hook
3614 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3615 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3616 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3622 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3623 numbly heavy and herself fall into a hazy trance as the boy sitting
3624 behind her drew repeated lines with his pencil across the back of her
3630 @section Group Topics
3633 If you read lots and lots of groups, it might be convenient to group
3634 them hierarchically according to topics. You put your Emacs groups over
3635 here, your sex groups over there, and the rest (what, two groups or so?)
3636 you put in some misc section that you never bother with anyway. You can
3637 even group the Emacs sex groups as a sub-topic to either the Emacs
3638 groups or the sex groups---or both! Go wild!
3642 \gnusfigure{Group Topics}{400}{
3643 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3654 2: alt.religion.emacs
3657 0: comp.talk.emacs.recovery
3659 8: comp.binaries.fractals
3660 13: comp.sources.unix
3663 @findex gnus-topic-mode
3665 To get this @emph{fab} functionality you simply turn on (ooh!) the
3666 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3667 is a toggling command.)
3669 Go ahead, just try it. I'll still be here when you get back. La de
3670 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3671 Yes, and now press @kbd{l}. There. All your groups are now listed
3672 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3675 If you want this permanently enabled, you should add that minor mode to
3676 the hook for the group mode. Put the following line in your
3677 @file{~/.gnus.el} file:
3680 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3684 * Topic Commands:: Interactive E-Z commands.
3685 * Topic Variables:: How to customize the topics the Lisp Way.
3686 * Topic Sorting:: Sorting each topic individually.
3687 * Topic Topology:: A map of the world.
3688 * Topic Parameters:: Parameters that apply to all groups in a topic.
3692 @node Topic Commands
3693 @subsection Topic Commands
3694 @cindex topic commands
3696 When the topic minor mode is turned on, a new @kbd{T} submap will be
3697 available. In addition, a few of the standard keys change their
3698 definitions slightly.
3700 In general, the following kinds of operations are possible on topics.
3701 First of all, you want to create topics. Secondly, you want to put
3702 groups in topics and to move them around until you have an order you
3703 like. The third kind of operation is to show/hide parts of the whole
3704 shebang. You might want to hide a topic including its subtopics and
3705 groups, to get a better overview of the other groups.
3707 Here is a list of the basic keys that you might need to set up topics
3714 @findex gnus-topic-create-topic
3715 Prompt for a new topic name and create it
3716 (@code{gnus-topic-create-topic}).
3720 @kindex T TAB (Topic)
3722 @findex gnus-topic-indent
3723 ``Indent'' the current topic so that it becomes a sub-topic of the
3724 previous topic (@code{gnus-topic-indent}). If given a prefix,
3725 ``un-indent'' the topic instead.
3728 @kindex M-TAB (Topic)
3729 @findex gnus-topic-unindent
3730 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3731 parent of its current parent (@code{gnus-topic-unindent}).
3735 The following two keys can be used to move groups and topics around.
3736 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3737 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3738 kill and yank rather than cut and paste.
3744 @findex gnus-topic-kill-group
3745 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3746 topic will be removed along with the topic.
3750 @findex gnus-topic-yank-group
3751 Yank the previously killed group or topic
3752 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3755 So, to move a topic to the beginning of the list of topics, just hit
3756 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3757 move the cursor to the beginning of the buffer (just below the ``Gnus''
3758 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3759 paste. Like I said -- E-Z.
3761 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3762 you can move topics around as well as groups.
3766 After setting up the topics the way you like them, you might wish to
3767 hide a topic, or to show it again. That's why we have the following
3774 @findex gnus-topic-select-group
3776 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3777 When you perform this command on a group, you'll enter the group, as
3778 usual. When done on a topic line, the topic will be folded (if it was
3779 visible) or unfolded (if it was folded already). So it's basically a
3780 toggling command on topics. In addition, if you give a numerical
3781 prefix, group on that level (and lower) will be displayed.
3785 Now for a list of other commands, in no particular order.
3791 @findex gnus-topic-move-group
3792 Move the current group to some other topic
3793 (@code{gnus-topic-move-group}). This command uses the process/prefix
3794 convention (@pxref{Process/Prefix}).
3798 @findex gnus-topic-jump-to-topic
3799 Go to a topic (@code{gnus-topic-jump-to-topic}).
3803 @findex gnus-topic-copy-group
3804 Copy the current group to some other topic
3805 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3806 convention (@pxref{Process/Prefix}).
3810 @findex gnus-topic-hide-topic
3811 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3812 a prefix, hide the topic permanently.
3816 @findex gnus-topic-show-topic
3817 Show the current topic (@code{gnus-topic-show-topic}). If given
3818 a prefix, show the topic permanently.
3822 @findex gnus-topic-remove-group
3823 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3824 This command is mainly useful if you have the same group in several
3825 topics and wish to remove it from one of the topics. You may also
3826 remove a group from all topics, but in that case, Gnus will add it to
3827 the root topic the next time you start Gnus. In fact, all new groups
3828 (which, naturally, don't belong to any topic) will show up in the root
3831 This command uses the process/prefix convention
3832 (@pxref{Process/Prefix}).
3836 @findex gnus-topic-move-matching
3837 Move all groups that match some regular expression to a topic
3838 (@code{gnus-topic-move-matching}).
3842 @findex gnus-topic-copy-matching
3843 Copy all groups that match some regular expression to a topic
3844 (@code{gnus-topic-copy-matching}).
3848 @findex gnus-topic-toggle-display-empty-topics
3849 Toggle hiding empty topics
3850 (@code{gnus-topic-toggle-display-empty-topics}).
3854 @findex gnus-topic-mark-topic
3855 Mark all groups in the current topic with the process mark
3856 (@code{gnus-topic-mark-topic}). This command works recursively on
3857 sub-topics unless given a prefix.
3860 @kindex T M-# (Topic)
3861 @findex gnus-topic-unmark-topic
3862 Remove the process mark from all groups in the current topic
3863 (@code{gnus-topic-unmark-topic}). This command works recursively on
3864 sub-topics unless given a prefix.
3867 @kindex C-c C-x (Topic)
3868 @findex gnus-topic-expire-articles
3869 @cindex expiring mail
3870 Run all expirable articles in the current group or topic through the
3871 expiry process (if any)
3872 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3876 @findex gnus-topic-rename
3877 Rename a topic (@code{gnus-topic-rename}).
3880 @kindex T DEL (Topic)
3881 @findex gnus-topic-delete
3882 Delete an empty topic (@code{gnus-topic-delete}).
3886 @findex gnus-topic-list-active
3887 List all groups that Gnus knows about in a topics-ified way
3888 (@code{gnus-topic-list-active}).
3891 @kindex T M-n (Topic)
3892 @findex gnus-topic-goto-next-topic
3893 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3896 @kindex T M-p (Topic)
3897 @findex gnus-topic-goto-previous-topic
3898 Go to the previous topic (@code{gnus-topic-goto-previous-topic}).
3902 @findex gnus-topic-edit-parameters
3903 @cindex group parameters
3904 @cindex topic parameters
3906 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3907 @xref{Topic Parameters}.
3912 @node Topic Variables
3913 @subsection Topic Variables
3914 @cindex topic variables
3916 The previous section told you how to tell Gnus which topics to display.
3917 This section explains how to tell Gnus what to display about each topic.
3919 @vindex gnus-topic-line-format
3920 The topic lines themselves are created according to the
3921 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3934 Number of groups in the topic.
3936 Number of unread articles in the topic.
3938 Number of unread articles in the topic and all its subtopics.
3941 @vindex gnus-topic-indent-level
3942 Each sub-topic (and the groups in the sub-topics) will be indented with
3943 @code{gnus-topic-indent-level} times the topic level number of spaces.
3946 @vindex gnus-topic-mode-hook
3947 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3949 @vindex gnus-topic-display-empty-topics
3950 The @code{gnus-topic-display-empty-topics} says whether to display even
3951 topics that have no unread articles in them. The default is @code{t}.
3955 @subsection Topic Sorting
3956 @cindex topic sorting
3958 You can sort the groups in each topic individually with the following
3964 @kindex T S a (Topic)
3965 @findex gnus-topic-sort-groups-by-alphabet
3966 Sort the current topic alphabetically by group name
3967 (@code{gnus-topic-sort-groups-by-alphabet}).
3970 @kindex T S u (Topic)
3971 @findex gnus-topic-sort-groups-by-unread
3972 Sort the current topic by the number of unread articles
3973 (@code{gnus-topic-sort-groups-by-unread}).
3976 @kindex T S l (Topic)
3977 @findex gnus-topic-sort-groups-by-level
3978 Sort the current topic by group level
3979 (@code{gnus-topic-sort-groups-by-level}).
3982 @kindex T S v (Topic)
3983 @findex gnus-topic-sort-groups-by-score
3984 Sort the current topic by group score
3985 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3988 @kindex T S r (Topic)
3989 @findex gnus-topic-sort-groups-by-rank
3990 Sort the current topic by group rank
3991 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3994 @kindex T S m (Topic)
3995 @findex gnus-topic-sort-groups-by-method
3996 Sort the current topic alphabetically by back end name
3997 (@code{gnus-topic-sort-groups-by-method}).
4000 @kindex T S e (Topic)
4001 @findex gnus-topic-sort-groups-by-server
4002 Sort the current topic alphabetically by server name
4003 (@code{gnus-topic-sort-groups-by-server}).
4006 @kindex T S s (Topic)
4007 @findex gnus-topic-sort-groups
4008 Sort the current topic according to the function(s) given by the
4009 @code{gnus-group-sort-function} variable
4010 (@code{gnus-topic-sort-groups}).
4014 When given a prefix argument, all these commands will sort in reverse
4015 order. @xref{Sorting Groups}, for more information about group
4019 @node Topic Topology
4020 @subsection Topic Topology
4021 @cindex topic topology
4024 So, let's have a look at an example group buffer:
4031 2: alt.religion.emacs
4034 0: comp.talk.emacs.recovery
4036 8: comp.binaries.fractals
4037 13: comp.sources.unix
4041 So, here we have one top-level topic (@samp{Gnus}), two topics under
4042 that, and one sub-topic under one of the sub-topics. (There is always
4043 just one (1) top-level topic). This topology can be expressed as
4048 (("Emacs -- I wuw it!" visible)
4049 (("Naughty Emacs" visible)))
4053 @vindex gnus-topic-topology
4054 This is in fact how the variable @code{gnus-topic-topology} would look
4055 for the display above. That variable is saved in the @file{.newsrc.eld}
4056 file, and shouldn't be messed with manually---unless you really want
4057 to. Since this variable is read from the @file{.newsrc.eld} file,
4058 setting it in any other startup files will have no effect.
4060 This topology shows what topics are sub-topics of what topics (right),
4061 and which topics are visible. Two settings are currently
4062 allowed---@code{visible} and @code{invisible}.
4065 @node Topic Parameters
4066 @subsection Topic Parameters
4067 @cindex topic parameters
4069 All groups in a topic will inherit group parameters from the parent
4070 (and ancestor) topic parameters. All valid group parameters are valid
4071 topic parameters (@pxref{Group Parameters}). When the agent is
4072 enabled, all agent parameters (See Agent Parameters in @ref{Category
4073 Syntax}) are also valid topic parameters.
4075 In addition, the following parameters are only valid as topic
4080 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4081 @code{subscribe} topic parameter says what groups go in what topic. Its
4082 value should be a regexp to match the groups that should go in that
4085 @item subscribe-level
4086 When subscribing new groups by topic (see the @code{subscribe} parameter),
4087 the group will be subscribed with the level specified in the
4088 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4092 Group parameters (of course) override topic parameters, and topic
4093 parameters in sub-topics override topic parameters in super-topics. You
4094 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4095 verb, although you may feel free to disagree with me here.)
4102 2: alt.religion.emacs
4106 0: comp.talk.emacs.recovery
4108 8: comp.binaries.fractals
4109 13: comp.sources.unix
4114 The @samp{Emacs} topic has the topic parameter @code{(score-file
4115 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4116 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4117 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4118 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4119 . "religion.SCORE")}.
4121 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4122 will get the @file{relief.SCORE} home score file. If you enter the same
4123 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4124 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4125 get the @file{religion.SCORE} home score file.
4127 This seems rather simple and self-evident, doesn't it? Well, yes. But
4128 there are some problems, especially with the @code{total-expiry}
4129 parameter. Say you have a mail group in two topics; one with
4130 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4131 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4132 of these topics you mean to expire articles from, so anything may
4133 happen. In fact, I hereby declare that it is @dfn{undefined} what
4134 happens. You just have to be careful if you do stuff like that.
4137 @node Misc Group Stuff
4138 @section Misc Group Stuff
4141 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4142 * Group Information:: Information and help on groups and Gnus.
4143 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4144 * File Commands:: Reading and writing the Gnus files.
4145 * Sieve Commands:: Managing Sieve scripts.
4152 @cindex keys, reserved for users (Group)
4153 The key @kbd{v} is reserved for users. You can bind it key to some
4154 function or better use it as a prefix key. For example:
4157 (define-key gnus-group-mode-map (kbd "v j d")
4160 (gnus-group-jump-to-group "nndraft:drafts")))
4163 On keys reserved for users in Emacs and on keybindings in general
4164 @xref{Keymaps, Keymaps, , emacs, The Emacs Editor}.
4168 @findex gnus-group-enter-server-mode
4169 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4170 @xref{Server Buffer}.
4174 @findex gnus-group-post-news
4175 Start composing a message (a news by default)
4176 (@code{gnus-group-post-news}). If given a prefix, post to the group
4177 under the point. If the prefix is 1, prompt for a group to post to.
4178 Contrary to what the name of this function suggests, the prepared
4179 article might be a mail instead of a news, if a mail group is specified
4180 with the prefix argument. @xref{Composing Messages}.
4184 @findex gnus-group-mail
4185 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4186 use the posting style of the group under the point. If the prefix is 1,
4187 prompt for a group name to find the posting style.
4188 @xref{Composing Messages}.
4192 @findex gnus-group-news
4193 Start composing a news (@code{gnus-group-news}). If given a prefix,
4194 post to the group under the point. If the prefix is 1, prompt
4195 for group to post to. @xref{Composing Messages}.
4197 This function actually prepares a news even when using mail groups.
4198 This is useful for ``posting'' messages to mail groups without actually
4199 sending them over the network: they're just saved directly to the group
4200 in question. The corresponding back end must have a request-post method
4201 for this to work though.
4205 @findex gnus-group-compact-group
4207 Compact the group under point (@code{gnus-group-compact-group}).
4208 Currently implemented only in nnml (@pxref{Mail Spool}). This removes
4209 gaps between article numbers, hence getting a correct total article
4214 Variables for the group buffer:
4218 @item gnus-group-mode-hook
4219 @vindex gnus-group-mode-hook
4220 is called after the group buffer has been
4223 @item gnus-group-prepare-hook
4224 @vindex gnus-group-prepare-hook
4225 is called after the group buffer is
4226 generated. It may be used to modify the buffer in some strange,
4229 @item gnus-group-prepared-hook
4230 @vindex gnus-group-prepare-hook
4231 is called as the very last thing after the group buffer has been
4232 generated. It may be used to move point around, for instance.
4234 @item gnus-permanently-visible-groups
4235 @vindex gnus-permanently-visible-groups
4236 Groups matching this regexp will always be listed in the group buffer,
4237 whether they are empty or not.
4239 @item gnus-group-name-charset-method-alist
4240 @vindex gnus-group-name-charset-method-alist
4241 An alist of method and the charset for group names. It is used to show
4242 non-@acronym{ASCII} group names.
4246 (setq gnus-group-name-charset-method-alist
4247 '(((nntp "news.com.cn") . cn-gb-2312)))
4250 @item gnus-group-name-charset-group-alist
4251 @cindex UTF-8 group names
4252 @vindex gnus-group-name-charset-group-alist
4253 An alist of regexp of group name and the charset for group names. It
4254 is used to show non-@acronym{ASCII} group names. @code{((".*"
4255 utf-8))} is the default value if UTF-8 is supported, otherwise the
4256 default is @code{nil}.
4260 (setq gnus-group-name-charset-group-alist
4261 '(("\\.com\\.cn:" . cn-gb-2312)))
4266 @node Scanning New Messages
4267 @subsection Scanning New Messages
4268 @cindex new messages
4269 @cindex scanning new news
4275 @findex gnus-group-get-new-news
4276 @c @icon{gnus-group-get-new-news}
4277 Check the server(s) for new articles. If the numerical prefix is used,
4278 this command will check only groups of level @var{arg} and lower
4279 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4280 command will force a total re-reading of the active file(s) from the
4285 @findex gnus-group-get-new-news-this-group
4286 @vindex gnus-goto-next-group-when-activating
4287 @c @icon{gnus-group-get-new-news-this-group}
4288 Check whether new articles have arrived in the current group
4289 (@code{gnus-group-get-new-news-this-group}).
4290 @code{gnus-goto-next-group-when-activating} says whether this command is
4291 to move point to the next group or not. It is @code{t} by default.
4293 @findex gnus-activate-all-groups
4294 @cindex activating groups
4296 @kindex C-c M-g (Group)
4297 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4302 @findex gnus-group-restart
4303 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4304 file(s), closes the connection to all servers, clears up all run-time
4305 Gnus variables, and then starts Gnus all over again.
4309 @vindex gnus-get-new-news-hook
4310 @code{gnus-get-new-news-hook} is run just before checking for new news.
4312 @vindex gnus-after-getting-new-news-hook
4313 @code{gnus-after-getting-new-news-hook} is run after checking for new
4317 @node Group Information
4318 @subsection Group Information
4319 @cindex group information
4320 @cindex information on groups
4327 @findex gnus-group-fetch-faq
4328 @vindex gnus-group-faq-directory
4331 Try to fetch the @acronym{FAQ} for the current group
4332 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4333 from @code{gnus-group-faq-directory}, which is usually a directory on
4334 a remote machine. This variable can also be a list of directories.
4335 In that case, giving a prefix to this command will allow you to choose
4336 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4337 used for fetching the file.
4339 If fetching from the first site is unsuccessful, Gnus will attempt to go
4340 through @code{gnus-group-faq-directory} and try to open them one by one.
4344 @findex gnus-group-fetch-charter
4345 @vindex gnus-group-charter-alist
4347 Try to open the charter for the current group in a web browser
4348 (@code{gnus-group-fetch-charter}). Query for a group if given a
4351 Gnus will use @code{gnus-group-charter-alist} to find the location of
4352 the charter. If no location is known, Gnus will fetch the control
4353 messages for the group, which in some cases includes the charter.
4357 @findex gnus-group-fetch-control
4358 @vindex gnus-group-fetch-control-use-browse-url
4359 @cindex control message
4360 Fetch the control messages for the group from the archive at
4361 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4362 group if given a prefix argument.
4364 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4365 Gnus will open the control messages in a browser using
4366 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4367 and displayed in an ephemeral group.
4369 Note that the control messages are compressed. To use this command
4370 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4371 Files, ,Compressed Files, emacs, The Emacs Manual}).
4375 @c @icon{gnus-group-describe-group}
4377 @kindex C-c C-d (Group)
4378 @cindex describing groups
4379 @cindex group description
4380 @findex gnus-group-describe-group
4381 Describe the current group (@code{gnus-group-describe-group}). If given
4382 a prefix, force Gnus to re-read the description from the server.
4386 @findex gnus-group-describe-all-groups
4387 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4388 prefix, force Gnus to re-read the description file from the server.
4395 @findex gnus-version
4396 Display current Gnus version numbers (@code{gnus-version}).
4400 @findex gnus-group-describe-briefly
4401 Give a very short help message (@code{gnus-group-describe-briefly}).
4404 @kindex C-c C-i (Group)
4407 @findex gnus-info-find-node
4408 Go to the Gnus info node (@code{gnus-info-find-node}).
4412 @node Group Timestamp
4413 @subsection Group Timestamp
4415 @cindex group timestamps
4417 It can be convenient to let Gnus keep track of when you last read a
4418 group. To set the ball rolling, you should add
4419 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4422 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4425 After doing this, each time you enter a group, it'll be recorded.
4427 This information can be displayed in various ways---the easiest is to
4428 use the @samp{%d} spec in the group line format:
4431 (setq gnus-group-line-format
4432 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4435 This will result in lines looking like:
4438 * 0: mail.ding 19961002T012943
4439 0: custom 19961002T012713
4442 As you can see, the date is displayed in compact ISO 8601 format. This
4443 may be a bit too much, so to just display the date, you could say
4447 (setq gnus-group-line-format
4448 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4451 If you would like greater control of the time format, you can use a
4452 user-defined format spec. Something like the following should do the
4456 (setq gnus-group-line-format
4457 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4458 (defun gnus-user-format-function-d (headers)
4459 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4461 (format-time-string "%b %d %H:%M" time)
4467 @subsection File Commands
4468 @cindex file commands
4474 @findex gnus-group-read-init-file
4475 @vindex gnus-init-file
4476 @cindex reading init file
4477 Re-read the init file (@code{gnus-init-file}, which defaults to
4478 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4482 @findex gnus-group-save-newsrc
4483 @cindex saving .newsrc
4484 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4485 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4486 file(s) whether Gnus thinks it is necessary or not.
4489 @c @kindex Z (Group)
4490 @c @findex gnus-group-clear-dribble
4491 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4496 @node Sieve Commands
4497 @subsection Sieve Commands
4498 @cindex group sieve commands
4500 Sieve is a server-side mail filtering language. In Gnus you can use
4501 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4502 sieve rules that should apply to each group. Gnus provides two
4503 commands to translate all these group parameters into a proper Sieve
4504 script that can be transfered to the server somehow.
4506 @vindex gnus-sieve-file
4507 @vindex gnus-sieve-region-start
4508 @vindex gnus-sieve-region-end
4509 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4510 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4511 between two delimiters, @code{gnus-sieve-region-start} and
4512 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4513 outside these delimiters that will not be removed the next time you
4514 regenerate the Sieve script.
4516 @vindex gnus-sieve-crosspost
4517 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4518 is generated. If it is non-@code{nil} (the default) articles is
4519 placed in all groups that have matching rules, otherwise the article
4520 is only placed in the group with the first matching rule. For
4521 example, the group parameter @samp{(sieve address "sender"
4522 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4523 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4524 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4525 except that the line containing the call to @code{stop} is removed.)
4528 if address "sender" "owner-ding@@hpc.uh.edu" @{
4529 fileinto "INBOX.ding";
4534 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4540 @findex gnus-sieve-generate
4541 @vindex gnus-sieve-file
4542 @cindex generating sieve script
4543 Regenerate a Sieve script from the @code{sieve} group parameters and
4544 put you into the @code{gnus-sieve-file} without saving it.
4548 @findex gnus-sieve-update
4549 @vindex gnus-sieve-file
4550 @cindex updating sieve script
4551 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4552 @code{sieve} group parameters, save the file and upload it to the
4553 server using the @code{sieveshell} program.
4558 @node Summary Buffer
4559 @chapter Summary Buffer
4560 @cindex summary buffer
4562 A line for each article is displayed in the summary buffer. You can
4563 move around, read articles, post articles and reply to articles.
4565 The most common way to a summary buffer is to select a group from the
4566 group buffer (@pxref{Selecting a Group}).
4568 You can have as many summary buffers open as you wish.
4570 You can customize the Summary Mode tool bar, see @kbd{M-x
4571 customize-apropos RET gnus-summary-tool-bar}. This feature is only
4575 @cindex keys, reserved for users (Summary)
4576 The key @kbd{v} is reserved for users. You can bind it key to some
4577 function or better use it as a prefix key. For example:
4579 (define-key gnus-summary-mode-map (kbd "v -") "LrS") ;; lower subthread
4583 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4584 * Summary Maneuvering:: Moving around the summary buffer.
4585 * Choosing Articles:: Reading articles.
4586 * Paging the Article:: Scrolling the current article.
4587 * Reply Followup and Post:: Posting articles.
4588 * Delayed Articles:: Send articles at a later time.
4589 * Marking Articles:: Marking articles as read, expirable, etc.
4590 * Limiting:: You can limit the summary buffer.
4591 * Threading:: How threads are made.
4592 * Sorting the Summary Buffer:: How articles and threads are sorted.
4593 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4594 * Article Caching:: You may store articles in a cache.
4595 * Persistent Articles:: Making articles expiry-resistant.
4596 * Article Backlog:: Having already read articles hang around.
4597 * Saving Articles:: Ways of customizing article saving.
4598 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4599 * Article Treatment:: The article buffer can be mangled at will.
4600 * MIME Commands:: Doing MIMEy things with the articles.
4601 * Charsets:: Character set issues.
4602 * Article Commands:: Doing various things with the article buffer.
4603 * Summary Sorting:: Sorting the summary buffer in various ways.
4604 * Finding the Parent:: No child support? Get the parent.
4605 * Alternative Approaches:: Reading using non-default summaries.
4606 * Tree Display:: A more visual display of threads.
4607 * Mail Group Commands:: Some commands can only be used in mail groups.
4608 * Various Summary Stuff:: What didn't fit anywhere else.
4609 * Exiting the Summary Buffer:: Returning to the Group buffer,
4610 or reselecting the current group.
4611 * Crosspost Handling:: How crossposted articles are dealt with.
4612 * Duplicate Suppression:: An alternative when crosspost handling fails.
4613 * Security:: Decrypt and Verify.
4614 * Mailing List:: Mailing list minor mode.
4618 @node Summary Buffer Format
4619 @section Summary Buffer Format
4620 @cindex summary buffer format
4624 \gnusfigure{The Summary Buffer}{180}{
4625 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4626 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4632 * Summary Buffer Lines:: You can specify how summary lines should look.
4633 * To From Newsgroups:: How to not display your own name.
4634 * Summary Buffer Mode Line:: You can say how the mode line should look.
4635 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4638 @findex mail-extract-address-components
4639 @findex gnus-extract-address-components
4640 @vindex gnus-extract-address-components
4641 Gnus will use the value of the @code{gnus-extract-address-components}
4642 variable as a function for getting the name and address parts of a
4643 @code{From} header. Two pre-defined functions exist:
4644 @code{gnus-extract-address-components}, which is the default, quite
4645 fast, and too simplistic solution; and
4646 @code{mail-extract-address-components}, which works very nicely, but is
4647 slower. The default function will return the wrong answer in 5% of the
4648 cases. If this is unacceptable to you, use the other function instead:
4651 (setq gnus-extract-address-components
4652 'mail-extract-address-components)
4655 @vindex gnus-summary-same-subject
4656 @code{gnus-summary-same-subject} is a string indicating that the current
4657 article has the same subject as the previous. This string will be used
4658 with those specs that require it. The default is @code{""}.
4661 @node Summary Buffer Lines
4662 @subsection Summary Buffer Lines
4664 @vindex gnus-summary-line-format
4665 You can change the format of the lines in the summary buffer by changing
4666 the @code{gnus-summary-line-format} variable. It works along the same
4667 lines as a normal @code{format} string, with some extensions
4668 (@pxref{Formatting Variables}).
4670 There should always be a colon or a point position marker on the line;
4671 the cursor always moves to the point position marker or the colon after
4672 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4673 possible to change this. Just write a new function
4674 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4675 @xref{Positioning Point}.
4677 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4679 The following format specification characters and extended format
4680 specification(s) are understood:
4686 Subject string. List identifiers stripped,
4687 @code{gnus-list-identifiers}. @xref{Article Hiding}.
4689 Subject if the article is the root of the thread or the previous article
4690 had a different subject, @code{gnus-summary-same-subject} otherwise.
4691 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4693 Full @code{From} header.
4695 The name (from the @code{From} header).
4697 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4700 The name (from the @code{From} header). This differs from the @code{n}
4701 spec in that it uses the function designated by the
4702 @code{gnus-extract-address-components} variable, which is slower, but
4703 may be more thorough.
4705 The address (from the @code{From} header). This works the same way as
4708 Number of lines in the article.
4710 Number of characters in the article. This specifier is not supported
4711 in some methods (like nnfolder).
4713 Pretty-printed version of the number of characters in the article;
4714 for example, @samp{1.2k} or @samp{0.4M}.
4716 Indentation based on thread level (@pxref{Customizing Threading}).
4718 A complex trn-style thread tree, showing response-connecting trace
4719 lines. A thread could be drawn like this:
4732 You can customize the appearance with the following options. Note
4733 that it is possible to make the thread display look really neat by
4734 replacing the default @acronym{ASCII} characters with graphic
4735 line-drawing glyphs.
4737 @item gnus-sum-thread-tree-root
4738 @vindex gnus-sum-thread-tree-root
4739 Used for the root of a thread. If @code{nil}, use subject
4740 instead. The default is @samp{> }.
4742 @item gnus-sum-thread-tree-false-root
4743 @vindex gnus-sum-thread-tree-false-root
4744 Used for the false root of a thread (@pxref{Loose Threads}). If
4745 @code{nil}, use subject instead. The default is @samp{> }.
4747 @item gnus-sum-thread-tree-single-indent
4748 @vindex gnus-sum-thread-tree-single-indent
4749 Used for a thread with just one message. If @code{nil}, use subject
4750 instead. The default is @samp{}.
4752 @item gnus-sum-thread-tree-vertical
4753 @vindex gnus-sum-thread-tree-vertical
4754 Used for drawing a vertical line. The default is @samp{| }.
4756 @item gnus-sum-thread-tree-indent
4757 @vindex gnus-sum-thread-tree-indent
4758 Used for indenting. The default is @samp{ }.
4760 @item gnus-sum-thread-tree-leaf-with-other
4761 @vindex gnus-sum-thread-tree-leaf-with-other
4762 Used for a leaf with brothers. The default is @samp{+-> }.
4764 @item gnus-sum-thread-tree-single-leaf
4765 @vindex gnus-sum-thread-tree-single-leaf
4766 Used for a leaf without brothers. The default is @samp{\-> }
4771 Nothing if the article is a root and lots of spaces if it isn't (it
4772 pushes everything after it off the screen).
4774 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4775 for adopted articles (@pxref{Customizing Threading}).
4777 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4778 for adopted articles.
4780 One space for each thread level.
4782 Twenty minus thread level spaces.
4784 Unread. @xref{Read Articles}.
4787 This misleadingly named specifier is the @dfn{secondary mark}. This
4788 mark will say whether the article has been replied to, has been cached,
4789 or has been saved. @xref{Other Marks}.
4792 Score as a number (@pxref{Scoring}).
4794 @vindex gnus-summary-zcore-fuzz
4795 Zcore, @samp{+} if above the default level and @samp{-} if below the
4796 default level. If the difference between
4797 @code{gnus-summary-default-score} and the score is less than
4798 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4806 The @code{Date} in @code{DD-MMM} format.
4808 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4814 Number of articles in the current sub-thread. Using this spec will slow
4815 down summary buffer generation somewhat.
4817 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4818 article has any children.
4824 Desired cursor position (instead of after first colon).
4826 Age sensitive date format. Various date format is defined in
4827 @code{gnus-user-date-format-alist}.
4829 User defined specifier. The next character in the format string should
4830 be a letter. Gnus will call the function
4831 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4832 following @samp{%u}. The function will be passed the current header as
4833 argument. The function should return a string, which will be inserted
4834 into the summary just like information from any other summary specifier.
4837 Text between @samp{%(} and @samp{%)} will be highlighted with
4838 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4839 There can only be one such area.
4841 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4842 have to be handled with care. For reasons of efficiency, Gnus will
4843 compute what column these characters will end up in, and ``hard-code''
4844 that. This means that it is invalid to have these specs after a
4845 variable-length spec. Well, you might not be arrested, but your summary
4846 buffer will look strange, which is bad enough.
4848 The smart choice is to have these specs as far to the left as possible.
4849 (Isn't that the case with everything, though? But I digress.)
4851 This restriction may disappear in later versions of Gnus.
4854 @node To From Newsgroups
4855 @subsection To From Newsgroups
4859 In some groups (particularly in archive groups), the @code{From} header
4860 isn't very interesting, since all the articles there are written by
4861 you. To display the information in the @code{To} or @code{Newsgroups}
4862 headers instead, you need to decide three things: What information to
4863 gather; where to display it; and when to display it.
4867 @vindex gnus-extra-headers
4868 The reading of extra header information is controlled by the
4869 @code{gnus-extra-headers}. This is a list of header symbols. For
4873 (setq gnus-extra-headers
4874 '(To Newsgroups X-Newsreader))
4877 This will result in Gnus trying to obtain these three headers, and
4878 storing it in header structures for later easy retrieval.
4881 @findex gnus-extra-header
4882 The value of these extra headers can be accessed via the
4883 @code{gnus-extra-header} function. Here's a format line spec that will
4884 access the @code{X-Newsreader} header:
4887 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4891 @vindex gnus-ignored-from-addresses
4892 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4893 summary line spec returns the @code{To}, @code{Newsreader} or
4894 @code{From} header. If this regexp matches the contents of the
4895 @code{From} header, the value of the @code{To} or @code{Newsreader}
4896 headers are used instead.
4898 To distinguish regular articles from those where the @code{From} field
4899 has been swapped, a string is prefixed to the @code{To} or
4900 @code{Newsgroups} header in the summary line. By default the string is
4901 @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can
4902 customize these strings with @code{gnus-summary-to-prefix} and
4903 @code{gnus-summary-newsgroup-prefix}.
4907 @vindex nnmail-extra-headers
4908 A related variable is @code{nnmail-extra-headers}, which controls when
4909 to include extra headers when generating overview (@acronym{NOV}) files.
4910 If you have old overview files, you should regenerate them after
4911 changing this variable, by entering the server buffer using @kbd{^},
4912 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
4915 @vindex gnus-summary-line-format
4916 You also have to instruct Gnus to display the data by changing the
4917 @code{%n} spec to the @code{%f} spec in the
4918 @code{gnus-summary-line-format} variable.
4920 In summary, you'd typically put something like the following in
4924 (setq gnus-extra-headers
4926 (setq nnmail-extra-headers gnus-extra-headers)
4927 (setq gnus-summary-line-format
4928 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4929 (setq gnus-ignored-from-addresses
4933 (The values listed above are the default values in Gnus. Alter them
4936 A note for news server administrators, or for users who wish to try to
4937 convince their news server administrator to provide some additional
4940 The above is mostly useful for mail groups, where you have control over
4941 the @acronym{NOV} files that are created. However, if you can persuade your
4942 nntp admin to add (in the usual implementation, notably INN):
4948 to the end of her @file{overview.fmt} file, then you can use that just
4949 as you would the extra headers from the mail groups.
4952 @node Summary Buffer Mode Line
4953 @subsection Summary Buffer Mode Line
4955 @vindex gnus-summary-mode-line-format
4956 You can also change the format of the summary mode bar (@pxref{Mode Line
4957 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4958 like. The default is @samp{Gnus: %%b [%A] %Z}.
4960 Here are the elements you can play with:
4966 Unprefixed group name.
4968 Current article number.
4970 Current article score.
4974 Number of unread articles in this group.
4976 Number of unread articles in this group that aren't displayed in the
4979 A string with the number of unread and unselected articles represented
4980 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4981 articles, and just as @samp{<%U more>} if there are just unread articles
4982 and no unselected ones.
4984 Shortish group name. For instance, @samp{rec.arts.anime} will be
4985 shortened to @samp{r.a.anime}.
4987 Subject of the current article.
4989 User-defined spec (@pxref{User-Defined Specs}).
4991 Name of the current score file (@pxref{Scoring}).
4993 Number of dormant articles (@pxref{Unread Articles}).
4995 Number of ticked articles (@pxref{Unread Articles}).
4997 Number of articles that have been marked as read in this session.
4999 Number of articles expunged by the score files.
5003 @node Summary Highlighting
5004 @subsection Summary Highlighting
5008 @item gnus-visual-mark-article-hook
5009 @vindex gnus-visual-mark-article-hook
5010 This hook is run after selecting an article. It is meant to be used for
5011 highlighting the article in some way. It is not run if
5012 @code{gnus-visual} is @code{nil}.
5014 @item gnus-summary-update-hook
5015 @vindex gnus-summary-update-hook
5016 This hook is called when a summary line is changed. It is not run if
5017 @code{gnus-visual} is @code{nil}.
5019 @item gnus-summary-selected-face
5020 @vindex gnus-summary-selected-face
5021 This is the face (or @dfn{font} as some people call it) used to
5022 highlight the current article in the summary buffer.
5024 @item gnus-summary-highlight
5025 @vindex gnus-summary-highlight
5026 Summary lines are highlighted according to this variable, which is a
5027 list where the elements are of the format @code{(@var{form}
5028 . @var{face})}. If you would, for instance, like ticked articles to be
5029 italic and high-scored articles to be bold, you could set this variable
5032 (((eq mark gnus-ticked-mark) . italic)
5033 ((> score default) . bold))
5035 As you may have guessed, if @var{form} returns a non-@code{nil} value,
5036 @var{face} will be applied to the line.
5040 @node Summary Maneuvering
5041 @section Summary Maneuvering
5042 @cindex summary movement
5044 All the straight movement commands understand the numeric prefix and
5045 behave pretty much as you'd expect.
5047 None of these commands select articles.
5052 @kindex M-n (Summary)
5053 @kindex G M-n (Summary)
5054 @findex gnus-summary-next-unread-subject
5055 Go to the next summary line of an unread article
5056 (@code{gnus-summary-next-unread-subject}).
5060 @kindex M-p (Summary)
5061 @kindex G M-p (Summary)
5062 @findex gnus-summary-prev-unread-subject
5063 Go to the previous summary line of an unread article
5064 (@code{gnus-summary-prev-unread-subject}).
5067 @kindex G g (Summary)
5068 @findex gnus-summary-goto-subject
5069 Ask for an article number and then go to the summary line of that article
5070 without displaying the article (@code{gnus-summary-goto-subject}).
5073 If Gnus asks you to press a key to confirm going to the next group, you
5074 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
5075 buffer, searching for the next group to read without actually returning
5076 to the group buffer.
5078 Variables related to summary movement:
5082 @vindex gnus-auto-select-next
5083 @item gnus-auto-select-next
5084 If you issue one of the movement commands (like @kbd{n}) and there are
5085 no more unread articles after the current one, Gnus will offer to go to
5086 the next group. If this variable is @code{t} and the next group is
5087 empty, Gnus will exit summary mode and return to the group buffer. If
5088 this variable is neither @code{t} nor @code{nil}, Gnus will select the
5089 next group with unread articles. As a special case, if this variable
5090 is @code{quietly}, Gnus will select the next group without asking for
5091 confirmation. If this variable is @code{almost-quietly}, the same
5092 will happen only if you are located on the last article in the group.
5093 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
5094 command will go to the next group without confirmation. Also
5095 @pxref{Group Levels}.
5097 @item gnus-auto-select-same
5098 @vindex gnus-auto-select-same
5099 If non-@code{nil}, all the movement commands will try to go to the next
5100 article with the same subject as the current. (@dfn{Same} here might
5101 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
5102 for details (@pxref{Customizing Threading}).) If there are no more
5103 articles with the same subject, go to the first unread article.
5105 This variable is not particularly useful if you use a threaded display.
5107 @item gnus-summary-check-current
5108 @vindex gnus-summary-check-current
5109 If non-@code{nil}, all the ``unread'' movement commands will not proceed
5110 to the next (or previous) article if the current article is unread.
5111 Instead, they will choose the current article.
5113 @item gnus-auto-center-summary
5114 @vindex gnus-auto-center-summary
5115 If non-@code{nil}, Gnus will keep the point in the summary buffer
5116 centered at all times. This makes things quite tidy, but if you have a
5117 slow network connection, or simply do not like this un-Emacsism, you can
5118 set this variable to @code{nil} to get the normal Emacs scrolling
5119 action. This will also inhibit horizontal re-centering of the summary
5120 buffer, which might make it more inconvenient to read extremely long
5123 This variable can also be a number. In that case, center the window at
5124 the given number of lines from the top.
5129 @node Choosing Articles
5130 @section Choosing Articles
5131 @cindex selecting articles
5134 * Choosing Commands:: Commands for choosing articles.
5135 * Choosing Variables:: Variables that influence these commands.
5139 @node Choosing Commands
5140 @subsection Choosing Commands
5142 None of the following movement commands understand the numeric prefix,
5143 and they all select and display an article.
5145 If you want to fetch new articles or redisplay the group, see
5146 @ref{Exiting the Summary Buffer}.
5150 @kindex SPACE (Summary)
5151 @findex gnus-summary-next-page
5152 Select the current article, or, if that one's read already, the next
5153 unread article (@code{gnus-summary-next-page}).
5155 If you have an article window open already and you press @kbd{SPACE}
5156 again, the article will be scrolled. This lets you conveniently
5157 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5162 @kindex G n (Summary)
5163 @findex gnus-summary-next-unread-article
5164 @c @icon{gnus-summary-next-unread}
5165 Go to next unread article (@code{gnus-summary-next-unread-article}).
5170 @findex gnus-summary-prev-unread-article
5171 @c @icon{gnus-summary-prev-unread}
5172 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5177 @kindex G N (Summary)
5178 @findex gnus-summary-next-article
5179 Go to the next article (@code{gnus-summary-next-article}).
5184 @kindex G P (Summary)
5185 @findex gnus-summary-prev-article
5186 Go to the previous article (@code{gnus-summary-prev-article}).
5189 @kindex G C-n (Summary)
5190 @findex gnus-summary-next-same-subject
5191 Go to the next article with the same subject
5192 (@code{gnus-summary-next-same-subject}).
5195 @kindex G C-p (Summary)
5196 @findex gnus-summary-prev-same-subject
5197 Go to the previous article with the same subject
5198 (@code{gnus-summary-prev-same-subject}).
5202 @kindex G f (Summary)
5204 @findex gnus-summary-first-unread-article
5205 Go to the first unread article
5206 (@code{gnus-summary-first-unread-article}).
5210 @kindex G b (Summary)
5212 @findex gnus-summary-best-unread-article
5213 Go to the unread article with the highest score
5214 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5215 go to the first unread article that has a score over the default score.
5220 @kindex G l (Summary)
5221 @findex gnus-summary-goto-last-article
5222 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5225 @kindex G o (Summary)
5226 @findex gnus-summary-pop-article
5228 @cindex article history
5229 Pop an article off the summary history and go to this article
5230 (@code{gnus-summary-pop-article}). This command differs from the
5231 command above in that you can pop as many previous articles off the
5232 history as you like, while @kbd{l} toggles the two last read articles.
5233 For a somewhat related issue (if you use these commands a lot),
5234 @pxref{Article Backlog}.
5239 @kindex G j (Summary)
5240 @findex gnus-summary-goto-article
5241 Ask for an article number or @code{Message-ID}, and then go to that
5242 article (@code{gnus-summary-goto-article}).
5247 @node Choosing Variables
5248 @subsection Choosing Variables
5250 Some variables relevant for moving and selecting articles:
5253 @item gnus-auto-extend-newsgroup
5254 @vindex gnus-auto-extend-newsgroup
5255 All the movement commands will try to go to the previous (or next)
5256 article, even if that article isn't displayed in the Summary buffer if
5257 this variable is non-@code{nil}. Gnus will then fetch the article from
5258 the server and display it in the article buffer.
5260 @item gnus-select-article-hook
5261 @vindex gnus-select-article-hook
5262 This hook is called whenever an article is selected. The default is
5263 @code{nil}. If you would like each article to be saved in the Agent as
5264 you read it, putting @code{gnus-agent-fetch-selected-article} on this
5267 @item gnus-mark-article-hook
5268 @vindex gnus-mark-article-hook
5269 @findex gnus-summary-mark-unread-as-read
5270 @findex gnus-summary-mark-read-and-unread-as-read
5271 @findex gnus-unread-mark
5272 This hook is called whenever an article is selected. It is intended to
5273 be used for marking articles as read. The default value is
5274 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5275 mark of almost any article you read to @code{gnus-read-mark}. The only
5276 articles not affected by this function are ticked, dormant, and
5277 expirable articles. If you'd instead like to just have unread articles
5278 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5279 instead. It will leave marks like @code{gnus-low-score-mark},
5280 @code{gnus-del-mark} (and so on) alone.
5285 @node Paging the Article
5286 @section Scrolling the Article
5287 @cindex article scrolling
5292 @kindex SPACE (Summary)
5293 @findex gnus-summary-next-page
5294 Pressing @kbd{SPACE} will scroll the current article forward one page,
5295 or, if you have come to the end of the current article, will choose the
5296 next article (@code{gnus-summary-next-page}).
5298 @vindex gnus-article-boring-faces
5299 @vindex gnus-article-skip-boring
5300 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5301 the article consists only of citations and signature, then it will be
5302 skipped; the next article will be shown instead. You can customize
5303 what is considered uninteresting with
5304 @code{gnus-article-boring-faces}. You can manually view the article's
5305 pages, no matter how boring, using @kbd{C-M-v}.
5308 @kindex DEL (Summary)
5309 @findex gnus-summary-prev-page
5310 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5313 @kindex RET (Summary)
5314 @findex gnus-summary-scroll-up
5315 Scroll the current article one line forward
5316 (@code{gnus-summary-scroll-up}).
5319 @kindex M-RET (Summary)
5320 @findex gnus-summary-scroll-down
5321 Scroll the current article one line backward
5322 (@code{gnus-summary-scroll-down}).
5326 @kindex A g (Summary)
5328 @findex gnus-summary-show-article
5329 @vindex gnus-summary-show-article-charset-alist
5330 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5331 given a prefix, fetch the current article, but don't run any of the
5332 article treatment functions. This will give you a ``raw'' article, just
5333 the way it came from the server.
5335 If given a numerical prefix, you can do semi-manual charset stuff.
5336 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5337 encoded in the @code{cn-gb-2312} charset. If you have
5340 (setq gnus-summary-show-article-charset-alist
5345 then you can say @kbd{C-u 1 g} to get the same effect.
5350 @kindex A < (Summary)
5351 @findex gnus-summary-beginning-of-article
5352 Scroll to the beginning of the article
5353 (@code{gnus-summary-beginning-of-article}).
5358 @kindex A > (Summary)
5359 @findex gnus-summary-end-of-article
5360 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5364 @kindex A s (Summary)
5366 @findex gnus-summary-isearch-article
5367 Perform an isearch in the article buffer
5368 (@code{gnus-summary-isearch-article}).
5372 @findex gnus-summary-select-article-buffer
5373 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5378 @node Reply Followup and Post
5379 @section Reply, Followup and Post
5382 * Summary Mail Commands:: Sending mail.
5383 * Summary Post Commands:: Sending news.
5384 * Summary Message Commands:: Other Message-related commands.
5385 * Canceling and Superseding::
5389 @node Summary Mail Commands
5390 @subsection Summary Mail Commands
5392 @cindex composing mail
5394 Commands for composing a mail message:
5400 @kindex S r (Summary)
5402 @findex gnus-summary-reply
5403 @c @icon{gnus-summary-mail-reply}
5404 @c @icon{gnus-summary-reply}
5405 Mail a reply to the author of the current article
5406 (@code{gnus-summary-reply}).
5411 @kindex S R (Summary)
5412 @findex gnus-summary-reply-with-original
5413 @c @icon{gnus-summary-reply-with-original}
5414 Mail a reply to the author of the current article and include the
5415 original message (@code{gnus-summary-reply-with-original}). This
5416 command uses the process/prefix convention.
5419 @kindex S w (Summary)
5420 @findex gnus-summary-wide-reply
5421 Mail a wide reply to the author of the current article
5422 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5423 goes out to all people listed in the @code{To}, @code{From} (or
5424 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5425 present, that's used instead.
5428 @kindex S W (Summary)
5429 @findex gnus-summary-wide-reply-with-original
5430 Mail a wide reply to the current article and include the original
5431 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5432 the process/prefix convention.
5435 @kindex S v (Summary)
5436 @findex gnus-summary-very-wide-reply
5437 Mail a very wide reply to the author of the current article
5438 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5439 that goes out to all people listed in the @code{To}, @code{From} (or
5440 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5441 articles. This command uses the process/prefix convention.
5444 @kindex S V (Summary)
5445 @findex gnus-summary-very-wide-reply-with-original
5446 Mail a very wide reply to the author of the current article and include the
5447 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5448 command uses the process/prefix convention.
5451 @kindex S B r (Summary)
5452 @findex gnus-summary-reply-broken-reply-to
5453 Mail a reply to the author of the current article but ignore the
5454 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5455 If you need this because a mailing list incorrectly sets a
5456 @code{Reply-To} header pointing to the list, you probably want to set
5457 the @code{broken-reply-to} group parameter instead, so things will work
5458 correctly. @xref{Group Parameters}.
5461 @kindex S B R (Summary)
5462 @findex gnus-summary-reply-broken-reply-to-with-original
5463 Mail a reply to the author of the current article and include the
5464 original message but ignore the @code{Reply-To} field
5465 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5469 @kindex S o m (Summary)
5470 @kindex C-c C-f (Summary)
5471 @findex gnus-summary-mail-forward
5472 @c @icon{gnus-summary-mail-forward}
5473 Forward the current article to some other person
5474 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
5475 is forwarded according to the value of (@code{message-forward-as-mime})
5476 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
5477 message and forward directly inline; if the prefix is 2, forward message
5478 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5479 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5480 directly inline; otherwise, the message is forwarded as no prefix given
5481 but use the flipped value of (@code{message-forward-as-mime}). By
5482 default, the message is decoded and forwarded as an rfc822 @acronym{MIME}
5488 @kindex S m (Summary)
5489 @findex gnus-summary-mail-other-window
5490 @c @icon{gnus-summary-mail-originate}
5491 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5492 the posting style of the current group. If given a prefix, disable that.
5493 If the prefix is 1, prompt for a group name to find the posting style.
5498 @kindex S i (Summary)
5499 @findex gnus-summary-news-other-window
5500 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5501 post to the current group. If given a prefix, disable that. If the
5502 prefix is 1, prompt for a group to post to.
5504 This function actually prepares a news even when using mail groups.
5505 This is useful for ``posting'' messages to mail groups without actually
5506 sending them over the network: they're just saved directly to the group
5507 in question. The corresponding back end must have a request-post method
5508 for this to work though.
5511 @kindex S D b (Summary)
5512 @findex gnus-summary-resend-bounced-mail
5513 @cindex bouncing mail
5514 If you have sent a mail, but the mail was bounced back to you for some
5515 reason (wrong address, transient failure), you can use this command to
5516 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5517 will be popped into a mail buffer where you can edit the headers before
5518 sending the mail off again. If you give a prefix to this command, and
5519 the bounced mail is a reply to some other mail, Gnus will try to fetch
5520 that mail and display it for easy perusal of its headers. This might
5521 very well fail, though.
5524 @kindex S D r (Summary)
5525 @findex gnus-summary-resend-message
5526 Not to be confused with the previous command,
5527 @code{gnus-summary-resend-message} will prompt you for an address to
5528 send the current message off to, and then send it to that place. The
5529 headers of the message won't be altered---but lots of headers that say
5530 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5531 means that you actually send a mail to someone that has a @code{To}
5532 header that (probably) points to yourself. This will confuse people.
5533 So, natcherly you'll only do that if you're really eVIl.
5535 This command is mainly used if you have several accounts and want to
5536 ship a mail to a different account of yours. (If you're both
5537 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5538 to the @code{root} account, you may want to resend it to
5539 @code{postmaster}. Ordnung muss sein!
5541 This command understands the process/prefix convention
5542 (@pxref{Process/Prefix}).
5545 @kindex S D e (Summary)
5546 @findex gnus-summary-resend-message-edit
5548 Like the previous command, but will allow you to edit the message as
5549 if it were a new message before resending.
5552 @kindex S O m (Summary)
5553 @findex gnus-uu-digest-mail-forward
5554 Digest the current series (@pxref{Decoding Articles}) and forward the
5555 result using mail (@code{gnus-uu-digest-mail-forward}). This command
5556 uses the process/prefix convention (@pxref{Process/Prefix}).
5559 @kindex S M-c (Summary)
5560 @findex gnus-summary-mail-crosspost-complaint
5561 @cindex crossposting
5562 @cindex excessive crossposting
5563 Send a complaint about excessive crossposting to the author of the
5564 current article (@code{gnus-summary-mail-crosspost-complaint}).
5566 @findex gnus-crosspost-complaint
5567 This command is provided as a way to fight back against the current
5568 crossposting pandemic that's sweeping Usenet. It will compose a reply
5569 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5570 command understands the process/prefix convention
5571 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5575 Also @xref{Header Commands, ,Header Commands, message, The Message
5576 Manual}, for more information.
5579 @node Summary Post Commands
5580 @subsection Summary Post Commands
5582 @cindex composing news
5584 Commands for posting a news article:
5590 @kindex S p (Summary)
5591 @findex gnus-summary-post-news
5592 @c @icon{gnus-summary-post-news}
5593 Prepare for posting an article (@code{gnus-summary-post-news}). By
5594 default, post to the current group. If given a prefix, disable that.
5595 If the prefix is 1, prompt for another group instead.
5600 @kindex S f (Summary)
5601 @findex gnus-summary-followup
5602 @c @icon{gnus-summary-followup}
5603 Post a followup to the current article (@code{gnus-summary-followup}).
5607 @kindex S F (Summary)
5609 @c @icon{gnus-summary-followup-with-original}
5610 @findex gnus-summary-followup-with-original
5611 Post a followup to the current article and include the original message
5612 (@code{gnus-summary-followup-with-original}). This command uses the
5613 process/prefix convention.
5616 @kindex S n (Summary)
5617 @findex gnus-summary-followup-to-mail
5618 Post a followup to the current article via news, even if you got the
5619 message through mail (@code{gnus-summary-followup-to-mail}).
5622 @kindex S N (Summary)
5623 @findex gnus-summary-followup-to-mail-with-original
5624 Post a followup to the current article via news, even if you got the
5625 message through mail and include the original message
5626 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5627 the process/prefix convention.
5630 @kindex S o p (Summary)
5631 @findex gnus-summary-post-forward
5632 Forward the current article to a newsgroup
5633 (@code{gnus-summary-post-forward}).
5634 If no prefix is given, the message is forwarded according to the value
5635 of (@code{message-forward-as-mime}) and
5636 (@code{message-forward-show-mml}); if the prefix is 1, decode the
5637 message and forward directly inline; if the prefix is 2, forward message
5638 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5639 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5640 directly inline; otherwise, the message is forwarded as no prefix given
5641 but use the flipped value of (@code{message-forward-as-mime}). By
5642 default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section.
5645 @kindex S O p (Summary)
5646 @findex gnus-uu-digest-post-forward
5648 @cindex making digests
5649 Digest the current series and forward the result to a newsgroup
5650 (@code{gnus-uu-digest-post-forward}). This command uses the
5651 process/prefix convention.
5654 @kindex S u (Summary)
5655 @findex gnus-uu-post-news
5656 @c @icon{gnus-uu-post-news}
5657 Uuencode a file, split it into parts, and post it as a series
5658 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5661 Also @xref{Header Commands, ,Header Commands, message, The Message
5662 Manual}, for more information.
5665 @node Summary Message Commands
5666 @subsection Summary Message Commands
5670 @kindex S y (Summary)
5671 @findex gnus-summary-yank-message
5672 Yank the current article into an already existing Message composition
5673 buffer (@code{gnus-summary-yank-message}). This command prompts for
5674 what message buffer you want to yank into, and understands the
5675 process/prefix convention (@pxref{Process/Prefix}).
5680 @node Canceling and Superseding
5681 @subsection Canceling Articles
5682 @cindex canceling articles
5683 @cindex superseding articles
5685 Have you ever written something, and then decided that you really,
5686 really, really wish you hadn't posted that?
5688 Well, you can't cancel mail, but you can cancel posts.
5690 @findex gnus-summary-cancel-article
5692 @c @icon{gnus-summary-cancel-article}
5693 Find the article you wish to cancel (you can only cancel your own
5694 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5695 c} (@code{gnus-summary-cancel-article}). Your article will be
5696 canceled---machines all over the world will be deleting your article.
5697 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5699 Be aware, however, that not all sites honor cancels, so your article may
5700 live on here and there, while most sites will delete the article in
5703 Gnus will use the ``current'' select method when canceling. If you
5704 want to use the standard posting method, use the @samp{a} symbolic
5705 prefix (@pxref{Symbolic Prefixes}).
5707 Gnus ensures that only you can cancel your own messages using a
5708 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5709 message, Message Manual}).
5711 If you discover that you have made some mistakes and want to do some
5712 corrections, you can post a @dfn{superseding} article that will replace
5713 your original article.
5715 @findex gnus-summary-supersede-article
5717 Go to the original article and press @kbd{S s}
5718 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5719 where you can edit the article all you want before sending it off the
5722 The same goes for superseding as for canceling, only more so: Some
5723 sites do not honor superseding. On those sites, it will appear that you
5724 have posted almost the same article twice.
5726 If you have just posted the article, and change your mind right away,
5727 there is a trick you can use to cancel/supersede the article without
5728 waiting for the article to appear on your site first. You simply return
5729 to the post buffer (which is called @code{*sent ...*}). There you will
5730 find the article you just posted, with all the headers intact. Change
5731 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5732 header by substituting one of those words for the word
5733 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5734 you would do normally. The previous article will be
5735 canceled/superseded.
5737 Just remember, kids: There is no 'c' in 'supersede'.
5739 @node Delayed Articles
5740 @section Delayed Articles
5741 @cindex delayed sending
5742 @cindex send delayed
5744 Sometimes, you might wish to delay the sending of a message. For
5745 example, you might wish to arrange for a message to turn up just in time
5746 to remind your about the birthday of your Significant Other. For this,
5747 there is the @code{gnus-delay} package. Setup is simple:
5750 (gnus-delay-initialize)
5753 @findex gnus-delay-article
5754 Normally, to send a message you use the @kbd{C-c C-c} command from
5755 Message mode. To delay a message, use @kbd{C-c C-j}
5756 (@code{gnus-delay-article}) instead. This will ask you for how long the
5757 message should be delayed. Possible answers are:
5761 A time span. Consists of an integer and a letter. For example,
5762 @code{42d} means to delay for 42 days. Available letters are @code{m}
5763 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5764 (months) and @code{Y} (years).
5767 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5768 delayed until that day, at a specific time (eight o'clock by default).
5769 See also @code{gnus-delay-default-hour}.
5772 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5773 stuff. The deadline will be at that time today, except if that time has
5774 already passed, then it's at the given time tomorrow. So if it's ten
5775 o'clock in the morning and you specify @code{11:15}, then the deadline
5776 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5777 that means a time tomorrow.
5780 The action of the @code{gnus-delay-article} command is influenced by a
5781 couple of variables:
5784 @item gnus-delay-default-hour
5785 @vindex gnus-delay-default-hour
5786 When you specify a specific date, the message will be due on that hour
5787 on the given date. Possible values are integers 0 through 23.
5789 @item gnus-delay-default-delay
5790 @vindex gnus-delay-default-delay
5791 This is a string and gives the default delay. It can be of any of the
5792 formats described above.
5794 @item gnus-delay-group
5795 @vindex gnus-delay-group
5796 Delayed articles will be kept in this group on the drafts server until
5797 they are due. You probably don't need to change this. The default
5798 value is @code{"delayed"}.
5800 @item gnus-delay-header
5801 @vindex gnus-delay-header
5802 The deadline for each article will be stored in a header. This variable
5803 is a string and gives the header name. You probably don't need to
5804 change this. The default value is @code{"X-Gnus-Delayed"}.
5807 The way delaying works is like this: when you use the
5808 @code{gnus-delay-article} command, you give a certain delay. Gnus
5809 calculates the deadline of the message and stores it in the
5810 @code{X-Gnus-Delayed} header and puts the message in the
5811 @code{nndraft:delayed} group.
5813 @findex gnus-delay-send-queue
5814 And whenever you get new news, Gnus looks through the group for articles
5815 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5816 function for this. By default, this function is added to the hook
5817 @code{gnus-get-new-news-hook}. But of course, you can change this.
5818 Maybe you want to use the demon to send drafts? Just tell the demon to
5819 execute the @code{gnus-delay-send-queue} function.
5822 @item gnus-delay-initialize
5823 @findex gnus-delay-initialize
5824 By default, this function installs @code{gnus-delay-send-queue} in
5825 @code{gnus-get-new-news-hook}. But it accepts the optional second
5826 argument @code{no-check}. If it is non-@code{nil},
5827 @code{gnus-get-new-news-hook} is not changed. The optional first
5828 argument is ignored.
5830 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5831 Presumably, you want to use the demon for sending due delayed articles.
5832 Just don't forget to set that up :-)
5836 @node Marking Articles
5837 @section Marking Articles
5838 @cindex article marking
5839 @cindex article ticking
5842 There are several marks you can set on an article.
5844 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5845 neologism ohoy!) of the article. Alphabetic marks generally mean
5846 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5848 In addition, you also have marks that do not affect readedness.
5851 There's a plethora of commands for manipulating these marks.
5855 * Unread Articles:: Marks for unread articles.
5856 * Read Articles:: Marks for read articles.
5857 * Other Marks:: Marks that do not affect readedness.
5858 * Setting Marks:: How to set and remove marks.
5859 * Generic Marking Commands:: How to customize the marking.
5860 * Setting Process Marks:: How to mark articles for later processing.
5864 @node Unread Articles
5865 @subsection Unread Articles
5867 The following marks mark articles as (kinda) unread, in one form or
5872 @vindex gnus-ticked-mark
5873 Marked as ticked (@code{gnus-ticked-mark}).
5875 @dfn{Ticked articles} are articles that will remain visible always. If
5876 you see an article that you find interesting, or you want to put off
5877 reading it, or replying to it, until sometime later, you'd typically
5878 tick it. However, articles can be expired (from news servers by the
5879 news server software, Gnus itself never expires ticked messages), so if
5880 you want to keep an article forever, you'll have to make it persistent
5881 (@pxref{Persistent Articles}).
5884 @vindex gnus-dormant-mark
5885 Marked as dormant (@code{gnus-dormant-mark}).
5887 @dfn{Dormant articles} will only appear in the summary buffer if there
5888 are followups to it. If you want to see them even if they don't have
5889 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5890 Otherwise (except for the visibility issue), they are just like ticked
5894 @vindex gnus-unread-mark
5895 Marked as unread (@code{gnus-unread-mark}).
5897 @dfn{Unread articles} are articles that haven't been read at all yet.
5902 @subsection Read Articles
5903 @cindex expirable mark
5905 All the following marks mark articles as read.
5910 @vindex gnus-del-mark
5911 These are articles that the user has marked as read with the @kbd{d}
5912 command manually, more or less (@code{gnus-del-mark}).
5915 @vindex gnus-read-mark
5916 Articles that have actually been read (@code{gnus-read-mark}).
5919 @vindex gnus-ancient-mark
5920 Articles that were marked as read in previous sessions and are now
5921 @dfn{old} (@code{gnus-ancient-mark}).
5924 @vindex gnus-killed-mark
5925 Marked as killed (@code{gnus-killed-mark}).
5928 @vindex gnus-kill-file-mark
5929 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5932 @vindex gnus-low-score-mark
5933 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5936 @vindex gnus-catchup-mark
5937 Marked as read by a catchup (@code{gnus-catchup-mark}).
5940 @vindex gnus-canceled-mark
5941 Canceled article (@code{gnus-canceled-mark})
5944 @vindex gnus-souped-mark
5945 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5948 @vindex gnus-sparse-mark
5949 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5953 @vindex gnus-duplicate-mark
5954 Article marked as read by duplicate suppression
5955 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5959 All these marks just mean that the article is marked as read, really.
5960 They are interpreted differently when doing adaptive scoring, though.
5962 One more special mark, though:
5966 @vindex gnus-expirable-mark
5967 Marked as expirable (@code{gnus-expirable-mark}).
5969 Marking articles as @dfn{expirable} (or have them marked as such
5970 automatically) doesn't make much sense in normal groups---a user doesn't
5971 control expiring of news articles, but in mail groups, for instance,
5972 articles marked as @dfn{expirable} can be deleted by Gnus at
5978 @subsection Other Marks
5979 @cindex process mark
5982 There are some marks that have nothing to do with whether the article is
5988 You can set a bookmark in the current article. Say you are reading a
5989 long thesis on cats' urinary tracts, and have to go home for dinner
5990 before you've finished reading the thesis. You can then set a bookmark
5991 in the article, and Gnus will jump to this bookmark the next time it
5992 encounters the article. @xref{Setting Marks}.
5995 @vindex gnus-replied-mark
5996 All articles that you have replied to or made a followup to (i.e., have
5997 answered) will be marked with an @samp{A} in the second column
5998 (@code{gnus-replied-mark}).
6001 @vindex gnus-forwarded-mark
6002 All articles that you have forwarded will be marked with an @samp{F} in
6003 the second column (@code{gnus-forwarded-mark}).
6006 @vindex gnus-cached-mark
6007 Articles stored in the article cache will be marked with an @samp{*} in
6008 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
6011 @vindex gnus-saved-mark
6012 Articles ``saved'' (in some manner or other; not necessarily
6013 religiously) are marked with an @samp{S} in the second column
6014 (@code{gnus-saved-mark}).
6017 @vindex gnus-recent-mark
6018 Articles that according to the server haven't been shown to the user
6019 before are marked with a @samp{N} in the second column
6020 (@code{gnus-recent-mark}). Note that not all servers support this
6021 mark, in which case it simply never appears. Compare with
6022 @code{gnus-unseen-mark}.
6025 @vindex gnus-unseen-mark
6026 Articles that haven't been seen before in Gnus by the user are marked
6027 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
6028 Compare with @code{gnus-recent-mark}.
6031 @vindex gnus-downloaded-mark
6032 When using the Gnus agent (@pxref{Agent Basics}), articles may be
6033 downloaded for unplugged (offline) viewing. If you are using the
6034 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
6035 (The variable @code{gnus-downloaded-mark} controls which character to
6039 @vindex gnus-undownloaded-mark
6040 When using the Gnus agent (@pxref{Agent Basics}), some articles might
6041 not have been downloaded. Such articles cannot be viewed while you
6042 are unplugged (offline). If you are using the @samp{%O} spec, these
6043 articles get the @samp{-} mark in that spec. (The variable
6044 @code{gnus-undownloaded-mark} controls which character to use.)
6047 @vindex gnus-downloadable-mark
6048 The Gnus agent (@pxref{Agent Basics}) downloads some articles
6049 automatically, but it is also possible to explicitly mark articles for
6050 download, even if they would not be downloaded automatically. Such
6051 explicitly-marked articles get the @samp{%} mark in the first column.
6052 (The variable @code{gnus-downloadable-mark} controls which character to
6056 @vindex gnus-not-empty-thread-mark
6057 @vindex gnus-empty-thread-mark
6058 If the @samp{%e} spec is used, the presence of threads or not will be
6059 marked with @code{gnus-not-empty-thread-mark} and
6060 @code{gnus-empty-thread-mark} in the third column, respectively.
6063 @vindex gnus-process-mark
6064 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
6065 variety of commands react to the presence of the process mark. For
6066 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
6067 all articles that have been marked with the process mark. Articles
6068 marked with the process mark have a @samp{#} in the second column.
6072 You might have noticed that most of these ``non-readedness'' marks
6073 appear in the second column by default. So if you have a cached, saved,
6074 replied article that you have process-marked, what will that look like?
6076 Nothing much. The precedence rules go as follows: process -> cache ->
6077 replied -> saved. So if the article is in the cache and is replied,
6078 you'll only see the cache mark and not the replied mark.
6082 @subsection Setting Marks
6083 @cindex setting marks
6085 All the marking commands understand the numeric prefix.
6090 @kindex M c (Summary)
6091 @kindex M-u (Summary)
6092 @findex gnus-summary-clear-mark-forward
6093 @cindex mark as unread
6094 Clear all readedness-marks from the current article
6095 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
6101 @kindex M t (Summary)
6102 @findex gnus-summary-tick-article-forward
6103 Tick the current article (@code{gnus-summary-tick-article-forward}).
6104 @xref{Article Caching}.
6109 @kindex M ? (Summary)
6110 @findex gnus-summary-mark-as-dormant
6111 Mark the current article as dormant
6112 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
6116 @kindex M d (Summary)
6118 @findex gnus-summary-mark-as-read-forward
6119 Mark the current article as read
6120 (@code{gnus-summary-mark-as-read-forward}).
6124 @findex gnus-summary-mark-as-read-backward
6125 Mark the current article as read and move point to the previous line
6126 (@code{gnus-summary-mark-as-read-backward}).
6131 @kindex M k (Summary)
6132 @findex gnus-summary-kill-same-subject-and-select
6133 Mark all articles that have the same subject as the current one as read,
6134 and then select the next unread article
6135 (@code{gnus-summary-kill-same-subject-and-select}).
6139 @kindex M K (Summary)
6140 @kindex C-k (Summary)
6141 @findex gnus-summary-kill-same-subject
6142 Mark all articles that have the same subject as the current one as read
6143 (@code{gnus-summary-kill-same-subject}).
6146 @kindex M C (Summary)
6147 @findex gnus-summary-catchup
6148 @c @icon{gnus-summary-catchup}
6149 Mark all unread articles as read (@code{gnus-summary-catchup}).
6152 @kindex M C-c (Summary)
6153 @findex gnus-summary-catchup-all
6154 Mark all articles in the group as read---even the ticked and dormant
6155 articles (@code{gnus-summary-catchup-all}).
6158 @kindex M H (Summary)
6159 @findex gnus-summary-catchup-to-here
6160 Catchup the current group to point (before the point)
6161 (@code{gnus-summary-catchup-to-here}).
6164 @kindex M h (Summary)
6165 @findex gnus-summary-catchup-from-here
6166 Catchup the current group from point (after the point)
6167 (@code{gnus-summary-catchup-from-here}).
6170 @kindex C-w (Summary)
6171 @findex gnus-summary-mark-region-as-read
6172 Mark all articles between point and mark as read
6173 (@code{gnus-summary-mark-region-as-read}).
6176 @kindex M V k (Summary)
6177 @findex gnus-summary-kill-below
6178 Kill all articles with scores below the default score (or below the
6179 numeric prefix) (@code{gnus-summary-kill-below}).
6183 @kindex M e (Summary)
6185 @findex gnus-summary-mark-as-expirable
6186 Mark the current article as expirable
6187 (@code{gnus-summary-mark-as-expirable}).
6190 @kindex M b (Summary)
6191 @findex gnus-summary-set-bookmark
6192 Set a bookmark in the current article
6193 (@code{gnus-summary-set-bookmark}).
6196 @kindex M B (Summary)
6197 @findex gnus-summary-remove-bookmark
6198 Remove the bookmark from the current article
6199 (@code{gnus-summary-remove-bookmark}).
6202 @kindex M V c (Summary)
6203 @findex gnus-summary-clear-above
6204 Clear all marks from articles with scores over the default score (or
6205 over the numeric prefix) (@code{gnus-summary-clear-above}).
6208 @kindex M V u (Summary)
6209 @findex gnus-summary-tick-above
6210 Tick all articles with scores over the default score (or over the
6211 numeric prefix) (@code{gnus-summary-tick-above}).
6214 @kindex M V m (Summary)
6215 @findex gnus-summary-mark-above
6216 Prompt for a mark, and mark all articles with scores over the default
6217 score (or over the numeric prefix) with this mark
6218 (@code{gnus-summary-clear-above}).
6221 @vindex gnus-summary-goto-unread
6222 The @code{gnus-summary-goto-unread} variable controls what action should
6223 be taken after setting a mark. If non-@code{nil}, point will move to
6224 the next/previous unread article. If @code{nil}, point will just move
6225 one line up or down. As a special case, if this variable is
6226 @code{never}, all the marking commands as well as other commands (like
6227 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6228 The default is @code{t}.
6231 @node Generic Marking Commands
6232 @subsection Generic Marking Commands
6234 Some people would like the command that ticks an article (@kbd{!}) go to
6235 the next article. Others would like it to go to the next unread
6236 article. Yet others would like it to stay on the current article. And
6237 even though I haven't heard of anybody wanting it to go to the
6238 previous (unread) article, I'm sure there are people that want that as
6241 Multiply these five behaviors with five different marking commands, and
6242 you get a potentially complex set of variable to control what each
6245 To sidestep that mess, Gnus provides commands that do all these
6246 different things. They can be found on the @kbd{M M} map in the summary
6247 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6248 to list in this manual.
6250 While you can use these commands directly, most users would prefer
6251 altering the summary mode keymap. For instance, if you would like the
6252 @kbd{!} command to go to the next article instead of the next unread
6253 article, you could say something like:
6257 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6258 (defun my-alter-summary-map ()
6259 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6267 (defun my-alter-summary-map ()
6268 (local-set-key "!" "MM!n"))
6272 @node Setting Process Marks
6273 @subsection Setting Process Marks
6274 @cindex setting process marks
6276 Process marks are displayed as @code{#} in the summary buffer, and are
6277 used for marking articles in such a way that other commands will
6278 process these articles. For instance, if you process mark four
6279 articles and then use the @kbd{*} command, Gnus will enter these four
6280 articles into the cache. For more information,
6281 @pxref{Process/Prefix}.
6288 @kindex M P p (Summary)
6289 @findex gnus-summary-mark-as-processable
6290 Mark the current article with the process mark
6291 (@code{gnus-summary-mark-as-processable}).
6292 @findex gnus-summary-unmark-as-processable
6296 @kindex M P u (Summary)
6297 @kindex M-# (Summary)
6298 Remove the process mark, if any, from the current article
6299 (@code{gnus-summary-unmark-as-processable}).
6302 @kindex M P U (Summary)
6303 @findex gnus-summary-unmark-all-processable
6304 Remove the process mark from all articles
6305 (@code{gnus-summary-unmark-all-processable}).
6308 @kindex M P i (Summary)
6309 @findex gnus-uu-invert-processable
6310 Invert the list of process marked articles
6311 (@code{gnus-uu-invert-processable}).
6314 @kindex M P R (Summary)
6315 @findex gnus-uu-mark-by-regexp
6316 Mark articles that have a @code{Subject} header that matches a regular
6317 expression (@code{gnus-uu-mark-by-regexp}).
6320 @kindex M P G (Summary)
6321 @findex gnus-uu-unmark-by-regexp
6322 Unmark articles that have a @code{Subject} header that matches a regular
6323 expression (@code{gnus-uu-unmark-by-regexp}).
6326 @kindex M P r (Summary)
6327 @findex gnus-uu-mark-region
6328 Mark articles in region (@code{gnus-uu-mark-region}).
6331 @kindex M P g (Summary)
6332 @findex gnus-uu-unmark-region
6333 Unmark articles in region (@code{gnus-uu-unmark-region}).
6336 @kindex M P t (Summary)
6337 @findex gnus-uu-mark-thread
6338 Mark all articles in the current (sub)thread
6339 (@code{gnus-uu-mark-thread}).
6342 @kindex M P T (Summary)
6343 @findex gnus-uu-unmark-thread
6344 Unmark all articles in the current (sub)thread
6345 (@code{gnus-uu-unmark-thread}).
6348 @kindex M P v (Summary)
6349 @findex gnus-uu-mark-over
6350 Mark all articles that have a score above the prefix argument
6351 (@code{gnus-uu-mark-over}).
6354 @kindex M P s (Summary)
6355 @findex gnus-uu-mark-series
6356 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6359 @kindex M P S (Summary)
6360 @findex gnus-uu-mark-sparse
6361 Mark all series that have already had some articles marked
6362 (@code{gnus-uu-mark-sparse}).
6365 @kindex M P a (Summary)
6366 @findex gnus-uu-mark-all
6367 Mark all articles in series order (@code{gnus-uu-mark-all}).
6370 @kindex M P b (Summary)
6371 @findex gnus-uu-mark-buffer
6372 Mark all articles in the buffer in the order they appear
6373 (@code{gnus-uu-mark-buffer}).
6376 @kindex M P k (Summary)
6377 @findex gnus-summary-kill-process-mark
6378 Push the current process mark set onto the stack and unmark all articles
6379 (@code{gnus-summary-kill-process-mark}).
6382 @kindex M P y (Summary)
6383 @findex gnus-summary-yank-process-mark
6384 Pop the previous process mark set from the stack and restore it
6385 (@code{gnus-summary-yank-process-mark}).
6388 @kindex M P w (Summary)
6389 @findex gnus-summary-save-process-mark
6390 Push the current process mark set onto the stack
6391 (@code{gnus-summary-save-process-mark}).
6395 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6396 set process marks based on article body contents.
6403 It can be convenient to limit the summary buffer to just show some
6404 subset of the articles currently in the group. The effect most limit
6405 commands have is to remove a few (or many) articles from the summary
6408 All limiting commands work on subsets of the articles already fetched
6409 from the servers. None of these commands query the server for
6410 additional articles.
6416 @kindex / / (Summary)
6417 @findex gnus-summary-limit-to-subject
6418 Limit the summary buffer to articles that match some subject
6419 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6423 @kindex / a (Summary)
6424 @findex gnus-summary-limit-to-author
6425 Limit the summary buffer to articles that match some author
6426 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6430 @kindex / R (Summary)
6431 @findex gnus-summary-limit-to-recipient
6432 Limit the summary buffer to articles that match some recipient
6433 (@code{gnus-summary-limit-to-recipient}). If given a prefix, exclude
6437 @kindex / S (Summary)
6438 @findex gnus-summary-limit-to-singletons
6439 Limit the summary buffer to articles that aren't part of any displayed
6440 threads (@code{gnus-summary-limit-to-singletons}). If given a prefix,
6441 limit to articles that are part of displayed threads.
6444 @kindex / x (Summary)
6445 @findex gnus-summary-limit-to-extra
6446 Limit the summary buffer to articles that match one of the ``extra''
6447 headers (@pxref{To From Newsgroups})
6448 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6453 @kindex / u (Summary)
6455 @findex gnus-summary-limit-to-unread
6456 Limit the summary buffer to articles not marked as read
6457 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6458 buffer to articles strictly unread. This means that ticked and
6459 dormant articles will also be excluded.
6462 @kindex / m (Summary)
6463 @findex gnus-summary-limit-to-marks
6464 Ask for a mark and then limit to all articles that have been marked
6465 with that mark (@code{gnus-summary-limit-to-marks}).
6468 @kindex / t (Summary)
6469 @findex gnus-summary-limit-to-age
6470 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6471 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6472 articles younger than that number of days.
6475 @kindex / n (Summary)
6476 @findex gnus-summary-limit-to-articles
6477 With prefix @samp{n}, limit the summary buffer to the next @samp{n}
6478 articles. If not given a prefix, use the process marked articles
6479 instead. (@code{gnus-summary-limit-to-articles}).
6482 @kindex / w (Summary)
6483 @findex gnus-summary-pop-limit
6484 Pop the previous limit off the stack and restore it
6485 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6489 @kindex / . (Summary)
6490 @findex gnus-summary-limit-to-unseen
6491 Limit the summary buffer to the unseen articles
6492 (@code{gnus-summary-limit-to-unseen}).
6495 @kindex / v (Summary)
6496 @findex gnus-summary-limit-to-score
6497 Limit the summary buffer to articles that have a score at or above some
6498 score (@code{gnus-summary-limit-to-score}).
6501 @kindex / p (Summary)
6502 @findex gnus-summary-limit-to-display-predicate
6503 Limit the summary buffer to articles that satisfy the @code{display}
6504 group parameter predicate
6505 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6506 Parameters}, for more on this predicate.
6509 @kindex / r (Summary)
6510 @findex gnus-summary-limit-to-replied
6511 Limit the summary buffer to replied articles
6512 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6517 @kindex M S (Summary)
6518 @kindex / E (Summary)
6519 @findex gnus-summary-limit-include-expunged
6520 Include all expunged articles in the limit
6521 (@code{gnus-summary-limit-include-expunged}).
6524 @kindex / D (Summary)
6525 @findex gnus-summary-limit-include-dormant
6526 Include all dormant articles in the limit
6527 (@code{gnus-summary-limit-include-dormant}).
6530 @kindex / * (Summary)
6531 @findex gnus-summary-limit-include-cached
6532 Include all cached articles in the limit
6533 (@code{gnus-summary-limit-include-cached}).
6536 @kindex / d (Summary)
6537 @findex gnus-summary-limit-exclude-dormant
6538 Exclude all dormant articles from the limit
6539 (@code{gnus-summary-limit-exclude-dormant}).
6542 @kindex / M (Summary)
6543 @findex gnus-summary-limit-exclude-marks
6544 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6547 @kindex / T (Summary)
6548 @findex gnus-summary-limit-include-thread
6549 Include all the articles in the current thread in the limit.
6552 @kindex / c (Summary)
6553 @findex gnus-summary-limit-exclude-childless-dormant
6554 Exclude all dormant articles that have no children from the limit@*
6555 (@code{gnus-summary-limit-exclude-childless-dormant}).
6558 @kindex / C (Summary)
6559 @findex gnus-summary-limit-mark-excluded-as-read
6560 Mark all excluded unread articles as read
6561 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6562 also mark excluded ticked and dormant articles as read.
6565 @kindex / N (Summary)
6566 @findex gnus-summary-insert-new-articles
6567 Insert all new articles in the summary buffer. It scans for new emails
6568 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6571 @kindex / o (Summary)
6572 @findex gnus-summary-insert-old-articles
6573 Insert all old articles in the summary buffer. If given a numbered
6574 prefix, fetch this number of articles.
6577 @kindex / b (Summary)
6578 @findex gnus-summary-limit-to-bodies
6579 Limit the summary buffer to articles that have bodies that match a
6580 certain regexp (@code{gnus-summary-limit-to-bodies}). If given a
6581 prefix, reverse the limit. This command is quite slow since it
6582 requires selecting each article to find the matches.
6585 @kindex / h (Summary)
6586 @findex gnus-summary-limit-to-headers
6587 Like the previous command, only limit to headers instead
6588 (@code{gnus-summary-limit-to-headers}).
6596 @cindex article threading
6598 Gnus threads articles by default. @dfn{To thread} is to put responses
6599 to articles directly after the articles they respond to---in a
6600 hierarchical fashion.
6602 Threading is done by looking at the @code{References} headers of the
6603 articles. In a perfect world, this would be enough to build pretty
6604 trees, but unfortunately, the @code{References} header is often broken
6605 or simply missing. Weird news propagation exacerbates the problem,
6606 so one has to employ other heuristics to get pleasing results. A
6607 plethora of approaches exists, as detailed in horrible detail in
6608 @ref{Customizing Threading}.
6610 First, a quick overview of the concepts:
6614 The top-most article in a thread; the first article in the thread.
6617 A tree-like article structure.
6620 A small(er) section of this tree-like structure.
6623 Threads often lose their roots due to article expiry, or due to the root
6624 already having been read in a previous session, and not displayed in the
6625 summary buffer. We then typically have many sub-threads that really
6626 belong to one thread, but are without connecting roots. These are
6627 called loose threads.
6629 @item thread gathering
6630 An attempt to gather loose threads into bigger threads.
6632 @item sparse threads
6633 A thread where the missing articles have been ``guessed'' at, and are
6634 displayed as empty lines in the summary buffer.
6640 * Customizing Threading:: Variables you can change to affect the threading.
6641 * Thread Commands:: Thread based commands in the summary buffer.
6645 @node Customizing Threading
6646 @subsection Customizing Threading
6647 @cindex customizing threading
6650 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6651 * Filling In Threads:: Making the threads displayed look fuller.
6652 * More Threading:: Even more variables for fiddling with threads.
6653 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6658 @subsubsection Loose Threads
6661 @cindex loose threads
6664 @item gnus-summary-make-false-root
6665 @vindex gnus-summary-make-false-root
6666 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
6667 and create a dummy root at the top. (Wait a minute. Root at the top?
6668 Yup.) Loose subtrees occur when the real root has expired, or you've
6669 read or killed the root in a previous session.
6671 When there is no real root of a thread, Gnus will have to fudge
6672 something. This variable says what fudging method Gnus should use.
6673 There are four possible values:
6677 \gnusfigure{The Summary Buffer}{390}{
6678 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6679 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6680 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6681 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6686 @cindex adopting articles
6691 Gnus will make the first of the orphaned articles the parent. This
6692 parent will adopt all the other articles. The adopted articles will be
6693 marked as such by pointy brackets (@samp{<>}) instead of the standard
6694 square brackets (@samp{[]}). This is the default method.
6697 @vindex gnus-summary-dummy-line-format
6698 @vindex gnus-summary-make-false-root-always
6699 Gnus will create a dummy summary line that will pretend to be the
6700 parent. This dummy line does not correspond to any real article, so
6701 selecting it will just select the first real article after the dummy
6702 article. @code{gnus-summary-dummy-line-format} is used to specify the
6703 format of the dummy roots. It accepts only one format spec: @samp{S},
6704 which is the subject of the article. @xref{Formatting Variables}.
6705 If you want all threads to have a dummy root, even the non-gathered
6706 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6709 Gnus won't actually make any article the parent, but simply leave the
6710 subject field of all orphans except the first empty. (Actually, it will
6711 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6715 Don't make any article parent at all. Just gather the threads and
6716 display them after one another.
6719 Don't gather loose threads.
6722 @item gnus-summary-gather-subject-limit
6723 @vindex gnus-summary-gather-subject-limit
6724 Loose threads are gathered by comparing subjects of articles. If this
6725 variable is @code{nil}, Gnus requires an exact match between the
6726 subjects of the loose threads before gathering them into one big
6727 super-thread. This might be too strict a requirement, what with the
6728 presence of stupid newsreaders that chop off long subject lines. If
6729 you think so, set this variable to, say, 20 to require that only the
6730 first 20 characters of the subjects have to match. If you set this
6731 variable to a really low number, you'll find that Gnus will gather
6732 everything in sight into one thread, which isn't very helpful.
6734 @cindex fuzzy article gathering
6735 If you set this variable to the special value @code{fuzzy}, Gnus will
6736 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6739 @item gnus-simplify-subject-fuzzy-regexp
6740 @vindex gnus-simplify-subject-fuzzy-regexp
6741 This can either be a regular expression or list of regular expressions
6742 that match strings that will be removed from subjects if fuzzy subject
6743 simplification is used.
6745 @item gnus-simplify-ignored-prefixes
6746 @vindex gnus-simplify-ignored-prefixes
6747 If you set @code{gnus-summary-gather-subject-limit} to something as low
6748 as 10, you might consider setting this variable to something sensible:
6750 @c Written by Michael Ernst <mernst@cs.rice.edu>
6752 (setq gnus-simplify-ignored-prefixes
6758 "wanted" "followup" "summary\\( of\\)?"
6759 "help" "query" "problem" "question"
6760 "answer" "reference" "announce"
6761 "How can I" "How to" "Comparison of"
6766 (mapconcat 'identity
6767 '("for" "for reference" "with" "about")
6769 "\\)?\\]?:?[ \t]*"))
6772 All words that match this regexp will be removed before comparing two
6775 @item gnus-simplify-subject-functions
6776 @vindex gnus-simplify-subject-functions
6777 If non-@code{nil}, this variable overrides
6778 @code{gnus-summary-gather-subject-limit}. This variable should be a
6779 list of functions to apply to the @code{Subject} string iteratively to
6780 arrive at the simplified version of the string.
6782 Useful functions to put in this list include:
6785 @item gnus-simplify-subject-re
6786 @findex gnus-simplify-subject-re
6787 Strip the leading @samp{Re:}.
6789 @item gnus-simplify-subject-fuzzy
6790 @findex gnus-simplify-subject-fuzzy
6793 @item gnus-simplify-whitespace
6794 @findex gnus-simplify-whitespace
6795 Remove excessive whitespace.
6797 @item gnus-simplify-all-whitespace
6798 @findex gnus-simplify-all-whitespace
6799 Remove all whitespace.
6802 You may also write your own functions, of course.
6805 @item gnus-summary-gather-exclude-subject
6806 @vindex gnus-summary-gather-exclude-subject
6807 Since loose thread gathering is done on subjects only, that might lead
6808 to many false hits, especially with certain common subjects like
6809 @samp{} and @samp{(none)}. To make the situation slightly better,
6810 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6811 what subjects should be excluded from the gathering process.@*
6812 The default is @samp{^ *$\\|^(none)$}.
6814 @item gnus-summary-thread-gathering-function
6815 @vindex gnus-summary-thread-gathering-function
6816 Gnus gathers threads by looking at @code{Subject} headers. This means
6817 that totally unrelated articles may end up in the same ``thread'', which
6818 is confusing. An alternate approach is to look at all the
6819 @code{Message-ID}s in all the @code{References} headers to find matches.
6820 This will ensure that no gathered threads ever include unrelated
6821 articles, but it also means that people who have posted with broken
6822 newsreaders won't be gathered properly. The choice is yours---plague or
6826 @item gnus-gather-threads-by-subject
6827 @findex gnus-gather-threads-by-subject
6828 This function is the default gathering function and looks at
6829 @code{Subject}s exclusively.
6831 @item gnus-gather-threads-by-references
6832 @findex gnus-gather-threads-by-references
6833 This function looks at @code{References} headers exclusively.
6836 If you want to test gathering by @code{References}, you could say
6840 (setq gnus-summary-thread-gathering-function
6841 'gnus-gather-threads-by-references)
6847 @node Filling In Threads
6848 @subsubsection Filling In Threads
6851 @item gnus-fetch-old-headers
6852 @vindex gnus-fetch-old-headers
6853 If non-@code{nil}, Gnus will attempt to build old threads by fetching
6854 more old headers---headers to articles marked as read. If you would
6855 like to display as few summary lines as possible, but still connect as
6856 many loose threads as possible, you should set this variable to
6857 @code{some} or a number. If you set it to a number, no more than that
6858 number of extra old headers will be fetched. In either case, fetching
6859 old headers only works if the back end you are using carries overview
6860 files---this would normally be @code{nntp}, @code{nnspool},
6861 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
6862 the thread has been expired by the server, there's not much Gnus can
6865 This variable can also be set to @code{invisible}. This won't have any
6866 visible effects, but is useful if you use the @kbd{A T} command a lot
6867 (@pxref{Finding the Parent}).
6869 @item gnus-fetch-old-ephemeral-headers
6870 @vindex gnus-fetch-old-ephemeral-headers
6871 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
6874 @item gnus-build-sparse-threads
6875 @vindex gnus-build-sparse-threads
6876 Fetching old headers can be slow. A low-rent similar effect can be
6877 gotten by setting this variable to @code{some}. Gnus will then look at
6878 the complete @code{References} headers of all articles and try to string
6879 together articles that belong in the same thread. This will leave
6880 @dfn{gaps} in the threading display where Gnus guesses that an article
6881 is missing from the thread. (These gaps appear like normal summary
6882 lines. If you select a gap, Gnus will try to fetch the article in
6883 question.) If this variable is @code{t}, Gnus will display all these
6884 ``gaps'' without regard for whether they are useful for completing the
6885 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
6886 off sparse leaf nodes that don't lead anywhere. This variable is
6887 @code{nil} by default.
6889 @item gnus-read-all-available-headers
6890 @vindex gnus-read-all-available-headers
6891 This is a rather obscure variable that few will find useful. It's
6892 intended for those non-news newsgroups where the back end has to fetch
6893 quite a lot to present the summary buffer, and where it's impossible to
6894 go back to parents of articles. This is mostly the case in the
6895 web-based groups, like the @code{nnultimate} groups.
6897 If you don't use those, then it's safe to leave this as the default
6898 @code{nil}. If you want to use this variable, it should be a regexp
6899 that matches the group name, or @code{t} for all groups.
6904 @node More Threading
6905 @subsubsection More Threading
6908 @item gnus-show-threads
6909 @vindex gnus-show-threads
6910 If this variable is @code{nil}, no threading will be done, and all of
6911 the rest of the variables here will have no effect. Turning threading
6912 off will speed group selection up a bit, but it is sure to make reading
6913 slower and more awkward.
6915 @item gnus-thread-hide-subtree
6916 @vindex gnus-thread-hide-subtree
6917 If non-@code{nil}, all threads will be hidden when the summary buffer is
6920 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6921 Available predicates are @code{gnus-article-unread-p} and
6922 @code{gnus-article-unseen-p}.
6927 (setq gnus-thread-hide-subtree
6928 '(or gnus-article-unread-p
6929 gnus-article-unseen-p))
6932 (It's a pretty nonsensical example, since all unseen articles are also
6933 unread, but you get my drift.)
6936 @item gnus-thread-expunge-below
6937 @vindex gnus-thread-expunge-below
6938 All threads that have a total score (as defined by
6939 @code{gnus-thread-score-function}) less than this number will be
6940 expunged. This variable is @code{nil} by default, which means that no
6941 threads are expunged.
6943 @item gnus-thread-hide-killed
6944 @vindex gnus-thread-hide-killed
6945 if you kill a thread and this variable is non-@code{nil}, the subtree
6948 @item gnus-thread-ignore-subject
6949 @vindex gnus-thread-ignore-subject
6950 Sometimes somebody changes the subject in the middle of a thread. If
6951 this variable is non-@code{nil}, which is the default, the subject
6952 change is ignored. If it is @code{nil}, a change in the subject will
6953 result in a new thread.
6955 @item gnus-thread-indent-level
6956 @vindex gnus-thread-indent-level
6957 This is a number that says how much each sub-thread should be indented.
6960 @item gnus-sort-gathered-threads-function
6961 @vindex gnus-sort-gathered-threads-function
6962 Sometimes, particularly with mailing lists, the order in which mails
6963 arrive locally is not necessarily the same as the order in which they
6964 arrived on the mailing list. Consequently, when sorting sub-threads
6965 using the default @code{gnus-thread-sort-by-number}, responses can end
6966 up appearing before the article to which they are responding to.
6967 Setting this variable to an alternate value
6968 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6969 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6970 more logical sub-thread ordering in such instances.
6975 @node Low-Level Threading
6976 @subsubsection Low-Level Threading
6980 @item gnus-parse-headers-hook
6981 @vindex gnus-parse-headers-hook
6982 Hook run before parsing any headers.
6984 @item gnus-alter-header-function
6985 @vindex gnus-alter-header-function
6986 If non-@code{nil}, this function will be called to allow alteration of
6987 article header structures. The function is called with one parameter,
6988 the article header vector, which it may alter in any way. For instance,
6989 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6990 in systematic ways (by adding prefixes and such), you can use this
6991 variable to un-scramble the @code{Message-ID}s so that they are more
6992 meaningful. Here's one example:
6995 (setq gnus-alter-header-function 'my-alter-message-id)
6997 (defun my-alter-message-id (header)
6998 (let ((id (mail-header-id header)))
7000 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
7002 (concat (match-string 1 id) "@@" (match-string 2 id))
7009 @node Thread Commands
7010 @subsection Thread Commands
7011 @cindex thread commands
7017 @kindex T k (Summary)
7018 @kindex C-M-k (Summary)
7019 @findex gnus-summary-kill-thread
7020 Mark all articles in the current (sub-)thread as read
7021 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
7022 remove all marks instead. If the prefix argument is negative, tick
7027 @kindex T l (Summary)
7028 @kindex C-M-l (Summary)
7029 @findex gnus-summary-lower-thread
7030 Lower the score of the current (sub-)thread
7031 (@code{gnus-summary-lower-thread}).
7034 @kindex T i (Summary)
7035 @findex gnus-summary-raise-thread
7036 Increase the score of the current (sub-)thread
7037 (@code{gnus-summary-raise-thread}).
7040 @kindex T # (Summary)
7041 @findex gnus-uu-mark-thread
7042 Set the process mark on the current (sub-)thread
7043 (@code{gnus-uu-mark-thread}).
7046 @kindex T M-# (Summary)
7047 @findex gnus-uu-unmark-thread
7048 Remove the process mark from the current (sub-)thread
7049 (@code{gnus-uu-unmark-thread}).
7052 @kindex T T (Summary)
7053 @findex gnus-summary-toggle-threads
7054 Toggle threading (@code{gnus-summary-toggle-threads}).
7057 @kindex T s (Summary)
7058 @findex gnus-summary-show-thread
7059 Expose the (sub-)thread hidden under the current article, if any@*
7060 (@code{gnus-summary-show-thread}).
7063 @kindex T h (Summary)
7064 @findex gnus-summary-hide-thread
7065 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
7068 @kindex T S (Summary)
7069 @findex gnus-summary-show-all-threads
7070 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
7073 @kindex T H (Summary)
7074 @findex gnus-summary-hide-all-threads
7075 Hide all threads (@code{gnus-summary-hide-all-threads}).
7078 @kindex T t (Summary)
7079 @findex gnus-summary-rethread-current
7080 Re-thread the current article's thread
7081 (@code{gnus-summary-rethread-current}). This works even when the
7082 summary buffer is otherwise unthreaded.
7085 @kindex T ^ (Summary)
7086 @findex gnus-summary-reparent-thread
7087 Make the current article the child of the marked (or previous) article
7088 (@code{gnus-summary-reparent-thread}).
7091 @kindex T M-^ (Summary)
7092 @findex gnus-summary-reparent-children
7093 Make the current article the parent of the marked articles
7094 (@code{gnus-summary-reparent-children}).
7098 The following commands are thread movement commands. They all
7099 understand the numeric prefix.
7104 @kindex T n (Summary)
7106 @kindex C-M-n (Summary)
7108 @kindex M-down (Summary)
7109 @findex gnus-summary-next-thread
7110 Go to the next thread (@code{gnus-summary-next-thread}).
7113 @kindex T p (Summary)
7115 @kindex C-M-p (Summary)
7117 @kindex M-up (Summary)
7118 @findex gnus-summary-prev-thread
7119 Go to the previous thread (@code{gnus-summary-prev-thread}).
7122 @kindex T d (Summary)
7123 @findex gnus-summary-down-thread
7124 Descend the thread (@code{gnus-summary-down-thread}).
7127 @kindex T u (Summary)
7128 @findex gnus-summary-up-thread
7129 Ascend the thread (@code{gnus-summary-up-thread}).
7132 @kindex T o (Summary)
7133 @findex gnus-summary-top-thread
7134 Go to the top of the thread (@code{gnus-summary-top-thread}).
7137 @vindex gnus-thread-operation-ignore-subject
7138 If you ignore subject while threading, you'll naturally end up with
7139 threads that have several different subjects in them. If you then issue
7140 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
7141 wish to kill the entire thread, but just those parts of the thread that
7142 have the same subject as the current article. If you like this idea,
7143 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
7144 is non-@code{nil} (which it is by default), subjects will be ignored
7145 when doing thread commands. If this variable is @code{nil}, articles in
7146 the same thread with different subjects will not be included in the
7147 operation in question. If this variable is @code{fuzzy}, only articles
7148 that have subjects fuzzily equal will be included (@pxref{Fuzzy
7152 @node Sorting the Summary Buffer
7153 @section Sorting the Summary Buffer
7155 @findex gnus-thread-sort-by-total-score
7156 @findex gnus-thread-sort-by-date
7157 @findex gnus-thread-sort-by-date-reverse
7158 @findex gnus-thread-sort-by-score
7159 @findex gnus-thread-sort-by-subject
7160 @findex gnus-thread-sort-by-author
7161 @findex gnus-thread-sort-by-recipient
7162 @findex gnus-thread-sort-by-number
7163 @findex gnus-thread-sort-by-random
7164 @vindex gnus-thread-sort-functions
7165 @findex gnus-thread-sort-by-most-recent-number
7166 @findex gnus-thread-sort-by-most-recent-date
7167 If you are using a threaded summary display, you can sort the threads by
7168 setting @code{gnus-thread-sort-functions}, which can be either a single
7169 function, a list of functions, or a list containing functions and
7170 @code{(not some-function)} elements.
7172 By default, sorting is done on article numbers. Ready-made sorting
7173 predicate functions include @code{gnus-thread-sort-by-number},
7174 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-recipient},
7175 @code{gnus-thread-sort-by-subject},
7176 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-date-reverse},
7177 @code{gnus-thread-sort-by-score},
7178 @code{gnus-thread-sort-by-most-recent-number},
7179 @code{gnus-thread-sort-by-most-recent-date},
7180 @code{gnus-thread-sort-by-random} and
7181 @code{gnus-thread-sort-by-total-score}.
7183 Each function takes two threads and returns non-@code{nil} if the first
7184 thread should be sorted before the other. Note that sorting really is
7185 normally done by looking only at the roots of each thread.
7187 If you use more than one function, the primary sort key should be the
7188 last function in the list. You should probably always include
7189 @code{gnus-thread-sort-by-number} in the list of sorting
7190 functions---preferably first. This will ensure that threads that are
7191 equal with respect to the other sort criteria will be displayed in
7192 ascending article order.
7194 If you would like to sort by reverse score, then by subject, and finally
7195 by number, you could do something like:
7198 (setq gnus-thread-sort-functions
7199 '(gnus-thread-sort-by-number
7200 gnus-thread-sort-by-subject
7201 (not gnus-thread-sort-by-total-score)))
7204 The threads that have highest score will be displayed first in the
7205 summary buffer. When threads have the same score, they will be sorted
7206 alphabetically. The threads that have the same score and the same
7207 subject will be sorted by number, which is (normally) the sequence in
7208 which the articles arrived.
7210 If you want to sort by score and then reverse arrival order, you could
7214 (setq gnus-thread-sort-functions
7215 '((not gnus-thread-sort-by-number)
7216 gnus-thread-sort-by-score))
7219 @vindex gnus-thread-score-function
7220 The function in the @code{gnus-thread-score-function} variable (default
7221 @code{+}) is used for calculating the total score of a thread. Useful
7222 functions might be @code{max}, @code{min}, or squared means, or whatever
7225 @findex gnus-article-sort-functions
7226 @findex gnus-article-sort-by-date
7227 @findex gnus-article-sort-by-score
7228 @findex gnus-article-sort-by-subject
7229 @findex gnus-article-sort-by-author
7230 @findex gnus-article-sort-by-random
7231 @findex gnus-article-sort-by-number
7232 If you are using an unthreaded display for some strange reason or
7233 other, you have to fiddle with the @code{gnus-article-sort-functions}
7234 variable. It is very similar to the
7235 @code{gnus-thread-sort-functions}, except that it uses slightly
7236 different functions for article comparison. Available sorting
7237 predicate functions are @code{gnus-article-sort-by-number},
7238 @code{gnus-article-sort-by-author},
7239 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7240 @code{gnus-article-sort-by-random}, and
7241 @code{gnus-article-sort-by-score}.
7243 If you want to sort an unthreaded summary display by subject, you could
7247 (setq gnus-article-sort-functions
7248 '(gnus-article-sort-by-number
7249 gnus-article-sort-by-subject))
7252 You can define group specific sorting via @code{gnus-parameters},
7253 @xref{Group Parameters}.
7256 @node Asynchronous Fetching
7257 @section Asynchronous Article Fetching
7258 @cindex asynchronous article fetching
7259 @cindex article pre-fetch
7262 If you read your news from an @acronym{NNTP} server that's far away, the
7263 network latencies may make reading articles a chore. You have to wait
7264 for a while after pressing @kbd{n} to go to the next article before the
7265 article appears. Why can't Gnus just go ahead and fetch the article
7266 while you are reading the previous one? Why not, indeed.
7268 First, some caveats. There are some pitfalls to using asynchronous
7269 article fetching, especially the way Gnus does it.
7271 Let's say you are reading article 1, which is short, and article 2 is
7272 quite long, and you are not interested in reading that. Gnus does not
7273 know this, so it goes ahead and fetches article 2. You decide to read
7274 article 3, but since Gnus is in the process of fetching article 2, the
7275 connection is blocked.
7277 To avoid these situations, Gnus will open two (count 'em two)
7278 connections to the server. Some people may think this isn't a very nice
7279 thing to do, but I don't see any real alternatives. Setting up that
7280 extra connection takes some time, so Gnus startup will be slower.
7282 Gnus will fetch more articles than you will read. This will mean that
7283 the link between your machine and the @acronym{NNTP} server will become more
7284 loaded than if you didn't use article pre-fetch. The server itself will
7285 also become more loaded---both with the extra article requests, and the
7288 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7291 @vindex gnus-asynchronous
7292 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7293 happen automatically.
7295 @vindex gnus-use-article-prefetch
7296 You can control how many articles are to be pre-fetched by setting
7297 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7298 that when you read an article in the group, the back end will pre-fetch
7299 the next 30 articles. If this variable is @code{t}, the back end will
7300 pre-fetch all the articles it can without bound. If it is
7301 @code{nil}, no pre-fetching will be done.
7303 @vindex gnus-async-prefetch-article-p
7304 @findex gnus-async-read-p
7305 There are probably some articles that you don't want to pre-fetch---read
7306 articles, for instance. The @code{gnus-async-prefetch-article-p}
7307 variable controls whether an article is to be pre-fetched. This
7308 function should return non-@code{nil} when the article in question is
7309 to be pre-fetched. The default is @code{gnus-async-read-p}, which
7310 returns @code{nil} on read articles. The function is called with an
7311 article data structure as the only parameter.
7313 If, for instance, you wish to pre-fetch only unread articles shorter
7314 than 100 lines, you could say something like:
7317 (defun my-async-short-unread-p (data)
7318 "Return non-nil for short, unread articles."
7319 (and (gnus-data-unread-p data)
7320 (< (mail-header-lines (gnus-data-header data))
7323 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7326 These functions will be called many, many times, so they should
7327 preferably be short and sweet to avoid slowing down Gnus too much.
7328 It's probably a good idea to byte-compile things like this.
7330 @vindex gnus-prefetched-article-deletion-strategy
7331 Articles have to be removed from the asynch buffer sooner or later. The
7332 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7333 articles. This is a list that may contain the following elements:
7337 Remove articles when they are read.
7340 Remove articles when exiting the group.
7343 The default value is @code{(read exit)}.
7345 @c @vindex gnus-use-header-prefetch
7346 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7347 @c from the next group.
7350 @node Article Caching
7351 @section Article Caching
7352 @cindex article caching
7355 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7356 consider turning article caching on. Each article will then be stored
7357 locally under your home directory. As you may surmise, this could
7358 potentially use @emph{huge} amounts of disk space, as well as eat up all
7359 your inodes so fast it will make your head swim. In vodka.
7361 Used carefully, though, it could be just an easier way to save articles.
7363 @vindex gnus-use-long-file-name
7364 @vindex gnus-cache-directory
7365 @vindex gnus-use-cache
7366 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7367 all articles ticked or marked as dormant will then be copied
7368 over to your local cache (@code{gnus-cache-directory}). Whether this
7369 cache is flat or hierarchical is controlled by the
7370 @code{gnus-use-long-file-name} variable, as usual.
7372 When re-selecting a ticked or dormant article, it will be fetched from the
7373 cache instead of from the server. As articles in your cache will never
7374 expire, this might serve as a method of saving articles while still
7375 keeping them where they belong. Just mark all articles you want to save
7376 as dormant, and don't worry.
7378 When an article is marked as read, is it removed from the cache.
7380 @vindex gnus-cache-remove-articles
7381 @vindex gnus-cache-enter-articles
7382 The entering/removal of articles from the cache is controlled by the
7383 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7384 variables. Both are lists of symbols. The first is @code{(ticked
7385 dormant)} by default, meaning that ticked and dormant articles will be
7386 put in the cache. The latter is @code{(read)} by default, meaning that
7387 articles marked as read are removed from the cache. Possibly
7388 symbols in these two lists are @code{ticked}, @code{dormant},
7389 @code{unread} and @code{read}.
7391 @findex gnus-jog-cache
7392 So where does the massive article-fetching and storing come into the
7393 picture? The @code{gnus-jog-cache} command will go through all
7394 subscribed newsgroups, request all unread articles, score them, and
7395 store them in the cache. You should only ever, ever ever ever, use this
7396 command if 1) your connection to the @acronym{NNTP} server is really, really,
7397 really slow and 2) you have a really, really, really huge disk.
7398 Seriously. One way to cut down on the number of articles downloaded is
7399 to score unwanted articles down and have them marked as read. They will
7400 not then be downloaded by this command.
7402 @vindex gnus-uncacheable-groups
7403 @vindex gnus-cacheable-groups
7404 It is likely that you do not want caching on all groups. For instance,
7405 if your @code{nnml} mail is located under your home directory, it makes no
7406 sense to cache it somewhere else under your home directory. Unless you
7407 feel that it's neat to use twice as much space.
7409 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7410 regexp of groups to cache, @samp{^nntp} for instance, or set the
7411 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7412 Both variables are @code{nil} by default. If a group matches both
7413 variables, the group is not cached.
7415 @findex gnus-cache-generate-nov-databases
7416 @findex gnus-cache-generate-active
7417 @vindex gnus-cache-active-file
7418 The cache stores information on what articles it contains in its active
7419 file (@code{gnus-cache-active-file}). If this file (or any other parts
7420 of the cache) becomes all messed up for some reason or other, Gnus
7421 offers two functions that will try to set things right. @kbd{M-x
7422 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7423 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7426 @findex gnus-cache-move-cache
7427 @code{gnus-cache-move-cache} will move your whole
7428 @code{gnus-cache-directory} to some other location. You get asked to
7429 where, isn't that cool?
7431 @node Persistent Articles
7432 @section Persistent Articles
7433 @cindex persistent articles
7435 Closely related to article caching, we have @dfn{persistent articles}.
7436 In fact, it's just a different way of looking at caching, and much more
7437 useful in my opinion.
7439 Say you're reading a newsgroup, and you happen on to some valuable gem
7440 that you want to keep and treasure forever. You'd normally just save it
7441 (using one of the many saving commands) in some file. The problem with
7442 that is that it's just, well, yucky. Ideally you'd prefer just having
7443 the article remain in the group where you found it forever; untouched by
7444 the expiry going on at the news server.
7446 This is what a @dfn{persistent article} is---an article that just won't
7447 be deleted. It's implemented using the normal cache functions, but
7448 you use two explicit commands for managing persistent articles:
7454 @findex gnus-cache-enter-article
7455 Make the current article persistent (@code{gnus-cache-enter-article}).
7458 @kindex M-* (Summary)
7459 @findex gnus-cache-remove-article
7460 Remove the current article from the persistent articles
7461 (@code{gnus-cache-remove-article}). This will normally delete the
7465 Both these commands understand the process/prefix convention.
7467 To avoid having all ticked articles (and stuff) entered into the cache,
7468 you should set @code{gnus-use-cache} to @code{passive} if you're just
7469 interested in persistent articles:
7472 (setq gnus-use-cache 'passive)
7476 @node Article Backlog
7477 @section Article Backlog
7479 @cindex article backlog
7481 If you have a slow connection, but the idea of using caching seems
7482 unappealing to you (and it is, really), you can help the situation some
7483 by switching on the @dfn{backlog}. This is where Gnus will buffer
7484 already read articles so that it doesn't have to re-fetch articles
7485 you've already read. This only helps if you are in the habit of
7486 re-selecting articles you've recently read, of course. If you never do
7487 that, turning the backlog on will slow Gnus down a little bit, and
7488 increase memory usage some.
7490 @vindex gnus-keep-backlog
7491 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
7492 at most @var{n} old articles in a buffer for later re-fetching. If this
7493 variable is non-@code{nil} and is not a number, Gnus will store
7494 @emph{all} read articles, which means that your Emacs will grow without
7495 bound before exploding and taking your machine down with you. I put
7496 that in there just to keep y'all on your toes.
7498 The default value is 20.
7501 @node Saving Articles
7502 @section Saving Articles
7503 @cindex saving articles
7505 Gnus can save articles in a number of ways. Below is the documentation
7506 for saving articles in a fairly straight-forward fashion (i.e., little
7507 processing of the article is done before it is saved). For a different
7508 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7509 (@pxref{Decoding Articles}).
7511 For the commands listed here, the target is a file. If you want to
7512 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7513 command (@pxref{Mail Group Commands}).
7515 @vindex gnus-save-all-headers
7516 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
7517 unwanted headers before saving the article.
7519 @vindex gnus-saved-headers
7520 If the preceding variable is @code{nil}, all headers that match the
7521 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7522 deleted before saving.
7528 @kindex O o (Summary)
7530 @findex gnus-summary-save-article
7531 @c @icon{gnus-summary-save-article}
7532 Save the current article using the default article saver
7533 (@code{gnus-summary-save-article}).
7536 @kindex O m (Summary)
7537 @findex gnus-summary-save-article-mail
7538 Save the current article in a Unix mail box (mbox) file
7539 (@code{gnus-summary-save-article-mail}).
7542 @kindex O r (Summary)
7543 @findex gnus-summary-save-article-rmail
7544 Save the current article in Rmail format
7545 (@code{gnus-summary-save-article-rmail}).
7548 @kindex O f (Summary)
7549 @findex gnus-summary-save-article-file
7550 @c @icon{gnus-summary-save-article-file}
7551 Save the current article in plain file format
7552 (@code{gnus-summary-save-article-file}).
7555 @kindex O F (Summary)
7556 @findex gnus-summary-write-article-file
7557 Write the current article in plain file format, overwriting any previous
7558 file contents (@code{gnus-summary-write-article-file}).
7561 @kindex O b (Summary)
7562 @findex gnus-summary-save-article-body-file
7563 Save the current article body in plain file format
7564 (@code{gnus-summary-save-article-body-file}).
7567 @kindex O h (Summary)
7568 @findex gnus-summary-save-article-folder
7569 Save the current article in mh folder format
7570 (@code{gnus-summary-save-article-folder}).
7573 @kindex O v (Summary)
7574 @findex gnus-summary-save-article-vm
7575 Save the current article in a VM folder
7576 (@code{gnus-summary-save-article-vm}).
7580 @kindex O p (Summary)
7582 @findex gnus-summary-pipe-output
7583 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7584 the current article to a process (@code{gnus-summary-pipe-output}).
7585 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7586 complete headers in the piped output.
7589 @kindex O P (Summary)
7590 @findex gnus-summary-muttprint
7591 @vindex gnus-summary-muttprint-program
7592 Save the current article into muttprint. That is, print it using the
7593 external program @uref{http://muttprint.sourceforge.net/,
7594 Muttprint}. The program name and options to use is controlled by the
7595 variable @code{gnus-summary-muttprint-program}.
7596 (@code{gnus-summary-muttprint}).
7600 @vindex gnus-prompt-before-saving
7601 All these commands use the process/prefix convention
7602 (@pxref{Process/Prefix}). If you save bunches of articles using these
7603 functions, you might get tired of being prompted for files to save each
7604 and every article in. The prompting action is controlled by
7605 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7606 default, giving you that excessive prompting action you know and
7607 loathe. If you set this variable to @code{t} instead, you'll be prompted
7608 just once for each series of articles you save. If you like to really
7609 have Gnus do all your thinking for you, you can even set this variable
7610 to @code{nil}, which means that you will never be prompted for files to
7611 save articles in. Gnus will simply save all the articles in the default
7615 @vindex gnus-default-article-saver
7616 You can customize the @code{gnus-default-article-saver} variable to make
7617 Gnus do what you want it to. You can use any of the eight ready-made
7618 functions below, or you can create your own.
7622 @item gnus-summary-save-in-rmail
7623 @findex gnus-summary-save-in-rmail
7624 @vindex gnus-rmail-save-name
7625 @findex gnus-plain-save-name
7626 This is the default format, @dfn{Babyl}. Uses the function in the
7627 @code{gnus-rmail-save-name} variable to get a file name to save the
7628 article in. The default is @code{gnus-plain-save-name}.
7630 @item gnus-summary-save-in-mail
7631 @findex gnus-summary-save-in-mail
7632 @vindex gnus-mail-save-name
7633 Save in a Unix mail (mbox) file. Uses the function in the
7634 @code{gnus-mail-save-name} variable to get a file name to save the
7635 article in. The default is @code{gnus-plain-save-name}.
7637 @item gnus-summary-save-in-file
7638 @findex gnus-summary-save-in-file
7639 @vindex gnus-file-save-name
7640 @findex gnus-numeric-save-name
7641 Append the article straight to an ordinary file. Uses the function in
7642 the @code{gnus-file-save-name} variable to get a file name to save the
7643 article in. The default is @code{gnus-numeric-save-name}.
7645 @item gnus-summary-write-to-file
7646 @findex gnus-summary-write-to-file
7647 Write the article straight to an ordinary file. The file is
7648 overwritten if it exists. Uses the function in the
7649 @code{gnus-file-save-name} variable to get a file name to save the
7650 article in. The default is @code{gnus-numeric-save-name}.
7652 @item gnus-summary-save-body-in-file
7653 @findex gnus-summary-save-body-in-file
7654 Append the article body to an ordinary file. Uses the function in the
7655 @code{gnus-file-save-name} variable to get a file name to save the
7656 article in. The default is @code{gnus-numeric-save-name}.
7658 @item gnus-summary-write-body-to-file
7659 @findex gnus-summary-write-body-to-file
7660 Write the article body straight to an ordinary file. The file is
7661 overwritten if it exists. Uses the function in the
7662 @code{gnus-file-save-name} variable to get a file name to save the
7663 article in. The default is @code{gnus-numeric-save-name}.
7665 @item gnus-summary-save-in-folder
7666 @findex gnus-summary-save-in-folder
7667 @findex gnus-folder-save-name
7668 @findex gnus-Folder-save-name
7669 @vindex gnus-folder-save-name
7672 Save the article to an MH folder using @code{rcvstore} from the MH
7673 library. Uses the function in the @code{gnus-folder-save-name} variable
7674 to get a file name to save the article in. The default is
7675 @code{gnus-folder-save-name}, but you can also use
7676 @code{gnus-Folder-save-name}, which creates capitalized names.
7678 @item gnus-summary-save-in-vm
7679 @findex gnus-summary-save-in-vm
7680 Save the article in a VM folder. You have to have the VM mail
7681 reader to use this setting.
7684 The symbol of each function may have the following properties:
7688 The value non-@code{nil} means save decoded articles. This is
7689 meaningful only with @code{gnus-summary-save-in-file},
7690 @code{gnus-summary-save-body-in-file},
7691 @code{gnus-summary-write-to-file}, and
7692 @code{gnus-summary-write-body-to-file}.
7695 The value specifies an alternative function which appends, not
7696 overwrites, articles to a file. This implies that when saving many
7697 articles at a time, @code{gnus-prompt-before-saving} is bound to
7698 @code{t} and all articles are saved in a single file. This is
7699 meaningful only with @code{gnus-summary-write-to-file} and
7700 @code{gnus-summary-write-body-to-file}.
7703 The value specifies the symbol of a variable of which the value
7704 specifies headers to be saved. If it is omitted,
7705 @code{gnus-save-all-headers} and @code{gnus-saved-headers} control what
7706 headers should be saved.
7709 @vindex gnus-article-save-directory
7710 All of these functions, except for the last one, will save the article
7711 in the @code{gnus-article-save-directory}, which is initialized from the
7712 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7715 As you can see above, the functions use different functions to find a
7716 suitable name of a file to save the article in. Below is a list of
7717 available functions that generate names:
7721 @item gnus-Numeric-save-name
7722 @findex gnus-Numeric-save-name
7723 File names like @file{~/News/Alt.andrea-dworkin/45}.
7725 @item gnus-numeric-save-name
7726 @findex gnus-numeric-save-name
7727 File names like @file{~/News/alt.andrea-dworkin/45}.
7729 @item gnus-Plain-save-name
7730 @findex gnus-Plain-save-name
7731 File names like @file{~/News/Alt.andrea-dworkin}.
7733 @item gnus-plain-save-name
7734 @findex gnus-plain-save-name
7735 File names like @file{~/News/alt.andrea-dworkin}.
7737 @item gnus-sender-save-name
7738 @findex gnus-sender-save-name
7739 File names like @file{~/News/larsi}.
7742 @vindex gnus-split-methods
7743 You can have Gnus suggest where to save articles by plonking a regexp into
7744 the @code{gnus-split-methods} alist. For instance, if you would like to
7745 save articles related to Gnus in the file @file{gnus-stuff}, and articles
7746 related to VM in @file{vm-stuff}, you could set this variable to something
7750 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7751 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7752 (my-choosing-function "../other-dir/my-stuff")
7753 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7756 We see that this is a list where each element is a list that has two
7757 elements---the @dfn{match} and the @dfn{file}. The match can either be
7758 a string (in which case it is used as a regexp to match on the article
7759 head); it can be a symbol (which will be called as a function with the
7760 group name as a parameter); or it can be a list (which will be
7761 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7762 the @dfn{file} will be used as a default prompt. In addition, the
7763 result of the operation itself will be used if the function or form
7764 called returns a string or a list of strings.
7766 You basically end up with a list of file names that might be used when
7767 saving the current article. (All ``matches'' will be used.) You will
7768 then be prompted for what you really want to use as a name, with file
7769 name completion over the results from applying this variable.
7771 This variable is @code{((gnus-article-archive-name))} by default, which
7772 means that Gnus will look at the articles it saves for an
7773 @code{Archive-name} line and use that as a suggestion for the file
7776 Here's an example function to clean up file names somewhat. If you have
7777 lots of mail groups called things like
7778 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7779 these group names before creating the file name to save to. The
7780 following will do just that:
7783 (defun my-save-name (group)
7784 (when (string-match "^nnml:mail." group)
7785 (substring group (match-end 0))))
7787 (setq gnus-split-methods
7788 '((gnus-article-archive-name)
7793 @vindex gnus-use-long-file-name
7794 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7795 @code{nil}, all the preceding functions will replace all periods
7796 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7797 the functions will generate hierarchies of directories instead of having
7798 all the files in the top level directory
7799 (@file{~/News/alt/andrea-dworkin} instead of
7800 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7801 on most systems. However, for historical reasons, this is @code{nil} on
7802 Xenix and usg-unix-v machines by default.
7804 This function also affects kill and score file names. If this variable
7805 is a list, and the list contains the element @code{not-score}, long file
7806 names will not be used for score files, if it contains the element
7807 @code{not-save}, long file names will not be used for saving, and if it
7808 contains the element @code{not-kill}, long file names will not be used
7811 If you'd like to save articles in a hierarchy that looks something like
7815 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
7816 (setq gnus-default-article-saver
7817 'gnus-summary-save-in-file) ; @r{no encoding}
7820 Then just save with @kbd{o}. You'd then read this hierarchy with
7821 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7822 the top level directory as the argument (@file{~/News/}). Then just walk
7823 around to the groups/directories with @code{nneething}.
7826 @node Decoding Articles
7827 @section Decoding Articles
7828 @cindex decoding articles
7830 Sometime users post articles (or series of articles) that have been
7831 encoded in some way or other. Gnus can decode them for you.
7834 * Uuencoded Articles:: Uudecode articles.
7835 * Shell Archives:: Unshar articles.
7836 * PostScript Files:: Split PostScript.
7837 * Other Files:: Plain save and binhex.
7838 * Decoding Variables:: Variables for a happy decoding.
7839 * Viewing Files:: You want to look at the result of the decoding?
7843 @cindex article series
7844 All these functions use the process/prefix convention
7845 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7846 the extension that a ``single article'' means ``a single series''. Gnus
7847 can find out by itself what articles belong to a series, decode all the
7848 articles and unpack/view/save the resulting file(s).
7850 Gnus guesses what articles are in the series according to the following
7851 simplish rule: The subjects must be (nearly) identical, except for the
7852 last two numbers of the line. (Spaces are largely ignored, however.)
7854 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
7855 will find all the articles that match the regexp @samp{^cat.gif
7856 ([0-9]+/[0-9]+).*$}.
7858 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7859 series}, will not be properly recognized by any of the automatic viewing
7860 commands, and you have to mark the articles manually with @kbd{#}.
7863 @node Uuencoded Articles
7864 @subsection Uuencoded Articles
7866 @cindex uuencoded articles
7871 @kindex X u (Summary)
7872 @findex gnus-uu-decode-uu
7873 @c @icon{gnus-uu-decode-uu}
7874 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7877 @kindex X U (Summary)
7878 @findex gnus-uu-decode-uu-and-save
7879 Uudecodes and saves the current series
7880 (@code{gnus-uu-decode-uu-and-save}).
7883 @kindex X v u (Summary)
7884 @findex gnus-uu-decode-uu-view
7885 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7888 @kindex X v U (Summary)
7889 @findex gnus-uu-decode-uu-and-save-view
7890 Uudecodes, views and saves the current series
7891 (@code{gnus-uu-decode-uu-and-save-view}).
7895 Remember that these all react to the presence of articles marked with
7896 the process mark. If, for instance, you'd like to decode and save an
7897 entire newsgroup, you'd typically do @kbd{M P a}
7898 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7899 (@code{gnus-uu-decode-uu-and-save}).
7901 All this is very much different from how @code{gnus-uu} worked with
7902 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7903 the sun. This version of @code{gnus-uu} generally assumes that you mark
7904 articles in some way (@pxref{Setting Process Marks}) and then press
7907 @vindex gnus-uu-notify-files
7908 Note: When trying to decode articles that have names matching
7909 @code{gnus-uu-notify-files}, which is hard-coded to
7910 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7911 automatically post an article on @samp{comp.unix.wizards} saying that
7912 you have just viewed the file in question. This feature can't be turned
7916 @node Shell Archives
7917 @subsection Shell Archives
7919 @cindex shell archives
7920 @cindex shared articles
7922 Shell archives (``shar files'') used to be a popular way to distribute
7923 sources, but it isn't used all that much today. In any case, we have
7924 some commands to deal with these:
7929 @kindex X s (Summary)
7930 @findex gnus-uu-decode-unshar
7931 Unshars the current series (@code{gnus-uu-decode-unshar}).
7934 @kindex X S (Summary)
7935 @findex gnus-uu-decode-unshar-and-save
7936 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7939 @kindex X v s (Summary)
7940 @findex gnus-uu-decode-unshar-view
7941 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7944 @kindex X v S (Summary)
7945 @findex gnus-uu-decode-unshar-and-save-view
7946 Unshars, views and saves the current series
7947 (@code{gnus-uu-decode-unshar-and-save-view}).
7951 @node PostScript Files
7952 @subsection PostScript Files
7958 @kindex X p (Summary)
7959 @findex gnus-uu-decode-postscript
7960 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7963 @kindex X P (Summary)
7964 @findex gnus-uu-decode-postscript-and-save
7965 Unpack and save the current PostScript series
7966 (@code{gnus-uu-decode-postscript-and-save}).
7969 @kindex X v p (Summary)
7970 @findex gnus-uu-decode-postscript-view
7971 View the current PostScript series
7972 (@code{gnus-uu-decode-postscript-view}).
7975 @kindex X v P (Summary)
7976 @findex gnus-uu-decode-postscript-and-save-view
7977 View and save the current PostScript series
7978 (@code{gnus-uu-decode-postscript-and-save-view}).
7983 @subsection Other Files
7987 @kindex X o (Summary)
7988 @findex gnus-uu-decode-save
7989 Save the current series
7990 (@code{gnus-uu-decode-save}).
7993 @kindex X b (Summary)
7994 @findex gnus-uu-decode-binhex
7995 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7996 doesn't really work yet.
8000 @node Decoding Variables
8001 @subsection Decoding Variables
8003 Adjective, not verb.
8006 * Rule Variables:: Variables that say how a file is to be viewed.
8007 * Other Decode Variables:: Other decode variables.
8008 * Uuencoding and Posting:: Variables for customizing uuencoding.
8012 @node Rule Variables
8013 @subsubsection Rule Variables
8014 @cindex rule variables
8016 Gnus uses @dfn{rule variables} to decide how to view a file. All these
8017 variables are of the form
8020 (list '(regexp1 command2)
8027 @item gnus-uu-user-view-rules
8028 @vindex gnus-uu-user-view-rules
8030 This variable is consulted first when viewing files. If you wish to use,
8031 for instance, @code{sox} to convert an @file{.au} sound file, you could
8034 (setq gnus-uu-user-view-rules
8035 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
8038 @item gnus-uu-user-view-rules-end
8039 @vindex gnus-uu-user-view-rules-end
8040 This variable is consulted if Gnus couldn't make any matches from the
8041 user and default view rules.
8043 @item gnus-uu-user-archive-rules
8044 @vindex gnus-uu-user-archive-rules
8045 This variable can be used to say what commands should be used to unpack
8050 @node Other Decode Variables
8051 @subsubsection Other Decode Variables
8054 @vindex gnus-uu-grabbed-file-functions
8056 @item gnus-uu-grabbed-file-functions
8057 All functions in this list will be called right after each file has been
8058 successfully decoded---so that you can move or view files right away,
8059 and don't have to wait for all files to be decoded before you can do
8060 anything. Ready-made functions you can put in this list are:
8064 @item gnus-uu-grab-view
8065 @findex gnus-uu-grab-view
8068 @item gnus-uu-grab-move
8069 @findex gnus-uu-grab-move
8070 Move the file (if you're using a saving function.)
8073 @item gnus-uu-be-dangerous
8074 @vindex gnus-uu-be-dangerous
8075 Specifies what to do if unusual situations arise during decoding. If
8076 @code{nil}, be as conservative as possible. If @code{t}, ignore things
8077 that didn't work, and overwrite existing files. Otherwise, ask each
8080 @item gnus-uu-ignore-files-by-name
8081 @vindex gnus-uu-ignore-files-by-name
8082 Files with name matching this regular expression won't be viewed.
8084 @item gnus-uu-ignore-files-by-type
8085 @vindex gnus-uu-ignore-files-by-type
8086 Files with a @acronym{MIME} type matching this variable won't be viewed.
8087 Note that Gnus tries to guess what type the file is based on the name.
8088 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
8091 @item gnus-uu-tmp-dir
8092 @vindex gnus-uu-tmp-dir
8093 Where @code{gnus-uu} does its work.
8095 @item gnus-uu-do-not-unpack-archives
8096 @vindex gnus-uu-do-not-unpack-archives
8097 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
8098 looking for files to display.
8100 @item gnus-uu-view-and-save
8101 @vindex gnus-uu-view-and-save
8102 Non-@code{nil} means that the user will always be asked to save a file
8105 @item gnus-uu-ignore-default-view-rules
8106 @vindex gnus-uu-ignore-default-view-rules
8107 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
8110 @item gnus-uu-ignore-default-archive-rules
8111 @vindex gnus-uu-ignore-default-archive-rules
8112 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
8115 @item gnus-uu-kill-carriage-return
8116 @vindex gnus-uu-kill-carriage-return
8117 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
8120 @item gnus-uu-unmark-articles-not-decoded
8121 @vindex gnus-uu-unmark-articles-not-decoded
8122 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
8123 decoded articles as unread.
8125 @item gnus-uu-correct-stripped-uucode
8126 @vindex gnus-uu-correct-stripped-uucode
8127 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
8128 uuencoded files that have had trailing spaces deleted.
8130 @item gnus-uu-pre-uudecode-hook
8131 @vindex gnus-uu-pre-uudecode-hook
8132 Hook run before sending a message to @code{uudecode}.
8134 @item gnus-uu-view-with-metamail
8135 @vindex gnus-uu-view-with-metamail
8137 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
8138 commands defined by the rule variables and just fudge a @acronym{MIME}
8139 content type based on the file name. The result will be fed to
8140 @code{metamail} for viewing.
8142 @item gnus-uu-save-in-digest
8143 @vindex gnus-uu-save-in-digest
8144 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
8145 decoding, will save in digests. If this variable is @code{nil},
8146 @code{gnus-uu} will just save everything in a file without any
8147 embellishments. The digesting almost conforms to RFC 1153---no easy way
8148 to specify any meaningful volume and issue numbers were found, so I
8149 simply dropped them.
8154 @node Uuencoding and Posting
8155 @subsubsection Uuencoding and Posting
8159 @item gnus-uu-post-include-before-composing
8160 @vindex gnus-uu-post-include-before-composing
8161 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
8162 before you compose the article. If this variable is @code{t}, you can
8163 either include an encoded file with @kbd{C-c C-i} or have one included
8164 for you when you post the article.
8166 @item gnus-uu-post-length
8167 @vindex gnus-uu-post-length
8168 Maximum length of an article. The encoded file will be split into how
8169 many articles it takes to post the entire file.
8171 @item gnus-uu-post-threaded
8172 @vindex gnus-uu-post-threaded
8173 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
8174 thread. This may not be smart, as no other decoder I have seen is able
8175 to follow threads when collecting uuencoded articles. (Well, I have
8176 seen one package that does that---@code{gnus-uu}, but somehow, I don't
8177 think that counts@dots{}) Default is @code{nil}.
8179 @item gnus-uu-post-separate-description
8180 @vindex gnus-uu-post-separate-description
8181 Non-@code{nil} means that the description will be posted in a separate
8182 article. The first article will typically be numbered (0/x). If this
8183 variable is @code{nil}, the description the user enters will be included
8184 at the beginning of the first article, which will be numbered (1/x).
8185 Default is @code{t}.
8191 @subsection Viewing Files
8192 @cindex viewing files
8193 @cindex pseudo-articles
8195 After decoding, if the file is some sort of archive, Gnus will attempt
8196 to unpack the archive and see if any of the files in the archive can be
8197 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
8198 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
8199 uncompress and de-tar the main file, and then view the two pictures.
8200 This unpacking process is recursive, so if the archive contains archives
8201 of archives, it'll all be unpacked.
8203 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
8204 extracted file into the summary buffer. If you go to these
8205 ``articles'', you will be prompted for a command to run (usually Gnus
8206 will make a suggestion), and then the command will be run.
8208 @vindex gnus-view-pseudo-asynchronously
8209 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
8210 until the viewing is done before proceeding.
8212 @vindex gnus-view-pseudos
8213 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8214 the pseudo-articles into the summary buffer, but view them
8215 immediately. If this variable is @code{not-confirm}, the user won't even
8216 be asked for a confirmation before viewing is done.
8218 @vindex gnus-view-pseudos-separately
8219 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8220 pseudo-article will be created for each file to be viewed. If
8221 @code{nil}, all files that use the same viewing command will be given as
8222 a list of parameters to that command.
8224 @vindex gnus-insert-pseudo-articles
8225 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8226 pseudo-articles when decoding. It is @code{t} by default.
8228 So; there you are, reading your @emph{pseudo-articles} in your
8229 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8230 Why isn't anything real anymore? How did we get here?
8233 @node Article Treatment
8234 @section Article Treatment
8236 Reading through this huge manual, you may have quite forgotten that the
8237 object of newsreaders is to actually, like, read what people have
8238 written. Reading articles. Unfortunately, people are quite bad at
8239 writing, so there are tons of functions and variables to make reading
8240 these articles easier.
8243 * Article Highlighting:: You want to make the article look like fruit salad.
8244 * Article Fontisizing:: Making emphasized text look nice.
8245 * Article Hiding:: You also want to make certain info go away.
8246 * Article Washing:: Lots of way-neat functions to make life better.
8247 * Article Header:: Doing various header transformations.
8248 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8249 * Article Button Levels:: Controlling appearance of buttons.
8250 * Article Date:: Grumble, UT!
8251 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8252 * Article Signature:: What is a signature?
8253 * Article Miscellanea:: Various other stuff.
8257 @node Article Highlighting
8258 @subsection Article Highlighting
8259 @cindex highlighting
8261 Not only do you want your article buffer to look like fruit salad, but
8262 you want it to look like technicolor fruit salad.
8267 @kindex W H a (Summary)
8268 @findex gnus-article-highlight
8269 @findex gnus-article-maybe-highlight
8270 Do much highlighting of the current article
8271 (@code{gnus-article-highlight}). This function highlights header, cited
8272 text, the signature, and adds buttons to the body and the head.
8275 @kindex W H h (Summary)
8276 @findex gnus-article-highlight-headers
8277 @vindex gnus-header-face-alist
8278 Highlight the headers (@code{gnus-article-highlight-headers}). The
8279 highlighting will be done according to the @code{gnus-header-face-alist}
8280 variable, which is a list where each element has the form
8281 @code{(@var{regexp} @var{name} @var{content})}.
8282 @var{regexp} is a regular expression for matching the
8283 header, @var{name} is the face used for highlighting the header name
8284 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8285 the header value. The first match made will be used. Note that
8286 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8289 @kindex W H c (Summary)
8290 @findex gnus-article-highlight-citation
8291 Highlight cited text (@code{gnus-article-highlight-citation}).
8293 Some variables to customize the citation highlights:
8296 @vindex gnus-cite-parse-max-size
8298 @item gnus-cite-parse-max-size
8299 If the article size in bytes is bigger than this variable (which is
8300 25000 by default), no citation highlighting will be performed.
8302 @item gnus-cite-max-prefix
8303 @vindex gnus-cite-max-prefix
8304 Maximum possible length for a citation prefix (default 20).
8306 @item gnus-cite-face-list
8307 @vindex gnus-cite-face-list
8308 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8309 When there are citations from multiple articles in the same message,
8310 Gnus will try to give each citation from each article its own face.
8311 This should make it easier to see who wrote what.
8313 @item gnus-supercite-regexp
8314 @vindex gnus-supercite-regexp
8315 Regexp matching normal Supercite attribution lines.
8317 @item gnus-supercite-secondary-regexp
8318 @vindex gnus-supercite-secondary-regexp
8319 Regexp matching mangled Supercite attribution lines.
8321 @item gnus-cite-minimum-match-count
8322 @vindex gnus-cite-minimum-match-count
8323 Minimum number of identical prefixes we have to see before we believe
8324 that it's a citation.
8326 @item gnus-cite-attribution-prefix
8327 @vindex gnus-cite-attribution-prefix
8328 Regexp matching the beginning of an attribution line.
8330 @item gnus-cite-attribution-suffix
8331 @vindex gnus-cite-attribution-suffix
8332 Regexp matching the end of an attribution line.
8334 @item gnus-cite-attribution-face
8335 @vindex gnus-cite-attribution-face
8336 Face used for attribution lines. It is merged with the face for the
8337 cited text belonging to the attribution.
8339 @item gnus-cite-ignore-quoted-from
8340 @vindex gnus-cite-ignore-quoted-from
8341 If non-@code{nil}, no citation highlighting will be performed on lines
8342 beginning with @samp{>From }. Those lines may have been quoted by MTAs
8343 in order not to mix up with the envelope From line. The default value
8350 @kindex W H s (Summary)
8351 @vindex gnus-signature-separator
8352 @vindex gnus-signature-face
8353 @findex gnus-article-highlight-signature
8354 Highlight the signature (@code{gnus-article-highlight-signature}).
8355 Everything after @code{gnus-signature-separator} (@pxref{Article
8356 Signature}) in an article will be considered a signature and will be
8357 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8362 @xref{Customizing Articles}, for how to highlight articles automatically.
8365 @node Article Fontisizing
8366 @subsection Article Fontisizing
8368 @cindex article emphasis
8370 @findex gnus-article-emphasize
8371 @kindex W e (Summary)
8372 People commonly add emphasis to words in news articles by writing things
8373 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8374 this look nicer by running the article through the @kbd{W e}
8375 (@code{gnus-article-emphasize}) command.
8377 @vindex gnus-emphasis-alist
8378 How the emphasis is computed is controlled by the
8379 @code{gnus-emphasis-alist} variable. This is an alist where the first
8380 element is a regular expression to be matched. The second is a number
8381 that says what regular expression grouping is used to find the entire
8382 emphasized word. The third is a number that says what regexp grouping
8383 should be displayed and highlighted. (The text between these two
8384 groupings will be hidden.) The fourth is the face used for
8388 (setq gnus-emphasis-alist
8389 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8390 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8399 @vindex gnus-emphasis-underline
8400 @vindex gnus-emphasis-bold
8401 @vindex gnus-emphasis-italic
8402 @vindex gnus-emphasis-underline-bold
8403 @vindex gnus-emphasis-underline-italic
8404 @vindex gnus-emphasis-bold-italic
8405 @vindex gnus-emphasis-underline-bold-italic
8406 By default, there are seven rules, and they use the following faces:
8407 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8408 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8409 @code{gnus-emphasis-underline-italic},
8410 @code{gnus-emphasis-underline-bold}, and
8411 @code{gnus-emphasis-underline-bold-italic}.
8413 If you want to change these faces, you can either use @kbd{M-x
8414 customize}, or you can use @code{copy-face}. For instance, if you want
8415 to make @code{gnus-emphasis-italic} use a red face instead, you could
8419 (copy-face 'red 'gnus-emphasis-italic)
8422 @vindex gnus-group-highlight-words-alist
8424 If you want to highlight arbitrary words, you can use the
8425 @code{gnus-group-highlight-words-alist} variable, which uses the same
8426 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8427 parameter (@pxref{Group Parameters}) can also be used.
8429 @xref{Customizing Articles}, for how to fontize articles automatically.
8432 @node Article Hiding
8433 @subsection Article Hiding
8434 @cindex article hiding
8436 Or rather, hiding certain things in each article. There usually is much
8437 too much cruft in most articles.
8442 @kindex W W a (Summary)
8443 @findex gnus-article-hide
8444 Do quite a lot of hiding on the article buffer
8445 (@kbd{gnus-article-hide}). In particular, this function will hide
8446 headers, @acronym{PGP}, cited text and the signature.
8449 @kindex W W h (Summary)
8450 @findex gnus-article-hide-headers
8451 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8455 @kindex W W b (Summary)
8456 @findex gnus-article-hide-boring-headers
8457 Hide headers that aren't particularly interesting
8458 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8461 @kindex W W s (Summary)
8462 @findex gnus-article-hide-signature
8463 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8467 @kindex W W l (Summary)
8468 @findex gnus-article-hide-list-identifiers
8469 @vindex gnus-list-identifiers
8470 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8471 are strings some mailing list servers add to the beginning of all
8472 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8473 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8474 may not contain @code{\\(..\\)}.
8478 @item gnus-list-identifiers
8479 @vindex gnus-list-identifiers
8480 A regular expression that matches list identifiers to be removed from
8481 subject. This can also be a list of regular expressions.
8486 @kindex W W P (Summary)
8487 @findex gnus-article-hide-pem
8488 Hide @acronym{PEM} (privacy enhanced messages) cruft
8489 (@code{gnus-article-hide-pem}).
8492 @kindex W W B (Summary)
8493 @findex gnus-article-strip-banner
8494 @vindex gnus-article-banner-alist
8495 @vindex gnus-article-address-banner-alist
8498 @cindex stripping advertisements
8499 @cindex advertisements
8500 Strip the banner specified by the @code{banner} group parameter
8501 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8502 annoying banners and/or signatures that some mailing lists and moderated
8503 groups adds to all the messages. The way to use this function is to add
8504 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8505 group you want banners stripped from. The parameter either be a string,
8506 which will be interpreted as a regular expression matching text to be
8507 removed, or the symbol @code{signature}, meaning that the (last)
8508 signature should be removed, or other symbol, meaning that the
8509 corresponding regular expression in @code{gnus-article-banner-alist} is
8512 Regardless of a group, you can hide things like advertisements only when
8513 the sender of an article has a certain mail address specified in
8514 @code{gnus-article-address-banner-alist}.
8518 @item gnus-article-address-banner-alist
8519 @vindex gnus-article-address-banner-alist
8520 Alist of mail addresses and banners. Each element has the form
8521 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8522 matching a mail address in the From header, @var{banner} is one of a
8523 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8524 a regexp and @code{nil}. If @var{address} matches author's mail
8525 address, it will remove things like advertisements. For example, if a
8526 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8527 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8528 sends, you can use the following element to remove them:
8531 ("@@yoo-hoo\\.co\\.jp\\'" .
8532 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8538 @kindex W W c (Summary)
8539 @findex gnus-article-hide-citation
8540 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8541 customizing the hiding:
8545 @item gnus-cited-opened-text-button-line-format
8546 @itemx gnus-cited-closed-text-button-line-format
8547 @vindex gnus-cited-closed-text-button-line-format
8548 @vindex gnus-cited-opened-text-button-line-format
8549 Gnus adds buttons to show where the cited text has been hidden, and to
8550 allow toggle hiding the text. The format of the variable is specified
8551 by these format-like variable (@pxref{Formatting Variables}). These
8556 Starting point of the hidden text.
8558 Ending point of the hidden text.
8560 Number of characters in the hidden region.
8562 Number of lines of hidden text.
8565 @item gnus-cited-lines-visible
8566 @vindex gnus-cited-lines-visible
8567 The number of lines at the beginning of the cited text to leave
8568 shown. This can also be a cons cell with the number of lines at the top
8569 and bottom of the text, respectively, to remain visible.
8574 @kindex W W C-c (Summary)
8575 @findex gnus-article-hide-citation-maybe
8577 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8578 following two variables:
8581 @item gnus-cite-hide-percentage
8582 @vindex gnus-cite-hide-percentage
8583 If the cited text is of a bigger percentage than this variable (default
8584 50), hide the cited text.
8586 @item gnus-cite-hide-absolute
8587 @vindex gnus-cite-hide-absolute
8588 The cited text must have at least this length (default 10) before it
8593 @kindex W W C (Summary)
8594 @findex gnus-article-hide-citation-in-followups
8595 Hide cited text in articles that aren't roots
8596 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8597 useful as an interactive command, but might be a handy function to stick
8598 have happen automatically (@pxref{Customizing Articles}).
8602 All these ``hiding'' commands are toggles, but if you give a negative
8603 prefix to these commands, they will show what they have previously
8604 hidden. If you give a positive prefix, they will always hide.
8606 Also @pxref{Article Highlighting} for further variables for
8607 citation customization.
8609 @xref{Customizing Articles}, for how to hide article elements
8613 @node Article Washing
8614 @subsection Article Washing
8616 @cindex article washing
8618 We call this ``article washing'' for a really good reason. Namely, the
8619 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8621 @dfn{Washing} is defined by us as ``changing something from something to
8622 something else'', but normally results in something looking better.
8625 @xref{Customizing Articles}, if you want to change how Gnus displays
8626 articles by default.
8631 This is not really washing, it's sort of the opposite of washing. If
8632 you type this, you see the article exactly as it exists on disk or on
8636 Force redisplaying of the current article
8637 (@code{gnus-summary-show-article}). This is also not really washing.
8638 If you type this, you see the article without any previously applied
8639 interactive Washing functions but with all default treatments
8640 (@pxref{Customizing Articles}).
8643 @kindex W l (Summary)
8644 @findex gnus-summary-stop-page-breaking
8645 Remove page breaks from the current article
8646 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8650 @kindex W r (Summary)
8651 @findex gnus-summary-caesar-message
8652 @c @icon{gnus-summary-caesar-message}
8653 Do a Caesar rotate (rot13) on the article buffer
8654 (@code{gnus-summary-caesar-message}).
8655 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8656 (Typically offensive jokes and such.)
8658 It's commonly called ``rot13'' because each letter is rotated 13
8659 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8660 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8661 is rumored to have employed this form of, uh, somewhat weak encryption.
8664 @kindex W m (Summary)
8665 @findex gnus-summary-morse-message
8666 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8669 @kindex W i (Summary)
8670 @findex gnus-summary-idna-message
8671 Decode IDNA encoded domain names in the current articles. IDNA
8672 encoded domain names looks like @samp{xn--bar}. If a string remain
8673 unencoded after running invoking this, it is likely an invalid IDNA
8674 string (@samp{xn--bar} is invalid). You must have GNU Libidn
8675 (@url{http://www.gnu.org/software/libidn/}) installed for this command
8680 @kindex W t (Summary)
8682 @findex gnus-summary-toggle-header
8683 Toggle whether to display all headers in the article buffer
8684 (@code{gnus-summary-toggle-header}).
8687 @kindex W v (Summary)
8688 @findex gnus-summary-verbose-headers
8689 Toggle whether to display all headers in the article buffer permanently
8690 (@code{gnus-summary-verbose-headers}).
8693 @kindex W o (Summary)
8694 @findex gnus-article-treat-overstrike
8695 Treat overstrike (@code{gnus-article-treat-overstrike}).
8698 @kindex W d (Summary)
8699 @findex gnus-article-treat-dumbquotes
8700 @vindex gnus-article-dumbquotes-map
8702 @cindex M****s*** sm*rtq**t*s
8704 Treat M****s*** sm*rtq**t*s according to
8705 @code{gnus-article-dumbquotes-map}
8706 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8707 whether a character is a sm*rtq**t* or not, so it should only be used
8710 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8711 an attempt to provide more quoting characters. If you see something
8712 like @code{\222} or @code{\264} where you're expecting some kind of
8713 apostrophe or quotation mark, then try this wash.
8716 @kindex W Y f (Summary)
8717 @findex gnus-article-outlook-deuglify-article
8718 @cindex Outlook Express
8719 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8720 unwrap lines, repair attribution and rearrange citation.
8721 (@code{gnus-article-outlook-deuglify-article}).
8724 @kindex W Y u (Summary)
8725 @findex gnus-article-outlook-unwrap-lines
8726 @vindex gnus-outlook-deuglify-unwrap-min
8727 @vindex gnus-outlook-deuglify-unwrap-max
8728 Unwrap lines that appear to be wrapped citation lines. You can control
8729 what lines will be unwrapped by frobbing
8730 @code{gnus-outlook-deuglify-unwrap-min} and
8731 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8732 maximum length of an unwrapped citation line.
8733 (@code{gnus-article-outlook-unwrap-lines}).
8736 @kindex W Y a (Summary)
8737 @findex gnus-article-outlook-repair-attribution
8738 Repair a broken attribution line.@*
8739 (@code{gnus-article-outlook-repair-attribution}).
8742 @kindex W Y c (Summary)
8743 @findex gnus-article-outlook-rearrange-citation
8744 Repair broken citations by rearranging the text.
8745 (@code{gnus-article-outlook-rearrange-citation}).
8748 @kindex W w (Summary)
8749 @findex gnus-article-fill-cited-article
8750 Do word wrap (@code{gnus-article-fill-cited-article}).
8752 You can give the command a numerical prefix to specify the width to use
8756 @kindex W Q (Summary)
8757 @findex gnus-article-fill-long-lines
8758 Fill long lines (@code{gnus-article-fill-long-lines}).
8761 @kindex W C (Summary)
8762 @findex gnus-article-capitalize-sentences
8763 Capitalize the first word in each sentence
8764 (@code{gnus-article-capitalize-sentences}).
8767 @kindex W c (Summary)
8768 @findex gnus-article-remove-cr
8769 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8770 (this takes care of DOS line endings), and then translate any remaining
8771 CRs into LF (this takes care of Mac line endings)
8772 (@code{gnus-article-remove-cr}).
8775 @kindex W q (Summary)
8776 @findex gnus-article-de-quoted-unreadable
8777 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8778 Quoted-Printable is one common @acronym{MIME} encoding employed when
8779 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8780 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
8781 which doesn't look very readable to me. Note that this is usually
8782 done automatically by Gnus if the message in question has a
8783 @code{Content-Transfer-Encoding} header that says that this encoding
8784 has been done. If a prefix is given, a charset will be asked for.
8787 @kindex W 6 (Summary)
8788 @findex gnus-article-de-base64-unreadable
8789 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8790 one common @acronym{MIME} encoding employed when sending
8791 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8792 usually done automatically by Gnus if the message in question has a
8793 @code{Content-Transfer-Encoding} header that says that this encoding
8794 has been done. If a prefix is given, a charset will be asked for.
8797 @kindex W Z (Summary)
8798 @findex gnus-article-decode-HZ
8799 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8800 common encoding employed when sending Chinese articles. It typically
8801 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8804 @kindex W A (Summary)
8805 @findex gnus-article-treat-ansi-sequences
8806 @cindex @acronym{ANSI} control sequences
8807 Translate @acronym{ANSI} SGR control sequences into overlays or
8808 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
8809 sequences are used in some Chinese hierarchies for highlighting.
8812 @kindex W u (Summary)
8813 @findex gnus-article-unsplit-urls
8814 Remove newlines from within URLs. Some mailers insert newlines into
8815 outgoing email messages to keep lines short. This reformatting can
8816 split long URLs onto multiple lines. Repair those URLs by removing
8817 the newlines (@code{gnus-article-unsplit-urls}).
8820 @kindex W h (Summary)
8821 @findex gnus-article-wash-html
8822 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
8823 usually done automatically by Gnus if the message in question has a
8824 @code{Content-Type} header that says that the message is @acronym{HTML}.
8826 If a prefix is given, a charset will be asked for. If it is a number,
8827 the charset defined in @code{gnus-summary-show-article-charset-alist}
8828 (@pxref{Paging the Article}) will be used.
8830 @vindex gnus-article-wash-function
8831 The default is to use the function specified by
8832 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
8833 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8834 @acronym{HTML}, but this is controlled by the
8835 @code{gnus-article-wash-function} variable. Pre-defined functions you
8843 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
8845 @item w3m-standalone
8846 Use @uref{http://w3m.sourceforge.net/, w3m}.
8849 Use @uref{http://links.sf.net/, Links}.
8852 Use @uref{http://lynx.isc.org/, Lynx}.
8855 Use html2text---a simple @acronym{HTML} converter included with Gnus.
8860 @kindex W b (Summary)
8861 @findex gnus-article-add-buttons
8862 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8863 @xref{Article Buttons}.
8866 @kindex W B (Summary)
8867 @findex gnus-article-add-buttons-to-head
8868 Add clickable buttons to the article headers
8869 (@code{gnus-article-add-buttons-to-head}).
8872 @kindex W p (Summary)
8873 @findex gnus-article-verify-x-pgp-sig
8874 Verify a signed control message
8875 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
8876 @code{newgroup} and @code{checkgroups} are usually signed by the
8877 hierarchy maintainer. You need to add the @acronym{PGP} public key of
8878 the maintainer to your keyring to verify the
8879 message.@footnote{@acronym{PGP} keys for many hierarchies are
8880 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8883 @kindex W s (Summary)
8884 @findex gnus-summary-force-verify-and-decrypt
8885 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
8886 @acronym{S/MIME}) message
8887 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8890 @kindex W a (Summary)
8891 @findex gnus-article-strip-headers-in-body
8892 Strip headers like the @code{X-No-Archive} header from the beginning of
8893 article bodies (@code{gnus-article-strip-headers-in-body}).
8896 @kindex W E l (Summary)
8897 @findex gnus-article-strip-leading-blank-lines
8898 Remove all blank lines from the beginning of the article
8899 (@code{gnus-article-strip-leading-blank-lines}).
8902 @kindex W E m (Summary)
8903 @findex gnus-article-strip-multiple-blank-lines
8904 Replace all blank lines with empty lines and then all multiple empty
8905 lines with a single empty line.
8906 (@code{gnus-article-strip-multiple-blank-lines}).
8909 @kindex W E t (Summary)
8910 @findex gnus-article-remove-trailing-blank-lines
8911 Remove all blank lines at the end of the article
8912 (@code{gnus-article-remove-trailing-blank-lines}).
8915 @kindex W E a (Summary)
8916 @findex gnus-article-strip-blank-lines
8917 Do all the three commands above
8918 (@code{gnus-article-strip-blank-lines}).
8921 @kindex W E A (Summary)
8922 @findex gnus-article-strip-all-blank-lines
8923 Remove all blank lines
8924 (@code{gnus-article-strip-all-blank-lines}).
8927 @kindex W E s (Summary)
8928 @findex gnus-article-strip-leading-space
8929 Remove all white space from the beginning of all lines of the article
8930 body (@code{gnus-article-strip-leading-space}).
8933 @kindex W E e (Summary)
8934 @findex gnus-article-strip-trailing-space
8935 Remove all white space from the end of all lines of the article
8936 body (@code{gnus-article-strip-trailing-space}).
8940 @xref{Customizing Articles}, for how to wash articles automatically.
8943 @node Article Header
8944 @subsection Article Header
8946 These commands perform various transformations of article header.
8951 @kindex W G u (Summary)
8952 @findex gnus-article-treat-unfold-headers
8953 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8956 @kindex W G n (Summary)
8957 @findex gnus-article-treat-fold-newsgroups
8958 Fold the @code{Newsgroups} and @code{Followup-To} headers
8959 (@code{gnus-article-treat-fold-newsgroups}).
8962 @kindex W G f (Summary)
8963 @findex gnus-article-treat-fold-headers
8964 Fold all the message headers
8965 (@code{gnus-article-treat-fold-headers}).
8968 @kindex W E w (Summary)
8969 @findex gnus-article-remove-leading-whitespace
8970 Remove excessive whitespace from all headers
8971 (@code{gnus-article-remove-leading-whitespace}).
8976 @node Article Buttons
8977 @subsection Article Buttons
8980 People often include references to other stuff in articles, and it would
8981 be nice if Gnus could just fetch whatever it is that people talk about
8982 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8983 button on these references.
8985 @vindex gnus-button-man-handler
8986 Gnus adds @dfn{buttons} to certain standard references by default:
8987 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
8988 Emacs or Gnus related references. This is controlled by two variables,
8989 one that handles article bodies and one that handles article heads:
8993 @item gnus-button-alist
8994 @vindex gnus-button-alist
8995 This is an alist where each entry has this form:
8998 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9004 All text that match this regular expression (case insensitive) will be
9005 considered an external reference. Here's a typical regexp that matches
9006 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
9007 variable containing a regexp, useful variables to use include
9008 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
9011 Gnus has to know which parts of the matches is to be highlighted. This
9012 is a number that says what sub-expression of the regexp is to be
9013 highlighted. If you want it all highlighted, you use 0 here.
9016 This form will be @code{eval}ed, and if the result is non-@code{nil},
9017 this is considered a match. This is useful if you want extra sifting to
9018 avoid false matches. Often variables named
9019 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
9020 Levels}, but any other form may be used too.
9022 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
9025 This function will be called when you click on this button.
9028 As with @var{button-par}, this is a sub-expression number, but this one
9029 says which part of the match is to be sent as data to @var{function}.
9033 So the full entry for buttonizing URLs is then
9036 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
9039 @item gnus-header-button-alist
9040 @vindex gnus-header-button-alist
9041 This is just like the other alist, except that it is applied to the
9042 article head only, and that each entry has an additional element that is
9043 used to say what headers to apply the buttonize coding to:
9046 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9049 @var{header} is a regular expression.
9052 @subsubsection Related variables and functions
9055 @item gnus-button-@var{*}-level
9056 @xref{Article Button Levels}.
9058 @c Stuff related to gnus-button-browse-level
9060 @item gnus-button-url-regexp
9061 @vindex gnus-button-url-regexp
9062 A regular expression that matches embedded URLs. It is used in the
9063 default values of the variables above.
9065 @c Stuff related to gnus-button-man-level
9067 @item gnus-button-man-handler
9068 @vindex gnus-button-man-handler
9069 The function to use for displaying man pages. It must take at least one
9070 argument with a string naming the man page.
9072 @c Stuff related to gnus-button-message-level
9074 @item gnus-button-mid-or-mail-regexp
9075 @vindex gnus-button-mid-or-mail-regexp
9076 Regular expression that matches a message ID or a mail address.
9078 @item gnus-button-prefer-mid-or-mail
9079 @vindex gnus-button-prefer-mid-or-mail
9080 This variable determines what to do when the button on a string as
9081 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
9082 message ID or a mail address. If it is one of the symbols @code{mid} or
9083 @code{mail}, Gnus will always assume that the string is a message ID or
9084 a mail address, respectively. If this variable is set to the symbol
9085 @code{ask}, always query the user what do do. If it is a function, this
9086 function will be called with the string as its only argument. The
9087 function must return @code{mid}, @code{mail}, @code{invalid} or
9088 @code{ask}. The default value is the function
9089 @code{gnus-button-mid-or-mail-heuristic}.
9091 @item gnus-button-mid-or-mail-heuristic
9092 @findex gnus-button-mid-or-mail-heuristic
9093 Function that guesses whether its argument is a message ID or a mail
9094 address. Returns @code{mid} if it's a message IDs, @code{mail} if
9095 it's a mail address, @code{ask} if unsure and @code{invalid} if the
9098 @item gnus-button-mid-or-mail-heuristic-alist
9099 @vindex gnus-button-mid-or-mail-heuristic-alist
9100 An alist of @code{(RATE . REGEXP)} pairs used by the function
9101 @code{gnus-button-mid-or-mail-heuristic}.
9103 @c Stuff related to gnus-button-tex-level
9105 @item gnus-button-ctan-handler
9106 @findex gnus-button-ctan-handler
9107 The function to use for displaying CTAN links. It must take one
9108 argument, the string naming the URL.
9111 @vindex gnus-ctan-url
9112 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
9113 by @code{gnus-button-ctan-handler}.
9117 @item gnus-article-button-face
9118 @vindex gnus-article-button-face
9119 Face used on buttons.
9121 @item gnus-article-mouse-face
9122 @vindex gnus-article-mouse-face
9123 Face used when the mouse cursor is over a button.
9127 @xref{Customizing Articles}, for how to buttonize articles automatically.
9130 @node Article Button Levels
9131 @subsection Article button levels
9132 @cindex button levels
9133 The higher the value of the variables @code{gnus-button-@var{*}-level},
9134 the more buttons will appear. If the level is zero, no corresponding
9135 buttons are displayed. With the default value (which is 5) you should
9136 already see quite a lot of buttons. With higher levels, you will see
9137 more buttons, but you may also get more false positives. To avoid them,
9138 you can set the variables @code{gnus-button-@var{*}-level} local to
9139 specific groups (@pxref{Group Parameters}). Here's an example for the
9140 variable @code{gnus-parameters}:
9143 ;; @r{increase @code{gnus-button-*-level} in some groups:}
9144 (setq gnus-parameters
9145 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
9146 ("\\<unix\\>" (gnus-button-man-level 10))
9147 ("\\<tex\\>" (gnus-button-tex-level 10))))
9152 @item gnus-button-browse-level
9153 @vindex gnus-button-browse-level
9154 Controls the display of references to message IDs, mail addresses and
9155 news URLs. Related variables and functions include
9156 @code{gnus-button-url-regexp}, @code{browse-url}, and
9157 @code{browse-url-browser-function}.
9159 @item gnus-button-emacs-level
9160 @vindex gnus-button-emacs-level
9161 Controls the display of Emacs or Gnus references. Related functions are
9162 @code{gnus-button-handle-custom},
9163 @code{gnus-button-handle-describe-function},
9164 @code{gnus-button-handle-describe-variable},
9165 @code{gnus-button-handle-symbol},
9166 @code{gnus-button-handle-describe-key},
9167 @code{gnus-button-handle-apropos},
9168 @code{gnus-button-handle-apropos-command},
9169 @code{gnus-button-handle-apropos-variable},
9170 @code{gnus-button-handle-apropos-documentation}, and
9171 @code{gnus-button-handle-library}.
9173 @item gnus-button-man-level
9174 @vindex gnus-button-man-level
9175 Controls the display of references to (Unix) man pages.
9176 See @code{gnus-button-man-handler}.
9178 @item gnus-button-message-level
9179 @vindex gnus-button-message-level
9180 Controls the display of message IDs, mail addresses and news URLs.
9181 Related variables and functions include
9182 @code{gnus-button-mid-or-mail-regexp},
9183 @code{gnus-button-prefer-mid-or-mail},
9184 @code{gnus-button-mid-or-mail-heuristic}, and
9185 @code{gnus-button-mid-or-mail-heuristic-alist}.
9187 @item gnus-button-tex-level
9188 @vindex gnus-button-tex-level
9189 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
9190 URLs. See the variables @code{gnus-ctan-url},
9191 @code{gnus-button-ctan-handler},
9192 @code{gnus-button-ctan-directory-regexp}, and
9193 @code{gnus-button-handle-ctan-bogus-regexp}.
9199 @subsection Article Date
9201 The date is most likely generated in some obscure timezone you've never
9202 heard of, so it's quite nice to be able to find out what the time was
9203 when the article was sent.
9208 @kindex W T u (Summary)
9209 @findex gnus-article-date-ut
9210 Display the date in UT (aka. GMT, aka ZULU)
9211 (@code{gnus-article-date-ut}).
9214 @kindex W T i (Summary)
9215 @findex gnus-article-date-iso8601
9217 Display the date in international format, aka. ISO 8601
9218 (@code{gnus-article-date-iso8601}).
9221 @kindex W T l (Summary)
9222 @findex gnus-article-date-local
9223 Display the date in the local timezone (@code{gnus-article-date-local}).
9226 @kindex W T p (Summary)
9227 @findex gnus-article-date-english
9228 Display the date in a format that's easily pronounceable in English
9229 (@code{gnus-article-date-english}).
9232 @kindex W T s (Summary)
9233 @vindex gnus-article-time-format
9234 @findex gnus-article-date-user
9235 @findex format-time-string
9236 Display the date using a user-defined format
9237 (@code{gnus-article-date-user}). The format is specified by the
9238 @code{gnus-article-time-format} variable, and is a string that's passed
9239 to @code{format-time-string}. See the documentation of that variable
9240 for a list of possible format specs.
9243 @kindex W T e (Summary)
9244 @findex gnus-article-date-lapsed
9245 @findex gnus-start-date-timer
9246 @findex gnus-stop-date-timer
9247 Say how much time has elapsed between the article was posted and now
9248 (@code{gnus-article-date-lapsed}). It looks something like:
9251 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9254 @vindex gnus-article-date-lapsed-new-header
9255 The value of @code{gnus-article-date-lapsed-new-header} determines
9256 whether this header will just be added below the old Date one, or will
9259 An advantage of using Gnus to read mail is that it converts simple bugs
9260 into wonderful absurdities.
9262 If you want to have this line updated continually, you can put
9265 (gnus-start-date-timer)
9268 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9269 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9273 @kindex W T o (Summary)
9274 @findex gnus-article-date-original
9275 Display the original date (@code{gnus-article-date-original}). This can
9276 be useful if you normally use some other conversion function and are
9277 worried that it might be doing something totally wrong. Say, claiming
9278 that the article was posted in 1854. Although something like that is
9279 @emph{totally} impossible. Don't you trust me? *titter*
9283 @xref{Customizing Articles}, for how to display the date in your
9284 preferred format automatically.
9287 @node Article Display
9288 @subsection Article Display
9293 These commands add various frivolous display gimmicks to the article
9294 buffer in Emacs versions that support them.
9296 @code{X-Face} headers are small black-and-white images supplied by the
9297 message headers (@pxref{X-Face}).
9299 @code{Face} headers are small colored images supplied by the message
9300 headers (@pxref{Face}).
9302 Smileys are those little @samp{:-)} symbols that people like to litter
9303 their messages with (@pxref{Smileys}).
9305 Picons, on the other hand, reside on your own system, and Gnus will
9306 try to match the headers to what you have (@pxref{Picons}).
9308 All these functions are toggles---if the elements already exist,
9313 @kindex W D x (Summary)
9314 @findex gnus-article-display-x-face
9315 Display an @code{X-Face} in the @code{From} header.
9316 (@code{gnus-article-display-x-face}).
9319 @kindex W D d (Summary)
9320 @findex gnus-article-display-face
9321 Display a @code{Face} in the @code{From} header.
9322 (@code{gnus-article-display-face}).
9325 @kindex W D s (Summary)
9326 @findex gnus-treat-smiley
9327 Display smileys (@code{gnus-treat-smiley}).
9330 @kindex W D f (Summary)
9331 @findex gnus-treat-from-picon
9332 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9335 @kindex W D m (Summary)
9336 @findex gnus-treat-mail-picon
9337 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9338 (@code{gnus-treat-mail-picon}).
9341 @kindex W D n (Summary)
9342 @findex gnus-treat-newsgroups-picon
9343 Piconify all news headers (i. e., @code{Newsgroups} and
9344 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9347 @kindex W D D (Summary)
9348 @findex gnus-article-remove-images
9349 Remove all images from the article buffer
9350 (@code{gnus-article-remove-images}).
9356 @node Article Signature
9357 @subsection Article Signature
9359 @cindex article signature
9361 @vindex gnus-signature-separator
9362 Each article is divided into two parts---the head and the body. The
9363 body can be divided into a signature part and a text part. The variable
9364 that says what is to be considered a signature is
9365 @code{gnus-signature-separator}. This is normally the standard
9366 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9367 non-standard signature separators, so this variable can also be a list
9368 of regular expressions to be tested, one by one. (Searches are done
9369 from the end of the body towards the beginning.) One likely value is:
9372 (setq gnus-signature-separator
9373 '("^-- $" ; @r{The standard}
9374 "^-- *$" ; @r{A common mangling}
9375 "^-------*$" ; @r{Many people just use a looong}
9376 ; @r{line of dashes. Shame!}
9377 "^ *--------*$" ; @r{Double-shame!}
9378 "^________*$" ; @r{Underscores are also popular}
9379 "^========*$")) ; @r{Pervert!}
9382 The more permissive you are, the more likely it is that you'll get false
9385 @vindex gnus-signature-limit
9386 @code{gnus-signature-limit} provides a limit to what is considered a
9387 signature when displaying articles.
9391 If it is an integer, no signature may be longer (in characters) than
9394 If it is a floating point number, no signature may be longer (in lines)
9397 If it is a function, the function will be called without any parameters,
9398 and if it returns @code{nil}, there is no signature in the buffer.
9400 If it is a string, it will be used as a regexp. If it matches, the text
9401 in question is not a signature.
9404 This variable can also be a list where the elements may be of the types
9405 listed above. Here's an example:
9408 (setq gnus-signature-limit
9409 '(200.0 "^---*Forwarded article"))
9412 This means that if there are more than 200 lines after the signature
9413 separator, or the text after the signature separator is matched by
9414 the regular expression @samp{^---*Forwarded article}, then it isn't a
9415 signature after all.
9418 @node Article Miscellanea
9419 @subsection Article Miscellanea
9423 @kindex A t (Summary)
9424 @findex gnus-article-babel
9425 Translate the article from one language to another
9426 (@code{gnus-article-babel}).
9432 @section MIME Commands
9433 @cindex MIME decoding
9435 @cindex viewing attachments
9437 The following commands all understand the numerical prefix. For
9438 instance, @kbd{3 K v} means ``view the third @acronym{MIME} part''.
9444 @kindex K v (Summary)
9445 View the @acronym{MIME} part.
9448 @kindex K o (Summary)
9449 Save the @acronym{MIME} part.
9452 @kindex K O (Summary)
9453 Prompt for a file name, then save the @acronym{MIME} part and strip it
9454 from the article. The stripped @acronym{MIME} object will be referred
9455 via the message/external-body @acronym{MIME} type.
9458 @kindex K r (Summary)
9459 Replace the @acronym{MIME} part with an external body.
9462 @kindex K d (Summary)
9463 Delete the @acronym{MIME} part and add some information about the
9467 @kindex K c (Summary)
9468 Copy the @acronym{MIME} part.
9471 @kindex K e (Summary)
9472 View the @acronym{MIME} part externally.
9475 @kindex K i (Summary)
9476 View the @acronym{MIME} part internally.
9479 @kindex K | (Summary)
9480 Pipe the @acronym{MIME} part to an external command.
9483 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9488 @kindex K b (Summary)
9489 Make all the @acronym{MIME} parts have buttons in front of them. This is
9490 mostly useful if you wish to save (or perform other actions) on inlined
9494 @kindex K m (Summary)
9495 @findex gnus-summary-repair-multipart
9496 Some multipart messages are transmitted with missing or faulty headers.
9497 This command will attempt to ``repair'' these messages so that they can
9498 be viewed in a more pleasant manner
9499 (@code{gnus-summary-repair-multipart}).
9502 @kindex X m (Summary)
9503 @findex gnus-summary-save-parts
9504 Save all parts matching a @acronym{MIME} type to a directory
9505 (@code{gnus-summary-save-parts}). Understands the process/prefix
9506 convention (@pxref{Process/Prefix}).
9509 @kindex M-t (Summary)
9510 @findex gnus-summary-toggle-display-buttonized
9511 Toggle the buttonized display of the article buffer
9512 (@code{gnus-summary-toggle-display-buttonized}).
9515 @kindex W M w (Summary)
9516 @findex gnus-article-decode-mime-words
9517 Decode RFC 2047-encoded words in the article headers
9518 (@code{gnus-article-decode-mime-words}).
9521 @kindex W M c (Summary)
9522 @findex gnus-article-decode-charset
9523 Decode encoded article bodies as well as charsets
9524 (@code{gnus-article-decode-charset}).
9526 This command looks in the @code{Content-Type} header to determine the
9527 charset. If there is no such header in the article, you can give it a
9528 prefix, which will prompt for the charset to decode as. In regional
9529 groups where people post using some common encoding (but do not
9530 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9531 parameter to the required charset (@pxref{Group Parameters}).
9534 @kindex W M v (Summary)
9535 @findex gnus-mime-view-all-parts
9536 View all the @acronym{MIME} parts in the current article
9537 (@code{gnus-mime-view-all-parts}).
9544 @item gnus-ignored-mime-types
9545 @vindex gnus-ignored-mime-types
9546 This is a list of regexps. @acronym{MIME} types that match a regexp from
9547 this list will be completely ignored by Gnus. The default value is
9550 To have all Vcards be ignored, you'd say something like this:
9553 (setq gnus-ignored-mime-types
9557 @item gnus-article-loose-mime
9558 @vindex gnus-article-loose-mime
9559 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9560 before interpreting the message as a @acronym{MIME} message. This helps
9561 when reading messages from certain broken mail user agents. The
9562 default is @code{nil}.
9564 @item gnus-article-emulate-mime
9565 @vindex gnus-article-emulate-mime
9568 There are other, non-@acronym{MIME} encoding methods used. The most common
9569 is @samp{uuencode}, but yEncode is also getting to be popular. If
9570 this variable is non-@code{nil}, Gnus will look in message bodies to
9571 see if it finds these encodings, and if so, it'll run them through the
9572 Gnus @acronym{MIME} machinery. The default is @code{t}. Only
9573 single-part yEnc encoded attachments can be decoded. There's no support
9574 for encoding in Gnus.
9576 @item gnus-unbuttonized-mime-types
9577 @vindex gnus-unbuttonized-mime-types
9578 This is a list of regexps. @acronym{MIME} types that match a regexp from
9579 this list won't have @acronym{MIME} buttons inserted unless they aren't
9580 displayed or this variable is overridden by
9581 @code{gnus-buttonized-mime-types}. The default value is
9582 @code{(".*/.*")}. This variable is only used when
9583 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9585 @item gnus-buttonized-mime-types
9586 @vindex gnus-buttonized-mime-types
9587 This is a list of regexps. @acronym{MIME} types that match a regexp from
9588 this list will have @acronym{MIME} buttons inserted unless they aren't
9589 displayed. This variable overrides
9590 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9591 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9594 To see e.g. security buttons but no other buttons, you could set this
9595 variable to @code{("multipart/signed")} and leave
9596 @code{gnus-unbuttonized-mime-types} at the default value.
9598 You could also add @code{"multipart/alternative"} to this list to
9599 display radio buttons that allow you to choose one of two media types
9600 those mails include. See also @code{mm-discouraged-alternatives}
9601 (@pxref{Display Customization, ,Display Customization, emacs-mime, The
9602 Emacs MIME Manual}).
9604 @item gnus-inhibit-mime-unbuttonizing
9605 @vindex gnus-inhibit-mime-unbuttonizing
9606 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9607 default value is @code{nil}.
9609 @item gnus-article-mime-part-function
9610 @vindex gnus-article-mime-part-function
9611 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9612 handle as the parameter. The function is meant to be used to allow
9613 users to gather information from the article (e. g., add Vcard info to
9614 the bbdb database) or to do actions based on parts (e. g., automatically
9615 save all jpegs into some directory).
9617 Here's an example function the does the latter:
9620 (defun my-save-all-jpeg-parts (handle)
9621 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9623 (insert (mm-get-part handle))
9624 (write-region (point-min) (point-max)
9625 (read-file-name "Save jpeg to: ")))))
9626 (setq gnus-article-mime-part-function
9627 'my-save-all-jpeg-parts)
9630 @vindex gnus-mime-multipart-functions
9631 @item gnus-mime-multipart-functions
9632 Alist of @acronym{MIME} multipart types and functions to handle them.
9634 @vindex gnus-mime-display-multipart-alternative-as-mixed
9635 @item gnus-mime-display-multipart-alternative-as-mixed
9636 Display "multipart/alternative" parts as "multipart/mixed".
9638 @vindex gnus-mime-display-multipart-related-as-mixed
9639 @item gnus-mime-display-multipart-related-as-mixed
9640 Display "multipart/related" parts as "multipart/mixed".
9642 If displaying "text/html" is discouraged, see
9643 @code{mm-discouraged-alternatives}, images or other material inside a
9644 "multipart/related" part might be overlooked when this variable is
9645 @code{nil}. @ref{Display Customization, Display Customization, ,
9646 emacs-mime, Emacs-Mime Manual}.
9648 @vindex gnus-mime-display-multipart-as-mixed
9649 @item gnus-mime-display-multipart-as-mixed
9650 Display "multipart" parts as "multipart/mixed". If @code{t}, it
9651 overrides @code{nil} values of
9652 @code{gnus-mime-display-multipart-alternative-as-mixed} and
9653 @code{gnus-mime-display-multipart-related-as-mixed}.
9655 @vindex mm-file-name-rewrite-functions
9656 @item mm-file-name-rewrite-functions
9657 List of functions used for rewriting file names of @acronym{MIME} parts.
9658 Each function takes a file name as input and returns a file name.
9660 Ready-made functions include@*
9661 @code{mm-file-name-delete-whitespace},
9662 @code{mm-file-name-trim-whitespace},
9663 @code{mm-file-name-collapse-whitespace}, and
9664 @code{mm-file-name-replace-whitespace}. The later uses the value of
9665 the variable @code{mm-file-name-replace-whitespace} to replace each
9666 whitespace character in a file name with that string; default value
9667 is @code{"_"} (a single underscore).
9668 @findex mm-file-name-delete-whitespace
9669 @findex mm-file-name-trim-whitespace
9670 @findex mm-file-name-collapse-whitespace
9671 @findex mm-file-name-replace-whitespace
9672 @vindex mm-file-name-replace-whitespace
9674 The standard functions @code{capitalize}, @code{downcase},
9675 @code{upcase}, and @code{upcase-initials} may be useful, too.
9677 Everybody knows that whitespace characters in file names are evil,
9678 except those who don't know. If you receive lots of attachments from
9679 such unenlightened users, you can make live easier by adding
9682 (setq mm-file-name-rewrite-functions
9683 '(mm-file-name-trim-whitespace
9684 mm-file-name-collapse-whitespace
9685 mm-file-name-replace-whitespace))
9689 to your @file{~/.gnus.el} file.
9698 People use different charsets, and we have @acronym{MIME} to let us know what
9699 charsets they use. Or rather, we wish we had. Many people use
9700 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9701 just send out messages without saying what character sets they use. To
9702 help a bit with this, some local news hierarchies have policies that say
9703 what character set is the default. For instance, the @samp{fj}
9704 hierarchy uses @code{iso-2022-jp}.
9706 @vindex gnus-group-charset-alist
9707 This knowledge is encoded in the @code{gnus-group-charset-alist}
9708 variable, which is an alist of regexps (use the first item to match full
9709 group names) and default charsets to be used when reading these groups.
9711 @vindex gnus-newsgroup-ignored-charsets
9712 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9713 aren't. These blithely mark messages as being in @code{iso-8859-1}
9714 even if they really are in @code{koi-8}. To help here, the
9715 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9716 charsets that are listed here will be ignored. The variable can be
9717 set on a group-by-group basis using the group parameters (@pxref{Group
9718 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9719 which includes values some agents insist on having in there.
9721 @vindex gnus-group-posting-charset-alist
9722 When posting, @code{gnus-group-posting-charset-alist} is used to
9723 determine which charsets should not be encoded using the @acronym{MIME}
9724 encodings. For instance, some hierarchies discourage using
9725 quoted-printable header encoding.
9727 This variable is an alist of regexps and permitted unencoded charsets
9728 for posting. Each element of the alist has the form @code{(}@var{test
9729 header body-list}@code{)}, where:
9733 is either a regular expression matching the newsgroup header or a
9736 is the charset which may be left unencoded in the header (@code{nil}
9737 means encode all charsets),
9739 is a list of charsets which may be encoded using 8bit content-transfer
9740 encoding in the body, or one of the special values @code{nil} (always
9741 encode using quoted-printable) or @code{t} (always use 8bit).
9748 @cindex coding system aliases
9749 @cindex preferred charset
9751 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
9752 The Emacs MIME Manual}, for additional variables that control which
9753 MIME charsets are used when sending messages.
9755 Other charset tricks that may be useful, although not Gnus-specific:
9757 If there are several @acronym{MIME} charsets that encode the same Emacs
9758 charset, you can choose what charset to use by saying the following:
9761 (put-charset-property 'cyrillic-iso8859-5
9762 'preferred-coding-system 'koi8-r)
9765 This means that Russian will be encoded using @code{koi8-r} instead of
9766 the default @code{iso-8859-5} @acronym{MIME} charset.
9768 If you want to read messages in @code{koi8-u}, you can cheat and say
9771 (define-coding-system-alias 'koi8-u 'koi8-r)
9774 This will almost do the right thing.
9776 And finally, to read charsets like @code{windows-1251}, you can say
9780 (codepage-setup 1251)
9781 (define-coding-system-alias 'windows-1251 'cp1251)
9785 @node Article Commands
9786 @section Article Commands
9793 @kindex A P (Summary)
9794 @vindex gnus-ps-print-hook
9795 @findex gnus-summary-print-article
9796 Generate and print a PostScript image of the article buffer
9797 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9798 be run just before printing the buffer. An alternative way to print
9799 article is to use Muttprint (@pxref{Saving Articles}).
9804 @node Summary Sorting
9805 @section Summary Sorting
9806 @cindex summary sorting
9808 You can have the summary buffer sorted in various ways, even though I
9809 can't really see why you'd want that.
9814 @kindex C-c C-s C-n (Summary)
9815 @findex gnus-summary-sort-by-number
9816 Sort by article number (@code{gnus-summary-sort-by-number}).
9819 @kindex C-c C-s C-a (Summary)
9820 @findex gnus-summary-sort-by-author
9821 Sort by author (@code{gnus-summary-sort-by-author}).
9824 @kindex C-c C-s C-t (Summary)
9825 @findex gnus-summary-sort-by-recipient
9826 Sort by recipient (@code{gnus-summary-sort-by-recipient}).
9829 @kindex C-c C-s C-s (Summary)
9830 @findex gnus-summary-sort-by-subject
9831 Sort by subject (@code{gnus-summary-sort-by-subject}).
9834 @kindex C-c C-s C-d (Summary)
9835 @findex gnus-summary-sort-by-date
9836 Sort by date (@code{gnus-summary-sort-by-date}).
9839 @kindex C-c C-s C-l (Summary)
9840 @findex gnus-summary-sort-by-lines
9841 Sort by lines (@code{gnus-summary-sort-by-lines}).
9844 @kindex C-c C-s C-c (Summary)
9845 @findex gnus-summary-sort-by-chars
9846 Sort by article length (@code{gnus-summary-sort-by-chars}).
9849 @kindex C-c C-s C-i (Summary)
9850 @findex gnus-summary-sort-by-score
9851 Sort by score (@code{gnus-summary-sort-by-score}).
9854 @kindex C-c C-s C-r (Summary)
9855 @findex gnus-summary-sort-by-random
9856 Randomize (@code{gnus-summary-sort-by-random}).
9859 @kindex C-c C-s C-o (Summary)
9860 @findex gnus-summary-sort-by-original
9861 Sort using the default sorting method
9862 (@code{gnus-summary-sort-by-original}).
9865 These functions will work both when you use threading and when you don't
9866 use threading. In the latter case, all summary lines will be sorted,
9867 line by line. In the former case, sorting will be done on a
9868 root-by-root basis, which might not be what you were looking for. To
9869 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9873 @node Finding the Parent
9874 @section Finding the Parent
9875 @cindex parent articles
9876 @cindex referring articles
9881 @findex gnus-summary-refer-parent-article
9882 If you'd like to read the parent of the current article, and it is not
9883 displayed in the summary buffer, you might still be able to. That is,
9884 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
9885 and the @code{References} in the current article are not mangled, you
9886 can just press @kbd{^} or @kbd{A r}
9887 (@code{gnus-summary-refer-parent-article}). If everything goes well,
9888 you'll get the parent. If the parent is already displayed in the
9889 summary buffer, point will just move to this article.
9891 If given a positive numerical prefix, fetch that many articles back into
9892 the ancestry. If given a negative numerical prefix, fetch just that
9893 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
9894 grandparent and the grandgrandparent of the current article. If you say
9895 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
9899 @findex gnus-summary-refer-references
9900 @kindex A R (Summary)
9901 Fetch all articles mentioned in the @code{References} header of the
9902 article (@code{gnus-summary-refer-references}).
9905 @findex gnus-summary-refer-thread
9906 @kindex A T (Summary)
9907 Display the full thread where the current article appears
9908 (@code{gnus-summary-refer-thread}). This command has to fetch all the
9909 headers in the current group to work, so it usually takes a while. If
9910 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9911 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
9912 visible effects normally, but it'll make this command work a whole lot
9913 faster. Of course, it'll make group entry somewhat slow.
9915 @vindex gnus-refer-thread-limit
9916 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9917 articles before the first displayed in the current group) headers to
9918 fetch when doing this command. The default is 200. If @code{t}, all
9919 the available headers will be fetched. This variable can be overridden
9920 by giving the @kbd{A T} command a numerical prefix.
9923 @findex gnus-summary-refer-article
9924 @kindex M-^ (Summary)
9926 @cindex fetching by Message-ID
9927 You can also ask Gnus for an arbitrary article, no matter what group it
9928 belongs to. @kbd{M-^} (@code{gnus-summary-refer-article}) will ask you
9929 for a @code{Message-ID}, which is one of those long, hard-to-read
9930 thingies that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.
9931 You have to get it all exactly right. No fuzzy searches, I'm afraid.
9933 Gnus looks for the @code{Message-ID} in the headers that have already
9934 been fetched, but also tries all the select methods specified by
9935 @code{gnus-refer-article-method} if it is not found.
9938 @vindex gnus-refer-article-method
9939 If the group you are reading is located on a back end that does not
9940 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9941 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
9942 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
9943 updating the spool you are reading from, but that's not really
9946 It can also be a list of select methods, as well as the special symbol
9947 @code{current}, which means to use the current select method. If it
9948 is a list, Gnus will try all the methods in the list until it finds a
9951 Here's an example setting that will first try the current method, and
9952 then ask Google if that fails:
9955 (setq gnus-refer-article-method
9957 (nnweb "google" (nnweb-type google))))
9960 Most of the mail back ends support fetching by @code{Message-ID}, but
9961 do not do a particularly excellent job at it. That is, @code{nnmbox},
9962 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
9963 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
9964 only able to locate articles that have been posted to the current
9965 group. (Anything else would be too time consuming.) @code{nnmh} does
9966 not support this at all.
9969 @node Alternative Approaches
9970 @section Alternative Approaches
9972 Different people like to read news using different methods. This being
9973 Gnus, we offer a small selection of minor modes for the summary buffers.
9976 * Pick and Read:: First mark articles and then read them.
9977 * Binary Groups:: Auto-decode all articles.
9982 @subsection Pick and Read
9983 @cindex pick and read
9985 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9986 a two-phased reading interface. The user first marks in a summary
9987 buffer the articles she wants to read. Then she starts reading the
9988 articles with just an article buffer displayed.
9990 @findex gnus-pick-mode
9991 @kindex M-x gnus-pick-mode
9992 Gnus provides a summary buffer minor mode that allows
9993 this---@code{gnus-pick-mode}. This basically means that a few process
9994 mark commands become one-keystroke commands to allow easy marking, and
9995 it provides one additional command for switching to the summary buffer.
9997 Here are the available keystrokes when using pick mode:
10002 @findex gnus-pick-article-or-thread
10003 Pick the article or thread on the current line
10004 (@code{gnus-pick-article-or-thread}). If the variable
10005 @code{gnus-thread-hide-subtree} is true, then this key selects the
10006 entire thread when used at the first article of the thread. Otherwise,
10007 it selects just the article. If given a numerical prefix, go to that
10008 thread or article and pick it. (The line number is normally displayed
10009 at the beginning of the summary pick lines.)
10012 @kindex SPACE (Pick)
10013 @findex gnus-pick-next-page
10014 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
10015 at the end of the buffer, start reading the picked articles.
10019 @findex gnus-pick-unmark-article-or-thread.
10020 Unpick the thread or article
10021 (@code{gnus-pick-unmark-article-or-thread}). If the variable
10022 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
10023 thread if used at the first article of the thread. Otherwise it unpicks
10024 just the article. You can give this key a numerical prefix to unpick
10025 the thread or article at that line.
10029 @findex gnus-pick-start-reading
10030 @vindex gnus-pick-display-summary
10031 Start reading the picked articles (@code{gnus-pick-start-reading}). If
10032 given a prefix, mark all unpicked articles as read first. If
10033 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
10034 will still be visible when you are reading.
10038 All the normal summary mode commands are still available in the
10039 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
10040 which is mapped to the same function
10041 @code{gnus-summary-tick-article-forward}.
10043 If this sounds like a good idea to you, you could say:
10046 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
10049 @vindex gnus-pick-mode-hook
10050 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
10052 @vindex gnus-mark-unpicked-articles-as-read
10053 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
10054 all unpicked articles as read. The default is @code{nil}.
10056 @vindex gnus-summary-pick-line-format
10057 The summary line format in pick mode is slightly different from the
10058 standard format. At the beginning of each line the line number is
10059 displayed. The pick mode line format is controlled by the
10060 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
10061 Variables}). It accepts the same format specs that
10062 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
10065 @node Binary Groups
10066 @subsection Binary Groups
10067 @cindex binary groups
10069 @findex gnus-binary-mode
10070 @kindex M-x gnus-binary-mode
10071 If you spend much time in binary groups, you may grow tired of hitting
10072 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
10073 is a minor mode for summary buffers that makes all ordinary Gnus article
10074 selection functions uudecode series of articles and display the result
10075 instead of just displaying the articles the normal way.
10078 @findex gnus-binary-show-article
10079 The only way, in fact, to see the actual articles is the @kbd{g}
10080 command, when you have turned on this mode
10081 (@code{gnus-binary-show-article}).
10083 @vindex gnus-binary-mode-hook
10084 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
10088 @section Tree Display
10091 @vindex gnus-use-trees
10092 If you don't like the normal Gnus summary display, you might try setting
10093 @code{gnus-use-trees} to @code{t}. This will create (by default) an
10094 additional @dfn{tree buffer}. You can execute all summary mode commands
10095 in the tree buffer.
10097 There are a few variables to customize the tree display, of course:
10100 @item gnus-tree-mode-hook
10101 @vindex gnus-tree-mode-hook
10102 A hook called in all tree mode buffers.
10104 @item gnus-tree-mode-line-format
10105 @vindex gnus-tree-mode-line-format
10106 A format string for the mode bar in the tree mode buffers (@pxref{Mode
10107 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
10108 of valid specs, @pxref{Summary Buffer Mode Line}.
10110 @item gnus-selected-tree-face
10111 @vindex gnus-selected-tree-face
10112 Face used for highlighting the selected article in the tree buffer. The
10113 default is @code{modeline}.
10115 @item gnus-tree-line-format
10116 @vindex gnus-tree-line-format
10117 A format string for the tree nodes. The name is a bit of a misnomer,
10118 though---it doesn't define a line, but just the node. The default value
10119 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
10120 the name of the poster. It is vital that all nodes are of the same
10121 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
10127 The name of the poster.
10129 The @code{From} header.
10131 The number of the article.
10133 The opening bracket.
10135 The closing bracket.
10140 @xref{Formatting Variables}.
10142 Variables related to the display are:
10145 @item gnus-tree-brackets
10146 @vindex gnus-tree-brackets
10147 This is used for differentiating between ``real'' articles and
10148 ``sparse'' articles. The format is
10150 ((@var{real-open} . @var{real-close})
10151 (@var{sparse-open} . @var{sparse-close})
10152 (@var{dummy-open} . @var{dummy-close}))
10154 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
10156 @item gnus-tree-parent-child-edges
10157 @vindex gnus-tree-parent-child-edges
10158 This is a list that contains the characters used for connecting parent
10159 nodes to their children. The default is @code{(?- ?\\ ?|)}.
10163 @item gnus-tree-minimize-window
10164 @vindex gnus-tree-minimize-window
10165 If this variable is non-@code{nil}, Gnus will try to keep the tree
10166 buffer as small as possible to allow more room for the other Gnus
10167 windows. If this variable is a number, the tree buffer will never be
10168 higher than that number. The default is @code{t}. Note that if you
10169 have several windows displayed side-by-side in a frame and the tree
10170 buffer is one of these, minimizing the tree window will also resize all
10171 other windows displayed next to it.
10173 You may also wish to add the following hook to keep the window minimized
10177 (add-hook 'gnus-configure-windows-hook
10178 'gnus-tree-perhaps-minimize)
10181 @item gnus-generate-tree-function
10182 @vindex gnus-generate-tree-function
10183 @findex gnus-generate-horizontal-tree
10184 @findex gnus-generate-vertical-tree
10185 The function that actually generates the thread tree. Two predefined
10186 functions are available: @code{gnus-generate-horizontal-tree} and
10187 @code{gnus-generate-vertical-tree} (which is the default).
10191 Here's an example from a horizontal tree buffer:
10194 @{***@}-(***)-[odd]-[Gun]
10204 Here's the same thread displayed in a vertical tree buffer:
10209 |--------------------------\-----\-----\
10210 (***) [Bjo] [Gun] [Gun]
10212 [odd] [Jan] [odd] (***) [Jor]
10214 [Gun] [Eri] [Eri] [odd]
10220 If you're using horizontal trees, it might be nice to display the trees
10221 side-by-side with the summary buffer. You could add something like the
10222 following to your @file{~/.gnus.el} file:
10225 (setq gnus-use-trees t
10226 gnus-generate-tree-function 'gnus-generate-horizontal-tree
10227 gnus-tree-minimize-window nil)
10228 (gnus-add-configuration
10232 (summary 0.75 point)
10237 @xref{Window Layout}.
10240 @node Mail Group Commands
10241 @section Mail Group Commands
10242 @cindex mail group commands
10244 Some commands only make sense in mail groups. If these commands are
10245 invalid in the current group, they will raise a hell and let you know.
10247 All these commands (except the expiry and edit commands) use the
10248 process/prefix convention (@pxref{Process/Prefix}).
10253 @kindex B e (Summary)
10254 @findex gnus-summary-expire-articles
10255 @cindex expiring mail
10256 Run all expirable articles in the current group through the expiry
10257 process (@code{gnus-summary-expire-articles}). That is, delete all
10258 expirable articles in the group that have been around for a while.
10259 (@pxref{Expiring Mail}).
10262 @kindex B C-M-e (Summary)
10263 @findex gnus-summary-expire-articles-now
10264 @cindex expiring mail
10265 Delete all the expirable articles in the group
10266 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
10267 articles eligible for expiry in the current group will
10268 disappear forever into that big @file{/dev/null} in the sky.
10271 @kindex B DEL (Summary)
10272 @findex gnus-summary-delete-article
10273 @c @icon{gnus-summary-mail-delete}
10274 Delete the mail article. This is ``delete'' as in ``delete it from your
10275 disk forever and ever, never to return again.'' Use with caution.
10276 (@code{gnus-summary-delete-article}).
10279 @kindex B m (Summary)
10281 @findex gnus-summary-move-article
10282 @vindex gnus-preserve-marks
10283 Move the article from one mail group to another
10284 (@code{gnus-summary-move-article}). Marks will be preserved if
10285 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10288 @kindex B c (Summary)
10290 @findex gnus-summary-copy-article
10291 @c @icon{gnus-summary-mail-copy}
10292 Copy the article from one group (mail group or not) to a mail group
10293 (@code{gnus-summary-copy-article}). Marks will be preserved if
10294 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10297 @kindex B B (Summary)
10298 @cindex crosspost mail
10299 @findex gnus-summary-crosspost-article
10300 Crosspost the current article to some other group
10301 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10302 the article in the other group, and the Xref headers of the article will
10303 be properly updated.
10306 @kindex B i (Summary)
10307 @findex gnus-summary-import-article
10308 Import an arbitrary file into the current mail newsgroup
10309 (@code{gnus-summary-import-article}). You will be prompted for a file
10310 name, a @code{From} header and a @code{Subject} header.
10313 @kindex B I (Summary)
10314 @findex gnus-summary-create-article
10315 Create an empty article in the current mail newsgroups
10316 (@code{gnus-summary-create-article}). You will be prompted for a
10317 @code{From} header and a @code{Subject} header.
10320 @kindex B r (Summary)
10321 @findex gnus-summary-respool-article
10322 @vindex gnus-summary-respool-default-method
10323 Respool the mail article (@code{gnus-summary-respool-article}).
10324 @code{gnus-summary-respool-default-method} will be used as the default
10325 select method when respooling. This variable is @code{nil} by default,
10326 which means that the current group select method will be used instead.
10327 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10328 (which is the default).
10332 @kindex B w (Summary)
10333 @kindex e (Summary)
10334 @findex gnus-summary-edit-article
10335 @kindex C-c C-c (Article)
10336 @findex gnus-summary-edit-article-done
10337 Edit the current article (@code{gnus-summary-edit-article}). To finish
10338 editing and make the changes permanent, type @kbd{C-c C-c}
10339 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10340 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
10343 @kindex B q (Summary)
10344 @findex gnus-summary-respool-query
10345 If you want to re-spool an article, you might be curious as to what group
10346 the article will end up in before you do the re-spooling. This command
10347 will tell you (@code{gnus-summary-respool-query}).
10350 @kindex B t (Summary)
10351 @findex gnus-summary-respool-trace
10352 Similarly, this command will display all fancy splitting patterns used
10353 when respooling, if any (@code{gnus-summary-respool-trace}).
10356 @kindex B p (Summary)
10357 @findex gnus-summary-article-posted-p
10358 Some people have a tendency to send you ``courtesy'' copies when they
10359 follow up to articles you have posted. These usually have a
10360 @code{Newsgroups} header in them, but not always. This command
10361 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10362 article from your news server (or rather, from
10363 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10364 report back whether it found the article or not. Even if it says that
10365 it didn't find the article, it may have been posted anyway---mail
10366 propagation is much faster than news propagation, and the news copy may
10367 just not have arrived yet.
10370 @kindex K E (Summary)
10371 @findex gnus-article-encrypt-body
10372 @vindex gnus-article-encrypt-protocol
10373 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10374 The body is encrypted with the encryption protocol specified by the
10375 variable @code{gnus-article-encrypt-protocol}.
10379 @vindex gnus-move-split-methods
10380 @cindex moving articles
10381 If you move (or copy) articles regularly, you might wish to have Gnus
10382 suggest where to put the articles. @code{gnus-move-split-methods} is a
10383 variable that uses the same syntax as @code{gnus-split-methods}
10384 (@pxref{Saving Articles}). You may customize that variable to create
10385 suggestions you find reasonable. (Note that
10386 @code{gnus-move-split-methods} uses group names where
10387 @code{gnus-split-methods} uses file names.)
10390 (setq gnus-move-split-methods
10391 '(("^From:.*Lars Magne" "nnml:junk")
10392 ("^Subject:.*gnus" "nnfolder:important")
10393 (".*" "nnml:misc")))
10397 @node Various Summary Stuff
10398 @section Various Summary Stuff
10401 * Summary Group Information:: Information oriented commands.
10402 * Searching for Articles:: Multiple article commands.
10403 * Summary Generation Commands::
10404 * Really Various Summary Commands:: Those pesky non-conformant commands.
10408 @vindex gnus-summary-display-while-building
10409 @item gnus-summary-display-while-building
10410 If non-@code{nil}, show and update the summary buffer as it's being
10411 built. If @code{t}, update the buffer after every line is inserted.
10412 If the value is an integer, @var{n}, update the display every @var{n}
10413 lines. The default is @code{nil}.
10415 @vindex gnus-summary-display-arrow
10416 @item gnus-summary-display-arrow
10417 If non-@code{nil}, display an arrow in the fringe to indicate the
10420 @vindex gnus-summary-mode-hook
10421 @item gnus-summary-mode-hook
10422 This hook is called when creating a summary mode buffer.
10424 @vindex gnus-summary-generate-hook
10425 @item gnus-summary-generate-hook
10426 This is called as the last thing before doing the threading and the
10427 generation of the summary buffer. It's quite convenient for customizing
10428 the threading variables based on what data the newsgroup has. This hook
10429 is called from the summary buffer after most summary buffer variables
10432 @vindex gnus-summary-prepare-hook
10433 @item gnus-summary-prepare-hook
10434 It is called after the summary buffer has been generated. You might use
10435 it to, for instance, highlight lines or modify the look of the buffer in
10436 some other ungodly manner. I don't care.
10438 @vindex gnus-summary-prepared-hook
10439 @item gnus-summary-prepared-hook
10440 A hook called as the very last thing after the summary buffer has been
10443 @vindex gnus-summary-ignore-duplicates
10444 @item gnus-summary-ignore-duplicates
10445 When Gnus discovers two articles that have the same @code{Message-ID},
10446 it has to do something drastic. No articles are allowed to have the
10447 same @code{Message-ID}, but this may happen when reading mail from some
10448 sources. Gnus allows you to customize what happens with this variable.
10449 If it is @code{nil} (which is the default), Gnus will rename the
10450 @code{Message-ID} (for display purposes only) and display the article as
10451 any other article. If this variable is @code{t}, it won't display the
10452 article---it'll be as if it never existed.
10454 @vindex gnus-alter-articles-to-read-function
10455 @item gnus-alter-articles-to-read-function
10456 This function, which takes two parameters (the group name and the list
10457 of articles to be selected), is called to allow the user to alter the
10458 list of articles to be selected.
10460 For instance, the following function adds the list of cached articles to
10461 the list in one particular group:
10464 (defun my-add-cached-articles (group articles)
10465 (if (string= group "some.group")
10466 (append gnus-newsgroup-cached articles)
10470 @vindex gnus-newsgroup-variables
10471 @item gnus-newsgroup-variables
10472 A list of newsgroup (summary buffer) local variables, or cons of
10473 variables and their default expressions to be evalled (when the default
10474 values are not @code{nil}), that should be made global while the summary
10477 Note: The default expressions will be evaluated (using function
10478 @code{eval}) before assignment to the local variable rather than just
10479 assigned to it. If the default expression is the symbol @code{global},
10480 that symbol will not be evaluated but the global value of the local
10481 variable will be used instead.
10483 These variables can be used to set variables in the group parameters
10484 while still allowing them to affect operations done in other
10485 buffers. For example:
10488 (setq gnus-newsgroup-variables
10489 '(message-use-followup-to
10490 (gnus-visible-headers .
10491 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10494 Also @pxref{Group Parameters}.
10498 @node Summary Group Information
10499 @subsection Summary Group Information
10504 @kindex H f (Summary)
10505 @findex gnus-summary-fetch-faq
10506 @vindex gnus-group-faq-directory
10507 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10508 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10509 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10510 is usually a directory on a remote machine. This variable can also be
10511 a list of directories. In that case, giving a prefix to this command
10512 will allow you to choose between the various sites. @code{ange-ftp}
10513 or @code{efs} will probably be used for fetching the file.
10516 @kindex H d (Summary)
10517 @findex gnus-summary-describe-group
10518 Give a brief description of the current group
10519 (@code{gnus-summary-describe-group}). If given a prefix, force
10520 rereading the description from the server.
10523 @kindex H h (Summary)
10524 @findex gnus-summary-describe-briefly
10525 Give an extremely brief description of the most important summary
10526 keystrokes (@code{gnus-summary-describe-briefly}).
10529 @kindex H i (Summary)
10530 @findex gnus-info-find-node
10531 Go to the Gnus info node (@code{gnus-info-find-node}).
10535 @node Searching for Articles
10536 @subsection Searching for Articles
10541 @kindex M-s (Summary)
10542 @findex gnus-summary-search-article-forward
10543 Search through all subsequent (raw) articles for a regexp
10544 (@code{gnus-summary-search-article-forward}).
10547 @kindex M-r (Summary)
10548 @findex gnus-summary-search-article-backward
10549 Search through all previous (raw) articles for a regexp
10550 (@code{gnus-summary-search-article-backward}).
10553 @kindex M-S (Summary)
10554 @findex gnus-summary-repeat-search-article-forward
10555 Repeat the previous search forwards
10556 (@code{gnus-summary-repeat-search-article-forward}).
10559 @kindex M-R (Summary)
10560 @findex gnus-summary-repeat-search-article-backward
10561 Repeat the previous search backwards
10562 (@code{gnus-summary-repeat-search-article-backward}).
10565 @kindex & (Summary)
10566 @findex gnus-summary-execute-command
10567 This command will prompt you for a header, a regular expression to match
10568 on this field, and a command to be executed if the match is made
10569 (@code{gnus-summary-execute-command}). If the header is an empty
10570 string, the match is done on the entire article. If given a prefix,
10571 search backward instead.
10573 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10574 all articles that have heads or bodies that match @samp{some.*string}.
10577 @kindex M-& (Summary)
10578 @findex gnus-summary-universal-argument
10579 Perform any operation on all articles that have been marked with
10580 the process mark (@code{gnus-summary-universal-argument}).
10583 @node Summary Generation Commands
10584 @subsection Summary Generation Commands
10589 @kindex Y g (Summary)
10590 @findex gnus-summary-prepare
10591 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10594 @kindex Y c (Summary)
10595 @findex gnus-summary-insert-cached-articles
10596 Pull all cached articles (for the current group) into the summary buffer
10597 (@code{gnus-summary-insert-cached-articles}).
10600 @kindex Y d (Summary)
10601 @findex gnus-summary-insert-dormant-articles
10602 Pull all dormant articles (for the current group) into the summary buffer
10603 (@code{gnus-summary-insert-dormant-articles}).
10606 @kindex Y t (Summary)
10607 @findex gnus-summary-insert-ticked-articles
10608 Pull all ticked articles (for the current group) into the summary buffer
10609 (@code{gnus-summary-insert-ticked-articles}).
10614 @node Really Various Summary Commands
10615 @subsection Really Various Summary Commands
10621 @kindex C-d (Summary)
10622 @kindex A D (Summary)
10623 @findex gnus-summary-enter-digest-group
10624 If the current article is a collection of other articles (for instance,
10625 a digest), you might use this command to enter a group based on the that
10626 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10627 guess what article type is currently displayed unless you give a prefix
10628 to this command, which forces a ``digest'' interpretation. Basically,
10629 whenever you see a message that is a collection of other messages of
10630 some format, you @kbd{C-d} and read these messages in a more convenient
10633 @vindex gnus-auto-select-on-ephemeral-exit
10634 The variable @code{gnus-auto-select-on-ephemeral-exit} controls what
10635 article should be selected after exiting a digest group. Valid values
10640 Select the next article.
10643 Select the next unread article.
10645 @item next-noselect
10646 Move the cursor to the next article. This is the default.
10648 @item next-unread-noselect
10649 Move the cursor to the next unread article.
10652 If it has any other value or there is no next (unread) article, the
10653 article selected before entering to the digest group will appear.
10656 @kindex C-M-d (Summary)
10657 @findex gnus-summary-read-document
10658 This command is very similar to the one above, but lets you gather
10659 several documents into one biiig group
10660 (@code{gnus-summary-read-document}). It does this by opening several
10661 @code{nndoc} groups for each document, and then opening an
10662 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10663 command understands the process/prefix convention
10664 (@pxref{Process/Prefix}).
10667 @kindex C-t (Summary)
10668 @findex gnus-summary-toggle-truncation
10669 Toggle truncation of summary lines
10670 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10671 line centering function in the summary buffer, so it's not a good idea
10672 to have truncation switched off while reading articles.
10675 @kindex = (Summary)
10676 @findex gnus-summary-expand-window
10677 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10678 If given a prefix, force an @code{article} window configuration.
10681 @kindex C-M-e (Summary)
10682 @findex gnus-summary-edit-parameters
10683 Edit the group parameters (@pxref{Group Parameters}) of the current
10684 group (@code{gnus-summary-edit-parameters}).
10687 @kindex C-M-a (Summary)
10688 @findex gnus-summary-customize-parameters
10689 Customize the group parameters (@pxref{Group Parameters}) of the current
10690 group (@code{gnus-summary-customize-parameters}).
10695 @node Exiting the Summary Buffer
10696 @section Exiting the Summary Buffer
10697 @cindex summary exit
10698 @cindex exiting groups
10700 Exiting from the summary buffer will normally update all info on the
10701 group and return you to the group buffer.
10708 @kindex Z Z (Summary)
10709 @kindex Z Q (Summary)
10710 @kindex q (Summary)
10711 @findex gnus-summary-exit
10712 @vindex gnus-summary-exit-hook
10713 @vindex gnus-summary-prepare-exit-hook
10714 @vindex gnus-group-no-more-groups-hook
10715 @c @icon{gnus-summary-exit}
10716 Exit the current group and update all information on the group
10717 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10718 called before doing much of the exiting, which calls
10719 @code{gnus-summary-expire-articles} by default.
10720 @code{gnus-summary-exit-hook} is called after finishing the exit
10721 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10722 group mode having no more (unread) groups.
10726 @kindex Z E (Summary)
10727 @kindex Q (Summary)
10728 @findex gnus-summary-exit-no-update
10729 Exit the current group without updating any information on the group
10730 (@code{gnus-summary-exit-no-update}).
10734 @kindex Z c (Summary)
10735 @kindex c (Summary)
10736 @findex gnus-summary-catchup-and-exit
10737 @c @icon{gnus-summary-catchup-and-exit}
10738 Mark all unticked articles in the group as read and then exit
10739 (@code{gnus-summary-catchup-and-exit}).
10742 @kindex Z C (Summary)
10743 @findex gnus-summary-catchup-all-and-exit
10744 Mark all articles, even the ticked ones, as read and then exit
10745 (@code{gnus-summary-catchup-all-and-exit}).
10748 @kindex Z n (Summary)
10749 @findex gnus-summary-catchup-and-goto-next-group
10750 Mark all articles as read and go to the next group
10751 (@code{gnus-summary-catchup-and-goto-next-group}).
10754 @kindex Z p (Summary)
10755 @findex gnus-summary-catchup-and-goto-prev-group
10756 Mark all articles as read and go to the previous group
10757 (@code{gnus-summary-catchup-and-goto-prev-group}).
10761 @kindex Z R (Summary)
10762 @kindex C-x C-s (Summary)
10763 @findex gnus-summary-reselect-current-group
10764 Exit this group, and then enter it again
10765 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10766 all articles, both read and unread.
10770 @kindex Z G (Summary)
10771 @kindex M-g (Summary)
10772 @findex gnus-summary-rescan-group
10773 @c @icon{gnus-summary-mail-get}
10774 Exit the group, check for new articles in the group, and select the
10775 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10776 articles, both read and unread.
10779 @kindex Z N (Summary)
10780 @findex gnus-summary-next-group
10781 Exit the group and go to the next group
10782 (@code{gnus-summary-next-group}).
10785 @kindex Z P (Summary)
10786 @findex gnus-summary-prev-group
10787 Exit the group and go to the previous group
10788 (@code{gnus-summary-prev-group}).
10791 @kindex Z s (Summary)
10792 @findex gnus-summary-save-newsrc
10793 Save the current number of read/marked articles in the dribble buffer
10794 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10795 given a prefix, also save the @file{.newsrc} file(s). Using this
10796 command will make exit without updating (the @kbd{Q} command) worthless.
10799 @vindex gnus-exit-group-hook
10800 @code{gnus-exit-group-hook} is called when you exit the current group
10801 with an ``updating'' exit. For instance @kbd{Q}
10802 (@code{gnus-summary-exit-no-update}) does not call this hook.
10804 @findex gnus-summary-wake-up-the-dead
10805 @findex gnus-dead-summary-mode
10806 @vindex gnus-kill-summary-on-exit
10807 If you're in the habit of exiting groups, and then changing your mind
10808 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10809 If you do that, Gnus won't kill the summary buffer when you exit it.
10810 (Quelle surprise!) Instead it will change the name of the buffer to
10811 something like @samp{*Dead Summary ... *} and install a minor mode
10812 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
10813 buffer, you'll find that all keys are mapped to a function called
10814 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
10815 summary buffer will result in a live, normal summary buffer.
10817 There will never be more than one dead summary buffer at any one time.
10819 @vindex gnus-use-cross-reference
10820 The data on the current group will be updated (which articles you have
10821 read, which articles you have replied to, etc.) when you exit the
10822 summary buffer. If the @code{gnus-use-cross-reference} variable is
10823 @code{t} (which is the default), articles that are cross-referenced to
10824 this group and are marked as read, will also be marked as read in the
10825 other subscribed groups they were cross-posted to. If this variable is
10826 neither @code{nil} nor @code{t}, the article will be marked as read in
10827 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10830 @node Crosspost Handling
10831 @section Crosspost Handling
10835 Marking cross-posted articles as read ensures that you'll never have to
10836 read the same article more than once. Unless, of course, somebody has
10837 posted it to several groups separately. Posting the same article to
10838 several groups (not cross-posting) is called @dfn{spamming}, and you are
10839 by law required to send nasty-grams to anyone who perpetrates such a
10840 heinous crime. You may want to try NoCeM handling to filter out spam
10843 Remember: Cross-posting is kinda ok, but posting the same article
10844 separately to several groups is not. Massive cross-posting (aka.
10845 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10846 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10847 excessive crossposting (@pxref{Summary Mail Commands}).
10849 @cindex cross-posting
10851 @cindex @acronym{NOV}
10852 One thing that may cause Gnus to not do the cross-posting thing
10853 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
10854 (which is very nice, because it speeds things up considerably) which
10855 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
10856 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
10857 even with @sc{xover} by registering the @code{Xref} lines of all
10858 articles you actually read, but if you kill the articles, or just mark
10859 them as read without reading them, Gnus will not get a chance to snoop
10860 the @code{Xref} lines out of these articles, and will be unable to use
10861 the cross reference mechanism.
10863 @cindex LIST overview.fmt
10864 @cindex overview.fmt
10865 To check whether your @acronym{NNTP} server includes the @code{Xref} header
10866 in its overview files, try @samp{telnet your.nntp.server nntp},
10867 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10868 overview.fmt}. This may not work, but if it does, and the last line you
10869 get does not read @samp{Xref:full}, then you should shout and whine at
10870 your news admin until she includes the @code{Xref} header in the
10873 @vindex gnus-nov-is-evil
10874 If you want Gnus to get the @code{Xref}s right all the time, you have to
10875 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10880 For an alternative approach, @pxref{Duplicate Suppression}.
10883 @node Duplicate Suppression
10884 @section Duplicate Suppression
10886 By default, Gnus tries to make sure that you don't have to read the same
10887 article more than once by utilizing the crossposting mechanism
10888 (@pxref{Crosspost Handling}). However, that simple and efficient
10889 approach may not work satisfactory for some users for various
10894 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
10895 is evil and not very common.
10898 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
10899 @file{.overview} data bases. This is evil and all too common, alas.
10902 You may be reading the same group (or several related groups) from
10903 different @acronym{NNTP} servers.
10906 You may be getting mail that duplicates articles posted to groups.
10909 I'm sure there are other situations where @code{Xref} handling fails as
10910 well, but these four are the most common situations.
10912 If, and only if, @code{Xref} handling fails for you, then you may
10913 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
10914 will remember the @code{Message-ID}s of all articles you have read or
10915 otherwise marked as read, and then, as if by magic, mark them as read
10916 all subsequent times you see them---in @emph{all} groups. Using this
10917 mechanism is quite likely to be somewhat inefficient, but not overly
10918 so. It's certainly preferable to reading the same articles more than
10921 Duplicate suppression is not a very subtle instrument. It's more like a
10922 sledge hammer than anything else. It works in a very simple
10923 fashion---if you have marked an article as read, it adds this Message-ID
10924 to a cache. The next time it sees this Message-ID, it will mark the
10925 article as read with the @samp{M} mark. It doesn't care what group it
10926 saw the article in.
10929 @item gnus-suppress-duplicates
10930 @vindex gnus-suppress-duplicates
10931 If non-@code{nil}, suppress duplicates.
10933 @item gnus-save-duplicate-list
10934 @vindex gnus-save-duplicate-list
10935 If non-@code{nil}, save the list of duplicates to a file. This will
10936 make startup and shutdown take longer, so the default is @code{nil}.
10937 However, this means that only duplicate articles read in a single Gnus
10938 session are suppressed.
10940 @item gnus-duplicate-list-length
10941 @vindex gnus-duplicate-list-length
10942 This variable says how many @code{Message-ID}s to keep in the duplicate
10943 suppression list. The default is 10000.
10945 @item gnus-duplicate-file
10946 @vindex gnus-duplicate-file
10947 The name of the file to store the duplicate suppression list in. The
10948 default is @file{~/News/suppression}.
10951 If you have a tendency to stop and start Gnus often, setting
10952 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
10953 you leave Gnus running for weeks on end, you may have it @code{nil}. On
10954 the other hand, saving the list makes startup and shutdown much slower,
10955 so that means that if you stop and start Gnus often, you should set
10956 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
10957 to you to figure out, I think.
10962 Gnus is able to verify signed messages or decrypt encrypted messages.
10963 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
10964 and @acronym{S/MIME}, however you need some external programs to get
10969 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
10970 install an OpenPGP implementation such as GnuPG. The Lisp interface
10971 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
10972 Manual}), but Mailcrypt and gpg.el are also supported.
10975 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
10976 or newer is recommended.
10980 The variables that control security functionality on reading messages
10984 @item mm-verify-option
10985 @vindex mm-verify-option
10986 Option of verifying signed parts. @code{never}, not verify;
10987 @code{always}, always verify; @code{known}, only verify known
10988 protocols. Otherwise, ask user.
10990 @item mm-decrypt-option
10991 @vindex mm-decrypt-option
10992 Option of decrypting encrypted parts. @code{never}, no decryption;
10993 @code{always}, always decrypt; @code{known}, only decrypt known
10994 protocols. Otherwise, ask user.
10997 @vindex mml1991-use
10998 Symbol indicating elisp interface to OpenPGP implementation for
10999 @acronym{PGP} messages. The default is @code{pgg}, but
11000 @code{mailcrypt} and @code{gpg} are also supported although
11004 @vindex mml2015-use
11005 Symbol indicating elisp interface to OpenPGP implementation for
11006 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
11007 @code{mailcrypt} and @code{gpg} are also supported although
11012 By default the buttons that display security information are not
11013 shown, because they clutter reading the actual e-mail. You can type
11014 @kbd{K b} manually to display the information. Use the
11015 @code{gnus-buttonized-mime-types} and
11016 @code{gnus-unbuttonized-mime-types} variables to control this
11017 permanently. @ref{MIME Commands} for further details, and hints on
11018 how to customize these variables to always display security
11021 @cindex snarfing keys
11022 @cindex importing PGP keys
11023 @cindex PGP key ring import
11024 Snarfing OpenPGP keys (i.e., importing keys from articles into your
11025 key ring) is not supported explicitly through a menu item or command,
11026 rather Gnus do detect and label keys as @samp{application/pgp-keys},
11027 allowing you to specify whatever action you think is appropriate
11028 through the usual @acronym{MIME} infrastructure. You can use a
11029 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
11030 Emacs MIME Manual}) such as the following to import keys using GNU
11031 Privacy Guard when you click on the @acronym{MIME} button
11032 (@pxref{Using MIME}).
11035 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
11038 This happens to also be the default action defined in
11039 @code{mailcap-mime-data}.
11041 More information on how to set things for sending outgoing signed and
11042 encrypted messages up can be found in the message manual
11043 (@pxref{Security, ,Security, message, Message Manual}).
11046 @section Mailing List
11047 @cindex mailing list
11050 @kindex A M (summary)
11051 @findex gnus-mailing-list-insinuate
11052 Gnus understands some mailing list fields of RFC 2369. To enable it,
11053 add a @code{to-list} group parameter (@pxref{Group Parameters}),
11054 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
11057 That enables the following commands to the summary buffer:
11062 @kindex C-c C-n h (Summary)
11063 @findex gnus-mailing-list-help
11064 Send a message to fetch mailing list help, if List-Help field exists.
11067 @kindex C-c C-n s (Summary)
11068 @findex gnus-mailing-list-subscribe
11069 Send a message to subscribe the mailing list, if List-Subscribe field exists.
11072 @kindex C-c C-n u (Summary)
11073 @findex gnus-mailing-list-unsubscribe
11074 Send a message to unsubscribe the mailing list, if List-Unsubscribe
11078 @kindex C-c C-n p (Summary)
11079 @findex gnus-mailing-list-post
11080 Post to the mailing list, if List-Post field exists.
11083 @kindex C-c C-n o (Summary)
11084 @findex gnus-mailing-list-owner
11085 Send a message to the mailing list owner, if List-Owner field exists.
11088 @kindex C-c C-n a (Summary)
11089 @findex gnus-mailing-list-archive
11090 Browse the mailing list archive, if List-Archive field exists.
11095 @node Article Buffer
11096 @chapter Article Buffer
11097 @cindex article buffer
11099 The articles are displayed in the article buffer, of which there is only
11100 one. All the summary buffers share the same article buffer unless you
11101 tell Gnus otherwise.
11104 * Hiding Headers:: Deciding what headers should be displayed.
11105 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
11106 * Customizing Articles:: Tailoring the look of the articles.
11107 * Article Keymap:: Keystrokes available in the article buffer.
11108 * Misc Article:: Other stuff.
11112 @node Hiding Headers
11113 @section Hiding Headers
11114 @cindex hiding headers
11115 @cindex deleting headers
11117 The top section of each article is the @dfn{head}. (The rest is the
11118 @dfn{body}, but you may have guessed that already.)
11120 @vindex gnus-show-all-headers
11121 There is a lot of useful information in the head: the name of the person
11122 who wrote the article, the date it was written and the subject of the
11123 article. That's well and nice, but there's also lots of information
11124 most people do not want to see---what systems the article has passed
11125 through before reaching you, the @code{Message-ID}, the
11126 @code{References}, etc. ad nauseam---and you'll probably want to get rid
11127 of some of those lines. If you want to keep all those lines in the
11128 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
11130 Gnus provides you with two variables for sifting headers:
11134 @item gnus-visible-headers
11135 @vindex gnus-visible-headers
11136 If this variable is non-@code{nil}, it should be a regular expression
11137 that says what headers you wish to keep in the article buffer. All
11138 headers that do not match this variable will be hidden.
11140 For instance, if you only want to see the name of the person who wrote
11141 the article and the subject, you'd say:
11144 (setq gnus-visible-headers "^From:\\|^Subject:")
11147 This variable can also be a list of regexps to match headers to
11150 @item gnus-ignored-headers
11151 @vindex gnus-ignored-headers
11152 This variable is the reverse of @code{gnus-visible-headers}. If this
11153 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
11154 should be a regular expression that matches all lines that you want to
11155 hide. All lines that do not match this variable will remain visible.
11157 For instance, if you just want to get rid of the @code{References} line
11158 and the @code{Xref} line, you might say:
11161 (setq gnus-ignored-headers "^References:\\|^Xref:")
11164 This variable can also be a list of regexps to match headers to
11167 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
11168 variable will have no effect.
11172 @vindex gnus-sorted-header-list
11173 Gnus can also sort the headers for you. (It does this by default.) You
11174 can control the sorting by setting the @code{gnus-sorted-header-list}
11175 variable. It is a list of regular expressions that says in what order
11176 the headers are to be displayed.
11178 For instance, if you want the name of the author of the article first,
11179 and then the subject, you might say something like:
11182 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
11185 Any headers that are to remain visible, but are not listed in this
11186 variable, will be displayed in random order after all the headers listed in this variable.
11188 @findex gnus-article-hide-boring-headers
11189 @vindex gnus-boring-article-headers
11190 You can hide further boring headers by setting
11191 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
11192 does depends on the @code{gnus-boring-article-headers} variable. It's a
11193 list, but this list doesn't actually contain header names. Instead it
11194 lists various @dfn{boring conditions} that Gnus can check and remove
11197 These conditions are:
11200 Remove all empty headers.
11202 Remove the @code{Followup-To} header if it is identical to the
11203 @code{Newsgroups} header.
11205 Remove the @code{Reply-To} header if it lists the same addresses as
11206 the @code{From} header, or if the @code{broken-reply-to} group
11209 Remove the @code{Newsgroups} header if it only contains the current group
11212 Remove the @code{To} header if it only contains the address identical to
11213 the current group's @code{to-address} parameter.
11215 Remove the @code{To} header if it only contains the address identical to
11216 the current group's @code{to-list} parameter.
11218 Remove the @code{Cc} header if it only contains the address identical to
11219 the current group's @code{to-list} parameter.
11221 Remove the @code{Date} header if the article is less than three days
11224 Remove the @code{To} and/or @code{Cc} header if it is very long.
11226 Remove all @code{To} and/or @code{Cc} headers if there are more than one.
11229 To include these three elements, you could say something like:
11232 (setq gnus-boring-article-headers
11233 '(empty followup-to reply-to))
11236 This is also the default value for this variable.
11240 @section Using MIME
11241 @cindex @acronym{MIME}
11243 Mime is a standard for waving your hands through the air, aimlessly,
11244 while people stand around yawning.
11246 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
11247 while all newsreaders die of fear.
11249 @acronym{MIME} may specify what character set the article uses, the encoding
11250 of the characters, and it also makes it possible to embed pictures and
11251 other naughty stuff in innocent-looking articles.
11253 @vindex gnus-display-mime-function
11254 @findex gnus-display-mime
11255 Gnus pushes @acronym{MIME} articles through @code{gnus-display-mime-function}
11256 to display the @acronym{MIME} parts. This is @code{gnus-display-mime} by
11257 default, which creates a bundle of clickable buttons that can be used to
11258 display, save and manipulate the @acronym{MIME} objects.
11260 The following commands are available when you have placed point over a
11261 @acronym{MIME} button:
11264 @findex gnus-article-press-button
11265 @item RET (Article)
11266 @kindex RET (Article)
11267 @itemx BUTTON-2 (Article)
11268 Toggle displaying of the @acronym{MIME} object
11269 (@code{gnus-article-press-button}). If built-in viewers can not display
11270 the object, Gnus resorts to external viewers in the @file{mailcap}
11271 files. If a viewer has the @samp{copiousoutput} specification, the
11272 object is displayed inline.
11274 @findex gnus-mime-view-part
11275 @item M-RET (Article)
11276 @kindex M-RET (Article)
11278 Prompt for a method, and then view the @acronym{MIME} object using this
11279 method (@code{gnus-mime-view-part}).
11281 @findex gnus-mime-view-part-as-type
11283 @kindex t (Article)
11284 View the @acronym{MIME} object as if it were a different @acronym{MIME} media type
11285 (@code{gnus-mime-view-part-as-type}).
11287 @findex gnus-mime-view-part-as-charset
11289 @kindex C (Article)
11290 Prompt for a charset, and then view the @acronym{MIME} object using this
11291 charset (@code{gnus-mime-view-part-as-charset}).
11293 @findex gnus-mime-save-part
11295 @kindex o (Article)
11296 Prompt for a file name, and then save the @acronym{MIME} object
11297 (@code{gnus-mime-save-part}).
11299 @findex gnus-mime-save-part-and-strip
11300 @item C-o (Article)
11301 @kindex C-o (Article)
11302 Prompt for a file name, then save the @acronym{MIME} object and strip it from
11303 the article. Then proceed to article editing, where a reasonable
11304 suggestion is being made on how the altered article should look
11305 like. The stripped @acronym{MIME} object will be referred via the
11306 message/external-body @acronym{MIME} type.
11307 (@code{gnus-mime-save-part-and-strip}).
11309 @findex gnus-mime-replace-part
11311 @kindex r (Article)
11312 Prompt for a file name, replace the @acronym{MIME} object with an
11313 external body refering to the file via the message/external-body
11314 @acronym{MIME} type. (@code{gnus-mime-replace-part}).
11316 @findex gnus-mime-delete-part
11318 @kindex d (Article)
11319 Delete the @acronym{MIME} object from the article and replace it with some
11320 information about the removed @acronym{MIME} object
11321 (@code{gnus-mime-delete-part}).
11323 @c FIXME: gnus-auto-select-part should be documented here
11325 @findex gnus-mime-copy-part
11327 @kindex c (Article)
11328 Copy the @acronym{MIME} object to a fresh buffer and display this buffer
11329 (@code{gnus-mime-copy-part}). If given a prefix, copy the raw contents
11330 without decoding. If given a numerical prefix, you can do semi-manual
11331 charset stuff (see @code{gnus-summary-show-article-charset-alist} in
11332 @ref{Paging the Article}). Compressed files like @file{.gz} and
11333 @file{.bz2} are automatically decompressed if
11334 @code{auto-compression-mode} is enabled (@pxref{Compressed Files,,
11335 Accessing Compressed Files, emacs, The Emacs Editor}).
11337 @findex gnus-mime-print-part
11339 @kindex p (Article)
11340 Print the @acronym{MIME} object (@code{gnus-mime-print-part}). This
11341 command respects the @samp{print=} specifications in the
11342 @file{.mailcap} file.
11344 @findex gnus-mime-inline-part
11346 @kindex i (Article)
11347 Insert the contents of the @acronym{MIME} object into the buffer
11348 (@code{gnus-mime-inline-part}) as text/plain. If given a prefix, insert
11349 the raw contents without decoding. If given a numerical prefix, you can
11350 do semi-manual charset stuff (see
11351 @code{gnus-summary-show-article-charset-alist} in @ref{Paging the
11352 Article}). Compressed files like @file{.gz} and @file{.bz2} are
11353 automatically decompressed depending on @code{jka-compr} regardless of
11354 @code{auto-compression-mode} (@pxref{Compressed Files,, Accessing
11355 Compressed Files, emacs, The Emacs Editor}).
11357 @findex gnus-mime-view-part-internally
11359 @kindex E (Article)
11360 View the @acronym{MIME} object with an internal viewer. If no internal
11361 viewer is available, use an external viewer
11362 (@code{gnus-mime-view-part-internally}).
11364 @findex gnus-mime-view-part-externally
11366 @kindex e (Article)
11367 View the @acronym{MIME} object with an external viewer.
11368 (@code{gnus-mime-view-part-externally}).
11370 @findex gnus-mime-pipe-part
11372 @kindex | (Article)
11373 Output the @acronym{MIME} object to a process (@code{gnus-mime-pipe-part}).
11375 @findex gnus-mime-action-on-part
11377 @kindex . (Article)
11378 Interactively run an action on the @acronym{MIME} object
11379 (@code{gnus-mime-action-on-part}).
11383 Gnus will display some @acronym{MIME} objects automatically. The way Gnus
11384 determines which parts to do this with is described in the Emacs
11385 @acronym{MIME} manual.
11387 It might be best to just use the toggling functions from the article
11388 buffer to avoid getting nasty surprises. (For instance, you enter the
11389 group @samp{alt.sing-a-long} and, before you know it, @acronym{MIME} has
11390 decoded the sound file in the article and some horrible sing-a-long song
11391 comes screaming out your speakers, and you can't find the volume button,
11392 because there isn't one, and people are starting to look at you, and you
11393 try to stop the program, but you can't, and you can't find the program
11394 to control the volume, and everybody else in the room suddenly decides
11395 to look at you disdainfully, and you'll feel rather stupid.)
11397 Any similarity to real events and people is purely coincidental. Ahem.
11399 Also @pxref{MIME Commands}.
11402 @node Customizing Articles
11403 @section Customizing Articles
11404 @cindex article customization
11406 A slew of functions for customizing how the articles are to look like
11407 exist. You can call these functions interactively
11408 (@pxref{Article Washing}), or you can have them
11409 called automatically when you select the articles.
11411 To have them called automatically, you should set the corresponding
11412 ``treatment'' variable. For instance, to have headers hidden, you'd set
11413 @code{gnus-treat-hide-headers}. Below is a list of variables that can
11414 be set, but first we discuss the values these variables can have.
11416 Note: Some values, while valid, make little sense. Check the list below
11417 for sensible values.
11421 @code{nil}: Don't do this treatment.
11424 @code{t}: Do this treatment on all body parts.
11427 @code{head}: Do the treatment on the headers.
11430 @code{first}: Do this treatment on the first body part.
11433 @code{last}: Do this treatment on the last body part.
11436 An integer: Do this treatment on all body parts that have a length less
11440 A list of strings: Do this treatment on all body parts that are in
11441 articles that are read in groups that have names that match one of the
11442 regexps in the list.
11445 A list where the first element is not a string:
11447 The list is evaluated recursively. The first element of the list is a
11448 predicate. The following predicates are recognized: @code{or},
11449 @code{and}, @code{not} and @code{typep}. Here's an example:
11453 (typep "text/x-vcard"))
11458 You may have noticed that the word @dfn{part} is used here. This refers
11459 to the fact that some messages are @acronym{MIME} multipart articles that may
11460 be divided into several parts. Articles that are not multiparts are
11461 considered to contain just a single part.
11463 @vindex gnus-article-treat-types
11464 Are the treatments applied to all sorts of multipart parts? Yes, if you
11465 want to, but by default, only @samp{text/plain} parts are given the
11466 treatment. This is controlled by the @code{gnus-article-treat-types}
11467 variable, which is a list of regular expressions that are matched to the
11468 type of the part. This variable is ignored if the value of the
11469 controlling variable is a predicate list, as described above.
11472 @c Avoid sort of redundant entries in the same section for the printed
11473 @c manual, but add them in info to allow `i gnus-treat-foo-bar RET' or
11475 @vindex gnus-treat-buttonize
11476 @vindex gnus-treat-buttonize-head
11477 @vindex gnus-treat-capitalize-sentences
11478 @vindex gnus-treat-overstrike
11479 @vindex gnus-treat-strip-cr
11480 @vindex gnus-treat-strip-headers-in-body
11481 @vindex gnus-treat-strip-leading-blank-lines
11482 @vindex gnus-treat-strip-multiple-blank-lines
11483 @vindex gnus-treat-strip-pem
11484 @vindex gnus-treat-strip-trailing-blank-lines
11485 @vindex gnus-treat-unsplit-urls
11486 @vindex gnus-treat-wash-html
11487 @vindex gnus-treat-date-english
11488 @vindex gnus-treat-date-iso8601
11489 @vindex gnus-treat-date-lapsed
11490 @vindex gnus-treat-date-local
11491 @vindex gnus-treat-date-original
11492 @vindex gnus-treat-date-user-defined
11493 @vindex gnus-treat-date-ut
11494 @vindex gnus-treat-from-picon
11495 @vindex gnus-treat-mail-picon
11496 @vindex gnus-treat-newsgroups-picon
11497 @vindex gnus-treat-display-smileys
11498 @vindex gnus-treat-body-boundary
11499 @vindex gnus-treat-display-x-face
11500 @vindex gnus-treat-display-face
11501 @vindex gnus-treat-emphasize
11502 @vindex gnus-treat-fill-article
11503 @vindex gnus-treat-fill-long-lines
11504 @vindex gnus-treat-hide-boring-headers
11505 @vindex gnus-treat-hide-citation
11506 @vindex gnus-treat-hide-citation-maybe
11507 @vindex gnus-treat-hide-headers
11508 @vindex gnus-treat-hide-signature
11509 @vindex gnus-treat-strip-banner
11510 @vindex gnus-treat-strip-list-identifiers
11511 @vindex gnus-treat-highlight-citation
11512 @vindex gnus-treat-highlight-headers
11513 @vindex gnus-treat-highlight-signature
11514 @vindex gnus-treat-play-sounds
11515 @vindex gnus-treat-translate
11516 @vindex gnus-treat-x-pgp-sig
11517 @vindex gnus-treat-unfold-headers
11518 @vindex gnus-treat-fold-headers
11519 @vindex gnus-treat-fold-newsgroups
11520 @vindex gnus-treat-leading-whitespace
11523 The following treatment options are available. The easiest way to
11524 customize this is to examine the @code{gnus-article-treat} customization
11525 group. Values in parenthesis are suggested sensible values. Others are
11526 possible but those listed are probably sufficient for most people.
11529 @item gnus-treat-buttonize (t, integer)
11530 @item gnus-treat-buttonize-head (head)
11532 @xref{Article Buttons}.
11534 @item gnus-treat-capitalize-sentences (t, integer)
11535 @item gnus-treat-overstrike (t, integer)
11536 @item gnus-treat-strip-cr (t, integer)
11537 @item gnus-treat-strip-headers-in-body (t, integer)
11538 @item gnus-treat-strip-leading-blank-lines (t, first, integer)
11539 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11540 @item gnus-treat-strip-pem (t, last, integer)
11541 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11542 @item gnus-treat-unsplit-urls (t, integer)
11543 @item gnus-treat-wash-html (t, integer)
11545 @xref{Article Washing}.
11547 @item gnus-treat-date-english (head)
11548 @item gnus-treat-date-iso8601 (head)
11549 @item gnus-treat-date-lapsed (head)
11550 @item gnus-treat-date-local (head)
11551 @item gnus-treat-date-original (head)
11552 @item gnus-treat-date-user-defined (head)
11553 @item gnus-treat-date-ut (head)
11555 @xref{Article Date}.
11557 @item gnus-treat-from-picon (head)
11558 @item gnus-treat-mail-picon (head)
11559 @item gnus-treat-newsgroups-picon (head)
11563 @item gnus-treat-display-smileys (t, integer)
11565 @item gnus-treat-body-boundary (head)
11567 @vindex gnus-body-boundary-delimiter
11568 Adds a delimiter between header and body, the string used as delimiter
11569 is controlled by @code{gnus-body-boundary-delimiter}.
11573 @vindex gnus-treat-display-x-face
11574 @item gnus-treat-display-x-face (head)
11578 @vindex gnus-treat-display-face
11579 @item gnus-treat-display-face (head)
11583 @vindex gnus-treat-emphasize
11584 @item gnus-treat-emphasize (t, head, integer)
11585 @vindex gnus-treat-fill-article
11586 @item gnus-treat-fill-article (t, integer)
11587 @vindex gnus-treat-fill-long-lines
11588 @item gnus-treat-fill-long-lines (t, integer)
11589 @vindex gnus-treat-hide-boring-headers
11590 @item gnus-treat-hide-boring-headers (head)
11591 @vindex gnus-treat-hide-citation
11592 @item gnus-treat-hide-citation (t, integer)
11593 @vindex gnus-treat-hide-citation-maybe
11594 @item gnus-treat-hide-citation-maybe (t, integer)
11595 @vindex gnus-treat-hide-headers
11596 @item gnus-treat-hide-headers (head)
11597 @vindex gnus-treat-hide-signature
11598 @item gnus-treat-hide-signature (t, last)
11599 @vindex gnus-treat-strip-banner
11600 @item gnus-treat-strip-banner (t, last)
11601 @vindex gnus-treat-strip-list-identifiers
11602 @item gnus-treat-strip-list-identifiers (head)
11604 @xref{Article Hiding}.
11606 @vindex gnus-treat-highlight-citation
11607 @item gnus-treat-highlight-citation (t, integer)
11608 @vindex gnus-treat-highlight-headers
11609 @item gnus-treat-highlight-headers (head)
11610 @vindex gnus-treat-highlight-signature
11611 @item gnus-treat-highlight-signature (t, last, integer)
11613 @xref{Article Highlighting}.
11615 @vindex gnus-treat-play-sounds
11616 @item gnus-treat-play-sounds
11617 @vindex gnus-treat-translate
11618 @item gnus-treat-translate
11619 @item gnus-treat-ansi-sequences (t)
11620 @vindex gnus-treat-x-pgp-sig
11621 @item gnus-treat-x-pgp-sig (head)
11623 @vindex gnus-treat-unfold-headers
11624 @item gnus-treat-unfold-headers (head)
11625 @vindex gnus-treat-fold-headers
11626 @item gnus-treat-fold-headers (head)
11627 @vindex gnus-treat-fold-newsgroups
11628 @item gnus-treat-fold-newsgroups (head)
11629 @vindex gnus-treat-leading-whitespace
11630 @item gnus-treat-leading-whitespace (head)
11632 @xref{Article Header}.
11637 @vindex gnus-part-display-hook
11638 You can, of course, write your own functions to be called from
11639 @code{gnus-part-display-hook}. The functions are called narrowed to the
11640 part, and you can do anything you like, pretty much. There is no
11641 information that you have to keep in the buffer---you can change
11645 @node Article Keymap
11646 @section Article Keymap
11648 Most of the keystrokes in the summary buffer can also be used in the
11649 article buffer. They should behave as if you typed them in the summary
11650 buffer, which means that you don't actually have to have a summary
11651 buffer displayed while reading. You can do it all from the article
11654 @kindex v (Article)
11655 @cindex keys, reserved for users (Article)
11656 The key @kbd{v} is reserved for users. You can bind it key to some
11657 function or better use it as a prefix key.
11659 A few additional keystrokes are available:
11664 @kindex SPACE (Article)
11665 @findex gnus-article-next-page
11666 Scroll forwards one page (@code{gnus-article-next-page}).
11667 This is exactly the same as @kbd{h SPACE h}.
11670 @kindex DEL (Article)
11671 @findex gnus-article-prev-page
11672 Scroll backwards one page (@code{gnus-article-prev-page}).
11673 This is exactly the same as @kbd{h DEL h}.
11676 @kindex C-c ^ (Article)
11677 @findex gnus-article-refer-article
11678 If point is in the neighborhood of a @code{Message-ID} and you press
11679 @kbd{C-c ^}, Gnus will try to get that article from the server
11680 (@code{gnus-article-refer-article}).
11683 @kindex C-c C-m (Article)
11684 @findex gnus-article-mail
11685 Send a reply to the address near point (@code{gnus-article-mail}). If
11686 given a prefix, include the mail.
11689 @kindex s (Article)
11690 @findex gnus-article-show-summary
11691 Reconfigure the buffers so that the summary buffer becomes visible
11692 (@code{gnus-article-show-summary}).
11695 @kindex ? (Article)
11696 @findex gnus-article-describe-briefly
11697 Give a very brief description of the available keystrokes
11698 (@code{gnus-article-describe-briefly}).
11701 @kindex TAB (Article)
11702 @findex gnus-article-next-button
11703 Go to the next button, if any (@code{gnus-article-next-button}). This
11704 only makes sense if you have buttonizing turned on.
11707 @kindex M-TAB (Article)
11708 @findex gnus-article-prev-button
11709 Go to the previous button, if any (@code{gnus-article-prev-button}).
11712 @kindex R (Article)
11713 @findex gnus-article-reply-with-original
11714 Send a reply to the current article and yank the current article
11715 (@code{gnus-article-reply-with-original}). If given a prefix, make a
11716 wide reply. If the region is active, only yank the text in the
11720 @kindex F (Article)
11721 @findex gnus-article-followup-with-original
11722 Send a followup to the current article and yank the current article
11723 (@code{gnus-article-followup-with-original}). If given a prefix, make
11724 a wide reply. If the region is active, only yank the text in the
11732 @section Misc Article
11736 @item gnus-single-article-buffer
11737 @vindex gnus-single-article-buffer
11738 If non-@code{nil}, use the same article buffer for all the groups.
11739 (This is the default.) If @code{nil}, each group will have its own
11742 @vindex gnus-article-decode-hook
11743 @item gnus-article-decode-hook
11744 @cindex @acronym{MIME}
11745 Hook used to decode @acronym{MIME} articles. The default value is
11746 @code{(article-decode-charset article-decode-encoded-words)}
11748 @vindex gnus-article-prepare-hook
11749 @item gnus-article-prepare-hook
11750 This hook is called right after the article has been inserted into the
11751 article buffer. It is mainly intended for functions that do something
11752 depending on the contents; it should probably not be used for changing
11753 the contents of the article buffer.
11755 @item gnus-article-mode-hook
11756 @vindex gnus-article-mode-hook
11757 Hook called in article mode buffers.
11759 @item gnus-article-mode-syntax-table
11760 @vindex gnus-article-mode-syntax-table
11761 Syntax table used in article buffers. It is initialized from
11762 @code{text-mode-syntax-table}.
11764 @vindex gnus-article-over-scroll
11765 @item gnus-article-over-scroll
11766 If non-@code{nil}, allow scrolling the article buffer even when there
11767 no more new text to scroll in. The default is @code{nil}.
11769 @vindex gnus-article-mode-line-format
11770 @item gnus-article-mode-line-format
11771 This variable is a format string along the same lines as
11772 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
11773 Line}). It accepts the same format specifications as that variable,
11774 with two extensions:
11779 The @dfn{wash status} of the article. This is a short string with one
11780 character for each possible article wash operation that may have been
11781 performed. The characters and their meaning:
11786 Displayed when cited text may be hidden in the article buffer.
11789 Displayed when headers are hidden in the article buffer.
11792 Displayed when article is digitally signed or encrypted, and Gnus has
11793 hidden the security headers. (N.B. does not tell anything about
11794 security status, i.e. good or bad signature.)
11797 Displayed when the signature has been hidden in the Article buffer.
11800 Displayed when Gnus has treated overstrike characters in the article buffer.
11803 Displayed when Gnus has treated emphasised strings in the article buffer.
11808 The number of @acronym{MIME} parts in the article.
11812 @vindex gnus-break-pages
11814 @item gnus-break-pages
11815 Controls whether @dfn{page breaking} is to take place. If this variable
11816 is non-@code{nil}, the articles will be divided into pages whenever a
11817 page delimiter appears in the article. If this variable is @code{nil},
11818 paging will not be done.
11820 @item gnus-page-delimiter
11821 @vindex gnus-page-delimiter
11822 This is the delimiter mentioned above. By default, it is @samp{^L}
11826 @cindex internationalized domain names
11827 @vindex gnus-use-idna
11828 @item gnus-use-idna
11829 This variable controls whether Gnus performs IDNA decoding of
11830 internationalized domain names inside @samp{From}, @samp{To} and
11831 @samp{Cc} headers. @xref{IDNA, ,IDNA,message, The Message Manual},
11832 for how to compose such messages. This requires
11833 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
11834 variable is only enabled if you have installed it.
11839 @node Composing Messages
11840 @chapter Composing Messages
11841 @cindex composing messages
11844 @cindex sending mail
11849 @cindex using s/mime
11850 @cindex using smime
11852 @kindex C-c C-c (Post)
11853 All commands for posting and mailing will put you in a message buffer
11854 where you can edit the article all you like, before you send the
11855 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
11856 Message Manual}. Where the message will be posted/mailed to depends
11857 on your setup (@pxref{Posting Server}).
11860 * Mail:: Mailing and replying.
11861 * Posting Server:: What server should you post and mail via?
11862 * POP before SMTP:: You cannot send a mail unless you read a mail.
11863 * Mail and Post:: Mailing and posting at the same time.
11864 * Archived Messages:: Where Gnus stores the messages you've sent.
11865 * Posting Styles:: An easier way to specify who you are.
11866 * Drafts:: Postponing messages and rejected messages.
11867 * Rejected Articles:: What happens if the server doesn't like your article?
11868 * Signing and encrypting:: How to compose secure messages.
11871 Also @pxref{Canceling and Superseding} for information on how to
11872 remove articles you shouldn't have posted.
11878 Variables for customizing outgoing mail:
11881 @item gnus-uu-digest-headers
11882 @vindex gnus-uu-digest-headers
11883 List of regexps to match headers included in digested messages. The
11884 headers will be included in the sequence they are matched. If
11885 @code{nil} include all headers.
11887 @item gnus-add-to-list
11888 @vindex gnus-add-to-list
11889 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11890 that have none when you do a @kbd{a}.
11892 @item gnus-confirm-mail-reply-to-news
11893 @vindex gnus-confirm-mail-reply-to-news
11894 If non-@code{nil}, Gnus will ask you for a confirmation when you are
11895 about to reply to news articles by mail. If it is @code{nil}, nothing
11896 interferes in what you want to do. This can also be a function
11897 receiving the group name as the only parameter which should return
11898 non-@code{nil} if a confirmation is needed, or a regular expression
11899 matching group names, where confirmation should be asked for.
11901 If you find yourself never wanting to reply to mail, but occasionally
11902 press @kbd{R} anyway, this variable might be for you.
11904 @item gnus-confirm-treat-mail-like-news
11905 @vindex gnus-confirm-treat-mail-like-news
11906 If non-@code{nil}, Gnus also requests confirmation according to
11907 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
11908 useful for treating mailing lists like newsgroups.
11913 @node Posting Server
11914 @section Posting Server
11916 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11917 (extremely intelligent, of course) article, where does it go?
11919 Thank you for asking. I hate you.
11921 It can be quite complicated.
11923 @vindex gnus-post-method
11924 When posting news, Message usually invokes @code{message-send-news}
11925 (@pxref{News Variables, , News Variables, message, Message Manual}).
11926 Normally, Gnus will post using the same select method as you're
11927 reading from (which might be convenient if you're reading lots of
11928 groups from different private servers). However. If the server
11929 you're reading from doesn't allow posting, just reading, you probably
11930 want to use some other server to post your (extremely intelligent and
11931 fabulously interesting) articles. You can then set the
11932 @code{gnus-post-method} to some other method:
11935 (setq gnus-post-method '(nnspool ""))
11938 Now, if you've done this, and then this server rejects your article, or
11939 this server is down, what do you do then? To override this variable you
11940 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11941 the ``current'' server, to get back the default behavior, for posting.
11943 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11944 Gnus will prompt you for what method to use for posting.
11946 You can also set @code{gnus-post-method} to a list of select methods.
11947 If that's the case, Gnus will always prompt you for what method to use
11950 Finally, if you want to always post using the native select method,
11951 you can set this variable to @code{native}.
11953 When sending mail, Message invokes @code{message-send-mail-function}.
11954 The default function, @code{message-send-mail-with-sendmail}, pipes
11955 your article to the @code{sendmail} binary for further queuing and
11956 sending. When your local system is not configured for sending mail
11957 using @code{sendmail}, and you have access to a remote @acronym{SMTP}
11958 server, you can set @code{message-send-mail-function} to
11959 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11960 package correctly. An example:
11963 (setq message-send-mail-function 'smtpmail-send-it
11964 smtpmail-default-smtp-server "YOUR SMTP HOST")
11967 To the thing similar to this, there is
11968 @code{message-smtpmail-send-it}. It is useful if your @acronym{ISP}
11969 requires the @acronym{POP}-before-@acronym{SMTP} authentication.
11970 @xref{POP before SMTP}.
11972 Other possible choices for @code{message-send-mail-function} includes
11973 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11974 and @code{feedmail-send-it}.
11976 @node POP before SMTP
11977 @section POP before SMTP
11978 @cindex pop before smtp
11979 @findex message-smtpmail-send-it
11980 @findex mail-source-touch-pop
11982 Does your @acronym{ISP} require the @acronym{POP}-before-@acronym{SMTP}
11983 authentication? It is whether you need to connect to the @acronym{POP}
11984 mail server within a certain time before sending mails. If so, there is
11985 a convenient way. To do that, put the following lines in your
11986 @file{~/.gnus.el} file:
11989 (setq message-send-mail-function 'message-smtpmail-send-it)
11990 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
11994 It means to let Gnus connect to the @acronym{POP} mail server in advance
11995 whenever you send a mail. The @code{mail-source-touch-pop} function
11996 does only a @acronym{POP} authentication according to the value of
11997 @code{mail-sources} without fetching mails, just before sending a mail.
11998 Note that you have to use @code{message-smtpmail-send-it} which runs
11999 @code{message-send-mail-hook} rather than @code{smtpmail-send-it} and
12000 set the value of @code{mail-sources} for a @acronym{POP} connection
12001 correctly. @xref{Mail Sources}.
12003 If you have two or more @acronym{POP} mail servers set in
12004 @code{mail-sources}, you may want to specify one of them to
12005 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
12006 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
12007 is your primary @acronym{POP} mail server (i.e., you are fetching mails
12008 mainly from that server), you can set it permanently as follows:
12011 (setq mail-source-primary-source
12012 '(pop :server "pop3.mail.server"
12013 :password "secret"))
12017 Otherwise, bind it dynamically only when performing the
12018 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
12021 (add-hook 'message-send-mail-hook
12023 (let ((mail-source-primary-source
12024 '(pop :server "pop3.mail.server"
12025 :password "secret")))
12026 (mail-source-touch-pop))))
12029 @node Mail and Post
12030 @section Mail and Post
12032 Here's a list of variables relevant to both mailing and
12036 @item gnus-mailing-list-groups
12037 @findex gnus-mailing-list-groups
12038 @cindex mailing lists
12040 If your news server offers groups that are really mailing lists
12041 gatewayed to the @acronym{NNTP} server, you can read those groups without
12042 problems, but you can't post/followup to them without some difficulty.
12043 One solution is to add a @code{to-address} to the group parameters
12044 (@pxref{Group Parameters}). An easier thing to do is set the
12045 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
12046 really are mailing lists. Then, at least, followups to the mailing
12047 lists will work most of the time. Posting to these groups (@kbd{a}) is
12048 still a pain, though.
12050 @item gnus-user-agent
12051 @vindex gnus-user-agent
12054 This variable controls which information should be exposed in the
12055 User-Agent header. It can be a list of symbols or a string. Valid
12056 symbols are @code{gnus} (show Gnus version) and @code{emacs} (show Emacs
12057 version). In addition to the Emacs version, you can add @code{codename}
12058 (show (S)XEmacs codename) or either @code{config} (show system
12059 configuration) or @code{type} (show system type). If you set it to a
12060 string, be sure to use a valid format, see RFC 2616.
12064 You may want to do spell-checking on messages that you send out. Or, if
12065 you don't want to spell-check by hand, you could add automatic
12066 spell-checking via the @code{ispell} package:
12069 @findex ispell-message
12071 (add-hook 'message-send-hook 'ispell-message)
12074 If you want to change the @code{ispell} dictionary based on what group
12075 you're in, you could say something like the following:
12078 (add-hook 'gnus-select-group-hook
12082 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
12083 (ispell-change-dictionary "deutsch"))
12085 (ispell-change-dictionary "english")))))
12088 Modify to suit your needs.
12090 @vindex gnus-message-highlight-citation
12091 If @code{gnus-message-highlight-citation} is t, different levels of
12092 citations are highlighted like in Gnus article buffers also in message
12095 @node Archived Messages
12096 @section Archived Messages
12097 @cindex archived messages
12098 @cindex sent messages
12100 Gnus provides a few different methods for storing the mail and news you
12101 send. The default method is to use the @dfn{archive virtual server} to
12102 store the messages. If you want to disable this completely, the
12103 @code{gnus-message-archive-group} variable should be @code{nil}, which
12106 For archiving interesting messages in a group you read, see the
12107 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
12110 @vindex gnus-message-archive-method
12111 @code{gnus-message-archive-method} says what virtual server Gnus is to
12112 use to store sent messages. The default is:
12115 (nnfolder "archive"
12116 (nnfolder-directory "~/Mail/archive")
12117 (nnfolder-active-file "~/Mail/archive/active")
12118 (nnfolder-get-new-mail nil)
12119 (nnfolder-inhibit-expiry t))
12122 You can, however, use any mail select method (@code{nnml},
12123 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
12124 for doing this sort of thing, though. If you don't like the default
12125 directory chosen, you could say something like:
12128 (setq gnus-message-archive-method
12129 '(nnfolder "archive"
12130 (nnfolder-inhibit-expiry t)
12131 (nnfolder-active-file "~/News/sent-mail/active")
12132 (nnfolder-directory "~/News/sent-mail/")))
12135 @vindex gnus-message-archive-group
12137 Gnus will insert @code{Gcc} headers in all outgoing messages that point
12138 to one or more group(s) on that server. Which group to use is
12139 determined by the @code{gnus-message-archive-group} variable.
12141 This variable can be used to do the following:
12145 Messages will be saved in that group.
12147 Note that you can include a select method in the group name, then the
12148 message will not be stored in the select method given by
12149 @code{gnus-message-archive-method}, but in the select method specified
12150 by the group name, instead. Suppose @code{gnus-message-archive-method}
12151 has the default value shown above. Then setting
12152 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
12153 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
12154 value @code{"nnml:foo"}, then outgoing messages will be stored in
12157 @item a list of strings
12158 Messages will be saved in all those groups.
12160 @item an alist of regexps, functions and forms
12161 When a key ``matches'', the result is used.
12164 No message archiving will take place. This is the default.
12169 Just saving to a single group called @samp{MisK}:
12171 (setq gnus-message-archive-group "MisK")
12174 Saving to two groups, @samp{MisK} and @samp{safe}:
12176 (setq gnus-message-archive-group '("MisK" "safe"))
12179 Save to different groups based on what group you are in:
12181 (setq gnus-message-archive-group
12182 '(("^alt" "sent-to-alt")
12183 ("mail" "sent-to-mail")
12184 (".*" "sent-to-misc")))
12187 More complex stuff:
12189 (setq gnus-message-archive-group
12190 '((if (message-news-p)
12195 How about storing all news messages in one file, but storing all mail
12196 messages in one file per month:
12199 (setq gnus-message-archive-group
12200 '((if (message-news-p)
12202 (concat "mail." (format-time-string "%Y-%m")))))
12205 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
12206 @c use a different value for @code{gnus-message-archive-group} there.)
12208 Now, when you send a message off, it will be stored in the appropriate
12209 group. (If you want to disable storing for just one particular message,
12210 you can just remove the @code{Gcc} header that has been inserted.) The
12211 archive group will appear in the group buffer the next time you start
12212 Gnus, or the next time you press @kbd{F} in the group buffer. You can
12213 enter it and read the articles in it just like you'd read any other
12214 group. If the group gets really big and annoying, you can simply rename
12215 if (using @kbd{G r} in the group buffer) to something
12216 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
12217 continue to be stored in the old (now empty) group.
12219 That's the default method of archiving sent messages. Gnus offers a
12220 different way for the people who don't like the default method. In that
12221 case you should set @code{gnus-message-archive-group} to @code{nil};
12222 this will disable archiving.
12225 @item gnus-outgoing-message-group
12226 @vindex gnus-outgoing-message-group
12227 All outgoing messages will be put in this group. If you want to store
12228 all your outgoing mail and articles in the group @samp{nnml:archive},
12229 you set this variable to that value. This variable can also be a list of
12232 If you want to have greater control over what group to put each
12233 message in, you can set this variable to a function that checks the
12234 current newsgroup name and then returns a suitable group name (or list
12237 This variable can be used instead of @code{gnus-message-archive-group},
12238 but the latter is the preferred method.
12240 @item gnus-gcc-mark-as-read
12241 @vindex gnus-gcc-mark-as-read
12242 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
12244 @item gnus-gcc-externalize-attachments
12245 @vindex gnus-gcc-externalize-attachments
12246 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
12247 and matches the Gcc group name, attach files as external parts; if it is
12248 @code{all}, attach local files as external parts; if it is other
12249 non-@code{nil}, the behavior is the same as @code{all}, but it may be
12250 changed in the future.
12255 @node Posting Styles
12256 @section Posting Styles
12257 @cindex posting styles
12260 All them variables, they make my head swim.
12262 So what if you want a different @code{Organization} and signature based
12263 on what groups you post to? And you post both from your home machine
12264 and your work machine, and you want different @code{From} lines, and so
12267 @vindex gnus-posting-styles
12268 One way to do stuff like that is to write clever hooks that change the
12269 variables you need to have changed. That's a bit boring, so somebody
12270 came up with the bright idea of letting the user specify these things in
12271 a handy alist. Here's an example of a @code{gnus-posting-styles}
12276 (signature "Peace and happiness")
12277 (organization "What me?"))
12279 (signature "Death to everybody"))
12280 ("comp.emacs.i-love-it"
12281 (organization "Emacs is it")))
12284 As you might surmise from this example, this alist consists of several
12285 @dfn{styles}. Each style will be applicable if the first element
12286 ``matches'', in some form or other. The entire alist will be iterated
12287 over, from the beginning towards the end, and each match will be
12288 applied, which means that attributes in later styles that match override
12289 the same attributes in earlier matching styles. So
12290 @samp{comp.programming.literate} will have the @samp{Death to everybody}
12291 signature and the @samp{What me?} @code{Organization} header.
12293 The first element in each style is called the @code{match}. If it's a
12294 string, then Gnus will try to regexp match it against the group name.
12295 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
12296 will look in the original article for a header whose name is
12297 @var{match} and compare that @var{regexp}. @var{match} and
12298 @var{regexp} are strings. (The original article is the one you are
12299 replying or following up to. If you are not composing a reply or a
12300 followup, then there is nothing to match against.) If the
12301 @code{match} is a function symbol, that function will be called with
12302 no arguments. If it's a variable symbol, then the variable will be
12303 referenced. If it's a list, then that list will be @code{eval}ed. In
12304 any case, if this returns a non-@code{nil} value, then the style is
12305 said to @dfn{match}.
12307 Each style may contain an arbitrary amount of @dfn{attributes}. Each
12308 attribute consists of a @code{(@var{name} @var{value})} pair. In
12309 addition, you can also use the @code{(@var{name} :file @var{value})}
12310 form or the @code{(@var{name} :value @var{value})} form. Where
12311 @code{:file} signifies @var{value} represents a file name and its
12312 contents should be used as the attribute value, @code{:value} signifies
12313 @var{value} does not represent a file name explicitly. The attribute
12314 name can be one of:
12317 @item @code{signature}
12318 @item @code{signature-file}
12319 @item @code{x-face-file}
12320 @item @code{address}, overriding @code{user-mail-address}
12321 @item @code{name}, overriding @code{(user-full-name)}
12325 Note that the @code{signature-file} attribute honors the variable
12326 @code{message-signature-directory}.
12328 The attribute name can also be a string or a symbol. In that case,
12329 this will be used as a header name, and the value will be inserted in
12330 the headers of the article; if the value is @code{nil}, the header
12331 name will be removed. If the attribute name is @code{eval}, the form
12332 is evaluated, and the result is thrown away.
12334 The attribute value can be a string (used verbatim), a function with
12335 zero arguments (the return value will be used), a variable (its value
12336 will be used) or a list (it will be @code{eval}ed and the return value
12337 will be used). The functions and sexps are called/@code{eval}ed in the
12338 message buffer that is being set up. The headers of the current article
12339 are available through the @code{message-reply-headers} variable, which
12340 is a vector of the following headers: number subject from date id
12341 references chars lines xref extra.
12343 @vindex message-reply-headers
12345 If you wish to check whether the message you are about to compose is
12346 meant to be a news article or a mail message, you can check the values
12347 of the @code{message-news-p} and @code{message-mail-p} functions.
12349 @findex message-mail-p
12350 @findex message-news-p
12352 So here's a new example:
12355 (setq gnus-posting-styles
12357 (signature-file "~/.signature")
12359 (x-face-file "~/.xface")
12360 (x-url (getenv "WWW_HOME"))
12361 (organization "People's Front Against MWM"))
12363 (signature my-funny-signature-randomizer))
12364 ((equal (system-name) "gnarly") ;; @r{A form}
12365 (signature my-quote-randomizer))
12366 (message-news-p ;; @r{A function symbol}
12367 (signature my-news-signature))
12368 (window-system ;; @r{A value symbol}
12369 ("X-Window-System" (format "%s" window-system)))
12370 ;; @r{If I'm replying to Larsi, set the Organization header.}
12371 ((header "from" "larsi.*org")
12372 (Organization "Somewhere, Inc."))
12373 ((posting-from-work-p) ;; @r{A user defined function}
12374 (signature-file "~/.work-signature")
12375 (address "user@@bar.foo")
12376 (body "You are fired.\n\nSincerely, your boss.")
12377 (organization "Important Work, Inc"))
12379 (From (save-excursion
12380 (set-buffer gnus-article-buffer)
12381 (message-fetch-field "to"))))
12383 (signature-file "~/.mail-signature"))))
12386 The @samp{nnml:.*} rule means that you use the @code{To} address as the
12387 @code{From} address in all your outgoing replies, which might be handy
12388 if you fill many roles.
12389 You may also use @code{message-alternative-emails} instead.
12390 @xref{Message Headers, ,Message Headers, message, Message Manual}.
12396 If you are writing a message (mail or news) and suddenly remember that
12397 you have a steak in the oven (or some pesto in the food processor, you
12398 craaazy vegetarians), you'll probably wish there was a method to save
12399 the message you are writing so that you can continue editing it some
12400 other day, and send it when you feel its finished.
12402 Well, don't worry about it. Whenever you start composing a message of
12403 some sort using the Gnus mail and post commands, the buffer you get will
12404 automatically associate to an article in a special @dfn{draft} group.
12405 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
12406 article will be saved there. (Auto-save files also go to the draft
12410 @vindex nndraft-directory
12411 The draft group is a special group (which is implemented as an
12412 @code{nndraft} group, if you absolutely have to know) called
12413 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
12414 @code{nndraft} is to store its files. What makes this group special is
12415 that you can't tick any articles in it or mark any articles as
12416 read---all articles in the group are permanently unread.
12418 If the group doesn't exist, it will be created and you'll be subscribed
12419 to it. The only way to make it disappear from the Group buffer is to
12420 unsubscribe it. The special properties of the draft group comes from
12421 a group property (@pxref{Group Parameters}), and if lost the group
12422 behaves like any other group. This means the commands below will not
12423 be available. To restore the special properties of the group, the
12424 simplest way is to kill the group, using @kbd{C-k}, and restart
12425 Gnus. The group is automatically created again with the
12426 correct parameters. The content of the group is not lost.
12428 @c @findex gnus-dissociate-buffer-from-draft
12429 @c @kindex C-c M-d (Mail)
12430 @c @kindex C-c M-d (Post)
12431 @c @findex gnus-associate-buffer-with-draft
12432 @c @kindex C-c C-d (Mail)
12433 @c @kindex C-c C-d (Post)
12434 @c If you're writing some super-secret message that you later want to
12435 @c encode with PGP before sending, you may wish to turn the auto-saving
12436 @c (and association with the draft group) off. You never know who might be
12437 @c interested in reading all your extremely valuable and terribly horrible
12438 @c and interesting secrets. The @kbd{C-c M-d}
12439 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
12440 @c If you change your mind and want to turn the auto-saving back on again,
12441 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
12443 @c @vindex gnus-use-draft
12444 @c To leave association with the draft group off by default, set
12445 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
12447 @findex gnus-draft-edit-message
12448 @kindex D e (Draft)
12449 When you want to continue editing the article, you simply enter the
12450 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
12451 that. You will be placed in a buffer where you left off.
12453 Rejected articles will also be put in this draft group (@pxref{Rejected
12456 @findex gnus-draft-send-all-messages
12457 @kindex D s (Draft)
12458 @findex gnus-draft-send-message
12459 @kindex D S (Draft)
12460 If you have lots of rejected messages you want to post (or mail) without
12461 doing further editing, you can use the @kbd{D s} command
12462 (@code{gnus-draft-send-message}). This command understands the
12463 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
12464 command (@code{gnus-draft-send-all-messages}) will ship off all messages
12467 @findex gnus-draft-toggle-sending
12468 @kindex D t (Draft)
12469 If you have some messages that you wish not to send, you can use the
12470 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
12471 as unsendable. This is a toggling command.
12474 @node Rejected Articles
12475 @section Rejected Articles
12476 @cindex rejected articles
12478 Sometimes a news server will reject an article. Perhaps the server
12479 doesn't like your face. Perhaps it just feels miserable. Perhaps
12480 @emph{there be demons}. Perhaps you have included too much cited text.
12481 Perhaps the disk is full. Perhaps the server is down.
12483 These situations are, of course, totally beyond the control of Gnus.
12484 (Gnus, of course, loves the way you look, always feels great, has angels
12485 fluttering around inside of it, doesn't care about how much cited text
12486 you include, never runs full and never goes down.) So Gnus saves these
12487 articles until some later time when the server feels better.
12489 The rejected articles will automatically be put in a special draft group
12490 (@pxref{Drafts}). When the server comes back up again, you'd then
12491 typically enter that group and send all the articles off.
12493 @node Signing and encrypting
12494 @section Signing and encrypting
12496 @cindex using s/mime
12497 @cindex using smime
12499 Gnus can digitally sign and encrypt your messages, using vanilla
12500 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
12501 decoding such messages, see the @code{mm-verify-option} and
12502 @code{mm-decrypt-option} options (@pxref{Security}).
12504 @vindex gnus-message-replysign
12505 @vindex gnus-message-replyencrypt
12506 @vindex gnus-message-replysignencrypted
12507 Often, you would like to sign replies to people who send you signed
12508 messages. Even more often, you might want to encrypt messages which
12509 are in reply to encrypted messages. Gnus offers
12510 @code{gnus-message-replysign} to enable the former, and
12511 @code{gnus-message-replyencrypt} for the latter. In addition, setting
12512 @code{gnus-message-replysignencrypted} (on by default) will sign
12513 automatically encrypted messages.
12515 Instructing @acronym{MML} to perform security operations on a
12516 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
12517 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
12522 @kindex C-c C-m s s (Message)
12523 @findex mml-secure-message-sign-smime
12525 Digitally sign current message using @acronym{S/MIME}.
12528 @kindex C-c C-m s o (Message)
12529 @findex mml-secure-message-sign-pgp
12531 Digitally sign current message using @acronym{PGP}.
12534 @kindex C-c C-m s p (Message)
12535 @findex mml-secure-message-sign-pgp
12537 Digitally sign current message using @acronym{PGP/MIME}.
12540 @kindex C-c C-m c s (Message)
12541 @findex mml-secure-message-encrypt-smime
12543 Digitally encrypt current message using @acronym{S/MIME}.
12546 @kindex C-c C-m c o (Message)
12547 @findex mml-secure-message-encrypt-pgp
12549 Digitally encrypt current message using @acronym{PGP}.
12552 @kindex C-c C-m c p (Message)
12553 @findex mml-secure-message-encrypt-pgpmime
12555 Digitally encrypt current message using @acronym{PGP/MIME}.
12558 @kindex C-c C-m C-n (Message)
12559 @findex mml-unsecure-message
12560 Remove security related @acronym{MML} tags from message.
12564 @xref{Security, ,Security, message, Message Manual}, for more information.
12566 @node Select Methods
12567 @chapter Select Methods
12568 @cindex foreign groups
12569 @cindex select methods
12571 A @dfn{foreign group} is a group not read by the usual (or
12572 default) means. It could be, for instance, a group from a different
12573 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12574 personal mail group.
12576 A foreign group (or any group, really) is specified by a @dfn{name} and
12577 a @dfn{select method}. To take the latter first, a select method is a
12578 list where the first element says what back end to use (e.g. @code{nntp},
12579 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12580 name}. There may be additional elements in the select method, where the
12581 value may have special meaning for the back end in question.
12583 One could say that a select method defines a @dfn{virtual server}---so
12584 we do just that (@pxref{Server Buffer}).
12586 The @dfn{name} of the group is the name the back end will recognize the
12589 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12590 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12591 method @code{(nntp "some.where.edu")}. Gnus will call this group
12592 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12593 back end just knows this group as @samp{soc.motss}.
12595 The different methods all have their peculiarities, of course.
12598 * Server Buffer:: Making and editing virtual servers.
12599 * Getting News:: Reading USENET news with Gnus.
12600 * Getting Mail:: Reading your personal mail with Gnus.
12601 * Browsing the Web:: Getting messages from a plethora of Web sources.
12602 * IMAP:: Using Gnus as a @acronym{IMAP} client.
12603 * Other Sources:: Reading directories, files, SOUP packets.
12604 * Combined Groups:: Combining groups into one group.
12605 * Email Based Diary:: Using mails to manage diary events in Gnus.
12606 * Gnus Unplugged:: Reading news and mail offline.
12610 @node Server Buffer
12611 @section Server Buffer
12613 Traditionally, a @dfn{server} is a machine or a piece of software that
12614 one connects to, and then requests information from. Gnus does not
12615 connect directly to any real servers, but does all transactions through
12616 one back end or other. But that's just putting one layer more between
12617 the actual media and Gnus, so we might just as well say that each
12618 back end represents a virtual server.
12620 For instance, the @code{nntp} back end may be used to connect to several
12621 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12622 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12623 use, and what parameters to set by specifying a @dfn{select method}.
12625 These select method specifications can sometimes become quite
12626 complicated---say, for instance, that you want to read from the
12627 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12628 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12629 Anyway, if you had to specify that for each group that used this
12630 server, that would be too much work, so Gnus offers a way of naming
12631 select methods, which is what you do in the server buffer.
12633 To enter the server buffer, use the @kbd{^}
12634 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12637 * Server Buffer Format:: You can customize the look of this buffer.
12638 * Server Commands:: Commands to manipulate servers.
12639 * Example Methods:: Examples server specifications.
12640 * Creating a Virtual Server:: An example session.
12641 * Server Variables:: Which variables to set.
12642 * Servers and Methods:: You can use server names as select methods.
12643 * Unavailable Servers:: Some servers you try to contact may be down.
12646 @vindex gnus-server-mode-hook
12647 @code{gnus-server-mode-hook} is run when creating the server buffer.
12650 @node Server Buffer Format
12651 @subsection Server Buffer Format
12652 @cindex server buffer format
12654 @vindex gnus-server-line-format
12655 You can change the look of the server buffer lines by changing the
12656 @code{gnus-server-line-format} variable. This is a @code{format}-like
12657 variable, with some simple extensions:
12662 How the news is fetched---the back end name.
12665 The name of this server.
12668 Where the news is to be fetched from---the address.
12671 The opened/closed/denied status of the server.
12674 Whether this server is agentized.
12677 @vindex gnus-server-mode-line-format
12678 The mode line can also be customized by using the
12679 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12680 Formatting}). The following specs are understood:
12690 Also @pxref{Formatting Variables}.
12693 @node Server Commands
12694 @subsection Server Commands
12695 @cindex server commands
12701 @cindex keys, reserved for users (Server)
12702 The key @kbd{v} is reserved for users. You can bind it key to some
12703 function or better use it as a prefix key.
12707 @findex gnus-server-add-server
12708 Add a new server (@code{gnus-server-add-server}).
12712 @findex gnus-server-edit-server
12713 Edit a server (@code{gnus-server-edit-server}).
12716 @kindex SPACE (Server)
12717 @findex gnus-server-read-server
12718 Browse the current server (@code{gnus-server-read-server}).
12722 @findex gnus-server-exit
12723 Return to the group buffer (@code{gnus-server-exit}).
12727 @findex gnus-server-kill-server
12728 Kill the current server (@code{gnus-server-kill-server}).
12732 @findex gnus-server-yank-server
12733 Yank the previously killed server (@code{gnus-server-yank-server}).
12737 @findex gnus-server-copy-server
12738 Copy the current server (@code{gnus-server-copy-server}).
12742 @findex gnus-server-list-servers
12743 List all servers (@code{gnus-server-list-servers}).
12747 @findex gnus-server-scan-server
12748 Request that the server scan its sources for new articles
12749 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12754 @findex gnus-server-regenerate-server
12755 Request that the server regenerate all its data structures
12756 (@code{gnus-server-regenerate-server}). This can be useful if you have
12757 a mail back end that has gotten out of sync.
12761 @findex gnus-server-compact-server
12763 Compact all groups in the server under point
12764 (@code{gnus-server-compact-server}). Currently implemented only in
12765 nnml (@pxref{Mail Spool}). This removes gaps between article numbers,
12766 hence getting a correct total article count.
12771 @node Example Methods
12772 @subsection Example Methods
12774 Most select methods are pretty simple and self-explanatory:
12777 (nntp "news.funet.fi")
12780 Reading directly from the spool is even simpler:
12786 As you can see, the first element in a select method is the name of the
12787 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12790 After these two elements, there may be an arbitrary number of
12791 @code{(@var{variable} @var{form})} pairs.
12793 To go back to the first example---imagine that you want to read from
12794 port 15 on that machine. This is what the select method should
12798 (nntp "news.funet.fi" (nntp-port-number 15))
12801 You should read the documentation to each back end to find out what
12802 variables are relevant, but here's an @code{nnmh} example:
12804 @code{nnmh} is a mail back end that reads a spool-like structure. Say
12805 you have two structures that you wish to access: One is your private
12806 mail spool, and the other is a public one. Here's the possible spec for
12810 (nnmh "private" (nnmh-directory "~/private/mail/"))
12813 (This server is then called @samp{private}, but you may have guessed
12816 Here's the method for a public spool:
12820 (nnmh-directory "/usr/information/spool/")
12821 (nnmh-get-new-mail nil))
12827 If you are behind a firewall and only have access to the @acronym{NNTP}
12828 server from the firewall machine, you can instruct Gnus to @code{rlogin}
12829 on the firewall machine and telnet from there to the @acronym{NNTP} server.
12830 Doing this can be rather fiddly, but your virtual server definition
12831 should probably look something like this:
12835 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
12836 (nntp-via-address "the.firewall.machine")
12837 (nntp-address "the.real.nntp.host")
12838 (nntp-end-of-line "\n"))
12841 If you want to use the wonderful @code{ssh} program to provide a
12842 compressed connection over the modem line, you could add the following
12843 configuration to the example above:
12846 (nntp-via-rlogin-command "ssh")
12849 See also @code{nntp-via-rlogin-command-switches}. Here's an example for
12850 an indirect connection:
12852 (setq gnus-select-method
12854 (nntp-address "news.server.example")
12855 (nntp-via-user-name "intermediate_user_name")
12856 (nntp-via-address "intermediate.host.example")
12857 (nntp-via-rlogin-command "ssh")
12858 (nntp-end-of-line "\n")
12859 (nntp-via-rlogin-command-switches ("-C" "-t" "-e" "none"))
12860 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)))
12863 If you're behind a firewall, but have direct access to the outside world
12864 through a wrapper command like "runsocks", you could open a socksified
12865 telnet connection to the news server as follows:
12869 (nntp-pre-command "runsocks")
12870 (nntp-open-connection-function nntp-open-via-telnet)
12871 (nntp-address "the.news.server")
12872 (nntp-end-of-line "\n"))
12875 This means that you have to have set up @code{ssh-agent} correctly to
12876 provide automatic authorization, of course. And to get a compressed
12877 connection, you have to have the @samp{Compression} option in the
12878 @code{ssh} @file{config} file.
12881 @node Creating a Virtual Server
12882 @subsection Creating a Virtual Server
12884 If you're saving lots of articles in the cache by using persistent
12885 articles, you may want to create a virtual server to read the cache.
12887 First you need to add a new server. The @kbd{a} command does that. It
12888 would probably be best to use @code{nnml} to read the cache. You
12889 could also use @code{nnspool} or @code{nnmh}, though.
12891 Type @kbd{a nnml RET cache RET}.
12893 You should now have a brand new @code{nnml} virtual server called
12894 @samp{cache}. You now need to edit it to have the right definitions.
12895 Type @kbd{e} to edit the server. You'll be entered into a buffer that
12896 will contain the following:
12906 (nnml-directory "~/News/cache/")
12907 (nnml-active-file "~/News/cache/active"))
12910 Type @kbd{C-c C-c} to return to the server buffer. If you now press
12911 @kbd{RET} over this virtual server, you should be entered into a browse
12912 buffer, and you should be able to enter any of the groups displayed.
12915 @node Server Variables
12916 @subsection Server Variables
12917 @cindex server variables
12918 @cindex server parameters
12920 One sticky point when defining variables (both on back ends and in Emacs
12921 in general) is that some variables are typically initialized from other
12922 variables when the definition of the variables is being loaded. If you
12923 change the ``base'' variable after the variables have been loaded, you
12924 won't change the ``derived'' variables.
12926 This typically affects directory and file variables. For instance,
12927 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
12928 directory variables are initialized from that variable, so
12929 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
12930 new virtual @code{nnml} server, it will @emph{not} suffice to set just
12931 @code{nnml-directory}---you have to explicitly set all the file
12932 variables to be what you want them to be. For a complete list of
12933 variables for each back end, see each back end's section later in this
12934 manual, but here's an example @code{nnml} definition:
12938 (nnml-directory "~/my-mail/")
12939 (nnml-active-file "~/my-mail/active")
12940 (nnml-newsgroups-file "~/my-mail/newsgroups"))
12943 Server variables are often called @dfn{server parameters}.
12945 @node Servers and Methods
12946 @subsection Servers and Methods
12948 Wherever you would normally use a select method
12949 (e.g. @code{gnus-secondary-select-method}, in the group select method,
12950 when browsing a foreign server) you can use a virtual server name
12951 instead. This could potentially save lots of typing. And it's nice all
12955 @node Unavailable Servers
12956 @subsection Unavailable Servers
12958 If a server seems to be unreachable, Gnus will mark that server as
12959 @code{denied}. That means that any subsequent attempt to make contact
12960 with that server will just be ignored. ``It can't be opened,'' Gnus
12961 will tell you, without making the least effort to see whether that is
12962 actually the case or not.
12964 That might seem quite naughty, but it does make sense most of the time.
12965 Let's say you have 10 groups subscribed to on server
12966 @samp{nephelococcygia.com}. This server is located somewhere quite far
12967 away from you and the machine is quite slow, so it takes 1 minute just
12968 to find out that it refuses connection to you today. If Gnus were to
12969 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12970 attempt to do that. Once it has gotten a single ``connection refused'',
12971 it will regard that server as ``down''.
12973 So, what happens if the machine was only feeling unwell temporarily?
12974 How do you test to see whether the machine has come up again?
12976 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12977 with the following commands:
12983 @findex gnus-server-open-server
12984 Try to establish connection to the server on the current line
12985 (@code{gnus-server-open-server}).
12989 @findex gnus-server-close-server
12990 Close the connection (if any) to the server
12991 (@code{gnus-server-close-server}).
12995 @findex gnus-server-deny-server
12996 Mark the current server as unreachable
12997 (@code{gnus-server-deny-server}).
13000 @kindex M-o (Server)
13001 @findex gnus-server-open-all-servers
13002 Open the connections to all servers in the buffer
13003 (@code{gnus-server-open-all-servers}).
13006 @kindex M-c (Server)
13007 @findex gnus-server-close-all-servers
13008 Close the connections to all servers in the buffer
13009 (@code{gnus-server-close-all-servers}).
13013 @findex gnus-server-remove-denials
13014 Remove all marks to whether Gnus was denied connection from any servers
13015 (@code{gnus-server-remove-denials}).
13019 @findex gnus-server-offline-server
13020 Set server status to offline (@code{gnus-server-offline-server}).
13026 @section Getting News
13027 @cindex reading news
13028 @cindex news back ends
13030 A newsreader is normally used for reading news. Gnus currently provides
13031 only two methods of getting news---it can read from an @acronym{NNTP} server,
13032 or it can read from a local spool.
13035 * NNTP:: Reading news from an @acronym{NNTP} server.
13036 * News Spool:: Reading news from the local spool.
13044 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
13045 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
13046 server as the, uhm, address.
13048 If the @acronym{NNTP} server is located at a non-standard port, setting the
13049 third element of the select method to this port number should allow you
13050 to connect to the right port. You'll have to edit the group info for
13051 that (@pxref{Foreign Groups}).
13053 The name of the foreign group can be the same as a native group. In
13054 fact, you can subscribe to the same group from as many different servers
13055 you feel like. There will be no name collisions.
13057 The following variables can be used to create a virtual @code{nntp}
13062 @item nntp-server-opened-hook
13063 @vindex nntp-server-opened-hook
13064 @cindex @sc{mode reader}
13066 @cindex authentication
13067 @cindex nntp authentication
13068 @findex nntp-send-authinfo
13069 @findex nntp-send-mode-reader
13070 is run after a connection has been made. It can be used to send
13071 commands to the @acronym{NNTP} server after it has been contacted. By
13072 default it sends the command @code{MODE READER} to the server with the
13073 @code{nntp-send-mode-reader} function. This function should always be
13074 present in this hook.
13076 @item nntp-authinfo-function
13077 @vindex nntp-authinfo-function
13078 @findex nntp-send-authinfo
13079 @vindex nntp-authinfo-file
13080 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
13081 server. The default function is @code{nntp-send-authinfo}, which looks
13082 through your @file{~/.authinfo} (or whatever you've set the
13083 @code{nntp-authinfo-file} variable to) for applicable entries. If none
13084 are found, it will prompt you for a login name and a password. The
13085 format of the @file{~/.authinfo} file is (almost) the same as the
13086 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
13087 manual page, but here are the salient facts:
13091 The file contains one or more line, each of which define one server.
13094 Each line may contain an arbitrary number of token/value pairs.
13096 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
13097 @samp{default}. In addition Gnus introduces two new tokens, not present
13098 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
13099 @samp{force}. (This is the only way the @file{.authinfo} file format
13100 deviates from the @file{.netrc} file format.) @samp{port} is used to
13101 indicate what port on the server the credentials apply to and
13102 @samp{force} is explained below.
13106 Here's an example file:
13109 machine news.uio.no login larsi password geheimnis
13110 machine nntp.ifi.uio.no login larsi force yes
13113 The token/value pairs may appear in any order; @samp{machine} doesn't
13114 have to be first, for instance.
13116 In this example, both login name and password have been supplied for the
13117 former server, while the latter has only the login name listed, and the
13118 user will be prompted for the password. The latter also has the
13119 @samp{force} tag, which means that the authinfo will be sent to the
13120 @var{nntp} server upon connection; the default (i.e., when there is not
13121 @samp{force} tag) is to not send authinfo to the @var{nntp} server
13122 until the @var{nntp} server asks for it.
13124 You can also add @samp{default} lines that will apply to all servers
13125 that don't have matching @samp{machine} lines.
13131 This will force sending @samp{AUTHINFO} commands to all servers not
13132 previously mentioned.
13134 Remember to not leave the @file{~/.authinfo} file world-readable.
13136 @item nntp-server-action-alist
13137 @vindex nntp-server-action-alist
13138 This is a list of regexps to match on server types and actions to be
13139 taken when matches are made. For instance, if you want Gnus to beep
13140 every time you connect to innd, you could say something like:
13143 (setq nntp-server-action-alist
13144 '(("innd" (ding))))
13147 You probably don't want to do that, though.
13149 The default value is
13152 '(("nntpd 1\\.5\\.11t"
13153 (remove-hook 'nntp-server-opened-hook
13154 'nntp-send-mode-reader)))
13157 This ensures that Gnus doesn't send the @code{MODE READER} command to
13158 nntpd 1.5.11t, since that command chokes that server, I've been told.
13160 @item nntp-maximum-request
13161 @vindex nntp-maximum-request
13162 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
13163 will collect headers by sending a series of @code{head} commands. To
13164 speed things up, the back end sends lots of these commands without
13165 waiting for reply, and then reads all the replies. This is controlled
13166 by the @code{nntp-maximum-request} variable, and is 400 by default. If
13167 your network is buggy, you should set this to 1.
13169 @item nntp-connection-timeout
13170 @vindex nntp-connection-timeout
13171 If you have lots of foreign @code{nntp} groups that you connect to
13172 regularly, you're sure to have problems with @acronym{NNTP} servers not
13173 responding properly, or being too loaded to reply within reasonable
13174 time. This is can lead to awkward problems, which can be helped
13175 somewhat by setting @code{nntp-connection-timeout}. This is an integer
13176 that says how many seconds the @code{nntp} back end should wait for a
13177 connection before giving up. If it is @code{nil}, which is the default,
13178 no timeouts are done.
13180 @item nntp-nov-is-evil
13181 @vindex nntp-nov-is-evil
13182 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
13183 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
13186 @item nntp-xover-commands
13187 @vindex nntp-xover-commands
13188 @cindex @acronym{NOV}
13190 List of strings used as commands to fetch @acronym{NOV} lines from a
13191 server. The default value of this variable is @code{("XOVER"
13195 @vindex nntp-nov-gap
13196 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
13197 the server. The server responds with one huge list of lines. However,
13198 if you have read articles 2-5000 in the group, and only want to read
13199 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
13200 lines that you will not need. This variable says how
13201 big a gap between two consecutive articles is allowed to be before the
13202 @code{XOVER} request is split into several request. Note that if your
13203 network is fast, setting this variable to a really small number means
13204 that fetching will probably be slower. If this variable is @code{nil},
13205 @code{nntp} will never split requests. The default is 5.
13207 @item nntp-prepare-server-hook
13208 @vindex nntp-prepare-server-hook
13209 A hook run before attempting to connect to an @acronym{NNTP} server.
13211 @item nntp-record-commands
13212 @vindex nntp-record-commands
13213 If non-@code{nil}, @code{nntp} will log all commands it sends to the
13214 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
13215 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
13216 that doesn't seem to work.
13218 @item nntp-open-connection-function
13219 @vindex nntp-open-connection-function
13220 It is possible to customize how the connection to the nntp server will
13221 be opened. If you specify an @code{nntp-open-connection-function}
13222 parameter, Gnus will use that function to establish the connection.
13223 Seven pre-made functions are supplied. These functions can be grouped
13224 in two categories: direct connection functions (four pre-made), and
13225 indirect ones (three pre-made).
13227 @item nntp-never-echoes-commands
13228 @vindex nntp-never-echoes-commands
13229 Non-@code{nil} means the nntp server never echoes commands. It is
13230 reported that some nntps server doesn't echo commands. So, you may want
13231 to set this to non-@code{nil} in the method for such a server setting
13232 @code{nntp-open-connection-function} to @code{nntp-open-ssl-stream} for
13233 example. The default value is @code{nil}. Note that the
13234 @code{nntp-open-connection-functions-never-echo-commands} variable
13235 overrides the @code{nil} value of this variable.
13237 @item nntp-open-connection-functions-never-echo-commands
13238 @vindex nntp-open-connection-functions-never-echo-commands
13239 List of functions that never echo commands. Add or set a function which
13240 you set to @code{nntp-open-connection-function} to this list if it does
13241 not echo commands. Note that a non-@code{nil} value of the
13242 @code{nntp-never-echoes-commands} variable overrides this variable. The
13243 default value is @code{(nntp-open-network-stream)}.
13245 @item nntp-prepare-post-hook
13246 @vindex nntp-prepare-post-hook
13247 A hook run just before posting an article. If there is no
13248 @code{Message-ID} header in the article and the news server provides the
13249 recommended ID, it will be added to the article before running this
13250 hook. It is useful to make @code{Cancel-Lock} headers even if you
13251 inhibit Gnus to add a @code{Message-ID} header, you could say:
13254 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
13257 Note that not all servers support the recommended ID. This works for
13258 INN versions 2.3.0 and later, for instance.
13263 * Direct Functions:: Connecting directly to the server.
13264 * Indirect Functions:: Connecting indirectly to the server.
13265 * Common Variables:: Understood by several connection functions.
13266 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
13270 @node Direct Functions
13271 @subsubsection Direct Functions
13272 @cindex direct connection functions
13274 These functions are called direct because they open a direct connection
13275 between your machine and the @acronym{NNTP} server. The behavior of these
13276 functions is also affected by commonly understood variables
13277 (@pxref{Common Variables}).
13280 @findex nntp-open-network-stream
13281 @item nntp-open-network-stream
13282 This is the default, and simply connects to some port or other on the
13285 @findex nntp-open-tls-stream
13286 @item nntp-open-tls-stream
13287 Opens a connection to a server over a @dfn{secure} channel. To use
13288 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
13289 installed. You then define a server as follows:
13292 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
13293 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
13295 (nntp "snews.bar.com"
13296 (nntp-open-connection-function nntp-open-tls-stream)
13297 (nntp-port-number )
13298 (nntp-address "snews.bar.com"))
13301 @findex nntp-open-ssl-stream
13302 @item nntp-open-ssl-stream
13303 Opens a connection to a server over a @dfn{secure} channel. To use
13304 this you must have @uref{http://www.openssl.org, OpenSSL} or
13305 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
13306 then define a server as follows:
13309 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
13310 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
13312 (nntp "snews.bar.com"
13313 (nntp-open-connection-function nntp-open-ssl-stream)
13314 (nntp-port-number 563)
13315 (nntp-address "snews.bar.com"))
13318 @findex nntp-open-telnet-stream
13319 @item nntp-open-telnet-stream
13320 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
13321 it. You might wonder why this function exists, since we have the
13322 default @code{nntp-open-network-stream} which would do the job. (One
13323 of) the reason(s) is that if you are behind a firewall but have direct
13324 connections to the outside world thanks to a command wrapper like
13325 @code{runsocks}, you can use it like this:
13329 (nntp-pre-command "runsocks")
13330 (nntp-open-connection-function nntp-open-telnet-stream)
13331 (nntp-address "the.news.server"))
13334 With the default method, you would need to wrap your whole Emacs
13335 session, which is not a good idea.
13339 @node Indirect Functions
13340 @subsubsection Indirect Functions
13341 @cindex indirect connection functions
13343 These functions are called indirect because they connect to an
13344 intermediate host before actually connecting to the @acronym{NNTP} server.
13345 All of these functions and related variables are also said to belong to
13346 the ``via'' family of connection: they're all prefixed with ``via'' to make
13347 things cleaner. The behavior of these functions is also affected by
13348 commonly understood variables (@pxref{Common Variables}).
13351 @item nntp-open-via-rlogin-and-telnet
13352 @findex nntp-open-via-rlogin-and-telnet
13353 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
13354 to the real @acronym{NNTP} server from there. This is useful for instance if
13355 you need to connect to a firewall machine first.
13357 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
13360 @item nntp-via-rlogin-command
13361 @vindex nntp-via-rlogin-command
13362 Command used to log in on the intermediate host. The default is
13363 @samp{rsh}, but @samp{ssh} is a popular alternative.
13365 @item nntp-via-rlogin-command-switches
13366 @vindex nntp-via-rlogin-command-switches
13367 List of strings to be used as the switches to
13368 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
13369 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
13370 @samp{("-C")} in order to compress all data connections, otherwise set
13371 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
13372 the telnet command requires a pseudo-tty allocation on an intermediate
13376 Note that you may want to change the value for @code{nntp-end-of-line}
13377 to @samp{\n} (@pxref{Common Variables}).
13379 @item nntp-open-via-rlogin-and-netcat
13380 @findex nntp-open-via-rlogin-and-netcat
13381 Does essentially the same, but uses
13382 @uref{http://netcat.sourceforge.net/, netcat} instead of @samp{telnet}
13383 to connect to the real @acronym{NNTP} server from the intermediate host.
13385 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
13388 @item nntp-via-netcat-command
13389 @vindex nntp-via-netcat-command
13390 Command used to connect to the real @acronym{NNTP} server from the
13391 intermediate host. The default is @samp{nc}. You can also use other
13392 programs like @uref{http://www.imasy.or.jp/~gotoh/ssh/connect.html,
13395 @item nntp-via-netcat-switches
13396 @vindex nntp-via-netcat-switches
13397 List of strings to be used as the switches to the
13398 @code{nntp-via-telnet-command} command. The default is @code{nil}.
13400 @item nntp-via-rlogin-command
13401 @vindex nntp-via-rlogin-command
13402 Command used to log in on the intermediate host. The default is
13403 @samp{rsh}, but @samp{ssh} is a popular alternative.
13405 @item nntp-via-rlogin-command-switches
13406 @vindex nntp-via-rlogin-command-switches
13407 List of strings to be used as the switches to
13408 @code{nntp-via-rlogin-command}. The default is @code{nil}.
13411 @item nntp-open-via-telnet-and-telnet
13412 @findex nntp-open-via-telnet-and-telnet
13413 Does essentially the same, but uses @samp{telnet} instead of
13414 @samp{rlogin} to connect to the intermediate host.
13416 @code{nntp-open-via-telnet-and-telnet}-specific variables:
13419 @item nntp-via-telnet-command
13420 @vindex nntp-via-telnet-command
13421 Command used to @code{telnet} the intermediate host. The default is
13424 @item nntp-via-telnet-switches
13425 @vindex nntp-via-telnet-switches
13426 List of strings to be used as the switches to the
13427 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
13429 @item nntp-via-user-password
13430 @vindex nntp-via-user-password
13431 Password to use when logging in on the intermediate host.
13433 @item nntp-via-envuser
13434 @vindex nntp-via-envuser
13435 If non-@code{nil}, the intermediate @code{telnet} session (client and
13436 server both) will support the @code{ENVIRON} option and not prompt for
13437 login name. This works for Solaris @code{telnet}, for instance.
13439 @item nntp-via-shell-prompt
13440 @vindex nntp-via-shell-prompt
13441 Regexp matching the shell prompt on the intermediate host. The default
13442 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
13446 Note that you may want to change the value for @code{nntp-end-of-line}
13447 to @samp{\n} (@pxref{Common Variables}).
13451 Here are some additional variables that are understood by all the above
13456 @item nntp-via-user-name
13457 @vindex nntp-via-user-name
13458 User name to use when connecting to the intermediate host.
13460 @item nntp-via-address
13461 @vindex nntp-via-address
13462 Address of the intermediate host to connect to.
13467 @node Common Variables
13468 @subsubsection Common Variables
13470 The following variables affect the behavior of all, or several of the
13471 pre-made connection functions. When not specified, all functions are
13472 affected (the values of the following variables will be used as the
13473 default if each virtual @code{nntp} server doesn't specify those server
13474 variables individually).
13478 @item nntp-pre-command
13479 @vindex nntp-pre-command
13480 A command wrapper to use when connecting through a non native
13481 connection function (all except @code{nntp-open-network-stream},
13482 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}). This is
13483 where you would put a @samp{SOCKS} wrapper for instance.
13486 @vindex nntp-address
13487 The address of the @acronym{NNTP} server.
13489 @item nntp-port-number
13490 @vindex nntp-port-number
13491 Port number to connect to the @acronym{NNTP} server. The default is
13492 @samp{nntp}. If you use @acronym{NNTP} over
13493 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
13494 than named ports (i.e, use @samp{563} instead of @samp{snews} or
13495 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
13496 not work with named ports.
13498 @item nntp-end-of-line
13499 @vindex nntp-end-of-line
13500 String to use as end-of-line marker when talking to the @acronym{NNTP}
13501 server. This is @samp{\r\n} by default, but should be @samp{\n} when
13502 using a non native telnet connection function.
13504 @item nntp-telnet-command
13505 @vindex nntp-telnet-command
13506 Command to use when connecting to the @acronym{NNTP} server through
13507 @samp{telnet}. This is @emph{not} for an intermediate host. This is
13508 just for the real @acronym{NNTP} server. The default is
13511 @item nntp-telnet-switches
13512 @vindex nntp-telnet-switches
13513 A list of switches to pass to @code{nntp-telnet-command}. The default
13519 @subsubsection NNTP marks
13520 @cindex storing NNTP marks
13522 Gnus stores marks (@pxref{Marking Articles}) for @acronym{NNTP}
13523 servers in marks files. A marks file records what marks you have set
13524 in a group and each file is specific to the corresponding server.
13525 Marks files are stored in @file{~/News/marks}
13526 (@code{nntp-marks-directory}) under a classic hierarchy resembling
13527 that of a news server, for example marks for the group
13528 @samp{gmane.discuss} on the news.gmane.org server will be stored in
13529 the file @file{~/News/marks/news.gmane.org/gmane/discuss/.marks}.
13531 Marks files are useful because you can copy the @file{~/News/marks}
13532 directory (using rsync, scp or whatever) to another Gnus installation,
13533 and it will realize what articles you have read and marked. The data
13534 in @file{~/News/marks} has priority over the same data in
13535 @file{~/.newsrc.eld}.
13537 Note that marks files are very much server-specific: Gnus remembers
13538 the article numbers so if you don't use the same servers on both
13539 installations things are most likely to break (most @acronym{NNTP}
13540 servers do not use the same article numbers as any other server).
13541 However, if you use servers A, B, C on one installation and servers A,
13542 D, E on the other, you can sync the marks files for A and then you'll
13543 get synchronization for that server between the two installations.
13545 Using @acronym{NNTP} marks can possibly incur a performance penalty so
13546 if Gnus feels sluggish, try setting the @code{nntp-marks-is-evil}
13547 variable to @code{t}. Marks will then be stored in @file{~/.newsrc.eld}.
13553 @item nntp-marks-is-evil
13554 @vindex nntp-marks-is-evil
13555 If non-@code{nil}, this back end will ignore any marks files. The
13556 default is @code{nil}.
13558 @item nntp-marks-directory
13559 @vindex nntp-marks-directory
13560 The directory where marks for nntp groups will be stored.
13566 @subsection News Spool
13570 Subscribing to a foreign group from the local spool is extremely easy,
13571 and might be useful, for instance, to speed up reading groups that
13572 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
13575 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
13576 anything else) as the address.
13578 If you have access to a local spool, you should probably use that as the
13579 native select method (@pxref{Finding the News}). It is normally faster
13580 than using an @code{nntp} select method, but might not be. It depends.
13581 You just have to try to find out what's best at your site.
13585 @item nnspool-inews-program
13586 @vindex nnspool-inews-program
13587 Program used to post an article.
13589 @item nnspool-inews-switches
13590 @vindex nnspool-inews-switches
13591 Parameters given to the inews program when posting an article.
13593 @item nnspool-spool-directory
13594 @vindex nnspool-spool-directory
13595 Where @code{nnspool} looks for the articles. This is normally
13596 @file{/usr/spool/news/}.
13598 @item nnspool-nov-directory
13599 @vindex nnspool-nov-directory
13600 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
13601 @file{/usr/spool/news/over.view/}.
13603 @item nnspool-lib-dir
13604 @vindex nnspool-lib-dir
13605 Where the news lib dir is (@file{/usr/lib/news/} by default).
13607 @item nnspool-active-file
13608 @vindex nnspool-active-file
13609 The name of the active file.
13611 @item nnspool-newsgroups-file
13612 @vindex nnspool-newsgroups-file
13613 The name of the group descriptions file.
13615 @item nnspool-history-file
13616 @vindex nnspool-history-file
13617 The name of the news history file.
13619 @item nnspool-active-times-file
13620 @vindex nnspool-active-times-file
13621 The name of the active date file.
13623 @item nnspool-nov-is-evil
13624 @vindex nnspool-nov-is-evil
13625 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13628 @item nnspool-sift-nov-with-sed
13629 @vindex nnspool-sift-nov-with-sed
13631 If non-@code{nil}, which is the default, use @code{sed} to get the
13632 relevant portion from the overview file. If @code{nil},
13633 @code{nnspool} will load the entire file into a buffer and process it
13640 @section Getting Mail
13641 @cindex reading mail
13644 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13648 * Mail in a Newsreader:: Important introductory notes.
13649 * Getting Started Reading Mail:: A simple cookbook example.
13650 * Splitting Mail:: How to create mail groups.
13651 * Mail Sources:: How to tell Gnus where to get mail from.
13652 * Mail Back End Variables:: Variables for customizing mail handling.
13653 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
13654 * Group Mail Splitting:: Use group customize to drive mail splitting.
13655 * Incorporating Old Mail:: What about the old mail you have?
13656 * Expiring Mail:: Getting rid of unwanted mail.
13657 * Washing Mail:: Removing cruft from the mail you get.
13658 * Duplicates:: Dealing with duplicated mail.
13659 * Not Reading Mail:: Using mail back ends for reading other files.
13660 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
13664 @node Mail in a Newsreader
13665 @subsection Mail in a Newsreader
13667 If you are used to traditional mail readers, but have decided to switch
13668 to reading mail with Gnus, you may find yourself experiencing something
13669 of a culture shock.
13671 Gnus does not behave like traditional mail readers. If you want to make
13672 it behave that way, you can, but it's an uphill battle.
13674 Gnus, by default, handles all its groups using the same approach. This
13675 approach is very newsreaderly---you enter a group, see the new/unread
13676 messages, and when you read the messages, they get marked as read, and
13677 you don't see them any more. (Unless you explicitly ask for them.)
13679 In particular, you do not do anything explicitly to delete messages.
13681 Does this mean that all the messages that have been marked as read are
13682 deleted? How awful!
13684 But, no, it means that old messages are @dfn{expired} according to some
13685 scheme or other. For news messages, the expire process is controlled by
13686 the news administrator; for mail, the expire process is controlled by
13687 you. The expire process for mail is covered in depth in @ref{Expiring
13690 What many Gnus users find, after using it a while for both news and
13691 mail, is that the transport mechanism has very little to do with how
13692 they want to treat a message.
13694 Many people subscribe to several mailing lists. These are transported
13695 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13696 answering, or even reading these messages very carefully. We may not
13697 need to save them because if we should need to read one again, they are
13698 archived somewhere else.
13700 Some people have local news groups which have only a handful of readers.
13701 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13702 to read and answer a large fraction of the messages very carefully in
13703 order to do our work. And there may not be an archive, so we may need
13704 to save the interesting messages the same way we would personal mail.
13706 The important distinction turns out to be not the transport mechanism,
13707 but other factors such as how interested we are in the subject matter,
13708 or how easy it is to retrieve the message if we need to read it again.
13710 Gnus provides many options for sorting mail into ``groups'' which behave
13711 like newsgroups, and for treating each group (whether mail or news)
13714 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13715 that Gnus should grow up and be a male, er, mail reader. It is possible
13716 to whip Gnus into a more mailreaderly being, but, as said before, it's
13717 not easy. People who prefer proper mail readers should try @sc{vm}
13718 instead, which is an excellent, and proper, mail reader.
13720 I don't mean to scare anybody off, but I want to make it clear that you
13721 may be required to learn a new way of thinking about messages. After
13722 you've been subjected to The Gnus Way, you will come to love it. I can
13723 guarantee it. (At least the guy who sold me the Emacs Subliminal
13724 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13725 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13729 @node Getting Started Reading Mail
13730 @subsection Getting Started Reading Mail
13732 It's quite easy to use Gnus to read your new mail. You just plonk the
13733 mail back end of your choice into @code{gnus-secondary-select-methods},
13734 and things will happen automatically.
13736 For instance, if you want to use @code{nnml} (which is a ``one file per
13737 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13740 (setq gnus-secondary-select-methods '((nnml "")))
13743 Now, the next time you start Gnus, this back end will be queried for new
13744 articles, and it will move all the messages in your spool file to its
13745 directory, which is @file{~/Mail/} by default. The new group that will
13746 be created (@samp{mail.misc}) will be subscribed, and you can read it
13747 like any other group.
13749 You will probably want to split the mail into several groups, though:
13752 (setq nnmail-split-methods
13753 '(("junk" "^From:.*Lars Ingebrigtsen")
13754 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13758 This will result in three new @code{nnml} mail groups being created:
13759 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
13760 mail that doesn't fit into the first two groups will be placed in the
13763 This should be sufficient for reading mail with Gnus. You might want to
13764 give the other sections in this part of the manual a perusal, though.
13765 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13768 @node Splitting Mail
13769 @subsection Splitting Mail
13770 @cindex splitting mail
13771 @cindex mail splitting
13772 @cindex mail filtering (splitting)
13774 @vindex nnmail-split-methods
13775 The @code{nnmail-split-methods} variable says how the incoming mail is
13776 to be split into groups.
13779 (setq nnmail-split-methods
13780 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
13781 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
13782 ("mail.other" "")))
13785 This variable is a list of lists, where the first element of each of
13786 these lists is the name of the mail group (they do not have to be called
13787 something beginning with @samp{mail}, by the way), and the second
13788 element is a regular expression used on the header of each mail to
13789 determine if it belongs in this mail group. The first string may
13790 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
13791 insert sub-expressions from the matched text. For instance:
13794 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
13798 In that case, @code{nnmail-split-lowercase-expanded} controls whether
13799 the inserted text should be made lowercase. @xref{Fancy Mail Splitting}.
13801 The second element can also be a function. In that case, it will be
13802 called narrowed to the headers with the first element of the rule as the
13803 argument. It should return a non-@code{nil} value if it thinks that the
13804 mail belongs in that group.
13806 @cindex @samp{bogus} group
13807 The last of these groups should always be a general one, and the regular
13808 expression should @emph{always} be @samp{""} so that it matches any mails
13809 that haven't been matched by any of the other regexps. (These rules are
13810 processed from the beginning of the alist toward the end. The first rule
13811 to make a match will ``win'', unless you have crossposting enabled. In
13812 that case, all matching rules will ``win''.) If no rule matched, the mail
13813 will end up in the @samp{bogus} group. When new groups are created by
13814 splitting mail, you may want to run @code{gnus-group-find-new-groups} to
13815 see the new groups. This also applies to the @samp{bogus} group.
13817 If you like to tinker with this yourself, you can set this variable to a
13818 function of your choice. This function will be called without any
13819 arguments in a buffer narrowed to the headers of an incoming mail
13820 message. The function should return a list of group names that it
13821 thinks should carry this mail message.
13823 Note that the mail back ends are free to maul the poor, innocent,
13824 incoming headers all they want to. They all add @code{Lines} headers;
13825 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
13826 @code{From<SPACE>} line to something else.
13828 @vindex nnmail-crosspost
13829 The mail back ends all support cross-posting. If several regexps match,
13830 the mail will be ``cross-posted'' to all those groups.
13831 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
13832 that no articles are crossposted to the general (@samp{""}) group.
13834 @vindex nnmail-crosspost-link-function
13837 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
13838 the crossposted articles. However, not all file systems support hard
13839 links. If that's the case for you, set
13840 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
13841 variable is @code{add-name-to-file} by default.)
13843 @kindex M-x nnmail-split-history
13844 @findex nnmail-split-history
13845 If you wish to see where the previous mail split put the messages, you
13846 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
13847 where re-spooling messages would put the messages, you can use
13848 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
13851 @vindex nnmail-split-header-length-limit
13852 Header lines longer than the value of
13853 @code{nnmail-split-header-length-limit} are excluded from the split
13856 @vindex nnmail-mail-splitting-charset
13857 @vindex nnmail-mail-splitting-decodes
13858 By default, splitting @acronym{MIME}-decodes headers so you
13859 can match on non-@acronym{ASCII} strings. The
13860 @code{nnmail-mail-splitting-charset} variable specifies the default
13861 charset for decoding. The behavior can be turned off completely by
13862 binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is
13863 useful if you want to match articles based on the raw header data.
13865 @vindex nnmail-resplit-incoming
13866 By default, splitting is performed on all incoming messages. If you
13867 specify a @code{directory} entry for the variable @code{mail-sources}
13868 (@pxref{Mail Source Specifiers}), however, then splitting does
13869 @emph{not} happen by default. You can set the variable
13870 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
13871 splitting happen even in this case. (This variable has no effect on
13872 other kinds of entries.)
13874 Gnus gives you all the opportunity you could possibly want for shooting
13875 yourself in the foot. Let's say you create a group that will contain
13876 all the mail you get from your boss. And then you accidentally
13877 unsubscribe from the group. Gnus will still put all the mail from your
13878 boss in the unsubscribed group, and so, when your boss mails you ``Have
13879 that report ready by Monday or you're fired!'', you'll never see it and,
13880 come Tuesday, you'll still believe that you're gainfully employed while
13881 you really should be out collecting empty bottles to save up for next
13882 month's rent money.
13886 @subsection Mail Sources
13888 Mail can be gotten from many different sources---the mail spool, from
13889 a @acronym{POP} mail server, from a procmail directory, or from a
13890 maildir, for instance.
13893 * Mail Source Specifiers:: How to specify what a mail source is.
13894 * Mail Source Customization:: Some variables that influence things.
13895 * Fetching Mail:: Using the mail source specifiers.
13899 @node Mail Source Specifiers
13900 @subsubsection Mail Source Specifiers
13902 @cindex mail server
13905 @cindex mail source
13907 You tell Gnus how to fetch mail by setting @code{mail-sources}
13908 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
13913 (pop :server "pop3.mailserver.com" :user "myname")
13916 As can be observed, a mail source specifier is a list where the first
13917 element is a @dfn{mail source type}, followed by an arbitrary number of
13918 @dfn{keywords}. Keywords that are not explicitly specified are given
13921 The following mail source types are available:
13925 Get mail from a single file; typically from the mail spool.
13931 The file name. Defaults to the value of the @env{MAIL}
13932 environment variable or the value of @code{rmail-spool-directory}
13933 (usually something like @file{/usr/mail/spool/user-name}).
13937 Script run before/after fetching mail.
13940 An example file mail source:
13943 (file :path "/usr/spool/mail/user-name")
13946 Or using the default file name:
13952 If the mail spool file is not located on the local machine, it's best
13953 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
13954 You can not use ange-ftp file names here---it has no way to lock the
13955 mail spool while moving the mail.
13957 If it's impossible to set up a proper server, you can use ssh instead.
13961 '((file :prescript "ssh host bin/getmail >%t")))
13964 The @samp{getmail} script would look something like the following:
13968 # getmail - move mail from spool to stdout
13971 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
13973 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
13976 Alter this script to fit the @samp{movemail} and temporary
13977 file you want to use.
13981 @vindex nnmail-scan-directory-mail-source-once
13982 Get mail from several files in a directory. This is typically used
13983 when you have procmail split the incoming mail into several files.
13984 That is, there is a one-to-one correspondence between files in that
13985 directory and groups, so that mail from the file @file{foo.bar.spool}
13986 will be put in the group @code{foo.bar}. (You can change the suffix
13987 to be used instead of @code{.spool}.) Setting
13988 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
13989 Gnus to scan the mail source only once. This is particularly useful
13990 if you want to scan mail groups at a specified level.
13992 @vindex nnmail-resplit-incoming
13993 There is also the variable @code{nnmail-resplit-incoming}, if you set
13994 that to a non-@code{nil} value, then the normal splitting process is
13995 applied to all the files from the directory, @ref{Splitting Mail}.
14001 The name of the directory where the files are. There is no default
14005 Only files ending with this suffix are used. The default is
14009 Only files that have this predicate return non-@code{nil} are returned.
14010 The default is @code{identity}. This is used as an additional
14011 filter---only files that have the right suffix @emph{and} satisfy this
14012 predicate are considered.
14016 Script run before/after fetching mail.
14020 An example directory mail source:
14023 (directory :path "/home/user-name/procmail-dir/"
14028 Get mail from a @acronym{POP} server.
14034 The name of the @acronym{POP} server. The default is taken from the
14035 @env{MAILHOST} environment variable.
14038 The port number of the @acronym{POP} server. This can be a number (eg,
14039 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
14040 string, it should be a service name as listed in @file{/etc/services} on
14041 Unix systems. The default is @samp{"pop3"}. On some systems you might
14042 need to specify it as @samp{"pop-3"} instead.
14045 The user name to give to the @acronym{POP} server. The default is the login
14049 The password to give to the @acronym{POP} server. If not specified,
14050 the user is prompted.
14053 The program to use to fetch mail from the @acronym{POP} server. This
14054 should be a @code{format}-like string. Here's an example:
14057 fetchmail %u@@%s -P %p %t
14060 The valid format specifier characters are:
14064 The name of the file the mail is to be moved to. This must always be
14065 included in this string.
14068 The name of the server.
14071 The port number of the server.
14074 The user name to use.
14077 The password to use.
14080 The values used for these specs are taken from the values you give the
14081 corresponding keywords.
14084 A script to be run before fetching the mail. The syntax is the same as
14085 the @code{:program} keyword. This can also be a function to be run.
14088 A script to be run after fetching the mail. The syntax is the same as
14089 the @code{:program} keyword. This can also be a function to be run.
14092 The function to use to fetch mail from the @acronym{POP} server. The
14093 function is called with one parameter---the name of the file where the
14094 mail should be moved to.
14096 @item :authentication
14097 This can be either the symbol @code{password} or the symbol @code{apop}
14098 and says what authentication scheme to use. The default is
14103 @vindex pop3-movemail
14104 @vindex pop3-leave-mail-on-server
14105 If the @code{:program} and @code{:function} keywords aren't specified,
14106 @code{pop3-movemail} will be used. If @code{pop3-leave-mail-on-server}
14107 is non-@code{nil} the mail is to be left on the @acronym{POP} server
14108 after fetching when using @code{pop3-movemail}. Note that POP servers
14109 maintain no state information between sessions, so what the client
14110 believes is there and what is actually there may not match up. If they
14111 do not, then you may get duplicate mails or the whole thing can fall
14112 apart and leave you with a corrupt mailbox.
14114 Here are some examples for getting mail from a @acronym{POP} server.
14115 Fetch from the default @acronym{POP} server, using the default user
14116 name, and default fetcher:
14122 Fetch from a named server with a named user and password:
14125 (pop :server "my.pop.server"
14126 :user "user-name" :password "secret")
14129 Use @samp{movemail} to move the mail:
14132 (pop :program "movemail po:%u %t %p")
14136 Get mail from a maildir. This is a type of mailbox that is supported by
14137 at least qmail and postfix, where each file in a special directory
14138 contains exactly one mail.
14144 The name of the directory where the mails are stored. The default is
14145 taken from the @env{MAILDIR} environment variable or
14148 The subdirectories of the Maildir. The default is
14149 @samp{("new" "cur")}.
14151 @c If you sometimes look at your mail through a pop3 daemon before fetching
14152 @c them with Gnus, you may also have to fetch your mails from the
14153 @c @code{cur} directory inside the maildir, like in the first example
14156 You can also get mails from remote hosts (because maildirs don't suffer
14157 from locking problems).
14161 Two example maildir mail sources:
14164 (maildir :path "/home/user-name/Maildir/"
14165 :subdirs ("cur" "new"))
14169 (maildir :path "/user@@remotehost.org:~/Maildir/"
14174 Get mail from a @acronym{IMAP} server. If you don't want to use
14175 @acronym{IMAP} as intended, as a network mail reading protocol (ie
14176 with nnimap), for some reason or other, Gnus let you treat it similar
14177 to a @acronym{POP} server and fetches articles from a given
14178 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
14180 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
14181 may need external programs and libraries, @xref{IMAP}.
14187 The name of the @acronym{IMAP} server. The default is taken from the
14188 @env{MAILHOST} environment variable.
14191 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
14192 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
14195 The user name to give to the @acronym{IMAP} server. The default is the login
14199 The password to give to the @acronym{IMAP} server. If not specified, the user is
14203 What stream to use for connecting to the server, this is one of the
14204 symbols in @code{imap-stream-alist}. Right now, this means
14205 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
14206 @samp{ssl}, @samp{shell} or the default @samp{network}.
14208 @item :authentication
14209 Which authenticator to use for authenticating to the server, this is
14210 one of the symbols in @code{imap-authenticator-alist}. Right now,
14211 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
14212 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
14215 When using the `shell' :stream, the contents of this variable is
14216 mapped into the @code{imap-shell-program} variable. This should be a
14217 @code{format}-like string (or list of strings). Here's an example:
14223 The valid format specifier characters are:
14227 The name of the server.
14230 User name from @code{imap-default-user}.
14233 The port number of the server.
14236 The values used for these specs are taken from the values you give the
14237 corresponding keywords.
14240 The name of the mailbox to get mail from. The default is @samp{INBOX}
14241 which normally is the mailbox which receive incoming mail.
14244 The predicate used to find articles to fetch. The default, @samp{UNSEEN
14245 UNDELETED}, is probably the best choice for most people, but if you
14246 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
14247 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
14248 Then all articles in the mailbox is fetched, no matter what. For a
14249 complete list of predicates, see RFC 2060 section 6.4.4.
14252 How to flag fetched articles on the server, the default @samp{\Deleted}
14253 will mark them as deleted, an alternative would be @samp{\Seen} which
14254 would simply mark them as read. These are the two most likely choices,
14255 but more flags are defined in RFC 2060 section 2.3.2.
14258 If non-@code{nil}, don't remove all articles marked as deleted in the
14259 mailbox after finishing the fetch.
14263 An example @acronym{IMAP} mail source:
14266 (imap :server "mail.mycorp.com"
14268 :fetchflag "\\Seen")
14272 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
14273 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
14274 @uref{http://mail.yahoo.com/}.
14276 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
14277 required for url "4.0pre.46".
14279 WARNING: Mails may be lost. NO WARRANTY.
14285 The type of the webmail server. The default is @code{hotmail}. The
14286 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
14289 The user name to give to the webmail server. The default is the login
14293 The password to give to the webmail server. If not specified, the user is
14297 If non-@code{nil}, only fetch unread articles and don't move them to
14298 trash folder after finishing the fetch.
14302 An example webmail source:
14305 (webmail :subtype 'hotmail
14307 :password "secret")
14312 @item Common Keywords
14313 Common keywords can be used in any type of mail source.
14319 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
14320 use directory source to get mail, you can specify it as in this
14325 '((directory :path "/home/pavel/.Spool/"
14330 Gnus will then fetch your mail even when you are unplugged. This is
14331 useful when you use local mail and news.
14336 @subsubsection Function Interface
14338 Some of the above keywords specify a Lisp function to be executed.
14339 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
14340 the value of the keyword while the function is executing. For example,
14341 consider the following mail-source setting:
14344 (setq mail-sources '((pop :user "jrl"
14345 :server "pophost" :function fetchfunc)))
14348 While the function @code{fetchfunc} is executing, the symbol @code{user}
14349 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
14350 @code{"pophost"}. The symbols @code{port}, @code{password},
14351 @code{program}, @code{prescript}, @code{postscript}, @code{function},
14352 and @code{authentication} are also bound (to their default values).
14354 See above for a list of keywords for each type of mail source.
14357 @node Mail Source Customization
14358 @subsubsection Mail Source Customization
14360 The following is a list of variables that influence how the mail is
14361 fetched. You would normally not need to set or change any of these
14365 @item mail-source-crash-box
14366 @vindex mail-source-crash-box
14367 File where mail will be stored while processing it. The default is@*
14368 @file{~/.emacs-mail-crash-box}.
14370 @item mail-source-delete-incoming
14371 @vindex mail-source-delete-incoming
14372 If non-@code{nil}, delete incoming files after handling them. If
14373 @code{t}, delete the files immediately, if @code{nil}, never delete any
14374 files. If a positive number, delete files older than number of days
14375 (This will only happen, when receiving new mail). You may also set
14376 @code{mail-source-delete-incoming} to @code{nil} and call
14377 @code{mail-source-delete-old-incoming} from a hook or interactively.
14379 @item mail-source-delete-old-incoming-confirm
14380 @vindex mail-source-delete-old-incoming-confirm
14381 If non-@code{nil}, ask for for confirmation before deleting old incoming
14382 files. This variable only applies when
14383 @code{mail-source-delete-incoming} is a positive number.
14385 @item mail-source-ignore-errors
14386 @vindex mail-source-ignore-errors
14387 If non-@code{nil}, ignore errors when reading mail from a mail source.
14389 @item mail-source-directory
14390 @vindex mail-source-directory
14391 Directory where incoming mail source files (if any) will be stored. The
14392 default is @file{~/Mail/}. At present, the only thing this is used for
14393 is to say where the incoming files will be stored if the variable
14394 @code{mail-source-delete-incoming} is @code{nil} or a number.
14396 @item mail-source-incoming-file-prefix
14397 @vindex mail-source-incoming-file-prefix
14398 Prefix for file name for storing incoming mail. The default is
14399 @file{Incoming}, in which case files will end up with names like
14400 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
14401 relevant if @code{mail-source-delete-incoming} is @code{nil} or a
14404 @item mail-source-default-file-modes
14405 @vindex mail-source-default-file-modes
14406 All new mail files will get this file mode. The default is 384.
14408 @item mail-source-movemail-program
14409 @vindex mail-source-movemail-program
14410 If non-@code{nil}, name of program for fetching new mail. If
14411 @code{nil}, @code{movemail} in @var{exec-directory}.
14416 @node Fetching Mail
14417 @subsubsection Fetching Mail
14419 @vindex mail-sources
14420 @vindex nnmail-spool-file
14421 The way to actually tell Gnus where to get new mail from is to set
14422 @code{mail-sources} to a list of mail source specifiers
14423 (@pxref{Mail Source Specifiers}).
14425 If this variable (and the obsolescent @code{nnmail-spool-file}) is
14426 @code{nil}, the mail back ends will never attempt to fetch mail by
14429 If you want to fetch mail both from your local spool as well as a
14430 @acronym{POP} mail server, you'd say something like:
14435 (pop :server "pop3.mail.server"
14436 :password "secret")))
14439 Or, if you don't want to use any of the keyword defaults:
14443 '((file :path "/var/spool/mail/user-name")
14444 (pop :server "pop3.mail.server"
14447 :password "secret")))
14451 When you use a mail back end, Gnus will slurp all your mail from your
14452 inbox and plonk it down in your home directory. Gnus doesn't move any
14453 mail if you're not using a mail back end---you have to do a lot of magic
14454 invocations first. At the time when you have finished drawing the
14455 pentagram, lightened the candles, and sacrificed the goat, you really
14456 shouldn't be too surprised when Gnus moves your mail.
14460 @node Mail Back End Variables
14461 @subsection Mail Back End Variables
14463 These variables are (for the most part) pertinent to all the various
14467 @vindex nnmail-read-incoming-hook
14468 @item nnmail-read-incoming-hook
14469 The mail back ends all call this hook after reading new mail. You can
14470 use this hook to notify any mail watch programs, if you want to.
14472 @vindex nnmail-split-hook
14473 @item nnmail-split-hook
14474 @findex gnus-article-decode-encoded-words
14475 @cindex RFC 1522 decoding
14476 @cindex RFC 2047 decoding
14477 Hook run in the buffer where the mail headers of each message is kept
14478 just before the splitting based on these headers is done. The hook is
14479 free to modify the buffer contents in any way it sees fit---the buffer
14480 is discarded after the splitting has been done, and no changes performed
14481 in the buffer will show up in any files.
14482 @code{gnus-article-decode-encoded-words} is one likely function to add
14485 @vindex nnmail-pre-get-new-mail-hook
14486 @vindex nnmail-post-get-new-mail-hook
14487 @item nnmail-pre-get-new-mail-hook
14488 @itemx nnmail-post-get-new-mail-hook
14489 These are two useful hooks executed when treating new incoming
14490 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
14491 starting to handle the new mail) and
14492 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
14493 is done). Here's and example of using these two hooks to change the
14494 default file modes the new mail files get:
14497 (add-hook 'nnmail-pre-get-new-mail-hook
14498 (lambda () (set-default-file-modes 511)))
14500 (add-hook 'nnmail-post-get-new-mail-hook
14501 (lambda () (set-default-file-modes 551)))
14504 @item nnmail-use-long-file-names
14505 @vindex nnmail-use-long-file-names
14506 If non-@code{nil}, the mail back ends will use long file and directory
14507 names. Groups like @samp{mail.misc} will end up in directories
14508 (assuming use of @code{nnml} back end) or files (assuming use of
14509 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
14510 the same group will end up in @file{mail/misc}.
14512 @item nnmail-delete-file-function
14513 @vindex nnmail-delete-file-function
14514 @findex delete-file
14515 Function called to delete files. It is @code{delete-file} by default.
14517 @item nnmail-cache-accepted-message-ids
14518 @vindex nnmail-cache-accepted-message-ids
14519 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
14520 the back end (via @code{Gcc}, for instance) into the mail duplication
14521 discovery cache. The default is @code{nil}.
14523 @item nnmail-cache-ignore-groups
14524 @vindex nnmail-cache-ignore-groups
14525 This can be a regular expression or a list of regular expressions.
14526 Group names that match any of the regular expressions will never be
14527 recorded in the @code{Message-ID} cache.
14529 This can be useful, for example, when using Fancy Splitting
14530 (@pxref{Fancy Mail Splitting}) together with the function
14531 @code{nnmail-split-fancy-with-parent}.
14536 @node Fancy Mail Splitting
14537 @subsection Fancy Mail Splitting
14538 @cindex mail splitting
14539 @cindex fancy mail splitting
14541 @vindex nnmail-split-fancy
14542 @findex nnmail-split-fancy
14543 If the rather simple, standard method for specifying how to split mail
14544 doesn't allow you to do what you want, you can set
14545 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
14546 play with the @code{nnmail-split-fancy} variable.
14548 Let's look at an example value of this variable first:
14551 ;; @r{Messages from the mailer daemon are not crossposted to any of}
14552 ;; @r{the ordinary groups. Warnings are put in a separate group}
14553 ;; @r{from real errors.}
14554 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
14556 ;; @r{Non-error messages are crossposted to all relevant}
14557 ;; @r{groups, but we don't crosspost between the group for the}
14558 ;; @r{(ding) list and the group for other (ding) related mail.}
14559 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
14560 ("subject" "ding" "ding.misc"))
14561 ;; @r{Other mailing lists@dots{}}
14562 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
14563 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
14564 ;; @r{Both lists below have the same suffix, so prevent}
14565 ;; @r{cross-posting to mkpkg.list of messages posted only to}
14566 ;; @r{the bugs- list, but allow cross-posting when the}
14567 ;; @r{message was really cross-posted.}
14568 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
14569 (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list")
14570 ;; @r{People@dots{}}
14571 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
14572 ;; @r{Unmatched mail goes to the catch all group.}
14576 This variable has the format of a @dfn{split}. A split is a
14577 (possibly) recursive structure where each split may contain other
14578 splits. Here are the possible split syntaxes:
14583 If the split is a string, that will be taken as a group name. Normal
14584 regexp match expansion will be done. See below for examples.
14586 @c Don't fold this line.
14587 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split} [@var{invert-partial}])
14588 The split can be a list containing at least three elements. If the
14589 first element @var{field} (a regexp matching a header) contains
14590 @var{value} (also a regexp) then store the message as specified by
14593 If @var{restrict} (yet another regexp) matches some string after
14594 @var{field} and before the end of the matched @var{value}, the
14595 @var{split} is ignored. If none of the @var{restrict} clauses match,
14596 @var{split} is processed.
14598 The last element @var{invert-partial} is optional. If it is
14599 non-@code{nil}, the match-partial-words behavior controlled by the
14600 variable @code{nnmail-split-fancy-match-partial-words} (see below) is
14601 be inverted. (New in Gnus 5.10.7)
14603 @item (| @var{split} @dots{})
14604 If the split is a list, and the first element is @code{|} (vertical
14605 bar), then process each @var{split} until one of them matches. A
14606 @var{split} is said to match if it will cause the mail message to be
14607 stored in one or more groups.
14609 @item (& @var{split} @dots{})
14610 If the split is a list, and the first element is @code{&}, then
14611 process all @var{split}s in the list.
14614 If the split is the symbol @code{junk}, then don't save (i.e., delete)
14615 this message. Use with extreme caution.
14617 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
14618 If the split is a list, and the first element is @samp{:}, then the
14619 second element will be called as a function with @var{args} given as
14620 arguments. The function should return a @var{split}.
14623 For instance, the following function could be used to split based on the
14624 body of the messages:
14627 (defun split-on-body ()
14631 (goto-char (point-min))
14632 (when (re-search-forward "Some.*string" nil t)
14636 The buffer is narrowed to the message in question when @var{function}
14637 is run. That's why @code{(widen)} needs to be called after
14638 @code{save-excursion} and @code{save-restriction} in the example
14639 above. Also note that with the nnimap back end, message bodies will
14640 not be downloaded by default. You need to set
14641 @code{nnimap-split-download-body} to @code{t} to do that
14642 (@pxref{Splitting in IMAP}).
14644 @item (! @var{func} @var{split})
14645 If the split is a list, and the first element is @code{!}, then
14646 @var{split} will be processed, and @var{func} will be called as a
14647 function with the result of @var{split} as argument. @var{func}
14648 should return a split.
14651 If the split is @code{nil}, it is ignored.
14655 In these splits, @var{field} must match a complete field name.
14657 Normally, @var{value} in these splits must match a complete @emph{word}
14658 according to the fundamental mode syntax table. In other words, all
14659 @var{value}'s will be implicitly surrounded by @code{\<...\>} markers,
14660 which are word delimiters. Therefore, if you use the following split,
14664 (any "joe" "joemail")
14668 messages sent from @samp{joedavis@@foo.org} will normally not be filed
14669 in @samp{joemail}. If you want to alter this behavior, you can use any
14670 of the following three ways:
14674 @vindex nnmail-split-fancy-match-partial-words
14675 You can set the @code{nnmail-split-fancy-match-partial-words} variable
14676 to non-@code{nil} in order to ignore word boundaries and instead the
14677 match becomes more like a grep. This variable controls whether partial
14678 words are matched during fancy splitting. The default value is
14681 Note that it influences all @var{value}'s in your split rules.
14684 @var{value} beginning with @code{.*} ignores word boundaries in front of
14685 a word. Similarly, if @var{value} ends with @code{.*}, word boundaries
14686 in the rear of a word will be ignored. For example, the @var{value}
14687 @code{"@@example\\.com"} does not match @samp{foo@@example.com} but
14688 @code{".*@@example\\.com"} does.
14691 You can set the @var{invert-partial} flag in your split rules of the
14692 @samp{(@var{field} @var{value} @dots{})} types, aforementioned in this
14693 section. If the flag is set, word boundaries on both sides of a word
14694 are ignored even if @code{nnmail-split-fancy-match-partial-words} is
14695 @code{nil}. Contrarily, if the flag is set, word boundaries are not
14696 ignored even if @code{nnmail-split-fancy-match-partial-words} is
14697 non-@code{nil}. (New in Gnus 5.10.7)
14700 @vindex nnmail-split-abbrev-alist
14701 @var{field} and @var{value} can also be Lisp symbols, in that case
14702 they are expanded as specified by the variable
14703 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
14704 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14705 contains the associated value. Predefined entries in
14706 @code{nnmail-split-abbrev-alist} include:
14710 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14712 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14713 @samp{Resent-To} and @samp{Resent-Cc} fields.
14715 Is the union of the @code{from} and @code{to} entries.
14718 @vindex nnmail-split-fancy-syntax-table
14719 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14720 when all this splitting is performed.
14722 If you want to have Gnus create groups dynamically based on some
14723 information in the headers (i.e., do @code{replace-match}-like
14724 substitutions in the group names), you can say things like:
14727 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14730 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14731 will be filed in @samp{mail.debian.foo}.
14733 If the string contains the element @samp{\&}, then the previously
14734 matched string will be substituted. Similarly, the elements @samp{\\1}
14735 up to @samp{\\9} will be substituted with the text matched by the
14736 groupings 1 through 9.
14738 @vindex nnmail-split-lowercase-expanded
14739 Where @code{nnmail-split-lowercase-expanded} controls whether the
14740 lowercase of the matched string should be used for the substitution.
14741 Setting it as non-@code{nil} is useful to avoid the creation of multiple
14742 groups when users send to an address using different case
14743 (i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value
14746 @findex nnmail-split-fancy-with-parent
14747 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14748 split followups into the same groups their parents are in. Sometimes
14749 you can't make splitting rules for all your mail. For example, your
14750 boss might send you personal mail regarding different projects you are
14751 working on, and as you can't tell your boss to put a distinguishing
14752 string into the subject line, you have to resort to manually moving the
14753 messages into the right group. With this function, you only have to do
14754 it once per thread.
14756 To use this feature, you have to set @code{nnmail-treat-duplicates}
14757 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14758 value. And then you can include @code{nnmail-split-fancy-with-parent}
14759 using the colon feature, like so:
14761 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
14762 nnmail-cache-accepted-message-ids t
14764 '(| (: nnmail-split-fancy-with-parent)
14765 ;; @r{other splits go here}
14769 This feature works as follows: when @code{nnmail-treat-duplicates} is
14770 non-@code{nil}, Gnus records the message id of every message it sees
14771 in the file specified by the variable
14772 @code{nnmail-message-id-cache-file}, together with the group it is in
14773 (the group is omitted for non-mail messages). When mail splitting is
14774 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
14775 at the References (and In-Reply-To) header of each message to split
14776 and searches the file specified by @code{nnmail-message-id-cache-file}
14777 for the message ids. When it has found a parent, it returns the
14778 corresponding group name unless the group name matches the regexp
14779 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
14780 recommended that you set @code{nnmail-message-id-cache-length} to a
14781 somewhat higher number than the default so that the message ids are
14782 still in the cache. (A value of 5000 appears to create a file some
14783 300 kBytes in size.)
14784 @vindex nnmail-cache-accepted-message-ids
14785 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
14786 also records the message ids of moved articles, so that the followup
14787 messages goes into the new group.
14789 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
14790 want certain groups to be recorded in the cache. For example, if all
14791 outgoing messages are written to an ``outgoing'' group, you could set
14792 @code{nnmail-cache-ignore-groups} to match that group name.
14793 Otherwise, answers to all your messages would end up in the
14794 ``outgoing'' group.
14797 @node Group Mail Splitting
14798 @subsection Group Mail Splitting
14799 @cindex mail splitting
14800 @cindex group mail splitting
14802 @findex gnus-group-split
14803 If you subscribe to dozens of mailing lists but you don't want to
14804 maintain mail splitting rules manually, group mail splitting is for you.
14805 You just have to set @code{to-list} and/or @code{to-address} in group
14806 parameters or group customization and set @code{nnmail-split-methods} to
14807 @code{gnus-group-split}. This splitting function will scan all groups
14808 for those parameters and split mail accordingly, i.e., messages posted
14809 from or to the addresses specified in the parameters @code{to-list} or
14810 @code{to-address} of a mail group will be stored in that group.
14812 Sometimes, mailing lists have multiple addresses, and you may want mail
14813 splitting to recognize them all: just set the @code{extra-aliases} group
14814 parameter to the list of additional addresses and it's done. If you'd
14815 rather use a regular expression, set @code{split-regexp}.
14817 All these parameters in a group will be used to create an
14818 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
14819 the @var{value} is a single regular expression that matches
14820 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
14821 matches of @code{split-regexp}, and the @var{split} is the name of the
14822 group. @var{restrict}s are also supported: just set the
14823 @code{split-exclude} parameter to a list of regular expressions.
14825 If you can't get the right split to be generated using all these
14826 parameters, or you just need something fancier, you can set the
14827 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
14828 this case, all other aforementioned parameters will be ignored by
14829 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
14830 @code{nil}, in which case the group will be ignored by
14831 @code{gnus-group-split}.
14833 @vindex gnus-group-split-default-catch-all-group
14834 @code{gnus-group-split} will do cross-posting on all groups that match,
14835 by defining a single @code{&} fancy split containing one split for each
14836 group. If a message doesn't match any split, it will be stored in the
14837 group named in @code{gnus-group-split-default-catch-all-group}, unless
14838 some group has @code{split-spec} set to @code{catch-all}, in which case
14839 that group is used as the catch-all group. Even though this variable is
14840 often used just to name a group, it may also be set to an arbitrarily
14841 complex fancy split (after all, a group name is a fancy split), and this
14842 may be useful to split mail that doesn't go to any mailing list to
14843 personal mail folders. Note that this fancy split is added as the last
14844 element of a @code{|} split list that also contains a @code{&} split
14845 with the rules extracted from group parameters.
14847 It's time for an example. Assume the following group parameters have
14852 ((to-address . "bar@@femail.com")
14853 (split-regexp . ".*@@femail\\.com"))
14855 ((to-list . "foo@@nowhere.gov")
14856 (extra-aliases "foo@@localhost" "foo-redist@@home")
14857 (split-exclude "bugs-foo" "rambling-foo")
14858 (admin-address . "foo-request@@nowhere.gov"))
14860 ((split-spec . catch-all))
14863 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
14864 behave as if @code{nnmail-split-fancy} had been selected and variable
14865 @code{nnmail-split-fancy} had been set as follows:
14868 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
14869 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
14870 - "bugs-foo" - "rambling-foo" "mail.foo"))
14874 @findex gnus-group-split-fancy
14875 If you'd rather not use group splitting for all your mail groups, you
14876 may use it for only some of them, by using @code{nnmail-split-fancy}
14880 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
14883 @var{groups} may be a regular expression or a list of group names whose
14884 parameters will be scanned to generate the output split.
14885 @var{no-crosspost} can be used to disable cross-posting; in this case, a
14886 single @code{|} split will be output. @var{catch-all} is the fall back
14887 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
14888 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
14889 empty string in any selected group, no catch-all split will be issued.
14890 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
14891 this group will override the value of the @var{catch-all} argument.
14893 @findex gnus-group-split-setup
14894 Unfortunately, scanning all groups and their parameters can be quite
14895 slow, especially considering that it has to be done for every message.
14896 But don't despair! The function @code{gnus-group-split-setup} can be
14897 used to enable @code{gnus-group-split} in a much more efficient way. It
14898 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
14899 @code{nnmail-split-fancy} to the split produced by
14900 @code{gnus-group-split-fancy}. Thus, the group parameters are only
14901 scanned once, no matter how many messages are split.
14903 @findex gnus-group-split-update
14904 However, if you change group parameters, you'd have to update
14905 @code{nnmail-split-fancy} manually. You can do it by running
14906 @code{gnus-group-split-update}. If you'd rather have it updated
14907 automatically, just tell @code{gnus-group-split-setup} to do it for
14908 you. For example, add to your @file{~/.gnus.el}:
14911 (gnus-group-split-setup @var{auto-update} @var{catch-all})
14914 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
14915 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
14916 have to worry about updating @code{nnmail-split-fancy} again. If you
14917 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
14918 @code{gnus-group-split-default-catch-all-group} will be set to its
14921 @vindex gnus-group-split-updated-hook
14922 Because you may want to change @code{nnmail-split-fancy} after it is set
14923 by @code{gnus-group-split-update}, this function will run
14924 @code{gnus-group-split-updated-hook} just before finishing.
14926 @node Incorporating Old Mail
14927 @subsection Incorporating Old Mail
14928 @cindex incorporating old mail
14929 @cindex import old mail
14931 Most people have lots of old mail stored in various file formats. If
14932 you have set up Gnus to read mail using one of the spiffy Gnus mail
14933 back ends, you'll probably wish to have that old mail incorporated into
14936 Doing so can be quite easy.
14938 To take an example: You're reading mail using @code{nnml}
14939 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
14940 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
14941 file filled with important, but old, mail. You want to move it into
14942 your @code{nnml} groups.
14948 Go to the group buffer.
14951 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
14952 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
14955 Type @kbd{SPACE} to enter the newly created group.
14958 Type @kbd{M P b} to process-mark all articles in this group's buffer
14959 (@pxref{Setting Process Marks}).
14962 Type @kbd{B r} to respool all the process-marked articles, and answer
14963 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
14966 All the mail messages in the mbox file will now also be spread out over
14967 all your @code{nnml} groups. Try entering them and check whether things
14968 have gone without a glitch. If things look ok, you may consider
14969 deleting the mbox file, but I wouldn't do that unless I was absolutely
14970 sure that all the mail has ended up where it should be.
14972 Respooling is also a handy thing to do if you're switching from one mail
14973 back end to another. Just respool all the mail in the old mail groups
14974 using the new mail back end.
14977 @node Expiring Mail
14978 @subsection Expiring Mail
14979 @cindex article expiry
14980 @cindex expiring mail
14982 Traditional mail readers have a tendency to remove mail articles when
14983 you mark them as read, in some way. Gnus takes a fundamentally
14984 different approach to mail reading.
14986 Gnus basically considers mail just to be news that has been received in
14987 a rather peculiar manner. It does not think that it has the power to
14988 actually change the mail, or delete any mail messages. If you enter a
14989 mail group, and mark articles as ``read'', or kill them in some other
14990 fashion, the mail articles will still exist on the system. I repeat:
14991 Gnus will not delete your old, read mail. Unless you ask it to, of
14994 To make Gnus get rid of your unwanted mail, you have to mark the
14995 articles as @dfn{expirable}. (With the default key bindings, this means
14996 that you have to type @kbd{E}.) This does not mean that the articles
14997 will disappear right away, however. In general, a mail article will be
14998 deleted from your system if, 1) it is marked as expirable, AND 2) it is
14999 more than one week old. If you do not mark an article as expirable, it
15000 will remain on your system until hell freezes over. This bears
15001 repeating one more time, with some spurious capitalizations: IF you do
15002 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
15004 You do not have to mark articles as expirable by hand. Gnus provides
15005 two features, called ``auto-expire'' and ``total-expire'', that can help you
15006 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
15007 for you when you select an article. And ``total-expire'' means that Gnus
15008 considers all articles as expirable that are read. So, in addition to
15009 the articles marked @samp{E}, also the articles marked @samp{r},
15010 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
15013 When should either auto-expire or total-expire be used? Most people
15014 who are subscribed to mailing lists split each list into its own group
15015 and then turn on auto-expire or total-expire for those groups.
15016 (@xref{Splitting Mail}, for more information on splitting each list
15017 into its own group.)
15019 Which one is better, auto-expire or total-expire? It's not easy to
15020 answer. Generally speaking, auto-expire is probably faster. Another
15021 advantage of auto-expire is that you get more marks to work with: for
15022 the articles that are supposed to stick around, you can still choose
15023 between tick and dormant and read marks. But with total-expire, you
15024 only have dormant and ticked to choose from. The advantage of
15025 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
15026 Scoring}). Auto-expire works with normal scoring but not with adaptive
15029 @vindex gnus-auto-expirable-newsgroups
15030 Groups that match the regular expression
15031 @code{gnus-auto-expirable-newsgroups} will have all articles that you
15032 read marked as expirable automatically. All articles marked as
15033 expirable have an @samp{E} in the first column in the summary buffer.
15035 By default, if you have auto expiry switched on, Gnus will mark all the
15036 articles you read as expirable, no matter if they were read or unread
15037 before. To avoid having articles marked as read marked as expirable
15038 automatically, you can put something like the following in your
15039 @file{~/.gnus.el} file:
15041 @vindex gnus-mark-article-hook
15043 (remove-hook 'gnus-mark-article-hook
15044 'gnus-summary-mark-read-and-unread-as-read)
15045 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
15048 Note that making a group auto-expirable doesn't mean that all read
15049 articles are expired---only the articles marked as expirable
15050 will be expired. Also note that using the @kbd{d} command won't make
15051 articles expirable---only semi-automatic marking of articles as read will
15052 mark the articles as expirable in auto-expirable groups.
15054 Let's say you subscribe to a couple of mailing lists, and you want the
15055 articles you have read to disappear after a while:
15058 (setq gnus-auto-expirable-newsgroups
15059 "mail.nonsense-list\\|mail.nice-list")
15062 Another way to have auto-expiry happen is to have the element
15063 @code{auto-expire} in the group parameters of the group.
15065 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
15066 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
15067 don't really mix very well.
15069 @vindex nnmail-expiry-wait
15070 The @code{nnmail-expiry-wait} variable supplies the default time an
15071 expirable article has to live. Gnus starts counting days from when the
15072 message @emph{arrived}, not from when it was sent. The default is seven
15075 Gnus also supplies a function that lets you fine-tune how long articles
15076 are to live, based on what group they are in. Let's say you want to
15077 have one month expiry period in the @samp{mail.private} group, a one day
15078 expiry period in the @samp{mail.junk} group, and a six day expiry period
15081 @vindex nnmail-expiry-wait-function
15083 (setq nnmail-expiry-wait-function
15085 (cond ((string= group "mail.private")
15087 ((string= group "mail.junk")
15089 ((string= group "important")
15095 The group names this function is fed are ``unadorned'' group
15096 names---no @samp{nnml:} prefixes and the like.
15098 The @code{nnmail-expiry-wait} variable and
15099 @code{nnmail-expiry-wait-function} function can either be a number (not
15100 necessarily an integer) or one of the symbols @code{immediate} or
15103 You can also use the @code{expiry-wait} group parameter to selectively
15104 change the expiry period (@pxref{Group Parameters}).
15106 @vindex nnmail-expiry-target
15107 The normal action taken when expiring articles is to delete them.
15108 However, in some circumstances it might make more sense to move them
15109 to other groups instead of deleting them. The variable
15110 @code{nnmail-expiry-target} (and the @code{expiry-target} group
15111 parameter) controls this. The variable supplies a default value for
15112 all groups, which can be overridden for specific groups by the group
15113 parameter. default value is @code{delete}, but this can also be a
15114 string (which should be the name of the group the message should be
15115 moved to), or a function (which will be called in a buffer narrowed to
15116 the message in question, and with the name of the group being moved
15117 from as its parameter) which should return a target---either a group
15118 name or @code{delete}.
15120 Here's an example for specifying a group name:
15122 (setq nnmail-expiry-target "nnml:expired")
15125 @findex nnmail-fancy-expiry-target
15126 @vindex nnmail-fancy-expiry-targets
15127 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
15128 expire mail to groups according to the variable
15129 @code{nnmail-fancy-expiry-targets}. Here's an example:
15132 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
15133 nnmail-fancy-expiry-targets
15134 '((to-from "boss" "nnfolder:Work")
15135 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
15136 ("from" ".*" "nnfolder:Archive-%Y")))
15139 With this setup, any mail that has @code{IMPORTANT} in its Subject
15140 header and was sent in the year @code{YYYY} and month @code{MMM}, will
15141 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
15142 From or To header contains the string @code{boss}, it will get expired
15143 to @code{nnfolder:Work}. All other mail will get expired to
15144 @code{nnfolder:Archive-YYYY}.
15146 @vindex nnmail-keep-last-article
15147 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
15148 expire the final article in a mail newsgroup. This is to make life
15149 easier for procmail users.
15151 @vindex gnus-total-expirable-newsgroups
15152 By the way: That line up there, about Gnus never expiring non-expirable
15153 articles, is a lie. If you put @code{total-expire} in the group
15154 parameters, articles will not be marked as expirable, but all read
15155 articles will be put through the expiry process. Use with extreme
15156 caution. Even more dangerous is the
15157 @code{gnus-total-expirable-newsgroups} variable. All groups that match
15158 this regexp will have all read articles put through the expiry process,
15159 which means that @emph{all} old mail articles in the groups in question
15160 will be deleted after a while. Use with extreme caution, and don't come
15161 crying to me when you discover that the regexp you used matched the
15162 wrong group and all your important mail has disappeared. Be a
15163 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
15166 Most people make most of their mail groups total-expirable, though.
15168 @vindex gnus-inhibit-user-auto-expire
15169 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
15170 commands will not mark an article as expirable, even if the group has
15171 auto-expire turned on.
15175 @subsection Washing Mail
15176 @cindex mail washing
15177 @cindex list server brain damage
15178 @cindex incoming mail treatment
15180 Mailers and list servers are notorious for doing all sorts of really,
15181 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
15182 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
15183 end of all lines passing through our server, so let's do that!!!!1!''
15184 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
15185 considered to be self-evident were not discussed. So. Here we are.
15187 Case in point: The German version of Microsoft Exchange adds @samp{AW:
15188 } to the subjects of replies instead of @samp{Re: }. I could pretend to
15189 be shocked and dismayed by this, but I haven't got the energy. It is to
15192 Gnus provides a plethora of functions for washing articles while
15193 displaying them, but it might be nicer to do the filtering before
15194 storing the mail to disk. For that purpose, we have three hooks and
15195 various functions that can be put in these hooks.
15198 @item nnmail-prepare-incoming-hook
15199 @vindex nnmail-prepare-incoming-hook
15200 This hook is called before doing anything with the mail and is meant for
15201 grand, sweeping gestures. It is called in a buffer that contains all
15202 the new, incoming mail. Functions to be used include:
15205 @item nnheader-ms-strip-cr
15206 @findex nnheader-ms-strip-cr
15207 Remove trailing carriage returns from each line. This is default on
15208 Emacs running on MS machines.
15212 @item nnmail-prepare-incoming-header-hook
15213 @vindex nnmail-prepare-incoming-header-hook
15214 This hook is called narrowed to each header. It can be used when
15215 cleaning up the headers. Functions that can be used include:
15218 @item nnmail-remove-leading-whitespace
15219 @findex nnmail-remove-leading-whitespace
15220 Clear leading white space that ``helpful'' listservs have added to the
15221 headers to make them look nice. Aaah.
15223 (Note that this function works on both the header on the body of all
15224 messages, so it is a potentially dangerous function to use (if a body
15225 of a message contains something that looks like a header line). So
15226 rather than fix the bug, it is of course the right solution to make it
15227 into a feature by documenting it.)
15229 @item nnmail-remove-list-identifiers
15230 @findex nnmail-remove-list-identifiers
15231 Some list servers add an identifier---for example, @samp{(idm)}---to the
15232 beginning of all @code{Subject} headers. I'm sure that's nice for
15233 people who use stone age mail readers. This function will remove
15234 strings that match the @code{nnmail-list-identifiers} regexp, which can
15235 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
15238 For instance, if you want to remove the @samp{(idm)} and the
15239 @samp{nagnagnag} identifiers:
15242 (setq nnmail-list-identifiers
15243 '("(idm)" "nagnagnag"))
15246 This can also be done non-destructively with
15247 @code{gnus-list-identifiers}, @xref{Article Hiding}.
15249 @item nnmail-remove-tabs
15250 @findex nnmail-remove-tabs
15251 Translate all @samp{TAB} characters into @samp{SPACE} characters.
15253 @item nnmail-ignore-broken-references
15254 @findex nnmail-ignore-broken-references
15255 @c @findex nnmail-fix-eudora-headers
15258 Some mail user agents (e.g. Eudora and Pegasus) produce broken
15259 @code{References} headers, but correct @code{In-Reply-To} headers. This
15260 function will get rid of the @code{References} header if the headers
15261 contain a line matching the regular expression
15262 @code{nnmail-broken-references-mailers}.
15266 @item nnmail-prepare-incoming-message-hook
15267 @vindex nnmail-prepare-incoming-message-hook
15268 This hook is called narrowed to each message. Functions to be used
15272 @item article-de-quoted-unreadable
15273 @findex article-de-quoted-unreadable
15274 Decode Quoted Readable encoding.
15281 @subsection Duplicates
15283 @vindex nnmail-treat-duplicates
15284 @vindex nnmail-message-id-cache-length
15285 @vindex nnmail-message-id-cache-file
15286 @cindex duplicate mails
15287 If you are a member of a couple of mailing lists, you will sometimes
15288 receive two copies of the same mail. This can be quite annoying, so
15289 @code{nnmail} checks for and treats any duplicates it might find. To do
15290 this, it keeps a cache of old @code{Message-ID}s---
15291 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
15292 default. The approximate maximum number of @code{Message-ID}s stored
15293 there is controlled by the @code{nnmail-message-id-cache-length}
15294 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
15295 stored.) If all this sounds scary to you, you can set
15296 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
15297 default), and @code{nnmail} won't delete duplicate mails. Instead it
15298 will insert a warning into the head of the mail saying that it thinks
15299 that this is a duplicate of a different message.
15301 This variable can also be a function. If that's the case, the function
15302 will be called from a buffer narrowed to the message in question with
15303 the @code{Message-ID} as a parameter. The function must return either
15304 @code{nil}, @code{warn}, or @code{delete}.
15306 You can turn this feature off completely by setting the variable to
15309 If you want all the duplicate mails to be put into a special
15310 @dfn{duplicates} group, you could do that using the normal mail split
15314 (setq nnmail-split-fancy
15315 '(| ;; @r{Messages duplicates go to a separate group.}
15316 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
15317 ;; @r{Message from daemons, postmaster, and the like to another.}
15318 (any mail "mail.misc")
15319 ;; @r{Other rules.}
15325 (setq nnmail-split-methods
15326 '(("duplicates" "^Gnus-Warning:.*duplicate")
15327 ;; @r{Other rules.}
15331 Here's a neat feature: If you know that the recipient reads her mail
15332 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
15333 @code{delete}, you can send her as many insults as you like, just by
15334 using a @code{Message-ID} of a mail that you know that she's already
15335 received. Think of all the fun! She'll never see any of it! Whee!
15338 @node Not Reading Mail
15339 @subsection Not Reading Mail
15341 If you start using any of the mail back ends, they have the annoying
15342 habit of assuming that you want to read mail with them. This might not
15343 be unreasonable, but it might not be what you want.
15345 If you set @code{mail-sources} and @code{nnmail-spool-file} to
15346 @code{nil}, none of the back ends will ever attempt to read incoming
15347 mail, which should help.
15349 @vindex nnbabyl-get-new-mail
15350 @vindex nnmbox-get-new-mail
15351 @vindex nnml-get-new-mail
15352 @vindex nnmh-get-new-mail
15353 @vindex nnfolder-get-new-mail
15354 This might be too much, if, for instance, you are reading mail quite
15355 happily with @code{nnml} and just want to peek at some old Rmail
15356 file you have stashed away with @code{nnbabyl}. All back ends have
15357 variables called back-end-@code{get-new-mail}. If you want to disable
15358 the @code{nnbabyl} mail reading, you edit the virtual server for the
15359 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
15361 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
15362 narrowed to the article to be saved before saving it when reading
15366 @node Choosing a Mail Back End
15367 @subsection Choosing a Mail Back End
15369 Gnus will read the mail spool when you activate a mail group. The mail
15370 file is first copied to your home directory. What happens after that
15371 depends on what format you want to store your mail in.
15373 There are six different mail back ends in the standard Gnus, and more
15374 back ends are available separately. The mail back end most people use
15375 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
15379 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
15380 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
15381 * Mail Spool:: Store your mail in a private spool?
15382 * MH Spool:: An mhspool-like back end.
15383 * Maildir:: Another one-file-per-message format.
15384 * Mail Folders:: Having one file for each group.
15385 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
15389 @node Unix Mail Box
15390 @subsubsection Unix Mail Box
15392 @cindex unix mail box
15394 @vindex nnmbox-active-file
15395 @vindex nnmbox-mbox-file
15396 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
15397 mail. @code{nnmbox} will add extra headers to each mail article to say
15398 which group it belongs in.
15400 Virtual server settings:
15403 @item nnmbox-mbox-file
15404 @vindex nnmbox-mbox-file
15405 The name of the mail box in the user's home directory. Default is
15408 @item nnmbox-active-file
15409 @vindex nnmbox-active-file
15410 The name of the active file for the mail box. Default is
15411 @file{~/.mbox-active}.
15413 @item nnmbox-get-new-mail
15414 @vindex nnmbox-get-new-mail
15415 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
15416 into groups. Default is @code{t}.
15421 @subsubsection Rmail Babyl
15425 @vindex nnbabyl-active-file
15426 @vindex nnbabyl-mbox-file
15427 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
15428 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
15429 mail article to say which group it belongs in.
15431 Virtual server settings:
15434 @item nnbabyl-mbox-file
15435 @vindex nnbabyl-mbox-file
15436 The name of the Rmail mbox file. The default is @file{~/RMAIL}
15438 @item nnbabyl-active-file
15439 @vindex nnbabyl-active-file
15440 The name of the active file for the rmail box. The default is
15441 @file{~/.rmail-active}
15443 @item nnbabyl-get-new-mail
15444 @vindex nnbabyl-get-new-mail
15445 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
15451 @subsubsection Mail Spool
15453 @cindex mail @acronym{NOV} spool
15455 The @dfn{nnml} spool mail format isn't compatible with any other known
15456 format. It should be used with some caution.
15458 @vindex nnml-directory
15459 If you use this back end, Gnus will split all incoming mail into files,
15460 one file for each mail, and put the articles into the corresponding
15461 directories under the directory specified by the @code{nnml-directory}
15462 variable. The default value is @file{~/Mail/}.
15464 You do not have to create any directories beforehand; Gnus will take
15467 If you have a strict limit as to how many files you are allowed to store
15468 in your account, you should not use this back end. As each mail gets its
15469 own file, you might very well occupy thousands of inodes within a few
15470 weeks. If this is no problem for you, and it isn't a problem for you
15471 having your friendly systems administrator walking around, madly,
15472 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
15473 know that this is probably the fastest format to use. You do not have
15474 to trudge through a big mbox file just to read your new mail.
15476 @code{nnml} is probably the slowest back end when it comes to article
15477 splitting. It has to create lots of files, and it also generates
15478 @acronym{NOV} databases for the incoming mails. This makes it possibly the
15479 fastest back end when it comes to reading mail.
15481 @cindex self contained nnml servers
15483 When the marks file is used (which it is by default), @code{nnml}
15484 servers have the property that you may backup them using @code{tar} or
15485 similar, and later be able to restore them into Gnus (by adding the
15486 proper @code{nnml} server) and have all your marks be preserved. Marks
15487 for a group are usually stored in the @code{.marks} file (but see
15488 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
15489 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
15490 to restore the group (after restoring the backup into the nnml
15493 If for some reason you believe your @file{.marks} files are screwed
15494 up, you can just delete them all. Gnus will then correctly regenerate
15495 them next time it starts.
15497 Virtual server settings:
15500 @item nnml-directory
15501 @vindex nnml-directory
15502 All @code{nnml} directories will be placed under this directory. The
15503 default is the value of @code{message-directory} (whose default value
15506 @item nnml-active-file
15507 @vindex nnml-active-file
15508 The active file for the @code{nnml} server. The default is
15509 @file{~/Mail/active}.
15511 @item nnml-newsgroups-file
15512 @vindex nnml-newsgroups-file
15513 The @code{nnml} group descriptions file. @xref{Newsgroups File
15514 Format}. The default is @file{~/Mail/newsgroups}.
15516 @item nnml-get-new-mail
15517 @vindex nnml-get-new-mail
15518 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
15521 @item nnml-nov-is-evil
15522 @vindex nnml-nov-is-evil
15523 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15524 default is @code{nil}.
15526 @item nnml-nov-file-name
15527 @vindex nnml-nov-file-name
15528 The name of the @acronym{NOV} files. The default is @file{.overview}.
15530 @item nnml-prepare-save-mail-hook
15531 @vindex nnml-prepare-save-mail-hook
15532 Hook run narrowed to an article before saving.
15534 @item nnml-marks-is-evil
15535 @vindex nnml-marks-is-evil
15536 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15537 default is @code{nil}.
15539 @item nnml-marks-file-name
15540 @vindex nnml-marks-file-name
15541 The name of the @dfn{marks} files. The default is @file{.marks}.
15543 @item nnml-use-compressed-files
15544 @vindex nnml-use-compressed-files
15545 If non-@code{nil}, @code{nnml} will allow using compressed message
15546 files. This requires @code{auto-compression-mode} to be enabled
15547 (@pxref{Compressed Files, ,Compressed Files, emacs, The Emacs Manual}).
15548 If the value of @code{nnml-use-compressed-files} is a string, it is used
15549 as the file extension specifying the compression program. You can set it
15550 to @samp{.bz2} if your Emacs supports it. A value of @code{t} is
15551 equivalent to @samp{.gz}.
15553 @item nnml-compressed-files-size-threshold
15554 @vindex nnml-compressed-files-size-threshold
15555 Default size threshold for compressed message files. Message files with
15556 bodies larger than that many characters will be automatically compressed
15557 if @code{nnml-use-compressed-files} is non-@code{nil}.
15561 @findex nnml-generate-nov-databases
15562 If your @code{nnml} groups and @acronym{NOV} files get totally out of
15563 whack, you can do a complete update by typing @kbd{M-x
15564 nnml-generate-nov-databases}. This command will trawl through the
15565 entire @code{nnml} hierarchy, looking at each and every article, so it
15566 might take a while to complete. A better interface to this
15567 functionality can be found in the server buffer (@pxref{Server
15572 @subsubsection MH Spool
15574 @cindex mh-e mail spool
15576 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
15577 @acronym{NOV} databases and it doesn't keep an active file or marks
15578 file. This makes @code{nnmh} a @emph{much} slower back end than
15579 @code{nnml}, but it also makes it easier to write procmail scripts
15582 Virtual server settings:
15585 @item nnmh-directory
15586 @vindex nnmh-directory
15587 All @code{nnmh} directories will be located under this directory. The
15588 default is the value of @code{message-directory} (whose default is
15591 @item nnmh-get-new-mail
15592 @vindex nnmh-get-new-mail
15593 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
15597 @vindex nnmh-be-safe
15598 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
15599 sure that the articles in the folder are actually what Gnus thinks
15600 they are. It will check date stamps and stat everything in sight, so
15601 setting this to @code{t} will mean a serious slow-down. If you never
15602 use anything but Gnus to read the @code{nnmh} articles, you do not
15603 have to set this variable to @code{t}. The default is @code{nil}.
15608 @subsubsection Maildir
15612 @code{nnmaildir} stores mail in the maildir format, with each maildir
15613 corresponding to a group in Gnus. This format is documented here:
15614 @uref{http://cr.yp.to/proto/maildir.html} and here:
15615 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
15616 also stores extra information in the @file{.nnmaildir/} directory
15619 Maildir format was designed to allow concurrent deliveries and
15620 reading, without needing locks. With other back ends, you would have
15621 your mail delivered to a spool of some kind, and then you would
15622 configure Gnus to split mail from that spool into your groups. You
15623 can still do that with @code{nnmaildir}, but the more common
15624 configuration is to have your mail delivered directly to the maildirs
15625 that appear as group in Gnus.
15627 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
15628 never corrupt its data in memory, and @code{SIGKILL} will never
15629 corrupt its data in the filesystem.
15631 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
15632 maildir. So you can copy a whole maildir from one Gnus setup to
15633 another, and you will keep your marks.
15635 Virtual server settings:
15639 For each of your @code{nnmaildir} servers (it's very unlikely that
15640 you'd need more than one), you need to create a directory and populate
15641 it with maildirs or symlinks to maildirs (and nothing else; do not
15642 choose a directory already used for other purposes). Each maildir
15643 will be represented in Gnus as a newsgroup on that server; the
15644 filename of the symlink will be the name of the group. Any filenames
15645 in the directory starting with @samp{.} are ignored. The directory is
15646 scanned when you first start Gnus, and each time you type @kbd{g} in
15647 the group buffer; if any maildirs have been removed or added,
15648 @code{nnmaildir} notices at these times.
15650 The value of the @code{directory} parameter should be a Lisp form
15651 which is processed by @code{eval} and @code{expand-file-name} to get
15652 the path of the directory for this server. The form is @code{eval}ed
15653 only when the server is opened; the resulting string is used until the
15654 server is closed. (If you don't know about forms and @code{eval},
15655 don't worry---a simple string will work.) This parameter is not
15656 optional; you must specify it. I don't recommend using
15657 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
15658 use that directory by default for various things, and may get confused
15659 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
15662 @item target-prefix
15663 This should be a Lisp form which is processed by @code{eval} and
15664 @code{expand-file-name}. The form is @code{eval}ed only when the
15665 server is opened; the resulting string is used until the server is
15668 When you create a group on an @code{nnmaildir} server, the maildir is
15669 created with @code{target-prefix} prepended to its name, and a symlink
15670 pointing to that maildir is created, named with the plain group name.
15671 So if @code{directory} is @code{"~/.nnmaildir"} and
15672 @code{target-prefix} is @code{"../maildirs/"}, then when you create
15673 the group @code{foo}, @code{nnmaildir} will create
15674 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
15675 @file{~/.nnmaildir/foo} as a symlink pointing to
15676 @file{../maildirs/foo}.
15678 You can set @code{target-prefix} to a string without any slashes to
15679 create both maildirs and symlinks in the same @code{directory}; in
15680 this case, any maildirs found in @code{directory} whose names start
15681 with @code{target-prefix} will not be listed as groups (but the
15682 symlinks pointing to them will be).
15684 As a special case, if @code{target-prefix} is @code{""} (the default),
15685 then when you create a group, the maildir will be created in
15686 @code{directory} without a corresponding symlink. Beware that you
15687 cannot use @code{gnus-group-delete-group} on such groups without the
15688 @code{force} argument.
15690 @item directory-files
15691 This should be a function with the same interface as
15692 @code{directory-files} (such as @code{directory-files} itself). It is
15693 used to scan the server's @code{directory} for maildirs. This
15694 parameter is optional; the default is
15695 @code{nnheader-directory-files-safe} if
15696 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15697 @code{directory-files} otherwise.
15698 (@code{nnheader-directory-files-is-safe} is checked only once when the
15699 server is opened; if you want to check it each time the directory is
15700 scanned, you'll have to provide your own function that does that.)
15703 If non-@code{nil}, then after scanning for new mail in the group
15704 maildirs themselves as usual, this server will also incorporate mail
15705 the conventional Gnus way, from @code{mail-sources} according to
15706 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
15707 value is @code{nil}.
15709 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15710 an @code{nnmaildir} group. The results might happen to be useful, but
15711 that would be by chance, not by design, and the results might be
15712 different in the future. If your split rules create new groups,
15713 remember to supply a @code{create-directory} server parameter.
15716 @subsubsection Group parameters
15718 @code{nnmaildir} uses several group parameters. It's safe to ignore
15719 all this; the default behavior for @code{nnmaildir} is the same as the
15720 default behavior for other mail back ends: articles are deleted after
15721 one week, etc. Except for the expiry parameters, all this
15722 functionality is unique to @code{nnmaildir}, so you can ignore it if
15723 you're just trying to duplicate the behavior you already have with
15726 If the value of any of these parameters is a vector, the first element
15727 is evaluated as a Lisp form and the result is used, rather than the
15728 original value. If the value is not a vector, the value itself is
15729 evaluated as a Lisp form. (This is why these parameters use names
15730 different from those of other, similar parameters supported by other
15731 back ends: they have different, though similar, meanings.) (For
15732 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15733 @code{eval} business again; for other values, remember to use an extra
15734 quote and wrap the value in a vector when appropriate.)
15738 An integer specifying the minimum age, in seconds, of an article
15739 before it will be expired, or the symbol @code{never} to specify that
15740 articles should never be expired. If this parameter is not set,
15741 @code{nnmaildir} falls back to the usual
15742 @code{nnmail-expiry-wait}(@code{-function}) variables (the
15743 @code{expiry-wait} group parameter overrides @code{nnmail-expiry-wait}
15744 and makes @code{nnmail-expiry-wait-function} ineffective). If you
15745 wanted a value of 3 days, you could use something like @code{[(* 3 24
15746 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15747 An article's age is measured starting from the article file's
15748 modification time. Normally, this is the same as the article's
15749 delivery time, but editing an article makes it younger. Moving an
15750 article (other than via expiry) may also make an article younger.
15753 If this is set to a string such as a full Gnus group name, like
15755 "backend+server.address.string:group.name"
15757 and if it is not the name of the same group that the parameter belongs
15758 to, then articles will be moved to the specified group during expiry
15759 before being deleted. @emph{If this is set to an @code{nnmaildir}
15760 group, the article will be just as old in the destination group as it
15761 was in the source group.} So be careful with @code{expire-age} in the
15762 destination group. If this is set to the name of the same group that
15763 the parameter belongs to, then the article is not expired at all. If
15764 you use the vector form, the first element is evaluated once for each
15765 article. So that form can refer to
15766 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15767 article. @emph{Even if this parameter is not set, @code{nnmaildir}
15768 does not fall back to the @code{expiry-target} group parameter or the
15769 @code{nnmail-expiry-target} variable.}
15772 If this is set to @code{t}, @code{nnmaildir} will treat the articles
15773 in this maildir as read-only. This means: articles are not renamed
15774 from @file{new/} into @file{cur/}; articles are only found in
15775 @file{new/}, not @file{cur/}; articles are never deleted; articles
15776 cannot be edited. @file{new/} is expected to be a symlink to the
15777 @file{new/} directory of another maildir---e.g., a system-wide mailbox
15778 containing a mailing list of common interest. Everything in the
15779 maildir outside @file{new/} is @emph{not} treated as read-only, so for
15780 a shared mailbox, you do still need to set up your own maildir (or
15781 have write permission to the shared mailbox); your maildir just won't
15782 contain extra copies of the articles.
15784 @item directory-files
15785 A function with the same interface as @code{directory-files}. It is
15786 used to scan the directories in the maildir corresponding to this
15787 group to find articles. The default is the function specified by the
15788 server's @code{directory-files} parameter.
15790 @item distrust-Lines:
15791 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
15792 article, rather than use the @code{Lines:} header field. If
15793 @code{nil}, the header field will be used if present.
15796 A list of mark symbols, such as @code{['(read expire)]}. Whenever
15797 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15798 say that all articles have these marks, regardless of whether the
15799 marks stored in the filesystem say so. This is a proof-of-concept
15800 feature that will probably be removed eventually; it ought to be done
15801 in Gnus proper, or abandoned if it's not worthwhile.
15804 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
15805 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15806 say that no articles have these marks, regardless of whether the marks
15807 stored in the filesystem say so. @code{never-marks} overrides
15808 @code{always-marks}. This is a proof-of-concept feature that will
15809 probably be removed eventually; it ought to be done in Gnus proper, or
15810 abandoned if it's not worthwhile.
15812 @item nov-cache-size
15813 An integer specifying the size of the @acronym{NOV} memory cache. To
15814 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
15815 for a limited number of articles in each group. (This is probably not
15816 worthwhile, and will probably be removed in the future.) This
15817 parameter's value is noticed only the first time a group is seen after
15818 the server is opened---i.e., when you first start Gnus, typically.
15819 The @acronym{NOV} cache is never resized until the server is closed
15820 and reopened. The default is an estimate of the number of articles
15821 that would be displayed in the summary buffer: a count of articles
15822 that are either marked with @code{tick} or not marked with
15823 @code{read}, plus a little extra.
15826 @subsubsection Article identification
15827 Articles are stored in the @file{cur/} subdirectory of each maildir.
15828 Each article file is named like @code{uniq:info}, where @code{uniq}
15829 contains no colons. @code{nnmaildir} ignores, but preserves, the
15830 @code{:info} part. (Other maildir readers typically use this part of
15831 the filename to store marks.) The @code{uniq} part uniquely
15832 identifies the article, and is used in various places in the
15833 @file{.nnmaildir/} subdirectory of the maildir to store information
15834 about the corresponding article. The full pathname of an article is
15835 available in the variable @code{nnmaildir-article-file-name} after you
15836 request the article in the summary buffer.
15838 @subsubsection NOV data
15839 An article identified by @code{uniq} has its @acronym{NOV} data (used
15840 to generate lines in the summary buffer) stored in
15841 @code{.nnmaildir/nov/uniq}. There is no
15842 @code{nnmaildir-generate-nov-databases} function. (There isn't much
15843 need for it---an article's @acronym{NOV} data is updated automatically
15844 when the article or @code{nnmail-extra-headers} has changed.) You can
15845 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
15846 single article simply by deleting the corresponding @acronym{NOV}
15847 file, but @emph{beware}: this will also cause @code{nnmaildir} to
15848 assign a new article number for this article, which may cause trouble
15849 with @code{seen} marks, the Agent, and the cache.
15851 @subsubsection Article marks
15852 An article identified by @code{uniq} is considered to have the mark
15853 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
15854 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
15855 looks for such files and reports the set of marks it finds. When Gnus
15856 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
15857 creates and deletes the corresponding files as needed. (Actually,
15858 rather than create a new file for each mark, it just creates hard
15859 links to @file{.nnmaildir/markfile}, to save inodes.)
15861 You can invent new marks by creating a new directory in
15862 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
15863 your server, untar it later, and keep your marks. You can add and
15864 remove marks yourself by creating and deleting mark files. If you do
15865 this while Gnus is running and your @code{nnmaildir} server is open,
15866 it's best to exit all summary buffers for @code{nnmaildir} groups and
15867 type @kbd{s} in the group buffer first, and to type @kbd{g} or
15868 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
15869 pick up the changes, and might undo them.
15873 @subsubsection Mail Folders
15875 @cindex mbox folders
15876 @cindex mail folders
15878 @code{nnfolder} is a back end for storing each mail group in a
15879 separate file. Each file is in the standard Un*x mbox format.
15880 @code{nnfolder} will add extra headers to keep track of article
15881 numbers and arrival dates.
15883 @cindex self contained nnfolder servers
15885 When the marks file is used (which it is by default), @code{nnfolder}
15886 servers have the property that you may backup them using @code{tar} or
15887 similar, and later be able to restore them into Gnus (by adding the
15888 proper @code{nnfolder} server) and have all your marks be preserved.
15889 Marks for a group are usually stored in a file named as the mbox file
15890 with @code{.mrk} concatenated to it (but see
15891 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
15892 directory. Individual @code{nnfolder} groups are also possible to
15893 backup, use @kbd{G m} to restore the group (after restoring the backup
15894 into the @code{nnfolder} directory).
15896 Virtual server settings:
15899 @item nnfolder-directory
15900 @vindex nnfolder-directory
15901 All the @code{nnfolder} mail boxes will be stored under this
15902 directory. The default is the value of @code{message-directory}
15903 (whose default is @file{~/Mail})
15905 @item nnfolder-active-file
15906 @vindex nnfolder-active-file
15907 The name of the active file. The default is @file{~/Mail/active}.
15909 @item nnfolder-newsgroups-file
15910 @vindex nnfolder-newsgroups-file
15911 The name of the group descriptions file. @xref{Newsgroups File
15912 Format}. The default is @file{~/Mail/newsgroups}
15914 @item nnfolder-get-new-mail
15915 @vindex nnfolder-get-new-mail
15916 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
15917 default is @code{t}
15919 @item nnfolder-save-buffer-hook
15920 @vindex nnfolder-save-buffer-hook
15921 @cindex backup files
15922 Hook run before saving the folders. Note that Emacs does the normal
15923 backup renaming of files even with the @code{nnfolder} buffers. If
15924 you wish to switch this off, you could say something like the
15925 following in your @file{.emacs} file:
15928 (defun turn-off-backup ()
15929 (set (make-local-variable 'backup-inhibited) t))
15931 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
15934 @item nnfolder-delete-mail-hook
15935 @vindex nnfolder-delete-mail-hook
15936 Hook run in a buffer narrowed to the message that is to be deleted.
15937 This function can be used to copy the message to somewhere else, or to
15938 extract some information from it before removing it.
15940 @item nnfolder-nov-is-evil
15941 @vindex nnfolder-nov-is-evil
15942 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15943 default is @code{nil}.
15945 @item nnfolder-nov-file-suffix
15946 @vindex nnfolder-nov-file-suffix
15947 The extension for @acronym{NOV} files. The default is @file{.nov}.
15949 @item nnfolder-nov-directory
15950 @vindex nnfolder-nov-directory
15951 The directory where the @acronym{NOV} files should be stored. If
15952 @code{nil}, @code{nnfolder-directory} is used.
15954 @item nnfolder-marks-is-evil
15955 @vindex nnfolder-marks-is-evil
15956 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15957 default is @code{nil}.
15959 @item nnfolder-marks-file-suffix
15960 @vindex nnfolder-marks-file-suffix
15961 The extension for @sc{marks} files. The default is @file{.mrk}.
15963 @item nnfolder-marks-directory
15964 @vindex nnfolder-marks-directory
15965 The directory where the @sc{marks} files should be stored. If
15966 @code{nil}, @code{nnfolder-directory} is used.
15971 @findex nnfolder-generate-active-file
15972 @kindex M-x nnfolder-generate-active-file
15973 If you have lots of @code{nnfolder}-like files you'd like to read with
15974 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
15975 command to make @code{nnfolder} aware of all likely files in
15976 @code{nnfolder-directory}. This only works if you use long file names,
15979 @node Comparing Mail Back Ends
15980 @subsubsection Comparing Mail Back Ends
15982 First, just for terminology, the @dfn{back end} is the common word for a
15983 low-level access method---a transport, if you will, by which something
15984 is acquired. The sense is that one's mail has to come from somewhere,
15985 and so selection of a suitable back end is required in order to get that
15986 mail within spitting distance of Gnus.
15988 The same concept exists for Usenet itself: Though access to articles is
15989 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
15990 in the world got at Usenet by running a reader on the machine where the
15991 articles lay (the machine which today we call an @acronym{NNTP} server), and
15992 access was by the reader stepping into the articles' directory spool
15993 area directly. One can still select between either the @code{nntp} or
15994 @code{nnspool} back ends, to select between these methods, if one happens
15995 actually to live on the server (or can see its spool directly, anyway,
15998 The goal in selecting a mail back end is to pick one which
15999 simultaneously represents a suitable way of dealing with the original
16000 format plus leaving mail in a form that is convenient to use in the
16001 future. Here are some high and low points on each:
16006 UNIX systems have historically had a single, very common, and well-
16007 defined format. All messages arrive in a single @dfn{spool file}, and
16008 they are delineated by a line whose regular expression matches
16009 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
16010 to make it clear in this instance that this is not the RFC-specified
16011 @samp{From:} header.) Because Emacs and therefore Gnus emanate
16012 historically from the Unix environment, it is simplest if one does not
16013 mess a great deal with the original mailbox format, so if one chooses
16014 this back end, Gnus' primary activity in getting mail from the real spool
16015 area to Gnus' preferred directory is simply to copy it, with no
16016 (appreciable) format change in the process. It is the ``dumbest'' way
16017 to move mail into availability in the Gnus environment. This makes it
16018 fast to move into place, but slow to parse, when Gnus has to look at
16023 Once upon a time, there was the DEC-10 and DEC-20, running operating
16024 systems called TOPS and related things, and the usual (only?) mail
16025 reading environment was a thing called Babyl. I don't know what format
16026 was used for mail landing on the system, but Babyl had its own internal
16027 format to which mail was converted, primarily involving creating a
16028 spool-file-like entity with a scheme for inserting Babyl-specific
16029 headers and status bits above the top of each message in the file.
16030 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
16031 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
16032 to understand the mail files folks already had in existence. Gnus (and
16033 VM, for that matter) continue to support this format because it's
16034 perceived as having some good qualities in those mailer-specific
16035 headers/status bits stuff. Rmail itself still exists as well, of
16036 course, and is still maintained by Stallman.
16038 Both of the above forms leave your mail in a single file on your
16039 file system, and they must parse that entire file each time you take a
16044 @code{nnml} is the back end which smells the most as though you were
16045 actually operating with an @code{nnspool}-accessed Usenet system. (In
16046 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
16047 lo these years ago.) One's mail is taken from the original spool file,
16048 and is then cut up into individual message files, 1:1. It maintains a
16049 Usenet-style active file (analogous to what one finds in an INN- or
16050 CNews-based news system in (for instance) @file{/var/lib/news/active},
16051 or what is returned via the @samp{NNTP LIST} verb) and also creates
16052 @dfn{overview} files for efficient group entry, as has been defined for
16053 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
16054 due to the creation of lots of files, updates to the @code{nnml} active
16055 file, and additions to overview files on a per-message basis, but it is
16056 extremely fast on access because of what amounts to the indexing support
16057 provided by the active file and overviews.
16059 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
16060 resource which defines available places in the file system to put new
16061 files. Sysadmins take a dim view of heavy inode occupation within
16062 tight, shared file systems. But if you live on a personal machine where
16063 the file system is your own and space is not at a premium, @code{nnml}
16066 It is also problematic using this back end if you are living in a
16067 FAT16-based Windows world, since much space will be wasted on all these
16072 The Rand MH mail-reading system has been around UNIX systems for a very
16073 long time; it operates by splitting one's spool file of messages into
16074 individual files, but with little or no indexing support---@code{nnmh}
16075 is considered to be semantically equivalent to ``@code{nnml} without
16076 active file or overviews''. This is arguably the worst choice, because
16077 one gets the slowness of individual file creation married to the
16078 slowness of access parsing when learning what's new in one's groups.
16082 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
16083 method described above) on a per-group basis. That is, @code{nnmbox}
16084 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
16085 little bit of optimization to this so that each of one's mail groups has
16086 a Unix mail box file. It's faster than @code{nnmbox} because each group
16087 can be parsed separately, and still provides the simple Unix mail box
16088 format requiring minimal effort in moving the mail around. In addition,
16089 it maintains an ``active'' file making it much faster for Gnus to figure
16090 out how many messages there are in each separate group.
16092 If you have groups that are expected to have a massive amount of
16093 messages, @code{nnfolder} is not the best choice, but if you receive
16094 only a moderate amount of mail, @code{nnfolder} is probably the most
16095 friendly mail back end all over.
16099 For configuring expiry and other things, @code{nnmaildir} uses
16100 incompatible group parameters, slightly different from those of other
16103 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
16104 differences. Each message is stored in a separate file, but the
16105 filename is unrelated to the article number in Gnus. @code{nnmaildir}
16106 also stores the equivalent of @code{nnml}'s overview files in one file
16107 per article, so it uses about twice as many inodes as @code{nnml}. (Use
16108 @code{df -i} to see how plentiful your inode supply is.) If this slows
16109 you down or takes up very much space, consider switching to
16110 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
16113 Since maildirs don't require locking for delivery, the maildirs you use
16114 as groups can also be the maildirs your mail is directly delivered to.
16115 This means you can skip Gnus' mail splitting if your mail is already
16116 organized into different mailboxes during delivery. A @code{directory}
16117 entry in @code{mail-sources} would have a similar effect, but would
16118 require one set of mailboxes for spooling deliveries (in mbox format,
16119 thus damaging message bodies), and another set to be used as groups (in
16120 whatever format you like). A maildir has a built-in spool, in the
16121 @code{new/} subdirectory. Beware that currently, mail moved from
16122 @code{new/} to @code{cur/} instead of via mail splitting will not
16123 undergo treatment such as duplicate checking.
16125 @code{nnmaildir} stores article marks for a given group in the
16126 corresponding maildir, in a way designed so that it's easy to manipulate
16127 them from outside Gnus. You can tar up a maildir, unpack it somewhere
16128 else, and still have your marks. @code{nnml} also stores marks, but
16129 it's not as easy to work with them from outside Gnus as with
16132 @code{nnmaildir} uses a significant amount of memory to speed things up.
16133 (It keeps in memory some of the things that @code{nnml} stores in files
16134 and that @code{nnmh} repeatedly parses out of message files.) If this
16135 is a problem for you, you can set the @code{nov-cache-size} group
16136 parameter to something small (0 would probably not work, but 1 probably
16137 would) to make it use less memory. This caching will probably be
16138 removed in the future.
16140 Startup is likely to be slower with @code{nnmaildir} than with other
16141 back ends. Everything else is likely to be faster, depending in part
16142 on your file system.
16144 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
16145 to write an @code{nnmaildir}-derived back end.
16150 @node Browsing the Web
16151 @section Browsing the Web
16153 @cindex browsing the web
16157 Web-based discussion forums are getting more and more popular. On many
16158 subjects, the web-based forums have become the most important forums,
16159 eclipsing the importance of mailing lists and news groups. The reason
16160 is easy to understand---they are friendly to new users; you just point
16161 and click, and there's the discussion. With mailing lists, you have to
16162 go through a cumbersome subscription procedure, and most people don't
16163 even know what a news group is.
16165 The problem with this scenario is that web browsers are not very good at
16166 being newsreaders. They do not keep track of what articles you've read;
16167 they do not allow you to score on subjects you're interested in; they do
16168 not allow off-line browsing; they require you to click around and drive
16169 you mad in the end.
16171 So---if web browsers suck at reading discussion forums, why not use Gnus
16174 Gnus has been getting a bit of a collection of back ends for providing
16175 interfaces to these sources.
16179 * Web Searches:: Creating groups from articles that match a string.
16180 * Slashdot:: Reading the Slashdot comments.
16181 * Ultimate:: The Ultimate Bulletin Board systems.
16182 * Web Archive:: Reading mailing list archived on web.
16183 * RSS:: Reading RDF site summary.
16184 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
16187 All the web sources require Emacs/W3 and the url library or those
16188 alternatives to work.
16190 The main caveat with all these web sources is that they probably won't
16191 work for a very long time. Gleaning information from the @acronym{HTML} data
16192 is guesswork at best, and when the layout is altered, the Gnus back end
16193 will fail. If you have reasonably new versions of these back ends,
16194 though, you should be ok.
16196 One thing all these Web methods have in common is that the Web sources
16197 are often down, unavailable or just plain too slow to be fun. In those
16198 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
16199 Unplugged}) handle downloading articles, and then you can read them at
16200 leisure from your local disk. No more World Wide Wait for you.
16202 @node Archiving Mail
16203 @subsection Archiving Mail
16204 @cindex archiving mail
16205 @cindex backup of mail
16207 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
16208 @code{nnmaildir}, now actually store the article marks with each group.
16209 For these servers, archiving and restoring a group while preserving
16210 marks is fairly simple.
16212 (Preserving the group level and group parameters as well still
16213 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
16216 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
16217 server, take a recursive copy of the server directory. There is no need
16218 to shut down Gnus, so archiving may be invoked by @code{cron} or
16219 similar. You restore the data by restoring the directory tree, and
16220 adding a server definition pointing to that directory in Gnus. The
16221 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
16222 might interfere with overwriting data, so you may want to shut down Gnus
16223 before you restore the data.
16225 It is also possible to archive individual @code{nnml},
16226 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
16227 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
16228 directory. For @code{nnfolder} you need to copy both the base folder
16229 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
16230 this example). Restoring the group is done with @kbd{G m} from the Group
16231 buffer. The last step makes Gnus notice the new directory.
16232 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
16233 is unnecessary in that case.
16236 @subsection Web Searches
16241 @cindex Usenet searches
16242 @cindex searching the Usenet
16244 It's, like, too neat to search the Usenet for articles that match a
16245 string, but it, like, totally @emph{sucks}, like, totally, to use one of
16246 those, like, Web browsers, and you, like, have to, rilly, like, look at
16247 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
16248 searches without having to use a browser.
16250 The @code{nnweb} back end allows an easy interface to the mighty search
16251 engine. You create an @code{nnweb} group, enter a search pattern, and
16252 then enter the group and read the articles like you would any normal
16253 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
16254 Groups}) will do this in an easy-to-use fashion.
16256 @code{nnweb} groups don't really lend themselves to being solid
16257 groups---they have a very fleeting idea of article numbers. In fact,
16258 each time you enter an @code{nnweb} group (not even changing the search
16259 pattern), you are likely to get the articles ordered in a different
16260 manner. Not even using duplicate suppression (@pxref{Duplicate
16261 Suppression}) will help, since @code{nnweb} doesn't even know the
16262 @code{Message-ID} of the articles before reading them using some search
16263 engines (Google, for instance). The only possible way to keep track
16264 of which articles you've read is by scoring on the @code{Date}
16265 header---mark all articles posted before the last date you read the
16268 If the search engine changes its output substantially, @code{nnweb}
16269 won't be able to parse it and will fail. One could hardly fault the Web
16270 providers if they were to do this---their @emph{raison d'@^etre} is to
16271 make money off of advertisements, not to provide services to the
16272 community. Since @code{nnweb} washes the ads off all the articles, one
16273 might think that the providers might be somewhat miffed. We'll see.
16275 You must have the @code{url} and @code{W3} package or those alternatives
16276 (try @code{customize-group} on the @samp{mm-url} variable group)
16277 installed to be able to use @code{nnweb}.
16279 Virtual server variables:
16284 What search engine type is being used. The currently supported types
16285 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
16286 @code{dejanews} is an alias to @code{google}.
16289 @vindex nnweb-search
16290 The search string to feed to the search engine.
16292 @item nnweb-max-hits
16293 @vindex nnweb-max-hits
16294 Advisory maximum number of hits per search to display. The default is
16297 @item nnweb-type-definition
16298 @vindex nnweb-type-definition
16299 Type-to-definition alist. This alist says what @code{nnweb} should do
16300 with the various search engine types. The following elements must be
16305 Function to decode the article and provide something that Gnus
16309 Function to create an article number to message header and URL alist.
16312 Function to send the search string to the search engine.
16315 The address the aforementioned function should send the search string
16319 Format string URL to fetch an article by @code{Message-ID}.
16326 @subsection Slashdot
16330 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
16331 lively discussion following the news articles. @code{nnslashdot} will
16332 let you read this forum in a convenient manner.
16334 The easiest way to read this source is to put something like the
16335 following in your @file{~/.gnus.el} file:
16338 (setq gnus-secondary-select-methods
16339 '((nnslashdot "")))
16342 This will make Gnus query the @code{nnslashdot} back end for new comments
16343 and groups. The @kbd{F} command will subscribe each new news article as
16344 a new Gnus group, and you can read the comments by entering these
16345 groups. (Note that the default subscription method is to subscribe new
16346 groups as zombies. Other methods are available (@pxref{Subscription
16349 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
16350 command is the most handy tool (@pxref{Foreign Groups}).
16352 When following up to @code{nnslashdot} comments (or posting new
16353 comments), some light @acronym{HTML}izations will be performed. In
16354 particular, text quoted with @samp{> } will be quoted with
16355 @samp{blockquote} instead, and signatures will have @samp{br} added to
16356 the end of each line. Other than that, you can just write @acronym{HTML}
16357 directly into the message buffer. Note that Slashdot filters out some
16358 @acronym{HTML} forms.
16360 The following variables can be altered to change its behavior:
16363 @item nnslashdot-threaded
16364 Whether @code{nnslashdot} should display threaded groups or not. The
16365 default is @code{t}. To be able to display threads, @code{nnslashdot}
16366 has to retrieve absolutely all comments in a group upon entry. If a
16367 threaded display is not required, @code{nnslashdot} will only retrieve
16368 the comments that are actually wanted by the user. Threading is nicer,
16369 but much, much slower than unthreaded.
16371 @item nnslashdot-login-name
16372 @vindex nnslashdot-login-name
16373 The login name to use when posting.
16375 @item nnslashdot-password
16376 @vindex nnslashdot-password
16377 The password to use when posting.
16379 @item nnslashdot-directory
16380 @vindex nnslashdot-directory
16381 Where @code{nnslashdot} will store its files. The default is
16382 @file{~/News/slashdot/}.
16384 @item nnslashdot-active-url
16385 @vindex nnslashdot-active-url
16386 The @acronym{URL} format string that will be used to fetch the
16387 information on news articles and comments. The default is@*
16388 @samp{http://slashdot.org/search.pl?section=&min=%d}.
16390 @item nnslashdot-comments-url
16391 @vindex nnslashdot-comments-url
16392 The @acronym{URL} format string that will be used to fetch comments.
16394 @item nnslashdot-article-url
16395 @vindex nnslashdot-article-url
16396 The @acronym{URL} format string that will be used to fetch the news
16397 article. The default is
16398 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
16400 @item nnslashdot-threshold
16401 @vindex nnslashdot-threshold
16402 The score threshold. The default is -1.
16404 @item nnslashdot-group-number
16405 @vindex nnslashdot-group-number
16406 The number of old groups, in addition to the ten latest, to keep
16407 updated. The default is 0.
16414 @subsection Ultimate
16416 @cindex Ultimate Bulletin Board
16418 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
16419 probably the most popular Web bulletin board system used. It has a
16420 quite regular and nice interface, and it's possible to get the
16421 information Gnus needs to keep groups updated.
16423 The easiest way to get started with @code{nnultimate} is to say
16424 something like the following in the group buffer: @kbd{B nnultimate RET
16425 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
16426 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
16427 you're interested in; there's quite a list of them on the Ultimate web
16428 site.) Then subscribe to the groups you're interested in from the
16429 server buffer, and read them from the group buffer.
16431 The following @code{nnultimate} variables can be altered:
16434 @item nnultimate-directory
16435 @vindex nnultimate-directory
16436 The directory where @code{nnultimate} stores its files. The default is@*
16437 @file{~/News/ultimate/}.
16442 @subsection Web Archive
16444 @cindex Web Archive
16446 Some mailing lists only have archives on Web servers, such as
16447 @uref{http://www.egroups.com/} and
16448 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
16449 interface, and it's possible to get the information Gnus needs to keep
16452 @findex gnus-group-make-warchive-group
16453 The easiest way to get started with @code{nnwarchive} is to say
16454 something like the following in the group buffer: @kbd{M-x
16455 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
16456 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
16457 @var{an_egroup} with the mailing list you subscribed, the
16458 @var{your@@email.address} with your email address.), or to browse the
16459 back end by @kbd{B nnwarchive RET mail-archive RET}.
16461 The following @code{nnwarchive} variables can be altered:
16464 @item nnwarchive-directory
16465 @vindex nnwarchive-directory
16466 The directory where @code{nnwarchive} stores its files. The default is@*
16467 @file{~/News/warchive/}.
16469 @item nnwarchive-login
16470 @vindex nnwarchive-login
16471 The account name on the web server.
16473 @item nnwarchive-passwd
16474 @vindex nnwarchive-passwd
16475 The password for your account on the web server.
16483 Some web sites have an RDF Site Summary (@acronym{RSS}).
16484 @acronym{RSS} is a format for summarizing headlines from news related
16485 sites (such as BBC or CNN). But basically anything list-like can be
16486 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
16487 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
16489 @acronym{RSS} has a quite regular and nice interface, and it's
16490 possible to get the information Gnus needs to keep groups updated.
16492 Note: you had better use Emacs which supports the @code{utf-8} coding
16493 system because @acronym{RSS} uses UTF-8 for encoding non-@acronym{ASCII}
16494 text by default. It is also used by default for non-@acronym{ASCII}
16497 @kindex G R (Group)
16498 Use @kbd{G R} from the group buffer to subscribe to a feed---you will be
16499 prompted for the location, the title and the description of the feed.
16500 The title, which allows any characters, will be used for the group name
16501 and the name of the group data file. The description can be omitted.
16503 An easy way to get started with @code{nnrss} is to say something like
16504 the following in the group buffer: @kbd{B nnrss RET RET y}, then
16505 subscribe to groups.
16507 The @code{nnrss} back end saves the group data file in
16508 @code{nnrss-directory} (see below) for each @code{nnrss} group. File
16509 names containing non-@acronym{ASCII} characters will be encoded by the
16510 coding system specified with the @code{nnmail-pathname-coding-system}
16511 variable. If it is @code{nil}, in Emacs the coding system defaults to
16512 the value of @code{default-file-name-coding-system}. If you are using
16513 XEmacs and want to use non-@acronym{ASCII} group names, you should set
16514 the value for the @code{nnmail-pathname-coding-system} variable properly.
16516 The @code{nnrss} back end generates @samp{multipart/alternative}
16517 @acronym{MIME} articles in which each contains a @samp{text/plain} part
16518 and a @samp{text/html} part.
16521 You can also use the following commands to import and export your
16522 subscriptions from a file in @acronym{OPML} format (Outline Processor
16525 @defun nnrss-opml-import file
16526 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
16530 @defun nnrss-opml-export
16531 Write your current @acronym{RSS} subscriptions to a buffer in
16532 @acronym{OPML} format.
16535 The following @code{nnrss} variables can be altered:
16538 @item nnrss-directory
16539 @vindex nnrss-directory
16540 The directory where @code{nnrss} stores its files. The default is
16541 @file{~/News/rss/}.
16543 @item nnrss-file-coding-system
16544 @vindex nnrss-file-coding-system
16545 The coding system used when reading and writing the @code{nnrss} groups
16546 data files. The default is the value of
16547 @code{mm-universal-coding-system} (which defaults to @code{emacs-mule}
16548 in Emacs or @code{escape-quoted} in XEmacs).
16550 @item nnrss-use-local
16551 @vindex nnrss-use-local
16552 @findex nnrss-generate-download-script
16553 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
16554 the feeds from local files in @code{nnrss-directory}. You can use
16555 the command @code{nnrss-generate-download-script} to generate a
16556 download script using @command{wget}.
16558 @item nnrss-wash-html-in-text-plain-parts
16559 Non-@code{nil} means that @code{nnrss} renders text in @samp{text/plain}
16560 parts as @acronym{HTML}. The function specified by the
16561 @code{mm-text-html-renderer} variable (@pxref{Display Customization,
16562 ,Display Customization, emacs-mime, The Emacs MIME Manual}) will be used
16563 to render text. If it is @code{nil}, which is the default, text will
16564 simply be folded. Leave it @code{nil} if you prefer to see
16565 @samp{text/html} parts.
16568 The following code may be helpful, if you want to show the description in
16569 the summary buffer.
16572 (add-to-list 'nnmail-extra-headers nnrss-description-field)
16573 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
16575 (defun gnus-user-format-function-X (header)
16577 (assq nnrss-description-field (mail-header-extra header))))
16578 (if descr (concat "\n\t" (cdr descr)) "")))
16581 The following code may be useful to open an nnrss url directly from the
16585 (require 'browse-url)
16587 (defun browse-nnrss-url( arg )
16589 (let ((url (assq nnrss-url-field
16592 (assq (gnus-summary-article-number)
16593 gnus-newsgroup-data))))))
16596 (browse-url (cdr url))
16597 (gnus-summary-mark-as-read-forward 1))
16598 (gnus-summary-scroll-up arg))))
16600 (eval-after-load "gnus"
16601 #'(define-key gnus-summary-mode-map
16602 (kbd "<RET>") 'browse-nnrss-url))
16603 (add-to-list 'nnmail-extra-headers nnrss-url-field)
16606 Even if you have added @code{"text/html"} to the
16607 @code{mm-discouraged-alternatives} variable (@pxref{Display
16608 Customization, ,Display Customization, emacs-mime, The Emacs MIME
16609 Manual}) since you don't want to see @acronym{HTML} parts, it might be
16610 more useful especially in @code{nnrss} groups to display
16611 @samp{text/html} parts. Here's an example of setting
16612 @code{mm-discouraged-alternatives} as a group parameter (@pxref{Group
16613 Parameters}) in order to display @samp{text/html} parts only in
16614 @code{nnrss} groups:
16617 ;; @r{Set the default value of @code{mm-discouraged-alternatives}.}
16618 (eval-after-load "gnus-sum"
16620 'gnus-newsgroup-variables
16621 '(mm-discouraged-alternatives
16622 . '("text/html" "image/.*"))))
16624 ;; @r{Display @samp{text/html} parts in @code{nnrss} groups.}
16627 '("\\`nnrss:" (mm-discouraged-alternatives nil)))
16631 @node Customizing W3
16632 @subsection Customizing W3
16638 Gnus uses the url library to fetch web pages and Emacs/W3 (or those
16639 alternatives) to display web pages. Emacs/W3 is documented in its own
16640 manual, but there are some things that may be more relevant for Gnus
16643 For instance, a common question is how to make Emacs/W3 follow links
16644 using the @code{browse-url} functions (which will call some external web
16645 browser like Netscape). Here's one way:
16648 (eval-after-load "w3"
16650 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
16651 (defun w3-fetch (&optional url target)
16652 (interactive (list (w3-read-url-with-default)))
16653 (if (eq major-mode 'gnus-article-mode)
16655 (w3-fetch-orig url target)))))
16658 Put that in your @file{.emacs} file, and hitting links in W3-rendered
16659 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
16666 @cindex @acronym{IMAP}
16668 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
16669 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
16670 server is much similar to connecting to a news server, you just
16671 specify the network address of the server.
16673 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
16674 everything that @acronym{POP} can, it can hence be viewed as a
16675 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
16676 similar to @acronym{NNTP} being a news storage protocol---however,
16677 @acronym{IMAP} offers more features than @acronym{NNTP} because news
16678 is more or less read-only whereas mail is read-write.
16680 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
16681 entry in @code{mail-sources}. With this, Gnus will fetch mails from
16682 the @acronym{IMAP} server and store them on the local disk. This is
16683 not the usage described in this section---@xref{Mail Sources}.
16685 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
16686 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
16687 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
16688 usage explained in this section.
16690 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
16691 servers might look something like the following. (Note that for
16692 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
16696 (setq gnus-secondary-select-methods
16697 '((nnimap "simpleserver") ; @r{no special configuration}
16698 ; @r{perhaps a ssh port forwarded server:}
16700 (nnimap-address "localhost")
16701 (nnimap-server-port 1430))
16702 ; @r{a UW server running on localhost}
16704 (nnimap-server-port 143)
16705 (nnimap-address "localhost")
16706 (nnimap-list-pattern ("INBOX" "mail/*")))
16707 ; @r{anonymous public cyrus server:}
16708 (nnimap "cyrus.andrew.cmu.edu"
16709 (nnimap-authenticator anonymous)
16710 (nnimap-list-pattern "archive.*")
16711 (nnimap-stream network))
16712 ; @r{a ssl server on a non-standard port:}
16714 (nnimap-address "vic20.somewhere.com")
16715 (nnimap-server-port 9930)
16716 (nnimap-stream ssl))))
16719 After defining the new server, you can subscribe to groups on the
16720 server using normal Gnus commands such as @kbd{U} in the Group Buffer
16721 (@pxref{Subscription Commands}) or via the Server Buffer
16722 (@pxref{Server Buffer}).
16724 The following variables can be used to create a virtual @code{nnimap}
16729 @item nnimap-address
16730 @vindex nnimap-address
16732 The address of the remote @acronym{IMAP} server. Defaults to the virtual
16733 server name if not specified.
16735 @item nnimap-server-port
16736 @vindex nnimap-server-port
16737 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
16739 Note that this should be an integer, example server specification:
16742 (nnimap "mail.server.com"
16743 (nnimap-server-port 4711))
16746 @item nnimap-list-pattern
16747 @vindex nnimap-list-pattern
16748 String or list of strings of mailboxes to limit available groups to.
16749 This is used when the server has very many mailboxes and you're only
16750 interested in a few---some servers export your home directory via
16751 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
16752 @file{~/Mail/*} then.
16754 The string can also be a cons of REFERENCE and the string as above, what
16755 REFERENCE is used for is server specific, but on the University of
16756 Washington server it's a directory that will be concatenated with the
16759 Example server specification:
16762 (nnimap "mail.server.com"
16763 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
16764 ("~friend/Mail/" . "list/*"))))
16767 @item nnimap-stream
16768 @vindex nnimap-stream
16769 The type of stream used to connect to your server. By default, nnimap
16770 will detect and automatically use all of the below, with the exception
16771 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
16772 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
16773 be automatically detected, but it's not widely deployed yet.)
16775 Example server specification:
16778 (nnimap "mail.server.com"
16779 (nnimap-stream ssl))
16782 Please note that the value of @code{nnimap-stream} is a symbol!
16786 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
16787 @samp{gsasl} or @samp{imtest} program.
16789 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
16791 @dfn{starttls:} Connect via the STARTTLS extension (similar to
16792 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
16795 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
16796 @samp{gnutls-cli}).
16798 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
16799 @samp{openssl}) or SSLeay (@samp{s_client}).
16801 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
16803 @dfn{network:} Plain, TCP/IP network connection.
16806 @vindex imap-kerberos4-program
16807 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
16808 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
16809 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
16810 to make @code{imap.el} use a pty instead of a pipe when communicating
16811 with @samp{imtest}. You will then suffer from a line length
16812 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
16813 indefinitely if you have many articles in a mailbox. The variable
16814 @code{imap-kerberos4-program} contain parameters to pass to the imtest
16817 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
16818 needed. It is available from
16819 @uref{http://www.gnu.org/software/gnutls/}.
16821 @vindex imap-gssapi-program
16822 This parameter specifies a list of command lines that invoke a GSSAPI
16823 authenticated @acronym{IMAP} stream in a subshell. They are tried
16824 sequentially until a connection is made, or the list has been
16825 exhausted. By default, @samp{gsasl} from GNU SASL, available from
16826 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
16827 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
16830 @vindex imap-ssl-program
16831 For @acronym{SSL} connections, the OpenSSL program is available from
16832 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
16833 and nnimap support it too---although the most recent versions of
16834 SSLeay, 0.9.x, are known to have serious bugs making it
16835 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
16836 work. The variable @code{imap-ssl-program} contain parameters to pass
16839 @vindex imap-shell-program
16840 @vindex imap-shell-host
16841 For @acronym{IMAP} connections using the @code{shell} stream, the variable
16842 @code{imap-shell-program} specify what program to call.
16844 @item nnimap-authenticator
16845 @vindex nnimap-authenticator
16847 The authenticator used to connect to the server. By default, nnimap
16848 will use the most secure authenticator your server is capable of.
16850 Example server specification:
16853 (nnimap "mail.server.com"
16854 (nnimap-authenticator anonymous))
16857 Please note that the value of @code{nnimap-authenticator} is a symbol!
16861 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
16862 external program @code{gsasl} or @code{imtest}.
16864 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
16867 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
16868 external library @code{digest-md5.el}.
16870 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
16872 @dfn{login:} Plain-text username/password via LOGIN.
16874 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
16877 @item nnimap-expunge-on-close
16879 @vindex nnimap-expunge-on-close
16880 Unlike Parmenides the @acronym{IMAP} designers have decided things that
16881 don't exist actually do exist. More specifically, @acronym{IMAP} has
16882 this concept of marking articles @code{Deleted} which doesn't actually
16883 delete them, and this (marking them @code{Deleted}, that is) is what
16884 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
16887 Since the articles aren't really removed when we mark them with the
16888 @code{Deleted} flag we'll need a way to actually delete them. Feel like
16889 running in circles yet?
16891 Traditionally, nnimap has removed all articles marked as @code{Deleted}
16892 when closing a mailbox but this is now configurable by this server
16895 The possible options are:
16900 The default behavior, delete all articles marked as ``Deleted'' when
16903 Never actually delete articles. Currently there is no way of showing
16904 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
16905 may allow you to do this. If you ever want to run the EXPUNGE command
16906 manually, @xref{Expunging mailboxes}.
16908 When closing mailboxes, nnimap will ask if you wish to expunge deleted
16913 @item nnimap-importantize-dormant
16914 @vindex nnimap-importantize-dormant
16916 If non-@code{nil} (the default), marks dormant articles as ticked (as
16917 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
16918 naturally still (only) be marked as dormant. This is to make dormant
16919 articles stand out, just like ticked articles, in other @acronym{IMAP}
16920 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
16923 Probably the only reason for frobbing this would be if you're trying
16924 enable per-user persistent dormant flags, using something like:
16927 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
16928 (format "gnus-dormant-%s" (user-login-name)))
16929 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
16930 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
16933 In this case, you would not want the per-user dormant flag showing up
16934 as ticked for other users.
16936 @item nnimap-expunge-search-string
16938 @vindex nnimap-expunge-search-string
16939 @cindex expiring @acronym{IMAP} mail
16941 This variable contain the @acronym{IMAP} search command sent to server when
16942 searching for articles eligible for expiring. The default is
16943 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
16944 UID set and the second @code{%s} is replaced by a date.
16946 Probably the only useful value to change this to is
16947 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
16948 messages instead of the internal article date. See section 6.4.4 of
16949 RFC 2060 for more information on valid strings.
16951 However, if @code{nnimap-search-uids-not-since-is-evil}
16952 is true, this variable has no effect since the search logic
16953 is reversed, as described below.
16955 @item nnimap-authinfo-file
16956 @vindex nnimap-authinfo-file
16958 A file containing credentials used to log in on servers. The format is
16959 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
16960 variable @code{nntp-authinfo-file} for exact syntax; also see
16961 @ref{NNTP}. An example of an .authinfo line for an IMAP server, is:
16964 machine students.uio.no login larsi password geheimnis port imap
16967 Note that it should be @code{port imap}, or @code{port 143}, if you
16968 use a @code{nnimap-stream} of @code{tls} or @code{ssl}, even if the
16969 actual port number used is port 993 for secured IMAP. For
16970 convenience, Gnus will accept @code{port imaps} as a synonym of
16973 @item nnimap-need-unselect-to-notice-new-mail
16974 @vindex nnimap-need-unselect-to-notice-new-mail
16976 Unselect mailboxes before looking for new mail in them. Some servers
16977 seem to need this under some circumstances; it was reported that
16980 @item nnimap-nov-is-evil
16981 @vindex nnimap-nov-is-evil
16982 @cindex Courier @acronym{IMAP} server
16983 @cindex @acronym{NOV}
16985 Never generate or use a local @acronym{NOV} database. Defaults to the
16986 value of @code{gnus-agent}.
16988 Using a @acronym{NOV} database usually makes header fetching much
16989 faster, but it uses the @code{UID SEARCH UID} command, which is very
16990 slow on some servers (notably some versions of Courier). Since the Gnus
16991 Agent caches the information in the @acronym{NOV} database without using
16992 the slow command, this variable defaults to true if the Agent is in use,
16993 and false otherwise.
16995 @item nnimap-search-uids-not-since-is-evil
16996 @vindex nnimap-search-uids-not-since-is-evil
16997 @cindex Courier @acronym{IMAP} server
16998 @cindex expiring @acronym{IMAP} mail
17000 Avoid the @code{UID SEARCH UID @var{message numbers} NOT SINCE
17001 @var{date}} command, which is slow on some @acronym{IMAP} servers
17002 (notably, some versions of Courier). Instead, use @code{UID SEARCH SINCE
17003 @var{date}} and prune the list of expirable articles within Gnus.
17005 When Gnus expires your mail (@pxref{Expiring Mail}), it starts with a
17006 list of expirable articles and asks the IMAP server questions like ``Of
17007 these articles, which ones are older than a week?'' While this seems
17008 like a perfectly reasonable question, some IMAP servers take a long time
17009 to answer it, since they seemingly go looking into every old article to
17010 see if it is one of the expirable ones. Curiously, the question ``Of
17011 @emph{all} articles, which ones are newer than a week?'' seems to be
17012 much faster to answer, so setting this variable causes Gnus to ask this
17013 question and figure out the answer to the real question itself.
17015 This problem can really sneak up on you: when you first configure Gnus,
17016 everything works fine, but once you accumulate a couple thousand
17017 messages, you start cursing Gnus for being so slow. On the other hand,
17018 if you get a lot of email within a week, setting this variable will
17019 cause a lot of network traffic between Gnus and the IMAP server.
17024 * Splitting in IMAP:: Splitting mail with nnimap.
17025 * Expiring in IMAP:: Expiring mail with nnimap.
17026 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
17027 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
17028 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
17029 * Debugging IMAP:: What to do when things don't work.
17034 @node Splitting in IMAP
17035 @subsection Splitting in IMAP
17036 @cindex splitting imap mail
17038 Splitting is something Gnus users have loved and used for years, and now
17039 the rest of the world is catching up. Yeah, dream on, not many
17040 @acronym{IMAP} servers have server side splitting and those that have
17041 splitting seem to use some non-standard protocol. This means that
17042 @acronym{IMAP} support for Gnus has to do its own splitting.
17046 (Incidentally, people seem to have been dreaming on, and Sieve has
17047 gaining a market share and is supported by several IMAP servers.
17048 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
17050 Here are the variables of interest:
17054 @item nnimap-split-crosspost
17055 @cindex splitting, crosspost
17057 @vindex nnimap-split-crosspost
17059 If non-@code{nil}, do crossposting if several split methods match the
17060 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
17061 found will be used.
17063 Nnmail equivalent: @code{nnmail-crosspost}.
17065 @item nnimap-split-inbox
17066 @cindex splitting, inbox
17068 @vindex nnimap-split-inbox
17070 A string or a list of strings that gives the name(s) of @acronym{IMAP}
17071 mailboxes to split from. Defaults to @code{nil}, which means that
17072 splitting is disabled!
17075 (setq nnimap-split-inbox
17076 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
17079 No nnmail equivalent.
17081 @item nnimap-split-rule
17082 @cindex splitting, rules
17083 @vindex nnimap-split-rule
17085 New mail found in @code{nnimap-split-inbox} will be split according to
17088 This variable contains a list of lists, where the first element in the
17089 sublist gives the name of the @acronym{IMAP} mailbox to move articles
17090 matching the regexp in the second element in the sublist. Got that?
17091 Neither did I, we need examples.
17094 (setq nnimap-split-rule
17096 "^Sender: owner-nnimap@@vic20.globalcom.se")
17097 ("INBOX.junk" "^Subject:.*MAKE MONEY")
17098 ("INBOX.private" "")))
17101 This will put all articles from the nnimap mailing list into mailbox
17102 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
17103 into INBOX.junk and everything else in INBOX.private.
17105 The first string may contain @samp{\\1} forms, like the ones used by
17106 replace-match to insert sub-expressions from the matched text. For
17110 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
17113 The first element can also be the symbol @code{junk} to indicate that
17114 matching messages should simply be deleted. Use with care.
17116 The second element can also be a function. In that case, it will be
17117 called with the first element of the rule as the argument, in a buffer
17118 containing the headers of the article. It should return a
17119 non-@code{nil} value if it thinks that the mail belongs in that group.
17121 Nnmail users might recollect that the last regexp had to be empty to
17122 match all articles (like in the example above). This is not required in
17123 nnimap. Articles not matching any of the regexps will not be moved out
17124 of your inbox. (This might affect performance if you keep lots of
17125 unread articles in your inbox, since the splitting code would go over
17126 them every time you fetch new mail.)
17128 These rules are processed from the beginning of the alist toward the
17129 end. The first rule to make a match will ``win'', unless you have
17130 crossposting enabled. In that case, all matching rules will ``win''.
17132 This variable can also have a function as its value, the function will
17133 be called with the headers narrowed and should return a group where it
17134 thinks the article should be split to. See @code{nnimap-split-fancy}.
17136 The splitting code tries to create mailboxes if it needs to.
17138 To allow for different split rules on different virtual servers, and
17139 even different split rules in different inboxes on the same server,
17140 the syntax of this variable have been extended along the lines of:
17143 (setq nnimap-split-rule
17144 '(("my1server" (".*" (("ding" "ding@@gnus.org")
17145 ("junk" "From:.*Simon"))))
17146 ("my2server" ("INBOX" nnimap-split-fancy))
17147 ("my[34]server" (".*" (("private" "To:.*Simon")
17148 ("junk" my-junk-func))))))
17151 The virtual server name is in fact a regexp, so that the same rules
17152 may apply to several servers. In the example, the servers
17153 @code{my3server} and @code{my4server} both use the same rules.
17154 Similarly, the inbox string is also a regexp. The actual splitting
17155 rules are as before, either a function, or a list with group/regexp or
17156 group/function elements.
17158 Nnmail equivalent: @code{nnmail-split-methods}.
17160 @item nnimap-split-predicate
17162 @vindex nnimap-split-predicate
17164 Mail matching this predicate in @code{nnimap-split-inbox} will be
17165 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
17167 This might be useful if you use another @acronym{IMAP} client to read mail in
17168 your inbox but would like Gnus to split all articles in the inbox
17169 regardless of readedness. Then you might change this to
17172 @item nnimap-split-fancy
17173 @cindex splitting, fancy
17174 @findex nnimap-split-fancy
17175 @vindex nnimap-split-fancy
17177 It's possible to set @code{nnimap-split-rule} to
17178 @code{nnmail-split-fancy} if you want to use fancy
17179 splitting. @xref{Fancy Mail Splitting}.
17181 However, to be able to have different fancy split rules for nnmail and
17182 nnimap back ends you can set @code{nnimap-split-rule} to
17183 @code{nnimap-split-fancy} and define the nnimap specific fancy split
17184 rule in @code{nnimap-split-fancy}.
17189 (setq nnimap-split-rule 'nnimap-split-fancy
17190 nnimap-split-fancy ...)
17193 Nnmail equivalent: @code{nnmail-split-fancy}.
17195 @item nnimap-split-download-body
17196 @findex nnimap-split-download-body
17197 @vindex nnimap-split-download-body
17199 Set to non-@code{nil} to download entire articles during splitting.
17200 This is generally not required, and will slow things down
17201 considerably. You may need it if you want to use an advanced
17202 splitting function that analyzes the body to split the article.
17206 @node Expiring in IMAP
17207 @subsection Expiring in IMAP
17208 @cindex expiring @acronym{IMAP} mail
17210 Even though @code{nnimap} is not a proper @code{nnmail} derived back
17211 end, it supports most features in regular expiring (@pxref{Expiring
17212 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
17213 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
17214 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
17215 follows below are the variables used by the @code{nnimap} expiry
17218 A note on how the expire mark is stored on the @acronym{IMAP} server is
17219 appropriate here as well. The expire mark is translated into a
17220 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
17221 message. This means that likely only Gnus will understand and treat
17222 the @code{gnus-expire} mark properly, although other clients may allow
17223 you to view client specific flags on the message. It also means that
17224 your server must support permanent storage of client specific flags on
17225 messages. Most do, fortunately.
17227 If expiring @acronym{IMAP} mail seems very slow, try setting the server
17228 variable @code{nnimap-search-uids-not-since-is-evil}.
17232 @item nnmail-expiry-wait
17233 @item nnmail-expiry-wait-function
17235 These variables are fully supported. The expire value can be a
17236 number, the symbol @code{immediate} or @code{never}.
17238 @item nnmail-expiry-target
17240 This variable is supported, and internally implemented by calling the
17241 @code{nnmail} functions that handle this. It contains an optimization
17242 that if the destination is a @acronym{IMAP} group on the same server, the
17243 article is copied instead of appended (that is, uploaded again).
17247 @node Editing IMAP ACLs
17248 @subsection Editing IMAP ACLs
17249 @cindex editing imap acls
17250 @cindex Access Control Lists
17251 @cindex Editing @acronym{IMAP} ACLs
17252 @kindex G l (Group)
17253 @findex gnus-group-nnimap-edit-acl
17255 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
17256 limiting (or enabling) other users access to your mail boxes. Not all
17257 @acronym{IMAP} servers support this, this function will give an error if it
17260 To edit an ACL for a mailbox, type @kbd{G l}
17261 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
17262 editing window with detailed instructions.
17264 Some possible uses:
17268 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
17269 on your mailing list mailboxes enables other users on the same server to
17270 follow the list without subscribing to it.
17272 At least with the Cyrus server, you are required to give the user
17273 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
17274 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
17278 @node Expunging mailboxes
17279 @subsection Expunging mailboxes
17283 @cindex manual expunging
17284 @kindex G x (Group)
17285 @findex gnus-group-nnimap-expunge
17287 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
17288 you may want the option of expunging all deleted articles in a mailbox
17289 manually. This is exactly what @kbd{G x} does.
17291 Currently there is no way of showing deleted articles, you can just
17294 @node A note on namespaces
17295 @subsection A note on namespaces
17296 @cindex IMAP namespace
17299 The @acronym{IMAP} protocol has a concept called namespaces, described
17300 by the following text in the RFC2060:
17303 5.1.2. Mailbox Namespace Naming Convention
17305 By convention, the first hierarchical element of any mailbox name
17306 which begins with "#" identifies the "namespace" of the remainder of
17307 the name. This makes it possible to disambiguate between different
17308 types of mailbox stores, each of which have their own namespaces.
17310 For example, implementations which offer access to USENET
17311 newsgroups MAY use the "#news" namespace to partition the USENET
17312 newsgroup namespace from that of other mailboxes. Thus, the
17313 comp.mail.misc newsgroup would have an mailbox name of
17314 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
17315 to a different object (e.g. a user's private mailbox).
17318 While there is nothing in this text that warrants concern for the
17319 @acronym{IMAP} implementation in Gnus, some servers use namespace
17320 prefixes in a way that does not work with how Gnus uses mailbox names.
17322 Specifically, University of Washington's @acronym{IMAP} server uses
17323 mailbox names like @code{#driver.mbx/read-mail} which are valid only
17324 in the @sc{create} and @sc{append} commands. After the mailbox is
17325 created (or a messages is appended to a mailbox), it must be accessed
17326 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
17327 not make it possible for the user to guarantee that user entered
17328 mailbox names will only be used with the CREATE and APPEND commands,
17329 you should simply not use the namespace prefixed mailbox names in
17332 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
17333 for more information on how to use the prefixes. They are a power
17334 tool and should be used only if you are sure what the effects are.
17336 @node Debugging IMAP
17337 @subsection Debugging IMAP
17338 @cindex IMAP debugging
17339 @cindex protocol dump (IMAP)
17341 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
17342 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
17343 best to fix them right away. If you encounter odd behavior, chances
17344 are that either the server or Gnus is buggy.
17346 If you are familiar with network protocols in general, you will
17347 probably be able to extract some clues from the protocol dump of the
17348 exchanges between Gnus and the server. Even if you are not familiar
17349 with network protocols, when you include the protocol dump in
17350 @acronym{IMAP}-related bug reports you are helping us with data
17351 critical to solving the problem. Therefore, we strongly encourage you
17352 to include the protocol dump when reporting IMAP bugs in Gnus.
17356 Because the protocol dump, when enabled, generates lots of data, it is
17357 disabled by default. You can enable it by setting @code{imap-log} as
17364 This instructs the @code{imap.el} package to log any exchanges with
17365 the server. The log is stored in the buffer @samp{*imap-log*}. Look
17366 for error messages, which sometimes are tagged with the keyword
17367 @code{BAD}---but when submitting a bug, make sure to include all the
17370 @node Other Sources
17371 @section Other Sources
17373 Gnus can do more than just read news or mail. The methods described
17374 below allow Gnus to view directories and files as if they were
17378 * Directory Groups:: You can read a directory as if it was a newsgroup.
17379 * Anything Groups:: Dired? Who needs dired?
17380 * Document Groups:: Single files can be the basis of a group.
17381 * SOUP:: Reading @sc{soup} packets ``offline''.
17382 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
17386 @node Directory Groups
17387 @subsection Directory Groups
17389 @cindex directory groups
17391 If you have a directory that has lots of articles in separate files in
17392 it, you might treat it as a newsgroup. The files have to have numerical
17395 This might be an opportune moment to mention @code{ange-ftp} (and its
17396 successor @code{efs}), that most wonderful of all wonderful Emacs
17397 packages. When I wrote @code{nndir}, I didn't think much about it---a
17398 back end to read directories. Big deal.
17400 @code{ange-ftp} changes that picture dramatically. For instance, if you
17401 enter the @code{ange-ftp} file name
17402 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
17403 @code{ange-ftp} or @code{efs} will actually allow you to read this
17404 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
17406 @code{nndir} will use @acronym{NOV} files if they are present.
17408 @code{nndir} is a ``read-only'' back end---you can't delete or expire
17409 articles with this method. You can use @code{nnmh} or @code{nnml} for
17410 whatever you use @code{nndir} for, so you could switch to any of those
17411 methods if you feel the need to have a non-read-only @code{nndir}.
17414 @node Anything Groups
17415 @subsection Anything Groups
17418 From the @code{nndir} back end (which reads a single spool-like
17419 directory), it's just a hop and a skip to @code{nneething}, which
17420 pretends that any arbitrary directory is a newsgroup. Strange, but
17423 When @code{nneething} is presented with a directory, it will scan this
17424 directory and assign article numbers to each file. When you enter such
17425 a group, @code{nneething} must create ``headers'' that Gnus can use.
17426 After all, Gnus is a newsreader, in case you're forgetting.
17427 @code{nneething} does this in a two-step process. First, it snoops each
17428 file in question. If the file looks like an article (i.e., the first
17429 few lines look like headers), it will use this as the head. If this is
17430 just some arbitrary file without a head (e.g. a C source file),
17431 @code{nneething} will cobble up a header out of thin air. It will use
17432 file ownership, name and date and do whatever it can with these
17435 All this should happen automatically for you, and you will be presented
17436 with something that looks very much like a newsgroup. Totally like a
17437 newsgroup, to be precise. If you select an article, it will be displayed
17438 in the article buffer, just as usual.
17440 If you select a line that represents a directory, Gnus will pop you into
17441 a new summary buffer for this @code{nneething} group. And so on. You can
17442 traverse the entire disk this way, if you feel like, but remember that
17443 Gnus is not dired, really, and does not intend to be, either.
17445 There are two overall modes to this action---ephemeral or solid. When
17446 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
17447 will not store information on what files you have read, and what files
17448 are new, and so on. If you create a solid @code{nneething} group the
17449 normal way with @kbd{G m}, Gnus will store a mapping table between
17450 article numbers and file names, and you can treat this group like any
17451 other groups. When you activate a solid @code{nneething} group, you will
17452 be told how many unread articles it contains, etc., etc.
17457 @item nneething-map-file-directory
17458 @vindex nneething-map-file-directory
17459 All the mapping files for solid @code{nneething} groups will be stored
17460 in this directory, which defaults to @file{~/.nneething/}.
17462 @item nneething-exclude-files
17463 @vindex nneething-exclude-files
17464 All files that match this regexp will be ignored. Nice to use to exclude
17465 auto-save files and the like, which is what it does by default.
17467 @item nneething-include-files
17468 @vindex nneething-include-files
17469 Regexp saying what files to include in the group. If this variable is
17470 non-@code{nil}, only files matching this regexp will be included.
17472 @item nneething-map-file
17473 @vindex nneething-map-file
17474 Name of the map files.
17478 @node Document Groups
17479 @subsection Document Groups
17481 @cindex documentation group
17484 @code{nndoc} is a cute little thing that will let you read a single file
17485 as a newsgroup. Several files types are supported:
17491 The Babyl (Rmail) mail box.
17496 The standard Unix mbox file.
17498 @cindex MMDF mail box
17500 The MMDF mail box format.
17503 Several news articles appended into a file.
17505 @cindex rnews batch files
17507 The rnews batch transport format.
17510 Netscape mail boxes.
17513 @acronym{MIME} multipart messages.
17515 @item standard-digest
17516 The standard (RFC 1153) digest format.
17519 A @acronym{MIME} digest of messages.
17521 @item lanl-gov-announce
17522 Announcement messages from LANL Gov Announce.
17524 @cindex forwarded messages
17525 @item rfc822-forward
17526 A message forwarded according to RFC822.
17529 The Outlook mail box.
17532 The Outlook Express dbx mail box.
17535 A bounce message from the Exim MTA.
17538 A message forwarded according to informal rules.
17541 An RFC934-forwarded message.
17547 A digest of Clarinet brief news items.
17550 Non-standard digest format---matches most things, but does it badly.
17556 You can also use the special ``file type'' @code{guess}, which means
17557 that @code{nndoc} will try to guess what file type it is looking at.
17558 @code{digest} means that @code{nndoc} should guess what digest type the
17561 @code{nndoc} will not try to change the file or insert any extra headers into
17562 it---it will simply, like, let you use the file as the basis for a
17563 group. And that's it.
17565 If you have some old archived articles that you want to insert into your
17566 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
17567 that. Say you have an old @file{RMAIL} file with mail that you now want
17568 to split into your new @code{nnml} groups. You look at that file using
17569 @code{nndoc} (using the @kbd{G f} command in the group buffer
17570 (@pxref{Foreign Groups})), set the process mark on all the articles in
17571 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
17572 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
17573 file is now also stored in lots of @code{nnml} directories, and you can
17574 delete that pesky @file{RMAIL} file. If you have the guts!
17576 Virtual server variables:
17579 @item nndoc-article-type
17580 @vindex nndoc-article-type
17581 This should be one of @code{mbox}, @code{babyl}, @code{digest},
17582 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
17583 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
17584 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
17585 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
17587 @item nndoc-post-type
17588 @vindex nndoc-post-type
17589 This variable says whether Gnus is to consider the group a news group or
17590 a mail group. There are two valid values: @code{mail} (the default)
17595 * Document Server Internals:: How to add your own document types.
17599 @node Document Server Internals
17600 @subsubsection Document Server Internals
17602 Adding new document types to be recognized by @code{nndoc} isn't
17603 difficult. You just have to whip up a definition of what the document
17604 looks like, write a predicate function to recognize that document type,
17605 and then hook into @code{nndoc}.
17607 First, here's an example document type definition:
17611 (article-begin . "^\^A\^A\^A\^A\n")
17612 (body-end . "^\^A\^A\^A\^A\n"))
17615 The definition is simply a unique @dfn{name} followed by a series of
17616 regexp pseudo-variable settings. Below are the possible
17617 variables---don't be daunted by the number of variables; most document
17618 types can be defined with very few settings:
17621 @item first-article
17622 If present, @code{nndoc} will skip past all text until it finds
17623 something that match this regexp. All text before this will be
17626 @item article-begin
17627 This setting has to be present in all document type definitions. It
17628 says what the beginning of each article looks like. To do more
17629 complicated things that cannot be dealt with a simple regexp, you can
17630 use @code{article-begin-function} instead of this.
17632 @item article-begin-function
17633 If present, this should be a function that moves point to the beginning
17634 of each article. This setting overrides @code{article-begin}.
17637 If present, this should be a regexp that matches the head of the
17638 article. To do more complicated things that cannot be dealt with a
17639 simple regexp, you can use @code{head-begin-function} instead of this.
17641 @item head-begin-function
17642 If present, this should be a function that moves point to the head of
17643 the article. This setting overrides @code{head-begin}.
17646 This should match the end of the head of the article. It defaults to
17647 @samp{^$}---the empty line.
17650 This should match the beginning of the body of the article. It defaults
17651 to @samp{^\n}. To do more complicated things that cannot be dealt with
17652 a simple regexp, you can use @code{body-begin-function} instead of this.
17654 @item body-begin-function
17655 If present, this function should move point to the beginning of the body
17656 of the article. This setting overrides @code{body-begin}.
17659 If present, this should match the end of the body of the article. To do
17660 more complicated things that cannot be dealt with a simple regexp, you
17661 can use @code{body-end-function} instead of this.
17663 @item body-end-function
17664 If present, this function should move point to the end of the body of
17665 the article. This setting overrides @code{body-end}.
17668 If present, this should match the beginning of the file. All text
17669 before this regexp will be totally ignored.
17672 If present, this should match the end of the file. All text after this
17673 regexp will be totally ignored.
17677 So, using these variables @code{nndoc} is able to dissect a document
17678 file into a series of articles, each with a head and a body. However, a
17679 few more variables are needed since not all document types are all that
17680 news-like---variables needed to transform the head or the body into
17681 something that's palatable for Gnus:
17684 @item prepare-body-function
17685 If present, this function will be called when requesting an article. It
17686 will be called with point at the start of the body, and is useful if the
17687 document has encoded some parts of its contents.
17689 @item article-transform-function
17690 If present, this function is called when requesting an article. It's
17691 meant to be used for more wide-ranging transformation of both head and
17692 body of the article.
17694 @item generate-head-function
17695 If present, this function is called to generate a head that Gnus can
17696 understand. It is called with the article number as a parameter, and is
17697 expected to generate a nice head for the article in question. It is
17698 called when requesting the headers of all articles.
17700 @item generate-article-function
17701 If present, this function is called to generate an entire article that
17702 Gnus can understand. It is called with the article number as a
17703 parameter when requesting all articles.
17705 @item dissection-function
17706 If present, this function is called to dissect a document by itself,
17707 overriding @code{first-article}, @code{article-begin},
17708 @code{article-begin-function}, @code{head-begin},
17709 @code{head-begin-function}, @code{head-end}, @code{body-begin},
17710 @code{body-begin-function}, @code{body-end}, @code{body-end-function},
17711 @code{file-begin}, and @code{file-end}.
17715 Let's look at the most complicated example I can come up with---standard
17720 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
17721 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
17722 (prepare-body-function . nndoc-unquote-dashes)
17723 (body-end-function . nndoc-digest-body-end)
17724 (head-end . "^ ?$")
17725 (body-begin . "^ ?\n")
17726 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
17727 (subtype digest guess))
17730 We see that all text before a 70-width line of dashes is ignored; all
17731 text after a line that starts with that @samp{^End of} is also ignored;
17732 each article begins with a 30-width line of dashes; the line separating
17733 the head from the body may contain a single space; and that the body is
17734 run through @code{nndoc-unquote-dashes} before being delivered.
17736 To hook your own document definition into @code{nndoc}, use the
17737 @code{nndoc-add-type} function. It takes two parameters---the first
17738 is the definition itself and the second (optional) parameter says
17739 where in the document type definition alist to put this definition.
17740 The alist is traversed sequentially, and
17741 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
17742 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
17743 @code{mmdf} type, and so on. These type predicates should return
17744 @code{nil} if the document is not of the correct type; @code{t} if it
17745 is of the correct type; and a number if the document might be of the
17746 correct type. A high number means high probability; a low number
17747 means low probability with @samp{0} being the lowest valid number.
17755 In the PC world people often talk about ``offline'' newsreaders. These
17756 are thingies that are combined reader/news transport monstrosities.
17757 With built-in modem programs. Yecchh!
17759 Of course, us Unix Weenie types of human beans use things like
17760 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
17761 transport things like Ghod intended. And then we just use normal
17764 However, it can sometimes be convenient to do something that's a bit
17765 easier on the brain if you have a very slow modem, and you're not really
17766 that interested in doing things properly.
17768 A file format called @sc{soup} has been developed for transporting news
17769 and mail from servers to home machines and back again. It can be a bit
17772 First some terminology:
17777 This is the machine that is connected to the outside world and where you
17778 get news and/or mail from.
17781 This is the machine that you want to do the actual reading and responding
17782 on. It is typically not connected to the rest of the world in any way.
17785 Something that contains messages and/or commands. There are two kinds
17789 @item message packets
17790 These are packets made at the server, and typically contain lots of
17791 messages for you to read. These are called @file{SoupoutX.tgz} by
17792 default, where @var{x} is a number.
17794 @item response packets
17795 These are packets made at the home machine, and typically contains
17796 replies that you've written. These are called @file{SoupinX.tgz} by
17797 default, where @var{x} is a number.
17807 You log in on the server and create a @sc{soup} packet. You can either
17808 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
17809 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
17810 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
17813 You transfer the packet home. Rail, boat, car or modem will do fine.
17816 You put the packet in your home directory.
17819 You fire up Gnus on your home machine using the @code{nnsoup} back end as
17820 the native or secondary server.
17823 You read articles and mail and answer and followup to the things you
17824 want (@pxref{SOUP Replies}).
17827 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
17831 You transfer this packet to the server.
17834 You use Gnus to mail this packet out with the @kbd{G s s} command.
17837 You then repeat until you die.
17841 So you basically have a bipartite system---you use @code{nnsoup} for
17842 reading and Gnus for packing/sending these @sc{soup} packets.
17845 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
17846 * SOUP Groups:: A back end for reading @sc{soup} packets.
17847 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
17851 @node SOUP Commands
17852 @subsubsection SOUP Commands
17854 These are commands for creating and manipulating @sc{soup} packets.
17858 @kindex G s b (Group)
17859 @findex gnus-group-brew-soup
17860 Pack all unread articles in the current group
17861 (@code{gnus-group-brew-soup}). This command understands the
17862 process/prefix convention.
17865 @kindex G s w (Group)
17866 @findex gnus-soup-save-areas
17867 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
17870 @kindex G s s (Group)
17871 @findex gnus-soup-send-replies
17872 Send all replies from the replies packet
17873 (@code{gnus-soup-send-replies}).
17876 @kindex G s p (Group)
17877 @findex gnus-soup-pack-packet
17878 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
17881 @kindex G s r (Group)
17882 @findex nnsoup-pack-replies
17883 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
17886 @kindex O s (Summary)
17887 @findex gnus-soup-add-article
17888 This summary-mode command adds the current article to a @sc{soup} packet
17889 (@code{gnus-soup-add-article}). It understands the process/prefix
17890 convention (@pxref{Process/Prefix}).
17895 There are a few variables to customize where Gnus will put all these
17900 @item gnus-soup-directory
17901 @vindex gnus-soup-directory
17902 Directory where Gnus will save intermediate files while composing
17903 @sc{soup} packets. The default is @file{~/SoupBrew/}.
17905 @item gnus-soup-replies-directory
17906 @vindex gnus-soup-replies-directory
17907 This is what Gnus will use as a temporary directory while sending our
17908 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
17910 @item gnus-soup-prefix-file
17911 @vindex gnus-soup-prefix-file
17912 Name of the file where Gnus stores the last used prefix. The default is
17913 @samp{gnus-prefix}.
17915 @item gnus-soup-packer
17916 @vindex gnus-soup-packer
17917 A format string command for packing a @sc{soup} packet. The default is
17918 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
17920 @item gnus-soup-unpacker
17921 @vindex gnus-soup-unpacker
17922 Format string command for unpacking a @sc{soup} packet. The default is
17923 @samp{gunzip -c %s | tar xvf -}.
17925 @item gnus-soup-packet-directory
17926 @vindex gnus-soup-packet-directory
17927 Where Gnus will look for reply packets. The default is @file{~/}.
17929 @item gnus-soup-packet-regexp
17930 @vindex gnus-soup-packet-regexp
17931 Regular expression matching @sc{soup} reply packets in
17932 @code{gnus-soup-packet-directory}.
17938 @subsubsection SOUP Groups
17941 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
17942 read incoming packets, unpack them, and put them in a directory where
17943 you can read them at leisure.
17945 These are the variables you can use to customize its behavior:
17949 @item nnsoup-tmp-directory
17950 @vindex nnsoup-tmp-directory
17951 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
17952 directory. (@file{/tmp/} by default.)
17954 @item nnsoup-directory
17955 @vindex nnsoup-directory
17956 @code{nnsoup} then moves each message and index file to this directory.
17957 The default is @file{~/SOUP/}.
17959 @item nnsoup-replies-directory
17960 @vindex nnsoup-replies-directory
17961 All replies will be stored in this directory before being packed into a
17962 reply packet. The default is @file{~/SOUP/replies/}.
17964 @item nnsoup-replies-format-type
17965 @vindex nnsoup-replies-format-type
17966 The @sc{soup} format of the replies packets. The default is @samp{?n}
17967 (rnews), and I don't think you should touch that variable. I probably
17968 shouldn't even have documented it. Drats! Too late!
17970 @item nnsoup-replies-index-type
17971 @vindex nnsoup-replies-index-type
17972 The index type of the replies packet. The default is @samp{?n}, which
17973 means ``none''. Don't fiddle with this one either!
17975 @item nnsoup-active-file
17976 @vindex nnsoup-active-file
17977 Where @code{nnsoup} stores lots of information. This is not an ``active
17978 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
17979 this file or mess it up in any way, you're dead. The default is
17980 @file{~/SOUP/active}.
17982 @item nnsoup-packer
17983 @vindex nnsoup-packer
17984 Format string command for packing a reply @sc{soup} packet. The default
17985 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
17987 @item nnsoup-unpacker
17988 @vindex nnsoup-unpacker
17989 Format string command for unpacking incoming @sc{soup} packets. The
17990 default is @samp{gunzip -c %s | tar xvf -}.
17992 @item nnsoup-packet-directory
17993 @vindex nnsoup-packet-directory
17994 Where @code{nnsoup} will look for incoming packets. The default is
17997 @item nnsoup-packet-regexp
17998 @vindex nnsoup-packet-regexp
17999 Regular expression matching incoming @sc{soup} packets. The default is
18002 @item nnsoup-always-save
18003 @vindex nnsoup-always-save
18004 If non-@code{nil}, save the replies buffer after each posted message.
18010 @subsubsection SOUP Replies
18012 Just using @code{nnsoup} won't mean that your postings and mailings end
18013 up in @sc{soup} reply packets automagically. You have to work a bit
18014 more for that to happen.
18016 @findex nnsoup-set-variables
18017 The @code{nnsoup-set-variables} command will set the appropriate
18018 variables to ensure that all your followups and replies end up in the
18021 In specific, this is what it does:
18024 (setq message-send-news-function 'nnsoup-request-post)
18025 (setq message-send-mail-function 'nnsoup-request-mail)
18028 And that's it, really. If you only want news to go into the @sc{soup}
18029 system you just use the first line. If you only want mail to be
18030 @sc{soup}ed you use the second.
18033 @node Mail-To-News Gateways
18034 @subsection Mail-To-News Gateways
18035 @cindex mail-to-news gateways
18038 If your local @code{nntp} server doesn't allow posting, for some reason
18039 or other, you can post using one of the numerous mail-to-news gateways.
18040 The @code{nngateway} back end provides the interface.
18042 Note that you can't read anything from this back end---it can only be
18048 @item nngateway-address
18049 @vindex nngateway-address
18050 This is the address of the mail-to-news gateway.
18052 @item nngateway-header-transformation
18053 @vindex nngateway-header-transformation
18054 News headers often have to be transformed in some odd way or other
18055 for the mail-to-news gateway to accept it. This variable says what
18056 transformation should be called, and defaults to
18057 @code{nngateway-simple-header-transformation}. The function is called
18058 narrowed to the headers to be transformed and with one parameter---the
18061 This default function just inserts a new @code{To} header based on the
18062 @code{Newsgroups} header and the gateway address.
18063 For instance, an article with this @code{Newsgroups} header:
18066 Newsgroups: alt.religion.emacs
18069 will get this @code{To} header inserted:
18072 To: alt-religion-emacs@@GATEWAY
18075 The following pre-defined functions exist:
18077 @findex nngateway-simple-header-transformation
18080 @item nngateway-simple-header-transformation
18081 Creates a @code{To} header that looks like
18082 @var{newsgroup}@@@code{nngateway-address}.
18084 @findex nngateway-mail2news-header-transformation
18086 @item nngateway-mail2news-header-transformation
18087 Creates a @code{To} header that looks like
18088 @code{nngateway-address}.
18096 (setq gnus-post-method
18098 "mail2news@@replay.com"
18099 (nngateway-header-transformation
18100 nngateway-mail2news-header-transformation)))
18103 So, to use this, simply say something like:
18106 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
18111 @node Combined Groups
18112 @section Combined Groups
18114 Gnus allows combining a mixture of all the other group types into bigger
18118 * Virtual Groups:: Combining articles from many groups.
18119 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
18123 @node Virtual Groups
18124 @subsection Virtual Groups
18126 @cindex virtual groups
18127 @cindex merging groups
18129 An @dfn{nnvirtual group} is really nothing more than a collection of
18132 For instance, if you are tired of reading many small groups, you can
18133 put them all in one big group, and then grow tired of reading one
18134 big, unwieldy group. The joys of computing!
18136 You specify @code{nnvirtual} as the method. The address should be a
18137 regexp to match component groups.
18139 All marks in the virtual group will stick to the articles in the
18140 component groups. So if you tick an article in a virtual group, the
18141 article will also be ticked in the component group from whence it
18142 came. (And vice versa---marks from the component groups will also be
18143 shown in the virtual group.). To create an empty virtual group, run
18144 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
18145 and edit the method regexp with @kbd{M-e}
18146 (@code{gnus-group-edit-group-method})
18148 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
18149 newsgroups into one, big, happy newsgroup:
18152 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
18155 The component groups can be native or foreign; everything should work
18156 smoothly, but if your computer explodes, it was probably my fault.
18158 Collecting the same group from several servers might actually be a good
18159 idea if users have set the Distribution header to limit distribution.
18160 If you would like to read @samp{soc.motss} both from a server in Japan
18161 and a server in Norway, you could use the following as the group regexp:
18164 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
18167 (Remember, though, that if you're creating the group with @kbd{G m}, you
18168 shouldn't double the backslashes, and you should leave off the quote
18169 characters at the beginning and the end of the string.)
18171 This should work kinda smoothly---all articles from both groups should
18172 end up in this one, and there should be no duplicates. Threading (and
18173 the rest) will still work as usual, but there might be problems with the
18174 sequence of articles. Sorting on date might be an option here
18175 (@pxref{Selecting a Group}).
18177 One limitation, however---all groups included in a virtual
18178 group have to be alive (i.e., subscribed or unsubscribed). Killed or
18179 zombie groups can't be component groups for @code{nnvirtual} groups.
18181 @vindex nnvirtual-always-rescan
18182 If the @code{nnvirtual-always-rescan} variable is non-@code{nil} (which
18183 is the default), @code{nnvirtual} will always scan groups for unread
18184 articles when entering a virtual group. If this variable is @code{nil}
18185 and you read articles in a component group after the virtual group has
18186 been activated, the read articles from the component group will show up
18187 when you enter the virtual group. You'll also see this effect if you
18188 have two virtual groups that have a component group in common. If
18189 that's the case, you should set this variable to @code{t}. Or you can
18190 just tap @code{M-g} on the virtual group every time before you enter
18191 it---it'll have much the same effect.
18193 @code{nnvirtual} can have both mail and news groups as component groups.
18194 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
18195 has to ask the back end of the component group the article comes from
18196 whether it is a news or mail back end. However, when you do a @kbd{^},
18197 there is typically no sure way for the component back end to know this,
18198 and in that case @code{nnvirtual} tells Gnus that the article came from a
18199 not-news back end. (Just to be on the safe side.)
18201 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
18202 line from the article you respond to in these cases.
18204 @code{nnvirtual} groups do not inherit anything but articles and marks
18205 from component groups---group parameters, for instance, are not
18209 @node Kibozed Groups
18210 @subsection Kibozed Groups
18214 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
18215 (parts of) the news feed''. @code{nnkiboze} is a back end that will
18216 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
18217 down to a halt with useless requests! Oh happiness!
18219 @kindex G k (Group)
18220 To create a kibozed group, use the @kbd{G k} command in the group
18223 The address field of the @code{nnkiboze} method is, as with
18224 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
18225 @code{nnkiboze} group. That's where most similarities between
18226 @code{nnkiboze} and @code{nnvirtual} end.
18228 In addition to this regexp detailing component groups, an
18229 @code{nnkiboze} group must have a score file to say what articles are
18230 to be included in the group (@pxref{Scoring}).
18232 @kindex M-x nnkiboze-generate-groups
18233 @findex nnkiboze-generate-groups
18234 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
18235 @code{nnkiboze} groups you want to have. This command will take time.
18236 Lots of time. Oodles and oodles of time. Gnus has to fetch the
18237 headers from all the articles in all the component groups and run them
18238 through the scoring process to determine if there are any articles in
18239 the groups that are to be part of the @code{nnkiboze} groups.
18241 Please limit the number of component groups by using restrictive
18242 regexps. Otherwise your sysadmin may become annoyed with you, and the
18243 @acronym{NNTP} site may throw you off and never let you back in again.
18244 Stranger things have happened.
18246 @code{nnkiboze} component groups do not have to be alive---they can be dead,
18247 and they can be foreign. No restrictions.
18249 @vindex nnkiboze-directory
18250 The generation of an @code{nnkiboze} group means writing two files in
18251 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
18252 One contains the @acronym{NOV} header lines for all the articles in
18253 the group, and the other is an additional @file{.newsrc} file to store
18254 information on what groups have been searched through to find
18255 component articles.
18257 Articles marked as read in the @code{nnkiboze} group will have
18258 their @acronym{NOV} lines removed from the @acronym{NOV} file.
18261 @node Email Based Diary
18262 @section Email Based Diary
18264 @cindex email based diary
18267 This section describes a special mail back end called @code{nndiary},
18268 and its companion library @code{gnus-diary}. It is ``special'' in the
18269 sense that it is not meant to be one of the standard alternatives for
18270 reading mail with Gnus. See @ref{Choosing a Mail Back End} for that.
18271 Instead, it is used to treat @emph{some} of your mails in a special way,
18272 namely, as event reminders.
18274 Here is a typical scenario:
18278 You've got a date with Andy Mc Dowell or Bruce Willis (select according
18279 to your sexual preference) in one month. You don't want to forget it.
18281 So you send a ``reminder'' message (actually, a diary one) to yourself.
18283 You forget all about it and keep on getting and reading new mail, as usual.
18285 From time to time, as you type `g' in the group buffer and as the date
18286 is getting closer, the message will pop up again to remind you of your
18287 appointment, just as if it were new and unread.
18289 Read your ``new'' messages, this one included, and start dreaming again
18290 of the night you're gonna have.
18292 Once the date is over (you actually fell asleep just after dinner), the
18293 message will be automatically deleted if it is marked as expirable.
18296 The Gnus Diary back end has the ability to handle regular appointments
18297 (that wouldn't ever be deleted) as well as punctual ones, operates as a
18298 real mail back end and is configurable in many ways. All of this is
18299 explained in the sections below.
18302 * The NNDiary Back End:: Basic setup and usage.
18303 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
18304 * Sending or Not Sending:: A final note on sending diary messages.
18308 @node The NNDiary Back End
18309 @subsection The NNDiary Back End
18311 @cindex the nndiary back end
18313 @code{nndiary} is a back end very similar to @code{nnml} (@pxref{Mail
18314 Spool}). Actually, it could appear as a mix of @code{nnml} and
18315 @code{nndraft}. If you know @code{nnml}, you're already familiar with
18316 the message storing scheme of @code{nndiary}: one file per message, one
18317 directory per group.
18319 Before anything, there is one requirement to be able to run
18320 @code{nndiary} properly: you @emph{must} use the group timestamp feature
18321 of Gnus. This adds a timestamp to each group's parameters. @ref{Group
18322 Timestamp} to see how it's done.
18325 * Diary Messages:: What makes a message valid for nndiary.
18326 * Running NNDiary:: NNDiary has two modes of operation.
18327 * Customizing NNDiary:: Bells and whistles.
18330 @node Diary Messages
18331 @subsubsection Diary Messages
18332 @cindex nndiary messages
18333 @cindex nndiary mails
18335 @code{nndiary} messages are just normal ones, except for the mandatory
18336 presence of 7 special headers. These headers are of the form
18337 @code{X-Diary-<something>}, @code{<something>} being one of
18338 @code{Minute}, @code{Hour}, @code{Dom}, @code{Month}, @code{Year},
18339 @code{Time-Zone} and @code{Dow}. @code{Dom} means ``Day of Month'', and
18340 @code{dow} means ``Day of Week''. These headers actually behave like
18341 crontab specifications and define the event date(s):
18345 For all headers except the @code{Time-Zone} one, a header value is
18346 either a star (meaning all possible values), or a list of fields
18347 (separated by a comma).
18349 A field is either an integer, or a range.
18351 A range is two integers separated by a dash.
18353 Possible integer values are 0--59 for @code{Minute}, 0--23 for
18354 @code{Hour}, 1--31 for @code{Dom}, 1--12 for @code{Month}, above 1971
18355 for @code{Year} and 0--6 for @code{Dow} (0 meaning Sunday).
18357 As a special case, a star in either @code{Dom} or @code{Dow} doesn't
18358 mean ``all possible values'', but ``use only the other field''. Note
18359 that if both are star'ed, the use of either one gives the same result.
18361 The @code{Time-Zone} header is special in that it can only have one
18362 value (@code{GMT}, for instance). A star doesn't mean ``all possible
18363 values'' (because it makes no sense), but ``the current local time
18364 zone''. Most of the time, you'll be using a star here. However, for a
18365 list of available time zone values, see the variable
18366 @code{nndiary-headers}.
18369 As a concrete example, here are the diary headers to add to your message
18370 for specifying ``Each Monday and each 1st of month, at 12:00, 20:00,
18371 21:00, 22:00, 23:00 and 24:00, from 1999 to 2010'' (I'll let you find
18376 X-Diary-Hour: 12, 20-24
18379 X-Diary-Year: 1999-2010
18381 X-Diary-Time-Zone: *
18384 @node Running NNDiary
18385 @subsubsection Running NNDiary
18386 @cindex running nndiary
18387 @cindex nndiary operation modes
18389 @code{nndiary} has two modes of operation: ``traditional'' (the default)
18390 and ``autonomous''. In traditional mode, @code{nndiary} does not get new
18391 mail by itself. You have to move (@kbd{B m}) or copy (@kbd{B c}) mails
18392 from your primary mail back end to nndiary groups in order to handle them
18393 as diary messages. In autonomous mode, @code{nndiary} retrieves its own
18394 mail and handles it independently from your primary mail back end.
18396 One should note that Gnus is not inherently designed to allow several
18397 ``master'' mail back ends at the same time. However, this does make
18398 sense with @code{nndiary}: you really want to send and receive diary
18399 messages to your diary groups directly. So, @code{nndiary} supports
18400 being sort of a ``second primary mail back end'' (to my knowledge, it is
18401 the only back end offering this feature). However, there is a limitation
18402 (which I hope to fix some day): respooling doesn't work in autonomous
18405 In order to use @code{nndiary} in autonomous mode, you have several
18410 Allow @code{nndiary} to retrieve new mail by itself. Put the following
18411 line in your @file{~/.gnus.el} file:
18414 (setq nndiary-get-new-mail t)
18417 You must arrange for diary messages (those containing @code{X-Diary-*}
18418 headers) to be split in a private folder @emph{before} Gnus treat them.
18419 Again, this is needed because Gnus cannot (yet ?) properly handle
18420 multiple primary mail back ends. Getting those messages from a separate
18421 source will compensate this misfeature to some extent.
18423 As an example, here's my procmailrc entry to store diary files in
18424 @file{~/.nndiary} (the default @code{nndiary} mail source file):
18433 Once this is done, you might want to customize the following two options
18434 that affect the diary mail retrieval and splitting processes:
18436 @defvar nndiary-mail-sources
18437 This is the diary-specific replacement for the standard
18438 @code{mail-sources} variable. It obeys the same syntax, and defaults to
18439 @code{(file :path "~/.nndiary")}.
18442 @defvar nndiary-split-methods
18443 This is the diary-specific replacement for the standard
18444 @code{nnmail-split-methods} variable. It obeys the same syntax.
18447 Finally, you may add a permanent @code{nndiary} virtual server
18448 (something like @code{(nndiary "diary")} should do) to your
18449 @code{gnus-secondary-select-methods}.
18451 Hopefully, almost everything (see the TODO section in
18452 @file{nndiary.el}) will work as expected when you restart Gnus: in
18453 autonomous mode, typing @kbd{g} and @kbd{M-g} in the group buffer, will
18454 also get your new diary mails and split them according to your
18455 diary-specific rules, @kbd{F} will find your new diary groups etc.
18457 @node Customizing NNDiary
18458 @subsubsection Customizing NNDiary
18459 @cindex customizing nndiary
18460 @cindex nndiary customization
18462 Now that @code{nndiary} is up and running, it's time to customize it.
18463 The custom group is called @code{nndiary} (no, really ?!). You should
18464 browse it to figure out which options you'd like to tweak. The following
18465 two variables are probably the only ones you will want to change:
18467 @defvar nndiary-reminders
18468 This is the list of times when you want to be reminded of your
18469 appointements (e.g. 3 weeks before, then 2 days before, then 1 hour
18470 before and that's it). Remember that ``being reminded'' means that the
18471 diary message will pop up as brand new and unread again when you get new
18475 @defvar nndiary-week-starts-on-monday
18476 Rather self-explanatory. Otherwise, Sunday is assumed (this is the
18481 @node The Gnus Diary Library
18482 @subsection The Gnus Diary Library
18484 @cindex the gnus diary library
18486 Using @code{nndiary} manually (I mean, writing the headers by hand and
18487 so on) would be rather boring. Fortunately, there is a library called
18488 @code{gnus-diary} written on top of @code{nndiary}, that does many
18489 useful things for you.
18491 In order to use it, add the following line to your @file{~/.gnus.el} file:
18494 (require 'gnus-diary)
18497 Also, you shouldn't use any @code{gnus-user-format-function-[d|D]}
18498 (@pxref{Summary Buffer Lines}). @code{gnus-diary} provides both of these
18499 (sorry if you used them before).
18503 * Diary Summary Line Format:: A nicer summary buffer line format.
18504 * Diary Articles Sorting:: A nicer way to sort messages.
18505 * Diary Headers Generation:: Not doing it manually.
18506 * Diary Group Parameters:: Not handling them manually.
18509 @node Diary Summary Line Format
18510 @subsubsection Diary Summary Line Format
18511 @cindex diary summary buffer line
18512 @cindex diary summary line format
18514 Displaying diary messages in standard summary line format (usually
18515 something like @samp{From Joe: Subject}) is pretty useless. Most of
18516 the time, you're the one who wrote the message, and you mostly want to
18517 see the event's date.
18519 @code{gnus-diary} provides two supplemental user formats to be used in
18520 summary line formats. @code{D} corresponds to a formatted time string
18521 for the next occurrence of the event (e.g. ``Sat, Sep 22 01, 12:00''),
18522 while @code{d} corresponds to an approximative remaining time until the
18523 next occurrence of the event (e.g. ``in 6 months, 1 week'').
18525 For example, here's how Joe's birthday is displayed in my
18526 @code{nndiary+diary:birthdays} summary buffer (note that the message is
18527 expirable, but will never be deleted, as it specifies a periodic event):
18530 E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week)
18533 In order to get something like the above, you would normally add the
18534 following line to your diary groups'parameters:
18537 (gnus-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n")
18540 However, @code{gnus-diary} does it automatically (@pxref{Diary Group
18541 Parameters}). You can however customize the provided summary line format
18542 with the following user options:
18544 @defvar gnus-diary-summary-line-format
18545 Defines the summary line format used for diary groups (@pxref{Summary
18546 Buffer Lines}). @code{gnus-diary} uses it to automatically update the
18547 diary groups'parameters.
18550 @defvar gnus-diary-time-format
18551 Defines the format to display dates in diary summary buffers. This is
18552 used by the @code{D} user format. See the docstring for details.
18555 @defvar gnus-diary-delay-format-function
18556 Defines the format function to use for displaying delays (remaining
18557 times) in diary summary buffers. This is used by the @code{d} user
18558 format. There are currently built-in functions for English and French;
18559 you can also define your own. See the docstring for details.
18562 @node Diary Articles Sorting
18563 @subsubsection Diary Articles Sorting
18564 @cindex diary articles sorting
18565 @cindex diary summary lines sorting
18566 @findex gnus-summary-sort-by-schedule
18567 @findex gnus-thread-sort-by-schedule
18568 @findex gnus-article-sort-by-schedule
18570 @code{gnus-diary} provides new sorting functions (@pxref{Sorting the
18571 Summary Buffer} ) called @code{gnus-summary-sort-by-schedule},
18572 @code{gnus-thread-sort-by-schedule} and
18573 @code{gnus-article-sort-by-schedule}. These functions let you organize
18574 your diary summary buffers from the closest event to the farthest one.
18576 @code{gnus-diary} automatically installs
18577 @code{gnus-summary-sort-by-schedule} as a menu item in the summary
18578 buffer's ``sort'' menu, and the two others as the primary (hence
18579 default) sorting functions in the group parameters (@pxref{Diary Group
18582 @node Diary Headers Generation
18583 @subsubsection Diary Headers Generation
18584 @cindex diary headers generation
18585 @findex gnus-diary-check-message
18587 @code{gnus-diary} provides a function called
18588 @code{gnus-diary-check-message} to help you handle the @code{X-Diary-*}
18589 headers. This function ensures that the current message contains all the
18590 required diary headers, and prompts you for values or corrections if
18593 This function is hooked into the @code{nndiary} back end, so that
18594 moving or copying an article to a diary group will trigger it
18595 automatically. It is also bound to @kbd{C-c D c} in @code{message-mode}
18596 and @code{article-edit-mode} in order to ease the process of converting
18597 a usual mail to a diary one.
18599 This function takes a prefix argument which will force prompting of
18600 all diary headers, regardless of their presence or validity. That way,
18601 you can very easily reschedule an already valid diary message, for
18604 @node Diary Group Parameters
18605 @subsubsection Diary Group Parameters
18606 @cindex diary group parameters
18608 When you create a new diary group, or visit one, @code{gnus-diary}
18609 automatically checks your group parameters and if needed, sets the
18610 summary line format to the diary-specific value, installs the
18611 diary-specific sorting functions, and also adds the different
18612 @code{X-Diary-*} headers to the group's posting-style. It is then easier
18613 to send a diary message, because if you use @kbd{C-u a} or @kbd{C-u m}
18614 on a diary group to prepare a message, these headers will be inserted
18615 automatically (although not filled with proper values yet).
18617 @node Sending or Not Sending
18618 @subsection Sending or Not Sending
18620 Well, assuming you've read of of the above, here are two final notes on
18621 mail sending with @code{nndiary}:
18625 @code{nndiary} is a @emph{real} mail back end. You really send real diary
18626 messsages for real. This means for instance that you can give
18627 appointements to anybody (provided they use Gnus and @code{nndiary}) by
18628 sending the diary message to them as well.
18630 However, since @code{nndiary} also has a @code{request-post} method, you
18631 can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the
18632 message won't actually be sent; just stored locally in the group. This
18633 comes in very handy for private appointments.
18636 @node Gnus Unplugged
18637 @section Gnus Unplugged
18642 @cindex Gnus unplugged
18644 In olden times (ca. February '88), people used to run their newsreaders
18645 on big machines with permanent connections to the net. News transport
18646 was dealt with by news servers, and all the newsreaders had to do was to
18647 read news. Believe it or not.
18649 Nowadays most people read news and mail at home, and use some sort of
18650 modem to connect to the net. To avoid running up huge phone bills, it
18651 would be nice to have a way to slurp down all the news and mail, hang up
18652 the phone, read for several hours, and then upload any responses you
18653 have to make. And then you repeat the procedure.
18655 Of course, you can use news servers for doing this as well. I've used
18656 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
18657 for some years, but doing that's a bore. Moving the news server
18658 functionality up to the newsreader makes sense if you're the only person
18659 reading news on a machine.
18661 Setting up Gnus as an ``offline'' newsreader is quite simple. In
18662 fact, you don't have to configure anything as the agent is now enabled
18663 by default (@pxref{Agent Variables, gnus-agent}).
18665 Of course, to use it as such, you have to learn a few new commands.
18668 * Agent Basics:: How it all is supposed to work.
18669 * Agent Categories:: How to tell the Gnus Agent what to download.
18670 * Agent Commands:: New commands for all the buffers.
18671 * Agent Visuals:: Ways that the agent may effect your summary buffer.
18672 * Agent as Cache:: The Agent is a big cache too.
18673 * Agent Expiry:: How to make old articles go away.
18674 * Agent Regeneration:: How to recover from lost connections and other accidents.
18675 * Agent and flags:: How the Agent maintains flags.
18676 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
18677 * Outgoing Messages:: What happens when you post/mail something?
18678 * Agent Variables:: Customizing is fun.
18679 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
18680 * Batching Agents:: How to fetch news from a @code{cron} job.
18681 * Agent Caveats:: What you think it'll do and what it does.
18686 @subsection Agent Basics
18688 First, let's get some terminology out of the way.
18690 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
18691 connection to the net (and notified the Agent that this is the case).
18692 When the connection to the net is up again (and Gnus knows this), the
18693 Agent is @dfn{plugged}.
18695 The @dfn{local} machine is the one you're running on, and which isn't
18696 connected to the net continuously.
18698 @dfn{Downloading} means fetching things from the net to your local
18699 machine. @dfn{Uploading} is doing the opposite.
18701 You know that Gnus gives you all the opportunity you'd ever want for
18702 shooting yourself in the foot. Some people call it flexibility. Gnus
18703 is also customizable to a great extent, which means that the user has a
18704 say on how Gnus behaves. Other newsreaders might unconditionally shoot
18705 you in your foot, but with Gnus, you have a choice!
18707 Gnus is never really in plugged or unplugged state. Rather, it applies
18708 that state to each server individually. This means that some servers
18709 can be plugged while others can be unplugged. Additionally, some
18710 servers can be ignored by the Agent altogether (which means that
18711 they're kinda like plugged always).
18713 So when you unplug the Agent and then wonder why is Gnus opening a
18714 connection to the Net, the next step to do is to look whether all
18715 servers are agentized. If there is an unagentized server, you found
18718 Another thing is the @dfn{offline} state. Sometimes, servers aren't
18719 reachable. When Gnus notices this, it asks you whether you want the
18720 server to be switched to offline state. If you say yes, then the
18721 server will behave somewhat as if it was unplugged, except that Gnus
18722 will ask you whether you want to switch it back online again.
18724 Let's take a typical Gnus session using the Agent.
18729 @findex gnus-unplugged
18730 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
18731 Agent in a disconnected state. You can read all the news that you have
18732 already fetched while in this mode.
18735 You then decide to see whether any new news has arrived. You connect
18736 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
18737 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
18738 as usual. To check for new mail in unplugged mode (@pxref{Mail
18739 Source Specifiers}).
18742 You can then read the new news immediately, or you can download the
18743 news onto your local machine. If you want to do the latter, you press
18744 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
18745 all the eligible articles in all the groups. (To let Gnus know which
18746 articles you want to download, @pxref{Agent Categories}).
18749 After fetching the articles, you press @kbd{J j} to make Gnus become
18750 unplugged again, and you shut down the PPP thing (or whatever). And
18751 then you read the news offline.
18754 And then you go to step 2.
18757 Here are some things you should do the first time (or so) that you use
18763 Decide which servers should be covered by the Agent. If you have a mail
18764 back end, it would probably be nonsensical to have it covered by the
18765 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
18766 @kbd{J a} on the server (or servers) that you wish to have covered by the
18767 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
18768 added servers you do not wish to have covered by the Agent. By default,
18769 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
18770 @code{gnus-secondary-select-methods} are agentized.
18773 Decide on download policy. It's fairly simple once you decide whether
18774 you are going to use agent categories, topic parameters, and/or group
18775 parameters to implement your policy. If you're new to gnus, it
18776 is probably best to start with a category, @xref{Agent Categories}.
18778 Both topic parameters (@pxref{Topic Parameters}) and agent categories
18779 (@pxref{Agent Categories}) provide for setting a policy that applies
18780 to multiple groups. Which you use is entirely up to you. Topic
18781 parameters do override categories so, if you mix the two, you'll have
18782 to take that into account. If you have a few groups that deviate from
18783 your policy, you can use group parameters (@pxref{Group Parameters}) to
18787 Uhm@dots{} that's it.
18791 @node Agent Categories
18792 @subsection Agent Categories
18794 One of the main reasons to integrate the news transport layer into the
18795 newsreader is to allow greater control over what articles to download.
18796 There's not much point in downloading huge amounts of articles, just to
18797 find out that you're not interested in reading any of them. It's better
18798 to be somewhat more conservative in choosing what to download, and then
18799 mark the articles for downloading manually if it should turn out that
18800 you're interested in the articles anyway.
18802 One of the more effective methods for controlling what is to be
18803 downloaded is to create a @dfn{category} and then assign some (or all)
18804 groups to this category. Groups that do not belong in any other
18805 category belong to the @code{default} category. Gnus has its own
18806 buffer for creating and managing categories.
18808 If you prefer, you can also use group parameters (@pxref{Group
18809 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
18810 alternative approach to controlling the agent. The only real
18811 difference is that categories are specific to the agent (so there is
18812 less to learn) while group and topic parameters include the kitchen
18815 Since you can set agent parameters in several different places we have
18816 a rule to decide which source to believe. This rule specifies that
18817 the parameter sources are checked in the following order: group
18818 parameters, topic parameters, agent category, and finally customizable
18819 variables. So you can mix all of these sources to produce a wide range
18820 of behavior, just don't blame me if you don't remember where you put
18824 * Category Syntax:: What a category looks like.
18825 * Category Buffer:: A buffer for maintaining categories.
18826 * Category Variables:: Customize'r'Us.
18830 @node Category Syntax
18831 @subsubsection Category Syntax
18833 A category consists of a name, the list of groups belonging to the
18834 category, and a number of optional parameters that override the
18835 customizable variables. The complete list of agent parameters are
18838 @cindex Agent Parameters
18841 The list of groups that are in this category.
18843 @item agent-predicate
18844 A predicate which (generally) gives a rough outline of which articles
18845 are eligible for downloading; and
18848 a score rule which (generally) gives you a finer granularity when
18849 deciding what articles to download. (Note that this @dfn{download
18850 score} is not necessarily related to normal scores.)
18852 @item agent-enable-expiration
18853 a boolean indicating whether the agent should expire old articles in
18854 this group. Most groups should be expired to conserve disk space. In
18855 fact, its probably safe to say that the gnus.* hierarchy contains the
18856 only groups that should not be expired.
18858 @item agent-days-until-old
18859 an integer indicating the number of days that the agent should wait
18860 before deciding that a read article is safe to expire.
18862 @item agent-low-score
18863 an integer that overrides the value of @code{gnus-agent-low-score}.
18865 @item agent-high-score
18866 an integer that overrides the value of @code{gnus-agent-high-score}.
18868 @item agent-short-article
18869 an integer that overrides the value of
18870 @code{gnus-agent-short-article}.
18872 @item agent-long-article
18873 an integer that overrides the value of @code{gnus-agent-long-article}.
18875 @item agent-enable-undownloaded-faces
18876 a symbol indicating whether the summary buffer should display
18877 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
18878 faces. Any symbol other than @code{nil} will enable the use of
18879 undownloaded faces.
18882 The name of a category can not be changed once the category has been
18885 Each category maintains a list of groups that are exclusive members of
18886 that category. The exclusivity rule is automatically enforced, add a
18887 group to a new category and it is automatically removed from its old
18890 A predicate in its simplest form can be a single predicate such as
18891 @code{true} or @code{false}. These two will download every available
18892 article or nothing respectively. In the case of these two special
18893 predicates an additional score rule is superfluous.
18895 Predicates of @code{high} or @code{low} download articles in respect of
18896 their scores in relationship to @code{gnus-agent-high-score} and
18897 @code{gnus-agent-low-score} as described below.
18899 To gain even finer control of what is to be regarded eligible for
18900 download a predicate can consist of a number of predicates with logical
18901 operators sprinkled in between.
18903 Perhaps some examples are in order.
18905 Here's a simple predicate. (It's the default predicate, in fact, used
18906 for all groups that don't belong to any other category.)
18912 Quite simple, eh? This predicate is true if and only if the article is
18913 short (for some value of ``short'').
18915 Here's a more complex predicate:
18924 This means that an article should be downloaded if it has a high score,
18925 or if the score is not low and the article is not long. You get the
18928 The available logical operators are @code{or}, @code{and} and
18929 @code{not}. (If you prefer, you can use the more ``C''-ish operators
18930 @samp{|}, @code{&} and @code{!} instead.)
18932 The following predicates are pre-defined, but if none of these fit what
18933 you want to do, you can write your own.
18935 When evaluating each of these predicates, the named constant will be
18936 bound to the value determined by calling
18937 @code{gnus-agent-find-parameter} on the appropriate parameter. For
18938 example, gnus-agent-short-article will be bound to
18939 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
18940 means that you can specify a predicate in your category then tune that
18941 predicate to individual groups.
18945 True iff the article is shorter than @code{gnus-agent-short-article}
18946 lines; default 100.
18949 True iff the article is longer than @code{gnus-agent-long-article}
18950 lines; default 200.
18953 True iff the article has a download score less than
18954 @code{gnus-agent-low-score}; default 0.
18957 True iff the article has a download score greater than
18958 @code{gnus-agent-high-score}; default 0.
18961 True iff the Gnus Agent guesses that the article is spam. The
18962 heuristics may change over time, but at present it just computes a
18963 checksum and sees whether articles match.
18972 If you want to create your own predicate function, here's what you have
18973 to know: The functions are called with no parameters, but the
18974 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
18977 For example, you could decide that you don't want to download articles
18978 that were posted more than a certain number of days ago (e.g. posted
18979 more than @code{gnus-agent-expire-days} ago) you might write a function
18980 something along the lines of the following:
18983 (defun my-article-old-p ()
18984 "Say whether an article is old."
18985 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
18986 (- (time-to-days (current-time)) gnus-agent-expire-days)))
18989 with the predicate then defined as:
18992 (not my-article-old-p)
18995 or you could append your predicate to the predefined
18996 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
19000 (require 'gnus-agent)
19001 (setq gnus-category-predicate-alist
19002 (append gnus-category-predicate-alist
19003 '((old . my-article-old-p))))
19006 and simply specify your predicate as:
19012 If/when using something like the above, be aware that there are many
19013 misconfigured systems/mailers out there and so an article's date is not
19014 always a reliable indication of when it was posted. Hell, some people
19015 just don't give a damn.
19017 The above predicates apply to @emph{all} the groups which belong to the
19018 category. However, if you wish to have a specific predicate for an
19019 individual group within a category, or you're just too lazy to set up a
19020 new category, you can enter a group's individual predicate in its group
19021 parameters like so:
19024 (agent-predicate . short)
19027 This is the group/topic parameter equivalent of the agent category default.
19028 Note that when specifying a single word predicate like this, the
19029 @code{agent-predicate} specification must be in dotted pair notation.
19031 The equivalent of the longer example from above would be:
19034 (agent-predicate or high (and (not low) (not long)))
19037 The outer parenthesis required in the category specification are not
19038 entered here as, not being in dotted pair notation, the value of the
19039 predicate is assumed to be a list.
19042 Now, the syntax of the download score is the same as the syntax of
19043 normal score files, except that all elements that require actually
19044 seeing the article itself are verboten. This means that only the
19045 following headers can be scored on: @code{Subject}, @code{From},
19046 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
19047 @code{Lines}, and @code{Xref}.
19049 As with predicates, the specification of the @code{download score rule}
19050 to use in respect of a group can be in either the category definition if
19051 it's to be applicable to all groups in therein, or a group's parameters
19052 if it's to be specific to that group.
19054 In both of these places the @code{download score rule} can take one of
19061 This has the same syntax as a normal Gnus score file except only a
19062 subset of scoring keywords are available as mentioned above.
19068 Category specification
19072 ("Lars Ingebrigtsen" 1000000 nil s))
19078 Group/Topic Parameter specification
19081 (agent-score ("from"
19082 ("Lars Ingebrigtsen" 1000000 nil s))
19087 Again, note the omission of the outermost parenthesis here.
19093 These score files must @emph{only} contain the permitted scoring
19094 keywords stated above.
19100 Category specification
19103 ("~/News/agent.SCORE")
19109 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
19113 Group Parameter specification
19116 (agent-score "~/News/agent.SCORE")
19119 Additional score files can be specified as above. Need I say anything
19124 Use @code{normal} score files
19126 If you don't want to maintain two sets of scoring rules for a group, and
19127 your desired @code{downloading} criteria for a group are the same as your
19128 @code{reading} criteria then you can tell the agent to refer to your
19129 @code{normal} score files when deciding what to download.
19131 These directives in either the category definition or a group's
19132 parameters will cause the agent to read in all the applicable score
19133 files for a group, @emph{filtering out} those sections that do not
19134 relate to one of the permitted subset of scoring keywords.
19138 Category Specification
19145 Group Parameter specification
19148 (agent-score . file)
19153 @node Category Buffer
19154 @subsubsection Category Buffer
19156 You'd normally do all category maintenance from the category buffer.
19157 When you enter it for the first time (with the @kbd{J c} command from
19158 the group buffer), you'll only see the @code{default} category.
19160 The following commands are available in this buffer:
19164 @kindex q (Category)
19165 @findex gnus-category-exit
19166 Return to the group buffer (@code{gnus-category-exit}).
19169 @kindex e (Category)
19170 @findex gnus-category-customize-category
19171 Use a customization buffer to set all of the selected category's
19172 parameters at one time (@code{gnus-category-customize-category}).
19175 @kindex k (Category)
19176 @findex gnus-category-kill
19177 Kill the current category (@code{gnus-category-kill}).
19180 @kindex c (Category)
19181 @findex gnus-category-copy
19182 Copy the current category (@code{gnus-category-copy}).
19185 @kindex a (Category)
19186 @findex gnus-category-add
19187 Add a new category (@code{gnus-category-add}).
19190 @kindex p (Category)
19191 @findex gnus-category-edit-predicate
19192 Edit the predicate of the current category
19193 (@code{gnus-category-edit-predicate}).
19196 @kindex g (Category)
19197 @findex gnus-category-edit-groups
19198 Edit the list of groups belonging to the current category
19199 (@code{gnus-category-edit-groups}).
19202 @kindex s (Category)
19203 @findex gnus-category-edit-score
19204 Edit the download score rule of the current category
19205 (@code{gnus-category-edit-score}).
19208 @kindex l (Category)
19209 @findex gnus-category-list
19210 List all the categories (@code{gnus-category-list}).
19214 @node Category Variables
19215 @subsubsection Category Variables
19218 @item gnus-category-mode-hook
19219 @vindex gnus-category-mode-hook
19220 Hook run in category buffers.
19222 @item gnus-category-line-format
19223 @vindex gnus-category-line-format
19224 Format of the lines in the category buffer (@pxref{Formatting
19225 Variables}). Valid elements are:
19229 The name of the category.
19232 The number of groups in the category.
19235 @item gnus-category-mode-line-format
19236 @vindex gnus-category-mode-line-format
19237 Format of the category mode line (@pxref{Mode Line Formatting}).
19239 @item gnus-agent-short-article
19240 @vindex gnus-agent-short-article
19241 Articles that have fewer lines than this are short. Default 100.
19243 @item gnus-agent-long-article
19244 @vindex gnus-agent-long-article
19245 Articles that have more lines than this are long. Default 200.
19247 @item gnus-agent-low-score
19248 @vindex gnus-agent-low-score
19249 Articles that have a score lower than this have a low score. Default
19252 @item gnus-agent-high-score
19253 @vindex gnus-agent-high-score
19254 Articles that have a score higher than this have a high score. Default
19257 @item gnus-agent-expire-days
19258 @vindex gnus-agent-expire-days
19259 The number of days that a @samp{read} article must stay in the agent's
19260 local disk before becoming eligible for expiration (While the name is
19261 the same, this doesn't mean expiring the article on the server. It
19262 just means deleting the local copy of the article). What is also
19263 important to understand is that the counter starts with the time the
19264 article was written to the local disk and not the time the article was
19268 @item gnus-agent-enable-expiration
19269 @vindex gnus-agent-enable-expiration
19270 Determines whether articles in a group are, by default, expired or
19271 retained indefinitely. The default is @code{ENABLE} which means that
19272 you'll have to disable expiration when desired. On the other hand,
19273 you could set this to @code{DISABLE}. In that case, you would then
19274 have to enable expiration in selected groups.
19279 @node Agent Commands
19280 @subsection Agent Commands
19281 @findex gnus-agent-toggle-plugged
19282 @kindex J j (Agent)
19284 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
19285 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
19286 toggles the plugged/unplugged state of the Gnus Agent.
19290 * Group Agent Commands:: Configure groups and fetch their contents.
19291 * Summary Agent Commands:: Manually select then fetch specific articles.
19292 * Server Agent Commands:: Select the servers that are supported by the agent.
19298 @node Group Agent Commands
19299 @subsubsection Group Agent Commands
19303 @kindex J u (Agent Group)
19304 @findex gnus-agent-fetch-groups
19305 Fetch all eligible articles in the current group
19306 (@code{gnus-agent-fetch-groups}).
19309 @kindex J c (Agent Group)
19310 @findex gnus-enter-category-buffer
19311 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
19314 @kindex J s (Agent Group)
19315 @findex gnus-agent-fetch-session
19316 Fetch all eligible articles in all groups
19317 (@code{gnus-agent-fetch-session}).
19320 @kindex J S (Agent Group)
19321 @findex gnus-group-send-queue
19322 Send all sendable messages in the queue group
19323 (@code{gnus-group-send-queue}). @xref{Drafts}.
19326 @kindex J a (Agent Group)
19327 @findex gnus-agent-add-group
19328 Add the current group to an Agent category
19329 (@code{gnus-agent-add-group}). This command understands the
19330 process/prefix convention (@pxref{Process/Prefix}).
19333 @kindex J r (Agent Group)
19334 @findex gnus-agent-remove-group
19335 Remove the current group from its category, if any
19336 (@code{gnus-agent-remove-group}). This command understands the
19337 process/prefix convention (@pxref{Process/Prefix}).
19340 @kindex J Y (Agent Group)
19341 @findex gnus-agent-synchronize-flags
19342 Synchronize flags changed while unplugged with remote server, if any.
19348 @node Summary Agent Commands
19349 @subsubsection Summary Agent Commands
19353 @kindex J # (Agent Summary)
19354 @findex gnus-agent-mark-article
19355 Mark the article for downloading (@code{gnus-agent-mark-article}).
19358 @kindex J M-# (Agent Summary)
19359 @findex gnus-agent-unmark-article
19360 Remove the downloading mark from the article
19361 (@code{gnus-agent-unmark-article}).
19365 @kindex @@ (Agent Summary)
19366 @findex gnus-agent-toggle-mark
19367 Toggle whether to download the article
19368 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
19372 @kindex J c (Agent Summary)
19373 @findex gnus-agent-catchup
19374 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
19377 @kindex J S (Agent Summary)
19378 @findex gnus-agent-fetch-group
19379 Download all eligible (@pxref{Agent Categories}) articles in this group.
19380 (@code{gnus-agent-fetch-group}).
19383 @kindex J s (Agent Summary)
19384 @findex gnus-agent-summary-fetch-series
19385 Download all processable articles in this group.
19386 (@code{gnus-agent-summary-fetch-series}).
19389 @kindex J u (Agent Summary)
19390 @findex gnus-agent-summary-fetch-group
19391 Download all downloadable articles in the current group
19392 (@code{gnus-agent-summary-fetch-group}).
19397 @node Server Agent Commands
19398 @subsubsection Server Agent Commands
19402 @kindex J a (Agent Server)
19403 @findex gnus-agent-add-server
19404 Add the current server to the list of servers covered by the Gnus Agent
19405 (@code{gnus-agent-add-server}).
19408 @kindex J r (Agent Server)
19409 @findex gnus-agent-remove-server
19410 Remove the current server from the list of servers covered by the Gnus
19411 Agent (@code{gnus-agent-remove-server}).
19416 @node Agent Visuals
19417 @subsection Agent Visuals
19419 If you open a summary while unplugged and, Gnus knows from the group's
19420 active range that there are more articles than the headers currently
19421 stored in the Agent, you may see some articles whose subject looks
19422 something like @samp{[Undownloaded article #####]}. These are
19423 placeholders for the missing headers. Aside from setting a mark,
19424 there is not much that can be done with one of these placeholders.
19425 When Gnus finally gets a chance to fetch the group's headers, the
19426 placeholders will automatically be replaced by the actual headers.
19427 You can configure the summary buffer's maneuvering to skip over the
19428 placeholders if you care (See @code{gnus-auto-goto-ignores}).
19430 While it may be obvious to all, the only headers and articles
19431 available while unplugged are those headers and articles that were
19432 fetched into the Agent while previously plugged. To put it another
19433 way, ``If you forget to fetch something while plugged, you might have a
19434 less than satisfying unplugged session''. For this reason, the Agent
19435 adds two visual effects to your summary buffer. These effects display
19436 the download status of each article so that you always know which
19437 articles will be available when unplugged.
19439 The first visual effect is the @samp{%O} spec. If you customize
19440 @code{gnus-summary-line-format} to include this specifier, you will add
19441 a single character field that indicates an article's download status.
19442 Articles that have been fetched into either the Agent or the Cache,
19443 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
19444 other articles will display @code{gnus-undownloaded-mark} (defaults to
19445 @samp{-}). If you open a group that has not been agentized, a space
19446 (@samp{ }) will be displayed.
19448 The second visual effect are the undownloaded faces. The faces, there
19449 are three indicating the article's score (low, normal, high), seem to
19450 result in a love/hate response from many Gnus users. The problem is
19451 that the face selection is controlled by a list of condition tests and
19452 face names (See @code{gnus-summary-highlight}). Each condition is
19453 tested in the order in which it appears in the list so early
19454 conditions have precedence over later conditions. All of this means
19455 that, if you tick an undownloaded article, the article will continue
19456 to be displayed in the undownloaded face rather than the ticked face.
19458 If you use the Agent as a cache (to avoid downloading the same article
19459 each time you visit it or to minimize your connection time), the
19460 undownloaded face will probably seem like a good idea. The reason
19461 being that you do all of our work (marking, reading, deleting) with
19462 downloaded articles so the normal faces always appear. For those
19463 users using the agent to improve online performance by caching the NOV
19464 database (most users since 5.10.2), the undownloaded faces may appear
19465 to be an absolutely horrible idea. The issue being that, since none
19466 of their articles have been fetched into the Agent, all of the
19467 normal faces will be obscured by the undownloaded faces.
19469 If you would like to use the undownloaded faces, you must enable the
19470 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
19471 group parameter to @code{t}. This parameter, like all other agent
19472 parameters, may be set on an Agent Category (@pxref{Agent Categories}),
19473 a Group Topic (@pxref{Topic Parameters}), or an individual group
19474 (@pxref{Group Parameters}).
19476 The one problem common to all users using the agent is how quickly it
19477 can consume disk space. If you using the agent on many groups, it is
19478 even more difficult to effectively recover disk space. One solution
19479 is the @samp{%F} format available in @code{gnus-group-line-format}.
19480 This format will display the actual disk space used by articles
19481 fetched into both the agent and cache. By knowing which groups use
19482 the most space, users know where to focus their efforts when ``agent
19483 expiring'' articles.
19485 @node Agent as Cache
19486 @subsection Agent as Cache
19488 When Gnus is plugged, it is not efficient to download headers or
19489 articles from the server again, if they are already stored in the
19490 Agent. So, Gnus normally only downloads headers once, and stores them
19491 in the Agent. These headers are later used when generating the summary
19492 buffer, regardless of whether you are plugged or unplugged. Articles
19493 are not cached in the Agent by default though (that would potentially
19494 consume lots of disk space), but if you have already downloaded an
19495 article into the Agent, Gnus will not download the article from the
19496 server again but use the locally stored copy instead.
19498 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
19499 @pxref{Agent Variables}) to always download headers and articles while
19500 plugged. Gnus will almost certainly be slower, but it will be kept
19501 synchronized with the server. That last point probably won't make any
19502 sense if you are using a nntp or nnimap back end.
19505 @subsection Agent Expiry
19507 @vindex gnus-agent-expire-days
19508 @findex gnus-agent-expire
19509 @kindex M-x gnus-agent-expire
19510 @kindex M-x gnus-agent-expire-group
19511 @findex gnus-agent-expire-group
19512 @cindex agent expiry
19513 @cindex Gnus agent expiry
19514 @cindex expiry, in Gnus agent
19516 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
19517 least it doesn't handle it like other back ends. Instead, there are
19518 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
19519 commands that will expire all read articles that are older than
19520 @code{gnus-agent-expire-days} days. They can be run whenever you feel
19521 that you're running out of space. Neither are particularly fast or
19522 efficient, and it's not a particularly good idea to interrupt them (with
19523 @kbd{C-g} or anything else) once you've started one of them.
19525 Note that other functions, e.g. @code{gnus-request-expire-articles},
19526 might run @code{gnus-agent-expire} for you to keep the agent
19527 synchronized with the group.
19529 The agent parameter @code{agent-enable-expiration} may be used to
19530 prevent expiration in selected groups.
19532 @vindex gnus-agent-expire-all
19533 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
19534 expiration commands will expire all articles---unread, read, ticked
19535 and dormant. If @code{nil} (which is the default), only read articles
19536 are eligible for expiry, and unread, ticked and dormant articles will
19537 be kept indefinitely.
19539 If you find that some articles eligible for expiry are never expired,
19540 perhaps some Gnus Agent files are corrupted. There's are special
19541 commands, @code{gnus-agent-regenerate} and
19542 @code{gnus-agent-regenerate-group}, to fix possible problems.
19544 @node Agent Regeneration
19545 @subsection Agent Regeneration
19547 @cindex agent regeneration
19548 @cindex Gnus agent regeneration
19549 @cindex regeneration
19551 The local data structures used by @code{nnagent} may become corrupted
19552 due to certain exceptional conditions. When this happens,
19553 @code{nnagent} functionality may degrade or even fail. The solution
19554 to this problem is to repair the local data structures by removing all
19555 internal inconsistencies.
19557 For example, if your connection to your server is lost while
19558 downloaded articles into the agent, the local data structures will not
19559 know about articles successfully downloaded prior to the connection
19560 failure. Running @code{gnus-agent-regenerate} or
19561 @code{gnus-agent-regenerate-group} will update the data structures
19562 such that you don't need to download these articles a second time.
19564 @findex gnus-agent-regenerate
19565 @kindex M-x gnus-agent-regenerate
19566 The command @code{gnus-agent-regenerate} will perform
19567 @code{gnus-agent-regenerate-group} on every agentized group. While
19568 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
19569 recommended that you first close all summary buffers.
19571 @findex gnus-agent-regenerate-group
19572 @kindex M-x gnus-agent-regenerate-group
19573 The command @code{gnus-agent-regenerate-group} uses the local copies
19574 of individual articles to repair the local @acronym{NOV}(header) database. It
19575 then updates the internal data structures that document which articles
19576 are stored locally. An optional argument will mark articles in the
19579 @node Agent and flags
19580 @subsection Agent and flags
19582 The Agent works with any Gnus back end including those, such as
19583 nnimap, that store flags (read, ticked, etc) on the server. Sadly,
19584 the Agent does not actually know which backends keep their flags in
19585 the backend server rather than in @file{.newsrc}. This means that the
19586 Agent, while unplugged or disconnected, will always record all changes
19587 to the flags in its own files.
19589 When you plug back in, Gnus will then check to see if you have any
19590 changed any flags and ask if you wish to synchronize these with the
19591 server. This behavior is customizable by @code{gnus-agent-synchronize-flags}.
19593 @vindex gnus-agent-synchronize-flags
19594 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19595 never automatically synchronize flags. If it is @code{ask}, which is
19596 the default, the Agent will check if you made any changes and if so
19597 ask if you wish to synchronize these when you re-connect. If it has
19598 any other value, all flags will be synchronized automatically.
19600 If you do not wish to synchronize flags automatically when you
19601 re-connect, you can do it manually with the
19602 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
19603 in the group buffer.
19605 Technical note: the synchronization algorithm does not work by ``pushing''
19606 all local flags to the server, but rather by incrementally updated the
19607 server view of flags by changing only those flags that were changed by
19608 the user. Thus, if you set one flag on an article, quit the group then
19609 re-select the group and remove the flag; the flag will be set and
19610 removed from the server when you ``synchronize''. The queued flag
19611 operations can be found in the per-server @code{flags} file in the Agent
19612 directory. It's emptied when you synchronize flags.
19614 @node Agent and IMAP
19615 @subsection Agent and IMAP
19617 The Agent works with any Gnus back end, including nnimap. However,
19618 since there are some conceptual differences between @acronym{NNTP} and
19619 @acronym{IMAP}, this section (should) provide you with some information to
19620 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
19622 Some things are currently not implemented in the Agent that you'd might
19623 expect from a disconnected @acronym{IMAP} client, including:
19628 Copying/moving articles into nnimap groups when unplugged.
19631 Creating/deleting nnimap groups when unplugged.
19635 @node Outgoing Messages
19636 @subsection Outgoing Messages
19638 By default, when Gnus is unplugged, all outgoing messages (both mail
19639 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
19640 You can view them there after posting, and edit them at will.
19642 You can control the circumstances under which outgoing mail is queued
19643 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
19644 news is always queued when Gnus is unplugged, and never otherwise.
19646 You can send the messages either from the draft group with the special
19647 commands available there, or you can use the @kbd{J S} command in the
19648 group buffer to send all the sendable messages in the draft group.
19649 Posting news will only work when Gnus is plugged, but you can send
19652 If sending mail while unplugged does not work for you and you worry
19653 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
19654 ask you to confirm your action (see
19655 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
19657 @node Agent Variables
19658 @subsection Agent Variables
19663 Is the agent enabled? The default is @code{t}. When first enabled,
19664 the agent will use @code{gnus-agent-auto-agentize-methods} to
19665 automatically mark some back ends as agentized. You may change which
19666 back ends are agentized using the agent commands in the server buffer.
19668 To enter the server buffer, use the @kbd{^}
19669 (@code{gnus-group-enter-server-mode}) command in the group buffer.
19672 @item gnus-agent-directory
19673 @vindex gnus-agent-directory
19674 Where the Gnus Agent will store its files. The default is
19675 @file{~/News/agent/}.
19677 @item gnus-agent-handle-level
19678 @vindex gnus-agent-handle-level
19679 Groups on levels (@pxref{Group Levels}) higher than this variable will
19680 be ignored by the Agent. The default is @code{gnus-level-subscribed},
19681 which means that only subscribed group will be considered by the Agent
19684 @item gnus-agent-plugged-hook
19685 @vindex gnus-agent-plugged-hook
19686 Hook run when connecting to the network.
19688 @item gnus-agent-unplugged-hook
19689 @vindex gnus-agent-unplugged-hook
19690 Hook run when disconnecting from the network.
19692 @item gnus-agent-fetched-hook
19693 @vindex gnus-agent-fetched-hook
19694 Hook run when finished fetching articles.
19696 @item gnus-agent-cache
19697 @vindex gnus-agent-cache
19698 Variable to control whether use the locally stored @acronym{NOV} and
19699 articles when plugged, e.g. essentially using the Agent as a cache.
19700 The default is non-@code{nil}, which means to use the Agent as a cache.
19702 @item gnus-agent-go-online
19703 @vindex gnus-agent-go-online
19704 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
19705 automatically switch offline servers into online status. If it is
19706 @code{ask}, the default, the Agent will ask if you wish to switch
19707 offline servers into online status when you re-connect. If it has any
19708 other value, all offline servers will be automatically switched into
19711 @item gnus-agent-mark-unread-after-downloaded
19712 @vindex gnus-agent-mark-unread-after-downloaded
19713 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
19714 mark articles as unread after downloading. This is usually a safe
19715 thing to do as the newly downloaded article has obviously not been
19716 read. The default is @code{t}.
19718 @item gnus-agent-synchronize-flags
19719 @vindex gnus-agent-synchronize-flags
19720 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19721 never automatically synchronize flags. If it is @code{ask}, which is
19722 the default, the Agent will check if you made any changes and if so
19723 ask if you wish to synchronize these when you re-connect. If it has
19724 any other value, all flags will be synchronized automatically.
19726 @item gnus-agent-consider-all-articles
19727 @vindex gnus-agent-consider-all-articles
19728 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
19729 agent will let the agent predicate decide whether articles need to be
19730 downloaded or not, for all articles. When @code{nil}, the default,
19731 the agent will only let the predicate decide whether unread articles
19732 are downloaded or not. If you enable this, you may also want to look
19733 into the agent expiry settings (@pxref{Category Variables}), so that
19734 the agent doesn't download articles which the agent will later expire,
19735 over and over again.
19737 @item gnus-agent-max-fetch-size
19738 @vindex gnus-agent-max-fetch-size
19739 The agent fetches articles into a temporary buffer prior to parsing
19740 them into individual files. To avoid exceeding the max. buffer size,
19741 the agent alternates between fetching and parsing until all articles
19742 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
19743 limit to control how often the cycling occurs. A large value improves
19744 performance. A small value minimizes the time lost should the
19745 connection be lost while fetching (You may need to run
19746 @code{gnus-agent-regenerate-group} to update the group's state.
19747 However, all articles parsed prior to loosing the connection will be
19748 available while unplugged). The default is 10M so it is unusual to
19751 @item gnus-server-unopen-status
19752 @vindex gnus-server-unopen-status
19753 Perhaps not an Agent variable, but closely related to the Agent, this
19754 variable says what will happen if Gnus cannot open a server. If the
19755 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
19756 whether to deny the server or whether to unplug the agent. If the
19757 Agent is disabled, Gnus always simply deny the server. Other choices
19758 for this variable include @code{denied} and @code{offline} the latter
19759 is only valid if the Agent is used.
19761 @item gnus-auto-goto-ignores
19762 @vindex gnus-auto-goto-ignores
19763 Another variable that isn't an Agent variable, yet so closely related
19764 that most will look for it here, this variable tells the summary
19765 buffer how to maneuver around undownloaded (only headers stored in the
19766 agent) and unfetched (neither article nor headers stored) articles.
19768 The valid values are @code{nil} (maneuver to any article),
19769 @code{undownloaded} (maneuvering while unplugged ignores articles that
19770 have not been fetched), @code{always-undownloaded} (maneuvering always
19771 ignores articles that have not been fetched), @code{unfetched}
19772 (maneuvering ignores articles whose headers have not been fetched).
19774 @item gnus-agent-queue-mail
19775 @vindex gnus-agent-queue-mail
19776 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
19777 queue mail rather than sending it straight away. When @code{t}, Gnus
19778 will queue mail when unplugged only. When @code{nil}, never queue
19779 mail. The default is @code{t}.
19781 @item gnus-agent-prompt-send-queue
19782 @vindex gnus-agent-prompt-send-queue
19783 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
19784 prompt you to confirm that you really wish to proceed if you hit
19785 @kbd{J S} while unplugged. The default is @code{nil}.
19787 @item gnus-agent-auto-agentize-methods
19788 @vindex gnus-agent-auto-agentize-methods
19789 If you have never used the Agent before (or more technically, if
19790 @file{~/News/agent/lib/servers} does not exist), Gnus will
19791 automatically agentize a few servers for you. This variable control
19792 which back ends should be auto-agentized. It is typically only useful
19793 to agentize remote back ends. The auto-agentizing has the same effect
19794 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
19795 If the file exist, you must manage the servers manually by adding or
19796 removing them, this variable is only applicable the first time you
19797 start Gnus. The default is @samp{(nntp nnimap)}.
19802 @node Example Setup
19803 @subsection Example Setup
19805 If you don't want to read this manual, and you have a fairly standard
19806 setup, you may be able to use something like the following as your
19807 @file{~/.gnus.el} file to get started.
19810 ;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
19811 ;; @r{from your ISP's server.}
19812 (setq gnus-select-method '(nntp "news.your-isp.com"))
19814 ;; @r{Define how Gnus is to read your mail. We read mail from}
19815 ;; @r{your ISP's @acronym{POP} server.}
19816 (setq mail-sources '((pop :server "pop.your-isp.com")))
19818 ;; @r{Say how Gnus is to store the mail. We use nnml groups.}
19819 (setq gnus-secondary-select-methods '((nnml "")))
19821 ;; @r{Make Gnus into an offline newsreader.}
19822 ;; (gnus-agentize) ; @r{The obsolete setting.}
19823 ;; (setq gnus-agent t) ; @r{Now the default.}
19826 That should be it, basically. Put that in your @file{~/.gnus.el} file,
19827 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
19830 If this is the first time you've run Gnus, you will be subscribed
19831 automatically to a few default newsgroups. You'll probably want to
19832 subscribe to more groups, and to do that, you have to query the
19833 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
19834 command. This usually takes quite a while, but you only have to do it
19837 After reading and parsing a while, you'll be presented with a list of
19838 groups. Subscribe to the ones you want to read with the @kbd{u}
19839 command. @kbd{l} to make all the killed groups disappear after you've
19840 subscribe to all the groups you want to read. (@kbd{A k} will bring
19841 back all the killed groups.)
19843 You can now read the groups at once, or you can download the articles
19844 with the @kbd{J s} command. And then read the rest of this manual to
19845 find out which of the other gazillion things you want to customize.
19848 @node Batching Agents
19849 @subsection Batching Agents
19850 @findex gnus-agent-batch
19852 Having the Gnus Agent fetch articles (and post whatever messages you've
19853 written) is quite easy once you've gotten things set up properly. The
19854 following shell script will do everything that is necessary:
19856 You can run a complete batch command from the command line with the
19857 following incantation:
19861 emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-agent-batch >/dev/null 2>&1
19865 @node Agent Caveats
19866 @subsection Agent Caveats
19868 The Gnus Agent doesn't seem to work like most other offline
19869 newsreaders. Here are some common questions that some imaginary people
19873 @item If I read an article while plugged, do they get entered into the Agent?
19875 @strong{No}. If you want this behavior, add
19876 @code{gnus-agent-fetch-selected-article} to
19877 @code{gnus-select-article-hook}.
19879 @item If I read an article while plugged, and the article already exists in
19880 the Agent, will it get downloaded once more?
19882 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
19886 In short, when Gnus is unplugged, it only looks into the locally stored
19887 articles; when it's plugged, it talks to your ISP and may also use the
19888 locally stored articles.
19895 Other people use @dfn{kill files}, but we here at Gnus Towers like
19896 scoring better than killing, so we'd rather switch than fight. They do
19897 something completely different as well, so sit up straight and pay
19900 @vindex gnus-summary-mark-below
19901 All articles have a default score (@code{gnus-summary-default-score}),
19902 which is 0 by default. This score may be raised or lowered either
19903 interactively or by score files. Articles that have a score lower than
19904 @code{gnus-summary-mark-below} are marked as read.
19906 Gnus will read any @dfn{score files} that apply to the current group
19907 before generating the summary buffer.
19909 There are several commands in the summary buffer that insert score
19910 entries based on the current article. You can, for instance, ask Gnus to
19911 lower or increase the score of all articles with a certain subject.
19913 There are two sorts of scoring entries: Permanent and temporary.
19914 Temporary score entries are self-expiring entries. Any entries that are
19915 temporary and have not been used for, say, a week, will be removed
19916 silently to help keep the sizes of the score files down.
19919 * Summary Score Commands:: Adding score entries for the current group.
19920 * Group Score Commands:: General score commands.
19921 * Score Variables:: Customize your scoring. (My, what terminology).
19922 * Score File Format:: What a score file may contain.
19923 * Score File Editing:: You can edit score files by hand as well.
19924 * Adaptive Scoring:: Big Sister Gnus knows what you read.
19925 * Home Score File:: How to say where new score entries are to go.
19926 * Followups To Yourself:: Having Gnus notice when people answer you.
19927 * Scoring On Other Headers:: Scoring on non-standard headers.
19928 * Scoring Tips:: How to score effectively.
19929 * Reverse Scoring:: That problem child of old is not problem.
19930 * Global Score Files:: Earth-spanning, ear-splitting score files.
19931 * Kill Files:: They are still here, but they can be ignored.
19932 * Converting Kill Files:: Translating kill files to score files.
19933 * Advanced Scoring:: Using logical expressions to build score rules.
19934 * Score Decays:: It can be useful to let scores wither away.
19938 @node Summary Score Commands
19939 @section Summary Score Commands
19940 @cindex score commands
19942 The score commands that alter score entries do not actually modify real
19943 score files. That would be too inefficient. Gnus maintains a cache of
19944 previously loaded score files, one of which is considered the
19945 @dfn{current score file alist}. The score commands simply insert
19946 entries into this list, and upon group exit, this list is saved.
19948 The current score file is by default the group's local score file, even
19949 if no such score file actually exists. To insert score commands into
19950 some other score file (e.g. @file{all.SCORE}), you must first make this
19951 score file the current one.
19953 General score commands that don't actually change the score file:
19958 @kindex V s (Summary)
19959 @findex gnus-summary-set-score
19960 Set the score of the current article (@code{gnus-summary-set-score}).
19963 @kindex V S (Summary)
19964 @findex gnus-summary-current-score
19965 Display the score of the current article
19966 (@code{gnus-summary-current-score}).
19969 @kindex V t (Summary)
19970 @findex gnus-score-find-trace
19971 Display all score rules that have been used on the current article
19972 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
19973 may type @kbd{e} to edit score file corresponding to the score rule on
19974 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
19975 score file and edit it.
19978 @kindex V w (Summary)
19979 @findex gnus-score-find-favourite-words
19980 List words used in scoring (@code{gnus-score-find-favourite-words}).
19983 @kindex V R (Summary)
19984 @findex gnus-summary-rescore
19985 Run the current summary through the scoring process
19986 (@code{gnus-summary-rescore}). This might be useful if you're playing
19987 around with your score files behind Gnus' back and want to see the
19988 effect you're having.
19991 @kindex V c (Summary)
19992 @findex gnus-score-change-score-file
19993 Make a different score file the current
19994 (@code{gnus-score-change-score-file}).
19997 @kindex V e (Summary)
19998 @findex gnus-score-edit-current-scores
19999 Edit the current score file (@code{gnus-score-edit-current-scores}).
20000 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
20004 @kindex V f (Summary)
20005 @findex gnus-score-edit-file
20006 Edit a score file and make this score file the current one
20007 (@code{gnus-score-edit-file}).
20010 @kindex V F (Summary)
20011 @findex gnus-score-flush-cache
20012 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
20013 after editing score files.
20016 @kindex V C (Summary)
20017 @findex gnus-score-customize
20018 Customize a score file in a visually pleasing manner
20019 (@code{gnus-score-customize}).
20023 The rest of these commands modify the local score file.
20028 @kindex V m (Summary)
20029 @findex gnus-score-set-mark-below
20030 Prompt for a score, and mark all articles with a score below this as
20031 read (@code{gnus-score-set-mark-below}).
20034 @kindex V x (Summary)
20035 @findex gnus-score-set-expunge-below
20036 Prompt for a score, and add a score rule to the current score file to
20037 expunge all articles below this score
20038 (@code{gnus-score-set-expunge-below}).
20041 The keystrokes for actually making score entries follow a very regular
20042 pattern, so there's no need to list all the commands. (Hundreds of
20045 @findex gnus-summary-increase-score
20046 @findex gnus-summary-lower-score
20050 The first key is either @kbd{I} (upper case i) for increasing the score
20051 or @kbd{L} for lowering the score.
20053 The second key says what header you want to score on. The following
20054 keys are available:
20058 Score on the author name.
20061 Score on the subject line.
20064 Score on the @code{Xref} line---i.e., the cross-posting line.
20067 Score on the @code{References} line.
20073 Score on the number of lines.
20076 Score on the @code{Message-ID} header.
20079 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
20080 if your @acronym{NNTP} server tracks additional header data in overviews.
20083 Score on followups---this matches the author name, and adds scores to
20084 the followups to this author. (Using this key leads to the creation of
20085 @file{ADAPT} files.)
20094 Score on thread. (Using this key leads to the creation of @file{ADAPT}
20100 The third key is the match type. Which match types are valid depends on
20101 what headers you are scoring on.
20113 Substring matching.
20116 Fuzzy matching (@pxref{Fuzzy Matching}).
20145 Greater than number.
20150 The fourth and usually final key says whether this is a temporary (i.e.,
20151 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
20152 or whether it is to be done immediately, without adding to the score
20157 Temporary score entry.
20160 Permanent score entry.
20163 Immediately scoring.
20167 If you are scoring on `e' (extra) headers, you will then be prompted for
20168 the header name on which you wish to score. This must be a header named
20169 in gnus-extra-headers, and @samp{TAB} completion is available.
20173 So, let's say you want to increase the score on the current author with
20174 exact matching permanently: @kbd{I a e p}. If you want to lower the
20175 score based on the subject line, using substring matching, and make a
20176 temporary score entry: @kbd{L s s t}. Pretty easy.
20178 To make things a bit more complicated, there are shortcuts. If you use
20179 a capital letter on either the second or third keys, Gnus will use
20180 defaults for the remaining one or two keystrokes. The defaults are
20181 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
20182 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
20184 These functions take both the numerical prefix and the symbolic prefix
20185 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
20186 (or increase) the score of the article. A symbolic prefix of @code{a}
20187 says to use the @file{all.SCORE} file for the command instead of the
20188 current score file.
20190 @vindex gnus-score-mimic-keymap
20191 The @code{gnus-score-mimic-keymap} says whether these commands will
20192 pretend they are keymaps or not.
20195 @node Group Score Commands
20196 @section Group Score Commands
20197 @cindex group score commands
20199 There aren't many of these as yet, I'm afraid.
20204 @kindex W e (Group)
20205 @findex gnus-score-edit-all-score
20206 Edit the apply-to-all-groups all.SCORE file. You will be popped into
20207 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
20210 @kindex W f (Group)
20211 @findex gnus-score-flush-cache
20212 Gnus maintains a cache of score alists to avoid having to reload them
20213 all the time. This command will flush the cache
20214 (@code{gnus-score-flush-cache}).
20218 You can do scoring from the command line by saying something like:
20220 @findex gnus-batch-score
20221 @cindex batch scoring
20223 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
20227 @node Score Variables
20228 @section Score Variables
20229 @cindex score variables
20233 @item gnus-use-scoring
20234 @vindex gnus-use-scoring
20235 If @code{nil}, Gnus will not check for score files, and will not, in
20236 general, do any score-related work. This is @code{t} by default.
20238 @item gnus-kill-killed
20239 @vindex gnus-kill-killed
20240 If this variable is @code{nil}, Gnus will never apply score files to
20241 articles that have already been through the kill process. While this
20242 may save you lots of time, it also means that if you apply a kill file
20243 to a group, and then change the kill file and want to run it over you
20244 group again to kill more articles, it won't work. You have to set this
20245 variable to @code{t} to do that. (It is @code{t} by default.)
20247 @item gnus-kill-files-directory
20248 @vindex gnus-kill-files-directory
20249 All kill and score files will be stored in this directory, which is
20250 initialized from the @env{SAVEDIR} environment variable by default.
20251 This is @file{~/News/} by default.
20253 @item gnus-score-file-suffix
20254 @vindex gnus-score-file-suffix
20255 Suffix to add to the group name to arrive at the score file name
20256 (@file{SCORE} by default.)
20258 @item gnus-score-uncacheable-files
20259 @vindex gnus-score-uncacheable-files
20260 @cindex score cache
20261 All score files are normally cached to avoid excessive re-loading of
20262 score files. However, if this might make your Emacs grow big and
20263 bloated, so this regexp can be used to weed out score files unlikely
20264 to be needed again. It would be a bad idea to deny caching of
20265 @file{all.SCORE}, while it might be a good idea to not cache
20266 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
20267 variable is @samp{ADAPT$} by default, so no adaptive score files will
20270 @item gnus-save-score
20271 @vindex gnus-save-score
20272 If you have really complicated score files, and do lots of batch
20273 scoring, then you might set this variable to @code{t}. This will make
20274 Gnus save the scores into the @file{.newsrc.eld} file.
20276 If you do not set this to @code{t}, then manual scores (like those set
20277 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
20278 across group visits.
20280 @item gnus-score-interactive-default-score
20281 @vindex gnus-score-interactive-default-score
20282 Score used by all the interactive raise/lower commands to raise/lower
20283 score with. Default is 1000, which may seem excessive, but this is to
20284 ensure that the adaptive scoring scheme gets enough room to play with.
20285 We don't want the small changes from the adaptive scoring to overwrite
20286 manually entered data.
20288 @item gnus-summary-default-score
20289 @vindex gnus-summary-default-score
20290 Default score of an article, which is 0 by default.
20292 @item gnus-summary-expunge-below
20293 @vindex gnus-summary-expunge-below
20294 Don't display the summary lines of articles that have scores lower than
20295 this variable. This is @code{nil} by default, which means that no
20296 articles will be hidden. This variable is local to the summary buffers,
20297 and has to be set from @code{gnus-summary-mode-hook}.
20299 @item gnus-score-over-mark
20300 @vindex gnus-score-over-mark
20301 Mark (in the third column) used for articles with a score over the
20302 default. Default is @samp{+}.
20304 @item gnus-score-below-mark
20305 @vindex gnus-score-below-mark
20306 Mark (in the third column) used for articles with a score below the
20307 default. Default is @samp{-}.
20309 @item gnus-score-find-score-files-function
20310 @vindex gnus-score-find-score-files-function
20311 Function used to find score files for the current group. This function
20312 is called with the name of the group as the argument.
20314 Predefined functions available are:
20317 @item gnus-score-find-single
20318 @findex gnus-score-find-single
20319 Only apply the group's own score file.
20321 @item gnus-score-find-bnews
20322 @findex gnus-score-find-bnews
20323 Apply all score files that match, using bnews syntax. This is the
20324 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
20325 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
20326 @file{gnu.all.SCORE} would all apply. In short, the instances of
20327 @samp{all} in the score file names are translated into @samp{.*}, and
20328 then a regexp match is done.
20330 This means that if you have some score entries that you want to apply to
20331 all groups, then you put those entries in the @file{all.SCORE} file.
20333 The score files are applied in a semi-random order, although Gnus will
20334 try to apply the more general score files before the more specific score
20335 files. It does this by looking at the number of elements in the score
20336 file names---discarding the @samp{all} elements.
20338 @item gnus-score-find-hierarchical
20339 @findex gnus-score-find-hierarchical
20340 Apply all score files from all the parent groups. This means that you
20341 can't have score files like @file{all.SCORE}, but you can have
20342 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
20346 This variable can also be a list of functions. In that case, all
20347 these functions will be called with the group name as argument, and
20348 all the returned lists of score files will be applied. These
20349 functions can also return lists of lists of score alists directly. In
20350 that case, the functions that return these non-file score alists
20351 should probably be placed before the ``real'' score file functions, to
20352 ensure that the last score file returned is the local score file.
20355 For example, to do hierarchical scoring but use a non-server-specific
20356 overall score file, you could use the value
20358 (list (lambda (group) ("all.SCORE"))
20359 'gnus-score-find-hierarchical)
20362 @item gnus-score-expiry-days
20363 @vindex gnus-score-expiry-days
20364 This variable says how many days should pass before an unused score file
20365 entry is expired. If this variable is @code{nil}, no score file entries
20366 are expired. It's 7 by default.
20368 @item gnus-update-score-entry-dates
20369 @vindex gnus-update-score-entry-dates
20370 If this variable is non-@code{nil}, temporary score entries that have
20371 been triggered (matched) will have their dates updated. (This is how Gnus
20372 controls expiry---all non-matched-entries will become too old while
20373 matched entries will stay fresh and young.) However, if you set this
20374 variable to @code{nil}, even matched entries will grow old and will
20375 have to face that oh-so grim reaper.
20377 @item gnus-score-after-write-file-function
20378 @vindex gnus-score-after-write-file-function
20379 Function called with the name of the score file just written.
20381 @item gnus-score-thread-simplify
20382 @vindex gnus-score-thread-simplify
20383 If this variable is non-@code{nil}, article subjects will be
20384 simplified for subject scoring purposes in the same manner as with
20385 threading---according to the current value of
20386 @code{gnus-simplify-subject-functions}. If the scoring entry uses
20387 @code{substring} or @code{exact} matching, the match will also be
20388 simplified in this manner.
20393 @node Score File Format
20394 @section Score File Format
20395 @cindex score file format
20397 A score file is an @code{emacs-lisp} file that normally contains just a
20398 single form. Casual users are not expected to edit these files;
20399 everything can be changed from the summary buffer.
20401 Anyway, if you'd like to dig into it yourself, here's an example:
20405 ("Lars Ingebrigtsen" -10000)
20407 ("larsi\\|lmi" -50000 nil R))
20409 ("Ding is Badd" nil 728373))
20411 ("alt.politics" -1000 728372 s))
20416 (mark-and-expunge -10)
20420 (files "/hom/larsi/News/gnu.SCORE")
20421 (exclude-files "all.SCORE")
20422 (local (gnus-newsgroup-auto-expire t)
20423 (gnus-summary-make-false-root empty))
20427 This example demonstrates most score file elements. @xref{Advanced
20428 Scoring}, for a different approach.
20430 Even though this looks much like Lisp code, nothing here is actually
20431 @code{eval}ed. The Lisp reader is used to read this form, though, so it
20432 has to be valid syntactically, if not semantically.
20434 Six keys are supported by this alist:
20439 If the key is a string, it is the name of the header to perform the
20440 match on. Scoring can only be performed on these eight headers:
20441 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
20442 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
20443 these headers, there are three strings to tell Gnus to fetch the entire
20444 article and do the match on larger parts of the article: @code{Body}
20445 will perform the match on the body of the article, @code{Head} will
20446 perform the match on the head of the article, and @code{All} will
20447 perform the match on the entire article. Note that using any of these
20448 last three keys will slow down group entry @emph{considerably}. The
20449 final ``header'' you can score on is @code{Followup}. These score
20450 entries will result in new score entries being added for all follow-ups
20451 to articles that matches these score entries.
20453 Following this key is an arbitrary number of score entries, where each
20454 score entry has one to four elements.
20458 The first element is the @dfn{match element}. On most headers this will
20459 be a string, but on the Lines and Chars headers, this must be an
20463 If the second element is present, it should be a number---the @dfn{score
20464 element}. This number should be an integer in the neginf to posinf
20465 interval. This number is added to the score of the article if the match
20466 is successful. If this element is not present, the
20467 @code{gnus-score-interactive-default-score} number will be used
20468 instead. This is 1000 by default.
20471 If the third element is present, it should be a number---the @dfn{date
20472 element}. This date says when the last time this score entry matched,
20473 which provides a mechanism for expiring the score entries. It this
20474 element is not present, the score entry is permanent. The date is
20475 represented by the number of days since December 31, 1 BCE.
20478 If the fourth element is present, it should be a symbol---the @dfn{type
20479 element}. This element specifies what function should be used to see
20480 whether this score entry matches the article. What match types that can
20481 be used depends on what header you wish to perform the match on.
20484 @item From, Subject, References, Xref, Message-ID
20485 For most header types, there are the @code{r} and @code{R} (regexp), as
20486 well as @code{s} and @code{S} (substring) types, and @code{e} and
20487 @code{E} (exact match), and @code{w} (word match) types. If this
20488 element is not present, Gnus will assume that substring matching should
20489 be used. @code{R}, @code{S}, and @code{E} differ from the others in
20490 that the matches will be done in a case-sensitive manner. All these
20491 one-letter types are really just abbreviations for the @code{regexp},
20492 @code{string}, @code{exact}, and @code{word} types, which you can use
20493 instead, if you feel like.
20496 Just as for the standard string overview headers, if you are using
20497 gnus-extra-headers, you can score on these headers' values. In this
20498 case, there is a 5th element in the score entry, being the name of the
20499 header to be scored. The following entry is useful in your
20500 @file{all.SCORE} file in case of spam attacks from a single origin
20501 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
20505 ("111.222.333.444" -1000 nil s
20506 "NNTP-Posting-Host")
20510 These two headers use different match types: @code{<}, @code{>},
20511 @code{=}, @code{>=} and @code{<=}.
20513 These predicates are true if
20516 (PREDICATE HEADER MATCH)
20519 evaluates to non-@code{nil}. For instance, the advanced match
20520 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
20527 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
20528 the match, we get the score added if the article has less than 4 lines.
20529 (It's easy to get confused and think it's the other way around. But
20530 it's not. I think.)
20532 When matching on @code{Lines}, be careful because some back ends (like
20533 @code{nndir}) do not generate @code{Lines} header, so every article ends
20534 up being marked as having 0 lines. This can lead to strange results if
20535 you happen to lower score of the articles with few lines.
20538 For the Date header we have three kinda silly match types:
20539 @code{before}, @code{at} and @code{after}. I can't really imagine this
20540 ever being useful, but, like, it would feel kinda silly not to provide
20541 this function. Just in case. You never know. Better safe than sorry.
20542 Once burnt, twice shy. Don't judge a book by its cover. Never not have
20543 sex on a first date. (I have been told that at least one person, and I
20544 quote, ``found this function indispensable'', however.)
20548 A more useful match type is @code{regexp}. With it, you can match the
20549 date string using a regular expression. The date is normalized to
20550 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
20551 you want to match all articles that have been posted on April 1st in
20552 every year, you could use @samp{....0401.........} as a match string,
20553 for instance. (Note that the date is kept in its original time zone, so
20554 this will match articles that were posted when it was April 1st where
20555 the article was posted from. Time zones are such wholesome fun for the
20558 @item Head, Body, All
20559 These three match keys use the same match types as the @code{From} (etc)
20563 This match key is somewhat special, in that it will match the
20564 @code{From} header, and affect the score of not only the matching
20565 articles, but also all followups to the matching articles. This allows
20566 you e.g. increase the score of followups to your own articles, or
20567 decrease the score of followups to the articles of some known
20568 trouble-maker. Uses the same match types as the @code{From} header
20569 uses. (Using this match key will lead to creation of @file{ADAPT}
20573 This match key works along the same lines as the @code{Followup} match
20574 key. If you say that you want to score on a (sub-)thread started by an
20575 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
20576 match. This will add a new @samp{thread} match for each article that
20577 has @var{x} in its @code{References} header. (These new @samp{thread}
20578 matches will use the @code{Message-ID}s of these matching articles.)
20579 This will ensure that you can raise/lower the score of an entire thread,
20580 even though some articles in the thread may not have complete
20581 @code{References} headers. Note that using this may lead to
20582 undeterministic scores of the articles in the thread. (Using this match
20583 key will lead to creation of @file{ADAPT} files.)
20587 @cindex score file atoms
20589 The value of this entry should be a number. Any articles with a score
20590 lower than this number will be marked as read.
20593 The value of this entry should be a number. Any articles with a score
20594 lower than this number will be removed from the summary buffer.
20596 @item mark-and-expunge
20597 The value of this entry should be a number. Any articles with a score
20598 lower than this number will be marked as read and removed from the
20601 @item thread-mark-and-expunge
20602 The value of this entry should be a number. All articles that belong to
20603 a thread that has a total score below this number will be marked as read
20604 and removed from the summary buffer. @code{gnus-thread-score-function}
20605 says how to compute the total score for a thread.
20608 The value of this entry should be any number of file names. These files
20609 are assumed to be score files as well, and will be loaded the same way
20612 @item exclude-files
20613 The clue of this entry should be any number of files. These files will
20614 not be loaded, even though they would normally be so, for some reason or
20618 The value of this entry will be @code{eval}el. This element will be
20619 ignored when handling global score files.
20622 Read-only score files will not be updated or saved. Global score files
20623 should feature this atom (@pxref{Global Score Files}). (Note:
20624 @dfn{Global} here really means @dfn{global}; not your personal
20625 apply-to-all-groups score files.)
20628 The value of this entry should be a number. Articles that do not have
20629 parents will get this number added to their scores. Imagine you follow
20630 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
20631 will only follow a few of the threads, also want to see any new threads.
20633 You can do this with the following two score file entries:
20637 (mark-and-expunge -100)
20640 When you enter the group the first time, you will only see the new
20641 threads. You then raise the score of the threads that you find
20642 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
20643 rest. Next time you enter the group, you will see new articles in the
20644 interesting threads, plus any new threads.
20646 I.e.---the orphan score atom is for high-volume groups where a few
20647 interesting threads which can't be found automatically by ordinary
20648 scoring rules exist.
20651 This entry controls the adaptive scoring. If it is @code{t}, the
20652 default adaptive scoring rules will be used. If it is @code{ignore}, no
20653 adaptive scoring will be performed on this group. If it is a list, this
20654 list will be used as the adaptive scoring rules. If it isn't present,
20655 or is something other than @code{t} or @code{ignore}, the default
20656 adaptive scoring rules will be used. If you want to use adaptive
20657 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
20658 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
20659 not want adaptive scoring. If you only want adaptive scoring in a few
20660 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
20661 insert @code{(adapt t)} in the score files of the groups where you want
20665 All adaptive score entries will go to the file named by this entry. It
20666 will also be applied when entering the group. This atom might be handy
20667 if you want to adapt on several groups at once, using the same adaptive
20668 file for a number of groups.
20671 @cindex local variables
20672 The value of this entry should be a list of @code{(@var{var}
20673 @var{value})} pairs. Each @var{var} will be made buffer-local to the
20674 current summary buffer, and set to the value specified. This is a
20675 convenient, if somewhat strange, way of setting variables in some
20676 groups if you don't like hooks much. Note that the @var{value} won't
20681 @node Score File Editing
20682 @section Score File Editing
20684 You normally enter all scoring commands from the summary buffer, but you
20685 might feel the urge to edit them by hand as well, so we've supplied you
20686 with a mode for that.
20688 It's simply a slightly customized @code{emacs-lisp} mode, with these
20689 additional commands:
20694 @kindex C-c C-c (Score)
20695 @findex gnus-score-edit-done
20696 Save the changes you have made and return to the summary buffer
20697 (@code{gnus-score-edit-done}).
20700 @kindex C-c C-d (Score)
20701 @findex gnus-score-edit-insert-date
20702 Insert the current date in numerical format
20703 (@code{gnus-score-edit-insert-date}). This is really the day number, if
20704 you were wondering.
20707 @kindex C-c C-p (Score)
20708 @findex gnus-score-pretty-print
20709 The adaptive score files are saved in an unformatted fashion. If you
20710 intend to read one of these files, you want to @dfn{pretty print} it
20711 first. This command (@code{gnus-score-pretty-print}) does that for
20716 Type @kbd{M-x gnus-score-mode} to use this mode.
20718 @vindex gnus-score-mode-hook
20719 @code{gnus-score-menu-hook} is run in score mode buffers.
20721 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
20722 @kbd{V t} to begin editing score files.
20725 @node Adaptive Scoring
20726 @section Adaptive Scoring
20727 @cindex adaptive scoring
20729 If all this scoring is getting you down, Gnus has a way of making it all
20730 happen automatically---as if by magic. Or rather, as if by artificial
20731 stupidity, to be precise.
20733 @vindex gnus-use-adaptive-scoring
20734 When you read an article, or mark an article as read, or kill an
20735 article, you leave marks behind. On exit from the group, Gnus can sniff
20736 these marks and add score elements depending on what marks it finds.
20737 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
20738 @code{t} or @code{(line)}. If you want score adaptively on separate
20739 words appearing in the subjects, you should set this variable to
20740 @code{(word)}. If you want to use both adaptive methods, set this
20741 variable to @code{(word line)}.
20743 @vindex gnus-default-adaptive-score-alist
20744 To give you complete control over the scoring process, you can customize
20745 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
20746 might look something like this:
20749 (setq gnus-default-adaptive-score-alist
20750 '((gnus-unread-mark)
20751 (gnus-ticked-mark (from 4))
20752 (gnus-dormant-mark (from 5))
20753 (gnus-del-mark (from -4) (subject -1))
20754 (gnus-read-mark (from 4) (subject 2))
20755 (gnus-expirable-mark (from -1) (subject -1))
20756 (gnus-killed-mark (from -1) (subject -3))
20757 (gnus-kill-file-mark)
20758 (gnus-ancient-mark)
20759 (gnus-low-score-mark)
20760 (gnus-catchup-mark (from -1) (subject -1))))
20763 As you see, each element in this alist has a mark as a key (either a
20764 variable name or a ``real'' mark---a character). Following this key is
20765 a arbitrary number of header/score pairs. If there are no header/score
20766 pairs following the key, no adaptive scoring will be done on articles
20767 that have that key as the article mark. For instance, articles with
20768 @code{gnus-unread-mark} in the example above will not get adaptive score
20771 Each article can have only one mark, so just a single of these rules
20772 will be applied to each article.
20774 To take @code{gnus-del-mark} as an example---this alist says that all
20775 articles that have that mark (i.e., are marked with @samp{e}) will have a
20776 score entry added to lower based on the @code{From} header by -4, and
20777 lowered by @code{Subject} by -1. Change this to fit your prejudices.
20779 If you have marked 10 articles with the same subject with
20780 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
20781 That means that that subject will get a score of ten times -1, which
20782 should be, unless I'm much mistaken, -10.
20784 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
20785 the read articles will be marked with the @samp{E} mark. This'll
20786 probably make adaptive scoring slightly impossible, so auto-expiring and
20787 adaptive scoring doesn't really mix very well.
20789 The headers you can score on are @code{from}, @code{subject},
20790 @code{message-id}, @code{references}, @code{xref}, @code{lines},
20791 @code{chars} and @code{date}. In addition, you can score on
20792 @code{followup}, which will create an adaptive score entry that matches
20793 on the @code{References} header using the @code{Message-ID} of the
20794 current article, thereby matching the following thread.
20796 If you use this scheme, you should set the score file atom @code{mark}
20797 to something small---like -300, perhaps, to avoid having small random
20798 changes result in articles getting marked as read.
20800 After using adaptive scoring for a week or so, Gnus should start to
20801 become properly trained and enhance the authors you like best, and kill
20802 the authors you like least, without you having to say so explicitly.
20804 You can control what groups the adaptive scoring is to be performed on
20805 by using the score files (@pxref{Score File Format}). This will also
20806 let you use different rules in different groups.
20808 @vindex gnus-adaptive-file-suffix
20809 The adaptive score entries will be put into a file where the name is the
20810 group name with @code{gnus-adaptive-file-suffix} appended. The default
20813 @vindex gnus-adaptive-pretty-print
20814 Adaptive score files can get huge and are not meant to be edited by
20815 human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the
20816 deafult) those files will not be written in a human readable way.
20818 @vindex gnus-score-exact-adapt-limit
20819 When doing adaptive scoring, substring or fuzzy matching would probably
20820 give you the best results in most cases. However, if the header one
20821 matches is short, the possibility for false positives is great, so if
20822 the length of the match is less than
20823 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
20824 this variable is @code{nil}, exact matching will always be used to avoid
20827 @vindex gnus-default-adaptive-word-score-alist
20828 As mentioned above, you can adapt either on individual words or entire
20829 headers. If you adapt on words, the
20830 @code{gnus-default-adaptive-word-score-alist} variable says what score
20831 each instance of a word should add given a mark.
20834 (setq gnus-default-adaptive-word-score-alist
20835 `((,gnus-read-mark . 30)
20836 (,gnus-catchup-mark . -10)
20837 (,gnus-killed-mark . -20)
20838 (,gnus-del-mark . -15)))
20841 This is the default value. If you have adaption on words enabled, every
20842 word that appears in subjects of articles marked with
20843 @code{gnus-read-mark} will result in a score rule that increase the
20844 score with 30 points.
20846 @vindex gnus-default-ignored-adaptive-words
20847 @vindex gnus-ignored-adaptive-words
20848 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
20849 will be ignored. If you wish to add more words to be ignored, use the
20850 @code{gnus-ignored-adaptive-words} list instead.
20852 @vindex gnus-adaptive-word-length-limit
20853 Some may feel that short words shouldn't count when doing adaptive
20854 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
20855 an integer. Words shorter than this number will be ignored. This
20856 variable defaults to @code{nil}.
20858 @vindex gnus-adaptive-word-syntax-table
20859 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
20860 syntax table in effect. It is similar to the standard syntax table, but
20861 it considers numbers to be non-word-constituent characters.
20863 @vindex gnus-adaptive-word-minimum
20864 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
20865 word scoring process will never bring down the score of an article to
20866 below this number. The default is @code{nil}.
20868 @vindex gnus-adaptive-word-no-group-words
20869 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
20870 won't adaptively word score any of the words in the group name. Useful
20871 for groups like @samp{comp.editors.emacs}, where most of the subject
20872 lines contain the word @samp{emacs}.
20874 After using this scheme for a while, it might be nice to write a
20875 @code{gnus-psychoanalyze-user} command to go through the rules and see
20876 what words you like and what words you don't like. Or perhaps not.
20878 Note that the adaptive word scoring thing is highly experimental and is
20879 likely to change in the future. Initial impressions seem to indicate
20880 that it's totally useless as it stands. Some more work (involving more
20881 rigorous statistical methods) will have to be done to make this useful.
20884 @node Home Score File
20885 @section Home Score File
20887 The score file where new score file entries will go is called the
20888 @dfn{home score file}. This is normally (and by default) the score file
20889 for the group itself. For instance, the home score file for
20890 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
20892 However, this may not be what you want. It is often convenient to share
20893 a common home score file among many groups---all @samp{emacs} groups
20894 could perhaps use the same home score file.
20896 @vindex gnus-home-score-file
20897 The variable that controls this is @code{gnus-home-score-file}. It can
20902 A string. Then this file will be used as the home score file for all
20906 A function. The result of this function will be used as the home score
20907 file. The function will be called with the name of the group as the
20911 A list. The elements in this list can be:
20915 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
20916 group name, the @var{file-name} will be used as the home score file.
20919 A function. If the function returns non-@code{nil}, the result will
20920 be used as the home score file. The function will be called with the
20921 name of the group as the parameter.
20924 A string. Use the string as the home score file.
20927 The list will be traversed from the beginning towards the end looking
20932 So, if you want to use just a single score file, you could say:
20935 (setq gnus-home-score-file
20936 "my-total-score-file.SCORE")
20939 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
20940 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
20942 @findex gnus-hierarchial-home-score-file
20944 (setq gnus-home-score-file
20945 'gnus-hierarchial-home-score-file)
20948 This is a ready-made function provided for your convenience.
20949 Other functions include
20952 @item gnus-current-home-score-file
20953 @findex gnus-current-home-score-file
20954 Return the ``current'' regular score file. This will make scoring
20955 commands add entry to the ``innermost'' matching score file.
20959 If you want to have one score file for the @samp{emacs} groups and
20960 another for the @samp{comp} groups, while letting all other groups use
20961 their own home score files:
20964 (setq gnus-home-score-file
20965 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
20966 '(("\\.emacs" "emacs.SCORE")
20967 ;; @r{All the comp groups in one score file}
20968 ("^comp" "comp.SCORE")))
20971 @vindex gnus-home-adapt-file
20972 @code{gnus-home-adapt-file} works exactly the same way as
20973 @code{gnus-home-score-file}, but says what the home adaptive score file
20974 is instead. All new adaptive file entries will go into the file
20975 specified by this variable, and the same syntax is allowed.
20977 In addition to using @code{gnus-home-score-file} and
20978 @code{gnus-home-adapt-file}, you can also use group parameters
20979 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
20980 Parameters}) to achieve much the same. Group and topic parameters take
20981 precedence over this variable.
20984 @node Followups To Yourself
20985 @section Followups To Yourself
20987 Gnus offers two commands for picking out the @code{Message-ID} header in
20988 the current buffer. Gnus will then add a score rule that scores using
20989 this @code{Message-ID} on the @code{References} header of other
20990 articles. This will, in effect, increase the score of all articles that
20991 respond to the article in the current buffer. Quite useful if you want
20992 to easily note when people answer what you've said.
20996 @item gnus-score-followup-article
20997 @findex gnus-score-followup-article
20998 This will add a score to articles that directly follow up your own
21001 @item gnus-score-followup-thread
21002 @findex gnus-score-followup-thread
21003 This will add a score to all articles that appear in a thread ``below''
21007 @vindex message-sent-hook
21008 These two functions are both primarily meant to be used in hooks like
21009 @code{message-sent-hook}, like this:
21011 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
21015 If you look closely at your own @code{Message-ID}, you'll notice that
21016 the first two or three characters are always the same. Here's two of
21020 <x6u3u47icf.fsf@@eyesore.no>
21021 <x6sp9o7ibw.fsf@@eyesore.no>
21024 So ``my'' ident on this machine is @samp{x6}. This can be
21025 exploited---the following rule will raise the score on all followups to
21030 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
21034 Whether it's the first two or first three characters that are ``yours''
21035 is system-dependent.
21038 @node Scoring On Other Headers
21039 @section Scoring On Other Headers
21040 @cindex scoring on other headers
21042 Gnus is quite fast when scoring the ``traditional''
21043 headers---@samp{From}, @samp{Subject} and so on. However, scoring
21044 other headers requires writing a @code{head} scoring rule, which means
21045 that Gnus has to request every single article from the back end to find
21046 matches. This takes a long time in big groups.
21048 Now, there's not much you can do about this for news groups, but for
21049 mail groups, you have greater control. In @ref{To From Newsgroups},
21050 it's explained in greater detail what this mechanism does, but here's
21051 a cookbook example for @code{nnml} on how to allow scoring on the
21052 @samp{To} and @samp{Cc} headers.
21054 Put the following in your @file{~/.gnus.el} file.
21057 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
21058 nnmail-extra-headers gnus-extra-headers)
21061 Restart Gnus and rebuild your @code{nnml} overview files with the
21062 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
21063 time if you have much mail.
21065 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
21066 so: @kbd{I e s p To RET <your name> RET}.
21070 @vindex gnus-inhibit-slow-scoring
21071 You can inhibit scoring the slow scoring on headers or body by setting
21072 the variable @code{gnus-inhibit-slow-scoring}. If
21073 @code{gnus-inhibit-slow-scoring} is regexp, slow scoring is inhibited if
21074 the group matches the regexp. If it is t, slow scoring on it is
21075 inhibited for all groups.
21079 @section Scoring Tips
21080 @cindex scoring tips
21086 @cindex scoring crossposts
21087 If you want to lower the score of crossposts, the line to match on is
21088 the @code{Xref} header.
21090 ("xref" (" talk.politics.misc:" -1000))
21093 @item Multiple crossposts
21094 If you want to lower the score of articles that have been crossposted to
21095 more than, say, 3 groups:
21098 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
21102 @item Matching on the body
21103 This is generally not a very good idea---it takes a very long time.
21104 Gnus actually has to fetch each individual article from the server. But
21105 you might want to anyway, I guess. Even though there are three match
21106 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
21107 and stick with it in each score file. If you use any two, each article
21108 will be fetched @emph{twice}. If you want to match a bit on the
21109 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
21112 @item Marking as read
21113 You will probably want to mark articles that have scores below a certain
21114 number as read. This is most easily achieved by putting the following
21115 in your @file{all.SCORE} file:
21119 You may also consider doing something similar with @code{expunge}.
21121 @item Negated character classes
21122 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
21123 That will match newlines, which might lead to, well, The Unknown. Say
21124 @code{[^abcd\n]*} instead.
21128 @node Reverse Scoring
21129 @section Reverse Scoring
21130 @cindex reverse scoring
21132 If you want to keep just articles that have @samp{Sex with Emacs} in the
21133 subject header, and expunge all other articles, you could put something
21134 like this in your score file:
21138 ("Sex with Emacs" 2))
21143 So, you raise all articles that match @samp{Sex with Emacs} and mark the
21144 rest as read, and expunge them to boot.
21147 @node Global Score Files
21148 @section Global Score Files
21149 @cindex global score files
21151 Sure, other newsreaders have ``global kill files''. These are usually
21152 nothing more than a single kill file that applies to all groups, stored
21153 in the user's home directory. Bah! Puny, weak newsreaders!
21155 What I'm talking about here are Global Score Files. Score files from
21156 all over the world, from users everywhere, uniting all nations in one
21157 big, happy score file union! Ange-score! New and untested!
21159 @vindex gnus-global-score-files
21160 All you have to do to use other people's score files is to set the
21161 @code{gnus-global-score-files} variable. One entry for each score file,
21162 or each score file directory. Gnus will decide by itself what score
21163 files are applicable to which group.
21165 To use the score file
21166 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
21167 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
21171 (setq gnus-global-score-files
21172 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
21173 "/ftp@@ftp.some-where:/pub/score/"))
21176 @findex gnus-score-search-global-directories
21178 Simple, eh? Directory names must end with a @samp{/}. These
21179 directories are typically scanned only once during each Gnus session.
21180 If you feel the need to manually re-scan the remote directories, you can
21181 use the @code{gnus-score-search-global-directories} command.
21183 Note that, at present, using this option will slow down group entry
21184 somewhat. (That is---a lot.)
21186 If you want to start maintaining score files for other people to use,
21187 just put your score file up for anonymous ftp and announce it to the
21188 world. Become a retro-moderator! Participate in the retro-moderator
21189 wars sure to ensue, where retro-moderators battle it out for the
21190 sympathy of the people, luring them to use their score files on false
21191 premises! Yay! The net is saved!
21193 Here are some tips for the would-be retro-moderator, off the top of my
21199 Articles heavily crossposted are probably junk.
21201 To lower a single inappropriate article, lower by @code{Message-ID}.
21203 Particularly brilliant authors can be raised on a permanent basis.
21205 Authors that repeatedly post off-charter for the group can safely be
21206 lowered out of existence.
21208 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
21209 articles completely.
21212 Use expiring score entries to keep the size of the file down. You
21213 should probably have a long expiry period, though, as some sites keep
21214 old articles for a long time.
21217 @dots{} I wonder whether other newsreaders will support global score files
21218 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
21219 Wave, xrn and 1stReader are bound to implement scoring. Should we start
21220 holding our breath yet?
21224 @section Kill Files
21227 Gnus still supports those pesky old kill files. In fact, the kill file
21228 entries can now be expiring, which is something I wrote before Daniel
21229 Quinlan thought of doing score files, so I've left the code in there.
21231 In short, kill processing is a lot slower (and I do mean @emph{a lot})
21232 than score processing, so it might be a good idea to rewrite your kill
21233 files into score files.
21235 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
21236 forms into this file, which means that you can use kill files as some
21237 sort of primitive hook function to be run on group entry, even though
21238 that isn't a very good idea.
21240 Normal kill files look like this:
21243 (gnus-kill "From" "Lars Ingebrigtsen")
21244 (gnus-kill "Subject" "ding")
21248 This will mark every article written by me as read, and remove the
21249 marked articles from the summary buffer. Very useful, you'll agree.
21251 Other programs use a totally different kill file syntax. If Gnus
21252 encounters what looks like a @code{rn} kill file, it will take a stab at
21255 Two summary functions for editing a @sc{gnus} kill file:
21260 @kindex M-k (Summary)
21261 @findex gnus-summary-edit-local-kill
21262 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
21265 @kindex M-K (Summary)
21266 @findex gnus-summary-edit-global-kill
21267 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
21270 Two group mode functions for editing the kill files:
21275 @kindex M-k (Group)
21276 @findex gnus-group-edit-local-kill
21277 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
21280 @kindex M-K (Group)
21281 @findex gnus-group-edit-global-kill
21282 Edit the general kill file (@code{gnus-group-edit-global-kill}).
21285 Kill file variables:
21288 @item gnus-kill-file-name
21289 @vindex gnus-kill-file-name
21290 A kill file for the group @samp{soc.motss} is normally called
21291 @file{soc.motss.KILL}. The suffix appended to the group name to get
21292 this file name is detailed by the @code{gnus-kill-file-name} variable.
21293 The ``global'' kill file (not in the score file sense of ``global'', of
21294 course) is just called @file{KILL}.
21296 @vindex gnus-kill-save-kill-file
21297 @item gnus-kill-save-kill-file
21298 If this variable is non-@code{nil}, Gnus will save the
21299 kill file after processing, which is necessary if you use expiring
21302 @item gnus-apply-kill-hook
21303 @vindex gnus-apply-kill-hook
21304 @findex gnus-apply-kill-file-unless-scored
21305 @findex gnus-apply-kill-file
21306 A hook called to apply kill files to a group. It is
21307 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
21308 kill file if you have a score file for the same group, you can set this
21309 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
21310 kill files to be processed, you should set this variable to @code{nil}.
21312 @item gnus-kill-file-mode-hook
21313 @vindex gnus-kill-file-mode-hook
21314 A hook called in kill-file mode buffers.
21319 @node Converting Kill Files
21320 @section Converting Kill Files
21322 @cindex converting kill files
21324 If you have loads of old kill files, you may want to convert them into
21325 score files. If they are ``regular'', you can use
21326 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
21329 The kill to score conversion package isn't included in Gnus by default.
21330 You can fetch it from
21331 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
21333 If your old kill files are very complex---if they contain more
21334 non-@code{gnus-kill} forms than not, you'll have to convert them by
21335 hand. Or just let them be as they are. Gnus will still use them as
21339 @node Advanced Scoring
21340 @section Advanced Scoring
21342 Scoring on Subjects and From headers is nice enough, but what if you're
21343 really interested in what a person has to say only when she's talking
21344 about a particular subject? Or what if you really don't want to
21345 read what person A has to say when she's following up to person B, but
21346 want to read what she says when she's following up to person C?
21348 By using advanced scoring rules you may create arbitrarily complex
21352 * Advanced Scoring Syntax:: A definition.
21353 * Advanced Scoring Examples:: What they look like.
21354 * Advanced Scoring Tips:: Getting the most out of it.
21358 @node Advanced Scoring Syntax
21359 @subsection Advanced Scoring Syntax
21361 Ordinary scoring rules have a string as the first element in the rule.
21362 Advanced scoring rules have a list as the first element. The second
21363 element is the score to be applied if the first element evaluated to a
21364 non-@code{nil} value.
21366 These lists may consist of three logical operators, one redirection
21367 operator, and various match operators.
21374 This logical operator will evaluate each of its arguments until it finds
21375 one that evaluates to @code{false}, and then it'll stop. If all arguments
21376 evaluate to @code{true} values, then this operator will return
21381 This logical operator will evaluate each of its arguments until it finds
21382 one that evaluates to @code{true}. If no arguments are @code{true},
21383 then this operator will return @code{false}.
21388 This logical operator only takes a single argument. It returns the
21389 logical negation of the value of its argument.
21393 There is an @dfn{indirection operator} that will make its arguments
21394 apply to the ancestors of the current article being scored. For
21395 instance, @code{1-} will make score rules apply to the parent of the
21396 current article. @code{2-} will make score rules apply to the
21397 grandparent of the current article. Alternatively, you can write
21398 @code{^^}, where the number of @code{^}s (carets) says how far back into
21399 the ancestry you want to go.
21401 Finally, we have the match operators. These are the ones that do the
21402 real work. Match operators are header name strings followed by a match
21403 and a match type. A typical match operator looks like @samp{("from"
21404 "Lars Ingebrigtsen" s)}. The header names are the same as when using
21405 simple scoring, and the match types are also the same.
21408 @node Advanced Scoring Examples
21409 @subsection Advanced Scoring Examples
21411 Please note that the following examples are score file rules. To
21412 make a complete score file from them, surround them with another pair
21415 Let's say you want to increase the score of articles written by Lars
21416 when he's talking about Gnus:
21421 ("from" "Lars Ingebrigtsen")
21422 ("subject" "Gnus"))
21429 When he writes long articles, he sometimes has something nice to say:
21433 ("from" "Lars Ingebrigtsen")
21440 However, when he responds to things written by Reig Eigil Logge, you
21441 really don't want to read what he's written:
21445 ("from" "Lars Ingebrigtsen")
21446 (1- ("from" "Reig Eigil Logge")))
21450 Everybody that follows up Redmondo when he writes about disappearing
21451 socks should have their scores raised, but only when they talk about
21452 white socks. However, when Lars talks about socks, it's usually not
21459 ("from" "redmondo@@.*no" r)
21460 ("body" "disappearing.*socks" t)))
21461 (! ("from" "Lars Ingebrigtsen"))
21462 ("body" "white.*socks"))
21466 Suppose you're reading a high volume group and you're only interested
21467 in replies. The plan is to score down all articles that don't have
21468 subject that begin with "Re:", "Fw:" or "Fwd:" and then score up all
21469 parents of articles that have subjects that begin with reply marks.
21472 ((! ("subject" "re:\\|fwd?:" r))
21474 ((1- ("subject" "re:\\|fwd?:" r))
21478 The possibilities are endless.
21480 @node Advanced Scoring Tips
21481 @subsection Advanced Scoring Tips
21483 The @code{&} and @code{|} logical operators do short-circuit logic.
21484 That is, they stop processing their arguments when it's clear what the
21485 result of the operation will be. For instance, if one of the arguments
21486 of an @code{&} evaluates to @code{false}, there's no point in evaluating
21487 the rest of the arguments. This means that you should put slow matches
21488 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
21489 @samp{subject}) first.
21491 The indirection arguments (@code{1-} and so on) will make their
21492 arguments work on previous generations of the thread. If you say
21503 Then that means ``score on the from header of the grandparent of the
21504 current article''. An indirection is quite fast, but it's better to say:
21510 ("subject" "Gnus")))
21517 (1- ("from" "Lars"))
21518 (1- ("subject" "Gnus")))
21523 @section Score Decays
21524 @cindex score decays
21527 You may find that your scores have a tendency to grow without
21528 bounds, especially if you're using adaptive scoring. If scores get too
21529 big, they lose all meaning---they simply max out and it's difficult to
21530 use them in any sensible way.
21532 @vindex gnus-decay-scores
21533 @findex gnus-decay-score
21534 @vindex gnus-decay-score-function
21535 Gnus provides a mechanism for decaying scores to help with this problem.
21536 When score files are loaded and @code{gnus-decay-scores} is
21537 non-@code{nil}, Gnus will run the score files through the decaying
21538 mechanism thereby lowering the scores of all non-permanent score rules.
21539 If @code{gnus-decay-scores} is a regexp, only score files matching this
21540 regexp are treated. E.g. you may set it to @samp{\\.ADAPT\\'} if only
21541 @emph{adaptive} score files should be decayed. The decay itself if
21542 performed by the @code{gnus-decay-score-function} function, which is
21543 @code{gnus-decay-score} by default. Here's the definition of that
21547 (defun gnus-decay-score (score)
21548 "Decay SCORE according to `gnus-score-decay-constant'
21549 and `gnus-score-decay-scale'."
21551 (* (if (< score 0) -1 1)
21553 (max gnus-score-decay-constant
21555 gnus-score-decay-scale)))))))
21556 (if (and (featurep 'xemacs)
21557 ;; XEmacs' floor can handle only the floating point
21558 ;; number below the half of the maximum integer.
21559 (> (abs n) (lsh -1 -2)))
21561 (car (split-string (number-to-string n) "\\.")))
21565 @vindex gnus-score-decay-scale
21566 @vindex gnus-score-decay-constant
21567 @code{gnus-score-decay-constant} is 3 by default and
21568 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
21572 Scores between -3 and 3 will be set to 0 when this function is called.
21575 Scores with magnitudes between 3 and 60 will be shrunk by 3.
21578 Scores with magnitudes greater than 60 will be shrunk by 5% of the
21582 If you don't like this decay function, write your own. It is called
21583 with the score to be decayed as its only parameter, and it should return
21584 the new score, which should be an integer.
21586 Gnus will try to decay scores once a day. If you haven't run Gnus for
21587 four days, Gnus will decay the scores four times, for instance.
21592 @include message.texi
21593 @chapter Emacs MIME
21594 @include emacs-mime.texi
21596 @include sieve.texi
21608 * Process/Prefix:: A convention used by many treatment commands.
21609 * Interactive:: Making Gnus ask you many questions.
21610 * Symbolic Prefixes:: How to supply some Gnus functions with options.
21611 * Formatting Variables:: You can specify what buffers should look like.
21612 * Window Layout:: Configuring the Gnus buffer windows.
21613 * Faces and Fonts:: How to change how faces look.
21614 * Compilation:: How to speed Gnus up.
21615 * Mode Lines:: Displaying information in the mode lines.
21616 * Highlighting and Menus:: Making buffers look all nice and cozy.
21617 * Buttons:: Get tendinitis in ten easy steps!
21618 * Daemons:: Gnus can do things behind your back.
21619 * NoCeM:: How to avoid spam and other fatty foods.
21620 * Undo:: Some actions can be undone.
21621 * Predicate Specifiers:: Specifying predicates.
21622 * Moderation:: What to do if you're a moderator.
21623 * Fetching a Group:: Starting Gnus just to read a group.
21624 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
21625 * Fuzzy Matching:: What's the big fuzz?
21626 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
21627 * Spam Package:: A package for filtering and processing spam.
21628 * Other modes:: Interaction with other modes.
21629 * Various Various:: Things that are really various.
21633 @node Process/Prefix
21634 @section Process/Prefix
21635 @cindex process/prefix convention
21637 Many functions, among them functions for moving, decoding and saving
21638 articles, use what is known as the @dfn{Process/Prefix convention}.
21640 This is a method for figuring out what articles the user wants the
21641 command to be performed on.
21645 If the numeric prefix is N, perform the operation on the next N
21646 articles, starting with the current one. If the numeric prefix is
21647 negative, perform the operation on the previous N articles, starting
21648 with the current one.
21650 @vindex transient-mark-mode
21651 If @code{transient-mark-mode} in non-@code{nil} and the region is
21652 active, all articles in the region will be worked upon.
21654 If there is no numeric prefix, but some articles are marked with the
21655 process mark, perform the operation on the articles marked with
21658 If there is neither a numeric prefix nor any articles marked with the
21659 process mark, just perform the operation on the current article.
21661 Quite simple, really, but it needs to be made clear so that surprises
21664 Commands that react to the process mark will push the current list of
21665 process marked articles onto a stack and will then clear all process
21666 marked articles. You can restore the previous configuration with the
21667 @kbd{M P y} command (@pxref{Setting Process Marks}).
21669 @vindex gnus-summary-goto-unread
21670 One thing that seems to shock & horrify lots of people is that, for
21671 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
21672 Since each @kbd{d} (which marks the current article as read) by default
21673 goes to the next unread article after marking, this means that @kbd{3 d}
21674 will mark the next three unread articles as read, no matter what the
21675 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
21676 @code{nil} for a more straightforward action.
21678 Many commands do not use the process/prefix convention. All commands
21679 that do explicitly say so in this manual. To apply the process/prefix
21680 convention to commands that do not use it, you can use the @kbd{M-&}
21681 command. For instance, to mark all the articles in the group as
21682 expirable, you could say @kbd{M P b M-& E}.
21686 @section Interactive
21687 @cindex interaction
21691 @item gnus-novice-user
21692 @vindex gnus-novice-user
21693 If this variable is non-@code{nil}, you are either a newcomer to the
21694 World of Usenet, or you are very cautious, which is a nice thing to be,
21695 really. You will be given questions of the type ``Are you sure you want
21696 to do this?'' before doing anything dangerous. This is @code{t} by
21699 @item gnus-expert-user
21700 @vindex gnus-expert-user
21701 If this variable is non-@code{nil}, you will seldom be asked any
21702 questions by Gnus. It will simply assume you know what you're doing, no
21703 matter how strange.
21705 @item gnus-interactive-catchup
21706 @vindex gnus-interactive-catchup
21707 Require confirmation before catching up a group if non-@code{nil}. It
21708 is @code{t} by default.
21710 @item gnus-interactive-exit
21711 @vindex gnus-interactive-exit
21712 Require confirmation before exiting Gnus. This variable is @code{t} by
21717 @node Symbolic Prefixes
21718 @section Symbolic Prefixes
21719 @cindex symbolic prefixes
21721 Quite a lot of Emacs commands react to the (numeric) prefix. For
21722 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
21723 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
21724 rule of 900 to the current article.
21726 This is all nice and well, but what if you want to give a command some
21727 additional information? Well, what most commands do is interpret the
21728 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
21729 doesn't want a backup file to be created when saving the current buffer,
21730 for instance. But what if you want to save without making a backup
21731 file, and you want Emacs to flash lights and play a nice tune at the
21732 same time? You can't, and you're probably perfectly happy that way.
21734 @kindex M-i (Summary)
21735 @findex gnus-symbolic-argument
21736 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
21737 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
21738 character typed in is the value. You can stack as many @kbd{M-i}
21739 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
21740 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
21741 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
21742 @code{b}''. You get the drift.
21744 Typing in symbolic prefixes to commands that don't accept them doesn't
21745 hurt, but it doesn't do any good either. Currently not many Gnus
21746 functions make use of the symbolic prefix.
21748 If you're interested in how Gnus implements this, @pxref{Extended
21752 @node Formatting Variables
21753 @section Formatting Variables
21754 @cindex formatting variables
21756 Throughout this manual you've probably noticed lots of variables called
21757 things like @code{gnus-group-line-format} and
21758 @code{gnus-summary-mode-line-format}. These control how Gnus is to
21759 output lines in the various buffers. There's quite a lot of them.
21760 Fortunately, they all use the same syntax, so there's not that much to
21763 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
21764 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
21765 lots of percentages everywhere.
21768 * Formatting Basics:: A formatting variable is basically a format string.
21769 * Mode Line Formatting:: Some rules about mode line formatting variables.
21770 * Advanced Formatting:: Modifying output in various ways.
21771 * User-Defined Specs:: Having Gnus call your own functions.
21772 * Formatting Fonts:: Making the formatting look colorful and nice.
21773 * Positioning Point:: Moving point to a position after an operation.
21774 * Tabulation:: Tabulating your output.
21775 * Wide Characters:: Dealing with wide characters.
21778 Currently Gnus uses the following formatting variables:
21779 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
21780 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
21781 @code{gnus-group-mode-line-format},
21782 @code{gnus-summary-mode-line-format},
21783 @code{gnus-article-mode-line-format},
21784 @code{gnus-server-mode-line-format}, and
21785 @code{gnus-summary-pick-line-format}.
21787 All these format variables can also be arbitrary elisp forms. In that
21788 case, they will be @code{eval}ed to insert the required lines.
21790 @kindex M-x gnus-update-format
21791 @findex gnus-update-format
21792 Gnus includes a command to help you while creating your own format
21793 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
21794 update the spec in question and pop you to a buffer where you can
21795 examine the resulting Lisp code to be run to generate the line.
21799 @node Formatting Basics
21800 @subsection Formatting Basics
21802 Each @samp{%} element will be replaced by some string or other when the
21803 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
21804 spec, and pad with spaces to get a 5-character field''.
21806 As with normal C and Emacs Lisp formatting strings, the numerical
21807 modifier between the @samp{%} and the formatting type character will
21808 @dfn{pad} the output so that it is always at least that long.
21809 @samp{%5y} will make the field always (at least) five characters wide by
21810 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
21813 You may also wish to limit the length of the field to protect against
21814 particularly wide values. For that you can say @samp{%4,6y}, which
21815 means that the field will never be more than 6 characters wide and never
21816 less than 4 characters wide.
21818 Also Gnus supports some extended format specifications, such as
21819 @samp{%&user-date;}.
21822 @node Mode Line Formatting
21823 @subsection Mode Line Formatting
21825 Mode line formatting variables (e.g.,
21826 @code{gnus-summary-mode-line-format}) follow the same rules as other,
21827 buffer line oriented formatting variables (@pxref{Formatting Basics})
21828 with the following two differences:
21833 There must be no newline (@samp{\n}) at the end.
21836 The special @samp{%%b} spec can be used to display the buffer name.
21837 Well, it's no spec at all, really---@samp{%%} is just a way to quote
21838 @samp{%} to allow it to pass through the formatting machinery unmangled,
21839 so that Emacs receives @samp{%b}, which is something the Emacs mode line
21840 display interprets to mean ``show the buffer name''. For a full list of
21841 mode line specs Emacs understands, see the documentation of the
21842 @code{mode-line-format} variable.
21847 @node Advanced Formatting
21848 @subsection Advanced Formatting
21850 It is frequently useful to post-process the fields in some way.
21851 Padding, limiting, cutting off parts and suppressing certain values can
21852 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
21853 look like @samp{%~(cut 3)~(ignore "0")y}.
21855 These are the valid modifiers:
21860 Pad the field to the left with spaces until it reaches the required
21864 Pad the field to the right with spaces until it reaches the required
21869 Cut off characters from the left until it reaches the specified length.
21872 Cut off characters from the right until it reaches the specified
21877 Cut off the specified number of characters from the left.
21880 Cut off the specified number of characters from the right.
21883 Return an empty string if the field is equal to the specified value.
21886 Use the specified form as the field value when the @samp{@@} spec is
21892 "~(form (current-time-string))@@"
21897 Let's take an example. The @samp{%o} spec in the summary mode lines
21898 will return a date in compact ISO8601 format---@samp{19960809T230410}.
21899 This is quite a mouthful, so we want to shave off the century number and
21900 the time, leaving us with a six-character date. That would be
21901 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
21902 maxing, and we need the padding to ensure that the date is never less
21903 than 6 characters to make it look nice in columns.)
21905 Ignoring is done first; then cutting; then maxing; and then as the very
21906 last operation, padding.
21908 If you use lots of these advanced thingies, you'll find that Gnus gets
21909 quite slow. This can be helped enormously by running @kbd{M-x
21910 gnus-compile} when you are satisfied with the look of your lines.
21911 @xref{Compilation}.
21914 @node User-Defined Specs
21915 @subsection User-Defined Specs
21917 All the specs allow for inserting user defined specifiers---@samp{u}.
21918 The next character in the format string should be a letter. Gnus
21919 will call the function @code{gnus-user-format-function-}@samp{X}, where
21920 @samp{X} is the letter following @samp{%u}. The function will be passed
21921 a single parameter---what the parameter means depends on what buffer
21922 it's being called from. The function should return a string, which will
21923 be inserted into the buffer just like information from any other
21924 specifier. This function may also be called with dummy values, so it
21925 should protect against that.
21927 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
21928 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
21930 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
21931 much the same without defining new functions. Here's an example:
21932 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
21933 given here will be evaluated to yield the current line number, and then
21937 @node Formatting Fonts
21938 @subsection Formatting Fonts
21940 There are specs for highlighting, and these are shared by all the format
21941 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
21942 the special @code{mouse-face} property set, which means that it will be
21943 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
21946 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
21947 normal faces set using @code{gnus-face-0}, which is @code{bold} by
21948 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
21949 and so on. Create as many faces as you wish. The same goes for the
21950 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
21951 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
21953 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
21954 special @code{balloon-help} property set to
21955 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
21956 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
21957 variables should be either strings or symbols naming functions that
21958 return a string. When the mouse passes over text with this property
21959 set, a balloon window will appear and display the string. Please
21960 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
21961 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
21962 XEmacs) for more information on this. (For technical reasons, the
21963 guillemets have been approximated as @samp{<<} and @samp{>>} in this
21966 Here's an alternative recipe for the group buffer:
21969 ;; @r{Create three face types.}
21970 (setq gnus-face-1 'bold)
21971 (setq gnus-face-3 'italic)
21973 ;; @r{We want the article count to be in}
21974 ;; @r{a bold and green face. So we create}
21975 ;; @r{a new face called @code{my-green-bold}.}
21976 (copy-face 'bold 'my-green-bold)
21977 ;; @r{Set the color.}
21978 (set-face-foreground 'my-green-bold "ForestGreen")
21979 (setq gnus-face-2 'my-green-bold)
21981 ;; @r{Set the new & fancy format.}
21982 (setq gnus-group-line-format
21983 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
21986 I'm sure you'll be able to use this scheme to create totally unreadable
21987 and extremely vulgar displays. Have fun!
21989 Note that the @samp{%(} specs (and friends) do not make any sense on the
21990 mode-line variables.
21992 @node Positioning Point
21993 @subsection Positioning Point
21995 Gnus usually moves point to a pre-defined place on each line in most
21996 buffers. By default, point move to the first colon character on the
21997 line. You can customize this behavior in three different ways.
21999 You can move the colon character to somewhere else on the line.
22001 @findex gnus-goto-colon
22002 You can redefine the function that moves the point to the colon. The
22003 function is called @code{gnus-goto-colon}.
22005 But perhaps the most convenient way to deal with this, if you don't want
22006 to have a colon in your line, is to use the @samp{%*} specifier. If you
22007 put a @samp{%*} somewhere in your format line definition, Gnus will
22012 @subsection Tabulation
22014 You can usually line up your displays by padding and cutting your
22015 strings. However, when combining various strings of different size, it
22016 can often be more convenient to just output the strings, and then worry
22017 about lining up the following text afterwards.
22019 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
22020 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
22022 @samp{%50=} will insert space characters to pad the line up to column
22023 50. If the text is already past column 50, nothing will be inserted.
22024 This is the soft tabulator.
22026 @samp{%-50=} will insert space characters to pad the line up to column
22027 50. If the text is already past column 50, the excess text past column
22028 50 will be removed. This is the hard tabulator.
22031 @node Wide Characters
22032 @subsection Wide Characters
22034 Fixed width fonts in most countries have characters of the same width.
22035 Some countries, however, use Latin characters mixed with wider
22036 characters---most notable East Asian countries.
22038 The problem is that when formatting, Gnus assumes that if a string is 10
22039 characters wide, it'll be 10 Latin characters wide on the screen. In
22040 these countries, that's not true.
22042 @vindex gnus-use-correct-string-widths
22043 To help fix this, you can set @code{gnus-use-correct-string-widths} to
22044 @code{t}. This makes buffer generation slower, but the results will be
22045 prettier. The default value under XEmacs is @code{t} but @code{nil}
22049 @node Window Layout
22050 @section Window Layout
22051 @cindex window layout
22053 No, there's nothing here about X, so be quiet.
22055 @vindex gnus-use-full-window
22056 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
22057 other windows and occupy the entire Emacs screen by itself. It is
22058 @code{t} by default.
22060 Setting this variable to @code{nil} kinda works, but there are
22061 glitches. Use at your own peril.
22063 @vindex gnus-buffer-configuration
22064 @code{gnus-buffer-configuration} describes how much space each Gnus
22065 buffer should be given. Here's an excerpt of this variable:
22068 ((group (vertical 1.0 (group 1.0 point)
22069 (if gnus-carpal (group-carpal 4))))
22070 (article (vertical 1.0 (summary 0.25 point)
22074 This is an alist. The @dfn{key} is a symbol that names some action or
22075 other. For instance, when displaying the group buffer, the window
22076 configuration function will use @code{group} as the key. A full list of
22077 possible names is listed below.
22079 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
22080 should occupy. To take the @code{article} split as an example -
22083 (article (vertical 1.0 (summary 0.25 point)
22087 This @dfn{split} says that the summary buffer should occupy 25% of upper
22088 half of the screen, and that it is placed over the article buffer. As
22089 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
22090 reaching for that calculator there). However, the special number
22091 @code{1.0} is used to signal that this buffer should soak up all the
22092 rest of the space available after the rest of the buffers have taken
22093 whatever they need. There should be only one buffer with the @code{1.0}
22094 size spec per split.
22096 Point will be put in the buffer that has the optional third element
22097 @code{point}. In a @code{frame} split, the last subsplit having a leaf
22098 split where the tag @code{frame-focus} is a member (i.e. is the third or
22099 fourth element in the list, depending on whether the @code{point} tag is
22100 present) gets focus.
22102 Here's a more complicated example:
22105 (article (vertical 1.0 (group 4)
22106 (summary 0.25 point)
22107 (if gnus-carpal (summary-carpal 4))
22111 If the size spec is an integer instead of a floating point number,
22112 then that number will be used to say how many lines a buffer should
22113 occupy, not a percentage.
22115 If the @dfn{split} looks like something that can be @code{eval}ed (to be
22116 precise---if the @code{car} of the split is a function or a subr), this
22117 split will be @code{eval}ed. If the result is non-@code{nil}, it will
22118 be used as a split. This means that there will be three buffers if
22119 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
22122 Not complicated enough for you? Well, try this on for size:
22125 (article (horizontal 1.0
22130 (summary 0.25 point)
22135 Whoops. Two buffers with the mystery 100% tag. And what's that
22136 @code{horizontal} thingie?
22138 If the first element in one of the split is @code{horizontal}, Gnus will
22139 split the window horizontally, giving you two windows side-by-side.
22140 Inside each of these strips you may carry on all you like in the normal
22141 fashion. The number following @code{horizontal} says what percentage of
22142 the screen is to be given to this strip.
22144 For each split, there @emph{must} be one element that has the 100% tag.
22145 The splitting is never accurate, and this buffer will eat any leftover
22146 lines from the splits.
22148 To be slightly more formal, here's a definition of what a valid split
22153 split = frame | horizontal | vertical | buffer | form
22154 frame = "(frame " size *split ")"
22155 horizontal = "(horizontal " size *split ")"
22156 vertical = "(vertical " size *split ")"
22157 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
22158 size = number | frame-params
22159 buf-name = group | article | summary ...
22163 The limitations are that the @code{frame} split can only appear as the
22164 top-level split. @var{form} should be an Emacs Lisp form that should
22165 return a valid split. We see that each split is fully recursive, and
22166 may contain any number of @code{vertical} and @code{horizontal} splits.
22168 @vindex gnus-window-min-width
22169 @vindex gnus-window-min-height
22170 @cindex window height
22171 @cindex window width
22172 Finding the right sizes can be a bit complicated. No window may be less
22173 than @code{gnus-window-min-height} (default 1) characters high, and all
22174 windows must be at least @code{gnus-window-min-width} (default 1)
22175 characters wide. Gnus will try to enforce this before applying the
22176 splits. If you want to use the normal Emacs window width/height limit,
22177 you can just set these two variables to @code{nil}.
22179 If you're not familiar with Emacs terminology, @code{horizontal} and
22180 @code{vertical} splits may work the opposite way of what you'd expect.
22181 Windows inside a @code{horizontal} split are shown side-by-side, and
22182 windows within a @code{vertical} split are shown above each other.
22184 @findex gnus-configure-frame
22185 If you want to experiment with window placement, a good tip is to call
22186 @code{gnus-configure-frame} directly with a split. This is the function
22187 that does all the real work when splitting buffers. Below is a pretty
22188 nonsensical configuration with 5 windows; two for the group buffer and
22189 three for the article buffer. (I said it was nonsensical.) If you
22190 @code{eval} the statement below, you can get an idea of how that would
22191 look straight away, without going through the normal Gnus channels.
22192 Play with it until you're satisfied, and then use
22193 @code{gnus-add-configuration} to add your new creation to the buffer
22194 configuration list.
22197 (gnus-configure-frame
22201 (article 0.3 point))
22209 You might want to have several frames as well. No prob---just use the
22210 @code{frame} split:
22213 (gnus-configure-frame
22216 (summary 0.25 point frame-focus)
22218 (vertical ((height . 5) (width . 15)
22219 (user-position . t)
22220 (left . -1) (top . 1))
22225 This split will result in the familiar summary/article window
22226 configuration in the first (or ``main'') frame, while a small additional
22227 frame will be created where picons will be shown. As you can see,
22228 instead of the normal @code{1.0} top-level spec, each additional split
22229 should have a frame parameter alist as the size spec.
22230 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
22231 Reference Manual}. Under XEmacs, a frame property list will be
22232 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
22234 The list of all possible keys for @code{gnus-buffer-configuration} can
22235 be found in its default value.
22237 Note that the @code{message} key is used for both
22238 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
22239 it is desirable to distinguish between the two, something like this
22243 (message (horizontal 1.0
22244 (vertical 1.0 (message 1.0 point))
22246 (if (buffer-live-p gnus-summary-buffer)
22251 One common desire for a multiple frame split is to have a separate frame
22252 for composing mail and news while leaving the original frame intact. To
22253 accomplish that, something like the following can be done:
22258 (if (not (buffer-live-p gnus-summary-buffer))
22259 (car (cdr (assoc 'group gnus-buffer-configuration)))
22260 (car (cdr (assoc 'summary gnus-buffer-configuration))))
22261 (vertical ((user-position . t) (top . 1) (left . 1)
22262 (name . "Message"))
22263 (message 1.0 point))))
22266 @findex gnus-add-configuration
22267 Since the @code{gnus-buffer-configuration} variable is so long and
22268 complicated, there's a function you can use to ease changing the config
22269 of a single setting: @code{gnus-add-configuration}. If, for instance,
22270 you want to change the @code{article} setting, you could say:
22273 (gnus-add-configuration
22274 '(article (vertical 1.0
22276 (summary .25 point)
22280 You'd typically stick these @code{gnus-add-configuration} calls in your
22281 @file{~/.gnus.el} file or in some startup hook---they should be run after
22282 Gnus has been loaded.
22284 @vindex gnus-always-force-window-configuration
22285 If all windows mentioned in the configuration are already visible, Gnus
22286 won't change the window configuration. If you always want to force the
22287 ``right'' window configuration, you can set
22288 @code{gnus-always-force-window-configuration} to non-@code{nil}.
22290 If you're using tree displays (@pxref{Tree Display}), and the tree
22291 window is displayed vertically next to another window, you may also want
22292 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
22295 @subsection Example Window Configurations
22299 Narrow left hand side occupied by group buffer. Right hand side split
22300 between summary buffer (top one-sixth) and article buffer (bottom).
22315 (gnus-add-configuration
22318 (vertical 25 (group 1.0))
22320 (summary 0.16 point)
22323 (gnus-add-configuration
22326 (vertical 25 (group 1.0))
22327 (vertical 1.0 (summary 1.0 point)))))
22333 @node Faces and Fonts
22334 @section Faces and Fonts
22339 Fiddling with fonts and faces used to be very difficult, but these days
22340 it is very simple. You simply say @kbd{M-x customize-face}, pick out
22341 the face you want to alter, and alter it via the standard Customize
22346 @section Compilation
22347 @cindex compilation
22348 @cindex byte-compilation
22350 @findex gnus-compile
22352 Remember all those line format specification variables?
22353 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
22354 on. Now, Gnus will of course heed whatever these variables are, but,
22355 unfortunately, changing them will mean a quite significant slow-down.
22356 (The default values of these variables have byte-compiled functions
22357 associated with them, while the user-generated versions do not, of
22360 To help with this, you can run @kbd{M-x gnus-compile} after you've
22361 fiddled around with the variables and feel that you're (kind of)
22362 satisfied. This will result in the new specs being byte-compiled, and
22363 you'll get top speed again. Gnus will save these compiled specs in the
22364 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
22365 this function, though---you should compile them yourself by sticking
22366 them into the @file{~/.gnus.el} file and byte-compiling that file.)
22370 @section Mode Lines
22373 @vindex gnus-updated-mode-lines
22374 @code{gnus-updated-mode-lines} says what buffers should keep their mode
22375 lines updated. It is a list of symbols. Supported symbols include
22376 @code{group}, @code{article}, @code{summary}, @code{server},
22377 @code{browse}, and @code{tree}. If the corresponding symbol is present,
22378 Gnus will keep that mode line updated with information that may be
22379 pertinent. If this variable is @code{nil}, screen refresh may be
22382 @cindex display-time
22384 @vindex gnus-mode-non-string-length
22385 By default, Gnus displays information on the current article in the mode
22386 lines of the summary and article buffers. The information Gnus wishes
22387 to display (e.g. the subject of the article) is often longer than the
22388 mode lines, and therefore have to be cut off at some point. The
22389 @code{gnus-mode-non-string-length} variable says how long the other
22390 elements on the line is (i.e., the non-info part). If you put
22391 additional elements on the mode line (e.g. a clock), you should modify
22394 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
22396 (add-hook 'display-time-hook
22397 (lambda () (setq gnus-mode-non-string-length
22399 (if line-number-mode 5 0)
22400 (if column-number-mode 4 0)
22401 (length display-time-string)))))
22404 If this variable is @code{nil} (which is the default), the mode line
22405 strings won't be chopped off, and they won't be padded either. Note
22406 that the default is unlikely to be desirable, as even the percentage
22407 complete in the buffer may be crowded off the mode line; the user should
22408 configure this variable appropriately for her configuration.
22411 @node Highlighting and Menus
22412 @section Highlighting and Menus
22414 @cindex highlighting
22417 @vindex gnus-visual
22418 The @code{gnus-visual} variable controls most of the Gnus-prettifying
22419 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
22420 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
22423 This variable can be a list of visual properties that are enabled. The
22424 following elements are valid, and are all included by default:
22427 @item group-highlight
22428 Do highlights in the group buffer.
22429 @item summary-highlight
22430 Do highlights in the summary buffer.
22431 @item article-highlight
22432 Do highlights in the article buffer.
22434 Turn on highlighting in all buffers.
22436 Create menus in the group buffer.
22438 Create menus in the summary buffers.
22440 Create menus in the article buffer.
22442 Create menus in the browse buffer.
22444 Create menus in the server buffer.
22446 Create menus in the score buffers.
22448 Create menus in all buffers.
22451 So if you only want highlighting in the article buffer and menus in all
22452 buffers, you could say something like:
22455 (setq gnus-visual '(article-highlight menu))
22458 If you want highlighting only and no menus whatsoever, you'd say:
22461 (setq gnus-visual '(highlight))
22464 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
22465 in all Gnus buffers.
22467 Other general variables that influence the look of all buffers include:
22470 @item gnus-mouse-face
22471 @vindex gnus-mouse-face
22472 This is the face (i.e., font) used for mouse highlighting in Gnus. No
22473 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
22477 There are hooks associated with the creation of all the different menus:
22481 @item gnus-article-menu-hook
22482 @vindex gnus-article-menu-hook
22483 Hook called after creating the article mode menu.
22485 @item gnus-group-menu-hook
22486 @vindex gnus-group-menu-hook
22487 Hook called after creating the group mode menu.
22489 @item gnus-summary-menu-hook
22490 @vindex gnus-summary-menu-hook
22491 Hook called after creating the summary mode menu.
22493 @item gnus-server-menu-hook
22494 @vindex gnus-server-menu-hook
22495 Hook called after creating the server mode menu.
22497 @item gnus-browse-menu-hook
22498 @vindex gnus-browse-menu-hook
22499 Hook called after creating the browse mode menu.
22501 @item gnus-score-menu-hook
22502 @vindex gnus-score-menu-hook
22503 Hook called after creating the score mode menu.
22514 Those new-fangled @dfn{mouse} contraptions is very popular with the
22515 young, hep kids who don't want to learn the proper way to do things
22516 these days. Why, I remember way back in the summer of '89, when I was
22517 using Emacs on a Tops 20 system. Three hundred users on one single
22518 machine, and every user was running Simula compilers. Bah!
22522 @vindex gnus-carpal
22523 Well, you can make Gnus display bufferfuls of buttons you can click to
22524 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
22525 really. Tell the chiropractor I sent you.
22530 @item gnus-carpal-mode-hook
22531 @vindex gnus-carpal-mode-hook
22532 Hook run in all carpal mode buffers.
22534 @item gnus-carpal-button-face
22535 @vindex gnus-carpal-button-face
22536 Face used on buttons.
22538 @item gnus-carpal-header-face
22539 @vindex gnus-carpal-header-face
22540 Face used on carpal buffer headers.
22542 @item gnus-carpal-group-buffer-buttons
22543 @vindex gnus-carpal-group-buffer-buttons
22544 Buttons in the group buffer.
22546 @item gnus-carpal-summary-buffer-buttons
22547 @vindex gnus-carpal-summary-buffer-buttons
22548 Buttons in the summary buffer.
22550 @item gnus-carpal-server-buffer-buttons
22551 @vindex gnus-carpal-server-buffer-buttons
22552 Buttons in the server buffer.
22554 @item gnus-carpal-browse-buffer-buttons
22555 @vindex gnus-carpal-browse-buffer-buttons
22556 Buttons in the browse buffer.
22559 All the @code{buttons} variables are lists. The elements in these list
22560 are either cons cells where the @code{car} contains a text to be displayed and
22561 the @code{cdr} contains a function symbol, or a simple string.
22569 Gnus, being larger than any program ever written (allegedly), does lots
22570 of strange stuff that you may wish to have done while you're not
22571 present. For instance, you may want it to check for new mail once in a
22572 while. Or you may want it to close down all connections to all servers
22573 when you leave Emacs idle. And stuff like that.
22575 Gnus will let you do stuff like that by defining various
22576 @dfn{handlers}. Each handler consists of three elements: A
22577 @var{function}, a @var{time}, and an @var{idle} parameter.
22579 Here's an example of a handler that closes connections when Emacs has
22580 been idle for thirty minutes:
22583 (gnus-demon-close-connections nil 30)
22586 Here's a handler that scans for @acronym{PGP} headers every hour when
22590 (gnus-demon-scan-pgp 60 t)
22593 This @var{time} parameter and that @var{idle} parameter work together
22594 in a strange, but wonderful fashion. Basically, if @var{idle} is
22595 @code{nil}, then the function will be called every @var{time} minutes.
22597 If @var{idle} is @code{t}, then the function will be called after
22598 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
22599 the function will never be called. But once Emacs goes idle, the
22600 function will be called every @var{time} minutes.
22602 If @var{idle} is a number and @var{time} is a number, the function will
22603 be called every @var{time} minutes only when Emacs has been idle for
22604 @var{idle} minutes.
22606 If @var{idle} is a number and @var{time} is @code{nil}, the function
22607 will be called once every time Emacs has been idle for @var{idle}
22610 And if @var{time} is a string, it should look like @samp{07:31}, and
22611 the function will then be called once every day somewhere near that
22612 time. Modified by the @var{idle} parameter, of course.
22614 @vindex gnus-demon-timestep
22615 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
22616 seconds. This is 60 by default. If you change that variable,
22617 all the timings in the handlers will be affected.)
22619 So, if you want to add a handler, you could put something like this in
22620 your @file{~/.gnus.el} file:
22622 @findex gnus-demon-add-handler
22624 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
22627 @findex gnus-demon-add-nocem
22628 @findex gnus-demon-add-scanmail
22629 @findex gnus-demon-add-rescan
22630 @findex gnus-demon-add-scan-timestamps
22631 @findex gnus-demon-add-disconnection
22632 Some ready-made functions to do this have been created:
22633 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
22634 @code{gnus-demon-add-nntp-close-connection},
22635 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
22636 @code{gnus-demon-add-scanmail}. Just put those functions in your
22637 @file{~/.gnus.el} if you want those abilities.
22639 @findex gnus-demon-init
22640 @findex gnus-demon-cancel
22641 @vindex gnus-demon-handlers
22642 If you add handlers to @code{gnus-demon-handlers} directly, you should
22643 run @code{gnus-demon-init} to make the changes take hold. To cancel all
22644 daemons, you can use the @code{gnus-demon-cancel} function.
22646 Note that adding daemons can be pretty naughty if you over do it. Adding
22647 functions that scan all news and mail from all servers every two seconds
22648 is a sure-fire way of getting booted off any respectable system. So
22657 @dfn{Spamming} is posting the same article lots and lots of times.
22658 Spamming is bad. Spamming is evil.
22660 Spamming is usually canceled within a day or so by various anti-spamming
22661 agencies. These agencies usually also send out @dfn{NoCeM} messages.
22662 NoCeM is pronounced ``no see-'em'', and means what the name
22663 implies---these are messages that make the offending articles, like, go
22666 What use are these NoCeM messages if the articles are canceled anyway?
22667 Some sites do not honor cancel messages and some sites just honor cancels
22668 from a select few people. Then you may wish to make use of the NoCeM
22669 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
22671 Gnus can read and parse the messages in this group automatically, and
22672 this will make spam disappear.
22674 There are some variables to customize, of course:
22677 @item gnus-use-nocem
22678 @vindex gnus-use-nocem
22679 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
22682 You can also set this variable to a positive number as a group level.
22683 In that case, Gnus scans NoCeM messages when checking new news if this
22684 value is not exceeding a group level that you specify as the prefix
22685 argument to some commands, e.g. @code{gnus},
22686 @code{gnus-group-get-new-news}, etc. Otherwise, Gnus does not scan
22687 NoCeM messages if you specify a group level to those commands. For
22688 example, if you use 1 or 2 on the mail groups and the levels on the news
22689 groups remain the default, 3 is the best choice.
22691 @item gnus-nocem-groups
22692 @vindex gnus-nocem-groups
22693 Gnus will look for NoCeM messages in the groups in this list. The
22696 ("news.lists.filters" "news.admin.net-abuse.bulletins"
22697 "alt.nocem.misc" "news.admin.net-abuse.announce")
22700 @item gnus-nocem-issuers
22701 @vindex gnus-nocem-issuers
22702 There are many people issuing NoCeM messages. This list says what
22703 people you want to listen to. The default is
22705 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
22706 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
22708 fine, upstanding citizens all of them.
22710 Known despammers that you can put in this list are listed at@*
22711 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
22713 You do not have to heed NoCeM messages from all these people---just the
22714 ones you want to listen to. You also don't have to accept all NoCeM
22715 messages from the people you like. Each NoCeM message has a @dfn{type}
22716 header that gives the message a (more or less, usually less) rigorous
22717 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
22718 @samp{binary}, and @samp{troll}. To specify this, you have to use
22719 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
22720 Each condition is either a string (which is a regexp that matches types
22721 you want to use) or a list on the form @code{(not @var{string})}, where
22722 @var{string} is a regexp that matches types you don't want to use.
22724 For instance, if you want all NoCeM messages from Chris Lewis except his
22725 @samp{troll} messages, you'd say:
22728 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
22731 On the other hand, if you just want nothing but his @samp{spam} and
22732 @samp{spew} messages, you'd say:
22735 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
22738 The specs are applied left-to-right.
22741 @item gnus-nocem-verifyer
22742 @vindex gnus-nocem-verifyer
22744 This should be a function for verifying that the NoCeM issuer is who she
22745 says she is. The default is @code{pgg-verify}, which returns
22746 non-@code{nil} if the verification is successful, otherwise (including
22747 the case the NoCeM message was not signed) returns @code{nil}. If this
22748 is too slow and you don't care for verification (which may be dangerous),
22749 you can set this variable to @code{nil}.
22751 Formerly the default was @code{mc-verify}, which is a Mailcrypt
22752 function. While you can still use it, you can change it into
22753 @code{pgg-verify} running with GnuPG if you are willing to add the
22754 @acronym{PGP} public keys to GnuPG's keyring.
22756 @item gnus-nocem-directory
22757 @vindex gnus-nocem-directory
22758 This is where Gnus will store its NoCeM cache files. The default is@*
22759 @file{~/News/NoCeM/}.
22761 @item gnus-nocem-expiry-wait
22762 @vindex gnus-nocem-expiry-wait
22763 The number of days before removing old NoCeM entries from the cache.
22764 The default is 15. If you make it shorter Gnus will be faster, but you
22765 might then see old spam.
22767 @item gnus-nocem-check-from
22768 @vindex gnus-nocem-check-from
22769 Non-@code{nil} means check for valid issuers in message bodies.
22770 Otherwise don't bother fetching articles unless their author matches a
22771 valid issuer; that is much faster if you are selective about the
22774 @item gnus-nocem-check-article-limit
22775 @vindex gnus-nocem-check-article-limit
22776 If non-@code{nil}, the maximum number of articles to check in any NoCeM
22777 group. NoCeM groups can be huge and very slow to process.
22781 Using NoCeM could potentially be a memory hog. If you have many living
22782 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
22783 big. If this is a problem, you should kill off all (or most) of your
22784 unsubscribed groups (@pxref{Subscription Commands}).
22791 It is very useful to be able to undo actions one has done. In normal
22792 Emacs buffers, it's easy enough---you just push the @code{undo} button.
22793 In Gnus buffers, however, it isn't that simple.
22795 The things Gnus displays in its buffer is of no value whatsoever to
22796 Gnus---it's all just data designed to look nice to the user.
22797 Killing a group in the group buffer with @kbd{C-k} makes the line
22798 disappear, but that's just a side-effect of the real action---the
22799 removal of the group in question from the internal Gnus structures.
22800 Undoing something like that can't be done by the normal Emacs
22801 @code{undo} function.
22803 Gnus tries to remedy this somewhat by keeping track of what the user
22804 does and coming up with actions that would reverse the actions the user
22805 takes. When the user then presses the @code{undo} key, Gnus will run
22806 the code to reverse the previous action, or the previous actions.
22807 However, not all actions are easily reversible, so Gnus currently offers
22808 a few key functions to be undoable. These include killing groups,
22809 yanking groups, and changing the list of read articles of groups.
22810 That's it, really. More functions may be added in the future, but each
22811 added function means an increase in data to be stored, so Gnus will
22812 never be totally undoable.
22814 @findex gnus-undo-mode
22815 @vindex gnus-use-undo
22817 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
22818 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
22819 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
22820 command, which should feel kinda like the normal Emacs @code{undo}
22824 @node Predicate Specifiers
22825 @section Predicate Specifiers
22826 @cindex predicate specifiers
22828 Some Gnus variables are @dfn{predicate specifiers}. This is a special
22829 form that allows flexible specification of predicates without having
22830 to type all that much.
22832 These specifiers are lists consisting of functions, symbols and lists.
22837 (or gnus-article-unseen-p
22838 gnus-article-unread-p)
22841 The available symbols are @code{or}, @code{and} and @code{not}. The
22842 functions all take one parameter.
22844 @findex gnus-make-predicate
22845 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
22846 to create a function that can be called. This input parameter to this
22847 function will be passed along to all the functions in the predicate
22852 @section Moderation
22855 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
22856 It is not included in the standard Gnus package. Write a mail to
22857 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
22860 The moderation package is implemented as a minor mode for summary
22864 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
22867 in your @file{~/.gnus.el} file.
22869 If you are the moderator of @samp{rec.zoofle}, this is how it's
22874 You split your incoming mail by matching on
22875 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
22876 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
22879 You enter that group once in a while and post articles using the @kbd{e}
22880 (edit-and-post) or @kbd{s} (just send unedited) commands.
22883 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
22884 articles that weren't approved by you, you can cancel them with the
22888 To use moderation mode in these two groups, say:
22891 (setq gnus-moderated-list
22892 "^nnml:rec.zoofle$\\|^rec.zoofle$")
22896 @node Fetching a Group
22897 @section Fetching a Group
22898 @cindex fetching a group
22900 @findex gnus-fetch-group
22901 It is sometimes convenient to be able to just say ``I want to read this
22902 group and I don't care whether Gnus has been started or not''. This is
22903 perhaps more useful for people who write code than for users, but the
22904 command @code{gnus-fetch-group} provides this functionality in any case.
22905 It takes the group name as a parameter.
22908 @node Image Enhancements
22909 @section Image Enhancements
22911 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
22912 support images, Emacs 22 does.} and up, are able to display pictures and
22913 stuff, so Gnus has taken advantage of that.
22916 * X-Face:: Display a funky, teensy black-and-white image.
22917 * Face:: Display a funkier, teensier colored image.
22918 * Smileys:: Show all those happy faces the way they were meant to be shown.
22919 * Picons:: How to display pictures of what you're reading.
22920 * XVarious:: Other XEmacsy Gnusey variables.
22928 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
22929 depth) image that's supposed to represent the author of the message.
22930 It seems to be supported by an ever-growing number of mail and news
22934 @findex gnus-article-display-x-face
22935 @vindex gnus-article-x-face-command
22936 @vindex gnus-article-x-face-too-ugly
22944 Viewing an @code{X-Face} header either requires an Emacs that has
22945 @samp{compface} support (which most XEmacs versions has), or that you
22946 have suitable conversion or display programs installed. If your Emacs
22947 has image support the default action is to display the face before the
22948 @code{From} header. If there's no native @code{X-Face} support, Gnus
22949 will try to convert the @code{X-Face} header using external programs
22950 from the @code{pbmplus} package and friends, see below. For XEmacs it's
22951 faster if XEmacs has been compiled with @code{X-Face} support. The
22952 default action under Emacs without image support is to fork off the
22953 @code{display} program.
22955 On a GNU/Linux system, the @code{display} program is included in the
22956 ImageMagick package. For external conversion programs look for packages
22957 with names like @code{netpbm}, @code{libgr-progs} and @code{compface}.
22958 On Windows, you may use the packages @code{netpbm} and @code{compface}
22959 from @url{http://gnuwin32.sourceforge.net}. You need to add the
22960 @code{bin} directory to your @code{PATH} environment variable.
22961 @c In fact only the following DLLs and binaries seem to be required:
22962 @c compface1.dll uncompface.exe libnetpbm10.dll icontopbm.exe
22964 The variable @code{gnus-article-x-face-command} controls which programs
22965 are used to display the @code{X-Face} header. If this variable is a
22966 string, this string will be executed in a sub-shell. If it is a
22967 function, this function will be called with the face as the argument.
22968 If @code{gnus-article-x-face-too-ugly} (which is a regexp) matches the
22969 @code{From} header, the face will not be shown.
22971 (Note: @code{x-face} is used in the variable/function names, not
22979 @vindex gnus-x-face
22980 Face to show X-Face. The colors from this face are used as the
22981 foreground and background colors of the displayed X-Faces. The
22982 default colors are black and white.
22984 @item gnus-face-properties-alist
22985 @vindex gnus-face-properties-alist
22986 Alist of image types and properties applied to Face (@pxref{Face}) and
22987 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
22988 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
22989 XEmacs. Here are examples:
22992 ;; Specify the altitude of Face and X-Face images in the From header.
22993 (setq gnus-face-properties-alist
22994 '((pbm . (:face gnus-x-face :ascent 80))
22995 (png . (:ascent 80))))
22997 ;; Show Face and X-Face images as pressed buttons.
22998 (setq gnus-face-properties-alist
22999 '((pbm . (:face gnus-x-face :relief -2))
23000 (png . (:relief -2))))
23003 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
23004 Reference Manual} for the valid properties for various image types.
23005 Currently, @code{pbm} is used for X-Face images and @code{png} is used
23006 for Face images in Emacs. Only the @code{:face} property is effective
23007 on the @code{xface} image type in XEmacs if it is built with the
23008 @samp{libcompface} library.
23011 If you use posting styles, you can use an @code{x-face-file} entry in
23012 @code{gnus-posting-styles}, @xref{Posting Styles}. If you don't, Gnus
23013 provides a few convenience functions and variables to allow easier
23014 insertion of X-Face headers in outgoing messages. You also need the
23015 above mentioned ImageMagick, netpbm or other image conversion packages
23016 (depending the values of the variables below) for these functions.
23018 @findex gnus-random-x-face
23019 @vindex gnus-convert-pbm-to-x-face-command
23020 @vindex gnus-x-face-directory
23021 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
23022 @code{gnus-x-face-directory} and picks one at random, and then
23023 converts it to the X-Face format by using the
23024 @code{gnus-convert-pbm-to-x-face-command} shell command. The
23025 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
23026 header data as a string.
23028 @findex gnus-insert-random-x-face-header
23029 @code{gnus-insert-random-x-face-header} calls
23030 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
23031 randomly generated data.
23033 @findex gnus-x-face-from-file
23034 @vindex gnus-convert-image-to-x-face-command
23035 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
23036 converts the file to X-Face format by using the
23037 @code{gnus-convert-image-to-x-face-command} shell command.
23039 Here's how you would typically use the first function. Put something
23040 like the following in your @file{~/.gnus.el} file:
23043 (setq message-required-news-headers
23044 (nconc message-required-news-headers
23045 (list '(X-Face . gnus-random-x-face))))
23048 Using the last function would be something like this:
23051 (setq message-required-news-headers
23052 (nconc message-required-news-headers
23053 (list '(X-Face . (lambda ()
23054 (gnus-x-face-from-file
23055 "~/My-face.gif"))))))
23063 @c #### FIXME: faces and x-faces' implementations should really be harmonized.
23065 @code{Face} headers are essentially a funkier version of @code{X-Face}
23066 ones. They describe a 48x48 pixel colored image that's supposed to
23067 represent the author of the message.
23070 @findex gnus-article-display-face
23071 The contents of a @code{Face} header must be a base64 encoded PNG image.
23072 See @uref{http://quimby.gnus.org/circus/face/} for the precise
23075 The @code{gnus-face-properties-alist} variable affects the appearance of
23076 displayed Face images. @xref{X-Face}.
23078 Viewing an @code{Face} header requires an Emacs that is able to display
23081 @c (if (featurep 'xemacs)
23083 @c (image-type-available-p 'png))
23085 Gnus provides a few convenience functions and variables to allow
23086 easier insertion of Face headers in outgoing messages.
23088 @findex gnus-convert-png-to-face
23089 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
23090 726 bytes long, and converts it to a face.
23092 @findex gnus-face-from-file
23093 @vindex gnus-convert-image-to-face-command
23094 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
23095 converts the file to Face format by using the
23096 @code{gnus-convert-image-to-face-command} shell command.
23098 Here's how you would typically use this function. Put something like the
23099 following in your @file{~/.gnus.el} file:
23102 (setq message-required-news-headers
23103 (nconc message-required-news-headers
23104 (list '(Face . (lambda ()
23105 (gnus-face-from-file "~/face.jpg"))))))
23110 @subsection Smileys
23115 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
23120 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
23121 currently the only package that uses Smiley, it is documented here.
23123 In short---to use Smiley in Gnus, put the following in your
23124 @file{~/.gnus.el} file:
23127 (setq gnus-treat-display-smileys t)
23130 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
23131 the like---to pictures and displays those instead of the text smiley
23132 faces. The conversion is controlled by a list of regexps that matches
23133 text and maps that to file names.
23135 @vindex smiley-regexp-alist
23136 The alist used is specified by the @code{smiley-regexp-alist}
23137 variable. The first item in each element is the regexp to be matched;
23138 the second element is the regexp match group that is to be replaced by
23139 the picture; and the third element is the name of the file to be
23142 The following variables customize where Smiley will look for these
23147 @item smiley-data-directory
23148 @vindex smiley-data-directory
23149 Where Smiley will look for smiley faces files.
23151 @item gnus-smiley-file-types
23152 @vindex gnus-smiley-file-types
23153 List of suffixes on smiley file names to try.
23167 So@dots{} You want to slow down your news reader even more! This is a
23168 good way to do so. It's also a great way to impress people staring
23169 over your shoulder as you read news.
23171 What are Picons? To quote directly from the Picons Web site:
23180 @dfn{Picons} is short for ``personal icons''. They're small,
23181 constrained images used to represent users and domains on the net,
23182 organized into databases so that the appropriate image for a given
23183 e-mail address can be found. Besides users and domains, there are picon
23184 databases for Usenet newsgroups and weather forecasts. The picons are
23185 in either monochrome @code{XBM} format or color @code{XPM} and
23186 @code{GIF} formats.
23189 @vindex gnus-picon-databases
23190 For instructions on obtaining and installing the picons databases,
23191 point your Web browser at
23192 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
23194 If you are using Debian GNU/Linux, saying @samp{apt-get install
23195 picons.*} will install the picons where Gnus can find them.
23197 To enable displaying picons, simply make sure that
23198 @code{gnus-picon-databases} points to the directory containing the
23201 @vindex gnus-picon-style
23202 The variable @code{gnus-picon-style} controls how picons are displayed.
23203 If @code{inline}, the textual representation is replaced. If
23204 @code{right}, picons are added right to the textual representation.
23206 The following variables offer control over where things are located.
23210 @item gnus-picon-databases
23211 @vindex gnus-picon-databases
23212 The location of the picons database. This is a list of directories
23213 containing the @file{news}, @file{domains}, @file{users} (and so on)
23214 subdirectories. Defaults to @code{("/usr/lib/picon"
23215 "/usr/local/faces")}.
23217 @item gnus-picon-news-directories
23218 @vindex gnus-picon-news-directories
23219 List of subdirectories to search in @code{gnus-picon-databases} for
23220 newsgroups faces. @code{("news")} is the default.
23222 @item gnus-picon-user-directories
23223 @vindex gnus-picon-user-directories
23224 List of subdirectories to search in @code{gnus-picon-databases} for user
23225 faces. @code{("users" "usenix" "local" "misc")} is the default.
23227 @item gnus-picon-domain-directories
23228 @vindex gnus-picon-domain-directories
23229 List of subdirectories to search in @code{gnus-picon-databases} for
23230 domain name faces. Defaults to @code{("domains")}. Some people may
23231 want to add @samp{"unknown"} to this list.
23233 @item gnus-picon-file-types
23234 @vindex gnus-picon-file-types
23235 Ordered list of suffixes on picon file names to try. Defaults to
23236 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
23242 @subsection Various XEmacs Variables
23245 @item gnus-xmas-glyph-directory
23246 @vindex gnus-xmas-glyph-directory
23247 This is where Gnus will look for pictures. Gnus will normally
23248 auto-detect this directory, but you may set it manually if you have an
23249 unusual directory structure.
23251 @item gnus-xmas-modeline-glyph
23252 @vindex gnus-xmas-modeline-glyph
23253 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
23258 @subsubsection Toolbar
23262 @item gnus-use-toolbar
23263 @vindex gnus-use-toolbar
23264 This variable specifies the position to display the toolbar. If
23265 @code{nil}, don't display toolbars. If it is non-@code{nil}, it should
23266 be one of the symbols @code{default}, @code{top}, @code{bottom},
23267 @code{right}, and @code{left}. @code{default} means to use the default
23268 toolbar, the rest mean to display the toolbar on the place which those
23269 names show. The default is @code{default}.
23271 @item gnus-toolbar-thickness
23272 @vindex gnus-toolbar-thickness
23273 Cons of the height and the width specifying the thickness of a toolbar.
23274 The height is used for the toolbar displayed on the top or the bottom,
23275 the width is used for the toolbar displayed on the right or the left.
23276 The default is that of the default toolbar.
23278 @item gnus-group-toolbar
23279 @vindex gnus-group-toolbar
23280 The toolbar in the group buffer.
23282 @item gnus-summary-toolbar
23283 @vindex gnus-summary-toolbar
23284 The toolbar in the summary buffer.
23286 @item gnus-summary-mail-toolbar
23287 @vindex gnus-summary-mail-toolbar
23288 The toolbar in the summary buffer of mail groups.
23299 @node Fuzzy Matching
23300 @section Fuzzy Matching
23301 @cindex fuzzy matching
23303 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
23304 things like scoring, thread gathering and thread comparison.
23306 As opposed to regular expression matching, fuzzy matching is very fuzzy.
23307 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
23308 means, and the implementation has changed over time.
23310 Basically, it tries to remove all noise from lines before comparing.
23311 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
23312 out of the strings before comparing the results. This often leads to
23313 adequate results---even when faced with strings generated by text
23314 manglers masquerading as newsreaders.
23317 @node Thwarting Email Spam
23318 @section Thwarting Email Spam
23322 @cindex unsolicited commercial email
23324 In these last days of the Usenet, commercial vultures are hanging about
23325 and grepping through news like crazy to find email addresses they can
23326 foist off their scams and products to. As a reaction to this, many
23327 people have started putting nonsense addresses into their @code{From}
23328 lines. I think this is counterproductive---it makes it difficult for
23329 people to send you legitimate mail in response to things you write, as
23330 well as making it difficult to see who wrote what. This rewriting may
23331 perhaps be a bigger menace than the unsolicited commercial email itself
23334 The biggest problem I have with email spam is that it comes in under
23335 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
23336 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
23337 mail group, only to find two pyramid schemes, seven advertisements
23338 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
23339 and one mail asking me to repent and find some god.
23341 This is annoying. Here's what you can do about it.
23344 * The problem of spam:: Some background, and some solutions
23345 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
23346 * SpamAssassin:: How to use external anti-spam tools.
23347 * Hashcash:: Reduce spam by burning CPU time.
23350 @node The problem of spam
23351 @subsection The problem of spam
23353 @cindex spam filtering approaches
23354 @cindex filtering approaches, spam
23356 @cindex unsolicited commercial email
23358 First, some background on spam.
23360 If you have access to e-mail, you are familiar with spam (technically
23361 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
23362 exists because e-mail delivery is very cheap compared to paper mail,
23363 so only a very small percentage of people need to respond to an UCE to
23364 make it worthwhile to the advertiser. Ironically, one of the most
23365 common spams is the one offering a database of e-mail addresses for
23366 further spamming. Senders of spam are usually called @emph{spammers},
23367 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
23368 @emph{morons} are in common use as well.
23370 Spam comes from a wide variety of sources. It is simply impossible to
23371 dispose of all spam without discarding useful messages. A good
23372 example is the TMDA system, which requires senders
23373 unknown to you to confirm themselves as legitimate senders before
23374 their e-mail can reach you. Without getting into the technical side
23375 of TMDA, a downside is clearly that e-mail from legitimate sources may
23376 be discarded if those sources can't or won't confirm themselves
23377 through the TMDA system. Another problem with TMDA is that it
23378 requires its users to have a basic understanding of e-mail delivery
23381 The simplest approach to filtering spam is filtering, at the mail
23382 server or when you sort through incoming mail. If you get 200 spam
23383 messages per day from @samp{random-address@@vmadmin.com}, you block
23384 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
23385 discard all messages with @samp{VIAGRA} in the message. If you get
23386 lots of spam from Bulgaria, for example, you try to filter all mail
23387 from Bulgarian IPs.
23389 This, unfortunately, is a great way to discard legitimate e-mail. The
23390 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
23391 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
23392 you should be obvious, so don't do it if you have the choice.
23394 In another instance, the very informative and useful RISKS digest has
23395 been blocked by overzealous mail filters because it @strong{contained}
23396 words that were common in spam messages. Nevertheless, in isolated
23397 cases, with great care, direct filtering of mail can be useful.
23399 Another approach to filtering e-mail is the distributed spam
23400 processing, for instance DCC implements such a system. In essence,
23401 @var{N} systems around the world agree that a machine @var{X} in
23402 Ghana, Estonia, or California is sending out spam e-mail, and these
23403 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
23404 database. The criteria for spam detection vary---it may be the number
23405 of messages sent, the content of the messages, and so on. When a user
23406 of the distributed processing system wants to find out if a message is
23407 spam, he consults one of those @var{N} systems.
23409 Distributed spam processing works very well against spammers that send
23410 a large number of messages at once, but it requires the user to set up
23411 fairly complicated checks. There are commercial and free distributed
23412 spam processing systems. Distributed spam processing has its risks as
23413 well. For instance legitimate e-mail senders have been accused of
23414 sending spam, and their web sites and mailing lists have been shut
23415 down for some time because of the incident.
23417 The statistical approach to spam filtering is also popular. It is
23418 based on a statistical analysis of previous spam messages. Usually
23419 the analysis is a simple word frequency count, with perhaps pairs of
23420 words or 3-word combinations thrown into the mix. Statistical
23421 analysis of spam works very well in most of the cases, but it can
23422 classify legitimate e-mail as spam in some cases. It takes time to
23423 run the analysis, the full message must be analyzed, and the user has
23424 to store the database of spam analysis. Statistical analysis on the
23425 server is gaining popularity. This has the advantage of letting the
23426 user Just Read Mail, but has the disadvantage that it's harder to tell
23427 the server that it has misclassified mail.
23429 Fighting spam is not easy, no matter what anyone says. There is no
23430 magic switch that will distinguish Viagra ads from Mom's e-mails.
23431 Even people are having a hard time telling spam apart from non-spam,
23432 because spammers are actively looking to fool us into thinking they
23433 are Mom, essentially. Spamming is irritating, irresponsible, and
23434 idiotic behavior from a bunch of people who think the world owes them
23435 a favor. We hope the following sections will help you in fighting the
23438 @node Anti-Spam Basics
23439 @subsection Anti-Spam Basics
23443 @cindex unsolicited commercial email
23445 One way of dealing with spam is having Gnus split out all spam into a
23446 @samp{spam} mail group (@pxref{Splitting Mail}).
23448 First, pick one (1) valid mail address that you can be reached at, and
23449 put it in your @code{From} header of all your news articles. (I've
23450 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
23451 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
23452 sysadmin whether your sendmail installation accepts keywords in the local
23453 part of the mail address.)
23456 (setq message-default-news-headers
23457 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
23460 Then put the following split rule in @code{nnmail-split-fancy}
23461 (@pxref{Fancy Mail Splitting}):
23465 (to "larsi@@trym.ifi.uio.no"
23466 (| ("subject" "re:.*" "misc")
23467 ("references" ".*@@.*" "misc")
23472 This says that all mail to this address is suspect, but if it has a
23473 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
23474 header, it's probably ok. All the rest goes to the @samp{spam} group.
23475 (This idea probably comes from Tim Pierce.)
23477 In addition, many mail spammers talk directly to your @acronym{SMTP} server
23478 and do not include your email address explicitly in the @code{To}
23479 header. Why they do this is unknown---perhaps it's to thwart this
23480 thwarting scheme? In any case, this is trivial to deal with---you just
23481 put anything not addressed to you in the @samp{spam} group by ending
23482 your fancy split rule in this way:
23487 (to "larsi" "misc")
23491 In my experience, this will sort virtually everything into the right
23492 group. You still have to check the @samp{spam} group from time to time to
23493 check for legitimate mail, though. If you feel like being a good net
23494 citizen, you can even send off complaints to the proper authorities on
23495 each unsolicited commercial email---at your leisure.
23497 This works for me. It allows people an easy way to contact me (they can
23498 just press @kbd{r} in the usual way), and I'm not bothered at all with
23499 spam. It's a win-win situation. Forging @code{From} headers to point
23500 to non-existent domains is yucky, in my opinion.
23502 Be careful with this approach. Spammers are wise to it.
23506 @subsection SpamAssassin, Vipul's Razor, DCC, etc
23507 @cindex SpamAssassin
23508 @cindex Vipul's Razor
23511 The days where the hints in the previous section were sufficient in
23512 avoiding spam are coming to an end. There are many tools out there
23513 that claim to reduce the amount of spam you get. This section could
23514 easily become outdated fast, as new products replace old, but
23515 fortunately most of these tools seem to have similar interfaces. Even
23516 though this section will use SpamAssassin as an example, it should be
23517 easy to adapt it to most other tools.
23519 Note that this section does not involve the @code{spam.el} package,
23520 which is discussed in the next section. If you don't care for all
23521 the features of @code{spam.el}, you can make do with these simple
23524 If the tool you are using is not installed on the mail server, you
23525 need to invoke it yourself. Ideas on how to use the
23526 @code{:postscript} mail source parameter (@pxref{Mail Source
23527 Specifiers}) follow.
23531 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
23535 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
23538 Once you manage to process your incoming spool somehow, thus making
23539 the mail contain e.g.@: a header indicating it is spam, you are ready to
23540 filter it out. Using normal split methods (@pxref{Splitting Mail}):
23543 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
23547 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
23550 (setq nnmail-split-methods 'nnmail-split-fancy
23551 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
23555 Some people might not like the idea of piping the mail through various
23556 programs using a @code{:prescript} (if some program is buggy, you
23557 might lose all mail). If you are one of them, another solution is to
23558 call the external tools during splitting. Example fancy split method:
23561 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
23563 (defun kevin-spamassassin ()
23567 (if (eq 1 (call-process-region (point-min) (point-max)
23568 "spamc" nil nil nil "-c"))
23572 Note that with the nnimap back end, message bodies will not be
23573 downloaded by default. You need to set
23574 @code{nnimap-split-download-body} to @code{t} to do that
23575 (@pxref{Splitting in IMAP}).
23577 That is about it. As some spam is likely to get through anyway, you
23578 might want to have a nifty function to call when you happen to read
23579 spam. And here is the nifty function:
23582 (defun my-gnus-raze-spam ()
23583 "Submit SPAM to Vipul's Razor, then mark it as expirable."
23585 (gnus-summary-show-raw-article)
23586 (gnus-summary-save-in-pipe "razor-report -f -d")
23587 (gnus-summary-mark-as-expirable 1))
23591 @subsection Hashcash
23594 A novel technique to fight spam is to require senders to do something
23595 costly and demonstrably unique for each message they send. This has
23596 the obvious drawback that you cannot rely on everyone in the world
23597 using this technique, since it is not part of the Internet standards,
23598 but it may be useful in smaller communities.
23600 While the tools in the previous section work well in practice, they
23601 work only because the tools are constantly maintained and updated as
23602 new form of spam appears. This means that a small percentage of spam
23603 will always get through. It also means that somewhere, someone needs
23604 to read lots of spam to update these tools. Hashcash avoids that, but
23605 instead prefers that everyone you contact through e-mail supports the
23606 scheme. You can view the two approaches as pragmatic vs dogmatic.
23607 The approaches have their own advantages and disadvantages, but as
23608 often in the real world, a combination of them is stronger than either
23609 one of them separately.
23612 The ``something costly'' is to burn CPU time, more specifically to
23613 compute a hash collision up to a certain number of bits. The
23614 resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header.
23615 For more details, and for the external application @code{hashcash} you
23616 need to install to use this feature, see
23617 @uref{http://www.hashcash.org/}. Even more information can be found
23618 at @uref{http://www.camram.org/}.
23620 If you wish to generate hashcash for each message you send, you can
23621 customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail
23622 Headers,message, The Message Manual}), as in:
23625 (setq message-generate-hashcash t)
23628 You will need to set up some additional variables as well:
23632 @item hashcash-default-payment
23633 @vindex hashcash-default-payment
23634 This variable indicates the default number of bits the hash collision
23635 should consist of. By default this is 20. Suggested useful values
23638 @item hashcash-payment-alist
23639 @vindex hashcash-payment-alist
23640 Some receivers may require you to spend burn more CPU time than the
23641 default. This variable contains a list of @samp{(@var{addr}
23642 @var{amount})} cells, where @var{addr} is the receiver (email address
23643 or newsgroup) and @var{amount} is the number of bits in the collision
23644 that is needed. It can also contain @samp{(@var{addr} @var{string}
23645 @var{amount})} cells, where the @var{string} is the string to use
23646 (normally the email address or newsgroup name is used).
23648 @item hashcash-path
23649 @vindex hashcash-path
23650 Where the @code{hashcash} binary is installed. This variable should
23651 be automatically set by @code{executable-find}, but if it's @code{nil}
23652 (usually because the @code{hashcash} binary is not in your path)
23653 you'll get a warning when you check hashcash payments and an error
23654 when you generate hashcash payments.
23658 Gnus can verify hashcash cookies, although this can also be done by
23659 hand customized mail filtering scripts. To verify a hashcash cookie
23660 in a message, use the @code{mail-check-payment} function in the
23661 @code{hashcash.el} library. You can also use the @code{spam.el}
23662 package with the @code{spam-use-hashcash} back end to validate hashcash
23663 cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam
23664 Hashcash Payments}).
23667 @section Spam Package
23668 @cindex spam filtering
23671 The Spam package provides Gnus with a centralized mechanism for
23672 detecting and filtering spam. It filters new mail, and processes
23673 messages according to whether they are spam or ham. (@dfn{Ham} is the
23674 name used throughout this manual to indicate non-spam messages.)
23677 * Spam Package Introduction::
23678 * Filtering Incoming Mail::
23679 * Detecting Spam in Groups::
23680 * Spam and Ham Processors::
23681 * Spam Package Configuration Examples::
23683 * Extending the Spam package::
23684 * Spam Statistics Package::
23687 @node Spam Package Introduction
23688 @subsection Spam Package Introduction
23689 @cindex spam filtering
23690 @cindex spam filtering sequence of events
23693 You must read this section to understand how the Spam package works.
23694 Do not skip, speed-read, or glance through this section.
23696 Make sure you read the section on the @code{spam.el} sequence of
23697 events. See @xref{Extending the Spam package}.
23699 @cindex spam-initialize
23700 @vindex spam-use-stat
23701 To use the Spam package, you @strong{must} first run the function
23702 @code{spam-initialize}:
23708 This autoloads @code{spam.el} and installs the various hooks necessary
23709 to let the Spam package do its job. In order to make use of the Spam
23710 package, you have to set up certain group parameters and variables,
23711 which we will describe below. All of the variables controlling the
23712 Spam package can be found in the @samp{spam} customization group.
23714 There are two ``contact points'' between the Spam package and the rest
23715 of Gnus: checking new mail for spam, and leaving a group.
23717 Checking new mail for spam is done in one of two ways: while splitting
23718 incoming mail, or when you enter a group.
23720 The first way, checking for spam while splitting incoming mail, is
23721 suited to mail back ends such as @code{nnml} or @code{nnimap}, where
23722 new mail appears in a single spool file. The Spam package processes
23723 incoming mail, and sends mail considered to be spam to a designated
23724 ``spam'' group. @xref{Filtering Incoming Mail}.
23726 The second way is suited to back ends such as @code{nntp}, which have
23727 no incoming mail spool, or back ends where the server is in charge of
23728 splitting incoming mail. In this case, when you enter a Gnus group,
23729 the unseen or unread messages in that group are checked for spam.
23730 Detected spam messages are marked as spam. @xref{Detecting Spam in
23733 @cindex spam back ends
23734 In either case, you have to tell the Spam package what method to use
23735 to detect spam messages. There are several methods, or @dfn{spam back
23736 ends} (not to be confused with Gnus back ends!) to choose from: spam
23737 ``blacklists'' and ``whitelists'', dictionary-based filters, and so
23738 forth. @xref{Spam Back Ends}.
23740 In the Gnus summary buffer, messages that have been identified as spam
23741 always appear with a @samp{$} symbol.
23743 The Spam package divides Gnus groups into three categories: ham
23744 groups, spam groups, and unclassified groups. You should mark each of
23745 the groups you subscribe to as either a ham group or a spam group,
23746 using the @code{spam-contents} group parameter (@pxref{Group
23747 Parameters}). Spam groups have a special property: when you enter a
23748 spam group, all unseen articles are marked as spam. Thus, mail split
23749 into a spam group is automatically marked as spam.
23751 Identifying spam messages is only half of the Spam package's job. The
23752 second half comes into play whenever you exit a group buffer. At this
23753 point, the Spam package does several things:
23755 First, it calls @dfn{spam and ham processors} to process the articles
23756 according to whether they are spam or ham. There is a pair of spam
23757 and ham processors associated with each spam back end, and what the
23758 processors do depends on the back end. At present, the main role of
23759 spam and ham processors is for dictionary-based spam filters: they add
23760 the contents of the messages in the group to the filter's dictionary,
23761 to improve its ability to detect future spam. The @code{spam-process}
23762 group parameter specifies what spam processors to use. @xref{Spam and
23765 If the spam filter failed to mark a spam message, you can mark it
23766 yourself, so that the message is processed as spam when you exit the
23776 @findex gnus-summary-mark-as-spam
23777 @findex gnus-summary-mark-as-spam
23778 Mark current article as spam, showing it with the @samp{$} mark
23779 (@code{gnus-summary-mark-as-spam}).
23783 Similarly, you can unmark an article if it has been erroneously marked
23784 as spam. @xref{Setting Marks}.
23786 Normally, a ham message found in a non-ham group is not processed as
23787 ham---the rationale is that it should be moved into a ham group for
23788 further processing (see below). However, you can force these articles
23789 to be processed as ham by setting
23790 @code{spam-process-ham-in-spam-groups} and
23791 @code{spam-process-ham-in-nonham-groups}.
23793 @vindex gnus-ham-process-destinations
23794 @vindex gnus-spam-process-destinations
23795 The second thing that the Spam package does when you exit a group is
23796 to move ham articles out of spam groups, and spam articles out of ham
23797 groups. Ham in a spam group is moved to the group specified by the
23798 variable @code{gnus-ham-process-destinations}, or the group parameter
23799 @code{ham-process-destination}. Spam in a ham group is moved to the
23800 group specified by the variable @code{gnus-spam-process-destinations},
23801 or the group parameter @code{spam-process-destination}. If these
23802 variables are not set, the articles are left in their current group.
23803 If an article cannot be moved (e.g., with a read-only backend such
23804 as @acronym{NNTP}), it is copied.
23806 If an article is moved to another group, it is processed again when
23807 you visit the new group. Normally, this is not a problem, but if you
23808 want each article to be processed only once, load the
23809 @code{gnus-registry.el} package and set the variable
23810 @code{spam-log-to-registry} to @code{t}. @xref{Spam Package
23811 Configuration Examples}.
23813 Normally, spam groups ignore @code{gnus-spam-process-destinations}.
23814 However, if you set @code{spam-move-spam-nonspam-groups-only} to
23815 @code{nil}, spam will also be moved out of spam groups, depending on
23816 the @code{spam-process-destination} parameter.
23818 The final thing the Spam package does is to mark spam articles as
23819 expired, which is usually the right thing to do.
23821 If all this seems confusing, don't worry. Soon it will be as natural
23822 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
23823 50 years in the future yet. Just trust us, it's not so bad.
23825 @node Filtering Incoming Mail
23826 @subsection Filtering Incoming Mail
23827 @cindex spam filtering
23828 @cindex spam filtering incoming mail
23831 To use the Spam package to filter incoming mail, you must first set up
23832 fancy mail splitting. @xref{Fancy Mail Splitting}. The Spam package
23833 defines a special splitting function that you can add to your fancy
23834 split variable (either @code{nnmail-split-fancy} or
23835 @code{nnimap-split-fancy}, depending on your mail back end):
23841 @vindex spam-split-group
23843 The @code{spam-split} function scans incoming mail according to your
23844 chosen spam back end(s), and sends messages identified as spam to a
23845 spam group. By default, the spam group is a group named @samp{spam},
23846 but you can change this by customizing @code{spam-split-group}. Make
23847 sure the contents of @code{spam-split-group} are an unqualified group
23848 name. For instance, in an @code{nnimap} server @samp{your-server},
23849 the value @samp{spam} means @samp{nnimap+your-server:spam}. The value
23850 @samp{nnimap+server:spam} is therefore wrong---it gives the group
23851 @samp{nnimap+your-server:nnimap+server:spam}.
23853 @code{spam-split} does not modify the contents of messages in any way.
23855 @vindex nnimap-split-download-body
23856 Note for IMAP users: if you use the @code{spam-check-bogofilter},
23857 @code{spam-check-ifile}, and @code{spam-check-stat} spam back ends,
23858 you should also set set the variable @code{nnimap-split-download-body}
23859 to @code{t}. These spam back ends are most useful when they can
23860 ``scan'' the full message body. By default, the nnimap back end only
23861 retrieves the message headers; @code{nnimap-split-download-body} tells
23862 it to retrieve the message bodies as well. We don't set this by
23863 default because it will slow @acronym{IMAP} down, and that is not an
23864 appropriate decision to make on behalf of the user. @xref{Splitting
23867 You have to specify one or more spam back ends for @code{spam-split}
23868 to use, by setting the @code{spam-use-*} variables. @xref{Spam Back
23869 Ends}. Normally, @code{spam-split} simply uses all the spam back ends
23870 you enabled in this way. However, you can tell @code{spam-split} to
23871 use only some of them. Why this is useful? Suppose you are using the
23872 @code{spam-use-regex-headers} and @code{spam-use-blackholes} spam back
23873 ends, and the following split rule:
23876 nnimap-split-fancy '(|
23877 (any "ding" "ding")
23879 ;; @r{default mailbox}
23884 The problem is that you want all ding messages to make it to the ding
23885 folder. But that will let obvious spam (for example, spam detected by
23886 SpamAssassin, and @code{spam-use-regex-headers}) through, when it's
23887 sent to the ding list. On the other hand, some messages to the ding
23888 list are from a mail server in the blackhole list, so the invocation
23889 of @code{spam-split} can't be before the ding rule.
23891 The solution is to let SpamAssassin headers supersede ding rules, and
23892 perform the other @code{spam-split} rules (including a second
23893 invocation of the regex-headers check) after the ding rule. This is
23894 done by passing a parameter to @code{spam-split}:
23899 ;; @r{spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
23900 (: spam-split "regex-spam" 'spam-use-regex-headers)
23901 (any "ding" "ding")
23902 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
23904 ;; @r{default mailbox}
23909 This lets you invoke specific @code{spam-split} checks depending on
23910 your particular needs, and target the results of those checks to a
23911 particular spam group. You don't have to throw all mail into all the
23912 spam tests. Another reason why this is nice is that messages to
23913 mailing lists you have rules for don't have to have resource-intensive
23914 blackhole checks performed on them. You could also specify different
23915 spam checks for your nnmail split vs. your nnimap split. Go crazy.
23917 You should set the @code{spam-use-*} variables for whatever spam back
23918 ends you intend to use. The reason is that when loading
23919 @file{spam.el}, some conditional loading is done depending on what
23920 @code{spam-use-xyz} variables you have set. @xref{Spam Back Ends}.
23922 @c @emph{TODO: spam.el needs to provide a uniform way of training all the
23923 @c statistical databases. Some have that functionality built-in, others
23926 @node Detecting Spam in Groups
23927 @subsection Detecting Spam in Groups
23929 To detect spam when visiting a group, set the group's
23930 @code{spam-autodetect} and @code{spam-autodetect-methods} group
23931 parameters. These are accessible with @kbd{G c} or @kbd{G p}, as
23932 usual (@pxref{Group Parameters}).
23934 You should set the @code{spam-use-*} variables for whatever spam back
23935 ends you intend to use. The reason is that when loading
23936 @file{spam.el}, some conditional loading is done depending on what
23937 @code{spam-use-xyz} variables you have set.
23939 By default, only unseen articles are processed for spam. You can
23940 force Gnus to recheck all messages in the group by setting the
23941 variable @code{spam-autodetect-recheck-messages} to @code{t}.
23943 If you use the @code{spam-autodetect} method of checking for spam, you
23944 can specify different spam detection methods for different groups.
23945 For instance, the @samp{ding} group may have @code{spam-use-BBDB} as
23946 the autodetection method, while the @samp{suspect} group may have the
23947 @code{spam-use-blacklist} and @code{spam-use-bogofilter} methods
23948 enabled. Unlike with @code{spam-split}, you don't have any control
23949 over the @emph{sequence} of checks, but this is probably unimportant.
23951 @node Spam and Ham Processors
23952 @subsection Spam and Ham Processors
23953 @cindex spam filtering
23954 @cindex spam filtering variables
23955 @cindex spam variables
23958 @vindex gnus-spam-process-newsgroups
23959 Spam and ham processors specify special actions to take when you exit
23960 a group buffer. Spam processors act on spam messages, and ham
23961 processors on ham messages. At present, the main role of these
23962 processors is to update the dictionaries of dictionary-based spam back
23963 ends such as Bogofilter (@pxref{Bogofilter}) and the Spam Statistics
23964 package (@pxref{Spam Statistics Filtering}).
23966 The spam and ham processors that apply to each group are determined by
23967 the group's@code{spam-process} group parameter. If this group
23968 parameter is not defined, they are determined by the variable
23969 @code{gnus-spam-process-newsgroups}.
23971 @vindex gnus-spam-newsgroup-contents
23972 Gnus learns from the spam you get. You have to collect your spam in
23973 one or more spam groups, and set or customize the variable
23974 @code{spam-junk-mailgroups} as appropriate. You can also declare
23975 groups to contain spam by setting their group parameter
23976 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
23977 by customizing the corresponding variable
23978 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
23979 parameter and the @code{gnus-spam-newsgroup-contents} variable can
23980 also be used to declare groups as @emph{ham} groups if you set their
23981 classification to @code{gnus-group-spam-classification-ham}. If
23982 groups are not classified by means of @code{spam-junk-mailgroups},
23983 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
23984 considered @emph{unclassified}. All groups are unclassified by
23987 @vindex gnus-spam-mark
23989 In spam groups, all messages are considered to be spam by default:
23990 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
23991 group. If you have seen a message, had it marked as spam, then
23992 unmarked it, it won't be marked as spam when you enter the group
23993 thereafter. You can disable that behavior, so all unread messages
23994 will get the @samp{$} mark, if you set the
23995 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
23996 should remove the @samp{$} mark when you are in the group summary
23997 buffer for every message that is not spam after all. To remove the
23998 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
23999 @kbd{d} for declaring it read the non-spam way. When you leave a
24000 group, all spam-marked (@samp{$}) articles are sent to a spam
24001 processor which will study them as spam samples.
24003 Messages may also be deleted in various other ways, and unless
24004 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
24005 and @samp{r} for default read or explicit delete, marks @samp{X} and
24006 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
24007 low scores, are all considered to be associated with articles which
24008 are not spam. This assumption might be false, in particular if you
24009 use kill files or score files as means for detecting genuine spam, you
24010 should then adjust the @code{ham-marks} group parameter.
24013 You can customize this group or topic parameter to be the list of
24014 marks you want to consider ham. By default, the list contains the
24015 deleted, read, killed, kill-filed, and low-score marks (the idea is
24016 that these articles have been read, but are not spam). It can be
24017 useful to also include the tick mark in the ham marks. It is not
24018 recommended to make the unread mark a ham mark, because it normally
24019 indicates a lack of classification. But you can do it, and we'll be
24024 You can customize this group or topic parameter to be the list of
24025 marks you want to consider spam. By default, the list contains only
24026 the spam mark. It is not recommended to change that, but you can if
24027 you really want to.
24030 When you leave @emph{any} group, regardless of its
24031 @code{spam-contents} classification, all spam-marked articles are sent
24032 to a spam processor, which will study these as spam samples. If you
24033 explicit kill a lot, you might sometimes end up with articles marked
24034 @samp{K} which you never saw, and which might accidentally contain
24035 spam. Best is to make sure that real spam is marked with @samp{$},
24038 @vindex gnus-ham-process-destinations
24039 When you leave a @emph{spam} group, all spam-marked articles are
24040 marked as expired after processing with the spam processor. This is
24041 not done for @emph{unclassified} or @emph{ham} groups. Also, any
24042 @strong{ham} articles in a spam group will be moved to a location
24043 determined by either the @code{ham-process-destination} group
24044 parameter or a match in the @code{gnus-ham-process-destinations}
24045 variable, which is a list of regular expressions matched with group
24046 names (it's easiest to customize this variable with @kbd{M-x
24047 customize-variable @key{RET} gnus-ham-process-destinations}). Each
24048 group name list is a standard Lisp list, if you prefer to customize
24049 the variable manually. If the @code{ham-process-destination}
24050 parameter is not set, ham articles are left in place. If the
24051 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
24052 set, the ham articles are marked as unread before being moved.
24054 If ham can not be moved---because of a read-only back end such as
24055 @acronym{NNTP}, for example, it will be copied.
24057 Note that you can use multiples destinations per group or regular
24058 expression! This enables you to send your ham to a regular mail
24059 group and to a @emph{ham training} group.
24061 When you leave a @emph{ham} group, all ham-marked articles are sent to
24062 a ham processor, which will study these as non-spam samples.
24064 @vindex spam-process-ham-in-spam-groups
24065 By default the variable @code{spam-process-ham-in-spam-groups} is
24066 @code{nil}. Set it to @code{t} if you want ham found in spam groups
24067 to be processed. Normally this is not done, you are expected instead
24068 to send your ham to a ham group and process it there.
24070 @vindex spam-process-ham-in-nonham-groups
24071 By default the variable @code{spam-process-ham-in-nonham-groups} is
24072 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
24073 or unclassified) groups to be processed. Normally this is not done,
24074 you are expected instead to send your ham to a ham group and process
24077 @vindex gnus-spam-process-destinations
24078 When you leave a @emph{ham} or @emph{unclassified} group, all
24079 @strong{spam} articles are moved to a location determined by either
24080 the @code{spam-process-destination} group parameter or a match in the
24081 @code{gnus-spam-process-destinations} variable, which is a list of
24082 regular expressions matched with group names (it's easiest to
24083 customize this variable with @kbd{M-x customize-variable @key{RET}
24084 gnus-spam-process-destinations}). Each group name list is a standard
24085 Lisp list, if you prefer to customize the variable manually. If the
24086 @code{spam-process-destination} parameter is not set, the spam
24087 articles are only expired. The group name is fully qualified, meaning
24088 that if you see @samp{nntp:servername} before the group name in the
24089 group buffer then you need it here as well.
24091 If spam can not be moved---because of a read-only back end such as
24092 @acronym{NNTP}, for example, it will be copied.
24094 Note that you can use multiples destinations per group or regular
24095 expression! This enables you to send your spam to multiple @emph{spam
24098 @vindex spam-log-to-registry
24099 The problem with processing ham and spam is that Gnus doesn't track
24100 this processing by default. Enable the @code{spam-log-to-registry}
24101 variable so @code{spam.el} will use @code{gnus-registry.el} to track
24102 what articles have been processed, and avoid processing articles
24103 multiple times. Keep in mind that if you limit the number of registry
24104 entries, this won't work as well as it does without a limit.
24106 @vindex spam-mark-only-unseen-as-spam
24107 Set this variable if you want only unseen articles in spam groups to
24108 be marked as spam. By default, it is set. If you set it to
24109 @code{nil}, unread articles will also be marked as spam.
24111 @vindex spam-mark-ham-unread-before-move-from-spam-group
24112 Set this variable if you want ham to be unmarked before it is moved
24113 out of the spam group. This is very useful when you use something
24114 like the tick mark @samp{!} to mark ham---the article will be placed
24115 in your @code{ham-process-destination}, unmarked as if it came fresh
24116 from the mail server.
24118 @vindex spam-autodetect-recheck-messages
24119 When autodetecting spam, this variable tells @code{spam.el} whether
24120 only unseen articles or all unread articles should be checked for
24121 spam. It is recommended that you leave it off.
24123 @node Spam Package Configuration Examples
24124 @subsection Spam Package Configuration Examples
24125 @cindex spam filtering
24126 @cindex spam filtering configuration examples
24127 @cindex spam configuration examples
24130 @subsubheading Ted's setup
24132 From Ted Zlatanov <tzz@@lifelogs.com>.
24134 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
24135 ;; @r{see @file{gnus-registry.el} for more information}
24136 (gnus-registry-initialize)
24140 spam-log-to-registry t ; @r{for spam autodetection}
24142 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
24143 ;; @r{all groups with @samp{spam} in the name contain spam}
24144 gnus-spam-newsgroup-contents
24145 '(("spam" gnus-group-spam-classification-spam))
24146 ;; @r{see documentation for these}
24147 spam-move-spam-nonspam-groups-only nil
24148 spam-mark-only-unseen-as-spam t
24149 spam-mark-ham-unread-before-move-from-spam-group t
24150 nnimap-split-rule 'nnimap-split-fancy
24151 ;; @r{understand what this does before you copy it to your own setup!}
24152 nnimap-split-fancy '(|
24153 ;; @r{trace references to parents and put in their group}
24154 (: gnus-registry-split-fancy-with-parent)
24155 ;; @r{this will catch server-side SpamAssassin tags}
24156 (: spam-split 'spam-use-regex-headers)
24157 (any "ding" "ding")
24158 ;; @r{note that spam by default will go to @samp{spam}}
24160 ;; @r{default mailbox}
24163 ;; @r{my parameters, set with @kbd{G p}}
24165 ;; @r{all nnml groups, and all nnimap groups except}
24166 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
24167 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
24168 ;; @r{because it must have been detected manually}
24170 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24172 ;; @r{all @acronym{NNTP} groups}
24173 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
24174 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
24175 ;; @r{send all spam to the training group}
24176 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24178 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
24179 ((spam-autodetect . t))
24181 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
24183 ;; @r{this is a spam group}
24184 ((spam-contents gnus-group-spam-classification-spam)
24186 ;; @r{any spam (which happens when I enter for all unseen messages,}
24187 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
24188 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
24190 (spam-process-destination "nnimap+mail.lifelogs.com:train")
24192 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
24193 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
24195 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
24196 "nnimap+mail.lifelogs.com:trainham")
24197 ;; @r{in this group, only @samp{!} marks are ham}
24199 (gnus-ticked-mark))
24200 ;; @r{remembers senders in the blacklist on the way out---this is}
24201 ;; @r{definitely not needed, it just makes me feel better}
24202 (spam-process (gnus-group-spam-exit-processor-blacklist)))
24204 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
24205 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
24206 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
24210 @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server
24211 From Reiner Steib <reiner.steib@@gmx.de>.
24213 My provider has set up bogofilter (in combination with @acronym{DCC}) on
24214 the mail server (@acronym{IMAP}). Recognized spam goes to
24215 @samp{spam.detected}, the rest goes through the normal filter rules,
24216 i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
24217 positives or negatives is done by copying or moving the article to
24218 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
24219 the server feeds those to bogofilter with the suitable ham or spam
24220 options and deletes them from the @samp{training.ham} and
24221 @samp{training.spam} folders.
24223 With the following entries in @code{gnus-parameters}, @code{spam.el}
24224 does most of the job for me:
24227 ("nnimap:spam\\.detected"
24228 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
24229 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
24230 (spam-contents gnus-group-spam-classification-spam))
24231 ("nnimap:\\(INBOX\\|other-folders\\)"
24232 (spam-process-destination . "nnimap:training.spam")
24233 (spam-contents gnus-group-spam-classification-ham))
24238 @item @b{The Spam folder:}
24240 In the folder @samp{spam.detected}, I have to check for false positives
24241 (i.e. legitimate mails, that were wrongly judged as spam by
24242 bogofilter or DCC).
24244 Because of the @code{gnus-group-spam-classification-spam} entry, all
24245 messages are marked as spam (with @code{$}). When I find a false
24246 positive, I mark the message with some other ham mark
24247 (@code{ham-marks}, @ref{Spam and Ham Processors}). On group exit,
24248 those messages are copied to both groups, @samp{INBOX} (where I want
24249 to have the article) and @samp{training.ham} (for training bogofilter)
24250 and deleted from the @samp{spam.detected} folder.
24252 The @code{gnus-article-sort-by-chars} entry simplifies detection of
24253 false positives for me. I receive lots of worms (sweN, @dots{}), that all
24254 have a similar size. Grouping them by size (i.e. chars) makes finding
24255 other false positives easier. (Of course worms aren't @i{spam}
24256 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
24257 an excellent tool for filtering those unwanted mails for me.)
24259 @item @b{Ham folders:}
24261 In my ham folders, I just hit @kbd{S x}
24262 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
24263 mail (false negative). On group exit, those messages are moved to
24264 @samp{training.spam}.
24267 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
24269 From Reiner Steib <reiner.steib@@gmx.de>.
24271 With following entry in @code{gnus-parameters}, @kbd{S x}
24272 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
24273 groups as spam and reports the to Gmane at group exit:
24277 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
24280 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
24281 because I don't read the groups directly from news.gmane.org, but
24282 through my local news server (leafnode). I.e. the article numbers are
24283 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
24284 the @code{X-Report-Spam} header to find the correct number.
24286 @node Spam Back Ends
24287 @subsection Spam Back Ends
24288 @cindex spam back ends
24290 The spam package offers a variety of back ends for detecting spam.
24291 Each back end defines a set of methods for detecting spam
24292 (@pxref{Filtering Incoming Mail}, @pxref{Detecting Spam in Groups}),
24293 and a pair of spam and ham processors (@pxref{Spam and Ham
24297 * Blacklists and Whitelists::
24298 * BBDB Whitelists::
24299 * Gmane Spam Reporting::
24300 * Anti-spam Hashcash Payments::
24302 * Regular Expressions Header Matching::
24304 * SpamAssassin back end::
24305 * ifile spam filtering::
24306 * Spam Statistics Filtering::
24310 @node Blacklists and Whitelists
24311 @subsubsection Blacklists and Whitelists
24312 @cindex spam filtering
24313 @cindex whitelists, spam filtering
24314 @cindex blacklists, spam filtering
24317 @defvar spam-use-blacklist
24319 Set this variable to @code{t} if you want to use blacklists when
24320 splitting incoming mail. Messages whose senders are in the blacklist
24321 will be sent to the @code{spam-split-group}. This is an explicit
24322 filter, meaning that it acts only on mail senders @emph{declared} to
24327 @defvar spam-use-whitelist
24329 Set this variable to @code{t} if you want to use whitelists when
24330 splitting incoming mail. Messages whose senders are not in the
24331 whitelist will be sent to the next spam-split rule. This is an
24332 explicit filter, meaning that unless someone is in the whitelist, their
24333 messages are not assumed to be spam or ham.
24337 @defvar spam-use-whitelist-exclusive
24339 Set this variable to @code{t} if you want to use whitelists as an
24340 implicit filter, meaning that every message will be considered spam
24341 unless the sender is in the whitelist. Use with care.
24345 @defvar gnus-group-spam-exit-processor-blacklist
24347 Add this symbol to a group's @code{spam-process} parameter by
24348 customizing the group parameters or the
24349 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24350 added to a group's @code{spam-process} parameter, the senders of
24351 spam-marked articles will be added to the blacklist.
24355 Instead of the obsolete
24356 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
24357 that you use @code{(spam spam-use-blacklist)}. Everything will work
24358 the same way, we promise.
24362 @defvar gnus-group-ham-exit-processor-whitelist
24364 Add this symbol to a group's @code{spam-process} parameter by
24365 customizing the group parameters or the
24366 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24367 added to a group's @code{spam-process} parameter, the senders of
24368 ham-marked articles in @emph{ham} groups will be added to the
24373 Instead of the obsolete
24374 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
24375 that you use @code{(ham spam-use-whitelist)}. Everything will work
24376 the same way, we promise.
24380 Blacklists are lists of regular expressions matching addresses you
24381 consider to be spam senders. For instance, to block mail from any
24382 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
24383 blacklist. You start out with an empty blacklist. Blacklist entries
24384 use the Emacs regular expression syntax.
24386 Conversely, whitelists tell Gnus what addresses are considered
24387 legitimate. All messages from whitelisted addresses are considered
24388 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
24389 Emacs regular expression syntax.
24391 The blacklist and whitelist file locations can be customized with the
24392 @code{spam-directory} variable (@file{~/News/spam} by default), or
24393 the @code{spam-whitelist} and @code{spam-blacklist} variables
24394 directly. The whitelist and blacklist files will by default be in the
24395 @code{spam-directory} directory, named @file{whitelist} and
24396 @file{blacklist} respectively.
24398 @node BBDB Whitelists
24399 @subsubsection BBDB Whitelists
24400 @cindex spam filtering
24401 @cindex BBDB whitelists, spam filtering
24402 @cindex BBDB, spam filtering
24405 @defvar spam-use-BBDB
24407 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
24408 Whitelists}), but uses the BBDB as the source of whitelisted
24409 addresses, without regular expressions. You must have the BBDB loaded
24410 for @code{spam-use-BBDB} to work properly. Messages whose senders are
24411 not in the BBDB will be sent to the next spam-split rule. This is an
24412 explicit filter, meaning that unless someone is in the BBDB, their
24413 messages are not assumed to be spam or ham.
24417 @defvar spam-use-BBDB-exclusive
24419 Set this variable to @code{t} if you want to use the BBDB as an
24420 implicit filter, meaning that every message will be considered spam
24421 unless the sender is in the BBDB. Use with care. Only sender
24422 addresses in the BBDB will be allowed through; all others will be
24423 classified as spammers.
24425 While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias
24426 for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is
24427 @emph{not} a separate back end. If you set
24428 @code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting
24433 @defvar gnus-group-ham-exit-processor-BBDB
24435 Add this symbol to a group's @code{spam-process} parameter by
24436 customizing the group parameters or the
24437 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24438 added to a group's @code{spam-process} parameter, the senders of
24439 ham-marked articles in @emph{ham} groups will be added to the
24444 Instead of the obsolete
24445 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
24446 that you use @code{(ham spam-use-BBDB)}. Everything will work
24447 the same way, we promise.
24451 @node Gmane Spam Reporting
24452 @subsubsection Gmane Spam Reporting
24453 @cindex spam reporting
24454 @cindex Gmane, spam reporting
24455 @cindex Gmane, spam reporting
24458 @defvar gnus-group-spam-exit-processor-report-gmane
24460 Add this symbol to a group's @code{spam-process} parameter by
24461 customizing the group parameters or the
24462 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24463 added to a group's @code{spam-process} parameter, the spam-marked
24464 articles groups will be reported to the Gmane administrators via a
24467 Gmane can be found at @uref{http://gmane.org}.
24471 Instead of the obsolete
24472 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
24473 that you use @code{(spam spam-use-gmane)}. Everything will work the
24474 same way, we promise.
24478 @defvar spam-report-gmane-use-article-number
24480 This variable is @code{t} by default. Set it to @code{nil} if you are
24481 running your own news server, for instance, and the local article
24482 numbers don't correspond to the Gmane article numbers. When
24483 @code{spam-report-gmane-use-article-number} is @code{nil},
24484 @code{spam-report.el} will fetch the number from the article headers.
24488 @defvar spam-report-user-mail-address
24490 Mail address exposed in the User-Agent spam reports to Gmane. It allows
24491 the Gmane administrators to contact you in case of misreports. The
24492 default is @code{user-mail-address}.
24496 @node Anti-spam Hashcash Payments
24497 @subsubsection Anti-spam Hashcash Payments
24498 @cindex spam filtering
24499 @cindex hashcash, spam filtering
24502 @defvar spam-use-hashcash
24504 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
24505 Whitelists}), but uses hashcash tokens for whitelisting messages
24506 instead of the sender address. Messages without a hashcash payment
24507 token will be sent to the next spam-split rule. This is an explicit
24508 filter, meaning that unless a hashcash token is found, the messages
24509 are not assumed to be spam or ham.
24514 @subsubsection Blackholes
24515 @cindex spam filtering
24516 @cindex blackholes, spam filtering
24519 @defvar spam-use-blackholes
24521 This option is disabled by default. You can let Gnus consult the
24522 blackhole-type distributed spam processing systems (DCC, for instance)
24523 when you set this option. The variable @code{spam-blackhole-servers}
24524 holds the list of blackhole servers Gnus will consult. The current
24525 list is fairly comprehensive, but make sure to let us know if it
24526 contains outdated servers.
24528 The blackhole check uses the @code{dig.el} package, but you can tell
24529 @code{spam.el} to use @code{dns.el} instead for better performance if
24530 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
24531 this time to set @code{spam-use-dig} to @code{nil} despite the
24532 possible performance improvements, because some users may be unable to
24533 use it, but you can try it and see if it works for you.
24537 @defvar spam-blackhole-servers
24539 The list of servers to consult for blackhole checks.
24543 @defvar spam-blackhole-good-server-regex
24545 A regular expression for IPs that should not be checked against the
24546 blackhole server list. When set to @code{nil}, it has no effect.
24550 @defvar spam-use-dig
24552 Use the @code{dig.el} package instead of the @code{dns.el} package.
24553 The default setting of @code{t} is recommended.
24557 Blackhole checks are done only on incoming mail. There is no spam or
24558 ham processor for blackholes.
24560 @node Regular Expressions Header Matching
24561 @subsubsection Regular Expressions Header Matching
24562 @cindex spam filtering
24563 @cindex regular expressions header matching, spam filtering
24566 @defvar spam-use-regex-headers
24568 This option is disabled by default. You can let Gnus check the
24569 message headers against lists of regular expressions when you set this
24570 option. The variables @code{spam-regex-headers-spam} and
24571 @code{spam-regex-headers-ham} hold the list of regular expressions.
24572 Gnus will check against the message headers to determine if the
24573 message is spam or ham, respectively.
24577 @defvar spam-regex-headers-spam
24579 The list of regular expressions that, when matched in the headers of
24580 the message, positively identify it as spam.
24584 @defvar spam-regex-headers-ham
24586 The list of regular expressions that, when matched in the headers of
24587 the message, positively identify it as ham.
24591 Regular expression header checks are done only on incoming mail.
24592 There is no specific spam or ham processor for regular expressions.
24595 @subsubsection Bogofilter
24596 @cindex spam filtering
24597 @cindex bogofilter, spam filtering
24600 @defvar spam-use-bogofilter
24602 Set this variable if you want @code{spam-split} to use Eric Raymond's
24605 With a minimum of care for associating the @samp{$} mark for spam
24606 articles only, Bogofilter training all gets fairly automatic. You
24607 should do this until you get a few hundreds of articles in each
24608 category, spam or not. The command @kbd{S t} in summary mode, either
24609 for debugging or for curiosity, shows the @emph{spamicity} score of
24610 the current article (between 0.0 and 1.0).
24612 Bogofilter determines if a message is spam based on a specific
24613 threshold. That threshold can be customized, consult the Bogofilter
24616 If the @code{bogofilter} executable is not in your path, Bogofilter
24617 processing will be turned off.
24619 You should not enable this if you use @code{spam-use-bogofilter-headers}.
24628 @findex spam-bogofilter-score
24629 Get the Bogofilter spamicity score (@code{spam-bogofilter-score}).
24632 @defvar spam-use-bogofilter-headers
24634 Set this variable if you want @code{spam-split} to use Eric Raymond's
24635 speedy Bogofilter, looking only at the message headers. It works
24636 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
24637 must be in the message already. Normally you would do this with a
24638 procmail recipe or something similar; consult the Bogofilter
24639 installation documents for details.
24641 You should not enable this if you use @code{spam-use-bogofilter}.
24645 @defvar gnus-group-spam-exit-processor-bogofilter
24646 Add this symbol to a group's @code{spam-process} parameter by
24647 customizing the group parameters or the
24648 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24649 added to a group's @code{spam-process} parameter, spam-marked articles
24650 will be added to the Bogofilter spam database.
24654 Instead of the obsolete
24655 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
24656 that you use @code{(spam spam-use-bogofilter)}. Everything will work
24657 the same way, we promise.
24660 @defvar gnus-group-ham-exit-processor-bogofilter
24661 Add this symbol to a group's @code{spam-process} parameter by
24662 customizing the group parameters or the
24663 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24664 added to a group's @code{spam-process} parameter, the ham-marked
24665 articles in @emph{ham} groups will be added to the Bogofilter database
24666 of non-spam messages.
24670 Instead of the obsolete
24671 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
24672 that you use @code{(ham spam-use-bogofilter)}. Everything will work
24673 the same way, we promise.
24676 @defvar spam-bogofilter-database-directory
24678 This is the directory where Bogofilter will store its databases. It
24679 is not specified by default, so Bogofilter will use its own default
24680 database directory.
24684 The Bogofilter mail classifier is similar to @command{ifile} in intent and
24685 purpose. A ham and a spam processor are provided, plus the
24686 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
24687 variables to indicate to spam-split that Bogofilter should either be
24688 used, or has already been used on the article. The 0.9.2.1 version of
24689 Bogofilter was used to test this functionality.
24691 @node SpamAssassin back end
24692 @subsubsection SpamAssassin back end
24693 @cindex spam filtering
24694 @cindex spamassassin, spam filtering
24697 @defvar spam-use-spamassassin
24699 Set this variable if you want @code{spam-split} to use SpamAssassin.
24701 SpamAssassin assigns a score to each article based on a set of rules
24702 and tests, including a Bayesian filter. The Bayesian filter can be
24703 trained by associating the @samp{$} mark for spam articles. The
24704 spam score can be viewed by using the command @kbd{S t} in summary
24707 If you set this variable, each article will be processed by
24708 SpamAssassin when @code{spam-split} is called. If your mail is
24709 preprocessed by SpamAssassin, and you want to just use the
24710 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
24713 You should not enable this if you use
24714 @code{spam-use-spamassassin-headers}.
24718 @defvar spam-use-spamassassin-headers
24720 Set this variable if your mail is preprocessed by SpamAssassin and
24721 want @code{spam-split} to split based on the SpamAssassin headers.
24723 You should not enable this if you use @code{spam-use-spamassassin}.
24727 @defvar spam-spamassassin-program
24729 This variable points to the SpamAssassin executable. If you have
24730 @code{spamd} running, you can set this variable to the @code{spamc}
24731 executable for faster processing. See the SpamAssassin documentation
24732 for more information on @code{spamd}/@code{spamc}.
24736 SpamAssassin is a powerful and flexible spam filter that uses a wide
24737 variety of tests to identify spam. A ham and a spam processors are
24738 provided, plus the @code{spam-use-spamassassin} and
24739 @code{spam-use-spamassassin-headers} variables to indicate to
24740 spam-split that SpamAssassin should be either used, or has already
24741 been used on the article. The 2.63 version of SpamAssassin was used
24742 to test this functionality.
24744 @node ifile spam filtering
24745 @subsubsection ifile spam filtering
24746 @cindex spam filtering
24747 @cindex ifile, spam filtering
24750 @defvar spam-use-ifile
24752 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
24753 statistical analyzer similar to Bogofilter.
24757 @defvar spam-ifile-all-categories
24759 Enable this variable if you want @code{spam-use-ifile} to give you all
24760 the ifile categories, not just spam/non-spam. If you use this, make
24761 sure you train ifile as described in its documentation.
24765 @defvar spam-ifile-spam-category
24767 This is the category of spam messages as far as ifile is concerned.
24768 The actual string used is irrelevant, but you probably want to leave
24769 the default value of @samp{spam}.
24772 @defvar spam-ifile-database
24774 This is the filename for the ifile database. It is not specified by
24775 default, so ifile will use its own default database name.
24779 The ifile mail classifier is similar to Bogofilter in intent and
24780 purpose. A ham and a spam processor are provided, plus the
24781 @code{spam-use-ifile} variable to indicate to spam-split that ifile
24782 should be used. The 1.2.1 version of ifile was used to test this
24785 @node Spam Statistics Filtering
24786 @subsubsection Spam Statistics Filtering
24787 @cindex spam filtering
24788 @cindex spam-stat, spam filtering
24792 This back end uses the Spam Statistics Emacs Lisp package to perform
24793 statistics-based filtering (@pxref{Spam Statistics Package}). Before
24794 using this, you may want to perform some additional steps to
24795 initialize your Spam Statistics dictionary. @xref{Creating a
24796 spam-stat dictionary}.
24798 @defvar spam-use-stat
24802 @defvar gnus-group-spam-exit-processor-stat
24803 Add this symbol to a group's @code{spam-process} parameter by
24804 customizing the group parameters or the
24805 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24806 added to a group's @code{spam-process} parameter, the spam-marked
24807 articles will be added to the spam-stat database of spam messages.
24811 Instead of the obsolete
24812 @code{gnus-group-spam-exit-processor-stat}, it is recommended
24813 that you use @code{(spam spam-use-stat)}. Everything will work
24814 the same way, we promise.
24817 @defvar gnus-group-ham-exit-processor-stat
24818 Add this symbol to a group's @code{spam-process} parameter by
24819 customizing the group parameters or the
24820 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24821 added to a group's @code{spam-process} parameter, the ham-marked
24822 articles in @emph{ham} groups will be added to the spam-stat database
24823 of non-spam messages.
24827 Instead of the obsolete
24828 @code{gnus-group-ham-exit-processor-stat}, it is recommended
24829 that you use @code{(ham spam-use-stat)}. Everything will work
24830 the same way, we promise.
24833 This enables @code{spam.el} to cooperate with @file{spam-stat.el}.
24834 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
24835 which unlike ifile or Bogofilter does not require external programs.
24836 A spam and a ham processor, and the @code{spam-use-stat} variable for
24837 @code{spam-split} are provided.
24840 @subsubsection Using SpamOracle with Gnus
24841 @cindex spam filtering
24845 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
24846 statistical mail filtering tool written by Xavier Leroy and needs to be
24847 installed separately.
24849 There are several ways to use SpamOracle with Gnus. In all cases, your
24850 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
24851 then enter an @samp{X-Spam} header indicating whether it regards the
24852 mail as a spam mail or not.
24854 One possibility is to run SpamOracle as a @code{:prescript} from the
24855 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
24856 the advantage that the user can see the @emph{X-Spam} headers.
24858 The easiest method is to make @file{spam.el} (@pxref{Spam Package})
24861 @vindex spam-use-spamoracle
24862 To enable SpamOracle usage by @code{spam.el}, set the variable
24863 @code{spam-use-spamoracle} to @code{t} and configure the
24864 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}. @xref{Spam
24865 Package}. In this example the @samp{INBOX} of an nnimap server is
24866 filtered using SpamOracle. Mails recognized as spam mails will be
24867 moved to @code{spam-split-group}, @samp{Junk} in this case. Ham
24868 messages stay in @samp{INBOX}:
24871 (setq spam-use-spamoracle t
24872 spam-split-group "Junk"
24873 nnimap-split-inbox '("INBOX")
24874 nnimap-split-rule 'nnimap-split-fancy
24875 nnimap-split-fancy '(| (: spam-split) "INBOX"))
24878 @defvar spam-use-spamoracle
24879 Set to @code{t} if you want Gnus to enable spam filtering using
24883 @defvar spam-spamoracle-binary
24884 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
24885 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
24889 @defvar spam-spamoracle-database
24890 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
24891 store its analysis. This is controlled by the variable
24892 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
24893 the default SpamOracle database will be used. In case you want your
24894 database to live somewhere special, set
24895 @code{spam-spamoracle-database} to this path.
24898 SpamOracle employs a statistical algorithm to determine whether a
24899 message is spam or ham. In order to get good results, meaning few
24900 false hits or misses, SpamOracle needs training. SpamOracle learns
24901 the characteristics of your spam mails. Using the @emph{add} mode
24902 (training mode) one has to feed good (ham) and spam mails to
24903 SpamOracle. This can be done by pressing @kbd{|} in the Summary
24904 buffer and pipe the mail to a SpamOracle process or using
24905 @file{spam.el}'s spam- and ham-processors, which is much more
24906 convenient. For a detailed description of spam- and ham-processors,
24907 @xref{Spam Package}.
24909 @defvar gnus-group-spam-exit-processor-spamoracle
24910 Add this symbol to a group's @code{spam-process} parameter by
24911 customizing the group parameter or the
24912 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
24913 to a group's @code{spam-process} parameter, spam-marked articles will be
24914 sent to SpamOracle as spam samples.
24918 Instead of the obsolete
24919 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
24920 that you use @code{(spam spam-use-spamoracle)}. Everything will work
24921 the same way, we promise.
24924 @defvar gnus-group-ham-exit-processor-spamoracle
24925 Add this symbol to a group's @code{spam-process} parameter by
24926 customizing the group parameter or the
24927 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
24928 to a group's @code{spam-process} parameter, the ham-marked articles in
24929 @emph{ham} groups will be sent to the SpamOracle as samples of ham
24934 Instead of the obsolete
24935 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
24936 that you use @code{(ham spam-use-spamoracle)}. Everything will work
24937 the same way, we promise.
24940 @emph{Example:} These are the Group Parameters of a group that has been
24941 classified as a ham group, meaning that it should only contain ham
24944 ((spam-contents gnus-group-spam-classification-ham)
24945 (spam-process ((ham spam-use-spamoracle)
24946 (spam spam-use-spamoracle))))
24948 For this group the @code{spam-use-spamoracle} is installed for both
24949 ham and spam processing. If the group contains spam message
24950 (e.g. because SpamOracle has not had enough sample messages yet) and
24951 the user marks some messages as spam messages, these messages will be
24952 processed by SpamOracle. The processor sends the messages to
24953 SpamOracle as new samples for spam.
24955 @node Extending the Spam package
24956 @subsection Extending the Spam package
24957 @cindex spam filtering
24958 @cindex spam elisp package, extending
24959 @cindex extending the spam elisp package
24961 Say you want to add a new back end called blackbox. For filtering
24962 incoming mail, provide the following:
24970 (defvar spam-use-blackbox nil
24971 "True if blackbox should be used.")
24974 Write @code{spam-check-blackbox} if Blackbox can check incoming mail.
24976 Write @code{spam-blackbox-register-routine} and
24977 @code{spam-blackbox-unregister-routine} using the bogofilter
24978 register/unregister routines as a start, or other restister/unregister
24979 routines more appropriate to Blackbox, if Blackbox can
24980 register/unregister spam and ham.
24985 The @code{spam-check-blackbox} function should return @samp{nil} or
24986 @code{spam-split-group}, observing the other conventions. See the
24987 existing @code{spam-check-*} functions for examples of what you can
24988 do, and stick to the template unless you fully understand the reasons
24993 For processing spam and ham messages, provide the following:
25000 Note you don't have to provide a spam or a ham processor. Only
25001 provide them if Blackbox supports spam or ham processing.
25003 Also, ham and spam processors are being phased out as single
25004 variables. Instead the form @code{(spam spam-use-blackbox)} or
25005 @code{(ham spam-use-blackbox)} is favored. For now, spam/ham
25006 processor variables are still around but they won't be for long.
25009 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
25010 "The Blackbox summary exit spam processor.
25011 Only applicable to spam groups.")
25013 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
25014 "The whitelist summary exit ham processor.
25015 Only applicable to non-spam (unclassified and ham) groups.")
25024 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
25025 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
25027 to the @code{spam-process} group parameter in @code{gnus.el}. Make
25028 sure you do it twice, once for the parameter and once for the
25029 variable customization.
25033 (variable-item spam-use-blackbox)
25035 to the @code{spam-autodetect-methods} group parameter in
25036 @code{gnus.el} if Blackbox can check incoming mail for spam contents.
25038 Finally, use the appropriate @code{spam-install-*-backend} function in
25039 @code{spam.el}. Here are the available functions.
25045 @code{spam-install-backend-alias}
25047 This function will simply install an alias for a back end that does
25048 everything like the original back end. It is currently only used to
25049 make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}.
25052 @code{spam-install-nocheck-backend}
25054 This function installs a back end that has no check function, but can
25055 register/unregister ham or spam. The @code{spam-use-gmane} back end is
25059 @code{spam-install-checkonly-backend}
25061 This function will install a back end that can only check incoming mail
25062 for spam contents. It can't register or unregister messages.
25063 @code{spam-use-blackholes} and @code{spam-use-hashcash} are such
25067 @code{spam-install-statistical-checkonly-backend}
25069 This function installs a statistical back end (one which requires the
25070 full body of a message to check it) that can only check incoming mail
25071 for contents. @code{spam-use-regex-body} is such a filter.
25074 @code{spam-install-statistical-backend}
25076 This function install a statistical back end with incoming checks and
25077 registration/unregistration routines. @code{spam-use-bogofilter} is
25081 @code{spam-install-backend}
25083 This is the most normal back end installation, where a back end that can
25084 check and register/unregister messages is set up without statistical
25085 abilities. The @code{spam-use-BBDB} is such a back end.
25088 @code{spam-install-mover-backend}
25090 Mover back ends are internal to @code{spam.el} and specifically move
25091 articles around when the summary is exited. You will very probably
25092 never install such a back end.
25097 @node Spam Statistics Package
25098 @subsection Spam Statistics Package
25099 @cindex Paul Graham
25100 @cindex Graham, Paul
25101 @cindex naive Bayesian spam filtering
25102 @cindex Bayesian spam filtering, naive
25103 @cindex spam filtering, naive Bayesian
25105 Paul Graham has written an excellent essay about spam filtering using
25106 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
25107 Spam}. In it he describes the inherent deficiency of rule-based
25108 filtering as used by SpamAssassin, for example: Somebody has to write
25109 the rules, and everybody else has to install these rules. You are
25110 always late. It would be much better, he argues, to filter mail based
25111 on whether it somehow resembles spam or non-spam. One way to measure
25112 this is word distribution. He then goes on to describe a solution
25113 that checks whether a new mail resembles any of your other spam mails
25116 The basic idea is this: Create a two collections of your mail, one
25117 with spam, one with non-spam. Count how often each word appears in
25118 either collection, weight this by the total number of mails in the
25119 collections, and store this information in a dictionary. For every
25120 word in a new mail, determine its probability to belong to a spam or a
25121 non-spam mail. Use the 15 most conspicuous words, compute the total
25122 probability of the mail being spam. If this probability is higher
25123 than a certain threshold, the mail is considered to be spam.
25125 The Spam Statistics package adds support to Gnus for this kind of
25126 filtering. It can be used as one of the back ends of the Spam package
25127 (@pxref{Spam Package}), or by itself.
25129 Before using the Spam Statistics package, you need to set it up.
25130 First, you need two collections of your mail, one with spam, one with
25131 non-spam. Then you need to create a dictionary using these two
25132 collections, and save it. And last but not least, you need to use
25133 this dictionary in your fancy mail splitting rules.
25136 * Creating a spam-stat dictionary::
25137 * Splitting mail using spam-stat::
25138 * Low-level interface to the spam-stat dictionary::
25141 @node Creating a spam-stat dictionary
25142 @subsubsection Creating a spam-stat dictionary
25144 Before you can begin to filter spam based on statistics, you must
25145 create these statistics based on two mail collections, one with spam,
25146 one with non-spam. These statistics are then stored in a dictionary
25147 for later use. In order for these statistics to be meaningful, you
25148 need several hundred emails in both collections.
25150 Gnus currently supports only the nnml back end for automated dictionary
25151 creation. The nnml back end stores all mails in a directory, one file
25152 per mail. Use the following:
25154 @defun spam-stat-process-spam-directory
25155 Create spam statistics for every file in this directory. Every file
25156 is treated as one spam mail.
25159 @defun spam-stat-process-non-spam-directory
25160 Create non-spam statistics for every file in this directory. Every
25161 file is treated as one non-spam mail.
25164 Usually you would call @code{spam-stat-process-spam-directory} on a
25165 directory such as @file{~/Mail/mail/spam} (this usually corresponds to
25166 the group @samp{nnml:mail.spam}), and you would call
25167 @code{spam-stat-process-non-spam-directory} on a directory such as
25168 @file{~/Mail/mail/misc} (this usually corresponds to the group
25169 @samp{nnml:mail.misc}).
25171 When you are using @acronym{IMAP}, you won't have the mails available
25172 locally, so that will not work. One solution is to use the Gnus Agent
25173 to cache the articles. Then you can use directories such as
25174 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
25175 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
25178 This variable holds the hash-table with all the statistics---the
25179 dictionary we have been talking about. For every word in either
25180 collection, this hash-table stores a vector describing how often the
25181 word appeared in spam and often it appeared in non-spam mails.
25184 If you want to regenerate the statistics from scratch, you need to
25185 reset the dictionary.
25187 @defun spam-stat-reset
25188 Reset the @code{spam-stat} hash-table, deleting all the statistics.
25191 When you are done, you must save the dictionary. The dictionary may
25192 be rather large. If you will not update the dictionary incrementally
25193 (instead, you will recreate it once a month, for example), then you
25194 can reduce the size of the dictionary by deleting all words that did
25195 not appear often enough or that do not clearly belong to only spam or
25196 only non-spam mails.
25198 @defun spam-stat-reduce-size
25199 Reduce the size of the dictionary. Use this only if you do not want
25200 to update the dictionary incrementally.
25203 @defun spam-stat-save
25204 Save the dictionary.
25207 @defvar spam-stat-file
25208 The filename used to store the dictionary. This defaults to
25209 @file{~/.spam-stat.el}.
25212 @node Splitting mail using spam-stat
25213 @subsubsection Splitting mail using spam-stat
25215 This section describes how to use the Spam statistics
25216 @emph{independently} of the @xref{Spam Package}.
25218 First, add the following to your @file{~/.gnus.el} file:
25221 (require 'spam-stat)
25225 This will load the necessary Gnus code, and the dictionary you
25228 Next, you need to adapt your fancy splitting rules: You need to
25229 determine how to use @code{spam-stat}. The following examples are for
25230 the nnml back end. Using the nnimap back end works just as well. Just
25231 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
25233 In the simplest case, you only have two groups, @samp{mail.misc} and
25234 @samp{mail.spam}. The following expression says that mail is either
25235 spam or it should go into @samp{mail.misc}. If it is spam, then
25236 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
25239 (setq nnmail-split-fancy
25240 `(| (: spam-stat-split-fancy)
25244 @defvar spam-stat-split-fancy-spam-group
25245 The group to use for spam. Default is @samp{mail.spam}.
25248 If you also filter mail with specific subjects into other groups, use
25249 the following expression. Only mails not matching the regular
25250 expression are considered potential spam.
25253 (setq nnmail-split-fancy
25254 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
25255 (: spam-stat-split-fancy)
25259 If you want to filter for spam first, then you must be careful when
25260 creating the dictionary. Note that @code{spam-stat-split-fancy} must
25261 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
25262 non-spam, therefore both should be in your collection of non-spam
25263 mails, when creating the dictionary!
25266 (setq nnmail-split-fancy
25267 `(| (: spam-stat-split-fancy)
25268 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25272 You can combine this with traditional filtering. Here, we move all
25273 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
25274 @code{spam-stat-split-fancy} will never see them, the mails in
25275 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
25276 nor in your collection of non-spam mails, when creating the
25280 (setq nnmail-split-fancy
25281 `(| ("Content-Type" "text/html" "mail.spam.filtered")
25282 (: spam-stat-split-fancy)
25283 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25288 @node Low-level interface to the spam-stat dictionary
25289 @subsubsection Low-level interface to the spam-stat dictionary
25291 The main interface to using @code{spam-stat}, are the following functions:
25293 @defun spam-stat-buffer-is-spam
25294 Called in a buffer, that buffer is considered to be a new spam mail.
25295 Use this for new mail that has not been processed before.
25298 @defun spam-stat-buffer-is-no-spam
25299 Called in a buffer, that buffer is considered to be a new non-spam
25300 mail. Use this for new mail that has not been processed before.
25303 @defun spam-stat-buffer-change-to-spam
25304 Called in a buffer, that buffer is no longer considered to be normal
25305 mail but spam. Use this to change the status of a mail that has
25306 already been processed as non-spam.
25309 @defun spam-stat-buffer-change-to-non-spam
25310 Called in a buffer, that buffer is no longer considered to be spam but
25311 normal mail. Use this to change the status of a mail that has already
25312 been processed as spam.
25315 @defun spam-stat-save
25316 Save the hash table to the file. The filename used is stored in the
25317 variable @code{spam-stat-file}.
25320 @defun spam-stat-load
25321 Load the hash table from a file. The filename used is stored in the
25322 variable @code{spam-stat-file}.
25325 @defun spam-stat-score-word
25326 Return the spam score for a word.
25329 @defun spam-stat-score-buffer
25330 Return the spam score for a buffer.
25333 @defun spam-stat-split-fancy
25334 Use this function for fancy mail splitting. Add the rule @samp{(:
25335 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
25338 Make sure you load the dictionary before using it. This requires the
25339 following in your @file{~/.gnus.el} file:
25342 (require 'spam-stat)
25346 Typical test will involve calls to the following functions:
25349 Reset: (setq spam-stat (make-hash-table :test 'equal))
25350 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25351 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25352 Save table: (spam-stat-save)
25353 File size: (nth 7 (file-attributes spam-stat-file))
25354 Number of words: (hash-table-count spam-stat)
25355 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25356 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25357 Reduce table size: (spam-stat-reduce-size)
25358 Save table: (spam-stat-save)
25359 File size: (nth 7 (file-attributes spam-stat-file))
25360 Number of words: (hash-table-count spam-stat)
25361 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25362 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25365 Here is how you would create your dictionary:
25368 Reset: (setq spam-stat (make-hash-table :test 'equal))
25369 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25370 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25371 Repeat for any other non-spam group you need...
25372 Reduce table size: (spam-stat-reduce-size)
25373 Save table: (spam-stat-save)
25377 @section Interaction with other modes
25382 @code{gnus-dired-minor-mode} provides some useful functions for dired
25383 buffers. It is enabled with
25385 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
25390 @findex gnus-dired-attach
25391 @cindex attachments, selection via dired
25392 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
25393 You will be prompted for a message buffer.
25396 @findex gnus-dired-find-file-mailcap
25397 Visit a file according to the appropriate mailcap entry
25398 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
25402 @findex gnus-dired-print
25403 Print file according to the mailcap entry (@code{gnus-dired-print}). If
25404 there is no print command, print in a PostScript image.
25407 @node Various Various
25408 @section Various Various
25414 @item gnus-home-directory
25415 @vindex gnus-home-directory
25416 All Gnus file and directory variables will be initialized from this
25417 variable, which defaults to @file{~/}.
25419 @item gnus-directory
25420 @vindex gnus-directory
25421 Most Gnus storage file and directory variables will be initialized from
25422 this variable, which defaults to the @env{SAVEDIR} environment
25423 variable, or @file{~/News/} if that variable isn't set.
25425 Note that Gnus is mostly loaded when the @file{~/.gnus.el} file is read.
25426 This means that other directory variables that are initialized from this
25427 variable won't be set properly if you set this variable in
25428 @file{~/.gnus.el}. Set this variable in @file{.emacs} instead.
25430 @item gnus-default-directory
25431 @vindex gnus-default-directory
25432 Not related to the above variable at all---this variable says what the
25433 default directory of all Gnus buffers should be. If you issue commands
25434 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
25435 default directory. If this variable is @code{nil} (which is the
25436 default), the default directory will be the default directory of the
25437 buffer you were in when you started Gnus.
25440 @vindex gnus-verbose
25441 This variable is an integer between zero and ten. The higher the value,
25442 the more messages will be displayed. If this variable is zero, Gnus
25443 will never flash any messages, if it is seven (which is the default),
25444 most important messages will be shown, and if it is ten, Gnus won't ever
25445 shut up, but will flash so many messages it will make your head swim.
25447 @item gnus-verbose-backends
25448 @vindex gnus-verbose-backends
25449 This variable works the same way as @code{gnus-verbose}, but it applies
25450 to the Gnus back ends instead of Gnus proper.
25452 @item nnheader-max-head-length
25453 @vindex nnheader-max-head-length
25454 When the back ends read straight heads of articles, they all try to read
25455 as little as possible. This variable (default 8192) specifies
25456 the absolute max length the back ends will try to read before giving up
25457 on finding a separator line between the head and the body. If this
25458 variable is @code{nil}, there is no upper read bound. If it is
25459 @code{t}, the back ends won't try to read the articles piece by piece,
25460 but read the entire articles. This makes sense with some versions of
25461 @code{ange-ftp} or @code{efs}.
25463 @item nnheader-head-chop-length
25464 @vindex nnheader-head-chop-length
25465 This variable (default 2048) says how big a piece of each article to
25466 read when doing the operation described above.
25468 @item nnheader-file-name-translation-alist
25469 @vindex nnheader-file-name-translation-alist
25471 @cindex invalid characters in file names
25472 @cindex characters in file names
25473 This is an alist that says how to translate characters in file names.
25474 For instance, if @samp{:} is invalid as a file character in file names
25475 on your system (you OS/2 user you), you could say something like:
25479 (setq nnheader-file-name-translation-alist
25484 In fact, this is the default value for this variable on OS/2 and MS
25485 Windows (phooey) systems.
25487 @item gnus-hidden-properties
25488 @vindex gnus-hidden-properties
25489 This is a list of properties to use to hide ``invisible'' text. It is
25490 @code{(invisible t intangible t)} by default on most systems, which
25491 makes invisible text invisible and intangible.
25493 @item gnus-parse-headers-hook
25494 @vindex gnus-parse-headers-hook
25495 A hook called before parsing headers. It can be used, for instance, to
25496 gather statistics on the headers fetched, or perhaps you'd like to prune
25497 some headers. I don't see why you'd want that, though.
25499 @item gnus-shell-command-separator
25500 @vindex gnus-shell-command-separator
25501 String used to separate two shell commands. The default is @samp{;}.
25503 @item gnus-invalid-group-regexp
25504 @vindex gnus-invalid-group-regexp
25506 Regexp to match ``invalid'' group names when querying user for a group
25507 name. The default value catches some @strong{really} invalid group
25508 names who could possibly mess up Gnus internally (like allowing
25509 @samp{:} in a group name, which is normally used to delimit method and
25512 @acronym{IMAP} users might want to allow @samp{/} in group names though.
25520 Well, that's the manual---you can get on with your life now. Keep in
25521 touch. Say hello to your cats from me.
25523 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
25525 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
25531 Not because of victories @*
25534 but for the common sunshine,@*
25536 the largess of the spring.
25540 but for the day's work done@*
25541 as well as I was able;@*
25542 not for a seat upon the dais@*
25543 but at the common table.@*
25548 @chapter Appendices
25551 * XEmacs:: Requirements for installing under XEmacs.
25552 * History:: How Gnus got where it is today.
25553 * On Writing Manuals:: Why this is not a beginner's guide.
25554 * Terminology:: We use really difficult, like, words here.
25555 * Customization:: Tailoring Gnus to your needs.
25556 * Troubleshooting:: What you might try if things do not work.
25557 * Gnus Reference Guide:: Rilly, rilly technical stuff.
25558 * Emacs for Heathens:: A short introduction to Emacsian terms.
25559 * Frequently Asked Questions:: The Gnus FAQ
25566 @cindex installing under XEmacs
25568 XEmacs is distributed as a collection of packages. You should install
25569 whatever packages the Gnus XEmacs package requires. The current
25570 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
25571 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
25572 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{W3},
25573 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
25580 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
25581 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
25583 If you want to investigate the person responsible for this outrage,
25584 you can point your (feh!) web browser to
25585 @uref{http://quimby.gnus.org/}. This is also the primary
25586 distribution point for the new and spiffy versions of Gnus, and is
25587 known as The Site That Destroys Newsrcs And Drives People Mad.
25589 During the first extended alpha period of development, the new Gnus was
25590 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
25591 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
25592 (Besides, the ``Gnus'' in this abbreviation should probably be
25593 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
25594 appropriate name, don't you think?)
25596 In any case, after spending all that energy on coming up with a new and
25597 spunky name, we decided that the name was @emph{too} spunky, so we
25598 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
25599 ``@sc{gnus}''. New vs. old.
25602 * Gnus Versions:: What Gnus versions have been released.
25603 * Other Gnus Versions:: Other Gnus versions that also have been released.
25604 * Why?:: What's the point of Gnus?
25605 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
25606 * Conformity:: Gnus tries to conform to all standards.
25607 * Emacsen:: Gnus can be run on a few modern Emacsen.
25608 * Gnus Development:: How Gnus is developed.
25609 * Contributors:: Oodles of people.
25610 * New Features:: Pointers to some of the new stuff in Gnus.
25614 @node Gnus Versions
25615 @subsection Gnus Versions
25617 @cindex September Gnus
25619 @cindex Quassia Gnus
25620 @cindex Pterodactyl Gnus
25623 @cindex Gnus versions
25625 The first ``proper'' release of Gnus 5 was done in November 1995 when it
25626 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
25627 plus 15 Gnus 5.0 releases).
25629 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
25630 releases)) was released under the name ``Gnus 5.2'' (40 releases).
25632 On July 28th 1996 work on Red Gnus was begun, and it was released on
25633 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
25635 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
25636 It was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
25638 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
25639 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
25642 On the 26th of October 2000, Oort Gnus was begun and was released as
25643 Gnus 5.10 on May 1st 2003 (24 releases).
25645 On the January 4th 2004, No Gnus was begun.
25647 If you happen upon a version of Gnus that has a prefixed name --
25648 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
25649 ``Pterodactyl Gnus'', ``Oort Gnus'', ``No Gnus'' -- don't panic.
25650 Don't let it know that you're frightened. Back away. Slowly. Whatever
25651 you do, don't run. Walk away, calmly, until you're out of its reach.
25652 Find a proper released version of Gnus and snuggle up to that instead.
25655 @node Other Gnus Versions
25656 @subsection Other Gnus Versions
25659 In addition to the versions of Gnus which have had their releases
25660 coordinated by Lars, one major development has been Semi-gnus from
25661 Japan. It's based on a library called @acronym{SEMI}, which provides
25662 @acronym{MIME} capabilities.
25664 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
25665 Collectively, they are called ``Semi-gnus'', and different strains are
25666 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
25667 @acronym{MIME} and multilingualization things, especially important for
25674 What's the point of Gnus?
25676 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
25677 newsreader, that lets you do anything you can think of. That was my
25678 original motivation, but while working on Gnus, it has become clear to
25679 me that this generation of newsreaders really belong in the stone age.
25680 Newsreaders haven't developed much since the infancy of the net. If the
25681 volume continues to rise with the current rate of increase, all current
25682 newsreaders will be pretty much useless. How do you deal with
25683 newsgroups that have thousands of new articles each day? How do you
25684 keep track of millions of people who post?
25686 Gnus offers no real solutions to these questions, but I would very much
25687 like to see Gnus being used as a testing ground for new methods of
25688 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
25689 to separate the newsreader from the back ends, Gnus now offers a simple
25690 interface for anybody who wants to write new back ends for fetching mail
25691 and news from different sources. I have added hooks for customizations
25692 everywhere I could imagine it being useful. By doing so, I'm inviting
25693 every one of you to explore and invent.
25695 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
25696 @kbd{C-u 100 M-x all-hail-xemacs}.
25699 @node Compatibility
25700 @subsection Compatibility
25702 @cindex compatibility
25703 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
25704 bindings have been kept. More key bindings have been added, of course,
25705 but only in one or two obscure cases have old bindings been changed.
25710 @center In a cloud bones of steel.
25714 All commands have kept their names. Some internal functions have changed
25717 The @code{gnus-uu} package has changed drastically. @xref{Decoding
25720 One major compatibility question is the presence of several summary
25721 buffers. All variables relevant while reading a group are
25722 buffer-local to the summary buffer they belong in. Although many
25723 important variables have their values copied into their global
25724 counterparts whenever a command is executed in the summary buffer, this
25725 change might lead to incorrect values being used unless you are careful.
25727 All code that relies on knowledge of @sc{gnus} internals will probably
25728 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
25729 changing it in any way, as a matter of fact) is strictly verboten. Gnus
25730 maintains a hash table that points to the entries in this alist (which
25731 speeds up many functions), and changing the alist directly will lead to
25735 @cindex highlighting
25736 Old hilit19 code does not work at all. In fact, you should probably
25737 remove all hilit code from all Gnus hooks
25738 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
25739 Gnus provides various integrated functions for highlighting. These are
25740 faster and more accurate. To make life easier for everybody, Gnus will
25741 by default remove all hilit calls from all hilit hooks. Uncleanliness!
25744 Packages like @code{expire-kill} will no longer work. As a matter of
25745 fact, you should probably remove all old @sc{gnus} packages (and other
25746 code) when you start using Gnus. More likely than not, Gnus already
25747 does what you have written code to make @sc{gnus} do. (Snicker.)
25749 Even though old methods of doing things are still supported, only the
25750 new methods are documented in this manual. If you detect a new method of
25751 doing something while reading this manual, that does not mean you have
25752 to stop doing it the old way.
25754 Gnus understands all @sc{gnus} startup files.
25756 @kindex M-x gnus-bug
25758 @cindex reporting bugs
25760 Overall, a casual user who hasn't written much code that depends on
25761 @sc{gnus} internals should suffer no problems. If problems occur,
25762 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
25764 @vindex gnus-bug-create-help-buffer
25765 If you are in the habit of sending bug reports @emph{very} often, you
25766 may find the helpful help buffer annoying after a while. If so, set
25767 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
25772 @subsection Conformity
25774 No rebels without a clue here, ma'am. We conform to all standards known
25775 to (wo)man. Except for those standards and/or conventions we disagree
25783 There are no known breaches of this standard.
25787 There are no known breaches of this standard, either.
25789 @item Son-of-RFC 1036
25790 @cindex Son-of-RFC 1036
25791 We do have some breaches to this one.
25797 These are considered to be ``vanity headers'', while I consider them
25798 to be consumer information. After seeing so many badly formatted
25799 articles coming from @code{tin} and @code{Netscape} I know not to use
25800 either of those for posting articles. I would not have known that if
25801 it wasn't for the @code{X-Newsreader} header.
25806 USEFOR is an IETF working group writing a successor to RFC 1036, based
25807 on Son-of-RFC 1036. They have produced a number of drafts proposing
25808 various changes to the format of news articles. The Gnus towers will
25809 look into implementing the changes when the draft is accepted as an RFC.
25811 @item MIME - RFC 2045-2049 etc
25812 @cindex @acronym{MIME}
25813 All the various @acronym{MIME} RFCs are supported.
25815 @item Disposition Notifications - RFC 2298
25816 Message Mode is able to request notifications from the receiver.
25818 @item PGP - RFC 1991 and RFC 2440
25821 RFC 1991 is the original @acronym{PGP} message specification,
25822 published as an informational RFC. RFC 2440 was the follow-up, now
25823 called Open PGP, and put on the Standards Track. Both document a
25824 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
25825 encoding (signing and encryption) and decoding (verification and
25828 @item PGP/MIME - RFC 2015/3156
25829 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
25830 1991) describes the @acronym{MIME}-wrapping around the RFC 1991/2440 format.
25831 Gnus supports both encoding and decoding.
25833 @item S/MIME - RFC 2633
25834 RFC 2633 describes the @acronym{S/MIME} format.
25836 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
25837 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
25838 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
25839 authentication for @acronym{IMAP}. RFC 2086 describes access control
25840 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
25841 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
25842 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
25843 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
25847 If you ever notice Gnus acting non-compliant with regards to the texts
25848 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
25853 @subsection Emacsen
25859 Gnus should work on:
25867 XEmacs 21.4 and up.
25871 This Gnus version will absolutely not work on any Emacsen older than
25872 that. Not reliably, at least. Older versions of Gnus may work on older
25873 Emacs versions. Particularly, Gnus 5.10.8 should also work on Emacs
25874 20.7 and XEmacs 21.1.
25876 There are some vague differences between Gnus on the various
25877 platforms---XEmacs features more graphics (a logo and a toolbar)---but
25878 other than that, things should look pretty much the same under all
25882 @node Gnus Development
25883 @subsection Gnus Development
25885 Gnus is developed in a two-phased cycle. The first phase involves much
25886 discussion on the @samp{ding@@gnus.org} mailing list, where people
25887 propose changes and new features, post patches and new back ends. This
25888 phase is called the @dfn{alpha} phase, since the Gnusae released in this
25889 phase are @dfn{alpha releases}, or (perhaps more commonly in other
25890 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
25891 unstable and should not be used by casual users. Gnus alpha releases
25892 have names like ``Red Gnus'' and ``Quassia Gnus''.
25894 After futzing around for 50-100 alpha releases, Gnus is declared
25895 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
25896 and is called things like ``Gnus 5.6.32'' instead. Normal people are
25897 supposed to be able to use these, and these are mostly discussed on the
25898 @samp{gnu.emacs.gnus} newsgroup.
25901 @vindex mail-source-delete-incoming
25902 Some variable defaults differ between alpha Gnusae and released Gnusae.
25903 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
25904 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
25905 lossage of mail if an alpha release hiccups while handling the mail.
25907 The division of discussion between the ding mailing list and the Gnus
25908 newsgroup is not purely based on publicity concerns. It's true that
25909 having people write about the horrible things that an alpha Gnus release
25910 can do (sometimes) in a public forum may scare people off, but more
25911 importantly, talking about new experimental features that have been
25912 introduced may confuse casual users. New features are frequently
25913 introduced, fiddled with, and judged to be found wanting, and then
25914 either discarded or totally rewritten. People reading the mailing list
25915 usually keep up with these rapid changes, while people on the newsgroup
25916 can't be assumed to do so.
25921 @subsection Contributors
25922 @cindex contributors
25924 The new Gnus version couldn't have been done without the help of all the
25925 people on the (ding) mailing list. Every day for over a year I have
25926 gotten billions of nice bug reports from them, filling me with joy,
25927 every single one of them. Smooches. The people on the list have been
25928 tried beyond endurance, what with my ``oh, that's a neat idea <type
25929 type>, yup, I'll release it right away <ship off> no wait, that doesn't
25930 work at all <type type>, yup, I'll ship that one off right away <ship
25931 off> no, wait, that absolutely does not work'' policy for releases.
25932 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
25933 ``worser''? ``much worser''? ``worsest''?)
25935 I would like to take this opportunity to thank the Academy for@dots{} oops,
25941 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
25944 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
25945 nnwarchive and many, many other things connected with @acronym{MIME} and
25946 other types of en/decoding, as well as general bug fixing, new
25947 functionality and stuff.
25950 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
25951 well as numerous other things).
25954 Luis Fernandes---design and graphics.
25957 Joe Reiss---creator of the smiley faces.
25960 Justin Sheehy---the @acronym{FAQ} maintainer.
25963 Erik Naggum---help, ideas, support, code and stuff.
25966 Wes Hardaker---@file{gnus-picon.el} and the manual section on
25967 @dfn{picons} (@pxref{Picons}).
25970 Kim-Minh Kaplan---further work on the picon code.
25973 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
25976 Sudish Joseph---innumerable bug fixes.
25979 Ilja Weis---@file{gnus-topic.el}.
25982 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
25985 Vladimir Alexiev---the refcard and reference booklets.
25988 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
25989 distribution by Felix Lee and JWZ.
25992 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
25995 Peter Mutsaers---orphan article scoring code.
25998 Ken Raeburn---POP mail support.
26001 Hallvard B Furuseth---various bits and pieces, especially dealing with
26005 Brian Edmonds---@file{gnus-bbdb.el}.
26008 David Moore---rewrite of @file{nnvirtual.el} and many other things.
26011 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
26014 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
26015 well as autoconf support.
26019 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
26020 Borges, and Jost Krieger proof-reading parts of the manual.
26022 The following people have contributed many patches and suggestions:
26037 Jason L. Tibbitts, III,
26039 Katsumi Yamaoka, @c Yamaoka
26043 Also thanks to the following for patches and stuff:
26053 Alexei V. Barantsev,
26068 Massimo Campostrini,
26073 Jae-you Chung, @c ?
26074 James H. Cloos, Jr.,
26078 Andrew J. Cosgriff,
26081 Geoffrey T. Dairiki,
26087 Michael Welsh Duggan,
26092 Enami Tsugutomo, @c Enami
26096 Nelson Jose dos Santos Ferreira,
26104 Arne Georg Gleditsch,
26106 Michelangelo Grigni,
26110 Kenichi Handa, @c Handa
26112 Yoshiki Hayashi, @c Hayashi
26114 Hisashige Kenji, @c Hisashige
26121 Fran@,{c}ois Felix Ingrand,
26122 Tatsuya Ichikawa, @c Ichikawa
26123 Ishikawa Ichiro, @c Ishikawa
26125 Iwamuro Motonori, @c Iwamuro
26135 Peter Skov Knudsen,
26136 Shuhei Kobayashi, @c Kobayashi
26138 Koseki Yoshinori, @c Koseki
26139 Thor Kristoffersen,
26142 Seokchan Lee, @c Lee
26160 Morioka Tomohiko, @c Morioka
26161 Erik Toubro Nielsen,
26168 Masaharu Onishi, @c Onishi
26173 Jens-Ulrik Holger Petersen,
26177 John McClary Prevost,
26183 Lars Balker Rasmussen,
26188 Christian von Roques,
26191 Wolfgang Rupprecht,
26198 Philippe Schnoebelen,
26200 Randal L. Schwartz,
26214 Kiyokazu Suto, @c Suto
26219 Tozawa Akihiko, @c Tozawa
26239 For a full overview of what each person has done, the ChangeLogs
26240 included in the Gnus alpha distributions should give ample reading
26241 (550kB and counting).
26243 Apologies to everybody that I've forgotten, of which there are many, I'm
26246 Gee, that's quite a list of people. I guess that must mean that there
26247 actually are people who are using Gnus. Who'd'a thunk it!
26251 @subsection New Features
26252 @cindex new features
26255 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
26256 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
26257 * Red Gnus:: Third time best---Gnus 5.4/5.5.
26258 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
26259 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
26260 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
26261 * No Gnus:: Very punny.
26264 These lists are, of course, just @emph{short} overviews of the
26265 @emph{most} important new features. No, really. There are tons more.
26266 Yes, we have feeping creaturism in full effect.
26269 @subsubsection (ding) Gnus
26271 New features in Gnus 5.0/5.1:
26276 The look of all buffers can be changed by setting format-like variables
26277 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
26280 Local spool and several @acronym{NNTP} servers can be used at once
26281 (@pxref{Select Methods}).
26284 You can combine groups into virtual groups (@pxref{Virtual Groups}).
26287 You can read a number of different mail formats (@pxref{Getting Mail}).
26288 All the mail back ends implement a convenient mail expiry scheme
26289 (@pxref{Expiring Mail}).
26292 Gnus can use various strategies for gathering threads that have lost
26293 their roots (thereby gathering loose sub-threads into one thread) or it
26294 can go back and retrieve enough headers to build a complete thread
26295 (@pxref{Customizing Threading}).
26298 Killed groups can be displayed in the group buffer, and you can read
26299 them as well (@pxref{Listing Groups}).
26302 Gnus can do partial group updates---you do not have to retrieve the
26303 entire active file just to check for new articles in a few groups
26304 (@pxref{The Active File}).
26307 Gnus implements a sliding scale of subscribedness to groups
26308 (@pxref{Group Levels}).
26311 You can score articles according to any number of criteria
26312 (@pxref{Scoring}). You can even get Gnus to find out how to score
26313 articles for you (@pxref{Adaptive Scoring}).
26316 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
26317 manner, so it should be difficult to lose much data on what you have
26318 read if your machine should go down (@pxref{Auto Save}).
26321 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
26322 cluttering up the @file{.emacs} file.
26325 You can set the process mark on both groups and articles and perform
26326 operations on all the marked items (@pxref{Process/Prefix}).
26329 You can grep through a subset of groups and create a group from the
26330 results (@pxref{Kibozed Groups}).
26333 You can list subsets of groups according to, well, anything
26334 (@pxref{Listing Groups}).
26337 You can browse foreign servers and subscribe to groups from those
26338 servers (@pxref{Browse Foreign Server}).
26341 Gnus can fetch articles, asynchronously, on a second connection to the
26342 server (@pxref{Asynchronous Fetching}).
26345 You can cache articles locally (@pxref{Article Caching}).
26348 The uudecode functions have been expanded and generalized
26349 (@pxref{Decoding Articles}).
26352 You can still post uuencoded articles, which was a little-known feature
26353 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
26356 Fetching parents (and other articles) now actually works without
26357 glitches (@pxref{Finding the Parent}).
26360 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
26363 Digests (and other files) can be used as the basis for groups
26364 (@pxref{Document Groups}).
26367 Articles can be highlighted and customized (@pxref{Customizing
26371 URLs and other external references can be buttonized (@pxref{Article
26375 You can do lots of strange stuff with the Gnus window & frame
26376 configuration (@pxref{Window Layout}).
26379 You can click on buttons instead of using the keyboard
26385 @node September Gnus
26386 @subsubsection September Gnus
26390 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
26394 New features in Gnus 5.2/5.3:
26399 A new message composition mode is used. All old customization variables
26400 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
26404 Gnus is now able to generate @dfn{sparse} threads---threads where
26405 missing articles are represented by empty nodes (@pxref{Customizing
26409 (setq gnus-build-sparse-threads 'some)
26413 Outgoing articles are stored on a special archive server
26414 (@pxref{Archived Messages}).
26417 Partial thread regeneration now happens when articles are
26421 Gnus can make use of GroupLens predictions.
26424 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
26427 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
26430 (setq gnus-use-trees t)
26434 An @code{nn}-like pick-and-read minor mode is available for the summary
26435 buffers (@pxref{Pick and Read}).
26438 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
26442 In binary groups you can use a special binary minor mode (@pxref{Binary
26446 Groups can be grouped in a folding topic hierarchy (@pxref{Group
26450 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
26454 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
26457 Groups can now have a score, and bubbling based on entry frequency
26458 is possible (@pxref{Group Score}).
26461 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
26465 Groups can be process-marked, and commands can be performed on
26466 groups of groups (@pxref{Marking Groups}).
26469 Caching is possible in virtual groups.
26472 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
26473 news batches, ClariNet briefs collections, and just about everything
26474 else (@pxref{Document Groups}).
26477 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
26481 The Gnus cache is much faster.
26484 Groups can be sorted according to many criteria (@pxref{Sorting
26488 New group parameters have been introduced to set list-addresses and
26489 expiry times (@pxref{Group Parameters}).
26492 All formatting specs allow specifying faces to be used
26493 (@pxref{Formatting Fonts}).
26496 There are several more commands for setting/removing/acting on process
26497 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
26500 The summary buffer can be limited to show parts of the available
26501 articles based on a wide range of criteria. These commands have been
26502 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
26505 Articles can be made persistent with the @kbd{*} command
26506 (@pxref{Persistent Articles}).
26509 All functions for hiding article elements are now toggles.
26512 Article headers can be buttonized (@pxref{Article Washing}).
26515 All mail back ends support fetching articles by @code{Message-ID}.
26518 Duplicate mail can now be treated properly (@pxref{Duplicates}).
26521 All summary mode commands are available directly from the article
26522 buffer (@pxref{Article Keymap}).
26525 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
26529 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
26532 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
26537 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
26540 (setq gnus-use-nocem t)
26544 Groups can be made permanently visible (@pxref{Listing Groups}).
26547 (setq gnus-permanently-visible-groups "^nnml:")
26551 Many new hooks have been introduced to make customizing easier.
26554 Gnus respects the @code{Mail-Copies-To} header.
26557 Threads can be gathered by looking at the @code{References} header
26558 (@pxref{Customizing Threading}).
26561 (setq gnus-summary-thread-gathering-function
26562 'gnus-gather-threads-by-references)
26566 Read articles can be stored in a special backlog buffer to avoid
26567 refetching (@pxref{Article Backlog}).
26570 (setq gnus-keep-backlog 50)
26574 A clean copy of the current article is always stored in a separate
26575 buffer to allow easier treatment.
26578 Gnus can suggest where to save articles (@pxref{Saving Articles}).
26581 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
26585 (setq gnus-prompt-before-saving t)
26589 @code{gnus-uu} can view decoded files asynchronously while fetching
26590 articles (@pxref{Other Decode Variables}).
26593 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
26597 Filling in the article buffer now works properly on cited text
26598 (@pxref{Article Washing}).
26601 Hiding cited text adds buttons to toggle hiding, and how much
26602 cited text to hide is now customizable (@pxref{Article Hiding}).
26605 (setq gnus-cited-lines-visible 2)
26609 Boring headers can be hidden (@pxref{Article Hiding}).
26612 Default scoring values can now be set from the menu bar.
26615 Further syntax checking of outgoing articles have been added.
26621 @subsubsection Red Gnus
26623 New features in Gnus 5.4/5.5:
26627 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
26634 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
26637 Article prefetching functionality has been moved up into
26638 Gnus (@pxref{Asynchronous Fetching}).
26641 Scoring can now be performed with logical operators like @code{and},
26642 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
26646 Article washing status can be displayed in the
26647 article mode line (@pxref{Misc Article}).
26650 @file{gnus.el} has been split into many smaller files.
26653 Suppression of duplicate articles based on Message-ID can be done
26654 (@pxref{Duplicate Suppression}).
26657 (setq gnus-suppress-duplicates t)
26661 New variables for specifying what score and adapt files are to be
26662 considered home score and adapt files (@pxref{Home Score File}) have
26666 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
26667 Server Internals}).
26670 Groups can inherit group parameters from parent topics (@pxref{Topic
26674 Article editing has been revamped and is now actually usable.
26677 Signatures can be recognized in more intelligent fashions
26678 (@pxref{Article Signature}).
26681 Summary pick mode has been made to look more @code{nn}-like. Line
26682 numbers are displayed and the @kbd{.} command can be used to pick
26683 articles (@code{Pick and Read}).
26686 Commands for moving the @file{.newsrc.eld} from one server to
26687 another have been added (@pxref{Changing Servers}).
26690 There's a way now to specify that ``uninteresting'' fields be suppressed
26691 when generating lines in buffers (@pxref{Advanced Formatting}).
26694 Several commands in the group buffer can be undone with @kbd{C-M-_}
26698 Scoring can be done on words using the new score type @code{w}
26699 (@pxref{Score File Format}).
26702 Adaptive scoring can be done on a Subject word-by-word basis
26703 (@pxref{Adaptive Scoring}).
26706 (setq gnus-use-adaptive-scoring '(word))
26710 Scores can be decayed (@pxref{Score Decays}).
26713 (setq gnus-decay-scores t)
26717 Scoring can be performed using a regexp on the Date header. The Date is
26718 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
26721 A new command has been added to remove all data on articles from
26722 the native server (@pxref{Changing Servers}).
26725 A new command for reading collections of documents
26726 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
26727 (@pxref{Really Various Summary Commands}).
26730 Process mark sets can be pushed and popped (@pxref{Setting Process
26734 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
26735 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
26738 A new back end for reading searches from Web search engines
26739 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
26740 (@pxref{Web Searches}).
26743 Groups inside topics can now be sorted using the standard sorting
26744 functions, and each topic can be sorted independently (@pxref{Topic
26748 Subsets of the groups can be sorted independently (@code{Sorting
26752 Cached articles can be pulled into the groups (@pxref{Summary Generation
26756 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
26761 Score files are now applied in a more reliable order (@pxref{Score
26765 Reports on where mail messages end up can be generated (@pxref{Splitting
26769 More hooks and functions have been added to remove junk from incoming
26770 mail before saving the mail (@pxref{Washing Mail}).
26773 Emphasized text can be properly fontisized:
26779 @subsubsection Quassia Gnus
26781 New features in Gnus 5.6:
26786 New functionality for using Gnus as an offline newsreader has been
26787 added. A plethora of new commands and modes have been added.
26788 @xref{Gnus Unplugged}, for the full story.
26791 The @code{nndraft} back end has returned, but works differently than
26792 before. All Message buffers are now also articles in the @code{nndraft}
26793 group, which is created automatically.
26796 @code{gnus-alter-header-function} can now be used to alter header
26800 @code{gnus-summary-goto-article} now accept Message-ID's.
26803 A new Message command for deleting text in the body of a message
26804 outside the region: @kbd{C-c C-v}.
26807 You can now post to component group in @code{nnvirtual} groups with
26811 @code{nntp-rlogin-program}---new variable to ease customization.
26814 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
26815 re-highlighting of the article buffer.
26818 New element in @code{gnus-boring-article-headers}---@code{long-to}.
26821 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
26825 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
26826 @kbd{a} to add the score rule to the @file{all.SCORE} file.
26829 @code{gnus-simplify-subject-functions} variable to allow greater
26830 control over simplification.
26833 @kbd{A T}---new command for fetching the current thread.
26836 @kbd{/ T}---new command for including the current thread in the
26840 @kbd{M-RET} is a new Message command for breaking cited text.
26843 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
26846 The @code{custom-face-lookup} function has been removed.
26847 If you used this function in your initialization files, you must
26848 rewrite them to use @code{face-spec-set} instead.
26851 Canceling now uses the current select method. Symbolic prefix
26852 @kbd{a} forces normal posting method.
26855 New command to translate M******** sm*rtq**t*s into proper
26859 For easier debugging of @code{nntp}, you can set
26860 @code{nntp-record-commands} to a non-@code{nil} value.
26863 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
26864 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
26867 A command for editing group parameters from the summary buffer
26871 A history of where mails have been split is available.
26874 A new article date command has been added---@code{article-date-iso8601}.
26877 Subjects can be simplified when threading by setting
26878 @code{gnus-score-thread-simplify}.
26881 A new function for citing in Message has been
26882 added---@code{message-cite-original-without-signature}.
26885 @code{article-strip-all-blank-lines}---new article command.
26888 A new Message command to kill to the end of the article has
26892 A minimum adaptive score can be specified by using the
26893 @code{gnus-adaptive-word-minimum} variable.
26896 The ``lapsed date'' article header can be kept continually
26897 updated by the @code{gnus-start-date-timer} command.
26900 Web listserv archives can be read with the @code{nnlistserv} back end.
26903 Old dejanews archives can now be read by @code{nnweb}.
26907 @node Pterodactyl Gnus
26908 @subsubsection Pterodactyl Gnus
26910 New features in Gnus 5.8:
26915 The mail-fetching functions have changed. See the manual for the
26916 many details. In particular, all procmail fetching variables are gone.
26918 If you used procmail like in
26921 (setq nnmail-use-procmail t)
26922 (setq nnmail-spool-file 'procmail)
26923 (setq nnmail-procmail-directory "~/mail/incoming/")
26924 (setq nnmail-procmail-suffix "\\.in")
26927 this now has changed to
26931 '((directory :path "~/mail/incoming/"
26935 @xref{Mail Source Specifiers}.
26938 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
26939 Gnus, and adds a slew of new commands. See the manual for details.
26942 Gnus has also been multilingualized. This also affects too
26943 many parts of Gnus to summarize here, and adds many new variables.
26946 @code{gnus-auto-select-first} can now be a function to be
26947 called to position point.
26950 The user can now decide which extra headers should be included in
26951 summary buffers and @acronym{NOV} files.
26954 @code{gnus-article-display-hook} has been removed. Instead, a number
26955 of variables starting with @code{gnus-treat-} have been added.
26958 The Gnus posting styles have been redone again and now works in a
26959 subtly different manner.
26962 New web-based back ends have been added: @code{nnslashdot},
26963 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
26964 again, to keep up with ever-changing layouts.
26967 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
26972 @subsubsection Oort Gnus
26975 New features in Gnus 5.10:
26979 @item Installation changes
26980 @c ***********************
26984 Upgrading from previous (stable) version if you have used Oort.
26986 If you have tried Oort (the unstable Gnus branch leading to this
26987 release) but went back to a stable version, be careful when upgrading to
26988 this version. In particular, you will probably want to remove all
26989 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
26990 read from your @file{.newsrc.eld} instead of from the
26991 @file{.marks}/@file{.mrk} file where this release store flags. See a
26992 later entry for more information about marks. Note that downgrading
26993 isn't save in general.
26996 Lisp files are now installed in @file{.../site-lisp/gnus/} by default.
26997 It defaulted to @file{.../site-lisp/} formerly. In addition to this,
26998 the new installer issues a warning if other Gnus installations which
26999 will shadow the latest one are detected. You can then remove those
27000 shadows manually or remove them using @code{make
27001 remove-installed-shadows}.
27004 New @file{make.bat} for compiling and installing Gnus under MS Windows
27006 Use @file{make.bat} if you want to install Gnus under MS Windows, the
27007 first argument to the batch-program should be the directory where
27008 @file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want
27009 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
27010 the second parameter.
27012 @file{make.bat} has been rewritten from scratch, it now features
27013 automatic recognition of XEmacs and GNU Emacs, generates
27014 @file{gnus-load.el}, checks if errors occur while compilation and
27015 generation of info files and reports them at the end of the build
27016 process. It now uses @code{makeinfo} if it is available and falls
27017 back to @file{infohack.el} otherwise. @file{make.bat} should now
27018 install all files which are necessary to run Gnus and be generally a
27019 complete replacement for the @code{configure; make; make install}
27020 cycle used under Unix systems.
27022 The new @file{make.bat} makes @file{make-x.bat} and @file{xemacs.mak}
27023 superfluous, so they have been removed.
27026 @file{~/News/overview/} not used.
27028 As a result of the following change, the @file{~/News/overview/}
27029 directory is not used any more. You can safely delete the entire
27032 @c FIXME: `gnus-load' is mentioned in README, which is not included in
27033 @c CVS. We should find a better place for this item.
27035 @code{(require 'gnus-load)}
27037 If you use a stand-alone Gnus distribution, you'd better add
27038 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
27039 lisp directory into load-path.
27041 File @file{gnus-load.el} contains autoload commands, functions and variables,
27042 some of which may not be included in distributions of Emacsen.
27046 @item New packages and libraries within Gnus
27047 @c *****************************************
27052 The revised Gnus @acronym{FAQ} is included in the manual,
27053 @xref{Frequently Asked Questions}.
27056 @acronym{TLS} wrapper shipped with Gnus
27058 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
27059 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
27060 @acronym{TLS}/@acronym{SSL} support via (external third party)
27061 @file{ssl.el} and OpenSSL still works.
27064 Improved anti-spam features.
27066 Gnus is now able to take out spam from your mail and news streams
27067 using a wide variety of programs and filter rules. Among the supported
27068 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
27069 for easy use of external packages such as SpamAssassin and Hashcash
27070 are also new. @ref{Thwarting Email Spam} and @ref{Spam Package}.
27071 @c FIXME: @xref{Spam Package}?. Should this be under Misc?
27074 Gnus supports server-side mail filtering using Sieve.
27076 Sieve rules can be added as Group Parameters for groups, and the
27077 complete Sieve script is generated using @kbd{D g} from the Group
27078 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
27079 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
27080 manual @ref{Top, , Top, sieve, Emacs Sieve}.
27084 @item Changes in group mode
27085 @c ************************
27090 @code{gnus-group-read-ephemeral-group} can be called interactively,
27094 Retrieval of charters and control messages
27096 There are new commands for fetching newsgroup charters (@kbd{H c}) and
27097 control messages (@kbd{H C}).
27100 The new variable @code{gnus-parameters} can be used to set group parameters.
27102 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
27103 the parameters in @file{~/.newsrc.eld}, but via this variable you can
27104 enjoy the powers of customize, and simplified backups since you set the
27105 variable in @file{~/.gnus.el} instead of @file{~/.newsrc.eld}. The
27106 variable maps regular expressions matching group names to group
27109 (setq gnus-parameters
27111 (gnus-show-threads nil)
27112 (gnus-use-scoring nil))
27113 ("^nnimap:\\(foo.bar\\)$"
27114 (to-group . "\\1"))))
27118 Unread count correct in nnimap groups.
27120 The estimated number of unread articles in the group buffer should now
27121 be correct for nnimap groups. This is achieved by calling
27122 @code{nnimap-fixup-unread-after-getting-new-news} from the
27123 @code{gnus-setup-news-hook} (called on startup) and
27124 @code{gnus-after-getting-new-news-hook}. (called after getting new
27125 mail). If you have modified those variables from the default, you may
27126 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
27127 you were happy with the estimate and want to save some (minimal) time
27128 when getting new mail, remove the function.
27131 Group names are treated as UTF-8 by default.
27133 This is supposedly what USEFOR wanted to migrate to. See
27134 @code{gnus-group-name-charset-group-alist} and
27135 @code{gnus-group-name-charset-method-alist} for customization.
27138 @code{gnus-group-charset-alist} and
27139 @code{gnus-group-ignored-charsets-alist}.
27141 The regexps in these variables are compared with full group names
27142 instead of real group names in 5.8. Users who customize these
27143 variables should change those regexps accordingly. For example:
27145 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
27150 @item Changes in summary and article mode
27151 @c **************************************
27156 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
27157 (@code{gnus-article-reply-with-original}) only yank the text in the
27158 region if the region is active.
27161 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
27162 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
27167 More buttons for URLs, mail addresses, Message-IDs, Info links, man
27168 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
27169 variables @code{gnus-button-@var{*}-level} can be used to control the
27170 appearance of all article buttons. @xref{Article Button Levels}.
27173 Single-part yenc encoded attachments can be decoded.
27178 The picons code has been reimplemented to work in GNU Emacs---some of
27179 the previous options have been removed or renamed.
27181 Picons are small ``personal icons'' representing users, domain and
27182 newsgroups, which can be displayed in the Article buffer.
27186 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
27187 boundary line is drawn at the end of the headers.
27190 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
27193 The Summary Buffer uses an arrow in the fringe to indicate the current
27194 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
27197 Warn about email replies to news
27199 Do you often find yourself replying to news by email by mistake? Then
27200 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
27204 If the new option @code{gnus-summary-display-while-building} is
27205 non-@code{nil}, the summary buffer is shown and updated as it's being
27209 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
27210 opposed to old but unread messages).
27213 Gnus supports RFC 2369 mailing list headers, and adds a number of
27214 related commands in mailing list groups. @xref{Mailing List}.
27217 The Date header can be displayed in a format that can be read aloud
27218 in English. @xref{Article Date}.
27221 diffs are automatically highlighted in groups matching
27222 @code{mm-uu-diff-groups-regexp}
27225 Better handling of Microsoft citation styles
27227 Gnus now tries to recognize the mangled header block that some Microsoft
27228 mailers use to indicate that the rest of the message is a citation, even
27229 though it is not quoted in any way. The variable
27230 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
27233 The new command @kbd{W Y f}
27234 (@code{gnus-article-outlook-deuglify-article}) allows deuglifying broken
27235 Outlook (Express) articles.
27238 @code{gnus-article-skip-boring}
27240 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
27241 not scroll down to show you a page that contains only boring text,
27242 which by default means cited text and signature. You can customize
27243 what is skippable using @code{gnus-article-boring-faces}.
27245 This feature is especially useful if you read many articles that
27246 consist of a little new content at the top with a long, untrimmed
27247 message cited below.
27250 Smileys (@samp{:-)}, @samp{;-)} etc) are now displayed graphically in
27253 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.gnus.el} to
27257 Face headers handling. @xref{Face}.
27260 In the summary buffer, the new command @kbd{/ N} inserts new messages
27261 and @kbd{/ o} inserts old messages.
27264 Gnus decodes morse encoded messages if you press @kbd{W m}.
27267 @code{gnus-summary-line-format}
27269 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
27270 %s\n}. Moreover @code{gnus-extra-headers},
27271 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
27272 changed their default so that the users name will be replaced by the
27273 recipient's name or the group name posting to for @acronym{NNTP}
27277 Deleting of attachments.
27279 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
27280 on @acronym{MIME} buttons) saves a part and replaces the part with an
27281 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
27282 @acronym{MIME} buttons) removes a part. It works only on back ends
27283 that support editing.
27286 @code{gnus-default-charset}
27288 The default value is determined from the
27289 @code{current-language-environment} variable, instead of
27290 @code{iso-8859-1}. Also the @samp{.*} item in
27291 @code{gnus-group-charset-alist} is removed.
27294 Printing capabilities are enhanced.
27296 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
27297 Article buffers. Also, each individual @acronym{MIME} part can be
27298 printed using @kbd{p} on the @acronym{MIME} button.
27301 Extended format specs.
27303 Format spec @samp{%&user-date;} is added into
27304 @code{gnus-summary-line-format-alist}. Also, user defined extended
27305 format specs are supported. The extended format specs look like
27306 @samp{%u&foo;}, which invokes function
27307 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
27308 escape character, old user defined format @samp{%u&} is no longer supported.
27311 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
27312 @c FIXME: Was this a user-visible change?
27314 It was aliased to @kbd{Y c}
27315 (@code{gnus-summary-insert-cached-articles}). The new function filters
27316 out other articles.
27319 Some limiting commands accept a @kbd{C-u} prefix to negate the match.
27321 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
27322 s}, @kbd{/ a}, and @kbd{/ x}
27323 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
27324 result will be to display all articles that do not match the expression.
27327 Gnus inlines external parts (message/external).
27331 @item Changes in Message mode and related Gnus features
27332 @c ****************************************************
27339 You can delay the sending of a message with @kbd{C-c C-j} in the Message
27340 buffer. The messages are delivered at specified time. This is useful
27341 for sending yourself reminders. @xref{Delayed Articles}.
27344 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
27345 the nnml back end allows compressed message files.
27348 The new option @code{gnus-gcc-mark-as-read} automatically marks
27349 Gcc articles as read.
27352 Externalizing of attachments
27354 If @code{gnus-gcc-externalize-attachments} or
27355 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
27356 local files as external parts.
27359 The envelope sender address can be customized when using Sendmail.
27360 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
27363 Gnus no longer generate the Sender: header automatically.
27365 Earlier it was generated iff the user configurable email address was
27366 different from the Gnus guessed default user address. As the guessing
27367 algorithm is rarely correct these days, and (more controversially) the
27368 only use of the Sender: header was to check if you are entitled to
27369 cancel/supersede news (which is now solved by Cancel Locks instead,
27370 see another entry), generation of the header has been disabled by
27371 default. See the variables @code{message-required-headers},
27372 @code{message-required-news-headers}, and
27373 @code{message-required-mail-headers}.
27376 Features from third party @file{message-utils.el} added to @file{message.el}.
27378 Message now asks if you wish to remove @samp{(was: <old subject>)} from
27379 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
27380 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
27381 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
27382 appropriate headers and a note in the body for cross-postings and
27383 followups (see the variables @code{message-cross-post-@var{*}}).
27386 References and X-Draft-From headers are no longer generated when you
27387 start composing messages and @code{message-generate-headers-first} is
27391 Easy inclusion of X-Faces headers. @xref{X-Face}.
27394 Group Carbon Copy (GCC) quoting
27396 To support groups that contains SPC and other weird characters, groups
27397 are quoted before they are placed in the Gcc: header. This means
27398 variables such as @code{gnus-message-archive-group} should no longer
27399 contain quote characters to make groups containing SPC work. Also, if
27400 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
27401 into two groups) you must change it to return the list
27402 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
27403 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
27404 was incorrect earlier, it just didn't generate any problems since it
27405 was inserted directly.
27408 @code{message-insinuate-rmail}
27410 Adding @code{(message-insinuate-rmail)} and @code{(setq
27411 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
27412 compose, reply and forward messages in message-mode, where you can
27413 enjoy the power of @acronym{MML}.
27416 @code{message-minibuffer-local-map}
27418 The line below enables BBDB in resending a message:
27420 (define-key message-minibuffer-local-map [(tab)]
27421 'bbdb-complete-name)
27425 @code{gnus-posting-styles}
27427 Add a new format of match like
27429 ((header "to" "larsi.*org")
27430 (Organization "Somewhere, Inc."))
27432 The old format like the lines below is obsolete, but still accepted.
27434 (header "to" "larsi.*org"
27435 (Organization "Somewhere, Inc."))
27439 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
27441 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
27442 added into these two variables. If you customized those, perhaps you
27443 need add those two headers too.
27446 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
27447 composing messages, it is enabled by @code{use-hard-newlines}.
27448 Decoding format=flowed was present but not documented in earlier
27452 The option @code{mm-fill-flowed} can be used to disable treatment of
27453 ``format=flowed'' messages. Also, flowed text is disabled when sending
27454 inline PGP signed messages. @xref{Flowed text, , Flowed text,
27455 emacs-mime, The Emacs MIME Manual}. (New in Gnus 5.10.7)
27456 @c This entry is also present in the node "No Gnus".
27459 Gnus supports the generation of RFC 2298 Disposition Notification requests.
27461 This is invoked with the @kbd{C-c M-n} key binding from message mode.
27464 Message supports the Importance: (RFC 2156) header.
27466 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
27470 Gnus supports Cancel Locks in News.
27472 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
27473 used to determine if you wrote an article or not (for canceling and
27474 superseding). Gnus generates a random password string the first time
27475 you post a message, and saves it in your @file{~/.emacs} using the Custom
27476 system. While the variable is called @code{canlock-password}, it is not
27477 security sensitive data. Publishing your canlock string on the web
27478 will not allow anyone to be able to anything she could not already do.
27479 The behavior can be changed by customizing @code{message-insert-canlock}.
27482 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
27483 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
27485 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
27486 additional Lisp libraries. This add several menu items to the
27487 Attachments menu, and @kbd{C-c RET} key bindings, when composing
27488 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
27491 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
27494 This change was made to avoid conflict with the standard binding of
27495 @code{back-to-indentation}, which is also useful in message mode.
27498 The default for @code{message-forward-show-mml} changed to the symbol
27501 The behavior for the @code{best} value is to show @acronym{MML} (i.e.,
27502 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
27503 used when forwarding signed or encrypted messages, as the conversion
27504 invalidate the digital signature.
27507 If @code{auto-compression-mode} is enabled, attachments are automatically
27508 decompressed when activated.
27509 @c FIXME: Does this affect article or message mode?
27512 Support for non-@acronym{ASCII} domain names
27514 Message supports non-@acronym{ASCII} domain names in From:, To: and
27515 Cc: and will query you whether to perform encoding when you try to
27516 send a message. The variable @code{message-use-idna} controls this.
27517 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
27518 and Cc: when you view a message. The variable @code{gnus-use-idna}
27521 @item You can now drag and drop attachments to the Message buffer.
27522 See @code{mml-dnd-protocol-alist} and @code{mml-dnd-attach-options}.
27523 @xref{MIME, ,MIME, message, Message Manual}.
27524 @c New in 5.10.9 / 5.11
27528 @item Changes in back ends
27529 @c ***********************
27533 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
27536 The nndoc back end now supports mailman digests and exim bounces.
27539 Gnus supports Maildir groups.
27541 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
27544 The nnml and nnfolder back ends store marks for each groups.
27546 This makes it possible to take backup of nnml/nnfolder servers/groups
27547 separately of @file{~/.newsrc.eld}, while preserving marks. It also
27548 makes it possible to share articles and marks between users (without
27549 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
27550 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
27551 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
27552 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
27553 another machine, Gnus will automatically use the @file{.marks} or
27554 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
27555 The new server variables @code{nnml-marks-is-evil} and
27556 @code{nnfolder-marks-is-evil} can be used to disable this feature.
27566 The menu bar item (in Group and Summary buffer) named ``Misc'' has
27567 been renamed to ``Gnus''.
27570 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
27571 renamed to ``Attachments''. Note that this menu also contains security
27572 related stuff, like signing and encryption (@pxref{Security, Security,,
27573 message, Message Manual}).
27576 The tool bars have been updated to use GNOME icons in Group, Summary and
27577 Message mode. You can also customize the tool bars. This is a new
27578 feature in Gnus 5.10.9. (Only for Emacs, not in XEmacs.)
27580 @item The tool bar icons are now (de)activated correctly
27581 in the group buffer, see the variable @code{gnus-group-update-tool-bar}.
27582 Its default value depends on your Emacs version. This is a new feature
27587 @item Miscellaneous changes
27588 @c ************************
27595 The Gnus Agent has seen a major updated and is now enabled by default,
27596 and all nntp and nnimap servers from @code{gnus-select-method} and
27597 @code{gnus-secondary-select-method} are agentized by default. Earlier
27598 only the server in @code{gnus-select-method} was agentized by the
27599 default, and the agent was disabled by default. When the agent is
27600 enabled, headers are now also retrieved from the Agent cache instead
27601 of the back ends when possible. Earlier this only happened in the
27602 unplugged state. You can enroll or remove servers with @kbd{J a} and
27603 @kbd{J r} in the server buffer. Gnus will not download articles into
27604 the Agent cache, unless you instruct it to do so, though, by using
27605 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
27606 behavior of having the Agent disabled with @code{(setq gnus-agent
27607 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
27608 is not needed any more.
27611 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
27613 If one reads an article while plugged, and the article already exists
27614 in the Agent, it won't get downloaded once more. @code{(setq
27615 gnus-agent-cache nil)} reverts to the old behavior.
27620 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
27621 bindings in dired buffers to send a file as an attachment, open a file
27622 using the appropriate mailcap entry, and print a file using the mailcap
27626 The format spec @code{%C} for positioning point has changed to @code{%*}.
27629 @code{gnus-slave-unplugged}
27631 A new command which starts Gnus offline in slave mode.
27638 @subsubsection No Gnus
27641 New features in No Gnus:
27642 @c FIXME: Gnus 5.12?
27644 @include gnus-news.texi
27650 @section The Manual
27654 This manual was generated from a TeXinfo file and then run through
27655 either @code{texi2dvi}
27657 or my own home-brewed TeXinfo to \LaTeX\ transformer,
27658 and then run through @code{latex} and @code{dvips}
27660 to get what you hold in your hands now.
27662 The following conventions have been used:
27667 This is a @samp{string}
27670 This is a @kbd{keystroke}
27673 This is a @file{file}
27676 This is a @code{symbol}
27680 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
27684 (setq flargnoze "yes")
27687 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
27690 (setq flumphel 'yes)
27693 @samp{yes} and @code{yes} are two @emph{very} different things---don't
27694 ever get them confused.
27698 Of course, everything in this manual is of vital interest, so you should
27699 read it all. Several times. However, if you feel like skimming the
27700 manual, look for that gnu head you should see in the margin over
27701 there---it means that what's being discussed is of more importance than
27702 the rest of the stuff. (On the other hand, if everything is infinitely
27703 important, how can anything be more important than that? Just one more
27704 of the mysteries of this world, I guess.)
27710 @node On Writing Manuals
27711 @section On Writing Manuals
27713 I guess most manuals are written after-the-fact; documenting a program
27714 that's already there. This is not how this manual is written. When
27715 implementing something, I write the manual entry for that something
27716 straight away. I then see that it's difficult to explain the
27717 functionality, so I write how it's supposed to be, and then I change the
27718 implementation. Writing the documentation and writing the code goes
27721 This, of course, means that this manual has no, or little, flow. It
27722 documents absolutely everything in Gnus, but often not where you're
27723 looking for it. It is a reference manual, and not a guide to how to get
27726 That would be a totally different book, that should be written using the
27727 reference manual as source material. It would look quite differently.
27732 @section Terminology
27734 @cindex terminology
27739 This is what you are supposed to use this thing for---reading news.
27740 News is generally fetched from a nearby @acronym{NNTP} server, and is
27741 generally publicly available to everybody. If you post news, the entire
27742 world is likely to read just what you have written, and they'll all
27743 snigger mischievously. Behind your back.
27747 Everything that's delivered to you personally is mail. Some news/mail
27748 readers (like Gnus) blur the distinction between mail and news, but
27749 there is a difference. Mail is private. News is public. Mailing is
27750 not posting, and replying is not following up.
27754 Send a mail to the person who has written what you are reading.
27758 Post an article to the current newsgroup responding to the article you
27763 Gnus considers mail and news to be mostly the same, really. The only
27764 difference is how to access the actual articles. News articles are
27765 commonly fetched via the protocol @acronym{NNTP}, whereas mail
27766 messages could be read from a file on the local disk. The internal
27767 architecture of Gnus thus comprises a ``front end'' and a number of
27768 ``back ends''. Internally, when you enter a group (by hitting
27769 @key{RET}, say), you thereby invoke a function in the front end in
27770 Gnus. The front end then ``talks'' to a back end and says things like
27771 ``Give me the list of articles in the foo group'' or ``Show me article
27774 So a back end mainly defines either a protocol (the @code{nntp} back
27775 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
27776 accesses mail via @acronym{IMAP}) or a file format and directory
27777 layout (the @code{nnspool} back end accesses news via the common
27778 ``spool directory'' format, the @code{nnml} back end access mail via a
27779 file format and directory layout that's quite similar).
27781 Gnus does not handle the underlying media, so to speak---this is all
27782 done by the back ends. A back end is a collection of functions to
27783 access the articles.
27785 However, sometimes the term ``back end'' is also used where ``server''
27786 would have been more appropriate. And then there is the term ``select
27787 method'' which can mean either. The Gnus terminology can be quite
27792 Gnus will always use one method (and back end) as the @dfn{native}, or
27793 default, way of getting news.
27797 You can also have any number of foreign groups active at the same time.
27798 These are groups that use non-native non-secondary back ends for getting
27803 Secondary back ends are somewhere half-way between being native and being
27804 foreign, but they mostly act like they are native.
27808 A message that has been posted as news.
27811 @cindex mail message
27812 A message that has been mailed.
27816 A mail message or news article
27820 The top part of a message, where administrative information (etc.) is
27825 The rest of an article. Everything not in the head is in the
27830 A line from the head of an article.
27834 A collection of such lines, or a collection of heads. Or even a
27835 collection of @acronym{NOV} lines.
27837 @item @acronym{NOV}
27838 @cindex @acronym{NOV}
27839 When Gnus enters a group, it asks the back end for the headers of all
27840 unread articles in the group. Most servers support the News OverView
27841 format, which is more compact and much faster to read and parse than the
27842 normal @sc{head} format.
27846 Each group is subscribed at some @dfn{level} or other (1-9). The ones
27847 that have a lower level are ``more'' subscribed than the groups with a
27848 higher level. In fact, groups on levels 1-5 are considered
27849 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
27850 are @dfn{killed}. Commands for listing groups and scanning for new
27851 articles will all use the numeric prefix as @dfn{working level}.
27853 @item killed groups
27854 @cindex killed groups
27855 No information on killed groups is stored or updated, which makes killed
27856 groups much easier to handle than subscribed groups.
27858 @item zombie groups
27859 @cindex zombie groups
27860 Just like killed groups, only slightly less dead.
27863 @cindex active file
27864 The news server has to keep track of what articles it carries, and what
27865 groups exist. All this information in stored in the active file, which
27866 is rather large, as you might surmise.
27869 @cindex bogus groups
27870 A group that exists in the @file{.newsrc} file, but isn't known to the
27871 server (i.e., it isn't in the active file), is a @emph{bogus group}.
27872 This means that the group probably doesn't exist (any more).
27875 @cindex activating groups
27876 The act of asking the server for info on a group and computing the
27877 number of unread articles is called @dfn{activating the group}.
27878 Un-activated groups are listed with @samp{*} in the group buffer.
27882 News servers store their articles locally in one fashion or other.
27883 One old-fashioned storage method is to have just one file per
27884 article. That's called a ``traditional spool''.
27888 A machine one can connect to and get news (or mail) from.
27890 @item select method
27891 @cindex select method
27892 A structure that specifies the back end, the server and the virtual
27895 @item virtual server
27896 @cindex virtual server
27897 A named select method. Since a select method defines all there is to
27898 know about connecting to a (physical) server, taking the thing as a
27899 whole is a virtual server.
27903 Taking a buffer and running it through a filter of some sort. The
27904 result will (more often than not) be cleaner and more pleasing than the
27907 @item ephemeral groups
27908 @cindex ephemeral groups
27909 @cindex temporary groups
27910 Most groups store data on what articles you have read. @dfn{Ephemeral}
27911 groups are groups that will have no data stored---when you exit the
27912 group, it'll disappear into the aether.
27915 @cindex solid groups
27916 This is the opposite of ephemeral groups. All groups listed in the
27917 group buffer are solid groups.
27919 @item sparse articles
27920 @cindex sparse articles
27921 These are article placeholders shown in the summary buffer when
27922 @code{gnus-build-sparse-threads} has been switched on.
27926 To put responses to articles directly after the articles they respond
27927 to---in a hierarchical fashion.
27931 @cindex thread root
27932 The first article in a thread is the root. It is the ancestor of all
27933 articles in the thread.
27937 An article that has responses.
27941 An article that responds to a different article---its parent.
27945 A collection of messages in one file. The most common digest format is
27946 specified by RFC 1153.
27949 @cindex splitting, terminology
27950 @cindex mail sorting
27951 @cindex mail filtering (splitting)
27952 The action of sorting your emails according to certain rules. Sometimes
27953 incorrectly called mail filtering.
27959 @node Customization
27960 @section Customization
27961 @cindex general customization
27963 All variables are properly documented elsewhere in this manual. This
27964 section is designed to give general pointers on how to customize Gnus
27965 for some quite common situations.
27968 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
27969 * Slow Terminal Connection:: You run a remote Emacs.
27970 * Little Disk Space:: You feel that having large setup files is icky.
27971 * Slow Machine:: You feel like buying a faster machine.
27975 @node Slow/Expensive Connection
27976 @subsection Slow/Expensive NNTP Connection
27978 If you run Emacs on a machine locally, and get your news from a machine
27979 over some very thin strings, you want to cut down on the amount of data
27980 Gnus has to get from the @acronym{NNTP} server.
27984 @item gnus-read-active-file
27985 Set this to @code{nil}, which will inhibit Gnus from requesting the
27986 entire active file from the server. This file is often very large. You
27987 also have to set @code{gnus-check-new-newsgroups} and
27988 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
27989 doesn't suddenly decide to fetch the active file anyway.
27991 @item gnus-nov-is-evil
27992 This one has to be @code{nil}. If not, grabbing article headers from
27993 the @acronym{NNTP} server will not be very fast. Not all @acronym{NNTP} servers
27994 support @sc{xover}; Gnus will detect this by itself.
27998 @node Slow Terminal Connection
27999 @subsection Slow Terminal Connection
28001 Let's say you use your home computer for dialing up the system that runs
28002 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
28003 possible) the amount of data sent over the wires.
28007 @item gnus-auto-center-summary
28008 Set this to @code{nil} to inhibit Gnus from re-centering the summary
28009 buffer all the time. If it is @code{vertical}, do only vertical
28010 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
28011 horizontal and vertical recentering.
28013 @item gnus-visible-headers
28014 Cut down on the headers included in the articles to the
28015 minimum. You can, in fact, make do without them altogether---most of the
28016 useful data is in the summary buffer, anyway. Set this variable to
28017 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
28019 Use the following to enable all the available hiding features:
28021 (setq gnus-treat-hide-headers 'head
28022 gnus-treat-hide-signature t
28023 gnus-treat-hide-citation t)
28026 @item gnus-use-full-window
28027 By setting this to @code{nil}, you can make all the windows smaller.
28028 While this doesn't really cut down much generally, it means that you
28029 have to see smaller portions of articles before deciding that you didn't
28030 want to read them anyway.
28032 @item gnus-thread-hide-subtree
28033 If this is non-@code{nil}, all threads in the summary buffer will be
28037 @item gnus-updated-mode-lines
28038 If this is @code{nil}, Gnus will not put information in the buffer mode
28039 lines, which might save some time.
28043 @node Little Disk Space
28044 @subsection Little Disk Space
28047 The startup files can get rather large, so you may want to cut their
28048 sizes a bit if you are running out of space.
28052 @item gnus-save-newsrc-file
28053 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
28054 only save @file{.newsrc.eld}. This means that you will not be able to
28055 use any other newsreaders than Gnus. This variable is @code{t} by
28058 @item gnus-read-newsrc-file
28059 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
28060 only read @file{.newsrc.eld}. This means that you will not be able to
28061 use any other newsreaders than Gnus. This variable is @code{t} by
28064 @item gnus-save-killed-list
28065 If this is @code{nil}, Gnus will not save the list of dead groups. You
28066 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
28067 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
28068 variable to @code{nil}. This variable is @code{t} by default.
28074 @subsection Slow Machine
28075 @cindex slow machine
28077 If you have a slow machine, or are just really impatient, there are a
28078 few things you can do to make Gnus run faster.
28080 Set @code{gnus-check-new-newsgroups} and
28081 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
28083 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
28084 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
28085 summary buffer faster.
28089 @node Troubleshooting
28090 @section Troubleshooting
28091 @cindex troubleshooting
28093 Gnus works @emph{so} well straight out of the box---I can't imagine any
28101 Make sure your computer is switched on.
28104 Make sure that you really load the current Gnus version. If you have
28105 been running @sc{gnus}, you need to exit Emacs and start it up again before
28109 Try doing an @kbd{M-x gnus-version}. If you get something that looks
28110 like @samp{Gnus v5.10.6} you have the right files loaded. Otherwise
28111 you have some old @file{.el} files lying around. Delete these.
28114 Read the help group (@kbd{G h} in the group buffer) for a
28115 @acronym{FAQ} and a how-to.
28118 @vindex max-lisp-eval-depth
28119 Gnus works on many recursive structures, and in some extreme (and very
28120 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
28121 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
28122 something like that.
28125 If all else fails, report the problem as a bug.
28128 @cindex reporting bugs
28130 @kindex M-x gnus-bug
28132 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
28133 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
28134 me the backtrace. I will fix bugs, but I can only fix them if you send
28135 me a precise description as to how to reproduce the bug.
28137 You really can never be too detailed in a bug report. Always use the
28138 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
28139 a 10Kb mail each time you use it, and even if you have sent me your
28140 environment 500 times before. I don't care. I want the full info each
28143 It is also important to remember that I have no memory whatsoever. If
28144 you send a bug report, and I send you a reply, and then you just send
28145 back ``No, it's not! Moron!'', I will have no idea what you are
28146 insulting me about. Always over-explain everything. It's much easier
28147 for all of us---if I don't have all the information I need, I will just
28148 mail you and ask for more info, and everything takes more time.
28150 If the problem you're seeing is very visual, and you can't quite explain
28151 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
28152 it somewhere it can be reached, and include the URL of the picture in
28156 If you would like to contribute a patch to fix bugs or make
28157 improvements, please produce the patch using @samp{diff -u}.
28160 If you want to debug your problem further before reporting, possibly
28161 in order to solve the problem yourself and send a patch, you can use
28162 edebug. Debugging Lisp code is documented in the Elisp manual
28163 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
28164 Lisp Reference Manual}). To get you started with edebug, consider if
28165 you discover some weird behavior when pressing @kbd{c}, the first
28166 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
28167 the documentation buffer that leads you to the function definition,
28168 then press @kbd{M-x edebug-defun RET} with point inside that function,
28169 return to Gnus and press @kbd{c} to invoke the code. You will be
28170 placed in the lisp buffer and can single step using @kbd{SPC} and
28171 evaluate expressions using @kbd{M-:} or inspect variables using
28172 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
28173 @kbd{c} or @kbd{g}.
28178 Sometimes, a problem do not directly generate an elisp error but
28179 manifests itself by causing Gnus to be very slow. In these cases, you
28180 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
28181 slow, and then try to analyze the backtrace (repeating the procedure
28182 helps isolating the real problem areas).
28184 A fancier approach is to use the elisp profiler, ELP. The profiler is
28185 (or should be) fully documented elsewhere, but to get you started
28186 there are a few steps that need to be followed. First, instrument the
28187 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
28188 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
28189 RET message}. Then perform the operation that is slow and press
28190 @kbd{M-x elp-results}. You will then see which operations that takes
28191 time, and can debug them further. If the entire operation takes much
28192 longer than the time spent in the slowest function in the profiler
28193 output, you probably profiled the wrong part of Gnus. To reset
28194 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
28195 elp-restore-all} is supposed to remove profiling, but given the
28196 complexities and dynamic code generation in Gnus, it might not always
28199 @cindex gnu.emacs.gnus
28200 @cindex ding mailing list
28201 If you just need help, you are better off asking on
28202 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
28203 @email{ding@@gnus.org, the ding mailing list}. Write to
28204 @email{ding-request@@gnus.org} to subscribe.
28208 @node Gnus Reference Guide
28209 @section Gnus Reference Guide
28211 It is my hope that other people will figure out smart stuff that Gnus
28212 can do, and that other people will write those smart things as well. To
28213 facilitate that I thought it would be a good idea to describe the inner
28214 workings of Gnus. And some of the not-so-inner workings, while I'm at
28217 You can never expect the internals of a program not to change, but I
28218 will be defining (in some details) the interface between Gnus and its
28219 back ends (this is written in stone), the format of the score files
28220 (ditto), data structures (some are less likely to change than others)
28221 and general methods of operation.
28224 * Gnus Utility Functions:: Common functions and variable to use.
28225 * Back End Interface:: How Gnus communicates with the servers.
28226 * Score File Syntax:: A BNF definition of the score file standard.
28227 * Headers:: How Gnus stores headers internally.
28228 * Ranges:: A handy format for storing mucho numbers.
28229 * Group Info:: The group info format.
28230 * Extended Interactive:: Symbolic prefixes and stuff.
28231 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
28232 * Various File Formats:: Formats of files that Gnus use.
28236 @node Gnus Utility Functions
28237 @subsection Gnus Utility Functions
28238 @cindex Gnus utility functions
28239 @cindex utility functions
28241 @cindex internal variables
28243 When writing small functions to be run from hooks (and stuff), it's
28244 vital to have access to the Gnus internal functions and variables.
28245 Below is a list of the most common ones.
28249 @item gnus-newsgroup-name
28250 @vindex gnus-newsgroup-name
28251 This variable holds the name of the current newsgroup.
28253 @item gnus-find-method-for-group
28254 @findex gnus-find-method-for-group
28255 A function that returns the select method for @var{group}.
28257 @item gnus-group-real-name
28258 @findex gnus-group-real-name
28259 Takes a full (prefixed) Gnus group name, and returns the unprefixed
28262 @item gnus-group-prefixed-name
28263 @findex gnus-group-prefixed-name
28264 Takes an unprefixed group name and a select method, and returns the full
28265 (prefixed) Gnus group name.
28267 @item gnus-get-info
28268 @findex gnus-get-info
28269 Returns the group info list for @var{group}.
28271 @item gnus-group-unread
28272 @findex gnus-group-unread
28273 The number of unread articles in @var{group}, or @code{t} if that is
28277 @findex gnus-active
28278 The active entry for @var{group}.
28280 @item gnus-set-active
28281 @findex gnus-set-active
28282 Set the active entry for @var{group}.
28284 @item gnus-add-current-to-buffer-list
28285 @findex gnus-add-current-to-buffer-list
28286 Adds the current buffer to the list of buffers to be killed on Gnus
28289 @item gnus-continuum-version
28290 @findex gnus-continuum-version
28291 Takes a Gnus version string as a parameter and returns a floating point
28292 number. Earlier versions will always get a lower number than later
28295 @item gnus-group-read-only-p
28296 @findex gnus-group-read-only-p
28297 Says whether @var{group} is read-only or not.
28299 @item gnus-news-group-p
28300 @findex gnus-news-group-p
28301 Says whether @var{group} came from a news back end.
28303 @item gnus-ephemeral-group-p
28304 @findex gnus-ephemeral-group-p
28305 Says whether @var{group} is ephemeral or not.
28307 @item gnus-server-to-method
28308 @findex gnus-server-to-method
28309 Returns the select method corresponding to @var{server}.
28311 @item gnus-server-equal
28312 @findex gnus-server-equal
28313 Says whether two virtual servers are equal.
28315 @item gnus-group-native-p
28316 @findex gnus-group-native-p
28317 Says whether @var{group} is native or not.
28319 @item gnus-group-secondary-p
28320 @findex gnus-group-secondary-p
28321 Says whether @var{group} is secondary or not.
28323 @item gnus-group-foreign-p
28324 @findex gnus-group-foreign-p
28325 Says whether @var{group} is foreign or not.
28327 @item gnus-group-find-parameter
28328 @findex gnus-group-find-parameter
28329 Returns the parameter list of @var{group}. If given a second parameter,
28330 returns the value of that parameter for @var{group}.
28332 @item gnus-group-set-parameter
28333 @findex gnus-group-set-parameter
28334 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
28336 @item gnus-narrow-to-body
28337 @findex gnus-narrow-to-body
28338 Narrows the current buffer to the body of the article.
28340 @item gnus-check-backend-function
28341 @findex gnus-check-backend-function
28342 Takes two parameters, @var{function} and @var{group}. If the back end
28343 @var{group} comes from supports @var{function}, return non-@code{nil}.
28346 (gnus-check-backend-function "request-scan" "nnml:misc")
28350 @item gnus-read-method
28351 @findex gnus-read-method
28352 Prompts the user for a select method.
28357 @node Back End Interface
28358 @subsection Back End Interface
28360 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
28361 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
28362 server is a @dfn{back end} and some @dfn{back end variables}. As examples
28363 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
28364 examples of the latter we have @code{nntp-port-number} and
28365 @code{nnmbox-directory}.
28367 When Gnus asks for information from a back end---say @code{nntp}---on
28368 something, it will normally include a virtual server name in the
28369 function parameters. (If not, the back end should use the ``current''
28370 virtual server.) For instance, @code{nntp-request-list} takes a virtual
28371 server as its only (optional) parameter. If this virtual server hasn't
28372 been opened, the function should fail.
28374 Note that a virtual server name has no relation to some physical server
28375 name. Take this example:
28379 (nntp-address "ifi.uio.no")
28380 (nntp-port-number 4324))
28383 Here the virtual server name is @samp{odd-one} while the name of
28384 the physical server is @samp{ifi.uio.no}.
28386 The back ends should be able to switch between several virtual servers.
28387 The standard back ends implement this by keeping an alist of virtual
28388 server environments that they pull down/push up when needed.
28390 There are two groups of interface functions: @dfn{required functions},
28391 which must be present, and @dfn{optional functions}, which Gnus will
28392 always check for presence before attempting to call 'em.
28394 All these functions are expected to return data in the buffer
28395 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
28396 unfortunately named, but we'll have to live with it. When I talk about
28397 @dfn{resulting data}, I always refer to the data in that buffer. When I
28398 talk about @dfn{return value}, I talk about the function value returned by
28399 the function call. Functions that fail should return @code{nil} as the
28402 Some back ends could be said to be @dfn{server-forming} back ends, and
28403 some might be said not to be. The latter are back ends that generally
28404 only operate on one group at a time, and have no concept of ``server''
28405 ---they have a group, and they deliver info on that group and nothing
28408 Gnus identifies each message by way of group name and article number. A
28409 few remarks about these article numbers might be useful. First of all,
28410 the numbers are positive integers. Secondly, it is normally not
28411 possible for later articles to ``re-use'' older article numbers without
28412 confusing Gnus. That is, if a group has ever contained a message
28413 numbered 42, then no other message may get that number, or Gnus will get
28414 mightily confused.@footnote{See the function
28415 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
28416 Third, article numbers must be assigned in order of arrival in the
28417 group; this is not necessarily the same as the date of the message.
28419 The previous paragraph already mentions all the ``hard'' restrictions that
28420 article numbers must fulfill. But it seems that it might be useful to
28421 assign @emph{consecutive} article numbers, for Gnus gets quite confused
28422 if there are holes in the article numbering sequence. However, due to
28423 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
28424 also useful for the article numbers to start at 1 to avoid running out
28425 of numbers as long as possible.
28427 Note that by convention, back ends are named @code{nnsomething}, but
28428 Gnus also comes with some @code{nnnotbackends}, such as
28429 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
28431 In the examples and definitions I will refer to the imaginary back end
28434 @cindex @code{nnchoke}
28437 * Required Back End Functions:: Functions that must be implemented.
28438 * Optional Back End Functions:: Functions that need not be implemented.
28439 * Error Messaging:: How to get messages and report errors.
28440 * Writing New Back Ends:: Extending old back ends.
28441 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
28442 * Mail-like Back Ends:: Some tips on mail back ends.
28446 @node Required Back End Functions
28447 @subsubsection Required Back End Functions
28451 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
28453 @var{articles} is either a range of article numbers or a list of
28454 @code{Message-ID}s. Current back ends do not fully support either---only
28455 sequences (lists) of article numbers, and most back ends do not support
28456 retrieval of @code{Message-ID}s. But they should try for both.
28458 The result data should either be HEADs or @acronym{NOV} lines, and the result
28459 value should either be @code{headers} or @code{nov} to reflect this.
28460 This might later be expanded to @code{various}, which will be a mixture
28461 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
28463 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
28464 headers'', in some meaning of the word. This is generally done by
28465 fetching (at most) @var{fetch-old} extra headers less than the smallest
28466 article number in @code{articles}, and filling the gaps as well. The
28467 presence of this parameter can be ignored if the back end finds it
28468 cumbersome to follow the request. If this is non-@code{nil} and not a
28469 number, do maximum fetches.
28471 Here's an example HEAD:
28474 221 1056 Article retrieved.
28475 Path: ifi.uio.no!sturles
28476 From: sturles@@ifi.uio.no (Sturle Sunde)
28477 Newsgroups: ifi.discussion
28478 Subject: Re: Something very droll
28479 Date: 27 Oct 1994 14:02:57 +0100
28480 Organization: Dept. of Informatics, University of Oslo, Norway
28482 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
28483 References: <38jdmq$4qu@@visbur.ifi.uio.no>
28484 NNTP-Posting-Host: holmenkollen.ifi.uio.no
28488 So a @code{headers} return value would imply that there's a number of
28489 these in the data buffer.
28491 Here's a BNF definition of such a buffer:
28495 head = error / valid-head
28496 error-message = [ "4" / "5" ] 2number " " <error message> eol
28497 valid-head = valid-message *header "." eol
28498 valid-message = "221 " <number> " Article retrieved." eol
28499 header = <text> eol
28503 (The version of BNF used here is the one used in RFC822.)
28505 If the return value is @code{nov}, the data buffer should contain
28506 @dfn{network overview database} lines. These are basically fields
28510 nov-buffer = *nov-line
28511 nov-line = field 7*8[ <TAB> field ] eol
28512 field = <text except TAB>
28515 For a closer look at what should be in those fields,
28519 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
28521 @var{server} is here the virtual server name. @var{definitions} is a
28522 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
28524 If the server can't be opened, no error should be signaled. The back end
28525 may then choose to refuse further attempts at connecting to this
28526 server. In fact, it should do so.
28528 If the server is opened already, this function should return a
28529 non-@code{nil} value. There should be no data returned.
28532 @item (nnchoke-close-server &optional SERVER)
28534 Close connection to @var{server} and free all resources connected
28535 to it. Return @code{nil} if the server couldn't be closed for some
28538 There should be no data returned.
28541 @item (nnchoke-request-close)
28543 Close connection to all servers and free all resources that the back end
28544 have reserved. All buffers that have been created by that back end
28545 should be killed. (Not the @code{nntp-server-buffer}, though.) This
28546 function is generally only called when Gnus is shutting down.
28548 There should be no data returned.
28551 @item (nnchoke-server-opened &optional SERVER)
28553 If @var{server} is the current virtual server, and the connection to the
28554 physical server is alive, then this function should return a
28555 non-@code{nil} value. This function should under no circumstances
28556 attempt to reconnect to a server we have lost connection to.
28558 There should be no data returned.
28561 @item (nnchoke-status-message &optional SERVER)
28563 This function should return the last error message from @var{server}.
28565 There should be no data returned.
28568 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
28570 The result data from this function should be the article specified by
28571 @var{article}. This might either be a @code{Message-ID} or a number.
28572 It is optional whether to implement retrieval by @code{Message-ID}, but
28573 it would be nice if that were possible.
28575 If @var{to-buffer} is non-@code{nil}, the result data should be returned
28576 in this buffer instead of the normal data buffer. This is to make it
28577 possible to avoid copying large amounts of data from one buffer to
28578 another, while Gnus mainly requests articles to be inserted directly
28579 into its article buffer.
28581 If it is at all possible, this function should return a cons cell where
28582 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
28583 the article number. This will enable Gnus to find out what the real
28584 group and article numbers are when fetching articles by
28585 @code{Message-ID}. If this isn't possible, @code{t} should be returned
28586 on successful article retrieval.
28589 @item (nnchoke-request-group GROUP &optional SERVER FAST)
28591 Get data on @var{group}. This function also has the side effect of
28592 making @var{group} the current group.
28594 If @var{fast}, don't bother to return useful data, just make @var{group}
28597 Here's an example of some result data and a definition of the same:
28600 211 56 1000 1059 ifi.discussion
28603 The first number is the status, which should be 211. Next is the
28604 total number of articles in the group, the lowest article number, the
28605 highest article number, and finally the group name. Note that the total
28606 number of articles may be less than one might think while just
28607 considering the highest and lowest article numbers, but some articles
28608 may have been canceled. Gnus just discards the total-number, so
28609 whether one should take the bother to generate it properly (if that is a
28610 problem) is left as an exercise to the reader. If the group contains no
28611 articles, the lowest article number should be reported as 1 and the
28615 group-status = [ error / info ] eol
28616 error = [ "4" / "5" ] 2<number> " " <Error message>
28617 info = "211 " 3* [ <number> " " ] <string>
28621 @item (nnchoke-close-group GROUP &optional SERVER)
28623 Close @var{group} and free any resources connected to it. This will be
28624 a no-op on most back ends.
28626 There should be no data returned.
28629 @item (nnchoke-request-list &optional SERVER)
28631 Return a list of all groups available on @var{server}. And that means
28634 Here's an example from a server that only carries two groups:
28637 ifi.test 0000002200 0000002000 y
28638 ifi.discussion 3324 3300 n
28641 On each line we have a group name, then the highest article number in
28642 that group, the lowest article number, and finally a flag. If the group
28643 contains no articles, the lowest article number should be reported as 1
28644 and the highest as 0.
28647 active-file = *active-line
28648 active-line = name " " <number> " " <number> " " flags eol
28650 flags = "n" / "y" / "m" / "x" / "j" / "=" name
28653 The flag says whether the group is read-only (@samp{n}), is moderated
28654 (@samp{m}), is dead (@samp{x}), is aliased to some other group
28655 (@samp{=other-group}) or none of the above (@samp{y}).
28658 @item (nnchoke-request-post &optional SERVER)
28660 This function should post the current buffer. It might return whether
28661 the posting was successful or not, but that's not required. If, for
28662 instance, the posting is done asynchronously, it has generally not been
28663 completed by the time this function concludes. In that case, this
28664 function should set up some kind of sentinel to beep the user loud and
28665 clear if the posting could not be completed.
28667 There should be no result data from this function.
28672 @node Optional Back End Functions
28673 @subsubsection Optional Back End Functions
28677 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
28679 @var{groups} is a list of groups, and this function should request data
28680 on all those groups. How it does it is of no concern to Gnus, but it
28681 should attempt to do this in a speedy fashion.
28683 The return value of this function can be either @code{active} or
28684 @code{group}, which says what the format of the result data is. The
28685 former is in the same format as the data from
28686 @code{nnchoke-request-list}, while the latter is a buffer full of lines
28687 in the same format as @code{nnchoke-request-group} gives.
28690 group-buffer = *active-line / *group-status
28694 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
28696 A Gnus group info (@pxref{Group Info}) is handed to the back end for
28697 alterations. This comes in handy if the back end really carries all
28698 the information (as is the case with virtual and imap groups). This
28699 function should destructively alter the info to suit its needs, and
28700 should return a non-@code{nil} value (exceptionally,
28701 @code{nntp-request-update-info} always returns @code{nil} not to waste
28702 the network resources).
28704 There should be no result data from this function.
28707 @item (nnchoke-request-type GROUP &optional ARTICLE)
28709 When the user issues commands for ``sending news'' (@kbd{F} in the
28710 summary buffer, for instance), Gnus has to know whether the article the
28711 user is following up on is news or mail. This function should return
28712 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
28713 is mail and @code{unknown} if the type can't be decided. (The
28714 @var{article} parameter is necessary in @code{nnvirtual} groups which
28715 might very well combine mail groups and news groups.) Both @var{group}
28716 and @var{article} may be @code{nil}.
28718 There should be no result data from this function.
28721 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
28723 Set/remove/add marks on articles. Normally Gnus handles the article
28724 marks (such as read, ticked, expired etc) internally, and store them in
28725 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
28726 all information about the articles on the server, so Gnus need to
28727 propagate the mark information to the server.
28729 @var{action} is a list of mark setting requests, having this format:
28732 (RANGE ACTION MARK)
28735 @var{range} is a range of articles you wish to update marks on.
28736 @var{action} is @code{add} or @code{del}, used to add marks or remove
28737 marks (preserving all marks not mentioned). @var{mark} is a list of
28738 marks; where each mark is a symbol. Currently used marks are
28739 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
28740 @code{dormant}, @code{save}, @code{download}, @code{unsend},
28741 @code{forward} and @code{recent}, but your back end should, if
28742 possible, not limit itself to these.
28744 Given contradictory actions, the last action in the list should be the
28745 effective one. That is, if your action contains a request to add the
28746 @code{tick} mark on article 1 and, later in the list, a request to
28747 remove the mark on the same article, the mark should in fact be removed.
28749 An example action list:
28752 (((5 12 30) 'del '(tick))
28753 ((10 . 90) 'add '(read expire))
28754 ((92 94) 'del '(read)))
28757 The function should return a range of articles it wasn't able to set the
28758 mark on (currently not used for anything).
28760 There should be no result data from this function.
28762 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
28764 If the user tries to set a mark that the back end doesn't like, this
28765 function may change the mark. Gnus will use whatever this function
28766 returns as the mark for @var{article} instead of the original
28767 @var{mark}. If the back end doesn't care, it must return the original
28768 @var{mark}, and not @code{nil} or any other type of garbage.
28770 The only use for this I can see is what @code{nnvirtual} does with
28771 it---if a component group is auto-expirable, marking an article as read
28772 in the virtual group should result in the article being marked as
28775 There should be no result data from this function.
28778 @item (nnchoke-request-scan &optional GROUP SERVER)
28780 This function may be called at any time (by Gnus or anything else) to
28781 request that the back end check for incoming articles, in one way or
28782 another. A mail back end will typically read the spool file or query
28783 the @acronym{POP} server when this function is invoked. The
28784 @var{group} doesn't have to be heeded---if the back end decides that
28785 it is too much work just scanning for a single group, it may do a
28786 total scan of all groups. It would be nice, however, to keep things
28787 local if that's practical.
28789 There should be no result data from this function.
28792 @item (nnchoke-request-group-description GROUP &optional SERVER)
28794 The result data from this function should be a description of
28798 description-line = name <TAB> description eol
28800 description = <text>
28803 @item (nnchoke-request-list-newsgroups &optional SERVER)
28805 The result data from this function should be the description of all
28806 groups available on the server.
28809 description-buffer = *description-line
28813 @item (nnchoke-request-newgroups DATE &optional SERVER)
28815 The result data from this function should be all groups that were
28816 created after @samp{date}, which is in normal human-readable date format
28817 (i.e., the date format used in mail and news headers, and returned by
28818 the function @code{message-make-date} by default). The data should be
28819 in the active buffer format.
28821 It is okay for this function to return ``too many'' groups; some back ends
28822 might find it cheaper to return the full list of groups, rather than
28823 just the new groups. But don't do this for back ends with many groups.
28824 Normally, if the user creates the groups herself, there won't be too
28825 many groups, so @code{nnml} and the like are probably safe. But for
28826 back ends like @code{nntp}, where the groups have been created by the
28827 server, it is quite likely that there can be many groups.
28830 @item (nnchoke-request-create-group GROUP &optional SERVER)
28832 This function should create an empty group with name @var{group}.
28834 There should be no return data.
28837 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
28839 This function should run the expiry process on all articles in the
28840 @var{articles} range (which is currently a simple list of article
28841 numbers.) It is left up to the back end to decide how old articles
28842 should be before they are removed by this function. If @var{force} is
28843 non-@code{nil}, all @var{articles} should be deleted, no matter how new
28846 This function should return a list of articles that it did not/was not
28849 There should be no result data returned.
28852 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
28854 This function should move @var{article} (which is a number) from
28855 @var{group} by calling @var{accept-form}.
28857 This function should ready the article in question for moving by
28858 removing any header lines it has added to the article, and generally
28859 should ``tidy up'' the article. Then it should @code{eval}
28860 @var{accept-form} in the buffer where the ``tidy'' article is. This
28861 will do the actual copying. If this @code{eval} returns a
28862 non-@code{nil} value, the article should be removed.
28864 If @var{last} is @code{nil}, that means that there is a high likelihood
28865 that there will be more requests issued shortly, so that allows some
28868 The function should return a cons where the @code{car} is the group name and
28869 the @code{cdr} is the article number that the article was entered as.
28871 There should be no data returned.
28874 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
28876 This function takes the current buffer and inserts it into @var{group}.
28877 If @var{last} in @code{nil}, that means that there will be more calls to
28878 this function in short order.
28880 The function should return a cons where the @code{car} is the group name and
28881 the @code{cdr} is the article number that the article was entered as.
28883 The group should exist before the back end is asked to accept the
28884 article for that group.
28886 There should be no data returned.
28889 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
28891 This function should remove @var{article} (which is a number) from
28892 @var{group} and insert @var{buffer} there instead.
28894 There should be no data returned.
28897 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
28899 This function should delete @var{group}. If @var{force}, it should
28900 really delete all the articles in the group, and then delete the group
28901 itself. (If there is such a thing as ``the group itself''.)
28903 There should be no data returned.
28906 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
28908 This function should rename @var{group} into @var{new-name}. All
28909 articles in @var{group} should move to @var{new-name}.
28911 There should be no data returned.
28916 @node Error Messaging
28917 @subsubsection Error Messaging
28919 @findex nnheader-report
28920 @findex nnheader-get-report
28921 The back ends should use the function @code{nnheader-report} to report
28922 error conditions---they should not raise errors when they aren't able to
28923 perform a request. The first argument to this function is the back end
28924 symbol, and the rest are interpreted as arguments to @code{format} if
28925 there are multiple of them, or just a string if there is one of them.
28926 This function must always returns @code{nil}.
28929 (nnheader-report 'nnchoke "You did something totally bogus")
28931 (nnheader-report 'nnchoke "Could not request group %s" group)
28934 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
28935 @code{nil} back from a server, and this function returns the most
28936 recently reported message for the back end in question. This function
28937 takes one argument---the server symbol.
28939 Internally, these functions access @var{back-end}@code{-status-string},
28940 so the @code{nnchoke} back end will have its error message stored in
28941 @code{nnchoke-status-string}.
28944 @node Writing New Back Ends
28945 @subsubsection Writing New Back Ends
28947 Many back ends are quite similar. @code{nnml} is just like
28948 @code{nnspool}, but it allows you to edit the articles on the server.
28949 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
28950 and it doesn't maintain overview databases. @code{nndir} is just like
28951 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
28954 It would make sense if it were possible to ``inherit'' functions from
28955 back ends when writing new back ends. And, indeed, you can do that if you
28956 want to. (You don't have to if you don't want to, of course.)
28958 All the back ends declare their public variables and functions by using a
28959 package called @code{nnoo}.
28961 To inherit functions from other back ends (and allow other back ends to
28962 inherit functions from the current back end), you should use the
28968 This macro declares the first parameter to be a child of the subsequent
28969 parameters. For instance:
28972 (nnoo-declare nndir
28976 @code{nndir} has declared here that it intends to inherit functions from
28977 both @code{nnml} and @code{nnmh}.
28980 This macro is equivalent to @code{defvar}, but registers the variable as
28981 a public server variable. Most state-oriented variables should be
28982 declared with @code{defvoo} instead of @code{defvar}.
28984 In addition to the normal @code{defvar} parameters, it takes a list of
28985 variables in the parent back ends to map the variable to when executing
28986 a function in those back ends.
28989 (defvoo nndir-directory nil
28990 "Where nndir will look for groups."
28991 nnml-current-directory nnmh-current-directory)
28994 This means that @code{nnml-current-directory} will be set to
28995 @code{nndir-directory} when an @code{nnml} function is called on behalf
28996 of @code{nndir}. (The same with @code{nnmh}.)
28998 @item nnoo-define-basics
28999 This macro defines some common functions that almost all back ends should
29003 (nnoo-define-basics nndir)
29007 This macro is just like @code{defun} and takes the same parameters. In
29008 addition to doing the normal @code{defun} things, it registers the
29009 function as being public so that other back ends can inherit it.
29011 @item nnoo-map-functions
29012 This macro allows mapping of functions from the current back end to
29013 functions from the parent back ends.
29016 (nnoo-map-functions nndir
29017 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29018 (nnmh-request-article 0 nndir-current-group 0 0))
29021 This means that when @code{nndir-retrieve-headers} is called, the first,
29022 third, and fourth parameters will be passed on to
29023 @code{nnml-retrieve-headers}, while the second parameter is set to the
29024 value of @code{nndir-current-group}.
29027 This macro allows importing functions from back ends. It should be the
29028 last thing in the source file, since it will only define functions that
29029 haven't already been defined.
29035 nnmh-request-newgroups)
29039 This means that calls to @code{nndir-request-list} should just be passed
29040 on to @code{nnmh-request-list}, while all public functions from
29041 @code{nnml} that haven't been defined in @code{nndir} yet should be
29046 Below is a slightly shortened version of the @code{nndir} back end.
29049 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
29050 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
29054 (require 'nnheader)
29058 (eval-when-compile (require 'cl))
29060 (nnoo-declare nndir
29063 (defvoo nndir-directory nil
29064 "Where nndir will look for groups."
29065 nnml-current-directory nnmh-current-directory)
29067 (defvoo nndir-nov-is-evil nil
29068 "*Non-nil means that nndir will never retrieve NOV headers."
29071 (defvoo nndir-current-group ""
29073 nnml-current-group nnmh-current-group)
29074 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
29075 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
29077 (defvoo nndir-status-string "" nil nnmh-status-string)
29078 (defconst nndir-version "nndir 1.0")
29080 ;;; @r{Interface functions.}
29082 (nnoo-define-basics nndir)
29084 (deffoo nndir-open-server (server &optional defs)
29085 (setq nndir-directory
29086 (or (cadr (assq 'nndir-directory defs))
29088 (unless (assq 'nndir-directory defs)
29089 (push `(nndir-directory ,server) defs))
29090 (push `(nndir-current-group
29091 ,(file-name-nondirectory
29092 (directory-file-name nndir-directory)))
29094 (push `(nndir-top-directory
29095 ,(file-name-directory (directory-file-name nndir-directory)))
29097 (nnoo-change-server 'nndir server defs))
29099 (nnoo-map-functions nndir
29100 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29101 (nnmh-request-article 0 nndir-current-group 0 0)
29102 (nnmh-request-group nndir-current-group 0 0)
29103 (nnmh-close-group nndir-current-group 0))
29107 nnmh-status-message
29109 nnmh-request-newgroups))
29115 @node Hooking New Back Ends Into Gnus
29116 @subsubsection Hooking New Back Ends Into Gnus
29118 @vindex gnus-valid-select-methods
29119 @findex gnus-declare-backend
29120 Having Gnus start using your new back end is rather easy---you just
29121 declare it with the @code{gnus-declare-backend} functions. This will
29122 enter the back end into the @code{gnus-valid-select-methods} variable.
29124 @code{gnus-declare-backend} takes two parameters---the back end name and
29125 an arbitrary number of @dfn{abilities}.
29130 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
29133 The above line would then go in the @file{nnchoke.el} file.
29135 The abilities can be:
29139 This is a mailish back end---followups should (probably) go via mail.
29141 This is a newsish back end---followups should (probably) go via news.
29143 This back end supports both mail and news.
29145 This is neither a post nor mail back end---it's something completely
29148 It supports respooling---or rather, it is able to modify its source
29149 articles and groups.
29151 The name of the server should be in the virtual server name. This is
29152 true for almost all back ends.
29153 @item prompt-address
29154 The user should be prompted for an address when doing commands like
29155 @kbd{B} in the group buffer. This is true for back ends like
29156 @code{nntp}, but not @code{nnmbox}, for instance.
29160 @node Mail-like Back Ends
29161 @subsubsection Mail-like Back Ends
29163 One of the things that separate the mail back ends from the rest of the
29164 back ends is the heavy dependence by most of the mail back ends on
29165 common functions in @file{nnmail.el}. For instance, here's the
29166 definition of @code{nnml-request-scan}:
29169 (deffoo nnml-request-scan (&optional group server)
29170 (setq nnml-article-file-alist nil)
29171 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
29174 It simply calls @code{nnmail-get-new-mail} with a few parameters,
29175 and @code{nnmail} takes care of all the moving and splitting of the
29178 This function takes four parameters.
29182 This should be a symbol to designate which back end is responsible for
29185 @item exit-function
29186 This function should be called after the splitting has been performed.
29188 @item temp-directory
29189 Where the temporary files should be stored.
29192 This optional argument should be a group name if the splitting is to be
29193 performed for one group only.
29196 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
29197 save each article. @var{back-end}@code{-active-number} will be called to
29198 find the article number assigned to this article.
29200 The function also uses the following variables:
29201 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
29202 this back end); and @var{back-end}@code{-group-alist} and
29203 @var{back-end}@code{-active-file} to generate the new active file.
29204 @var{back-end}@code{-group-alist} should be a group-active alist, like
29208 (("a-group" (1 . 10))
29209 ("some-group" (34 . 39)))
29213 @node Score File Syntax
29214 @subsection Score File Syntax
29216 Score files are meant to be easily parseable, but yet extremely
29217 mallable. It was decided that something that had the same read syntax
29218 as an Emacs Lisp list would fit that spec.
29220 Here's a typical score file:
29224 ("win95" -10000 nil s)
29231 BNF definition of a score file:
29234 score-file = "" / "(" *element ")"
29235 element = rule / atom
29236 rule = string-rule / number-rule / date-rule
29237 string-rule = "(" quote string-header quote space *string-match ")"
29238 number-rule = "(" quote number-header quote space *number-match ")"
29239 date-rule = "(" quote date-header quote space *date-match ")"
29241 string-header = "subject" / "from" / "references" / "message-id" /
29242 "xref" / "body" / "head" / "all" / "followup"
29243 number-header = "lines" / "chars"
29244 date-header = "date"
29245 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
29246 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
29247 score = "nil" / <integer>
29248 date = "nil" / <natural number>
29249 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
29250 "r" / "regex" / "R" / "Regex" /
29251 "e" / "exact" / "E" / "Exact" /
29252 "f" / "fuzzy" / "F" / "Fuzzy"
29253 number-match = "(" <integer> [ "" / [ space score [ "" /
29254 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
29255 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
29256 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
29257 space date [ "" / [ space date-match-t ] ] ] ] ")"
29258 date-match-t = "nil" / "at" / "before" / "after"
29259 atom = "(" [ required-atom / optional-atom ] ")"
29260 required-atom = mark / expunge / mark-and-expunge / files /
29261 exclude-files / read-only / touched
29262 optional-atom = adapt / local / eval
29263 mark = "mark" space nil-or-number
29264 nil-or-number = "nil" / <integer>
29265 expunge = "expunge" space nil-or-number
29266 mark-and-expunge = "mark-and-expunge" space nil-or-number
29267 files = "files" *[ space <string> ]
29268 exclude-files = "exclude-files" *[ space <string> ]
29269 read-only = "read-only" [ space "nil" / space "t" ]
29270 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
29271 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
29272 local = "local" *[ space "(" <string> space <form> ")" ]
29273 eval = "eval" space <form>
29274 space = *[ " " / <TAB> / <NEWLINE> ]
29277 Any unrecognized elements in a score file should be ignored, but not
29280 As you can see, white space is needed, but the type and amount of white
29281 space is irrelevant. This means that formatting of the score file is
29282 left up to the programmer---if it's simpler to just spew it all out on
29283 one looong line, then that's ok.
29285 The meaning of the various atoms are explained elsewhere in this
29286 manual (@pxref{Score File Format}).
29290 @subsection Headers
29292 Internally Gnus uses a format for storing article headers that
29293 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
29294 almost suspect that the author looked at the @acronym{NOV} specification and
29295 just shamelessly @emph{stole} the entire thing, and one would be right.
29297 @dfn{Header} is a severely overloaded term. ``Header'' is used in
29298 RFC 1036 to talk about lines in the head of an article (e.g.,
29299 @code{From}). It is used by many people as a synonym for
29300 ``head''---``the header and the body''. (That should be avoided, in my
29301 opinion.) And Gnus uses a format internally that it calls ``header'',
29302 which is what I'm talking about here. This is a 9-element vector,
29303 basically, with each header (ouch) having one slot.
29305 These slots are, in order: @code{number}, @code{subject}, @code{from},
29306 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
29307 @code{xref}, and @code{extra}. There are macros for accessing and
29308 setting these slots---they all have predictable names beginning with
29309 @code{mail-header-} and @code{mail-header-set-}, respectively.
29311 All these slots contain strings, except the @code{extra} slot, which
29312 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
29318 @sc{gnus} introduced a concept that I found so useful that I've started
29319 using it a lot and have elaborated on it greatly.
29321 The question is simple: If you have a large amount of objects that are
29322 identified by numbers (say, articles, to take a @emph{wild} example)
29323 that you want to qualify as being ``included'', a normal sequence isn't
29324 very useful. (A 200,000 length sequence is a bit long-winded.)
29326 The solution is as simple as the question: You just collapse the
29330 (1 2 3 4 5 6 10 11 12)
29333 is transformed into
29336 ((1 . 6) (10 . 12))
29339 To avoid having those nasty @samp{(13 . 13)} elements to denote a
29340 lonesome object, a @samp{13} is a valid element:
29343 ((1 . 6) 7 (10 . 12))
29346 This means that comparing two ranges to find out whether they are equal
29347 is slightly tricky:
29350 ((1 . 5) 7 8 (10 . 12))
29356 ((1 . 5) (7 . 8) (10 . 12))
29359 are equal. In fact, any non-descending list is a range:
29365 is a perfectly valid range, although a pretty long-winded one. This is
29372 and is equal to the previous range.
29374 Here's a BNF definition of ranges. Of course, one must remember the
29375 semantic requirement that the numbers are non-descending. (Any number
29376 of repetition of the same number is allowed, but apt to disappear in
29380 range = simple-range / normal-range
29381 simple-range = "(" number " . " number ")"
29382 normal-range = "(" start-contents ")"
29383 contents = "" / simple-range *[ " " contents ] /
29384 number *[ " " contents ]
29387 Gnus currently uses ranges to keep track of read articles and article
29388 marks. I plan on implementing a number of range operators in C if The
29389 Powers That Be are willing to let me. (I haven't asked yet, because I
29390 need to do some more thinking on what operators I need to make life
29391 totally range-based without ever having to convert back to normal
29396 @subsection Group Info
29398 Gnus stores all permanent info on groups in a @dfn{group info} list.
29399 This list is from three to six elements (or more) long and exhaustively
29400 describes the group.
29402 Here are two example group infos; one is a very simple group while the
29403 second is a more complex one:
29406 ("no.group" 5 ((1 . 54324)))
29408 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
29409 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
29411 ((auto-expire . t) (to-address . "ding@@gnus.org")))
29414 The first element is the @dfn{group name}---as Gnus knows the group,
29415 anyway. The second element is the @dfn{subscription level}, which
29416 normally is a small integer. (It can also be the @dfn{rank}, which is a
29417 cons cell where the @code{car} is the level and the @code{cdr} is the
29418 score.) The third element is a list of ranges of read articles. The
29419 fourth element is a list of lists of article marks of various kinds.
29420 The fifth element is the select method (or virtual server, if you like).
29421 The sixth element is a list of @dfn{group parameters}, which is what
29422 this section is about.
29424 Any of the last three elements may be missing if they are not required.
29425 In fact, the vast majority of groups will normally only have the first
29426 three elements, which saves quite a lot of cons cells.
29428 Here's a BNF definition of the group info format:
29431 info = "(" group space ralevel space read
29432 [ "" / [ space marks-list [ "" / [ space method [ "" /
29433 space parameters ] ] ] ] ] ")"
29434 group = quote <string> quote
29435 ralevel = rank / level
29436 level = <integer in the range of 1 to inf>
29437 rank = "(" level "." score ")"
29438 score = <integer in the range of 1 to inf>
29440 marks-lists = nil / "(" *marks ")"
29441 marks = "(" <string> range ")"
29442 method = "(" <string> *elisp-forms ")"
29443 parameters = "(" *elisp-forms ")"
29446 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
29447 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
29450 If you have a Gnus info and want to access the elements, Gnus offers a
29451 series of macros for getting/setting these elements.
29454 @item gnus-info-group
29455 @itemx gnus-info-set-group
29456 @findex gnus-info-group
29457 @findex gnus-info-set-group
29458 Get/set the group name.
29460 @item gnus-info-rank
29461 @itemx gnus-info-set-rank
29462 @findex gnus-info-rank
29463 @findex gnus-info-set-rank
29464 Get/set the group rank (@pxref{Group Score}).
29466 @item gnus-info-level
29467 @itemx gnus-info-set-level
29468 @findex gnus-info-level
29469 @findex gnus-info-set-level
29470 Get/set the group level.
29472 @item gnus-info-score
29473 @itemx gnus-info-set-score
29474 @findex gnus-info-score
29475 @findex gnus-info-set-score
29476 Get/set the group score (@pxref{Group Score}).
29478 @item gnus-info-read
29479 @itemx gnus-info-set-read
29480 @findex gnus-info-read
29481 @findex gnus-info-set-read
29482 Get/set the ranges of read articles.
29484 @item gnus-info-marks
29485 @itemx gnus-info-set-marks
29486 @findex gnus-info-marks
29487 @findex gnus-info-set-marks
29488 Get/set the lists of ranges of marked articles.
29490 @item gnus-info-method
29491 @itemx gnus-info-set-method
29492 @findex gnus-info-method
29493 @findex gnus-info-set-method
29494 Get/set the group select method.
29496 @item gnus-info-params
29497 @itemx gnus-info-set-params
29498 @findex gnus-info-params
29499 @findex gnus-info-set-params
29500 Get/set the group parameters.
29503 All the getter functions take one parameter---the info list. The setter
29504 functions take two parameters---the info list and the new value.
29506 The last three elements in the group info aren't mandatory, so it may be
29507 necessary to extend the group info before setting the element. If this
29508 is necessary, you can just pass on a non-@code{nil} third parameter to
29509 the three final setter functions to have this happen automatically.
29512 @node Extended Interactive
29513 @subsection Extended Interactive
29514 @cindex interactive
29515 @findex gnus-interactive
29517 Gnus extends the standard Emacs @code{interactive} specification
29518 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
29519 Prefixes}). Here's an example of how this is used:
29522 (defun gnus-summary-increase-score (&optional score symp)
29523 (interactive (gnus-interactive "P\ny"))
29528 The best thing to do would have been to implement
29529 @code{gnus-interactive} as a macro which would have returned an
29530 @code{interactive} form, but this isn't possible since Emacs checks
29531 whether a function is interactive or not by simply doing an @code{assq}
29532 on the lambda form. So, instead we have @code{gnus-interactive}
29533 function that takes a string and returns values that are usable to
29534 @code{interactive}.
29536 This function accepts (almost) all normal @code{interactive} specs, but
29541 @vindex gnus-current-prefix-symbol
29542 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
29546 @vindex gnus-current-prefix-symbols
29547 A list of the current symbolic prefixes---the
29548 @code{gnus-current-prefix-symbol} variable.
29551 The current article number---the @code{gnus-summary-article-number}
29555 The current article header---the @code{gnus-summary-article-header}
29559 The current group name---the @code{gnus-group-group-name}
29565 @node Emacs/XEmacs Code
29566 @subsection Emacs/XEmacs Code
29570 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
29571 platforms must be the primary one. I chose Emacs. Not because I don't
29572 like XEmacs or Mule, but because it comes first alphabetically.
29574 This means that Gnus will byte-compile under Emacs with nary a warning,
29575 while XEmacs will pump out gigabytes of warnings while byte-compiling.
29576 As I use byte-compilation warnings to help me root out trivial errors in
29577 Gnus, that's very useful.
29579 I've also consistently used Emacs function interfaces, but have used
29580 Gnusey aliases for the functions. To take an example: Emacs defines a
29581 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
29582 function. I then define a function called @code{gnus-run-at-time} that
29583 takes the same parameters as the Emacs @code{run-at-time}. When running
29584 Gnus under Emacs, the former function is just an alias for the latter.
29585 However, when running under XEmacs, the former is an alias for the
29586 following function:
29589 (defun gnus-xmas-run-at-time (time repeat function &rest args)
29593 (,function ,@@args))
29597 This sort of thing has been done for bunches of functions. Gnus does
29598 not redefine any native Emacs functions while running under XEmacs---it
29599 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
29602 In the cases where the XEmacs function interface was obviously cleaner,
29603 I used it instead. For example @code{gnus-region-active-p} is an alias
29604 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
29606 Of course, I could have chosen XEmacs as my native platform and done
29607 mapping functions the other way around. But I didn't. The performance
29608 hit these indirections impose on Gnus under XEmacs should be slight.
29611 @node Various File Formats
29612 @subsection Various File Formats
29615 * Active File Format:: Information on articles and groups available.
29616 * Newsgroups File Format:: Group descriptions.
29620 @node Active File Format
29621 @subsubsection Active File Format
29623 The active file lists all groups available on the server in
29624 question. It also lists the highest and lowest current article numbers
29627 Here's an excerpt from a typical active file:
29630 soc.motss 296030 293865 y
29631 alt.binaries.pictures.fractals 3922 3913 n
29632 comp.sources.unix 1605 1593 m
29633 comp.binaries.ibm.pc 5097 5089 y
29634 no.general 1000 900 y
29637 Here's a pseudo-BNF definition of this file:
29640 active = *group-line
29641 group-line = group spc high-number spc low-number spc flag <NEWLINE>
29642 group = <non-white-space string>
29644 high-number = <non-negative integer>
29645 low-number = <positive integer>
29646 flag = "y" / "n" / "m" / "j" / "x" / "=" group
29649 For a full description of this file, see the manual pages for
29650 @samp{innd}, in particular @samp{active(5)}.
29653 @node Newsgroups File Format
29654 @subsubsection Newsgroups File Format
29656 The newsgroups file lists groups along with their descriptions. Not all
29657 groups on the server have to be listed, and not all groups in the file
29658 have to exist on the server. The file is meant purely as information to
29661 The format is quite simple; a group name, a tab, and the description.
29662 Here's the definition:
29666 line = group tab description <NEWLINE>
29667 group = <non-white-space string>
29669 description = <string>
29674 @node Emacs for Heathens
29675 @section Emacs for Heathens
29677 Believe it or not, but some people who use Gnus haven't really used
29678 Emacs much before they embarked on their journey on the Gnus Love Boat.
29679 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
29680 region'', and ``set @code{gnus-flargblossen} to an alist where the key
29681 is a regexp that is used for matching on the group name'' are magical
29682 phrases with little or no meaning, then this appendix is for you. If
29683 you are already familiar with Emacs, just ignore this and go fondle your
29687 * Keystrokes:: Entering text and executing commands.
29688 * Emacs Lisp:: The built-in Emacs programming language.
29693 @subsection Keystrokes
29697 Q: What is an experienced Emacs user?
29700 A: A person who wishes that the terminal had pedals.
29703 Yes, when you use Emacs, you are apt to use the control key, the shift
29704 key and the meta key a lot. This is very annoying to some people
29705 (notably @code{vi}le users), and the rest of us just love the hell out
29706 of it. Just give up and submit. Emacs really does stand for
29707 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
29708 may have heard from other disreputable sources (like the Emacs author).
29710 The shift keys are normally located near your pinky fingers, and are
29711 normally used to get capital letters and stuff. You probably use it all
29712 the time. The control key is normally marked ``CTRL'' or something like
29713 that. The meta key is, funnily enough, never marked as such on any
29714 keyboard. The one I'm currently at has a key that's marked ``Alt'',
29715 which is the meta key on this keyboard. It's usually located somewhere
29716 to the left hand side of the keyboard, usually on the bottom row.
29718 Now, us Emacs people don't say ``press the meta-control-m key'',
29719 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
29720 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
29721 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
29722 down the control key, and hold it down while you press @kbd{k}''.
29723 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
29724 the control key and then press @kbd{k}''. Simple, ay?
29726 This is somewhat complicated by the fact that not all keyboards have a
29727 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
29728 means ``press escape, release escape, press @kbd{k}''. That's much more
29729 work than if you have a meta key, so if that's the case, I respectfully
29730 suggest you get a real keyboard with a meta key. You can't live without
29736 @subsection Emacs Lisp
29738 Emacs is the King of Editors because it's really a Lisp interpreter.
29739 Each and every key you tap runs some Emacs Lisp code snippet, and since
29740 Emacs Lisp is an interpreted language, that means that you can configure
29741 any key to run any arbitrary code. You just, like, do it.
29743 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
29744 functions. (These are byte-compiled for speed, but it's still
29745 interpreted.) If you decide that you don't like the way Gnus does
29746 certain things, it's trivial to have it do something a different way.
29747 (Well, at least if you know how to write Lisp code.) However, that's
29748 beyond the scope of this manual, so we are simply going to talk about
29749 some common constructs that you normally use in your @file{~/.gnus.el}
29750 file to customize Gnus. (You can also use the @file{~/.emacs} file, but
29751 in order to set things of Gnus up, it is much better to use the
29752 @file{~/.gnus.el} file, @xref{Startup Files}.)
29754 If you want to set the variable @code{gnus-florgbnize} to four (4), you
29755 write the following:
29758 (setq gnus-florgbnize 4)
29761 This function (really ``special form'') @code{setq} is the one that can
29762 set a variable to some value. This is really all you need to know. Now
29763 you can go and fill your @file{~/.gnus.el} file with lots of these to
29764 change how Gnus works.
29766 If you have put that thing in your @file{~/.gnus.el} file, it will be
29767 read and @code{eval}ed (which is Lisp-ese for ``run'') the next time you
29768 start Gnus. If you want to change the variable right away, simply say
29769 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
29770 previous ``form'', which is a simple @code{setq} statement here.
29772 Go ahead---just try it, if you're located at your Emacs. After you
29773 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
29774 is the return value of the form you @code{eval}ed.
29778 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
29782 (setq gnus-read-active-file 'some)
29785 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
29786 @samp{nntp.ifi.uio.no}'', that means:
29789 (setq gnus-nntp-server "nntp.ifi.uio.no")
29792 So be careful not to mix up strings (the latter) with symbols (the
29793 former). The manual is unambiguous, but it can be confusing.
29796 @include gnus-faq.texi
29798 @node GNU Free Documentation License
29799 @chapter GNU Free Documentation License
29800 @include doclicense.texi
29820 @c Local Variables:
29822 @c coding: iso-8859-1
29826 arch-tag: c9fa47e7-78ca-4681-bda9-9fef45d1c819