3 @include gnus-overrides.texi
5 @setfilename ../../info/gnus
11 @documentencoding UTF-8
14 Copyright @copyright{} 1995--2013 Free Software Foundation, Inc.
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.3 or
19 any later version published by the Free Software Foundation; with no
20 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
21 and with the Back-Cover Texts as in (a) below. A copy of the license
22 is included in the section entitled ``GNU Free Documentation License''.
24 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
25 modify this GNU manual.''
31 \documentclass[twoside,a4paper,openright,11pt]{book}
32 \usepackage[latin1]{inputenc}
33 \usepackage{pagestyle}
36 \input{gnusconfig.tex}
38 \ifx\pdfoutput\undefined
40 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
48 % Adjust ../Makefile.in if you change the following line:
49 \newcommand{\gnusversionname}{Gnus v5.13}
50 \newcommand{\gnuschaptername}{}
51 \newcommand{\gnussectionname}{}
53 \newcommand{\gnusbackslash}{/}
55 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
56 \ifx\pdfoutput\undefined
57 \newcommand{\gnusuref}[1]{\gnustt{#1}}
59 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
61 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
62 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
64 \newcommand{\gnuskindex}[1]{\index{#1}}
65 \newcommand{\gnusindex}[1]{\index{#1}}
67 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
68 \newcommand{\gnuscode}[1]{\gnustt{#1}}
69 \newcommand{\gnusasis}[1]{\gnustt{#1}}
70 \newcommand{\gnusurl}[1]{\gnustt{#1}}
71 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
72 \newcommand{\gnusenv}[1]{\gnustt{#1}}
73 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
74 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
75 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
76 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
77 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
78 \newcommand{\gnusdfn}[1]{\textit{#1}}
79 \newcommand{\gnusi}[1]{\textit{#1}}
80 \newcommand{\gnusr}[1]{\textrm{#1}}
81 \newcommand{\gnusstrong}[1]{\textbf{#1}}
82 \newcommand{\gnusemph}[1]{\textit{#1}}
83 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
84 \newcommand{\gnussc}[1]{\textsc{#1}}
85 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
86 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
87 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
88 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
89 \newcommand{\gnusacronym}[1]{\textsc{#1}}
90 \newcommand{\gnusemail}[1]{\textit{#1}}
92 \newcommand{\gnusbullet}{{${\bullet}$}}
93 \newcommand{\gnusdollar}{\$}
94 \newcommand{\gnusampersand}{\&}
95 \newcommand{\gnuspercent}{\%}
96 \newcommand{\gnushash}{\#}
97 \newcommand{\gnushat}{\symbol{"5E}}
98 \newcommand{\gnusunderline}{\symbol{"5F}}
99 \newcommand{\gnusnot}{$\neg$}
100 \newcommand{\gnustilde}{\symbol{"7E}}
101 \newcommand{\gnusless}{{$<$}}
102 \newcommand{\gnusgreater}{{$>$}}
103 \newcommand{\gnusbraceleft}{{$>$}}
104 \newcommand{\gnusbraceright}{{$>$}}
106 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
107 \newcommand{\gnusinteresting}{
108 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
111 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
113 \newcommand{\gnuspagechapter}[1]{
117 \newdimen{\gnusdimen}
120 \newcommand{\gnuschapter}[2]{
122 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
124 \renewcommand{\gnussectionname}{}
125 \renewcommand{\gnuschaptername}{#2}
126 \thispagestyle{empty}
128 \begin{picture}(500,500)(0,0)
129 \put(480,350){\makebox(0,0)[tr]{#1}}
130 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
135 \newcommand{\gnusfigure}[3]{
137 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
144 \newcommand{\gnusicon}[1]{
145 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
148 \newcommand{\gnuspicon}[1]{
149 \margindex{\epsfig{figure=#1,width=2cm}}
152 \newcommand{\gnusxface}[2]{
153 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
156 \newcommand{\gnussmiley}[2]{
157 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
160 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
162 \newcommand{\gnussection}[1]{
163 \renewcommand{\gnussectionname}{#1}
167 \newenvironment{codelist}%
172 \newenvironment{asislist}%
177 \newenvironment{kbdlist}%
183 \newenvironment{dfnlist}%
188 \newenvironment{stronglist}%
193 \newenvironment{samplist}%
198 \newenvironment{varlist}%
203 \newenvironment{emphlist}%
208 \newlength\gnusheadtextwidth
209 \setlength{\gnusheadtextwidth}{\headtextwidth}
210 \addtolength{\gnusheadtextwidth}{1cm}
212 \newpagestyle{gnuspreamble}%
217 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
221 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
230 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
232 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
237 \newpagestyle{gnusindex}%
242 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
246 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
254 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
256 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
266 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
270 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
278 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
280 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
285 \pagenumbering{roman}
286 \pagestyle{gnuspreamble}
297 %\addtolength{\oddsidemargin}{-5cm}
298 %\addtolength{\evensidemargin}{-5cm}
300 \addtolength{\textheight}{2cm}
302 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
305 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
308 \gnusauthor{by Lars Magne Ingebrigtsen}
315 \thispagestyle{empty}
323 @dircategory Emacs network features
325 * Gnus: (gnus). The newsreader Gnus.
334 @title Gnus Manual (DEVELOPMENT VERSION)
336 @ifclear WEBHACKDEVEL
340 @author by Lars Magne Ingebrigtsen
342 @vskip 0pt plus 1filll
350 @top The Gnus Newsreader
354 You can read news (and mail) from within Emacs by using Gnus. The news
355 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
356 spool or your mbox file. All at the same time, if you want to push your
359 @c Adjust ../Makefile.in if you change the following line:
360 This manual corresponds to Gnus v5.13
375 Gnus is the advanced, self-documenting, customizable, extensible
376 unreal-time newsreader for GNU Emacs.
378 Oops. That sounds oddly familiar, so let's start over again to avoid
379 being accused of plagiarism:
381 Gnus is a message-reading laboratory. It will let you look at just
382 about anything as if it were a newsgroup. You can read mail with it,
383 you can browse directories with it, you can @code{ftp} with it---you
384 can even read news with it!
386 Gnus tries to empower people who read news the same way Emacs empowers
387 people who edit text. Gnus sets no limits to what the user should be
388 allowed to do. Users are encouraged to extend Gnus to make it behave
389 like they want it to behave. A program should not control people;
390 people should be empowered to do what they want by using (or abusing)
393 @c Adjust ../Makefile.in if you change the following line:
394 This manual corresponds to Gnus v5.13
396 @heading Other related manuals
398 @item Message manual: Composing messages
399 @item Emacs-MIME: Composing messages; @acronym{MIME}-specific parts.
400 @item Sieve: Managing Sieve scripts in Emacs.
401 @item EasyPG: @acronym{PGP/MIME} with Gnus.
402 @item SASL: @acronym{SASL} authentication in Emacs.
408 * Starting Up:: Finding news can be a pain.
409 * Group Buffer:: Selecting, subscribing and killing groups.
410 * Summary Buffer:: Reading, saving and posting articles.
411 * Article Buffer:: Displaying and handling articles.
412 * Composing Messages:: Information on sending mail and news.
413 * Select Methods:: Gnus reads all messages from various select methods.
414 * Scoring:: Assigning values to articles.
415 * Searching:: Mail and News search engines.
416 * Various:: General purpose settings.
417 * The End:: Farewell and goodbye.
418 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
419 * GNU Free Documentation License:: The license for this documentation.
420 * Index:: Variable, function and concept index.
421 * Key Index:: Key Index.
423 @c Doesn't work right in html.
424 @c FIXME Do this in a more standard way.
426 Other related manuals
428 * Message:(message). Composing messages.
429 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
430 * Sieve:(sieve). Managing Sieve scripts in Emacs.
431 * EasyPG:(epa). @acronym{PGP/MIME} with Gnus.
432 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
436 --- The Detailed Node Listing ---
440 * Finding the News:: Choosing a method for getting news.
441 * The Server is Down:: How can I read my mail then?
442 * Slave Gnusae:: You can have more than one Gnus active at a time.
443 * Fetching a Group:: Starting Gnus just to read a group.
444 * New Groups:: What is Gnus supposed to do with new groups?
445 * Changing Servers:: You may want to move from one server to another.
446 * Startup Files:: Those pesky startup files---@file{.newsrc}.
447 * Auto Save:: Recovering from a crash.
448 * The Active File:: Reading the active file over a slow line Takes Time.
449 * Startup Variables:: Other variables you might change.
453 * Checking New Groups:: Determining what groups are new.
454 * Subscription Methods:: What Gnus should do with new groups.
455 * Filtering New Groups:: Making Gnus ignore certain new groups.
459 * Group Buffer Format:: Information listed and how you can change it.
460 * Group Maneuvering:: Commands for moving in the group buffer.
461 * Selecting a Group:: Actually reading news.
462 * Subscription Commands:: Unsubscribing, killing, subscribing.
463 * Group Data:: Changing the info for a group.
464 * Group Levels:: Levels? What are those, then?
465 * Group Score:: A mechanism for finding out what groups you like.
466 * Marking Groups:: You can mark groups for later processing.
467 * Foreign Groups:: Creating and editing groups.
468 * Group Parameters:: Each group may have different parameters set.
469 * Listing Groups:: Gnus can list various subsets of the groups.
470 * Sorting Groups:: Re-arrange the group order.
471 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
472 * Browse Foreign Server:: You can browse a server. See what it has to offer.
473 * Exiting Gnus:: Stop reading news and get some work done.
474 * Group Topics:: A folding group mode divided into topics.
475 * Non-ASCII Group Names:: Accessing groups of non-English names.
476 * Misc Group Stuff:: Other stuff that you can to do.
480 * Group Line Specification:: Deciding how the group buffer is to look.
481 * Group Mode Line Specification:: The group buffer mode line.
482 * Group Highlighting:: Having nice colors in the group buffer.
486 * Topic Commands:: Interactive E-Z commands.
487 * Topic Variables:: How to customize the topics the Lisp Way.
488 * Topic Sorting:: Sorting each topic individually.
489 * Topic Topology:: A map of the world.
490 * Topic Parameters:: Parameters that apply to all groups in a topic.
494 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
495 * Group Information:: Information and help on groups and Gnus.
496 * Group Timestamp:: Making Gnus keep track of when you last read a group.
497 * File Commands:: Reading and writing the Gnus files.
498 * Sieve Commands:: Managing Sieve scripts.
502 * Summary Buffer Format:: Deciding how the summary buffer is to look.
503 * Summary Maneuvering:: Moving around the summary buffer.
504 * Choosing Articles:: Reading articles.
505 * Paging the Article:: Scrolling the current article.
506 * Reply Followup and Post:: Posting articles.
507 * Delayed Articles:: Send articles at a later time.
508 * Marking Articles:: Marking articles as read, expirable, etc.
509 * Limiting:: You can limit the summary buffer.
510 * Threading:: How threads are made.
511 * Sorting the Summary Buffer:: How articles and threads are sorted.
512 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
513 * Article Caching:: You may store articles in a cache.
514 * Persistent Articles:: Making articles expiry-resistant.
515 * Sticky Articles:: Article buffers that are not reused.
516 * Article Backlog:: Having already read articles hang around.
517 * Saving Articles:: Ways of customizing article saving.
518 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
519 * Article Treatment:: The article buffer can be mangled at will.
520 * MIME Commands:: Doing MIMEy things with the articles.
521 * Charsets:: Character set issues.
522 * Article Commands:: Doing various things with the article buffer.
523 * Summary Sorting:: Sorting the summary buffer in various ways.
524 * Finding the Parent:: No child support? Get the parent.
525 * Alternative Approaches:: Reading using non-default summaries.
526 * Tree Display:: A more visual display of threads.
527 * Mail Group Commands:: Some commands can only be used in mail groups.
528 * Various Summary Stuff:: What didn't fit anywhere else.
529 * Exiting the Summary Buffer:: Returning to the Group buffer,
530 or reselecting the current group.
531 * Crosspost Handling:: How crossposted articles are dealt with.
532 * Duplicate Suppression:: An alternative when crosspost handling fails.
533 * Security:: Decrypt and Verify.
534 * Mailing List:: Mailing list minor mode.
536 Summary Buffer Format
538 * Summary Buffer Lines:: You can specify how summary lines should look.
539 * To From Newsgroups:: How to not display your own name.
540 * Summary Buffer Mode Line:: You can say how the mode line should look.
541 * Summary Highlighting:: Making the summary buffer all pretty and nice.
545 * Choosing Commands:: Commands for choosing articles.
546 * Choosing Variables:: Variables that influence these commands.
548 Reply, Followup and Post
550 * Summary Mail Commands:: Sending mail.
551 * Summary Post Commands:: Sending news.
552 * Summary Message Commands:: Other Message-related commands.
553 * Canceling and Superseding::
557 * Unread Articles:: Marks for unread articles.
558 * Read Articles:: Marks for read articles.
559 * Other Marks:: Marks that do not affect readedness.
560 * Setting Marks:: How to set and remove marks.
561 * Generic Marking Commands:: How to customize the marking.
562 * Setting Process Marks:: How to mark articles for later processing.
566 * Customizing Threading:: Variables you can change to affect the threading.
567 * Thread Commands:: Thread based commands in the summary buffer.
569 Customizing Threading
571 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
572 * Filling In Threads:: Making the threads displayed look fuller.
573 * More Threading:: Even more variables for fiddling with threads.
574 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
578 * Uuencoded Articles:: Uudecode articles.
579 * Shell Archives:: Unshar articles.
580 * PostScript Files:: Split PostScript.
581 * Other Files:: Plain save and binhex.
582 * Decoding Variables:: Variables for a happy decoding.
583 * Viewing Files:: You want to look at the result of the decoding?
587 * Rule Variables:: Variables that say how a file is to be viewed.
588 * Other Decode Variables:: Other decode variables.
589 * Uuencoding and Posting:: Variables for customizing uuencoding.
593 * Article Highlighting:: You want to make the article look like fruit salad.
594 * Article Fontisizing:: Making emphasized text look nice.
595 * Article Hiding:: You also want to make certain info go away.
596 * Article Washing:: Lots of way-neat functions to make life better.
597 * Article Header:: Doing various header transformations.
598 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
599 * Article Button Levels:: Controlling appearance of buttons.
600 * Article Date:: Grumble, UT!
601 * Article Display:: Display various stuff---X-Face, Picons, Smileys, Gravatars
602 * Article Signature:: What is a signature?
603 * Article Miscellanea:: Various other stuff.
605 Alternative Approaches
607 * Pick and Read:: First mark articles and then read them.
608 * Binary Groups:: Auto-decode all articles.
610 Various Summary Stuff
612 * Summary Group Information:: Information oriented commands.
613 * Searching for Articles:: Multiple article commands.
614 * Summary Generation Commands::
615 * Really Various Summary Commands:: Those pesky non-conformant commands.
619 * Hiding Headers:: Deciding what headers should be displayed.
620 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
621 * Customizing Articles:: Tailoring the look of the articles.
622 * Article Keymap:: Keystrokes available in the article buffer.
623 * Misc Article:: Other stuff.
627 * Mail:: Mailing and replying.
628 * Posting Server:: What server should you post and mail via?
629 * POP before SMTP:: You cannot send a mail unless you read a mail.
630 * Mail and Post:: Mailing and posting at the same time.
631 * Archived Messages:: Where Gnus stores the messages you've sent.
632 * Posting Styles:: An easier way to specify who you are.
633 * Drafts:: Postponing messages and rejected messages.
634 * Rejected Articles:: What happens if the server doesn't like your article?
635 * Signing and encrypting:: How to compose secure messages.
639 * Server Buffer:: Making and editing virtual servers.
640 * Getting News:: Reading USENET news with Gnus.
641 * Using IMAP:: Reading mail from @acronym{IMAP}.
642 * Getting Mail:: Reading your personal mail with Gnus.
643 * Browsing the Web:: Getting messages from a plethora of Web sources.
644 * Other Sources:: Reading directories, files.
645 * Combined Groups:: Combining groups into one group.
646 * Email Based Diary:: Using mails to manage diary events in Gnus.
647 * Gnus Unplugged:: Reading news and mail offline.
651 * Server Buffer Format:: You can customize the look of this buffer.
652 * Server Commands:: Commands to manipulate servers.
653 * Example Methods:: Examples server specifications.
654 * Creating a Virtual Server:: An example session.
655 * Server Variables:: Which variables to set.
656 * Servers and Methods:: You can use server names as select methods.
657 * Unavailable Servers:: Some servers you try to contact may be down.
661 * NNTP:: Reading news from an @acronym{NNTP} server.
662 * News Spool:: Reading news from the local spool.
666 * Direct Functions:: Connecting directly to the server.
667 * Indirect Functions:: Connecting indirectly to the server.
668 * Common Variables:: Understood by several connection functions.
672 * Mail in a Newsreader:: Important introductory notes.
673 * Getting Started Reading Mail:: A simple cookbook example.
674 * Splitting Mail:: How to create mail groups.
675 * Mail Sources:: How to tell Gnus where to get mail from.
676 * Mail Back End Variables:: Variables for customizing mail handling.
677 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
678 * Group Mail Splitting:: Use group customize to drive mail splitting.
679 * Incorporating Old Mail:: What about the old mail you have?
680 * Expiring Mail:: Getting rid of unwanted mail.
681 * Washing Mail:: Removing cruft from the mail you get.
682 * Duplicates:: Dealing with duplicated mail.
683 * Not Reading Mail:: Using mail back ends for reading other files.
684 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
688 * Mail Source Specifiers:: How to specify what a mail source is.
689 * Mail Source Customization:: Some variables that influence things.
690 * Fetching Mail:: Using the mail source specifiers.
692 Choosing a Mail Back End
694 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
695 * Babyl:: Babyl was used by older versions of Rmail.
696 * Mail Spool:: Store your mail in a private spool?
697 * MH Spool:: An mhspool-like back end.
698 * Maildir:: Another one-file-per-message format.
699 * Mail Folders:: Having one file for each group.
700 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
705 * Web Searches:: Creating groups from articles that match a string.
706 * RSS:: Reading RDF site summary.
707 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
711 * Directory Groups:: You can read a directory as if it was a newsgroup.
712 * Anything Groups:: Dired? Who needs dired?
713 * Document Groups:: Single files can be the basis of a group.
714 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
715 * The Empty Backend:: The backend that never has any news.
719 * Document Server Internals:: How to add your own document types.
723 * Virtual Groups:: Combining articles from many groups.
727 * The NNDiary Back End:: Basic setup and usage.
728 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
729 * Sending or Not Sending:: A final note on sending diary messages.
733 * Diary Messages:: What makes a message valid for nndiary.
734 * Running NNDiary:: NNDiary has two modes of operation.
735 * Customizing NNDiary:: Bells and whistles.
737 The Gnus Diary Library
739 * Diary Summary Line Format:: A nicer summary buffer line format.
740 * Diary Articles Sorting:: A nicer way to sort messages.
741 * Diary Headers Generation:: Not doing it manually.
742 * Diary Group Parameters:: Not handling them manually.
746 * Agent Basics:: How it all is supposed to work.
747 * Agent Categories:: How to tell the Gnus Agent what to download.
748 * Agent Commands:: New commands for all the buffers.
749 * Agent Visuals:: Ways that the agent may effect your summary buffer.
750 * Agent as Cache:: The Agent is a big cache too.
751 * Agent Expiry:: How to make old articles go away.
752 * Agent Regeneration:: How to recover from lost connections and other accidents.
753 * Agent and flags:: How the Agent maintains flags.
754 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
755 * Outgoing Messages:: What happens when you post/mail something?
756 * Agent Variables:: Customizing is fun.
757 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
758 * Batching Agents:: How to fetch news from a @code{cron} job.
759 * Agent Caveats:: What you think it'll do and what it does.
763 * Category Syntax:: What a category looks like.
764 * Category Buffer:: A buffer for maintaining categories.
765 * Category Variables:: Customize'r'Us.
769 * Group Agent Commands:: Configure groups and fetch their contents.
770 * Summary Agent Commands:: Manually select then fetch specific articles.
771 * Server Agent Commands:: Select the servers that are supported by the agent.
775 * Summary Score Commands:: Adding score entries for the current group.
776 * Group Score Commands:: General score commands.
777 * Score Variables:: Customize your scoring. (My, what terminology).
778 * Score File Format:: What a score file may contain.
779 * Score File Editing:: You can edit score files by hand as well.
780 * Adaptive Scoring:: Big Sister Gnus knows what you read.
781 * Home Score File:: How to say where new score entries are to go.
782 * Followups To Yourself:: Having Gnus notice when people answer you.
783 * Scoring On Other Headers:: Scoring on non-standard headers.
784 * Scoring Tips:: How to score effectively.
785 * Reverse Scoring:: That problem child of old is not problem.
786 * Global Score Files:: Earth-spanning, ear-splitting score files.
787 * Kill Files:: They are still here, but they can be ignored.
788 * Converting Kill Files:: Translating kill files to score files.
789 * Advanced Scoring:: Using logical expressions to build score rules.
790 * Score Decays:: It can be useful to let scores wither away.
794 * Advanced Scoring Syntax:: A definition.
795 * Advanced Scoring Examples:: What they look like.
796 * Advanced Scoring Tips:: Getting the most out of it.
800 * nnir:: Searching with various engines.
801 * nnmairix:: Searching with Mairix.
805 * What is nnir?:: What does nnir do.
806 * Basic Usage:: How to perform simple searches.
807 * Setting up nnir:: How to set up nnir.
811 * Associating Engines:: How to associate engines.
815 * Process/Prefix:: A convention used by many treatment commands.
816 * Interactive:: Making Gnus ask you many questions.
817 * Symbolic Prefixes:: How to supply some Gnus functions with options.
818 * Formatting Variables:: You can specify what buffers should look like.
819 * Window Layout:: Configuring the Gnus buffer windows.
820 * Faces and Fonts:: How to change how faces look.
821 * Mode Lines:: Displaying information in the mode lines.
822 * Highlighting and Menus:: Making buffers look all nice and cozy.
823 * Daemons:: Gnus can do things behind your back.
824 * Undo:: Some actions can be undone.
825 * Predicate Specifiers:: Specifying predicates.
826 * Moderation:: What to do if you're a moderator.
827 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
828 * Fuzzy Matching:: What's the big fuzz?
829 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
830 * Spam Package:: A package for filtering and processing spam.
831 * The Gnus Registry:: A package for tracking messages by Message-ID.
832 * Other modes:: Interaction with other modes.
833 * Various Various:: Things that are really various.
837 * Formatting Basics:: A formatting variable is basically a format string.
838 * Mode Line Formatting:: Some rules about mode line formatting variables.
839 * Advanced Formatting:: Modifying output in various ways.
840 * User-Defined Specs:: Having Gnus call your own functions.
841 * Formatting Fonts:: Making the formatting look colorful and nice.
842 * Positioning Point:: Moving point to a position after an operation.
843 * Tabulation:: Tabulating your output.
844 * Wide Characters:: Dealing with wide characters.
848 * X-Face:: Display a funky, teensy black-and-white image.
849 * Face:: Display a funkier, teensier colored image.
850 * Smileys:: Show all those happy faces the way they were
852 * Picons:: How to display pictures of what you're reading.
853 * Gravatars:: Display the avatar of people you read.
854 * XVarious:: Other XEmacsy Gnusey variables.
858 * The problem of spam:: Some background, and some solutions
859 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
860 * SpamAssassin:: How to use external anti-spam tools.
861 * Hashcash:: Reduce spam by burning CPU time.
865 * Spam Package Introduction::
866 * Filtering Incoming Mail::
867 * Detecting Spam in Groups::
868 * Spam and Ham Processors::
869 * Spam Package Configuration Examples::
871 * Extending the Spam package::
872 * Spam Statistics Package::
874 Spam Statistics Package
876 * Creating a spam-stat dictionary::
877 * Splitting mail using spam-stat::
878 * Low-level interface to the spam-stat dictionary::
882 * XEmacs:: Requirements for installing under XEmacs.
883 * History:: How Gnus got where it is today.
884 * On Writing Manuals:: Why this is not a beginner's guide.
885 * Terminology:: We use really difficult, like, words here.
886 * Customization:: Tailoring Gnus to your needs.
887 * Troubleshooting:: What you might try if things do not work.
888 * Gnus Reference Guide:: Rilly, rilly technical stuff.
889 * Emacs for Heathens:: A short introduction to Emacsian terms.
890 * Frequently Asked Questions:: The Gnus FAQ
894 * Gnus Versions:: What Gnus versions have been released.
895 * Why?:: What's the point of Gnus?
896 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
897 * Conformity:: Gnus tries to conform to all standards.
898 * Emacsen:: Gnus can be run on a few modern Emacsen.
899 * Gnus Development:: How Gnus is developed.
900 * Contributors:: Oodles of people.
901 * New Features:: Pointers to some of the new stuff in Gnus.
905 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
906 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
907 * Red Gnus:: Third time best---Gnus 5.4/5.5.
908 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
909 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
910 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
911 * No Gnus:: Very punny. Gnus 5.12/5.13
912 * Ma Gnus:: Celebrating 25 years of Gnus.
916 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
917 * Slow Terminal Connection:: You run a remote Emacs.
918 * Little Disk Space:: You feel that having large setup files is icky.
919 * Slow Machine:: You feel like buying a faster machine.
923 * Gnus Utility Functions:: Common functions and variable to use.
924 * Back End Interface:: How Gnus communicates with the servers.
925 * Score File Syntax:: A BNF definition of the score file standard.
926 * Headers:: How Gnus stores headers internally.
927 * Ranges:: A handy format for storing mucho numbers.
928 * Group Info:: The group info format.
929 * Extended Interactive:: Symbolic prefixes and stuff.
930 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
931 * Various File Formats:: Formats of files that Gnus use.
935 * Required Back End Functions:: Functions that must be implemented.
936 * Optional Back End Functions:: Functions that need not be implemented.
937 * Error Messaging:: How to get messages and report errors.
938 * Writing New Back Ends:: Extending old back ends.
939 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
940 * Mail-like Back Ends:: Some tips on mail back ends.
944 * Active File Format:: Information on articles and groups available.
945 * Newsgroups File Format:: Group descriptions.
949 * Keystrokes:: Entering text and executing commands.
950 * Emacs Lisp:: The built-in Emacs programming language.
956 @chapter Starting Gnus
959 If you haven't used Emacs much before using Gnus, read @ref{Emacs for
964 If your system administrator has set things up properly, starting Gnus
965 and reading news is extremely easy---you just type @kbd{M-x gnus} in
966 your Emacs. If not, you should customize the variable
967 @code{gnus-select-method} as described in @ref{Finding the News}. For a
968 minimal setup for posting should also customize the variables
969 @code{user-full-name} and @code{user-mail-address}.
971 @findex gnus-other-frame
972 @kindex M-x gnus-other-frame
973 If you want to start Gnus in a different frame, you can use the command
974 @kbd{M-x gnus-other-frame} instead.
976 If things do not go smoothly at startup, you have to twiddle some
977 variables in your @file{~/.gnus.el} file. This file is similar to
978 @file{~/.emacs}, but is read when Gnus starts.
980 If you puzzle at any terms used in this manual, please refer to the
981 terminology section (@pxref{Terminology}).
984 * Finding the News:: Choosing a method for getting news.
985 * The Server is Down:: How can I read my mail then?
986 * Slave Gnusae:: You can have more than one Gnus active at a time.
987 * New Groups:: What is Gnus supposed to do with new groups?
988 * Changing Servers:: You may want to move from one server to another.
989 * Startup Files:: Those pesky startup files---@file{.newsrc}.
990 * Auto Save:: Recovering from a crash.
991 * The Active File:: Reading the active file over a slow line Takes Time.
992 * Startup Variables:: Other variables you might change.
996 @node Finding the News
997 @section Finding the News
1000 First of all, you should know that there is a special buffer called
1001 @code{*Server*} that lists all the servers Gnus knows about. You can
1002 press @kbd{^} from the Group buffer to see it. In the Server buffer,
1003 you can press @kbd{RET} on a defined server to see all the groups it
1004 serves (subscribed or not!). You can also add or delete servers, edit
1005 a foreign server's definition, agentize or de-agentize a server, and
1006 do many other neat things. @xref{Server Buffer}.
1007 @xref{Foreign Groups}. @xref{Agent Basics}.
1009 @vindex gnus-select-method
1011 The @code{gnus-select-method} variable says where Gnus should look for
1012 news. This variable should be a list where the first element says
1013 @dfn{how} and the second element says @dfn{where}. This method is your
1014 native method. All groups not fetched with this method are
1015 secondary or foreign groups.
1017 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
1018 you want to get your daily dosage of news from, you'd say:
1021 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1024 If you want to read directly from the local spool, say:
1027 (setq gnus-select-method '(nnspool ""))
1030 If you can use a local spool, you probably should, as it will almost
1031 certainly be much faster. But do not use the local spool if your
1032 server is running Leafnode (which is a simple, standalone private news
1033 server); in this case, use @code{(nntp "localhost")}.
1035 @vindex gnus-nntpserver-file
1037 @cindex @acronym{NNTP} server
1038 If this variable is not set, Gnus will take a look at the
1039 @env{NNTPSERVER} environment variable. If that variable isn't set,
1040 Gnus will see whether @code{gnus-nntpserver-file}
1041 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1042 If that fails as well, Gnus will try to use the machine running Emacs
1043 as an @acronym{NNTP} server. That's a long shot, though.
1045 @findex gnus-group-browse-foreign-server
1047 However, if you use one @acronym{NNTP} server regularly and are just
1048 interested in a couple of groups from a different server, you would be
1049 better served by using the @kbd{B} command in the group buffer. It will
1050 let you have a look at what groups are available, and you can subscribe
1051 to any of the groups you want to. This also makes @file{.newsrc}
1052 maintenance much tidier. @xref{Foreign Groups}.
1054 @vindex gnus-secondary-select-methods
1056 A slightly different approach to foreign groups is to set the
1057 @code{gnus-secondary-select-methods} variable. The select methods
1058 listed in this variable are in many ways just as native as the
1059 @code{gnus-select-method} server. They will also be queried for active
1060 files during startup (if that's required), and new newsgroups that
1061 appear on these servers will be subscribed (or not) just as native
1064 For instance, if you use the @code{nnmbox} back end to read your mail,
1065 you would typically set this variable to
1068 (setq gnus-secondary-select-methods '((nnmbox "")))
1073 @node The Server is Down
1074 @section The Server is Down
1075 @cindex server errors
1077 If the default server is down, Gnus will understandably have some
1078 problems starting. However, if you have some mail groups in addition to
1079 the news groups, you may want to start Gnus anyway.
1081 Gnus, being the trusting sort of program, will ask whether to proceed
1082 without a native select method if that server can't be contacted. This
1083 will happen whether the server doesn't actually exist (i.e., you have
1084 given the wrong address) or the server has just momentarily taken ill
1085 for some reason or other. If you decide to continue and have no foreign
1086 groups, you'll find it difficult to actually do anything in the group
1087 buffer. But, hey, that's your problem. Blllrph!
1089 @findex gnus-no-server
1090 @kindex M-x gnus-no-server
1092 If you know that the server is definitely down, or you just want to read
1093 your mail without bothering with the server at all, you can use the
1094 @code{gnus-no-server} command to start Gnus. That might come in handy
1095 if you're in a hurry as well. This command will not attempt to contact
1096 your primary server---instead, it will just activate all groups on level
1097 1 and 2. (You should preferably keep no native groups on those two
1098 levels.) Also @pxref{Group Levels}.
1102 @section Slave Gnusae
1105 You might want to run more than one Emacs with more than one Gnus at the
1106 same time. If you are using different @file{.newsrc} files (e.g., if you
1107 are using the two different Gnusae to read from two different servers),
1108 that is no problem whatsoever. You just do it.
1110 The problem appears when you want to run two Gnusae that use the same
1111 @file{.newsrc} file.
1113 To work around that problem some, we here at the Think-Tank at the Gnus
1114 Towers have come up with a new concept: @dfn{Masters} and
1115 @dfn{slaves}. (We have applied for a patent on this concept, and have
1116 taken out a copyright on those words. If you wish to use those words in
1117 conjunction with each other, you have to send $1 per usage instance to
1118 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1119 Applications}) will be much more expensive, of course.)
1122 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1123 however you do it). Each subsequent slave Gnusae should be started with
1124 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1125 files, but instead save @dfn{slave files} that contain information only
1126 on what groups have been read in the slave session. When a master Gnus
1127 starts, it will read (and delete) these slave files, incorporating all
1128 information from them. (The slave files will be read in the sequence
1129 they were created, so the latest changes will have precedence.)
1131 Information from the slave files has, of course, precedence over the
1132 information in the normal (i.e., master) @file{.newsrc} file.
1134 If the @file{.newsrc*} files have not been saved in the master when the
1135 slave starts, you may be prompted as to whether to read an auto-save
1136 file. If you answer ``yes'', the unsaved changes to the master will be
1137 incorporated into the slave. If you answer ``no'', the slave may see some
1138 messages as unread that have been read in the master.
1145 @cindex subscription
1147 @vindex gnus-check-new-newsgroups
1148 If you are satisfied that you really never want to see any new groups,
1149 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1150 also save you some time at startup. Even if this variable is
1151 @code{nil}, you can always subscribe to the new groups just by pressing
1152 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1153 is @code{ask-server} by default. If you set this variable to
1154 @code{always}, then Gnus will query the back ends for new groups even
1155 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1158 * Checking New Groups:: Determining what groups are new.
1159 * Subscription Methods:: What Gnus should do with new groups.
1160 * Filtering New Groups:: Making Gnus ignore certain new groups.
1164 @node Checking New Groups
1165 @subsection Checking New Groups
1167 Gnus normally determines whether a group is new or not by comparing
1168 the list of groups from the active file(s) with the lists of
1169 subscribed and dead groups. This isn't a particularly fast method.
1170 If @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will
1171 ask the server for new groups since the last time. This is both
1172 faster and cheaper. This also means that you can get rid of the list
1173 of killed groups (@pxref{Group Levels}) altogether, so you may set
1174 @code{gnus-save-killed-list} to @code{nil}, which will save time both
1175 at startup, at exit, and all over. Saves disk space, too. Why isn't
1176 this the default, then? Unfortunately, not all servers support this
1179 I bet I know what you're thinking now: How do I find out whether my
1180 server supports @code{ask-server}? No? Good, because I don't have a
1181 fail-safe answer. I would suggest just setting this variable to
1182 @code{ask-server} and see whether any new groups appear within the next
1183 few days. If any do, then it works. If none do, then it doesn't
1184 work. I could write a function to make Gnus guess whether the server
1185 supports @code{ask-server}, but it would just be a guess. So I won't.
1186 You could @code{telnet} to the server and say @code{HELP} and see
1187 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1188 it does, then it might work. (But there are servers that lists
1189 @samp{NEWGROUPS} without supporting the function properly.)
1191 This variable can also be a list of select methods. If so, Gnus will
1192 issue an @code{ask-server} command to each of the select methods, and
1193 subscribe them (or not) using the normal methods. This might be handy
1194 if you are monitoring a few servers for new groups. A side effect is
1195 that startup will take much longer, so you can meditate while waiting.
1196 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1199 @node Subscription Methods
1200 @subsection Subscription Methods
1202 @vindex gnus-subscribe-newsgroup-method
1203 What Gnus does when it encounters a new group is determined by the
1204 @code{gnus-subscribe-newsgroup-method} variable.
1206 This variable should contain a function. This function will be called
1207 with the name of the new group as the only parameter.
1209 Some handy pre-fab functions are:
1213 @item gnus-subscribe-zombies
1214 @vindex gnus-subscribe-zombies
1215 Make all new groups zombies (@pxref{Group Levels}). This is the
1216 default. You can browse the zombies later (with @kbd{A z}) and either
1217 kill them all off properly (with @kbd{S z}), or subscribe to them
1220 @item gnus-subscribe-randomly
1221 @vindex gnus-subscribe-randomly
1222 Subscribe all new groups in arbitrary order. This really means that all
1223 new groups will be added at ``the top'' of the group buffer.
1225 @item gnus-subscribe-alphabetically
1226 @vindex gnus-subscribe-alphabetically
1227 Subscribe all new groups in alphabetical order.
1229 @item gnus-subscribe-hierarchically
1230 @vindex gnus-subscribe-hierarchically
1231 Subscribe all new groups hierarchically. The difference between this
1232 function and @code{gnus-subscribe-alphabetically} is slight.
1233 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1234 alphabetical fashion, while this function will enter groups into its
1235 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1236 @samp{comp} hierarchy, this function will not mess that configuration
1237 up. Or something like that.
1239 @item gnus-subscribe-interactively
1240 @vindex gnus-subscribe-interactively
1241 Subscribe new groups interactively. This means that Gnus will ask
1242 you about @strong{all} new groups. The groups you choose to subscribe
1243 to will be subscribed hierarchically.
1245 @item gnus-subscribe-killed
1246 @vindex gnus-subscribe-killed
1247 Kill all new groups.
1249 @item gnus-subscribe-topics
1250 @vindex gnus-subscribe-topics
1251 Put the groups into the topic that has a matching @code{subscribe} topic
1252 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1253 topic parameter that looks like
1259 will mean that all groups that match that regex will be subscribed under
1262 If no topics match the groups, the groups will be subscribed in the
1267 @vindex gnus-subscribe-hierarchical-interactive
1268 A closely related variable is
1269 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1270 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1271 hierarchical fashion whether to subscribe to new groups or not. Gnus
1272 will ask you for each sub-hierarchy whether you want to descend the
1275 One common mistake is to set the variable a few paragraphs above
1276 (@code{gnus-subscribe-newsgroup-method}) to
1277 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1278 will not work. This is ga-ga. So don't do it.
1281 @node Filtering New Groups
1282 @subsection Filtering New Groups
1284 A nice and portable way to control which new newsgroups should be
1285 subscribed (or ignored) is to put an @dfn{options} line at the start of
1286 the @file{.newsrc} file. Here's an example:
1289 options -n !alt.all !rec.all sci.all
1292 @vindex gnus-subscribe-options-newsgroup-method
1293 This line obviously belongs to a serious-minded intellectual scientific
1294 person (or she may just be plain old boring), because it says that all
1295 groups that have names beginning with @samp{alt} and @samp{rec} should
1296 be ignored, and all groups with names beginning with @samp{sci} should
1297 be subscribed. Gnus will not use the normal subscription method for
1298 subscribing these groups.
1299 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1300 variable defaults to @code{gnus-subscribe-alphabetically}.
1302 The ``options -n'' format is very simplistic. The syntax above is all
1303 that is supports: you can force-subscribe hierarchies, or you can
1304 deny hierarchies, and that's it.
1306 @vindex gnus-options-not-subscribe
1307 @vindex gnus-options-subscribe
1308 If you don't want to mess with your @file{.newsrc} file, you can just
1309 set the two variables @code{gnus-options-subscribe} and
1310 @code{gnus-options-not-subscribe}. These two variables do exactly the
1311 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1312 and if the new group matches the former, it will be unconditionally
1313 subscribed, and if it matches the latter, it will be ignored.
1315 @vindex gnus-auto-subscribed-groups
1316 Yet another variable that meddles here is
1317 @code{gnus-auto-subscribed-groups}. It works exactly like
1318 @code{gnus-options-subscribe}, and is therefore really superfluous,
1319 but I thought it would be nice to have two of these. This variable is
1320 more meant for setting some ground rules, while the other variable is
1321 used more for user fiddling. By default this variable makes all new
1322 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1323 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, @code{nnimap}, and
1324 @code{nnmaildir}) subscribed. If you don't like that, just set this
1325 variable to @code{nil}.
1327 @vindex gnus-auto-subscribed-categories
1328 As if that wasn't enough, @code{gnus-auto-subscribed-categories} also
1329 allows you to specify that new groups should be subscribed based on the
1330 category their select methods belong to. The default is @samp{(mail
1331 post-mail)}, meaning that all new groups from mail-like backends
1332 should be subscribed automatically.
1334 New groups that match these variables are subscribed using
1335 @code{gnus-subscribe-options-newsgroup-method}.
1338 @node Changing Servers
1339 @section Changing Servers
1340 @cindex changing servers
1342 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1343 This happens very rarely, but perhaps you change jobs, or one server is
1344 very flaky and you want to use another.
1346 Changing the server is pretty easy, right? You just change
1347 @code{gnus-select-method} to point to the new server?
1351 Article numbers are not (in any way) kept synchronized between different
1352 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1353 you have read is by keeping track of article numbers. So when you
1354 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1357 @kindex M-x gnus-group-clear-data-on-native-groups
1358 @findex gnus-group-clear-data-on-native-groups
1359 You can use the @kbd{M-x gnus-group-clear-data-on-native-groups}
1360 command to clear out all data that you have on your native groups.
1363 @kindex M-x gnus-group-clear-data
1364 @findex gnus-group-clear-data
1365 Clear the data from the current group only---nix out marks and the
1366 list of read articles (@code{gnus-group-clear-data}).
1368 After changing servers, you @strong{must} move the cache hierarchy away,
1369 since the cached articles will have wrong article numbers, which will
1370 affect which articles Gnus thinks are read.
1371 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1372 to have it done automatically; for @code{gnus-group-clear-data}, you
1373 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1374 cache for all groups).
1378 @section Startup Files
1379 @cindex startup files
1384 Most common Unix news readers use a shared startup file called
1385 @file{.newsrc}. This file contains all the information about what
1386 groups are subscribed, and which articles in these groups have been
1389 Things got a bit more complicated with @sc{gnus}. In addition to
1390 keeping the @file{.newsrc} file updated, it also used a file called
1391 @file{.newsrc.el} for storing all the information that didn't fit into
1392 the @file{.newsrc} file. (Actually, it also duplicated everything in
1393 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1394 files was the most recently saved, which enabled people to swap between
1395 @sc{gnus} and other newsreaders.
1397 That was kinda silly, so Gnus went one better: In addition to the
1398 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1399 @file{.newsrc.eld}. It will read whichever of these files that are most
1400 recent, but it will never write a @file{.newsrc.el} file. You should
1401 never delete the @file{.newsrc.eld} file---it contains much information
1402 not stored in the @file{.newsrc} file.
1404 @vindex gnus-save-newsrc-file
1405 @vindex gnus-read-newsrc-file
1406 You can turn off writing the @file{.newsrc} file by setting
1407 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1408 the file and save some space, as well as exiting from Gnus faster.
1409 However, this will make it impossible to use other newsreaders than
1410 Gnus. But hey, who would want to, right? Similarly, setting
1411 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1412 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which can be
1413 convenient if you use a different news reader occasionally, and you
1414 want to read a different subset of the available groups with that
1417 @vindex gnus-save-killed-list
1418 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1419 will not save the list of killed groups to the startup file. This will
1420 save both time (when starting and quitting) and space (on disk). It
1421 will also mean that Gnus has no record of what groups are new or old,
1422 so the automatic new groups subscription methods become meaningless.
1423 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1424 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1425 Groups}). This variable can also be a regular expression. If that's
1426 the case, remove all groups that do not match this regexp before
1427 saving. This can be useful in certain obscure situations that involve
1428 several servers where not all servers support @code{ask-server}.
1430 @vindex gnus-startup-file
1431 @vindex gnus-backup-startup-file
1432 @vindex version-control
1433 The @code{gnus-startup-file} variable says where the startup files are.
1434 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1435 file being whatever that one is, with a @samp{.eld} appended.
1436 If you want to keep multiple numbered backups of this file, set
1437 @code{gnus-backup-startup-file}. It respects the same values as the
1438 @code{version-control} variable.
1440 @vindex gnus-save-newsrc-hook
1441 @vindex gnus-save-quick-newsrc-hook
1442 @vindex gnus-save-standard-newsrc-hook
1443 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1444 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1445 saving the @file{.newsrc.eld} file, and
1446 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1447 @file{.newsrc} file. The latter two are commonly used to turn version
1448 control on or off. Version control is on by default when saving the
1449 startup files. If you want to turn backup creation off, say something like:
1452 (defun turn-off-backup ()
1453 (set (make-local-variable 'backup-inhibited) t))
1455 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1456 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1459 @vindex gnus-init-file
1460 @vindex gnus-site-init-file
1461 When Gnus starts, it will read the @code{gnus-site-init-file}
1462 (@file{.../site-lisp/gnus-init} by default) and @code{gnus-init-file}
1463 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1464 and can be used to avoid cluttering your @file{~/.emacs} and
1465 @file{site-init} files with Gnus stuff. Gnus will also check for files
1466 with the same names as these, but with @file{.elc} and @file{.el}
1467 suffixes. In other words, if you have set @code{gnus-init-file} to
1468 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1469 and finally @file{~/.gnus} (in this order). If Emacs was invoked with
1470 the @option{-q} or @option{--no-init-file} options (@pxref{Initial
1471 Options, ,Initial Options, emacs, The Emacs Manual}), Gnus doesn't read
1472 @code{gnus-init-file}.
1477 @cindex dribble file
1480 Whenever you do something that changes the Gnus data (reading articles,
1481 catching up, killing/subscribing groups), the change is added to a
1482 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1483 Emacs way. If your Emacs should crash before you have saved the
1484 @file{.newsrc} files, all changes you have made can be recovered from
1487 If Gnus detects this file at startup, it will ask the user whether to
1488 read it. The auto save file is deleted whenever the real startup file is
1491 @vindex gnus-use-dribble-file
1492 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1493 maintain a dribble buffer. The default is @code{t}.
1495 @vindex gnus-dribble-directory
1496 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1497 this variable is @code{nil}, which it is by default, Gnus will dribble
1498 into the directory where the @file{.newsrc} file is located. (This is
1499 normally the user's home directory.) The dribble file will get the same
1500 file permissions as the @file{.newsrc} file.
1502 @vindex gnus-always-read-dribble-file
1503 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1504 read the dribble file on startup without querying the user.
1507 @node The Active File
1508 @section The Active File
1510 @cindex ignored groups
1512 When Gnus starts, or indeed whenever it tries to determine whether new
1513 articles have arrived, it reads the active file. This is a very large
1514 file that lists all the active groups and articles on the server.
1516 @vindex gnus-ignored-newsgroups
1517 Before examining the active file, Gnus deletes all lines that match the
1518 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1519 any groups with bogus names, but you can use this variable to make Gnus
1520 ignore hierarchies you aren't ever interested in. However, this is not
1521 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1522 Groups} for an overview of other variables that can be used instead.
1525 @c @code{nil} by default, and will slow down active file handling somewhat
1526 @c if you set it to anything else.
1528 @vindex gnus-read-active-file
1530 The active file can be rather Huge, so if you have a slow network, you
1531 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1532 reading the active file. This variable is @code{some} by default.
1534 Gnus will try to make do by getting information just on the groups that
1535 you actually subscribe to.
1537 Note that if you subscribe to lots and lots of groups, setting this
1538 variable to @code{nil} will probably make Gnus slower, not faster. At
1539 present, having this variable @code{nil} will slow Gnus down
1540 considerably, unless you read news over a 2400 baud modem.
1542 This variable can also have the value @code{some}. Gnus will then
1543 attempt to read active info only on the subscribed groups. On some
1544 servers this is quite fast (on sparkling, brand new INN servers that
1545 support the @code{LIST ACTIVE group} command), on others this isn't fast
1546 at all. In any case, @code{some} should be faster than @code{nil}, and
1547 is certainly faster than @code{t} over slow lines.
1549 Some news servers (old versions of Leafnode and old versions of INN, for
1550 instance) do not support the @code{LIST ACTIVE group}. For these
1551 servers, @code{nil} is probably the most efficient value for this
1554 If this variable is @code{nil}, Gnus will ask for group info in total
1555 lock-step, which isn't very fast. If it is @code{some} and you use an
1556 @acronym{NNTP} server, Gnus will pump out commands as fast as it can, and
1557 read all the replies in one swoop. This will normally result in better
1558 performance, but if the server does not support the aforementioned
1559 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1561 If you think that starting up Gnus takes too long, try all the three
1562 different values for this variable and see what works best for you.
1564 In any case, if you use @code{some} or @code{nil}, you should definitely
1565 kill all groups that you aren't interested in to speed things up.
1567 Note that this variable also affects active file retrieval from
1568 secondary select methods.
1571 @node Startup Variables
1572 @section Startup Variables
1576 @item gnus-load-hook
1577 @vindex gnus-load-hook
1578 A hook run while Gnus is being loaded. Note that this hook will
1579 normally be run just once in each Emacs session, no matter how many
1580 times you start Gnus.
1582 @item gnus-before-startup-hook
1583 @vindex gnus-before-startup-hook
1584 A hook called as the first thing when Gnus is started.
1586 @item gnus-before-resume-hook
1587 @vindex gnus-before-resume-hook
1588 A hook called as the first thing when Gnus is resumed after a suspend.
1590 @item gnus-startup-hook
1591 @vindex gnus-startup-hook
1592 A hook run as the very last thing after starting up Gnus
1594 @item gnus-started-hook
1595 @vindex gnus-started-hook
1596 A hook that is run as the very last thing after starting up Gnus
1599 @item gnus-setup-news-hook
1600 @vindex gnus-setup-news-hook
1601 A hook that is run after reading the @file{.newsrc} file(s), but before
1602 generating the group buffer.
1604 @item gnus-check-bogus-newsgroups
1605 @vindex gnus-check-bogus-newsgroups
1606 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1607 startup. A @dfn{bogus group} is a group that you have in your
1608 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1609 bogus groups can take quite a while, so to save time and resources it's
1610 best to leave this option off, and do the checking for bogus groups once
1611 in a while from the group buffer instead (@pxref{Group Maintenance}).
1613 @item gnus-inhibit-startup-message
1614 @vindex gnus-inhibit-startup-message
1615 If non-@code{nil}, the startup message won't be displayed. That way,
1616 your boss might not notice as easily that you are reading news instead
1617 of doing your job. Note that this variable is used before
1618 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1620 @item gnus-no-groups-message
1621 @vindex gnus-no-groups-message
1622 Message displayed by Gnus when no groups are available.
1624 @item gnus-use-backend-marks
1625 @vindex gnus-use-backend-marks
1626 If non-@code{nil}, Gnus will store article marks both in the
1627 @file{.newsrc.eld} file and in the backends. This will slow down
1628 group operation some.
1634 @chapter Group Buffer
1635 @cindex group buffer
1637 @c Alex Schroeder suggests to rearrange this as follows:
1639 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1640 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1641 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1642 @c 7. Group Score, 8. Group Buffer Format
1643 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1644 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1645 @c <kensanata> First, "Gnus considers groups... (default 9)."
1646 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1647 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1648 @c <kensanata> Then expand the next paragraph or add some more to it.
1649 @c This short one sentence explains levels 1 and 2, therefore I understand
1650 @c that I should keep important news at 3 and boring news at 4.
1651 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1652 @c Maybe keep those that you don't want to read temporarily at 6,
1653 @c those that you never want to read at 8, those that offend your
1654 @c human rights at 9...
1657 The @dfn{group buffer} lists all (or parts) of the available groups. It
1658 is the first buffer shown when Gnus starts, and will never be killed as
1659 long as Gnus is active.
1663 \gnusfigure{The Group Buffer}{320}{
1664 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1665 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1666 \put(120,38){\vector(1,2){10}}
1667 \put(40,60){\makebox(0,0)[r]{Mode line}}
1668 \put(40,58){\vector(1,0){30}}
1669 \put(200,28){\makebox(0,0)[t]{Native select method}}
1670 \put(200,26){\vector(-1,2){15}}
1676 * Group Buffer Format:: Information listed and how you can change it.
1677 * Group Maneuvering:: Commands for moving in the group buffer.
1678 * Selecting a Group:: Actually reading news.
1679 * Subscription Commands:: Unsubscribing, killing, subscribing.
1680 * Group Data:: Changing the info for a group.
1681 * Group Levels:: Levels? What are those, then?
1682 * Group Score:: A mechanism for finding out what groups you like.
1683 * Marking Groups:: You can mark groups for later processing.
1684 * Foreign Groups:: Creating and editing groups.
1685 * Group Parameters:: Each group may have different parameters set.
1686 * Listing Groups:: Gnus can list various subsets of the groups.
1687 * Sorting Groups:: Re-arrange the group order.
1688 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1689 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1690 * Exiting Gnus:: Stop reading news and get some work done.
1691 * Group Topics:: A folding group mode divided into topics.
1692 * Non-ASCII Group Names:: Accessing groups of non-English names.
1693 * Misc Group Stuff:: Other stuff that you can to do.
1697 @node Group Buffer Format
1698 @section Group Buffer Format
1701 * Group Line Specification:: Deciding how the group buffer is to look.
1702 * Group Mode Line Specification:: The group buffer mode line.
1703 * Group Highlighting:: Having nice colors in the group buffer.
1706 You can customize the Group Mode tool bar, see @kbd{M-x
1707 customize-apropos RET gnus-group-tool-bar}. This feature is only
1710 The tool bar icons are now (de)activated correctly depending on the
1711 cursor position. Therefore, moving around in the Group Buffer is
1712 slower. You can disable this via the variable
1713 @code{gnus-group-update-tool-bar}. Its default value depends on your
1716 @node Group Line Specification
1717 @subsection Group Line Specification
1718 @cindex group buffer format
1720 The default format of the group buffer is nice and dull, but you can
1721 make it as exciting and ugly as you feel like.
1723 Here's a couple of example group lines:
1726 25: news.announce.newusers
1727 * 0: alt.fan.andrea-dworkin
1732 You can see that there are 25 unread articles in
1733 @samp{news.announce.newusers}. There are no unread articles, but some
1734 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1735 asterisk at the beginning of the line?).
1737 @vindex gnus-group-line-format
1738 You can change that format to whatever you want by fiddling with the
1739 @code{gnus-group-line-format} variable. This variable works along the
1740 lines of a @code{format} specification, which is pretty much the same as
1741 a @code{printf} specifications, for those of you who use (feh!) C@.
1742 @xref{Formatting Variables}.
1744 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1746 There should always be a colon on the line; the cursor always moves to
1747 the colon after performing an operation. @xref{Positioning
1748 Point}. Nothing else is required---not even the group name. All
1749 displayed text is just window dressing, and is never examined by Gnus.
1750 Gnus stores all real information it needs using text properties.
1752 (Note that if you make a really strange, wonderful, spreadsheet-like
1753 layout, everybody will believe you are hard at work with the accounting
1754 instead of wasting time reading news.)
1756 Here's a list of all available format characters:
1761 An asterisk if the group only has marked articles.
1764 Whether the group is subscribed.
1767 Level of subscribedness.
1770 Number of unread articles.
1773 Number of dormant articles.
1776 Number of ticked articles.
1779 Number of read articles.
1782 Number of unseen articles.
1785 Estimated total number of articles. (This is really @var{max-number}
1786 minus @var{min-number} plus 1.)
1788 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1789 efficient access to @var{max-number} and @var{min-number} but getting
1790 the true unread message count is not possible efficiently. For
1791 hysterical raisins, even the mail back ends, where the true number of
1792 unread messages might be available efficiently, use the same limited
1793 interface. To remove this restriction from Gnus means that the back
1794 end interface has to be changed, which is not an easy job.
1796 The nnml backend (@pxref{Mail Spool}) has a feature called ``group
1797 compaction'' which circumvents this deficiency: the idea is to
1798 renumber all articles from 1, removing all gaps between numbers, hence
1799 getting a correct total count. Other backends may support this in the
1800 future. In order to keep your total article count relatively up to
1801 date, you might want to compact your groups (or even directly your
1802 server) from time to time. @xref{Misc Group Stuff}, @xref{Server Commands}.
1805 Number of unread, unticked, non-dormant articles.
1808 Number of ticked and dormant articles.
1817 Group comment (@pxref{Group Parameters}) or group name if there is no
1818 comment element in the group parameters.
1821 Newsgroup description. You need to read the group descriptions
1822 before these will appear, and to do that, you either have to set
1823 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1827 @samp{m} if moderated.
1830 @samp{(m)} if moderated.
1836 If the summary buffer for the group is open or not.
1842 A string that looks like @samp{<%s:%n>} if a foreign select method is
1846 Indentation based on the level of the topic (@pxref{Group Topics}).
1849 @vindex gnus-group-uncollapsed-levels
1850 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1851 variable says how many levels to leave at the end of the group name.
1852 The default is 1---this will mean that group names like
1853 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1856 @vindex gnus-new-mail-mark
1858 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1862 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1865 A string that says when you last read the group (@pxref{Group
1869 The disk space used by the articles fetched by both the cache and
1870 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1871 megabytes(M), or gigabytes(G) to minimize the column width. A format
1872 of %7F is sufficient for a fixed-width column.
1875 User defined specifier. The next character in the format string should
1876 be a letter. Gnus will call the function
1877 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1878 following @samp{%u}. The function will be passed a single dummy
1879 parameter as argument. The function should return a string, which will
1880 be inserted into the buffer just like information from any other
1885 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1886 if no info is available---for instance, if it is a non-activated foreign
1887 group, or a bogus native group.
1890 @node Group Mode Line Specification
1891 @subsection Group Mode Line Specification
1892 @cindex group mode line
1894 @vindex gnus-group-mode-line-format
1895 The mode line can be changed by setting
1896 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1897 doesn't understand that many format specifiers:
1901 The native news server.
1903 The native select method.
1907 @node Group Highlighting
1908 @subsection Group Highlighting
1909 @cindex highlighting
1910 @cindex group highlighting
1912 @vindex gnus-group-highlight
1913 Highlighting in the group buffer is controlled by the
1914 @code{gnus-group-highlight} variable. This is an alist with elements
1915 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1916 something non-@code{nil}, the @var{face} will be used on the line.
1918 Here's an example value for this variable that might look nice if the
1922 (cond (window-system
1923 (setq custom-background-mode 'light)
1924 (defface my-group-face-1
1925 '((t (:foreground "Red" :bold t))) "First group face")
1926 (defface my-group-face-2
1927 '((t (:foreground "DarkSeaGreen4" :bold t)))
1928 "Second group face")
1929 (defface my-group-face-3
1930 '((t (:foreground "Green4" :bold t))) "Third group face")
1931 (defface my-group-face-4
1932 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1933 (defface my-group-face-5
1934 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1936 (setq gnus-group-highlight
1937 '(((> unread 200) . my-group-face-1)
1938 ((and (< level 3) (zerop unread)) . my-group-face-2)
1939 ((< level 3) . my-group-face-3)
1940 ((zerop unread) . my-group-face-4)
1941 (t . my-group-face-5)))
1944 Also @pxref{Faces and Fonts}.
1946 Variables that are dynamically bound when the forms are evaluated
1953 The number of unread articles in the group.
1957 Whether the group is a mail group.
1959 The level of the group.
1961 The score of the group.
1963 The number of ticked articles in the group.
1965 The total number of articles in the group. Or rather,
1966 @var{max-number} minus @var{min-number} plus one.
1968 When using the topic minor mode, this variable is bound to the current
1969 topic being inserted.
1972 When the forms are @code{eval}ed, point is at the beginning of the line
1973 of the group in question, so you can use many of the normal Gnus
1974 functions for snarfing info on the group.
1976 @vindex gnus-group-update-hook
1977 @findex gnus-group-highlight-line
1978 @code{gnus-group-update-hook} is called when a group line is changed.
1979 It will not be called when @code{gnus-visual} is @code{nil}.
1982 @node Group Maneuvering
1983 @section Group Maneuvering
1984 @cindex group movement
1986 All movement commands understand the numeric prefix and will behave as
1987 expected, hopefully.
1993 @findex gnus-group-next-unread-group
1994 Go to the next group that has unread articles
1995 (@code{gnus-group-next-unread-group}).
2001 @findex gnus-group-prev-unread-group
2002 Go to the previous group that has unread articles
2003 (@code{gnus-group-prev-unread-group}).
2007 @findex gnus-group-next-group
2008 Go to the next group (@code{gnus-group-next-group}).
2012 @findex gnus-group-prev-group
2013 Go to the previous group (@code{gnus-group-prev-group}).
2017 @findex gnus-group-next-unread-group-same-level
2018 Go to the next unread group on the same (or lower) level
2019 (@code{gnus-group-next-unread-group-same-level}).
2023 @findex gnus-group-prev-unread-group-same-level
2024 Go to the previous unread group on the same (or lower) level
2025 (@code{gnus-group-prev-unread-group-same-level}).
2028 Three commands for jumping to groups:
2034 @findex gnus-group-jump-to-group
2035 Jump to a group (and make it visible if it isn't already)
2036 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2041 @findex gnus-group-best-unread-group
2042 Jump to the unread group with the lowest level
2043 (@code{gnus-group-best-unread-group}).
2047 @findex gnus-group-first-unread-group
2048 Jump to the first group with unread articles
2049 (@code{gnus-group-first-unread-group}).
2052 @vindex gnus-group-goto-unread
2053 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2054 commands will move to the next group, not the next unread group. Even
2055 the commands that say they move to the next unread group. The default
2058 @vindex gnus-summary-next-group-on-exit
2059 If @code{gnus-summary-next-group-on-exit} is @code{t}, when a summary is
2060 exited, the point in the group buffer is moved to the next unread group.
2061 Otherwise, the point is set to the group just exited. The default is
2064 @node Selecting a Group
2065 @section Selecting a Group
2066 @cindex group selection
2071 @kindex SPACE (Group)
2072 @findex gnus-group-read-group
2073 Select the current group, switch to the summary buffer and display the
2074 first unread article (@code{gnus-group-read-group}). If there are no
2075 unread articles in the group, or if you give a non-numerical prefix to
2076 this command, Gnus will offer to fetch all the old articles in this
2077 group from the server. If you give a numerical prefix @var{n}, @var{n}
2078 determines the number of articles Gnus will fetch. If @var{n} is
2079 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2080 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2082 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2083 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2084 - 4 2 SPC} fetches the 42 oldest ones.
2086 When you are in the group (in the Summary buffer), you can type
2087 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2092 @findex gnus-group-select-group
2093 Select the current group and switch to the summary buffer
2094 (@code{gnus-group-select-group}). Takes the same arguments as
2095 @code{gnus-group-read-group}---the only difference is that this command
2096 does not display the first unread article automatically upon group
2100 @kindex M-RET (Group)
2101 @findex gnus-group-quick-select-group
2102 This does the same as the command above, but tries to do it with the
2103 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2104 scoring/killing will be performed, there will be no highlights and no
2105 expunging. This might be useful if you're in a real hurry and have to
2106 enter some humongous group. If you give a 0 prefix to this command
2107 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
2108 which is useful if you want to toggle threading before generating the
2109 summary buffer (@pxref{Summary Generation Commands}).
2112 @kindex M-SPACE (Group)
2113 @findex gnus-group-visible-select-group
2114 This is yet one more command that does the same as the @kbd{RET}
2115 command, but this one does it without expunging and hiding dormants
2116 (@code{gnus-group-visible-select-group}).
2119 @kindex C-M-RET (Group)
2120 @findex gnus-group-select-group-ephemerally
2121 Finally, this command selects the current group ephemerally without
2122 doing any processing of its contents
2123 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2124 turned off. Everything you do in the group after selecting it in this
2125 manner will have no permanent effects.
2129 @vindex gnus-large-newsgroup
2130 The @code{gnus-large-newsgroup} variable says what Gnus should
2131 consider to be a big group. If it is @code{nil}, no groups are
2132 considered big. The default value is 200. If the group has more
2133 (unread and/or ticked) articles than this, Gnus will query the user
2134 before entering the group. The user can then specify how many
2135 articles should be fetched from the server. If the user specifies a
2136 negative number (@var{-n}), the @var{n} oldest articles will be
2137 fetched. If it is positive, the @var{n} articles that have arrived
2138 most recently will be fetched.
2140 @vindex gnus-large-ephemeral-newsgroup
2141 @code{gnus-large-ephemeral-newsgroup} is the same as
2142 @code{gnus-large-newsgroup}, but is only used for ephemeral
2145 @vindex gnus-newsgroup-maximum-articles
2146 In groups in some news servers, there might be a big gap between a few
2147 very old articles that will never be expired and the recent ones. In
2148 such a case, the server will return the data like @code{(1 . 30000000)}
2149 for the @code{LIST ACTIVE group} command, for example. Even if there
2150 are actually only the articles 1--10 and 29999900--30000000, Gnus doesn't
2151 know it at first and prepares for getting 30000000 articles. However,
2152 it will consume hundreds megabytes of memories and might make Emacs get
2153 stuck as the case may be. If you use such news servers, set the
2154 variable @code{gnus-newsgroup-maximum-articles} to a positive number.
2155 The value means that Gnus ignores articles other than this number of the
2156 latest ones in every group. For instance, the value 10000 makes Gnus
2157 get only the articles 29990001--30000000 (if the latest article number is
2158 30000000 in a group). Note that setting this variable to a number might
2159 prevent you from reading very old articles. The default value of the
2160 variable @code{gnus-newsgroup-maximum-articles} is @code{nil}, which
2161 means Gnus never ignores old articles.
2163 @vindex gnus-select-group-hook
2164 @vindex gnus-auto-select-first
2165 @vindex gnus-auto-select-subject
2166 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2167 automatically when entering a group with the @kbd{SPACE} command.
2168 Which article this is controlled by the
2169 @code{gnus-auto-select-subject} variable. Valid values for this
2175 Place point on the subject line of the first unread article.
2178 Place point on the subject line of the first article.
2181 Place point on the subject line of the first unseen article.
2183 @item unseen-or-unread
2184 Place point on the subject line of the first unseen article, and if
2185 there is no such article, place point on the subject line of the first
2189 Place point on the subject line of the highest-scored unread article.
2193 This variable can also be a function. In that case, that function
2194 will be called to place point on a subject line.
2196 If you want to prevent automatic selection in some group (say, in a
2197 binary group with Huge articles) you can set the
2198 @code{gnus-auto-select-first} variable to @code{nil} in
2199 @code{gnus-select-group-hook}, which is called when a group is
2203 @node Subscription Commands
2204 @section Subscription Commands
2205 @cindex subscription
2207 The following commands allow for managing your subscriptions in the
2208 Group buffer. If you want to subscribe to many groups, it's probably
2209 more convenient to go to the @ref{Server Buffer}, and choose the
2210 server there using @kbd{RET} or @kbd{SPC}. Then you'll have the
2211 commands listed in @ref{Browse Foreign Server} at hand.
2219 @findex gnus-group-unsubscribe-current-group
2220 @c @icon{gnus-group-unsubscribe}
2221 Toggle subscription to the current group
2222 (@code{gnus-group-unsubscribe-current-group}).
2228 @findex gnus-group-unsubscribe-group
2229 Prompt for a group to subscribe, and then subscribe it. If it was
2230 subscribed already, unsubscribe it instead
2231 (@code{gnus-group-unsubscribe-group}).
2237 @findex gnus-group-kill-group
2238 @c @icon{gnus-group-kill-group}
2239 Kill the current group (@code{gnus-group-kill-group}).
2245 @findex gnus-group-yank-group
2246 Yank the last killed group (@code{gnus-group-yank-group}).
2249 @kindex C-x C-t (Group)
2250 @findex gnus-group-transpose-groups
2251 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2252 really a subscription command, but you can use it instead of a
2253 kill-and-yank sequence sometimes.
2259 @findex gnus-group-kill-region
2260 Kill all groups in the region (@code{gnus-group-kill-region}).
2264 @findex gnus-group-kill-all-zombies
2265 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2268 @kindex S C-k (Group)
2269 @findex gnus-group-kill-level
2270 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2271 These groups can't be yanked back after killing, so this command should
2272 be used with some caution. The only time where this command comes in
2273 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2274 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2275 kill off all unsubscribed groups that do not have message numbers in the
2276 @file{.newsrc} file.
2280 Also @pxref{Group Levels}.
2290 @findex gnus-group-catchup-current
2291 @vindex gnus-group-catchup-group-hook
2292 @c @icon{gnus-group-catchup-current}
2293 Mark all unticked articles in this group as read
2294 (@code{gnus-group-catchup-current}).
2295 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2300 @findex gnus-group-catchup-current-all
2301 Mark all articles in this group, even the ticked ones, as read
2302 (@code{gnus-group-catchup-current-all}).
2306 @findex gnus-group-clear-data
2307 Clear the data from the current group---nix out marks and the list of
2308 read articles (@code{gnus-group-clear-data}).
2310 @item M-x gnus-group-clear-data-on-native-groups
2311 @kindex M-x gnus-group-clear-data-on-native-groups
2312 @findex gnus-group-clear-data-on-native-groups
2313 If you have switched from one @acronym{NNTP} server to another, all your marks
2314 and read ranges have become worthless. You can use this command to
2315 clear out all data that you have on your native groups. Use with
2322 @section Group Levels
2326 All groups have a level of @dfn{subscribedness}. For instance, if a
2327 group is on level 2, it is more subscribed than a group on level 5. You
2328 can ask Gnus to just list groups on a given level or lower
2329 (@pxref{Listing Groups}), or to just check for new articles in groups on
2330 a given level or lower (@pxref{Scanning New Messages}).
2332 Remember: The higher the level of the group, the less important it is.
2338 @findex gnus-group-set-current-level
2339 Set the level of the current group. If a numeric prefix is given, the
2340 next @var{n} groups will have their levels set. The user will be
2341 prompted for a level.
2344 @vindex gnus-level-killed
2345 @vindex gnus-level-zombie
2346 @vindex gnus-level-unsubscribed
2347 @vindex gnus-level-subscribed
2348 Gnus considers groups from levels 1 to
2349 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2350 @code{gnus-level-subscribed} (exclusive) and
2351 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2352 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2353 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2354 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2355 same, but zombie and killed groups store no information on what articles
2356 you have read, etc. This distinction between dead and living
2357 groups isn't done because it is nice or clever, it is done purely for
2358 reasons of efficiency.
2360 It is recommended that you keep all your mail groups (if any) on quite
2361 low levels (e.g., 1 or 2).
2363 Maybe the following description of the default behavior of Gnus helps to
2364 understand what these levels are all about. By default, Gnus shows you
2365 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2366 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2367 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2368 groups are hidden, in a way.
2370 @cindex zombie groups
2371 Zombie and killed groups are similar to unsubscribed groups in that they
2372 are hidden by default. But they are different from subscribed and
2373 unsubscribed groups in that Gnus doesn't ask the news server for
2374 information (number of messages, number of unread messages) on zombie
2375 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2376 aren't interested in. If most groups are killed, Gnus is faster.
2378 Why does Gnus distinguish between zombie and killed groups? Well, when
2379 a new group arrives on the server, Gnus by default makes it a zombie
2380 group. This means that you are normally not bothered with new groups,
2381 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2382 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2383 list of killed groups.)
2385 If you want to play with the level variables, you should show some care.
2386 Set them once, and don't touch them ever again. Better yet, don't touch
2387 them at all unless you know exactly what you're doing.
2389 @vindex gnus-level-default-unsubscribed
2390 @vindex gnus-level-default-subscribed
2391 Two closely related variables are @code{gnus-level-default-subscribed}
2392 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2393 which are the levels that new groups will be put on if they are
2394 (un)subscribed. These two variables should, of course, be inside the
2395 relevant valid ranges.
2397 @vindex gnus-keep-same-level
2398 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2399 will only move to groups of the same level (or lower). In
2400 particular, going from the last article in one group to the next group
2401 will go to the next group of the same level (or lower). This might be
2402 handy if you want to read the most important groups before you read the
2405 If this variable is @code{best}, Gnus will make the next newsgroup the
2406 one with the best level.
2408 @vindex gnus-group-default-list-level
2409 All groups with a level less than or equal to
2410 @code{gnus-group-default-list-level} will be listed in the group buffer
2412 This variable can also be a function. In that case, that function will
2413 be called and the result will be used as value.
2416 @vindex gnus-group-list-inactive-groups
2417 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2418 groups will be listed along with the unread groups. This variable is
2419 @code{t} by default. If it is @code{nil}, inactive groups won't be
2422 @vindex gnus-group-use-permanent-levels
2423 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2424 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2425 use this level as the ``work'' level.
2427 @vindex gnus-activate-level
2428 Gnus will normally just activate (i.e., query the server about) groups
2429 on level @code{gnus-activate-level} or less. If you don't want to
2430 activate unsubscribed groups, for instance, you might set this variable
2431 to 5. The default is 6.
2435 @section Group Score
2440 You would normally keep important groups on high levels, but that scheme
2441 is somewhat restrictive. Don't you wish you could have Gnus sort the
2442 group buffer according to how often you read groups, perhaps? Within
2445 This is what @dfn{group score} is for. You can have Gnus assign a score
2446 to each group through the mechanism described below. You can then sort
2447 the group buffer based on this score. Alternatively, you can sort on
2448 score and then level. (Taken together, the level and the score is
2449 called the @dfn{rank} of the group. A group that is on level 4 and has
2450 a score of 1 has a higher rank than a group on level 5 that has a score
2451 of 300. (The level is the most significant part and the score is the
2452 least significant part.))
2454 @findex gnus-summary-bubble-group
2455 If you want groups you read often to get higher scores than groups you
2456 read seldom you can add the @code{gnus-summary-bubble-group} function to
2457 the @code{gnus-summary-exit-hook} hook. This will result (after
2458 sorting) in a bubbling sort of action. If you want to see that in
2459 action after each summary exit, you can add
2460 @code{gnus-group-sort-groups-by-rank} or
2461 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2462 slow things down somewhat.
2465 @node Marking Groups
2466 @section Marking Groups
2467 @cindex marking groups
2469 If you want to perform some command on several groups, and they appear
2470 subsequently in the group buffer, you would normally just give a
2471 numerical prefix to the command. Most group commands will then do your
2472 bidding on those groups.
2474 However, if the groups are not in sequential order, you can still
2475 perform a command on several groups. You simply mark the groups first
2476 with the process mark and then execute the command.
2484 @findex gnus-group-mark-group
2485 Set the mark on the current group (@code{gnus-group-mark-group}).
2491 @findex gnus-group-unmark-group
2492 Remove the mark from the current group
2493 (@code{gnus-group-unmark-group}).
2497 @findex gnus-group-unmark-all-groups
2498 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2502 @findex gnus-group-mark-region
2503 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2507 @findex gnus-group-mark-buffer
2508 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2512 @findex gnus-group-mark-regexp
2513 Mark all groups that match some regular expression
2514 (@code{gnus-group-mark-regexp}).
2517 Also @pxref{Process/Prefix}.
2519 @findex gnus-group-universal-argument
2520 If you want to execute some command on all groups that have been marked
2521 with the process mark, you can use the @kbd{M-&}
2522 (@code{gnus-group-universal-argument}) command. It will prompt you for
2523 the command to be executed.
2526 @node Foreign Groups
2527 @section Foreign Groups
2528 @cindex foreign groups
2530 If you recall how to subscribe to servers (@pxref{Finding the News})
2531 you will remember that @code{gnus-secondary-select-methods} and
2532 @code{gnus-select-method} let you write a definition in Emacs Lisp of
2533 what servers you want to see when you start up. The alternate
2534 approach is to use foreign servers and groups. ``Foreign'' here means
2535 they are not coming from the select methods. All foreign server
2536 configuration and subscriptions are stored only in the
2537 @file{~/.newsrc.eld} file.
2539 Below are some group mode commands for making and editing general foreign
2540 groups, as well as commands to ease the creation of a few
2541 special-purpose groups. All these commands insert the newly created
2542 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2545 Changes from the group editing commands are stored in
2546 @file{~/.newsrc.eld} (@code{gnus-startup-file}). An alternative is the
2547 variable @code{gnus-parameters}, @xref{Group Parameters}.
2553 @findex gnus-group-make-group
2554 @cindex making groups
2555 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2556 for a name, a method and possibly an @dfn{address}. For an easier way
2557 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2561 @findex gnus-group-read-ephemeral-group
2562 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2563 will prompt you for a name, a method and an @dfn{address}.
2567 @findex gnus-group-rename-group
2568 @cindex renaming groups
2569 Rename the current group to something else
2570 (@code{gnus-group-rename-group}). This is valid only on some
2571 groups---mail groups mostly. This command might very well be quite slow
2577 @findex gnus-group-customize
2578 Customize the group parameters (@code{gnus-group-customize}).
2582 @findex gnus-group-edit-group-method
2583 @cindex renaming groups
2584 Enter a buffer where you can edit the select method of the current
2585 group (@code{gnus-group-edit-group-method}).
2589 @findex gnus-group-edit-group-parameters
2590 Enter a buffer where you can edit the group parameters
2591 (@code{gnus-group-edit-group-parameters}).
2595 @findex gnus-group-edit-group
2596 Enter a buffer where you can edit the group info
2597 (@code{gnus-group-edit-group}).
2601 @findex gnus-group-make-directory-group
2603 Make a directory group (@pxref{Directory Groups}). You will be prompted
2604 for a directory name (@code{gnus-group-make-directory-group}).
2609 @findex gnus-group-make-help-group
2610 Make the Gnus help group (@code{gnus-group-make-help-group}).
2614 @findex gnus-group-enter-directory
2616 Read an arbitrary directory as if it were a newsgroup with the
2617 @code{nneething} back end (@code{gnus-group-enter-directory}).
2618 @xref{Anything Groups}.
2622 @findex gnus-group-make-doc-group
2623 @cindex ClariNet Briefs
2625 Make a group based on some file or other
2626 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2627 command, you will be prompted for a file name and a file type.
2628 Currently supported types are @code{mbox}, @code{babyl},
2629 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2630 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2631 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2632 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2633 you run this command without a prefix, Gnus will guess at the file
2634 type. @xref{Document Groups}.
2638 @vindex gnus-useful-groups
2639 @findex gnus-group-make-useful-group
2640 Create one of the groups mentioned in @code{gnus-useful-groups}
2641 (@code{gnus-group-make-useful-group}).
2645 @findex gnus-group-make-web-group
2649 Make an ephemeral group based on a web search
2650 (@code{gnus-group-make-web-group}). If you give a prefix to this
2651 command, make a solid group instead. You will be prompted for the
2652 search engine type and the search string. Valid search engine types
2653 include @code{google}, @code{dejanews}, and @code{gmane}.
2654 @xref{Web Searches}.
2656 If you use the @code{google} search engine, you can limit the search
2657 to a particular group by using a match string like
2658 @samp{shaving group:alt.sysadmin.recovery}.
2662 @findex gnus-group-make-rss-group
2663 Make a group based on an @acronym{RSS} feed
2664 (@code{gnus-group-make-rss-group}). You will be prompted for an URL@.
2668 @kindex G DEL (Group)
2669 @findex gnus-group-delete-group
2670 This function will delete the current group
2671 (@code{gnus-group-delete-group}). If given a prefix, this function will
2672 actually delete all the articles in the group, and forcibly remove the
2673 group itself from the face of the Earth. Use a prefix only if you are
2674 absolutely sure of what you are doing. This command can't be used on
2675 read-only groups (like @code{nntp} groups), though.
2679 @findex gnus-group-make-empty-virtual
2680 Make a new, fresh, empty @code{nnvirtual} group
2681 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2685 @findex gnus-group-add-to-virtual
2686 Add the current group to an @code{nnvirtual} group
2687 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2690 @xref{Select Methods}, for more information on the various select
2693 @vindex gnus-activate-foreign-newsgroups
2694 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2695 Gnus will check all foreign groups with this level or lower at startup.
2696 This might take quite a while, especially if you subscribe to lots of
2697 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2698 @code{gnus-activate-level} also affects activation of foreign
2702 The following commands create ephemeral groups. They can be called not
2703 only from the Group buffer, but in any Gnus buffer.
2706 @item gnus-read-ephemeral-gmane-group
2707 @findex gnus-read-ephemeral-gmane-group
2708 @vindex gnus-gmane-group-download-format
2709 Read an ephemeral group on Gmane.org. The articles are downloaded via
2710 HTTP using the URL specified by @code{gnus-gmane-group-download-format}.
2711 Gnus will prompt you for a group name, the start article number and an
2714 @item gnus-read-ephemeral-gmane-group-url
2715 @findex gnus-read-ephemeral-gmane-group-url
2716 This command is similar to @code{gnus-read-ephemeral-gmane-group}, but
2717 the group name and the article number and range are constructed from a
2718 given @acronym{URL}. Supported @acronym{URL} formats include:
2719 @indicateurl{http://thread.gmane.org/gmane.foo.bar/12300/focus=12399},
2720 @indicateurl{http://thread.gmane.org/gmane.foo.bar/12345/},
2721 @indicateurl{http://article.gmane.org/gmane.foo.bar/12345/},
2722 @indicateurl{http://permalink.gmane.org/gmane.foo.bar/12345/}, and
2723 @indicateurl{http://news.gmane.org/group/gmane.foo.bar/thread=12345}.
2725 @item gnus-read-ephemeral-emacs-bug-group
2726 @findex gnus-read-ephemeral-emacs-bug-group
2727 Read an Emacs bug report in an ephemeral group. Gnus will prompt for a
2728 bug number. The default is the number at point. The @acronym{URL} is
2729 specified in @code{gnus-bug-group-download-format-alist}.
2731 @item gnus-read-ephemeral-debian-bug-group
2732 @findex gnus-read-ephemeral-debian-bug-group
2733 Read a Debian bug report in an ephemeral group. Analog to
2734 @code{gnus-read-ephemeral-emacs-bug-group}.
2737 Some of these command are also useful for article buttons, @xref{Article
2745 '("#\\([0-9]+\\)\\>" 1
2746 (string-match "\\<emacs\\>" (or gnus-newsgroup-name ""))
2747 gnus-read-ephemeral-emacs-bug-group 1))
2751 @node Group Parameters
2752 @section Group Parameters
2753 @cindex group parameters
2755 The group parameters store information local to a particular group.
2757 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2758 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2759 presents you with a Customize-like interface. The latter helps avoid
2760 silly Lisp errors.) You might also be interested in reading about topic
2761 parameters (@pxref{Topic Parameters}).
2762 Additionally, you can set group parameters via the
2763 @code{gnus-parameters} variable, see below.
2765 Here's an example group parameter list:
2768 ((to-address . "ding@@gnus.org")
2772 We see that each element consists of a ``dotted pair''---the thing before
2773 the dot is the key, while the thing after the dot is the value. All the
2774 parameters have this form @emph{except} local variable specs, which are
2775 not dotted pairs, but proper lists.
2777 Some parameters have correspondent customizable variables, each of which
2778 is an alist of regexps and values.
2780 The following group parameters can be used:
2785 Address used by when doing followups and new posts.
2788 (to-address . "some@@where.com")
2791 This is primarily useful in mail groups that represent closed mailing
2792 lists---mailing lists where it's expected that everybody that writes to
2793 the mailing list is subscribed to it. Since using this parameter
2794 ensures that the mail only goes to the mailing list itself, it means
2795 that members won't receive two copies of your followups.
2797 Using @code{to-address} will actually work whether the group is foreign
2798 or not. Let's say there's a group on the server that is called
2799 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2800 the articles from a mail-to-news gateway. Posting directly to this
2801 group is therefore impossible---you have to send mail to the mailing
2802 list address instead.
2804 See also @code{gnus-parameter-to-address-alist}.
2808 Address used when doing @kbd{a} in that group.
2811 (to-list . "some@@where.com")
2814 It is totally ignored
2815 when doing a followup---except that if it is present in a news group,
2816 you'll get mail group semantics when doing @kbd{f}.
2818 If you do an @kbd{a} command in a mail group and you have neither a
2819 @code{to-list} group parameter nor a @code{to-address} group parameter,
2820 then a @code{to-list} group parameter will be added automatically upon
2821 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2822 @vindex gnus-add-to-list
2824 @findex gnus-mailing-list-mode
2825 @cindex mail list groups
2826 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2827 entering summary buffer.
2829 See also @code{gnus-parameter-to-list-alist}.
2834 @cindex Mail-Followup-To
2835 @findex gnus-find-subscribed-addresses
2836 If this parameter is set to @code{t}, Gnus will consider the
2837 to-address and to-list parameters for this group as addresses of
2838 mailing lists you are subscribed to. Giving Gnus this information is
2839 (only) a first step in getting it to generate correct Mail-Followup-To
2840 headers for your posts to these lists. The second step is to put the
2841 following in your @file{.gnus.el}
2844 (setq message-subscribed-address-functions
2845 '(gnus-find-subscribed-addresses))
2848 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2849 a complete treatment of available MFT support.
2853 If the group parameter list has the element @code{(visible . t)},
2854 that group will always be visible in the Group buffer, regardless
2855 of whether it has any unread articles.
2857 This parameter cannot be set via @code{gnus-parameters}. See
2858 @code{gnus-permanently-visible-groups} as an alternative.
2860 @item broken-reply-to
2861 @cindex broken-reply-to
2862 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2863 headers in this group are to be ignored, and for the header to be hidden
2864 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2865 can be useful if you're reading a mailing list group where the listserv
2866 has inserted @code{Reply-To} headers that point back to the listserv
2867 itself. That is broken behavior. So there!
2871 Elements like @code{(to-group . "some.group.name")} means that all
2872 posts in that group will be sent to @code{some.group.name}.
2876 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2877 will treat all responses as if they were responses to news articles.
2878 This can be useful if you have a mail group that's really a mirror of a
2883 If @code{(gcc-self . t)} is present in the group parameter list, newly
2884 composed messages will be @code{Gcc}'d to the current group. If
2885 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2886 generated, if @code{(gcc-self . "string")} is present, this string will
2887 be inserted literally as a @code{gcc} header. This parameter takes
2888 precedence over any default @code{Gcc} rules as described later
2889 (@pxref{Archived Messages}), with the exception for messages to resend.
2891 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2892 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2893 doesn't accept articles.
2897 @cindex expiring mail
2898 If the group parameter has an element that looks like @code{(auto-expire
2899 . t)}, all articles read will be marked as expirable. For an
2900 alternative approach, @pxref{Expiring Mail}.
2902 See also @code{gnus-auto-expirable-newsgroups}.
2905 @cindex total-expire
2906 @cindex expiring mail
2907 If the group parameter has an element that looks like
2908 @code{(total-expire . t)}, all read articles will be put through the
2909 expiry process, even if they are not marked as expirable. Use with
2910 caution. Unread, ticked and dormant articles are not eligible for
2913 See also @code{gnus-total-expirable-newsgroups}.
2917 @vindex nnmail-expiry-wait-function
2918 If the group parameter has an element that looks like
2919 @code{(expiry-wait . 10)}, this value will override any
2920 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2921 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2922 can either be a number of days (not necessarily an integer) or the
2923 symbols @code{never} or @code{immediate}.
2926 @cindex expiry-target
2927 Where expired messages end up. This parameter overrides
2928 @code{nnmail-expiry-target}.
2931 @cindex score file group parameter
2932 Elements that look like @code{(score-file . "file")} will make
2933 @file{file} into the current score file for the group in question. All
2934 interactive score entries will be put into this file.
2937 @cindex adapt file group parameter
2938 Elements that look like @code{(adapt-file . "file")} will make
2939 @file{file} into the current adaptive file for the group in question.
2940 All adaptive score entries will be put into this file.
2943 @cindex admin-address
2944 When unsubscribing from a mailing list you should never send the
2945 unsubscription notice to the mailing list itself. Instead, you'd send
2946 messages to the administrative address. This parameter allows you to
2947 put the admin address somewhere convenient.
2951 Elements that look like @code{(display . MODE)} say which articles to
2952 display on entering the group. Valid values are:
2956 Display all articles, both read and unread.
2959 Display the last @var{integer} articles in the group. This is the same as
2960 entering the group with @kbd{C-u @var{integer}}.
2963 Display the default visible articles, which normally includes unread and
2967 Display articles that satisfy a predicate.
2969 Here are some examples:
2973 Display only unread articles.
2976 Display everything except expirable articles.
2978 @item [and (not reply) (not expire)]
2979 Display everything except expirable and articles you've already
2983 The available operators are @code{not}, @code{and} and @code{or}.
2984 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2985 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2986 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2987 @code{cache}, @code{forward}, and @code{unseen}.
2991 The @code{display} parameter works by limiting the summary buffer to
2992 the subset specified. You can pop the limit by using the @kbd{/ w}
2993 command (@pxref{Limiting}).
2997 Elements that look like @code{(comment . "This is a comment")} are
2998 arbitrary comments on the group. You can display comments in the
2999 group line (@pxref{Group Line Specification}).
3003 Elements that look like @code{(charset . iso-8859-1)} will make
3004 @code{iso-8859-1} the default charset; that is, the charset that will be
3005 used for all articles that do not specify a charset.
3007 See also @code{gnus-group-charset-alist}.
3009 @item ignored-charsets
3010 @cindex ignored-charset
3011 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
3012 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
3013 default charset will be used for decoding articles.
3015 See also @code{gnus-group-ignored-charsets-alist}.
3018 @cindex posting-style
3019 You can store additional posting style information for this group
3020 here (@pxref{Posting Styles}). The format is that of an entry in the
3021 @code{gnus-posting-styles} alist, except that there's no regexp matching
3022 the group name (of course). Style elements in this group parameter will
3023 take precedence over the ones found in @code{gnus-posting-styles}.
3025 For instance, if you want a funky name and signature in this group only,
3026 instead of hacking @code{gnus-posting-styles}, you could put something
3027 like this in the group parameters:
3032 ("X-Message-SMTP-Method" "smtp smtp.example.org 587")
3033 ("X-My-Header" "Funky Value")
3034 (signature "Funky Signature"))
3037 If you're using topics to organize your group buffer
3038 (@pxref{Group Topics}), note that posting styles can also be set in
3039 the topics parameters. Posting styles in topic parameters apply to all
3040 groups in this topic. More precisely, the posting-style settings for a
3041 group result from the hierarchical merging of all posting-style
3042 entries in the parameters of this group and all the topics it belongs
3048 If it is set, the value is used as the method for posting message
3049 instead of @code{gnus-post-method}.
3053 If it is set, and the setting of @code{mail-sources} includes a
3054 @code{group} mail source (@pxref{Mail Sources}), the value is a
3055 mail source for this group.
3059 An item like @code{(banner . @var{regexp})} causes any part of an article
3060 that matches the regular expression @var{regexp} to be stripped. Instead of
3061 @var{regexp}, you can also use the symbol @code{signature} which strips the
3062 last signature or any of the elements of the alist
3063 @code{gnus-article-banner-alist}.
3067 This parameter contains a Sieve test that should match incoming mail
3068 that should be placed in this group. From this group parameter, a
3069 Sieve @samp{IF} control structure is generated, having the test as the
3070 condition and @samp{fileinto "group.name";} as the body.
3072 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
3073 address "sender" "sieve-admin@@extundo.com")} group parameter, when
3074 translating the group parameter into a Sieve script (@pxref{Sieve
3075 Commands}) the following Sieve code is generated:
3078 if address "sender" "sieve-admin@@extundo.com" @{
3079 fileinto "INBOX.list.sieve";
3083 To generate tests for multiple email-addresses use a group parameter
3084 like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}.
3085 When generating a sieve script (@pxref{Sieve Commands}) Sieve code
3086 like the following is generated:
3089 if address "sender" ["name@@one.org", "else@@two.org"] @{
3090 fileinto "INBOX.list.sieve";
3094 You can also use regexp expansions in the rules:
3097 (sieve header :regex "list-id" "<c++std-\\1.accu.org>")
3100 See @pxref{Sieve Commands} for commands and variables that might be of
3101 interest in relation to the sieve parameter.
3103 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3104 Top, sieve, Emacs Sieve}.
3106 @item (agent parameters)
3107 If the agent has been enabled, you can set any of its parameters to
3108 control the behavior of the agent in individual groups. See Agent
3109 Parameters in @ref{Category Syntax}. Most users will choose to set
3110 agent parameters in either an agent category or group topic to
3111 minimize the configuration effort.
3113 @item (@var{variable} @var{form})
3114 You can use the group parameters to set variables local to the group you
3115 are entering. If you want to turn threading off in @samp{news.answers},
3116 you could put @code{(gnus-show-threads nil)} in the group parameters of
3117 that group. @code{gnus-show-threads} will be made into a local variable
3118 in the summary buffer you enter, and the form @code{nil} will be
3119 @code{eval}ed there.
3121 Note that this feature sets the variable locally to the summary buffer
3122 if and only if @var{variable} has been bound as a variable. Otherwise,
3123 only evaluating the form will take place. So, you may want to bind the
3124 variable in advance using @code{defvar} or other if the result of the
3125 form needs to be set to it.
3127 But some variables are evaluated in the article buffer, or in the
3128 message buffer (of a reply or followup or otherwise newly created
3129 message). As a workaround, it might help to add the variable in
3130 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3131 Stuff}. So if you want to set @code{message-from-style} via the group
3132 parameters, then you may need the following statement elsewhere in your
3133 @file{~/.gnus.el} file:
3136 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3139 @vindex gnus-list-identifiers
3140 A use for this feature is to remove a mailing list identifier tag in
3141 the subject fields of articles. E.g., if the news group
3144 nntp+news.gnus.org:gmane.text.docbook.apps
3147 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3148 tag can be removed from the article subjects in the summary buffer for
3149 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3150 into the group parameters for the group.
3152 This can also be used as a group-specific hook function. If you want to
3153 hear a beep when you enter a group, you could put something like
3154 @code{(dummy-variable (ding))} in the parameters of that group. If
3155 @code{dummy-variable} has been bound (see above), it will be set to the
3156 (meaningless) result of the @code{(ding)} form.
3158 Alternatively, since the VARIABLE becomes local to the group, this
3159 pattern can be used to temporarily change a hook. For example, if the
3160 following is added to a group parameter
3163 (gnus-summary-prepared-hook
3164 (lambda nil (local-set-key "d" (local-key-binding "n"))))
3167 when the group is entered, the 'd' key will not mark the article as
3172 @vindex gnus-parameters
3173 Group parameters can be set via the @code{gnus-parameters} variable too.
3174 But some variables, such as @code{visible}, have no effect (For this
3175 case see @code{gnus-permanently-visible-groups} as an alternative.).
3179 (setq gnus-parameters
3181 (gnus-show-threads nil)
3182 (gnus-use-scoring nil)
3183 (gnus-summary-line-format
3184 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3188 ("^nnimap:\\(foo.bar\\)$"
3192 (gnus-use-scoring t))
3196 (broken-reply-to . t))))
3199 All clauses that matches the group name will be used, but the last
3200 setting ``wins''. So if you have two clauses that both match the
3201 group name, and both set, say @code{display}, the last setting will
3204 Parameters that are strings will be subjected to regexp substitution,
3205 as the @code{to-group} example shows.
3207 @vindex gnus-parameters-case-fold-search
3208 By default, whether comparing the group name and one of those regexps
3209 specified in @code{gnus-parameters} is done in a case-sensitive manner
3210 or a case-insensitive manner depends on the value of
3211 @code{case-fold-search} at the time when the comparison is done. The
3212 value of @code{case-fold-search} is typically @code{t}; it means, for
3213 example, the element @code{("INBOX\\.FOO" (total-expire . t))} might be
3214 applied to both the @samp{INBOX.FOO} group and the @samp{INBOX.foo}
3215 group. If you want to make those regexps always case-sensitive, set the
3216 value of the @code{gnus-parameters-case-fold-search} variable to
3217 @code{nil}. Otherwise, set it to @code{t} if you want to compare them
3218 always in a case-insensitive manner.
3220 You can define different sorting to different groups via
3221 @code{gnus-parameters}. Here is an example to sort an @acronym{NNTP}
3222 group by reverse date to see the latest news at the top and an
3223 @acronym{RSS} group by subject. In this example, the first group is the
3224 Debian daily news group @code{gmane.linux.debian.user.news} from
3225 news.gmane.org. The @acronym{RSS} group corresponds to the Debian
3226 weekly news RSS feed
3227 @url{http://packages.debian.org/unstable/newpkg_main.en.rdf},
3233 '(("nntp.*gmane\\.debian\\.user\\.news"
3234 (gnus-show-threads nil)
3235 (gnus-article-sort-functions '((not gnus-article-sort-by-date)))
3236 (gnus-use-adaptive-scoring nil)
3237 (gnus-use-scoring nil))
3239 (gnus-show-threads nil)
3240 (gnus-article-sort-functions 'gnus-article-sort-by-subject)
3241 (gnus-use-adaptive-scoring nil)
3242 (gnus-use-scoring t)
3243 (gnus-score-find-score-files-function 'gnus-score-find-single)
3244 (gnus-summary-line-format "%U%R%z%d %I%(%[ %s %]%)\n"))))
3248 @node Listing Groups
3249 @section Listing Groups
3250 @cindex group listing
3252 These commands all list various slices of the groups available.
3260 @findex gnus-group-list-groups
3261 List all groups that have unread articles
3262 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3263 command will list only groups of level ARG and lower. By default, it
3264 only lists groups of level five (i.e.,
3265 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3272 @findex gnus-group-list-all-groups
3273 List all groups, whether they have unread articles or not
3274 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3275 this command will list only groups of level ARG and lower. By default,
3276 it lists groups of level seven or lower (i.e., just subscribed and
3277 unsubscribed groups).
3281 @findex gnus-group-list-level
3282 List all unread groups on a specific level
3283 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3284 with no unread articles.
3288 @findex gnus-group-list-killed
3289 List all killed groups (@code{gnus-group-list-killed}). If given a
3290 prefix argument, really list all groups that are available, but aren't
3291 currently (un)subscribed. This could entail reading the active file
3296 @findex gnus-group-list-zombies
3297 List all zombie groups (@code{gnus-group-list-zombies}).
3301 @findex gnus-group-list-matching
3302 List all unread, subscribed groups with names that match a regexp
3303 (@code{gnus-group-list-matching}).
3307 @findex gnus-group-list-all-matching
3308 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3312 @findex gnus-group-list-active
3313 List absolutely all groups in the active file(s) of the
3314 server(s) you are connected to (@code{gnus-group-list-active}). This
3315 might very well take quite a while. It might actually be a better idea
3316 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3317 thing to match on. Also note that this command may list groups that
3318 don't exist (yet)---these will be listed as if they were killed groups.
3319 Take the output with some grains of salt.
3323 @findex gnus-group-apropos
3324 List all groups that have names that match a regexp
3325 (@code{gnus-group-apropos}).
3329 @findex gnus-group-description-apropos
3330 List all groups that have names or descriptions that match a regexp
3331 (@code{gnus-group-description-apropos}).
3335 @findex gnus-group-list-cached
3336 List all groups with cached articles (@code{gnus-group-list-cached}).
3340 @findex gnus-group-list-dormant
3341 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3345 @findex gnus-group-list-ticked
3346 List all groups with ticked articles (@code{gnus-group-list-ticked}).
3350 @findex gnus-group-list-limit
3351 Further limit groups within the current selection
3352 (@code{gnus-group-list-limit}). If you've first limited to groups
3353 with dormant articles with @kbd{A ?}, you can then further limit with
3354 @kbd{A / c}, which will then limit to groups with cached articles,
3355 giving you the groups that have both dormant articles and cached
3360 @findex gnus-group-list-flush
3361 Flush groups from the current selection (@code{gnus-group-list-flush}).
3365 @findex gnus-group-list-plus
3366 List groups plus the current selection (@code{gnus-group-list-plus}).
3370 @vindex gnus-permanently-visible-groups
3371 @cindex visible group parameter
3372 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3373 always be shown, whether they have unread articles or not. You can also
3374 add the @code{visible} element to the group parameters in question to
3375 get the same effect.
3377 @vindex gnus-list-groups-with-ticked-articles
3378 Groups that have just ticked articles in it are normally listed in the
3379 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3380 @code{nil}, these groups will be treated just like totally empty
3381 groups. It is @code{t} by default.
3384 @node Sorting Groups
3385 @section Sorting Groups
3386 @cindex sorting groups
3388 @kindex C-c C-s (Group)
3389 @findex gnus-group-sort-groups
3390 @vindex gnus-group-sort-function
3391 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3392 group buffer according to the function(s) given by the
3393 @code{gnus-group-sort-function} variable. Available sorting functions
3398 @item gnus-group-sort-by-alphabet
3399 @findex gnus-group-sort-by-alphabet
3400 Sort the group names alphabetically. This is the default.
3402 @item gnus-group-sort-by-real-name
3403 @findex gnus-group-sort-by-real-name
3404 Sort the group alphabetically on the real (unprefixed) group names.
3406 @item gnus-group-sort-by-level
3407 @findex gnus-group-sort-by-level
3408 Sort by group level.
3410 @item gnus-group-sort-by-score
3411 @findex gnus-group-sort-by-score
3412 Sort by group score. @xref{Group Score}.
3414 @item gnus-group-sort-by-rank
3415 @findex gnus-group-sort-by-rank
3416 Sort by group score and then the group level. The level and the score
3417 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3419 @item gnus-group-sort-by-unread
3420 @findex gnus-group-sort-by-unread
3421 Sort by number of unread articles.
3423 @item gnus-group-sort-by-method
3424 @findex gnus-group-sort-by-method
3425 Sort alphabetically on the select method.
3427 @item gnus-group-sort-by-server
3428 @findex gnus-group-sort-by-server
3429 Sort alphabetically on the Gnus server name.
3434 @code{gnus-group-sort-function} can also be a list of sorting
3435 functions. In that case, the most significant sort key function must be
3439 There are also a number of commands for sorting directly according to
3440 some sorting criteria:
3444 @kindex G S a (Group)
3445 @findex gnus-group-sort-groups-by-alphabet
3446 Sort the group buffer alphabetically by group name
3447 (@code{gnus-group-sort-groups-by-alphabet}).
3450 @kindex G S u (Group)
3451 @findex gnus-group-sort-groups-by-unread
3452 Sort the group buffer by the number of unread articles
3453 (@code{gnus-group-sort-groups-by-unread}).
3456 @kindex G S l (Group)
3457 @findex gnus-group-sort-groups-by-level
3458 Sort the group buffer by group level
3459 (@code{gnus-group-sort-groups-by-level}).
3462 @kindex G S v (Group)
3463 @findex gnus-group-sort-groups-by-score
3464 Sort the group buffer by group score
3465 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3468 @kindex G S r (Group)
3469 @findex gnus-group-sort-groups-by-rank
3470 Sort the group buffer by group rank
3471 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3474 @kindex G S m (Group)
3475 @findex gnus-group-sort-groups-by-method
3476 Sort the group buffer alphabetically by back end name@*
3477 (@code{gnus-group-sort-groups-by-method}).
3480 @kindex G S n (Group)
3481 @findex gnus-group-sort-groups-by-real-name
3482 Sort the group buffer alphabetically by real (unprefixed) group name
3483 (@code{gnus-group-sort-groups-by-real-name}).
3487 All the commands below obey the process/prefix convention
3488 (@pxref{Process/Prefix}).
3490 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3491 commands will sort in reverse order.
3493 You can also sort a subset of the groups:
3497 @kindex G P a (Group)
3498 @findex gnus-group-sort-selected-groups-by-alphabet
3499 Sort the groups alphabetically by group name
3500 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3503 @kindex G P u (Group)
3504 @findex gnus-group-sort-selected-groups-by-unread
3505 Sort the groups by the number of unread articles
3506 (@code{gnus-group-sort-selected-groups-by-unread}).
3509 @kindex G P l (Group)
3510 @findex gnus-group-sort-selected-groups-by-level
3511 Sort the groups by group level
3512 (@code{gnus-group-sort-selected-groups-by-level}).
3515 @kindex G P v (Group)
3516 @findex gnus-group-sort-selected-groups-by-score
3517 Sort the groups by group score
3518 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3521 @kindex G P r (Group)
3522 @findex gnus-group-sort-selected-groups-by-rank
3523 Sort the groups by group rank
3524 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3527 @kindex G P m (Group)
3528 @findex gnus-group-sort-selected-groups-by-method
3529 Sort the groups alphabetically by back end name@*
3530 (@code{gnus-group-sort-selected-groups-by-method}).
3533 @kindex G P n (Group)
3534 @findex gnus-group-sort-selected-groups-by-real-name
3535 Sort the groups alphabetically by real (unprefixed) group name
3536 (@code{gnus-group-sort-selected-groups-by-real-name}).
3539 @kindex G P s (Group)
3540 @findex gnus-group-sort-selected-groups
3541 Sort the groups according to @code{gnus-group-sort-function}.
3545 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3549 @node Group Maintenance
3550 @section Group Maintenance
3551 @cindex bogus groups
3556 @findex gnus-group-check-bogus-groups
3557 Find bogus groups and delete them
3558 (@code{gnus-group-check-bogus-groups}).
3562 @findex gnus-group-find-new-groups
3563 Find new groups and process them (@code{gnus-group-find-new-groups}).
3564 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3565 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3566 to query the server for new groups, and subscribe the new groups as
3570 @kindex C-c C-x (Group)
3571 @findex gnus-group-expire-articles
3572 @cindex expiring mail
3573 Run all expirable articles in the current group through the expiry
3574 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3575 all expirable articles in the group that have been around for a while.
3576 (@pxref{Expiring Mail}).
3579 @kindex C-c C-M-x (Group)
3580 @findex gnus-group-expire-all-groups
3581 @cindex expiring mail
3582 Run all expirable articles in all groups through the expiry process
3583 (@code{gnus-group-expire-all-groups}).
3588 @node Browse Foreign Server
3589 @section Browse Foreign Server
3590 @cindex foreign servers
3591 @cindex browsing servers
3596 @findex gnus-group-browse-foreign-server
3597 You will be queried for a select method and a server name. Gnus will
3598 then attempt to contact this server and let you browse the groups there
3599 (@code{gnus-group-browse-foreign-server}).
3602 @findex gnus-browse-mode
3603 A new buffer with a list of available groups will appear. This buffer
3604 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3605 a lot) like a normal group buffer.
3607 Here's a list of keystrokes available in the browse mode:
3612 @findex gnus-group-next-group
3613 Go to the next group (@code{gnus-group-next-group}).
3617 @findex gnus-group-prev-group
3618 Go to the previous group (@code{gnus-group-prev-group}).
3621 @kindex SPACE (Browse)
3622 @findex gnus-browse-read-group
3623 Enter the current group and display the first article
3624 (@code{gnus-browse-read-group}).
3627 @kindex RET (Browse)
3628 @findex gnus-browse-select-group
3629 Enter the current group (@code{gnus-browse-select-group}).
3633 @findex gnus-browse-unsubscribe-current-group
3634 @vindex gnus-browse-subscribe-newsgroup-method
3635 Unsubscribe to the current group, or, as will be the case here,
3636 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). You
3637 can affect the way the new group is entered into the Group buffer
3638 using the variable @code{gnus-browse-subscribe-newsgroup-method}. See
3639 @pxref{Subscription Methods} for available options.
3645 @findex gnus-browse-exit
3646 Exit browse mode (@code{gnus-browse-exit}).
3650 @findex gnus-browse-describe-group
3651 Describe the current group (@code{gnus-browse-describe-group}).
3655 @findex gnus-browse-describe-briefly
3656 Describe browse mode briefly (well, there's not much to describe, is
3657 there) (@code{gnus-browse-describe-briefly}).
3660 @kindex DEL (Browse)
3661 @findex gnus-browse-delete-group
3662 This function will delete the current group
3663 (@code{gnus-browse-delete-group}). If given a prefix, this function
3664 will actually delete all the articles in the group, and forcibly
3665 remove the group itself from the face of the Earth. Use a prefix only
3666 if you are absolutely sure of what you are doing.
3671 @section Exiting Gnus
3672 @cindex exiting Gnus
3674 Yes, Gnus is ex(c)iting.
3679 @findex gnus-group-suspend
3680 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3681 but it kills all buffers except the Group buffer. I'm not sure why this
3682 is a gain, but then who am I to judge?
3686 @findex gnus-group-exit
3687 @c @icon{gnus-group-exit}
3688 Quit Gnus (@code{gnus-group-exit}).
3692 @findex gnus-group-quit
3693 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3694 The dribble file will be saved, though (@pxref{Auto Save}).
3697 @vindex gnus-exit-gnus-hook
3698 @vindex gnus-suspend-gnus-hook
3699 @vindex gnus-after-exiting-gnus-hook
3700 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3701 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3702 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3708 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3709 numbly heavy and herself fall into a hazy trance as the boy sitting
3710 behind her drew repeated lines with his pencil across the back of her
3716 @section Group Topics
3719 If you read lots and lots of groups, it might be convenient to group
3720 them hierarchically according to topics. You put your Emacs groups over
3721 here, your sex groups over there, and the rest (what, two groups or so?)
3722 you put in some misc section that you never bother with anyway. You can
3723 even group the Emacs sex groups as a sub-topic to either the Emacs
3724 groups or the sex groups---or both! Go wild!
3728 \gnusfigure{Group Topics}{400}{
3729 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3740 2: alt.religion.emacs
3743 0: comp.talk.emacs.recovery
3745 8: comp.binaries.fractals
3746 13: comp.sources.unix
3749 @findex gnus-topic-mode
3751 To get this @emph{fab} functionality you simply turn on (ooh!) the
3752 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3753 is a toggling command.)
3755 Go ahead, just try it. I'll still be here when you get back. La de
3756 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3757 Yes, and now press @kbd{l}. There. All your groups are now listed
3758 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3761 If you want this permanently enabled, you should add that minor mode to
3762 the hook for the group mode. Put the following line in your
3763 @file{~/.gnus.el} file:
3766 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3770 * Topic Commands:: Interactive E-Z commands.
3771 * Topic Variables:: How to customize the topics the Lisp Way.
3772 * Topic Sorting:: Sorting each topic individually.
3773 * Topic Topology:: A map of the world.
3774 * Topic Parameters:: Parameters that apply to all groups in a topic.
3778 @node Topic Commands
3779 @subsection Topic Commands
3780 @cindex topic commands
3782 When the topic minor mode is turned on, a new @kbd{T} submap will be
3783 available. In addition, a few of the standard keys change their
3784 definitions slightly.
3786 In general, the following kinds of operations are possible on topics.
3787 First of all, you want to create topics. Secondly, you want to put
3788 groups in topics and to move them around until you have an order you
3789 like. The third kind of operation is to show/hide parts of the whole
3790 shebang. You might want to hide a topic including its subtopics and
3791 groups, to get a better overview of the other groups.
3793 Here is a list of the basic keys that you might need to set up topics
3800 @findex gnus-topic-create-topic
3801 Prompt for a new topic name and create it
3802 (@code{gnus-topic-create-topic}).
3806 @kindex T TAB (Topic)
3808 @findex gnus-topic-indent
3809 ``Indent'' the current topic so that it becomes a sub-topic of the
3810 previous topic (@code{gnus-topic-indent}). If given a prefix,
3811 ``un-indent'' the topic instead.
3814 @kindex M-TAB (Topic)
3815 @findex gnus-topic-unindent
3816 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3817 parent of its current parent (@code{gnus-topic-unindent}).
3821 The following two keys can be used to move groups and topics around.
3822 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3823 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3824 kill and yank rather than cut and paste.
3830 @findex gnus-topic-kill-group
3831 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3832 topic will be removed along with the topic.
3836 @findex gnus-topic-yank-group
3837 Yank the previously killed group or topic
3838 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3841 So, to move a topic to the beginning of the list of topics, just hit
3842 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3843 move the cursor to the beginning of the buffer (just below the ``Gnus''
3844 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3845 paste. Like I said---E-Z.
3847 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3848 you can move topics around as well as groups.
3852 After setting up the topics the way you like them, you might wish to
3853 hide a topic, or to show it again. That's why we have the following
3860 @findex gnus-topic-select-group
3862 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3863 When you perform this command on a group, you'll enter the group, as
3864 usual. When done on a topic line, the topic will be folded (if it was
3865 visible) or unfolded (if it was folded already). So it's basically a
3866 toggling command on topics. In addition, if you give a numerical
3867 prefix, group on that level (and lower) will be displayed.
3871 Now for a list of other commands, in no particular order.
3877 @findex gnus-topic-move-group
3878 Move the current group to some other topic
3879 (@code{gnus-topic-move-group}). This command uses the process/prefix
3880 convention (@pxref{Process/Prefix}).
3884 @findex gnus-topic-jump-to-topic
3885 Go to a topic (@code{gnus-topic-jump-to-topic}).
3889 @findex gnus-topic-copy-group
3890 Copy the current group to some other topic
3891 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3892 convention (@pxref{Process/Prefix}).
3896 @findex gnus-topic-hide-topic
3897 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3898 a prefix, hide the topic permanently.
3902 @findex gnus-topic-show-topic
3903 Show the current topic (@code{gnus-topic-show-topic}). If given
3904 a prefix, show the topic permanently.
3908 @findex gnus-topic-remove-group
3909 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3910 This command is mainly useful if you have the same group in several
3911 topics and wish to remove it from one of the topics. You may also
3912 remove a group from all topics, but in that case, Gnus will add it to
3913 the root topic the next time you start Gnus. In fact, all new groups
3914 (which, naturally, don't belong to any topic) will show up in the root
3917 This command uses the process/prefix convention
3918 (@pxref{Process/Prefix}).
3922 @findex gnus-topic-move-matching
3923 Move all groups that match some regular expression to a topic
3924 (@code{gnus-topic-move-matching}).
3928 @findex gnus-topic-copy-matching
3929 Copy all groups that match some regular expression to a topic
3930 (@code{gnus-topic-copy-matching}).
3934 @findex gnus-topic-toggle-display-empty-topics
3935 Toggle hiding empty topics
3936 (@code{gnus-topic-toggle-display-empty-topics}).
3940 @findex gnus-topic-mark-topic
3941 Mark all groups in the current topic with the process mark
3942 (@code{gnus-topic-mark-topic}). This command works recursively on
3943 sub-topics unless given a prefix.
3946 @kindex T M-# (Topic)
3947 @findex gnus-topic-unmark-topic
3948 Remove the process mark from all groups in the current topic
3949 (@code{gnus-topic-unmark-topic}). This command works recursively on
3950 sub-topics unless given a prefix.
3953 @kindex C-c C-x (Topic)
3954 @findex gnus-topic-expire-articles
3955 @cindex expiring mail
3956 Run all expirable articles in the current group or topic through the
3957 expiry process (if any)
3958 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3962 @findex gnus-topic-rename
3963 Rename a topic (@code{gnus-topic-rename}).
3966 @kindex T DEL (Topic)
3967 @findex gnus-topic-delete
3968 Delete an empty topic (@code{gnus-topic-delete}).
3972 @findex gnus-topic-list-active
3973 List all groups that Gnus knows about in a topics-ified way
3974 (@code{gnus-topic-list-active}).
3977 @kindex T M-n (Topic)
3978 @findex gnus-topic-goto-next-topic
3979 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3982 @kindex T M-p (Topic)
3983 @findex gnus-topic-goto-previous-topic
3984 Go to the previous topic (@code{gnus-topic-goto-previous-topic}).
3988 @findex gnus-topic-edit-parameters
3989 @cindex group parameters
3990 @cindex topic parameters
3992 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3993 @xref{Topic Parameters}.
3998 @node Topic Variables
3999 @subsection Topic Variables
4000 @cindex topic variables
4002 The previous section told you how to tell Gnus which topics to display.
4003 This section explains how to tell Gnus what to display about each topic.
4005 @vindex gnus-topic-line-format
4006 The topic lines themselves are created according to the
4007 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
4020 Number of groups in the topic.
4022 Number of unread articles in the topic.
4024 Number of unread articles in the topic and all its subtopics.
4027 @vindex gnus-topic-indent-level
4028 Each sub-topic (and the groups in the sub-topics) will be indented with
4029 @code{gnus-topic-indent-level} times the topic level number of spaces.
4032 @vindex gnus-topic-mode-hook
4033 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
4035 @vindex gnus-topic-display-empty-topics
4036 The @code{gnus-topic-display-empty-topics} says whether to display even
4037 topics that have no unread articles in them. The default is @code{t}.
4041 @subsection Topic Sorting
4042 @cindex topic sorting
4044 You can sort the groups in each topic individually with the following
4050 @kindex T S a (Topic)
4051 @findex gnus-topic-sort-groups-by-alphabet
4052 Sort the current topic alphabetically by group name
4053 (@code{gnus-topic-sort-groups-by-alphabet}).
4056 @kindex T S u (Topic)
4057 @findex gnus-topic-sort-groups-by-unread
4058 Sort the current topic by the number of unread articles
4059 (@code{gnus-topic-sort-groups-by-unread}).
4062 @kindex T S l (Topic)
4063 @findex gnus-topic-sort-groups-by-level
4064 Sort the current topic by group level
4065 (@code{gnus-topic-sort-groups-by-level}).
4068 @kindex T S v (Topic)
4069 @findex gnus-topic-sort-groups-by-score
4070 Sort the current topic by group score
4071 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
4074 @kindex T S r (Topic)
4075 @findex gnus-topic-sort-groups-by-rank
4076 Sort the current topic by group rank
4077 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
4080 @kindex T S m (Topic)
4081 @findex gnus-topic-sort-groups-by-method
4082 Sort the current topic alphabetically by back end name
4083 (@code{gnus-topic-sort-groups-by-method}).
4086 @kindex T S e (Topic)
4087 @findex gnus-topic-sort-groups-by-server
4088 Sort the current topic alphabetically by server name
4089 (@code{gnus-topic-sort-groups-by-server}).
4092 @kindex T S s (Topic)
4093 @findex gnus-topic-sort-groups
4094 Sort the current topic according to the function(s) given by the
4095 @code{gnus-group-sort-function} variable
4096 (@code{gnus-topic-sort-groups}).
4100 When given a prefix argument, all these commands will sort in reverse
4101 order. @xref{Sorting Groups}, for more information about group
4105 @node Topic Topology
4106 @subsection Topic Topology
4107 @cindex topic topology
4110 So, let's have a look at an example group buffer:
4117 2: alt.religion.emacs
4120 0: comp.talk.emacs.recovery
4122 8: comp.binaries.fractals
4123 13: comp.sources.unix
4127 So, here we have one top-level topic (@samp{Gnus}), two topics under
4128 that, and one sub-topic under one of the sub-topics. (There is always
4129 just one (1) top-level topic). This topology can be expressed as
4134 (("Emacs -- I wuw it!" visible)
4135 (("Naughty Emacs" visible)))
4139 @vindex gnus-topic-topology
4140 This is in fact how the variable @code{gnus-topic-topology} would look
4141 for the display above. That variable is saved in the @file{.newsrc.eld}
4142 file, and shouldn't be messed with manually---unless you really want
4143 to. Since this variable is read from the @file{.newsrc.eld} file,
4144 setting it in any other startup files will have no effect.
4146 This topology shows what topics are sub-topics of what topics (right),
4147 and which topics are visible. Two settings are currently
4148 allowed---@code{visible} and @code{invisible}.
4151 @node Topic Parameters
4152 @subsection Topic Parameters
4153 @cindex topic parameters
4155 All groups in a topic will inherit group parameters from the parent
4156 (and ancestor) topic parameters. All valid group parameters are valid
4157 topic parameters (@pxref{Group Parameters}). When the agent is
4158 enabled, all agent parameters (See Agent Parameters in @ref{Category
4159 Syntax}) are also valid topic parameters.
4161 In addition, the following parameters are only valid as topic
4166 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4167 @code{subscribe} topic parameter says what groups go in what topic. Its
4168 value should be a regexp to match the groups that should go in that
4171 @item subscribe-level
4172 When subscribing new groups by topic (see the @code{subscribe} parameter),
4173 the group will be subscribed with the level specified in the
4174 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4178 Group parameters (of course) override topic parameters, and topic
4179 parameters in sub-topics override topic parameters in super-topics. You
4180 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4181 verb, although you may feel free to disagree with me here.)
4188 2: alt.religion.emacs
4192 0: comp.talk.emacs.recovery
4194 8: comp.binaries.fractals
4195 13: comp.sources.unix
4200 The @samp{Emacs} topic has the topic parameter @code{(score-file
4201 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4202 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4203 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4204 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4205 . "religion.SCORE")}.
4207 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4208 will get the @file{relief.SCORE} home score file. If you enter the same
4209 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4210 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4211 get the @file{religion.SCORE} home score file.
4213 This seems rather simple and self-evident, doesn't it? Well, yes. But
4214 there are some problems, especially with the @code{total-expiry}
4215 parameter. Say you have a mail group in two topics; one with
4216 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4217 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4218 of these topics you mean to expire articles from, so anything may
4219 happen. In fact, I hereby declare that it is @dfn{undefined} what
4220 happens. You just have to be careful if you do stuff like that.
4223 @node Non-ASCII Group Names
4224 @section Accessing groups of non-English names
4225 @cindex non-ascii group names
4227 There are some news servers that provide groups of which the names are
4228 expressed with their native languages in the world. For instance, in a
4229 certain news server there are some newsgroups of which the names are
4230 spelled in Chinese, where people are talking in Chinese. You can, of
4231 course, subscribe to such news groups using Gnus. Currently Gnus
4232 supports non-@acronym{ASCII} group names not only with the @code{nntp}
4233 back end but also with the @code{nnml} back end and the @code{nnrss}
4236 Every such group name is encoded by a certain charset in the server
4237 side (in an @acronym{NNTP} server its administrator determines the
4238 charset, but for groups in the other back ends it is determined by you).
4239 Gnus has to display the decoded ones for you in the group buffer and the
4240 article buffer, and needs to use the encoded ones when communicating
4241 with servers. However, Gnus doesn't know what charset is used for each
4242 non-@acronym{ASCII} group name. The following two variables are just
4243 the ones for telling Gnus what charset should be used for each group:
4246 @item gnus-group-name-charset-method-alist
4247 @vindex gnus-group-name-charset-method-alist
4248 An alist of select methods and charsets. The default value is
4249 @code{nil}. The names of groups in the server specified by that select
4250 method are all supposed to use the corresponding charset. For example:
4253 (setq gnus-group-name-charset-method-alist
4254 '(((nntp "news.com.cn") . cn-gb-2312)))
4257 Charsets specified for groups with this variable are preferred to the
4258 ones specified for the same groups with the
4259 @code{gnus-group-name-charset-group-alist} variable (see below).
4261 A select method can be very long, like:
4265 (nntp-address "news.gmane.org")
4266 (nntp-end-of-line "\n")
4267 (nntp-open-connection-function
4268 nntp-open-via-rlogin-and-telnet)
4269 (nntp-via-rlogin-command "ssh")
4270 (nntp-via-rlogin-command-switches
4271 ("-C" "-t" "-e" "none"))
4272 (nntp-via-address @dots{}))
4275 In that case, you can truncate it into @code{(nntp "gmane")} in this
4276 variable. That is, it is enough to contain only the back end name and
4279 @item gnus-group-name-charset-group-alist
4280 @cindex UTF-8 group names
4281 @vindex gnus-group-name-charset-group-alist
4282 An alist of regexp of group name and the charset for group names.
4283 @code{((".*" . utf-8))} is the default value if UTF-8 is supported,
4284 otherwise the default is @code{nil}. For example:
4287 (setq gnus-group-name-charset-group-alist
4288 '(("\\.com\\.cn:" . cn-gb-2312)
4292 Note that this variable is ignored if the match is made with
4293 @code{gnus-group-name-charset-method-alist}.
4296 Those two variables are used also to determine the charset for encoding
4297 and decoding non-@acronym{ASCII} group names that are in the back ends
4298 other than @code{nntp}. It means that it is you who determine it. If
4299 you do nothing, the charset used for group names in those back ends will
4300 all be @code{utf-8} because of the last element of
4301 @code{gnus-group-name-charset-group-alist}.
4303 There is one more important variable for non-@acronym{ASCII} group
4307 @item nnmail-pathname-coding-system
4308 @vindex nnmail-pathname-coding-system
4309 The value of this variable should be a coding system or @code{nil}. The
4310 default is @code{nil} in Emacs, or is the aliasee of the coding system
4311 named @code{file-name} (a certain coding system of which an alias is
4312 @code{file-name}) in XEmacs.
4314 The @code{nnml} back end, the @code{nnrss} back end, the agent, and
4315 the cache use non-@acronym{ASCII} group names in those files and
4316 directories. This variable overrides the value of
4317 @code{file-name-coding-system} which specifies the coding system used
4318 when encoding and decoding those file names and directory names.
4320 In XEmacs (with the @code{mule} feature), @code{file-name-coding-system}
4321 is the only means to specify the coding system used to encode and decode
4322 file names. On the other hand, Emacs uses the value of
4323 @code{default-file-name-coding-system} if @code{file-name-coding-system}
4324 is @code{nil} or it is bound to the value of
4325 @code{nnmail-pathname-coding-system} which is @code{nil}.
4327 Normally the value of @code{default-file-name-coding-system} in Emacs or
4328 @code{nnmail-pathname-coding-system} in XEmacs is initialized according
4329 to the locale, so you will need to do nothing if the value is suitable
4330 to encode and decode non-@acronym{ASCII} group names.
4332 The value of this variable (or @code{default-file-name-coding-system})
4333 does not necessarily need to be the same value that is determined by
4334 @code{gnus-group-name-charset-method-alist} and
4335 @code{gnus-group-name-charset-group-alist}.
4337 If @code{default-file-name-coding-system} or this variable is
4338 initialized by default to @code{iso-latin-1} for example, although you
4339 want to subscribe to the groups spelled in Chinese, that is the most
4340 typical case where you have to customize
4341 @code{nnmail-pathname-coding-system}. The @code{utf-8} coding system is
4342 a good candidate for it. Otherwise, you may change the locale in your
4343 system so that @code{default-file-name-coding-system} or this variable
4344 may be initialized to an appropriate value.
4347 Note that when you copy or move articles from a non-@acronym{ASCII}
4348 group to another group, the charset used to encode and decode group
4349 names should be the same in both groups. Otherwise the Newsgroups
4350 header will be displayed incorrectly in the article buffer.
4353 @node Misc Group Stuff
4354 @section Misc Group Stuff
4357 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4358 * Group Information:: Information and help on groups and Gnus.
4359 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4360 * File Commands:: Reading and writing the Gnus files.
4361 * Sieve Commands:: Managing Sieve scripts.
4368 @cindex keys, reserved for users (Group)
4369 The key @kbd{v} is reserved for users. You can bind it to some
4370 command or better use it as a prefix key. For example:
4373 (define-key gnus-group-mode-map (kbd "v j d")
4376 (gnus-group-jump-to-group "nndraft:drafts")))
4379 On keys reserved for users in Emacs and on keybindings in general
4380 @xref{Keymaps, Keymaps, , emacs, The Emacs Editor}.
4384 @findex gnus-group-enter-server-mode
4385 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4386 @xref{Server Buffer}.
4390 @findex gnus-group-post-news
4391 Start composing a message (a news by default)
4392 (@code{gnus-group-post-news}). If given a prefix, post to the group
4393 under the point. If the prefix is 1, prompt for a group to post to.
4394 Contrary to what the name of this function suggests, the prepared
4395 article might be a mail instead of a news, if a mail group is specified
4396 with the prefix argument. @xref{Composing Messages}.
4400 @findex gnus-group-mail
4401 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4402 use the posting style of the group under the point. If the prefix is 1,
4403 prompt for a group name to find the posting style.
4404 @xref{Composing Messages}.
4408 @findex gnus-group-news
4409 Start composing a news (@code{gnus-group-news}). If given a prefix,
4410 post to the group under the point. If the prefix is 1, prompt
4411 for group to post to. @xref{Composing Messages}.
4413 This function actually prepares a news even when using mail groups.
4414 This is useful for ``posting'' messages to mail groups without actually
4415 sending them over the network: they're just saved directly to the group
4416 in question. The corresponding back end must have a request-post method
4417 for this to work though.
4421 @findex gnus-group-compact-group
4423 Compact the group under point (@code{gnus-group-compact-group}).
4424 Currently implemented only in nnml (@pxref{Mail Spool}). This removes
4425 gaps between article numbers, hence getting a correct total article
4430 Variables for the group buffer:
4434 @item gnus-group-mode-hook
4435 @vindex gnus-group-mode-hook
4436 is called after the group buffer has been
4439 @item gnus-group-prepare-hook
4440 @vindex gnus-group-prepare-hook
4441 is called after the group buffer is
4442 generated. It may be used to modify the buffer in some strange,
4445 @item gnus-group-prepared-hook
4446 @vindex gnus-group-prepare-hook
4447 is called as the very last thing after the group buffer has been
4448 generated. It may be used to move point around, for instance.
4450 @item gnus-permanently-visible-groups
4451 @vindex gnus-permanently-visible-groups
4452 Groups matching this regexp will always be listed in the group buffer,
4453 whether they are empty or not.
4457 @node Scanning New Messages
4458 @subsection Scanning New Messages
4459 @cindex new messages
4460 @cindex scanning new news
4466 @findex gnus-group-get-new-news
4467 @c @icon{gnus-group-get-new-news}
4468 Check the server(s) for new articles. If the numerical prefix is used,
4469 this command will check only groups of level @var{arg} and lower
4470 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4471 command will force a total re-reading of the active file(s) from the
4476 @findex gnus-group-get-new-news-this-group
4477 @vindex gnus-goto-next-group-when-activating
4478 @c @icon{gnus-group-get-new-news-this-group}
4479 Check whether new articles have arrived in the current group
4480 (@code{gnus-group-get-new-news-this-group}).
4481 @code{gnus-goto-next-group-when-activating} says whether this command is
4482 to move point to the next group or not. It is @code{t} by default.
4484 @findex gnus-activate-all-groups
4485 @cindex activating groups
4487 @kindex C-c M-g (Group)
4488 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4493 @findex gnus-group-restart
4494 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4495 file(s), closes the connection to all servers, clears up all run-time
4496 Gnus variables, and then starts Gnus all over again.
4500 @vindex gnus-get-new-news-hook
4501 @code{gnus-get-new-news-hook} is run just before checking for new news.
4503 @vindex gnus-after-getting-new-news-hook
4504 @code{gnus-after-getting-new-news-hook} is run after checking for new
4508 @node Group Information
4509 @subsection Group Information
4510 @cindex group information
4511 @cindex information on groups
4518 @c @icon{gnus-group-describe-group}
4520 @kindex C-c C-d (Group)
4521 @cindex describing groups
4522 @cindex group description
4523 @findex gnus-group-describe-group
4524 Describe the current group (@code{gnus-group-describe-group}). If given
4525 a prefix, force Gnus to re-read the description from the server.
4529 @findex gnus-group-describe-all-groups
4530 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4531 prefix, force Gnus to re-read the description file from the server.
4538 @findex gnus-version
4539 Display current Gnus version numbers (@code{gnus-version}).
4543 @findex gnus-group-describe-briefly
4544 Give a very short help message (@code{gnus-group-describe-briefly}).
4547 @kindex C-c C-i (Group)
4550 @findex gnus-info-find-node
4551 Go to the Gnus info node (@code{gnus-info-find-node}).
4555 @node Group Timestamp
4556 @subsection Group Timestamp
4558 @cindex group timestamps
4560 It can be convenient to let Gnus keep track of when you last read a
4561 group. To set the ball rolling, you should add
4562 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4565 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4568 After doing this, each time you enter a group, it'll be recorded.
4570 This information can be displayed in various ways---the easiest is to
4571 use the @samp{%d} spec in the group line format:
4574 (setq gnus-group-line-format
4575 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4578 This will result in lines looking like:
4581 * 0: mail.ding 19961002T012943
4582 0: custom 19961002T012713
4585 As you can see, the date is displayed in compact ISO 8601 format. This
4586 may be a bit too much, so to just display the date, you could say
4590 (setq gnus-group-line-format
4591 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4594 If you would like greater control of the time format, you can use a
4595 user-defined format spec. Something like the following should do the
4599 (setq gnus-group-line-format
4600 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4601 (defun gnus-user-format-function-d (headers)
4602 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4604 (format-time-string "%b %d %H:%M" time)
4608 To see what variables are dynamically bound (like
4609 @code{gnus-tmp-group}), you have to look at the source code. The
4610 variable names aren't guaranteed to be stable over Gnus versions,
4615 @subsection File Commands
4616 @cindex file commands
4622 @findex gnus-group-read-init-file
4623 @vindex gnus-init-file
4624 @cindex reading init file
4625 Re-read the init file (@code{gnus-init-file}, which defaults to
4626 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4630 @findex gnus-group-save-newsrc
4631 @cindex saving .newsrc
4632 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4633 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4634 file(s) whether Gnus thinks it is necessary or not.
4637 @c @kindex Z (Group)
4638 @c @findex gnus-group-clear-dribble
4639 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4644 @node Sieve Commands
4645 @subsection Sieve Commands
4646 @cindex group sieve commands
4648 Sieve is a server-side mail filtering language. In Gnus you can use
4649 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4650 sieve rules that should apply to each group. Gnus provides two
4651 commands to translate all these group parameters into a proper Sieve
4652 script that can be transferred to the server somehow.
4654 @vindex gnus-sieve-file
4655 @vindex gnus-sieve-region-start
4656 @vindex gnus-sieve-region-end
4657 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4658 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4659 between two delimiters, @code{gnus-sieve-region-start} and
4660 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4661 outside these delimiters that will not be removed the next time you
4662 regenerate the Sieve script.
4664 @vindex gnus-sieve-crosspost
4665 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4666 is generated. If it is non-@code{nil} (the default) articles is
4667 placed in all groups that have matching rules, otherwise the article
4668 is only placed in the group with the first matching rule. For
4669 example, the group parameter @samp{(sieve address "sender"
4670 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4671 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4672 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4673 except that the line containing the call to @code{stop} is removed.)
4676 if address "sender" "owner-ding@@hpc.uh.edu" @{
4677 fileinto "INBOX.ding";
4682 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4688 @findex gnus-sieve-generate
4689 @vindex gnus-sieve-file
4690 @cindex generating sieve script
4691 Regenerate a Sieve script from the @code{sieve} group parameters and
4692 put you into the @code{gnus-sieve-file} without saving it.
4696 @findex gnus-sieve-update
4697 @vindex gnus-sieve-file
4698 @cindex updating sieve script
4699 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4700 @code{sieve} group parameters, save the file and upload it to the
4701 server using the @code{sieveshell} program.
4706 @node Summary Buffer
4707 @chapter Summary Buffer
4708 @cindex summary buffer
4710 A line for each article is displayed in the summary buffer. You can
4711 move around, read articles, post articles and reply to articles.
4713 The most common way to a summary buffer is to select a group from the
4714 group buffer (@pxref{Selecting a Group}).
4716 You can have as many summary buffers open as you wish.
4718 You can customize the Summary Mode tool bar, see @kbd{M-x
4719 customize-apropos RET gnus-summary-tool-bar}. This feature is only
4723 @cindex keys, reserved for users (Summary)
4724 The key @kbd{v} is reserved for users. You can bind it to some
4725 command or better use it as a prefix key. For example:
4727 (define-key gnus-summary-mode-map (kbd "v -") "LrS") ;; lower subthread
4731 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4732 * Summary Maneuvering:: Moving around the summary buffer.
4733 * Choosing Articles:: Reading articles.
4734 * Paging the Article:: Scrolling the current article.
4735 * Reply Followup and Post:: Posting articles.
4736 * Delayed Articles:: Send articles at a later time.
4737 * Marking Articles:: Marking articles as read, expirable, etc.
4738 * Limiting:: You can limit the summary buffer.
4739 * Threading:: How threads are made.
4740 * Sorting the Summary Buffer:: How articles and threads are sorted.
4741 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4742 * Article Caching:: You may store articles in a cache.
4743 * Persistent Articles:: Making articles expiry-resistant.
4744 * Sticky Articles:: Article buffers that are not reused.
4745 * Article Backlog:: Having already read articles hang around.
4746 * Saving Articles:: Ways of customizing article saving.
4747 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4748 * Article Treatment:: The article buffer can be mangled at will.
4749 * MIME Commands:: Doing MIMEy things with the articles.
4750 * Charsets:: Character set issues.
4751 * Article Commands:: Doing various things with the article buffer.
4752 * Summary Sorting:: Sorting the summary buffer in various ways.
4753 * Finding the Parent:: No child support? Get the parent.
4754 * Alternative Approaches:: Reading using non-default summaries.
4755 * Tree Display:: A more visual display of threads.
4756 * Mail Group Commands:: Some commands can only be used in mail groups.
4757 * Various Summary Stuff:: What didn't fit anywhere else.
4758 * Exiting the Summary Buffer:: Returning to the Group buffer,
4759 or reselecting the current group.
4760 * Crosspost Handling:: How crossposted articles are dealt with.
4761 * Duplicate Suppression:: An alternative when crosspost handling fails.
4762 * Security:: Decrypt and Verify.
4763 * Mailing List:: Mailing list minor mode.
4767 @node Summary Buffer Format
4768 @section Summary Buffer Format
4769 @cindex summary buffer format
4773 \gnusfigure{The Summary Buffer}{180}{
4774 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4775 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4781 * Summary Buffer Lines:: You can specify how summary lines should look.
4782 * To From Newsgroups:: How to not display your own name.
4783 * Summary Buffer Mode Line:: You can say how the mode line should look.
4784 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4787 @findex mail-extract-address-components
4788 @findex gnus-extract-address-components
4789 @vindex gnus-extract-address-components
4790 Gnus will use the value of the @code{gnus-extract-address-components}
4791 variable as a function for getting the name and address parts of a
4792 @code{From} header. Two pre-defined functions exist:
4793 @code{gnus-extract-address-components}, which is the default, quite
4794 fast, and too simplistic solution; and
4795 @code{mail-extract-address-components}, which works very nicely, but is
4796 slower. The default function will return the wrong answer in 5% of the
4797 cases. If this is unacceptable to you, use the other function instead:
4800 (setq gnus-extract-address-components
4801 'mail-extract-address-components)
4804 @vindex gnus-summary-same-subject
4805 @code{gnus-summary-same-subject} is a string indicating that the current
4806 article has the same subject as the previous. This string will be used
4807 with those specs that require it. The default is @code{""}.
4810 @node Summary Buffer Lines
4811 @subsection Summary Buffer Lines
4813 @vindex gnus-summary-line-format
4814 You can change the format of the lines in the summary buffer by changing
4815 the @code{gnus-summary-line-format} variable. It works along the same
4816 lines as a normal @code{format} string, with some extensions
4817 (@pxref{Formatting Variables}).
4819 There should always be a colon or a point position marker on the line;
4820 the cursor always moves to the point position marker or the colon after
4821 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4822 possible to change this. Just write a new function
4823 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4824 @xref{Positioning Point}.
4826 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4828 The following format specification characters and extended format
4829 specification(s) are understood:
4835 Subject string. List identifiers stripped,
4836 @code{gnus-list-identifiers}. @xref{Article Hiding}.
4838 Subject if the article is the root of the thread or the previous article
4839 had a different subject, @code{gnus-summary-same-subject} otherwise.
4840 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4842 Full @code{From} header.
4844 The name (from the @code{From} header).
4846 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4849 The name (from the @code{From} header). This differs from the @code{n}
4850 spec in that it uses the function designated by the
4851 @code{gnus-extract-address-components} variable, which is slower, but
4852 may be more thorough.
4854 The address (from the @code{From} header). This works the same way as
4857 Number of lines in the article.
4859 Number of characters in the article. This specifier is not supported
4860 in some methods (like nnfolder).
4862 Pretty-printed version of the number of characters in the article;
4863 for example, @samp{1.2k} or @samp{0.4M}.
4865 Indentation based on thread level (@pxref{Customizing Threading}).
4867 A complex trn-style thread tree, showing response-connecting trace
4868 lines. A thread could be drawn like this:
4881 You can customize the appearance with the following options. Note
4882 that it is possible to make the thread display look really neat by
4883 replacing the default @acronym{ASCII} characters with graphic
4884 line-drawing glyphs.
4886 @item gnus-sum-thread-tree-root
4887 @vindex gnus-sum-thread-tree-root
4888 Used for the root of a thread. If @code{nil}, use subject
4889 instead. The default is @samp{> }.
4891 @item gnus-sum-thread-tree-false-root
4892 @vindex gnus-sum-thread-tree-false-root
4893 Used for the false root of a thread (@pxref{Loose Threads}). If
4894 @code{nil}, use subject instead. The default is @samp{> }.
4896 @item gnus-sum-thread-tree-single-indent
4897 @vindex gnus-sum-thread-tree-single-indent
4898 Used for a thread with just one message. If @code{nil}, use subject
4899 instead. The default is @samp{}.
4901 @item gnus-sum-thread-tree-vertical
4902 @vindex gnus-sum-thread-tree-vertical
4903 Used for drawing a vertical line. The default is @samp{| }.
4905 @item gnus-sum-thread-tree-indent
4906 @vindex gnus-sum-thread-tree-indent
4907 Used for indenting. The default is @samp{ }.
4909 @item gnus-sum-thread-tree-leaf-with-other
4910 @vindex gnus-sum-thread-tree-leaf-with-other
4911 Used for a leaf with brothers. The default is @samp{+-> }.
4913 @item gnus-sum-thread-tree-single-leaf
4914 @vindex gnus-sum-thread-tree-single-leaf
4915 Used for a leaf without brothers. The default is @samp{\-> }
4920 Nothing if the article is a root and lots of spaces if it isn't (it
4921 pushes everything after it off the screen).
4923 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4924 for adopted articles (@pxref{Customizing Threading}).
4926 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4927 for adopted articles.
4929 One space for each thread level.
4931 Twenty minus thread level spaces.
4933 Unread. @xref{Read Articles}.
4936 This misleadingly named specifier is the @dfn{secondary mark}. This
4937 mark will say whether the article has been replied to, has been cached,
4938 or has been saved. @xref{Other Marks}.
4941 Score as a number (@pxref{Scoring}).
4943 @vindex gnus-summary-zcore-fuzz
4944 Zcore, @samp{+} if above the default level and @samp{-} if below the
4945 default level. If the difference between
4946 @code{gnus-summary-default-score} and the score is less than
4947 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4955 The @code{Date} in @code{DD-MMM} format.
4957 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4963 Number of articles in the current sub-thread. Using this spec will slow
4964 down summary buffer generation somewhat.
4966 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4967 article has any children.
4973 Desired cursor position (instead of after first colon).
4975 Age sensitive date format. Various date format is defined in
4976 @code{gnus-user-date-format-alist}.
4978 User defined specifier. The next character in the format string should
4979 be a letter. Gnus will call the function
4980 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4981 following @samp{%u}. The function will be passed the current header as
4982 argument. The function should return a string, which will be inserted
4983 into the summary just like information from any other summary specifier.
4986 Text between @samp{%(} and @samp{%)} will be highlighted with
4987 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4988 There can only be one such area.
4990 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4991 have to be handled with care. For reasons of efficiency, Gnus will
4992 compute what column these characters will end up in, and ``hard-code''
4993 that. This means that it is invalid to have these specs after a
4994 variable-length spec. Well, you might not be arrested, but your summary
4995 buffer will look strange, which is bad enough.
4997 The smart choice is to have these specs as far to the left as possible.
4998 (Isn't that the case with everything, though? But I digress.)
5000 This restriction may disappear in later versions of Gnus.
5003 @node To From Newsgroups
5004 @subsection To From Newsgroups
5008 In some groups (particularly in archive groups), the @code{From} header
5009 isn't very interesting, since all the articles there are written by
5010 you. To display the information in the @code{To} or @code{Newsgroups}
5011 headers instead, you need to decide three things: What information to
5012 gather; where to display it; and when to display it.
5016 @vindex gnus-extra-headers
5017 The reading of extra header information is controlled by the
5018 @code{gnus-extra-headers}. This is a list of header symbols. For
5022 (setq gnus-extra-headers
5023 '(To Newsgroups X-Newsreader))
5026 This will result in Gnus trying to obtain these three headers, and
5027 storing it in header structures for later easy retrieval.
5030 @findex gnus-extra-header
5031 The value of these extra headers can be accessed via the
5032 @code{gnus-extra-header} function. Here's a format line spec that will
5033 access the @code{X-Newsreader} header:
5036 "%~(form (gnus-extra-header 'X-Newsreader))@@"
5040 @vindex gnus-ignored-from-addresses
5041 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
5042 summary line spec returns the @code{To}, @code{Newsreader} or
5043 @code{From} header. If this regexp matches the contents of the
5044 @code{From} header, the value of the @code{To} or @code{Newsreader}
5045 headers are used instead.
5047 To distinguish regular articles from those where the @code{From} field
5048 has been swapped, a string is prefixed to the @code{To} or
5049 @code{Newsgroups} header in the summary line. By default the string is
5050 @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can
5051 customize these strings with @code{gnus-summary-to-prefix} and
5052 @code{gnus-summary-newsgroup-prefix}.
5056 @vindex nnmail-extra-headers
5057 A related variable is @code{nnmail-extra-headers}, which controls when
5058 to include extra headers when generating overview (@acronym{NOV}) files.
5059 If you have old overview files, you should regenerate them after
5060 changing this variable, by entering the server buffer using @kbd{^},
5061 and then @kbd{g} on the appropriate mail server (e.g., nnml) to cause
5064 @vindex gnus-summary-line-format
5065 You also have to instruct Gnus to display the data by changing the
5066 @code{%n} spec to the @code{%f} spec in the
5067 @code{gnus-summary-line-format} variable.
5069 In summary, you'd typically put something like the following in
5073 (setq gnus-extra-headers
5075 (setq nnmail-extra-headers gnus-extra-headers)
5076 (setq gnus-summary-line-format
5077 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
5078 (setq gnus-ignored-from-addresses
5082 (The values listed above are the default values in Gnus. Alter them
5085 A note for news server administrators, or for users who wish to try to
5086 convince their news server administrator to provide some additional
5089 The above is mostly useful for mail groups, where you have control over
5090 the @acronym{NOV} files that are created. However, if you can persuade your
5091 nntp admin to add (in the usual implementation, notably INN):
5097 to the end of her @file{overview.fmt} file, then you can use that just
5098 as you would the extra headers from the mail groups.
5101 @node Summary Buffer Mode Line
5102 @subsection Summary Buffer Mode Line
5104 @vindex gnus-summary-mode-line-format
5105 You can also change the format of the summary mode bar (@pxref{Mode Line
5106 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
5107 like. The default is @samp{Gnus: %%b [%A] %Z}.
5109 Here are the elements you can play with:
5115 Unprefixed group name.
5117 Current article number.
5119 Current article score.
5123 Number of unread articles in this group.
5125 Number of unread articles in this group that aren't displayed in the
5128 A string with the number of unread and unselected articles represented
5129 either as @samp{<%U(+%e) more>} if there are both unread and unselected
5130 articles, and just as @samp{<%U more>} if there are just unread articles
5131 and no unselected ones.
5133 Shortish group name. For instance, @samp{rec.arts.anime} will be
5134 shortened to @samp{r.a.anime}.
5136 Subject of the current article.
5138 User-defined spec (@pxref{User-Defined Specs}).
5140 Name of the current score file (@pxref{Scoring}).
5142 Number of dormant articles (@pxref{Unread Articles}).
5144 Number of ticked articles (@pxref{Unread Articles}).
5146 Number of articles that have been marked as read in this session.
5148 Number of articles expunged by the score files.
5152 @node Summary Highlighting
5153 @subsection Summary Highlighting
5157 @item gnus-visual-mark-article-hook
5158 @vindex gnus-visual-mark-article-hook
5159 This hook is run after selecting an article. It is meant to be used for
5160 highlighting the article in some way. It is not run if
5161 @code{gnus-visual} is @code{nil}.
5163 @item gnus-summary-update-hook
5164 @vindex gnus-summary-update-hook
5165 This hook is called when a summary line is changed. It is not run if
5166 @code{gnus-visual} is @code{nil}.
5168 @item gnus-summary-selected-face
5169 @vindex gnus-summary-selected-face
5170 This is the face (or @dfn{font} as some people call it) used to
5171 highlight the current article in the summary buffer.
5173 @item gnus-summary-highlight
5174 @vindex gnus-summary-highlight
5175 Summary lines are highlighted according to this variable, which is a
5176 list where the elements are of the format @code{(@var{form}
5177 . @var{face})}. If you would, for instance, like ticked articles to be
5178 italic and high-scored articles to be bold, you could set this variable
5181 (((eq mark gnus-ticked-mark) . italic)
5182 ((> score default) . bold))
5184 As you may have guessed, if @var{form} returns a non-@code{nil} value,
5185 @var{face} will be applied to the line.
5189 @node Summary Maneuvering
5190 @section Summary Maneuvering
5191 @cindex summary movement
5193 All the straight movement commands understand the numeric prefix and
5194 behave pretty much as you'd expect.
5196 None of these commands select articles.
5201 @kindex M-n (Summary)
5202 @kindex G M-n (Summary)
5203 @findex gnus-summary-next-unread-subject
5204 Go to the next summary line of an unread article
5205 (@code{gnus-summary-next-unread-subject}).
5209 @kindex M-p (Summary)
5210 @kindex G M-p (Summary)
5211 @findex gnus-summary-prev-unread-subject
5212 Go to the previous summary line of an unread article
5213 (@code{gnus-summary-prev-unread-subject}).
5216 @kindex G g (Summary)
5217 @findex gnus-summary-goto-subject
5218 Ask for an article number and then go to the summary line of that article
5219 without displaying the article (@code{gnus-summary-goto-subject}).
5222 If Gnus asks you to press a key to confirm going to the next group, you
5223 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
5224 buffer, searching for the next group to read without actually returning
5225 to the group buffer.
5227 Variables related to summary movement:
5231 @vindex gnus-auto-select-next
5232 @item gnus-auto-select-next
5233 If you issue one of the movement commands (like @kbd{n}) and there are
5234 no more unread articles after the current one, Gnus will offer to go to
5235 the next group. If this variable is @code{t} and the next group is
5236 empty, Gnus will exit summary mode and return to the group buffer. If
5237 this variable is neither @code{t} nor @code{nil}, Gnus will select the
5238 next group with unread articles. As a special case, if this variable
5239 is @code{quietly}, Gnus will select the next group without asking for
5240 confirmation. If this variable is @code{almost-quietly}, the same
5241 will happen only if you are located on the last article in the group.
5242 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
5243 command will go to the next group without confirmation. Also
5244 @pxref{Group Levels}.
5246 @item gnus-auto-select-same
5247 @vindex gnus-auto-select-same
5248 If non-@code{nil}, all the movement commands will try to go to the next
5249 article with the same subject as the current. (@dfn{Same} here might
5250 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
5251 for details (@pxref{Customizing Threading}).) If there are no more
5252 articles with the same subject, go to the first unread article.
5254 This variable is not particularly useful if you use a threaded display.
5256 @item gnus-summary-check-current
5257 @vindex gnus-summary-check-current
5258 If non-@code{nil}, all the ``unread'' movement commands will not proceed
5259 to the next (or previous) article if the current article is unread.
5260 Instead, they will choose the current article.
5262 @item gnus-auto-center-summary
5263 @vindex gnus-auto-center-summary
5264 If non-@code{nil}, Gnus will keep the point in the summary buffer
5265 centered at all times. This makes things quite tidy, but if you have a
5266 slow network connection, or simply do not like this un-Emacsism, you can
5267 set this variable to @code{nil} to get the normal Emacs scrolling
5268 action. This will also inhibit horizontal re-centering of the summary
5269 buffer, which might make it more inconvenient to read extremely long
5272 This variable can also be a number. In that case, center the window at
5273 the given number of lines from the top.
5275 @item gnus-summary-stop-at-end-of-message
5276 @vindex gnus-summary-stop-at-end-of-message
5277 If non-@code{nil}, don't go to the next article when hitting
5278 @kbd{SPC}, and you're at the end of the article.
5283 @node Choosing Articles
5284 @section Choosing Articles
5285 @cindex selecting articles
5288 * Choosing Commands:: Commands for choosing articles.
5289 * Choosing Variables:: Variables that influence these commands.
5293 @node Choosing Commands
5294 @subsection Choosing Commands
5296 None of the following movement commands understand the numeric prefix,
5297 and they all select and display an article.
5299 If you want to fetch new articles or redisplay the group, see
5300 @ref{Exiting the Summary Buffer}.
5304 @kindex SPACE (Summary)
5305 @findex gnus-summary-next-page
5306 Select the current article, or, if that one's read already, the next
5307 unread article (@code{gnus-summary-next-page}).
5309 If you have an article window open already and you press @kbd{SPACE}
5310 again, the article will be scrolled. This lets you conveniently
5311 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5316 @kindex G n (Summary)
5317 @findex gnus-summary-next-unread-article
5318 @c @icon{gnus-summary-next-unread}
5319 Go to next unread article (@code{gnus-summary-next-unread-article}).
5324 @findex gnus-summary-prev-unread-article
5325 @c @icon{gnus-summary-prev-unread}
5326 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5331 @kindex G N (Summary)
5332 @findex gnus-summary-next-article
5333 Go to the next article (@code{gnus-summary-next-article}).
5338 @kindex G P (Summary)
5339 @findex gnus-summary-prev-article
5340 Go to the previous article (@code{gnus-summary-prev-article}).
5343 @kindex G C-n (Summary)
5344 @findex gnus-summary-next-same-subject
5345 Go to the next article with the same subject
5346 (@code{gnus-summary-next-same-subject}).
5349 @kindex G C-p (Summary)
5350 @findex gnus-summary-prev-same-subject
5351 Go to the previous article with the same subject
5352 (@code{gnus-summary-prev-same-subject}).
5356 @kindex G f (Summary)
5358 @findex gnus-summary-first-unread-article
5359 Go to the first unread article
5360 (@code{gnus-summary-first-unread-article}).
5364 @kindex G b (Summary)
5366 @findex gnus-summary-best-unread-article
5367 Go to the unread article with the highest score
5368 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5369 go to the first unread article that has a score over the default score.
5374 @kindex G l (Summary)
5375 @findex gnus-summary-goto-last-article
5376 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5379 @kindex G o (Summary)
5380 @findex gnus-summary-pop-article
5382 @cindex article history
5383 Pop an article off the summary history and go to this article
5384 (@code{gnus-summary-pop-article}). This command differs from the
5385 command above in that you can pop as many previous articles off the
5386 history as you like, while @kbd{l} toggles the two last read articles.
5387 For a somewhat related issue (if you use these commands a lot),
5388 @pxref{Article Backlog}.
5393 @kindex G j (Summary)
5394 @findex gnus-summary-goto-article
5395 Ask for an article number or @code{Message-ID}, and then go to that
5396 article (@code{gnus-summary-goto-article}).
5401 @node Choosing Variables
5402 @subsection Choosing Variables
5404 Some variables relevant for moving and selecting articles:
5407 @item gnus-auto-extend-newsgroup
5408 @vindex gnus-auto-extend-newsgroup
5409 All the movement commands will try to go to the previous (or next)
5410 article, even if that article isn't displayed in the Summary buffer if
5411 this variable is non-@code{nil}. Gnus will then fetch the article from
5412 the server and display it in the article buffer.
5414 @item gnus-select-article-hook
5415 @vindex gnus-select-article-hook
5416 This hook is called whenever an article is selected. The default is
5417 @code{nil}. If you would like each article to be saved in the Agent as
5418 you read it, putting @code{gnus-agent-fetch-selected-article} on this
5421 @item gnus-mark-article-hook
5422 @vindex gnus-mark-article-hook
5423 @findex gnus-summary-mark-unread-as-read
5424 @findex gnus-summary-mark-read-and-unread-as-read
5425 @findex gnus-unread-mark
5426 This hook is called whenever an article is selected. It is intended to
5427 be used for marking articles as read. The default value is
5428 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5429 mark of almost any article you read to @code{gnus-read-mark}. The only
5430 articles not affected by this function are ticked, dormant, and
5431 expirable articles. If you'd instead like to just have unread articles
5432 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5433 instead. It will leave marks like @code{gnus-low-score-mark},
5434 @code{gnus-del-mark} (and so on) alone.
5439 @node Paging the Article
5440 @section Scrolling the Article
5441 @cindex article scrolling
5446 @kindex SPACE (Summary)
5447 @findex gnus-summary-next-page
5448 Pressing @kbd{SPACE} will scroll the current article forward one page,
5449 or, if you have come to the end of the current article, will choose the
5450 next article (@code{gnus-summary-next-page}).
5452 @vindex gnus-article-boring-faces
5453 @vindex gnus-article-skip-boring
5454 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5455 the article consists only of citations and signature, then it will be
5456 skipped; the next article will be shown instead. You can customize
5457 what is considered uninteresting with
5458 @code{gnus-article-boring-faces}. You can manually view the article's
5459 pages, no matter how boring, using @kbd{C-M-v}.
5462 @kindex DEL (Summary)
5463 @findex gnus-summary-prev-page
5464 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5467 @kindex RET (Summary)
5468 @findex gnus-summary-scroll-up
5469 Scroll the current article one line forward
5470 (@code{gnus-summary-scroll-up}).
5473 @kindex M-RET (Summary)
5474 @findex gnus-summary-scroll-down
5475 Scroll the current article one line backward
5476 (@code{gnus-summary-scroll-down}).
5480 @kindex A g (Summary)
5482 @findex gnus-summary-show-article
5483 @vindex gnus-summary-show-article-charset-alist
5484 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5485 given a prefix, show a completely ``raw'' article, just the way it
5486 came from the server. If given a prefix twice (i.e., @kbd{C-u C-u
5487 g'}), fetch the current article, but don't run any of the article
5488 treatment functions.
5490 @cindex charset, view article with different charset
5491 If given a numerical prefix, you can do semi-manual charset stuff.
5492 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5493 encoded in the @code{cn-gb-2312} charset. If you have
5496 (setq gnus-summary-show-article-charset-alist
5501 then you can say @kbd{C-u 1 g} to get the same effect.
5506 @kindex A < (Summary)
5507 @findex gnus-summary-beginning-of-article
5508 Scroll to the beginning of the article
5509 (@code{gnus-summary-beginning-of-article}).
5514 @kindex A > (Summary)
5515 @findex gnus-summary-end-of-article
5516 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5520 @kindex A s (Summary)
5522 @findex gnus-summary-isearch-article
5523 Perform an isearch in the article buffer
5524 (@code{gnus-summary-isearch-article}).
5528 @findex gnus-summary-select-article-buffer
5529 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5534 @node Reply Followup and Post
5535 @section Reply, Followup and Post
5538 * Summary Mail Commands:: Sending mail.
5539 * Summary Post Commands:: Sending news.
5540 * Summary Message Commands:: Other Message-related commands.
5541 * Canceling and Superseding::
5545 @node Summary Mail Commands
5546 @subsection Summary Mail Commands
5548 @cindex composing mail
5550 Commands for composing a mail message:
5556 @kindex S r (Summary)
5558 @findex gnus-summary-reply
5559 @c @icon{gnus-summary-mail-reply}
5560 @c @icon{gnus-summary-reply}
5561 Mail a reply to the author of the current article
5562 (@code{gnus-summary-reply}).
5567 @kindex S R (Summary)
5568 @findex gnus-summary-reply-with-original
5569 @c @icon{gnus-summary-reply-with-original}
5570 Mail a reply to the author of the current article and include the
5571 original message (@code{gnus-summary-reply-with-original}). This
5572 command uses the process/prefix convention.
5575 @kindex S w (Summary)
5576 @findex gnus-summary-wide-reply
5577 Mail a wide reply to the author of the current article
5578 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5579 goes out to all people listed in the @code{To}, @code{From} (or
5580 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5581 present, that's used instead.
5584 @kindex S W (Summary)
5585 @findex gnus-summary-wide-reply-with-original
5586 Mail a wide reply to the current article and include the original
5587 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5588 the process/prefix convention, but only uses the headers from the
5589 first article to determine the recipients.
5592 @kindex S L (Summary)
5593 @findex gnus-summary-reply-to-list-with-original
5594 When replying to a message from a mailing list, send a reply to that
5595 message to the mailing list, and include the original message
5596 (@code{gnus-summary-reply-to-list-with-original}).
5599 @kindex S v (Summary)
5600 @findex gnus-summary-very-wide-reply
5601 Mail a very wide reply to the author of the current article
5602 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5603 that goes out to all people listed in the @code{To}, @code{From} (or
5604 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5605 articles. This command uses the process/prefix convention.
5608 @kindex S V (Summary)
5609 @findex gnus-summary-very-wide-reply-with-original
5610 Mail a very wide reply to the author of the current article and include the
5611 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5612 command uses the process/prefix convention.
5615 @kindex S B r (Summary)
5616 @findex gnus-summary-reply-broken-reply-to
5617 Mail a reply to the author of the current article but ignore the
5618 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5619 If you need this because a mailing list incorrectly sets a
5620 @code{Reply-To} header pointing to the list, you probably want to set
5621 the @code{broken-reply-to} group parameter instead, so things will work
5622 correctly. @xref{Group Parameters}.
5625 @kindex S B R (Summary)
5626 @findex gnus-summary-reply-broken-reply-to-with-original
5627 Mail a reply to the author of the current article and include the
5628 original message but ignore the @code{Reply-To} field
5629 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5633 @kindex S o m (Summary)
5634 @kindex C-c C-f (Summary)
5635 @findex gnus-summary-mail-forward
5636 @c @icon{gnus-summary-mail-forward}
5637 Forward the current article to some other person
5638 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
5639 is forwarded according to the value of (@code{message-forward-as-mime})
5640 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
5641 message and forward directly inline; if the prefix is 2, forward message
5642 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5643 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5644 directly inline; otherwise, the message is forwarded as no prefix given
5645 but use the flipped value of (@code{message-forward-as-mime}). By
5646 default, the message is decoded and forwarded as an rfc822 @acronym{MIME}
5652 @kindex S m (Summary)
5653 @findex gnus-summary-mail-other-window
5654 @c @icon{gnus-summary-mail-originate}
5655 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5656 the posting style of the current group. If given a prefix, disable that.
5657 If the prefix is 1, prompt for a group name to find the posting style.
5660 @kindex S i (Summary)
5661 @findex gnus-summary-news-other-window
5662 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5663 post to the current group. If given a prefix, disable that. If the
5664 prefix is 1, prompt for a group to post to.
5666 This function actually prepares a news even when using mail groups.
5667 This is useful for ``posting'' messages to mail groups without actually
5668 sending them over the network: they're just saved directly to the group
5669 in question. The corresponding back end must have a request-post method
5670 for this to work though.
5673 @kindex S D b (Summary)
5674 @findex gnus-summary-resend-bounced-mail
5675 @cindex bouncing mail
5676 If you have sent a mail, but the mail was bounced back to you for some
5677 reason (wrong address, transient failure), you can use this command to
5678 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5679 will be popped into a mail buffer where you can edit the headers before
5680 sending the mail off again. If you give a prefix to this command, and
5681 the bounced mail is a reply to some other mail, Gnus will try to fetch
5682 that mail and display it for easy perusal of its headers. This might
5683 very well fail, though.
5686 @kindex S D r (Summary)
5687 @findex gnus-summary-resend-message
5688 Not to be confused with the previous command,
5689 @code{gnus-summary-resend-message} will prompt you for an address to
5690 send the current message off to, and then send it to that place. The
5691 headers of the message won't be altered---but lots of headers that say
5692 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5693 means that you actually send a mail to someone that has a @code{To}
5694 header that (probably) points to yourself. This will confuse people.
5695 So, natcherly you'll only do that if you're really eVIl.
5697 This command is mainly used if you have several accounts and want to
5698 ship a mail to a different account of yours. (If you're both
5699 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5700 to the @code{root} account, you may want to resend it to
5701 @code{postmaster}. Ordnung muss sein!
5703 This command understands the process/prefix convention
5704 (@pxref{Process/Prefix}).
5707 @kindex S D e (Summary)
5708 @findex gnus-summary-resend-message-edit
5710 Like the previous command, but will allow you to edit the message as
5711 if it were a new message before resending.
5714 @kindex S O m (Summary)
5715 @findex gnus-uu-digest-mail-forward
5716 Digest the current series (@pxref{Decoding Articles}) and forward the
5717 result using mail (@code{gnus-uu-digest-mail-forward}). This command
5718 uses the process/prefix convention (@pxref{Process/Prefix}).
5721 @kindex S M-c (Summary)
5722 @findex gnus-summary-mail-crosspost-complaint
5723 @cindex crossposting
5724 @cindex excessive crossposting
5725 Send a complaint about excessive crossposting to the author of the
5726 current article (@code{gnus-summary-mail-crosspost-complaint}).
5728 @findex gnus-crosspost-complaint
5729 This command is provided as a way to fight back against the current
5730 crossposting pandemic that's sweeping Usenet. It will compose a reply
5731 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5732 command understands the process/prefix convention
5733 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5737 Also @xref{Header Commands, ,Header Commands, message, The Message
5738 Manual}, for more information.
5741 @node Summary Post Commands
5742 @subsection Summary Post Commands
5744 @cindex composing news
5746 Commands for posting a news article:
5752 @kindex S p (Summary)
5753 @findex gnus-summary-post-news
5754 @c @icon{gnus-summary-post-news}
5755 Prepare for posting an article (@code{gnus-summary-post-news}). By
5756 default, post to the current group. If given a prefix, disable that.
5757 If the prefix is 1, prompt for another group instead.
5762 @kindex S f (Summary)
5763 @findex gnus-summary-followup
5764 @c @icon{gnus-summary-followup}
5765 Post a followup to the current article (@code{gnus-summary-followup}).
5769 @kindex S F (Summary)
5771 @c @icon{gnus-summary-followup-with-original}
5772 @findex gnus-summary-followup-with-original
5773 Post a followup to the current article and include the original message
5774 (@code{gnus-summary-followup-with-original}). This command uses the
5775 process/prefix convention.
5778 @kindex S n (Summary)
5779 @findex gnus-summary-followup-to-mail
5780 Post a followup to the current article via news, even if you got the
5781 message through mail (@code{gnus-summary-followup-to-mail}).
5784 @kindex S N (Summary)
5785 @findex gnus-summary-followup-to-mail-with-original
5786 Post a followup to the current article via news, even if you got the
5787 message through mail and include the original message
5788 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5789 the process/prefix convention.
5792 @kindex S o p (Summary)
5793 @findex gnus-summary-post-forward
5794 Forward the current article to a newsgroup
5795 (@code{gnus-summary-post-forward}).
5796 If no prefix is given, the message is forwarded according to the value
5797 of (@code{message-forward-as-mime}) and
5798 (@code{message-forward-show-mml}); if the prefix is 1, decode the
5799 message and forward directly inline; if the prefix is 2, forward message
5800 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5801 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5802 directly inline; otherwise, the message is forwarded as no prefix given
5803 but use the flipped value of (@code{message-forward-as-mime}). By
5804 default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section.
5807 @kindex S O p (Summary)
5808 @findex gnus-uu-digest-post-forward
5810 @cindex making digests
5811 Digest the current series and forward the result to a newsgroup
5812 (@code{gnus-uu-digest-post-forward}). This command uses the
5813 process/prefix convention.
5816 @kindex S u (Summary)
5817 @findex gnus-uu-post-news
5818 @c @icon{gnus-uu-post-news}
5819 Uuencode a file, split it into parts, and post it as a series
5820 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5823 Also @xref{Header Commands, ,Header Commands, message, The Message
5824 Manual}, for more information.
5827 @node Summary Message Commands
5828 @subsection Summary Message Commands
5832 @kindex S y (Summary)
5833 @findex gnus-summary-yank-message
5834 Yank the current article into an already existing Message composition
5835 buffer (@code{gnus-summary-yank-message}). This command prompts for
5836 what message buffer you want to yank into, and understands the
5837 process/prefix convention (@pxref{Process/Prefix}).
5842 @node Canceling and Superseding
5843 @subsection Canceling Articles
5844 @cindex canceling articles
5845 @cindex superseding articles
5847 Have you ever written something, and then decided that you really,
5848 really, really wish you hadn't posted that?
5850 Well, you can't cancel mail, but you can cancel posts.
5852 @findex gnus-summary-cancel-article
5854 @c @icon{gnus-summary-cancel-article}
5855 Find the article you wish to cancel (you can only cancel your own
5856 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5857 c} (@code{gnus-summary-cancel-article}). Your article will be
5858 canceled---machines all over the world will be deleting your article.
5859 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5861 Be aware, however, that not all sites honor cancels, so your article may
5862 live on here and there, while most sites will delete the article in
5865 Gnus will use the ``current'' select method when canceling. If you
5866 want to use the standard posting method, use the @samp{a} symbolic
5867 prefix (@pxref{Symbolic Prefixes}).
5869 Gnus ensures that only you can cancel your own messages using a
5870 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5871 message, Message Manual}).
5873 If you discover that you have made some mistakes and want to do some
5874 corrections, you can post a @dfn{superseding} article that will replace
5875 your original article.
5877 @findex gnus-summary-supersede-article
5879 Go to the original article and press @kbd{S s}
5880 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5881 where you can edit the article all you want before sending it off the
5884 The same goes for superseding as for canceling, only more so: Some
5885 sites do not honor superseding. On those sites, it will appear that you
5886 have posted almost the same article twice.
5888 If you have just posted the article, and change your mind right away,
5889 there is a trick you can use to cancel/supersede the article without
5890 waiting for the article to appear on your site first. You simply return
5891 to the post buffer (which is called @code{*sent ...*}). There you will
5892 find the article you just posted, with all the headers intact. Change
5893 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5894 header by substituting one of those words for the word
5895 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5896 you would do normally. The previous article will be
5897 canceled/superseded.
5899 Just remember, kids: There is no 'c' in 'supersede'.
5901 @node Delayed Articles
5902 @section Delayed Articles
5903 @cindex delayed sending
5904 @cindex send delayed
5906 Sometimes, you might wish to delay the sending of a message. For
5907 example, you might wish to arrange for a message to turn up just in time
5908 to remind your about the birthday of your Significant Other. For this,
5909 there is the @code{gnus-delay} package. Setup is simple:
5912 (gnus-delay-initialize)
5915 @findex gnus-delay-article
5916 Normally, to send a message you use the @kbd{C-c C-c} command from
5917 Message mode. To delay a message, use @kbd{C-c C-j}
5918 (@code{gnus-delay-article}) instead. This will ask you for how long the
5919 message should be delayed. Possible answers are:
5923 A time span. Consists of an integer and a letter. For example,
5924 @code{42d} means to delay for 42 days. Available letters are @code{m}
5925 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5926 (months) and @code{Y} (years).
5929 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5930 delayed until that day, at a specific time (eight o'clock by default).
5931 See also @code{gnus-delay-default-hour}.
5934 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5935 stuff. The deadline will be at that time today, except if that time has
5936 already passed, then it's at the given time tomorrow. So if it's ten
5937 o'clock in the morning and you specify @code{11:15}, then the deadline
5938 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5939 that means a time tomorrow.
5942 The action of the @code{gnus-delay-article} command is influenced by a
5943 couple of variables:
5946 @item gnus-delay-default-hour
5947 @vindex gnus-delay-default-hour
5948 When you specify a specific date, the message will be due on that hour
5949 on the given date. Possible values are integers 0 through 23.
5951 @item gnus-delay-default-delay
5952 @vindex gnus-delay-default-delay
5953 This is a string and gives the default delay. It can be of any of the
5954 formats described above.
5956 @item gnus-delay-group
5957 @vindex gnus-delay-group
5958 Delayed articles will be kept in this group on the drafts server until
5959 they are due. You probably don't need to change this. The default
5960 value is @code{"delayed"}.
5962 @item gnus-delay-header
5963 @vindex gnus-delay-header
5964 The deadline for each article will be stored in a header. This variable
5965 is a string and gives the header name. You probably don't need to
5966 change this. The default value is @code{"X-Gnus-Delayed"}.
5969 The way delaying works is like this: when you use the
5970 @code{gnus-delay-article} command, you give a certain delay. Gnus
5971 calculates the deadline of the message and stores it in the
5972 @code{X-Gnus-Delayed} header and puts the message in the
5973 @code{nndraft:delayed} group.
5975 @findex gnus-delay-send-queue
5976 And whenever you get new news, Gnus looks through the group for articles
5977 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5978 function for this. By default, this function is added to the hook
5979 @code{gnus-get-new-news-hook}. But of course, you can change this.
5980 Maybe you want to use the demon to send drafts? Just tell the demon to
5981 execute the @code{gnus-delay-send-queue} function.
5984 @item gnus-delay-initialize
5985 @findex gnus-delay-initialize
5986 By default, this function installs @code{gnus-delay-send-queue} in
5987 @code{gnus-get-new-news-hook}. But it accepts the optional second
5988 argument @code{no-check}. If it is non-@code{nil},
5989 @code{gnus-get-new-news-hook} is not changed. The optional first
5990 argument is ignored.
5992 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5993 Presumably, you want to use the demon for sending due delayed articles.
5994 Just don't forget to set that up :-)
5997 When delaying an article with @kbd{C-c C-j}, Message mode will
5998 automatically add a @code{"Date"} header with the current time. In
5999 many cases you probably want the @code{"Date"} header to reflect the
6000 time the message is sent instead. To do this, you have to delete
6001 @code{Date} from @code{message-draft-headers}.
6004 @node Marking Articles
6005 @section Marking Articles
6006 @cindex article marking
6007 @cindex article ticking
6010 There are several marks you can set on an article.
6012 You have marks that decide the @dfn{readedness} (whoo, neato-keano
6013 neologism ohoy!) of the article. Alphabetic marks generally mean
6014 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
6016 In addition, you also have marks that do not affect readedness.
6019 There's a plethora of commands for manipulating these marks.
6023 * Unread Articles:: Marks for unread articles.
6024 * Read Articles:: Marks for read articles.
6025 * Other Marks:: Marks that do not affect readedness.
6026 * Setting Marks:: How to set and remove marks.
6027 * Generic Marking Commands:: How to customize the marking.
6028 * Setting Process Marks:: How to mark articles for later processing.
6032 @node Unread Articles
6033 @subsection Unread Articles
6035 The following marks mark articles as (kinda) unread, in one form or
6040 @vindex gnus-ticked-mark
6041 Marked as ticked (@code{gnus-ticked-mark}).
6043 @dfn{Ticked articles} are articles that will remain visible always. If
6044 you see an article that you find interesting, or you want to put off
6045 reading it, or replying to it, until sometime later, you'd typically
6046 tick it. However, articles can be expired (from news servers by the
6047 news server software, Gnus itself never expires ticked messages), so if
6048 you want to keep an article forever, you'll have to make it persistent
6049 (@pxref{Persistent Articles}).
6052 @vindex gnus-dormant-mark
6053 Marked as dormant (@code{gnus-dormant-mark}).
6055 @dfn{Dormant articles} will only appear in the summary buffer if there
6056 are followups to it. If you want to see them even if they don't have
6057 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
6058 Otherwise (except for the visibility issue), they are just like ticked
6062 @vindex gnus-unread-mark
6063 Marked as unread (@code{gnus-unread-mark}).
6065 @dfn{Unread articles} are articles that haven't been read at all yet.
6070 @subsection Read Articles
6071 @cindex expirable mark
6073 All the following marks mark articles as read.
6078 @vindex gnus-del-mark
6079 These are articles that the user has marked as read with the @kbd{d}
6080 command manually, more or less (@code{gnus-del-mark}).
6083 @vindex gnus-read-mark
6084 Articles that have actually been read (@code{gnus-read-mark}).
6087 @vindex gnus-ancient-mark
6088 Articles that were marked as read in previous sessions and are now
6089 @dfn{old} (@code{gnus-ancient-mark}).
6092 @vindex gnus-killed-mark
6093 Marked as killed (@code{gnus-killed-mark}).
6096 @vindex gnus-kill-file-mark
6097 Marked as killed by kill files (@code{gnus-kill-file-mark}).
6100 @vindex gnus-low-score-mark
6101 Marked as read by having too low a score (@code{gnus-low-score-mark}).
6104 @vindex gnus-catchup-mark
6105 Marked as read by a catchup (@code{gnus-catchup-mark}).
6108 @vindex gnus-canceled-mark
6109 Canceled article (@code{gnus-canceled-mark})
6112 @vindex gnus-sparse-mark
6113 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
6117 @vindex gnus-duplicate-mark
6118 Article marked as read by duplicate suppression
6119 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
6123 All these marks just mean that the article is marked as read, really.
6124 They are interpreted differently when doing adaptive scoring, though.
6126 One more special mark, though:
6130 @vindex gnus-expirable-mark
6131 Marked as expirable (@code{gnus-expirable-mark}).
6133 Marking articles as @dfn{expirable} (or have them marked as such
6134 automatically) doesn't make much sense in normal groups---a user doesn't
6135 control expiring of news articles, but in mail groups, for instance,
6136 articles marked as @dfn{expirable} can be deleted by Gnus at
6142 @subsection Other Marks
6143 @cindex process mark
6146 There are some marks that have nothing to do with whether the article is
6152 You can set a bookmark in the current article. Say you are reading a
6153 long thesis on cats' urinary tracts, and have to go home for dinner
6154 before you've finished reading the thesis. You can then set a bookmark
6155 in the article, and Gnus will jump to this bookmark the next time it
6156 encounters the article. @xref{Setting Marks}.
6159 @vindex gnus-replied-mark
6160 All articles that you have replied to or made a followup to (i.e., have
6161 answered) will be marked with an @samp{A} in the second column
6162 (@code{gnus-replied-mark}).
6165 @vindex gnus-forwarded-mark
6166 All articles that you have forwarded will be marked with an @samp{F} in
6167 the second column (@code{gnus-forwarded-mark}).
6170 @vindex gnus-cached-mark
6171 Articles stored in the article cache will be marked with an @samp{*} in
6172 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
6175 @vindex gnus-saved-mark
6176 Articles ``saved'' (in some manner or other; not necessarily
6177 religiously) are marked with an @samp{S} in the second column
6178 (@code{gnus-saved-mark}).
6181 @vindex gnus-unseen-mark
6182 Articles that haven't been seen before in Gnus by the user are marked
6183 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
6186 @vindex gnus-downloaded-mark
6187 When using the Gnus agent (@pxref{Agent Basics}), articles may be
6188 downloaded for unplugged (offline) viewing. If you are using the
6189 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
6190 (The variable @code{gnus-downloaded-mark} controls which character to
6194 @vindex gnus-undownloaded-mark
6195 When using the Gnus agent (@pxref{Agent Basics}), some articles might
6196 not have been downloaded. Such articles cannot be viewed while you
6197 are unplugged (offline). If you are using the @samp{%O} spec, these
6198 articles get the @samp{-} mark in that spec. (The variable
6199 @code{gnus-undownloaded-mark} controls which character to use.)
6202 @vindex gnus-downloadable-mark
6203 The Gnus agent (@pxref{Agent Basics}) downloads some articles
6204 automatically, but it is also possible to explicitly mark articles for
6205 download, even if they would not be downloaded automatically. Such
6206 explicitly-marked articles get the @samp{%} mark in the first column.
6207 (The variable @code{gnus-downloadable-mark} controls which character to
6211 @vindex gnus-not-empty-thread-mark
6212 @vindex gnus-empty-thread-mark
6213 If the @samp{%e} spec is used, the presence of threads or not will be
6214 marked with @code{gnus-not-empty-thread-mark} and
6215 @code{gnus-empty-thread-mark} in the third column, respectively.
6218 @vindex gnus-process-mark
6219 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
6220 variety of commands react to the presence of the process mark. For
6221 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
6222 all articles that have been marked with the process mark. Articles
6223 marked with the process mark have a @samp{#} in the second column.
6227 You might have noticed that most of these ``non-readedness'' marks
6228 appear in the second column by default. So if you have a cached, saved,
6229 replied article that you have process-marked, what will that look like?
6231 Nothing much. The precedence rules go as follows: process -> cache ->
6232 replied -> saved. So if the article is in the cache and is replied,
6233 you'll only see the cache mark and not the replied mark.
6237 @subsection Setting Marks
6238 @cindex setting marks
6240 All the marking commands understand the numeric prefix.
6245 @kindex M c (Summary)
6246 @kindex M-u (Summary)
6247 @findex gnus-summary-clear-mark-forward
6248 @cindex mark as unread
6249 Clear all readedness-marks from the current article
6250 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
6256 @kindex M t (Summary)
6257 @findex gnus-summary-tick-article-forward
6258 Tick the current article (@code{gnus-summary-tick-article-forward}).
6259 @xref{Article Caching}.
6264 @kindex M ? (Summary)
6265 @findex gnus-summary-mark-as-dormant
6266 Mark the current article as dormant
6267 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
6271 @kindex M d (Summary)
6273 @findex gnus-summary-mark-as-read-forward
6274 Mark the current article as read
6275 (@code{gnus-summary-mark-as-read-forward}).
6279 @findex gnus-summary-mark-as-read-backward
6280 Mark the current article as read and move point to the previous line
6281 (@code{gnus-summary-mark-as-read-backward}).
6286 @kindex M k (Summary)
6287 @findex gnus-summary-kill-same-subject-and-select
6288 Mark all articles that have the same subject as the current one as read,
6289 and then select the next unread article
6290 (@code{gnus-summary-kill-same-subject-and-select}).
6294 @kindex M K (Summary)
6295 @kindex C-k (Summary)
6296 @findex gnus-summary-kill-same-subject
6297 Mark all articles that have the same subject as the current one as read
6298 (@code{gnus-summary-kill-same-subject}).
6301 @kindex M C (Summary)
6302 @findex gnus-summary-catchup
6303 @c @icon{gnus-summary-catchup}
6304 Mark all unread articles as read (@code{gnus-summary-catchup}).
6307 @kindex M C-c (Summary)
6308 @findex gnus-summary-catchup-all
6309 Mark all articles in the group as read---even the ticked and dormant
6310 articles (@code{gnus-summary-catchup-all}).
6313 @kindex M H (Summary)
6314 @findex gnus-summary-catchup-to-here
6315 Catchup the current group to point (before the point)
6316 (@code{gnus-summary-catchup-to-here}).
6319 @kindex M h (Summary)
6320 @findex gnus-summary-catchup-from-here
6321 Catchup the current group from point (after the point)
6322 (@code{gnus-summary-catchup-from-here}).
6325 @kindex C-w (Summary)
6326 @findex gnus-summary-mark-region-as-read
6327 Mark all articles between point and mark as read
6328 (@code{gnus-summary-mark-region-as-read}).
6331 @kindex M V k (Summary)
6332 @findex gnus-summary-kill-below
6333 Kill all articles with scores below the default score (or below the
6334 numeric prefix) (@code{gnus-summary-kill-below}).
6338 @kindex M e (Summary)
6340 @findex gnus-summary-mark-as-expirable
6341 Mark the current article as expirable
6342 (@code{gnus-summary-mark-as-expirable}).
6345 @kindex M b (Summary)
6346 @findex gnus-summary-set-bookmark
6347 Set a bookmark in the current article
6348 (@code{gnus-summary-set-bookmark}).
6351 @kindex M B (Summary)
6352 @findex gnus-summary-remove-bookmark
6353 Remove the bookmark from the current article
6354 (@code{gnus-summary-remove-bookmark}).
6357 @kindex M V c (Summary)
6358 @findex gnus-summary-clear-above
6359 Clear all marks from articles with scores over the default score (or
6360 over the numeric prefix) (@code{gnus-summary-clear-above}).
6363 @kindex M V u (Summary)
6364 @findex gnus-summary-tick-above
6365 Tick all articles with scores over the default score (or over the
6366 numeric prefix) (@code{gnus-summary-tick-above}).
6369 @kindex M V m (Summary)
6370 @findex gnus-summary-mark-above
6371 Prompt for a mark, and mark all articles with scores over the default
6372 score (or over the numeric prefix) with this mark
6373 (@code{gnus-summary-clear-above}).
6376 @vindex gnus-summary-goto-unread
6377 The @code{gnus-summary-goto-unread} variable controls what action should
6378 be taken after setting a mark. If non-@code{nil}, point will move to
6379 the next/previous unread article. If @code{nil}, point will just move
6380 one line up or down. As a special case, if this variable is
6381 @code{never}, all the marking commands as well as other commands (like
6382 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6383 The default is @code{t}.
6386 @node Generic Marking Commands
6387 @subsection Generic Marking Commands
6389 Some people would like the command that ticks an article (@kbd{!}) to
6390 go to the next article. Others would like it to go to the next unread
6391 article. Yet others would like it to stay on the current article.
6392 And even though I haven't heard of anybody wanting it to go to the
6393 previous (unread) article, I'm sure there are people that want that as
6396 Multiply these five behaviors with five different marking commands, and
6397 you get a potentially complex set of variable to control what each
6400 To sidestep that mess, Gnus provides commands that do all these
6401 different things. They can be found on the @kbd{M M} map in the summary
6402 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6403 to list in this manual.
6405 While you can use these commands directly, most users would prefer
6406 altering the summary mode keymap. For instance, if you would like the
6407 @kbd{!} command to go to the next article instead of the next unread
6408 article, you could say something like:
6412 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6413 (defun my-alter-summary-map ()
6414 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6422 (defun my-alter-summary-map ()
6423 (local-set-key "!" "MM!n"))
6427 @node Setting Process Marks
6428 @subsection Setting Process Marks
6429 @cindex setting process marks
6431 Process marks are displayed as @code{#} in the summary buffer, and are
6432 used for marking articles in such a way that other commands will
6433 process these articles. For instance, if you process mark four
6434 articles and then use the @kbd{*} command, Gnus will enter these four
6435 articles into the cache. For more information,
6436 @pxref{Process/Prefix}.
6443 @kindex M P p (Summary)
6444 @findex gnus-summary-mark-as-processable
6445 Mark the current article with the process mark
6446 (@code{gnus-summary-mark-as-processable}).
6447 @findex gnus-summary-unmark-as-processable
6451 @kindex M P u (Summary)
6452 @kindex M-# (Summary)
6453 Remove the process mark, if any, from the current article
6454 (@code{gnus-summary-unmark-as-processable}).
6457 @kindex M P U (Summary)
6458 @findex gnus-summary-unmark-all-processable
6459 Remove the process mark from all articles
6460 (@code{gnus-summary-unmark-all-processable}).
6463 @kindex M P i (Summary)
6464 @findex gnus-uu-invert-processable
6465 Invert the list of process marked articles
6466 (@code{gnus-uu-invert-processable}).
6469 @kindex M P R (Summary)
6470 @findex gnus-uu-mark-by-regexp
6471 Mark articles that have a @code{Subject} header that matches a regular
6472 expression (@code{gnus-uu-mark-by-regexp}).
6475 @kindex M P G (Summary)
6476 @findex gnus-uu-unmark-by-regexp
6477 Unmark articles that have a @code{Subject} header that matches a regular
6478 expression (@code{gnus-uu-unmark-by-regexp}).
6481 @kindex M P r (Summary)
6482 @findex gnus-uu-mark-region
6483 Mark articles in region (@code{gnus-uu-mark-region}).
6486 @kindex M P g (Summary)
6487 @findex gnus-uu-unmark-region
6488 Unmark articles in region (@code{gnus-uu-unmark-region}).
6491 @kindex M P t (Summary)
6492 @findex gnus-uu-mark-thread
6493 Mark all articles in the current (sub)thread
6494 (@code{gnus-uu-mark-thread}).
6497 @kindex M P T (Summary)
6498 @findex gnus-uu-unmark-thread
6499 Unmark all articles in the current (sub)thread
6500 (@code{gnus-uu-unmark-thread}).
6503 @kindex M P v (Summary)
6504 @findex gnus-uu-mark-over
6505 Mark all articles that have a score above the prefix argument
6506 (@code{gnus-uu-mark-over}).
6509 @kindex M P s (Summary)
6510 @findex gnus-uu-mark-series
6511 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6514 @kindex M P S (Summary)
6515 @findex gnus-uu-mark-sparse
6516 Mark all series that have already had some articles marked
6517 (@code{gnus-uu-mark-sparse}).
6520 @kindex M P a (Summary)
6521 @findex gnus-uu-mark-all
6522 Mark all articles in series order (@code{gnus-uu-mark-all}).
6525 @kindex M P b (Summary)
6526 @findex gnus-uu-mark-buffer
6527 Mark all articles in the buffer in the order they appear
6528 (@code{gnus-uu-mark-buffer}).
6531 @kindex M P k (Summary)
6532 @findex gnus-summary-kill-process-mark
6533 Push the current process mark set onto the stack and unmark all articles
6534 (@code{gnus-summary-kill-process-mark}).
6537 @kindex M P y (Summary)
6538 @findex gnus-summary-yank-process-mark
6539 Pop the previous process mark set from the stack and restore it
6540 (@code{gnus-summary-yank-process-mark}).
6543 @kindex M P w (Summary)
6544 @findex gnus-summary-save-process-mark
6545 Push the current process mark set onto the stack
6546 (@code{gnus-summary-save-process-mark}).
6550 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6551 set process marks based on article body contents.
6558 It can be convenient to limit the summary buffer to just show some
6559 subset of the articles currently in the group. The effect most limit
6560 commands have is to remove a few (or many) articles from the summary
6563 Limiting commands work on subsets of the articles already fetched from
6564 the servers. These commands don't query the server for additional
6571 @kindex / / (Summary)
6572 @findex gnus-summary-limit-to-subject
6573 Limit the summary buffer to articles that match some subject
6574 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6578 @kindex / a (Summary)
6579 @findex gnus-summary-limit-to-author
6580 Limit the summary buffer to articles that match some author
6581 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6585 @kindex / R (Summary)
6586 @findex gnus-summary-limit-to-recipient
6587 Limit the summary buffer to articles that match some recipient
6588 (@code{gnus-summary-limit-to-recipient}). If given a prefix, exclude
6592 @kindex / A (Summary)
6593 @findex gnus-summary-limit-to-address
6594 Limit the summary buffer to articles in which contents of From, To or Cc
6595 header match a given address (@code{gnus-summary-limit-to-address}). If
6596 given a prefix, exclude matching articles.
6599 @kindex / S (Summary)
6600 @findex gnus-summary-limit-to-singletons
6601 Limit the summary buffer to articles that aren't part of any displayed
6602 threads (@code{gnus-summary-limit-to-singletons}). If given a prefix,
6603 limit to articles that are part of displayed threads.
6606 @kindex / x (Summary)
6607 @findex gnus-summary-limit-to-extra
6608 Limit the summary buffer to articles that match one of the ``extra''
6609 headers (@pxref{To From Newsgroups})
6610 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6615 @kindex / u (Summary)
6617 @findex gnus-summary-limit-to-unread
6618 Limit the summary buffer to articles not marked as read
6619 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6620 buffer to articles strictly unread. This means that ticked and
6621 dormant articles will also be excluded.
6624 @kindex / m (Summary)
6625 @findex gnus-summary-limit-to-marks
6626 Ask for a mark and then limit to all articles that have been marked
6627 with that mark (@code{gnus-summary-limit-to-marks}).
6630 @kindex / t (Summary)
6631 @findex gnus-summary-limit-to-age
6632 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6633 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6634 articles younger than that number of days.
6637 @kindex / n (Summary)
6638 @findex gnus-summary-limit-to-articles
6639 With prefix @samp{n}, limit the summary buffer to the next @samp{n}
6640 articles. If not given a prefix, use the process marked articles
6641 instead. (@code{gnus-summary-limit-to-articles}).
6644 @kindex / w (Summary)
6645 @findex gnus-summary-pop-limit
6646 Pop the previous limit off the stack and restore it
6647 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6651 @kindex / . (Summary)
6652 @findex gnus-summary-limit-to-unseen
6653 Limit the summary buffer to the unseen articles
6654 (@code{gnus-summary-limit-to-unseen}).
6657 @kindex / v (Summary)
6658 @findex gnus-summary-limit-to-score
6659 Limit the summary buffer to articles that have a score at or above some
6660 score (@code{gnus-summary-limit-to-score}).
6663 @kindex / p (Summary)
6664 @findex gnus-summary-limit-to-display-predicate
6665 Limit the summary buffer to articles that satisfy the @code{display}
6666 group parameter predicate
6667 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6668 Parameters}, for more on this predicate.
6671 @kindex / r (Summary)
6672 @findex gnus-summary-limit-to-replied
6673 Limit the summary buffer to replied articles
6674 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6679 @kindex M S (Summary)
6680 @kindex / E (Summary)
6681 @findex gnus-summary-limit-include-expunged
6682 Include all expunged articles in the limit
6683 (@code{gnus-summary-limit-include-expunged}).
6686 @kindex / D (Summary)
6687 @findex gnus-summary-limit-include-dormant
6688 Include all dormant articles in the limit
6689 (@code{gnus-summary-limit-include-dormant}).
6692 @kindex / * (Summary)
6693 @findex gnus-summary-limit-include-cached
6694 Include all cached articles in the limit
6695 (@code{gnus-summary-limit-include-cached}).
6698 @kindex / d (Summary)
6699 @findex gnus-summary-limit-exclude-dormant
6700 Exclude all dormant articles from the limit
6701 (@code{gnus-summary-limit-exclude-dormant}).
6704 @kindex / M (Summary)
6705 @findex gnus-summary-limit-exclude-marks
6706 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6709 @kindex / T (Summary)
6710 @findex gnus-summary-limit-include-thread
6711 Include all the articles in the current thread in the limit.
6714 @kindex / c (Summary)
6715 @findex gnus-summary-limit-exclude-childless-dormant
6716 Exclude all dormant articles that have no children from the limit@*
6717 (@code{gnus-summary-limit-exclude-childless-dormant}).
6720 @kindex / C (Summary)
6721 @findex gnus-summary-limit-mark-excluded-as-read
6722 Mark all excluded unread articles as read
6723 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6724 also mark excluded ticked and dormant articles as read.
6727 @kindex / b (Summary)
6728 @findex gnus-summary-limit-to-bodies
6729 Limit the summary buffer to articles that have bodies that match a
6730 certain regexp (@code{gnus-summary-limit-to-bodies}). If given a
6731 prefix, reverse the limit. This command is quite slow since it
6732 requires selecting each article to find the matches.
6735 @kindex / h (Summary)
6736 @findex gnus-summary-limit-to-headers
6737 Like the previous command, only limit to headers instead
6738 (@code{gnus-summary-limit-to-headers}).
6743 The following commands aren't limiting commands, but use the @kbd{/}
6748 @kindex / N (Summary)
6749 @findex gnus-summary-insert-new-articles
6750 Insert all new articles in the summary buffer. It scans for new emails
6751 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6754 @kindex / o (Summary)
6755 @findex gnus-summary-insert-old-articles
6756 Insert all old articles in the summary buffer. If given a numbered
6757 prefix, fetch this number of articles.
6765 @cindex article threading
6767 Gnus threads articles by default. @dfn{To thread} is to put responses
6768 to articles directly after the articles they respond to---in a
6769 hierarchical fashion.
6771 Threading is done by looking at the @code{References} headers of the
6772 articles. In a perfect world, this would be enough to build pretty
6773 trees, but unfortunately, the @code{References} header is often broken
6774 or simply missing. Weird news propagation exacerbates the problem,
6775 so one has to employ other heuristics to get pleasing results. A
6776 plethora of approaches exists, as detailed in horrible detail in
6777 @ref{Customizing Threading}.
6779 First, a quick overview of the concepts:
6783 The top-most article in a thread; the first article in the thread.
6786 A tree-like article structure.
6789 A small(er) section of this tree-like structure.
6792 Threads often lose their roots due to article expiry, or due to the root
6793 already having been read in a previous session, and not displayed in the
6794 summary buffer. We then typically have many sub-threads that really
6795 belong to one thread, but are without connecting roots. These are
6796 called loose threads.
6798 @item thread gathering
6799 An attempt to gather loose threads into bigger threads.
6801 @item sparse threads
6802 A thread where the missing articles have been ``guessed'' at, and are
6803 displayed as empty lines in the summary buffer.
6809 * Customizing Threading:: Variables you can change to affect the threading.
6810 * Thread Commands:: Thread based commands in the summary buffer.
6814 @node Customizing Threading
6815 @subsection Customizing Threading
6816 @cindex customizing threading
6819 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6820 * Filling In Threads:: Making the threads displayed look fuller.
6821 * More Threading:: Even more variables for fiddling with threads.
6822 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6827 @subsubsection Loose Threads
6830 @cindex loose threads
6833 @item gnus-summary-make-false-root
6834 @vindex gnus-summary-make-false-root
6835 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
6836 and create a dummy root at the top. (Wait a minute. Root at the top?
6837 Yup.) Loose subtrees occur when the real root has expired, or you've
6838 read or killed the root in a previous session.
6840 When there is no real root of a thread, Gnus will have to fudge
6841 something. This variable says what fudging method Gnus should use.
6842 There are four possible values:
6846 \gnusfigure{The Summary Buffer}{390}{
6847 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6848 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6849 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6850 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6855 @cindex adopting articles
6860 Gnus will make the first of the orphaned articles the parent. This
6861 parent will adopt all the other articles. The adopted articles will be
6862 marked as such by pointy brackets (@samp{<>}) instead of the standard
6863 square brackets (@samp{[]}). This is the default method.
6866 @vindex gnus-summary-dummy-line-format
6867 @vindex gnus-summary-make-false-root-always
6868 Gnus will create a dummy summary line that will pretend to be the
6869 parent. This dummy line does not correspond to any real article, so
6870 selecting it will just select the first real article after the dummy
6871 article. @code{gnus-summary-dummy-line-format} is used to specify the
6872 format of the dummy roots. It accepts only one format spec: @samp{S},
6873 which is the subject of the article. @xref{Formatting Variables}.
6874 If you want all threads to have a dummy root, even the non-gathered
6875 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6878 Gnus won't actually make any article the parent, but simply leave the
6879 subject field of all orphans except the first empty. (Actually, it will
6880 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6884 Don't make any article parent at all. Just gather the threads and
6885 display them after one another.
6888 Don't gather loose threads.
6891 @item gnus-summary-gather-subject-limit
6892 @vindex gnus-summary-gather-subject-limit
6893 Loose threads are gathered by comparing subjects of articles. If this
6894 variable is @code{nil}, Gnus requires an exact match between the
6895 subjects of the loose threads before gathering them into one big
6896 super-thread. This might be too strict a requirement, what with the
6897 presence of stupid newsreaders that chop off long subject lines. If
6898 you think so, set this variable to, say, 20 to require that only the
6899 first 20 characters of the subjects have to match. If you set this
6900 variable to a really low number, you'll find that Gnus will gather
6901 everything in sight into one thread, which isn't very helpful.
6903 @cindex fuzzy article gathering
6904 If you set this variable to the special value @code{fuzzy}, Gnus will
6905 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6908 @item gnus-simplify-subject-fuzzy-regexp
6909 @vindex gnus-simplify-subject-fuzzy-regexp
6910 This can either be a regular expression or list of regular expressions
6911 that match strings that will be removed from subjects if fuzzy subject
6912 simplification is used.
6914 @item gnus-simplify-ignored-prefixes
6915 @vindex gnus-simplify-ignored-prefixes
6916 If you set @code{gnus-summary-gather-subject-limit} to something as low
6917 as 10, you might consider setting this variable to something sensible:
6919 @c Written by Michael Ernst <mernst@cs.rice.edu>
6921 (setq gnus-simplify-ignored-prefixes
6927 "wanted" "followup" "summary\\( of\\)?"
6928 "help" "query" "problem" "question"
6929 "answer" "reference" "announce"
6930 "How can I" "How to" "Comparison of"
6935 (mapconcat 'identity
6936 '("for" "for reference" "with" "about")
6938 "\\)?\\]?:?[ \t]*"))
6941 All words that match this regexp will be removed before comparing two
6944 @item gnus-simplify-subject-functions
6945 @vindex gnus-simplify-subject-functions
6946 If non-@code{nil}, this variable overrides
6947 @code{gnus-summary-gather-subject-limit}. This variable should be a
6948 list of functions to apply to the @code{Subject} string iteratively to
6949 arrive at the simplified version of the string.
6951 Useful functions to put in this list include:
6954 @item gnus-simplify-subject-re
6955 @findex gnus-simplify-subject-re
6956 Strip the leading @samp{Re:}.
6958 @item gnus-simplify-subject-fuzzy
6959 @findex gnus-simplify-subject-fuzzy
6962 @item gnus-simplify-whitespace
6963 @findex gnus-simplify-whitespace
6964 Remove excessive whitespace.
6966 @item gnus-simplify-all-whitespace
6967 @findex gnus-simplify-all-whitespace
6968 Remove all whitespace.
6971 You may also write your own functions, of course.
6974 @item gnus-summary-gather-exclude-subject
6975 @vindex gnus-summary-gather-exclude-subject
6976 Since loose thread gathering is done on subjects only, that might lead
6977 to many false hits, especially with certain common subjects like
6978 @samp{} and @samp{(none)}. To make the situation slightly better,
6979 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6980 what subjects should be excluded from the gathering process.@*
6981 The default is @samp{^ *$\\|^(none)$}.
6983 @item gnus-summary-thread-gathering-function
6984 @vindex gnus-summary-thread-gathering-function
6985 Gnus gathers threads by looking at @code{Subject} headers. This means
6986 that totally unrelated articles may end up in the same ``thread'', which
6987 is confusing. An alternate approach is to look at all the
6988 @code{Message-ID}s in all the @code{References} headers to find matches.
6989 This will ensure that no gathered threads ever include unrelated
6990 articles, but it also means that people who have posted with broken
6991 newsreaders won't be gathered properly. The choice is yours---plague or
6995 @item gnus-gather-threads-by-subject
6996 @findex gnus-gather-threads-by-subject
6997 This function is the default gathering function and looks at
6998 @code{Subject}s exclusively.
7000 @item gnus-gather-threads-by-references
7001 @findex gnus-gather-threads-by-references
7002 This function looks at @code{References} headers exclusively.
7005 If you want to test gathering by @code{References}, you could say
7009 (setq gnus-summary-thread-gathering-function
7010 'gnus-gather-threads-by-references)
7016 @node Filling In Threads
7017 @subsubsection Filling In Threads
7020 @item gnus-fetch-old-headers
7021 @vindex gnus-fetch-old-headers
7022 If non-@code{nil}, Gnus will attempt to build old threads by fetching
7023 more old headers---headers to articles marked as read. If you would
7024 like to display as few summary lines as possible, but still connect as
7025 many loose threads as possible, you should set this variable to
7026 @code{some} or a number. If you set it to a number, no more than that
7027 number of extra old headers will be fetched. In either case, fetching
7028 old headers only works if the back end you are using carries overview
7029 files---this would normally be @code{nntp}, @code{nnspool},
7030 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
7031 the thread has been expired by the server, there's not much Gnus can
7034 This variable can also be set to @code{invisible}. This won't have any
7035 visible effects, but is useful if you use the @kbd{A T} command a lot
7036 (@pxref{Finding the Parent}).
7038 The server has to support @acronym{NOV} for any of this to work.
7040 @cindex Gmane, gnus-fetch-old-headers
7041 This feature can seriously impact performance it ignores all locally
7042 cached header entries. Setting it to @code{t} for groups for a server
7043 that doesn't expire articles (such as news.gmane.org), leads to very
7044 slow summary generation.
7046 @item gnus-fetch-old-ephemeral-headers
7047 @vindex gnus-fetch-old-ephemeral-headers
7048 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
7051 @item gnus-build-sparse-threads
7052 @vindex gnus-build-sparse-threads
7053 Fetching old headers can be slow. A low-rent similar effect can be
7054 gotten by setting this variable to @code{some}. Gnus will then look at
7055 the complete @code{References} headers of all articles and try to string
7056 together articles that belong in the same thread. This will leave
7057 @dfn{gaps} in the threading display where Gnus guesses that an article
7058 is missing from the thread. (These gaps appear like normal summary
7059 lines. If you select a gap, Gnus will try to fetch the article in
7060 question.) If this variable is @code{t}, Gnus will display all these
7061 ``gaps'' without regard for whether they are useful for completing the
7062 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
7063 off sparse leaf nodes that don't lead anywhere. This variable is
7064 @code{nil} by default.
7066 @item gnus-read-all-available-headers
7067 @vindex gnus-read-all-available-headers
7068 This is a rather obscure variable that few will find useful. It's
7069 intended for those non-news newsgroups where the back end has to fetch
7070 quite a lot to present the summary buffer, and where it's impossible to
7071 go back to parents of articles. This is mostly the case in the
7074 If you don't use those, then it's safe to leave this as the default
7075 @code{nil}. If you want to use this variable, it should be a regexp
7076 that matches the group name, or @code{t} for all groups.
7081 @node More Threading
7082 @subsubsection More Threading
7085 @item gnus-show-threads
7086 @vindex gnus-show-threads
7087 If this variable is @code{nil}, no threading will be done, and all of
7088 the rest of the variables here will have no effect. Turning threading
7089 off will speed group selection up a bit, but it is sure to make reading
7090 slower and more awkward.
7092 @item gnus-thread-hide-subtree
7093 @vindex gnus-thread-hide-subtree
7094 If non-@code{nil}, all threads will be hidden when the summary buffer is
7097 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
7098 Available predicates are @code{gnus-article-unread-p} and
7099 @code{gnus-article-unseen-p}.
7104 (setq gnus-thread-hide-subtree
7105 '(or gnus-article-unread-p
7106 gnus-article-unseen-p))
7109 (It's a pretty nonsensical example, since all unseen articles are also
7110 unread, but you get my drift.)
7113 @item gnus-thread-expunge-below
7114 @vindex gnus-thread-expunge-below
7115 All threads that have a total score (as defined by
7116 @code{gnus-thread-score-function}) less than this number will be
7117 expunged. This variable is @code{nil} by default, which means that no
7118 threads are expunged.
7120 @item gnus-thread-hide-killed
7121 @vindex gnus-thread-hide-killed
7122 if you kill a thread and this variable is non-@code{nil}, the subtree
7125 @item gnus-thread-ignore-subject
7126 @vindex gnus-thread-ignore-subject
7127 Sometimes somebody changes the subject in the middle of a thread. If
7128 this variable is non-@code{nil}, which is the default, the subject
7129 change is ignored. If it is @code{nil}, a change in the subject will
7130 result in a new thread.
7132 @item gnus-thread-indent-level
7133 @vindex gnus-thread-indent-level
7134 This is a number that says how much each sub-thread should be indented.
7137 @item gnus-sort-gathered-threads-function
7138 @vindex gnus-sort-gathered-threads-function
7139 Sometimes, particularly with mailing lists, the order in which mails
7140 arrive locally is not necessarily the same as the order in which they
7141 arrived on the mailing list. Consequently, when sorting sub-threads
7142 using the default @code{gnus-thread-sort-by-number}, responses can end
7143 up appearing before the article to which they are responding to.
7144 Setting this variable to an alternate value
7145 (e.g., @code{gnus-thread-sort-by-date}), in a group's parameters or in an
7146 appropriate hook (e.g., @code{gnus-summary-generate-hook}) can produce a
7147 more logical sub-thread ordering in such instances.
7152 @node Low-Level Threading
7153 @subsubsection Low-Level Threading
7157 @item gnus-parse-headers-hook
7158 @vindex gnus-parse-headers-hook
7159 Hook run before parsing any headers.
7161 @item gnus-alter-header-function
7162 @vindex gnus-alter-header-function
7163 If non-@code{nil}, this function will be called to allow alteration of
7164 article header structures. The function is called with one parameter,
7165 the article header vector, which it may alter in any way. For instance,
7166 if you have a mail-to-news gateway which alters the @code{Message-ID}s
7167 in systematic ways (by adding prefixes and such), you can use this
7168 variable to un-scramble the @code{Message-ID}s so that they are more
7169 meaningful. Here's one example:
7172 (setq gnus-alter-header-function 'my-alter-message-id)
7174 (defun my-alter-message-id (header)
7175 (let ((id (mail-header-id header)))
7177 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
7179 (concat (match-string 1 id) "@@" (match-string 2 id))
7186 @node Thread Commands
7187 @subsection Thread Commands
7188 @cindex thread commands
7194 @kindex T k (Summary)
7195 @kindex C-M-k (Summary)
7196 @findex gnus-summary-kill-thread
7197 Mark all articles in the current (sub-)thread as read
7198 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
7199 remove all marks instead. If the prefix argument is negative, tick
7204 @kindex T l (Summary)
7205 @kindex C-M-l (Summary)
7206 @findex gnus-summary-lower-thread
7207 Lower the score of the current (sub-)thread
7208 (@code{gnus-summary-lower-thread}).
7211 @kindex T i (Summary)
7212 @findex gnus-summary-raise-thread
7213 Increase the score of the current (sub-)thread
7214 (@code{gnus-summary-raise-thread}).
7217 @kindex T # (Summary)
7218 @findex gnus-uu-mark-thread
7219 Set the process mark on the current (sub-)thread
7220 (@code{gnus-uu-mark-thread}).
7223 @kindex T M-# (Summary)
7224 @findex gnus-uu-unmark-thread
7225 Remove the process mark from the current (sub-)thread
7226 (@code{gnus-uu-unmark-thread}).
7229 @kindex T T (Summary)
7230 @findex gnus-summary-toggle-threads
7231 Toggle threading (@code{gnus-summary-toggle-threads}).
7234 @kindex T s (Summary)
7235 @findex gnus-summary-show-thread
7236 Expose the (sub-)thread hidden under the current article, if any@*
7237 (@code{gnus-summary-show-thread}).
7240 @kindex T h (Summary)
7241 @findex gnus-summary-hide-thread
7242 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
7245 @kindex T S (Summary)
7246 @findex gnus-summary-show-all-threads
7247 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
7250 @kindex T H (Summary)
7251 @findex gnus-summary-hide-all-threads
7252 Hide all threads (@code{gnus-summary-hide-all-threads}).
7255 @kindex T t (Summary)
7256 @findex gnus-summary-rethread-current
7257 Re-thread the current article's thread
7258 (@code{gnus-summary-rethread-current}). This works even when the
7259 summary buffer is otherwise unthreaded.
7262 @kindex T ^ (Summary)
7263 @findex gnus-summary-reparent-thread
7264 Make the current article the child of the marked (or previous) article
7265 (@code{gnus-summary-reparent-thread}).
7268 @kindex T M-^ (Summary)
7269 @findex gnus-summary-reparent-children
7270 Make the current article the parent of the marked articles
7271 (@code{gnus-summary-reparent-children}).
7275 The following commands are thread movement commands. They all
7276 understand the numeric prefix.
7281 @kindex T n (Summary)
7283 @kindex C-M-n (Summary)
7285 @kindex M-down (Summary)
7286 @findex gnus-summary-next-thread
7287 Go to the next thread (@code{gnus-summary-next-thread}).
7290 @kindex T p (Summary)
7292 @kindex C-M-p (Summary)
7294 @kindex M-up (Summary)
7295 @findex gnus-summary-prev-thread
7296 Go to the previous thread (@code{gnus-summary-prev-thread}).
7299 @kindex T d (Summary)
7300 @findex gnus-summary-down-thread
7301 Descend the thread (@code{gnus-summary-down-thread}).
7304 @kindex T u (Summary)
7305 @findex gnus-summary-up-thread
7306 Ascend the thread (@code{gnus-summary-up-thread}).
7309 @kindex T o (Summary)
7310 @findex gnus-summary-top-thread
7311 Go to the top of the thread (@code{gnus-summary-top-thread}).
7314 @vindex gnus-thread-operation-ignore-subject
7315 If you ignore subject while threading, you'll naturally end up with
7316 threads that have several different subjects in them. If you then issue
7317 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
7318 wish to kill the entire thread, but just those parts of the thread that
7319 have the same subject as the current article. If you like this idea,
7320 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
7321 is non-@code{nil} (which it is by default), subjects will be ignored
7322 when doing thread commands. If this variable is @code{nil}, articles in
7323 the same thread with different subjects will not be included in the
7324 operation in question. If this variable is @code{fuzzy}, only articles
7325 that have subjects fuzzily equal will be included (@pxref{Fuzzy
7329 @node Sorting the Summary Buffer
7330 @section Sorting the Summary Buffer
7332 @findex gnus-thread-sort-by-total-score
7333 @findex gnus-thread-sort-by-date
7334 @findex gnus-thread-sort-by-score
7335 @findex gnus-thread-sort-by-subject
7336 @findex gnus-thread-sort-by-author
7337 @findex gnus-thread-sort-by-recipient
7338 @findex gnus-thread-sort-by-number
7339 @findex gnus-thread-sort-by-random
7340 @vindex gnus-thread-sort-functions
7341 @findex gnus-thread-sort-by-most-recent-number
7342 @findex gnus-thread-sort-by-most-recent-date
7343 If you are using a threaded summary display, you can sort the threads by
7344 setting @code{gnus-thread-sort-functions}, which can be either a single
7345 function, a list of functions, or a list containing functions and
7346 @code{(not some-function)} elements.
7348 By default, sorting is done on article numbers. Ready-made sorting
7349 predicate functions include @code{gnus-thread-sort-by-number},
7350 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-recipient},
7351 @code{gnus-thread-sort-by-subject},
7352 @code{gnus-thread-sort-by-date},
7353 @code{gnus-thread-sort-by-score},
7354 @code{gnus-thread-sort-by-most-recent-number},
7355 @code{gnus-thread-sort-by-most-recent-date},
7356 @code{gnus-thread-sort-by-random} and
7357 @code{gnus-thread-sort-by-total-score}.
7359 Each function takes two threads and returns non-@code{nil} if the first
7360 thread should be sorted before the other. Note that sorting really is
7361 normally done by looking only at the roots of each thread. Exceptions
7362 to this rule are @code{gnus-thread-sort-by-most-recent-number} and
7363 @code{gnus-thread-sort-by-most-recent-date}.
7365 If you use more than one function, the primary sort key should be the
7366 last function in the list. You should probably always include
7367 @code{gnus-thread-sort-by-number} in the list of sorting
7368 functions---preferably first. This will ensure that threads that are
7369 equal with respect to the other sort criteria will be displayed in
7370 ascending article order.
7372 If you would like to sort by reverse score, then by subject, and finally
7373 by number, you could do something like:
7376 (setq gnus-thread-sort-functions
7377 '(gnus-thread-sort-by-number
7378 gnus-thread-sort-by-subject
7379 (not gnus-thread-sort-by-total-score)))
7382 The threads that have highest score will be displayed first in the
7383 summary buffer. When threads have the same score, they will be sorted
7384 alphabetically. The threads that have the same score and the same
7385 subject will be sorted by number, which is (normally) the sequence in
7386 which the articles arrived.
7388 If you want to sort by score and then reverse arrival order, you could
7392 (setq gnus-thread-sort-functions
7393 '((not gnus-thread-sort-by-number)
7394 gnus-thread-sort-by-score))
7397 @vindex gnus-thread-score-function
7398 The function in the @code{gnus-thread-score-function} variable (default
7399 @code{+}) is used for calculating the total score of a thread. Useful
7400 functions might be @code{max}, @code{min}, or squared means, or whatever
7403 @findex gnus-article-sort-functions
7404 @findex gnus-article-sort-by-date
7405 @findex gnus-article-sort-by-most-recent-date
7406 @findex gnus-article-sort-by-score
7407 @findex gnus-article-sort-by-subject
7408 @findex gnus-article-sort-by-author
7409 @findex gnus-article-sort-by-random
7410 @findex gnus-article-sort-by-number
7411 @findex gnus-article-sort-by-most-recent-number
7412 If you are using an unthreaded display for some strange reason or
7413 other, you have to fiddle with the @code{gnus-article-sort-functions}
7414 variable. It is very similar to the
7415 @code{gnus-thread-sort-functions}, except that it uses slightly
7416 different functions for article comparison. Available sorting
7417 predicate functions are @code{gnus-article-sort-by-number},
7418 @code{gnus-article-sort-by-author},
7419 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7420 @code{gnus-article-sort-by-random}, and
7421 @code{gnus-article-sort-by-score}.
7423 If you want to sort an unthreaded summary display by subject, you could
7427 (setq gnus-article-sort-functions
7428 '(gnus-article-sort-by-number
7429 gnus-article-sort-by-subject))
7432 You can define group specific sorting via @code{gnus-parameters},
7433 @xref{Group Parameters}.
7436 @node Asynchronous Fetching
7437 @section Asynchronous Article Fetching
7438 @cindex asynchronous article fetching
7439 @cindex article pre-fetch
7442 If you read your news from an @acronym{NNTP} server that's far away, the
7443 network latencies may make reading articles a chore. You have to wait
7444 for a while after pressing @kbd{n} to go to the next article before the
7445 article appears. Why can't Gnus just go ahead and fetch the article
7446 while you are reading the previous one? Why not, indeed.
7448 First, some caveats. There are some pitfalls to using asynchronous
7449 article fetching, especially the way Gnus does it.
7451 Let's say you are reading article 1, which is short, and article 2 is
7452 quite long, and you are not interested in reading that. Gnus does not
7453 know this, so it goes ahead and fetches article 2. You decide to read
7454 article 3, but since Gnus is in the process of fetching article 2, the
7455 connection is blocked.
7457 To avoid these situations, Gnus will open two (count 'em two)
7458 connections to the server. Some people may think this isn't a very nice
7459 thing to do, but I don't see any real alternatives. Setting up that
7460 extra connection takes some time, so Gnus startup will be slower.
7462 Gnus will fetch more articles than you will read. This will mean that
7463 the link between your machine and the @acronym{NNTP} server will become more
7464 loaded than if you didn't use article pre-fetch. The server itself will
7465 also become more loaded---both with the extra article requests, and the
7468 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7471 @vindex gnus-asynchronous
7472 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7473 happen automatically.
7475 @vindex gnus-use-article-prefetch
7476 You can control how many articles are to be pre-fetched by setting
7477 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7478 that when you read an article in the group, the back end will pre-fetch
7479 the next 30 articles. If this variable is @code{t}, the back end will
7480 pre-fetch all the articles it can without bound. If it is
7481 @code{nil}, no pre-fetching will be done.
7483 @vindex gnus-async-prefetch-article-p
7484 @findex gnus-async-unread-p
7485 There are probably some articles that you don't want to pre-fetch---read
7486 articles, for instance. The @code{gnus-async-prefetch-article-p}
7487 variable controls whether an article is to be pre-fetched. This
7488 function should return non-@code{nil} when the article in question is
7489 to be pre-fetched. The default is @code{gnus-async-unread-p}, which
7490 returns @code{nil} on read articles. The function is called with an
7491 article data structure as the only parameter.
7493 If, for instance, you wish to pre-fetch only unread articles shorter
7494 than 100 lines, you could say something like:
7497 (defun my-async-short-unread-p (data)
7498 "Return non-nil for short, unread articles."
7499 (and (gnus-data-unread-p data)
7500 (< (mail-header-lines (gnus-data-header data))
7503 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7506 These functions will be called many, many times, so they should
7507 preferably be short and sweet to avoid slowing down Gnus too much.
7508 It's probably a good idea to byte-compile things like this.
7510 @vindex gnus-async-post-fetch-function
7511 @findex gnus-html-prefetch-images
7512 After an article has been prefetched, this
7513 @code{gnus-async-post-fetch-function} will be called. The buffer will
7514 be narrowed to the region of the article that was fetched. A useful
7515 value would be @code{gnus-html-prefetch-images}, which will prefetch
7516 and store images referenced in the article, so that you don't have to
7517 wait for them to be fetched when you read the article. This is useful
7518 for @acronym{HTML} messages that have external images.
7520 @vindex gnus-prefetched-article-deletion-strategy
7521 Articles have to be removed from the asynch buffer sooner or later. The
7522 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7523 articles. This is a list that may contain the following elements:
7527 Remove articles when they are read.
7530 Remove articles when exiting the group.
7533 The default value is @code{(read exit)}.
7535 @c @vindex gnus-use-header-prefetch
7536 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7537 @c from the next group.
7540 @node Article Caching
7541 @section Article Caching
7542 @cindex article caching
7545 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7546 consider turning article caching on. Each article will then be stored
7547 locally under your home directory. As you may surmise, this could
7548 potentially use @emph{huge} amounts of disk space, as well as eat up all
7549 your inodes so fast it will make your head swim. In vodka.
7551 Used carefully, though, it could be just an easier way to save articles.
7553 @vindex gnus-use-long-file-name
7554 @vindex gnus-cache-directory
7555 @vindex gnus-use-cache
7556 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7557 all articles ticked or marked as dormant will then be copied
7558 over to your local cache (@code{gnus-cache-directory}). Whether this
7559 cache is flat or hierarchical is controlled by the
7560 @code{gnus-use-long-file-name} variable, as usual.
7562 When re-selecting a ticked or dormant article, it will be fetched from the
7563 cache instead of from the server. As articles in your cache will never
7564 expire, this might serve as a method of saving articles while still
7565 keeping them where they belong. Just mark all articles you want to save
7566 as dormant, and don't worry.
7568 When an article is marked as read, is it removed from the cache.
7570 @vindex gnus-cache-remove-articles
7571 @vindex gnus-cache-enter-articles
7572 The entering/removal of articles from the cache is controlled by the
7573 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7574 variables. Both are lists of symbols. The first is @code{(ticked
7575 dormant)} by default, meaning that ticked and dormant articles will be
7576 put in the cache. The latter is @code{(read)} by default, meaning that
7577 articles marked as read are removed from the cache. Possibly
7578 symbols in these two lists are @code{ticked}, @code{dormant},
7579 @code{unread} and @code{read}.
7581 @findex gnus-jog-cache
7582 So where does the massive article-fetching and storing come into the
7583 picture? The @code{gnus-jog-cache} command will go through all
7584 subscribed newsgroups, request all unread articles, score them, and
7585 store them in the cache. You should only ever, ever ever ever, use this
7586 command if 1) your connection to the @acronym{NNTP} server is really, really,
7587 really slow and 2) you have a really, really, really huge disk.
7588 Seriously. One way to cut down on the number of articles downloaded is
7589 to score unwanted articles down and have them marked as read. They will
7590 not then be downloaded by this command.
7592 @vindex gnus-uncacheable-groups
7593 @vindex gnus-cacheable-groups
7594 It is likely that you do not want caching on all groups. For instance,
7595 if your @code{nnml} mail is located under your home directory, it makes no
7596 sense to cache it somewhere else under your home directory. Unless you
7597 feel that it's neat to use twice as much space.
7599 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7600 regexp of groups to cache, @samp{^nntp} for instance, or set the
7601 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7602 Both variables are @code{nil} by default. If a group matches both
7603 variables, the group is not cached.
7605 @findex gnus-cache-generate-nov-databases
7606 @findex gnus-cache-generate-active
7607 @vindex gnus-cache-active-file
7608 The cache stores information on what articles it contains in its active
7609 file (@code{gnus-cache-active-file}). If this file (or any other parts
7610 of the cache) becomes all messed up for some reason or other, Gnus
7611 offers two functions that will try to set things right. @kbd{M-x
7612 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7613 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7616 @findex gnus-cache-move-cache
7617 @code{gnus-cache-move-cache} will move your whole
7618 @code{gnus-cache-directory} to some other location. You get asked to
7619 where, isn't that cool?
7621 @node Persistent Articles
7622 @section Persistent Articles
7623 @cindex persistent articles
7625 Closely related to article caching, we have @dfn{persistent articles}.
7626 In fact, it's just a different way of looking at caching, and much more
7627 useful in my opinion.
7629 Say you're reading a newsgroup, and you happen on to some valuable gem
7630 that you want to keep and treasure forever. You'd normally just save it
7631 (using one of the many saving commands) in some file. The problem with
7632 that is that it's just, well, yucky. Ideally you'd prefer just having
7633 the article remain in the group where you found it forever; untouched by
7634 the expiry going on at the news server.
7636 This is what a @dfn{persistent article} is---an article that just won't
7637 be deleted. It's implemented using the normal cache functions, but
7638 you use two explicit commands for managing persistent articles:
7644 @findex gnus-cache-enter-article
7645 Make the current article persistent (@code{gnus-cache-enter-article}).
7648 @kindex M-* (Summary)
7649 @findex gnus-cache-remove-article
7650 Remove the current article from the persistent articles
7651 (@code{gnus-cache-remove-article}). This will normally delete the
7655 Both these commands understand the process/prefix convention.
7657 To avoid having all ticked articles (and stuff) entered into the cache,
7658 you should set @code{gnus-use-cache} to @code{passive} if you're just
7659 interested in persistent articles:
7662 (setq gnus-use-cache 'passive)
7665 @node Sticky Articles
7666 @section Sticky Articles
7667 @cindex sticky articles
7669 When you select an article the current article buffer will be reused
7670 according to the value of the variable
7671 @code{gnus-single-article-buffer}. If its value is non-@code{nil} (the
7672 default) all articles reuse the same article buffer. Else each group
7673 has its own article buffer.
7675 This implies that it's not possible to have more than one article buffer
7676 in a group at a time. But sometimes you might want to display all the
7677 latest emails from your mother, your father, your aunt, your uncle and
7678 your 17 cousins to coordinate the next Christmas party.
7680 That's where sticky articles come in handy. A sticky article buffer
7681 basically is a normal article buffer, but it won't be reused when you
7682 select another article. You can make an article sticky with:
7686 @kindex A S (Summary)
7687 @findex gnus-sticky-article
7688 Make the current article sticky. If a prefix arg is given, ask for a
7689 name for this sticky article buffer.
7692 To close a sticky article buffer you can use these commands:
7698 Puts this sticky article buffer at the end of the list of all buffers.
7702 @findex gnus-kill-sticky-article-buffer
7703 Kills this sticky article buffer.
7706 To kill all sticky article buffers you can use:
7708 @defun gnus-kill-sticky-article-buffers ARG
7709 Kill all sticky article buffers.
7710 If a prefix ARG is given, ask for confirmation.
7713 @node Article Backlog
7714 @section Article Backlog
7716 @cindex article backlog
7718 If you have a slow connection, but the idea of using caching seems
7719 unappealing to you (and it is, really), you can help the situation some
7720 by switching on the @dfn{backlog}. This is where Gnus will buffer
7721 already read articles so that it doesn't have to re-fetch articles
7722 you've already read. This only helps if you are in the habit of
7723 re-selecting articles you've recently read, of course. If you never do
7724 that, turning the backlog on will slow Gnus down a little bit, and
7725 increase memory usage some.
7727 @vindex gnus-keep-backlog
7728 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
7729 at most @var{n} old articles in a buffer for later re-fetching. If this
7730 variable is non-@code{nil} and is not a number, Gnus will store
7731 @emph{all} read articles, which means that your Emacs will grow without
7732 bound before exploding and taking your machine down with you. I put
7733 that in there just to keep y'all on your toes.
7735 The default value is 20.
7738 @node Saving Articles
7739 @section Saving Articles
7740 @cindex saving articles
7742 Gnus can save articles in a number of ways. Below is the documentation
7743 for saving articles in a fairly straight-forward fashion (i.e., little
7744 processing of the article is done before it is saved). For a different
7745 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7746 (@pxref{Decoding Articles}).
7748 For the commands listed here, the target is a file. If you want to
7749 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7750 command (@pxref{Mail Group Commands}).
7752 @vindex gnus-save-all-headers
7753 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
7754 unwanted headers before saving the article.
7756 @vindex gnus-saved-headers
7757 If the preceding variable is @code{nil}, all headers that match the
7758 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7759 deleted before saving.
7765 @kindex O o (Summary)
7767 @findex gnus-summary-save-article
7768 @c @icon{gnus-summary-save-article}
7769 Save the current article using the default article saver
7770 (@code{gnus-summary-save-article}).
7773 @kindex O m (Summary)
7774 @findex gnus-summary-save-article-mail
7775 Save the current article in a Unix mail box (mbox) file
7776 (@code{gnus-summary-save-article-mail}).
7779 @kindex O r (Summary)
7780 @findex gnus-summary-save-article-rmail
7781 Save the current article in Rmail format
7782 (@code{gnus-summary-save-article-rmail}). This is mbox since Emacs 23,
7783 Babyl in older versions.
7786 @kindex O f (Summary)
7787 @findex gnus-summary-save-article-file
7788 @c @icon{gnus-summary-save-article-file}
7789 Save the current article in plain file format
7790 (@code{gnus-summary-save-article-file}).
7793 @kindex O F (Summary)
7794 @findex gnus-summary-write-article-file
7795 Write the current article in plain file format, overwriting any previous
7796 file contents (@code{gnus-summary-write-article-file}).
7799 @kindex O b (Summary)
7800 @findex gnus-summary-save-article-body-file
7801 Save the current article body in plain file format
7802 (@code{gnus-summary-save-article-body-file}).
7805 @kindex O h (Summary)
7806 @findex gnus-summary-save-article-folder
7807 Save the current article in mh folder format
7808 (@code{gnus-summary-save-article-folder}).
7811 @kindex O v (Summary)
7812 @findex gnus-summary-save-article-vm
7813 Save the current article in a VM folder
7814 (@code{gnus-summary-save-article-vm}).
7818 @kindex O p (Summary)
7820 @findex gnus-summary-pipe-output
7821 @vindex gnus-summary-pipe-output-default-command
7822 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7823 the current article to a process (@code{gnus-summary-pipe-output}).
7824 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7825 complete headers in the piped output. The symbolic prefix @code{r} is
7826 special; it lets this command pipe a raw article including all headers.
7827 The @code{gnus-summary-pipe-output-default-command} variable can be set
7828 to a string containing the default command and options (default
7832 @kindex O P (Summary)
7833 @findex gnus-summary-muttprint
7834 @vindex gnus-summary-muttprint-program
7835 Save the current article into muttprint. That is, print it using the
7836 external program @uref{http://muttprint.sourceforge.net/,
7837 Muttprint}. The program name and options to use is controlled by the
7838 variable @code{gnus-summary-muttprint-program}.
7839 (@code{gnus-summary-muttprint}).
7843 @vindex gnus-prompt-before-saving
7844 All these commands use the process/prefix convention
7845 (@pxref{Process/Prefix}). If you save bunches of articles using these
7846 functions, you might get tired of being prompted for files to save each
7847 and every article in. The prompting action is controlled by
7848 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7849 default, giving you that excessive prompting action you know and
7850 loathe. If you set this variable to @code{t} instead, you'll be prompted
7851 just once for each series of articles you save. If you like to really
7852 have Gnus do all your thinking for you, you can even set this variable
7853 to @code{nil}, which means that you will never be prompted for files to
7854 save articles in. Gnus will simply save all the articles in the default
7858 @vindex gnus-default-article-saver
7859 You can customize the @code{gnus-default-article-saver} variable to make
7860 Gnus do what you want it to. You can use any of the eight ready-made
7861 functions below, or you can create your own.
7865 @item gnus-summary-save-in-rmail
7866 @findex gnus-summary-save-in-rmail
7867 @vindex gnus-rmail-save-name
7868 @findex gnus-plain-save-name
7869 This is the default format, that used by the Rmail package. Since Emacs
7870 23, Rmail uses standard mbox format. Before this, it used the
7871 @dfn{Babyl} format. Accordingly, this command writes mbox format since
7872 Emacs 23, unless appending to an existing Babyl file. In older versions
7873 of Emacs, it always uses Babyl format. Uses the function in the
7874 @code{gnus-rmail-save-name} variable to get a file name to save the
7875 article in. The default is @code{gnus-plain-save-name}.
7877 @item gnus-summary-save-in-mail
7878 @findex gnus-summary-save-in-mail
7879 @vindex gnus-mail-save-name
7880 Save in a Unix mail (mbox) file. Uses the function in the
7881 @code{gnus-mail-save-name} variable to get a file name to save the
7882 article in. The default is @code{gnus-plain-save-name}.
7884 @item gnus-summary-save-in-file
7885 @findex gnus-summary-save-in-file
7886 @vindex gnus-file-save-name
7887 @findex gnus-numeric-save-name
7888 Append the article straight to an ordinary file. Uses the function in
7889 the @code{gnus-file-save-name} variable to get a file name to save the
7890 article in. The default is @code{gnus-numeric-save-name}.
7892 @item gnus-summary-write-to-file
7893 @findex gnus-summary-write-to-file
7894 Write the article straight to an ordinary file. The file is
7895 overwritten if it exists. Uses the function in the
7896 @code{gnus-file-save-name} variable to get a file name to save the
7897 article in. The default is @code{gnus-numeric-save-name}.
7899 @item gnus-summary-save-body-in-file
7900 @findex gnus-summary-save-body-in-file
7901 Append the article body to an ordinary file. Uses the function in the
7902 @code{gnus-file-save-name} variable to get a file name to save the
7903 article in. The default is @code{gnus-numeric-save-name}.
7905 @item gnus-summary-write-body-to-file
7906 @findex gnus-summary-write-body-to-file
7907 Write the article body straight to an ordinary file. The file is
7908 overwritten if it exists. Uses the function in the
7909 @code{gnus-file-save-name} variable to get a file name to save the
7910 article in. The default is @code{gnus-numeric-save-name}.
7912 @item gnus-summary-save-in-folder
7913 @findex gnus-summary-save-in-folder
7914 @findex gnus-folder-save-name
7915 @findex gnus-Folder-save-name
7916 @vindex gnus-folder-save-name
7919 Save the article to an MH folder using @code{rcvstore} from the MH
7920 library. Uses the function in the @code{gnus-folder-save-name} variable
7921 to get a file name to save the article in. The default is
7922 @code{gnus-folder-save-name}, but you can also use
7923 @code{gnus-Folder-save-name}, which creates capitalized names.
7925 @item gnus-summary-save-in-vm
7926 @findex gnus-summary-save-in-vm
7927 Save the article in a VM folder. You have to have the VM mail
7928 reader to use this setting.
7930 @item gnus-summary-save-in-pipe
7931 @findex gnus-summary-save-in-pipe
7932 Pipe the article to a shell command. This function takes optional two
7933 arguments COMMAND and RAW@. Valid values for COMMAND include:
7937 The executable command name and possibly arguments.
7939 You will be prompted for the command in the minibuffer.
7940 @item the symbol @code{default}@*
7941 It will be replaced with the command which the variable
7942 @code{gnus-summary-pipe-output-default-command} holds or the command
7943 last used for saving.
7946 Non-@code{nil} value for RAW overrides @code{:decode} and
7947 @code{:headers} properties (see below) and the raw article including all
7948 headers will be piped.
7951 The symbol of each function may have the following properties:
7955 The value non-@code{nil} means save decoded articles. This is
7956 meaningful only with @code{gnus-summary-save-in-file},
7957 @code{gnus-summary-save-body-in-file},
7958 @code{gnus-summary-write-to-file},
7959 @code{gnus-summary-write-body-to-file}, and
7960 @code{gnus-summary-save-in-pipe}.
7963 The value specifies an alternative function which appends, not
7964 overwrites, articles to a file. This implies that when saving many
7965 articles at a time, @code{gnus-prompt-before-saving} is bound to
7966 @code{t} and all articles are saved in a single file. This is
7967 meaningful only with @code{gnus-summary-write-to-file} and
7968 @code{gnus-summary-write-body-to-file}.
7971 The value specifies the symbol of a variable of which the value
7972 specifies headers to be saved. If it is omitted,
7973 @code{gnus-save-all-headers} and @code{gnus-saved-headers} control what
7974 headers should be saved.
7977 @vindex gnus-article-save-directory
7978 All of these functions, except for the last one, will save the article
7979 in the @code{gnus-article-save-directory}, which is initialized from the
7980 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7983 As you can see above, the functions use different functions to find a
7984 suitable name of a file to save the article in. Below is a list of
7985 available functions that generate names:
7989 @item gnus-Numeric-save-name
7990 @findex gnus-Numeric-save-name
7991 File names like @file{~/News/Alt.andrea-dworkin/45}.
7993 @item gnus-numeric-save-name
7994 @findex gnus-numeric-save-name
7995 File names like @file{~/News/alt.andrea-dworkin/45}.
7997 @item gnus-Plain-save-name
7998 @findex gnus-Plain-save-name
7999 File names like @file{~/News/Alt.andrea-dworkin}.
8001 @item gnus-plain-save-name
8002 @findex gnus-plain-save-name
8003 File names like @file{~/News/alt.andrea-dworkin}.
8005 @item gnus-sender-save-name
8006 @findex gnus-sender-save-name
8007 File names like @file{~/News/larsi}.
8010 @vindex gnus-split-methods
8011 You can have Gnus suggest where to save articles by plonking a regexp into
8012 the @code{gnus-split-methods} alist. For instance, if you would like to
8013 save articles related to Gnus in the file @file{gnus-stuff}, and articles
8014 related to VM in @file{vm-stuff}, you could set this variable to something
8018 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
8019 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
8020 (my-choosing-function "../other-dir/my-stuff")
8021 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
8024 We see that this is a list where each element is a list that has two
8025 elements---the @dfn{match} and the @dfn{file}. The match can either be
8026 a string (in which case it is used as a regexp to match on the article
8027 head); it can be a symbol (which will be called as a function with the
8028 group name as a parameter); or it can be a list (which will be
8029 @code{eval}ed). If any of these actions have a non-@code{nil} result,
8030 the @dfn{file} will be used as a default prompt. In addition, the
8031 result of the operation itself will be used if the function or form
8032 called returns a string or a list of strings.
8034 You basically end up with a list of file names that might be used when
8035 saving the current article. (All ``matches'' will be used.) You will
8036 then be prompted for what you really want to use as a name, with file
8037 name completion over the results from applying this variable.
8039 This variable is @code{((gnus-article-archive-name))} by default, which
8040 means that Gnus will look at the articles it saves for an
8041 @code{Archive-name} line and use that as a suggestion for the file
8044 Here's an example function to clean up file names somewhat. If you have
8045 lots of mail groups called things like
8046 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
8047 these group names before creating the file name to save to. The
8048 following will do just that:
8051 (defun my-save-name (group)
8052 (when (string-match "^nnml:mail." group)
8053 (substring group (match-end 0))))
8055 (setq gnus-split-methods
8056 '((gnus-article-archive-name)
8061 @vindex gnus-use-long-file-name
8062 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
8063 @code{nil}, all the preceding functions will replace all periods
8064 (@samp{.}) in the group names with slashes (@samp{/})---which means that
8065 the functions will generate hierarchies of directories instead of having
8066 all the files in the top level directory
8067 (@file{~/News/alt/andrea-dworkin} instead of
8068 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
8069 on most systems. However, for historical reasons, this is @code{nil} on
8070 Xenix and usg-unix-v machines by default.
8072 This function also affects kill and score file names. If this variable
8073 is a list, and the list contains the element @code{not-score}, long file
8074 names will not be used for score files, if it contains the element
8075 @code{not-save}, long file names will not be used for saving, and if it
8076 contains the element @code{not-kill}, long file names will not be used
8079 If you'd like to save articles in a hierarchy that looks something like
8083 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
8084 (setq gnus-default-article-saver
8085 'gnus-summary-save-in-file) ; @r{no encoding}
8088 Then just save with @kbd{o}. You'd then read this hierarchy with
8089 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
8090 the top level directory as the argument (@file{~/News/}). Then just walk
8091 around to the groups/directories with @code{nneething}.
8094 @node Decoding Articles
8095 @section Decoding Articles
8096 @cindex decoding articles
8098 Sometime users post articles (or series of articles) that have been
8099 encoded in some way or other. Gnus can decode them for you.
8102 * Uuencoded Articles:: Uudecode articles.
8103 * Shell Archives:: Unshar articles.
8104 * PostScript Files:: Split PostScript.
8105 * Other Files:: Plain save and binhex.
8106 * Decoding Variables:: Variables for a happy decoding.
8107 * Viewing Files:: You want to look at the result of the decoding?
8111 @cindex article series
8112 All these functions use the process/prefix convention
8113 (@pxref{Process/Prefix}) for finding out what articles to work on, with
8114 the extension that a ``single article'' means ``a single series''. Gnus
8115 can find out by itself what articles belong to a series, decode all the
8116 articles and unpack/view/save the resulting file(s).
8118 Gnus guesses what articles are in the series according to the following
8119 simplish rule: The subjects must be (nearly) identical, except for the
8120 last two numbers of the line. (Spaces are largely ignored, however.)
8122 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
8123 will find all the articles that match the regexp @samp{^cat.gif
8124 ([0-9]+/[0-9]+).*$}.
8126 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
8127 series}, will not be properly recognized by any of the automatic viewing
8128 commands, and you have to mark the articles manually with @kbd{#}.
8131 @node Uuencoded Articles
8132 @subsection Uuencoded Articles
8134 @cindex uuencoded articles
8139 @kindex X u (Summary)
8140 @findex gnus-uu-decode-uu
8141 @c @icon{gnus-uu-decode-uu}
8142 Uudecodes the current series (@code{gnus-uu-decode-uu}).
8145 @kindex X U (Summary)
8146 @findex gnus-uu-decode-uu-and-save
8147 Uudecodes and saves the current series
8148 (@code{gnus-uu-decode-uu-and-save}).
8151 @kindex X v u (Summary)
8152 @findex gnus-uu-decode-uu-view
8153 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
8156 @kindex X v U (Summary)
8157 @findex gnus-uu-decode-uu-and-save-view
8158 Uudecodes, views and saves the current series
8159 (@code{gnus-uu-decode-uu-and-save-view}).
8163 Remember that these all react to the presence of articles marked with
8164 the process mark. If, for instance, you'd like to decode and save an
8165 entire newsgroup, you'd typically do @kbd{M P a}
8166 (@code{gnus-uu-mark-all}) and then @kbd{X U}
8167 (@code{gnus-uu-decode-uu-and-save}).
8169 All this is very much different from how @code{gnus-uu} worked with
8170 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
8171 the sun. This version of @code{gnus-uu} generally assumes that you mark
8172 articles in some way (@pxref{Setting Process Marks}) and then press
8175 @vindex gnus-uu-notify-files
8176 Note: When trying to decode articles that have names matching
8177 @code{gnus-uu-notify-files}, which is hard-coded to
8178 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
8179 automatically post an article on @samp{comp.unix.wizards} saying that
8180 you have just viewed the file in question. This feature can't be turned
8184 @node Shell Archives
8185 @subsection Shell Archives
8187 @cindex shell archives
8188 @cindex shared articles
8190 Shell archives (``shar files'') used to be a popular way to distribute
8191 sources, but it isn't used all that much today. In any case, we have
8192 some commands to deal with these:
8197 @kindex X s (Summary)
8198 @findex gnus-uu-decode-unshar
8199 Unshars the current series (@code{gnus-uu-decode-unshar}).
8202 @kindex X S (Summary)
8203 @findex gnus-uu-decode-unshar-and-save
8204 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
8207 @kindex X v s (Summary)
8208 @findex gnus-uu-decode-unshar-view
8209 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
8212 @kindex X v S (Summary)
8213 @findex gnus-uu-decode-unshar-and-save-view
8214 Unshars, views and saves the current series
8215 (@code{gnus-uu-decode-unshar-and-save-view}).
8219 @node PostScript Files
8220 @subsection PostScript Files
8226 @kindex X p (Summary)
8227 @findex gnus-uu-decode-postscript
8228 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
8231 @kindex X P (Summary)
8232 @findex gnus-uu-decode-postscript-and-save
8233 Unpack and save the current PostScript series
8234 (@code{gnus-uu-decode-postscript-and-save}).
8237 @kindex X v p (Summary)
8238 @findex gnus-uu-decode-postscript-view
8239 View the current PostScript series
8240 (@code{gnus-uu-decode-postscript-view}).
8243 @kindex X v P (Summary)
8244 @findex gnus-uu-decode-postscript-and-save-view
8245 View and save the current PostScript series
8246 (@code{gnus-uu-decode-postscript-and-save-view}).
8251 @subsection Other Files
8255 @kindex X o (Summary)
8256 @findex gnus-uu-decode-save
8257 Save the current series
8258 (@code{gnus-uu-decode-save}).
8261 @kindex X b (Summary)
8262 @findex gnus-uu-decode-binhex
8263 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
8264 doesn't really work yet.
8267 @kindex X Y (Summary)
8268 @findex gnus-uu-decode-yenc
8269 yEnc-decode the current series and save it (@code{gnus-uu-decode-yenc}).
8273 @node Decoding Variables
8274 @subsection Decoding Variables
8276 Adjective, not verb.
8279 * Rule Variables:: Variables that say how a file is to be viewed.
8280 * Other Decode Variables:: Other decode variables.
8281 * Uuencoding and Posting:: Variables for customizing uuencoding.
8285 @node Rule Variables
8286 @subsubsection Rule Variables
8287 @cindex rule variables
8289 Gnus uses @dfn{rule variables} to decide how to view a file. All these
8290 variables are of the form
8293 (list '(regexp1 command2)
8300 @item gnus-uu-user-view-rules
8301 @vindex gnus-uu-user-view-rules
8303 This variable is consulted first when viewing files. If you wish to use,
8304 for instance, @code{sox} to convert an @file{.au} sound file, you could
8307 (setq gnus-uu-user-view-rules
8308 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
8311 @item gnus-uu-user-view-rules-end
8312 @vindex gnus-uu-user-view-rules-end
8313 This variable is consulted if Gnus couldn't make any matches from the
8314 user and default view rules.
8316 @item gnus-uu-user-archive-rules
8317 @vindex gnus-uu-user-archive-rules
8318 This variable can be used to say what commands should be used to unpack
8323 @node Other Decode Variables
8324 @subsubsection Other Decode Variables
8327 @vindex gnus-uu-grabbed-file-functions
8329 @item gnus-uu-grabbed-file-functions
8330 All functions in this list will be called right after each file has been
8331 successfully decoded---so that you can move or view files right away,
8332 and don't have to wait for all files to be decoded before you can do
8333 anything. Ready-made functions you can put in this list are:
8337 @item gnus-uu-grab-view
8338 @findex gnus-uu-grab-view
8341 @item gnus-uu-grab-move
8342 @findex gnus-uu-grab-move
8343 Move the file (if you're using a saving function.)
8346 @item gnus-uu-be-dangerous
8347 @vindex gnus-uu-be-dangerous
8348 Specifies what to do if unusual situations arise during decoding. If
8349 @code{nil}, be as conservative as possible. If @code{t}, ignore things
8350 that didn't work, and overwrite existing files. Otherwise, ask each
8353 @item gnus-uu-ignore-files-by-name
8354 @vindex gnus-uu-ignore-files-by-name
8355 Files with name matching this regular expression won't be viewed.
8357 @item gnus-uu-ignore-files-by-type
8358 @vindex gnus-uu-ignore-files-by-type
8359 Files with a @acronym{MIME} type matching this variable won't be viewed.
8360 Note that Gnus tries to guess what type the file is based on the name.
8361 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
8364 @item gnus-uu-tmp-dir
8365 @vindex gnus-uu-tmp-dir
8366 Where @code{gnus-uu} does its work.
8368 @item gnus-uu-do-not-unpack-archives
8369 @vindex gnus-uu-do-not-unpack-archives
8370 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
8371 looking for files to display.
8373 @item gnus-uu-view-and-save
8374 @vindex gnus-uu-view-and-save
8375 Non-@code{nil} means that the user will always be asked to save a file
8378 @item gnus-uu-ignore-default-view-rules
8379 @vindex gnus-uu-ignore-default-view-rules
8380 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
8383 @item gnus-uu-ignore-default-archive-rules
8384 @vindex gnus-uu-ignore-default-archive-rules
8385 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
8388 @item gnus-uu-kill-carriage-return
8389 @vindex gnus-uu-kill-carriage-return
8390 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
8393 @item gnus-uu-unmark-articles-not-decoded
8394 @vindex gnus-uu-unmark-articles-not-decoded
8395 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
8396 decoded articles as unread.
8398 @item gnus-uu-correct-stripped-uucode
8399 @vindex gnus-uu-correct-stripped-uucode
8400 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
8401 uuencoded files that have had trailing spaces deleted.
8403 @item gnus-uu-pre-uudecode-hook
8404 @vindex gnus-uu-pre-uudecode-hook
8405 Hook run before sending a message to @code{uudecode}.
8407 @item gnus-uu-view-with-metamail
8408 @vindex gnus-uu-view-with-metamail
8410 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
8411 commands defined by the rule variables and just fudge a @acronym{MIME}
8412 content type based on the file name. The result will be fed to
8413 @code{metamail} for viewing.
8415 @item gnus-uu-save-in-digest
8416 @vindex gnus-uu-save-in-digest
8417 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
8418 decoding, will save in digests. If this variable is @code{nil},
8419 @code{gnus-uu} will just save everything in a file without any
8420 embellishments. The digesting almost conforms to RFC 1153---no easy way
8421 to specify any meaningful volume and issue numbers were found, so I
8422 simply dropped them.
8427 @node Uuencoding and Posting
8428 @subsubsection Uuencoding and Posting
8432 @item gnus-uu-post-include-before-composing
8433 @vindex gnus-uu-post-include-before-composing
8434 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
8435 before you compose the article. If this variable is @code{t}, you can
8436 either include an encoded file with @kbd{C-c C-i} or have one included
8437 for you when you post the article.
8439 @item gnus-uu-post-length
8440 @vindex gnus-uu-post-length
8441 Maximum length of an article. The encoded file will be split into how
8442 many articles it takes to post the entire file.
8444 @item gnus-uu-post-threaded
8445 @vindex gnus-uu-post-threaded
8446 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
8447 thread. This may not be smart, as no other decoder I have seen is able
8448 to follow threads when collecting uuencoded articles. (Well, I have
8449 seen one package that does that---@code{gnus-uu}, but somehow, I don't
8450 think that counts@dots{}) Default is @code{nil}.
8452 @item gnus-uu-post-separate-description
8453 @vindex gnus-uu-post-separate-description
8454 Non-@code{nil} means that the description will be posted in a separate
8455 article. The first article will typically be numbered (0/x). If this
8456 variable is @code{nil}, the description the user enters will be included
8457 at the beginning of the first article, which will be numbered (1/x).
8458 Default is @code{t}.
8464 @subsection Viewing Files
8465 @cindex viewing files
8466 @cindex pseudo-articles
8468 After decoding, if the file is some sort of archive, Gnus will attempt
8469 to unpack the archive and see if any of the files in the archive can be
8470 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
8471 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
8472 uncompress and de-tar the main file, and then view the two pictures.
8473 This unpacking process is recursive, so if the archive contains archives
8474 of archives, it'll all be unpacked.
8476 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
8477 extracted file into the summary buffer. If you go to these
8478 ``articles'', you will be prompted for a command to run (usually Gnus
8479 will make a suggestion), and then the command will be run.
8481 @vindex gnus-view-pseudo-asynchronously
8482 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
8483 until the viewing is done before proceeding.
8485 @vindex gnus-view-pseudos
8486 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8487 the pseudo-articles into the summary buffer, but view them
8488 immediately. If this variable is @code{not-confirm}, the user won't even
8489 be asked for a confirmation before viewing is done.
8491 @vindex gnus-view-pseudos-separately
8492 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8493 pseudo-article will be created for each file to be viewed. If
8494 @code{nil}, all files that use the same viewing command will be given as
8495 a list of parameters to that command.
8497 @vindex gnus-insert-pseudo-articles
8498 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8499 pseudo-articles when decoding. It is @code{t} by default.
8501 So; there you are, reading your @emph{pseudo-articles} in your
8502 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8503 Why isn't anything real anymore? How did we get here?
8506 @node Article Treatment
8507 @section Article Treatment
8509 Reading through this huge manual, you may have quite forgotten that the
8510 object of newsreaders is to actually, like, read what people have
8511 written. Reading articles. Unfortunately, people are quite bad at
8512 writing, so there are tons of functions and variables to make reading
8513 these articles easier.
8516 * Article Highlighting:: You want to make the article look like fruit salad.
8517 * Article Fontisizing:: Making emphasized text look nice.
8518 * Article Hiding:: You also want to make certain info go away.
8519 * Article Washing:: Lots of way-neat functions to make life better.
8520 * Article Header:: Doing various header transformations.
8521 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8522 * Article Button Levels:: Controlling appearance of buttons.
8523 * Article Date:: Grumble, UT!
8524 * Article Display:: Display various stuff:
8525 X-Face, Picons, Gravatars, Smileys.
8526 * Article Signature:: What is a signature?
8527 * Article Miscellanea:: Various other stuff.
8531 @node Article Highlighting
8532 @subsection Article Highlighting
8533 @cindex highlighting
8535 Not only do you want your article buffer to look like fruit salad, but
8536 you want it to look like technicolor fruit salad.
8541 @kindex W H a (Summary)
8542 @findex gnus-article-highlight
8543 @findex gnus-article-maybe-highlight
8544 Do much highlighting of the current article
8545 (@code{gnus-article-highlight}). This function highlights header, cited
8546 text, the signature, and adds buttons to the body and the head.
8549 @kindex W H h (Summary)
8550 @findex gnus-article-highlight-headers
8551 @vindex gnus-header-face-alist
8552 Highlight the headers (@code{gnus-article-highlight-headers}). The
8553 highlighting will be done according to the @code{gnus-header-face-alist}
8554 variable, which is a list where each element has the form
8555 @code{(@var{regexp} @var{name} @var{content})}.
8556 @var{regexp} is a regular expression for matching the
8557 header, @var{name} is the face used for highlighting the header name
8558 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8559 the header value. The first match made will be used. Note that
8560 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8563 @kindex W H c (Summary)
8564 @findex gnus-article-highlight-citation
8565 Highlight cited text (@code{gnus-article-highlight-citation}).
8567 Some variables to customize the citation highlights:
8570 @vindex gnus-cite-parse-max-size
8572 @item gnus-cite-parse-max-size
8573 If the article size in bytes is bigger than this variable (which is
8574 25000 by default), no citation highlighting will be performed.
8576 @item gnus-cite-max-prefix
8577 @vindex gnus-cite-max-prefix
8578 Maximum possible length for a citation prefix (default 20).
8580 @item gnus-cite-face-list
8581 @vindex gnus-cite-face-list
8582 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8583 When there are citations from multiple articles in the same message,
8584 Gnus will try to give each citation from each article its own face.
8585 This should make it easier to see who wrote what.
8587 @item gnus-supercite-regexp
8588 @vindex gnus-supercite-regexp
8589 Regexp matching normal Supercite attribution lines.
8591 @item gnus-supercite-secondary-regexp
8592 @vindex gnus-supercite-secondary-regexp
8593 Regexp matching mangled Supercite attribution lines.
8595 @item gnus-cite-minimum-match-count
8596 @vindex gnus-cite-minimum-match-count
8597 Minimum number of identical prefixes we have to see before we believe
8598 that it's a citation.
8600 @item gnus-cite-attribution-prefix
8601 @vindex gnus-cite-attribution-prefix
8602 Regexp matching the beginning of an attribution line.
8604 @item gnus-cite-attribution-suffix
8605 @vindex gnus-cite-attribution-suffix
8606 Regexp matching the end of an attribution line.
8608 @item gnus-cite-attribution-face
8609 @vindex gnus-cite-attribution-face
8610 Face used for attribution lines. It is merged with the face for the
8611 cited text belonging to the attribution.
8613 @item gnus-cite-ignore-quoted-from
8614 @vindex gnus-cite-ignore-quoted-from
8615 If non-@code{nil}, no citation highlighting will be performed on lines
8616 beginning with @samp{>From }. Those lines may have been quoted by MTAs
8617 in order not to mix up with the envelope From line. The default value
8624 @kindex W H s (Summary)
8625 @vindex gnus-signature-separator
8626 @vindex gnus-signature-face
8627 @findex gnus-article-highlight-signature
8628 Highlight the signature (@code{gnus-article-highlight-signature}).
8629 Everything after @code{gnus-signature-separator} (@pxref{Article
8630 Signature}) in an article will be considered a signature and will be
8631 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8636 @xref{Customizing Articles}, for how to highlight articles automatically.
8639 @node Article Fontisizing
8640 @subsection Article Fontisizing
8642 @cindex article emphasis
8644 @findex gnus-article-emphasize
8645 @kindex W e (Summary)
8646 People commonly add emphasis to words in news articles by writing things
8647 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8648 this look nicer by running the article through the @kbd{W e}
8649 (@code{gnus-article-emphasize}) command.
8651 @vindex gnus-emphasis-alist
8652 How the emphasis is computed is controlled by the
8653 @code{gnus-emphasis-alist} variable. This is an alist where the first
8654 element is a regular expression to be matched. The second is a number
8655 that says what regular expression grouping is used to find the entire
8656 emphasized word. The third is a number that says what regexp grouping
8657 should be displayed and highlighted. (The text between these two
8658 groupings will be hidden.) The fourth is the face used for
8662 (setq gnus-emphasis-alist
8663 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8664 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8673 @vindex gnus-emphasis-underline
8674 @vindex gnus-emphasis-bold
8675 @vindex gnus-emphasis-italic
8676 @vindex gnus-emphasis-underline-bold
8677 @vindex gnus-emphasis-underline-italic
8678 @vindex gnus-emphasis-bold-italic
8679 @vindex gnus-emphasis-underline-bold-italic
8680 By default, there are seven rules, and they use the following faces:
8681 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8682 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8683 @code{gnus-emphasis-underline-italic},
8684 @code{gnus-emphasis-underline-bold}, and
8685 @code{gnus-emphasis-underline-bold-italic}.
8687 If you want to change these faces, you can either use @kbd{M-x
8688 customize}, or you can use @code{copy-face}. For instance, if you want
8689 to make @code{gnus-emphasis-italic} use a red face instead, you could
8693 (copy-face 'red 'gnus-emphasis-italic)
8696 @vindex gnus-group-highlight-words-alist
8698 If you want to highlight arbitrary words, you can use the
8699 @code{gnus-group-highlight-words-alist} variable, which uses the same
8700 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8701 parameter (@pxref{Group Parameters}) can also be used.
8703 @xref{Customizing Articles}, for how to fontize articles automatically.
8706 @node Article Hiding
8707 @subsection Article Hiding
8708 @cindex article hiding
8710 Or rather, hiding certain things in each article. There usually is much
8711 too much cruft in most articles.
8716 @kindex W W a (Summary)
8717 @findex gnus-article-hide
8718 Do quite a lot of hiding on the article buffer
8719 (@kbd{gnus-article-hide}). In particular, this function will hide
8720 headers, @acronym{PGP}, cited text and the signature.
8723 @kindex W W h (Summary)
8724 @findex gnus-article-hide-headers
8725 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8729 @kindex W W b (Summary)
8730 @findex gnus-article-hide-boring-headers
8731 Hide headers that aren't particularly interesting
8732 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8735 @kindex W W s (Summary)
8736 @findex gnus-article-hide-signature
8737 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8741 @kindex W W l (Summary)
8742 @findex gnus-article-hide-list-identifiers
8743 @vindex gnus-list-identifiers
8744 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8745 are strings some mailing list servers add to the beginning of all
8746 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8747 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8748 may not contain @code{\\(..\\)}.
8752 @item gnus-list-identifiers
8753 @vindex gnus-list-identifiers
8754 A regular expression that matches list identifiers to be removed from
8755 subject. This can also be a list of regular expressions.
8760 @kindex W W P (Summary)
8761 @findex gnus-article-hide-pem
8762 Hide @acronym{PEM} (privacy enhanced messages) cruft
8763 (@code{gnus-article-hide-pem}).
8766 @kindex W W B (Summary)
8767 @findex gnus-article-strip-banner
8768 @vindex gnus-article-banner-alist
8769 @vindex gnus-article-address-banner-alist
8772 @cindex stripping advertisements
8773 @cindex advertisements
8774 Strip the banner specified by the @code{banner} group parameter
8775 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8776 annoying banners and/or signatures that some mailing lists and moderated
8777 groups adds to all the messages. The way to use this function is to add
8778 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8779 group you want banners stripped from. The parameter either be a string,
8780 which will be interpreted as a regular expression matching text to be
8781 removed, or the symbol @code{signature}, meaning that the (last)
8782 signature should be removed, or other symbol, meaning that the
8783 corresponding regular expression in @code{gnus-article-banner-alist} is
8789 (setq gnus-article-banner-alist
8791 "^\n*--~--~---------\\(.+\n\\)+")))
8794 Regardless of a group, you can hide things like advertisements only when
8795 the sender of an article has a certain mail address specified in
8796 @code{gnus-article-address-banner-alist}.
8800 @item gnus-article-address-banner-alist
8801 @vindex gnus-article-address-banner-alist
8802 Alist of mail addresses and banners. Each element has the form
8803 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8804 matching a mail address in the From header, @var{banner} is one of a
8805 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8806 a regexp and @code{nil}. If @var{address} matches author's mail
8807 address, it will remove things like advertisements. For example, if a
8808 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8809 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8810 sends, you can use the following element to remove them:
8813 ("@@yoo-hoo\\.co\\.jp\\'" .
8814 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8820 @kindex W W c (Summary)
8821 @findex gnus-article-hide-citation
8822 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8823 customizing the hiding:
8827 @item gnus-cited-opened-text-button-line-format
8828 @itemx gnus-cited-closed-text-button-line-format
8829 @vindex gnus-cited-closed-text-button-line-format
8830 @vindex gnus-cited-opened-text-button-line-format
8831 Gnus adds buttons to show where the cited text has been hidden, and to
8832 allow toggle hiding the text. The format of the variable is specified
8833 by these format-like variable (@pxref{Formatting Variables}). These
8838 Starting point of the hidden text.
8840 Ending point of the hidden text.
8842 Number of characters in the hidden region.
8844 Number of lines of hidden text.
8847 @item gnus-cited-lines-visible
8848 @vindex gnus-cited-lines-visible
8849 The number of lines at the beginning of the cited text to leave
8850 shown. This can also be a cons cell with the number of lines at the top
8851 and bottom of the text, respectively, to remain visible.
8856 @kindex W W C-c (Summary)
8857 @findex gnus-article-hide-citation-maybe
8859 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8860 following two variables:
8863 @item gnus-cite-hide-percentage
8864 @vindex gnus-cite-hide-percentage
8865 If the cited text is of a bigger percentage than this variable (default
8866 50), hide the cited text.
8868 @item gnus-cite-hide-absolute
8869 @vindex gnus-cite-hide-absolute
8870 The cited text must have at least this length (default 10) before it
8875 @kindex W W C (Summary)
8876 @findex gnus-article-hide-citation-in-followups
8877 Hide cited text in articles that aren't roots
8878 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8879 useful as an interactive command, but might be a handy function to stick
8880 have happen automatically (@pxref{Customizing Articles}).
8884 All these ``hiding'' commands are toggles, but if you give a negative
8885 prefix to these commands, they will show what they have previously
8886 hidden. If you give a positive prefix, they will always hide.
8888 Also @pxref{Article Highlighting} for further variables for
8889 citation customization.
8891 @xref{Customizing Articles}, for how to hide article elements
8895 @node Article Washing
8896 @subsection Article Washing
8898 @cindex article washing
8900 We call this ``article washing'' for a really good reason. Namely, the
8901 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8903 @dfn{Washing} is defined by us as ``changing something from something to
8904 something else'', but normally results in something looking better.
8907 @xref{Customizing Articles}, if you want to change how Gnus displays
8908 articles by default.
8913 This is not really washing, it's sort of the opposite of washing. If
8914 you type this, you see the article exactly as it exists on disk or on
8918 Force redisplaying of the current article
8919 (@code{gnus-summary-show-article}). This is also not really washing.
8920 If you type this, you see the article without any previously applied
8921 interactive Washing functions but with all default treatments
8922 (@pxref{Customizing Articles}).
8925 @kindex W l (Summary)
8926 @findex gnus-summary-stop-page-breaking
8927 Remove page breaks from the current article
8928 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8932 @kindex W r (Summary)
8933 @findex gnus-summary-caesar-message
8934 @c @icon{gnus-summary-caesar-message}
8935 Do a Caesar rotate (rot13) on the article buffer
8936 (@code{gnus-summary-caesar-message}).
8937 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8938 (Typically offensive jokes and such.)
8940 It's commonly called ``rot13'' because each letter is rotated 13
8941 positions in the alphabet, e.g., @samp{B} (letter #2) -> @samp{O} (letter
8942 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8943 is rumored to have employed this form of, uh, somewhat weak encryption.
8946 @kindex W m (Summary)
8947 @findex gnus-summary-morse-message
8948 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8951 @kindex W i (Summary)
8952 @findex gnus-summary-idna-message
8953 Decode IDNA encoded domain names in the current articles. IDNA
8954 encoded domain names looks like @samp{xn--bar}. If a string remain
8955 unencoded after running invoking this, it is likely an invalid IDNA
8956 string (@samp{xn--bar} is invalid). You must have GNU Libidn
8957 (@url{http://www.gnu.org/software/libidn/}) installed for this command
8962 @kindex W t (Summary)
8964 @findex gnus-summary-toggle-header
8965 Toggle whether to display all headers in the article buffer
8966 (@code{gnus-summary-toggle-header}).
8969 @kindex W v (Summary)
8970 @findex gnus-summary-verbose-headers
8971 Toggle whether to display all headers in the article buffer permanently
8972 (@code{gnus-summary-verbose-headers}).
8975 @kindex W o (Summary)
8976 @findex gnus-article-treat-overstrike
8977 Treat overstrike (@code{gnus-article-treat-overstrike}).
8980 @kindex W d (Summary)
8981 @findex gnus-article-treat-dumbquotes
8982 @vindex gnus-article-dumbquotes-map
8984 @cindex M****s*** sm*rtq**t*s
8986 Treat M****s*** sm*rtq**t*s according to
8987 @code{gnus-article-dumbquotes-map}
8988 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8989 whether a character is a sm*rtq**t* or not, so it should only be used
8992 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8993 an attempt to provide more quoting characters. If you see something
8994 like @code{\222} or @code{\264} where you're expecting some kind of
8995 apostrophe or quotation mark, then try this wash.
8998 @kindex W U (Summary)
8999 @findex gnus-article-treat-non-ascii
9001 @cindex Non-@acronym{ASCII}
9002 Translate many non-@acronym{ASCII} characters into their
9003 @acronym{ASCII} equivalents (@code{gnus-article-treat-non-ascii}).
9004 This is mostly useful if you're on a terminal that has a limited font
9005 and doesn't show accented characters, ``advanced'' punctuation, and the
9006 like. For instance, @samp{»} is translated into @samp{>>}, and so on.
9009 @kindex W Y f (Summary)
9010 @findex gnus-article-outlook-deuglify-article
9011 @cindex Outlook Express
9012 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
9013 unwrap lines, repair attribution and rearrange citation.
9014 (@code{gnus-article-outlook-deuglify-article}).
9017 @kindex W Y u (Summary)
9018 @findex gnus-article-outlook-unwrap-lines
9019 @vindex gnus-outlook-deuglify-unwrap-min
9020 @vindex gnus-outlook-deuglify-unwrap-max
9021 Unwrap lines that appear to be wrapped citation lines. You can control
9022 what lines will be unwrapped by frobbing
9023 @code{gnus-outlook-deuglify-unwrap-min} and
9024 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
9025 maximum length of an unwrapped citation line.
9026 (@code{gnus-article-outlook-unwrap-lines}).
9029 @kindex W Y a (Summary)
9030 @findex gnus-article-outlook-repair-attribution
9031 Repair a broken attribution line.@*
9032 (@code{gnus-article-outlook-repair-attribution}).
9035 @kindex W Y c (Summary)
9036 @findex gnus-article-outlook-rearrange-citation
9037 Repair broken citations by rearranging the text.
9038 (@code{gnus-article-outlook-rearrange-citation}).
9041 @kindex W w (Summary)
9042 @findex gnus-article-fill-cited-article
9043 Do word wrap (@code{gnus-article-fill-cited-article}).
9045 You can give the command a numerical prefix to specify the width to use
9049 @kindex W Q (Summary)
9050 @findex gnus-article-fill-long-lines
9051 Fill long lines (@code{gnus-article-fill-long-lines}).
9054 @kindex W C (Summary)
9055 @findex gnus-article-capitalize-sentences
9056 Capitalize the first word in each sentence
9057 (@code{gnus-article-capitalize-sentences}).
9060 @kindex W c (Summary)
9061 @findex gnus-article-remove-cr
9062 Translate CRLF pairs (i.e., @samp{^M}s on the end of the lines) into LF
9063 (this takes care of DOS line endings), and then translate any remaining
9064 CRs into LF (this takes care of Mac line endings)
9065 (@code{gnus-article-remove-cr}).
9068 @kindex W q (Summary)
9069 @findex gnus-article-de-quoted-unreadable
9070 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
9071 Quoted-Printable is one common @acronym{MIME} encoding employed when
9072 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
9073 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
9074 which doesn't look very readable to me. Note that this is usually
9075 done automatically by Gnus if the message in question has a
9076 @code{Content-Transfer-Encoding} header that says that this encoding
9077 has been done. If a prefix is given, a charset will be asked for.
9080 @kindex W 6 (Summary)
9081 @findex gnus-article-de-base64-unreadable
9082 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
9083 one common @acronym{MIME} encoding employed when sending
9084 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
9085 usually done automatically by Gnus if the message in question has a
9086 @code{Content-Transfer-Encoding} header that says that this encoding
9087 has been done. If a prefix is given, a charset will be asked for.
9090 @kindex W Z (Summary)
9091 @findex gnus-article-decode-HZ
9092 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
9093 common encoding employed when sending Chinese articles. It typically
9094 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
9097 @kindex W A (Summary)
9098 @findex gnus-article-treat-ansi-sequences
9099 @cindex @acronym{ANSI} control sequences
9100 Translate @acronym{ANSI} SGR control sequences into overlays or
9101 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
9102 sequences are used in some Chinese hierarchies for highlighting.
9105 @kindex W u (Summary)
9106 @findex gnus-article-unsplit-urls
9107 Remove newlines from within URLs. Some mailers insert newlines into
9108 outgoing email messages to keep lines short. This reformatting can
9109 split long URLs onto multiple lines. Repair those URLs by removing
9110 the newlines (@code{gnus-article-unsplit-urls}).
9113 @kindex W h (Summary)
9114 @findex gnus-article-wash-html
9115 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
9116 usually done automatically by Gnus if the message in question has a
9117 @code{Content-Type} header that says that the message is @acronym{HTML}.
9119 If a prefix is given, a charset will be asked for. If it is a number,
9120 the charset defined in @code{gnus-summary-show-article-charset-alist}
9121 (@pxref{Paging the Article}) will be used.
9123 The default is to use the function specified by
9124 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
9125 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
9126 @acronym{HTML}. Pre-defined functions you can use include:
9130 Use Gnus simple html renderer.
9133 Use Gnus rendered based on w3m.
9139 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
9141 @item w3m-standalone
9142 Use @uref{http://w3m.sourceforge.net/, w3m}.
9145 Use @uref{http://links.sf.net/, Links}.
9148 Use @uref{http://lynx.isc.org/, Lynx}.
9151 Use html2text---a simple @acronym{HTML} converter included with Gnus.
9156 @kindex W b (Summary)
9157 @findex gnus-article-add-buttons
9158 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
9159 @xref{Article Buttons}.
9162 @kindex W B (Summary)
9163 @findex gnus-article-add-buttons-to-head
9164 Add clickable buttons to the article headers
9165 (@code{gnus-article-add-buttons-to-head}).
9168 @kindex W p (Summary)
9169 @findex gnus-article-verify-x-pgp-sig
9170 Verify a signed control message
9171 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
9172 @code{newgroup} and @code{checkgroups} are usually signed by the
9173 hierarchy maintainer. You need to add the @acronym{PGP} public key of
9174 the maintainer to your keyring to verify the
9175 message.@footnote{@acronym{PGP} keys for many hierarchies are
9176 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
9179 @kindex W s (Summary)
9180 @findex gnus-summary-force-verify-and-decrypt
9181 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
9182 @acronym{S/MIME}) message
9183 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
9186 @kindex W a (Summary)
9187 @findex gnus-article-strip-headers-in-body
9188 Strip headers like the @code{X-No-Archive} header from the beginning of
9189 article bodies (@code{gnus-article-strip-headers-in-body}).
9192 @kindex W E l (Summary)
9193 @findex gnus-article-strip-leading-blank-lines
9194 Remove all blank lines from the beginning of the article
9195 (@code{gnus-article-strip-leading-blank-lines}).
9198 @kindex W E m (Summary)
9199 @findex gnus-article-strip-multiple-blank-lines
9200 Replace all blank lines with empty lines and then all multiple empty
9201 lines with a single empty line.
9202 (@code{gnus-article-strip-multiple-blank-lines}).
9205 @kindex W E t (Summary)
9206 @findex gnus-article-remove-trailing-blank-lines
9207 Remove all blank lines at the end of the article
9208 (@code{gnus-article-remove-trailing-blank-lines}).
9211 @kindex W E a (Summary)
9212 @findex gnus-article-strip-blank-lines
9213 Do all the three commands above
9214 (@code{gnus-article-strip-blank-lines}).
9217 @kindex W E A (Summary)
9218 @findex gnus-article-strip-all-blank-lines
9219 Remove all blank lines
9220 (@code{gnus-article-strip-all-blank-lines}).
9223 @kindex W E s (Summary)
9224 @findex gnus-article-strip-leading-space
9225 Remove all white space from the beginning of all lines of the article
9226 body (@code{gnus-article-strip-leading-space}).
9229 @kindex W E e (Summary)
9230 @findex gnus-article-strip-trailing-space
9231 Remove all white space from the end of all lines of the article
9232 body (@code{gnus-article-strip-trailing-space}).
9236 @xref{Customizing Articles}, for how to wash articles automatically.
9239 @node Article Header
9240 @subsection Article Header
9242 These commands perform various transformations of article header.
9247 @kindex W G u (Summary)
9248 @findex gnus-article-treat-unfold-headers
9249 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
9252 @kindex W G n (Summary)
9253 @findex gnus-article-treat-fold-newsgroups
9254 Fold the @code{Newsgroups} and @code{Followup-To} headers
9255 (@code{gnus-article-treat-fold-newsgroups}).
9258 @kindex W G f (Summary)
9259 @findex gnus-article-treat-fold-headers
9260 Fold all the message headers
9261 (@code{gnus-article-treat-fold-headers}).
9264 @kindex W E w (Summary)
9265 @findex gnus-article-remove-leading-whitespace
9266 Remove excessive whitespace from all headers
9267 (@code{gnus-article-remove-leading-whitespace}).
9272 @node Article Buttons
9273 @subsection Article Buttons
9276 People often include references to other stuff in articles, and it would
9277 be nice if Gnus could just fetch whatever it is that people talk about
9278 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
9279 button on these references.
9281 @vindex gnus-button-man-handler
9282 Gnus adds @dfn{buttons} to certain standard references by default:
9283 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
9284 Emacs or Gnus related references. This is controlled by two variables,
9285 one that handles article bodies and one that handles article heads:
9289 @item gnus-button-alist
9290 @vindex gnus-button-alist
9291 This is an alist where each entry has this form:
9294 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9300 All text that match this regular expression (case insensitive) will be
9301 considered an external reference. Here's a typical regexp that matches
9302 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
9303 variable containing a regexp, useful variables to use include
9304 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
9307 Gnus has to know which parts of the matches is to be highlighted. This
9308 is a number that says what sub-expression of the regexp is to be
9309 highlighted. If you want it all highlighted, you use 0 here.
9312 This form will be @code{eval}ed, and if the result is non-@code{nil},
9313 this is considered a match. This is useful if you want extra sifting to
9314 avoid false matches. Often variables named
9315 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
9316 Levels}, but any other form may be used too.
9318 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
9321 This function will be called when you click on this button.
9324 As with @var{button-par}, this is a sub-expression number, but this one
9325 says which part of the match is to be sent as data to @var{function}.
9329 So the full entry for buttonizing URLs is then
9332 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
9335 @item gnus-header-button-alist
9336 @vindex gnus-header-button-alist
9337 This is just like the other alist, except that it is applied to the
9338 article head only, and that each entry has an additional element that is
9339 used to say what headers to apply the buttonize coding to:
9342 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9345 @var{header} is a regular expression.
9348 @subsubsection Related variables and functions
9351 @item gnus-button-@var{*}-level
9352 @xref{Article Button Levels}.
9354 @c Stuff related to gnus-button-browse-level
9356 @item gnus-button-url-regexp
9357 @vindex gnus-button-url-regexp
9358 A regular expression that matches embedded URLs. It is used in the
9359 default values of the variables above.
9361 @c Stuff related to gnus-button-man-level
9363 @item gnus-button-man-handler
9364 @vindex gnus-button-man-handler
9365 The function to use for displaying man pages. It must take at least one
9366 argument with a string naming the man page.
9368 @c Stuff related to gnus-button-message-level
9370 @item gnus-button-mid-or-mail-regexp
9371 @vindex gnus-button-mid-or-mail-regexp
9372 Regular expression that matches a message ID or a mail address.
9374 @item gnus-button-prefer-mid-or-mail
9375 @vindex gnus-button-prefer-mid-or-mail
9376 This variable determines what to do when the button on a string as
9377 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
9378 message ID or a mail address. If it is one of the symbols @code{mid} or
9379 @code{mail}, Gnus will always assume that the string is a message ID or
9380 a mail address, respectively. If this variable is set to the symbol
9381 @code{ask}, always query the user what to do. If it is a function, this
9382 function will be called with the string as its only argument. The
9383 function must return @code{mid}, @code{mail}, @code{invalid} or
9384 @code{ask}. The default value is the function
9385 @code{gnus-button-mid-or-mail-heuristic}.
9387 @item gnus-button-mid-or-mail-heuristic
9388 @findex gnus-button-mid-or-mail-heuristic
9389 Function that guesses whether its argument is a message ID or a mail
9390 address. Returns @code{mid} if it's a message IDs, @code{mail} if
9391 it's a mail address, @code{ask} if unsure and @code{invalid} if the
9394 @item gnus-button-mid-or-mail-heuristic-alist
9395 @vindex gnus-button-mid-or-mail-heuristic-alist
9396 An alist of @code{(RATE . REGEXP)} pairs used by the function
9397 @code{gnus-button-mid-or-mail-heuristic}.
9401 @item gnus-article-button-face
9402 @vindex gnus-article-button-face
9403 Face used on buttons.
9405 @item gnus-article-mouse-face
9406 @vindex gnus-article-mouse-face
9407 Face used when the mouse cursor is over a button.
9411 @xref{Customizing Articles}, for how to buttonize articles automatically.
9414 @node Article Button Levels
9415 @subsection Article button levels
9416 @cindex button levels
9417 The higher the value of the variables @code{gnus-button-@var{*}-level},
9418 the more buttons will appear. If the level is zero, no corresponding
9419 buttons are displayed. With the default value (which is 5) you should
9420 already see quite a lot of buttons. With higher levels, you will see
9421 more buttons, but you may also get more false positives. To avoid them,
9422 you can set the variables @code{gnus-button-@var{*}-level} local to
9423 specific groups (@pxref{Group Parameters}). Here's an example for the
9424 variable @code{gnus-parameters}:
9427 ;; @r{increase @code{gnus-button-*-level} in some groups:}
9428 (setq gnus-parameters
9429 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
9430 ("\\<unix\\>" (gnus-button-man-level 10))
9431 ("\\<tex\\>" (gnus-button-tex-level 10))))
9436 @item gnus-button-browse-level
9437 @vindex gnus-button-browse-level
9438 Controls the display of references to message IDs, mail addresses and
9439 news URLs. Related variables and functions include
9440 @code{gnus-button-url-regexp}, @code{browse-url}, and
9441 @code{browse-url-browser-function}.
9443 @item gnus-button-emacs-level
9444 @vindex gnus-button-emacs-level
9445 Controls the display of Emacs or Gnus references. Related functions are
9446 @code{gnus-button-handle-custom},
9447 @code{gnus-button-handle-describe-function},
9448 @code{gnus-button-handle-describe-variable},
9449 @code{gnus-button-handle-symbol},
9450 @code{gnus-button-handle-describe-key},
9451 @code{gnus-button-handle-apropos},
9452 @code{gnus-button-handle-apropos-command},
9453 @code{gnus-button-handle-apropos-variable},
9454 @code{gnus-button-handle-apropos-documentation}, and
9455 @code{gnus-button-handle-library}.
9457 @item gnus-button-man-level
9458 @vindex gnus-button-man-level
9459 Controls the display of references to (Unix) man pages.
9460 See @code{gnus-button-man-handler}.
9462 @item gnus-button-message-level
9463 @vindex gnus-button-message-level
9464 Controls the display of message IDs, mail addresses and news URLs.
9465 Related variables and functions include
9466 @code{gnus-button-mid-or-mail-regexp},
9467 @code{gnus-button-prefer-mid-or-mail},
9468 @code{gnus-button-mid-or-mail-heuristic}, and
9469 @code{gnus-button-mid-or-mail-heuristic-alist}.
9475 @subsection Article Date
9477 The date is most likely generated in some obscure timezone you've never
9478 heard of, so it's quite nice to be able to find out what the time was
9479 when the article was sent.
9484 @kindex W T u (Summary)
9485 @findex gnus-article-date-ut
9486 Display the date in UT (aka. GMT, aka ZULU)
9487 (@code{gnus-article-date-ut}).
9490 @kindex W T i (Summary)
9491 @findex gnus-article-date-iso8601
9493 Display the date in international format, aka. ISO 8601
9494 (@code{gnus-article-date-iso8601}).
9497 @kindex W T l (Summary)
9498 @findex gnus-article-date-local
9499 Display the date in the local timezone (@code{gnus-article-date-local}).
9502 @kindex W T p (Summary)
9503 @findex gnus-article-date-english
9504 Display the date in a format that's easily pronounceable in English
9505 (@code{gnus-article-date-english}).
9508 @kindex W T s (Summary)
9509 @vindex gnus-article-time-format
9510 @findex gnus-article-date-user
9511 @findex format-time-string
9512 Display the date using a user-defined format
9513 (@code{gnus-article-date-user}). The format is specified by the
9514 @code{gnus-article-time-format} variable, and is a string that's passed
9515 to @code{format-time-string}. See the documentation of that variable
9516 for a list of possible format specs.
9519 @kindex W T e (Summary)
9520 @findex gnus-article-date-lapsed
9521 @findex gnus-start-date-timer
9522 @findex gnus-stop-date-timer
9523 Say how much time has elapsed between the article was posted and now
9524 (@code{gnus-article-date-lapsed}). It looks something like:
9527 Date: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9530 To make this line updated continually, set the
9531 @code{gnus-article-update-date-headers} variable to the frequency in
9532 seconds (the default is @code{nil}).
9535 @kindex W T o (Summary)
9536 @findex gnus-article-date-original
9537 Display the original date (@code{gnus-article-date-original}). This can
9538 be useful if you normally use some other conversion function and are
9539 worried that it might be doing something totally wrong. Say, claiming
9540 that the article was posted in 1854. Although something like that is
9541 @emph{totally} impossible. Don't you trust me? *titter*
9545 @xref{Customizing Articles}, for how to display the date in your
9546 preferred format automatically.
9549 @node Article Display
9550 @subsection Article Display
9556 These commands add various frivolous display gimmicks to the article
9557 buffer in Emacs versions that support them.
9559 @code{X-Face} headers are small black-and-white images supplied by the
9560 message headers (@pxref{X-Face}).
9562 @code{Face} headers are small colored images supplied by the message
9563 headers (@pxref{Face}).
9565 Smileys are those little @samp{:-)} symbols that people like to litter
9566 their messages with (@pxref{Smileys}).
9568 Picons, on the other hand, reside on your own system, and Gnus will
9569 try to match the headers to what you have (@pxref{Picons}).
9571 Gravatars reside on-line and are fetched from
9572 @uref{http://www.gravatar.com/} (@pxref{Gravatars}).
9574 All these functions are toggles---if the elements already exist,
9579 @kindex W D x (Summary)
9580 @findex gnus-article-display-x-face
9581 Display an @code{X-Face} in the @code{From} header.
9582 (@code{gnus-article-display-x-face}).
9585 @kindex W D d (Summary)
9586 @findex gnus-article-display-face
9587 Display a @code{Face} in the @code{From} header.
9588 (@code{gnus-article-display-face}).
9591 @kindex W D s (Summary)
9592 @findex gnus-treat-smiley
9593 Display smileys (@code{gnus-treat-smiley}).
9596 @kindex W D f (Summary)
9597 @findex gnus-treat-from-picon
9598 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9601 @kindex W D m (Summary)
9602 @findex gnus-treat-mail-picon
9603 Piconify all mail headers (i.e., @code{Cc}, @code{To})
9604 (@code{gnus-treat-mail-picon}).
9607 @kindex W D n (Summary)
9608 @findex gnus-treat-newsgroups-picon
9609 Piconify all news headers (i.e., @code{Newsgroups} and
9610 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9613 @kindex W D g (Summary)
9614 @findex gnus-treat-from-gravatar
9615 Gravatarify the @code{From} header (@code{gnus-treat-from-gravatar}).
9618 @kindex W D h (Summary)
9619 @findex gnus-treat-mail-gravatar
9620 Gravatarify all mail headers (i.e., @code{Cc}, @code{To})
9621 (@code{gnus-treat-from-gravatar}).
9624 @kindex W D D (Summary)
9625 @findex gnus-article-remove-images
9626 Remove all images from the article buffer
9627 (@code{gnus-article-remove-images}).
9630 @kindex W D W (Summary)
9631 @findex gnus-html-show-images
9632 If you're reading an @acronym{HTML} article rendered with
9633 @code{gnus-article-html}, then you can insert any blocked images in
9634 the buffer with this command.
9635 (@code{gnus-html-show-images}).
9641 @node Article Signature
9642 @subsection Article Signature
9644 @cindex article signature
9646 @vindex gnus-signature-separator
9647 Each article is divided into two parts---the head and the body. The
9648 body can be divided into a signature part and a text part. The variable
9649 that says what is to be considered a signature is
9650 @code{gnus-signature-separator}. This is normally the standard
9651 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9652 non-standard signature separators, so this variable can also be a list
9653 of regular expressions to be tested, one by one. (Searches are done
9654 from the end of the body towards the beginning.) One likely value is:
9657 (setq gnus-signature-separator
9658 '("^-- $" ; @r{The standard}
9659 "^-- *$" ; @r{A common mangling}
9660 "^-------*$" ; @r{Many people just use a looong}
9661 ; @r{line of dashes. Shame!}
9662 "^ *--------*$" ; @r{Double-shame!}
9663 "^________*$" ; @r{Underscores are also popular}
9664 "^========*$")) ; @r{Pervert!}
9667 The more permissive you are, the more likely it is that you'll get false
9670 @vindex gnus-signature-limit
9671 @code{gnus-signature-limit} provides a limit to what is considered a
9672 signature when displaying articles.
9676 If it is an integer, no signature may be longer (in characters) than
9679 If it is a floating point number, no signature may be longer (in lines)
9682 If it is a function, the function will be called without any parameters,
9683 and if it returns @code{nil}, there is no signature in the buffer.
9685 If it is a string, it will be used as a regexp. If it matches, the text
9686 in question is not a signature.
9689 This variable can also be a list where the elements may be of the types
9690 listed above. Here's an example:
9693 (setq gnus-signature-limit
9694 '(200.0 "^---*Forwarded article"))
9697 This means that if there are more than 200 lines after the signature
9698 separator, or the text after the signature separator is matched by
9699 the regular expression @samp{^---*Forwarded article}, then it isn't a
9700 signature after all.
9703 @node Article Miscellanea
9704 @subsection Article Miscellanea
9708 @kindex A t (Summary)
9709 @findex gnus-article-babel
9710 Translate the article from one language to another
9711 (@code{gnus-article-babel}).
9717 @section MIME Commands
9718 @cindex MIME decoding
9720 @cindex viewing attachments
9722 The following commands all understand the numerical prefix. For
9723 instance, @kbd{3 K v} means ``view the third @acronym{MIME} part''.
9729 @kindex K v (Summary)
9730 View the @acronym{MIME} part.
9733 @kindex K o (Summary)
9734 Save the @acronym{MIME} part.
9737 @kindex K O (Summary)
9738 Prompt for a file name, then save the @acronym{MIME} part and strip it
9739 from the article. The stripped @acronym{MIME} object will be referred
9740 via the message/external-body @acronym{MIME} type.
9743 @kindex K r (Summary)
9744 Replace the @acronym{MIME} part with an external body.
9747 @kindex K d (Summary)
9748 Delete the @acronym{MIME} part and add some information about the
9752 @kindex K c (Summary)
9753 Copy the @acronym{MIME} part.
9756 @kindex K e (Summary)
9757 View the @acronym{MIME} part externally.
9760 @kindex K i (Summary)
9761 View the @acronym{MIME} part internally.
9764 @kindex K | (Summary)
9765 Pipe the @acronym{MIME} part to an external command.
9768 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9773 @kindex K H (Summary)
9774 @findex gnus-article-browse-html-article
9775 View @samp{text/html} parts of the current article with a WWW browser.
9776 Inline images embedded in a message using the @code{cid} scheme, as they
9777 are generally considered to be safe, will be processed properly. The
9778 message header is added to the beginning of every @acronym{HTML} part
9779 unless the prefix argument is given.
9781 Warning: Spammers use links to images (using the @code{http} scheme) in
9782 @acronym{HTML} articles to verify whether you have read the message. As
9783 this command passes the @acronym{HTML} content to the browser without
9784 eliminating these ``web bugs'' you should only use it for mails from
9787 If you always want to display @acronym{HTML} parts in the browser, set
9788 @code{mm-text-html-renderer} to @code{nil}.
9790 This command creates temporary files to pass @acronym{HTML} contents
9791 including images if any to the browser, and deletes them when exiting
9792 the group (if you want).
9795 @kindex K b (Summary)
9796 Make all the @acronym{MIME} parts have buttons in front of them. This is
9797 mostly useful if you wish to save (or perform other actions) on inlined
9801 @kindex K m (Summary)
9802 @findex gnus-summary-repair-multipart
9803 Some multipart messages are transmitted with missing or faulty headers.
9804 This command will attempt to ``repair'' these messages so that they can
9805 be viewed in a more pleasant manner
9806 (@code{gnus-summary-repair-multipart}).
9809 @kindex X m (Summary)
9810 @findex gnus-summary-save-parts
9811 Save all parts matching a @acronym{MIME} type to a directory
9812 (@code{gnus-summary-save-parts}). Understands the process/prefix
9813 convention (@pxref{Process/Prefix}).
9816 @kindex M-t (Summary)
9817 @findex gnus-summary-toggle-display-buttonized
9818 Toggle the buttonized display of the article buffer
9819 (@code{gnus-summary-toggle-display-buttonized}).
9822 @kindex W M w (Summary)
9823 @findex gnus-article-decode-mime-words
9824 Decode RFC 2047-encoded words in the article headers
9825 (@code{gnus-article-decode-mime-words}).
9828 @kindex W M c (Summary)
9829 @findex gnus-article-decode-charset
9830 Decode encoded article bodies as well as charsets
9831 (@code{gnus-article-decode-charset}).
9833 This command looks in the @code{Content-Type} header to determine the
9834 charset. If there is no such header in the article, you can give it a
9835 prefix, which will prompt for the charset to decode as. In regional
9836 groups where people post using some common encoding (but do not
9837 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9838 parameter to the required charset (@pxref{Group Parameters}).
9841 @kindex W M v (Summary)
9842 @findex gnus-mime-view-all-parts
9843 View all the @acronym{MIME} parts in the current article
9844 (@code{gnus-mime-view-all-parts}).
9851 @item gnus-ignored-mime-types
9852 @vindex gnus-ignored-mime-types
9853 This is a list of regexps. @acronym{MIME} types that match a regexp from
9854 this list will be completely ignored by Gnus. The default value is
9857 To have all Vcards be ignored, you'd say something like this:
9860 (setq gnus-ignored-mime-types
9864 @item gnus-article-loose-mime
9865 @vindex gnus-article-loose-mime
9866 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9867 before interpreting the message as a @acronym{MIME} message. This helps
9868 when reading messages from certain broken mail user agents. The
9869 default is @code{t}.
9871 @item gnus-article-emulate-mime
9872 @vindex gnus-article-emulate-mime
9875 There are other, non-@acronym{MIME} encoding methods used. The most common
9876 is @samp{uuencode}, but yEncode is also getting to be popular. If
9877 this variable is non-@code{nil}, Gnus will look in message bodies to
9878 see if it finds these encodings, and if so, it'll run them through the
9879 Gnus @acronym{MIME} machinery. The default is @code{t}. Only
9880 single-part yEnc encoded attachments can be decoded. There's no support
9881 for encoding in Gnus.
9883 @item gnus-unbuttonized-mime-types
9884 @vindex gnus-unbuttonized-mime-types
9885 This is a list of regexps. @acronym{MIME} types that match a regexp from
9886 this list won't have @acronym{MIME} buttons inserted unless they aren't
9887 displayed or this variable is overridden by
9888 @code{gnus-buttonized-mime-types}. The default value is
9889 @code{(".*/.*")}. This variable is only used when
9890 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9892 @item gnus-buttonized-mime-types
9893 @vindex gnus-buttonized-mime-types
9894 This is a list of regexps. @acronym{MIME} types that match a regexp from
9895 this list will have @acronym{MIME} buttons inserted unless they aren't
9896 displayed. This variable overrides
9897 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9898 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9901 E.g., to see security buttons but no other buttons, you could set this
9902 variable to @code{("multipart/signed")} and leave
9903 @code{gnus-unbuttonized-mime-types} at the default value.
9905 You could also add @code{"multipart/alternative"} to this list to
9906 display radio buttons that allow you to choose one of two media types
9907 those mails include. See also @code{mm-discouraged-alternatives}
9908 (@pxref{Display Customization, ,Display Customization, emacs-mime, The
9909 Emacs MIME Manual}).
9911 @item gnus-inhibit-mime-unbuttonizing
9912 @vindex gnus-inhibit-mime-unbuttonizing
9913 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9914 default value is @code{nil}.
9916 @item gnus-article-mime-part-function
9917 @vindex gnus-article-mime-part-function
9918 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9919 handle as the parameter. The function is meant to be used to allow
9920 users to gather information from the article (e.g., add Vcard info to
9921 the bbdb database) or to do actions based on parts (e.g., automatically
9922 save all jpegs into some directory).
9924 Here's an example function the does the latter:
9927 (defun my-save-all-jpeg-parts (handle)
9928 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9930 (insert (mm-get-part handle))
9931 (write-region (point-min) (point-max)
9932 (read-file-name "Save jpeg to: ")))))
9933 (setq gnus-article-mime-part-function
9934 'my-save-all-jpeg-parts)
9937 @vindex gnus-mime-multipart-functions
9938 @item gnus-mime-multipart-functions
9939 Alist of @acronym{MIME} multipart types and functions to handle them.
9941 @vindex gnus-mime-display-multipart-alternative-as-mixed
9942 @item gnus-mime-display-multipart-alternative-as-mixed
9943 Display "multipart/alternative" parts as "multipart/mixed".
9945 @vindex gnus-mime-display-multipart-related-as-mixed
9946 @item gnus-mime-display-multipart-related-as-mixed
9947 Display "multipart/related" parts as "multipart/mixed".
9949 If displaying @samp{text/html} is discouraged, see
9950 @code{mm-discouraged-alternatives}, images or other material inside a
9951 "multipart/related" part might be overlooked when this variable is
9952 @code{nil}. @ref{Display Customization, Display Customization, ,
9953 emacs-mime, Emacs-Mime Manual}.
9955 @vindex gnus-mime-display-multipart-as-mixed
9956 @item gnus-mime-display-multipart-as-mixed
9957 Display "multipart" parts as "multipart/mixed". If @code{t}, it
9958 overrides @code{nil} values of
9959 @code{gnus-mime-display-multipart-alternative-as-mixed} and
9960 @code{gnus-mime-display-multipart-related-as-mixed}.
9962 @vindex mm-file-name-rewrite-functions
9963 @item mm-file-name-rewrite-functions
9964 List of functions used for rewriting file names of @acronym{MIME} parts.
9965 Each function takes a file name as input and returns a file name.
9967 Ready-made functions include@*
9968 @code{mm-file-name-delete-whitespace},
9969 @code{mm-file-name-trim-whitespace},
9970 @code{mm-file-name-collapse-whitespace}, and
9971 @code{mm-file-name-replace-whitespace}. The later uses the value of
9972 the variable @code{mm-file-name-replace-whitespace} to replace each
9973 whitespace character in a file name with that string; default value
9974 is @code{"_"} (a single underscore).
9975 @findex mm-file-name-delete-whitespace
9976 @findex mm-file-name-trim-whitespace
9977 @findex mm-file-name-collapse-whitespace
9978 @findex mm-file-name-replace-whitespace
9979 @vindex mm-file-name-replace-whitespace
9981 The standard functions @code{capitalize}, @code{downcase},
9982 @code{upcase}, and @code{upcase-initials} may be useful, too.
9984 Everybody knows that whitespace characters in file names are evil,
9985 except those who don't know. If you receive lots of attachments from
9986 such unenlightened users, you can make live easier by adding
9989 (setq mm-file-name-rewrite-functions
9990 '(mm-file-name-trim-whitespace
9991 mm-file-name-collapse-whitespace
9992 mm-file-name-replace-whitespace))
9996 to your @file{~/.gnus.el} file.
10005 People use different charsets, and we have @acronym{MIME} to let us know what
10006 charsets they use. Or rather, we wish we had. Many people use
10007 newsreaders and mailers that do not understand or use @acronym{MIME}, and
10008 just send out messages without saying what character sets they use. To
10009 help a bit with this, some local news hierarchies have policies that say
10010 what character set is the default. For instance, the @samp{fj}
10011 hierarchy uses @code{iso-2022-jp}.
10013 @vindex gnus-group-charset-alist
10014 This knowledge is encoded in the @code{gnus-group-charset-alist}
10015 variable, which is an alist of regexps (use the first item to match full
10016 group names) and default charsets to be used when reading these groups.
10018 @vindex gnus-newsgroup-ignored-charsets
10019 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
10020 aren't. These blithely mark messages as being in @code{iso-8859-1}
10021 even if they really are in @code{koi-8}. To help here, the
10022 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
10023 charsets that are listed here will be ignored. The variable can be
10024 set on a group-by-group basis using the group parameters (@pxref{Group
10025 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
10026 which includes values some agents insist on having in there.
10028 @vindex gnus-group-posting-charset-alist
10029 When posting, @code{gnus-group-posting-charset-alist} is used to
10030 determine which charsets should not be encoded using the @acronym{MIME}
10031 encodings. For instance, some hierarchies discourage using
10032 quoted-printable header encoding.
10034 This variable is an alist of regexps and permitted unencoded charsets
10035 for posting. Each element of the alist has the form @code{(}@var{test
10036 header body-list}@code{)}, where:
10040 is either a regular expression matching the newsgroup header or a
10043 is the charset which may be left unencoded in the header (@code{nil}
10044 means encode all charsets),
10046 is a list of charsets which may be encoded using 8bit content-transfer
10047 encoding in the body, or one of the special values @code{nil} (always
10048 encode using quoted-printable) or @code{t} (always use 8bit).
10055 @cindex coding system aliases
10056 @cindex preferred charset
10058 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
10059 The Emacs MIME Manual}, for additional variables that control which
10060 MIME charsets are used when sending messages.
10062 Other charset tricks that may be useful, although not Gnus-specific:
10064 If there are several @acronym{MIME} charsets that encode the same Emacs
10065 charset, you can choose what charset to use by saying the following:
10068 (put-charset-property 'cyrillic-iso8859-5
10069 'preferred-coding-system 'koi8-r)
10072 This means that Russian will be encoded using @code{koi8-r} instead of
10073 the default @code{iso-8859-5} @acronym{MIME} charset.
10075 If you want to read messages in @code{koi8-u}, you can cheat and say
10078 (define-coding-system-alias 'koi8-u 'koi8-r)
10081 This will almost do the right thing.
10083 And finally, to read charsets like @code{windows-1251}, you can say
10087 (codepage-setup 1251)
10088 (define-coding-system-alias 'windows-1251 'cp1251)
10092 @node Article Commands
10093 @section Article Commands
10100 @kindex A P (Summary)
10101 @vindex gnus-ps-print-hook
10102 @findex gnus-summary-print-article
10103 Generate and print a PostScript image of the article buffer
10104 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
10105 be run just before printing the buffer. An alternative way to print
10106 article is to use Muttprint (@pxref{Saving Articles}).
10109 @vindex gnus-fetch-partial-articles
10110 @findex gnus-summary-show-complete-article
10111 If @code{<backend>-fetch-partial-articles} is non-@code{nil}, Gnus will
10112 fetch partial articles, if the backend it fetches them from supports
10113 it. Currently only @code{nnimap} does. If you're looking at a
10114 partial article, and want to see the complete article instead, then
10115 the @kbd{A C} command (@code{gnus-summary-show-complete-article}) will
10121 @node Summary Sorting
10122 @section Summary Sorting
10123 @cindex summary sorting
10125 You can have the summary buffer sorted in various ways, even though I
10126 can't really see why you'd want that.
10131 @kindex C-c C-s C-n (Summary)
10132 @findex gnus-summary-sort-by-number
10133 Sort by article number (@code{gnus-summary-sort-by-number}).
10135 @item C-c C-s C-m C-n
10136 @kindex C-c C-s C-n (Summary)
10137 @findex gnus-summary-sort-by-most-recent-number
10138 Sort by most recent article number
10139 (@code{gnus-summary-sort-by-most-recent-number}).
10142 @kindex C-c C-s C-a (Summary)
10143 @findex gnus-summary-sort-by-author
10144 Sort by author (@code{gnus-summary-sort-by-author}).
10147 @kindex C-c C-s C-t (Summary)
10148 @findex gnus-summary-sort-by-recipient
10149 Sort by recipient (@code{gnus-summary-sort-by-recipient}).
10152 @kindex C-c C-s C-s (Summary)
10153 @findex gnus-summary-sort-by-subject
10154 Sort by subject (@code{gnus-summary-sort-by-subject}).
10157 @kindex C-c C-s C-d (Summary)
10158 @findex gnus-summary-sort-by-date
10159 Sort by date (@code{gnus-summary-sort-by-date}).
10161 @item C-c C-s C-m C-d
10162 @kindex C-c C-s C-m C-d (Summary)
10163 @findex gnus-summary-sort-by-most-recent-date
10164 Sort by most recent date (@code{gnus-summary-sort-by-most-recent-date}).
10167 @kindex C-c C-s C-l (Summary)
10168 @findex gnus-summary-sort-by-lines
10169 Sort by lines (@code{gnus-summary-sort-by-lines}).
10172 @kindex C-c C-s C-c (Summary)
10173 @findex gnus-summary-sort-by-chars
10174 Sort by article length (@code{gnus-summary-sort-by-chars}).
10177 @kindex C-c C-s C-i (Summary)
10178 @findex gnus-summary-sort-by-score
10179 Sort by score (@code{gnus-summary-sort-by-score}).
10182 @kindex C-c C-s C-r (Summary)
10183 @findex gnus-summary-sort-by-random
10184 Randomize (@code{gnus-summary-sort-by-random}).
10187 @kindex C-c C-s C-o (Summary)
10188 @findex gnus-summary-sort-by-original
10189 Sort using the default sorting method
10190 (@code{gnus-summary-sort-by-original}).
10193 These functions will work both when you use threading and when you don't
10194 use threading. In the latter case, all summary lines will be sorted,
10195 line by line. In the former case, sorting will be done on a
10196 root-by-root basis, which might not be what you were looking for. To
10197 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
10200 If a prefix argument if given, the sort order is reversed.
10203 @node Finding the Parent
10204 @section Finding the Parent
10205 @cindex parent articles
10206 @cindex referring articles
10210 @kindex ^ (Summary)
10211 @findex gnus-summary-refer-parent-article
10212 If you'd like to read the parent of the current article, and it is not
10213 displayed in the summary buffer, you might still be able to. That is,
10214 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
10215 and the @code{References} in the current article are not mangled, you
10216 can just press @kbd{^} or @kbd{A r}
10217 (@code{gnus-summary-refer-parent-article}). If everything goes well,
10218 you'll get the parent. If the parent is already displayed in the
10219 summary buffer, point will just move to this article.
10221 If given a positive numerical prefix, fetch that many articles back into
10222 the ancestry. If given a negative numerical prefix, fetch just that
10223 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
10224 grandparent and the grandgrandparent of the current article. If you say
10225 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
10228 @item A R (Summary)
10229 @findex gnus-summary-refer-references
10230 @kindex A R (Summary)
10231 Fetch all articles mentioned in the @code{References} header of the
10232 article (@code{gnus-summary-refer-references}).
10234 @item A T (Summary)
10235 @findex gnus-summary-refer-thread
10236 @kindex A T (Summary)
10237 Display the full thread where the current article appears
10238 (@code{gnus-summary-refer-thread}). This command has to fetch all the
10239 headers in the current group to work, so it usually takes a while. If
10240 you do it often, you may consider setting @code{gnus-fetch-old-headers}
10241 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
10242 visible effects normally, but it'll make this command work a whole lot
10243 faster. Of course, it'll make group entry somewhat slow.
10245 @vindex gnus-refer-thread-limit
10246 The @code{gnus-refer-thread-limit} variable says how many old (i.e.,
10247 articles before the first displayed in the current group) headers to
10248 fetch when doing this command. The default is 200. If @code{t}, all
10249 the available headers will be fetched. This variable can be overridden
10250 by giving the @kbd{A T} command a numerical prefix.
10252 @item M-^ (Summary)
10253 @findex gnus-summary-refer-article
10254 @kindex M-^ (Summary)
10256 @cindex fetching by Message-ID
10257 You can also ask Gnus for an arbitrary article, no matter what group it
10258 belongs to. @kbd{M-^} (@code{gnus-summary-refer-article}) will ask you
10259 for a @code{Message-ID}, which is one of those long, hard-to-read
10260 thingies that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.
10261 You have to get it all exactly right. No fuzzy searches, I'm afraid.
10263 Gnus looks for the @code{Message-ID} in the headers that have already
10264 been fetched, but also tries all the select methods specified by
10265 @code{gnus-refer-article-method} if it is not found.
10268 @vindex gnus-refer-article-method
10269 If the group you are reading is located on a back end that does not
10270 support fetching by @code{Message-ID} very well (like @code{nnspool}),
10271 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
10272 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
10273 updating the spool you are reading from, but that's not really
10276 It can also be a list of select methods, as well as the special symbol
10277 @code{current}, which means to use the current select method. If it
10278 is a list, Gnus will try all the methods in the list until it finds a
10281 Here's an example setting that will first try the current method, and
10282 then ask Google if that fails:
10285 (setq gnus-refer-article-method
10287 (nnweb "google" (nnweb-type google))))
10290 Most of the mail back ends support fetching by @code{Message-ID}, but
10291 do not do a particularly excellent job at it. That is, @code{nnmbox},
10292 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
10293 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
10294 only able to locate articles that have been posted to the current
10295 group. @code{nnmh} does not support this at all.
10297 Fortunately, the special @code{nnregistry} back end is able to locate
10298 articles in any groups, regardless of their back end (@pxref{Registry
10299 Article Refer Method, fetching by @code{Message-ID} using the
10302 @node Alternative Approaches
10303 @section Alternative Approaches
10305 Different people like to read news using different methods. This being
10306 Gnus, we offer a small selection of minor modes for the summary buffers.
10309 * Pick and Read:: First mark articles and then read them.
10310 * Binary Groups:: Auto-decode all articles.
10314 @node Pick and Read
10315 @subsection Pick and Read
10316 @cindex pick and read
10318 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
10319 a two-phased reading interface. The user first marks in a summary
10320 buffer the articles she wants to read. Then she starts reading the
10321 articles with just an article buffer displayed.
10323 @findex gnus-pick-mode
10324 @kindex M-x gnus-pick-mode
10325 Gnus provides a summary buffer minor mode that allows
10326 this---@code{gnus-pick-mode}. This basically means that a few process
10327 mark commands become one-keystroke commands to allow easy marking, and
10328 it provides one additional command for switching to the summary buffer.
10330 Here are the available keystrokes when using pick mode:
10335 @findex gnus-pick-article-or-thread
10336 Pick the article or thread on the current line
10337 (@code{gnus-pick-article-or-thread}). If the variable
10338 @code{gnus-thread-hide-subtree} is true, then this key selects the
10339 entire thread when used at the first article of the thread. Otherwise,
10340 it selects just the article. If given a numerical prefix, go to that
10341 thread or article and pick it. (The line number is normally displayed
10342 at the beginning of the summary pick lines.)
10345 @kindex SPACE (Pick)
10346 @findex gnus-pick-next-page
10347 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
10348 at the end of the buffer, start reading the picked articles.
10352 @findex gnus-pick-unmark-article-or-thread.
10353 Unpick the thread or article
10354 (@code{gnus-pick-unmark-article-or-thread}). If the variable
10355 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
10356 thread if used at the first article of the thread. Otherwise it unpicks
10357 just the article. You can give this key a numerical prefix to unpick
10358 the thread or article at that line.
10362 @findex gnus-pick-start-reading
10363 @vindex gnus-pick-display-summary
10364 Start reading the picked articles (@code{gnus-pick-start-reading}). If
10365 given a prefix, mark all unpicked articles as read first. If
10366 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
10367 will still be visible when you are reading.
10371 All the normal summary mode commands are still available in the
10372 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
10373 which is mapped to the same function
10374 @code{gnus-summary-tick-article-forward}.
10376 If this sounds like a good idea to you, you could say:
10379 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
10382 @vindex gnus-pick-mode-hook
10383 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
10385 @vindex gnus-mark-unpicked-articles-as-read
10386 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
10387 all unpicked articles as read. The default is @code{nil}.
10389 @vindex gnus-summary-pick-line-format
10390 The summary line format in pick mode is slightly different from the
10391 standard format. At the beginning of each line the line number is
10392 displayed. The pick mode line format is controlled by the
10393 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
10394 Variables}). It accepts the same format specs that
10395 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
10398 @node Binary Groups
10399 @subsection Binary Groups
10400 @cindex binary groups
10402 @findex gnus-binary-mode
10403 @kindex M-x gnus-binary-mode
10404 If you spend much time in binary groups, you may grow tired of hitting
10405 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
10406 is a minor mode for summary buffers that makes all ordinary Gnus article
10407 selection functions uudecode series of articles and display the result
10408 instead of just displaying the articles the normal way.
10411 @findex gnus-binary-show-article
10412 The only way, in fact, to see the actual articles is the @kbd{g}
10413 command, when you have turned on this mode
10414 (@code{gnus-binary-show-article}).
10416 @vindex gnus-binary-mode-hook
10417 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
10421 @section Tree Display
10424 @vindex gnus-use-trees
10425 If you don't like the normal Gnus summary display, you might try setting
10426 @code{gnus-use-trees} to @code{t}. This will create (by default) an
10427 additional @dfn{tree buffer}. You can execute all summary mode commands
10428 in the tree buffer.
10430 There are a few variables to customize the tree display, of course:
10433 @item gnus-tree-mode-hook
10434 @vindex gnus-tree-mode-hook
10435 A hook called in all tree mode buffers.
10437 @item gnus-tree-mode-line-format
10438 @vindex gnus-tree-mode-line-format
10439 A format string for the mode bar in the tree mode buffers (@pxref{Mode
10440 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
10441 of valid specs, @pxref{Summary Buffer Mode Line}.
10443 @item gnus-selected-tree-face
10444 @vindex gnus-selected-tree-face
10445 Face used for highlighting the selected article in the tree buffer. The
10446 default is @code{modeline}.
10448 @item gnus-tree-line-format
10449 @vindex gnus-tree-line-format
10450 A format string for the tree nodes. The name is a bit of a misnomer,
10451 though---it doesn't define a line, but just the node. The default value
10452 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
10453 the name of the poster. It is vital that all nodes are of the same
10454 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
10460 The name of the poster.
10462 The @code{From} header.
10464 The number of the article.
10466 The opening bracket.
10468 The closing bracket.
10473 @xref{Formatting Variables}.
10475 Variables related to the display are:
10478 @item gnus-tree-brackets
10479 @vindex gnus-tree-brackets
10480 This is used for differentiating between ``real'' articles and
10481 ``sparse'' articles. The format is
10483 ((@var{real-open} . @var{real-close})
10484 (@var{sparse-open} . @var{sparse-close})
10485 (@var{dummy-open} . @var{dummy-close}))
10487 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
10489 @item gnus-tree-parent-child-edges
10490 @vindex gnus-tree-parent-child-edges
10491 This is a list that contains the characters used for connecting parent
10492 nodes to their children. The default is @code{(?- ?\\ ?|)}.
10496 @item gnus-tree-minimize-window
10497 @vindex gnus-tree-minimize-window
10498 If this variable is non-@code{nil}, Gnus will try to keep the tree
10499 buffer as small as possible to allow more room for the other Gnus
10500 windows. If this variable is a number, the tree buffer will never be
10501 higher than that number. The default is @code{t}. Note that if you
10502 have several windows displayed side-by-side in a frame and the tree
10503 buffer is one of these, minimizing the tree window will also resize all
10504 other windows displayed next to it.
10506 You may also wish to add the following hook to keep the window minimized
10510 (add-hook 'gnus-configure-windows-hook
10511 'gnus-tree-perhaps-minimize)
10514 @item gnus-generate-tree-function
10515 @vindex gnus-generate-tree-function
10516 @findex gnus-generate-horizontal-tree
10517 @findex gnus-generate-vertical-tree
10518 The function that actually generates the thread tree. Two predefined
10519 functions are available: @code{gnus-generate-horizontal-tree} and
10520 @code{gnus-generate-vertical-tree} (which is the default).
10524 Here's an example from a horizontal tree buffer:
10527 @{***@}-(***)-[odd]-[Gun]
10537 Here's the same thread displayed in a vertical tree buffer:
10542 |--------------------------\-----\-----\
10543 (***) [Bjo] [Gun] [Gun]
10545 [odd] [Jan] [odd] (***) [Jor]
10547 [Gun] [Eri] [Eri] [odd]
10553 If you're using horizontal trees, it might be nice to display the trees
10554 side-by-side with the summary buffer. You could add something like the
10555 following to your @file{~/.gnus.el} file:
10558 (setq gnus-use-trees t
10559 gnus-generate-tree-function 'gnus-generate-horizontal-tree
10560 gnus-tree-minimize-window nil)
10561 (gnus-add-configuration
10565 (summary 0.75 point)
10570 @xref{Window Layout}.
10573 @node Mail Group Commands
10574 @section Mail Group Commands
10575 @cindex mail group commands
10577 Some commands only make sense in mail groups. If these commands are
10578 invalid in the current group, they will raise a hell and let you know.
10580 All these commands (except the expiry and edit commands) use the
10581 process/prefix convention (@pxref{Process/Prefix}).
10586 @kindex B e (Summary)
10587 @findex gnus-summary-expire-articles
10588 @cindex expiring mail
10589 Run all expirable articles in the current group through the expiry
10590 process (@code{gnus-summary-expire-articles}). That is, delete all
10591 expirable articles in the group that have been around for a while.
10592 (@pxref{Expiring Mail}).
10595 @kindex B C-M-e (Summary)
10596 @findex gnus-summary-expire-articles-now
10597 @cindex expiring mail
10598 Delete all the expirable articles in the group
10599 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
10600 articles eligible for expiry in the current group will
10601 disappear forever into that big @file{/dev/null} in the sky.
10604 @kindex B DEL (Summary)
10605 @cindex deleting mail
10606 @findex gnus-summary-delete-article
10607 @c @icon{gnus-summary-mail-delete}
10608 Delete the mail article. This is ``delete'' as in ``delete it from your
10609 disk forever and ever, never to return again.'' Use with caution.
10610 (@code{gnus-summary-delete-article}).
10613 @kindex B m (Summary)
10615 @findex gnus-summary-move-article
10616 @vindex gnus-preserve-marks
10617 Move the article from one mail group to another
10618 (@code{gnus-summary-move-article}). Marks will be preserved if
10619 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10622 @kindex B c (Summary)
10624 @findex gnus-summary-copy-article
10625 @c @icon{gnus-summary-mail-copy}
10626 Copy the article from one group (mail group or not) to a mail group
10627 (@code{gnus-summary-copy-article}). Marks will be preserved if
10628 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10631 @kindex B B (Summary)
10632 @cindex crosspost mail
10633 @findex gnus-summary-crosspost-article
10634 Crosspost the current article to some other group
10635 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10636 the article in the other group, and the Xref headers of the article will
10637 be properly updated.
10640 @kindex B i (Summary)
10641 @findex gnus-summary-import-article
10642 Import an arbitrary file into the current mail newsgroup
10643 (@code{gnus-summary-import-article}). You will be prompted for a file
10644 name, a @code{From} header and a @code{Subject} header.
10647 @kindex B I (Summary)
10648 @findex gnus-summary-create-article
10649 Create an empty article in the current mail newsgroups
10650 (@code{gnus-summary-create-article}). You will be prompted for a
10651 @code{From} header and a @code{Subject} header.
10654 @kindex B r (Summary)
10655 @findex gnus-summary-respool-article
10656 @vindex gnus-summary-respool-default-method
10657 Respool the mail article (@code{gnus-summary-respool-article}).
10658 @code{gnus-summary-respool-default-method} will be used as the default
10659 select method when respooling. This variable is @code{nil} by default,
10660 which means that the current group select method will be used instead.
10661 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10662 (which is the default).
10666 @kindex B w (Summary)
10667 @kindex e (Summary)
10668 @findex gnus-summary-edit-article
10669 @kindex C-c C-c (Article)
10670 @findex gnus-summary-edit-article-done
10671 Edit the current article (@code{gnus-summary-edit-article}). To finish
10672 editing and make the changes permanent, type @kbd{C-c C-c}
10673 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10674 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
10677 @kindex B q (Summary)
10678 @findex gnus-summary-respool-query
10679 If you want to re-spool an article, you might be curious as to what group
10680 the article will end up in before you do the re-spooling. This command
10681 will tell you (@code{gnus-summary-respool-query}).
10684 @kindex B t (Summary)
10685 @findex gnus-summary-respool-trace
10686 Similarly, this command will display all fancy splitting patterns used
10687 when respooling, if any (@code{gnus-summary-respool-trace}).
10690 @kindex B p (Summary)
10691 @findex gnus-summary-article-posted-p
10692 Some people have a tendency to send you ``courtesy'' copies when they
10693 follow up to articles you have posted. These usually have a
10694 @code{Newsgroups} header in them, but not always. This command
10695 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10696 article from your news server (or rather, from
10697 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10698 report back whether it found the article or not. Even if it says that
10699 it didn't find the article, it may have been posted anyway---mail
10700 propagation is much faster than news propagation, and the news copy may
10701 just not have arrived yet.
10704 @kindex K E (Summary)
10705 @findex gnus-article-encrypt-body
10706 @vindex gnus-article-encrypt-protocol
10707 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10708 The body is encrypted with the encryption protocol specified by the
10709 variable @code{gnus-article-encrypt-protocol}.
10713 @vindex gnus-move-split-methods
10714 @cindex moving articles
10715 If you move (or copy) articles regularly, you might wish to have Gnus
10716 suggest where to put the articles. @code{gnus-move-split-methods} is a
10717 variable that uses the same syntax as @code{gnus-split-methods}
10718 (@pxref{Saving Articles}). You may customize that variable to create
10719 suggestions you find reasonable. (Note that
10720 @code{gnus-move-split-methods} uses group names where
10721 @code{gnus-split-methods} uses file names.)
10724 (setq gnus-move-split-methods
10725 '(("^From:.*Lars Magne" "nnml:junk")
10726 ("^Subject:.*gnus" "nnfolder:important")
10727 (".*" "nnml:misc")))
10731 @node Various Summary Stuff
10732 @section Various Summary Stuff
10735 * Summary Group Information:: Information oriented commands.
10736 * Searching for Articles:: Multiple article commands.
10737 * Summary Generation Commands::
10738 * Really Various Summary Commands:: Those pesky non-conformant commands.
10742 @vindex gnus-summary-display-while-building
10743 @item gnus-summary-display-while-building
10744 If non-@code{nil}, show and update the summary buffer as it's being
10745 built. If @code{t}, update the buffer after every line is inserted.
10746 If the value is an integer, @var{n}, update the display every @var{n}
10747 lines. The default is @code{nil}.
10749 @vindex gnus-summary-display-arrow
10750 @item gnus-summary-display-arrow
10751 If non-@code{nil}, display an arrow in the fringe to indicate the
10754 @vindex gnus-summary-mode-hook
10755 @item gnus-summary-mode-hook
10756 This hook is called when creating a summary mode buffer.
10758 @vindex gnus-summary-generate-hook
10759 @item gnus-summary-generate-hook
10760 This is called as the last thing before doing the threading and the
10761 generation of the summary buffer. It's quite convenient for customizing
10762 the threading variables based on what data the newsgroup has. This hook
10763 is called from the summary buffer after most summary buffer variables
10766 @vindex gnus-summary-prepare-hook
10767 @item gnus-summary-prepare-hook
10768 It is called after the summary buffer has been generated. You might use
10769 it to, for instance, highlight lines or modify the look of the buffer in
10770 some other ungodly manner. I don't care.
10772 @vindex gnus-summary-prepared-hook
10773 @item gnus-summary-prepared-hook
10774 A hook called as the very last thing after the summary buffer has been
10777 @vindex gnus-summary-ignore-duplicates
10778 @item gnus-summary-ignore-duplicates
10779 When Gnus discovers two articles that have the same @code{Message-ID},
10780 it has to do something drastic. No articles are allowed to have the
10781 same @code{Message-ID}, but this may happen when reading mail from some
10782 sources. Gnus allows you to customize what happens with this variable.
10783 If it is @code{nil} (which is the default), Gnus will rename the
10784 @code{Message-ID} (for display purposes only) and display the article as
10785 any other article. If this variable is @code{t}, it won't display the
10786 article---it'll be as if it never existed.
10788 @vindex gnus-alter-articles-to-read-function
10789 @item gnus-alter-articles-to-read-function
10790 This function, which takes two parameters (the group name and the list
10791 of articles to be selected), is called to allow the user to alter the
10792 list of articles to be selected.
10794 For instance, the following function adds the list of cached articles to
10795 the list in one particular group:
10798 (defun my-add-cached-articles (group articles)
10799 (if (string= group "some.group")
10800 (append gnus-newsgroup-cached articles)
10804 @vindex gnus-newsgroup-variables
10805 @item gnus-newsgroup-variables
10806 A list of newsgroup (summary buffer) local variables, or cons of
10807 variables and their default expressions to be evalled (when the default
10808 values are not @code{nil}), that should be made global while the summary
10811 Note: The default expressions will be evaluated (using function
10812 @code{eval}) before assignment to the local variable rather than just
10813 assigned to it. If the default expression is the symbol @code{global},
10814 that symbol will not be evaluated but the global value of the local
10815 variable will be used instead.
10817 These variables can be used to set variables in the group parameters
10818 while still allowing them to affect operations done in other
10819 buffers. For example:
10822 (setq gnus-newsgroup-variables
10823 '(message-use-followup-to
10824 (gnus-visible-headers .
10825 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10828 Also @pxref{Group Parameters}.
10833 @node Summary Group Information
10834 @subsection Summary Group Information
10839 @kindex H d (Summary)
10840 @findex gnus-summary-describe-group
10841 Give a brief description of the current group
10842 (@code{gnus-summary-describe-group}). If given a prefix, force
10843 rereading the description from the server.
10846 @kindex H h (Summary)
10847 @findex gnus-summary-describe-briefly
10848 Give an extremely brief description of the most important summary
10849 keystrokes (@code{gnus-summary-describe-briefly}).
10852 @kindex H i (Summary)
10853 @findex gnus-info-find-node
10854 Go to the Gnus info node (@code{gnus-info-find-node}).
10858 @node Searching for Articles
10859 @subsection Searching for Articles
10864 @kindex M-s (Summary)
10865 @findex gnus-summary-search-article-forward
10866 Search through all subsequent (raw) articles for a regexp
10867 (@code{gnus-summary-search-article-forward}).
10870 @kindex M-r (Summary)
10871 @findex gnus-summary-search-article-backward
10872 Search through all previous (raw) articles for a regexp
10873 (@code{gnus-summary-search-article-backward}).
10876 @kindex M-S (Summary)
10877 @findex gnus-summary-repeat-search-article-forward
10878 Repeat the previous search forwards
10879 (@code{gnus-summary-repeat-search-article-forward}).
10882 @kindex M-R (Summary)
10883 @findex gnus-summary-repeat-search-article-backward
10884 Repeat the previous search backwards
10885 (@code{gnus-summary-repeat-search-article-backward}).
10888 @kindex & (Summary)
10889 @findex gnus-summary-execute-command
10890 This command will prompt you for a header, a regular expression to match
10891 on this field, and a command to be executed if the match is made
10892 (@code{gnus-summary-execute-command}). If the header is an empty
10893 string, the match is done on the entire article. If given a prefix,
10894 search backward instead.
10896 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10897 all articles that have heads or bodies that match @samp{some.*string}.
10900 @kindex M-& (Summary)
10901 @findex gnus-summary-universal-argument
10902 Perform any operation on all articles that have been marked with
10903 the process mark (@code{gnus-summary-universal-argument}).
10906 @node Summary Generation Commands
10907 @subsection Summary Generation Commands
10912 @kindex Y g (Summary)
10913 @findex gnus-summary-prepare
10914 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10917 @kindex Y c (Summary)
10918 @findex gnus-summary-insert-cached-articles
10919 Pull all cached articles (for the current group) into the summary buffer
10920 (@code{gnus-summary-insert-cached-articles}).
10923 @kindex Y d (Summary)
10924 @findex gnus-summary-insert-dormant-articles
10925 Pull all dormant articles (for the current group) into the summary buffer
10926 (@code{gnus-summary-insert-dormant-articles}).
10929 @kindex Y t (Summary)
10930 @findex gnus-summary-insert-ticked-articles
10931 Pull all ticked articles (for the current group) into the summary buffer
10932 (@code{gnus-summary-insert-ticked-articles}).
10937 @node Really Various Summary Commands
10938 @subsection Really Various Summary Commands
10944 @kindex C-d (Summary)
10945 @kindex A D (Summary)
10946 @findex gnus-summary-enter-digest-group
10947 If the current article is a collection of other articles (for instance,
10948 a digest), you might use this command to enter a group based on the that
10949 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10950 guess what article type is currently displayed unless you give a prefix
10951 to this command, which forces a ``digest'' interpretation. Basically,
10952 whenever you see a message that is a collection of other messages of
10953 some format, you @kbd{C-d} and read these messages in a more convenient
10956 @vindex gnus-auto-select-on-ephemeral-exit
10957 The variable @code{gnus-auto-select-on-ephemeral-exit} controls what
10958 article should be selected after exiting a digest group. Valid values
10963 Select the next article.
10966 Select the next unread article.
10968 @item next-noselect
10969 Move the cursor to the next article. This is the default.
10971 @item next-unread-noselect
10972 Move the cursor to the next unread article.
10975 If it has any other value or there is no next (unread) article, the
10976 article selected before entering to the digest group will appear.
10979 @kindex C-M-d (Summary)
10980 @findex gnus-summary-read-document
10981 This command is very similar to the one above, but lets you gather
10982 several documents into one biiig group
10983 (@code{gnus-summary-read-document}). It does this by opening several
10984 @code{nndoc} groups for each document, and then opening an
10985 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10986 command understands the process/prefix convention
10987 (@pxref{Process/Prefix}).
10990 @kindex C-t (Summary)
10991 @findex gnus-summary-toggle-truncation
10992 Toggle truncation of summary lines
10993 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10994 line centering function in the summary buffer, so it's not a good idea
10995 to have truncation switched off while reading articles.
10998 @kindex = (Summary)
10999 @findex gnus-summary-expand-window
11000 Expand the summary buffer window (@code{gnus-summary-expand-window}).
11001 If given a prefix, force an @code{article} window configuration.
11004 @kindex C-M-e (Summary)
11005 @findex gnus-summary-edit-parameters
11006 Edit the group parameters (@pxref{Group Parameters}) of the current
11007 group (@code{gnus-summary-edit-parameters}).
11010 @kindex C-M-a (Summary)
11011 @findex gnus-summary-customize-parameters
11012 Customize the group parameters (@pxref{Group Parameters}) of the current
11013 group (@code{gnus-summary-customize-parameters}).
11018 @node Exiting the Summary Buffer
11019 @section Exiting the Summary Buffer
11020 @cindex summary exit
11021 @cindex exiting groups
11023 Exiting from the summary buffer will normally update all info on the
11024 group and return you to the group buffer.
11031 @kindex Z Z (Summary)
11032 @kindex Z Q (Summary)
11033 @kindex q (Summary)
11034 @findex gnus-summary-exit
11035 @vindex gnus-summary-exit-hook
11036 @vindex gnus-summary-prepare-exit-hook
11037 @vindex gnus-group-no-more-groups-hook
11038 @c @icon{gnus-summary-exit}
11039 Exit the current group and update all information on the group
11040 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
11041 called before doing much of the exiting, which calls
11042 @code{gnus-summary-expire-articles} by default.
11043 @code{gnus-summary-exit-hook} is called after finishing the exit
11044 process. @code{gnus-group-no-more-groups-hook} is run when returning to
11045 group mode having no more (unread) groups.
11049 @kindex Z E (Summary)
11050 @kindex Q (Summary)
11051 @findex gnus-summary-exit-no-update
11052 Exit the current group without updating any information on the group
11053 (@code{gnus-summary-exit-no-update}).
11057 @kindex Z c (Summary)
11058 @kindex c (Summary)
11059 @findex gnus-summary-catchup-and-exit
11060 @c @icon{gnus-summary-catchup-and-exit}
11061 Mark all unticked articles in the group as read and then exit
11062 (@code{gnus-summary-catchup-and-exit}).
11065 @kindex Z C (Summary)
11066 @findex gnus-summary-catchup-all-and-exit
11067 Mark all articles, even the ticked ones, as read and then exit
11068 (@code{gnus-summary-catchup-all-and-exit}).
11071 @kindex Z n (Summary)
11072 @findex gnus-summary-catchup-and-goto-next-group
11073 Mark all articles as read and go to the next group
11074 (@code{gnus-summary-catchup-and-goto-next-group}).
11077 @kindex Z p (Summary)
11078 @findex gnus-summary-catchup-and-goto-prev-group
11079 Mark all articles as read and go to the previous group
11080 (@code{gnus-summary-catchup-and-goto-prev-group}).
11084 @kindex Z R (Summary)
11085 @kindex C-x C-s (Summary)
11086 @findex gnus-summary-reselect-current-group
11087 Exit this group, and then enter it again
11088 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
11089 all articles, both read and unread.
11093 @kindex Z G (Summary)
11094 @kindex M-g (Summary)
11095 @findex gnus-summary-rescan-group
11096 @c @icon{gnus-summary-mail-get}
11097 Exit the group, check for new articles in the group, and select the
11098 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
11099 articles, both read and unread.
11102 @kindex Z N (Summary)
11103 @findex gnus-summary-next-group
11104 Exit the group and go to the next group
11105 (@code{gnus-summary-next-group}).
11108 @kindex Z P (Summary)
11109 @findex gnus-summary-prev-group
11110 Exit the group and go to the previous group
11111 (@code{gnus-summary-prev-group}).
11114 @kindex Z s (Summary)
11115 @findex gnus-summary-save-newsrc
11116 Save the current number of read/marked articles in the dribble buffer
11117 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
11118 given a prefix, also save the @file{.newsrc} file(s). Using this
11119 command will make exit without updating (the @kbd{Q} command) worthless.
11122 @vindex gnus-exit-group-hook
11123 @code{gnus-exit-group-hook} is called when you exit the current group
11124 with an ``updating'' exit. For instance @kbd{Q}
11125 (@code{gnus-summary-exit-no-update}) does not call this hook.
11127 @findex gnus-summary-wake-up-the-dead
11128 @findex gnus-dead-summary-mode
11129 @vindex gnus-kill-summary-on-exit
11130 If you're in the habit of exiting groups, and then changing your mind
11131 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
11132 If you do that, Gnus won't kill the summary buffer when you exit it.
11133 (Quelle surprise!) Instead it will change the name of the buffer to
11134 something like @samp{*Dead Summary ... *} and install a minor mode
11135 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
11136 buffer, you'll find that all keys are mapped to a function called
11137 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
11138 summary buffer will result in a live, normal summary buffer.
11140 There will never be more than one dead summary buffer at any one time.
11142 @vindex gnus-use-cross-reference
11143 The data on the current group will be updated (which articles you have
11144 read, which articles you have replied to, etc.)@: when you exit the
11145 summary buffer. If the @code{gnus-use-cross-reference} variable is
11146 @code{t} (which is the default), articles that are cross-referenced to
11147 this group and are marked as read, will also be marked as read in the
11148 other subscribed groups they were cross-posted to. If this variable is
11149 neither @code{nil} nor @code{t}, the article will be marked as read in
11150 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
11153 @node Crosspost Handling
11154 @section Crosspost Handling
11158 Marking cross-posted articles as read ensures that you'll never have to
11159 read the same article more than once. Unless, of course, somebody has
11160 posted it to several groups separately. Posting the same article to
11161 several groups (not cross-posting) is called @dfn{spamming}, and you are
11162 by law required to send nasty-grams to anyone who perpetrates such a
11165 Remember: Cross-posting is kinda ok, but posting the same article
11166 separately to several groups is not. Massive cross-posting (aka.
11167 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
11168 @code{gnus-summary-mail-crosspost-complaint} command to complain about
11169 excessive crossposting (@pxref{Summary Mail Commands}).
11171 @cindex cross-posting
11173 @cindex @acronym{NOV}
11174 One thing that may cause Gnus to not do the cross-posting thing
11175 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
11176 (which is very nice, because it speeds things up considerably) which
11177 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
11178 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
11179 even with @sc{xover} by registering the @code{Xref} lines of all
11180 articles you actually read, but if you kill the articles, or just mark
11181 them as read without reading them, Gnus will not get a chance to snoop
11182 the @code{Xref} lines out of these articles, and will be unable to use
11183 the cross reference mechanism.
11185 @cindex LIST overview.fmt
11186 @cindex overview.fmt
11187 To check whether your @acronym{NNTP} server includes the @code{Xref} header
11188 in its overview files, try @samp{telnet your.nntp.server nntp},
11189 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
11190 overview.fmt}. This may not work, but if it does, and the last line you
11191 get does not read @samp{Xref:full}, then you should shout and whine at
11192 your news admin until she includes the @code{Xref} header in the
11195 If you want Gnus to get the @code{Xref}s right all the time, you have to
11196 set @code{nntp-nov-is-evil} to @code{t}, which slows things down
11197 considerably. Also @pxref{Slow/Expensive Connection}.
11201 For an alternative approach, @pxref{Duplicate Suppression}.
11204 @node Duplicate Suppression
11205 @section Duplicate Suppression
11207 By default, Gnus tries to make sure that you don't have to read the same
11208 article more than once by utilizing the crossposting mechanism
11209 (@pxref{Crosspost Handling}). However, that simple and efficient
11210 approach may not work satisfactory for some users for various
11215 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
11216 is evil and not very common.
11219 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
11220 @file{.overview} data bases. This is evil and all too common, alas.
11223 You may be reading the same group (or several related groups) from
11224 different @acronym{NNTP} servers.
11227 You may be getting mail that duplicates articles posted to groups.
11230 I'm sure there are other situations where @code{Xref} handling fails as
11231 well, but these four are the most common situations.
11233 If, and only if, @code{Xref} handling fails for you, then you may
11234 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
11235 will remember the @code{Message-ID}s of all articles you have read or
11236 otherwise marked as read, and then, as if by magic, mark them as read
11237 all subsequent times you see them---in @emph{all} groups. Using this
11238 mechanism is quite likely to be somewhat inefficient, but not overly
11239 so. It's certainly preferable to reading the same articles more than
11242 Duplicate suppression is not a very subtle instrument. It's more like a
11243 sledge hammer than anything else. It works in a very simple
11244 fashion---if you have marked an article as read, it adds this Message-ID
11245 to a cache. The next time it sees this Message-ID, it will mark the
11246 article as read with the @samp{M} mark. It doesn't care what group it
11247 saw the article in.
11250 @item gnus-suppress-duplicates
11251 @vindex gnus-suppress-duplicates
11252 If non-@code{nil}, suppress duplicates.
11254 @item gnus-save-duplicate-list
11255 @vindex gnus-save-duplicate-list
11256 If non-@code{nil}, save the list of duplicates to a file. This will
11257 make startup and shutdown take longer, so the default is @code{nil}.
11258 However, this means that only duplicate articles read in a single Gnus
11259 session are suppressed.
11261 @item gnus-duplicate-list-length
11262 @vindex gnus-duplicate-list-length
11263 This variable says how many @code{Message-ID}s to keep in the duplicate
11264 suppression list. The default is 10000.
11266 @item gnus-duplicate-file
11267 @vindex gnus-duplicate-file
11268 The name of the file to store the duplicate suppression list in. The
11269 default is @file{~/News/suppression}.
11272 If you have a tendency to stop and start Gnus often, setting
11273 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
11274 you leave Gnus running for weeks on end, you may have it @code{nil}. On
11275 the other hand, saving the list makes startup and shutdown much slower,
11276 so that means that if you stop and start Gnus often, you should set
11277 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
11278 to you to figure out, I think.
11283 Gnus is able to verify signed messages or decrypt encrypted messages.
11284 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
11285 and @acronym{S/MIME}, however you need some external programs to get
11290 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
11291 install an OpenPGP implementation such as GnuPG@. The Lisp interface
11292 to GnuPG included with Emacs is called EasyPG (@pxref{Top, ,EasyPG,
11293 epa, EasyPG Assistant user's manual}), but PGG (@pxref{Top, ,PGG, pgg,
11294 PGG Manual}), and Mailcrypt are also supported.
11297 To handle @acronym{S/MIME} message, you need to install OpenSSL@. OpenSSL 0.9.6
11298 or newer is recommended.
11302 The variables that control security functionality on reading/composing
11306 @item mm-verify-option
11307 @vindex mm-verify-option
11308 Option of verifying signed parts. @code{never}, not verify;
11309 @code{always}, always verify; @code{known}, only verify known
11310 protocols. Otherwise, ask user.
11312 @item mm-decrypt-option
11313 @vindex mm-decrypt-option
11314 Option of decrypting encrypted parts. @code{never}, no decryption;
11315 @code{always}, always decrypt; @code{known}, only decrypt known
11316 protocols. Otherwise, ask user.
11318 @item mm-sign-option
11319 @vindex mm-sign-option
11320 Option of creating signed parts. @code{nil}, use default signing
11321 keys; @code{guided}, ask user to select signing keys from the menu.
11323 @item mm-encrypt-option
11324 @vindex mm-encrypt-option
11325 Option of creating encrypted parts. @code{nil}, use the first
11326 public-key matching the @samp{From:} header as the recipient;
11327 @code{guided}, ask user to select recipient keys from the menu.
11330 @vindex mml1991-use
11331 Symbol indicating elisp interface to OpenPGP implementation for
11332 @acronym{PGP} messages. The default is @code{epg}, but @code{pgg},
11333 and @code{mailcrypt} are also supported although
11334 deprecated. By default, Gnus uses the first available interface in
11338 @vindex mml2015-use
11339 Symbol indicating elisp interface to OpenPGP implementation for
11340 @acronym{PGP/MIME} messages. The default is @code{epg}, but
11341 @code{pgg}, and @code{mailcrypt} are also supported
11342 although deprecated. By default, Gnus uses the first available
11343 interface in this order.
11347 By default the buttons that display security information are not
11348 shown, because they clutter reading the actual e-mail. You can type
11349 @kbd{K b} manually to display the information. Use the
11350 @code{gnus-buttonized-mime-types} and
11351 @code{gnus-unbuttonized-mime-types} variables to control this
11352 permanently. @ref{MIME Commands} for further details, and hints on
11353 how to customize these variables to always display security
11356 @cindex snarfing keys
11357 @cindex importing PGP keys
11358 @cindex PGP key ring import
11359 Snarfing OpenPGP keys (i.e., importing keys from articles into your
11360 key ring) is not supported explicitly through a menu item or command,
11361 rather Gnus do detect and label keys as @samp{application/pgp-keys},
11362 allowing you to specify whatever action you think is appropriate
11363 through the usual @acronym{MIME} infrastructure. You can use a
11364 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
11365 Emacs MIME Manual}) such as the following to import keys using GNU
11366 Privacy Guard when you click on the @acronym{MIME} button
11367 (@pxref{Using MIME}).
11370 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
11373 This happens to also be the default action defined in
11374 @code{mailcap-mime-data}.
11376 More information on how to set things for sending outgoing signed and
11377 encrypted messages up can be found in the message manual
11378 (@pxref{Security, ,Security, message, Message Manual}).
11381 @section Mailing List
11382 @cindex mailing list
11385 @kindex A M (summary)
11386 @findex gnus-mailing-list-insinuate
11387 Gnus understands some mailing list fields of RFC 2369. To enable it,
11388 add a @code{to-list} group parameter (@pxref{Group Parameters}),
11389 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
11392 That enables the following commands to the summary buffer:
11397 @kindex C-c C-n h (Summary)
11398 @findex gnus-mailing-list-help
11399 Send a message to fetch mailing list help, if List-Help field exists.
11402 @kindex C-c C-n s (Summary)
11403 @findex gnus-mailing-list-subscribe
11404 Send a message to subscribe the mailing list, if List-Subscribe field exists.
11407 @kindex C-c C-n u (Summary)
11408 @findex gnus-mailing-list-unsubscribe
11409 Send a message to unsubscribe the mailing list, if List-Unsubscribe
11413 @kindex C-c C-n p (Summary)
11414 @findex gnus-mailing-list-post
11415 Post to the mailing list, if List-Post field exists.
11418 @kindex C-c C-n o (Summary)
11419 @findex gnus-mailing-list-owner
11420 Send a message to the mailing list owner, if List-Owner field exists.
11423 @kindex C-c C-n a (Summary)
11424 @findex gnus-mailing-list-archive
11425 Browse the mailing list archive, if List-Archive field exists.
11430 @node Article Buffer
11431 @chapter Article Buffer
11432 @cindex article buffer
11434 The articles are displayed in the article buffer, of which there is only
11435 one. All the summary buffers share the same article buffer unless you
11436 tell Gnus otherwise.
11439 * Hiding Headers:: Deciding what headers should be displayed.
11440 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
11441 * HTML:: Reading @acronym{HTML} messages.
11442 * Customizing Articles:: Tailoring the look of the articles.
11443 * Article Keymap:: Keystrokes available in the article buffer.
11444 * Misc Article:: Other stuff.
11448 @node Hiding Headers
11449 @section Hiding Headers
11450 @cindex hiding headers
11451 @cindex deleting headers
11453 The top section of each article is the @dfn{head}. (The rest is the
11454 @dfn{body}, but you may have guessed that already.)
11456 @vindex gnus-show-all-headers
11457 There is a lot of useful information in the head: the name of the person
11458 who wrote the article, the date it was written and the subject of the
11459 article. That's well and nice, but there's also lots of information
11460 most people do not want to see---what systems the article has passed
11461 through before reaching you, the @code{Message-ID}, the
11462 @code{References}, etc. ad nauseam---and you'll probably want to get rid
11463 of some of those lines. If you want to keep all those lines in the
11464 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
11466 Gnus provides you with two variables for sifting headers:
11470 @item gnus-visible-headers
11471 @vindex gnus-visible-headers
11472 If this variable is non-@code{nil}, it should be a regular expression
11473 that says what headers you wish to keep in the article buffer. All
11474 headers that do not match this variable will be hidden.
11476 For instance, if you only want to see the name of the person who wrote
11477 the article and the subject, you'd say:
11480 (setq gnus-visible-headers "^From:\\|^Subject:")
11483 This variable can also be a list of regexps to match headers to
11486 @item gnus-ignored-headers
11487 @vindex gnus-ignored-headers
11488 This variable is the reverse of @code{gnus-visible-headers}. If this
11489 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
11490 should be a regular expression that matches all lines that you want to
11491 hide. All lines that do not match this variable will remain visible.
11493 For instance, if you just want to get rid of the @code{References} line
11494 and the @code{Xref} line, you might say:
11497 (setq gnus-ignored-headers "^References:\\|^Xref:")
11500 This variable can also be a list of regexps to match headers to
11503 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
11504 variable will have no effect.
11508 @vindex gnus-sorted-header-list
11509 Gnus can also sort the headers for you. (It does this by default.) You
11510 can control the sorting by setting the @code{gnus-sorted-header-list}
11511 variable. It is a list of regular expressions that says in what order
11512 the headers are to be displayed.
11514 For instance, if you want the name of the author of the article first,
11515 and then the subject, you might say something like:
11518 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
11521 Any headers that are to remain visible, but are not listed in this
11522 variable, will be displayed in random order after all the headers listed in this variable.
11524 @findex gnus-article-hide-boring-headers
11525 @vindex gnus-boring-article-headers
11526 You can hide further boring headers by setting
11527 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
11528 does depends on the @code{gnus-boring-article-headers} variable. It's a
11529 list, but this list doesn't actually contain header names. Instead it
11530 lists various @dfn{boring conditions} that Gnus can check and remove
11533 These conditions are:
11536 Remove all empty headers.
11538 Remove the @code{Followup-To} header if it is identical to the
11539 @code{Newsgroups} header.
11541 Remove the @code{Reply-To} header if it lists the same addresses as
11542 the @code{From} header, or if the @code{broken-reply-to} group
11545 Remove the @code{Newsgroups} header if it only contains the current group
11548 Remove the @code{To} header if it only contains the address identical to
11549 the current group's @code{to-address} parameter.
11551 Remove the @code{To} header if it only contains the address identical to
11552 the current group's @code{to-list} parameter.
11554 Remove the @code{Cc} header if it only contains the address identical to
11555 the current group's @code{to-list} parameter.
11557 Remove the @code{Date} header if the article is less than three days
11560 Remove the @code{To} and/or @code{Cc} header if it is very long.
11562 Remove all @code{To} and/or @code{Cc} headers if there are more than one.
11565 To include these three elements, you could say something like:
11568 (setq gnus-boring-article-headers
11569 '(empty followup-to reply-to))
11572 This is also the default value for this variable.
11576 @section Using MIME
11577 @cindex @acronym{MIME}
11579 Mime is a standard for waving your hands through the air, aimlessly,
11580 while people stand around yawning.
11582 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
11583 while all newsreaders die of fear.
11585 @acronym{MIME} may specify what character set the article uses, the encoding
11586 of the characters, and it also makes it possible to embed pictures and
11587 other naughty stuff in innocent-looking articles.
11589 @vindex gnus-display-mime-function
11590 @findex gnus-display-mime
11591 Gnus pushes @acronym{MIME} articles through @code{gnus-display-mime-function}
11592 to display the @acronym{MIME} parts. This is @code{gnus-display-mime} by
11593 default, which creates a bundle of clickable buttons that can be used to
11594 display, save and manipulate the @acronym{MIME} objects.
11596 The following commands are available when you have placed point over a
11597 @acronym{MIME} button:
11600 @findex gnus-article-press-button
11601 @item RET (Article)
11602 @kindex RET (Article)
11603 @itemx BUTTON-2 (Article)
11604 Toggle displaying of the @acronym{MIME} object
11605 (@code{gnus-article-press-button}). If built-in viewers can not display
11606 the object, Gnus resorts to external viewers in the @file{mailcap}
11607 files. If a viewer has the @samp{copiousoutput} specification, the
11608 object is displayed inline.
11610 @findex gnus-mime-view-part
11611 @item M-RET (Article)
11612 @kindex M-RET (Article)
11614 Prompt for a method, and then view the @acronym{MIME} object using this
11615 method (@code{gnus-mime-view-part}).
11617 @findex gnus-mime-view-part-as-type
11619 @kindex t (Article)
11620 View the @acronym{MIME} object as if it were a different @acronym{MIME} media type
11621 (@code{gnus-mime-view-part-as-type}).
11623 @findex gnus-mime-view-part-as-charset
11625 @kindex C (Article)
11626 Prompt for a charset, and then view the @acronym{MIME} object using this
11627 charset (@code{gnus-mime-view-part-as-charset}).
11629 @findex gnus-mime-save-part
11631 @kindex o (Article)
11632 Prompt for a file name, and then save the @acronym{MIME} object
11633 (@code{gnus-mime-save-part}).
11635 @findex gnus-mime-save-part-and-strip
11636 @item C-o (Article)
11637 @kindex C-o (Article)
11638 Prompt for a file name, then save the @acronym{MIME} object and strip it from
11639 the article. Then proceed to article editing, where a reasonable
11640 suggestion is being made on how the altered article should look
11641 like. The stripped @acronym{MIME} object will be referred via the
11642 message/external-body @acronym{MIME} type.
11643 (@code{gnus-mime-save-part-and-strip}).
11645 @findex gnus-mime-replace-part
11647 @kindex r (Article)
11648 Prompt for a file name, replace the @acronym{MIME} object with an
11649 external body referring to the file via the message/external-body
11650 @acronym{MIME} type. (@code{gnus-mime-replace-part}).
11652 @findex gnus-mime-delete-part
11654 @kindex d (Article)
11655 Delete the @acronym{MIME} object from the article and replace it with some
11656 information about the removed @acronym{MIME} object
11657 (@code{gnus-mime-delete-part}).
11659 @c FIXME: gnus-auto-select-part should be documented here
11661 @findex gnus-mime-copy-part
11663 @kindex c (Article)
11664 Copy the @acronym{MIME} object to a fresh buffer and display this buffer
11665 (@code{gnus-mime-copy-part}). If given a prefix, copy the raw contents
11666 without decoding. If given a numerical prefix, you can do semi-manual
11667 charset stuff (see @code{gnus-summary-show-article-charset-alist} in
11668 @ref{Paging the Article}). Compressed files like @file{.gz} and
11669 @file{.bz2} are automatically decompressed if
11670 @code{auto-compression-mode} is enabled (@pxref{Compressed Files,,
11671 Accessing Compressed Files, emacs, The Emacs Editor}).
11673 @findex gnus-mime-print-part
11675 @kindex p (Article)
11676 Print the @acronym{MIME} object (@code{gnus-mime-print-part}). This
11677 command respects the @samp{print=} specifications in the
11678 @file{.mailcap} file.
11680 @findex gnus-mime-inline-part
11682 @kindex i (Article)
11683 Insert the contents of the @acronym{MIME} object into the buffer
11684 (@code{gnus-mime-inline-part}) as @samp{text/plain}. If given a prefix, insert
11685 the raw contents without decoding. If given a numerical prefix, you can
11686 do semi-manual charset stuff (see
11687 @code{gnus-summary-show-article-charset-alist} in @ref{Paging the
11688 Article}). Compressed files like @file{.gz} and @file{.bz2} are
11689 automatically decompressed depending on @code{jka-compr} regardless of
11690 @code{auto-compression-mode} (@pxref{Compressed Files,, Accessing
11691 Compressed Files, emacs, The Emacs Editor}).
11693 @findex gnus-mime-view-part-internally
11695 @kindex E (Article)
11696 View the @acronym{MIME} object with an internal viewer. If no internal
11697 viewer is available, use an external viewer
11698 (@code{gnus-mime-view-part-internally}).
11700 @findex gnus-mime-view-part-externally
11702 @kindex e (Article)
11703 View the @acronym{MIME} object with an external viewer.
11704 (@code{gnus-mime-view-part-externally}).
11706 @findex gnus-mime-pipe-part
11708 @kindex | (Article)
11709 Output the @acronym{MIME} object to a process (@code{gnus-mime-pipe-part}).
11711 @findex gnus-mime-action-on-part
11713 @kindex . (Article)
11714 Interactively run an action on the @acronym{MIME} object
11715 (@code{gnus-mime-action-on-part}).
11719 Gnus will display some @acronym{MIME} objects automatically. The way Gnus
11720 determines which parts to do this with is described in the Emacs
11721 @acronym{MIME} manual.
11723 It might be best to just use the toggling functions from the article
11724 buffer to avoid getting nasty surprises. (For instance, you enter the
11725 group @samp{alt.sing-a-long} and, before you know it, @acronym{MIME} has
11726 decoded the sound file in the article and some horrible sing-a-long song
11727 comes screaming out your speakers, and you can't find the volume button,
11728 because there isn't one, and people are starting to look at you, and you
11729 try to stop the program, but you can't, and you can't find the program
11730 to control the volume, and everybody else in the room suddenly decides
11731 to look at you disdainfully, and you'll feel rather stupid.)
11733 Any similarity to real events and people is purely coincidental. Ahem.
11735 Also @pxref{MIME Commands}.
11739 @section @acronym{HTML}
11740 @cindex @acronym{HTML}
11742 If you have @code{w3m} installed on your system, Gnus can display
11743 @acronym{HTML} articles in the article buffer. There are many Gnus
11744 add-ons for doing this, using various approaches, but there's one
11745 (sort of) built-in method that's used by default.
11747 For a complete overview, consult @xref{Display Customization,
11748 ,Display Customization, emacs-mime, The Emacs MIME Manual}. This
11749 section only describes the default method.
11752 @item mm-text-html-renderer
11753 @vindex mm-text-html-renderer
11754 If set to @code{gnus-article-html}, Gnus will use the built-in method,
11755 that's based on @code{w3m}.
11757 @item gnus-blocked-images
11758 @vindex gnus-blocked-images
11759 External images that have @acronym{URL}s that match this regexp won't
11760 be fetched and displayed. For instance, do block all @acronym{URL}s
11761 that have the string ``ads'' in them, do the following:
11764 (setq gnus-blocked-images "ads")
11767 This can also be a function to be evaluated. If so, it will be
11768 called with the group name as the parameter. The default value is
11769 @code{gnus-block-private-groups}, which will return @samp{"."} for
11770 anything that isn't a newsgroup. This means that no external images
11771 will be fetched as a result of reading mail, so that nobody can use
11772 web bugs (and the like) to track whether you've read email.
11774 Also @pxref{Misc Article} for @code{gnus-inhibit-images}.
11776 @item gnus-html-cache-directory
11777 @vindex gnus-html-cache-directory
11778 Gnus will download and cache images according to how
11779 @code{gnus-blocked-images} is set. These images will be stored in
11782 @item gnus-html-cache-size
11783 @vindex gnus-html-cache-size
11784 When @code{gnus-html-cache-size} bytes have been used in that
11785 directory, the oldest files will be deleted. The default is 500MB.
11787 @item gnus-html-frame-width
11788 @vindex gnus-html-frame-width
11789 The width to use when rendering HTML@. The default is 70.
11791 @item gnus-max-image-proportion
11792 @vindex gnus-max-image-proportion
11793 How big pictures displayed are in relation to the window they're in.
11794 A value of 0.7 (the default) means that they are allowed to take up
11795 70% of the width and height of the window. If they are larger than
11796 this, and Emacs supports it, then the images will be rescaled down to
11797 fit these criteria.
11801 To use this, make sure that you have @code{w3m} and @code{curl}
11802 installed. If you have, then Gnus should display @acronym{HTML}
11807 @node Customizing Articles
11808 @section Customizing Articles
11809 @cindex article customization
11811 A slew of functions for customizing how the articles are to look like
11812 exist. You can call these functions interactively
11813 (@pxref{Article Washing}), or you can have them
11814 called automatically when you select the articles.
11816 To have them called automatically, you should set the corresponding
11817 ``treatment'' variable. For instance, to have headers hidden, you'd set
11818 @code{gnus-treat-hide-headers}. Below is a list of variables that can
11819 be set, but first we discuss the values these variables can have.
11821 Note: Some values, while valid, make little sense. Check the list below
11822 for sensible values.
11826 @code{nil}: Don't do this treatment.
11829 @code{t}: Do this treatment on all body parts.
11832 @code{head}: Do the treatment on the headers.
11835 @code{first}: Do this treatment on the first body part.
11838 @code{last}: Do this treatment on the last body part.
11841 An integer: Do this treatment on all body parts that have a length less
11845 A list of strings: Do this treatment on all body parts that are in
11846 articles that are read in groups that have names that match one of the
11847 regexps in the list.
11850 A list where the first element is not a string:
11852 The list is evaluated recursively. The first element of the list is a
11853 predicate. The following predicates are recognized: @code{or},
11854 @code{and}, @code{not} and @code{typep}. Here's an example:
11858 (typep "text/x-vcard"))
11863 You may have noticed that the word @dfn{part} is used here. This refers
11864 to the fact that some messages are @acronym{MIME} multipart articles that may
11865 be divided into several parts. Articles that are not multiparts are
11866 considered to contain just a single part.
11868 @vindex gnus-article-treat-types
11869 Are the treatments applied to all sorts of multipart parts? Yes, if you
11870 want to, but by default, only @samp{text/plain} parts are given the
11871 treatment. This is controlled by the @code{gnus-article-treat-types}
11872 variable, which is a list of regular expressions that are matched to the
11873 type of the part. This variable is ignored if the value of the
11874 controlling variable is a predicate list, as described above.
11877 @c Avoid sort of redundant entries in the same section for the printed
11878 @c manual, but add them in info to allow `i gnus-treat-foo-bar RET' or
11880 @vindex gnus-treat-buttonize
11881 @vindex gnus-treat-buttonize-head
11882 @vindex gnus-treat-capitalize-sentences
11883 @vindex gnus-treat-overstrike
11884 @vindex gnus-treat-strip-cr
11885 @vindex gnus-treat-strip-headers-in-body
11886 @vindex gnus-treat-strip-leading-blank-lines
11887 @vindex gnus-treat-strip-multiple-blank-lines
11888 @vindex gnus-treat-strip-pem
11889 @vindex gnus-treat-strip-trailing-blank-lines
11890 @vindex gnus-treat-unsplit-urls
11891 @vindex gnus-treat-wash-html
11892 @vindex gnus-treat-date
11893 @vindex gnus-treat-from-picon
11894 @vindex gnus-treat-mail-picon
11895 @vindex gnus-treat-newsgroups-picon
11896 @vindex gnus-treat-from-gravatar
11897 @vindex gnus-treat-mail-gravatar
11898 @vindex gnus-treat-display-smileys
11899 @vindex gnus-treat-body-boundary
11900 @vindex gnus-treat-display-x-face
11901 @vindex gnus-treat-display-face
11902 @vindex gnus-treat-emphasize
11903 @vindex gnus-treat-fill-article
11904 @vindex gnus-treat-fill-long-lines
11905 @vindex gnus-treat-hide-boring-headers
11906 @vindex gnus-treat-hide-citation
11907 @vindex gnus-treat-hide-citation-maybe
11908 @vindex gnus-treat-hide-headers
11909 @vindex gnus-treat-hide-signature
11910 @vindex gnus-treat-strip-banner
11911 @vindex gnus-treat-strip-list-identifiers
11912 @vindex gnus-treat-highlight-citation
11913 @vindex gnus-treat-highlight-headers
11914 @vindex gnus-treat-highlight-signature
11915 @vindex gnus-treat-play-sounds
11916 @vindex gnus-treat-x-pgp-sig
11917 @vindex gnus-treat-unfold-headers
11918 @vindex gnus-treat-fold-headers
11919 @vindex gnus-treat-fold-newsgroups
11920 @vindex gnus-treat-leading-whitespace
11923 The following treatment options are available. The easiest way to
11924 customize this is to examine the @code{gnus-article-treat} customization
11925 group. Values in parenthesis are suggested sensible values. Others are
11926 possible but those listed are probably sufficient for most people.
11929 @item gnus-treat-buttonize (t, integer)
11930 @item gnus-treat-buttonize-head (head)
11932 @xref{Article Buttons}.
11934 @item gnus-treat-capitalize-sentences (t, integer)
11935 @item gnus-treat-overstrike (t, integer)
11936 @item gnus-treat-strip-cr (t, integer)
11937 @item gnus-treat-strip-headers-in-body (t, integer)
11938 @item gnus-treat-strip-leading-blank-lines (t, first, integer)
11939 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11940 @item gnus-treat-strip-pem (t, last, integer)
11941 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11942 @item gnus-treat-unsplit-urls (t, integer)
11943 @item gnus-treat-wash-html (t, integer)
11945 @xref{Article Washing}.
11947 @item gnus-treat-date (head)
11949 This will transform/add date headers according to the
11950 @code{gnus-article-date-headers} variable. This is a list of Date
11951 headers to display. The formats available are:
11955 Universal time, aka GMT, aka ZULU.
11958 The user's local time zone.
11961 A semi-readable English sentence.
11964 The time elapsed since the message was posted.
11966 @item combined-lapsed
11967 Both the original date header and a (shortened) elapsed time.
11970 The original date header.
11973 ISO8601 format, i.e., ``2010-11-23T22:05:21''.
11976 A format done according to the @code{gnus-article-time-format}
11981 @xref{Article Date}.
11983 @item gnus-treat-from-picon (head)
11984 @item gnus-treat-mail-picon (head)
11985 @item gnus-treat-newsgroups-picon (head)
11989 @item gnus-treat-from-gravatar (head)
11990 @item gnus-treat-mail-gravatar (head)
11994 @item gnus-treat-display-smileys (t, integer)
11996 @item gnus-treat-body-boundary (head)
11998 @vindex gnus-body-boundary-delimiter
11999 Adds a delimiter between header and body, the string used as delimiter
12000 is controlled by @code{gnus-body-boundary-delimiter}.
12004 @vindex gnus-treat-display-x-face
12005 @item gnus-treat-display-x-face (head)
12009 @vindex gnus-treat-display-face
12010 @item gnus-treat-display-face (head)
12014 @vindex gnus-treat-emphasize
12015 @item gnus-treat-emphasize (t, head, integer)
12016 @vindex gnus-treat-fill-article
12017 @item gnus-treat-fill-article (t, integer)
12018 @vindex gnus-treat-fill-long-lines
12019 @item gnus-treat-fill-long-lines (t, integer)
12020 @vindex gnus-treat-hide-boring-headers
12021 @item gnus-treat-hide-boring-headers (head)
12022 @vindex gnus-treat-hide-citation
12023 @item gnus-treat-hide-citation (t, integer)
12024 @vindex gnus-treat-hide-citation-maybe
12025 @item gnus-treat-hide-citation-maybe (t, integer)
12026 @vindex gnus-treat-hide-headers
12027 @item gnus-treat-hide-headers (head)
12028 @vindex gnus-treat-hide-signature
12029 @item gnus-treat-hide-signature (t, last)
12030 @vindex gnus-treat-strip-banner
12031 @item gnus-treat-strip-banner (t, last)
12032 @vindex gnus-treat-strip-list-identifiers
12033 @item gnus-treat-strip-list-identifiers (head)
12035 @xref{Article Hiding}.
12037 @vindex gnus-treat-highlight-citation
12038 @item gnus-treat-highlight-citation (t, integer)
12039 @vindex gnus-treat-highlight-headers
12040 @item gnus-treat-highlight-headers (head)
12041 @vindex gnus-treat-highlight-signature
12042 @item gnus-treat-highlight-signature (t, last, integer)
12044 @xref{Article Highlighting}.
12046 @vindex gnus-treat-play-sounds
12047 @item gnus-treat-play-sounds
12048 @item gnus-treat-ansi-sequences (t)
12049 @vindex gnus-treat-x-pgp-sig
12050 @item gnus-treat-x-pgp-sig (head)
12052 @vindex gnus-treat-unfold-headers
12053 @item gnus-treat-unfold-headers (head)
12054 @vindex gnus-treat-fold-headers
12055 @item gnus-treat-fold-headers (head)
12056 @vindex gnus-treat-fold-newsgroups
12057 @item gnus-treat-fold-newsgroups (head)
12058 @vindex gnus-treat-leading-whitespace
12059 @item gnus-treat-leading-whitespace (head)
12061 @xref{Article Header}.
12066 @vindex gnus-part-display-hook
12067 You can, of course, write your own functions to be called from
12068 @code{gnus-part-display-hook}. The functions are called narrowed to the
12069 part, and you can do anything you like, pretty much. There is no
12070 information that you have to keep in the buffer---you can change
12074 @node Article Keymap
12075 @section Article Keymap
12077 Most of the keystrokes in the summary buffer can also be used in the
12078 article buffer. They should behave as if you typed them in the summary
12079 buffer, which means that you don't actually have to have a summary
12080 buffer displayed while reading. You can do it all from the article
12083 @kindex v (Article)
12084 @cindex keys, reserved for users (Article)
12085 The key @kbd{v} is reserved for users. You can bind it to some
12086 command or better use it as a prefix key.
12088 A few additional keystrokes are available:
12093 @kindex SPACE (Article)
12094 @findex gnus-article-next-page
12095 Scroll forwards one page (@code{gnus-article-next-page}).
12096 This is exactly the same as @kbd{h SPACE h}.
12099 @kindex DEL (Article)
12100 @findex gnus-article-prev-page
12101 Scroll backwards one page (@code{gnus-article-prev-page}).
12102 This is exactly the same as @kbd{h DEL h}.
12105 @kindex C-c ^ (Article)
12106 @findex gnus-article-refer-article
12107 If point is in the neighborhood of a @code{Message-ID} and you press
12108 @kbd{C-c ^}, Gnus will try to get that article from the server
12109 (@code{gnus-article-refer-article}).
12112 @kindex C-c C-m (Article)
12113 @findex gnus-article-mail
12114 Send a reply to the address near point (@code{gnus-article-mail}). If
12115 given a prefix, include the mail.
12118 @kindex s (Article)
12119 @findex gnus-article-show-summary
12120 Reconfigure the buffers so that the summary buffer becomes visible
12121 (@code{gnus-article-show-summary}).
12124 @kindex ? (Article)
12125 @findex gnus-article-describe-briefly
12126 Give a very brief description of the available keystrokes
12127 (@code{gnus-article-describe-briefly}).
12130 @kindex TAB (Article)
12131 @findex gnus-article-next-button
12132 Go to the next button, if any (@code{gnus-article-next-button}). This
12133 only makes sense if you have buttonizing turned on.
12136 @kindex M-TAB (Article)
12137 @findex gnus-article-prev-button
12138 Go to the previous button, if any (@code{gnus-article-prev-button}).
12141 @kindex R (Article)
12142 @findex gnus-article-reply-with-original
12143 Send a reply to the current article and yank the current article
12144 (@code{gnus-article-reply-with-original}). If the region is active,
12145 only yank the text in the region.
12148 @kindex S W (Article)
12149 @findex gnus-article-wide-reply-with-original
12150 Send a wide reply to the current article and yank the current article
12151 (@code{gnus-article-wide-reply-with-original}). If the region is
12152 active, only yank the text in the region.
12155 @kindex F (Article)
12156 @findex gnus-article-followup-with-original
12157 Send a followup to the current article and yank the current article
12158 (@code{gnus-article-followup-with-original}). If the region is active,
12159 only yank the text in the region.
12166 @section Misc Article
12170 @item gnus-single-article-buffer
12171 @vindex gnus-single-article-buffer
12172 @cindex article buffers, several
12173 If non-@code{nil}, use the same article buffer for all the groups.
12174 (This is the default.) If @code{nil}, each group will have its own
12177 @item gnus-widen-article-window
12178 @cindex gnus-widen-article-window
12179 If non-@code{nil}, selecting the article buffer with the @kbd{h}
12180 command will ``widen'' the article window to take the entire frame.
12182 @vindex gnus-article-decode-hook
12183 @item gnus-article-decode-hook
12184 @cindex @acronym{MIME}
12185 Hook used to decode @acronym{MIME} articles. The default value is
12186 @code{(article-decode-charset article-decode-encoded-words)}
12188 @vindex gnus-article-prepare-hook
12189 @item gnus-article-prepare-hook
12190 This hook is called right after the article has been inserted into the
12191 article buffer. It is mainly intended for functions that do something
12192 depending on the contents; it should probably not be used for changing
12193 the contents of the article buffer.
12195 @item gnus-article-mode-hook
12196 @vindex gnus-article-mode-hook
12197 Hook called in article mode buffers.
12199 @item gnus-article-mode-syntax-table
12200 @vindex gnus-article-mode-syntax-table
12201 Syntax table used in article buffers. It is initialized from
12202 @code{text-mode-syntax-table}.
12204 @vindex gnus-article-over-scroll
12205 @item gnus-article-over-scroll
12206 If non-@code{nil}, allow scrolling the article buffer even when there
12207 no more new text to scroll in. The default is @code{nil}.
12209 @vindex gnus-article-mode-line-format
12210 @item gnus-article-mode-line-format
12211 This variable is a format string along the same lines as
12212 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
12213 Line}). It accepts the same format specifications as that variable,
12214 with two extensions:
12219 The @dfn{wash status} of the article. This is a short string with one
12220 character for each possible article wash operation that may have been
12221 performed. The characters and their meaning:
12226 Displayed when cited text may be hidden in the article buffer.
12229 Displayed when headers are hidden in the article buffer.
12232 Displayed when article is digitally signed or encrypted, and Gnus has
12233 hidden the security headers. (N.B. does not tell anything about
12234 security status, i.e., good or bad signature.)
12237 Displayed when the signature has been hidden in the Article buffer.
12240 Displayed when Gnus has treated overstrike characters in the article buffer.
12243 Displayed when Gnus has treated emphasized strings in the article buffer.
12248 The number of @acronym{MIME} parts in the article.
12252 @vindex gnus-break-pages
12254 @item gnus-break-pages
12255 Controls whether @dfn{page breaking} is to take place. If this variable
12256 is non-@code{nil}, the articles will be divided into pages whenever a
12257 page delimiter appears in the article. If this variable is @code{nil},
12258 paging will not be done.
12260 @item gnus-page-delimiter
12261 @vindex gnus-page-delimiter
12262 This is the delimiter mentioned above. By default, it is @samp{^L}
12266 @cindex internationalized domain names
12267 @vindex gnus-use-idna
12268 @item gnus-use-idna
12269 This variable controls whether Gnus performs IDNA decoding of
12270 internationalized domain names inside @samp{From}, @samp{To} and
12271 @samp{Cc} headers. @xref{IDNA, ,IDNA,message, The Message Manual},
12272 for how to compose such messages. This requires
12273 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
12274 variable is only enabled if you have installed it.
12276 @vindex gnus-inhibit-images
12277 @item gnus-inhibit-images
12278 If this is non-@code{nil}, inhibit displaying of images inline in the
12279 article body. It is effective to images that are in articles as
12280 @acronym{MIME} parts, and images in @acronym{HTML} articles rendered
12281 when @code{mm-text-html-renderer} (@pxref{Display Customization,
12282 ,Display Customization, emacs-mime, The Emacs MIME Manual}) is
12283 @code{shr} or @code{gnus-w3m}.
12288 @node Composing Messages
12289 @chapter Composing Messages
12290 @cindex composing messages
12293 @cindex sending mail
12298 @cindex using s/mime
12299 @cindex using smime
12301 @kindex C-c C-c (Post)
12302 All commands for posting and mailing will put you in a message buffer
12303 where you can edit the article all you like, before you send the
12304 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
12305 Message Manual}. Where the message will be posted/mailed to depends
12306 on your setup (@pxref{Posting Server}).
12309 * Mail:: Mailing and replying.
12310 * Posting Server:: What server should you post and mail via?
12311 * POP before SMTP:: You cannot send a mail unless you read a mail.
12312 * Mail and Post:: Mailing and posting at the same time.
12313 * Archived Messages:: Where Gnus stores the messages you've sent.
12314 * Posting Styles:: An easier way to specify who you are.
12315 * Drafts:: Postponing messages and rejected messages.
12316 * Rejected Articles:: What happens if the server doesn't like your article?
12317 * Signing and encrypting:: How to compose secure messages.
12320 Also @pxref{Canceling and Superseding} for information on how to
12321 remove articles you shouldn't have posted.
12327 Variables for customizing outgoing mail:
12330 @item gnus-uu-digest-headers
12331 @vindex gnus-uu-digest-headers
12332 List of regexps to match headers included in digested messages. The
12333 headers will be included in the sequence they are matched. If
12334 @code{nil} include all headers.
12336 @item gnus-add-to-list
12337 @vindex gnus-add-to-list
12338 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
12339 that have none when you do a @kbd{a}.
12341 @item gnus-confirm-mail-reply-to-news
12342 @vindex gnus-confirm-mail-reply-to-news
12343 If non-@code{nil}, Gnus will ask you for a confirmation when you are
12344 about to reply to news articles by mail. If it is @code{nil}, nothing
12345 interferes in what you want to do. This can also be a function
12346 receiving the group name as the only parameter which should return
12347 non-@code{nil} if a confirmation is needed, or a regular expression
12348 matching group names, where confirmation should be asked for.
12350 If you find yourself never wanting to reply to mail, but occasionally
12351 press @kbd{R} anyway, this variable might be for you.
12353 @item gnus-confirm-treat-mail-like-news
12354 @vindex gnus-confirm-treat-mail-like-news
12355 If non-@code{nil}, Gnus also requests confirmation according to
12356 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
12357 useful for treating mailing lists like newsgroups.
12362 @node Posting Server
12363 @section Posting Server
12365 When you press those magical @kbd{C-c C-c} keys to ship off your latest
12366 (extremely intelligent, of course) article, where does it go?
12368 Thank you for asking. I hate you.
12370 It can be quite complicated.
12372 @vindex gnus-post-method
12373 When posting news, Message usually invokes @code{message-send-news}
12374 (@pxref{News Variables, , News Variables, message, Message Manual}).
12375 Normally, Gnus will post using the same select method as you're
12376 reading from (which might be convenient if you're reading lots of
12377 groups from different private servers). However. If the server
12378 you're reading from doesn't allow posting, just reading, you probably
12379 want to use some other server to post your (extremely intelligent and
12380 fabulously interesting) articles. You can then set the
12381 @code{gnus-post-method} to some other method:
12384 (setq gnus-post-method '(nnspool ""))
12387 Now, if you've done this, and then this server rejects your article, or
12388 this server is down, what do you do then? To override this variable you
12389 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
12390 the ``current'' server, to get back the default behavior, for posting.
12392 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
12393 Gnus will prompt you for what method to use for posting.
12395 You can also set @code{gnus-post-method} to a list of select methods.
12396 If that's the case, Gnus will always prompt you for what method to use
12399 Finally, if you want to always post using the native select method,
12400 you can set this variable to @code{native}.
12402 @vindex message-send-mail-function
12403 When sending mail, Message invokes the function specified by the
12404 variable @code{message-send-mail-function}. Gnus tries to set it to a
12405 value suitable for your system.
12406 @xref{Mail Variables, ,Mail Variables,message,Message manual}, for more
12410 @node POP before SMTP
12411 @section POP before SMTP
12412 @cindex pop before smtp
12413 @findex mail-source-touch-pop
12415 Does your @acronym{ISP} use @acronym{POP}-before-@acronym{SMTP}
12416 authentication? This authentication method simply requires you to
12417 contact the @acronym{POP} server before sending email. To do that,
12418 put the following lines in your @file{~/.gnus.el} file:
12421 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
12425 The @code{mail-source-touch-pop} function does @acronym{POP}
12426 authentication according to the value of @code{mail-sources} without
12427 fetching mails, just before sending a mail. @xref{Mail Sources}.
12429 If you have two or more @acronym{POP} mail servers set in
12430 @code{mail-sources}, you may want to specify one of them to
12431 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
12432 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
12433 is your primary @acronym{POP} mail server (i.e., you are fetching mails
12434 mainly from that server), you can set it permanently as follows:
12437 (setq mail-source-primary-source
12438 '(pop :server "pop3.mail.server"
12439 :password "secret"))
12443 Otherwise, bind it dynamically only when performing the
12444 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
12447 (add-hook 'message-send-mail-hook
12449 (let ((mail-source-primary-source
12450 '(pop :server "pop3.mail.server"
12451 :password "secret")))
12452 (mail-source-touch-pop))))
12456 @node Mail and Post
12457 @section Mail and Post
12459 Here's a list of variables relevant to both mailing and
12463 @item gnus-mailing-list-groups
12464 @findex gnus-mailing-list-groups
12465 @cindex mailing lists
12467 If your news server offers groups that are really mailing lists
12468 gatewayed to the @acronym{NNTP} server, you can read those groups without
12469 problems, but you can't post/followup to them without some difficulty.
12470 One solution is to add a @code{to-address} to the group parameters
12471 (@pxref{Group Parameters}). An easier thing to do is set the
12472 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
12473 really are mailing lists. Then, at least, followups to the mailing
12474 lists will work most of the time. Posting to these groups (@kbd{a}) is
12475 still a pain, though.
12477 @item gnus-user-agent
12478 @vindex gnus-user-agent
12481 This variable controls which information should be exposed in the
12482 User-Agent header. It can be a list of symbols or a string. Valid
12483 symbols are @code{gnus} (show Gnus version) and @code{emacs} (show Emacs
12484 version). In addition to the Emacs version, you can add @code{codename}
12485 (show (S)XEmacs codename) or either @code{config} (show system
12486 configuration) or @code{type} (show system type). If you set it to a
12487 string, be sure to use a valid format, see RFC 2616.
12491 You may want to do spell-checking on messages that you send out. Or, if
12492 you don't want to spell-check by hand, you could add automatic
12493 spell-checking via the @code{ispell} package:
12496 @findex ispell-message
12498 (add-hook 'message-send-hook 'ispell-message)
12501 If you want to change the @code{ispell} dictionary based on what group
12502 you're in, you could say something like the following:
12505 (add-hook 'gnus-select-group-hook
12509 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
12510 (ispell-change-dictionary "deutsch"))
12512 (ispell-change-dictionary "english")))))
12515 Modify to suit your needs.
12517 @vindex gnus-message-highlight-citation
12518 If @code{gnus-message-highlight-citation} is t, different levels of
12519 citations are highlighted like in Gnus article buffers also in message
12522 @node Archived Messages
12523 @section Archived Messages
12524 @cindex archived messages
12525 @cindex sent messages
12527 Gnus provides a few different methods for storing the mail and news you
12528 send. The default method is to use the @dfn{archive virtual server} to
12529 store the messages. If you want to disable this completely, the
12530 @code{gnus-message-archive-group} variable should be @code{nil}. The
12531 default is "sent.%Y-%m", which gives you one archive group per month.
12533 For archiving interesting messages in a group you read, see the
12534 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
12537 @vindex gnus-message-archive-method
12538 @code{gnus-message-archive-method} says what virtual server Gnus is to
12539 use to store sent messages. The default is @code{"archive"}, and when
12540 actually being used it is expanded into:
12543 (nnfolder "archive"
12544 (nnfolder-directory "~/Mail/archive")
12545 (nnfolder-active-file "~/Mail/archive/active")
12546 (nnfolder-get-new-mail nil)
12547 (nnfolder-inhibit-expiry t))
12551 @vindex gnus-update-message-archive-method
12552 Note: a server like this is saved in the @file{~/.newsrc.eld} file first
12553 so that it may be used as a real method of the server which is named
12554 @code{"archive"} (that is, for the case where
12555 @code{gnus-message-archive-method} is set to @code{"archive"}) ever
12556 since. If it once has been saved, it will never be updated by default
12557 even if you change the value of @code{gnus-message-archive-method}
12558 afterward. Therefore, the server @code{"archive"} doesn't necessarily
12559 mean the @code{nnfolder} server like this at all times. If you want the
12560 saved method to reflect always the value of
12561 @code{gnus-message-archive-method}, set the
12562 @code{gnus-update-message-archive-method} variable to a non-@code{nil}
12563 value. The default value of this variable is @code{nil}.
12566 You can, however, use any mail select method (@code{nnml},
12567 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
12568 for doing this sort of thing, though. If you don't like the default
12569 directory chosen, you could say something like:
12572 (setq gnus-message-archive-method
12573 '(nnfolder "archive"
12574 (nnfolder-inhibit-expiry t)
12575 (nnfolder-active-file "~/News/sent-mail/active")
12576 (nnfolder-directory "~/News/sent-mail/")))
12579 @vindex gnus-message-archive-group
12581 Gnus will insert @code{Gcc} headers in all outgoing messages that point
12582 to one or more group(s) on that server. Which group to use is
12583 determined by the @code{gnus-message-archive-group} variable.
12585 This variable can be used to do the following:
12589 Messages will be saved in that group.
12591 Note that you can include a select method in the group name, then the
12592 message will not be stored in the select method given by
12593 @code{gnus-message-archive-method}, but in the select method specified
12594 by the group name, instead. Suppose @code{gnus-message-archive-method}
12595 has the default value shown above. Then setting
12596 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
12597 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
12598 value @code{"nnml:foo"}, then outgoing messages will be stored in
12601 @item a list of strings
12602 Messages will be saved in all those groups.
12604 @item an alist of regexps, functions and forms
12605 When a key ``matches'', the result is used.
12608 No message archiving will take place.
12613 Just saving to a single group called @samp{MisK}:
12615 (setq gnus-message-archive-group "MisK")
12618 Saving to two groups, @samp{MisK} and @samp{safe}:
12620 (setq gnus-message-archive-group '("MisK" "safe"))
12623 Save to different groups based on what group you are in:
12625 (setq gnus-message-archive-group
12626 '(("^alt" "sent-to-alt")
12627 ("mail" "sent-to-mail")
12628 (".*" "sent-to-misc")))
12631 More complex stuff:
12633 (setq gnus-message-archive-group
12634 '((if (message-news-p)
12639 How about storing all news messages in one file, but storing all mail
12640 messages in one file per month:
12643 (setq gnus-message-archive-group
12644 '((if (message-news-p)
12646 (concat "mail." (format-time-string "%Y-%m")))))
12649 Now, when you send a message off, it will be stored in the appropriate
12650 group. (If you want to disable storing for just one particular message,
12651 you can just remove the @code{Gcc} header that has been inserted.) The
12652 archive group will appear in the group buffer the next time you start
12653 Gnus, or the next time you press @kbd{F} in the group buffer. You can
12654 enter it and read the articles in it just like you'd read any other
12655 group. If the group gets really big and annoying, you can simply rename
12656 if (using @kbd{G r} in the group buffer) to something
12657 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
12658 continue to be stored in the old (now empty) group.
12661 @item gnus-gcc-mark-as-read
12662 @vindex gnus-gcc-mark-as-read
12663 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
12665 @item gnus-gcc-externalize-attachments
12666 @vindex gnus-gcc-externalize-attachments
12667 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
12668 and matches the Gcc group name, attach files as external parts; if it is
12669 @code{all}, attach local files as external parts; if it is other
12670 non-@code{nil}, the behavior is the same as @code{all}, but it may be
12671 changed in the future.
12673 @item gnus-gcc-self-resent-messages
12674 @vindex gnus-gcc-self-resent-messages
12675 Like the @code{gcc-self} group parameter, applied only for unmodified
12676 messages that @code{gnus-summary-resend-message} (@pxref{Summary Mail
12677 Commands}) resends. Non-@code{nil} value of this variable takes
12678 precedence over any existing @code{Gcc} header.
12680 If this is @code{none}, no @code{Gcc} copy will be made. If this is
12681 @code{t}, messages resent will be @code{Gcc} copied to the current
12682 group. If this is a string, it specifies a group to which resent
12683 messages will be @code{Gcc} copied. If this is @code{nil}, @code{Gcc}
12684 will be done according to existing @code{Gcc} header(s), if any. If
12685 this is @code{no-gcc-self}, that is the default, resent messages will be
12686 @code{Gcc} copied to groups that existing @code{Gcc} header specifies,
12687 except for the current group.
12689 @item gnus-gcc-pre-body-encode-hook
12690 @vindex gnus-gcc-pre-body-encode-hook
12691 @itemx gnus-gcc-post-body-encode-hook
12692 @vindex gnus-gcc-post-body-encode-hook
12694 These hooks are run before/after encoding the message body of the Gcc
12695 copy of a sent message. The current buffer (when the hook is run)
12696 contains the message including the message header. Changes made to
12697 the message will only affect the Gcc copy, but not the original
12698 message. You can use these hooks to edit the copy (and influence
12699 subsequent transformations), e.g., remove MML secure tags
12700 (@pxref{Signing and encrypting}).
12705 @node Posting Styles
12706 @section Posting Styles
12707 @cindex posting styles
12710 All them variables, they make my head swim.
12712 So what if you want a different @code{Organization} and signature based
12713 on what groups you post to? And you post both from your home machine
12714 and your work machine, and you want different @code{From} lines, and so
12717 @vindex gnus-posting-styles
12718 One way to do stuff like that is to write clever hooks that change the
12719 variables you need to have changed. That's a bit boring, so somebody
12720 came up with the bright idea of letting the user specify these things in
12721 a handy alist. Here's an example of a @code{gnus-posting-styles}
12726 (signature "Peace and happiness")
12727 (organization "What me?"))
12729 (signature "Death to everybody"))
12730 ("comp.emacs.i-love-it"
12731 (organization "Emacs is it")))
12734 As you might surmise from this example, this alist consists of several
12735 @dfn{styles}. Each style will be applicable if the first element
12736 ``matches'', in some form or other. The entire alist will be iterated
12737 over, from the beginning towards the end, and each match will be
12738 applied, which means that attributes in later styles that match override
12739 the same attributes in earlier matching styles. So
12740 @samp{comp.programming.literate} will have the @samp{Death to everybody}
12741 signature and the @samp{What me?} @code{Organization} header.
12743 The first element in each style is called the @code{match}. If it's a
12744 string, then Gnus will try to regexp match it against the group name.
12745 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
12746 will look in the original article for a header whose name is
12747 @var{match} and compare that @var{regexp}. @var{match} and
12748 @var{regexp} are strings. (The original article is the one you are
12749 replying or following up to. If you are not composing a reply or a
12750 followup, then there is nothing to match against.) If the
12751 @code{match} is a function symbol, that function will be called with
12752 no arguments. If it's a variable symbol, then the variable will be
12753 referenced. If it's a list, then that list will be @code{eval}ed. In
12754 any case, if this returns a non-@code{nil} value, then the style is
12755 said to @dfn{match}.
12757 Each style may contain an arbitrary amount of @dfn{attributes}. Each
12758 attribute consists of a @code{(@var{name} @var{value})} pair. In
12759 addition, you can also use the @code{(@var{name} :file @var{value})}
12760 form or the @code{(@var{name} :value @var{value})} form. Where
12761 @code{:file} signifies @var{value} represents a file name and its
12762 contents should be used as the attribute value, @code{:value} signifies
12763 @var{value} does not represent a file name explicitly. The attribute
12764 name can be one of:
12767 @item @code{signature}
12768 @item @code{signature-file}
12769 @item @code{x-face-file}
12770 @item @code{address}, overriding @code{user-mail-address}
12771 @item @code{name}, overriding @code{(user-full-name)}
12775 Note that the @code{signature-file} attribute honors the variable
12776 @code{message-signature-directory}.
12778 The attribute name can also be a string or a symbol. In that case,
12779 this will be used as a header name, and the value will be inserted in
12780 the headers of the article; if the value is @code{nil}, the header
12781 name will be removed. If the attribute name is @code{eval}, the form
12782 is evaluated, and the result is thrown away.
12784 The attribute value can be a string, a function with zero arguments
12785 (the return value will be used), a variable (its value will be used)
12786 or a list (it will be @code{eval}ed and the return value will be
12787 used). The functions and sexps are called/@code{eval}ed in the
12788 message buffer that is being set up. The headers of the current
12789 article are available through the @code{message-reply-headers}
12790 variable, which is a vector of the following headers: number subject
12791 from date id references chars lines xref extra.
12793 In the case of a string value, if the @code{match} is a regular
12794 expression, a @samp{gnus-match-substitute-replacement} is proceed on
12795 the value to replace the positional parameters @samp{\@var{n}} by the
12796 corresponding parenthetical matches (see @xref{Replacing Match,,
12797 Replacing the Text that Matched, elisp, The Emacs Lisp Reference Manual}.)
12799 @vindex message-reply-headers
12801 If you wish to check whether the message you are about to compose is
12802 meant to be a news article or a mail message, you can check the values
12803 of the @code{message-news-p} and @code{message-mail-p} functions.
12805 @findex message-mail-p
12806 @findex message-news-p
12808 So here's a new example:
12811 (setq gnus-posting-styles
12813 (signature-file "~/.signature")
12815 (x-face-file "~/.xface")
12816 (x-url (getenv "WWW_HOME"))
12817 (organization "People's Front Against MWM"))
12819 (signature my-funny-signature-randomizer))
12820 ((equal (system-name) "gnarly") ;; @r{A form}
12821 (signature my-quote-randomizer))
12822 (message-news-p ;; @r{A function symbol}
12823 (signature my-news-signature))
12824 (window-system ;; @r{A value symbol}
12825 ("X-Window-System" (format "%s" window-system)))
12826 ;; @r{If I'm replying to Larsi, set the Organization header.}
12827 ((header "from" "larsi.*org")
12828 (Organization "Somewhere, Inc."))
12829 ((posting-from-work-p) ;; @r{A user defined function}
12830 (signature-file "~/.work-signature")
12831 (address "user@@bar.foo")
12832 (body "You are fired.\n\nSincerely, your boss.")
12833 ("X-Message-SMTP-Method" "smtp smtp.example.org 587")
12834 (organization "Important Work, Inc"))
12836 (From (with-current-buffer gnus-article-buffer
12837 (message-fetch-field "to"))))
12839 (signature-file "~/.mail-signature"))))
12842 The @samp{nnml:.*} rule means that you use the @code{To} address as the
12843 @code{From} address in all your outgoing replies, which might be handy
12844 if you fill many roles.
12845 You may also use @code{message-alternative-emails} instead.
12846 @xref{Message Headers, ,Message Headers, message, Message Manual}.
12848 Of particular interest in the ``work-mail'' style is the
12849 @samp{X-Message-SMTP-Method} header. It specifies how to send the
12850 outgoing email. You may want to sent certain emails through certain
12851 @acronym{SMTP} servers due to company policies, for instance.
12852 @xref{Mail Variables, ,Message Variables, message, Message Manual}.
12859 If you are writing a message (mail or news) and suddenly remember that
12860 you have a steak in the oven (or some pesto in the food processor, you
12861 craaazy vegetarians), you'll probably wish there was a method to save
12862 the message you are writing so that you can continue editing it some
12863 other day, and send it when you feel its finished.
12865 Well, don't worry about it. Whenever you start composing a message of
12866 some sort using the Gnus mail and post commands, the buffer you get will
12867 automatically associate to an article in a special @dfn{draft} group.
12868 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
12869 article will be saved there. (Auto-save files also go to the draft
12873 @vindex nndraft-directory
12874 The draft group is a special group (which is implemented as an
12875 @code{nndraft} group, if you absolutely have to know) called
12876 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
12877 @code{nndraft} is to store its files. What makes this group special is
12878 that you can't tick any articles in it or mark any articles as
12879 read---all articles in the group are permanently unread.
12881 If the group doesn't exist, it will be created and you'll be subscribed
12882 to it. The only way to make it disappear from the Group buffer is to
12883 unsubscribe it. The special properties of the draft group comes from
12884 a group property (@pxref{Group Parameters}), and if lost the group
12885 behaves like any other group. This means the commands below will not
12886 be available. To restore the special properties of the group, the
12887 simplest way is to kill the group, using @kbd{C-k}, and restart
12888 Gnus. The group is automatically created again with the
12889 correct parameters. The content of the group is not lost.
12891 @c @findex gnus-dissociate-buffer-from-draft
12892 @c @kindex C-c M-d (Mail)
12893 @c @kindex C-c M-d (Post)
12894 @c @findex gnus-associate-buffer-with-draft
12895 @c @kindex C-c C-d (Mail)
12896 @c @kindex C-c C-d (Post)
12897 @c If you're writing some super-secret message that you later want to
12898 @c encode with PGP before sending, you may wish to turn the auto-saving
12899 @c (and association with the draft group) off. You never know who might be
12900 @c interested in reading all your extremely valuable and terribly horrible
12901 @c and interesting secrets. The @kbd{C-c M-d}
12902 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
12903 @c If you change your mind and want to turn the auto-saving back on again,
12904 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
12906 @c @vindex gnus-use-draft
12907 @c To leave association with the draft group off by default, set
12908 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
12910 @findex gnus-draft-edit-message
12911 @kindex D e (Draft)
12912 When you want to continue editing the article, you simply enter the
12913 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
12914 that. You will be placed in a buffer where you left off.
12916 Rejected articles will also be put in this draft group (@pxref{Rejected
12919 @findex gnus-draft-send-all-messages
12920 @kindex D s (Draft)
12921 @findex gnus-draft-send-message
12922 @kindex D S (Draft)
12923 If you have lots of rejected messages you want to post (or mail) without
12924 doing further editing, you can use the @kbd{D s} command
12925 (@code{gnus-draft-send-message}). This command understands the
12926 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
12927 command (@code{gnus-draft-send-all-messages}) will ship off all messages
12930 @findex gnus-draft-toggle-sending
12931 @kindex D t (Draft)
12932 If you have some messages that you wish not to send, you can use the
12933 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
12934 as unsendable. This is a toggling command.
12936 Finally, if you want to delete a draft, use the normal @kbd{B DEL}
12937 command (@pxref{Mail Group Commands}).
12940 @node Rejected Articles
12941 @section Rejected Articles
12942 @cindex rejected articles
12944 Sometimes a news server will reject an article. Perhaps the server
12945 doesn't like your face. Perhaps it just feels miserable. Perhaps
12946 @emph{there be demons}. Perhaps you have included too much cited text.
12947 Perhaps the disk is full. Perhaps the server is down.
12949 These situations are, of course, totally beyond the control of Gnus.
12950 (Gnus, of course, loves the way you look, always feels great, has angels
12951 fluttering around inside of it, doesn't care about how much cited text
12952 you include, never runs full and never goes down.) So Gnus saves these
12953 articles until some later time when the server feels better.
12955 The rejected articles will automatically be put in a special draft group
12956 (@pxref{Drafts}). When the server comes back up again, you'd then
12957 typically enter that group and send all the articles off.
12959 @node Signing and encrypting
12960 @section Signing and encrypting
12962 @cindex using s/mime
12963 @cindex using smime
12965 Gnus can digitally sign and encrypt your messages, using vanilla
12966 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
12967 decoding such messages, see the @code{mm-verify-option} and
12968 @code{mm-decrypt-option} options (@pxref{Security}).
12970 @vindex gnus-message-replysign
12971 @vindex gnus-message-replyencrypt
12972 @vindex gnus-message-replysignencrypted
12973 Often, you would like to sign replies to people who send you signed
12974 messages. Even more often, you might want to encrypt messages which
12975 are in reply to encrypted messages. Gnus offers
12976 @code{gnus-message-replysign} to enable the former, and
12977 @code{gnus-message-replyencrypt} for the latter. In addition, setting
12978 @code{gnus-message-replysignencrypted} (on by default) will sign
12979 automatically encrypted messages.
12981 Instructing @acronym{MML} to perform security operations on a
12982 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
12983 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
12988 @kindex C-c C-m s s (Message)
12989 @findex mml-secure-message-sign-smime
12991 Digitally sign current message using @acronym{S/MIME}.
12994 @kindex C-c C-m s o (Message)
12995 @findex mml-secure-message-sign-pgp
12997 Digitally sign current message using @acronym{PGP}.
13000 @kindex C-c C-m s p (Message)
13001 @findex mml-secure-message-sign-pgp
13003 Digitally sign current message using @acronym{PGP/MIME}.
13006 @kindex C-c C-m c s (Message)
13007 @findex mml-secure-message-encrypt-smime
13009 Digitally encrypt current message using @acronym{S/MIME}.
13012 @kindex C-c C-m c o (Message)
13013 @findex mml-secure-message-encrypt-pgp
13015 Digitally encrypt current message using @acronym{PGP}.
13018 @kindex C-c C-m c p (Message)
13019 @findex mml-secure-message-encrypt-pgpmime
13021 Digitally encrypt current message using @acronym{PGP/MIME}.
13024 @kindex C-c C-m C-n (Message)
13025 @findex mml-unsecure-message
13026 Remove security related @acronym{MML} tags from message.
13030 @xref{Security, ,Security, message, Message Manual}, for more information.
13032 @node Select Methods
13033 @chapter Select Methods
13034 @cindex foreign groups
13035 @cindex select methods
13037 A @dfn{foreign group} is a group not read by the usual (or
13038 default) means. It could be, for instance, a group from a different
13039 @acronym{NNTP} server, it could be a virtual group, or it could be your own
13040 personal mail group.
13042 A foreign group (or any group, really) is specified by a @dfn{name} and
13043 a @dfn{select method}. To take the latter first, a select method is a
13044 list where the first element says what back end to use (e.g., @code{nntp},
13045 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
13046 name}. There may be additional elements in the select method, where the
13047 value may have special meaning for the back end in question.
13049 One could say that a select method defines a @dfn{virtual server}---so
13050 we do just that (@pxref{Server Buffer}).
13052 The @dfn{name} of the group is the name the back end will recognize the
13055 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
13056 @samp{some.where.edu} will have the name @samp{soc.motss} and select
13057 method @code{(nntp "some.where.edu")}. Gnus will call this group
13058 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
13059 back end just knows this group as @samp{soc.motss}.
13061 The different methods all have their peculiarities, of course.
13064 * Server Buffer:: Making and editing virtual servers.
13065 * Getting News:: Reading USENET news with Gnus.
13066 * Using IMAP:: Reading mail from @acronym{IMAP}.
13067 * Getting Mail:: Reading your personal mail with Gnus.
13068 * Browsing the Web:: Getting messages from a plethora of Web sources.
13069 * Other Sources:: Reading directories, files.
13070 * Combined Groups:: Combining groups into one group.
13071 * Email Based Diary:: Using mails to manage diary events in Gnus.
13072 * Gnus Unplugged:: Reading news and mail offline.
13076 @node Server Buffer
13077 @section Server Buffer
13079 Traditionally, a @dfn{server} is a machine or a piece of software that
13080 one connects to, and then requests information from. Gnus does not
13081 connect directly to any real servers, but does all transactions through
13082 one back end or other. But that's just putting one layer more between
13083 the actual media and Gnus, so we might just as well say that each
13084 back end represents a virtual server.
13086 For instance, the @code{nntp} back end may be used to connect to several
13087 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
13088 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
13089 use, and what parameters to set by specifying a @dfn{select method}.
13091 These select method specifications can sometimes become quite
13092 complicated---say, for instance, that you want to read from the
13093 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
13094 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
13095 Anyway, if you had to specify that for each group that used this
13096 server, that would be too much work, so Gnus offers a way of naming
13097 select methods, which is what you do in the server buffer.
13099 To enter the server buffer, use the @kbd{^}
13100 (@code{gnus-group-enter-server-mode}) command in the group buffer.
13103 * Server Buffer Format:: You can customize the look of this buffer.
13104 * Server Commands:: Commands to manipulate servers.
13105 * Example Methods:: Examples server specifications.
13106 * Creating a Virtual Server:: An example session.
13107 * Server Variables:: Which variables to set.
13108 * Servers and Methods:: You can use server names as select methods.
13109 * Unavailable Servers:: Some servers you try to contact may be down.
13112 @vindex gnus-server-mode-hook
13113 @code{gnus-server-mode-hook} is run when creating the server buffer.
13116 @node Server Buffer Format
13117 @subsection Server Buffer Format
13118 @cindex server buffer format
13120 @vindex gnus-server-line-format
13121 You can change the look of the server buffer lines by changing the
13122 @code{gnus-server-line-format} variable. This is a @code{format}-like
13123 variable, with some simple extensions:
13128 How the news is fetched---the back end name.
13131 The name of this server.
13134 Where the news is to be fetched from---the address.
13137 The opened/closed/denied status of the server.
13140 Whether this server is agentized.
13143 @vindex gnus-server-mode-line-format
13144 The mode line can also be customized by using the
13145 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
13146 Formatting}). The following specs are understood:
13156 Also @pxref{Formatting Variables}.
13159 @node Server Commands
13160 @subsection Server Commands
13161 @cindex server commands
13167 @cindex keys, reserved for users (Server)
13168 The key @kbd{v} is reserved for users. You can bind it to some
13169 command or better use it as a prefix key.
13173 @findex gnus-server-add-server
13174 Add a new server (@code{gnus-server-add-server}).
13178 @findex gnus-server-edit-server
13179 Edit a server (@code{gnus-server-edit-server}).
13183 @findex gnus-server-show-server
13184 Show the definition of a server (@code{gnus-server-show-server}).
13187 @kindex SPACE (Server)
13188 @findex gnus-server-read-server
13189 Browse the current server (@code{gnus-server-read-server}).
13193 @findex gnus-server-exit
13194 Return to the group buffer (@code{gnus-server-exit}).
13198 @findex gnus-server-kill-server
13199 Kill the current server (@code{gnus-server-kill-server}).
13203 @findex gnus-server-yank-server
13204 Yank the previously killed server (@code{gnus-server-yank-server}).
13208 @findex gnus-server-copy-server
13209 Copy the current server (@code{gnus-server-copy-server}).
13213 @findex gnus-server-list-servers
13214 List all servers (@code{gnus-server-list-servers}).
13218 @findex gnus-server-scan-server
13219 Request that the server scan its sources for new articles
13220 (@code{gnus-server-scan-server}). This is mainly sensible with mail
13225 @findex gnus-server-regenerate-server
13226 Request that the server regenerate all its data structures
13227 (@code{gnus-server-regenerate-server}). This can be useful if you have
13228 a mail back end that has gotten out of sync.
13232 @findex gnus-server-compact-server
13234 Compact all groups in the server under point
13235 (@code{gnus-server-compact-server}). Currently implemented only in
13236 nnml (@pxref{Mail Spool}). This removes gaps between article numbers,
13237 hence getting a correct total article count.
13241 Some more commands for closing, disabling, and re-opening servers are
13242 listed in @ref{Unavailable Servers}.
13245 @node Example Methods
13246 @subsection Example Methods
13248 Most select methods are pretty simple and self-explanatory:
13251 (nntp "news.funet.fi")
13254 Reading directly from the spool is even simpler:
13260 As you can see, the first element in a select method is the name of the
13261 back end, and the second is the @dfn{address}, or @dfn{name}, if you
13264 After these two elements, there may be an arbitrary number of
13265 @code{(@var{variable} @var{form})} pairs.
13267 To go back to the first example---imagine that you want to read from
13268 port 15 on that machine. This is what the select method should
13272 (nntp "news.funet.fi" (nntp-port-number 15))
13275 You should read the documentation to each back end to find out what
13276 variables are relevant, but here's an @code{nnmh} example:
13278 @code{nnmh} is a mail back end that reads a spool-like structure. Say
13279 you have two structures that you wish to access: One is your private
13280 mail spool, and the other is a public one. Here's the possible spec for
13284 (nnmh "private" (nnmh-directory "~/private/mail/"))
13287 (This server is then called @samp{private}, but you may have guessed
13290 Here's the method for a public spool:
13294 (nnmh-directory "/usr/information/spool/")
13295 (nnmh-get-new-mail nil))
13301 If you are behind a firewall and only have access to the @acronym{NNTP}
13302 server from the firewall machine, you can instruct Gnus to @code{rlogin}
13303 on the firewall machine and connect with
13304 @uref{http://netcat.sourceforge.net/, netcat} from there to the
13305 @acronym{NNTP} server.
13306 Doing this can be rather fiddly, but your virtual server definition
13307 should probably look something like this:
13311 (nntp-open-connection-function nntp-open-via-rlogin-and-netcat)
13312 (nntp-via-address "the.firewall.machine")
13313 (nntp-address "the.real.nntp.host"))
13316 If you want to use the wonderful @code{ssh} program to provide a
13317 compressed connection over the modem line, you could add the following
13318 configuration to the example above:
13321 (nntp-via-rlogin-command "ssh")
13324 See also @code{nntp-via-rlogin-command-switches}. Here's an example for
13325 an indirect connection:
13328 (setq gnus-select-method
13330 (nntp-address "news.server.example")
13331 (nntp-via-user-name "intermediate_user_name")
13332 (nntp-via-address "intermediate.host.example")
13333 (nntp-via-rlogin-command "ssh")
13334 (nntp-via-rlogin-command-switches ("-C"))
13335 (nntp-open-connection-function nntp-open-via-rlogin-and-netcat)))
13338 This means that you have to have set up @code{ssh-agent} correctly to
13339 provide automatic authorization, of course.
13341 If you're behind a firewall, but have direct access to the outside world
13342 through a wrapper command like "runsocks", you could open a socksified
13343 netcat connection to the news server as follows:
13347 (nntp-pre-command "runsocks")
13348 (nntp-open-connection-function nntp-open-netcat-stream)
13349 (nntp-address "the.news.server"))
13353 @node Creating a Virtual Server
13354 @subsection Creating a Virtual Server
13356 If you're saving lots of articles in the cache by using persistent
13357 articles, you may want to create a virtual server to read the cache.
13359 First you need to add a new server. The @kbd{a} command does that. It
13360 would probably be best to use @code{nnml} to read the cache. You
13361 could also use @code{nnspool} or @code{nnmh}, though.
13363 Type @kbd{a nnml RET cache RET}.
13365 You should now have a brand new @code{nnml} virtual server called
13366 @samp{cache}. You now need to edit it to have the right definitions.
13367 Type @kbd{e} to edit the server. You'll be entered into a buffer that
13368 will contain the following:
13378 (nnml-directory "~/News/cache/")
13379 (nnml-active-file "~/News/cache/active"))
13382 Type @kbd{C-c C-c} to return to the server buffer. If you now press
13383 @kbd{RET} over this virtual server, you should be entered into a browse
13384 buffer, and you should be able to enter any of the groups displayed.
13387 @node Server Variables
13388 @subsection Server Variables
13389 @cindex server variables
13390 @cindex server parameters
13392 One sticky point when defining variables (both on back ends and in Emacs
13393 in general) is that some variables are typically initialized from other
13394 variables when the definition of the variables is being loaded. If you
13395 change the ``base'' variable after the variables have been loaded, you
13396 won't change the ``derived'' variables.
13398 This typically affects directory and file variables. For instance,
13399 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
13400 directory variables are initialized from that variable, so
13401 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
13402 new virtual @code{nnml} server, it will @emph{not} suffice to set just
13403 @code{nnml-directory}---you have to explicitly set all the file
13404 variables to be what you want them to be. For a complete list of
13405 variables for each back end, see each back end's section later in this
13406 manual, but here's an example @code{nnml} definition:
13410 (nnml-directory "~/my-mail/")
13411 (nnml-active-file "~/my-mail/active")
13412 (nnml-newsgroups-file "~/my-mail/newsgroups"))
13415 Server variables are often called @dfn{server parameters}.
13417 @node Servers and Methods
13418 @subsection Servers and Methods
13420 Wherever you would normally use a select method
13421 (e.g., @code{gnus-secondary-select-method}, in the group select method,
13422 when browsing a foreign server) you can use a virtual server name
13423 instead. This could potentially save lots of typing. And it's nice all
13427 @node Unavailable Servers
13428 @subsection Unavailable Servers
13430 If a server seems to be unreachable, Gnus will mark that server as
13431 @code{denied}. That means that any subsequent attempt to make contact
13432 with that server will just be ignored. ``It can't be opened,'' Gnus
13433 will tell you, without making the least effort to see whether that is
13434 actually the case or not.
13436 That might seem quite naughty, but it does make sense most of the time.
13437 Let's say you have 10 groups subscribed to on server
13438 @samp{nephelococcygia.com}. This server is located somewhere quite far
13439 away from you and the machine is quite slow, so it takes 1 minute just
13440 to find out that it refuses connection to you today. If Gnus were to
13441 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
13442 attempt to do that. Once it has gotten a single ``connection refused'',
13443 it will regard that server as ``down''.
13445 So, what happens if the machine was only feeling unwell temporarily?
13446 How do you test to see whether the machine has come up again?
13448 You jump to the server buffer (@pxref{Server Buffer}) and poke it
13449 with the following commands:
13455 @findex gnus-server-open-server
13456 Try to establish connection to the server on the current line
13457 (@code{gnus-server-open-server}).
13461 @findex gnus-server-close-server
13462 Close the connection (if any) to the server
13463 (@code{gnus-server-close-server}).
13467 @findex gnus-server-deny-server
13468 Mark the current server as unreachable
13469 (@code{gnus-server-deny-server}).
13472 @kindex M-o (Server)
13473 @findex gnus-server-open-all-servers
13474 Open the connections to all servers in the buffer
13475 (@code{gnus-server-open-all-servers}).
13478 @kindex M-c (Server)
13479 @findex gnus-server-close-all-servers
13480 Close the connections to all servers in the buffer
13481 (@code{gnus-server-close-all-servers}).
13485 @findex gnus-server-remove-denials
13486 Remove all marks to whether Gnus was denied connection from any servers
13487 (@code{gnus-server-remove-denials}).
13491 @findex gnus-server-copy-server
13492 Copy a server and give it a new name
13493 (@code{gnus-server-copy-server}). This can be useful if you have a
13494 complex method definition, and want to use the same definition towards
13495 a different (physical) server.
13499 @findex gnus-server-offline-server
13500 Set server status to offline (@code{gnus-server-offline-server}).
13506 @section Getting News
13507 @cindex reading news
13508 @cindex news back ends
13510 A newsreader is normally used for reading news. Gnus currently provides
13511 only two methods of getting news---it can read from an @acronym{NNTP} server,
13512 or it can read from a local spool.
13515 * NNTP:: Reading news from an @acronym{NNTP} server.
13516 * News Spool:: Reading news from the local spool.
13524 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
13525 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
13526 server as the, uhm, address.
13528 If the @acronym{NNTP} server is located at a non-standard port, setting the
13529 third element of the select method to this port number should allow you
13530 to connect to the right port. You'll have to edit the group info for
13531 that (@pxref{Foreign Groups}).
13533 The name of the foreign group can be the same as a native group. In
13534 fact, you can subscribe to the same group from as many different servers
13535 you feel like. There will be no name collisions.
13537 The following variables can be used to create a virtual @code{nntp}
13542 @item nntp-server-opened-hook
13543 @vindex nntp-server-opened-hook
13544 @cindex @sc{mode reader}
13546 @cindex authentication
13547 @cindex nntp authentication
13548 @findex nntp-send-authinfo
13549 @findex nntp-send-mode-reader
13550 is run after a connection has been made. It can be used to send
13551 commands to the @acronym{NNTP} server after it has been contacted. By
13552 default it sends the command @code{MODE READER} to the server with the
13553 @code{nntp-send-mode-reader} function. This function should always be
13554 present in this hook.
13556 @item nntp-authinfo-function
13557 @vindex nntp-authinfo-function
13558 @findex nntp-send-authinfo
13559 @vindex nntp-authinfo-file
13560 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
13561 server. The default function is @code{nntp-send-authinfo}, which looks
13562 through your @file{~/.authinfo} (or whatever you've set the
13563 @code{nntp-authinfo-file} variable to) for applicable entries. If none
13564 are found, it will prompt you for a login name and a password. The
13565 format of the @file{~/.authinfo} file is (almost) the same as the
13566 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
13567 manual page, but here are the salient facts:
13571 The file contains one or more line, each of which define one server.
13574 Each line may contain an arbitrary number of token/value pairs.
13576 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
13577 @samp{default}. In addition Gnus introduces two new tokens, not present
13578 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
13579 @samp{force}. (This is the only way the @file{.authinfo} file format
13580 deviates from the @file{.netrc} file format.) @samp{port} is used to
13581 indicate what port on the server the credentials apply to and
13582 @samp{force} is explained below.
13586 Here's an example file:
13589 machine news.uio.no login larsi password geheimnis
13590 machine nntp.ifi.uio.no login larsi force yes
13593 The token/value pairs may appear in any order; @samp{machine} doesn't
13594 have to be first, for instance.
13596 In this example, both login name and password have been supplied for the
13597 former server, while the latter has only the login name listed, and the
13598 user will be prompted for the password. The latter also has the
13599 @samp{force} tag, which means that the authinfo will be sent to the
13600 @var{nntp} server upon connection; the default (i.e., when there is not
13601 @samp{force} tag) is to not send authinfo to the @var{nntp} server
13602 until the @var{nntp} server asks for it.
13604 You can also add @samp{default} lines that will apply to all servers
13605 that don't have matching @samp{machine} lines.
13611 This will force sending @samp{AUTHINFO} commands to all servers not
13612 previously mentioned.
13614 Remember to not leave the @file{~/.authinfo} file world-readable.
13616 @item nntp-server-action-alist
13617 @vindex nntp-server-action-alist
13618 This is a list of regexps to match on server types and actions to be
13619 taken when matches are made. For instance, if you want Gnus to beep
13620 every time you connect to innd, you could say something like:
13623 (setq nntp-server-action-alist
13624 '(("innd" (ding))))
13627 You probably don't want to do that, though.
13629 The default value is
13632 '(("nntpd 1\\.5\\.11t"
13633 (remove-hook 'nntp-server-opened-hook
13634 'nntp-send-mode-reader)))
13637 This ensures that Gnus doesn't send the @code{MODE READER} command to
13638 nntpd 1.5.11t, since that command chokes that server, I've been told.
13640 @item nntp-maximum-request
13641 @vindex nntp-maximum-request
13642 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
13643 will collect headers by sending a series of @code{head} commands. To
13644 speed things up, the back end sends lots of these commands without
13645 waiting for reply, and then reads all the replies. This is controlled
13646 by the @code{nntp-maximum-request} variable, and is 400 by default. If
13647 your network is buggy, you should set this to 1.
13649 @item nntp-connection-timeout
13650 @vindex nntp-connection-timeout
13651 If you have lots of foreign @code{nntp} groups that you connect to
13652 regularly, you're sure to have problems with @acronym{NNTP} servers not
13653 responding properly, or being too loaded to reply within reasonable
13654 time. This is can lead to awkward problems, which can be helped
13655 somewhat by setting @code{nntp-connection-timeout}. This is an integer
13656 that says how many seconds the @code{nntp} back end should wait for a
13657 connection before giving up. If it is @code{nil}, which is the default,
13658 no timeouts are done.
13660 @item nntp-nov-is-evil
13661 @vindex nntp-nov-is-evil
13662 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
13663 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
13666 @item nntp-xover-commands
13667 @vindex nntp-xover-commands
13668 @cindex @acronym{NOV}
13670 List of strings used as commands to fetch @acronym{NOV} lines from a
13671 server. The default value of this variable is @code{("XOVER"
13675 @vindex nntp-nov-gap
13676 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
13677 the server. The server responds with one huge list of lines. However,
13678 if you have read articles 2--5000 in the group, and only want to read
13679 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
13680 lines that you will not need. This variable says how
13681 big a gap between two consecutive articles is allowed to be before the
13682 @code{XOVER} request is split into several request. Note that if your
13683 network is fast, setting this variable to a really small number means
13684 that fetching will probably be slower. If this variable is @code{nil},
13685 @code{nntp} will never split requests. The default is 5.
13687 @item nntp-xref-number-is-evil
13688 @vindex nntp-xref-number-is-evil
13689 When Gnus refers to an article having the @code{Message-ID} that a user
13690 specifies or having the @code{Message-ID} of the parent article of the
13691 current one (@pxref{Finding the Parent}), Gnus sends a @code{HEAD}
13692 command to the @acronym{NNTP} server to know where it is, and the server
13693 returns the data containing the pairs of a group and an article number
13694 in the @code{Xref} header. Gnus normally uses the article number to
13695 refer to the article if the data shows that that article is in the
13696 current group, while it uses the @code{Message-ID} otherwise. However,
13697 some news servers, e.g., ones running Diablo, run multiple engines
13698 having the same articles but article numbers are not kept synchronized
13699 between them. In that case, the article number that appears in the
13700 @code{Xref} header varies by which engine is chosen, so you cannot refer
13701 to the parent article that is in the current group, for instance. If
13702 you connect to such a server, set this variable to a non-@code{nil}
13703 value, and Gnus never uses article numbers. For example:
13706 (setq gnus-select-method
13708 (nntp-address "newszilla.example.com")
13709 (nntp-xref-number-is-evil t)
13713 The default value of this server variable is @code{nil}.
13715 @item nntp-prepare-server-hook
13716 @vindex nntp-prepare-server-hook
13717 A hook run before attempting to connect to an @acronym{NNTP} server.
13719 @item nntp-record-commands
13720 @vindex nntp-record-commands
13721 If non-@code{nil}, @code{nntp} will log all commands it sends to the
13722 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
13723 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
13724 that doesn't seem to work.
13726 @item nntp-open-connection-function
13727 @vindex nntp-open-connection-function
13728 It is possible to customize how the connection to the nntp server will
13729 be opened. If you specify an @code{nntp-open-connection-function}
13730 parameter, Gnus will use that function to establish the connection.
13731 Seven pre-made functions are supplied. These functions can be grouped
13732 in two categories: direct connection functions (four pre-made), and
13733 indirect ones (three pre-made).
13735 @item nntp-never-echoes-commands
13736 @vindex nntp-never-echoes-commands
13737 Non-@code{nil} means the nntp server never echoes commands. It is
13738 reported that some nntps server doesn't echo commands. So, you may want
13739 to set this to non-@code{nil} in the method for such a server setting
13740 @code{nntp-open-connection-function} to @code{nntp-open-ssl-stream} for
13741 example. The default value is @code{nil}. Note that the
13742 @code{nntp-open-connection-functions-never-echo-commands} variable
13743 overrides the @code{nil} value of this variable.
13745 @item nntp-open-connection-functions-never-echo-commands
13746 @vindex nntp-open-connection-functions-never-echo-commands
13747 List of functions that never echo commands. Add or set a function which
13748 you set to @code{nntp-open-connection-function} to this list if it does
13749 not echo commands. Note that a non-@code{nil} value of the
13750 @code{nntp-never-echoes-commands} variable overrides this variable. The
13751 default value is @code{(nntp-open-network-stream)}.
13753 @item nntp-prepare-post-hook
13754 @vindex nntp-prepare-post-hook
13755 A hook run just before posting an article. If there is no
13756 @code{Message-ID} header in the article and the news server provides the
13757 recommended ID, it will be added to the article before running this
13758 hook. It is useful to make @code{Cancel-Lock} headers even if you
13759 inhibit Gnus to add a @code{Message-ID} header, you could say:
13762 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
13765 Note that not all servers support the recommended ID@. This works for
13766 INN versions 2.3.0 and later, for instance.
13768 @item nntp-server-list-active-group
13769 If @code{nil}, then always use @samp{GROUP} instead of @samp{LIST
13770 ACTIVE}. This is usually slower, but on misconfigured servers that
13771 don't update their active files often, this can help.
13777 * Direct Functions:: Connecting directly to the server.
13778 * Indirect Functions:: Connecting indirectly to the server.
13779 * Common Variables:: Understood by several connection functions.
13783 @node Direct Functions
13784 @subsubsection Direct Functions
13785 @cindex direct connection functions
13787 These functions are called direct because they open a direct connection
13788 between your machine and the @acronym{NNTP} server. The behavior of these
13789 functions is also affected by commonly understood variables
13790 (@pxref{Common Variables}).
13793 @findex nntp-open-network-stream
13794 @item nntp-open-network-stream
13795 This is the default, and simply connects to some port or other on the
13796 remote system. If both Emacs and the server supports it, the
13797 connection will be upgraded to an encrypted @acronym{STARTTLS}
13798 connection automatically.
13801 The same as the above, but don't do automatic @acronym{STARTTLS} upgrades.
13803 @findex nntp-open-tls-stream
13804 @item nntp-open-tls-stream
13805 Opens a connection to a server over a @dfn{secure} channel. To use
13806 this you must have @uref{http://www.gnu.org/software/gnutls/, GnuTLS}
13807 installed. You then define a server as follows:
13810 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
13811 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
13813 (nntp "snews.bar.com"
13814 (nntp-open-connection-function nntp-open-tls-stream)
13815 (nntp-port-number 563)
13816 (nntp-address "snews.bar.com"))
13819 @findex nntp-open-ssl-stream
13820 @item nntp-open-ssl-stream
13821 Opens a connection to a server over a @dfn{secure} channel. To use
13822 this you must have @uref{http://www.openssl.org, OpenSSL}
13824 @c Defunct URL, ancient package, so don't mention it.
13825 or @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay}
13827 installed. You then define a server as follows:
13830 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
13831 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
13833 (nntp "snews.bar.com"
13834 (nntp-open-connection-function nntp-open-ssl-stream)
13835 (nntp-port-number 563)
13836 (nntp-address "snews.bar.com"))
13839 @findex nntp-open-netcat-stream
13840 @item nntp-open-netcat-stream
13841 Opens a connection to an @acronym{NNTP} server using the @code{netcat}
13842 program. You might wonder why this function exists, since we have
13843 the default @code{nntp-open-network-stream} which would do the job. (One
13844 of) the reason(s) is that if you are behind a firewall but have direct
13845 connections to the outside world thanks to a command wrapper like
13846 @code{runsocks}, you can use it like this:
13850 (nntp-pre-command "runsocks")
13851 (nntp-open-connection-function nntp-open-netcat-stream)
13852 (nntp-address "the.news.server"))
13855 With the default method, you would need to wrap your whole Emacs
13856 session, which is not a good idea.
13858 @findex nntp-open-telnet-stream
13859 @item nntp-open-telnet-stream
13860 Like @code{nntp-open-netcat-stream}, but uses @code{telnet} rather than
13861 @code{netcat}. @code{telnet} is a bit less robust because of things
13862 like line-end-conversion, but sometimes netcat is simply
13863 not available. The previous example would turn into:
13867 (nntp-pre-command "runsocks")
13868 (nntp-open-connection-function nntp-open-telnet-stream)
13869 (nntp-address "the.news.server")
13870 (nntp-end-of-line "\n"))
13875 @node Indirect Functions
13876 @subsubsection Indirect Functions
13877 @cindex indirect connection functions
13879 These functions are called indirect because they connect to an
13880 intermediate host before actually connecting to the @acronym{NNTP} server.
13881 All of these functions and related variables are also said to belong to
13882 the ``via'' family of connection: they're all prefixed with ``via'' to make
13883 things cleaner. The behavior of these functions is also affected by
13884 commonly understood variables (@pxref{Common Variables}).
13887 @item nntp-open-via-rlogin-and-netcat
13888 @findex nntp-open-via-rlogin-and-netcat
13889 Does an @samp{rlogin} on a remote system, and then uses @code{netcat} to connect
13890 to the real @acronym{NNTP} server from there. This is useful for instance if
13891 you need to connect to a firewall machine first.
13893 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
13896 @item nntp-via-rlogin-command
13897 @vindex nntp-via-rlogin-command
13898 Command used to log in on the intermediate host. The default is
13899 @samp{rsh}, but @samp{ssh} is a popular alternative.
13901 @item nntp-via-rlogin-command-switches
13902 @vindex nntp-via-rlogin-command-switches
13903 List of strings to be used as the switches to
13904 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
13905 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
13906 @samp{("-C")} in order to compress all data connections.
13909 @item nntp-open-via-rlogin-and-telnet
13910 @findex nntp-open-via-rlogin-and-telnet
13911 Does essentially the same, but uses @code{telnet} instead of @samp{netcat}
13912 to connect to the real @acronym{NNTP} server from the intermediate host.
13913 @code{telnet} is a bit less robust because of things like
13914 line-end-conversion, but sometimes @code{netcat} is simply not available.
13916 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
13919 @item nntp-telnet-command
13920 @vindex nntp-telnet-command
13921 Command used to connect to the real @acronym{NNTP} server from the
13922 intermediate host. The default is @samp{telnet}.
13924 @item nntp-telnet-switches
13925 @vindex nntp-telnet-switches
13926 List of strings to be used as the switches to the
13927 @code{nntp-telnet-command} command. The default is @code{("-8")}.
13929 @item nntp-via-rlogin-command
13930 @vindex nntp-via-rlogin-command
13931 Command used to log in on the intermediate host. The default is
13932 @samp{rsh}, but @samp{ssh} is a popular alternative.
13934 @item nntp-via-rlogin-command-switches
13935 @vindex nntp-via-rlogin-command-switches
13936 List of strings to be used as the switches to
13937 @code{nntp-via-rlogin-command}. If you use @samp{ssh}, you may need to set
13938 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
13939 the telnet command requires a pseudo-tty allocation on an intermediate
13940 host. The default is @code{nil}.
13943 Note that you may want to change the value for @code{nntp-end-of-line}
13944 to @samp{\n} (@pxref{Common Variables}).
13946 @item nntp-open-via-telnet-and-telnet
13947 @findex nntp-open-via-telnet-and-telnet
13948 Does essentially the same, but uses @samp{telnet} instead of
13949 @samp{rlogin} to connect to the intermediate host.
13951 @code{nntp-open-via-telnet-and-telnet}-specific variables:
13954 @item nntp-via-telnet-command
13955 @vindex nntp-via-telnet-command
13956 Command used to @code{telnet} the intermediate host. The default is
13959 @item nntp-via-telnet-switches
13960 @vindex nntp-via-telnet-switches
13961 List of strings to be used as the switches to the
13962 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
13964 @item nntp-via-user-password
13965 @vindex nntp-via-user-password
13966 Password to use when logging in on the intermediate host.
13968 @item nntp-via-envuser
13969 @vindex nntp-via-envuser
13970 If non-@code{nil}, the intermediate @code{telnet} session (client and
13971 server both) will support the @code{ENVIRON} option and not prompt for
13972 login name. This works for Solaris @code{telnet}, for instance.
13974 @item nntp-via-shell-prompt
13975 @vindex nntp-via-shell-prompt
13976 Regexp matching the shell prompt on the intermediate host. The default
13977 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
13981 Note that you may want to change the value for @code{nntp-end-of-line}
13982 to @samp{\n} (@pxref{Common Variables}).
13986 Here are some additional variables that are understood by all the above
13991 @item nntp-via-user-name
13992 @vindex nntp-via-user-name
13993 User name to use when connecting to the intermediate host.
13995 @item nntp-via-address
13996 @vindex nntp-via-address
13997 Address of the intermediate host to connect to.
14002 @node Common Variables
14003 @subsubsection Common Variables
14005 The following variables affect the behavior of all, or several of the
14006 pre-made connection functions. When not specified, all functions are
14007 affected (the values of the following variables will be used as the
14008 default if each virtual @code{nntp} server doesn't specify those server
14009 variables individually).
14013 @item nntp-pre-command
14014 @vindex nntp-pre-command
14015 A command wrapper to use when connecting through a non native
14016 connection function (all except @code{nntp-open-network-stream},
14017 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}). This is
14018 where you would put a @samp{SOCKS} wrapper for instance.
14021 @vindex nntp-address
14022 The address of the @acronym{NNTP} server.
14024 @item nntp-port-number
14025 @vindex nntp-port-number
14026 Port number to connect to the @acronym{NNTP} server. The default is
14027 @samp{nntp}. If you use @acronym{NNTP} over
14028 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
14029 than named ports (i.e., use @samp{563} instead of @samp{snews} or
14030 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
14031 not work with named ports.
14033 @item nntp-end-of-line
14034 @vindex nntp-end-of-line
14035 String to use as end-of-line marker when talking to the @acronym{NNTP}
14036 server. This is @samp{\r\n} by default, but should be @samp{\n} when
14037 using a non native telnet connection function.
14039 @item nntp-netcat-command
14040 @vindex nntp-netcat-command
14041 Command to use when connecting to the @acronym{NNTP} server through
14042 @samp{netcat}. This is @emph{not} for an intermediate host. This is
14043 just for the real @acronym{NNTP} server. The default is
14046 @item nntp-netcat-switches
14047 @vindex nntp-netcat-switches
14048 A list of switches to pass to @code{nntp-netcat-command}. The default
14054 @subsection News Spool
14058 Subscribing to a foreign group from the local spool is extremely easy,
14059 and might be useful, for instance, to speed up reading groups that
14060 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
14063 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
14064 anything else) as the address.
14066 If you have access to a local spool, you should probably use that as the
14067 native select method (@pxref{Finding the News}). It is normally faster
14068 than using an @code{nntp} select method, but might not be. It depends.
14069 You just have to try to find out what's best at your site.
14073 @item nnspool-inews-program
14074 @vindex nnspool-inews-program
14075 Program used to post an article.
14077 @item nnspool-inews-switches
14078 @vindex nnspool-inews-switches
14079 Parameters given to the inews program when posting an article.
14081 @item nnspool-spool-directory
14082 @vindex nnspool-spool-directory
14083 Where @code{nnspool} looks for the articles. This is normally
14084 @file{/usr/spool/news/}.
14086 @item nnspool-nov-directory
14087 @vindex nnspool-nov-directory
14088 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
14089 @file{/usr/spool/news/over.view/}.
14091 @item nnspool-lib-dir
14092 @vindex nnspool-lib-dir
14093 Where the news lib dir is (@file{/usr/lib/news/} by default).
14095 @item nnspool-active-file
14096 @vindex nnspool-active-file
14097 The name of the active file.
14099 @item nnspool-newsgroups-file
14100 @vindex nnspool-newsgroups-file
14101 The name of the group descriptions file.
14103 @item nnspool-history-file
14104 @vindex nnspool-history-file
14105 The name of the news history file.
14107 @item nnspool-active-times-file
14108 @vindex nnspool-active-times-file
14109 The name of the active date file.
14111 @item nnspool-nov-is-evil
14112 @vindex nnspool-nov-is-evil
14113 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
14116 @item nnspool-sift-nov-with-sed
14117 @vindex nnspool-sift-nov-with-sed
14119 If non-@code{nil}, which is the default, use @code{sed} to get the
14120 relevant portion from the overview file. If @code{nil},
14121 @code{nnspool} will load the entire file into a buffer and process it
14128 @section Using IMAP
14131 The most popular mail backend is probably @code{nnimap}, which
14132 provides access to @acronym{IMAP} servers. @acronym{IMAP} servers
14133 store mail remotely, so the client doesn't store anything locally.
14134 This means that it's a convenient choice when you're reading your mail
14135 from different locations, or with different user agents.
14138 * Connecting to an IMAP Server:: Getting started with @acronym{IMAP}.
14139 * Customizing the IMAP Connection:: Variables for @acronym{IMAP} connection.
14140 * Client-Side IMAP Splitting:: Put mail in the correct mail box.
14144 @node Connecting to an IMAP Server
14145 @subsection Connecting to an IMAP Server
14147 Connecting to an @acronym{IMAP} can be very easy. Type @kbd{B} in the
14148 group buffer, or (if your primary interest is reading email), say
14152 (setq gnus-select-method
14153 '(nnimap "imap.gmail.com"))
14156 You'll be prompted for a user name and password. If you grow tired of
14157 that, then add the following to your @file{~/.authinfo} file:
14160 machine imap.gmail.com login <username> password <password> port imap
14163 That should basically be it for most users.
14166 @node Customizing the IMAP Connection
14167 @subsection Customizing the IMAP Connection
14169 Here's an example method that's more complex:
14172 (nnimap "imap.gmail.com"
14173 (nnimap-inbox "INBOX")
14174 (nnimap-split-methods default)
14176 (nnimap-stream ssl))
14180 @item nnimap-address
14181 The address of the server, like @samp{imap.gmail.com}.
14183 @item nnimap-server-port
14184 If the server uses a non-standard port, that can be specified here. A
14185 typical port would be @code{"imap"} or @code{"imaps"}.
14187 @item nnimap-stream
14188 How @code{nnimap} should connect to the server. Possible values are:
14192 This is the default, and this first tries the @code{ssl} setting, and
14193 then tries the @code{network} setting.
14196 This uses standard @acronym{TLS}/@acronym{SSL} connections.
14199 Non-encrypted and unsafe straight socket connection, but will upgrade
14200 to encrypted @acronym{STARTTLS} if both Emacs and the server
14204 Encrypted @acronym{STARTTLS} over the normal @acronym{IMAP} port.
14207 If you need to tunnel via other systems to connect to the server, you
14208 can use this option, and customize @code{nnimap-shell-program} to be
14213 @item nnimap-authenticator
14214 Some @acronym{IMAP} servers allow anonymous logins. In that case,
14215 this should be set to @code{anonymous}. If this variable isn't set,
14216 the normal login methods will be used. If you wish to specify a
14217 specific login method to be used, you can set this variable to either
14218 @code{login} (the traditional @acronym{IMAP} login method),
14219 @code{plain} or @code{cram-md5}.
14221 @item nnimap-expunge
14222 If non-@code{nil}, expunge articles after deleting them. This is always done
14223 if the server supports UID EXPUNGE, but it's not done by default on
14224 servers that doesn't support that command.
14226 @item nnimap-streaming
14227 Virtually all @acronym{IMAP} server support fast streaming of data.
14228 If you have problems connecting to the server, try setting this to
14231 @item nnimap-fetch-partial-articles
14232 If non-@code{nil}, fetch partial articles from the server. If set to
14233 a string, then it's interpreted as a regexp, and parts that have
14234 matching types will be fetched. For instance, @samp{"text/"} will
14235 fetch all textual parts, while leaving the rest on the server.
14237 @item nnimap-record-commands
14238 If non-@code{nil}, record all @acronym{IMAP} commands in the
14239 @samp{"*imap log*"} buffer.
14244 @node Client-Side IMAP Splitting
14245 @subsection Client-Side IMAP Splitting
14247 Many people prefer to do the sorting/splitting of mail into their mail
14248 boxes on the @acronym{IMAP} server. That way they don't have to
14249 download the mail they're not all that interested in.
14251 If you do want to do client-side mail splitting, then the following
14252 variables are relevant:
14256 This is the @acronym{IMAP} mail box that will be scanned for new
14257 mail. This can also be a list of mail box names.
14259 @item nnimap-split-methods
14260 Uses the same syntax as @code{nnmail-split-methods} (@pxref{Splitting
14261 Mail}), except the symbol @code{default}, which means that it should
14262 use the value of the @code{nnmail-split-methods} variable.
14264 @item nnimap-split-fancy
14265 Uses the same syntax as @code{nnmail-split-fancy}.
14267 @item nnimap-unsplittable-articles
14268 List of flag symbols to ignore when doing splitting. That is,
14269 articles that have these flags won't be considered when splitting.
14270 The default is @samp{(%Deleted %Seen)}.
14274 Here's a complete example @code{nnimap} backend with a client-side
14275 ``fancy'' splitting method:
14278 (nnimap "imap.example.com"
14279 (nnimap-inbox "INBOX")
14280 (nnimap-split-methods
14281 (| ("MailScanner-SpamCheck" "spam" "spam.detected")
14282 (to "foo@@bar.com" "foo")
14288 @section Getting Mail
14289 @cindex reading mail
14292 Reading mail with a newsreader---isn't that just plain WeIrD@? But of
14296 * Mail in a Newsreader:: Important introductory notes.
14297 * Getting Started Reading Mail:: A simple cookbook example.
14298 * Splitting Mail:: How to create mail groups.
14299 * Mail Sources:: How to tell Gnus where to get mail from.
14300 * Mail Back End Variables:: Variables for customizing mail handling.
14301 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
14302 * Group Mail Splitting:: Use group customize to drive mail splitting.
14303 * Incorporating Old Mail:: What about the old mail you have?
14304 * Expiring Mail:: Getting rid of unwanted mail.
14305 * Washing Mail:: Removing cruft from the mail you get.
14306 * Duplicates:: Dealing with duplicated mail.
14307 * Not Reading Mail:: Using mail back ends for reading other files.
14308 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
14312 @node Mail in a Newsreader
14313 @subsection Mail in a Newsreader
14315 If you are used to traditional mail readers, but have decided to switch
14316 to reading mail with Gnus, you may find yourself experiencing something
14317 of a culture shock.
14319 Gnus does not behave like traditional mail readers. If you want to make
14320 it behave that way, you can, but it's an uphill battle.
14322 Gnus, by default, handles all its groups using the same approach. This
14323 approach is very newsreaderly---you enter a group, see the new/unread
14324 messages, and when you read the messages, they get marked as read, and
14325 you don't see them any more. (Unless you explicitly ask for them.)
14327 In particular, you do not do anything explicitly to delete messages.
14329 Does this mean that all the messages that have been marked as read are
14330 deleted? How awful!
14332 But, no, it means that old messages are @dfn{expired} according to some
14333 scheme or other. For news messages, the expire process is controlled by
14334 the news administrator; for mail, the expire process is controlled by
14335 you. The expire process for mail is covered in depth in @ref{Expiring
14338 What many Gnus users find, after using it a while for both news and
14339 mail, is that the transport mechanism has very little to do with how
14340 they want to treat a message.
14342 Many people subscribe to several mailing lists. These are transported
14343 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
14344 answering, or even reading these messages very carefully. We may not
14345 need to save them because if we should need to read one again, they are
14346 archived somewhere else.
14348 Some people have local news groups which have only a handful of readers.
14349 These are transported via @acronym{NNTP}, and are therefore news. But we may need
14350 to read and answer a large fraction of the messages very carefully in
14351 order to do our work. And there may not be an archive, so we may need
14352 to save the interesting messages the same way we would personal mail.
14354 The important distinction turns out to be not the transport mechanism,
14355 but other factors such as how interested we are in the subject matter,
14356 or how easy it is to retrieve the message if we need to read it again.
14358 Gnus provides many options for sorting mail into ``groups'' which behave
14359 like newsgroups, and for treating each group (whether mail or news)
14362 Some users never get comfortable using the Gnus (ahem) paradigm and wish
14363 that Gnus should grow up and be a male, er, mail reader. It is possible
14364 to whip Gnus into a more mailreaderly being, but, as said before, it's
14365 not easy. People who prefer proper mail readers should try @sc{vm}
14366 instead, which is an excellent, and proper, mail reader.
14368 I don't mean to scare anybody off, but I want to make it clear that you
14369 may be required to learn a new way of thinking about messages. After
14370 you've been subjected to The Gnus Way, you will come to love it. I can
14371 guarantee it. (At least the guy who sold me the Emacs Subliminal
14372 Brain-Washing Functions that I've put into Gnus did guarantee it. You
14373 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
14377 @node Getting Started Reading Mail
14378 @subsection Getting Started Reading Mail
14380 It's quite easy to use Gnus to read your new mail. You just plonk the
14381 mail back end of your choice into @code{gnus-secondary-select-methods},
14382 and things will happen automatically.
14384 For instance, if you want to use @code{nnml} (which is a ``one file per
14385 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
14388 (setq gnus-secondary-select-methods '((nnml "")))
14391 Now, the next time you start Gnus, this back end will be queried for new
14392 articles, and it will move all the messages in your spool file to its
14393 directory, which is @file{~/Mail/} by default. The new group that will
14394 be created (@samp{mail.misc}) will be subscribed, and you can read it
14395 like any other group.
14397 You will probably want to split the mail into several groups, though:
14400 (setq nnmail-split-methods
14401 '(("junk" "^From:.*Lars Ingebrigtsen")
14402 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
14406 This will result in three new @code{nnml} mail groups being created:
14407 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
14408 mail that doesn't fit into the first two groups will be placed in the
14411 This should be sufficient for reading mail with Gnus. You might want to
14412 give the other sections in this part of the manual a perusal, though.
14413 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
14416 @node Splitting Mail
14417 @subsection Splitting Mail
14418 @cindex splitting mail
14419 @cindex mail splitting
14420 @cindex mail filtering (splitting)
14422 @vindex nnmail-split-methods
14423 The @code{nnmail-split-methods} variable says how the incoming mail is
14424 to be split into groups.
14427 (setq nnmail-split-methods
14428 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
14429 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
14430 ("mail.other" "")))
14433 This variable is a list of lists, where the first element of each of
14434 these lists is the name of the mail group (they do not have to be called
14435 something beginning with @samp{mail}, by the way), and the second
14436 element is a regular expression used on the header of each mail to
14437 determine if it belongs in this mail group. The first string may
14438 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
14439 insert sub-expressions from the matched text. For instance:
14442 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
14446 In that case, @code{nnmail-split-lowercase-expanded} controls whether
14447 the inserted text should be made lowercase. @xref{Fancy Mail Splitting}.
14449 The second element can also be a function. In that case, it will be
14450 called narrowed to the headers with the first element of the rule as the
14451 argument. It should return a non-@code{nil} value if it thinks that the
14452 mail belongs in that group.
14454 @cindex @samp{bogus} group
14455 The last of these groups should always be a general one, and the regular
14456 expression should @emph{always} be @samp{""} so that it matches any mails
14457 that haven't been matched by any of the other regexps. (These rules are
14458 processed from the beginning of the alist toward the end. The first rule
14459 to make a match will ``win'', unless you have crossposting enabled. In
14460 that case, all matching rules will ``win''.) If no rule matched, the mail
14461 will end up in the @samp{bogus} group. When new groups are created by
14462 splitting mail, you may want to run @code{gnus-group-find-new-groups} to
14463 see the new groups. This also applies to the @samp{bogus} group.
14465 If you like to tinker with this yourself, you can set this variable to a
14466 function of your choice. This function will be called without any
14467 arguments in a buffer narrowed to the headers of an incoming mail
14468 message. The function should return a list of group names that it
14469 thinks should carry this mail message.
14471 This variable can also be a fancy split method. For the syntax,
14472 see @ref{Fancy Mail Splitting}.
14474 Note that the mail back ends are free to maul the poor, innocent,
14475 incoming headers all they want to. They all add @code{Lines} headers;
14476 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
14477 @code{From<SPACE>} line to something else.
14479 @vindex nnmail-crosspost
14480 The mail back ends all support cross-posting. If several regexps match,
14481 the mail will be ``cross-posted'' to all those groups.
14482 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
14483 that no articles are crossposted to the general (@samp{""}) group.
14485 @vindex nnmail-crosspost-link-function
14488 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
14489 the crossposted articles. However, not all file systems support hard
14490 links. If that's the case for you, set
14491 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
14492 variable is @code{add-name-to-file} by default.)
14494 @kindex M-x nnmail-split-history
14495 @findex nnmail-split-history
14496 If you wish to see where the previous mail split put the messages, you
14497 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
14498 where re-spooling messages would put the messages, you can use
14499 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
14502 @vindex nnmail-split-header-length-limit
14503 Header lines longer than the value of
14504 @code{nnmail-split-header-length-limit} are excluded from the split
14507 @vindex nnmail-mail-splitting-decodes
14508 @vindex nnmail-mail-splitting-charset
14509 By default, splitting does not decode headers, so you can not match on
14510 non-@acronym{ASCII} strings. But it is useful if you want to match
14511 articles based on the raw header data. To enable it, set the
14512 @code{nnmail-mail-splitting-decodes} variable to a non-@code{nil} value.
14513 In addition, the value of the @code{nnmail-mail-splitting-charset}
14514 variable is used for decoding non-@acronym{MIME} encoded string when
14515 @code{nnmail-mail-splitting-decodes} is non-@code{nil}. The default
14516 value is @code{nil} which means not to decode non-@acronym{MIME} encoded
14517 string. A suitable value for you will be @code{undecided} or be the
14518 charset used normally in mails you are interested in.
14520 @vindex nnmail-resplit-incoming
14521 By default, splitting is performed on all incoming messages. If you
14522 specify a @code{directory} entry for the variable @code{mail-sources}
14523 (@pxref{Mail Source Specifiers}), however, then splitting does
14524 @emph{not} happen by default. You can set the variable
14525 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
14526 splitting happen even in this case. (This variable has no effect on
14527 other kinds of entries.)
14529 Gnus gives you all the opportunity you could possibly want for shooting
14530 yourself in the foot. Let's say you create a group that will contain
14531 all the mail you get from your boss. And then you accidentally
14532 unsubscribe from the group. Gnus will still put all the mail from your
14533 boss in the unsubscribed group, and so, when your boss mails you ``Have
14534 that report ready by Monday or you're fired!'', you'll never see it and,
14535 come Tuesday, you'll still believe that you're gainfully employed while
14536 you really should be out collecting empty bottles to save up for next
14537 month's rent money.
14541 @subsection Mail Sources
14543 Mail can be gotten from many different sources---the mail spool, from
14544 a @acronym{POP} mail server, from a procmail directory, or from a
14545 maildir, for instance.
14548 * Mail Source Specifiers:: How to specify what a mail source is.
14549 * Mail Source Functions::
14550 * Mail Source Customization:: Some variables that influence things.
14551 * Fetching Mail:: Using the mail source specifiers.
14555 @node Mail Source Specifiers
14556 @subsubsection Mail Source Specifiers
14558 @cindex mail server
14561 @cindex mail source
14563 You tell Gnus how to fetch mail by setting @code{mail-sources}
14564 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
14569 (pop :server "pop3.mailserver.com" :user "myname")
14572 As can be observed, a mail source specifier is a list where the first
14573 element is a @dfn{mail source type}, followed by an arbitrary number of
14574 @dfn{keywords}. Keywords that are not explicitly specified are given
14577 The @code{mail-sources} is global for all mail groups. You can specify
14578 an additional mail source for a particular group by including the
14579 @code{group} mail specifier in @code{mail-sources}, and setting a
14580 @code{mail-source} group parameter (@pxref{Group Parameters}) specifying
14581 a single mail source. When this is used, @code{mail-sources} is
14582 typically just @code{(group)}; the @code{mail-source} parameter for a
14583 group might look like this:
14586 (mail-source . (file :path "home/user/spools/foo.spool"))
14589 This means that the group's (and only this group's) messages will be
14590 fetched from the spool file @samp{/user/spools/foo.spool}.
14592 The following mail source types are available:
14596 Get mail from a single file; typically from the mail spool.
14602 The file name. Defaults to the value of the @env{MAIL}
14603 environment variable or the value of @code{rmail-spool-directory}
14604 (usually something like @file{/usr/mail/spool/user-name}).
14608 Script run before/after fetching mail.
14611 An example file mail source:
14614 (file :path "/usr/spool/mail/user-name")
14617 Or using the default file name:
14623 If the mail spool file is not located on the local machine, it's best
14624 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
14625 You can not use ange-ftp file names here---it has no way to lock the
14626 mail spool while moving the mail.
14628 If it's impossible to set up a proper server, you can use ssh instead.
14632 '((file :prescript "ssh host bin/getmail >%t")))
14635 The @samp{getmail} script would look something like the following:
14639 # getmail - move mail from spool to stdout
14642 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
14644 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
14647 Alter this script to fit the @samp{movemail} and temporary
14648 file you want to use.
14652 @vindex nnmail-scan-directory-mail-source-once
14653 Get mail from several files in a directory. This is typically used
14654 when you have procmail split the incoming mail into several files.
14655 That is, there is a one-to-one correspondence between files in that
14656 directory and groups, so that mail from the file @file{foo.bar.spool}
14657 will be put in the group @code{foo.bar}. (You can change the suffix
14658 to be used instead of @code{.spool}.) Setting
14659 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
14660 Gnus to scan the mail source only once. This is particularly useful
14661 if you want to scan mail groups at a specified level.
14663 @vindex nnmail-resplit-incoming
14664 There is also the variable @code{nnmail-resplit-incoming}, if you set
14665 that to a non-@code{nil} value, then the normal splitting process is
14666 applied to all the files from the directory, @ref{Splitting Mail}.
14672 The name of the directory where the files are. There is no default
14676 Only files ending with this suffix are used. The default is
14680 Only files that have this predicate return non-@code{nil} are returned.
14681 The default is @code{identity}. This is used as an additional
14682 filter---only files that have the right suffix @emph{and} satisfy this
14683 predicate are considered.
14687 Script run before/after fetching mail.
14691 An example directory mail source:
14694 (directory :path "/home/user-name/procmail-dir/"
14699 Get mail from a @acronym{POP} server.
14705 The name of the @acronym{POP} server. The default is taken from the
14706 @env{MAILHOST} environment variable.
14709 The port number of the @acronym{POP} server. This can be a number (e.g.,
14710 @samp{:port 1234}) or a string (e.g., @samp{:port "pop3"}). If it is a
14711 string, it should be a service name as listed in @file{/etc/services} on
14712 Unix systems. The default is @samp{"pop3"}. On some systems you might
14713 need to specify it as @samp{"pop-3"} instead.
14716 The user name to give to the @acronym{POP} server. The default is the login
14720 The password to give to the @acronym{POP} server. If not specified,
14721 the user is prompted.
14724 The program to use to fetch mail from the @acronym{POP} server. This
14725 should be a @code{format}-like string. Here's an example:
14728 fetchmail %u@@%s -P %p %t
14731 The valid format specifier characters are:
14735 The name of the file the mail is to be moved to. This must always be
14736 included in this string.
14739 The name of the server.
14742 The port number of the server.
14745 The user name to use.
14748 The password to use.
14751 The values used for these specs are taken from the values you give the
14752 corresponding keywords.
14755 A script to be run before fetching the mail. The syntax is the same as
14756 the @code{:program} keyword. This can also be a function to be run.
14758 One popular way to use this is to set up an SSH tunnel to access the
14759 @acronym{POP} server. Here's an example:
14762 (pop :server "127.0.0.1"
14767 "nohup ssh -f -L 1234:pop.server:110 remote.host sleep 3600 &")
14771 A script to be run after fetching the mail. The syntax is the same as
14772 the @code{:program} keyword. This can also be a function to be run.
14775 The function to use to fetch mail from the @acronym{POP} server. The
14776 function is called with one parameter---the name of the file where the
14777 mail should be moved to.
14779 @item :authentication
14780 This can be either the symbol @code{password} or the symbol @code{apop}
14781 and says what authentication scheme to use. The default is
14785 Non-@code{nil} if the mail is to be left on the @acronym{POP} server
14786 after fetching. Mails once fetched will never be fetched again by the
14787 @acronym{UIDL} control. Only the built-in @code{pop3-movemail} program
14788 (the default) supports this keyword.
14790 If this is neither @code{nil} nor a number, all mails will be left on
14791 the server. If this is a number, leave mails on the server for this
14792 many days since you first checked new mails. If this is @code{nil}
14793 (the default), mails will be deleted on the server right after fetching.
14795 @vindex pop3-uidl-file
14796 The @code{pop3-uidl-file} variable specifies the file to which the
14797 @acronym{UIDL} data are locally stored. The default value is
14798 @file{~/.pop3-uidl}.
14800 Note that @acronym{POP} servers maintain no state information between
14801 sessions, so what the client believes is there and what is actually
14802 there may not match up. If they do not, then you may get duplicate
14803 mails or the whole thing can fall apart and leave you with a corrupt
14808 @findex pop3-movemail
14809 @vindex pop3-leave-mail-on-server
14810 If the @code{:program} and @code{:function} keywords aren't specified,
14811 @code{pop3-movemail} will be used.
14813 Here are some examples for getting mail from a @acronym{POP} server.
14815 Fetch from the default @acronym{POP} server, using the default user
14816 name, and default fetcher:
14822 Fetch from a named server with a named user and password:
14825 (pop :server "my.pop.server"
14826 :user "user-name" :password "secret")
14829 Leave mails on the server for 14 days:
14832 (pop :server "my.pop.server"
14833 :user "user-name" :password "secret"
14837 Use @samp{movemail} to move the mail:
14840 (pop :program "movemail po:%u %t %p")
14844 Get mail from a maildir. This is a type of mailbox that is supported by
14845 at least qmail and postfix, where each file in a special directory
14846 contains exactly one mail.
14852 The name of the directory where the mails are stored. The default is
14853 taken from the @env{MAILDIR} environment variable or
14856 The subdirectories of the Maildir. The default is
14857 @samp{("new" "cur")}.
14859 @c If you sometimes look at your mail through a pop3 daemon before fetching
14860 @c them with Gnus, you may also have to fetch your mails from the
14861 @c @code{cur} directory inside the maildir, like in the first example
14864 You can also get mails from remote hosts (because maildirs don't suffer
14865 from locking problems).
14869 Two example maildir mail sources:
14872 (maildir :path "/home/user-name/Maildir/"
14873 :subdirs ("cur" "new"))
14877 (maildir :path "/user@@remotehost.org:~/Maildir/"
14882 Get mail from a @acronym{IMAP} server. If you don't want to use
14883 @acronym{IMAP} as intended, as a network mail reading protocol (i.e.,
14884 with nnimap), for some reason or other, Gnus let you treat it similar
14885 to a @acronym{POP} server and fetches articles from a given
14886 @acronym{IMAP} mailbox. @xref{Using IMAP}, for more information.
14892 The name of the @acronym{IMAP} server. The default is taken from the
14893 @env{MAILHOST} environment variable.
14896 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
14897 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
14900 The user name to give to the @acronym{IMAP} server. The default is the login
14904 The password to give to the @acronym{IMAP} server. If not specified, the user is
14908 What stream to use for connecting to the server, this is one of the
14909 symbols in @code{imap-stream-alist}. Right now, this means
14910 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
14911 @samp{ssl}, @samp{shell} or the default @samp{network}.
14913 @item :authentication
14914 Which authenticator to use for authenticating to the server, this is
14915 one of the symbols in @code{imap-authenticator-alist}. Right now,
14916 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
14917 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
14920 When using the `shell' :stream, the contents of this variable is
14921 mapped into the @code{imap-shell-program} variable. This should be a
14922 @code{format}-like string (or list of strings). Here's an example:
14928 Make sure nothing is interfering with the output of the program, e.g.,
14929 don't forget to redirect the error output to the void. The valid format
14930 specifier characters are:
14934 The name of the server.
14937 User name from @code{imap-default-user}.
14940 The port number of the server.
14943 The values used for these specs are taken from the values you give the
14944 corresponding keywords.
14947 The name of the mailbox to get mail from. The default is @samp{INBOX}
14948 which normally is the mailbox which receives incoming mail.
14951 The predicate used to find articles to fetch. The default, @samp{UNSEEN
14952 UNDELETED}, is probably the best choice for most people, but if you
14953 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
14954 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
14955 Then all articles in the mailbox is fetched, no matter what. For a
14956 complete list of predicates, see RFC 2060 section 6.4.4.
14959 How to flag fetched articles on the server, the default @samp{\Deleted}
14960 will mark them as deleted, an alternative would be @samp{\Seen} which
14961 would simply mark them as read. These are the two most likely choices,
14962 but more flags are defined in RFC 2060 section 2.3.2.
14965 If non-@code{nil}, don't remove all articles marked as deleted in the
14966 mailbox after finishing the fetch.
14970 An example @acronym{IMAP} mail source:
14973 (imap :server "mail.mycorp.com"
14975 :fetchflag "\\Seen")
14979 Get the actual mail source from the @code{mail-source} group parameter,
14980 @xref{Group Parameters}.
14985 @item Common Keywords
14986 Common keywords can be used in any type of mail source.
14992 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
14993 use directory source to get mail, you can specify it as in this
14998 '((directory :path "/home/pavel/.Spool/"
15003 Gnus will then fetch your mail even when you are unplugged. This is
15004 useful when you use local mail and news.
15009 @node Mail Source Functions
15010 @subsubsection Function Interface
15012 Some of the above keywords specify a Lisp function to be executed.
15013 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
15014 the value of the keyword while the function is executing. For example,
15015 consider the following mail-source setting:
15018 (setq mail-sources '((pop :user "jrl"
15019 :server "pophost" :function fetchfunc)))
15022 While the function @code{fetchfunc} is executing, the symbol @code{user}
15023 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
15024 @code{"pophost"}. The symbols @code{port}, @code{password},
15025 @code{program}, @code{prescript}, @code{postscript}, @code{function},
15026 and @code{authentication} are also bound (to their default values).
15028 See above for a list of keywords for each type of mail source.
15031 @node Mail Source Customization
15032 @subsubsection Mail Source Customization
15034 The following is a list of variables that influence how the mail is
15035 fetched. You would normally not need to set or change any of these
15039 @item mail-source-crash-box
15040 @vindex mail-source-crash-box
15041 File where mail will be stored while processing it. The default is@*
15042 @file{~/.emacs-mail-crash-box}.
15045 @item mail-source-delete-incoming
15046 @vindex mail-source-delete-incoming
15047 If non-@code{nil}, delete incoming files after handling them. If
15048 @code{t}, delete the files immediately, if @code{nil}, never delete any
15049 files. If a positive number, delete files older than number of days
15050 (the deletion will only happen when receiving new mail). You may also
15051 set @code{mail-source-delete-incoming} to @code{nil} and call
15052 @code{mail-source-delete-old-incoming} from a hook or interactively.
15053 @code{mail-source-delete-incoming} defaults to @code{10} in alpha Gnusae
15054 and @code{2} in released Gnusae. @xref{Gnus Development}.
15056 @item mail-source-delete-old-incoming-confirm
15057 @vindex mail-source-delete-old-incoming-confirm
15058 If non-@code{nil}, ask for confirmation before deleting old incoming
15059 files. This variable only applies when
15060 @code{mail-source-delete-incoming} is a positive number.
15062 @item mail-source-ignore-errors
15063 @vindex mail-source-ignore-errors
15064 If non-@code{nil}, ignore errors when reading mail from a mail source.
15066 @item mail-source-directory
15067 @vindex mail-source-directory
15068 Directory where incoming mail source files (if any) will be stored. The
15069 default is @file{~/Mail/}. At present, the only thing this is used for
15070 is to say where the incoming files will be stored if the variable
15071 @code{mail-source-delete-incoming} is @code{nil} or a number.
15073 @item mail-source-incoming-file-prefix
15074 @vindex mail-source-incoming-file-prefix
15075 Prefix for file name for storing incoming mail. The default is
15076 @file{Incoming}, in which case files will end up with names like
15077 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
15078 relevant if @code{mail-source-delete-incoming} is @code{nil} or a
15081 @item mail-source-default-file-modes
15082 @vindex mail-source-default-file-modes
15083 All new mail files will get this file mode. The default is @code{#o600}.
15085 @item mail-source-movemail-program
15086 @vindex mail-source-movemail-program
15087 If non-@code{nil}, name of program for fetching new mail. If
15088 @code{nil}, @code{movemail} in @var{exec-directory}.
15093 @node Fetching Mail
15094 @subsubsection Fetching Mail
15096 @vindex mail-sources
15097 The way to actually tell Gnus where to get new mail from is to set
15098 @code{mail-sources} to a list of mail source specifiers
15099 (@pxref{Mail Source Specifiers}).
15101 If this variable is @code{nil}, the mail back ends will never attempt to
15102 fetch mail by themselves.
15104 If you want to fetch mail both from your local spool as well as a
15105 @acronym{POP} mail server, you'd say something like:
15110 (pop :server "pop3.mail.server"
15111 :password "secret")))
15114 Or, if you don't want to use any of the keyword defaults:
15118 '((file :path "/var/spool/mail/user-name")
15119 (pop :server "pop3.mail.server"
15122 :password "secret")))
15126 When you use a mail back end, Gnus will slurp all your mail from your
15127 inbox and plonk it down in your home directory. Gnus doesn't move any
15128 mail if you're not using a mail back end---you have to do a lot of magic
15129 invocations first. At the time when you have finished drawing the
15130 pentagram, lightened the candles, and sacrificed the goat, you really
15131 shouldn't be too surprised when Gnus moves your mail.
15135 @node Mail Back End Variables
15136 @subsection Mail Back End Variables
15138 These variables are (for the most part) pertinent to all the various
15142 @vindex nnmail-read-incoming-hook
15143 @item nnmail-read-incoming-hook
15144 The mail back ends all call this hook after reading new mail. You can
15145 use this hook to notify any mail watch programs, if you want to.
15147 @vindex nnmail-split-hook
15148 @item nnmail-split-hook
15149 @findex gnus-article-decode-encoded-words
15150 @cindex RFC 1522 decoding
15151 @cindex RFC 2047 decoding
15152 Hook run in the buffer where the mail headers of each message is kept
15153 just before the splitting based on these headers is done. The hook is
15154 free to modify the buffer contents in any way it sees fit---the buffer
15155 is discarded after the splitting has been done, and no changes performed
15156 in the buffer will show up in any files.
15157 @code{gnus-article-decode-encoded-words} is one likely function to add
15160 @vindex nnmail-pre-get-new-mail-hook
15161 @vindex nnmail-post-get-new-mail-hook
15162 @item nnmail-pre-get-new-mail-hook
15163 @itemx nnmail-post-get-new-mail-hook
15164 These are two useful hooks executed when treating new incoming
15165 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
15166 starting to handle the new mail) and
15167 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
15168 is done). Here's and example of using these two hooks to change the
15169 default file modes the new mail files get:
15172 (add-hook 'nnmail-pre-get-new-mail-hook
15173 (lambda () (set-default-file-modes #o700)))
15175 (add-hook 'nnmail-post-get-new-mail-hook
15176 (lambda () (set-default-file-modes #o775)))
15179 @item nnmail-use-long-file-names
15180 @vindex nnmail-use-long-file-names
15181 If non-@code{nil}, the mail back ends will use long file and directory
15182 names. Groups like @samp{mail.misc} will end up in directories
15183 (assuming use of @code{nnml} back end) or files (assuming use of
15184 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
15185 the same group will end up in @file{mail/misc}.
15187 @item nnmail-delete-file-function
15188 @vindex nnmail-delete-file-function
15189 @findex delete-file
15190 Function called to delete files. It is @code{delete-file} by default.
15192 @item nnmail-cache-accepted-message-ids
15193 @vindex nnmail-cache-accepted-message-ids
15194 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
15195 the back end (via @code{Gcc}, for instance) into the mail duplication
15196 discovery cache. The default is @code{nil}.
15198 @item nnmail-cache-ignore-groups
15199 @vindex nnmail-cache-ignore-groups
15200 This can be a regular expression or a list of regular expressions.
15201 Group names that match any of the regular expressions will never be
15202 recorded in the @code{Message-ID} cache.
15204 This can be useful, for example, when using Fancy Splitting
15205 (@pxref{Fancy Mail Splitting}) together with the function
15206 @code{nnmail-split-fancy-with-parent}.
15211 @node Fancy Mail Splitting
15212 @subsection Fancy Mail Splitting
15213 @cindex mail splitting
15214 @cindex fancy mail splitting
15216 @vindex nnmail-split-fancy
15217 @findex nnmail-split-fancy
15218 If the rather simple, standard method for specifying how to split mail
15219 doesn't allow you to do what you want, you can set
15220 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
15221 play with the @code{nnmail-split-fancy} variable.
15223 Let's look at an example value of this variable first:
15226 ;; @r{Messages from the mailer daemon are not crossposted to any of}
15227 ;; @r{the ordinary groups. Warnings are put in a separate group}
15228 ;; @r{from real errors.}
15229 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
15231 ;; @r{Non-error messages are crossposted to all relevant}
15232 ;; @r{groups, but we don't crosspost between the group for the}
15233 ;; @r{(ding) list and the group for other (ding) related mail.}
15234 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
15235 ("subject" "ding" "ding.misc"))
15236 ;; @r{Other mailing lists@dots{}}
15237 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
15238 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
15239 ;; @r{Both lists below have the same suffix, so prevent}
15240 ;; @r{cross-posting to mkpkg.list of messages posted only to}
15241 ;; @r{the bugs- list, but allow cross-posting when the}
15242 ;; @r{message was really cross-posted.}
15243 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
15244 (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list")
15245 ;; @r{People@dots{}}
15246 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
15247 ;; @r{Unmatched mail goes to the catch all group.}
15251 This variable has the format of a @dfn{split}. A split is a
15252 (possibly) recursive structure where each split may contain other
15253 splits. Here are the possible split syntaxes:
15258 If the split is a string, that will be taken as a group name. Normal
15259 regexp match expansion will be done. See below for examples.
15261 @c Don't fold this line.
15262 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split} [@var{invert-partial}])
15263 The split can be a list containing at least three elements. If the
15264 first element @var{field} (a regexp matching a header) contains
15265 @var{value} (also a regexp) then store the message as specified by
15268 If @var{restrict} (yet another regexp) matches some string after
15269 @var{field} and before the end of the matched @var{value}, the
15270 @var{split} is ignored. If none of the @var{restrict} clauses match,
15271 @var{split} is processed.
15273 The last element @var{invert-partial} is optional. If it is
15274 non-@code{nil}, the match-partial-words behavior controlled by the
15275 variable @code{nnmail-split-fancy-match-partial-words} (see below) is
15276 be inverted. (New in Gnus 5.10.7)
15278 @item (| @var{split} @dots{})
15279 If the split is a list, and the first element is @code{|} (vertical
15280 bar), then process each @var{split} until one of them matches. A
15281 @var{split} is said to match if it will cause the mail message to be
15282 stored in one or more groups.
15284 @item (& @var{split} @dots{})
15285 If the split is a list, and the first element is @code{&}, then
15286 process all @var{split}s in the list.
15289 If the split is the symbol @code{junk}, then don't save (i.e., delete)
15290 this message. Use with extreme caution.
15292 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
15293 If the split is a list, and the first element is @samp{:}, then the
15294 second element will be called as a function with @var{args} given as
15295 arguments. The function should return a @var{split}.
15298 For instance, the following function could be used to split based on the
15299 body of the messages:
15302 (defun split-on-body ()
15306 (goto-char (point-min))
15307 (when (re-search-forward "Some.*string" nil t)
15311 The buffer is narrowed to the header of the message in question when
15312 @var{function} is run. That's why @code{(widen)} needs to be called
15313 after @code{save-excursion} and @code{save-restriction} in the example
15314 above. Also note that with the nnimap backend, message bodies will
15315 not be downloaded by default. You need to set
15316 @code{nnimap-split-download-body} to @code{t} to do that
15317 (@pxref{Client-Side IMAP Splitting}).
15319 @item (! @var{func} @var{split})
15320 If the split is a list, and the first element is @code{!}, then
15321 @var{split} will be processed, and @var{func} will be called as a
15322 function with the result of @var{split} as argument. @var{func}
15323 should return a split.
15326 If the split is @code{nil}, it is ignored.
15330 In these splits, @var{field} must match a complete field name.
15332 Normally, @var{value} in these splits must match a complete @emph{word}
15333 according to the fundamental mode syntax table. In other words, all
15334 @var{value}'s will be implicitly surrounded by @code{\<...\>} markers,
15335 which are word delimiters. Therefore, if you use the following split,
15339 (any "joe" "joemail")
15343 messages sent from @samp{joedavis@@foo.org} will normally not be filed
15344 in @samp{joemail}. If you want to alter this behavior, you can use any
15345 of the following three ways:
15349 @vindex nnmail-split-fancy-match-partial-words
15350 You can set the @code{nnmail-split-fancy-match-partial-words} variable
15351 to non-@code{nil} in order to ignore word boundaries and instead the
15352 match becomes more like a grep. This variable controls whether partial
15353 words are matched during fancy splitting. The default value is
15356 Note that it influences all @var{value}'s in your split rules.
15359 @var{value} beginning with @code{.*} ignores word boundaries in front of
15360 a word. Similarly, if @var{value} ends with @code{.*}, word boundaries
15361 in the rear of a word will be ignored. For example, the @var{value}
15362 @code{"@@example\\.com"} does not match @samp{foo@@example.com} but
15363 @code{".*@@example\\.com"} does.
15366 You can set the @var{invert-partial} flag in your split rules of the
15367 @samp{(@var{field} @var{value} @dots{})} types, aforementioned in this
15368 section. If the flag is set, word boundaries on both sides of a word
15369 are ignored even if @code{nnmail-split-fancy-match-partial-words} is
15370 @code{nil}. Contrarily, if the flag is set, word boundaries are not
15371 ignored even if @code{nnmail-split-fancy-match-partial-words} is
15372 non-@code{nil}. (New in Gnus 5.10.7)
15375 @vindex nnmail-split-abbrev-alist
15376 @var{field} and @var{value} can also be Lisp symbols, in that case
15377 they are expanded as specified by the variable
15378 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
15379 where the @sc{car} of a cell contains the key, and the @sc{cdr}
15380 contains the associated value. Predefined entries in
15381 @code{nnmail-split-abbrev-alist} include:
15385 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
15387 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
15388 @samp{Resent-To} and @samp{Resent-Cc} fields.
15390 Is the union of the @code{from} and @code{to} entries.
15393 @vindex nnmail-split-fancy-syntax-table
15394 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
15395 when all this splitting is performed.
15397 If you want to have Gnus create groups dynamically based on some
15398 information in the headers (i.e., do @code{replace-match}-like
15399 substitutions in the group names), you can say things like:
15402 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
15405 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
15406 will be filed in @samp{mail.debian.foo}.
15408 If the string contains the element @samp{\\&}, then the previously
15409 matched string will be substituted. Similarly, the elements @samp{\\1}
15410 up to @samp{\\9} will be substituted with the text matched by the
15411 groupings 1 through 9.
15413 @vindex nnmail-split-lowercase-expanded
15414 Where @code{nnmail-split-lowercase-expanded} controls whether the
15415 lowercase of the matched string should be used for the substitution.
15416 Setting it as non-@code{nil} is useful to avoid the creation of multiple
15417 groups when users send to an address using different case
15418 (i.e., mailing-list@@domain vs Mailing-List@@Domain). The default value
15421 @findex nnmail-split-fancy-with-parent
15422 @code{nnmail-split-fancy-with-parent} is a function which allows you to
15423 split followups into the same groups their parents are in. Sometimes
15424 you can't make splitting rules for all your mail. For example, your
15425 boss might send you personal mail regarding different projects you are
15426 working on, and as you can't tell your boss to put a distinguishing
15427 string into the subject line, you have to resort to manually moving the
15428 messages into the right group. With this function, you only have to do
15429 it once per thread.
15431 To use this feature, you have to set @code{nnmail-treat-duplicates}
15432 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
15433 value. And then you can include @code{nnmail-split-fancy-with-parent}
15434 using the colon feature, like so:
15436 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
15437 nnmail-cache-accepted-message-ids t
15439 '(| (: nnmail-split-fancy-with-parent)
15440 ;; @r{other splits go here}
15444 This feature works as follows: when @code{nnmail-treat-duplicates} is
15445 non-@code{nil}, Gnus records the message id of every message it sees
15446 in the file specified by the variable
15447 @code{nnmail-message-id-cache-file}, together with the group it is in
15448 (the group is omitted for non-mail messages). When mail splitting is
15449 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
15450 at the References (and In-Reply-To) header of each message to split
15451 and searches the file specified by @code{nnmail-message-id-cache-file}
15452 for the message ids. When it has found a parent, it returns the
15453 corresponding group name unless the group name matches the regexp
15454 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
15455 recommended that you set @code{nnmail-message-id-cache-length} to a
15456 somewhat higher number than the default so that the message ids are
15457 still in the cache. (A value of 5000 appears to create a file some
15458 300 kBytes in size.)
15459 @vindex nnmail-cache-accepted-message-ids
15460 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
15461 also records the message ids of moved articles, so that the followup
15462 messages goes into the new group.
15464 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
15465 want certain groups to be recorded in the cache. For example, if all
15466 outgoing messages are written to an ``outgoing'' group, you could set
15467 @code{nnmail-cache-ignore-groups} to match that group name.
15468 Otherwise, answers to all your messages would end up in the
15469 ``outgoing'' group.
15472 @node Group Mail Splitting
15473 @subsection Group Mail Splitting
15474 @cindex mail splitting
15475 @cindex group mail splitting
15477 @findex gnus-group-split
15478 If you subscribe to dozens of mailing lists but you don't want to
15479 maintain mail splitting rules manually, group mail splitting is for you.
15480 You just have to set @code{to-list} and/or @code{to-address} in group
15481 parameters or group customization and set @code{nnmail-split-methods} to
15482 @code{gnus-group-split}. This splitting function will scan all groups
15483 for those parameters and split mail accordingly, i.e., messages posted
15484 from or to the addresses specified in the parameters @code{to-list} or
15485 @code{to-address} of a mail group will be stored in that group.
15487 Sometimes, mailing lists have multiple addresses, and you may want mail
15488 splitting to recognize them all: just set the @code{extra-aliases} group
15489 parameter to the list of additional addresses and it's done. If you'd
15490 rather use a regular expression, set @code{split-regexp}.
15492 All these parameters in a group will be used to create an
15493 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
15494 the @var{value} is a single regular expression that matches
15495 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
15496 matches of @code{split-regexp}, and the @var{split} is the name of the
15497 group. @var{restrict}s are also supported: just set the
15498 @code{split-exclude} parameter to a list of regular expressions.
15500 If you can't get the right split to be generated using all these
15501 parameters, or you just need something fancier, you can set the
15502 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
15503 this case, all other aforementioned parameters will be ignored by
15504 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
15505 @code{nil}, in which case the group will be ignored by
15506 @code{gnus-group-split}.
15508 @vindex gnus-group-split-default-catch-all-group
15509 @code{gnus-group-split} will do cross-posting on all groups that match,
15510 by defining a single @code{&} fancy split containing one split for each
15511 group. If a message doesn't match any split, it will be stored in the
15512 group named in @code{gnus-group-split-default-catch-all-group}, unless
15513 some group has @code{split-spec} set to @code{catch-all}, in which case
15514 that group is used as the catch-all group. Even though this variable is
15515 often used just to name a group, it may also be set to an arbitrarily
15516 complex fancy split (after all, a group name is a fancy split), and this
15517 may be useful to split mail that doesn't go to any mailing list to
15518 personal mail folders. Note that this fancy split is added as the last
15519 element of a @code{|} split list that also contains a @code{&} split
15520 with the rules extracted from group parameters.
15522 It's time for an example. Assume the following group parameters have
15527 ((to-address . "bar@@femail.com")
15528 (split-regexp . ".*@@femail\\.com"))
15530 ((to-list . "foo@@nowhere.gov")
15531 (extra-aliases "foo@@localhost" "foo-redist@@home")
15532 (split-exclude "bugs-foo" "rambling-foo")
15533 (admin-address . "foo-request@@nowhere.gov"))
15535 ((split-spec . catch-all))
15538 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
15539 behave as if @code{nnmail-split-fancy} had been selected and variable
15540 @code{nnmail-split-fancy} had been set as follows:
15543 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
15544 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
15545 - "bugs-foo" - "rambling-foo" "mail.foo"))
15549 @findex gnus-group-split-fancy
15550 If you'd rather not use group splitting for all your mail groups, you
15551 may use it for only some of them, by using @code{nnmail-split-fancy}
15555 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
15558 @var{groups} may be a regular expression or a list of group names whose
15559 parameters will be scanned to generate the output split.
15560 @var{no-crosspost} can be used to disable cross-posting; in this case, a
15561 single @code{|} split will be output. @var{catch-all} is the fall back
15562 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
15563 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
15564 empty string in any selected group, no catch-all split will be issued.
15565 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
15566 this group will override the value of the @var{catch-all} argument.
15568 @findex gnus-group-split-setup
15569 Unfortunately, scanning all groups and their parameters can be quite
15570 slow, especially considering that it has to be done for every message.
15571 But don't despair! The function @code{gnus-group-split-setup} can be
15572 used to enable @code{gnus-group-split} in a much more efficient way. It
15573 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
15574 @code{nnmail-split-fancy} to the split produced by
15575 @code{gnus-group-split-fancy}. Thus, the group parameters are only
15576 scanned once, no matter how many messages are split.
15578 @findex gnus-group-split-update
15579 However, if you change group parameters, you'd have to update
15580 @code{nnmail-split-fancy} manually. You can do it by running
15581 @code{gnus-group-split-update}. If you'd rather have it updated
15582 automatically, just tell @code{gnus-group-split-setup} to do it for
15583 you. For example, add to your @file{~/.gnus.el}:
15586 (gnus-group-split-setup @var{auto-update} @var{catch-all})
15589 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
15590 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
15591 have to worry about updating @code{nnmail-split-fancy} again. If you
15592 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
15593 @code{gnus-group-split-default-catch-all-group} will be set to its
15596 @vindex gnus-group-split-updated-hook
15597 Because you may want to change @code{nnmail-split-fancy} after it is set
15598 by @code{gnus-group-split-update}, this function will run
15599 @code{gnus-group-split-updated-hook} just before finishing.
15601 @node Incorporating Old Mail
15602 @subsection Incorporating Old Mail
15603 @cindex incorporating old mail
15604 @cindex import old mail
15606 Most people have lots of old mail stored in various file formats. If
15607 you have set up Gnus to read mail using one of the spiffy Gnus mail
15608 back ends, you'll probably wish to have that old mail incorporated into
15611 Doing so can be quite easy.
15613 To take an example: You're reading mail using @code{nnml}
15614 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
15615 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
15616 file filled with important, but old, mail. You want to move it into
15617 your @code{nnml} groups.
15623 Go to the group buffer.
15626 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
15627 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
15630 Type @kbd{SPACE} to enter the newly created group.
15633 Type @kbd{M P b} to process-mark all articles in this group's buffer
15634 (@pxref{Setting Process Marks}).
15637 Type @kbd{B r} to respool all the process-marked articles, and answer
15638 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
15641 All the mail messages in the mbox file will now also be spread out over
15642 all your @code{nnml} groups. Try entering them and check whether things
15643 have gone without a glitch. If things look ok, you may consider
15644 deleting the mbox file, but I wouldn't do that unless I was absolutely
15645 sure that all the mail has ended up where it should be.
15647 Respooling is also a handy thing to do if you're switching from one mail
15648 back end to another. Just respool all the mail in the old mail groups
15649 using the new mail back end.
15652 @node Expiring Mail
15653 @subsection Expiring Mail
15654 @cindex article expiry
15655 @cindex expiring mail
15657 Traditional mail readers have a tendency to remove mail articles when
15658 you mark them as read, in some way. Gnus takes a fundamentally
15659 different approach to mail reading.
15661 Gnus basically considers mail just to be news that has been received in
15662 a rather peculiar manner. It does not think that it has the power to
15663 actually change the mail, or delete any mail messages. If you enter a
15664 mail group, and mark articles as ``read'', or kill them in some other
15665 fashion, the mail articles will still exist on the system. I repeat:
15666 Gnus will not delete your old, read mail. Unless you ask it to, of
15669 To make Gnus get rid of your unwanted mail, you have to mark the
15670 articles as @dfn{expirable}. (With the default key bindings, this means
15671 that you have to type @kbd{E}.) This does not mean that the articles
15672 will disappear right away, however. In general, a mail article will be
15673 deleted from your system if, 1) it is marked as expirable, AND 2) it is
15674 more than one week old. If you do not mark an article as expirable, it
15675 will remain on your system until hell freezes over. This bears
15676 repeating one more time, with some spurious capitalizations: IF you do
15677 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
15679 @vindex gnus-auto-expirable-marks
15680 You do not have to mark articles as expirable by hand. Gnus provides
15681 two features, called ``auto-expire'' and ``total-expire'', that can help you
15682 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
15683 for you when you select an article. And ``total-expire'' means that Gnus
15684 considers all articles as expirable that are read. So, in addition to
15685 the articles marked @samp{E}, also the articles marked @samp{r},
15686 @samp{R}, @samp{O}, @samp{K}, @samp{Y} (and so on) are considered
15687 expirable. @code{gnus-auto-expirable-marks} has the full list of
15690 When should either auto-expire or total-expire be used? Most people
15691 who are subscribed to mailing lists split each list into its own group
15692 and then turn on auto-expire or total-expire for those groups.
15693 (@xref{Splitting Mail}, for more information on splitting each list
15694 into its own group.)
15696 Which one is better, auto-expire or total-expire? It's not easy to
15697 answer. Generally speaking, auto-expire is probably faster. Another
15698 advantage of auto-expire is that you get more marks to work with: for
15699 the articles that are supposed to stick around, you can still choose
15700 between tick and dormant and read marks. But with total-expire, you
15701 only have dormant and ticked to choose from. The advantage of
15702 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
15703 Scoring}). Auto-expire works with normal scoring but not with adaptive
15706 @vindex gnus-auto-expirable-newsgroups
15707 Groups that match the regular expression
15708 @code{gnus-auto-expirable-newsgroups} will have all articles that you
15709 read marked as expirable automatically. All articles marked as
15710 expirable have an @samp{E} in the first column in the summary buffer.
15712 By default, if you have auto expiry switched on, Gnus will mark all the
15713 articles you read as expirable, no matter if they were read or unread
15714 before. To avoid having articles marked as read marked as expirable
15715 automatically, you can put something like the following in your
15716 @file{~/.gnus.el} file:
15718 @vindex gnus-mark-article-hook
15720 (remove-hook 'gnus-mark-article-hook
15721 'gnus-summary-mark-read-and-unread-as-read)
15722 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
15725 Note that making a group auto-expirable doesn't mean that all read
15726 articles are expired---only the articles marked as expirable
15727 will be expired. Also note that using the @kbd{d} command won't make
15728 articles expirable---only semi-automatic marking of articles as read will
15729 mark the articles as expirable in auto-expirable groups.
15731 Let's say you subscribe to a couple of mailing lists, and you want the
15732 articles you have read to disappear after a while:
15735 (setq gnus-auto-expirable-newsgroups
15736 "mail.nonsense-list\\|mail.nice-list")
15739 Another way to have auto-expiry happen is to have the element
15740 @code{auto-expire} in the group parameters of the group.
15742 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
15743 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
15744 don't really mix very well.
15746 @vindex nnmail-expiry-wait
15747 The @code{nnmail-expiry-wait} variable supplies the default time an
15748 expirable article has to live. Gnus starts counting days from when the
15749 message @emph{arrived}, not from when it was sent. The default is seven
15752 Gnus also supplies a function that lets you fine-tune how long articles
15753 are to live, based on what group they are in. Let's say you want to
15754 have one month expiry period in the @samp{mail.private} group, a one day
15755 expiry period in the @samp{mail.junk} group, and a six day expiry period
15758 @vindex nnmail-expiry-wait-function
15760 (setq nnmail-expiry-wait-function
15762 (cond ((string= group "mail.private")
15764 ((string= group "mail.junk")
15766 ((string= group "important")
15772 The group names this function is fed are ``unadorned'' group
15773 names---no @samp{nnml:} prefixes and the like.
15775 The @code{nnmail-expiry-wait} variable and
15776 @code{nnmail-expiry-wait-function} function can either be a number (not
15777 necessarily an integer) or one of the symbols @code{immediate} or
15780 You can also use the @code{expiry-wait} group parameter to selectively
15781 change the expiry period (@pxref{Group Parameters}).
15783 @vindex nnmail-expiry-target
15784 The normal action taken when expiring articles is to delete them.
15785 However, in some circumstances it might make more sense to move them
15786 to other groups instead of deleting them. The variable
15787 @code{nnmail-expiry-target} (and the @code{expiry-target} group
15788 parameter) controls this. The variable supplies a default value for
15789 all groups, which can be overridden for specific groups by the group
15790 parameter. default value is @code{delete}, but this can also be a
15791 string (which should be the name of the group the message should be
15792 moved to), or a function (which will be called in a buffer narrowed to
15793 the message in question, and with the name of the group being moved
15794 from as its parameter) which should return a target---either a group
15795 name or @code{delete}.
15797 Here's an example for specifying a group name:
15799 (setq nnmail-expiry-target "nnml:expired")
15802 @findex nnmail-fancy-expiry-target
15803 @vindex nnmail-fancy-expiry-targets
15804 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
15805 expire mail to groups according to the variable
15806 @code{nnmail-fancy-expiry-targets}. Here's an example:
15809 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
15810 nnmail-fancy-expiry-targets
15811 '((to-from "boss" "nnfolder:Work")
15812 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
15813 ("from" ".*" "nnfolder:Archive-%Y")))
15816 With this setup, any mail that has @code{IMPORTANT} in its Subject
15817 header and was sent in the year @code{YYYY} and month @code{MMM}, will
15818 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
15819 From or To header contains the string @code{boss}, it will get expired
15820 to @code{nnfolder:Work}. All other mail will get expired to
15821 @code{nnfolder:Archive-YYYY}.
15823 @vindex nnmail-keep-last-article
15824 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
15825 expire the final article in a mail newsgroup. This is to make life
15826 easier for procmail users.
15828 @vindex gnus-total-expirable-newsgroups
15829 By the way: That line up there, about Gnus never expiring non-expirable
15830 articles, is a lie. If you put @code{total-expire} in the group
15831 parameters, articles will not be marked as expirable, but all read
15832 articles will be put through the expiry process. Use with extreme
15833 caution. Even more dangerous is the
15834 @code{gnus-total-expirable-newsgroups} variable. All groups that match
15835 this regexp will have all read articles put through the expiry process,
15836 which means that @emph{all} old mail articles in the groups in question
15837 will be deleted after a while. Use with extreme caution, and don't come
15838 crying to me when you discover that the regexp you used matched the
15839 wrong group and all your important mail has disappeared. Be a
15840 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
15843 Most people make most of their mail groups total-expirable, though.
15845 @vindex gnus-inhibit-user-auto-expire
15846 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
15847 commands will not mark an article as expirable, even if the group has
15848 auto-expire turned on.
15850 @vindex gnus-mark-copied-or-moved-articles-as-expirable
15851 The expirable marks of articles will be removed when copying or moving
15852 them to a group in which auto-expire is not turned on. This is for
15853 preventing articles from being expired unintentionally. On the other
15854 hand, to a group that has turned auto-expire on, the expirable marks of
15855 articles that are copied or moved will not be changed by default. I.e.,
15856 when copying or moving to such a group, articles that were expirable
15857 will be left expirable and ones that were not expirable will not be
15858 marked as expirable. So, even though in auto-expire groups, some
15859 articles will never get expired (unless you read them again). If you
15860 don't side with that behavior that unexpirable articles may be mixed
15861 into auto-expire groups, you can set
15862 @code{gnus-mark-copied-or-moved-articles-as-expirable} to a
15863 non-@code{nil} value. In that case, articles that have been read will
15864 be marked as expirable automatically when being copied or moved to a
15865 group that has auto-expire turned on. The default value is @code{nil}.
15869 @subsection Washing Mail
15870 @cindex mail washing
15871 @cindex list server brain damage
15872 @cindex incoming mail treatment
15874 Mailers and list servers are notorious for doing all sorts of really,
15875 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
15876 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
15877 end of all lines passing through our server, so let's do that!!!!1!''
15878 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
15879 considered to be self-evident were not discussed. So. Here we are.
15881 Case in point: The German version of Microsoft Exchange adds @samp{AW:
15882 } to the subjects of replies instead of @samp{Re: }. I could pretend to
15883 be shocked and dismayed by this, but I haven't got the energy. It is to
15886 Gnus provides a plethora of functions for washing articles while
15887 displaying them, but it might be nicer to do the filtering before
15888 storing the mail to disk. For that purpose, we have three hooks and
15889 various functions that can be put in these hooks.
15892 @item nnmail-prepare-incoming-hook
15893 @vindex nnmail-prepare-incoming-hook
15894 This hook is called before doing anything with the mail and is meant for
15895 grand, sweeping gestures. It is called in a buffer that contains all
15896 the new, incoming mail. Functions to be used include:
15899 @item nnheader-ms-strip-cr
15900 @findex nnheader-ms-strip-cr
15901 Remove trailing carriage returns from each line. This is default on
15902 Emacs running on MS machines.
15906 @item nnmail-prepare-incoming-header-hook
15907 @vindex nnmail-prepare-incoming-header-hook
15908 This hook is called narrowed to each header. It can be used when
15909 cleaning up the headers. Functions that can be used include:
15912 @item nnmail-remove-leading-whitespace
15913 @findex nnmail-remove-leading-whitespace
15914 Clear leading white space that ``helpful'' listservs have added to the
15915 headers to make them look nice. Aaah.
15917 (Note that this function works on both the header on the body of all
15918 messages, so it is a potentially dangerous function to use (if a body
15919 of a message contains something that looks like a header line). So
15920 rather than fix the bug, it is of course the right solution to make it
15921 into a feature by documenting it.)
15923 @item nnmail-remove-list-identifiers
15924 @findex nnmail-remove-list-identifiers
15925 Some list servers add an identifier---for example, @samp{(idm)}---to the
15926 beginning of all @code{Subject} headers. I'm sure that's nice for
15927 people who use stone age mail readers. This function will remove
15928 strings that match the @code{nnmail-list-identifiers} regexp, which can
15929 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
15932 For instance, if you want to remove the @samp{(idm)} and the
15933 @samp{nagnagnag} identifiers:
15936 (setq nnmail-list-identifiers
15937 '("(idm)" "nagnagnag"))
15940 This can also be done non-destructively with
15941 @code{gnus-list-identifiers}, @xref{Article Hiding}.
15943 @item nnmail-remove-tabs
15944 @findex nnmail-remove-tabs
15945 Translate all @samp{TAB} characters into @samp{SPACE} characters.
15947 @item nnmail-ignore-broken-references
15948 @findex nnmail-ignore-broken-references
15949 @c @findex nnmail-fix-eudora-headers
15952 Some mail user agents (e.g., Eudora and Pegasus) produce broken
15953 @code{References} headers, but correct @code{In-Reply-To} headers. This
15954 function will get rid of the @code{References} header if the headers
15955 contain a line matching the regular expression
15956 @code{nnmail-broken-references-mailers}.
15960 @item nnmail-prepare-incoming-message-hook
15961 @vindex nnmail-prepare-incoming-message-hook
15962 This hook is called narrowed to each message. Functions to be used
15966 @item article-de-quoted-unreadable
15967 @findex article-de-quoted-unreadable
15968 Decode Quoted Readable encoding.
15975 @subsection Duplicates
15977 @vindex nnmail-treat-duplicates
15978 @vindex nnmail-message-id-cache-length
15979 @vindex nnmail-message-id-cache-file
15980 @cindex duplicate mails
15981 If you are a member of a couple of mailing lists, you will sometimes
15982 receive two copies of the same mail. This can be quite annoying, so
15983 @code{nnmail} checks for and treats any duplicates it might find. To do
15984 this, it keeps a cache of old @code{Message-ID}s:
15985 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
15986 default. The approximate maximum number of @code{Message-ID}s stored
15987 there is controlled by the @code{nnmail-message-id-cache-length}
15988 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
15989 stored.) If all this sounds scary to you, you can set
15990 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
15991 default), and @code{nnmail} won't delete duplicate mails. Instead it
15992 will insert a warning into the head of the mail saying that it thinks
15993 that this is a duplicate of a different message.
15995 This variable can also be a function. If that's the case, the function
15996 will be called from a buffer narrowed to the message in question with
15997 the @code{Message-ID} as a parameter. The function must return either
15998 @code{nil}, @code{warn}, or @code{delete}.
16000 You can turn this feature off completely by setting the variable to
16003 If you want all the duplicate mails to be put into a special
16004 @dfn{duplicates} group, you could do that using the normal mail split
16008 (setq nnmail-split-fancy
16009 '(| ;; @r{Messages duplicates go to a separate group.}
16010 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
16011 ;; @r{Message from daemons, postmaster, and the like to another.}
16012 (any mail "mail.misc")
16013 ;; @r{Other rules.}
16019 (setq nnmail-split-methods
16020 '(("duplicates" "^Gnus-Warning:.*duplicate")
16021 ;; @r{Other rules.}
16025 Here's a neat feature: If you know that the recipient reads her mail
16026 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
16027 @code{delete}, you can send her as many insults as you like, just by
16028 using a @code{Message-ID} of a mail that you know that she's already
16029 received. Think of all the fun! She'll never see any of it! Whee!
16032 @node Not Reading Mail
16033 @subsection Not Reading Mail
16035 If you start using any of the mail back ends, they have the annoying
16036 habit of assuming that you want to read mail with them. This might not
16037 be unreasonable, but it might not be what you want.
16039 If you set @code{mail-sources} and @code{nnmail-spool-file} to
16040 @code{nil}, none of the back ends will ever attempt to read incoming
16041 mail, which should help.
16043 @vindex nnbabyl-get-new-mail
16044 @vindex nnmbox-get-new-mail
16045 @vindex nnml-get-new-mail
16046 @vindex nnmh-get-new-mail
16047 @vindex nnfolder-get-new-mail
16048 This might be too much, if, for instance, you are reading mail quite
16049 happily with @code{nnml} and just want to peek at some old (pre-Emacs
16050 23) Rmail file you have stashed away with @code{nnbabyl}. All back ends have
16051 variables called back-end-@code{get-new-mail}. If you want to disable
16052 the @code{nnbabyl} mail reading, you edit the virtual server for the
16053 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
16055 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
16056 narrowed to the article to be saved before saving it when reading
16060 @node Choosing a Mail Back End
16061 @subsection Choosing a Mail Back End
16063 Gnus will read the mail spool when you activate a mail group. The mail
16064 file is first copied to your home directory. What happens after that
16065 depends on what format you want to store your mail in.
16067 There are six different mail back ends in the standard Gnus, and more
16068 back ends are available separately. The mail back end most people use
16069 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
16073 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
16074 * Babyl:: Babyl was used by older versions of Rmail.
16075 * Mail Spool:: Store your mail in a private spool?
16076 * MH Spool:: An mhspool-like back end.
16077 * Maildir:: Another one-file-per-message format.
16078 * nnmaildir Group Parameters::
16079 * Article Identification::
16082 * Mail Folders:: Having one file for each group.
16083 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
16088 @node Unix Mail Box
16089 @subsubsection Unix Mail Box
16091 @cindex unix mail box
16093 @vindex nnmbox-active-file
16094 @vindex nnmbox-mbox-file
16095 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
16096 mail. @code{nnmbox} will add extra headers to each mail article to say
16097 which group it belongs in.
16099 Virtual server settings:
16102 @item nnmbox-mbox-file
16103 @vindex nnmbox-mbox-file
16104 The name of the mail box in the user's home directory. Default is
16107 @item nnmbox-active-file
16108 @vindex nnmbox-active-file
16109 The name of the active file for the mail box. Default is
16110 @file{~/.mbox-active}.
16112 @item nnmbox-get-new-mail
16113 @vindex nnmbox-get-new-mail
16114 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
16115 into groups. Default is @code{t}.
16120 @subsubsection Babyl
16123 @vindex nnbabyl-active-file
16124 @vindex nnbabyl-mbox-file
16125 The @dfn{nnbabyl} back end will use a Babyl mail box to store mail.
16126 @code{nnbabyl} will add extra headers to each mail article to say which
16127 group it belongs in.
16129 Virtual server settings:
16132 @item nnbabyl-mbox-file
16133 @vindex nnbabyl-mbox-file
16134 The name of the Babyl file. The default is @file{~/RMAIL}
16136 @item nnbabyl-active-file
16137 @vindex nnbabyl-active-file
16138 The name of the active file for the Babyl file. The default is
16139 @file{~/.rmail-active}
16141 @item nnbabyl-get-new-mail
16142 @vindex nnbabyl-get-new-mail
16143 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
16149 @subsubsection Mail Spool
16151 @cindex mail @acronym{NOV} spool
16153 The @dfn{nnml} spool mail format isn't compatible with any other known
16154 format. It should be used with some caution.
16156 @vindex nnml-directory
16157 If you use this back end, Gnus will split all incoming mail into files,
16158 one file for each mail, and put the articles into the corresponding
16159 directories under the directory specified by the @code{nnml-directory}
16160 variable. The default value is @file{~/Mail/}.
16162 You do not have to create any directories beforehand; Gnus will take
16165 If you have a strict limit as to how many files you are allowed to store
16166 in your account, you should not use this back end. As each mail gets its
16167 own file, you might very well occupy thousands of inodes within a few
16168 weeks. If this is no problem for you, and it isn't a problem for you
16169 having your friendly systems administrator walking around, madly,
16170 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
16171 know that this is probably the fastest format to use. You do not have
16172 to trudge through a big mbox file just to read your new mail.
16174 @code{nnml} is probably the slowest back end when it comes to article
16175 splitting. It has to create lots of files, and it also generates
16176 @acronym{NOV} databases for the incoming mails. This makes it possibly the
16177 fastest back end when it comes to reading mail.
16179 Virtual server settings:
16182 @item nnml-directory
16183 @vindex nnml-directory
16184 All @code{nnml} directories will be placed under this directory. The
16185 default is the value of @code{message-directory} (whose default value
16188 @item nnml-active-file
16189 @vindex nnml-active-file
16190 The active file for the @code{nnml} server. The default is
16191 @file{~/Mail/active}.
16193 @item nnml-newsgroups-file
16194 @vindex nnml-newsgroups-file
16195 The @code{nnml} group descriptions file. @xref{Newsgroups File
16196 Format}. The default is @file{~/Mail/newsgroups}.
16198 @item nnml-get-new-mail
16199 @vindex nnml-get-new-mail
16200 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
16203 @item nnml-nov-is-evil
16204 @vindex nnml-nov-is-evil
16205 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
16206 default is @code{nil}.
16208 @item nnml-nov-file-name
16209 @vindex nnml-nov-file-name
16210 The name of the @acronym{NOV} files. The default is @file{.overview}.
16212 @item nnml-prepare-save-mail-hook
16213 @vindex nnml-prepare-save-mail-hook
16214 Hook run narrowed to an article before saving.
16216 @item nnml-use-compressed-files
16217 @vindex nnml-use-compressed-files
16218 If non-@code{nil}, @code{nnml} will allow using compressed message
16219 files. This requires @code{auto-compression-mode} to be enabled
16220 (@pxref{Compressed Files, ,Compressed Files, emacs, The Emacs Manual}).
16221 If the value of @code{nnml-use-compressed-files} is a string, it is used
16222 as the file extension specifying the compression program. You can set it
16223 to @samp{.bz2} if your Emacs supports it. A value of @code{t} is
16224 equivalent to @samp{.gz}.
16226 @item nnml-compressed-files-size-threshold
16227 @vindex nnml-compressed-files-size-threshold
16228 Default size threshold for compressed message files. Message files with
16229 bodies larger than that many characters will be automatically compressed
16230 if @code{nnml-use-compressed-files} is non-@code{nil}.
16234 @findex nnml-generate-nov-databases
16235 If your @code{nnml} groups and @acronym{NOV} files get totally out of
16236 whack, you can do a complete update by typing @kbd{M-x
16237 nnml-generate-nov-databases}. This command will trawl through the
16238 entire @code{nnml} hierarchy, looking at each and every article, so it
16239 might take a while to complete. A better interface to this
16240 functionality can be found in the server buffer (@pxref{Server
16245 @subsubsection MH Spool
16247 @cindex mh-e mail spool
16249 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
16250 @acronym{NOV} databases and it doesn't keep an active file or marks
16251 file. This makes @code{nnmh} a @emph{much} slower back end than
16252 @code{nnml}, but it also makes it easier to write procmail scripts
16255 Virtual server settings:
16258 @item nnmh-directory
16259 @vindex nnmh-directory
16260 All @code{nnmh} directories will be located under this directory. The
16261 default is the value of @code{message-directory} (whose default is
16264 @item nnmh-get-new-mail
16265 @vindex nnmh-get-new-mail
16266 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
16270 @vindex nnmh-be-safe
16271 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
16272 sure that the articles in the folder are actually what Gnus thinks
16273 they are. It will check date stamps and stat everything in sight, so
16274 setting this to @code{t} will mean a serious slow-down. If you never
16275 use anything but Gnus to read the @code{nnmh} articles, you do not
16276 have to set this variable to @code{t}. The default is @code{nil}.
16281 @subsubsection Maildir
16285 @code{nnmaildir} stores mail in the maildir format, with each maildir
16286 corresponding to a group in Gnus. This format is documented here:
16287 @uref{http://cr.yp.to/proto/maildir.html} and here:
16288 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
16289 also stores extra information in the @file{.nnmaildir/} directory
16292 Maildir format was designed to allow concurrent deliveries and
16293 reading, without needing locks. With other back ends, you would have
16294 your mail delivered to a spool of some kind, and then you would
16295 configure Gnus to split mail from that spool into your groups. You
16296 can still do that with @code{nnmaildir}, but the more common
16297 configuration is to have your mail delivered directly to the maildirs
16298 that appear as group in Gnus.
16300 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
16301 never corrupt its data in memory, and @code{SIGKILL} will never
16302 corrupt its data in the filesystem.
16304 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
16305 maildir. So you can copy a whole maildir from one Gnus setup to
16306 another, and you will keep your marks.
16308 Virtual server settings:
16312 For each of your @code{nnmaildir} servers (it's very unlikely that
16313 you'd need more than one), you need to create a directory and populate
16314 it with maildirs or symlinks to maildirs (and nothing else; do not
16315 choose a directory already used for other purposes). Each maildir
16316 will be represented in Gnus as a newsgroup on that server; the
16317 filename of the symlink will be the name of the group. Any filenames
16318 in the directory starting with @samp{.} are ignored. The directory is
16319 scanned when you first start Gnus, and each time you type @kbd{g} in
16320 the group buffer; if any maildirs have been removed or added,
16321 @code{nnmaildir} notices at these times.
16323 The value of the @code{directory} parameter should be a Lisp form
16324 which is processed by @code{eval} and @code{expand-file-name} to get
16325 the path of the directory for this server. The form is @code{eval}ed
16326 only when the server is opened; the resulting string is used until the
16327 server is closed. (If you don't know about forms and @code{eval},
16328 don't worry---a simple string will work.) This parameter is not
16329 optional; you must specify it. I don't recommend using
16330 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
16331 use that directory by default for various things, and may get confused
16332 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
16335 @item target-prefix
16336 This should be a Lisp form which is processed by @code{eval} and
16337 @code{expand-file-name}. The form is @code{eval}ed only when the
16338 server is opened; the resulting string is used until the server is
16341 When you create a group on an @code{nnmaildir} server, the maildir is
16342 created with @code{target-prefix} prepended to its name, and a symlink
16343 pointing to that maildir is created, named with the plain group name.
16344 So if @code{directory} is @code{"~/.nnmaildir"} and
16345 @code{target-prefix} is @code{"../maildirs/"}, then when you create
16346 the group @code{foo}, @code{nnmaildir} will create
16347 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
16348 @file{~/.nnmaildir/foo} as a symlink pointing to
16349 @file{../maildirs/foo}.
16351 You can set @code{target-prefix} to a string without any slashes to
16352 create both maildirs and symlinks in the same @code{directory}; in
16353 this case, any maildirs found in @code{directory} whose names start
16354 with @code{target-prefix} will not be listed as groups (but the
16355 symlinks pointing to them will be).
16357 As a special case, if @code{target-prefix} is @code{""} (the default),
16358 then when you create a group, the maildir will be created in
16359 @code{directory} without a corresponding symlink. Beware that you
16360 cannot use @code{gnus-group-delete-group} on such groups without the
16361 @code{force} argument.
16363 @item directory-files
16364 This should be a function with the same interface as
16365 @code{directory-files} (such as @code{directory-files} itself). It is
16366 used to scan the server's @code{directory} for maildirs. This
16367 parameter is optional; the default is
16368 @code{nnheader-directory-files-safe} if
16369 @code{nnheader-directory-files-is-safe} is @code{nil}, and
16370 @code{directory-files} otherwise.
16371 (@code{nnheader-directory-files-is-safe} is checked only once when the
16372 server is opened; if you want to check it each time the directory is
16373 scanned, you'll have to provide your own function that does that.)
16376 If non-@code{nil}, then after scanning for new mail in the group
16377 maildirs themselves as usual, this server will also incorporate mail
16378 the conventional Gnus way, from @code{mail-sources} according to
16379 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
16380 value is @code{nil}.
16382 Do @emph{not} use the same maildir both in @code{mail-sources} and as
16383 an @code{nnmaildir} group. The results might happen to be useful, but
16384 that would be by chance, not by design, and the results might be
16385 different in the future. If your split rules create new groups,
16386 remember to supply a @code{create-directory} server parameter.
16389 @node nnmaildir Group Parameters
16390 @subsubsection Group parameters
16392 @code{nnmaildir} uses several group parameters. It's safe to ignore
16393 all this; the default behavior for @code{nnmaildir} is the same as the
16394 default behavior for other mail back ends: articles are deleted after
16395 one week, etc. Except for the expiry parameters, all this
16396 functionality is unique to @code{nnmaildir}, so you can ignore it if
16397 you're just trying to duplicate the behavior you already have with
16400 If the value of any of these parameters is a vector, the first element
16401 is evaluated as a Lisp form and the result is used, rather than the
16402 original value. If the value is not a vector, the value itself is
16403 evaluated as a Lisp form. (This is why these parameters use names
16404 different from those of other, similar parameters supported by other
16405 back ends: they have different, though similar, meanings.) (For
16406 numbers, strings, @code{nil}, and @code{t}, you can ignore the
16407 @code{eval} business again; for other values, remember to use an extra
16408 quote and wrap the value in a vector when appropriate.)
16412 An integer specifying the minimum age, in seconds, of an article
16413 before it will be expired, or the symbol @code{never} to specify that
16414 articles should never be expired. If this parameter is not set,
16415 @code{nnmaildir} falls back to the usual
16416 @code{nnmail-expiry-wait}(@code{-function}) variables (the
16417 @code{expiry-wait} group parameter overrides @code{nnmail-expiry-wait}
16418 and makes @code{nnmail-expiry-wait-function} ineffective). If you
16419 wanted a value of 3 days, you could use something like @code{[(* 3 24
16420 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
16421 An article's age is measured starting from the article file's
16422 modification time. Normally, this is the same as the article's
16423 delivery time, but editing an article makes it younger. Moving an
16424 article (other than via expiry) may also make an article younger.
16427 If this is set to a string such as a full Gnus group name, like
16429 "backend+server.address.string:group.name"
16431 and if it is not the name of the same group that the parameter belongs
16432 to, then articles will be moved to the specified group during expiry
16433 before being deleted. @emph{If this is set to an @code{nnmaildir}
16434 group, the article will be just as old in the destination group as it
16435 was in the source group.} So be careful with @code{expire-age} in the
16436 destination group. If this is set to the name of the same group that
16437 the parameter belongs to, then the article is not expired at all. If
16438 you use the vector form, the first element is evaluated once for each
16439 article. So that form can refer to
16440 @code{nnmaildir-article-file-name}, etc., to decide where to put the
16441 article. @emph{Even if this parameter is not set, @code{nnmaildir}
16442 does not fall back to the @code{expiry-target} group parameter or the
16443 @code{nnmail-expiry-target} variable.}
16446 If this is set to @code{t}, @code{nnmaildir} will treat the articles
16447 in this maildir as read-only. This means: articles are not renamed
16448 from @file{new/} into @file{cur/}; articles are only found in
16449 @file{new/}, not @file{cur/}; articles are never deleted; articles
16450 cannot be edited. @file{new/} is expected to be a symlink to the
16451 @file{new/} directory of another maildir---e.g., a system-wide mailbox
16452 containing a mailing list of common interest. Everything in the
16453 maildir outside @file{new/} is @emph{not} treated as read-only, so for
16454 a shared mailbox, you do still need to set up your own maildir (or
16455 have write permission to the shared mailbox); your maildir just won't
16456 contain extra copies of the articles.
16458 @item directory-files
16459 A function with the same interface as @code{directory-files}. It is
16460 used to scan the directories in the maildir corresponding to this
16461 group to find articles. The default is the function specified by the
16462 server's @code{directory-files} parameter.
16464 @item distrust-Lines:
16465 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
16466 article, rather than use the @code{Lines:} header field. If
16467 @code{nil}, the header field will be used if present.
16470 A list of mark symbols, such as @code{['(read expire)]}. Whenever
16471 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
16472 say that all articles have these marks, regardless of whether the
16473 marks stored in the filesystem say so. This is a proof-of-concept
16474 feature that will probably be removed eventually; it ought to be done
16475 in Gnus proper, or abandoned if it's not worthwhile.
16478 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
16479 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
16480 say that no articles have these marks, regardless of whether the marks
16481 stored in the filesystem say so. @code{never-marks} overrides
16482 @code{always-marks}. This is a proof-of-concept feature that will
16483 probably be removed eventually; it ought to be done in Gnus proper, or
16484 abandoned if it's not worthwhile.
16486 @item nov-cache-size
16487 An integer specifying the size of the @acronym{NOV} memory cache. To
16488 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
16489 for a limited number of articles in each group. (This is probably not
16490 worthwhile, and will probably be removed in the future.) This
16491 parameter's value is noticed only the first time a group is seen after
16492 the server is opened---i.e., when you first start Gnus, typically.
16493 The @acronym{NOV} cache is never resized until the server is closed
16494 and reopened. The default is an estimate of the number of articles
16495 that would be displayed in the summary buffer: a count of articles
16496 that are either marked with @code{tick} or not marked with
16497 @code{read}, plus a little extra.
16500 @node Article Identification
16501 @subsubsection Article identification
16502 Articles are stored in the @file{cur/} subdirectory of each maildir.
16503 Each article file is named like @code{uniq:info}, where @code{uniq}
16504 contains no colons. @code{nnmaildir} ignores, but preserves, the
16505 @code{:info} part. (Other maildir readers typically use this part of
16506 the filename to store marks.) The @code{uniq} part uniquely
16507 identifies the article, and is used in various places in the
16508 @file{.nnmaildir/} subdirectory of the maildir to store information
16509 about the corresponding article. The full pathname of an article is
16510 available in the variable @code{nnmaildir-article-file-name} after you
16511 request the article in the summary buffer.
16514 @subsubsection NOV data
16515 An article identified by @code{uniq} has its @acronym{NOV} data (used
16516 to generate lines in the summary buffer) stored in
16517 @code{.nnmaildir/nov/uniq}. There is no
16518 @code{nnmaildir-generate-nov-databases} function. (There isn't much
16519 need for it---an article's @acronym{NOV} data is updated automatically
16520 when the article or @code{nnmail-extra-headers} has changed.) You can
16521 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
16522 single article simply by deleting the corresponding @acronym{NOV}
16523 file, but @emph{beware}: this will also cause @code{nnmaildir} to
16524 assign a new article number for this article, which may cause trouble
16525 with @code{seen} marks, the Agent, and the cache.
16527 @node Article Marks
16528 @subsubsection Article marks
16529 An article identified by @code{uniq} is considered to have the mark
16530 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
16531 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
16532 looks for such files and reports the set of marks it finds. When Gnus
16533 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
16534 creates and deletes the corresponding files as needed. (Actually,
16535 rather than create a new file for each mark, it just creates hard
16536 links to @file{.nnmaildir/markfile}, to save inodes.)
16538 You can invent new marks by creating a new directory in
16539 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
16540 your server, untar it later, and keep your marks. You can add and
16541 remove marks yourself by creating and deleting mark files. If you do
16542 this while Gnus is running and your @code{nnmaildir} server is open,
16543 it's best to exit all summary buffers for @code{nnmaildir} groups and
16544 type @kbd{s} in the group buffer first, and to type @kbd{g} or
16545 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
16546 pick up the changes, and might undo them.
16550 @subsubsection Mail Folders
16552 @cindex mbox folders
16553 @cindex mail folders
16555 @code{nnfolder} is a back end for storing each mail group in a
16556 separate file. Each file is in the standard Un*x mbox format.
16557 @code{nnfolder} will add extra headers to keep track of article
16558 numbers and arrival dates.
16560 Virtual server settings:
16563 @item nnfolder-directory
16564 @vindex nnfolder-directory
16565 All the @code{nnfolder} mail boxes will be stored under this
16566 directory. The default is the value of @code{message-directory}
16567 (whose default is @file{~/Mail})
16569 @item nnfolder-active-file
16570 @vindex nnfolder-active-file
16571 The name of the active file. The default is @file{~/Mail/active}.
16573 @item nnfolder-newsgroups-file
16574 @vindex nnfolder-newsgroups-file
16575 The name of the group descriptions file. @xref{Newsgroups File
16576 Format}. The default is @file{~/Mail/newsgroups}
16578 @item nnfolder-get-new-mail
16579 @vindex nnfolder-get-new-mail
16580 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
16581 default is @code{t}
16583 @item nnfolder-save-buffer-hook
16584 @vindex nnfolder-save-buffer-hook
16585 @cindex backup files
16586 Hook run before saving the folders. Note that Emacs does the normal
16587 backup renaming of files even with the @code{nnfolder} buffers. If
16588 you wish to switch this off, you could say something like the
16589 following in your @file{.emacs} file:
16592 (defun turn-off-backup ()
16593 (set (make-local-variable 'backup-inhibited) t))
16595 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
16598 @item nnfolder-delete-mail-hook
16599 @vindex nnfolder-delete-mail-hook
16600 Hook run in a buffer narrowed to the message that is to be deleted.
16601 This function can be used to copy the message to somewhere else, or to
16602 extract some information from it before removing it.
16604 @item nnfolder-nov-is-evil
16605 @vindex nnfolder-nov-is-evil
16606 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
16607 default is @code{nil}.
16609 @item nnfolder-nov-file-suffix
16610 @vindex nnfolder-nov-file-suffix
16611 The extension for @acronym{NOV} files. The default is @file{.nov}.
16613 @item nnfolder-nov-directory
16614 @vindex nnfolder-nov-directory
16615 The directory where the @acronym{NOV} files should be stored. If
16616 @code{nil}, @code{nnfolder-directory} is used.
16621 @findex nnfolder-generate-active-file
16622 @kindex M-x nnfolder-generate-active-file
16623 If you have lots of @code{nnfolder}-like files you'd like to read with
16624 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
16625 command to make @code{nnfolder} aware of all likely files in
16626 @code{nnfolder-directory}. This only works if you use long file names,
16629 @node Comparing Mail Back Ends
16630 @subsubsection Comparing Mail Back Ends
16632 First, just for terminology, the @dfn{back end} is the common word for a
16633 low-level access method---a transport, if you will, by which something
16634 is acquired. The sense is that one's mail has to come from somewhere,
16635 and so selection of a suitable back end is required in order to get that
16636 mail within spitting distance of Gnus.
16638 The same concept exists for Usenet itself: Though access to articles is
16639 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
16640 in the world got at Usenet by running a reader on the machine where the
16641 articles lay (the machine which today we call an @acronym{NNTP} server), and
16642 access was by the reader stepping into the articles' directory spool
16643 area directly. One can still select between either the @code{nntp} or
16644 @code{nnspool} back ends, to select between these methods, if one happens
16645 actually to live on the server (or can see its spool directly, anyway,
16648 The goal in selecting a mail back end is to pick one which
16649 simultaneously represents a suitable way of dealing with the original
16650 format plus leaving mail in a form that is convenient to use in the
16651 future. Here are some high and low points on each:
16656 UNIX systems have historically had a single, very common, and well-defined
16657 format. All messages arrive in a single @dfn{spool file}, and
16658 they are delineated by a line whose regular expression matches
16659 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
16660 to make it clear in this instance that this is not the RFC-specified
16661 @samp{From:} header.) Because Emacs and therefore Gnus emanate
16662 historically from the Unix environment, it is simplest if one does not
16663 mess a great deal with the original mailbox format, so if one chooses
16664 this back end, Gnus' primary activity in getting mail from the real spool
16665 area to Gnus' preferred directory is simply to copy it, with no
16666 (appreciable) format change in the process. It is the ``dumbest'' way
16667 to move mail into availability in the Gnus environment. This makes it
16668 fast to move into place, but slow to parse, when Gnus has to look at
16673 Once upon a time, there was the DEC-10 and DEC-20, running operating
16674 systems called TOPS and related things, and the usual (only?) mail
16675 reading environment was a thing called Babyl. I don't know what format
16676 was used for mail landing on the system, but Babyl had its own internal
16677 format to which mail was converted, primarily involving creating a
16678 spool-file-like entity with a scheme for inserting Babyl-specific
16679 headers and status bits above the top of each message in the file.
16680 Rmail was Emacs's first mail reader, it was written by Richard Stallman,
16681 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
16682 to understand the mail files folks already had in existence. Gnus (and
16683 VM, for that matter) continue to support this format because it's
16684 perceived as having some good qualities in those mailer-specific
16685 headers/status bits stuff. Rmail itself still exists as well, of
16686 course, and is still maintained within Emacs. Since Emacs 23, it
16687 uses standard mbox format rather than Babyl.
16689 Both of the above forms leave your mail in a single file on your
16690 file system, and they must parse that entire file each time you take a
16695 @code{nnml} is the back end which smells the most as though you were
16696 actually operating with an @code{nnspool}-accessed Usenet system. (In
16697 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
16698 lo these years ago.) One's mail is taken from the original spool file,
16699 and is then cut up into individual message files, 1:1. It maintains a
16700 Usenet-style active file (analogous to what one finds in an INN- or
16701 CNews-based news system in (for instance) @file{/var/lib/news/active},
16702 or what is returned via the @samp{NNTP LIST} verb) and also creates
16703 @dfn{overview} files for efficient group entry, as has been defined for
16704 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
16705 due to the creation of lots of files, updates to the @code{nnml} active
16706 file, and additions to overview files on a per-message basis, but it is
16707 extremely fast on access because of what amounts to the indexing support
16708 provided by the active file and overviews.
16710 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
16711 resource which defines available places in the file system to put new
16712 files. Sysadmins take a dim view of heavy inode occupation within
16713 tight, shared file systems. But if you live on a personal machine where
16714 the file system is your own and space is not at a premium, @code{nnml}
16717 It is also problematic using this back end if you are living in a
16718 FAT16-based Windows world, since much space will be wasted on all these
16723 The Rand MH mail-reading system has been around UNIX systems for a very
16724 long time; it operates by splitting one's spool file of messages into
16725 individual files, but with little or no indexing support---@code{nnmh}
16726 is considered to be semantically equivalent to ``@code{nnml} without
16727 active file or overviews''. This is arguably the worst choice, because
16728 one gets the slowness of individual file creation married to the
16729 slowness of access parsing when learning what's new in one's groups.
16733 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
16734 method described above) on a per-group basis. That is, @code{nnmbox}
16735 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
16736 little bit of optimization to this so that each of one's mail groups has
16737 a Unix mail box file. It's faster than @code{nnmbox} because each group
16738 can be parsed separately, and still provides the simple Unix mail box
16739 format requiring minimal effort in moving the mail around. In addition,
16740 it maintains an ``active'' file making it much faster for Gnus to figure
16741 out how many messages there are in each separate group.
16743 If you have groups that are expected to have a massive amount of
16744 messages, @code{nnfolder} is not the best choice, but if you receive
16745 only a moderate amount of mail, @code{nnfolder} is probably the most
16746 friendly mail back end all over.
16750 For configuring expiry and other things, @code{nnmaildir} uses
16751 incompatible group parameters, slightly different from those of other
16754 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
16755 differences. Each message is stored in a separate file, but the
16756 filename is unrelated to the article number in Gnus. @code{nnmaildir}
16757 also stores the equivalent of @code{nnml}'s overview files in one file
16758 per article, so it uses about twice as many inodes as @code{nnml}.
16759 (Use @code{df -i} to see how plentiful your inode supply is.) If this
16760 slows you down or takes up very much space, a non-block-structured
16763 Since maildirs don't require locking for delivery, the maildirs you use
16764 as groups can also be the maildirs your mail is directly delivered to.
16765 This means you can skip Gnus' mail splitting if your mail is already
16766 organized into different mailboxes during delivery. A @code{directory}
16767 entry in @code{mail-sources} would have a similar effect, but would
16768 require one set of mailboxes for spooling deliveries (in mbox format,
16769 thus damaging message bodies), and another set to be used as groups (in
16770 whatever format you like). A maildir has a built-in spool, in the
16771 @code{new/} subdirectory. Beware that currently, mail moved from
16772 @code{new/} to @code{cur/} instead of via mail splitting will not
16773 undergo treatment such as duplicate checking.
16775 @code{nnmaildir} stores article marks for a given group in the
16776 corresponding maildir, in a way designed so that it's easy to manipulate
16777 them from outside Gnus. You can tar up a maildir, unpack it somewhere
16778 else, and still have your marks.
16780 @code{nnmaildir} uses a significant amount of memory to speed things up.
16781 (It keeps in memory some of the things that @code{nnml} stores in files
16782 and that @code{nnmh} repeatedly parses out of message files.) If this
16783 is a problem for you, you can set the @code{nov-cache-size} group
16784 parameter to something small (0 would probably not work, but 1 probably
16785 would) to make it use less memory. This caching will probably be
16786 removed in the future.
16788 Startup is likely to be slower with @code{nnmaildir} than with other
16789 back ends. Everything else is likely to be faster, depending in part
16790 on your file system.
16792 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
16793 to write an @code{nnmaildir}-derived back end.
16798 @node Browsing the Web
16799 @section Browsing the Web
16801 @cindex browsing the web
16805 Web-based discussion forums are getting more and more popular. On many
16806 subjects, the web-based forums have become the most important forums,
16807 eclipsing the importance of mailing lists and news groups. The reason
16808 is easy to understand---they are friendly to new users; you just point
16809 and click, and there's the discussion. With mailing lists, you have to
16810 go through a cumbersome subscription procedure, and most people don't
16811 even know what a news group is.
16813 The problem with this scenario is that web browsers are not very good at
16814 being newsreaders. They do not keep track of what articles you've read;
16815 they do not allow you to score on subjects you're interested in; they do
16816 not allow off-line browsing; they require you to click around and drive
16817 you mad in the end.
16819 So---if web browsers suck at reading discussion forums, why not use Gnus
16822 Gnus has been getting a bit of a collection of back ends for providing
16823 interfaces to these sources.
16827 * Web Searches:: Creating groups from articles that match a string.
16828 * RSS:: Reading RDF site summary.
16829 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
16832 All the web sources require Emacs/W3 and the url library or those
16833 alternatives to work.
16835 The main caveat with all these web sources is that they probably won't
16836 work for a very long time. Gleaning information from the @acronym{HTML} data
16837 is guesswork at best, and when the layout is altered, the Gnus back end
16838 will fail. If you have reasonably new versions of these back ends,
16839 though, you should be ok.
16841 One thing all these Web methods have in common is that the Web sources
16842 are often down, unavailable or just plain too slow to be fun. In those
16843 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
16844 Unplugged}) handle downloading articles, and then you can read them at
16845 leisure from your local disk. No more World Wide Wait for you.
16847 @node Archiving Mail
16848 @subsection Archiving Mail
16849 @cindex archiving mail
16850 @cindex backup of mail
16852 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
16853 @code{nnmaildir}, now actually store the article marks with each group.
16854 For these servers, archiving and restoring a group while preserving
16855 marks is fairly simple.
16857 (Preserving the group level and group parameters as well still
16858 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
16861 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
16862 server, take a recursive copy of the server directory. There is no need
16863 to shut down Gnus, so archiving may be invoked by @code{cron} or
16864 similar. You restore the data by restoring the directory tree, and
16865 adding a server definition pointing to that directory in Gnus. The
16866 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
16867 might interfere with overwriting data, so you may want to shut down Gnus
16868 before you restore the data.
16871 @subsection Web Searches
16876 @cindex Usenet searches
16877 @cindex searching the Usenet
16879 It's, like, too neat to search the Usenet for articles that match a
16880 string, but it, like, totally @emph{sucks}, like, totally, to use one of
16881 those, like, Web browsers, and you, like, have to, rilly, like, look at
16882 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
16883 searches without having to use a browser.
16885 The @code{nnweb} back end allows an easy interface to the mighty search
16886 engine. You create an @code{nnweb} group, enter a search pattern, and
16887 then enter the group and read the articles like you would any normal
16888 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
16889 Groups}) will do this in an easy-to-use fashion.
16891 @code{nnweb} groups don't really lend themselves to being solid
16892 groups---they have a very fleeting idea of article numbers. In fact,
16893 each time you enter an @code{nnweb} group (not even changing the search
16894 pattern), you are likely to get the articles ordered in a different
16895 manner. Not even using duplicate suppression (@pxref{Duplicate
16896 Suppression}) will help, since @code{nnweb} doesn't even know the
16897 @code{Message-ID} of the articles before reading them using some search
16898 engines (Google, for instance). The only possible way to keep track
16899 of which articles you've read is by scoring on the @code{Date}
16900 header---mark all articles posted before the last date you read the
16903 If the search engine changes its output substantially, @code{nnweb}
16904 won't be able to parse it and will fail. One could hardly fault the Web
16905 providers if they were to do this---their @emph{raison d'@^etre} is to
16906 make money off of advertisements, not to provide services to the
16907 community. Since @code{nnweb} washes the ads off all the articles, one
16908 might think that the providers might be somewhat miffed. We'll see.
16910 You must have the @code{url} and @code{W3} package or those alternatives
16911 (try @code{customize-group} on the @samp{mm-url} variable group)
16912 installed to be able to use @code{nnweb}.
16914 Virtual server variables:
16919 What search engine type is being used. The currently supported types
16920 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
16921 @code{dejanews} is an alias to @code{google}.
16924 @vindex nnweb-search
16925 The search string to feed to the search engine.
16927 @item nnweb-max-hits
16928 @vindex nnweb-max-hits
16929 Advisory maximum number of hits per search to display. The default is
16932 @item nnweb-type-definition
16933 @vindex nnweb-type-definition
16934 Type-to-definition alist. This alist says what @code{nnweb} should do
16935 with the various search engine types. The following elements must be
16940 Function to decode the article and provide something that Gnus
16944 Function to create an article number to message header and URL alist.
16947 Function to send the search string to the search engine.
16950 The address the aforementioned function should send the search string
16954 Format string URL to fetch an article by @code{Message-ID}.
16965 Some web sites have an RDF Site Summary (@acronym{RSS}).
16966 @acronym{RSS} is a format for summarizing headlines from news related
16967 sites (such as BBC or CNN). But basically anything list-like can be
16968 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
16969 changes to a wiki (e.g., @url{http://cliki.net/site/recent-changes}).
16971 @acronym{RSS} has a quite regular and nice interface, and it's
16972 possible to get the information Gnus needs to keep groups updated.
16974 Note: you had better use Emacs which supports the @code{utf-8} coding
16975 system because @acronym{RSS} uses UTF-8 for encoding non-@acronym{ASCII}
16976 text by default. It is also used by default for non-@acronym{ASCII}
16979 @kindex G R (Group)
16980 Use @kbd{G R} from the group buffer to subscribe to a feed---you will be
16981 prompted for the location, the title and the description of the feed.
16982 The title, which allows any characters, will be used for the group name
16983 and the name of the group data file. The description can be omitted.
16985 An easy way to get started with @code{nnrss} is to say something like
16986 the following in the group buffer: @kbd{B nnrss RET RET y}, then
16987 subscribe to groups.
16989 The @code{nnrss} back end saves the group data file in
16990 @code{nnrss-directory} (see below) for each @code{nnrss} group. File
16991 names containing non-@acronym{ASCII} characters will be encoded by the
16992 coding system specified with the @code{nnmail-pathname-coding-system}
16993 variable or other. Also @xref{Non-ASCII Group Names}, for more
16996 The @code{nnrss} back end generates @samp{multipart/alternative}
16997 @acronym{MIME} articles in which each contains a @samp{text/plain} part
16998 and a @samp{text/html} part.
17001 You can also use the following commands to import and export your
17002 subscriptions from a file in @acronym{OPML} format (Outline Processor
17005 @defun nnrss-opml-import file
17006 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
17010 @defun nnrss-opml-export
17011 Write your current @acronym{RSS} subscriptions to a buffer in
17012 @acronym{OPML} format.
17015 The following @code{nnrss} variables can be altered:
17018 @item nnrss-directory
17019 @vindex nnrss-directory
17020 The directory where @code{nnrss} stores its files. The default is
17021 @file{~/News/rss/}.
17023 @item nnrss-file-coding-system
17024 @vindex nnrss-file-coding-system
17025 The coding system used when reading and writing the @code{nnrss} groups
17026 data files. The default is the value of
17027 @code{mm-universal-coding-system} (which defaults to @code{emacs-mule}
17028 in Emacs or @code{escape-quoted} in XEmacs).
17030 @item nnrss-ignore-article-fields
17031 @vindex nnrss-ignore-article-fields
17032 Some feeds update constantly article fields during their publications,
17033 e.g., to indicate the number of comments. However, if there is
17034 a difference between the local article and the distant one, the latter
17035 is considered to be new. To avoid this and discard some fields, set this
17036 variable to the list of fields to be ignored. The default is
17037 @code{'(slash:comments)}.
17039 @item nnrss-use-local
17040 @vindex nnrss-use-local
17041 @findex nnrss-generate-download-script
17042 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
17043 the feeds from local files in @code{nnrss-directory}. You can use
17044 the command @code{nnrss-generate-download-script} to generate a
17045 download script using @command{wget}.
17048 The following code may be helpful, if you want to show the description in
17049 the summary buffer.
17052 (add-to-list 'nnmail-extra-headers nnrss-description-field)
17053 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
17055 (defun gnus-user-format-function-X (header)
17057 (assq nnrss-description-field (mail-header-extra header))))
17058 (if descr (concat "\n\t" (cdr descr)) "")))
17061 The following code may be useful to open an nnrss url directly from the
17065 (require 'browse-url)
17067 (defun browse-nnrss-url (arg)
17069 (let ((url (assq nnrss-url-field
17072 (assq (gnus-summary-article-number)
17073 gnus-newsgroup-data))))))
17076 (browse-url (cdr url))
17077 (gnus-summary-mark-as-read-forward 1))
17078 (gnus-summary-scroll-up arg))))
17080 (eval-after-load "gnus"
17081 #'(define-key gnus-summary-mode-map
17082 (kbd "<RET>") 'browse-nnrss-url))
17083 (add-to-list 'nnmail-extra-headers nnrss-url-field)
17086 Even if you have added @samp{text/html} to the
17087 @code{mm-discouraged-alternatives} variable (@pxref{Display
17088 Customization, ,Display Customization, emacs-mime, The Emacs MIME
17089 Manual}) since you don't want to see @acronym{HTML} parts, it might be
17090 more useful especially in @code{nnrss} groups to display
17091 @samp{text/html} parts. Here's an example of setting
17092 @code{mm-discouraged-alternatives} as a group parameter (@pxref{Group
17093 Parameters}) in order to display @samp{text/html} parts only in
17094 @code{nnrss} groups:
17097 ;; @r{Set the default value of @code{mm-discouraged-alternatives}.}
17098 (eval-after-load "gnus-sum"
17100 'gnus-newsgroup-variables
17101 '(mm-discouraged-alternatives
17102 . '("text/html" "image/.*"))))
17104 ;; @r{Display @samp{text/html} parts in @code{nnrss} groups.}
17107 '("\\`nnrss:" (mm-discouraged-alternatives nil)))
17111 @node Customizing W3
17112 @subsection Customizing W3
17118 Gnus uses the url library to fetch web pages and Emacs/W3 (or those
17119 alternatives) to display web pages. Emacs/W3 is documented in its own
17120 manual, but there are some things that may be more relevant for Gnus
17123 For instance, a common question is how to make Emacs/W3 follow links
17124 using the @code{browse-url} functions (which will call some external web
17125 browser like Netscape). Here's one way:
17128 (eval-after-load "w3"
17130 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
17131 (defun w3-fetch (&optional url target)
17132 (interactive (list (w3-read-url-with-default)))
17133 (if (eq major-mode 'gnus-article-mode)
17135 (w3-fetch-orig url target)))))
17138 Put that in your @file{.emacs} file, and hitting links in W3-rendered
17139 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
17143 @node Other Sources
17144 @section Other Sources
17146 Gnus can do more than just read news or mail. The methods described
17147 below allow Gnus to view directories and files as if they were
17151 * Directory Groups:: You can read a directory as if it was a newsgroup.
17152 * Anything Groups:: Dired? Who needs dired?
17153 * Document Groups:: Single files can be the basis of a group.
17154 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
17155 * The Empty Backend:: The backend that never has any news.
17159 @node Directory Groups
17160 @subsection Directory Groups
17162 @cindex directory groups
17164 If you have a directory that has lots of articles in separate files in
17165 it, you might treat it as a newsgroup. The files have to have numerical
17168 This might be an opportune moment to mention @code{ange-ftp} (and its
17169 successor @code{efs}), that most wonderful of all wonderful Emacs
17170 packages. When I wrote @code{nndir}, I didn't think much about it---a
17171 back end to read directories. Big deal.
17173 @code{ange-ftp} changes that picture dramatically. For instance, if you
17174 enter the @code{ange-ftp} file name
17175 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
17176 @code{ange-ftp} or @code{efs} will actually allow you to read this
17177 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
17179 @code{nndir} will use @acronym{NOV} files if they are present.
17181 @code{nndir} is a ``read-only'' back end---you can't delete or expire
17182 articles with this method. You can use @code{nnmh} or @code{nnml} for
17183 whatever you use @code{nndir} for, so you could switch to any of those
17184 methods if you feel the need to have a non-read-only @code{nndir}.
17187 @node Anything Groups
17188 @subsection Anything Groups
17191 From the @code{nndir} back end (which reads a single spool-like
17192 directory), it's just a hop and a skip to @code{nneething}, which
17193 pretends that any arbitrary directory is a newsgroup. Strange, but
17196 When @code{nneething} is presented with a directory, it will scan this
17197 directory and assign article numbers to each file. When you enter such
17198 a group, @code{nneething} must create ``headers'' that Gnus can use.
17199 After all, Gnus is a newsreader, in case you're forgetting.
17200 @code{nneething} does this in a two-step process. First, it snoops each
17201 file in question. If the file looks like an article (i.e., the first
17202 few lines look like headers), it will use this as the head. If this is
17203 just some arbitrary file without a head (e.g., a C source file),
17204 @code{nneething} will cobble up a header out of thin air. It will use
17205 file ownership, name and date and do whatever it can with these
17208 All this should happen automatically for you, and you will be presented
17209 with something that looks very much like a newsgroup. Totally like a
17210 newsgroup, to be precise. If you select an article, it will be displayed
17211 in the article buffer, just as usual.
17213 If you select a line that represents a directory, Gnus will pop you into
17214 a new summary buffer for this @code{nneething} group. And so on. You can
17215 traverse the entire disk this way, if you feel like, but remember that
17216 Gnus is not dired, really, and does not intend to be, either.
17218 There are two overall modes to this action---ephemeral or solid. When
17219 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
17220 will not store information on what files you have read, and what files
17221 are new, and so on. If you create a solid @code{nneething} group the
17222 normal way with @kbd{G m}, Gnus will store a mapping table between
17223 article numbers and file names, and you can treat this group like any
17224 other groups. When you activate a solid @code{nneething} group, you will
17225 be told how many unread articles it contains, etc., etc.
17230 @item nneething-map-file-directory
17231 @vindex nneething-map-file-directory
17232 All the mapping files for solid @code{nneething} groups will be stored
17233 in this directory, which defaults to @file{~/.nneething/}.
17235 @item nneething-exclude-files
17236 @vindex nneething-exclude-files
17237 All files that match this regexp will be ignored. Nice to use to exclude
17238 auto-save files and the like, which is what it does by default.
17240 @item nneething-include-files
17241 @vindex nneething-include-files
17242 Regexp saying what files to include in the group. If this variable is
17243 non-@code{nil}, only files matching this regexp will be included.
17245 @item nneething-map-file
17246 @vindex nneething-map-file
17247 Name of the map files.
17251 @node Document Groups
17252 @subsection Document Groups
17254 @cindex documentation group
17257 @code{nndoc} is a cute little thing that will let you read a single file
17258 as a newsgroup. Several files types are supported:
17268 The standard Unix mbox file.
17270 @cindex MMDF mail box
17272 The MMDF mail box format.
17275 Several news articles appended into a file.
17277 @cindex rnews batch files
17279 The rnews batch transport format.
17282 Netscape mail boxes.
17285 @acronym{MIME} multipart messages.
17287 @item standard-digest
17288 The standard (RFC 1153) digest format.
17291 A @acronym{MIME} digest of messages.
17293 @item lanl-gov-announce
17294 Announcement messages from LANL Gov Announce.
17296 @cindex git commit messages
17298 @code{git} commit messages.
17300 @cindex forwarded messages
17301 @item rfc822-forward
17302 A message forwarded according to RFC822.
17305 The Outlook mail box.
17308 The Outlook Express dbx mail box.
17311 A bounce message from the Exim MTA.
17314 A message forwarded according to informal rules.
17317 An RFC934-forwarded message.
17323 A digest of Clarinet brief news items.
17326 Non-standard digest format---matches most things, but does it badly.
17332 You can also use the special ``file type'' @code{guess}, which means
17333 that @code{nndoc} will try to guess what file type it is looking at.
17334 @code{digest} means that @code{nndoc} should guess what digest type the
17337 @code{nndoc} will not try to change the file or insert any extra headers into
17338 it---it will simply, like, let you use the file as the basis for a
17339 group. And that's it.
17341 If you have some old archived articles that you want to insert into your
17342 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
17343 that. Say you have an old @file{RMAIL} file with mail that you now want
17344 to split into your new @code{nnml} groups. You look at that file using
17345 @code{nndoc} (using the @kbd{G f} command in the group buffer
17346 (@pxref{Foreign Groups})), set the process mark on all the articles in
17347 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
17348 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
17349 file is now also stored in lots of @code{nnml} directories, and you can
17350 delete that pesky @file{RMAIL} file. If you have the guts!
17352 Virtual server variables:
17355 @item nndoc-article-type
17356 @vindex nndoc-article-type
17357 This should be one of @code{mbox}, @code{babyl}, @code{digest},
17358 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
17359 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
17360 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
17361 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
17363 @item nndoc-post-type
17364 @vindex nndoc-post-type
17365 This variable says whether Gnus is to consider the group a news group or
17366 a mail group. There are two valid values: @code{mail} (the default)
17371 * Document Server Internals:: How to add your own document types.
17375 @node Document Server Internals
17376 @subsubsection Document Server Internals
17378 Adding new document types to be recognized by @code{nndoc} isn't
17379 difficult. You just have to whip up a definition of what the document
17380 looks like, write a predicate function to recognize that document type,
17381 and then hook into @code{nndoc}.
17383 First, here's an example document type definition:
17387 (article-begin . "^\^A\^A\^A\^A\n")
17388 (body-end . "^\^A\^A\^A\^A\n"))
17391 The definition is simply a unique @dfn{name} followed by a series of
17392 regexp pseudo-variable settings. Below are the possible
17393 variables---don't be daunted by the number of variables; most document
17394 types can be defined with very few settings:
17397 @item first-article
17398 If present, @code{nndoc} will skip past all text until it finds
17399 something that match this regexp. All text before this will be
17402 @item article-begin
17403 This setting has to be present in all document type definitions. It
17404 says what the beginning of each article looks like. To do more
17405 complicated things that cannot be dealt with a simple regexp, you can
17406 use @code{article-begin-function} instead of this.
17408 @item article-begin-function
17409 If present, this should be a function that moves point to the beginning
17410 of each article. This setting overrides @code{article-begin}.
17413 If present, this should be a regexp that matches the head of the
17414 article. To do more complicated things that cannot be dealt with a
17415 simple regexp, you can use @code{head-begin-function} instead of this.
17417 @item head-begin-function
17418 If present, this should be a function that moves point to the head of
17419 the article. This setting overrides @code{head-begin}.
17422 This should match the end of the head of the article. It defaults to
17423 @samp{^$}---the empty line.
17426 This should match the beginning of the body of the article. It defaults
17427 to @samp{^\n}. To do more complicated things that cannot be dealt with
17428 a simple regexp, you can use @code{body-begin-function} instead of this.
17430 @item body-begin-function
17431 If present, this function should move point to the beginning of the body
17432 of the article. This setting overrides @code{body-begin}.
17435 If present, this should match the end of the body of the article. To do
17436 more complicated things that cannot be dealt with a simple regexp, you
17437 can use @code{body-end-function} instead of this.
17439 @item body-end-function
17440 If present, this function should move point to the end of the body of
17441 the article. This setting overrides @code{body-end}.
17444 If present, this should match the beginning of the file. All text
17445 before this regexp will be totally ignored.
17448 If present, this should match the end of the file. All text after this
17449 regexp will be totally ignored.
17453 So, using these variables @code{nndoc} is able to dissect a document
17454 file into a series of articles, each with a head and a body. However, a
17455 few more variables are needed since not all document types are all that
17456 news-like---variables needed to transform the head or the body into
17457 something that's palatable for Gnus:
17460 @item prepare-body-function
17461 If present, this function will be called when requesting an article. It
17462 will be called with point at the start of the body, and is useful if the
17463 document has encoded some parts of its contents.
17465 @item article-transform-function
17466 If present, this function is called when requesting an article. It's
17467 meant to be used for more wide-ranging transformation of both head and
17468 body of the article.
17470 @item generate-head-function
17471 If present, this function is called to generate a head that Gnus can
17472 understand. It is called with the article number as a parameter, and is
17473 expected to generate a nice head for the article in question. It is
17474 called when requesting the headers of all articles.
17476 @item generate-article-function
17477 If present, this function is called to generate an entire article that
17478 Gnus can understand. It is called with the article number as a
17479 parameter when requesting all articles.
17481 @item dissection-function
17482 If present, this function is called to dissect a document by itself,
17483 overriding @code{first-article}, @code{article-begin},
17484 @code{article-begin-function}, @code{head-begin},
17485 @code{head-begin-function}, @code{head-end}, @code{body-begin},
17486 @code{body-begin-function}, @code{body-end}, @code{body-end-function},
17487 @code{file-begin}, and @code{file-end}.
17491 Let's look at the most complicated example I can come up with---standard
17496 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
17497 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
17498 (prepare-body-function . nndoc-unquote-dashes)
17499 (body-end-function . nndoc-digest-body-end)
17500 (head-end . "^ ?$")
17501 (body-begin . "^ ?\n")
17502 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
17503 (subtype digest guess))
17506 We see that all text before a 70-width line of dashes is ignored; all
17507 text after a line that starts with that @samp{^End of} is also ignored;
17508 each article begins with a 30-width line of dashes; the line separating
17509 the head from the body may contain a single space; and that the body is
17510 run through @code{nndoc-unquote-dashes} before being delivered.
17512 To hook your own document definition into @code{nndoc}, use the
17513 @code{nndoc-add-type} function. It takes two parameters---the first
17514 is the definition itself and the second (optional) parameter says
17515 where in the document type definition alist to put this definition.
17516 The alist is traversed sequentially, and
17517 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
17518 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
17519 @code{mmdf} type, and so on. These type predicates should return
17520 @code{nil} if the document is not of the correct type; @code{t} if it
17521 is of the correct type; and a number if the document might be of the
17522 correct type. A high number means high probability; a low number
17523 means low probability with @samp{0} being the lowest valid number.
17526 @node Mail-To-News Gateways
17527 @subsection Mail-To-News Gateways
17528 @cindex mail-to-news gateways
17531 If your local @code{nntp} server doesn't allow posting, for some reason
17532 or other, you can post using one of the numerous mail-to-news gateways.
17533 The @code{nngateway} back end provides the interface.
17535 Note that you can't read anything from this back end---it can only be
17541 @item nngateway-address
17542 @vindex nngateway-address
17543 This is the address of the mail-to-news gateway.
17545 @item nngateway-header-transformation
17546 @vindex nngateway-header-transformation
17547 News headers often have to be transformed in some odd way or other
17548 for the mail-to-news gateway to accept it. This variable says what
17549 transformation should be called, and defaults to
17550 @code{nngateway-simple-header-transformation}. The function is called
17551 narrowed to the headers to be transformed and with one parameter---the
17554 This default function just inserts a new @code{To} header based on the
17555 @code{Newsgroups} header and the gateway address.
17556 For instance, an article with this @code{Newsgroups} header:
17559 Newsgroups: alt.religion.emacs
17562 will get this @code{To} header inserted:
17565 To: alt-religion-emacs@@GATEWAY
17568 The following pre-defined functions exist:
17570 @findex nngateway-simple-header-transformation
17573 @item nngateway-simple-header-transformation
17574 Creates a @code{To} header that looks like
17575 @var{newsgroup}@@@code{nngateway-address}.
17577 @findex nngateway-mail2news-header-transformation
17579 @item nngateway-mail2news-header-transformation
17580 Creates a @code{To} header that looks like
17581 @code{nngateway-address}.
17589 (setq gnus-post-method
17591 "mail2news@@replay.com"
17592 (nngateway-header-transformation
17593 nngateway-mail2news-header-transformation)))
17596 So, to use this, simply say something like:
17599 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17603 @node The Empty Backend
17604 @subsection The Empty Backend
17607 @code{nnnil} is a backend that can be used as a placeholder if you
17608 have to specify a backend somewhere, but don't really want to. The
17609 classical example is if you don't want to have a primary select
17610 methods, but want to only use secondary ones:
17613 (setq gnus-select-method '(nnnil ""))
17614 (setq gnus-secondary-select-methods
17620 @node Combined Groups
17621 @section Combined Groups
17623 Gnus allows combining a mixture of all the other group types into bigger
17627 * Virtual Groups:: Combining articles from many groups.
17631 @node Virtual Groups
17632 @subsection Virtual Groups
17634 @cindex virtual groups
17635 @cindex merging groups
17637 An @dfn{nnvirtual group} is really nothing more than a collection of
17640 For instance, if you are tired of reading many small groups, you can
17641 put them all in one big group, and then grow tired of reading one
17642 big, unwieldy group. The joys of computing!
17644 You specify @code{nnvirtual} as the method. The address should be a
17645 regexp to match component groups.
17647 All marks in the virtual group will stick to the articles in the
17648 component groups. So if you tick an article in a virtual group, the
17649 article will also be ticked in the component group from whence it
17650 came. (And vice versa---marks from the component groups will also be
17651 shown in the virtual group.). To create an empty virtual group, run
17652 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17653 and edit the method regexp with @kbd{M-e}
17654 (@code{gnus-group-edit-group-method})
17656 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17657 newsgroups into one, big, happy newsgroup:
17660 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17663 The component groups can be native or foreign; everything should work
17664 smoothly, but if your computer explodes, it was probably my fault.
17666 Collecting the same group from several servers might actually be a good
17667 idea if users have set the Distribution header to limit distribution.
17668 If you would like to read @samp{soc.motss} both from a server in Japan
17669 and a server in Norway, you could use the following as the group regexp:
17672 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17675 (Remember, though, that if you're creating the group with @kbd{G m}, you
17676 shouldn't double the backslashes, and you should leave off the quote
17677 characters at the beginning and the end of the string.)
17679 This should work kinda smoothly---all articles from both groups should
17680 end up in this one, and there should be no duplicates. Threading (and
17681 the rest) will still work as usual, but there might be problems with the
17682 sequence of articles. Sorting on date might be an option here
17683 (@pxref{Selecting a Group}).
17685 One limitation, however---all groups included in a virtual
17686 group have to be alive (i.e., subscribed or unsubscribed). Killed or
17687 zombie groups can't be component groups for @code{nnvirtual} groups.
17689 @vindex nnvirtual-always-rescan
17690 If the @code{nnvirtual-always-rescan} variable is non-@code{nil} (which
17691 is the default), @code{nnvirtual} will always scan groups for unread
17692 articles when entering a virtual group. If this variable is @code{nil}
17693 and you read articles in a component group after the virtual group has
17694 been activated, the read articles from the component group will show up
17695 when you enter the virtual group. You'll also see this effect if you
17696 have two virtual groups that have a component group in common. If
17697 that's the case, you should set this variable to @code{t}. Or you can
17698 just tap @code{M-g} on the virtual group every time before you enter
17699 it---it'll have much the same effect.
17701 @code{nnvirtual} can have both mail and news groups as component groups.
17702 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17703 has to ask the back end of the component group the article comes from
17704 whether it is a news or mail back end. However, when you do a @kbd{^},
17705 there is typically no sure way for the component back end to know this,
17706 and in that case @code{nnvirtual} tells Gnus that the article came from a
17707 not-news back end. (Just to be on the safe side.)
17709 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17710 line from the article you respond to in these cases.
17712 @code{nnvirtual} groups do not inherit anything but articles and marks
17713 from component groups---group parameters, for instance, are not
17717 @node Email Based Diary
17718 @section Email Based Diary
17720 @cindex email based diary
17723 This section describes a special mail back end called @code{nndiary},
17724 and its companion library @code{gnus-diary}. It is ``special'' in the
17725 sense that it is not meant to be one of the standard alternatives for
17726 reading mail with Gnus. See @ref{Choosing a Mail Back End} for that.
17727 Instead, it is used to treat @emph{some} of your mails in a special way,
17728 namely, as event reminders.
17730 Here is a typical scenario:
17734 You've got a date with Andy Mc Dowell or Bruce Willis (select according
17735 to your sexual preference) in one month. You don't want to forget it.
17737 So you send a ``reminder'' message (actually, a diary one) to yourself.
17739 You forget all about it and keep on getting and reading new mail, as usual.
17741 From time to time, as you type `g' in the group buffer and as the date
17742 is getting closer, the message will pop up again to remind you of your
17743 appointment, just as if it were new and unread.
17745 Read your ``new'' messages, this one included, and start dreaming again
17746 of the night you're gonna have.
17748 Once the date is over (you actually fell asleep just after dinner), the
17749 message will be automatically deleted if it is marked as expirable.
17752 The Gnus Diary back end has the ability to handle regular appointments
17753 (that wouldn't ever be deleted) as well as punctual ones, operates as a
17754 real mail back end and is configurable in many ways. All of this is
17755 explained in the sections below.
17758 * The NNDiary Back End:: Basic setup and usage.
17759 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
17760 * Sending or Not Sending:: A final note on sending diary messages.
17764 @node The NNDiary Back End
17765 @subsection The NNDiary Back End
17767 @cindex the nndiary back end
17769 @code{nndiary} is a back end very similar to @code{nnml} (@pxref{Mail
17770 Spool}). Actually, it could appear as a mix of @code{nnml} and
17771 @code{nndraft}. If you know @code{nnml}, you're already familiar with
17772 the message storing scheme of @code{nndiary}: one file per message, one
17773 directory per group.
17775 Before anything, there is one requirement to be able to run
17776 @code{nndiary} properly: you @emph{must} use the group timestamp feature
17777 of Gnus. This adds a timestamp to each group's parameters. @ref{Group
17778 Timestamp} to see how it's done.
17781 * Diary Messages:: What makes a message valid for nndiary.
17782 * Running NNDiary:: NNDiary has two modes of operation.
17783 * Customizing NNDiary:: Bells and whistles.
17786 @node Diary Messages
17787 @subsubsection Diary Messages
17788 @cindex nndiary messages
17789 @cindex nndiary mails
17791 @code{nndiary} messages are just normal ones, except for the mandatory
17792 presence of 7 special headers. These headers are of the form
17793 @code{X-Diary-<something>}, @code{<something>} being one of
17794 @code{Minute}, @code{Hour}, @code{Dom}, @code{Month}, @code{Year},
17795 @code{Time-Zone} and @code{Dow}. @code{Dom} means ``Day of Month'', and
17796 @code{dow} means ``Day of Week''. These headers actually behave like
17797 crontab specifications and define the event date(s):
17801 For all headers except the @code{Time-Zone} one, a header value is
17802 either a star (meaning all possible values), or a list of fields
17803 (separated by a comma).
17805 A field is either an integer, or a range.
17807 A range is two integers separated by a dash.
17809 Possible integer values are 0--59 for @code{Minute}, 0--23 for
17810 @code{Hour}, 1--31 for @code{Dom}, 1--12 for @code{Month}, above 1971
17811 for @code{Year} and 0--6 for @code{Dow} (0 meaning Sunday).
17813 As a special case, a star in either @code{Dom} or @code{Dow} doesn't
17814 mean ``all possible values'', but ``use only the other field''. Note
17815 that if both are star'ed, the use of either one gives the same result.
17817 The @code{Time-Zone} header is special in that it can only have one
17818 value (@code{GMT}, for instance). A star doesn't mean ``all possible
17819 values'' (because it makes no sense), but ``the current local time
17820 zone''. Most of the time, you'll be using a star here. However, for a
17821 list of available time zone values, see the variable
17822 @code{nndiary-headers}.
17825 As a concrete example, here are the diary headers to add to your message
17826 for specifying ``Each Monday and each 1st of month, at 12:00, 20:00,
17827 21:00, 22:00, 23:00 and 24:00, from 1999 to 2010'' (I'll let you find
17832 X-Diary-Hour: 12, 20-24
17835 X-Diary-Year: 1999-2010
17837 X-Diary-Time-Zone: *
17840 @node Running NNDiary
17841 @subsubsection Running NNDiary
17842 @cindex running nndiary
17843 @cindex nndiary operation modes
17845 @code{nndiary} has two modes of operation: ``traditional'' (the default)
17846 and ``autonomous''. In traditional mode, @code{nndiary} does not get new
17847 mail by itself. You have to move (@kbd{B m}) or copy (@kbd{B c}) mails
17848 from your primary mail back end to nndiary groups in order to handle them
17849 as diary messages. In autonomous mode, @code{nndiary} retrieves its own
17850 mail and handles it independently from your primary mail back end.
17852 One should note that Gnus is not inherently designed to allow several
17853 ``master'' mail back ends at the same time. However, this does make
17854 sense with @code{nndiary}: you really want to send and receive diary
17855 messages to your diary groups directly. So, @code{nndiary} supports
17856 being sort of a ``second primary mail back end'' (to my knowledge, it is
17857 the only back end offering this feature). However, there is a limitation
17858 (which I hope to fix some day): respooling doesn't work in autonomous
17861 In order to use @code{nndiary} in autonomous mode, you have several
17866 Allow @code{nndiary} to retrieve new mail by itself. Put the following
17867 line in your @file{~/.gnus.el} file:
17870 (setq nndiary-get-new-mail t)
17873 You must arrange for diary messages (those containing @code{X-Diary-*}
17874 headers) to be split in a private folder @emph{before} Gnus treat them.
17875 Again, this is needed because Gnus cannot (yet ?) properly handle
17876 multiple primary mail back ends. Getting those messages from a separate
17877 source will compensate this misfeature to some extent.
17879 As an example, here's my procmailrc entry to store diary files in
17880 @file{~/.nndiary} (the default @code{nndiary} mail source file):
17889 Once this is done, you might want to customize the following two options
17890 that affect the diary mail retrieval and splitting processes:
17892 @defvar nndiary-mail-sources
17893 This is the diary-specific replacement for the standard
17894 @code{mail-sources} variable. It obeys the same syntax, and defaults to
17895 @code{(file :path "~/.nndiary")}.
17898 @defvar nndiary-split-methods
17899 This is the diary-specific replacement for the standard
17900 @code{nnmail-split-methods} variable. It obeys the same syntax.
17903 Finally, you may add a permanent @code{nndiary} virtual server
17904 (something like @code{(nndiary "diary")} should do) to your
17905 @code{gnus-secondary-select-methods}.
17907 Hopefully, almost everything (see the TODO section in
17908 @file{nndiary.el}) will work as expected when you restart Gnus: in
17909 autonomous mode, typing @kbd{g} and @kbd{M-g} in the group buffer, will
17910 also get your new diary mails and split them according to your
17911 diary-specific rules, @kbd{F} will find your new diary groups etc.
17913 @node Customizing NNDiary
17914 @subsubsection Customizing NNDiary
17915 @cindex customizing nndiary
17916 @cindex nndiary customization
17918 Now that @code{nndiary} is up and running, it's time to customize it.
17919 The custom group is called @code{nndiary} (no, really ?!). You should
17920 browse it to figure out which options you'd like to tweak. The following
17921 two variables are probably the only ones you will want to change:
17923 @defvar nndiary-reminders
17924 This is the list of times when you want to be reminded of your
17925 appointments (e.g., 3 weeks before, then 2 days before, then 1 hour
17926 before and that's it). Remember that ``being reminded'' means that the
17927 diary message will pop up as brand new and unread again when you get new
17931 @defvar nndiary-week-starts-on-monday
17932 Rather self-explanatory. Otherwise, Sunday is assumed (this is the
17937 @node The Gnus Diary Library
17938 @subsection The Gnus Diary Library
17940 @cindex the gnus diary library
17942 Using @code{nndiary} manually (I mean, writing the headers by hand and
17943 so on) would be rather boring. Fortunately, there is a library called
17944 @code{gnus-diary} written on top of @code{nndiary}, that does many
17945 useful things for you.
17947 In order to use it, add the following line to your @file{~/.gnus.el} file:
17950 (require 'gnus-diary)
17953 Also, you shouldn't use any @code{gnus-user-format-function-[d|D]}
17954 (@pxref{Summary Buffer Lines}). @code{gnus-diary} provides both of these
17955 (sorry if you used them before).
17959 * Diary Summary Line Format:: A nicer summary buffer line format.
17960 * Diary Articles Sorting:: A nicer way to sort messages.
17961 * Diary Headers Generation:: Not doing it manually.
17962 * Diary Group Parameters:: Not handling them manually.
17965 @node Diary Summary Line Format
17966 @subsubsection Diary Summary Line Format
17967 @cindex diary summary buffer line
17968 @cindex diary summary line format
17970 Displaying diary messages in standard summary line format (usually
17971 something like @samp{From Joe: Subject}) is pretty useless. Most of
17972 the time, you're the one who wrote the message, and you mostly want to
17973 see the event's date.
17975 @code{gnus-diary} provides two supplemental user formats to be used in
17976 summary line formats. @code{D} corresponds to a formatted time string
17977 for the next occurrence of the event (e.g., ``Sat, Sep 22 01, 12:00''),
17978 while @code{d} corresponds to an approximate remaining time until the
17979 next occurrence of the event (e.g., ``in 6 months, 1 week'').
17981 For example, here's how Joe's birthday is displayed in my
17982 @code{nndiary+diary:birthdays} summary buffer (note that the message is
17983 expirable, but will never be deleted, as it specifies a periodic event):
17986 E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week)
17989 In order to get something like the above, you would normally add the
17990 following line to your diary groups'parameters:
17993 (gnus-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n")
17996 However, @code{gnus-diary} does it automatically (@pxref{Diary Group
17997 Parameters}). You can however customize the provided summary line format
17998 with the following user options:
18000 @defvar gnus-diary-summary-line-format
18001 Defines the summary line format used for diary groups (@pxref{Summary
18002 Buffer Lines}). @code{gnus-diary} uses it to automatically update the
18003 diary groups'parameters.
18006 @defvar gnus-diary-time-format
18007 Defines the format to display dates in diary summary buffers. This is
18008 used by the @code{D} user format. See the docstring for details.
18011 @defvar gnus-diary-delay-format-function
18012 Defines the format function to use for displaying delays (remaining
18013 times) in diary summary buffers. This is used by the @code{d} user
18014 format. There are currently built-in functions for English and French;
18015 you can also define your own. See the docstring for details.
18018 @node Diary Articles Sorting
18019 @subsubsection Diary Articles Sorting
18020 @cindex diary articles sorting
18021 @cindex diary summary lines sorting
18022 @findex gnus-summary-sort-by-schedule
18023 @findex gnus-thread-sort-by-schedule
18024 @findex gnus-article-sort-by-schedule
18026 @code{gnus-diary} provides new sorting functions (@pxref{Sorting the
18027 Summary Buffer} ) called @code{gnus-summary-sort-by-schedule},
18028 @code{gnus-thread-sort-by-schedule} and
18029 @code{gnus-article-sort-by-schedule}. These functions let you organize
18030 your diary summary buffers from the closest event to the farthest one.
18032 @code{gnus-diary} automatically installs
18033 @code{gnus-summary-sort-by-schedule} as a menu item in the summary
18034 buffer's ``sort'' menu, and the two others as the primary (hence
18035 default) sorting functions in the group parameters (@pxref{Diary Group
18038 @node Diary Headers Generation
18039 @subsubsection Diary Headers Generation
18040 @cindex diary headers generation
18041 @findex gnus-diary-check-message
18043 @code{gnus-diary} provides a function called
18044 @code{gnus-diary-check-message} to help you handle the @code{X-Diary-*}
18045 headers. This function ensures that the current message contains all the
18046 required diary headers, and prompts you for values or corrections if
18049 This function is hooked into the @code{nndiary} back end, so that
18050 moving or copying an article to a diary group will trigger it
18051 automatically. It is also bound to @kbd{C-c C-f d} in
18052 @code{message-mode} and @code{article-edit-mode} in order to ease the
18053 process of converting a usual mail to a diary one.
18055 This function takes a prefix argument which will force prompting of
18056 all diary headers, regardless of their presence or validity. That way,
18057 you can very easily reschedule an already valid diary message, for
18060 @node Diary Group Parameters
18061 @subsubsection Diary Group Parameters
18062 @cindex diary group parameters
18064 When you create a new diary group, or visit one, @code{gnus-diary}
18065 automatically checks your group parameters and if needed, sets the
18066 summary line format to the diary-specific value, installs the
18067 diary-specific sorting functions, and also adds the different
18068 @code{X-Diary-*} headers to the group's posting-style. It is then easier
18069 to send a diary message, because if you use @kbd{C-u a} or @kbd{C-u m}
18070 on a diary group to prepare a message, these headers will be inserted
18071 automatically (although not filled with proper values yet).
18073 @node Sending or Not Sending
18074 @subsection Sending or Not Sending
18076 Well, assuming you've read all of the above, here are two final notes on
18077 mail sending with @code{nndiary}:
18081 @code{nndiary} is a @emph{real} mail back end. You really send real diary
18082 messages for real. This means for instance that you can give
18083 appointments to anybody (provided they use Gnus and @code{nndiary}) by
18084 sending the diary message to them as well.
18086 However, since @code{nndiary} also has a @code{request-post} method, you
18087 can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the
18088 message won't actually be sent; just stored locally in the group. This
18089 comes in very handy for private appointments.
18092 @node Gnus Unplugged
18093 @section Gnus Unplugged
18098 @cindex Gnus unplugged
18100 In olden times (ca. February '88), people used to run their newsreaders
18101 on big machines with permanent connections to the net. News transport
18102 was dealt with by news servers, and all the newsreaders had to do was to
18103 read news. Believe it or not.
18105 Nowadays most people read news and mail at home, and use some sort of
18106 modem to connect to the net. To avoid running up huge phone bills, it
18107 would be nice to have a way to slurp down all the news and mail, hang up
18108 the phone, read for several hours, and then upload any responses you
18109 have to make. And then you repeat the procedure.
18111 Of course, you can use news servers for doing this as well. I've used
18112 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
18113 for some years, but doing that's a bore. Moving the news server
18114 functionality up to the newsreader makes sense if you're the only person
18115 reading news on a machine.
18117 Setting up Gnus as an ``offline'' newsreader is quite simple. In
18118 fact, you don't have to configure anything as the agent is now enabled
18119 by default (@pxref{Agent Variables, gnus-agent}).
18121 Of course, to use it as such, you have to learn a few new commands.
18124 * Agent Basics:: How it all is supposed to work.
18125 * Agent Categories:: How to tell the Gnus Agent what to download.
18126 * Agent Commands:: New commands for all the buffers.
18127 * Agent Visuals:: Ways that the agent may effect your summary buffer.
18128 * Agent as Cache:: The Agent is a big cache too.
18129 * Agent Expiry:: How to make old articles go away.
18130 * Agent Regeneration:: How to recover from lost connections and other accidents.
18131 * Agent and flags:: How the Agent maintains flags.
18132 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
18133 * Outgoing Messages:: What happens when you post/mail something?
18134 * Agent Variables:: Customizing is fun.
18135 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
18136 * Batching Agents:: How to fetch news from a @code{cron} job.
18137 * Agent Caveats:: What you think it'll do and what it does.
18142 @subsection Agent Basics
18144 First, let's get some terminology out of the way.
18146 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
18147 connection to the net (and notified the Agent that this is the case).
18148 When the connection to the net is up again (and Gnus knows this), the
18149 Agent is @dfn{plugged}.
18151 The @dfn{local} machine is the one you're running on, and which isn't
18152 connected to the net continuously.
18154 @dfn{Downloading} means fetching things from the net to your local
18155 machine. @dfn{Uploading} is doing the opposite.
18157 You know that Gnus gives you all the opportunity you'd ever want for
18158 shooting yourself in the foot. Some people call it flexibility. Gnus
18159 is also customizable to a great extent, which means that the user has a
18160 say on how Gnus behaves. Other newsreaders might unconditionally shoot
18161 you in your foot, but with Gnus, you have a choice!
18163 Gnus is never really in plugged or unplugged state. Rather, it applies
18164 that state to each server individually. This means that some servers
18165 can be plugged while others can be unplugged. Additionally, some
18166 servers can be ignored by the Agent altogether (which means that
18167 they're kinda like plugged always).
18169 So when you unplug the Agent and then wonder why is Gnus opening a
18170 connection to the Net, the next step to do is to look whether all
18171 servers are agentized. If there is an unagentized server, you found
18174 Another thing is the @dfn{offline} state. Sometimes, servers aren't
18175 reachable. When Gnus notices this, it asks you whether you want the
18176 server to be switched to offline state. If you say yes, then the
18177 server will behave somewhat as if it was unplugged, except that Gnus
18178 will ask you whether you want to switch it back online again.
18180 Let's take a typical Gnus session using the Agent.
18185 @findex gnus-unplugged
18186 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
18187 Agent in a disconnected state. You can read all the news that you have
18188 already fetched while in this mode.
18191 You then decide to see whether any new news has arrived. You connect
18192 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
18193 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
18194 as usual. To check for new mail in unplugged mode (@pxref{Mail
18195 Source Specifiers}).
18198 You can then read the new news immediately, or you can download the
18199 news onto your local machine. If you want to do the latter, you press
18200 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
18201 all the eligible articles in all the groups. (To let Gnus know which
18202 articles you want to download, @pxref{Agent Categories}).
18205 After fetching the articles, you press @kbd{J j} to make Gnus become
18206 unplugged again, and you shut down the PPP thing (or whatever). And
18207 then you read the news offline.
18210 And then you go to step 2.
18213 Here are some things you should do the first time (or so) that you use
18219 Decide which servers should be covered by the Agent. If you have a mail
18220 back end, it would probably be nonsensical to have it covered by the
18221 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
18222 @kbd{J a} on the server (or servers) that you wish to have covered by the
18223 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
18224 added servers you do not wish to have covered by the Agent. By default,
18225 no servers are agentized.
18228 Decide on download policy. It's fairly simple once you decide whether
18229 you are going to use agent categories, topic parameters, and/or group
18230 parameters to implement your policy. If you're new to gnus, it
18231 is probably best to start with a category, @xref{Agent Categories}.
18233 Both topic parameters (@pxref{Topic Parameters}) and agent categories
18234 (@pxref{Agent Categories}) provide for setting a policy that applies
18235 to multiple groups. Which you use is entirely up to you. Topic
18236 parameters do override categories so, if you mix the two, you'll have
18237 to take that into account. If you have a few groups that deviate from
18238 your policy, you can use group parameters (@pxref{Group Parameters}) to
18242 Uhm@dots{} that's it.
18246 @node Agent Categories
18247 @subsection Agent Categories
18249 One of the main reasons to integrate the news transport layer into the
18250 newsreader is to allow greater control over what articles to download.
18251 There's not much point in downloading huge amounts of articles, just to
18252 find out that you're not interested in reading any of them. It's better
18253 to be somewhat more conservative in choosing what to download, and then
18254 mark the articles for downloading manually if it should turn out that
18255 you're interested in the articles anyway.
18257 One of the more effective methods for controlling what is to be
18258 downloaded is to create a @dfn{category} and then assign some (or all)
18259 groups to this category. Groups that do not belong in any other
18260 category belong to the @code{default} category. Gnus has its own
18261 buffer for creating and managing categories.
18263 If you prefer, you can also use group parameters (@pxref{Group
18264 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
18265 alternative approach to controlling the agent. The only real
18266 difference is that categories are specific to the agent (so there is
18267 less to learn) while group and topic parameters include the kitchen
18270 Since you can set agent parameters in several different places we have
18271 a rule to decide which source to believe. This rule specifies that
18272 the parameter sources are checked in the following order: group
18273 parameters, topic parameters, agent category, and finally customizable
18274 variables. So you can mix all of these sources to produce a wide range
18275 of behavior, just don't blame me if you don't remember where you put
18279 * Category Syntax:: What a category looks like.
18280 * Category Buffer:: A buffer for maintaining categories.
18281 * Category Variables:: Customize'r'Us.
18285 @node Category Syntax
18286 @subsubsection Category Syntax
18288 A category consists of a name, the list of groups belonging to the
18289 category, and a number of optional parameters that override the
18290 customizable variables. The complete list of agent parameters are
18293 @cindex Agent Parameters
18296 The list of groups that are in this category.
18298 @item agent-predicate
18299 A predicate which (generally) gives a rough outline of which articles
18300 are eligible for downloading; and
18303 a score rule which (generally) gives you a finer granularity when
18304 deciding what articles to download. (Note that this @dfn{download
18305 score} is not necessarily related to normal scores.)
18307 @item agent-enable-expiration
18308 a boolean indicating whether the agent should expire old articles in
18309 this group. Most groups should be expired to conserve disk space. In
18310 fact, its probably safe to say that the gnus.* hierarchy contains the
18311 only groups that should not be expired.
18313 @item agent-days-until-old
18314 an integer indicating the number of days that the agent should wait
18315 before deciding that a read article is safe to expire.
18317 @item agent-low-score
18318 an integer that overrides the value of @code{gnus-agent-low-score}.
18320 @item agent-high-score
18321 an integer that overrides the value of @code{gnus-agent-high-score}.
18323 @item agent-short-article
18324 an integer that overrides the value of
18325 @code{gnus-agent-short-article}.
18327 @item agent-long-article
18328 an integer that overrides the value of @code{gnus-agent-long-article}.
18330 @item agent-enable-undownloaded-faces
18331 a symbol indicating whether the summary buffer should display
18332 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
18333 faces. Any symbol other than @code{nil} will enable the use of
18334 undownloaded faces.
18337 The name of a category can not be changed once the category has been
18340 Each category maintains a list of groups that are exclusive members of
18341 that category. The exclusivity rule is automatically enforced, add a
18342 group to a new category and it is automatically removed from its old
18345 A predicate in its simplest form can be a single predicate such as
18346 @code{true} or @code{false}. These two will download every available
18347 article or nothing respectively. In the case of these two special
18348 predicates an additional score rule is superfluous.
18350 Predicates of @code{high} or @code{low} download articles in respect of
18351 their scores in relationship to @code{gnus-agent-high-score} and
18352 @code{gnus-agent-low-score} as described below.
18354 To gain even finer control of what is to be regarded eligible for
18355 download a predicate can consist of a number of predicates with logical
18356 operators sprinkled in between.
18358 Perhaps some examples are in order.
18360 Here's a simple predicate. (It's the default predicate, in fact, used
18361 for all groups that don't belong to any other category.)
18367 Quite simple, eh? This predicate is true if and only if the article is
18368 short (for some value of ``short'').
18370 Here's a more complex predicate:
18379 This means that an article should be downloaded if it has a high score,
18380 or if the score is not low and the article is not long. You get the
18383 The available logical operators are @code{or}, @code{and} and
18384 @code{not}. (If you prefer, you can use the more ``C''-ish operators
18385 @samp{|}, @code{&} and @code{!} instead.)
18387 The following predicates are pre-defined, but if none of these fit what
18388 you want to do, you can write your own.
18390 When evaluating each of these predicates, the named constant will be
18391 bound to the value determined by calling
18392 @code{gnus-agent-find-parameter} on the appropriate parameter. For
18393 example, gnus-agent-short-article will be bound to
18394 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
18395 means that you can specify a predicate in your category then tune that
18396 predicate to individual groups.
18400 True if the article is shorter than @code{gnus-agent-short-article}
18401 lines; default 100.
18404 True if the article is longer than @code{gnus-agent-long-article}
18405 lines; default 200.
18408 True if the article has a download score less than
18409 @code{gnus-agent-low-score}; default 0.
18412 True if the article has a download score greater than
18413 @code{gnus-agent-high-score}; default 0.
18416 True if the Gnus Agent guesses that the article is spam. The
18417 heuristics may change over time, but at present it just computes a
18418 checksum and sees whether articles match.
18427 If you want to create your own predicate function, here's what you have
18428 to know: The functions are called with no parameters, but the
18429 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
18432 For example, you could decide that you don't want to download articles
18433 that were posted more than a certain number of days ago (e.g., posted
18434 more than @code{gnus-agent-expire-days} ago) you might write a function
18435 something along the lines of the following:
18438 (defun my-article-old-p ()
18439 "Say whether an article is old."
18440 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
18441 (- (time-to-days (current-time)) gnus-agent-expire-days)))
18444 with the predicate then defined as:
18447 (not my-article-old-p)
18450 or you could append your predicate to the predefined
18451 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
18455 (require 'gnus-agent)
18456 (setq gnus-category-predicate-alist
18457 (append gnus-category-predicate-alist
18458 '((old . my-article-old-p))))
18461 and simply specify your predicate as:
18467 If/when using something like the above, be aware that there are many
18468 misconfigured systems/mailers out there and so an article's date is not
18469 always a reliable indication of when it was posted. Hell, some people
18470 just don't give a damn.
18472 The above predicates apply to @emph{all} the groups which belong to the
18473 category. However, if you wish to have a specific predicate for an
18474 individual group within a category, or you're just too lazy to set up a
18475 new category, you can enter a group's individual predicate in its group
18476 parameters like so:
18479 (agent-predicate . short)
18482 This is the group/topic parameter equivalent of the agent category default.
18483 Note that when specifying a single word predicate like this, the
18484 @code{agent-predicate} specification must be in dotted pair notation.
18486 The equivalent of the longer example from above would be:
18489 (agent-predicate or high (and (not low) (not long)))
18492 The outer parenthesis required in the category specification are not
18493 entered here as, not being in dotted pair notation, the value of the
18494 predicate is assumed to be a list.
18497 Now, the syntax of the download score is the same as the syntax of
18498 normal score files, except that all elements that require actually
18499 seeing the article itself are verboten. This means that only the
18500 following headers can be scored on: @code{Subject}, @code{From},
18501 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
18502 @code{Lines}, and @code{Xref}.
18504 As with predicates, the specification of the @code{download score rule}
18505 to use in respect of a group can be in either the category definition if
18506 it's to be applicable to all groups in therein, or a group's parameters
18507 if it's to be specific to that group.
18509 In both of these places the @code{download score rule} can take one of
18516 This has the same syntax as a normal Gnus score file except only a
18517 subset of scoring keywords are available as mentioned above.
18523 Category specification
18527 ("Lars Ingebrigtsen" 1000000 nil s))
18533 Group/Topic Parameter specification
18536 (agent-score ("from"
18537 ("Lars Ingebrigtsen" 1000000 nil s))
18542 Again, note the omission of the outermost parenthesis here.
18548 These score files must @emph{only} contain the permitted scoring
18549 keywords stated above.
18555 Category specification
18558 ("~/News/agent.SCORE")
18564 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
18568 Group Parameter specification
18571 (agent-score "~/News/agent.SCORE")
18574 Additional score files can be specified as above. Need I say anything
18579 Use @code{normal} score files
18581 If you don't want to maintain two sets of scoring rules for a group, and
18582 your desired @code{downloading} criteria for a group are the same as your
18583 @code{reading} criteria then you can tell the agent to refer to your
18584 @code{normal} score files when deciding what to download.
18586 These directives in either the category definition or a group's
18587 parameters will cause the agent to read in all the applicable score
18588 files for a group, @emph{filtering out} those sections that do not
18589 relate to one of the permitted subset of scoring keywords.
18593 Category Specification
18600 Group Parameter specification
18603 (agent-score . file)
18608 @node Category Buffer
18609 @subsubsection Category Buffer
18611 You'd normally do all category maintenance from the category buffer.
18612 When you enter it for the first time (with the @kbd{J c} command from
18613 the group buffer), you'll only see the @code{default} category.
18615 The following commands are available in this buffer:
18619 @kindex q (Category)
18620 @findex gnus-category-exit
18621 Return to the group buffer (@code{gnus-category-exit}).
18624 @kindex e (Category)
18625 @findex gnus-category-customize-category
18626 Use a customization buffer to set all of the selected category's
18627 parameters at one time (@code{gnus-category-customize-category}).
18630 @kindex k (Category)
18631 @findex gnus-category-kill
18632 Kill the current category (@code{gnus-category-kill}).
18635 @kindex c (Category)
18636 @findex gnus-category-copy
18637 Copy the current category (@code{gnus-category-copy}).
18640 @kindex a (Category)
18641 @findex gnus-category-add
18642 Add a new category (@code{gnus-category-add}).
18645 @kindex p (Category)
18646 @findex gnus-category-edit-predicate
18647 Edit the predicate of the current category
18648 (@code{gnus-category-edit-predicate}).
18651 @kindex g (Category)
18652 @findex gnus-category-edit-groups
18653 Edit the list of groups belonging to the current category
18654 (@code{gnus-category-edit-groups}).
18657 @kindex s (Category)
18658 @findex gnus-category-edit-score
18659 Edit the download score rule of the current category
18660 (@code{gnus-category-edit-score}).
18663 @kindex l (Category)
18664 @findex gnus-category-list
18665 List all the categories (@code{gnus-category-list}).
18669 @node Category Variables
18670 @subsubsection Category Variables
18673 @item gnus-category-mode-hook
18674 @vindex gnus-category-mode-hook
18675 Hook run in category buffers.
18677 @item gnus-category-line-format
18678 @vindex gnus-category-line-format
18679 Format of the lines in the category buffer (@pxref{Formatting
18680 Variables}). Valid elements are:
18684 The name of the category.
18687 The number of groups in the category.
18690 @item gnus-category-mode-line-format
18691 @vindex gnus-category-mode-line-format
18692 Format of the category mode line (@pxref{Mode Line Formatting}).
18694 @item gnus-agent-short-article
18695 @vindex gnus-agent-short-article
18696 Articles that have fewer lines than this are short. Default 100.
18698 @item gnus-agent-long-article
18699 @vindex gnus-agent-long-article
18700 Articles that have more lines than this are long. Default 200.
18702 @item gnus-agent-low-score
18703 @vindex gnus-agent-low-score
18704 Articles that have a score lower than this have a low score. Default
18707 @item gnus-agent-high-score
18708 @vindex gnus-agent-high-score
18709 Articles that have a score higher than this have a high score. Default
18712 @item gnus-agent-expire-days
18713 @vindex gnus-agent-expire-days
18714 The number of days that a @samp{read} article must stay in the agent's
18715 local disk before becoming eligible for expiration (While the name is
18716 the same, this doesn't mean expiring the article on the server. It
18717 just means deleting the local copy of the article). What is also
18718 important to understand is that the counter starts with the time the
18719 article was written to the local disk and not the time the article was
18723 @item gnus-agent-enable-expiration
18724 @vindex gnus-agent-enable-expiration
18725 Determines whether articles in a group are, by default, expired or
18726 retained indefinitely. The default is @code{ENABLE} which means that
18727 you'll have to disable expiration when desired. On the other hand,
18728 you could set this to @code{DISABLE}. In that case, you would then
18729 have to enable expiration in selected groups.
18734 @node Agent Commands
18735 @subsection Agent Commands
18736 @findex gnus-agent-toggle-plugged
18737 @kindex J j (Agent)
18739 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
18740 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18741 toggles the plugged/unplugged state of the Gnus Agent.
18745 * Group Agent Commands:: Configure groups and fetch their contents.
18746 * Summary Agent Commands:: Manually select then fetch specific articles.
18747 * Server Agent Commands:: Select the servers that are supported by the agent.
18753 @node Group Agent Commands
18754 @subsubsection Group Agent Commands
18758 @kindex J u (Agent Group)
18759 @findex gnus-agent-fetch-groups
18760 Fetch all eligible articles in the current group
18761 (@code{gnus-agent-fetch-groups}).
18764 @kindex J c (Agent Group)
18765 @findex gnus-enter-category-buffer
18766 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18769 @kindex J s (Agent Group)
18770 @findex gnus-agent-fetch-session
18771 Fetch all eligible articles in all groups
18772 (@code{gnus-agent-fetch-session}).
18775 @kindex J S (Agent Group)
18776 @findex gnus-group-send-queue
18777 Send all sendable messages in the queue group
18778 (@code{gnus-group-send-queue}). @xref{Drafts}.
18781 @kindex J a (Agent Group)
18782 @findex gnus-agent-add-group
18783 Add the current group to an Agent category
18784 (@code{gnus-agent-add-group}). This command understands the
18785 process/prefix convention (@pxref{Process/Prefix}).
18788 @kindex J r (Agent Group)
18789 @findex gnus-agent-remove-group
18790 Remove the current group from its category, if any
18791 (@code{gnus-agent-remove-group}). This command understands the
18792 process/prefix convention (@pxref{Process/Prefix}).
18795 @kindex J Y (Agent Group)
18796 @findex gnus-agent-synchronize-flags
18797 Synchronize flags changed while unplugged with remote server, if any.
18803 @node Summary Agent Commands
18804 @subsubsection Summary Agent Commands
18808 @kindex J # (Agent Summary)
18809 @findex gnus-agent-mark-article
18810 Mark the article for downloading (@code{gnus-agent-mark-article}).
18813 @kindex J M-# (Agent Summary)
18814 @findex gnus-agent-unmark-article
18815 Remove the downloading mark from the article
18816 (@code{gnus-agent-unmark-article}).
18820 @kindex @@ (Agent Summary)
18821 @findex gnus-agent-toggle-mark
18822 Toggle whether to download the article
18823 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
18827 @kindex J c (Agent Summary)
18828 @findex gnus-agent-catchup
18829 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18832 @kindex J S (Agent Summary)
18833 @findex gnus-agent-fetch-group
18834 Download all eligible (@pxref{Agent Categories}) articles in this group.
18835 (@code{gnus-agent-fetch-group}).
18838 @kindex J s (Agent Summary)
18839 @findex gnus-agent-summary-fetch-series
18840 Download all processable articles in this group.
18841 (@code{gnus-agent-summary-fetch-series}).
18844 @kindex J u (Agent Summary)
18845 @findex gnus-agent-summary-fetch-group
18846 Download all downloadable articles in the current group
18847 (@code{gnus-agent-summary-fetch-group}).
18852 @node Server Agent Commands
18853 @subsubsection Server Agent Commands
18857 @kindex J a (Agent Server)
18858 @findex gnus-agent-add-server
18859 Add the current server to the list of servers covered by the Gnus Agent
18860 (@code{gnus-agent-add-server}).
18863 @kindex J r (Agent Server)
18864 @findex gnus-agent-remove-server
18865 Remove the current server from the list of servers covered by the Gnus
18866 Agent (@code{gnus-agent-remove-server}).
18871 @node Agent Visuals
18872 @subsection Agent Visuals
18874 If you open a summary while unplugged and, Gnus knows from the group's
18875 active range that there are more articles than the headers currently
18876 stored in the Agent, you may see some articles whose subject looks
18877 something like @samp{[Undownloaded article #####]}. These are
18878 placeholders for the missing headers. Aside from setting a mark,
18879 there is not much that can be done with one of these placeholders.
18880 When Gnus finally gets a chance to fetch the group's headers, the
18881 placeholders will automatically be replaced by the actual headers.
18882 You can configure the summary buffer's maneuvering to skip over the
18883 placeholders if you care (See @code{gnus-auto-goto-ignores}).
18885 While it may be obvious to all, the only headers and articles
18886 available while unplugged are those headers and articles that were
18887 fetched into the Agent while previously plugged. To put it another
18888 way, ``If you forget to fetch something while plugged, you might have a
18889 less than satisfying unplugged session''. For this reason, the Agent
18890 adds two visual effects to your summary buffer. These effects display
18891 the download status of each article so that you always know which
18892 articles will be available when unplugged.
18894 The first visual effect is the @samp{%O} spec. If you customize
18895 @code{gnus-summary-line-format} to include this specifier, you will add
18896 a single character field that indicates an article's download status.
18897 Articles that have been fetched into either the Agent or the Cache,
18898 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
18899 other articles will display @code{gnus-undownloaded-mark} (defaults to
18900 @samp{-}). If you open a group that has not been agentized, a space
18901 (@samp{ }) will be displayed.
18903 The second visual effect are the undownloaded faces. The faces, there
18904 are three indicating the article's score (low, normal, high), seem to
18905 result in a love/hate response from many Gnus users. The problem is
18906 that the face selection is controlled by a list of condition tests and
18907 face names (See @code{gnus-summary-highlight}). Each condition is
18908 tested in the order in which it appears in the list so early
18909 conditions have precedence over later conditions. All of this means
18910 that, if you tick an undownloaded article, the article will continue
18911 to be displayed in the undownloaded face rather than the ticked face.
18913 If you use the Agent as a cache (to avoid downloading the same article
18914 each time you visit it or to minimize your connection time), the
18915 undownloaded face will probably seem like a good idea. The reason
18916 being that you do all of our work (marking, reading, deleting) with
18917 downloaded articles so the normal faces always appear. For those
18918 users using the agent to improve online performance by caching the NOV
18919 database (most users since 5.10.2), the undownloaded faces may appear
18920 to be an absolutely horrible idea. The issue being that, since none
18921 of their articles have been fetched into the Agent, all of the
18922 normal faces will be obscured by the undownloaded faces.
18924 If you would like to use the undownloaded faces, you must enable the
18925 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
18926 group parameter to @code{t}. This parameter, like all other agent
18927 parameters, may be set on an Agent Category (@pxref{Agent Categories}),
18928 a Group Topic (@pxref{Topic Parameters}), or an individual group
18929 (@pxref{Group Parameters}).
18931 The one problem common to all users using the agent is how quickly it
18932 can consume disk space. If you using the agent on many groups, it is
18933 even more difficult to effectively recover disk space. One solution
18934 is the @samp{%F} format available in @code{gnus-group-line-format}.
18935 This format will display the actual disk space used by articles
18936 fetched into both the agent and cache. By knowing which groups use
18937 the most space, users know where to focus their efforts when ``agent
18938 expiring'' articles.
18940 @node Agent as Cache
18941 @subsection Agent as Cache
18943 When Gnus is plugged, it is not efficient to download headers or
18944 articles from the server again, if they are already stored in the
18945 Agent. So, Gnus normally only downloads headers once, and stores them
18946 in the Agent. These headers are later used when generating the summary
18947 buffer, regardless of whether you are plugged or unplugged. Articles
18948 are not cached in the Agent by default though (that would potentially
18949 consume lots of disk space), but if you have already downloaded an
18950 article into the Agent, Gnus will not download the article from the
18951 server again but use the locally stored copy instead.
18953 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
18954 @pxref{Agent Variables}) to always download headers and articles while
18955 plugged. Gnus will almost certainly be slower, but it will be kept
18956 synchronized with the server. That last point probably won't make any
18957 sense if you are using a nntp or nnimap back end.
18960 @subsection Agent Expiry
18962 @vindex gnus-agent-expire-days
18963 @findex gnus-agent-expire
18964 @kindex M-x gnus-agent-expire
18965 @kindex M-x gnus-agent-expire-group
18966 @findex gnus-agent-expire-group
18967 @cindex agent expiry
18968 @cindex Gnus agent expiry
18969 @cindex expiry, in Gnus agent
18971 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
18972 least it doesn't handle it like other back ends. Instead, there are
18973 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
18974 commands that will expire all read articles that are older than
18975 @code{gnus-agent-expire-days} days. They can be run whenever you feel
18976 that you're running out of space. Neither are particularly fast or
18977 efficient, and it's not a particularly good idea to interrupt them (with
18978 @kbd{C-g} or anything else) once you've started one of them.
18980 Note that other functions might run @code{gnus-agent-expire} for you
18981 to keep the agent synchronized with the group.
18983 The agent parameter @code{agent-enable-expiration} may be used to
18984 prevent expiration in selected groups.
18986 @vindex gnus-agent-expire-all
18987 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
18988 expiration commands will expire all articles---unread, read, ticked
18989 and dormant. If @code{nil} (which is the default), only read articles
18990 are eligible for expiry, and unread, ticked and dormant articles will
18991 be kept indefinitely.
18993 If you find that some articles eligible for expiry are never expired,
18994 perhaps some Gnus Agent files are corrupted. There's are special
18995 commands, @code{gnus-agent-regenerate} and
18996 @code{gnus-agent-regenerate-group}, to fix possible problems.
18998 @node Agent Regeneration
18999 @subsection Agent Regeneration
19001 @cindex agent regeneration
19002 @cindex Gnus agent regeneration
19003 @cindex regeneration
19005 The local data structures used by @code{nnagent} may become corrupted
19006 due to certain exceptional conditions. When this happens,
19007 @code{nnagent} functionality may degrade or even fail. The solution
19008 to this problem is to repair the local data structures by removing all
19009 internal inconsistencies.
19011 For example, if your connection to your server is lost while
19012 downloaded articles into the agent, the local data structures will not
19013 know about articles successfully downloaded prior to the connection
19014 failure. Running @code{gnus-agent-regenerate} or
19015 @code{gnus-agent-regenerate-group} will update the data structures
19016 such that you don't need to download these articles a second time.
19018 @findex gnus-agent-regenerate
19019 @kindex M-x gnus-agent-regenerate
19020 The command @code{gnus-agent-regenerate} will perform
19021 @code{gnus-agent-regenerate-group} on every agentized group. While
19022 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
19023 recommended that you first close all summary buffers.
19025 @findex gnus-agent-regenerate-group
19026 @kindex M-x gnus-agent-regenerate-group
19027 The command @code{gnus-agent-regenerate-group} uses the local copies
19028 of individual articles to repair the local @acronym{NOV}(header) database. It
19029 then updates the internal data structures that document which articles
19030 are stored locally. An optional argument will mark articles in the
19033 @node Agent and flags
19034 @subsection Agent and flags
19036 The Agent works with any Gnus back end including those, such as
19037 nnimap, that store flags (read, ticked, etc.)@: on the server. Sadly,
19038 the Agent does not actually know which backends keep their flags in
19039 the backend server rather than in @file{.newsrc}. This means that the
19040 Agent, while unplugged or disconnected, will always record all changes
19041 to the flags in its own files.
19043 When you plug back in, Gnus will then check to see if you have any
19044 changed any flags and ask if you wish to synchronize these with the
19045 server. This behavior is customizable by @code{gnus-agent-synchronize-flags}.
19047 @vindex gnus-agent-synchronize-flags
19048 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19049 never automatically synchronize flags. If it is @code{ask}, which is
19050 the default, the Agent will check if you made any changes and if so
19051 ask if you wish to synchronize these when you re-connect. If it has
19052 any other value, all flags will be synchronized automatically.
19054 If you do not wish to synchronize flags automatically when you
19055 re-connect, you can do it manually with the
19056 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
19057 in the group buffer.
19059 Technical note: the synchronization algorithm does not work by ``pushing''
19060 all local flags to the server, but rather by incrementally updated the
19061 server view of flags by changing only those flags that were changed by
19062 the user. Thus, if you set one flag on an article, quit the group then
19063 re-select the group and remove the flag; the flag will be set and
19064 removed from the server when you ``synchronize''. The queued flag
19065 operations can be found in the per-server @code{flags} file in the Agent
19066 directory. It's emptied when you synchronize flags.
19068 @node Agent and IMAP
19069 @subsection Agent and IMAP
19071 The Agent works with any Gnus back end, including nnimap. However,
19072 since there are some conceptual differences between @acronym{NNTP} and
19073 @acronym{IMAP}, this section (should) provide you with some information to
19074 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
19076 Some things are currently not implemented in the Agent that you'd might
19077 expect from a disconnected @acronym{IMAP} client, including:
19082 Copying/moving articles into nnimap groups when unplugged.
19085 Creating/deleting nnimap groups when unplugged.
19089 @node Outgoing Messages
19090 @subsection Outgoing Messages
19092 By default, when Gnus is unplugged, all outgoing messages (both mail
19093 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
19094 You can view them there after posting, and edit them at will.
19096 You can control the circumstances under which outgoing mail is queued
19097 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
19098 news is always queued when Gnus is unplugged, and never otherwise.
19100 You can send the messages either from the draft group with the special
19101 commands available there, or you can use the @kbd{J S} command in the
19102 group buffer to send all the sendable messages in the draft group.
19103 Posting news will only work when Gnus is plugged, but you can send
19106 If sending mail while unplugged does not work for you and you worry
19107 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
19108 ask you to confirm your action (see
19109 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
19111 @node Agent Variables
19112 @subsection Agent Variables
19117 Is the agent enabled? The default is @code{t}. When first enabled,
19118 the agent will use @code{gnus-agent-auto-agentize-methods} to
19119 automatically mark some back ends as agentized. You may change which
19120 back ends are agentized using the agent commands in the server buffer.
19122 To enter the server buffer, use the @kbd{^}
19123 (@code{gnus-group-enter-server-mode}) command in the group buffer.
19126 @item gnus-agent-directory
19127 @vindex gnus-agent-directory
19128 Where the Gnus Agent will store its files. The default is
19129 @file{~/News/agent/}.
19131 @item gnus-agent-handle-level
19132 @vindex gnus-agent-handle-level
19133 Groups on levels (@pxref{Group Levels}) higher than this variable will
19134 be ignored by the Agent. The default is @code{gnus-level-subscribed},
19135 which means that only subscribed group will be considered by the Agent
19138 @item gnus-agent-plugged-hook
19139 @vindex gnus-agent-plugged-hook
19140 Hook run when connecting to the network.
19142 @item gnus-agent-unplugged-hook
19143 @vindex gnus-agent-unplugged-hook
19144 Hook run when disconnecting from the network.
19146 @item gnus-agent-fetched-hook
19147 @vindex gnus-agent-fetched-hook
19148 Hook run when finished fetching articles.
19150 @item gnus-agent-cache
19151 @vindex gnus-agent-cache
19152 Variable to control whether use the locally stored @acronym{NOV} and
19153 articles when plugged, e.g., essentially using the Agent as a cache.
19154 The default is non-@code{nil}, which means to use the Agent as a cache.
19156 @item gnus-agent-go-online
19157 @vindex gnus-agent-go-online
19158 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
19159 automatically switch offline servers into online status. If it is
19160 @code{ask}, the default, the Agent will ask if you wish to switch
19161 offline servers into online status when you re-connect. If it has any
19162 other value, all offline servers will be automatically switched into
19165 @item gnus-agent-mark-unread-after-downloaded
19166 @vindex gnus-agent-mark-unread-after-downloaded
19167 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
19168 mark articles as unread after downloading. This is usually a safe
19169 thing to do as the newly downloaded article has obviously not been
19170 read. The default is @code{t}.
19172 @item gnus-agent-synchronize-flags
19173 @vindex gnus-agent-synchronize-flags
19174 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19175 never automatically synchronize flags. If it is @code{ask}, which is
19176 the default, the Agent will check if you made any changes and if so
19177 ask if you wish to synchronize these when you re-connect. If it has
19178 any other value, all flags will be synchronized automatically.
19180 @item gnus-agent-consider-all-articles
19181 @vindex gnus-agent-consider-all-articles
19182 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
19183 agent will let the agent predicate decide whether articles need to be
19184 downloaded or not, for all articles. When @code{nil}, the default,
19185 the agent will only let the predicate decide whether unread articles
19186 are downloaded or not. If you enable this, you may also want to look
19187 into the agent expiry settings (@pxref{Category Variables}), so that
19188 the agent doesn't download articles which the agent will later expire,
19189 over and over again.
19191 @item gnus-agent-max-fetch-size
19192 @vindex gnus-agent-max-fetch-size
19193 The agent fetches articles into a temporary buffer prior to parsing
19194 them into individual files. To avoid exceeding the max. buffer size,
19195 the agent alternates between fetching and parsing until all articles
19196 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
19197 limit to control how often the cycling occurs. A large value improves
19198 performance. A small value minimizes the time lost should the
19199 connection be lost while fetching (You may need to run
19200 @code{gnus-agent-regenerate-group} to update the group's state.
19201 However, all articles parsed prior to losing the connection will be
19202 available while unplugged). The default is 10M so it is unusual to
19205 @item gnus-server-unopen-status
19206 @vindex gnus-server-unopen-status
19207 Perhaps not an Agent variable, but closely related to the Agent, this
19208 variable says what will happen if Gnus cannot open a server. If the
19209 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
19210 whether to deny the server or whether to unplug the agent. If the
19211 Agent is disabled, Gnus always simply deny the server. Other choices
19212 for this variable include @code{denied} and @code{offline} the latter
19213 is only valid if the Agent is used.
19215 @item gnus-auto-goto-ignores
19216 @vindex gnus-auto-goto-ignores
19217 Another variable that isn't an Agent variable, yet so closely related
19218 that most will look for it here, this variable tells the summary
19219 buffer how to maneuver around undownloaded (only headers stored in the
19220 agent) and unfetched (neither article nor headers stored) articles.
19222 The valid values are @code{nil} (maneuver to any article),
19223 @code{undownloaded} (maneuvering while unplugged ignores articles that
19224 have not been fetched), @code{always-undownloaded} (maneuvering always
19225 ignores articles that have not been fetched), @code{unfetched}
19226 (maneuvering ignores articles whose headers have not been fetched).
19228 @item gnus-agent-queue-mail
19229 @vindex gnus-agent-queue-mail
19230 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
19231 queue mail rather than sending it straight away. When @code{t}, Gnus
19232 will queue mail when unplugged only. When @code{nil}, never queue
19233 mail. The default is @code{t}.
19235 @item gnus-agent-prompt-send-queue
19236 @vindex gnus-agent-prompt-send-queue
19237 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
19238 prompt you to confirm that you really wish to proceed if you hit
19239 @kbd{J S} while unplugged. The default is @code{nil}.
19241 @item gnus-agent-auto-agentize-methods
19242 @vindex gnus-agent-auto-agentize-methods
19243 If you have never used the Agent before (or more technically, if
19244 @file{~/News/agent/lib/servers} does not exist), Gnus will
19245 automatically agentize a few servers for you. This variable control
19246 which back ends should be auto-agentized. It is typically only useful
19247 to agentize remote back ends. The auto-agentizing has the same effect
19248 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
19249 If the file exist, you must manage the servers manually by adding or
19250 removing them, this variable is only applicable the first time you
19251 start Gnus. The default is @samp{nil}.
19256 @node Example Setup
19257 @subsection Example Setup
19259 If you don't want to read this manual, and you have a fairly standard
19260 setup, you may be able to use something like the following as your
19261 @file{~/.gnus.el} file to get started.
19264 ;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
19265 ;; @r{from your ISP's server.}
19266 (setq gnus-select-method '(nntp "news.your-isp.com"))
19268 ;; @r{Define how Gnus is to read your mail. We read mail from}
19269 ;; @r{your ISP's @acronym{POP} server.}
19270 (setq mail-sources '((pop :server "pop.your-isp.com")))
19272 ;; @r{Say how Gnus is to store the mail. We use nnml groups.}
19273 (setq gnus-secondary-select-methods '((nnml "")))
19275 ;; @r{Make Gnus into an offline newsreader.}
19276 ;; (gnus-agentize) ; @r{The obsolete setting.}
19277 ;; (setq gnus-agent t) ; @r{Now the default.}
19280 That should be it, basically. Put that in your @file{~/.gnus.el} file,
19281 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
19284 If this is the first time you've run Gnus, you will be subscribed
19285 automatically to a few default newsgroups. You'll probably want to
19286 subscribe to more groups, and to do that, you have to query the
19287 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
19288 command. This usually takes quite a while, but you only have to do it
19291 After reading and parsing a while, you'll be presented with a list of
19292 groups. Subscribe to the ones you want to read with the @kbd{u}
19293 command. @kbd{l} to make all the killed groups disappear after you've
19294 subscribe to all the groups you want to read. (@kbd{A k} will bring
19295 back all the killed groups.)
19297 You can now read the groups at once, or you can download the articles
19298 with the @kbd{J s} command. And then read the rest of this manual to
19299 find out which of the other gazillion things you want to customize.
19302 @node Batching Agents
19303 @subsection Batching Agents
19304 @findex gnus-agent-batch
19306 Having the Gnus Agent fetch articles (and post whatever messages you've
19307 written) is quite easy once you've gotten things set up properly. The
19308 following shell script will do everything that is necessary:
19310 You can run a complete batch command from the command line with the
19311 following incantation:
19315 emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-agent-batch >/dev/null 2>&1
19319 @node Agent Caveats
19320 @subsection Agent Caveats
19322 The Gnus Agent doesn't seem to work like most other offline
19323 newsreaders. Here are some common questions that some imaginary people
19327 @item If I read an article while plugged, do they get entered into the Agent?
19329 @strong{No}. If you want this behavior, add
19330 @code{gnus-agent-fetch-selected-article} to
19331 @code{gnus-select-article-hook}.
19333 @item If I read an article while plugged, and the article already exists in
19334 the Agent, will it get downloaded once more?
19336 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
19340 In short, when Gnus is unplugged, it only looks into the locally stored
19341 articles; when it's plugged, it talks to your ISP and may also use the
19342 locally stored articles.
19349 Other people use @dfn{kill files}, but we here at Gnus Towers like
19350 scoring better than killing, so we'd rather switch than fight. They do
19351 something completely different as well, so sit up straight and pay
19354 @vindex gnus-summary-mark-below
19355 All articles have a default score (@code{gnus-summary-default-score}),
19356 which is 0 by default. This score may be raised or lowered either
19357 interactively or by score files. Articles that have a score lower than
19358 @code{gnus-summary-mark-below} are marked as read.
19360 Gnus will read any @dfn{score files} that apply to the current group
19361 before generating the summary buffer.
19363 There are several commands in the summary buffer that insert score
19364 entries based on the current article. You can, for instance, ask Gnus to
19365 lower or increase the score of all articles with a certain subject.
19367 There are two sorts of scoring entries: Permanent and temporary.
19368 Temporary score entries are self-expiring entries. Any entries that are
19369 temporary and have not been used for, say, a week, will be removed
19370 silently to help keep the sizes of the score files down.
19373 * Summary Score Commands:: Adding score entries for the current group.
19374 * Group Score Commands:: General score commands.
19375 * Score Variables:: Customize your scoring. (My, what terminology).
19376 * Score File Format:: What a score file may contain.
19377 * Score File Editing:: You can edit score files by hand as well.
19378 * Adaptive Scoring:: Big Sister Gnus knows what you read.
19379 * Home Score File:: How to say where new score entries are to go.
19380 * Followups To Yourself:: Having Gnus notice when people answer you.
19381 * Scoring On Other Headers:: Scoring on non-standard headers.
19382 * Scoring Tips:: How to score effectively.
19383 * Reverse Scoring:: That problem child of old is not problem.
19384 * Global Score Files:: Earth-spanning, ear-splitting score files.
19385 * Kill Files:: They are still here, but they can be ignored.
19386 * Converting Kill Files:: Translating kill files to score files.
19387 * Advanced Scoring:: Using logical expressions to build score rules.
19388 * Score Decays:: It can be useful to let scores wither away.
19392 @node Summary Score Commands
19393 @section Summary Score Commands
19394 @cindex score commands
19396 The score commands that alter score entries do not actually modify real
19397 score files. That would be too inefficient. Gnus maintains a cache of
19398 previously loaded score files, one of which is considered the
19399 @dfn{current score file alist}. The score commands simply insert
19400 entries into this list, and upon group exit, this list is saved.
19402 The current score file is by default the group's local score file, even
19403 if no such score file actually exists. To insert score commands into
19404 some other score file (e.g., @file{all.SCORE}), you must first make this
19405 score file the current one.
19407 General score commands that don't actually change the score file:
19412 @kindex V s (Summary)
19413 @findex gnus-summary-set-score
19414 Set the score of the current article (@code{gnus-summary-set-score}).
19417 @kindex V S (Summary)
19418 @findex gnus-summary-current-score
19419 Display the score of the current article
19420 (@code{gnus-summary-current-score}).
19423 @kindex V t (Summary)
19424 @findex gnus-score-find-trace
19425 Display all score rules that have been used on the current article
19426 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
19427 may type @kbd{e} to edit score file corresponding to the score rule on
19428 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
19429 score file and edit it.
19432 @kindex V w (Summary)
19433 @findex gnus-score-find-favourite-words
19434 List words used in scoring (@code{gnus-score-find-favourite-words}).
19437 @kindex V R (Summary)
19438 @findex gnus-summary-rescore
19439 Run the current summary through the scoring process
19440 (@code{gnus-summary-rescore}). This might be useful if you're playing
19441 around with your score files behind Gnus' back and want to see the
19442 effect you're having.
19445 @kindex V c (Summary)
19446 @findex gnus-score-change-score-file
19447 Make a different score file the current
19448 (@code{gnus-score-change-score-file}).
19451 @kindex V e (Summary)
19452 @findex gnus-score-edit-current-scores
19453 Edit the current score file (@code{gnus-score-edit-current-scores}).
19454 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
19458 @kindex V f (Summary)
19459 @findex gnus-score-edit-file
19460 Edit a score file and make this score file the current one
19461 (@code{gnus-score-edit-file}).
19464 @kindex V F (Summary)
19465 @findex gnus-score-flush-cache
19466 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
19467 after editing score files.
19470 @kindex V C (Summary)
19471 @findex gnus-score-customize
19472 Customize a score file in a visually pleasing manner
19473 (@code{gnus-score-customize}).
19477 The rest of these commands modify the local score file.
19482 @kindex V m (Summary)
19483 @findex gnus-score-set-mark-below
19484 Prompt for a score, and mark all articles with a score below this as
19485 read (@code{gnus-score-set-mark-below}).
19488 @kindex V x (Summary)
19489 @findex gnus-score-set-expunge-below
19490 Prompt for a score, and add a score rule to the current score file to
19491 expunge all articles below this score
19492 (@code{gnus-score-set-expunge-below}).
19495 The keystrokes for actually making score entries follow a very regular
19496 pattern, so there's no need to list all the commands. (Hundreds of
19499 @findex gnus-summary-increase-score
19500 @findex gnus-summary-lower-score
19504 The first key is either @kbd{I} (upper case i) for increasing the score
19505 or @kbd{L} for lowering the score.
19507 The second key says what header you want to score on. The following
19508 keys are available:
19512 Score on the author name.
19515 Score on the subject line.
19518 Score on the @code{Xref} line---i.e., the cross-posting line.
19521 Score on the @code{References} line.
19527 Score on the number of lines.
19530 Score on the @code{Message-ID} header.
19533 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
19534 if your @acronym{NNTP} server tracks additional header data in overviews.
19537 Score on followups---this matches the author name, and adds scores to
19538 the followups to this author. (Using this key leads to the creation of
19539 @file{ADAPT} files.)
19548 Score on thread. (Using this key leads to the creation of @file{ADAPT}
19554 The third key is the match type. Which match types are valid depends on
19555 what headers you are scoring on.
19567 Substring matching.
19570 Fuzzy matching (@pxref{Fuzzy Matching}).
19599 Greater than number.
19604 The fourth and usually final key says whether this is a temporary (i.e.,
19605 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
19606 or whether it is to be done immediately, without adding to the score
19611 Temporary score entry.
19614 Permanent score entry.
19617 Immediately scoring.
19621 If you are scoring on `e' (extra) headers, you will then be prompted for
19622 the header name on which you wish to score. This must be a header named
19623 in gnus-extra-headers, and @samp{TAB} completion is available.
19627 So, let's say you want to increase the score on the current author with
19628 exact matching permanently: @kbd{I a e p}. If you want to lower the
19629 score based on the subject line, using substring matching, and make a
19630 temporary score entry: @kbd{L s s t}. Pretty easy.
19632 To make things a bit more complicated, there are shortcuts. If you use
19633 a capital letter on either the second or third keys, Gnus will use
19634 defaults for the remaining one or two keystrokes. The defaults are
19635 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
19636 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
19638 These functions take both the numerical prefix and the symbolic prefix
19639 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
19640 (or increase) the score of the article. A symbolic prefix of @code{a}
19641 says to use the @file{all.SCORE} file for the command instead of the
19642 current score file.
19644 @vindex gnus-score-mimic-keymap
19645 The @code{gnus-score-mimic-keymap} says whether these commands will
19646 pretend they are keymaps or not.
19649 @node Group Score Commands
19650 @section Group Score Commands
19651 @cindex group score commands
19653 There aren't many of these as yet, I'm afraid.
19658 @kindex W e (Group)
19659 @findex gnus-score-edit-all-score
19660 Edit the apply-to-all-groups all.SCORE file. You will be popped into
19661 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
19664 @kindex W f (Group)
19665 @findex gnus-score-flush-cache
19666 Gnus maintains a cache of score alists to avoid having to reload them
19667 all the time. This command will flush the cache
19668 (@code{gnus-score-flush-cache}).
19672 You can do scoring from the command line by saying something like:
19674 @findex gnus-batch-score
19675 @cindex batch scoring
19677 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
19681 @node Score Variables
19682 @section Score Variables
19683 @cindex score variables
19687 @item gnus-use-scoring
19688 @vindex gnus-use-scoring
19689 If @code{nil}, Gnus will not check for score files, and will not, in
19690 general, do any score-related work. This is @code{t} by default.
19692 @item gnus-kill-killed
19693 @vindex gnus-kill-killed
19694 If this variable is @code{nil}, Gnus will never apply score files to
19695 articles that have already been through the kill process. While this
19696 may save you lots of time, it also means that if you apply a kill file
19697 to a group, and then change the kill file and want to run it over you
19698 group again to kill more articles, it won't work. You have to set this
19699 variable to @code{t} to do that. (It is @code{t} by default.)
19701 @item gnus-kill-files-directory
19702 @vindex gnus-kill-files-directory
19703 All kill and score files will be stored in this directory, which is
19704 initialized from the @env{SAVEDIR} environment variable by default.
19705 This is @file{~/News/} by default.
19707 @item gnus-score-file-suffix
19708 @vindex gnus-score-file-suffix
19709 Suffix to add to the group name to arrive at the score file name
19710 (@file{SCORE} by default.)
19712 @item gnus-score-uncacheable-files
19713 @vindex gnus-score-uncacheable-files
19714 @cindex score cache
19715 All score files are normally cached to avoid excessive re-loading of
19716 score files. However, this might make your Emacs grow big and
19717 bloated, so this regexp can be used to weed out score files unlikely
19718 to be needed again. It would be a bad idea to deny caching of
19719 @file{all.SCORE}, while it might be a good idea to not cache
19720 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
19721 variable is @samp{ADAPT$} by default, so no adaptive score files will
19724 @item gnus-save-score
19725 @vindex gnus-save-score
19726 If you have really complicated score files, and do lots of batch
19727 scoring, then you might set this variable to @code{t}. This will make
19728 Gnus save the scores into the @file{.newsrc.eld} file.
19730 If you do not set this to @code{t}, then manual scores (like those set
19731 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
19732 across group visits.
19734 @item gnus-score-interactive-default-score
19735 @vindex gnus-score-interactive-default-score
19736 Score used by all the interactive raise/lower commands to raise/lower
19737 score with. Default is 1000, which may seem excessive, but this is to
19738 ensure that the adaptive scoring scheme gets enough room to play with.
19739 We don't want the small changes from the adaptive scoring to overwrite
19740 manually entered data.
19742 @item gnus-summary-default-score
19743 @vindex gnus-summary-default-score
19744 Default score of an article, which is 0 by default.
19746 @item gnus-summary-expunge-below
19747 @vindex gnus-summary-expunge-below
19748 Don't display the summary lines of articles that have scores lower than
19749 this variable. This is @code{nil} by default, which means that no
19750 articles will be hidden. This variable is local to the summary buffers,
19751 and has to be set from @code{gnus-summary-mode-hook}.
19753 @item gnus-score-over-mark
19754 @vindex gnus-score-over-mark
19755 Mark (in the third column) used for articles with a score over the
19756 default. Default is @samp{+}.
19758 @item gnus-score-below-mark
19759 @vindex gnus-score-below-mark
19760 Mark (in the third column) used for articles with a score below the
19761 default. Default is @samp{-}.
19763 @item gnus-score-find-score-files-function
19764 @vindex gnus-score-find-score-files-function
19765 Function used to find score files for the current group. This function
19766 is called with the name of the group as the argument.
19768 Predefined functions available are:
19771 @item gnus-score-find-single
19772 @findex gnus-score-find-single
19773 Only apply the group's own score file.
19775 @item gnus-score-find-bnews
19776 @findex gnus-score-find-bnews
19777 Apply all score files that match, using bnews syntax. This is the
19778 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
19779 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
19780 @file{gnu.all.SCORE} would all apply. In short, the instances of
19781 @samp{all} in the score file names are translated into @samp{.*}, and
19782 then a regexp match is done.
19784 This means that if you have some score entries that you want to apply to
19785 all groups, then you put those entries in the @file{all.SCORE} file.
19787 The score files are applied in a semi-random order, although Gnus will
19788 try to apply the more general score files before the more specific score
19789 files. It does this by looking at the number of elements in the score
19790 file names---discarding the @samp{all} elements.
19792 @item gnus-score-find-hierarchical
19793 @findex gnus-score-find-hierarchical
19794 Apply all score files from all the parent groups. This means that you
19795 can't have score files like @file{all.SCORE}, but you can have
19796 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19800 This variable can also be a list of functions. In that case, all
19801 these functions will be called with the group name as argument, and
19802 all the returned lists of score files will be applied. These
19803 functions can also return lists of lists of score alists directly. In
19804 that case, the functions that return these non-file score alists
19805 should probably be placed before the ``real'' score file functions, to
19806 ensure that the last score file returned is the local score file.
19809 For example, to do hierarchical scoring but use a non-server-specific
19810 overall score file, you could use the value
19812 (list (lambda (group) ("all.SCORE"))
19813 'gnus-score-find-hierarchical)
19816 @item gnus-score-expiry-days
19817 @vindex gnus-score-expiry-days
19818 This variable says how many days should pass before an unused score file
19819 entry is expired. If this variable is @code{nil}, no score file entries
19820 are expired. It's 7 by default.
19822 @item gnus-update-score-entry-dates
19823 @vindex gnus-update-score-entry-dates
19824 If this variable is non-@code{nil}, temporary score entries that have
19825 been triggered (matched) will have their dates updated. (This is how Gnus
19826 controls expiry---all non-matched-entries will become too old while
19827 matched entries will stay fresh and young.) However, if you set this
19828 variable to @code{nil}, even matched entries will grow old and will
19829 have to face that oh-so grim reaper.
19831 @item gnus-score-after-write-file-function
19832 @vindex gnus-score-after-write-file-function
19833 Function called with the name of the score file just written.
19835 @item gnus-score-thread-simplify
19836 @vindex gnus-score-thread-simplify
19837 If this variable is non-@code{nil}, article subjects will be
19838 simplified for subject scoring purposes in the same manner as with
19839 threading---according to the current value of
19840 @code{gnus-simplify-subject-functions}. If the scoring entry uses
19841 @code{substring} or @code{exact} matching, the match will also be
19842 simplified in this manner.
19847 @node Score File Format
19848 @section Score File Format
19849 @cindex score file format
19851 A score file is an @code{emacs-lisp} file that normally contains just a
19852 single form. Casual users are not expected to edit these files;
19853 everything can be changed from the summary buffer.
19855 Anyway, if you'd like to dig into it yourself, here's an example:
19859 ("Lars Ingebrigtsen" -10000)
19861 ("larsi\\|lmi" -50000 nil R))
19863 ("Ding is Badd" nil 728373))
19865 ("alt.politics" -1000 728372 s))
19870 (mark-and-expunge -10)
19874 (files "/hom/larsi/News/gnu.SCORE")
19875 (exclude-files "all.SCORE")
19876 (local (gnus-newsgroup-auto-expire t)
19877 (gnus-summary-make-false-root empty))
19881 This example demonstrates most score file elements. @xref{Advanced
19882 Scoring}, for a different approach.
19884 Even though this looks much like Lisp code, nothing here is actually
19885 @code{eval}ed. The Lisp reader is used to read this form, though, so it
19886 has to be valid syntactically, if not semantically.
19888 Six keys are supported by this alist:
19893 If the key is a string, it is the name of the header to perform the
19894 match on. Scoring can only be performed on these eight headers:
19895 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
19896 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
19897 these headers, there are three strings to tell Gnus to fetch the entire
19898 article and do the match on larger parts of the article: @code{Body}
19899 will perform the match on the body of the article, @code{Head} will
19900 perform the match on the head of the article, and @code{All} will
19901 perform the match on the entire article. Note that using any of these
19902 last three keys will slow down group entry @emph{considerably}. The
19903 final ``header'' you can score on is @code{Followup}. These score
19904 entries will result in new score entries being added for all follow-ups
19905 to articles that matches these score entries.
19907 Following this key is an arbitrary number of score entries, where each
19908 score entry has one to four elements.
19912 The first element is the @dfn{match element}. On most headers this will
19913 be a string, but on the Lines and Chars headers, this must be an
19917 If the second element is present, it should be a number---the @dfn{score
19918 element}. This number should be an integer in the neginf to posinf
19919 interval. This number is added to the score of the article if the match
19920 is successful. If this element is not present, the
19921 @code{gnus-score-interactive-default-score} number will be used
19922 instead. This is 1000 by default.
19925 If the third element is present, it should be a number---the @dfn{date
19926 element}. This date says when the last time this score entry matched,
19927 which provides a mechanism for expiring the score entries. It this
19928 element is not present, the score entry is permanent. The date is
19929 represented by the number of days since December 31, 1 BCE.
19932 If the fourth element is present, it should be a symbol---the @dfn{type
19933 element}. This element specifies what function should be used to see
19934 whether this score entry matches the article. What match types that can
19935 be used depends on what header you wish to perform the match on.
19938 @item From, Subject, References, Xref, Message-ID
19939 For most header types, there are the @code{r} and @code{R} (regexp), as
19940 well as @code{s} and @code{S} (substring) types, and @code{e} and
19941 @code{E} (exact match), and @code{w} (word match) types. If this
19942 element is not present, Gnus will assume that substring matching should
19943 be used. @code{R}, @code{S}, and @code{E} differ from the others in
19944 that the matches will be done in a case-sensitive manner. All these
19945 one-letter types are really just abbreviations for the @code{regexp},
19946 @code{string}, @code{exact}, and @code{word} types, which you can use
19947 instead, if you feel like.
19950 Just as for the standard string overview headers, if you are using
19951 gnus-extra-headers, you can score on these headers' values. In this
19952 case, there is a 5th element in the score entry, being the name of the
19953 header to be scored. The following entry is useful in your
19954 @file{all.SCORE} file in case of spam attacks from a single origin
19955 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
19959 ("111.222.333.444" -1000 nil s
19960 "NNTP-Posting-Host")
19964 These two headers use different match types: @code{<}, @code{>},
19965 @code{=}, @code{>=} and @code{<=}.
19967 These predicates are true if
19970 (PREDICATE HEADER MATCH)
19973 evaluates to non-@code{nil}. For instance, the advanced match
19974 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
19981 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
19982 the match, we get the score added if the article has less than 4 lines.
19983 (It's easy to get confused and think it's the other way around. But
19984 it's not. I think.)
19986 When matching on @code{Lines}, be careful because some back ends (like
19987 @code{nndir}) do not generate @code{Lines} header, so every article ends
19988 up being marked as having 0 lines. This can lead to strange results if
19989 you happen to lower score of the articles with few lines.
19992 For the Date header we have three kinda silly match types:
19993 @code{before}, @code{at} and @code{after}. I can't really imagine this
19994 ever being useful, but, like, it would feel kinda silly not to provide
19995 this function. Just in case. You never know. Better safe than sorry.
19996 Once burnt, twice shy. Don't judge a book by its cover. Never not have
19997 sex on a first date. (I have been told that at least one person, and I
19998 quote, ``found this function indispensable'', however.)
20002 A more useful match type is @code{regexp}. With it, you can match the
20003 date string using a regular expression. The date is normalized to
20004 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
20005 you want to match all articles that have been posted on April 1st in
20006 every year, you could use @samp{....0401.........} as a match string,
20007 for instance. (Note that the date is kept in its original time zone, so
20008 this will match articles that were posted when it was April 1st where
20009 the article was posted from. Time zones are such wholesome fun for the
20012 @item Head, Body, All
20013 These three match keys use the same match types as the @code{From} (etc.)@:
20017 This match key is somewhat special, in that it will match the
20018 @code{From} header, and affect the score of not only the matching
20019 articles, but also all followups to the matching articles. This allows
20020 you to increase the score of followups to your own articles, or
20021 decrease the score of followups to the articles of some known
20022 trouble-maker. Uses the same match types as the @code{From} header
20023 uses. (Using this match key will lead to creation of @file{ADAPT}
20027 This match key works along the same lines as the @code{Followup} match
20028 key. If you say that you want to score on a (sub-)thread started by an
20029 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
20030 match. This will add a new @samp{thread} match for each article that
20031 has @var{x} in its @code{References} header. (These new @samp{thread}
20032 matches will use the @code{Message-ID}s of these matching articles.)
20033 This will ensure that you can raise/lower the score of an entire thread,
20034 even though some articles in the thread may not have complete
20035 @code{References} headers. Note that using this may lead to
20036 nondeterministic scores of the articles in the thread. (Using this match
20037 key will lead to creation of @file{ADAPT} files.)
20041 @cindex score file atoms
20043 The value of this entry should be a number. Any articles with a score
20044 lower than this number will be marked as read.
20047 The value of this entry should be a number. Any articles with a score
20048 lower than this number will be removed from the summary buffer.
20050 @item mark-and-expunge
20051 The value of this entry should be a number. Any articles with a score
20052 lower than this number will be marked as read and removed from the
20055 @item thread-mark-and-expunge
20056 The value of this entry should be a number. All articles that belong to
20057 a thread that has a total score below this number will be marked as read
20058 and removed from the summary buffer. @code{gnus-thread-score-function}
20059 says how to compute the total score for a thread.
20062 The value of this entry should be any number of file names. These files
20063 are assumed to be score files as well, and will be loaded the same way
20066 @item exclude-files
20067 The clue of this entry should be any number of files. These files will
20068 not be loaded, even though they would normally be so, for some reason or
20072 The value of this entry will be @code{eval}ed. This element will be
20073 ignored when handling global score files.
20076 Read-only score files will not be updated or saved. Global score files
20077 should feature this atom (@pxref{Global Score Files}). (Note:
20078 @dfn{Global} here really means @dfn{global}; not your personal
20079 apply-to-all-groups score files.)
20082 The value of this entry should be a number. Articles that do not have
20083 parents will get this number added to their scores. Imagine you follow
20084 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
20085 will only follow a few of the threads, also want to see any new threads.
20087 You can do this with the following two score file entries:
20091 (mark-and-expunge -100)
20094 When you enter the group the first time, you will only see the new
20095 threads. You then raise the score of the threads that you find
20096 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{c y}) the
20097 rest. Next time you enter the group, you will see new articles in the
20098 interesting threads, plus any new threads.
20100 I.e., the orphan score atom is for high-volume groups where a few
20101 interesting threads which can't be found automatically by ordinary
20102 scoring rules exist.
20105 This entry controls the adaptive scoring. If it is @code{t}, the
20106 default adaptive scoring rules will be used. If it is @code{ignore}, no
20107 adaptive scoring will be performed on this group. If it is a list, this
20108 list will be used as the adaptive scoring rules. If it isn't present,
20109 or is something other than @code{t} or @code{ignore}, the default
20110 adaptive scoring rules will be used. If you want to use adaptive
20111 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
20112 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
20113 not want adaptive scoring. If you only want adaptive scoring in a few
20114 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
20115 insert @code{(adapt t)} in the score files of the groups where you want
20119 All adaptive score entries will go to the file named by this entry. It
20120 will also be applied when entering the group. This atom might be handy
20121 if you want to adapt on several groups at once, using the same adaptive
20122 file for a number of groups.
20125 @cindex local variables
20126 The value of this entry should be a list of @code{(@var{var}
20127 @var{value})} pairs. Each @var{var} will be made buffer-local to the
20128 current summary buffer, and set to the value specified. This is a
20129 convenient, if somewhat strange, way of setting variables in some
20130 groups if you don't like hooks much. Note that the @var{value} won't
20135 @node Score File Editing
20136 @section Score File Editing
20138 You normally enter all scoring commands from the summary buffer, but you
20139 might feel the urge to edit them by hand as well, so we've supplied you
20140 with a mode for that.
20142 It's simply a slightly customized @code{emacs-lisp} mode, with these
20143 additional commands:
20148 @kindex C-c C-c (Score)
20149 @findex gnus-score-edit-exit
20150 Save the changes you have made and return to the summary buffer
20151 (@code{gnus-score-edit-exit}).
20154 @kindex C-c C-d (Score)
20155 @findex gnus-score-edit-insert-date
20156 Insert the current date in numerical format
20157 (@code{gnus-score-edit-insert-date}). This is really the day number, if
20158 you were wondering.
20161 @kindex C-c C-p (Score)
20162 @findex gnus-score-pretty-print
20163 The adaptive score files are saved in an unformatted fashion. If you
20164 intend to read one of these files, you want to @dfn{pretty print} it
20165 first. This command (@code{gnus-score-pretty-print}) does that for
20170 Type @kbd{M-x gnus-score-mode} to use this mode.
20172 @vindex gnus-score-mode-hook
20173 @code{gnus-score-menu-hook} is run in score mode buffers.
20175 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
20176 @kbd{V t} to begin editing score files.
20179 @node Adaptive Scoring
20180 @section Adaptive Scoring
20181 @cindex adaptive scoring
20183 If all this scoring is getting you down, Gnus has a way of making it all
20184 happen automatically---as if by magic. Or rather, as if by artificial
20185 stupidity, to be precise.
20187 @vindex gnus-use-adaptive-scoring
20188 When you read an article, or mark an article as read, or kill an
20189 article, you leave marks behind. On exit from the group, Gnus can sniff
20190 these marks and add score elements depending on what marks it finds.
20191 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
20192 @code{t} or @code{(line)}. If you want score adaptively on separate
20193 words appearing in the subjects, you should set this variable to
20194 @code{(word)}. If you want to use both adaptive methods, set this
20195 variable to @code{(word line)}.
20197 @vindex gnus-default-adaptive-score-alist
20198 To give you complete control over the scoring process, you can customize
20199 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
20200 might look something like this:
20203 (setq gnus-default-adaptive-score-alist
20204 '((gnus-unread-mark)
20205 (gnus-ticked-mark (from 4))
20206 (gnus-dormant-mark (from 5))
20207 (gnus-del-mark (from -4) (subject -1))
20208 (gnus-read-mark (from 4) (subject 2))
20209 (gnus-expirable-mark (from -1) (subject -1))
20210 (gnus-killed-mark (from -1) (subject -3))
20211 (gnus-kill-file-mark)
20212 (gnus-ancient-mark)
20213 (gnus-low-score-mark)
20214 (gnus-catchup-mark (from -1) (subject -1))))
20217 As you see, each element in this alist has a mark as a key (either a
20218 variable name or a ``real'' mark---a character). Following this key is
20219 a arbitrary number of header/score pairs. If there are no header/score
20220 pairs following the key, no adaptive scoring will be done on articles
20221 that have that key as the article mark. For instance, articles with
20222 @code{gnus-unread-mark} in the example above will not get adaptive score
20225 Each article can have only one mark, so just a single of these rules
20226 will be applied to each article.
20228 To take @code{gnus-del-mark} as an example---this alist says that all
20229 articles that have that mark (i.e., are marked with @samp{e}) will have a
20230 score entry added to lower based on the @code{From} header by -4, and
20231 lowered by @code{Subject} by -1. Change this to fit your prejudices.
20233 If you have marked 10 articles with the same subject with
20234 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
20235 That means that that subject will get a score of ten times -1, which
20236 should be, unless I'm much mistaken, -10.
20238 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
20239 the read articles will be marked with the @samp{E} mark. This'll
20240 probably make adaptive scoring slightly impossible, so auto-expiring and
20241 adaptive scoring doesn't really mix very well.
20243 The headers you can score on are @code{from}, @code{subject},
20244 @code{message-id}, @code{references}, @code{xref}, @code{lines},
20245 @code{chars} and @code{date}. In addition, you can score on
20246 @code{followup}, which will create an adaptive score entry that matches
20247 on the @code{References} header using the @code{Message-ID} of the
20248 current article, thereby matching the following thread.
20250 If you use this scheme, you should set the score file atom @code{mark}
20251 to something small---like -300, perhaps, to avoid having small random
20252 changes result in articles getting marked as read.
20254 After using adaptive scoring for a week or so, Gnus should start to
20255 become properly trained and enhance the authors you like best, and kill
20256 the authors you like least, without you having to say so explicitly.
20258 You can control what groups the adaptive scoring is to be performed on
20259 by using the score files (@pxref{Score File Format}). This will also
20260 let you use different rules in different groups.
20262 @vindex gnus-adaptive-file-suffix
20263 The adaptive score entries will be put into a file where the name is the
20264 group name with @code{gnus-adaptive-file-suffix} appended. The default
20267 @vindex gnus-adaptive-pretty-print
20268 Adaptive score files can get huge and are not meant to be edited by
20269 human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the
20270 default) those files will not be written in a human readable way.
20272 @vindex gnus-score-exact-adapt-limit
20273 When doing adaptive scoring, substring or fuzzy matching would probably
20274 give you the best results in most cases. However, if the header one
20275 matches is short, the possibility for false positives is great, so if
20276 the length of the match is less than
20277 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
20278 this variable is @code{nil}, exact matching will always be used to avoid
20281 @vindex gnus-default-adaptive-word-score-alist
20282 As mentioned above, you can adapt either on individual words or entire
20283 headers. If you adapt on words, the
20284 @code{gnus-default-adaptive-word-score-alist} variable says what score
20285 each instance of a word should add given a mark.
20288 (setq gnus-default-adaptive-word-score-alist
20289 `((,gnus-read-mark . 30)
20290 (,gnus-catchup-mark . -10)
20291 (,gnus-killed-mark . -20)
20292 (,gnus-del-mark . -15)))
20295 This is the default value. If you have adaption on words enabled, every
20296 word that appears in subjects of articles marked with
20297 @code{gnus-read-mark} will result in a score rule that increase the
20298 score with 30 points.
20300 @vindex gnus-default-ignored-adaptive-words
20301 @vindex gnus-ignored-adaptive-words
20302 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
20303 will be ignored. If you wish to add more words to be ignored, use the
20304 @code{gnus-ignored-adaptive-words} list instead.
20306 @vindex gnus-adaptive-word-length-limit
20307 Some may feel that short words shouldn't count when doing adaptive
20308 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
20309 an integer. Words shorter than this number will be ignored. This
20310 variable defaults to @code{nil}.
20312 @vindex gnus-adaptive-word-syntax-table
20313 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
20314 syntax table in effect. It is similar to the standard syntax table, but
20315 it considers numbers to be non-word-constituent characters.
20317 @vindex gnus-adaptive-word-minimum
20318 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
20319 word scoring process will never bring down the score of an article to
20320 below this number. The default is @code{nil}.
20322 @vindex gnus-adaptive-word-no-group-words
20323 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
20324 won't adaptively word score any of the words in the group name. Useful
20325 for groups like @samp{comp.editors.emacs}, where most of the subject
20326 lines contain the word @samp{emacs}.
20328 After using this scheme for a while, it might be nice to write a
20329 @code{gnus-psychoanalyze-user} command to go through the rules and see
20330 what words you like and what words you don't like. Or perhaps not.
20332 Note that the adaptive word scoring thing is highly experimental and is
20333 likely to change in the future. Initial impressions seem to indicate
20334 that it's totally useless as it stands. Some more work (involving more
20335 rigorous statistical methods) will have to be done to make this useful.
20338 @node Home Score File
20339 @section Home Score File
20341 The score file where new score file entries will go is called the
20342 @dfn{home score file}. This is normally (and by default) the score file
20343 for the group itself. For instance, the home score file for
20344 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
20346 However, this may not be what you want. It is often convenient to share
20347 a common home score file among many groups---all @samp{emacs} groups
20348 could perhaps use the same home score file.
20350 @vindex gnus-home-score-file
20351 The variable that controls this is @code{gnus-home-score-file}. It can
20356 A string. Then this file will be used as the home score file for all
20360 A function. The result of this function will be used as the home score
20361 file. The function will be called with the name of the group as the
20365 A list. The elements in this list can be:
20369 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
20370 group name, the @var{file-name} will be used as the home score file.
20373 A function. If the function returns non-@code{nil}, the result will
20374 be used as the home score file. The function will be called with the
20375 name of the group as the parameter.
20378 A string. Use the string as the home score file.
20381 The list will be traversed from the beginning towards the end looking
20386 So, if you want to use just a single score file, you could say:
20389 (setq gnus-home-score-file
20390 "my-total-score-file.SCORE")
20393 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
20394 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
20396 @findex gnus-hierarchial-home-score-file
20398 (setq gnus-home-score-file
20399 'gnus-hierarchial-home-score-file)
20402 This is a ready-made function provided for your convenience.
20403 Other functions include
20406 @item gnus-current-home-score-file
20407 @findex gnus-current-home-score-file
20408 Return the ``current'' regular score file. This will make scoring
20409 commands add entry to the ``innermost'' matching score file.
20413 If you want to have one score file for the @samp{emacs} groups and
20414 another for the @samp{comp} groups, while letting all other groups use
20415 their own home score files:
20418 (setq gnus-home-score-file
20419 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
20420 '(("\\.emacs" "emacs.SCORE")
20421 ;; @r{All the comp groups in one score file}
20422 ("^comp" "comp.SCORE")))
20425 @vindex gnus-home-adapt-file
20426 @code{gnus-home-adapt-file} works exactly the same way as
20427 @code{gnus-home-score-file}, but says what the home adaptive score file
20428 is instead. All new adaptive file entries will go into the file
20429 specified by this variable, and the same syntax is allowed.
20431 In addition to using @code{gnus-home-score-file} and
20432 @code{gnus-home-adapt-file}, you can also use group parameters
20433 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
20434 Parameters}) to achieve much the same. Group and topic parameters take
20435 precedence over this variable.
20438 @node Followups To Yourself
20439 @section Followups To Yourself
20441 Gnus offers two commands for picking out the @code{Message-ID} header in
20442 the current buffer. Gnus will then add a score rule that scores using
20443 this @code{Message-ID} on the @code{References} header of other
20444 articles. This will, in effect, increase the score of all articles that
20445 respond to the article in the current buffer. Quite useful if you want
20446 to easily note when people answer what you've said.
20450 @item gnus-score-followup-article
20451 @findex gnus-score-followup-article
20452 This will add a score to articles that directly follow up your own
20455 @item gnus-score-followup-thread
20456 @findex gnus-score-followup-thread
20457 This will add a score to all articles that appear in a thread ``below''
20461 @vindex message-sent-hook
20462 These two functions are both primarily meant to be used in hooks like
20463 @code{message-sent-hook}, like this:
20465 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
20469 If you look closely at your own @code{Message-ID}, you'll notice that
20470 the first two or three characters are always the same. Here's two of
20474 <x6u3u47icf.fsf@@eyesore.no>
20475 <x6sp9o7ibw.fsf@@eyesore.no>
20478 So ``my'' ident on this machine is @samp{x6}. This can be
20479 exploited---the following rule will raise the score on all followups to
20484 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
20488 Whether it's the first two or first three characters that are ``yours''
20489 is system-dependent.
20492 @node Scoring On Other Headers
20493 @section Scoring On Other Headers
20494 @cindex scoring on other headers
20496 Gnus is quite fast when scoring the ``traditional''
20497 headers---@samp{From}, @samp{Subject} and so on. However, scoring
20498 other headers requires writing a @code{head} scoring rule, which means
20499 that Gnus has to request every single article from the back end to find
20500 matches. This takes a long time in big groups.
20502 @vindex gnus-inhibit-slow-scoring
20503 You can inhibit this slow scoring on headers or body by setting the
20504 variable @code{gnus-inhibit-slow-scoring}. If
20505 @code{gnus-inhibit-slow-scoring} is regexp, slow scoring is inhibited if
20506 the group matches the regexp. If it is t, slow scoring on it is
20507 inhibited for all groups.
20509 Now, there's not much you can do about the slowness for news groups, but for
20510 mail groups, you have greater control. In @ref{To From Newsgroups},
20511 it's explained in greater detail what this mechanism does, but here's
20512 a cookbook example for @code{nnml} on how to allow scoring on the
20513 @samp{To} and @samp{Cc} headers.
20515 Put the following in your @file{~/.gnus.el} file.
20518 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
20519 nnmail-extra-headers gnus-extra-headers)
20522 Restart Gnus and rebuild your @code{nnml} overview files with the
20523 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
20524 time if you have much mail.
20526 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
20527 so: @kbd{I e s p To RET <your name> RET}.
20533 @section Scoring Tips
20534 @cindex scoring tips
20540 @cindex scoring crossposts
20541 If you want to lower the score of crossposts, the line to match on is
20542 the @code{Xref} header.
20544 ("xref" (" talk.politics.misc:" -1000))
20547 @item Multiple crossposts
20548 If you want to lower the score of articles that have been crossposted to
20549 more than, say, 3 groups:
20552 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
20556 @item Matching on the body
20557 This is generally not a very good idea---it takes a very long time.
20558 Gnus actually has to fetch each individual article from the server. But
20559 you might want to anyway, I guess. Even though there are three match
20560 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
20561 and stick with it in each score file. If you use any two, each article
20562 will be fetched @emph{twice}. If you want to match a bit on the
20563 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
20566 @item Marking as read
20567 You will probably want to mark articles that have scores below a certain
20568 number as read. This is most easily achieved by putting the following
20569 in your @file{all.SCORE} file:
20573 You may also consider doing something similar with @code{expunge}.
20575 @item Negated character classes
20576 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
20577 That will match newlines, which might lead to, well, The Unknown. Say
20578 @code{[^abcd\n]*} instead.
20582 @node Reverse Scoring
20583 @section Reverse Scoring
20584 @cindex reverse scoring
20586 If you want to keep just articles that have @samp{Sex with Emacs} in the
20587 subject header, and expunge all other articles, you could put something
20588 like this in your score file:
20592 ("Sex with Emacs" 2))
20597 So, you raise all articles that match @samp{Sex with Emacs} and mark the
20598 rest as read, and expunge them to boot.
20601 @node Global Score Files
20602 @section Global Score Files
20603 @cindex global score files
20605 Sure, other newsreaders have ``global kill files''. These are usually
20606 nothing more than a single kill file that applies to all groups, stored
20607 in the user's home directory. Bah! Puny, weak newsreaders!
20609 What I'm talking about here are Global Score Files. Score files from
20610 all over the world, from users everywhere, uniting all nations in one
20611 big, happy score file union! Ange-score! New and untested!
20613 @vindex gnus-global-score-files
20614 All you have to do to use other people's score files is to set the
20615 @code{gnus-global-score-files} variable. One entry for each score file,
20616 or each score file directory. Gnus will decide by itself what score
20617 files are applicable to which group.
20619 To use the score file
20620 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
20621 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
20625 (setq gnus-global-score-files
20626 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
20627 "/ftp@@ftp.some-where:/pub/score/"))
20630 @findex gnus-score-search-global-directories
20632 Simple, eh? Directory names must end with a @samp{/}. These
20633 directories are typically scanned only once during each Gnus session.
20634 If you feel the need to manually re-scan the remote directories, you can
20635 use the @code{gnus-score-search-global-directories} command.
20637 Note that, at present, using this option will slow down group entry
20638 somewhat. (That is---a lot.)
20640 If you want to start maintaining score files for other people to use,
20641 just put your score file up for anonymous ftp and announce it to the
20642 world. Become a retro-moderator! Participate in the retro-moderator
20643 wars sure to ensue, where retro-moderators battle it out for the
20644 sympathy of the people, luring them to use their score files on false
20645 premises! Yay! The net is saved!
20647 Here are some tips for the would-be retro-moderator, off the top of my
20653 Articles heavily crossposted are probably junk.
20655 To lower a single inappropriate article, lower by @code{Message-ID}.
20657 Particularly brilliant authors can be raised on a permanent basis.
20659 Authors that repeatedly post off-charter for the group can safely be
20660 lowered out of existence.
20662 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
20663 articles completely.
20666 Use expiring score entries to keep the size of the file down. You
20667 should probably have a long expiry period, though, as some sites keep
20668 old articles for a long time.
20671 @dots{} I wonder whether other newsreaders will support global score files
20672 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
20673 Wave, xrn and 1stReader are bound to implement scoring. Should we start
20674 holding our breath yet?
20678 @section Kill Files
20681 Gnus still supports those pesky old kill files. In fact, the kill file
20682 entries can now be expiring, which is something I wrote before Daniel
20683 Quinlan thought of doing score files, so I've left the code in there.
20685 In short, kill processing is a lot slower (and I do mean @emph{a lot})
20686 than score processing, so it might be a good idea to rewrite your kill
20687 files into score files.
20689 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
20690 forms into this file, which means that you can use kill files as some
20691 sort of primitive hook function to be run on group entry, even though
20692 that isn't a very good idea.
20694 Normal kill files look like this:
20697 (gnus-kill "From" "Lars Ingebrigtsen")
20698 (gnus-kill "Subject" "ding")
20702 This will mark every article written by me as read, and remove the
20703 marked articles from the summary buffer. Very useful, you'll agree.
20705 Other programs use a totally different kill file syntax. If Gnus
20706 encounters what looks like a @code{rn} kill file, it will take a stab at
20709 Two summary functions for editing a @sc{gnus} kill file:
20714 @kindex M-k (Summary)
20715 @findex gnus-summary-edit-local-kill
20716 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
20719 @kindex M-K (Summary)
20720 @findex gnus-summary-edit-global-kill
20721 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
20724 Two group mode functions for editing the kill files:
20729 @kindex M-k (Group)
20730 @findex gnus-group-edit-local-kill
20731 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
20734 @kindex M-K (Group)
20735 @findex gnus-group-edit-global-kill
20736 Edit the general kill file (@code{gnus-group-edit-global-kill}).
20739 Kill file variables:
20742 @item gnus-kill-file-name
20743 @vindex gnus-kill-file-name
20744 A kill file for the group @samp{soc.motss} is normally called
20745 @file{soc.motss.KILL}. The suffix appended to the group name to get
20746 this file name is detailed by the @code{gnus-kill-file-name} variable.
20747 The ``global'' kill file (not in the score file sense of ``global'', of
20748 course) is just called @file{KILL}.
20750 @vindex gnus-kill-save-kill-file
20751 @item gnus-kill-save-kill-file
20752 If this variable is non-@code{nil}, Gnus will save the
20753 kill file after processing, which is necessary if you use expiring
20756 @item gnus-apply-kill-hook
20757 @vindex gnus-apply-kill-hook
20758 @findex gnus-apply-kill-file-unless-scored
20759 @findex gnus-apply-kill-file
20760 A hook called to apply kill files to a group. It is
20761 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
20762 kill file if you have a score file for the same group, you can set this
20763 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
20764 kill files to be processed, you should set this variable to @code{nil}.
20766 @item gnus-kill-file-mode-hook
20767 @vindex gnus-kill-file-mode-hook
20768 A hook called in kill-file mode buffers.
20773 @node Converting Kill Files
20774 @section Converting Kill Files
20776 @cindex converting kill files
20778 If you have loads of old kill files, you may want to convert them into
20779 score files. If they are ``regular'', you can use
20780 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
20783 The kill to score conversion package isn't included in Emacs by default.
20784 You can fetch it from the contrib directory of the Gnus distribution or
20786 @uref{http://heim.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
20788 If your old kill files are very complex---if they contain more
20789 non-@code{gnus-kill} forms than not, you'll have to convert them by
20790 hand. Or just let them be as they are. Gnus will still use them as
20794 @node Advanced Scoring
20795 @section Advanced Scoring
20797 Scoring on Subjects and From headers is nice enough, but what if you're
20798 really interested in what a person has to say only when she's talking
20799 about a particular subject? Or what if you really don't want to
20800 read what person A has to say when she's following up to person B, but
20801 want to read what she says when she's following up to person C?
20803 By using advanced scoring rules you may create arbitrarily complex
20807 * Advanced Scoring Syntax:: A definition.
20808 * Advanced Scoring Examples:: What they look like.
20809 * Advanced Scoring Tips:: Getting the most out of it.
20813 @node Advanced Scoring Syntax
20814 @subsection Advanced Scoring Syntax
20816 Ordinary scoring rules have a string as the first element in the rule.
20817 Advanced scoring rules have a list as the first element. The second
20818 element is the score to be applied if the first element evaluated to a
20819 non-@code{nil} value.
20821 These lists may consist of three logical operators, one redirection
20822 operator, and various match operators.
20829 This logical operator will evaluate each of its arguments until it finds
20830 one that evaluates to @code{false}, and then it'll stop. If all arguments
20831 evaluate to @code{true} values, then this operator will return
20836 This logical operator will evaluate each of its arguments until it finds
20837 one that evaluates to @code{true}. If no arguments are @code{true},
20838 then this operator will return @code{false}.
20843 This logical operator only takes a single argument. It returns the
20844 logical negation of the value of its argument.
20848 There is an @dfn{indirection operator} that will make its arguments
20849 apply to the ancestors of the current article being scored. For
20850 instance, @code{1-} will make score rules apply to the parent of the
20851 current article. @code{2-} will make score rules apply to the
20852 grandparent of the current article. Alternatively, you can write
20853 @code{^^}, where the number of @code{^}s (carets) says how far back into
20854 the ancestry you want to go.
20856 Finally, we have the match operators. These are the ones that do the
20857 real work. Match operators are header name strings followed by a match
20858 and a match type. A typical match operator looks like @samp{("from"
20859 "Lars Ingebrigtsen" s)}. The header names are the same as when using
20860 simple scoring, and the match types are also the same.
20863 @node Advanced Scoring Examples
20864 @subsection Advanced Scoring Examples
20866 Please note that the following examples are score file rules. To
20867 make a complete score file from them, surround them with another pair
20870 Let's say you want to increase the score of articles written by Lars
20871 when he's talking about Gnus:
20876 ("from" "Lars Ingebrigtsen")
20877 ("subject" "Gnus"))
20884 When he writes long articles, he sometimes has something nice to say:
20888 ("from" "Lars Ingebrigtsen")
20895 However, when he responds to things written by Reig Eigil Logge, you
20896 really don't want to read what he's written:
20900 ("from" "Lars Ingebrigtsen")
20901 (1- ("from" "Reig Eigil Logge")))
20905 Everybody that follows up Redmondo when he writes about disappearing
20906 socks should have their scores raised, but only when they talk about
20907 white socks. However, when Lars talks about socks, it's usually not
20914 ("from" "redmondo@@.*no" r)
20915 ("body" "disappearing.*socks" t)))
20916 (! ("from" "Lars Ingebrigtsen"))
20917 ("body" "white.*socks"))
20921 Suppose you're reading a high volume group and you're only interested
20922 in replies. The plan is to score down all articles that don't have
20923 subject that begin with "Re:", "Fw:" or "Fwd:" and then score up all
20924 parents of articles that have subjects that begin with reply marks.
20927 ((! ("subject" "re:\\|fwd?:" r))
20929 ((1- ("subject" "re:\\|fwd?:" r))
20933 The possibilities are endless.
20935 @node Advanced Scoring Tips
20936 @subsection Advanced Scoring Tips
20938 The @code{&} and @code{|} logical operators do short-circuit logic.
20939 That is, they stop processing their arguments when it's clear what the
20940 result of the operation will be. For instance, if one of the arguments
20941 of an @code{&} evaluates to @code{false}, there's no point in evaluating
20942 the rest of the arguments. This means that you should put slow matches
20943 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
20944 @samp{subject}) first.
20946 The indirection arguments (@code{1-} and so on) will make their
20947 arguments work on previous generations of the thread. If you say
20958 Then that means ``score on the from header of the grandparent of the
20959 current article''. An indirection is quite fast, but it's better to say:
20965 ("subject" "Gnus")))
20972 (1- ("from" "Lars"))
20973 (1- ("subject" "Gnus")))
20978 @section Score Decays
20979 @cindex score decays
20982 You may find that your scores have a tendency to grow without
20983 bounds, especially if you're using adaptive scoring. If scores get too
20984 big, they lose all meaning---they simply max out and it's difficult to
20985 use them in any sensible way.
20987 @vindex gnus-decay-scores
20988 @findex gnus-decay-score
20989 @vindex gnus-decay-score-function
20990 Gnus provides a mechanism for decaying scores to help with this problem.
20991 When score files are loaded and @code{gnus-decay-scores} is
20992 non-@code{nil}, Gnus will run the score files through the decaying
20993 mechanism thereby lowering the scores of all non-permanent score rules.
20994 If @code{gnus-decay-scores} is a regexp, only score files matching this
20995 regexp are treated. E.g., you may set it to @samp{\\.ADAPT\\'} if only
20996 @emph{adaptive} score files should be decayed. The decay itself if
20997 performed by the @code{gnus-decay-score-function} function, which is
20998 @code{gnus-decay-score} by default. Here's the definition of that
21002 (defun gnus-decay-score (score)
21003 "Decay SCORE according to `gnus-score-decay-constant'
21004 and `gnus-score-decay-scale'."
21006 (* (if (< score 0) -1 1)
21008 (max gnus-score-decay-constant
21010 gnus-score-decay-scale)))))))
21011 (if (and (featurep 'xemacs)
21012 ;; XEmacs's floor can handle only the floating point
21013 ;; number below the half of the maximum integer.
21014 (> (abs n) (lsh -1 -2)))
21016 (car (split-string (number-to-string n) "\\.")))
21020 @vindex gnus-score-decay-scale
21021 @vindex gnus-score-decay-constant
21022 @code{gnus-score-decay-constant} is 3 by default and
21023 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
21027 Scores between -3 and 3 will be set to 0 when this function is called.
21030 Scores with magnitudes between 3 and 60 will be shrunk by 3.
21033 Scores with magnitudes greater than 60 will be shrunk by 5% of the
21037 If you don't like this decay function, write your own. It is called
21038 with the score to be decayed as its only parameter, and it should return
21039 the new score, which should be an integer.
21041 Gnus will try to decay scores once a day. If you haven't run Gnus for
21042 four days, Gnus will decay the scores four times, for instance.
21048 FIXME: Add a brief overview of Gnus search capabilities. A brief
21049 comparison of nnir, nnmairix, contrib/gnus-namazu would be nice
21052 This chapter describes tools for searching groups and servers for
21053 articles matching a query and then retrieving those articles. Gnus
21054 provides a simpler mechanism for searching through articles in a summary buffer
21055 to find those matching a pattern. @xref{Searching for Articles}.
21058 * nnir:: Searching with various engines.
21059 * nnmairix:: Searching with Mairix.
21066 This section describes how to use @code{nnir} to search for articles
21070 * What is nnir?:: What does @code{nnir} do?
21071 * Basic Usage:: How to perform simple searches.
21072 * Setting up nnir:: How to set up @code{nnir}.
21075 @node What is nnir?
21076 @subsection What is nnir?
21078 @code{nnir} is a Gnus interface to a number of tools for searching
21079 through mail and news repositories. Different backends (like
21080 @code{nnimap} and @code{nntp}) work with different tools (called
21081 @dfn{engines} in @code{nnir} lingo), but all use the same basic search
21084 The @code{nnimap} and @code{gmane} search engines should work with no
21085 configuration. Other engines require a local index that needs to be
21086 created and maintained outside of Gnus.
21090 @subsection Basic Usage
21092 In the group buffer typing @kbd{G G} will search the group on the
21093 current line by calling @code{gnus-group-make-nnir-group}. This prompts
21094 for a query string, creates an ephemeral @code{nnir} group containing
21095 the articles that match this query, and takes you to a summary buffer
21096 showing these articles. Articles may then be read, moved and deleted
21097 using the usual commands.
21099 The @code{nnir} group made in this way is an @code{ephemeral} group, and
21100 some changes are not permanent: aside from reading, moving, and
21101 deleting, you can't act on the original article. But there is an
21102 alternative: you can @emph{warp} to the original group for the article
21103 on the current line with @kbd{A W}, aka
21104 @code{gnus-warp-to-article}. Even better, the function
21105 @code{gnus-summary-refer-thread}, bound by default in summary buffers to
21106 @kbd{A T}, will first warp to the original group before it works its
21107 magic and includes all the articles in the thread. From here you can
21108 read, move and delete articles, but also copy them, alter article marks,
21111 You say you want to search more than just the group on the current line?
21112 No problem: just process-mark the groups you want to search. You want
21113 even more? Calling for an nnir search with the cursor on a topic heading
21114 will search all the groups under that heading.
21116 Still not enough? OK, in the server buffer
21117 @code{gnus-group-make-nnir-group} (now bound to @kbd{G}) will search all
21118 groups from the server on the current line. Too much? Want to ignore
21119 certain groups when searching, like spam groups? Just customize
21120 @code{nnir-ignored-newsgroups}.
21122 One more thing: individual search engines may have special search
21123 features. You can access these special features by giving a prefix-arg
21124 to @code{gnus-group-make-nnir-group}. If you are searching multiple
21125 groups with different search engines you will be prompted for the
21126 special search features for each engine separately.
21129 @node Setting up nnir
21130 @subsection Setting up nnir
21132 To set up nnir you may need to do some prep work. Firstly, you may need
21133 to configure the search engines you plan to use. Some of them, like
21134 @code{imap} and @code{gmane}, need no special configuration. Others,
21135 like @code{namazu} and @code{swish}, require configuration as described
21136 below. Secondly, you need to associate a search engine with a server or
21139 If you just want to use the @code{imap} engine to search @code{nnimap}
21140 servers, and the @code{gmane} engine to search @code{gmane} then you
21141 don't have to do anything. But you might want to read the details of the
21142 query language anyway.
21145 * Associating Engines:: How to associate engines.
21146 * The imap Engine:: Imap configuration and usage.
21147 * The gmane Engine:: Gmane configuration and usage.
21148 * The swish++ Engine:: Swish++ configuration and usage.
21149 * The swish-e Engine:: Swish-e configuration and usage.
21150 * The namazu Engine:: Namazu configuration and usage.
21151 * The hyrex Engine:: Hyrex configuration and usage.
21152 * Customizations:: User customizable settings.
21155 @node Associating Engines
21156 @subsubsection Associating Engines
21159 When searching a group, @code{nnir} needs to know which search engine to
21160 use. You can configure a given server to use a particular engine by
21161 setting the server variable @code{nnir-search-engine} to the engine
21162 name. For example to use the @code{namazu} engine to search the server
21163 named @code{home} you can use
21166 (setq gnus-secondary-select-methods
21168 (nnimap-address "localhost")
21169 (nnir-search-engine namazu))))
21172 Alternatively you might want to use a particular engine for all servers
21173 with a given backend. For example, you might want to use the @code{imap}
21174 engine for all servers using the @code{nnimap} backend. In this case you
21175 can customize the variable @code{nnir-method-default-engines}. This is
21176 an alist of pairs of the form @code{(backend . engine)}. By default this
21177 variable is set to use the @code{imap} engine for all servers using the
21178 @code{nnimap} backend, and the @code{gmane} backend for @code{nntp}
21179 servers. (Don't worry, the @code{gmane} search engine won't actually try
21180 to search non-gmane @code{nntp} servers.) But if you wanted to use
21181 @code{namazu} for all your servers with an @code{nnimap} backend you
21182 could change this to
21185 '((nnimap . namazu)
21189 @node The imap Engine
21190 @subsubsection The imap Engine
21192 The @code{imap} engine requires no configuration.
21194 Queries using the @code{imap} engine follow a simple query language.
21195 The search is always case-insensitive and supports the following
21196 features (inspired by the Google search input language):
21200 @item Boolean query operators
21201 AND, OR, and NOT are supported, and parentheses can be used to control
21202 operator precedence, e.g., (emacs OR xemacs) AND linux. Note that
21203 operators must be written with all capital letters to be
21204 recognized. Also preceding a term with a @minus{} sign is equivalent to NOT
21207 @item Automatic AND queries
21208 If you specify multiple words then they will be treated as an AND
21209 expression intended to match all components.
21211 @item Phrase searches
21212 If you wrap your query in double-quotes then it will be treated as a
21217 By default the whole message will be searched. The query can be limited
21218 to a specific part of a message by using a prefix-arg. After inputting
21219 the query this will prompt (with completion) for a message part.
21220 Choices include ``Whole message'', ``Subject'', ``From'', and
21221 ``To''. Any unrecognized input is interpreted as a header name. For
21222 example, typing @kbd{Message-ID} in response to this prompt will limit
21223 the query to the Message-ID header.
21225 Finally selecting ``Imap'' will interpret the query as a raw
21226 @acronym{IMAP} search query. The format of such queries can be found in
21229 If you don't like the default of searching whole messages you can
21230 customize @code{nnir-imap-default-search-key}. For example to use
21231 @acronym{IMAP} queries by default
21234 (setq nnir-imap-default-search-key "Imap")
21237 @node The gmane Engine
21238 @subsubsection The gmane Engine
21240 The @code{gmane} engine requires no configuration.
21242 Gmane queries follow a simple query language:
21245 @item Boolean query operators
21246 AND, OR, NOT (or AND NOT), and XOR are supported, and brackets can be
21247 used to control operator precedence, e.g., (emacs OR xemacs) AND linux.
21248 Note that operators must be written with all capital letters to be
21251 @item Required and excluded terms
21252 + and @minus{} can be used to require or exclude terms, e.g., football
21255 @item Unicode handling
21256 The search engine converts all text to utf-8, so searching should work
21260 Common English words (like 'the' and 'a') are ignored by default. You
21261 can override this by prefixing such words with a + (e.g., +the) or
21262 enclosing the word in quotes (e.g., "the").
21266 The query can be limited to articles by a specific author using a
21267 prefix-arg. After inputting the query this will prompt for an author
21268 name (or part of a name) to match.
21270 @node The swish++ Engine
21271 @subsubsection The swish++ Engine
21273 FIXME: Say something more here.
21275 Documentation for swish++ may be found at the swish++ sourceforge page:
21276 @uref{http://swishplusplus.sourceforge.net}
21280 @item nnir-swish++-program
21281 The name of the swish++ executable. Defaults to @code{search}
21283 @item nnir-swish++-additional-switches
21284 A list of strings to be given as additional arguments to
21285 swish++. @code{nil} by default.
21287 @item nnir-swish++-remove-prefix
21288 The prefix to remove from each file name returned by swish++ in order
21289 to get a group name. By default this is @code{$HOME/Mail}.
21293 @node The swish-e Engine
21294 @subsubsection The swish-e Engine
21296 FIXME: Say something more here.
21298 Documentation for swish-e may be found at the swish-e homepage
21299 @uref{http://swish-e.org}
21303 @item nnir-swish-e-program
21304 The name of the swish-e search program. Defaults to @code{swish-e}.
21306 @item nnir-swish-e-additional-switches
21307 A list of strings to be given as additional arguments to
21308 swish-e. @code{nil} by default.
21310 @item nnir-swish-e-remove-prefix
21311 The prefix to remove from each file name returned by swish-e in order
21312 to get a group name. By default this is @code{$HOME/Mail}.
21316 @node The namazu Engine
21317 @subsubsection The namazu Engine
21319 Using the namazu engine requires creating and maintaining index files.
21320 One directory should contain all the index files, and nnir must be told
21321 where to find them by setting the @code{nnir-namazu-index-directory}
21324 To work correctly the @code{nnir-namazu-remove-prefix} variable must
21325 also be correct. This is the prefix to remove from each file name
21326 returned by Namazu in order to get a proper group name (albeit with `/'
21329 For example, suppose that Namazu returns file names such as
21330 @samp{/home/john/Mail/mail/misc/42}. For this example, use the
21331 following setting: @code{(setq nnir-namazu-remove-prefix
21332 "/home/john/Mail/")} Note the trailing slash. Removing this prefix from
21333 the directory gives @samp{mail/misc/42}. @code{nnir} knows to remove
21334 the @samp{/42} and to replace @samp{/} with @samp{.} to arrive at the
21335 correct group name @samp{mail.misc}.
21337 Extra switches may be passed to the namazu search command by setting the
21338 variable @code{nnir-namazu-additional-switches}. It is particularly
21339 important not to pass any any switches to namazu that will change the
21340 output format. Good switches to use include `--sort', `--ascending',
21341 `--early' and `--late'. Refer to the Namazu documentation for further
21342 information on valid switches.
21344 Mail must first be indexed with the `mknmz' program. Read the documentation
21345 for namazu to create a configuration file. Here is an example:
21349 package conf; # Don't remove this line!
21351 # Paths which will not be indexed. Don't use `^' or `$' anchors.
21352 $EXCLUDE_PATH = "spam|sent";
21354 # Header fields which should be searchable. case-insensitive
21355 $REMAIN_HEADER = "from|date|message-id|subject";
21357 # Searchable fields. case-insensitive
21358 $SEARCH_FIELD = "from|date|message-id|subject";
21360 # The max length of a word.
21361 $WORD_LENG_MAX = 128;
21363 # The max length of a field.
21364 $MAX_FIELD_LENGTH = 256;
21368 For this example, mail is stored in the directories @samp{~/Mail/mail/},
21369 @samp{~/Mail/lists/} and @samp{~/Mail/archive/}, so to index them go to
21370 the index directory set in @code{nnir-namazu-index-directory} and issue
21371 the following command:
21374 mknmz --mailnews ~/Mail/archive/ ~/Mail/mail/ ~/Mail/lists/
21377 For maximum searching efficiency you might want to have a cron job run
21378 this command periodically, say every four hours.
21380 @node The hyrex Engine
21381 @subsubsection The hyrex Engine
21382 This engine is obsolete.
21384 @node Customizations
21385 @subsubsection Customizations
21389 @item nnir-method-default-engines
21390 Alist of pairs of server backends and search engines. The default associations
21397 @item nnir-ignored-newsgroups
21398 A regexp to match newsgroups in the active file that should be skipped
21399 when searching all groups on a server.
21401 @item nnir-summary-line-format
21402 The format specification to be used for lines in an nnir summary buffer.
21403 All the items from `gnus-summary-line-format' are available, along with
21404 three items unique to nnir summary buffers:
21407 %Z Search retrieval score value (integer)
21408 %G Article original full group name (string)
21409 %g Article original short group name (string)
21412 If nil (the default) this will use @code{gnus-summary-line-format}.
21414 @item nnir-retrieve-headers-override-function
21415 If non-nil, a function that retrieves article headers rather than using
21416 the gnus built-in function. This function takes an article list and
21417 group as arguments and populates the `nntp-server-buffer' with the
21418 retrieved headers. It should then return either 'nov or 'headers
21419 indicating the retrieved header format. Failure to retrieve headers
21420 should return @code{nil}
21422 If this variable is nil, or if the provided function returns nil for a
21423 search result, @code{gnus-retrieve-headers} will be called instead."
21434 This paragraph describes how to set up mairix and the back end
21435 @code{nnmairix} for indexing and searching your mail from within
21436 Gnus. Additionally, you can create permanent ``smart'' groups which are
21437 bound to mairix searches and are automatically updated.
21440 * About mairix:: About the mairix mail search engine
21441 * nnmairix requirements:: What you will need for using nnmairix
21442 * What nnmairix does:: What does nnmairix actually do?
21443 * Setting up mairix:: Set up your mairix installation
21444 * Configuring nnmairix:: Set up the nnmairix back end
21445 * nnmairix keyboard shortcuts:: List of available keyboard shortcuts
21446 * Propagating marks:: How to propagate marks from nnmairix groups
21447 * nnmairix tips and tricks:: Some tips, tricks and examples
21448 * nnmairix caveats:: Some more stuff you might want to know
21451 @c FIXME: The markup in this section might need improvement.
21452 @c E.g., adding @samp, @var, @file, @command, etc.
21453 @c Cf. (info "(texinfo)Indicating")
21456 @subsection About mairix
21458 Mairix is a tool for indexing and searching words in locally stored
21459 mail. It was written by Richard Curnow and is licensed under the
21460 GPL@. Mairix comes with most popular GNU/Linux distributions, but it also
21461 runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can
21463 @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html}
21465 Though mairix might not be as flexible as other search tools like
21466 swish++ or namazu, which you can use via the @code{nnir} back end, it
21467 has the prime advantage of being incredibly fast. On current systems, it
21468 can easily search through headers and message bodies of thousands and
21469 thousands of mails in well under a second. Building the database
21470 necessary for searching might take a minute or two, but only has to be
21471 done once fully. Afterwards, the updates are done incrementally and
21472 therefore are really fast, too. Additionally, mairix is very easy to set
21475 For maximum speed though, mairix should be used with mails stored in
21476 @code{Maildir} or @code{MH} format (this includes the @code{nnml} back
21477 end), although it also works with mbox. Mairix presents the search
21478 results by populating a @emph{virtual} maildir/MH folder with symlinks
21479 which point to the ``real'' message files (if mbox is used, copies are
21480 made). Since mairix already presents search results in such a virtual
21481 mail folder, it is very well suited for using it as an external program
21482 for creating @emph{smart} mail folders, which represent certain mail
21485 @node nnmairix requirements
21486 @subsection nnmairix requirements
21488 Mairix searches local mail---that means, mairix absolutely must have
21489 direct access to your mail folders. If your mail resides on another
21490 server (e.g., an @acronym{IMAP} server) and you happen to have shell
21491 access, @code{nnmairix} supports running mairix remotely, e.g., via ssh.
21493 Additionally, @code{nnmairix} only supports the following Gnus back
21494 ends: @code{nnml}, @code{nnmaildir}, and @code{nnimap}. You must use
21495 one of these back ends for using @code{nnmairix}. Other back ends, like
21496 @code{nnmbox}, @code{nnfolder} or @code{nnmh}, won't work.
21498 If you absolutely must use mbox and still want to use @code{nnmairix},
21499 you can set up a local @acronym{IMAP} server, which you then access via
21500 @code{nnimap}. This is a rather massive setup for accessing some mbox
21501 files, so just change to MH or Maildir already... However, if you're
21502 really, really passionate about using mbox, you might want to look into
21503 the package @file{mairix.el}, which comes with Emacs 23.
21505 @node What nnmairix does
21506 @subsection What nnmairix does
21508 The back end @code{nnmairix} enables you to call mairix from within Gnus,
21509 either to query mairix with a search term or to update the
21510 database. While visiting a message in the summary buffer, you can use
21511 several pre-defined shortcuts for calling mairix, e.g., to quickly
21512 search for all mails from the sender of the current message or to
21513 display the whole thread associated with the message, even if the
21514 mails are in different folders.
21516 Additionally, you can create permanent @code{nnmairix} groups which are bound
21517 to certain mairix searches. This way, you can easily create a group
21518 containing mails from a certain sender, with a certain subject line or
21519 even for one specific thread based on the Message-ID@. If you check for
21520 new mail in these folders (e.g., by pressing @kbd{g} or @kbd{M-g}), they
21521 automatically update themselves by calling mairix.
21523 You might ask why you need @code{nnmairix} at all, since mairix already
21524 creates the group, populates it with links to the mails so that you can
21525 then access it with Gnus, right? Well, this @emph{might} work, but often
21526 does not---at least not without problems. Most probably you will get
21527 strange article counts, and sometimes you might see mails which Gnus
21528 claims have already been canceled and are inaccessible. This is due to
21529 the fact that Gnus isn't really amused when things are happening behind
21530 its back. Another problem can be the mail back end itself, e.g., if you
21531 use mairix with an @acronym{IMAP} server (I had Dovecot complaining
21532 about corrupt index files when mairix changed the contents of the search
21533 group). Using @code{nnmairix} should circumvent these problems.
21535 @code{nnmairix} is not really a mail back end---it's actually more like
21536 a wrapper, sitting between a ``real'' mail back end where mairix stores
21537 the searches and the Gnus front end. You can choose between three
21538 different mail back ends for the mairix folders: @code{nnml},
21539 @code{nnmaildir} or @code{nnimap}. @code{nnmairix} will call the mairix
21540 binary so that the search results are stored in folders named
21541 @code{zz_mairix-<NAME>-<NUMBER>} on this mail back end, but it will
21542 present these folders in the Gnus front end only with @code{<NAME>}.
21543 You can use an existing mail back end where you already store your mail,
21544 but if you're uncomfortable with @code{nnmairix} creating new mail
21545 groups alongside your other mail, you can also create, e.g., a new
21546 @code{nnmaildir} or @code{nnml} server exclusively for mairix, but then
21547 make sure those servers do not accidentally receive your new mail
21548 (@pxref{nnmairix caveats}). A special case exists if you want to use
21549 mairix remotely on an IMAP server with @code{nnimap}---here the mairix
21550 folders and your other mail must be on the same @code{nnimap} back end.
21552 @node Setting up mairix
21553 @subsection Setting up mairix
21555 First: create a backup of your mail folders (@pxref{nnmairix caveats}).
21557 Setting up mairix is easy: simply create a @file{.mairixrc} file with
21558 (at least) the following entries:
21561 # Your Maildir/MH base folder
21565 This is the base folder for your mails. All the following directories
21566 are relative to this base folder. If you want to use @code{nnmairix}
21567 with @code{nnimap}, this base directory has to point to the mail
21568 directory where the @acronym{IMAP} server stores the mail folders!
21571 maildir= ... your maildir folders which should be indexed ...
21572 mh= ... your nnml/mh folders which should be indexed ...
21573 mbox = ... your mbox files which should be indexed ...
21576 This specifies all your mail folders and mbox files (relative to the
21577 base directory!) you want to index with mairix. Note that the
21578 @code{nnml} back end saves mails in MH format, so you have to put those
21579 directories in the @code{mh} line. See the example at the end of this
21580 section and mairixrc's man-page for further details.
21586 @vindex nnmairix-group-prefix
21587 This should make sure that you don't accidentally index the mairix
21588 search results. You can change the prefix of these folders with the
21589 variable @code{nnmairix-group-prefix}.
21592 mformat= ... 'maildir' or 'mh' ...
21593 database= ... location of database file ...
21596 The @code{format} setting specifies the output format for the mairix
21597 search folder. Set this to @code{mh} if you want to access search results
21598 with @code{nnml}. Otherwise choose @code{maildir}.
21600 To summarize, here is my shortened @file{.mairixrc} file as an example:
21604 maildir=.personal:.work:.logcheck:.sent
21605 mh=../Mail/nnml/*...
21606 mbox=../mboxmail/mailarchive_year*
21609 database=~/.mairixdatabase
21612 In this case, the base directory is @file{~/Maildir}, where all my Maildir
21613 folders are stored. As you can see, the folders are separated by
21614 colons. If you wonder why every folder begins with a dot: this is
21615 because I use Dovecot as @acronym{IMAP} server, which again uses
21616 @code{Maildir++} folders. For testing nnmairix, I also have some
21617 @code{nnml} mail, which is saved in @file{~/Mail/nnml}. Since this has
21618 to be specified relative to the @code{base} directory, the @code{../Mail}
21619 notation is needed. Note that the line ends in @code{*...}, which means
21620 to recursively scan all files under this directory. Without the three
21621 dots, the wildcard @code{*} will not work recursively. I also have some
21622 old mbox files with archived mail lying around in @file{~/mboxmail}.
21623 The other lines should be obvious.
21625 See the man page for @code{mairixrc} for details and further options,
21626 especially regarding wildcard usage, which may be a little different
21627 than you are used to.
21629 Now simply call @code{mairix} to create the index for the first time.
21630 Note that this may take a few minutes, but every following index will do
21631 the updates incrementally and hence is very fast.
21633 @node Configuring nnmairix
21634 @subsection Configuring nnmairix
21636 In group mode, type @kbd{G b c}
21637 (@code{nnmairix-create-server-and-default-group}). This will ask you for all
21638 necessary information and create a @code{nnmairix} server as a foreign
21639 server. You will have to specify the following:
21644 The @strong{name} of the @code{nnmairix} server---choose whatever you
21648 The name of the @strong{back end server} where mairix should store its
21649 searches. This must be a full server name, like @code{nnml:mymail}.
21650 Just hit @kbd{TAB} to see the available servers. Currently, servers
21651 which are accessed through @code{nnmaildir}, @code{nnimap} and
21652 @code{nnml} are supported. As explained above, for locally stored
21653 mails, this can be an existing server where you store your mails.
21654 However, you can also create, e.g., a new @code{nnmaildir} or @code{nnml}
21655 server exclusively for @code{nnmairix} in your secondary select methods
21656 (@pxref{Finding the News}). If you use a secondary @code{nnml} server
21657 just for mairix, make sure that you explicitly set the server variable
21658 @code{nnml-get-new-mail} to @code{nil}, or you might lose mail
21659 (@pxref{nnmairix caveats}). If you want to use mairix remotely on an
21660 @acronym{IMAP} server, you have to choose the corresponding
21661 @code{nnimap} server here.
21664 @vindex nnmairix-mairix-search-options
21665 The @strong{command} to call the mairix binary. This will usually just
21666 be @code{mairix}, but you can also choose something like @code{ssh
21667 SERVER mairix} if you want to call mairix remotely, e.g., on your
21668 @acronym{IMAP} server. If you want to add some default options to
21669 mairix, you could do this here, but better use the variable
21670 @code{nnmairix-mairix-search-options} instead.
21673 The name of the @strong{default search group}. This will be the group
21674 where all temporary mairix searches are stored, i.e., all searches which
21675 are not bound to permanent @code{nnmairix} groups. Choose whatever you
21679 If the mail back end is @code{nnimap} or @code{nnmaildir}, you will be
21680 asked if you work with @strong{Maildir++}, i.e., with hidden maildir
21681 folders (=beginning with a dot). For example, you have to answer
21682 @samp{yes} here if you work with the Dovecot @acronym{IMAP}
21683 server. Otherwise, you should answer @samp{no} here.
21687 @node nnmairix keyboard shortcuts
21688 @subsection nnmairix keyboard shortcuts
21695 @kindex G b c (Group)
21696 @findex nnmairix-create-server-and-default-group
21697 Creates @code{nnmairix} server and default search group for this server
21698 (@code{nnmairix-create-server-and-default-group}). You should have done
21699 this by now (@pxref{Configuring nnmairix}).
21702 @kindex G b s (Group)
21703 @findex nnmairix-search
21704 Prompts for query which is then sent to the mairix binary. Search
21705 results are put into the default search group which is automatically
21706 displayed (@code{nnmairix-search}).
21709 @kindex G b m (Group)
21710 @findex nnmairix-widget-search
21711 Allows you to create a mairix search or a permanent group more
21712 comfortably using graphical widgets, similar to a customization
21713 group. Just try it to see how it works (@code{nnmairix-widget-search}).
21716 @kindex G b i (Group)
21717 @findex nnmairix-search-interactive
21718 Another command for creating a mairix query more comfortably, but uses
21719 only the minibuffer (@code{nnmairix-search-interactive}).
21722 @kindex G b g (Group)
21723 @findex nnmairix-create-search-group
21724 Creates a permanent group which is associated with a search query
21725 (@code{nnmairix-create-search-group}). The @code{nnmairix} back end
21726 automatically calls mairix when you update this group with @kbd{g} or
21730 @kindex G b q (Group)
21731 @findex nnmairix-group-change-query-this-group
21732 Changes the search query for the @code{nnmairix} group under cursor
21733 (@code{nnmairix-group-change-query-this-group}).
21736 @kindex G b t (Group)
21737 @findex nnmairix-group-toggle-threads-this-group
21738 Toggles the 'threads' parameter for the @code{nnmairix} group under cursor,
21739 i.e., if you want see the whole threads of the found messages
21740 (@code{nnmairix-group-toggle-threads-this-group}).
21743 @kindex G b u (Group)
21744 @findex nnmairix-update-database
21745 @vindex nnmairix-mairix-update-options
21746 Calls mairix binary for updating the database
21747 (@code{nnmairix-update-database}). The default parameters are @code{-F}
21748 and @code{-Q} for making this as fast as possible (see variable
21749 @code{nnmairix-mairix-update-options} for defining these default
21753 @kindex G b r (Group)
21754 @findex nnmairix-group-toggle-readmarks-this-group
21755 Keep articles in this @code{nnmairix} group always read or unread, or leave the
21756 marks unchanged (@code{nnmairix-group-toggle-readmarks-this-group}).
21759 @kindex G b d (Group)
21760 @findex nnmairix-group-delete-recreate-this-group
21761 Recreate @code{nnmairix} group on the ``real'' mail back end
21762 (@code{nnmairix-group-delete-recreate-this-group}). You can do this if
21763 you always get wrong article counts with a @code{nnmairix} group.
21766 @kindex G b a (Group)
21767 @findex nnmairix-group-toggle-allowfast-this-group
21768 Toggles the @code{allow-fast} parameters for group under cursor
21769 (@code{nnmairix-group-toggle-allowfast-this-group}). The default
21770 behavior of @code{nnmairix} is to do a mairix search every time you
21771 update or enter the group. With the @code{allow-fast} parameter set,
21772 mairix will only be called when you explicitly update the group, but not
21773 upon entering. This makes entering the group faster, but it may also
21774 lead to dangling symlinks if something changed between updating and
21775 entering the group which is not yet in the mairix database.
21778 @kindex G b p (Group)
21779 @findex nnmairix-group-toggle-propmarks-this-group
21780 Toggle marks propagation for this group
21781 (@code{nnmairix-group-toggle-propmarks-this-group}). (@pxref{Propagating
21785 @kindex G b o (Group)
21786 @findex nnmairix-propagate-marks
21787 Manually propagate marks (@code{nnmairix-propagate-marks}); needed only when
21788 @code{nnmairix-propagate-marks-upon-close} is set to @code{nil}.
21797 @kindex $ m (Summary)
21798 @findex nnmairix-widget-search-from-this-article
21799 Allows you to create a mairix query or group based on the current
21800 message using graphical widgets (same as @code{nnmairix-widget-search})
21801 (@code{nnmairix-widget-search-from-this-article}).
21804 @kindex $ g (Summary)
21805 @findex nnmairix-create-search-group-from-message
21806 Interactively creates a new search group with query based on the current
21807 message, but uses the minibuffer instead of graphical widgets
21808 (@code{nnmairix-create-search-group-from-message}).
21811 @kindex $ t (Summary)
21812 @findex nnmairix-search-thread-this-article
21813 Searches thread for the current article
21814 (@code{nnmairix-search-thread-this-article}). This is effectively a
21815 shortcut for calling @code{nnmairix-search} with @samp{m:msgid} of the
21816 current article and enabled threads.
21819 @kindex $ f (Summary)
21820 @findex nnmairix-search-from-this-article
21821 Searches all messages from sender of the current article
21822 (@code{nnmairix-search-from-this-article}). This is a shortcut for
21823 calling @code{nnmairix-search} with @samp{f:From}.
21826 @kindex $ o (Summary)
21827 @findex nnmairix-goto-original-article
21828 (Only in @code{nnmairix} groups!) Tries determine the group this article
21829 originally came from and displays the article in this group, so that,
21830 e.g., replying to this article the correct posting styles/group
21831 parameters are applied (@code{nnmairix-goto-original-article}). This
21832 function will use the registry if available, but can also parse the
21833 article file name as a fallback method.
21836 @kindex $ u (Summary)
21837 @findex nnmairix-remove-tick-mark-original-article
21838 Remove possibly existing tick mark from original article
21839 (@code{nnmairix-remove-tick-mark-original-article}). (@pxref{nnmairix
21844 @node Propagating marks
21845 @subsection Propagating marks
21847 First of: you really need a patched mairix binary for using the marks
21848 propagation feature efficiently. Otherwise, you would have to update
21849 the mairix database all the time. You can get the patch at
21851 @uref{http://www.randomsample.de/mairix-maildir-patch.tar}
21853 You need the mairix v0.21 source code for this patch; everything else
21854 is explained in the accompanied readme file. If you don't want to use
21855 marks propagation, you don't have to apply these patches, but they also
21856 fix some annoyances regarding changing maildir flags, so it might still
21859 With the patched mairix binary, you can use @code{nnmairix} as an
21860 alternative to mail splitting (@pxref{Fancy Mail Splitting}). For
21861 example, instead of splitting all mails from @samp{david@@foobar.com}
21862 into a group, you can simply create a search group with the query
21863 @samp{f:david@@foobar.com}. This is actually what ``smart folders'' are
21864 all about: simply put everything in one mail folder and dynamically
21865 create searches instead of splitting. This is more flexible, since you
21866 can dynamically change your folders any time you want to. This also
21867 implies that you will usually read your mails in the @code{nnmairix}
21868 groups instead of your ``real'' mail groups.
21870 There is one problem, though: say you got a new mail from
21871 @samp{david@@foobar.com}; it will now show up in two groups, the
21872 ``real'' group (your INBOX, for example) and in the @code{nnmairix}
21873 search group (provided you have updated the mairix database). Now you
21874 enter the @code{nnmairix} group and read the mail. The mail will be
21875 marked as read, but only in the @code{nnmairix} group---in the ``real''
21876 mail group it will be still shown as unread.
21878 You could now catch up the mail group (@pxref{Group Data}), but this is
21879 tedious and error prone, since you may overlook mails you don't have
21880 created @code{nnmairix} groups for. Of course, you could first use
21881 @code{nnmairix-goto-original-article} (@pxref{nnmairix keyboard
21882 shortcuts}) and then read the mail in the original group, but that's
21883 even more cumbersome.
21885 Clearly, the easiest way would be if marks could somehow be
21886 automatically set for the original article. This is exactly what
21887 @emph{marks propagation} is about.
21889 Marks propagation is inactive by default. You can activate it for a
21890 certain @code{nnmairix} group with
21891 @code{nnmairix-group-toggle-propmarks-this-group} (bound to @kbd{G b
21892 p}). This function will warn you if you try to use it with your default
21893 search group; the reason is that the default search group is used for
21894 temporary searches, and it's easy to accidentally propagate marks from
21895 this group. However, you can ignore this warning if you really want to.
21897 With marks propagation enabled, all the marks you set in a @code{nnmairix}
21898 group should now be propagated to the original article. For example,
21899 you can now tick an article (by default with @kbd{!}) and this mark should
21900 magically be set for the original article, too.
21902 A few more remarks which you may or may not want to know:
21904 @vindex nnmairix-propagate-marks-upon-close
21905 Marks will not be set immediately, but only upon closing a group. This
21906 not only makes marks propagation faster, it also avoids problems with
21907 dangling symlinks when dealing with maildir files (since changing flags
21908 will change the file name). You can also control when to propagate marks
21909 via @code{nnmairix-propagate-marks-upon-close} (see the doc-string for
21912 Obviously, @code{nnmairix} will have to look up the original group for every
21913 article you want to set marks for. If available, @code{nnmairix} will first use
21914 the registry for determining the original group. The registry is very
21915 fast, hence you should really, really enable the registry when using
21916 marks propagation. If you don't have to worry about RAM and disc space,
21917 set @code{gnus-registry-max-entries} to a large enough value; to be on
21918 the safe side, choose roughly the amount of mails you index with mairix.
21920 @vindex nnmairix-only-use-registry
21921 If you don't want to use the registry or the registry hasn't seen the
21922 original article yet, @code{nnmairix} will use an additional mairix
21923 search for determining the file name of the article. This, of course, is
21924 way slower than the registry---if you set hundreds or even thousands of
21925 marks this way, it might take some time. You can avoid this situation by
21926 setting @code{nnmairix-only-use-registry} to t.
21928 Maybe you also want to propagate marks the other way round, i.e., if you
21929 tick an article in a "real" mail group, you'd like to have the same
21930 article in a @code{nnmairix} group ticked, too. For several good
21931 reasons, this can only be done efficiently if you use maildir. To
21932 immediately contradict myself, let me mention that it WON'T work with
21933 @code{nnmaildir}, since @code{nnmaildir} stores the marks externally and
21934 not in the file name. Therefore, propagating marks to @code{nnmairix}
21935 groups will usually only work if you use an IMAP server which uses
21936 maildir as its file format.
21938 @vindex nnmairix-propagate-marks-to-nnmairix-groups
21939 If you work with this setup, just set
21940 @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t} and see what
21941 happens. If you don't like what you see, just set it to @code{nil} again. One
21942 problem might be that you get a wrong number of unread articles; this
21943 usually happens when you delete or expire articles in the original
21944 groups. When this happens, you can recreate the @code{nnmairix} group on the
21945 back end using @kbd{G b d}.
21947 @node nnmairix tips and tricks
21948 @subsection nnmairix tips and tricks
21954 @findex nnmairix-update-groups
21955 I put all my important mail groups at group level 1. The mairix groups
21956 have group level 5, so they do not get checked at start up (@pxref{Group
21959 I use the following to check for mails:
21962 (defun my-check-mail-mairix-update (level)
21964 ;; if no prefix given, set level=1
21965 (gnus-group-get-new-news (or level 1))
21966 (nnmairix-update-groups "mairixsearch" t t)
21967 (gnus-group-list-groups))
21969 (define-key gnus-group-mode-map "g" 'my-check-mail-mairix-update)
21972 Instead of @samp{"mairixsearch"} use the name of your @code{nnmairix}
21973 server. See the doc string for @code{nnmairix-update-groups} for
21977 Example: search group for ticked articles
21979 For example, you can create a group for all ticked articles, where the
21980 articles always stay unread:
21982 Hit @kbd{G b g}, enter group name (e.g., @samp{important}), use
21983 @samp{F:f} as query and do not include threads.
21985 Now activate marks propagation for this group by using @kbd{G b p}. Then
21986 activate the always-unread feature by using @kbd{G b r} twice.
21988 So far so good---but how do you remove the tick marks in the @code{nnmairix}
21989 group? There are two options: You may simply use
21990 @code{nnmairix-remove-tick-mark-original-article} (bound to @kbd{$ u}) to remove
21991 tick marks from the original article. The other possibility is to set
21992 @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above
21993 comments about this option. If it works for you, the tick marks should
21994 also exist in the @code{nnmairix} group and you can remove them as usual,
21995 e.g., by marking an article as read.
21997 When you have removed a tick mark from the original article, this
21998 article should vanish from the @code{nnmairix} group after you have updated the
21999 mairix database and updated the group. Fortunately, there is a function
22000 for doing exactly that: @code{nnmairix-update-groups}. See the previous code
22001 snippet and the doc string for details.
22004 Dealing with auto-subscription of mail groups
22006 As described before, all @code{nnmairix} groups are in fact stored on
22007 the mail back end in the form @samp{zz_mairix-<NAME>-<NUMBER>}. You can
22008 see them when you enter the back end server in the server buffer. You
22009 should not subscribe these groups! Unfortunately, these groups will
22010 usually get @emph{auto-subscribed} when you use @code{nnmaildir} or
22011 @code{nnml}, i.e., you will suddenly see groups of the form
22012 @samp{zz_mairix*} pop up in your group buffer. If this happens to you,
22013 simply kill these groups with C-k. For avoiding this, turn off
22014 auto-subscription completely by setting the variable
22015 @code{gnus-auto-subscribed-groups} to @code{nil} (@pxref{Filtering New
22016 Groups}), or if you like to keep this feature use the following kludge
22017 for turning it off for all groups beginning with @samp{zz_}:
22020 (setq gnus-auto-subscribed-groups
22021 "^\\(nnml\\|nnfolder\\|nnmbox\\|nnmh\\|nnbabyl\\|nnmaildir\\).*:\\([^z]\\|z$\\|\\z[^z]\\|zz$\\|zz[^_]\\|zz_$\\).*")
22026 @node nnmairix caveats
22027 @subsection nnmairix caveats
22031 You can create a secondary @code{nnml} server just for nnmairix, but then
22032 you have to explicitly set the corresponding server variable
22033 @code{nnml-get-new-mail} to @code{nil}. Otherwise, new mail might get
22034 put into this secondary server (and would never show up again). Here's
22035 an example server definition:
22038 (nnml "mairix" (nnml-directory "mairix") (nnml-get-new-mail nil))
22041 (The @code{nnmaildir} back end also has a server variable
22042 @code{get-new-mail}, but its default value is @code{nil}, so you don't
22043 have to explicitly set it if you use a @code{nnmaildir} server just for
22047 If you use the Gnus registry: don't use the registry with
22048 @code{nnmairix} groups (put them in
22049 @code{gnus-registry-unfollowed-groups}; this is the default). Be
22050 @emph{extra careful} if you use
22051 @code{gnus-registry-split-fancy-with-parent}; mails which are split
22052 into @code{nnmairix} groups are usually gone for good as soon as you
22053 check the group for new mail (yes, it has happened to me...).
22056 Therefore: @emph{Never ever} put ``real'' mails into @code{nnmairix}
22057 groups (you shouldn't be able to, anyway).
22060 If you use the Gnus agent (@pxref{Gnus Unplugged}): don't agentize
22061 @code{nnmairix} groups (though I have no idea what happens if you do).
22064 mairix does only support us-ascii characters.
22067 @code{nnmairix} uses a rather brute force method to force Gnus to
22068 completely reread the group on the mail back end after mairix was
22069 called---it simply deletes and re-creates the group on the mail
22070 back end. So far, this has worked for me without any problems, and I
22071 don't see how @code{nnmairix} could delete other mail groups than its
22072 own, but anyway: you really should have a backup of your mail
22076 All necessary information is stored in the group parameters
22077 (@pxref{Group Parameters}). This has the advantage that no active file
22078 is needed, but also implies that when you kill a @code{nnmairix} group,
22079 it is gone for good.
22082 @findex nnmairix-purge-old-groups
22083 If you create and kill a lot of @code{nnmairix} groups, the
22084 ``zz_mairix-*'' groups will accumulate on the mail back end server. To
22085 delete old groups which are no longer needed, call
22086 @code{nnmairix-purge-old-groups}. Note that this assumes that you don't
22087 save any ``real'' mail in folders of the form
22088 @code{zz_mairix-<NAME>-<NUMBER>}. You can change the prefix of
22089 @code{nnmairix} groups by changing the variable
22090 @code{nnmairix-group-prefix}.
22093 The following only applies if you @emph{don't} use the mentioned patch
22094 for mairix (@pxref{Propagating marks}):
22096 A problem can occur when using @code{nnmairix} with maildir folders and
22097 comes with the fact that maildir stores mail flags like @samp{Seen} or
22098 @samp{Replied} by appending chars @samp{S} and @samp{R} to the message
22099 file name, respectively. This implies that currently you would have to
22100 update the mairix database not only when new mail arrives, but also when
22101 mail flags are changing. The same applies to new mails which are indexed
22102 while they are still in the @samp{new} folder but then get moved to
22103 @samp{cur} when Gnus has seen the mail. If you don't update the database
22104 after this has happened, a mairix query can lead to symlinks pointing to
22105 non-existing files. In Gnus, these messages will usually appear with
22106 ``(none)'' entries in the header and can't be accessed. If this happens
22107 to you, using @kbd{G b u} and updating the group will usually fix this.
22114 @include message.texi
22115 @chapter Emacs MIME
22116 @include emacs-mime.texi
22118 @include sieve.texi
22130 * Process/Prefix:: A convention used by many treatment commands.
22131 * Interactive:: Making Gnus ask you many questions.
22132 * Symbolic Prefixes:: How to supply some Gnus functions with options.
22133 * Formatting Variables:: You can specify what buffers should look like.
22134 * Window Layout:: Configuring the Gnus buffer windows.
22135 * Faces and Fonts:: How to change how faces look.
22136 * Mode Lines:: Displaying information in the mode lines.
22137 * Highlighting and Menus:: Making buffers look all nice and cozy.
22138 * Daemons:: Gnus can do things behind your back.
22139 * Undo:: Some actions can be undone.
22140 * Predicate Specifiers:: Specifying predicates.
22141 * Moderation:: What to do if you're a moderator.
22142 * Fetching a Group:: Starting Gnus just to read a group.
22143 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
22144 * Fuzzy Matching:: What's the big fuzz?
22145 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
22146 * Spam Package:: A package for filtering and processing spam.
22147 * The Gnus Registry:: A package for tracking messages by Message-ID.
22148 * Other modes:: Interaction with other modes.
22149 * Various Various:: Things that are really various.
22153 @node Process/Prefix
22154 @section Process/Prefix
22155 @cindex process/prefix convention
22157 Many functions, among them functions for moving, decoding and saving
22158 articles, use what is known as the @dfn{Process/Prefix convention}.
22160 This is a method for figuring out what articles the user wants the
22161 command to be performed on.
22165 If the numeric prefix is N, perform the operation on the next N
22166 articles, starting with the current one. If the numeric prefix is
22167 negative, perform the operation on the previous N articles, starting
22168 with the current one.
22170 @vindex transient-mark-mode
22171 If @code{transient-mark-mode} in non-@code{nil} and the region is
22172 active, all articles in the region will be worked upon.
22174 If there is no numeric prefix, but some articles are marked with the
22175 process mark, perform the operation on the articles marked with
22178 If there is neither a numeric prefix nor any articles marked with the
22179 process mark, just perform the operation on the current article.
22181 Quite simple, really, but it needs to be made clear so that surprises
22184 Commands that react to the process mark will push the current list of
22185 process marked articles onto a stack and will then clear all process
22186 marked articles. You can restore the previous configuration with the
22187 @kbd{M P y} command (@pxref{Setting Process Marks}).
22189 @vindex gnus-summary-goto-unread
22190 One thing that seems to shock & horrify lots of people is that, for
22191 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
22192 Since each @kbd{d} (which marks the current article as read) by default
22193 goes to the next unread article after marking, this means that @kbd{3 d}
22194 will mark the next three unread articles as read, no matter what the
22195 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
22196 @code{nil} for a more straightforward action.
22198 Many commands do not use the process/prefix convention. All commands
22199 that do explicitly say so in this manual. To apply the process/prefix
22200 convention to commands that do not use it, you can use the @kbd{M-&}
22201 command. For instance, to mark all the articles in the group as
22202 expirable, you could say @kbd{M P b M-& E}.
22206 @section Interactive
22207 @cindex interaction
22211 @item gnus-novice-user
22212 @vindex gnus-novice-user
22213 If this variable is non-@code{nil}, you are either a newcomer to the
22214 World of Usenet, or you are very cautious, which is a nice thing to be,
22215 really. You will be given questions of the type ``Are you sure you want
22216 to do this?'' before doing anything dangerous. This is @code{t} by
22219 @item gnus-expert-user
22220 @vindex gnus-expert-user
22221 If this variable is non-@code{nil}, you will seldom be asked any
22222 questions by Gnus. It will simply assume you know what you're doing,
22223 no matter how strange. For example, quitting Gnus, exiting a group
22224 without an update, catching up with a group, deleting expired
22225 articles, and replying by mail to a news message will not require
22228 @item gnus-interactive-catchup
22229 @vindex gnus-interactive-catchup
22230 Require confirmation before catching up a group if non-@code{nil}. It
22231 is @code{t} by default.
22233 @item gnus-interactive-exit
22234 @vindex gnus-interactive-exit
22235 If non-@code{nil}, require a confirmation when exiting Gnus. If
22236 @code{quiet}, update any active summary buffers automatically without
22237 querying. The default value is @code{t}.
22241 @node Symbolic Prefixes
22242 @section Symbolic Prefixes
22243 @cindex symbolic prefixes
22245 Quite a lot of Emacs commands react to the (numeric) prefix. For
22246 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
22247 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
22248 rule of 900 to the current article.
22250 This is all nice and well, but what if you want to give a command some
22251 additional information? Well, what most commands do is interpret the
22252 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
22253 doesn't want a backup file to be created when saving the current buffer,
22254 for instance. But what if you want to save without making a backup
22255 file, and you want Emacs to flash lights and play a nice tune at the
22256 same time? You can't, and you're probably perfectly happy that way.
22258 @kindex M-i (Summary)
22259 @findex gnus-symbolic-argument
22260 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
22261 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
22262 character typed in is the value. You can stack as many @kbd{M-i}
22263 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
22264 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
22265 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
22266 @code{b}''. You get the drift.
22268 Typing in symbolic prefixes to commands that don't accept them doesn't
22269 hurt, but it doesn't do any good either. Currently not many Gnus
22270 functions make use of the symbolic prefix.
22272 If you're interested in how Gnus implements this, @pxref{Extended
22276 @node Formatting Variables
22277 @section Formatting Variables
22278 @cindex formatting variables
22280 Throughout this manual you've probably noticed lots of variables called
22281 things like @code{gnus-group-line-format} and
22282 @code{gnus-summary-mode-line-format}. These control how Gnus is to
22283 output lines in the various buffers. There's quite a lot of them.
22284 Fortunately, they all use the same syntax, so there's not that much to
22287 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
22288 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
22289 lots of percentages everywhere.
22292 * Formatting Basics:: A formatting variable is basically a format string.
22293 * Mode Line Formatting:: Some rules about mode line formatting variables.
22294 * Advanced Formatting:: Modifying output in various ways.
22295 * User-Defined Specs:: Having Gnus call your own functions.
22296 * Formatting Fonts:: Making the formatting look colorful and nice.
22297 * Positioning Point:: Moving point to a position after an operation.
22298 * Tabulation:: Tabulating your output.
22299 * Wide Characters:: Dealing with wide characters.
22302 Currently Gnus uses the following formatting variables:
22303 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
22304 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
22305 @code{gnus-group-mode-line-format},
22306 @code{gnus-summary-mode-line-format},
22307 @code{gnus-article-mode-line-format},
22308 @code{gnus-server-mode-line-format}, and
22309 @code{gnus-summary-pick-line-format}.
22311 All these format variables can also be arbitrary elisp forms. In that
22312 case, they will be @code{eval}ed to insert the required lines.
22314 @kindex M-x gnus-update-format
22315 @findex gnus-update-format
22316 Gnus includes a command to help you while creating your own format
22317 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
22318 update the spec in question and pop you to a buffer where you can
22319 examine the resulting Lisp code to be run to generate the line.
22323 @node Formatting Basics
22324 @subsection Formatting Basics
22326 Each @samp{%} element will be replaced by some string or other when the
22327 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
22328 spec, and pad with spaces to get a 5-character field''.
22330 As with normal C and Emacs Lisp formatting strings, the numerical
22331 modifier between the @samp{%} and the formatting type character will
22332 @dfn{pad} the output so that it is always at least that long.
22333 @samp{%5y} will make the field always (at least) five characters wide by
22334 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
22337 You may also wish to limit the length of the field to protect against
22338 particularly wide values. For that you can say @samp{%4,6y}, which
22339 means that the field will never be more than 6 characters wide and never
22340 less than 4 characters wide.
22342 Also Gnus supports some extended format specifications, such as
22343 @samp{%&user-date;}.
22346 @node Mode Line Formatting
22347 @subsection Mode Line Formatting
22349 Mode line formatting variables (e.g.,
22350 @code{gnus-summary-mode-line-format}) follow the same rules as other,
22351 buffer line oriented formatting variables (@pxref{Formatting Basics})
22352 with the following two differences:
22357 There must be no newline (@samp{\n}) at the end.
22360 The special @samp{%%b} spec can be used to display the buffer name.
22361 Well, it's no spec at all, really---@samp{%%} is just a way to quote
22362 @samp{%} to allow it to pass through the formatting machinery unmangled,
22363 so that Emacs receives @samp{%b}, which is something the Emacs mode line
22364 display interprets to mean ``show the buffer name''. For a full list of
22365 mode line specs Emacs understands, see the documentation of the
22366 @code{mode-line-format} variable.
22371 @node Advanced Formatting
22372 @subsection Advanced Formatting
22374 It is frequently useful to post-process the fields in some way.
22375 Padding, limiting, cutting off parts and suppressing certain values can
22376 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
22377 look like @samp{%~(cut 3)~(ignore "0")y}.
22379 These are the valid modifiers:
22384 Pad the field to the left with spaces until it reaches the required
22388 Pad the field to the right with spaces until it reaches the required
22393 Cut off characters from the left until it reaches the specified length.
22396 Cut off characters from the right until it reaches the specified
22401 Cut off the specified number of characters from the left.
22404 Cut off the specified number of characters from the right.
22407 Return an empty string if the field is equal to the specified value.
22410 Use the specified form as the field value when the @samp{@@} spec is
22416 "~(form (current-time-string))@@"
22421 Let's take an example. The @samp{%o} spec in the summary mode lines
22422 will return a date in compact ISO8601 format---@samp{19960809T230410}.
22423 This is quite a mouthful, so we want to shave off the century number and
22424 the time, leaving us with a six-character date. That would be
22425 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
22426 maxing, and we need the padding to ensure that the date is never less
22427 than 6 characters to make it look nice in columns.)
22429 Ignoring is done first; then cutting; then maxing; and then as the very
22430 last operation, padding.
22433 @node User-Defined Specs
22434 @subsection User-Defined Specs
22436 All the specs allow for inserting user defined specifiers---@samp{u}.
22437 The next character in the format string should be a letter. Gnus
22438 will call the function @code{gnus-user-format-function-}@samp{X}, where
22439 @samp{X} is the letter following @samp{%u}. The function will be passed
22440 a single parameter---what the parameter means depends on what buffer
22441 it's being called from. The function should return a string, which will
22442 be inserted into the buffer just like information from any other
22443 specifier. This function may also be called with dummy values, so it
22444 should protect against that.
22446 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
22447 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
22449 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
22450 much the same without defining new functions. Here's an example:
22451 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
22452 given here will be evaluated to yield the current line number, and then
22456 @node Formatting Fonts
22457 @subsection Formatting Fonts
22460 @vindex gnus-mouse-face
22461 There are specs for highlighting, and these are shared by all the format
22462 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
22463 the special @code{mouse-face} property set, which means that it will be
22464 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
22468 @vindex gnus-face-0
22469 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
22470 normal faces set using @code{gnus-face-0}, which is @code{bold} by
22471 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
22472 and so on. Create as many faces as you wish. The same goes for the
22473 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
22474 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
22476 @cindex %<<, %>>, guillemets
22477 @c @cindex %<<, %>>, %«, %», guillemets
22478 @vindex gnus-balloon-face-0
22479 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
22480 special @code{balloon-help} property set to
22481 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
22482 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
22483 variables should be either strings or symbols naming functions that
22484 return a string. When the mouse passes over text with this property
22485 set, a balloon window will appear and display the string. Please
22486 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
22487 (in Emacs) or the doc string of @code{balloon-help-mode} (in
22488 XEmacs) for more information on this. (For technical reasons, the
22489 guillemets have been approximated as @samp{<<} and @samp{>>} in this
22492 Here's an alternative recipe for the group buffer:
22495 ;; @r{Create three face types.}
22496 (setq gnus-face-1 'bold)
22497 (setq gnus-face-3 'italic)
22499 ;; @r{We want the article count to be in}
22500 ;; @r{a bold and green face. So we create}
22501 ;; @r{a new face called @code{my-green-bold}.}
22502 (copy-face 'bold 'my-green-bold)
22503 ;; @r{Set the color.}
22504 (set-face-foreground 'my-green-bold "ForestGreen")
22505 (setq gnus-face-2 'my-green-bold)
22507 ;; @r{Set the new & fancy format.}
22508 (setq gnus-group-line-format
22509 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
22512 I'm sure you'll be able to use this scheme to create totally unreadable
22513 and extremely vulgar displays. Have fun!
22515 Note that the @samp{%(} specs (and friends) do not make any sense on the
22516 mode-line variables.
22518 @node Positioning Point
22519 @subsection Positioning Point
22521 Gnus usually moves point to a pre-defined place on each line in most
22522 buffers. By default, point move to the first colon character on the
22523 line. You can customize this behavior in three different ways.
22525 You can move the colon character to somewhere else on the line.
22527 @findex gnus-goto-colon
22528 You can redefine the function that moves the point to the colon. The
22529 function is called @code{gnus-goto-colon}.
22531 But perhaps the most convenient way to deal with this, if you don't want
22532 to have a colon in your line, is to use the @samp{%*} specifier. If you
22533 put a @samp{%*} somewhere in your format line definition, Gnus will
22538 @subsection Tabulation
22540 You can usually line up your displays by padding and cutting your
22541 strings. However, when combining various strings of different size, it
22542 can often be more convenient to just output the strings, and then worry
22543 about lining up the following text afterwards.
22545 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
22546 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
22548 @samp{%50=} will insert space characters to pad the line up to column
22549 50. If the text is already past column 50, nothing will be inserted.
22550 This is the soft tabulator.
22552 @samp{%-50=} will insert space characters to pad the line up to column
22553 50. If the text is already past column 50, the excess text past column
22554 50 will be removed. This is the hard tabulator.
22557 @node Wide Characters
22558 @subsection Wide Characters
22560 Fixed width fonts in most countries have characters of the same width.
22561 Some countries, however, use Latin characters mixed with wider
22562 characters---most notable East Asian countries.
22564 The problem is that when formatting, Gnus assumes that if a string is 10
22565 characters wide, it'll be 10 Latin characters wide on the screen. In
22566 these countries, that's not true.
22568 @vindex gnus-use-correct-string-widths
22569 To help fix this, you can set @code{gnus-use-correct-string-widths} to
22570 @code{t}. This makes buffer generation slower, but the results will be
22571 prettier. The default value under XEmacs is @code{t} but @code{nil}
22575 @node Window Layout
22576 @section Window Layout
22577 @cindex window layout
22579 No, there's nothing here about X, so be quiet.
22581 @vindex gnus-use-full-window
22582 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
22583 other windows and occupy the entire Emacs screen by itself. It is
22584 @code{t} by default.
22586 Setting this variable to @code{nil} kinda works, but there are
22587 glitches. Use at your own peril.
22589 @vindex gnus-buffer-configuration
22590 @code{gnus-buffer-configuration} describes how much space each Gnus
22591 buffer should be given. Here's an excerpt of this variable:
22594 ((group (vertical 1.0 (group 1.0 point)))
22595 (article (vertical 1.0 (summary 0.25 point)
22599 This is an alist. The @dfn{key} is a symbol that names some action or
22600 other. For instance, when displaying the group buffer, the window
22601 configuration function will use @code{group} as the key. A full list of
22602 possible names is listed below.
22604 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
22605 should occupy. To take the @code{article} split as an example:
22608 (article (vertical 1.0 (summary 0.25 point)
22612 This @dfn{split} says that the summary buffer should occupy 25% of upper
22613 half of the screen, and that it is placed over the article buffer. As
22614 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
22615 reaching for that calculator there). However, the special number
22616 @code{1.0} is used to signal that this buffer should soak up all the
22617 rest of the space available after the rest of the buffers have taken
22618 whatever they need. There should be only one buffer with the @code{1.0}
22619 size spec per split.
22621 Point will be put in the buffer that has the optional third element
22622 @code{point}. In a @code{frame} split, the last subsplit having a leaf
22623 split where the tag @code{frame-focus} is a member (i.e., is the third or
22624 fourth element in the list, depending on whether the @code{point} tag is
22625 present) gets focus.
22627 Here's a more complicated example:
22630 (article (vertical 1.0 (group 4)
22631 (summary 0.25 point)
22635 If the size spec is an integer instead of a floating point number,
22636 then that number will be used to say how many lines a buffer should
22637 occupy, not a percentage.
22639 If the @dfn{split} looks like something that can be @code{eval}ed (to be
22640 precise---if the @code{car} of the split is a function or a subr), this
22641 split will be @code{eval}ed. If the result is non-@code{nil}, it will
22642 be used as a split.
22644 Not complicated enough for you? Well, try this on for size:
22647 (article (horizontal 1.0
22651 (summary 0.25 point)
22655 Whoops. Two buffers with the mystery 100% tag. And what's that
22656 @code{horizontal} thingie?
22658 If the first element in one of the split is @code{horizontal}, Gnus will
22659 split the window horizontally, giving you two windows side-by-side.
22660 Inside each of these strips you may carry on all you like in the normal
22661 fashion. The number following @code{horizontal} says what percentage of
22662 the screen is to be given to this strip.
22664 For each split, there @emph{must} be one element that has the 100% tag.
22665 The splitting is never accurate, and this buffer will eat any leftover
22666 lines from the splits.
22668 To be slightly more formal, here's a definition of what a valid split
22673 split = frame | horizontal | vertical | buffer | form
22674 frame = "(frame " size *split ")"
22675 horizontal = "(horizontal " size *split ")"
22676 vertical = "(vertical " size *split ")"
22677 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
22678 size = number | frame-params
22679 buf-name = group | article | summary ...
22683 The limitations are that the @code{frame} split can only appear as the
22684 top-level split. @var{form} should be an Emacs Lisp form that should
22685 return a valid split. We see that each split is fully recursive, and
22686 may contain any number of @code{vertical} and @code{horizontal} splits.
22688 @vindex gnus-window-min-width
22689 @vindex gnus-window-min-height
22690 @cindex window height
22691 @cindex window width
22692 Finding the right sizes can be a bit complicated. No window may be less
22693 than @code{gnus-window-min-height} (default 1) characters high, and all
22694 windows must be at least @code{gnus-window-min-width} (default 1)
22695 characters wide. Gnus will try to enforce this before applying the
22696 splits. If you want to use the normal Emacs window width/height limit,
22697 you can just set these two variables to @code{nil}.
22699 If you're not familiar with Emacs terminology, @code{horizontal} and
22700 @code{vertical} splits may work the opposite way of what you'd expect.
22701 Windows inside a @code{horizontal} split are shown side-by-side, and
22702 windows within a @code{vertical} split are shown above each other.
22704 @findex gnus-configure-frame
22705 If you want to experiment with window placement, a good tip is to call
22706 @code{gnus-configure-frame} directly with a split. This is the function
22707 that does all the real work when splitting buffers. Below is a pretty
22708 nonsensical configuration with 5 windows; two for the group buffer and
22709 three for the article buffer. (I said it was nonsensical.) If you
22710 @code{eval} the statement below, you can get an idea of how that would
22711 look straight away, without going through the normal Gnus channels.
22712 Play with it until you're satisfied, and then use
22713 @code{gnus-add-configuration} to add your new creation to the buffer
22714 configuration list.
22717 (gnus-configure-frame
22721 (article 0.3 point))
22729 You might want to have several frames as well. No prob---just use the
22730 @code{frame} split:
22733 (gnus-configure-frame
22736 (summary 0.25 point frame-focus)
22738 (vertical ((height . 5) (width . 15)
22739 (user-position . t)
22740 (left . -1) (top . 1))
22745 This split will result in the familiar summary/article window
22746 configuration in the first (or ``main'') frame, while a small additional
22747 frame will be created where picons will be shown. As you can see,
22748 instead of the normal @code{1.0} top-level spec, each additional split
22749 should have a frame parameter alist as the size spec.
22750 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
22751 Reference Manual}. Under XEmacs, a frame property list will be
22752 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
22754 The list of all possible keys for @code{gnus-buffer-configuration} can
22755 be found in its default value.
22757 Note that the @code{message} key is used for both
22758 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
22759 it is desirable to distinguish between the two, something like this
22763 (message (horizontal 1.0
22764 (vertical 1.0 (message 1.0 point))
22766 (if (buffer-live-p gnus-summary-buffer)
22771 One common desire for a multiple frame split is to have a separate frame
22772 for composing mail and news while leaving the original frame intact. To
22773 accomplish that, something like the following can be done:
22778 (if (not (buffer-live-p gnus-summary-buffer))
22779 (car (cdr (assoc 'group gnus-buffer-configuration)))
22780 (car (cdr (assoc 'summary gnus-buffer-configuration))))
22781 (vertical ((user-position . t) (top . 1) (left . 1)
22782 (name . "Message"))
22783 (message 1.0 point))))
22786 @findex gnus-add-configuration
22787 Since the @code{gnus-buffer-configuration} variable is so long and
22788 complicated, there's a function you can use to ease changing the config
22789 of a single setting: @code{gnus-add-configuration}. If, for instance,
22790 you want to change the @code{article} setting, you could say:
22793 (gnus-add-configuration
22794 '(article (vertical 1.0
22796 (summary .25 point)
22800 You'd typically stick these @code{gnus-add-configuration} calls in your
22801 @file{~/.gnus.el} file or in some startup hook---they should be run after
22802 Gnus has been loaded.
22804 @vindex gnus-always-force-window-configuration
22805 If all windows mentioned in the configuration are already visible, Gnus
22806 won't change the window configuration. If you always want to force the
22807 ``right'' window configuration, you can set
22808 @code{gnus-always-force-window-configuration} to non-@code{nil}.
22810 If you're using tree displays (@pxref{Tree Display}), and the tree
22811 window is displayed vertically next to another window, you may also want
22812 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
22815 @subsection Window Configuration Names
22817 Here's a list of most of the currently known window configurations,
22818 and when they're used:
22825 Entering a group and showing only the summary.
22828 Selecting an article.
22834 Browsing groups from the server buffer.
22837 Composing a (new) message.
22840 Showing only the article buffer.
22843 Editing an article.
22846 Editing group parameters and the like.
22849 Editing a server definition.
22852 Composing a news message.
22855 Replying or following up an article without yanking the text.
22858 Forwarding a message.
22861 Replying or following up an article with yanking the text.
22864 Bouncing a message.
22867 Sending an article to an external process.
22870 Sending a bug report.
22873 Displaying the score trace.
22876 Displaying the score words.
22879 Displaying the split trace.
22881 @item compose-bounce
22882 Composing a bounce message.
22885 Previewing a @acronym{MIME} part.
22890 @subsection Example Window Configurations
22894 Narrow left hand side occupied by group buffer. Right hand side split
22895 between summary buffer (top one-sixth) and article buffer (bottom).
22910 (gnus-add-configuration
22913 (vertical 25 (group 1.0))
22915 (summary 0.16 point)
22918 (gnus-add-configuration
22921 (vertical 25 (group 1.0))
22922 (vertical 1.0 (summary 1.0 point)))))
22928 @node Faces and Fonts
22929 @section Faces and Fonts
22934 Fiddling with fonts and faces used to be very difficult, but these days
22935 it is very simple. You simply say @kbd{M-x customize-face}, pick out
22936 the face you want to alter, and alter it via the standard Customize
22941 @section Mode Lines
22944 @vindex gnus-updated-mode-lines
22945 @code{gnus-updated-mode-lines} says what buffers should keep their mode
22946 lines updated. It is a list of symbols. Supported symbols include
22947 @code{group}, @code{article}, @code{summary}, @code{server},
22948 @code{browse}, and @code{tree}. If the corresponding symbol is present,
22949 Gnus will keep that mode line updated with information that may be
22950 pertinent. If this variable is @code{nil}, screen refresh may be
22953 @cindex display-time
22955 @vindex gnus-mode-non-string-length
22956 By default, Gnus displays information on the current article in the mode
22957 lines of the summary and article buffers. The information Gnus wishes
22958 to display (e.g., the subject of the article) is often longer than the
22959 mode lines, and therefore have to be cut off at some point. The
22960 @code{gnus-mode-non-string-length} variable says how long the other
22961 elements on the line is (i.e., the non-info part). If you put
22962 additional elements on the mode line (e.g., a clock), you should modify
22965 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
22967 (add-hook 'display-time-hook
22968 (lambda () (setq gnus-mode-non-string-length
22970 (if line-number-mode 5 0)
22971 (if column-number-mode 4 0)
22972 (length display-time-string)))))
22975 If this variable is @code{nil} (which is the default), the mode line
22976 strings won't be chopped off, and they won't be padded either. Note
22977 that the default is unlikely to be desirable, as even the percentage
22978 complete in the buffer may be crowded off the mode line; the user should
22979 configure this variable appropriately for her configuration.
22982 @node Highlighting and Menus
22983 @section Highlighting and Menus
22985 @cindex highlighting
22988 @vindex gnus-visual
22989 The @code{gnus-visual} variable controls most of the Gnus-prettifying
22990 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
22991 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
22994 This variable can be a list of visual properties that are enabled. The
22995 following elements are valid, and are all included by default:
22998 @item group-highlight
22999 Do highlights in the group buffer.
23000 @item summary-highlight
23001 Do highlights in the summary buffer.
23002 @item article-highlight
23003 Do highlights in the article buffer.
23005 Turn on highlighting in all buffers.
23007 Create menus in the group buffer.
23009 Create menus in the summary buffers.
23011 Create menus in the article buffer.
23013 Create menus in the browse buffer.
23015 Create menus in the server buffer.
23017 Create menus in the score buffers.
23019 Create menus in all buffers.
23022 So if you only want highlighting in the article buffer and menus in all
23023 buffers, you could say something like:
23026 (setq gnus-visual '(article-highlight menu))
23029 If you want highlighting only and no menus whatsoever, you'd say:
23032 (setq gnus-visual '(highlight))
23035 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
23036 in all Gnus buffers.
23038 Other general variables that influence the look of all buffers include:
23041 @item gnus-mouse-face
23042 @vindex gnus-mouse-face
23043 This is the face (i.e., font) used for mouse highlighting in Gnus. No
23044 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
23048 There are hooks associated with the creation of all the different menus:
23052 @item gnus-article-menu-hook
23053 @vindex gnus-article-menu-hook
23054 Hook called after creating the article mode menu.
23056 @item gnus-group-menu-hook
23057 @vindex gnus-group-menu-hook
23058 Hook called after creating the group mode menu.
23060 @item gnus-summary-menu-hook
23061 @vindex gnus-summary-menu-hook
23062 Hook called after creating the summary mode menu.
23064 @item gnus-server-menu-hook
23065 @vindex gnus-server-menu-hook
23066 Hook called after creating the server mode menu.
23068 @item gnus-browse-menu-hook
23069 @vindex gnus-browse-menu-hook
23070 Hook called after creating the browse mode menu.
23072 @item gnus-score-menu-hook
23073 @vindex gnus-score-menu-hook
23074 Hook called after creating the score mode menu.
23084 Gnus, being larger than any program ever written (allegedly), does lots
23085 of strange stuff that you may wish to have done while you're not
23086 present. For instance, you may want it to check for new mail once in a
23087 while. Or you may want it to close down all connections to all servers
23088 when you leave Emacs idle. And stuff like that.
23090 Gnus will let you do stuff like that by defining various
23091 @dfn{handlers}. Each handler consists of three elements: A
23092 @var{function}, a @var{time}, and an @var{idle} parameter.
23094 Here's an example of a handler that closes connections when Emacs has
23095 been idle for thirty minutes:
23098 (gnus-demon-close-connections nil 30)
23101 Here's a handler that scans for @acronym{PGP} headers every hour when
23105 (gnus-demon-scan-pgp 60 t)
23108 This @var{time} parameter and that @var{idle} parameter work together
23109 in a strange, but wonderful fashion. Basically, if @var{idle} is
23110 @code{nil}, then the function will be called every @var{time} minutes.
23112 If @var{idle} is @code{t}, then the function will be called after
23113 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
23114 the function will never be called. But once Emacs goes idle, the
23115 function will be called every @var{time} minutes.
23117 If @var{idle} is a number and @var{time} is a number, the function will
23118 be called every @var{time} minutes only when Emacs has been idle for
23119 @var{idle} minutes.
23121 If @var{idle} is a number and @var{time} is @code{nil}, the function
23122 will be called once every time Emacs has been idle for @var{idle}
23125 And if @var{time} is a string, it should look like @samp{07:31}, and
23126 the function will then be called once every day somewhere near that
23127 time. Modified by the @var{idle} parameter, of course.
23129 @vindex gnus-demon-timestep
23130 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
23131 seconds. This is 60 by default. If you change that variable,
23132 all the timings in the handlers will be affected.)
23134 So, if you want to add a handler, you could put something like this in
23135 your @file{~/.gnus.el} file:
23137 @findex gnus-demon-add-handler
23139 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
23142 @findex gnus-demon-add-scanmail
23143 @findex gnus-demon-add-rescan
23144 @findex gnus-demon-add-scan-timestamps
23145 @findex gnus-demon-add-disconnection
23146 Some ready-made functions to do this have been created:
23147 @code{gnus-demon-add-disconnection},
23148 @code{gnus-demon-add-nntp-close-connection},
23149 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
23150 @code{gnus-demon-add-scanmail}. Just put those functions in your
23151 @file{~/.gnus.el} if you want those abilities.
23153 @findex gnus-demon-init
23154 @findex gnus-demon-cancel
23155 @vindex gnus-demon-handlers
23156 If you add handlers to @code{gnus-demon-handlers} directly, you should
23157 run @code{gnus-demon-init} to make the changes take hold. To cancel all
23158 daemons, you can use the @code{gnus-demon-cancel} function.
23160 Note that adding daemons can be pretty naughty if you over do it. Adding
23161 functions that scan all news and mail from all servers every two seconds
23162 is a sure-fire way of getting booted off any respectable system. So
23170 It is very useful to be able to undo actions one has done. In normal
23171 Emacs buffers, it's easy enough---you just push the @code{undo} button.
23172 In Gnus buffers, however, it isn't that simple.
23174 The things Gnus displays in its buffer is of no value whatsoever to
23175 Gnus---it's all just data designed to look nice to the user.
23176 Killing a group in the group buffer with @kbd{C-k} makes the line
23177 disappear, but that's just a side-effect of the real action---the
23178 removal of the group in question from the internal Gnus structures.
23179 Undoing something like that can't be done by the normal Emacs
23180 @code{undo} function.
23182 Gnus tries to remedy this somewhat by keeping track of what the user
23183 does and coming up with actions that would reverse the actions the user
23184 takes. When the user then presses the @code{undo} key, Gnus will run
23185 the code to reverse the previous action, or the previous actions.
23186 However, not all actions are easily reversible, so Gnus currently offers
23187 a few key functions to be undoable. These include killing groups,
23188 yanking groups, and changing the list of read articles of groups.
23189 That's it, really. More functions may be added in the future, but each
23190 added function means an increase in data to be stored, so Gnus will
23191 never be totally undoable.
23193 @findex gnus-undo-mode
23194 @vindex gnus-use-undo
23196 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
23197 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
23198 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
23199 command, which should feel kinda like the normal Emacs @code{undo}
23203 @node Predicate Specifiers
23204 @section Predicate Specifiers
23205 @cindex predicate specifiers
23207 Some Gnus variables are @dfn{predicate specifiers}. This is a special
23208 form that allows flexible specification of predicates without having
23209 to type all that much.
23211 These specifiers are lists consisting of functions, symbols and lists.
23216 (or gnus-article-unseen-p
23217 gnus-article-unread-p)
23220 The available symbols are @code{or}, @code{and} and @code{not}. The
23221 functions all take one parameter.
23223 @findex gnus-make-predicate
23224 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
23225 to create a function that can be called. This input parameter to this
23226 function will be passed along to all the functions in the predicate
23231 @section Moderation
23234 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
23235 It is not included in the standard Gnus package. Write a mail to
23236 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
23239 The moderation package is implemented as a minor mode for summary
23243 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
23246 in your @file{~/.gnus.el} file.
23248 If you are the moderator of @samp{rec.zoofle}, this is how it's
23253 You split your incoming mail by matching on
23254 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
23255 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
23258 You enter that group once in a while and post articles using the @kbd{e}
23259 (edit-and-post) or @kbd{s} (just send unedited) commands.
23262 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
23263 articles that weren't approved by you, you can cancel them with the
23267 To use moderation mode in these two groups, say:
23270 (setq gnus-moderated-list
23271 "^nnml:rec.zoofle$\\|^rec.zoofle$")
23275 @node Fetching a Group
23276 @section Fetching a Group
23277 @cindex fetching a group
23279 @findex gnus-fetch-group
23280 It is sometimes convenient to be able to just say ``I want to read this
23281 group and I don't care whether Gnus has been started or not''. This is
23282 perhaps more useful for people who write code than for users, but the
23283 command @code{gnus-fetch-group} provides this functionality in any case.
23284 It takes the group name as a parameter.
23287 @node Image Enhancements
23288 @section Image Enhancements
23290 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
23291 support images, Emacs 22 does.} and up, are able to display pictures and
23292 stuff, so Gnus has taken advantage of that.
23295 * X-Face:: Display a funky, teensy black-and-white image.
23296 * Face:: Display a funkier, teensier colored image.
23297 * Smileys:: Show all those happy faces the way they were meant to be shown.
23298 * Picons:: How to display pictures of what you're reading.
23299 * Gravatars:: Display the avatar of people you read.
23300 * XVarious:: Other XEmacsy Gnusey variables.
23308 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
23309 depth) image that's supposed to represent the author of the message.
23310 It seems to be supported by an ever-growing number of mail and news
23314 @findex gnus-article-display-x-face
23315 @vindex gnus-article-x-face-command
23316 @vindex gnus-article-x-face-too-ugly
23324 Viewing an @code{X-Face} header either requires an Emacs that has
23325 @samp{compface} support (which most XEmacs versions have), or that you
23326 have suitable conversion or display programs installed. If your Emacs
23327 has image support the default action is to display the face before the
23328 @code{From} header. If there's no native @code{X-Face} support, Gnus
23329 will try to convert the @code{X-Face} header using external programs
23330 from the @code{pbmplus} package and friends, see below. For XEmacs it's
23331 faster if XEmacs has been compiled with @code{X-Face} support. The
23332 default action under Emacs without image support is to fork off the
23333 @code{display} program.
23335 On a GNU/Linux system, the @code{display} program is included in the
23336 ImageMagick package. For external conversion programs look for packages
23337 with names like @code{netpbm}, @code{libgr-progs} and @code{compface}.
23338 On Windows, you may use the packages @code{netpbm} and @code{compface}
23339 from @url{http://gnuwin32.sourceforge.net}. You need to add the
23340 @code{bin} directory to your @code{PATH} environment variable.
23341 @c In fact only the following DLLs and binaries seem to be required:
23342 @c compface1.dll uncompface.exe libnetpbm10.dll icontopbm.exe
23344 The variable @code{gnus-article-x-face-command} controls which programs
23345 are used to display the @code{X-Face} header. If this variable is a
23346 string, this string will be executed in a sub-shell. If it is a
23347 function, this function will be called with the face as the argument.
23348 If @code{gnus-article-x-face-too-ugly} (which is a regexp) matches the
23349 @code{From} header, the face will not be shown.
23351 (Note: @code{x-face} is used in the variable/function names, not
23359 @vindex gnus-x-face
23360 Face to show X-Face. The colors from this face are used as the
23361 foreground and background colors of the displayed X-Faces. The
23362 default colors are black and white.
23364 @item gnus-face-properties-alist
23365 @vindex gnus-face-properties-alist
23366 Alist of image types and properties applied to Face (@pxref{Face}) and
23367 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
23368 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
23369 XEmacs. Here are examples:
23372 ;; Specify the altitude of Face and X-Face images in the From header.
23373 (setq gnus-face-properties-alist
23374 '((pbm . (:face gnus-x-face :ascent 80))
23375 (png . (:ascent 80))))
23377 ;; Show Face and X-Face images as pressed buttons.
23378 (setq gnus-face-properties-alist
23379 '((pbm . (:face gnus-x-face :relief -2))
23380 (png . (:relief -2))))
23383 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
23384 Reference Manual} for the valid properties for various image types.
23385 Currently, @code{pbm} is used for X-Face images and @code{png} is used
23386 for Face images in Emacs. Only the @code{:face} property is effective
23387 on the @code{xface} image type in XEmacs if it is built with the
23388 @samp{libcompface} library.
23391 If you use posting styles, you can use an @code{x-face-file} entry in
23392 @code{gnus-posting-styles}, @xref{Posting Styles}. If you don't, Gnus
23393 provides a few convenience functions and variables to allow easier
23394 insertion of X-Face headers in outgoing messages. You also need the
23395 above mentioned ImageMagick, netpbm or other image conversion packages
23396 (depending the values of the variables below) for these functions.
23398 @findex gnus-random-x-face
23399 @vindex gnus-convert-pbm-to-x-face-command
23400 @vindex gnus-x-face-directory
23401 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
23402 @code{gnus-x-face-directory} and picks one at random, and then
23403 converts it to the X-Face format by using the
23404 @code{gnus-convert-pbm-to-x-face-command} shell command. The
23405 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
23406 header data as a string.
23408 @findex gnus-insert-random-x-face-header
23409 @code{gnus-insert-random-x-face-header} calls
23410 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
23411 randomly generated data.
23413 @findex gnus-x-face-from-file
23414 @vindex gnus-convert-image-to-x-face-command
23415 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
23416 converts the file to X-Face format by using the
23417 @code{gnus-convert-image-to-x-face-command} shell command.
23419 Here's how you would typically use the first function. Put something
23420 like the following in your @file{~/.gnus.el} file:
23423 (setq message-required-news-headers
23424 (nconc message-required-news-headers
23425 (list '(X-Face . gnus-random-x-face))))
23428 Using the last function would be something like this:
23431 (setq message-required-news-headers
23432 (nconc message-required-news-headers
23433 (list '(X-Face . (lambda ()
23434 (gnus-x-face-from-file
23435 "~/My-face.gif"))))))
23443 @c #### FIXME: faces and x-faces' implementations should really be harmonized.
23445 @code{Face} headers are essentially a funkier version of @code{X-Face}
23446 ones. They describe a 48x48 pixel colored image that's supposed to
23447 represent the author of the message.
23450 @findex gnus-article-display-face
23451 The contents of a @code{Face} header must be a base64 encoded PNG image.
23452 See @uref{http://quimby.gnus.org/circus/face/} for the precise
23455 The @code{gnus-face-properties-alist} variable affects the appearance of
23456 displayed Face images. @xref{X-Face}.
23458 Viewing a @code{Face} header requires an Emacs that is able to display
23461 @c (if (featurep 'xemacs)
23463 @c (image-type-available-p 'png))
23465 Gnus provides a few convenience functions and variables to allow
23466 easier insertion of Face headers in outgoing messages.
23468 @findex gnus-convert-png-to-face
23469 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
23470 726 bytes long, and converts it to a face.
23472 @findex gnus-face-from-file
23473 @vindex gnus-convert-image-to-face-command
23474 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
23475 converts the file to Face format by using the
23476 @code{gnus-convert-image-to-face-command} shell command.
23478 Here's how you would typically use this function. Put something like the
23479 following in your @file{~/.gnus.el} file:
23482 (setq message-required-news-headers
23483 (nconc message-required-news-headers
23484 (list '(Face . (lambda ()
23485 (gnus-face-from-file "~/face.jpg"))))))
23490 @subsection Smileys
23495 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
23500 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
23501 currently the only package that uses Smiley, it is documented here.
23503 In short---to use Smiley in Gnus, put the following in your
23504 @file{~/.gnus.el} file:
23507 (setq gnus-treat-display-smileys t)
23510 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
23511 the like---to pictures and displays those instead of the text smiley
23512 faces. The conversion is controlled by a list of regexps that matches
23513 text and maps that to file names.
23515 @vindex smiley-regexp-alist
23516 The alist used is specified by the @code{smiley-regexp-alist}
23517 variable. The first item in each element is the regexp to be matched;
23518 the second element is the regexp match group that is to be replaced by
23519 the picture; and the third element is the name of the file to be
23522 The following variables customize the appearance of the smileys:
23527 @vindex smiley-style
23528 Specifies the smiley style. Predefined smiley styles include
23529 @code{low-color} (small 13x14 pixel, three-color images), @code{medium}
23530 (more colorful images, 16x16 pixel), and @code{grayscale} (grayscale
23531 images, 14x14 pixel). The default depends on the height of the default
23534 @item smiley-data-directory
23535 @vindex smiley-data-directory
23536 Where Smiley will look for smiley faces files. You shouldn't set this
23537 variable anymore. Customize @code{smiley-style} instead.
23539 @item gnus-smiley-file-types
23540 @vindex gnus-smiley-file-types
23541 List of suffixes on smiley file names to try.
23555 So@dots{} You want to slow down your news reader even more! This is a
23556 good way to do so. It's also a great way to impress people staring
23557 over your shoulder as you read news.
23559 What are Picons? To quote directly from the Picons Web site:
23568 @dfn{Picons} is short for ``personal icons''. They're small,
23569 constrained images used to represent users and domains on the net,
23570 organized into databases so that the appropriate image for a given
23571 e-mail address can be found. Besides users and domains, there are picon
23572 databases for Usenet newsgroups and weather forecasts. The picons are
23573 in either monochrome @code{XBM} format or color @code{XPM} and
23574 @code{GIF} formats.
23577 @vindex gnus-picon-databases
23578 For instructions on obtaining and installing the picons databases,
23579 point your Web browser at
23580 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
23582 If you are using Debian GNU/Linux, saying @samp{apt-get install
23583 picons.*} will install the picons where Gnus can find them.
23585 To enable displaying picons, simply make sure that
23586 @code{gnus-picon-databases} points to the directory containing the
23589 @vindex gnus-picon-style
23590 The variable @code{gnus-picon-style} controls how picons are displayed.
23591 If @code{inline}, the textual representation is replaced. If
23592 @code{right}, picons are added right to the textual representation.
23594 @vindex gnus-picon-properties
23595 The value of the variable @code{gnus-picon-properties} is a list of
23596 properties applied to picons.
23598 The following variables offer control over where things are located.
23602 @item gnus-picon-databases
23603 @vindex gnus-picon-databases
23604 The location of the picons database. This is a list of directories
23605 containing the @file{news}, @file{domains}, @file{users} (and so on)
23606 subdirectories. Defaults to @code{("/usr/lib/picon"
23607 "/usr/local/faces")}.
23609 @item gnus-picon-news-directories
23610 @vindex gnus-picon-news-directories
23611 List of subdirectories to search in @code{gnus-picon-databases} for
23612 newsgroups faces. @code{("news")} is the default.
23614 @item gnus-picon-user-directories
23615 @vindex gnus-picon-user-directories
23616 List of subdirectories to search in @code{gnus-picon-databases} for user
23617 faces. @code{("users" "usenix" "local" "misc")} is the default.
23619 @item gnus-picon-domain-directories
23620 @vindex gnus-picon-domain-directories
23621 List of subdirectories to search in @code{gnus-picon-databases} for
23622 domain name faces. Defaults to @code{("domains")}. Some people may
23623 want to add @samp{"unknown"} to this list.
23625 @item gnus-picon-file-types
23626 @vindex gnus-picon-file-types
23627 Ordered list of suffixes on picon file names to try. Defaults to
23628 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
23630 @item gnus-picon-inhibit-top-level-domains
23631 @vindex gnus-picon-inhibit-top-level-domains
23632 If non-@code{nil} (which is the default), don't display picons for
23633 things like @samp{.net} and @samp{.de}, which aren't usually very
23639 @subsection Gravatars
23643 \include{gravatars}
23647 A gravatar is an image registered to an e-mail address.
23649 You can submit yours on-line at @uref{http://www.gravatar.com}.
23651 The following variables offer control over how things are displayed.
23655 @item gnus-gravatar-size
23656 @vindex gnus-gravatar-size
23657 The size in pixels of gravatars. Gravatars are always square, so one
23658 number for the size is enough.
23660 @item gnus-gravatar-properties
23661 @vindex gnus-gravatar-properties
23662 List of image properties applied to Gravatar images.
23664 @item gnus-gravatar-too-ugly
23665 @vindex gnus-gravatar-too-ugly
23666 Regexp that matches mail addresses or names of people of which avatars
23667 should not be displayed, or @code{nil}. It default to the value of
23668 @code{gnus-article-x-face-too-ugly} (@pxref{X-Face}).
23672 If you want to see them in the From field, set:
23674 (setq gnus-treat-from-gravatar 'head)
23677 If you want to see them in the Cc and To fields, set:
23680 (setq gnus-treat-mail-gravatar 'head)
23685 @subsection Various XEmacs Variables
23688 @item gnus-xmas-glyph-directory
23689 @vindex gnus-xmas-glyph-directory
23690 This is where Gnus will look for pictures. Gnus will normally
23691 auto-detect this directory, but you may set it manually if you have an
23692 unusual directory structure.
23694 @item gnus-xmas-modeline-glyph
23695 @vindex gnus-xmas-modeline-glyph
23696 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
23701 @subsubsection Toolbar
23705 @item gnus-use-toolbar
23706 @vindex gnus-use-toolbar
23707 This variable specifies the position to display the toolbar. If
23708 @code{nil}, don't display toolbars. If it is non-@code{nil}, it should
23709 be one of the symbols @code{default}, @code{top}, @code{bottom},
23710 @code{right}, and @code{left}. @code{default} means to use the default
23711 toolbar, the rest mean to display the toolbar on the place which those
23712 names show. The default is @code{default}.
23714 @item gnus-toolbar-thickness
23715 @vindex gnus-toolbar-thickness
23716 Cons of the height and the width specifying the thickness of a toolbar.
23717 The height is used for the toolbar displayed on the top or the bottom,
23718 the width is used for the toolbar displayed on the right or the left.
23719 The default is that of the default toolbar.
23721 @item gnus-group-toolbar
23722 @vindex gnus-group-toolbar
23723 The toolbar in the group buffer.
23725 @item gnus-summary-toolbar
23726 @vindex gnus-summary-toolbar
23727 The toolbar in the summary buffer.
23729 @item gnus-summary-mail-toolbar
23730 @vindex gnus-summary-mail-toolbar
23731 The toolbar in the summary buffer of mail groups.
23742 @node Fuzzy Matching
23743 @section Fuzzy Matching
23744 @cindex fuzzy matching
23746 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
23747 things like scoring, thread gathering and thread comparison.
23749 As opposed to regular expression matching, fuzzy matching is very fuzzy.
23750 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
23751 means, and the implementation has changed over time.
23753 Basically, it tries to remove all noise from lines before comparing.
23754 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
23755 out of the strings before comparing the results. This often leads to
23756 adequate results---even when faced with strings generated by text
23757 manglers masquerading as newsreaders.
23760 @node Thwarting Email Spam
23761 @section Thwarting Email Spam
23765 @cindex unsolicited commercial email
23767 In these last days of the Usenet, commercial vultures are hanging about
23768 and grepping through news like crazy to find email addresses they can
23769 foist off their scams and products to. As a reaction to this, many
23770 people have started putting nonsense addresses into their @code{From}
23771 lines. I think this is counterproductive---it makes it difficult for
23772 people to send you legitimate mail in response to things you write, as
23773 well as making it difficult to see who wrote what. This rewriting may
23774 perhaps be a bigger menace than the unsolicited commercial email itself
23777 The biggest problem I have with email spam is that it comes in under
23778 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
23779 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
23780 mail group, only to find two pyramid schemes, seven advertisements
23781 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
23782 and one mail asking me to repent and find some god.
23784 This is annoying. Here's what you can do about it.
23787 * The problem of spam:: Some background, and some solutions
23788 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
23789 * SpamAssassin:: How to use external anti-spam tools.
23790 * Hashcash:: Reduce spam by burning CPU time.
23793 @node The problem of spam
23794 @subsection The problem of spam
23796 @cindex spam filtering approaches
23797 @cindex filtering approaches, spam
23799 @cindex unsolicited commercial email
23801 First, some background on spam.
23803 If you have access to e-mail, you are familiar with spam (technically
23804 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
23805 exists because e-mail delivery is very cheap compared to paper mail,
23806 so only a very small percentage of people need to respond to an UCE to
23807 make it worthwhile to the advertiser. Ironically, one of the most
23808 common spams is the one offering a database of e-mail addresses for
23809 further spamming. Senders of spam are usually called @emph{spammers},
23810 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
23811 @emph{morons} are in common use as well.
23813 Spam comes from a wide variety of sources. It is simply impossible to
23814 dispose of all spam without discarding useful messages. A good
23815 example is the TMDA system, which requires senders
23816 unknown to you to confirm themselves as legitimate senders before
23817 their e-mail can reach you. Without getting into the technical side
23818 of TMDA, a downside is clearly that e-mail from legitimate sources may
23819 be discarded if those sources can't or won't confirm themselves
23820 through the TMDA system. Another problem with TMDA is that it
23821 requires its users to have a basic understanding of e-mail delivery
23824 The simplest approach to filtering spam is filtering, at the mail
23825 server or when you sort through incoming mail. If you get 200 spam
23826 messages per day from @samp{random-address@@vmadmin.com}, you block
23827 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
23828 discard all messages with @samp{VIAGRA} in the message. If you get
23829 lots of spam from Bulgaria, for example, you try to filter all mail
23830 from Bulgarian IPs.
23832 This, unfortunately, is a great way to discard legitimate e-mail. The
23833 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
23834 etc.)@: or even a continent (Asia, Africa, Europe, etc.)@: from contacting
23835 you should be obvious, so don't do it if you have the choice.
23837 In another instance, the very informative and useful RISKS digest has
23838 been blocked by overzealous mail filters because it @strong{contained}
23839 words that were common in spam messages. Nevertheless, in isolated
23840 cases, with great care, direct filtering of mail can be useful.
23842 Another approach to filtering e-mail is the distributed spam
23843 processing, for instance DCC implements such a system. In essence,
23844 @var{N} systems around the world agree that a machine @var{X} in
23845 Ghana, Estonia, or California is sending out spam e-mail, and these
23846 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
23847 database. The criteria for spam detection vary---it may be the number
23848 of messages sent, the content of the messages, and so on. When a user
23849 of the distributed processing system wants to find out if a message is
23850 spam, he consults one of those @var{N} systems.
23852 Distributed spam processing works very well against spammers that send
23853 a large number of messages at once, but it requires the user to set up
23854 fairly complicated checks. There are commercial and free distributed
23855 spam processing systems. Distributed spam processing has its risks as
23856 well. For instance legitimate e-mail senders have been accused of
23857 sending spam, and their web sites and mailing lists have been shut
23858 down for some time because of the incident.
23860 The statistical approach to spam filtering is also popular. It is
23861 based on a statistical analysis of previous spam messages. Usually
23862 the analysis is a simple word frequency count, with perhaps pairs of
23863 words or 3-word combinations thrown into the mix. Statistical
23864 analysis of spam works very well in most of the cases, but it can
23865 classify legitimate e-mail as spam in some cases. It takes time to
23866 run the analysis, the full message must be analyzed, and the user has
23867 to store the database of spam analysis. Statistical analysis on the
23868 server is gaining popularity. This has the advantage of letting the
23869 user Just Read Mail, but has the disadvantage that it's harder to tell
23870 the server that it has misclassified mail.
23872 Fighting spam is not easy, no matter what anyone says. There is no
23873 magic switch that will distinguish Viagra ads from Mom's e-mails.
23874 Even people are having a hard time telling spam apart from non-spam,
23875 because spammers are actively looking to fool us into thinking they
23876 are Mom, essentially. Spamming is irritating, irresponsible, and
23877 idiotic behavior from a bunch of people who think the world owes them
23878 a favor. We hope the following sections will help you in fighting the
23881 @node Anti-Spam Basics
23882 @subsection Anti-Spam Basics
23886 @cindex unsolicited commercial email
23888 One way of dealing with spam is having Gnus split out all spam into a
23889 @samp{spam} mail group (@pxref{Splitting Mail}).
23891 First, pick one (1) valid mail address that you can be reached at, and
23892 put it in your @code{From} header of all your news articles. (I've
23893 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
23894 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
23895 sysadmin whether your sendmail installation accepts keywords in the local
23896 part of the mail address.)
23899 (setq message-default-news-headers
23900 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
23903 Then put the following split rule in @code{nnmail-split-fancy}
23904 (@pxref{Fancy Mail Splitting}):
23908 (to "larsi@@trym.ifi.uio.no"
23909 (| ("subject" "re:.*" "misc")
23910 ("references" ".*@@.*" "misc")
23915 This says that all mail to this address is suspect, but if it has a
23916 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
23917 header, it's probably ok. All the rest goes to the @samp{spam} group.
23918 (This idea probably comes from Tim Pierce.)
23920 In addition, many mail spammers talk directly to your @acronym{SMTP} server
23921 and do not include your email address explicitly in the @code{To}
23922 header. Why they do this is unknown---perhaps it's to thwart this
23923 thwarting scheme? In any case, this is trivial to deal with---you just
23924 put anything not addressed to you in the @samp{spam} group by ending
23925 your fancy split rule in this way:
23930 (to "larsi" "misc")
23934 In my experience, this will sort virtually everything into the right
23935 group. You still have to check the @samp{spam} group from time to time to
23936 check for legitimate mail, though. If you feel like being a good net
23937 citizen, you can even send off complaints to the proper authorities on
23938 each unsolicited commercial email---at your leisure.
23940 This works for me. It allows people an easy way to contact me (they can
23941 just press @kbd{r} in the usual way), and I'm not bothered at all with
23942 spam. It's a win-win situation. Forging @code{From} headers to point
23943 to non-existent domains is yucky, in my opinion.
23945 Be careful with this approach. Spammers are wise to it.
23949 @subsection SpamAssassin, Vipul's Razor, DCC, etc
23950 @cindex SpamAssassin
23951 @cindex Vipul's Razor
23954 The days where the hints in the previous section were sufficient in
23955 avoiding spam are coming to an end. There are many tools out there
23956 that claim to reduce the amount of spam you get. This section could
23957 easily become outdated fast, as new products replace old, but
23958 fortunately most of these tools seem to have similar interfaces. Even
23959 though this section will use SpamAssassin as an example, it should be
23960 easy to adapt it to most other tools.
23962 Note that this section does not involve the @code{spam.el} package,
23963 which is discussed in the next section. If you don't care for all
23964 the features of @code{spam.el}, you can make do with these simple
23967 If the tool you are using is not installed on the mail server, you
23968 need to invoke it yourself. Ideas on how to use the
23969 @code{:postscript} mail source parameter (@pxref{Mail Source
23970 Specifiers}) follow.
23974 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
23978 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
23981 Once you manage to process your incoming spool somehow, thus making
23982 the mail contain, e.g., a header indicating it is spam, you are ready to
23983 filter it out. Using normal split methods (@pxref{Splitting Mail}):
23986 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
23990 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
23993 (setq nnmail-split-methods 'nnmail-split-fancy
23994 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
23998 Some people might not like the idea of piping the mail through various
23999 programs using a @code{:prescript} (if some program is buggy, you
24000 might lose all mail). If you are one of them, another solution is to
24001 call the external tools during splitting. Example fancy split method:
24004 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
24006 (defun kevin-spamassassin ()
24010 (if (eq 1 (call-process-region (point-min) (point-max)
24011 "spamc" nil nil nil "-c"))
24015 Note that with the nnimap back end, message bodies will not be
24016 downloaded by default. You need to set
24017 @code{nnimap-split-download-body} to @code{t} to do that
24018 (@pxref{Client-Side IMAP Splitting}).
24020 That is about it. As some spam is likely to get through anyway, you
24021 might want to have a nifty function to call when you happen to read
24022 spam. And here is the nifty function:
24025 (defun my-gnus-raze-spam ()
24026 "Submit SPAM to Vipul's Razor, then mark it as expirable."
24028 (gnus-summary-save-in-pipe "razor-report -f -d" t)
24029 (gnus-summary-mark-as-expirable 1))
24033 @subsection Hashcash
24036 A novel technique to fight spam is to require senders to do something
24037 costly and demonstrably unique for each message they send. This has
24038 the obvious drawback that you cannot rely on everyone in the world
24039 using this technique, since it is not part of the Internet standards,
24040 but it may be useful in smaller communities.
24042 While the tools in the previous section work well in practice, they
24043 work only because the tools are constantly maintained and updated as
24044 new form of spam appears. This means that a small percentage of spam
24045 will always get through. It also means that somewhere, someone needs
24046 to read lots of spam to update these tools. Hashcash avoids that, but
24047 instead prefers that everyone you contact through e-mail supports the
24048 scheme. You can view the two approaches as pragmatic vs dogmatic.
24049 The approaches have their own advantages and disadvantages, but as
24050 often in the real world, a combination of them is stronger than either
24051 one of them separately.
24054 The ``something costly'' is to burn CPU time, more specifically to
24055 compute a hash collision up to a certain number of bits. The
24056 resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header.
24057 For more details, and for the external application @code{hashcash} you
24058 need to install to use this feature, see
24059 @uref{http://www.hashcash.org/}. Even more information can be found
24060 at @uref{http://www.camram.org/}.
24062 If you wish to generate hashcash for each message you send, you can
24063 customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail
24064 Headers,message, The Message Manual}), as in:
24067 (setq message-generate-hashcash t)
24070 You will need to set up some additional variables as well:
24074 @item hashcash-default-payment
24075 @vindex hashcash-default-payment
24076 This variable indicates the default number of bits the hash collision
24077 should consist of. By default this is 20. Suggested useful values
24080 @item hashcash-payment-alist
24081 @vindex hashcash-payment-alist
24082 Some receivers may require you to spend burn more CPU time than the
24083 default. This variable contains a list of @samp{(@var{addr}
24084 @var{amount})} cells, where @var{addr} is the receiver (email address
24085 or newsgroup) and @var{amount} is the number of bits in the collision
24086 that is needed. It can also contain @samp{(@var{addr} @var{string}
24087 @var{amount})} cells, where the @var{string} is the string to use
24088 (normally the email address or newsgroup name is used).
24090 @item hashcash-path
24091 @vindex hashcash-path
24092 Where the @code{hashcash} binary is installed. This variable should
24093 be automatically set by @code{executable-find}, but if it's @code{nil}
24094 (usually because the @code{hashcash} binary is not in your path)
24095 you'll get a warning when you check hashcash payments and an error
24096 when you generate hashcash payments.
24100 Gnus can verify hashcash cookies, although this can also be done by
24101 hand customized mail filtering scripts. To verify a hashcash cookie
24102 in a message, use the @code{mail-check-payment} function in the
24103 @code{hashcash.el} library. You can also use the @code{spam.el}
24104 package with the @code{spam-use-hashcash} back end to validate hashcash
24105 cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam
24106 Hashcash Payments}).
24109 @section Spam Package
24110 @cindex spam filtering
24113 The Spam package provides Gnus with a centralized mechanism for
24114 detecting and filtering spam. It filters new mail, and processes
24115 messages according to whether they are spam or ham. (@dfn{Ham} is the
24116 name used throughout this manual to indicate non-spam messages.)
24119 * Spam Package Introduction::
24120 * Filtering Incoming Mail::
24121 * Detecting Spam in Groups::
24122 * Spam and Ham Processors::
24123 * Spam Package Configuration Examples::
24125 * Extending the Spam package::
24126 * Spam Statistics Package::
24129 @node Spam Package Introduction
24130 @subsection Spam Package Introduction
24131 @cindex spam filtering
24132 @cindex spam filtering sequence of events
24135 You must read this section to understand how the Spam package works.
24136 Do not skip, speed-read, or glance through this section.
24138 Make sure you read the section on the @code{spam.el} sequence of
24139 events. See @xref{Extending the Spam package}.
24141 @cindex spam-initialize
24142 @vindex spam-use-stat
24143 To use the Spam package, you @strong{must} first run the function
24144 @code{spam-initialize}:
24150 This autoloads @code{spam.el} and installs the various hooks necessary
24151 to let the Spam package do its job. In order to make use of the Spam
24152 package, you have to set up certain group parameters and variables,
24153 which we will describe below. All of the variables controlling the
24154 Spam package can be found in the @samp{spam} customization group.
24156 There are two ``contact points'' between the Spam package and the rest
24157 of Gnus: checking new mail for spam, and leaving a group.
24159 Checking new mail for spam is done in one of two ways: while splitting
24160 incoming mail, or when you enter a group.
24162 The first way, checking for spam while splitting incoming mail, is
24163 suited to mail back ends such as @code{nnml} or @code{nnimap}, where
24164 new mail appears in a single spool file. The Spam package processes
24165 incoming mail, and sends mail considered to be spam to a designated
24166 ``spam'' group. @xref{Filtering Incoming Mail}.
24168 The second way is suited to back ends such as @code{nntp}, which have
24169 no incoming mail spool, or back ends where the server is in charge of
24170 splitting incoming mail. In this case, when you enter a Gnus group,
24171 the unseen or unread messages in that group are checked for spam.
24172 Detected spam messages are marked as spam. @xref{Detecting Spam in
24175 @cindex spam back ends
24176 In either case, you have to tell the Spam package what method to use
24177 to detect spam messages. There are several methods, or @dfn{spam back
24178 ends} (not to be confused with Gnus back ends!) to choose from: spam
24179 ``blacklists'' and ``whitelists'', dictionary-based filters, and so
24180 forth. @xref{Spam Back Ends}.
24182 In the Gnus summary buffer, messages that have been identified as spam
24183 always appear with a @samp{$} symbol.
24185 The Spam package divides Gnus groups into three categories: ham
24186 groups, spam groups, and unclassified groups. You should mark each of
24187 the groups you subscribe to as either a ham group or a spam group,
24188 using the @code{spam-contents} group parameter (@pxref{Group
24189 Parameters}). Spam groups have a special property: when you enter a
24190 spam group, all unseen articles are marked as spam. Thus, mail split
24191 into a spam group is automatically marked as spam.
24193 Identifying spam messages is only half of the Spam package's job. The
24194 second half comes into play whenever you exit a group buffer. At this
24195 point, the Spam package does several things:
24197 First, it calls @dfn{spam and ham processors} to process the articles
24198 according to whether they are spam or ham. There is a pair of spam
24199 and ham processors associated with each spam back end, and what the
24200 processors do depends on the back end. At present, the main role of
24201 spam and ham processors is for dictionary-based spam filters: they add
24202 the contents of the messages in the group to the filter's dictionary,
24203 to improve its ability to detect future spam. The @code{spam-process}
24204 group parameter specifies what spam processors to use. @xref{Spam and
24207 If the spam filter failed to mark a spam message, you can mark it
24208 yourself, so that the message is processed as spam when you exit the
24216 @kindex $ (Summary)
24217 @kindex M-d (Summary)
24218 @kindex S x (Summary)
24219 @kindex M s x (Summary)
24220 @findex gnus-summary-mark-as-spam
24221 @findex gnus-summary-mark-as-spam
24222 Mark current article as spam, showing it with the @samp{$} mark
24223 (@code{gnus-summary-mark-as-spam}).
24227 Similarly, you can unmark an article if it has been erroneously marked
24228 as spam. @xref{Setting Marks}.
24230 Normally, a ham message found in a non-ham group is not processed as
24231 ham---the rationale is that it should be moved into a ham group for
24232 further processing (see below). However, you can force these articles
24233 to be processed as ham by setting
24234 @code{spam-process-ham-in-spam-groups} and
24235 @code{spam-process-ham-in-nonham-groups}.
24237 @vindex gnus-ham-process-destinations
24238 @vindex gnus-spam-process-destinations
24239 The second thing that the Spam package does when you exit a group is
24240 to move ham articles out of spam groups, and spam articles out of ham
24241 groups. Ham in a spam group is moved to the group specified by the
24242 variable @code{gnus-ham-process-destinations}, or the group parameter
24243 @code{ham-process-destination}. Spam in a ham group is moved to the
24244 group specified by the variable @code{gnus-spam-process-destinations},
24245 or the group parameter @code{spam-process-destination}. If these
24246 variables are not set, the articles are left in their current group.
24247 If an article cannot be moved (e.g., with a read-only backend such
24248 as @acronym{NNTP}), it is copied.
24250 If an article is moved to another group, it is processed again when
24251 you visit the new group. Normally, this is not a problem, but if you
24252 want each article to be processed only once, load the
24253 @code{gnus-registry.el} package and set the variable
24254 @code{spam-log-to-registry} to @code{t}. @xref{Spam Package
24255 Configuration Examples}.
24257 Normally, spam groups ignore @code{gnus-spam-process-destinations}.
24258 However, if you set @code{spam-move-spam-nonspam-groups-only} to
24259 @code{nil}, spam will also be moved out of spam groups, depending on
24260 the @code{spam-process-destination} parameter.
24262 The final thing the Spam package does is to mark spam articles as
24263 expired, which is usually the right thing to do.
24265 If all this seems confusing, don't worry. Soon it will be as natural
24266 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
24267 50 years in the future yet. Just trust us, it's not so bad.
24269 @node Filtering Incoming Mail
24270 @subsection Filtering Incoming Mail
24271 @cindex spam filtering
24272 @cindex spam filtering incoming mail
24275 To use the Spam package to filter incoming mail, you must first set up
24276 fancy mail splitting. @xref{Fancy Mail Splitting}. The Spam package
24277 defines a special splitting function that you can add to your fancy
24278 split variable (either @code{nnmail-split-fancy} or
24279 @code{nnimap-split-fancy}, depending on your mail back end):
24285 @vindex spam-split-group
24287 The @code{spam-split} function scans incoming mail according to your
24288 chosen spam back end(s), and sends messages identified as spam to a
24289 spam group. By default, the spam group is a group named @samp{spam},
24290 but you can change this by customizing @code{spam-split-group}. Make
24291 sure the contents of @code{spam-split-group} are an unqualified group
24292 name. For instance, in an @code{nnimap} server @samp{your-server},
24293 the value @samp{spam} means @samp{nnimap+your-server:spam}. The value
24294 @samp{nnimap+server:spam} is therefore wrong---it gives the group
24295 @samp{nnimap+your-server:nnimap+server:spam}.
24297 @code{spam-split} does not modify the contents of messages in any way.
24299 @vindex nnimap-split-download-body
24300 Note for IMAP users: if you use the @code{spam-check-bogofilter},
24301 @code{spam-check-ifile}, and @code{spam-check-stat} spam back ends,
24302 you should also set the variable @code{nnimap-split-download-body} to
24303 @code{t}. These spam back ends are most useful when they can ``scan''
24304 the full message body. By default, the nnimap back end only retrieves
24305 the message headers; @code{nnimap-split-download-body} tells it to
24306 retrieve the message bodies as well. We don't set this by default
24307 because it will slow @acronym{IMAP} down, and that is not an
24308 appropriate decision to make on behalf of the user. @xref{Client-Side
24311 You have to specify one or more spam back ends for @code{spam-split}
24312 to use, by setting the @code{spam-use-*} variables. @xref{Spam Back
24313 Ends}. Normally, @code{spam-split} simply uses all the spam back ends
24314 you enabled in this way. However, you can tell @code{spam-split} to
24315 use only some of them. Why this is useful? Suppose you are using the
24316 @code{spam-use-regex-headers} and @code{spam-use-blackholes} spam back
24317 ends, and the following split rule:
24320 nnimap-split-fancy '(|
24321 (any "ding" "ding")
24323 ;; @r{default mailbox}
24328 The problem is that you want all ding messages to make it to the ding
24329 folder. But that will let obvious spam (for example, spam detected by
24330 SpamAssassin, and @code{spam-use-regex-headers}) through, when it's
24331 sent to the ding list. On the other hand, some messages to the ding
24332 list are from a mail server in the blackhole list, so the invocation
24333 of @code{spam-split} can't be before the ding rule.
24335 The solution is to let SpamAssassin headers supersede ding rules, and
24336 perform the other @code{spam-split} rules (including a second
24337 invocation of the regex-headers check) after the ding rule. This is
24338 done by passing a parameter to @code{spam-split}:
24343 ;; @r{spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
24344 (: spam-split "regex-spam" 'spam-use-regex-headers)
24345 (any "ding" "ding")
24346 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
24348 ;; @r{default mailbox}
24353 This lets you invoke specific @code{spam-split} checks depending on
24354 your particular needs, and target the results of those checks to a
24355 particular spam group. You don't have to throw all mail into all the
24356 spam tests. Another reason why this is nice is that messages to
24357 mailing lists you have rules for don't have to have resource-intensive
24358 blackhole checks performed on them. You could also specify different
24359 spam checks for your nnmail split vs. your nnimap split. Go crazy.
24361 You should set the @code{spam-use-*} variables for whatever spam back
24362 ends you intend to use. The reason is that when loading
24363 @file{spam.el}, some conditional loading is done depending on what
24364 @code{spam-use-xyz} variables you have set. @xref{Spam Back Ends}.
24366 @c @emph{TODO: spam.el needs to provide a uniform way of training all the
24367 @c statistical databases. Some have that functionality built-in, others
24370 @node Detecting Spam in Groups
24371 @subsection Detecting Spam in Groups
24373 To detect spam when visiting a group, set the group's
24374 @code{spam-autodetect} and @code{spam-autodetect-methods} group
24375 parameters. These are accessible with @kbd{G c} or @kbd{G p}, as
24376 usual (@pxref{Group Parameters}).
24378 You should set the @code{spam-use-*} variables for whatever spam back
24379 ends you intend to use. The reason is that when loading
24380 @file{spam.el}, some conditional loading is done depending on what
24381 @code{spam-use-xyz} variables you have set.
24383 By default, only unseen articles are processed for spam. You can
24384 force Gnus to recheck all messages in the group by setting the
24385 variable @code{spam-autodetect-recheck-messages} to @code{t}.
24387 If you use the @code{spam-autodetect} method of checking for spam, you
24388 can specify different spam detection methods for different groups.
24389 For instance, the @samp{ding} group may have @code{spam-use-BBDB} as
24390 the autodetection method, while the @samp{suspect} group may have the
24391 @code{spam-use-blacklist} and @code{spam-use-bogofilter} methods
24392 enabled. Unlike with @code{spam-split}, you don't have any control
24393 over the @emph{sequence} of checks, but this is probably unimportant.
24395 @node Spam and Ham Processors
24396 @subsection Spam and Ham Processors
24397 @cindex spam filtering
24398 @cindex spam filtering variables
24399 @cindex spam variables
24402 @vindex gnus-spam-process-newsgroups
24403 Spam and ham processors specify special actions to take when you exit
24404 a group buffer. Spam processors act on spam messages, and ham
24405 processors on ham messages. At present, the main role of these
24406 processors is to update the dictionaries of dictionary-based spam back
24407 ends such as Bogofilter (@pxref{Bogofilter}) and the Spam Statistics
24408 package (@pxref{Spam Statistics Filtering}).
24410 The spam and ham processors that apply to each group are determined by
24411 the group's@code{spam-process} group parameter. If this group
24412 parameter is not defined, they are determined by the variable
24413 @code{gnus-spam-process-newsgroups}.
24415 @vindex gnus-spam-newsgroup-contents
24416 Gnus learns from the spam you get. You have to collect your spam in
24417 one or more spam groups, and set or customize the variable
24418 @code{spam-junk-mailgroups} as appropriate. You can also declare
24419 groups to contain spam by setting their group parameter
24420 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
24421 by customizing the corresponding variable
24422 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
24423 parameter and the @code{gnus-spam-newsgroup-contents} variable can
24424 also be used to declare groups as @emph{ham} groups if you set their
24425 classification to @code{gnus-group-spam-classification-ham}. If
24426 groups are not classified by means of @code{spam-junk-mailgroups},
24427 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
24428 considered @emph{unclassified}. All groups are unclassified by
24431 @vindex gnus-spam-mark
24433 In spam groups, all messages are considered to be spam by default:
24434 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
24435 group. If you have seen a message, had it marked as spam, then
24436 unmarked it, it won't be marked as spam when you enter the group
24437 thereafter. You can disable that behavior, so all unread messages
24438 will get the @samp{$} mark, if you set the
24439 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
24440 should remove the @samp{$} mark when you are in the group summary
24441 buffer for every message that is not spam after all. To remove the
24442 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
24443 @kbd{d} for declaring it read the non-spam way. When you leave a
24444 group, all spam-marked (@samp{$}) articles are sent to a spam
24445 processor which will study them as spam samples.
24447 Messages may also be deleted in various other ways, and unless
24448 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
24449 and @samp{r} for default read or explicit delete, marks @samp{X} and
24450 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
24451 low scores, are all considered to be associated with articles which
24452 are not spam. This assumption might be false, in particular if you
24453 use kill files or score files as means for detecting genuine spam, you
24454 should then adjust the @code{ham-marks} group parameter.
24457 You can customize this group or topic parameter to be the list of
24458 marks you want to consider ham. By default, the list contains the
24459 deleted, read, killed, kill-filed, and low-score marks (the idea is
24460 that these articles have been read, but are not spam). It can be
24461 useful to also include the tick mark in the ham marks. It is not
24462 recommended to make the unread mark a ham mark, because it normally
24463 indicates a lack of classification. But you can do it, and we'll be
24468 You can customize this group or topic parameter to be the list of
24469 marks you want to consider spam. By default, the list contains only
24470 the spam mark. It is not recommended to change that, but you can if
24471 you really want to.
24474 When you leave @emph{any} group, regardless of its
24475 @code{spam-contents} classification, all spam-marked articles are sent
24476 to a spam processor, which will study these as spam samples. If you
24477 explicit kill a lot, you might sometimes end up with articles marked
24478 @samp{K} which you never saw, and which might accidentally contain
24479 spam. Best is to make sure that real spam is marked with @samp{$},
24482 @vindex gnus-ham-process-destinations
24483 When you leave a @emph{spam} group, all spam-marked articles are
24484 marked as expired after processing with the spam processor. This is
24485 not done for @emph{unclassified} or @emph{ham} groups. Also, any
24486 @strong{ham} articles in a spam group will be moved to a location
24487 determined by either the @code{ham-process-destination} group
24488 parameter or a match in the @code{gnus-ham-process-destinations}
24489 variable, which is a list of regular expressions matched with group
24490 names (it's easiest to customize this variable with @kbd{M-x
24491 customize-variable @key{RET} gnus-ham-process-destinations}). Each
24492 group name list is a standard Lisp list, if you prefer to customize
24493 the variable manually. If the @code{ham-process-destination}
24494 parameter is not set, ham articles are left in place. If the
24495 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
24496 set, the ham articles are marked as unread before being moved.
24498 If ham can not be moved---because of a read-only back end such as
24499 @acronym{NNTP}, for example, it will be copied.
24501 Note that you can use multiples destinations per group or regular
24502 expression! This enables you to send your ham to a regular mail
24503 group and to a @emph{ham training} group.
24505 When you leave a @emph{ham} group, all ham-marked articles are sent to
24506 a ham processor, which will study these as non-spam samples.
24508 @vindex spam-process-ham-in-spam-groups
24509 By default the variable @code{spam-process-ham-in-spam-groups} is
24510 @code{nil}. Set it to @code{t} if you want ham found in spam groups
24511 to be processed. Normally this is not done, you are expected instead
24512 to send your ham to a ham group and process it there.
24514 @vindex spam-process-ham-in-nonham-groups
24515 By default the variable @code{spam-process-ham-in-nonham-groups} is
24516 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
24517 or unclassified) groups to be processed. Normally this is not done,
24518 you are expected instead to send your ham to a ham group and process
24521 @vindex gnus-spam-process-destinations
24522 When you leave a @emph{ham} or @emph{unclassified} group, all
24523 @strong{spam} articles are moved to a location determined by either
24524 the @code{spam-process-destination} group parameter or a match in the
24525 @code{gnus-spam-process-destinations} variable, which is a list of
24526 regular expressions matched with group names (it's easiest to
24527 customize this variable with @kbd{M-x customize-variable @key{RET}
24528 gnus-spam-process-destinations}). Each group name list is a standard
24529 Lisp list, if you prefer to customize the variable manually. If the
24530 @code{spam-process-destination} parameter is not set, the spam
24531 articles are only expired. The group name is fully qualified, meaning
24532 that if you see @samp{nntp:servername} before the group name in the
24533 group buffer then you need it here as well.
24535 If spam can not be moved---because of a read-only back end such as
24536 @acronym{NNTP}, for example, it will be copied.
24538 Note that you can use multiples destinations per group or regular
24539 expression! This enables you to send your spam to multiple @emph{spam
24542 @vindex spam-log-to-registry
24543 The problem with processing ham and spam is that Gnus doesn't track
24544 this processing by default. Enable the @code{spam-log-to-registry}
24545 variable so @code{spam.el} will use @code{gnus-registry.el} to track
24546 what articles have been processed, and avoid processing articles
24547 multiple times. Keep in mind that if you limit the number of registry
24548 entries, this won't work as well as it does without a limit.
24550 @vindex spam-mark-only-unseen-as-spam
24551 Set this variable if you want only unseen articles in spam groups to
24552 be marked as spam. By default, it is set. If you set it to
24553 @code{nil}, unread articles will also be marked as spam.
24555 @vindex spam-mark-ham-unread-before-move-from-spam-group
24556 Set this variable if you want ham to be unmarked before it is moved
24557 out of the spam group. This is very useful when you use something
24558 like the tick mark @samp{!} to mark ham---the article will be placed
24559 in your @code{ham-process-destination}, unmarked as if it came fresh
24560 from the mail server.
24562 @vindex spam-autodetect-recheck-messages
24563 When autodetecting spam, this variable tells @code{spam.el} whether
24564 only unseen articles or all unread articles should be checked for
24565 spam. It is recommended that you leave it off.
24567 @node Spam Package Configuration Examples
24568 @subsection Spam Package Configuration Examples
24569 @cindex spam filtering
24570 @cindex spam filtering configuration examples
24571 @cindex spam configuration examples
24574 @subsubheading Ted's setup
24576 From Ted Zlatanov <tzz@@lifelogs.com>.
24578 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
24579 ;; @r{see @file{gnus-registry.el} for more information}
24580 (gnus-registry-initialize)
24584 spam-log-to-registry t ; @r{for spam autodetection}
24586 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
24587 ;; @r{all groups with @samp{spam} in the name contain spam}
24588 gnus-spam-newsgroup-contents
24589 '(("spam" gnus-group-spam-classification-spam))
24590 ;; @r{see documentation for these}
24591 spam-move-spam-nonspam-groups-only nil
24592 spam-mark-only-unseen-as-spam t
24593 spam-mark-ham-unread-before-move-from-spam-group t
24594 ;; @r{understand what this does before you copy it to your own setup!}
24595 ;; @r{for nnimap you'll probably want to set nnimap-split-methods, see the manual}
24596 nnimap-split-fancy '(|
24597 ;; @r{trace references to parents and put in their group}
24598 (: gnus-registry-split-fancy-with-parent)
24599 ;; @r{this will catch server-side SpamAssassin tags}
24600 (: spam-split 'spam-use-regex-headers)
24601 (any "ding" "ding")
24602 ;; @r{note that spam by default will go to @samp{spam}}
24604 ;; @r{default mailbox}
24607 ;; @r{my parameters, set with @kbd{G p}}
24609 ;; @r{all nnml groups, and all nnimap groups except}
24610 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
24611 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
24612 ;; @r{because it must have been detected manually}
24614 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24616 ;; @r{all @acronym{NNTP} groups}
24617 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
24618 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
24619 ;; @r{send all spam to the training group}
24620 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24622 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
24623 ((spam-autodetect . t))
24625 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
24627 ;; @r{this is a spam group}
24628 ((spam-contents gnus-group-spam-classification-spam)
24630 ;; @r{any spam (which happens when I enter for all unseen messages,}
24631 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
24632 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
24634 (spam-process-destination "nnimap+mail.lifelogs.com:train")
24636 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
24637 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
24639 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
24640 "nnimap+mail.lifelogs.com:trainham")
24641 ;; @r{in this group, only @samp{!} marks are ham}
24643 (gnus-ticked-mark))
24644 ;; @r{remembers senders in the blacklist on the way out---this is}
24645 ;; @r{definitely not needed, it just makes me feel better}
24646 (spam-process (gnus-group-spam-exit-processor-blacklist)))
24648 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
24649 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
24650 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
24654 @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server
24655 From Reiner Steib <reiner.steib@@gmx.de>.
24657 My provider has set up bogofilter (in combination with @acronym{DCC}) on
24658 the mail server (@acronym{IMAP}). Recognized spam goes to
24659 @samp{spam.detected}, the rest goes through the normal filter rules,
24660 i.e., to @samp{some.folder} or to @samp{INBOX}. Training on false
24661 positives or negatives is done by copying or moving the article to
24662 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
24663 the server feeds those to bogofilter with the suitable ham or spam
24664 options and deletes them from the @samp{training.ham} and
24665 @samp{training.spam} folders.
24667 With the following entries in @code{gnus-parameters}, @code{spam.el}
24668 does most of the job for me:
24671 ("nnimap:spam\\.detected"
24672 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
24673 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
24674 (spam-contents gnus-group-spam-classification-spam))
24675 ("nnimap:\\(INBOX\\|other-folders\\)"
24676 (spam-process-destination . "nnimap:training.spam")
24677 (spam-contents gnus-group-spam-classification-ham))
24682 @item @b{The Spam folder:}
24684 In the folder @samp{spam.detected}, I have to check for false positives
24685 (i.e., legitimate mails, that were wrongly judged as spam by
24686 bogofilter or DCC).
24688 Because of the @code{gnus-group-spam-classification-spam} entry, all
24689 messages are marked as spam (with @code{$}). When I find a false
24690 positive, I mark the message with some other ham mark
24691 (@code{ham-marks}, @ref{Spam and Ham Processors}). On group exit,
24692 those messages are copied to both groups, @samp{INBOX} (where I want
24693 to have the article) and @samp{training.ham} (for training bogofilter)
24694 and deleted from the @samp{spam.detected} folder.
24696 The @code{gnus-article-sort-by-chars} entry simplifies detection of
24697 false positives for me. I receive lots of worms (sweN, @dots{}), that all
24698 have a similar size. Grouping them by size (i.e., chars) makes finding
24699 other false positives easier. (Of course worms aren't @i{spam}
24700 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
24701 an excellent tool for filtering those unwanted mails for me.)
24703 @item @b{Ham folders:}
24705 In my ham folders, I just hit @kbd{S x}
24706 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
24707 mail (false negative). On group exit, those messages are moved to
24708 @samp{training.spam}.
24711 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
24713 From Reiner Steib <reiner.steib@@gmx.de>.
24715 With following entry in @code{gnus-parameters}, @kbd{S x}
24716 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
24717 groups as spam and reports the to Gmane at group exit:
24721 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
24724 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
24725 because I don't read the groups directly from news.gmane.org, but
24726 through my local news server (leafnode). I.e., the article numbers are
24727 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
24728 the @code{X-Report-Spam} header to find the correct number.
24730 @node Spam Back Ends
24731 @subsection Spam Back Ends
24732 @cindex spam back ends
24734 The spam package offers a variety of back ends for detecting spam.
24735 Each back end defines a set of methods for detecting spam
24736 (@pxref{Filtering Incoming Mail}, @pxref{Detecting Spam in Groups}),
24737 and a pair of spam and ham processors (@pxref{Spam and Ham
24741 * Blacklists and Whitelists::
24742 * BBDB Whitelists::
24743 * Gmane Spam Reporting::
24744 * Anti-spam Hashcash Payments::
24746 * Regular Expressions Header Matching::
24748 * SpamAssassin back end::
24749 * ifile spam filtering::
24750 * Spam Statistics Filtering::
24754 @node Blacklists and Whitelists
24755 @subsubsection Blacklists and Whitelists
24756 @cindex spam filtering
24757 @cindex whitelists, spam filtering
24758 @cindex blacklists, spam filtering
24761 @defvar spam-use-blacklist
24763 Set this variable to @code{t} if you want to use blacklists when
24764 splitting incoming mail. Messages whose senders are in the blacklist
24765 will be sent to the @code{spam-split-group}. This is an explicit
24766 filter, meaning that it acts only on mail senders @emph{declared} to
24771 @defvar spam-use-whitelist
24773 Set this variable to @code{t} if you want to use whitelists when
24774 splitting incoming mail. Messages whose senders are not in the
24775 whitelist will be sent to the next spam-split rule. This is an
24776 explicit filter, meaning that unless someone is in the whitelist, their
24777 messages are not assumed to be spam or ham.
24781 @defvar spam-use-whitelist-exclusive
24783 Set this variable to @code{t} if you want to use whitelists as an
24784 implicit filter, meaning that every message will be considered spam
24785 unless the sender is in the whitelist. Use with care.
24789 @defvar gnus-group-spam-exit-processor-blacklist
24791 Add this symbol to a group's @code{spam-process} parameter by
24792 customizing the group parameters or the
24793 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24794 added to a group's @code{spam-process} parameter, the senders of
24795 spam-marked articles will be added to the blacklist.
24799 Instead of the obsolete
24800 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
24801 that you use @code{(spam spam-use-blacklist)}. Everything will work
24802 the same way, we promise.
24806 @defvar gnus-group-ham-exit-processor-whitelist
24808 Add this symbol to a group's @code{spam-process} parameter by
24809 customizing the group parameters or the
24810 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24811 added to a group's @code{spam-process} parameter, the senders of
24812 ham-marked articles in @emph{ham} groups will be added to the
24817 Instead of the obsolete
24818 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
24819 that you use @code{(ham spam-use-whitelist)}. Everything will work
24820 the same way, we promise.
24824 Blacklists are lists of regular expressions matching addresses you
24825 consider to be spam senders. For instance, to block mail from any
24826 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
24827 blacklist. You start out with an empty blacklist. Blacklist entries
24828 use the Emacs regular expression syntax.
24830 Conversely, whitelists tell Gnus what addresses are considered
24831 legitimate. All messages from whitelisted addresses are considered
24832 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
24833 Emacs regular expression syntax.
24835 The blacklist and whitelist file locations can be customized with the
24836 @code{spam-directory} variable (@file{~/News/spam} by default), or
24837 the @code{spam-whitelist} and @code{spam-blacklist} variables
24838 directly. The whitelist and blacklist files will by default be in the
24839 @code{spam-directory} directory, named @file{whitelist} and
24840 @file{blacklist} respectively.
24842 @node BBDB Whitelists
24843 @subsubsection BBDB Whitelists
24844 @cindex spam filtering
24845 @cindex BBDB whitelists, spam filtering
24846 @cindex BBDB, spam filtering
24849 @defvar spam-use-BBDB
24851 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
24852 Whitelists}), but uses the BBDB as the source of whitelisted
24853 addresses, without regular expressions. You must have the BBDB loaded
24854 for @code{spam-use-BBDB} to work properly. Messages whose senders are
24855 not in the BBDB will be sent to the next spam-split rule. This is an
24856 explicit filter, meaning that unless someone is in the BBDB, their
24857 messages are not assumed to be spam or ham.
24861 @defvar spam-use-BBDB-exclusive
24863 Set this variable to @code{t} if you want to use the BBDB as an
24864 implicit filter, meaning that every message will be considered spam
24865 unless the sender is in the BBDB@. Use with care. Only sender
24866 addresses in the BBDB will be allowed through; all others will be
24867 classified as spammers.
24869 While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias
24870 for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is
24871 @emph{not} a separate back end. If you set
24872 @code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting
24877 @defvar gnus-group-ham-exit-processor-BBDB
24879 Add this symbol to a group's @code{spam-process} parameter by
24880 customizing the group parameters or the
24881 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24882 added to a group's @code{spam-process} parameter, the senders of
24883 ham-marked articles in @emph{ham} groups will be added to the
24888 Instead of the obsolete
24889 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
24890 that you use @code{(ham spam-use-BBDB)}. Everything will work
24891 the same way, we promise.
24895 @node Gmane Spam Reporting
24896 @subsubsection Gmane Spam Reporting
24897 @cindex spam reporting
24898 @cindex Gmane, spam reporting
24899 @cindex Gmane, spam reporting
24902 @defvar gnus-group-spam-exit-processor-report-gmane
24904 Add this symbol to a group's @code{spam-process} parameter by
24905 customizing the group parameters or the
24906 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24907 added to a group's @code{spam-process} parameter, the spam-marked
24908 articles groups will be reported to the Gmane administrators via a
24911 Gmane can be found at @uref{http://gmane.org}.
24915 Instead of the obsolete
24916 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
24917 that you use @code{(spam spam-use-gmane)}. Everything will work the
24918 same way, we promise.
24922 @defvar spam-report-gmane-use-article-number
24924 This variable is @code{t} by default. Set it to @code{nil} if you are
24925 running your own news server, for instance, and the local article
24926 numbers don't correspond to the Gmane article numbers. When
24927 @code{spam-report-gmane-use-article-number} is @code{nil},
24928 @code{spam-report.el} will fetch the number from the article headers.
24932 @defvar spam-report-user-mail-address
24934 Mail address exposed in the User-Agent spam reports to Gmane. It allows
24935 the Gmane administrators to contact you in case of misreports. The
24936 default is @code{user-mail-address}.
24940 @node Anti-spam Hashcash Payments
24941 @subsubsection Anti-spam Hashcash Payments
24942 @cindex spam filtering
24943 @cindex hashcash, spam filtering
24946 @defvar spam-use-hashcash
24948 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
24949 Whitelists}), but uses hashcash tokens for whitelisting messages
24950 instead of the sender address. Messages without a hashcash payment
24951 token will be sent to the next spam-split rule. This is an explicit
24952 filter, meaning that unless a hashcash token is found, the messages
24953 are not assumed to be spam or ham.
24958 @subsubsection Blackholes
24959 @cindex spam filtering
24960 @cindex blackholes, spam filtering
24963 @defvar spam-use-blackholes
24965 This option is disabled by default. You can let Gnus consult the
24966 blackhole-type distributed spam processing systems (DCC, for instance)
24967 when you set this option. The variable @code{spam-blackhole-servers}
24968 holds the list of blackhole servers Gnus will consult. The current
24969 list is fairly comprehensive, but make sure to let us know if it
24970 contains outdated servers.
24972 The blackhole check uses the @code{dig.el} package, but you can tell
24973 @code{spam.el} to use @code{dns.el} instead for better performance if
24974 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
24975 this time to set @code{spam-use-dig} to @code{nil} despite the
24976 possible performance improvements, because some users may be unable to
24977 use it, but you can try it and see if it works for you.
24981 @defvar spam-blackhole-servers
24983 The list of servers to consult for blackhole checks.
24987 @defvar spam-blackhole-good-server-regex
24989 A regular expression for IPs that should not be checked against the
24990 blackhole server list. When set to @code{nil}, it has no effect.
24994 @defvar spam-use-dig
24996 Use the @code{dig.el} package instead of the @code{dns.el} package.
24997 The default setting of @code{t} is recommended.
25001 Blackhole checks are done only on incoming mail. There is no spam or
25002 ham processor for blackholes.
25004 @node Regular Expressions Header Matching
25005 @subsubsection Regular Expressions Header Matching
25006 @cindex spam filtering
25007 @cindex regular expressions header matching, spam filtering
25010 @defvar spam-use-regex-headers
25012 This option is disabled by default. You can let Gnus check the
25013 message headers against lists of regular expressions when you set this
25014 option. The variables @code{spam-regex-headers-spam} and
25015 @code{spam-regex-headers-ham} hold the list of regular expressions.
25016 Gnus will check against the message headers to determine if the
25017 message is spam or ham, respectively.
25021 @defvar spam-regex-headers-spam
25023 The list of regular expressions that, when matched in the headers of
25024 the message, positively identify it as spam.
25028 @defvar spam-regex-headers-ham
25030 The list of regular expressions that, when matched in the headers of
25031 the message, positively identify it as ham.
25035 Regular expression header checks are done only on incoming mail.
25036 There is no specific spam or ham processor for regular expressions.
25039 @subsubsection Bogofilter
25040 @cindex spam filtering
25041 @cindex bogofilter, spam filtering
25044 @defvar spam-use-bogofilter
25046 Set this variable if you want @code{spam-split} to use Eric Raymond's
25049 With a minimum of care for associating the @samp{$} mark for spam
25050 articles only, Bogofilter training all gets fairly automatic. You
25051 should do this until you get a few hundreds of articles in each
25052 category, spam or not. The command @kbd{S t} in summary mode, either
25053 for debugging or for curiosity, shows the @emph{spamicity} score of
25054 the current article (between 0.0 and 1.0).
25056 Bogofilter determines if a message is spam based on a specific
25057 threshold. That threshold can be customized, consult the Bogofilter
25060 If the @code{bogofilter} executable is not in your path, Bogofilter
25061 processing will be turned off.
25063 You should not enable this if you use @code{spam-use-bogofilter-headers}.
25072 @findex spam-bogofilter-score
25073 Get the Bogofilter spamicity score (@code{spam-bogofilter-score}).
25076 @defvar spam-use-bogofilter-headers
25078 Set this variable if you want @code{spam-split} to use Eric Raymond's
25079 speedy Bogofilter, looking only at the message headers. It works
25080 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
25081 must be in the message already. Normally you would do this with a
25082 procmail recipe or something similar; consult the Bogofilter
25083 installation documents for details.
25085 You should not enable this if you use @code{spam-use-bogofilter}.
25089 @defvar gnus-group-spam-exit-processor-bogofilter
25090 Add this symbol to a group's @code{spam-process} parameter by
25091 customizing the group parameters or the
25092 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25093 added to a group's @code{spam-process} parameter, spam-marked articles
25094 will be added to the Bogofilter spam database.
25098 Instead of the obsolete
25099 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
25100 that you use @code{(spam spam-use-bogofilter)}. Everything will work
25101 the same way, we promise.
25104 @defvar gnus-group-ham-exit-processor-bogofilter
25105 Add this symbol to a group's @code{spam-process} parameter by
25106 customizing the group parameters or the
25107 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25108 added to a group's @code{spam-process} parameter, the ham-marked
25109 articles in @emph{ham} groups will be added to the Bogofilter database
25110 of non-spam messages.
25114 Instead of the obsolete
25115 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
25116 that you use @code{(ham spam-use-bogofilter)}. Everything will work
25117 the same way, we promise.
25120 @defvar spam-bogofilter-database-directory
25122 This is the directory where Bogofilter will store its databases. It
25123 is not specified by default, so Bogofilter will use its own default
25124 database directory.
25128 The Bogofilter mail classifier is similar to @command{ifile} in intent and
25129 purpose. A ham and a spam processor are provided, plus the
25130 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
25131 variables to indicate to spam-split that Bogofilter should either be
25132 used, or has already been used on the article. The 0.9.2.1 version of
25133 Bogofilter was used to test this functionality.
25135 @node SpamAssassin back end
25136 @subsubsection SpamAssassin back end
25137 @cindex spam filtering
25138 @cindex spamassassin, spam filtering
25141 @defvar spam-use-spamassassin
25143 Set this variable if you want @code{spam-split} to use SpamAssassin.
25145 SpamAssassin assigns a score to each article based on a set of rules
25146 and tests, including a Bayesian filter. The Bayesian filter can be
25147 trained by associating the @samp{$} mark for spam articles. The
25148 spam score can be viewed by using the command @kbd{S t} in summary
25151 If you set this variable, each article will be processed by
25152 SpamAssassin when @code{spam-split} is called. If your mail is
25153 preprocessed by SpamAssassin, and you want to just use the
25154 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
25157 You should not enable this if you use
25158 @code{spam-use-spamassassin-headers}.
25162 @defvar spam-use-spamassassin-headers
25164 Set this variable if your mail is preprocessed by SpamAssassin and
25165 want @code{spam-split} to split based on the SpamAssassin headers.
25167 You should not enable this if you use @code{spam-use-spamassassin}.
25171 @defvar spam-spamassassin-program
25173 This variable points to the SpamAssassin executable. If you have
25174 @code{spamd} running, you can set this variable to the @code{spamc}
25175 executable for faster processing. See the SpamAssassin documentation
25176 for more information on @code{spamd}/@code{spamc}.
25180 SpamAssassin is a powerful and flexible spam filter that uses a wide
25181 variety of tests to identify spam. A ham and a spam processors are
25182 provided, plus the @code{spam-use-spamassassin} and
25183 @code{spam-use-spamassassin-headers} variables to indicate to
25184 spam-split that SpamAssassin should be either used, or has already
25185 been used on the article. The 2.63 version of SpamAssassin was used
25186 to test this functionality.
25188 @node ifile spam filtering
25189 @subsubsection ifile spam filtering
25190 @cindex spam filtering
25191 @cindex ifile, spam filtering
25194 @defvar spam-use-ifile
25196 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
25197 statistical analyzer similar to Bogofilter.
25201 @defvar spam-ifile-all-categories
25203 Enable this variable if you want @code{spam-use-ifile} to give you all
25204 the ifile categories, not just spam/non-spam. If you use this, make
25205 sure you train ifile as described in its documentation.
25209 @defvar spam-ifile-spam-category
25211 This is the category of spam messages as far as ifile is concerned.
25212 The actual string used is irrelevant, but you probably want to leave
25213 the default value of @samp{spam}.
25216 @defvar spam-ifile-database
25218 This is the filename for the ifile database. It is not specified by
25219 default, so ifile will use its own default database name.
25223 The ifile mail classifier is similar to Bogofilter in intent and
25224 purpose. A ham and a spam processor are provided, plus the
25225 @code{spam-use-ifile} variable to indicate to spam-split that ifile
25226 should be used. The 1.2.1 version of ifile was used to test this
25229 @node Spam Statistics Filtering
25230 @subsubsection Spam Statistics Filtering
25231 @cindex spam filtering
25232 @cindex spam-stat, spam filtering
25236 This back end uses the Spam Statistics Emacs Lisp package to perform
25237 statistics-based filtering (@pxref{Spam Statistics Package}). Before
25238 using this, you may want to perform some additional steps to
25239 initialize your Spam Statistics dictionary. @xref{Creating a
25240 spam-stat dictionary}.
25242 @defvar spam-use-stat
25246 @defvar gnus-group-spam-exit-processor-stat
25247 Add this symbol to a group's @code{spam-process} parameter by
25248 customizing the group parameters or the
25249 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25250 added to a group's @code{spam-process} parameter, the spam-marked
25251 articles will be added to the spam-stat database of spam messages.
25255 Instead of the obsolete
25256 @code{gnus-group-spam-exit-processor-stat}, it is recommended
25257 that you use @code{(spam spam-use-stat)}. Everything will work
25258 the same way, we promise.
25261 @defvar gnus-group-ham-exit-processor-stat
25262 Add this symbol to a group's @code{spam-process} parameter by
25263 customizing the group parameters or the
25264 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25265 added to a group's @code{spam-process} parameter, the ham-marked
25266 articles in @emph{ham} groups will be added to the spam-stat database
25267 of non-spam messages.
25271 Instead of the obsolete
25272 @code{gnus-group-ham-exit-processor-stat}, it is recommended
25273 that you use @code{(ham spam-use-stat)}. Everything will work
25274 the same way, we promise.
25277 This enables @code{spam.el} to cooperate with @file{spam-stat.el}.
25278 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
25279 which unlike ifile or Bogofilter does not require external programs.
25280 A spam and a ham processor, and the @code{spam-use-stat} variable for
25281 @code{spam-split} are provided.
25284 @subsubsection Using SpamOracle with Gnus
25285 @cindex spam filtering
25289 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
25290 statistical mail filtering tool written by Xavier Leroy and needs to be
25291 installed separately.
25293 There are several ways to use SpamOracle with Gnus. In all cases, your
25294 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
25295 then enter an @samp{X-Spam} header indicating whether it regards the
25296 mail as a spam mail or not.
25298 One possibility is to run SpamOracle as a @code{:prescript} from the
25299 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
25300 the advantage that the user can see the @emph{X-Spam} headers.
25302 The easiest method is to make @file{spam.el} (@pxref{Spam Package})
25305 @vindex spam-use-spamoracle
25306 To enable SpamOracle usage by @code{spam.el}, set the variable
25307 @code{spam-use-spamoracle} to @code{t} and configure the
25308 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}. @xref{Spam
25309 Package}. In this example the @samp{INBOX} of an nnimap server is
25310 filtered using SpamOracle. Mails recognized as spam mails will be
25311 moved to @code{spam-split-group}, @samp{Junk} in this case. Ham
25312 messages stay in @samp{INBOX}:
25315 (setq spam-use-spamoracle t
25316 spam-split-group "Junk"
25317 ;; @r{for nnimap you'll probably want to set nnimap-split-methods, see the manual}
25318 nnimap-split-inbox '("INBOX")
25319 nnimap-split-fancy '(| (: spam-split) "INBOX"))
25322 @defvar spam-use-spamoracle
25323 Set to @code{t} if you want Gnus to enable spam filtering using
25327 @defvar spam-spamoracle-binary
25328 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
25329 user's PATH@. Using the variable @code{spam-spamoracle-binary}, this
25333 @defvar spam-spamoracle-database
25334 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
25335 store its analysis. This is controlled by the variable
25336 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
25337 the default SpamOracle database will be used. In case you want your
25338 database to live somewhere special, set
25339 @code{spam-spamoracle-database} to this path.
25342 SpamOracle employs a statistical algorithm to determine whether a
25343 message is spam or ham. In order to get good results, meaning few
25344 false hits or misses, SpamOracle needs training. SpamOracle learns
25345 the characteristics of your spam mails. Using the @emph{add} mode
25346 (training mode) one has to feed good (ham) and spam mails to
25347 SpamOracle. This can be done by pressing @kbd{|} in the Summary
25348 buffer and pipe the mail to a SpamOracle process or using
25349 @file{spam.el}'s spam- and ham-processors, which is much more
25350 convenient. For a detailed description of spam- and ham-processors,
25351 @xref{Spam Package}.
25353 @defvar gnus-group-spam-exit-processor-spamoracle
25354 Add this symbol to a group's @code{spam-process} parameter by
25355 customizing the group parameter or the
25356 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
25357 to a group's @code{spam-process} parameter, spam-marked articles will be
25358 sent to SpamOracle as spam samples.
25362 Instead of the obsolete
25363 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
25364 that you use @code{(spam spam-use-spamoracle)}. Everything will work
25365 the same way, we promise.
25368 @defvar gnus-group-ham-exit-processor-spamoracle
25369 Add this symbol to a group's @code{spam-process} parameter by
25370 customizing the group parameter or the
25371 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
25372 to a group's @code{spam-process} parameter, the ham-marked articles in
25373 @emph{ham} groups will be sent to the SpamOracle as samples of ham
25378 Instead of the obsolete
25379 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
25380 that you use @code{(ham spam-use-spamoracle)}. Everything will work
25381 the same way, we promise.
25384 @emph{Example:} These are the Group Parameters of a group that has been
25385 classified as a ham group, meaning that it should only contain ham
25388 ((spam-contents gnus-group-spam-classification-ham)
25389 (spam-process ((ham spam-use-spamoracle)
25390 (spam spam-use-spamoracle))))
25392 For this group the @code{spam-use-spamoracle} is installed for both
25393 ham and spam processing. If the group contains spam message
25394 (e.g., because SpamOracle has not had enough sample messages yet) and
25395 the user marks some messages as spam messages, these messages will be
25396 processed by SpamOracle. The processor sends the messages to
25397 SpamOracle as new samples for spam.
25399 @node Extending the Spam package
25400 @subsection Extending the Spam package
25401 @cindex spam filtering
25402 @cindex spam elisp package, extending
25403 @cindex extending the spam elisp package
25405 Say you want to add a new back end called blackbox. For filtering
25406 incoming mail, provide the following:
25414 (defvar spam-use-blackbox nil
25415 "True if blackbox should be used.")
25418 Write @code{spam-check-blackbox} if Blackbox can check incoming mail.
25420 Write @code{spam-blackbox-register-routine} and
25421 @code{spam-blackbox-unregister-routine} using the bogofilter
25422 register/unregister routines as a start, or other register/unregister
25423 routines more appropriate to Blackbox, if Blackbox can
25424 register/unregister spam and ham.
25429 The @code{spam-check-blackbox} function should return @samp{nil} or
25430 @code{spam-split-group}, observing the other conventions. See the
25431 existing @code{spam-check-*} functions for examples of what you can
25432 do, and stick to the template unless you fully understand the reasons
25437 For processing spam and ham messages, provide the following:
25444 Note you don't have to provide a spam or a ham processor. Only
25445 provide them if Blackbox supports spam or ham processing.
25447 Also, ham and spam processors are being phased out as single
25448 variables. Instead the form @code{(spam spam-use-blackbox)} or
25449 @code{(ham spam-use-blackbox)} is favored. For now, spam/ham
25450 processor variables are still around but they won't be for long.
25453 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
25454 "The Blackbox summary exit spam processor.
25455 Only applicable to spam groups.")
25457 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
25458 "The whitelist summary exit ham processor.
25459 Only applicable to non-spam (unclassified and ham) groups.")
25468 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
25469 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
25471 to the @code{spam-process} group parameter in @code{gnus.el}. Make
25472 sure you do it twice, once for the parameter and once for the
25473 variable customization.
25477 (variable-item spam-use-blackbox)
25479 to the @code{spam-autodetect-methods} group parameter in
25480 @code{gnus.el} if Blackbox can check incoming mail for spam contents.
25482 Finally, use the appropriate @code{spam-install-*-backend} function in
25483 @code{spam.el}. Here are the available functions.
25489 @code{spam-install-backend-alias}
25491 This function will simply install an alias for a back end that does
25492 everything like the original back end. It is currently only used to
25493 make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}.
25496 @code{spam-install-nocheck-backend}
25498 This function installs a back end that has no check function, but can
25499 register/unregister ham or spam. The @code{spam-use-gmane} back end is
25503 @code{spam-install-checkonly-backend}
25505 This function will install a back end that can only check incoming mail
25506 for spam contents. It can't register or unregister messages.
25507 @code{spam-use-blackholes} and @code{spam-use-hashcash} are such
25511 @code{spam-install-statistical-checkonly-backend}
25513 This function installs a statistical back end (one which requires the
25514 full body of a message to check it) that can only check incoming mail
25515 for contents. @code{spam-use-regex-body} is such a filter.
25518 @code{spam-install-statistical-backend}
25520 This function install a statistical back end with incoming checks and
25521 registration/unregistration routines. @code{spam-use-bogofilter} is
25525 @code{spam-install-backend}
25527 This is the most normal back end installation, where a back end that can
25528 check and register/unregister messages is set up without statistical
25529 abilities. The @code{spam-use-BBDB} is such a back end.
25532 @code{spam-install-mover-backend}
25534 Mover back ends are internal to @code{spam.el} and specifically move
25535 articles around when the summary is exited. You will very probably
25536 never install such a back end.
25541 @node Spam Statistics Package
25542 @subsection Spam Statistics Package
25543 @cindex Paul Graham
25544 @cindex Graham, Paul
25545 @cindex naive Bayesian spam filtering
25546 @cindex Bayesian spam filtering, naive
25547 @cindex spam filtering, naive Bayesian
25549 Paul Graham has written an excellent essay about spam filtering using
25550 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
25551 Spam}. In it he describes the inherent deficiency of rule-based
25552 filtering as used by SpamAssassin, for example: Somebody has to write
25553 the rules, and everybody else has to install these rules. You are
25554 always late. It would be much better, he argues, to filter mail based
25555 on whether it somehow resembles spam or non-spam. One way to measure
25556 this is word distribution. He then goes on to describe a solution
25557 that checks whether a new mail resembles any of your other spam mails
25560 The basic idea is this: Create a two collections of your mail, one
25561 with spam, one with non-spam. Count how often each word appears in
25562 either collection, weight this by the total number of mails in the
25563 collections, and store this information in a dictionary. For every
25564 word in a new mail, determine its probability to belong to a spam or a
25565 non-spam mail. Use the 15 most conspicuous words, compute the total
25566 probability of the mail being spam. If this probability is higher
25567 than a certain threshold, the mail is considered to be spam.
25569 The Spam Statistics package adds support to Gnus for this kind of
25570 filtering. It can be used as one of the back ends of the Spam package
25571 (@pxref{Spam Package}), or by itself.
25573 Before using the Spam Statistics package, you need to set it up.
25574 First, you need two collections of your mail, one with spam, one with
25575 non-spam. Then you need to create a dictionary using these two
25576 collections, and save it. And last but not least, you need to use
25577 this dictionary in your fancy mail splitting rules.
25580 * Creating a spam-stat dictionary::
25581 * Splitting mail using spam-stat::
25582 * Low-level interface to the spam-stat dictionary::
25585 @node Creating a spam-stat dictionary
25586 @subsubsection Creating a spam-stat dictionary
25588 Before you can begin to filter spam based on statistics, you must
25589 create these statistics based on two mail collections, one with spam,
25590 one with non-spam. These statistics are then stored in a dictionary
25591 for later use. In order for these statistics to be meaningful, you
25592 need several hundred emails in both collections.
25594 Gnus currently supports only the nnml back end for automated dictionary
25595 creation. The nnml back end stores all mails in a directory, one file
25596 per mail. Use the following:
25598 @defun spam-stat-process-spam-directory
25599 Create spam statistics for every file in this directory. Every file
25600 is treated as one spam mail.
25603 @defun spam-stat-process-non-spam-directory
25604 Create non-spam statistics for every file in this directory. Every
25605 file is treated as one non-spam mail.
25608 Usually you would call @code{spam-stat-process-spam-directory} on a
25609 directory such as @file{~/Mail/mail/spam} (this usually corresponds to
25610 the group @samp{nnml:mail.spam}), and you would call
25611 @code{spam-stat-process-non-spam-directory} on a directory such as
25612 @file{~/Mail/mail/misc} (this usually corresponds to the group
25613 @samp{nnml:mail.misc}).
25615 When you are using @acronym{IMAP}, you won't have the mails available
25616 locally, so that will not work. One solution is to use the Gnus Agent
25617 to cache the articles. Then you can use directories such as
25618 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
25619 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
25622 This variable holds the hash-table with all the statistics---the
25623 dictionary we have been talking about. For every word in either
25624 collection, this hash-table stores a vector describing how often the
25625 word appeared in spam and often it appeared in non-spam mails.
25628 If you want to regenerate the statistics from scratch, you need to
25629 reset the dictionary.
25631 @defun spam-stat-reset
25632 Reset the @code{spam-stat} hash-table, deleting all the statistics.
25635 When you are done, you must save the dictionary. The dictionary may
25636 be rather large. If you will not update the dictionary incrementally
25637 (instead, you will recreate it once a month, for example), then you
25638 can reduce the size of the dictionary by deleting all words that did
25639 not appear often enough or that do not clearly belong to only spam or
25640 only non-spam mails.
25642 @defun spam-stat-reduce-size
25643 Reduce the size of the dictionary. Use this only if you do not want
25644 to update the dictionary incrementally.
25647 @defun spam-stat-save
25648 Save the dictionary.
25651 @defvar spam-stat-file
25652 The filename used to store the dictionary. This defaults to
25653 @file{~/.spam-stat.el}.
25656 @node Splitting mail using spam-stat
25657 @subsubsection Splitting mail using spam-stat
25659 This section describes how to use the Spam statistics
25660 @emph{independently} of the @xref{Spam Package}.
25662 First, add the following to your @file{~/.gnus.el} file:
25665 (require 'spam-stat)
25669 This will load the necessary Gnus code, and the dictionary you
25672 Next, you need to adapt your fancy splitting rules: You need to
25673 determine how to use @code{spam-stat}. The following examples are for
25674 the nnml back end. Using the nnimap back end works just as well. Just
25675 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
25677 In the simplest case, you only have two groups, @samp{mail.misc} and
25678 @samp{mail.spam}. The following expression says that mail is either
25679 spam or it should go into @samp{mail.misc}. If it is spam, then
25680 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
25683 (setq nnmail-split-fancy
25684 `(| (: spam-stat-split-fancy)
25688 @defvar spam-stat-split-fancy-spam-group
25689 The group to use for spam. Default is @samp{mail.spam}.
25692 If you also filter mail with specific subjects into other groups, use
25693 the following expression. Only mails not matching the regular
25694 expression are considered potential spam.
25697 (setq nnmail-split-fancy
25698 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
25699 (: spam-stat-split-fancy)
25703 If you want to filter for spam first, then you must be careful when
25704 creating the dictionary. Note that @code{spam-stat-split-fancy} must
25705 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
25706 non-spam, therefore both should be in your collection of non-spam
25707 mails, when creating the dictionary!
25710 (setq nnmail-split-fancy
25711 `(| (: spam-stat-split-fancy)
25712 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25716 You can combine this with traditional filtering. Here, we move all
25717 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
25718 @code{spam-stat-split-fancy} will never see them, the mails in
25719 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
25720 nor in your collection of non-spam mails, when creating the
25724 (setq nnmail-split-fancy
25725 `(| ("Content-Type" "text/html" "mail.spam.filtered")
25726 (: spam-stat-split-fancy)
25727 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25732 @node Low-level interface to the spam-stat dictionary
25733 @subsubsection Low-level interface to the spam-stat dictionary
25735 The main interface to using @code{spam-stat}, are the following functions:
25737 @defun spam-stat-buffer-is-spam
25738 Called in a buffer, that buffer is considered to be a new spam mail.
25739 Use this for new mail that has not been processed before.
25742 @defun spam-stat-buffer-is-no-spam
25743 Called in a buffer, that buffer is considered to be a new non-spam
25744 mail. Use this for new mail that has not been processed before.
25747 @defun spam-stat-buffer-change-to-spam
25748 Called in a buffer, that buffer is no longer considered to be normal
25749 mail but spam. Use this to change the status of a mail that has
25750 already been processed as non-spam.
25753 @defun spam-stat-buffer-change-to-non-spam
25754 Called in a buffer, that buffer is no longer considered to be spam but
25755 normal mail. Use this to change the status of a mail that has already
25756 been processed as spam.
25759 @defun spam-stat-save
25760 Save the hash table to the file. The filename used is stored in the
25761 variable @code{spam-stat-file}.
25764 @defun spam-stat-load
25765 Load the hash table from a file. The filename used is stored in the
25766 variable @code{spam-stat-file}.
25769 @defun spam-stat-score-word
25770 Return the spam score for a word.
25773 @defun spam-stat-score-buffer
25774 Return the spam score for a buffer.
25777 @defun spam-stat-split-fancy
25778 Use this function for fancy mail splitting. Add the rule @samp{(:
25779 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
25782 Make sure you load the dictionary before using it. This requires the
25783 following in your @file{~/.gnus.el} file:
25786 (require 'spam-stat)
25790 Typical test will involve calls to the following functions:
25793 Reset: (setq spam-stat (make-hash-table :test 'equal))
25794 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25795 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25796 Save table: (spam-stat-save)
25797 File size: (nth 7 (file-attributes spam-stat-file))
25798 Number of words: (hash-table-count spam-stat)
25799 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25800 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25801 Reduce table size: (spam-stat-reduce-size)
25802 Save table: (spam-stat-save)
25803 File size: (nth 7 (file-attributes spam-stat-file))
25804 Number of words: (hash-table-count spam-stat)
25805 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25806 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25809 Here is how you would create your dictionary:
25812 Reset: (setq spam-stat (make-hash-table :test 'equal))
25813 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25814 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25815 Repeat for any other non-spam group you need...
25816 Reduce table size: (spam-stat-reduce-size)
25817 Save table: (spam-stat-save)
25820 @node The Gnus Registry
25821 @section The Gnus Registry
25826 The Gnus registry is a package that tracks messages by their
25827 Message-ID across all backends. This allows Gnus users to do several
25828 cool things, be the envy of the locals, get free haircuts, and be
25829 experts on world issues. Well, maybe not all of those, but the
25830 features are pretty cool.
25832 Although they will be explained in detail shortly, here's a quick list
25833 of said features in case your attention span is... never mind.
25837 Split messages to their parent
25839 This keeps discussions in the same group. You can use the subject and
25840 the sender in addition to the Message-ID@. Several strategies are
25844 Refer to messages by ID
25846 Commands like @code{gnus-summary-refer-parent-article} can take
25847 advantage of the registry to jump to the referred article, regardless
25848 of the group the message is in.
25851 Store custom flags and keywords
25853 The registry can store custom flags and keywords for a message. For
25854 instance, you can mark a message ``To-Do'' this way and the flag will
25855 persist whether the message is in the nnimap, nnml, nnmaildir,
25859 Store arbitrary data
25861 Through a simple ELisp API, the registry can remember any data for a
25862 message. A built-in inverse map, when activated, allows quick lookups
25863 of all messages matching a particular set of criteria.
25867 * Gnus Registry Setup::
25868 * Registry Article Refer Method::
25869 * Fancy splitting to parent::
25870 * Store custom flags and keywords::
25871 * Store arbitrary data::
25874 @node Gnus Registry Setup
25875 @subsection Gnus Registry Setup
25877 Fortunately, setting up the Gnus registry is pretty easy:
25880 (setq gnus-registry-max-entries 2500)
25882 (gnus-registry-initialize)
25885 This adds registry saves to Gnus newsrc saves (which happen on exit
25886 and when you press @kbd{s} from the @code{*Group*} buffer. It also
25887 adds registry calls to article actions in Gnus (copy, move, etc.)@: so
25888 it's not easy to undo the initialization. See
25889 @code{gnus-registry-initialize} for the gory details.
25891 Here are other settings used by the author of the registry (understand
25892 what they do before you copy them blindly).
25896 gnus-registry-split-strategy 'majority
25897 gnus-registry-ignored-groups '(("nntp" t)
25901 gnus-registry-max-entries 500000
25902 ;; this is the default
25903 gnus-registry-track-extra '(sender subject))
25906 They say: keep a lot of messages around, track messages by sender and
25907 subject (not just parent Message-ID), and when the registry splits
25908 incoming mail, use a majority rule to decide where messages should go
25909 if there's more than one possibility. In addition, the registry
25910 should ignore messages in groups that match ``nntp'', ``nnrss'',
25911 ``spam'', or ``train.''
25913 You are doubtless impressed by all this, but you ask: ``I am a Gnus
25914 user, I customize to live. Give me more.'' Here you go, these are
25915 the general settings.
25917 @defvar gnus-registry-unfollowed-groups
25918 The groups that will not be followed by
25919 @code{gnus-registry-split-fancy-with-parent}. They will still be
25920 remembered by the registry. This is a list of regular expressions.
25921 By default any group name that ends with ``delayed'', ``drafts'',
25922 ``queue'', or ``INBOX'', belongs to the nnmairix backend, or contains
25923 the word ``archive'' is not followed.
25926 @defvar gnus-registry-max-entries
25927 The number (an integer or @code{nil} for unlimited) of entries the
25928 registry will keep.
25931 @defvar gnus-registry-max-pruned-entries
25932 The maximum number (an integer or @code{nil} for unlimited) of entries
25933 the registry will keep after pruning.
25936 @defvar gnus-registry-cache-file
25937 The file where the registry will be stored between Gnus sessions. By
25938 default the file name is @code{.gnus.registry.eioio} in the same
25939 directory as your @code{.newsrc.eld}.
25942 @node Registry Article Refer Method
25943 @subsection Fetching by @code{Message-ID} Using the Registry
25945 The registry knows how to map each @code{Message-ID} to the group it's
25946 in. This can be leveraged to enhance the ``article refer method'',
25947 the thing that tells Gnus how to look up an article given its
25948 Message-ID (@pxref{Finding the Parent}).
25951 @vindex gnus-refer-article-method
25953 The @code{nnregistry} refer method does exactly that. It has the
25954 advantage that an article may be found regardless of the group it's
25955 in---provided its @code{Message-ID} is known to the registry. It can
25956 be enabled by augmenting the start-up file with something along these
25960 ;; Keep enough entries to have a good hit rate when referring to an
25961 ;; article using the registry. Use long group names so that Gnus
25962 ;; knows where the article is.
25963 (setq gnus-registry-max-entries 2500)
25965 (gnus-registry-initialize)
25967 (setq gnus-refer-article-method
25970 (nnweb "gmane" (nnweb-type gmane))))
25973 The example above instructs Gnus to first look up the article in the
25974 current group, or, alternatively, using the registry, and finally, if
25975 all else fails, using Gmane.
25977 @node Fancy splitting to parent
25978 @subsection Fancy splitting to parent
25980 Simply put, this lets you put followup e-mail where it belongs.
25982 Every message has a Message-ID, which is unique, and the registry
25983 remembers it. When the message is moved or copied, the registry will
25984 notice this and offer the new group as a choice to the splitting
25987 When a followup is made, usually it mentions the original message's
25988 Message-ID in the headers. The registry knows this and uses that
25989 mention to find the group where the original message lives. You only
25990 have to put a rule like this:
25993 (setq nnimap-my-split-fancy '(|
25995 ;; split to parent: you need this
25996 (: gnus-registry-split-fancy-with-parent)
25998 ;; other rules, as an example
26004 in your fancy split setup. In addition, you may want to customize the
26005 following variables.
26007 @defvar gnus-registry-track-extra
26008 This is a list of symbols, so it's best to change it from the
26009 Customize interface. By default it's @code{(subject sender recipient)},
26010 which may work for you. It can be annoying if your mail flow is large
26011 and people don't stick to the same groups.
26013 When you decide to stop tracking any of those extra data, you can use
26014 the command @code{gnus-registry-remove-extra-data} to purge it from
26015 the existing registry entries.
26018 @defvar gnus-registry-split-strategy
26019 This is a symbol, so it's best to change it from the Customize
26020 interface. By default it's @code{nil}, but you may want to set it to
26021 @code{majority} or @code{first} to split by sender or subject based on
26022 the majority of matches or on the first found. I find @code{majority}
26026 @node Store custom flags and keywords
26027 @subsection Store custom flags and keywords
26029 The registry lets you set custom flags and keywords per message. You
26030 can use the Gnus->Registry Marks menu or the @kbd{M M x} keyboard
26031 shortcuts, where @code{x} is the first letter of the mark's name.
26033 @defvar gnus-registry-marks
26034 The custom marks that the registry can use. You can modify the
26035 default list, if you like. If you do, you'll have to exit Emacs
26036 before they take effect (you can also unload the registry and reload
26037 it or evaluate the specific macros you'll need, but you probably don't
26038 want to bother). Use the Customize interface to modify the list.
26040 By default this list has the @code{Important}, @code{Work},
26041 @code{Personal}, @code{To-Do}, and @code{Later} marks. They all have
26042 keyboard shortcuts like @kbd{M M i} for Important, using the first
26046 @defun gnus-registry-mark-article
26047 Call this function to mark an article with a custom registry mark. It
26048 will offer the available marks for completion.
26051 You can use @code{defalias} to install a summary line formatting
26052 function that will show the registry marks. There are two flavors of
26053 this function, either showing the marks as single characters, using
26054 their @code{:char} property, or showing the marks as full strings.
26057 ;; show the marks as single characters (see the :char property in
26058 ;; `gnus-registry-marks'):
26059 ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-chars)
26061 ;; show the marks by name (see `gnus-registry-marks'):
26062 ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-names)
26066 @node Store arbitrary data
26067 @subsection Store arbitrary data
26069 The registry has a simple API that uses a Message-ID as the key to
26070 store arbitrary data (as long as it can be converted to a list for
26073 @defun gnus-registry-set-id-key (id key value)
26074 Store @code{value} under @code{key} for message @code{id}.
26077 @defun gnus-registry-get-id-key (id key)
26078 Get the data under @code{key} for message @code{id}.
26081 @defvar gnus-registry-extra-entries-precious
26082 If any extra entries are precious, their presence will make the
26083 registry keep the whole entry forever, even if there are no groups for
26084 the Message-ID and if the size limit of the registry is reached. By
26085 default this is just @code{(marks)} so the custom registry marks are
26090 @section Interaction with other modes
26095 @code{gnus-dired-minor-mode} provides some useful functions for dired
26096 buffers. It is enabled with
26098 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
26103 @findex gnus-dired-attach
26104 @cindex attachments, selection via dired
26105 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
26106 You will be prompted for a message buffer.
26109 @findex gnus-dired-find-file-mailcap
26110 Visit a file according to the appropriate mailcap entry
26111 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
26115 @findex gnus-dired-print
26116 Print file according to the mailcap entry (@code{gnus-dired-print}). If
26117 there is no print command, print in a PostScript image.
26120 @node Various Various
26121 @section Various Various
26127 @item gnus-home-directory
26128 @vindex gnus-home-directory
26129 All Gnus file and directory variables will be initialized from this
26130 variable, which defaults to @file{~/}.
26132 @item gnus-directory
26133 @vindex gnus-directory
26134 Most Gnus storage file and directory variables will be initialized from
26135 this variable, which defaults to the @env{SAVEDIR} environment
26136 variable, or @file{~/News/} if that variable isn't set.
26138 Note that Gnus is mostly loaded when the @file{~/.gnus.el} file is read.
26139 This means that other directory variables that are initialized from this
26140 variable won't be set properly if you set this variable in
26141 @file{~/.gnus.el}. Set this variable in @file{.emacs} instead.
26143 @item gnus-default-directory
26144 @vindex gnus-default-directory
26145 Not related to the above variable at all---this variable says what the
26146 default directory of all Gnus buffers should be. If you issue commands
26147 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
26148 default directory. If this variable is @code{nil} (which is the
26149 default), the default directory will be the default directory of the
26150 buffer you were in when you started Gnus.
26153 @vindex gnus-verbose
26154 This variable is an integer between zero and ten. The higher the value,
26155 the more messages will be displayed. If this variable is zero, Gnus
26156 will never flash any messages, if it is seven (which is the default),
26157 most important messages will be shown, and if it is ten, Gnus won't ever
26158 shut up, but will flash so many messages it will make your head swim.
26160 @item gnus-verbose-backends
26161 @vindex gnus-verbose-backends
26162 This variable works the same way as @code{gnus-verbose}, but it applies
26163 to the Gnus back ends instead of Gnus proper.
26165 @item gnus-add-timestamp-to-message
26166 @vindex gnus-add-timestamp-to-message
26167 This variable controls whether to add timestamps to messages that are
26168 controlled by @code{gnus-verbose} and @code{gnus-verbose-backends} and
26169 are issued. The default value is @code{nil} which means never to add
26170 timestamp. If it is @code{log}, add timestamps to only the messages
26171 that go into the @samp{*Messages*} buffer (in XEmacs, it is the
26172 @w{@samp{ *Message-Log*}} buffer). If it is neither @code{nil} nor
26173 @code{log}, add timestamps not only to log messages but also to the ones
26174 displayed in the echo area.
26176 @item nnheader-max-head-length
26177 @vindex nnheader-max-head-length
26178 When the back ends read straight heads of articles, they all try to read
26179 as little as possible. This variable (default 8192) specifies
26180 the absolute max length the back ends will try to read before giving up
26181 on finding a separator line between the head and the body. If this
26182 variable is @code{nil}, there is no upper read bound. If it is
26183 @code{t}, the back ends won't try to read the articles piece by piece,
26184 but read the entire articles. This makes sense with some versions of
26185 @code{ange-ftp} or @code{efs}.
26187 @item nnheader-head-chop-length
26188 @vindex nnheader-head-chop-length
26189 This variable (default 2048) says how big a piece of each article to
26190 read when doing the operation described above.
26192 @item nnheader-file-name-translation-alist
26193 @vindex nnheader-file-name-translation-alist
26195 @cindex invalid characters in file names
26196 @cindex characters in file names
26197 This is an alist that says how to translate characters in file names.
26198 For instance, if @samp{:} is invalid as a file character in file names
26199 on your system (you OS/2 user you), you could say something like:
26203 (setq nnheader-file-name-translation-alist
26208 In fact, this is the default value for this variable on OS/2 and MS
26209 Windows (phooey) systems.
26211 @item gnus-hidden-properties
26212 @vindex gnus-hidden-properties
26213 This is a list of properties to use to hide ``invisible'' text. It is
26214 @code{(invisible t intangible t)} by default on most systems, which
26215 makes invisible text invisible and intangible.
26217 @item gnus-parse-headers-hook
26218 @vindex gnus-parse-headers-hook
26219 A hook called before parsing headers. It can be used, for instance, to
26220 gather statistics on the headers fetched, or perhaps you'd like to prune
26221 some headers. I don't see why you'd want that, though.
26223 @item gnus-shell-command-separator
26224 @vindex gnus-shell-command-separator
26225 String used to separate two shell commands. The default is @samp{;}.
26227 @item gnus-invalid-group-regexp
26228 @vindex gnus-invalid-group-regexp
26230 Regexp to match ``invalid'' group names when querying user for a group
26231 name. The default value catches some @strong{really} invalid group
26232 names who could possibly mess up Gnus internally (like allowing
26233 @samp{:} in a group name, which is normally used to delimit method and
26236 @acronym{IMAP} users might want to allow @samp{/} in group names though.
26238 @item gnus-safe-html-newsgroups
26239 @vindex gnus-safe-html-newsgroups
26240 Groups in which links in html articles are considered all safe. The
26241 value may be a regexp matching those groups, a list of group names, or
26242 @code{nil}. This overrides @code{mm-w3m-safe-url-regexp}. The default
26243 value is @code{"\\`nnrss[+:]"}. This is effective only when emacs-w3m
26244 renders html articles, i.e., in the case @code{mm-text-html-renderer} is
26245 set to @code{w3m}. @xref{Display Customization, ,Display Customization,
26246 emacs-mime, The Emacs MIME Manual}.
26253 Well, that's the manual---you can get on with your life now. Keep in
26254 touch. Say hello to your cats from me.
26256 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
26258 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
26264 Not because of victories @*
26267 but for the common sunshine,@*
26269 the largess of the spring.
26273 but for the day's work done@*
26274 as well as I was able;@*
26275 not for a seat upon the dais@*
26276 but at the common table.@*
26281 @chapter Appendices
26284 * XEmacs:: Requirements for installing under XEmacs.
26285 * History:: How Gnus got where it is today.
26286 * On Writing Manuals:: Why this is not a beginner's guide.
26287 * Terminology:: We use really difficult, like, words here.
26288 * Customization:: Tailoring Gnus to your needs.
26289 * Troubleshooting:: What you might try if things do not work.
26290 * Gnus Reference Guide:: Rilly, rilly technical stuff.
26291 * Emacs for Heathens:: A short introduction to Emacsian terms.
26292 * Frequently Asked Questions:: The Gnus FAQ
26299 @cindex installing under XEmacs
26301 XEmacs is distributed as a collection of packages. You should install
26302 whatever packages the Gnus XEmacs package requires. The current
26303 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
26304 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
26305 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{W3},
26306 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
26313 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
26314 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
26316 If you want to investigate the person responsible for this outrage,
26317 you can point your (feh!) web browser to
26318 @uref{http://quimby.gnus.org/}. This is also the primary
26319 distribution point for the new and spiffy versions of Gnus, and is
26320 known as The Site That Destroys Newsrcs And Drives People Mad.
26322 During the first extended alpha period of development, the new Gnus was
26323 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
26324 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
26325 (Besides, the ``Gnus'' in this abbreviation should probably be
26326 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
26327 appropriate name, don't you think?)
26329 In any case, after spending all that energy on coming up with a new and
26330 spunky name, we decided that the name was @emph{too} spunky, so we
26331 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
26332 ``@sc{gnus}''. New vs. old.
26335 * Gnus Versions:: What Gnus versions have been released.
26336 * Why?:: What's the point of Gnus?
26337 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
26338 * Conformity:: Gnus tries to conform to all standards.
26339 * Emacsen:: Gnus can be run on a few modern Emacsen.
26340 * Gnus Development:: How Gnus is developed.
26341 * Contributors:: Oodles of people.
26342 * New Features:: Pointers to some of the new stuff in Gnus.
26346 @node Gnus Versions
26347 @subsection Gnus Versions
26349 @cindex September Gnus
26351 @cindex Quassia Gnus
26352 @cindex Pterodactyl Gnus
26356 @cindex Gnus versions
26358 The first ``proper'' release of Gnus 5 was done in November 1995 when it
26359 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
26360 plus 15 Gnus 5.0 releases).
26362 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
26363 releases)) was released under the name ``Gnus 5.2'' (40 releases).
26365 On July 28th 1996 work on Red Gnus was begun, and it was released on
26366 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
26368 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
26369 It was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
26371 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
26372 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
26375 On the 26th of October 2000, Oort Gnus was begun and was released as
26376 Gnus 5.10 on May 1st 2003 (24 releases).
26378 On the January 4th 2004, No Gnus was begun.
26380 On April 19, 2010 Gnus development was moved to Git. See
26381 http://git.gnus.org for details (http://www.gnus.org will be updated
26382 with the information when possible).
26384 On the January 31th 2012, Ma Gnus was begun.
26386 If you happen upon a version of Gnus that has a prefixed name---``(ding)
26387 Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
26388 ``Pterodactyl Gnus'', ``Oort Gnus'', ``No Gnus'', ``Ma Gnus''---don't
26389 panic. Don't let it know that you're frightened. Back away. Slowly.
26390 Whatever you do, don't run. Walk away, calmly, until you're out of
26391 its reach. Find a proper released version of Gnus and snuggle up to
26398 What's the point of Gnus?
26400 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
26401 newsreader, that lets you do anything you can think of. That was my
26402 original motivation, but while working on Gnus, it has become clear to
26403 me that this generation of newsreaders really belong in the stone age.
26404 Newsreaders haven't developed much since the infancy of the net. If the
26405 volume continues to rise with the current rate of increase, all current
26406 newsreaders will be pretty much useless. How do you deal with
26407 newsgroups that have thousands of new articles each day? How do you
26408 keep track of millions of people who post?
26410 Gnus offers no real solutions to these questions, but I would very much
26411 like to see Gnus being used as a testing ground for new methods of
26412 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
26413 to separate the newsreader from the back ends, Gnus now offers a simple
26414 interface for anybody who wants to write new back ends for fetching mail
26415 and news from different sources. I have added hooks for customizations
26416 everywhere I could imagine it being useful. By doing so, I'm inviting
26417 every one of you to explore and invent.
26419 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
26420 @kbd{C-u 100 M-x all-hail-xemacs}.
26423 @node Compatibility
26424 @subsection Compatibility
26426 @cindex compatibility
26427 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
26428 bindings have been kept. More key bindings have been added, of course,
26429 but only in one or two obscure cases have old bindings been changed.
26434 @center In a cloud bones of steel.
26438 All commands have kept their names. Some internal functions have changed
26441 The @code{gnus-uu} package has changed drastically. @xref{Decoding
26444 One major compatibility question is the presence of several summary
26445 buffers. All variables relevant while reading a group are
26446 buffer-local to the summary buffer they belong in. Although many
26447 important variables have their values copied into their global
26448 counterparts whenever a command is executed in the summary buffer, this
26449 change might lead to incorrect values being used unless you are careful.
26451 All code that relies on knowledge of @sc{gnus} internals will probably
26452 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
26453 changing it in any way, as a matter of fact) is strictly verboten. Gnus
26454 maintains a hash table that points to the entries in this alist (which
26455 speeds up many functions), and changing the alist directly will lead to
26459 @cindex highlighting
26460 Old hilit19 code does not work at all. In fact, you should probably
26461 remove all hilit code from all Gnus hooks
26462 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
26463 Gnus provides various integrated functions for highlighting. These are
26464 faster and more accurate. To make life easier for everybody, Gnus will
26465 by default remove all hilit calls from all hilit hooks. Uncleanliness!
26468 Packages like @code{expire-kill} will no longer work. As a matter of
26469 fact, you should probably remove all old @sc{gnus} packages (and other
26470 code) when you start using Gnus. More likely than not, Gnus already
26471 does what you have written code to make @sc{gnus} do. (Snicker.)
26473 Even though old methods of doing things are still supported, only the
26474 new methods are documented in this manual. If you detect a new method of
26475 doing something while reading this manual, that does not mean you have
26476 to stop doing it the old way.
26478 Gnus understands all @sc{gnus} startup files.
26480 @kindex M-x gnus-bug
26482 @cindex reporting bugs
26484 Overall, a casual user who hasn't written much code that depends on
26485 @sc{gnus} internals should suffer no problems. If problems occur,
26486 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
26488 @vindex gnus-bug-create-help-buffer
26489 If you are in the habit of sending bug reports @emph{very} often, you
26490 may find the helpful help buffer annoying after a while. If so, set
26491 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
26496 @subsection Conformity
26498 No rebels without a clue here, ma'am. We conform to all standards known
26499 to (wo)man. Except for those standards and/or conventions we disagree
26507 There are no known breaches of this standard.
26511 There are no known breaches of this standard, either.
26513 @item Son-of-RFC 1036
26514 @cindex Son-of-RFC 1036
26515 We do have some breaches to this one.
26521 These are considered to be ``vanity headers'', while I consider them
26522 to be consumer information. After seeing so many badly formatted
26523 articles coming from @code{tin} and @code{Netscape} I know not to use
26524 either of those for posting articles. I would not have known that if
26525 it wasn't for the @code{X-Newsreader} header.
26530 USEFOR is an IETF working group writing a successor to RFC 1036, based
26531 on Son-of-RFC 1036. They have produced a number of drafts proposing
26532 various changes to the format of news articles. The Gnus towers will
26533 look into implementing the changes when the draft is accepted as an RFC.
26535 @item MIME---RFC 2045--2049 etc
26536 @cindex @acronym{MIME}
26537 All the various @acronym{MIME} RFCs are supported.
26539 @item Disposition Notifications---RFC 2298
26540 Message Mode is able to request notifications from the receiver.
26542 @item PGP---RFC 1991 and RFC 2440
26545 RFC 1991 is the original @acronym{PGP} message specification,
26546 published as an informational RFC@. RFC 2440 was the follow-up, now
26547 called Open PGP, and put on the Standards Track. Both document a
26548 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
26549 encoding (signing and encryption) and decoding (verification and
26552 @item PGP/MIME---RFC 2015/3156
26553 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
26554 1991) describes the @acronym{MIME}-wrapping around the RFC 1991/2440 format.
26555 Gnus supports both encoding and decoding.
26557 @item S/MIME---RFC 2633
26558 RFC 2633 describes the @acronym{S/MIME} format.
26560 @item IMAP---RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
26561 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
26562 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
26563 authentication for @acronym{IMAP}. RFC 2086 describes access control
26564 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
26565 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
26566 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
26567 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
26571 If you ever notice Gnus acting non-compliant with regards to the texts
26572 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
26577 @subsection Emacsen
26583 This version of Gnus should work on:
26591 XEmacs 21.4 and up.
26595 This Gnus version will absolutely not work on any Emacsen older than
26596 that. Not reliably, at least. Older versions of Gnus may work on older
26597 Emacs versions. Particularly, Gnus 5.10.8 should also work on Emacs
26598 20.7 and XEmacs 21.1.
26600 @c No-merge comment: The paragraph added in v5-10 here must not be
26603 @node Gnus Development
26604 @subsection Gnus Development
26606 Gnus is developed in a two-phased cycle. The first phase involves much
26607 discussion on the development mailing list @samp{ding@@gnus.org}, where people
26608 propose changes and new features, post patches and new back ends. This
26609 phase is called the @dfn{alpha} phase, since the Gnusae released in this
26610 phase are @dfn{alpha releases}, or (perhaps more commonly in other
26611 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
26612 unstable and should not be used by casual users. Gnus alpha releases
26613 have names like ``Oort Gnus'' and ``No Gnus''. @xref{Gnus Versions}.
26615 After futzing around for 10--100 alpha releases, Gnus is declared
26616 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
26617 and is called things like ``Gnus 5.10.1'' instead. Normal people are
26618 supposed to be able to use these, and these are mostly discussed on the
26619 @samp{gnu.emacs.gnus} newsgroup. This newgroup is mirrored to the
26620 mailing list @samp{info-gnus-english@@gnu.org} which is carried on Gmane
26621 as @samp{gmane.emacs.gnus.user}. These releases are finally integrated
26625 @vindex mail-source-delete-incoming
26626 Some variable defaults differ between alpha Gnusae and released Gnusae,
26627 in particular, @code{mail-source-delete-incoming}. This is to prevent
26628 lossage of mail if an alpha release hiccups while handling the mail.
26629 @xref{Mail Source Customization}.
26631 The division of discussion between the ding mailing list and the Gnus
26632 newsgroup is not purely based on publicity concerns. It's true that
26633 having people write about the horrible things that an alpha Gnus release
26634 can do (sometimes) in a public forum may scare people off, but more
26635 importantly, talking about new experimental features that have been
26636 introduced may confuse casual users. New features are frequently
26637 introduced, fiddled with, and judged to be found wanting, and then
26638 either discarded or totally rewritten. People reading the mailing list
26639 usually keep up with these rapid changes, while people on the newsgroup
26640 can't be assumed to do so.
26642 So if you have problems with or questions about the alpha versions,
26643 direct those to the ding mailing list @samp{ding@@gnus.org}. This list
26644 is also available on Gmane as @samp{gmane.emacs.gnus.general}.
26647 @vindex mail-source-delete-incoming
26648 Some variable defaults differ between alpha Gnusae and released Gnusae,
26649 in particular, @code{mail-source-delete-incoming}. This is to prevent
26650 lossage of mail if an alpha release hiccups while handling the mail.
26651 @xref{Mail Source Customization}.
26654 @subsection Contributors
26655 @cindex contributors
26657 The new Gnus version couldn't have been done without the help of all the
26658 people on the (ding) mailing list. Every day for over a year I have
26659 gotten billions of nice bug reports from them, filling me with joy,
26660 every single one of them. Smooches. The people on the list have been
26661 tried beyond endurance, what with my ``oh, that's a neat idea <type
26662 type>, yup, I'll release it right away <ship off> no wait, that doesn't
26663 work at all <type type>, yup, I'll ship that one off right away <ship
26664 off> no, wait, that absolutely does not work'' policy for releases.
26665 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
26666 ``worser''? ``much worser''? ``worsest''?)
26668 I would like to take this opportunity to thank the Academy for@dots{} oops,
26674 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
26677 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el,
26678 nnwarchive and many, many other things connected with @acronym{MIME} and
26679 other types of en/decoding, as well as general bug fixing, new
26680 functionality and stuff.
26683 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
26684 well as numerous other things).
26687 Luis Fernandes---design and graphics.
26690 Joe Reiss---creator of the smiley faces.
26693 Justin Sheehy---the @acronym{FAQ} maintainer.
26696 Erik Naggum---help, ideas, support, code and stuff.
26699 Wes Hardaker---@file{gnus-picon.el} and the manual section on
26700 @dfn{picons} (@pxref{Picons}).
26703 Kim-Minh Kaplan---further work on the picon code.
26706 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
26709 Sudish Joseph---innumerable bug fixes.
26712 Ilja Weis---@file{gnus-topic.el}.
26715 Steven L. Baur---lots and lots and lots of bug detection and fixes.
26718 Vladimir Alexiev---the refcard and reference booklets.
26721 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
26722 distribution by Felix Lee and JWZ.
26725 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
26728 Peter Mutsaers---orphan article scoring code.
26731 Ken Raeburn---POP mail support.
26734 Hallvard B Furuseth---various bits and pieces, especially dealing with
26738 Brian Edmonds---@file{gnus-bbdb.el}.
26741 David Moore---rewrite of @file{nnvirtual.el} and many other things.
26744 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
26747 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
26748 well as autoconf support.
26752 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
26753 Borges, and Jost Krieger proof-reading parts of the manual.
26755 The following people have contributed many patches and suggestions:
26770 Jason L. Tibbitts, III,
26772 Katsumi Yamaoka, @c Yamaoka
26776 Also thanks to the following for patches and stuff:
26786 Alexei V. Barantsev,
26801 Massimo Campostrini,
26806 Jae-you Chung, @c ?
26807 James H. Cloos, Jr.,
26811 Andrew J. Cosgriff,
26814 Geoffrey T. Dairiki,
26820 Michael Welsh Duggan,
26825 Enami Tsugutomo, @c Enami
26829 Nelson Jose dos Santos Ferreira,
26837 Arne Georg Gleditsch,
26839 Michelangelo Grigni,
26843 Kenichi Handa, @c Handa
26845 Yoshiki Hayashi, @c Hayashi
26847 Hisashige Kenji, @c Hisashige
26855 Fran@,{c}ois Felix Ingrand,
26856 Tatsuya Ichikawa, @c Ichikawa
26857 Ishikawa Ichiro, @c Ishikawa
26859 Iwamuro Motonori, @c Iwamuro
26869 Peter Skov Knudsen,
26870 Shuhei Kobayashi, @c Kobayashi
26872 Koseki Yoshinori, @c Koseki
26873 Thor Kristoffersen,
26876 Seokchan Lee, @c Lee
26894 Morioka Tomohiko, @c Morioka
26895 Erik Toubro Nielsen,
26902 Masaharu Onishi, @c Onishi
26907 Jens-Ulrik Holger Petersen,
26911 John McClary Prevost,
26917 Lars Balker Rasmussen,
26922 Christian von Roques,
26925 Wolfgang Rupprecht,
26932 Philippe Schnoebelen,
26934 Randal L. Schwartz,
26948 Kiyokazu Suto, @c Suto
26953 Tozawa Akihiko, @c Tozawa
26973 For a full overview of what each person has done, the ChangeLogs
26974 included in the Gnus alpha distributions should give ample reading
26975 (550kB and counting).
26977 Apologies to everybody that I've forgotten, of which there are many, I'm
26980 Gee, that's quite a list of people. I guess that must mean that there
26981 actually are people who are using Gnus. Who'd'a thunk it!
26985 @subsection New Features
26986 @cindex new features
26989 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
26990 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
26991 * Red Gnus:: Third time best---Gnus 5.4/5.5.
26992 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
26993 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
26994 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
26995 * No Gnus:: Very punny. Gnus 5.12/5.13.
26996 * Ma Gnus:: Celebrating 25 years of Gnus.
26999 These lists are, of course, just @emph{short} overviews of the
27000 @emph{most} important new features. No, really. There are tons more.
27001 Yes, we have feeping creaturism in full effect.
27004 @subsubsection (ding) Gnus
27006 New features in Gnus 5.0/5.1:
27011 The look of all buffers can be changed by setting format-like variables
27012 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
27015 Local spool and several @acronym{NNTP} servers can be used at once
27016 (@pxref{Select Methods}).
27019 You can combine groups into virtual groups (@pxref{Virtual Groups}).
27022 You can read a number of different mail formats (@pxref{Getting Mail}).
27023 All the mail back ends implement a convenient mail expiry scheme
27024 (@pxref{Expiring Mail}).
27027 Gnus can use various strategies for gathering threads that have lost
27028 their roots (thereby gathering loose sub-threads into one thread) or it
27029 can go back and retrieve enough headers to build a complete thread
27030 (@pxref{Customizing Threading}).
27033 Killed groups can be displayed in the group buffer, and you can read
27034 them as well (@pxref{Listing Groups}).
27037 Gnus can do partial group updates---you do not have to retrieve the
27038 entire active file just to check for new articles in a few groups
27039 (@pxref{The Active File}).
27042 Gnus implements a sliding scale of subscribedness to groups
27043 (@pxref{Group Levels}).
27046 You can score articles according to any number of criteria
27047 (@pxref{Scoring}). You can even get Gnus to find out how to score
27048 articles for you (@pxref{Adaptive Scoring}).
27051 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
27052 manner, so it should be difficult to lose much data on what you have
27053 read if your machine should go down (@pxref{Auto Save}).
27056 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
27057 cluttering up the @file{.emacs} file.
27060 You can set the process mark on both groups and articles and perform
27061 operations on all the marked items (@pxref{Process/Prefix}).
27064 You can list subsets of groups according to, well, anything
27065 (@pxref{Listing Groups}).
27068 You can browse foreign servers and subscribe to groups from those
27069 servers (@pxref{Browse Foreign Server}).
27072 Gnus can fetch articles, asynchronously, on a second connection to the
27073 server (@pxref{Asynchronous Fetching}).
27076 You can cache articles locally (@pxref{Article Caching}).
27079 The uudecode functions have been expanded and generalized
27080 (@pxref{Decoding Articles}).
27083 You can still post uuencoded articles, which was a little-known feature
27084 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
27087 Fetching parents (and other articles) now actually works without
27088 glitches (@pxref{Finding the Parent}).
27091 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
27094 Digests (and other files) can be used as the basis for groups
27095 (@pxref{Document Groups}).
27098 Articles can be highlighted and customized (@pxref{Customizing
27102 URLs and other external references can be buttonized (@pxref{Article
27106 You can do lots of strange stuff with the Gnus window & frame
27107 configuration (@pxref{Window Layout}).
27112 @node September Gnus
27113 @subsubsection September Gnus
27117 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
27121 New features in Gnus 5.2/5.3:
27126 A new message composition mode is used. All old customization variables
27127 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
27131 Gnus is now able to generate @dfn{sparse} threads---threads where
27132 missing articles are represented by empty nodes (@pxref{Customizing
27136 (setq gnus-build-sparse-threads 'some)
27140 Outgoing articles are stored on a special archive server
27141 (@pxref{Archived Messages}).
27144 Partial thread regeneration now happens when articles are
27148 Gnus can make use of GroupLens predictions.
27151 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
27154 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
27157 (setq gnus-use-trees t)
27161 An @code{nn}-like pick-and-read minor mode is available for the summary
27162 buffers (@pxref{Pick and Read}).
27165 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
27169 In binary groups you can use a special binary minor mode (@pxref{Binary
27173 Groups can be grouped in a folding topic hierarchy (@pxref{Group
27177 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
27181 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
27184 Groups can now have a score, and bubbling based on entry frequency
27185 is possible (@pxref{Group Score}).
27188 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
27192 Groups can be process-marked, and commands can be performed on
27193 groups of groups (@pxref{Marking Groups}).
27196 Caching is possible in virtual groups.
27199 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
27200 news batches, ClariNet briefs collections, and just about everything
27201 else (@pxref{Document Groups}).
27204 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets.
27207 The Gnus cache is much faster.
27210 Groups can be sorted according to many criteria (@pxref{Sorting
27214 New group parameters have been introduced to set list-addresses and
27215 expiry times (@pxref{Group Parameters}).
27218 All formatting specs allow specifying faces to be used
27219 (@pxref{Formatting Fonts}).
27222 There are several more commands for setting/removing/acting on process
27223 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
27226 The summary buffer can be limited to show parts of the available
27227 articles based on a wide range of criteria. These commands have been
27228 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
27231 Articles can be made persistent with the @kbd{*} command
27232 (@pxref{Persistent Articles}).
27235 All functions for hiding article elements are now toggles.
27238 Article headers can be buttonized (@pxref{Article Washing}).
27241 All mail back ends support fetching articles by @code{Message-ID}.
27244 Duplicate mail can now be treated properly (@pxref{Duplicates}).
27247 All summary mode commands are available directly from the article
27248 buffer (@pxref{Article Keymap}).
27251 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
27255 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
27258 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
27263 Groups can be made permanently visible (@pxref{Listing Groups}).
27266 (setq gnus-permanently-visible-groups "^nnml:")
27270 Many new hooks have been introduced to make customizing easier.
27273 Gnus respects the @code{Mail-Copies-To} header.
27276 Threads can be gathered by looking at the @code{References} header
27277 (@pxref{Customizing Threading}).
27280 (setq gnus-summary-thread-gathering-function
27281 'gnus-gather-threads-by-references)
27285 Read articles can be stored in a special backlog buffer to avoid
27286 refetching (@pxref{Article Backlog}).
27289 (setq gnus-keep-backlog 50)
27293 A clean copy of the current article is always stored in a separate
27294 buffer to allow easier treatment.
27297 Gnus can suggest where to save articles (@pxref{Saving Articles}).
27300 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
27304 (setq gnus-prompt-before-saving t)
27308 @code{gnus-uu} can view decoded files asynchronously while fetching
27309 articles (@pxref{Other Decode Variables}).
27312 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
27316 Filling in the article buffer now works properly on cited text
27317 (@pxref{Article Washing}).
27320 Hiding cited text adds buttons to toggle hiding, and how much
27321 cited text to hide is now customizable (@pxref{Article Hiding}).
27324 (setq gnus-cited-lines-visible 2)
27328 Boring headers can be hidden (@pxref{Article Hiding}).
27331 Default scoring values can now be set from the menu bar.
27334 Further syntax checking of outgoing articles have been added.
27340 @subsubsection Red Gnus
27342 New features in Gnus 5.4/5.5:
27346 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
27353 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
27356 Article prefetching functionality has been moved up into
27357 Gnus (@pxref{Asynchronous Fetching}).
27360 Scoring can now be performed with logical operators like @code{and},
27361 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
27365 Article washing status can be displayed in the
27366 article mode line (@pxref{Misc Article}).
27369 @file{gnus.el} has been split into many smaller files.
27372 Suppression of duplicate articles based on Message-ID can be done
27373 (@pxref{Duplicate Suppression}).
27376 (setq gnus-suppress-duplicates t)
27380 New variables for specifying what score and adapt files are to be
27381 considered home score and adapt files (@pxref{Home Score File}) have
27385 @code{nndoc} was rewritten to be easily extensible (@pxref{Document
27386 Server Internals}).
27389 Groups can inherit group parameters from parent topics (@pxref{Topic
27393 Article editing has been revamped and is now actually usable.
27396 Signatures can be recognized in more intelligent fashions
27397 (@pxref{Article Signature}).
27400 Summary pick mode has been made to look more @code{nn}-like. Line
27401 numbers are displayed and the @kbd{.} command can be used to pick
27402 articles (@code{Pick and Read}).
27405 Commands for moving the @file{.newsrc.eld} from one server to
27406 another have been added (@pxref{Changing Servers}).
27409 There's a way now to specify that ``uninteresting'' fields be suppressed
27410 when generating lines in buffers (@pxref{Advanced Formatting}).
27413 Several commands in the group buffer can be undone with @kbd{C-M-_}
27417 Scoring can be done on words using the new score type @code{w}
27418 (@pxref{Score File Format}).
27421 Adaptive scoring can be done on a Subject word-by-word basis
27422 (@pxref{Adaptive Scoring}).
27425 (setq gnus-use-adaptive-scoring '(word))
27429 Scores can be decayed (@pxref{Score Decays}).
27432 (setq gnus-decay-scores t)
27436 Scoring can be performed using a regexp on the Date header. The Date is
27437 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
27440 A new command has been added to remove all data on articles from
27441 the native server (@pxref{Changing Servers}).
27444 A new command for reading collections of documents
27445 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
27446 (@pxref{Really Various Summary Commands}).
27449 Process mark sets can be pushed and popped (@pxref{Setting Process
27453 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
27454 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
27457 A new back end for reading searches from Web search engines
27458 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
27459 (@pxref{Web Searches}).
27462 Groups inside topics can now be sorted using the standard sorting
27463 functions, and each topic can be sorted independently (@pxref{Topic
27467 Subsets of the groups can be sorted independently (@code{Sorting
27471 Cached articles can be pulled into the groups (@pxref{Summary Generation
27475 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
27480 Score files are now applied in a more reliable order (@pxref{Score
27484 Reports on where mail messages end up can be generated (@pxref{Splitting
27488 More hooks and functions have been added to remove junk from incoming
27489 mail before saving the mail (@pxref{Washing Mail}).
27492 Emphasized text can be properly fontisized:
27498 @subsubsection Quassia Gnus
27500 New features in Gnus 5.6:
27505 New functionality for using Gnus as an offline newsreader has been
27506 added. A plethora of new commands and modes have been added.
27507 @xref{Gnus Unplugged}, for the full story.
27510 The @code{nndraft} back end has returned, but works differently than
27511 before. All Message buffers are now also articles in the @code{nndraft}
27512 group, which is created automatically.
27515 @code{gnus-alter-header-function} can now be used to alter header
27519 @code{gnus-summary-goto-article} now accept Message-IDs.
27522 A new Message command for deleting text in the body of a message
27523 outside the region: @kbd{C-c C-v}.
27526 You can now post to component group in @code{nnvirtual} groups with
27530 @code{nntp-rlogin-program}---new variable to ease customization.
27533 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
27534 re-highlighting of the article buffer.
27537 New element in @code{gnus-boring-article-headers}---@code{long-to}.
27540 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
27544 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
27545 @kbd{a} to add the score rule to the @file{all.SCORE} file.
27548 @code{gnus-simplify-subject-functions} variable to allow greater
27549 control over simplification.
27552 @kbd{A T}---new command for fetching the current thread.
27555 @kbd{/ T}---new command for including the current thread in the
27559 @kbd{M-RET} is a new Message command for breaking cited text.
27562 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
27565 The @code{custom-face-lookup} function has been removed.
27566 If you used this function in your initialization files, you must
27567 rewrite them to use @code{face-spec-set} instead.
27570 Canceling now uses the current select method. Symbolic prefix
27571 @kbd{a} forces normal posting method.
27574 New command to translate M******** sm*rtq**t*s into proper
27578 For easier debugging of @code{nntp}, you can set
27579 @code{nntp-record-commands} to a non-@code{nil} value.
27582 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
27583 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
27586 A command for editing group parameters from the summary buffer
27590 A history of where mails have been split is available.
27593 A new article date command has been added---@code{article-date-iso8601}.
27596 Subjects can be simplified when threading by setting
27597 @code{gnus-score-thread-simplify}.
27600 A new function for citing in Message has been
27601 added---@code{message-cite-original-without-signature}.
27604 @code{article-strip-all-blank-lines}---new article command.
27607 A new Message command to kill to the end of the article has
27611 A minimum adaptive score can be specified by using the
27612 @code{gnus-adaptive-word-minimum} variable.
27615 The ``lapsed date'' article header can be kept continually
27616 updated by the @code{gnus-start-date-timer} command.
27619 Web listserv archives can be read with the @code{nnlistserv} back end.
27622 Old dejanews archives can now be read by @code{nnweb}.
27626 @node Pterodactyl Gnus
27627 @subsubsection Pterodactyl Gnus
27629 New features in Gnus 5.8:
27634 The mail-fetching functions have changed. See the manual for the
27635 many details. In particular, all procmail fetching variables are gone.
27637 If you used procmail like in
27640 (setq nnmail-use-procmail t)
27641 (setq nnmail-spool-file 'procmail)
27642 (setq nnmail-procmail-directory "~/mail/incoming/")
27643 (setq nnmail-procmail-suffix "\\.in")
27646 this now has changed to
27650 '((directory :path "~/mail/incoming/"
27654 @xref{Mail Source Specifiers}.
27657 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
27658 Gnus, and adds a slew of new commands. See the manual for details.
27661 Gnus has also been multilingualized. This also affects too
27662 many parts of Gnus to summarize here, and adds many new variables.
27665 @code{gnus-auto-select-first} can now be a function to be
27666 called to position point.
27669 The user can now decide which extra headers should be included in
27670 summary buffers and @acronym{NOV} files.
27673 @code{gnus-article-display-hook} has been removed. Instead, a number
27674 of variables starting with @code{gnus-treat-} have been added.
27677 The Gnus posting styles have been redone again and now works in a
27678 subtly different manner.
27681 New web-based back ends have been added: @code{nnslashdot},
27682 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
27683 again, to keep up with ever-changing layouts.
27686 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
27691 @subsubsection Oort Gnus
27694 New features in Gnus 5.10:
27698 @item Installation changes
27699 @c ***********************
27703 Upgrading from previous (stable) version if you have used Oort.
27705 If you have tried Oort (the unstable Gnus branch leading to this
27706 release) but went back to a stable version, be careful when upgrading to
27707 this version. In particular, you will probably want to remove all
27708 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
27709 read from your @file{.newsrc.eld} instead of from the
27710 @file{.marks}/@file{.mrk} file where this release store flags. See a
27711 later entry for more information about marks. Note that downgrading
27712 isn't save in general.
27715 Lisp files are now installed in @file{.../site-lisp/gnus/} by default.
27716 It defaulted to @file{.../site-lisp/} formerly. In addition to this,
27717 the new installer issues a warning if other Gnus installations which
27718 will shadow the latest one are detected. You can then remove those
27719 shadows manually or remove them using @code{make
27720 remove-installed-shadows}.
27723 New @file{make.bat} for compiling and installing Gnus under MS Windows
27725 Use @file{make.bat} if you want to install Gnus under MS Windows, the
27726 first argument to the batch-program should be the directory where
27727 @file{xemacs.exe} respectively @file{emacs.exe} is located, if you want
27728 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
27729 the second parameter.
27731 @file{make.bat} has been rewritten from scratch, it now features
27732 automatic recognition of XEmacs and Emacs, generates
27733 @file{gnus-load.el}, checks if errors occur while compilation and
27734 generation of info files and reports them at the end of the build
27735 process. It now uses @code{makeinfo} if it is available and falls
27736 back to @file{infohack.el} otherwise. @file{make.bat} should now
27737 install all files which are necessary to run Gnus and be generally a
27738 complete replacement for the @code{configure; make; make install}
27739 cycle used under Unix systems.
27741 The new @file{make.bat} makes @file{make-x.bat} and @file{xemacs.mak}
27742 superfluous, so they have been removed.
27745 @file{~/News/overview/} not used.
27747 As a result of the following change, the @file{~/News/overview/}
27748 directory is not used any more. You can safely delete the entire
27751 @c FIXME: `gnus-load' is mentioned in README, which is not included in
27752 @c the repository. We should find a better place for this item.
27754 @code{(require 'gnus-load)}
27756 If you use a stand-alone Gnus distribution, you'd better add
27757 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
27758 lisp directory into load-path.
27760 File @file{gnus-load.el} contains autoload commands, functions and variables,
27761 some of which may not be included in distributions of Emacsen.
27765 @item New packages and libraries within Gnus
27766 @c *****************************************
27771 The revised Gnus @acronym{FAQ} is included in the manual,
27772 @xref{Frequently Asked Questions}.
27775 @acronym{TLS} wrapper shipped with Gnus
27777 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
27778 @acronym{NNTP} via @file{tls.el} and GnuTLS.
27781 Improved anti-spam features.
27783 Gnus is now able to take out spam from your mail and news streams
27784 using a wide variety of programs and filter rules. Among the supported
27785 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
27786 for easy use of external packages such as SpamAssassin and Hashcash
27787 are also new. @ref{Thwarting Email Spam} and @ref{Spam Package}.
27788 @c FIXME: @xref{Spam Package}?. Should this be under Misc?
27791 Gnus supports server-side mail filtering using Sieve.
27793 Sieve rules can be added as Group Parameters for groups, and the
27794 complete Sieve script is generated using @kbd{D g} from the Group
27795 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
27796 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
27797 manual @ref{Top, , Top, sieve, Emacs Sieve}.
27801 @item Changes in group mode
27802 @c ************************
27807 @code{gnus-group-read-ephemeral-group} can be called interactively,
27811 Retrieval of charters and control messages
27813 There are new commands for fetching newsgroup charters (@kbd{H c}) and
27814 control messages (@kbd{H C}).
27817 The new variable @code{gnus-parameters} can be used to set group parameters.
27819 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
27820 the parameters in @file{~/.newsrc.eld}, but via this variable you can
27821 enjoy the powers of customize, and simplified backups since you set the
27822 variable in @file{~/.gnus.el} instead of @file{~/.newsrc.eld}. The
27823 variable maps regular expressions matching group names to group
27826 (setq gnus-parameters
27828 (gnus-show-threads nil)
27829 (gnus-use-scoring nil))
27830 ("^nnimap:\\(foo.bar\\)$"
27831 (to-group . "\\1"))))
27835 Unread count correct in nnimap groups.
27837 The estimated number of unread articles in the group buffer should now
27838 be correct for nnimap groups. This is achieved by calling
27839 @code{nnimap-fixup-unread-after-getting-new-news} from the
27840 @code{gnus-setup-news-hook} (called on startup) and
27841 @code{gnus-after-getting-new-news-hook}. (called after getting new
27842 mail). If you have modified those variables from the default, you may
27843 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
27844 you were happy with the estimate and want to save some (minimal) time
27845 when getting new mail, remove the function.
27848 Group names are treated as UTF-8 by default.
27850 This is supposedly what USEFOR wanted to migrate to. See
27851 @code{gnus-group-name-charset-group-alist} and
27852 @code{gnus-group-name-charset-method-alist} for customization.
27855 @code{gnus-group-charset-alist} and
27856 @code{gnus-group-ignored-charsets-alist}.
27858 The regexps in these variables are compared with full group names
27859 instead of real group names in 5.8. Users who customize these
27860 variables should change those regexps accordingly. For example:
27862 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
27866 Old intermediate incoming mail files (@file{Incoming*}) are deleted
27867 after a couple of days, not immediately. @xref{Mail Source
27868 Customization}. (New in Gnus 5.10.10 / Emacs 22.2)
27872 @item Changes in summary and article mode
27873 @c **************************************
27878 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
27879 (@code{gnus-article-reply-with-original}) only yank the text in the
27880 region if the region is active.
27883 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
27884 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
27889 More buttons for URLs, mail addresses, Message-IDs, Info links, man
27890 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
27891 variables @code{gnus-button-@var{*}-level} can be used to control the
27892 appearance of all article buttons. @xref{Article Button Levels}.
27895 Single-part yenc encoded attachments can be decoded.
27900 The picons code has been reimplemented to work in GNU Emacs---some of
27901 the previous options have been removed or renamed.
27903 Picons are small ``personal icons'' representing users, domain and
27904 newsgroups, which can be displayed in the Article buffer.
27908 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
27909 boundary line is drawn at the end of the headers.
27912 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
27915 The Summary Buffer uses an arrow in the fringe to indicate the current
27916 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
27919 Warn about email replies to news
27921 Do you often find yourself replying to news by email by mistake? Then
27922 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
27926 If the new option @code{gnus-summary-display-while-building} is
27927 non-@code{nil}, the summary buffer is shown and updated as it's being
27931 Gnus supports RFC 2369 mailing list headers, and adds a number of
27932 related commands in mailing list groups. @xref{Mailing List}.
27935 The Date header can be displayed in a format that can be read aloud
27936 in English. @xref{Article Date}.
27939 diffs are automatically highlighted in groups matching
27940 @code{mm-uu-diff-groups-regexp}
27943 Better handling of Microsoft citation styles
27945 Gnus now tries to recognize the mangled header block that some Microsoft
27946 mailers use to indicate that the rest of the message is a citation, even
27947 though it is not quoted in any way. The variable
27948 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
27951 The new command @kbd{W Y f}
27952 (@code{gnus-article-outlook-deuglify-article}) allows deuglifying broken
27953 Outlook (Express) articles.
27956 @code{gnus-article-skip-boring}
27958 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
27959 not scroll down to show you a page that contains only boring text,
27960 which by default means cited text and signature. You can customize
27961 what is skippable using @code{gnus-article-boring-faces}.
27963 This feature is especially useful if you read many articles that
27964 consist of a little new content at the top with a long, untrimmed
27965 message cited below.
27968 Smileys (@samp{:-)}, @samp{;-)} etc.)@: are now displayed graphically in
27971 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.gnus.el} to
27975 Face headers handling. @xref{Face}.
27978 In the summary buffer, the new command @kbd{/ N} inserts new messages
27979 and @kbd{/ o} inserts old messages.
27982 Gnus decodes morse encoded messages if you press @kbd{W m}.
27985 @code{gnus-summary-line-format}
27987 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
27988 %s\n}. Moreover @code{gnus-extra-headers},
27989 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
27990 changed their default so that the users name will be replaced by the
27991 recipient's name or the group name posting to for @acronym{NNTP}
27995 Deleting of attachments.
27997 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
27998 on @acronym{MIME} buttons) saves a part and replaces the part with an
27999 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
28000 @acronym{MIME} buttons) removes a part. It works only on back ends
28001 that support editing.
28004 @code{gnus-default-charset}
28006 The default value is determined from the
28007 @code{current-language-environment} variable, instead of
28008 @code{iso-8859-1}. Also the @samp{.*} item in
28009 @code{gnus-group-charset-alist} is removed.
28012 Printing capabilities are enhanced.
28014 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
28015 Article buffers. Also, each individual @acronym{MIME} part can be
28016 printed using @kbd{p} on the @acronym{MIME} button.
28019 Extended format specs.
28021 Format spec @samp{%&user-date;} is added into
28022 @code{gnus-summary-line-format-alist}. Also, user defined extended
28023 format specs are supported. The extended format specs look like
28024 @samp{%u&foo;}, which invokes function
28025 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
28026 escape character, old user defined format @samp{%u&} is no longer supported.
28029 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
28030 @c FIXME: Was this a user-visible change?
28032 It was aliased to @kbd{Y c}
28033 (@code{gnus-summary-insert-cached-articles}). The new function filters
28034 out other articles.
28037 Some limiting commands accept a @kbd{C-u} prefix to negate the match.
28039 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
28040 s}, @kbd{/ a}, and @kbd{/ x}
28041 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
28042 result will be to display all articles that do not match the expression.
28045 Gnus inlines external parts (message/external).
28049 @item Changes in Message mode and related Gnus features
28050 @c ****************************************************
28057 You can delay the sending of a message with @kbd{C-c C-j} in the Message
28058 buffer. The messages are delivered at specified time. This is useful
28059 for sending yourself reminders. @xref{Delayed Articles}.
28062 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
28063 the nnml back end allows compressed message files.
28066 The new option @code{gnus-gcc-mark-as-read} automatically marks
28067 Gcc articles as read.
28070 Externalizing of attachments
28072 If @code{gnus-gcc-externalize-attachments} or
28073 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
28074 local files as external parts.
28077 The envelope sender address can be customized when using Sendmail.
28078 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
28081 Gnus no longer generate the Sender: header automatically.
28083 Earlier it was generated when the user configurable email address was
28084 different from the Gnus guessed default user address. As the guessing
28085 algorithm is rarely correct these days, and (more controversially) the
28086 only use of the Sender: header was to check if you are entitled to
28087 cancel/supersede news (which is now solved by Cancel Locks instead,
28088 see another entry), generation of the header has been disabled by
28089 default. See the variables @code{message-required-headers},
28090 @code{message-required-news-headers}, and
28091 @code{message-required-mail-headers}.
28094 Features from third party @file{message-utils.el} added to @file{message.el}.
28096 Message now asks if you wish to remove @samp{(was: <old subject>)} from
28097 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
28098 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
28099 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
28100 appropriate headers and a note in the body for cross-postings and
28101 followups (see the variables @code{message-cross-post-@var{*}}).
28104 References and X-Draft-From headers are no longer generated when you
28105 start composing messages and @code{message-generate-headers-first} is
28109 Easy inclusion of X-Faces headers. @xref{X-Face}.
28112 Group Carbon Copy (GCC) quoting
28114 To support groups that contains SPC and other weird characters, groups
28115 are quoted before they are placed in the Gcc: header. This means
28116 variables such as @code{gnus-message-archive-group} should no longer
28117 contain quote characters to make groups containing SPC work. Also, if
28118 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
28119 into two groups) you must change it to return the list
28120 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
28121 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
28122 was incorrect earlier, it just didn't generate any problems since it
28123 was inserted directly.
28126 @code{message-insinuate-rmail}
28128 @c FIXME should that not be 'message-user-agent?
28129 Adding @code{(message-insinuate-rmail)} and @code{(setq
28130 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
28131 compose, reply and forward messages in message-mode, where you can
28132 enjoy the power of @acronym{MML}.
28135 @code{message-minibuffer-local-map}
28137 The line below enables BBDB in resending a message:
28139 (define-key message-minibuffer-local-map [(tab)]
28140 'bbdb-complete-name)
28144 @code{gnus-posting-styles}
28146 Add a new format of match like
28148 ((header "to" "larsi.*org")
28149 (Organization "Somewhere, Inc."))
28151 The old format like the lines below is obsolete, but still accepted.
28153 (header "to" "larsi.*org"
28154 (Organization "Somewhere, Inc."))
28158 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
28160 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
28161 added into these two variables. If you customized those, perhaps you
28162 need add those two headers too.
28165 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
28166 composing messages, it is enabled by @code{use-hard-newlines}.
28167 Decoding format=flowed was present but not documented in earlier
28171 The option @code{mm-fill-flowed} can be used to disable treatment of
28172 ``format=flowed'' messages. Also, flowed text is disabled when sending
28173 inline PGP signed messages. @xref{Flowed text, , Flowed text,
28174 emacs-mime, The Emacs MIME Manual}. (New in Gnus 5.10.7)
28175 @c This entry is also present in the node "No Gnus".
28178 Gnus supports the generation of RFC 2298 Disposition Notification requests.
28180 This is invoked with the @kbd{C-c M-n} key binding from message mode.
28183 Message supports the Importance: (RFC 2156) header.
28185 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
28189 Gnus supports Cancel Locks in News.
28191 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
28192 used to determine if you wrote an article or not (for canceling and
28193 superseding). Gnus generates a random password string the first time
28194 you post a message, and saves it in your @file{~/.emacs} using the Custom
28195 system. While the variable is called @code{canlock-password}, it is not
28196 security sensitive data. Publishing your canlock string on the web
28197 will not allow anyone to be able to anything she could not already do.
28198 The behavior can be changed by customizing @code{message-insert-canlock}.
28201 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
28202 2015/3156) and @acronym{S/MIME} (RFC 2630--2633).
28204 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
28205 additional Lisp libraries. This add several menu items to the
28206 Attachments menu, and @kbd{C-c RET} key bindings, when composing
28207 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
28210 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
28213 This change was made to avoid conflict with the standard binding of
28214 @code{back-to-indentation}, which is also useful in message mode.
28217 The default for @code{message-forward-show-mml} changed to the symbol
28220 The behavior for the @code{best} value is to show @acronym{MML} (i.e.,
28221 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
28222 used when forwarding signed or encrypted messages, as the conversion
28223 invalidate the digital signature.
28226 If @code{auto-compression-mode} is enabled, attachments are automatically
28227 decompressed when activated.
28228 @c FIXME: Does this affect article or message mode?
28231 Support for non-@acronym{ASCII} domain names
28233 Message supports non-@acronym{ASCII} domain names in From:, To: and
28234 Cc: and will query you whether to perform encoding when you try to
28235 send a message. The variable @code{message-use-idna} controls this.
28236 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
28237 and Cc: when you view a message. The variable @code{gnus-use-idna}
28240 @item You can now drag and drop attachments to the Message buffer.
28241 See @code{mml-dnd-protocol-alist} and @code{mml-dnd-attach-options}.
28242 @xref{MIME, ,MIME, message, Message Manual}.
28243 @c New in 5.10.9 / 5.11 (Emacs 22.1)
28245 @item @code{auto-fill-mode} is enabled by default in Message mode.
28246 See @code{message-fill-column}. @xref{Various Message Variables, ,
28247 Message Headers, message, Message Manual}.
28248 @c New in Gnus 5.10.12 / 5.11 (Emacs 22.3)
28252 @item Changes in back ends
28253 @c ***********************
28257 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
28260 The nndoc back end now supports mailman digests and exim bounces.
28263 Gnus supports Maildir groups.
28265 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
28268 The nnml and nnfolder back ends store marks for each groups.
28270 This makes it possible to take backup of nnml/nnfolder servers/groups
28271 separately of @file{~/.newsrc.eld}, while preserving marks. It also
28272 makes it possible to share articles and marks between users (without
28273 sharing the @file{~/.newsrc.eld} file) within, e.g., a department. It
28274 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
28275 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
28276 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
28277 another machine, Gnus will automatically use the @file{.marks} or
28278 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
28279 The new server variables @code{nnml-marks-is-evil} and
28280 @code{nnfolder-marks-is-evil} can be used to disable this feature.
28290 The menu bar item (in Group and Summary buffer) named ``Misc'' has
28291 been renamed to ``Gnus''.
28294 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
28295 renamed to ``Attachments''. Note that this menu also contains security
28296 related stuff, like signing and encryption (@pxref{Security, Security,,
28297 message, Message Manual}).
28300 The tool bars have been updated to use GNOME icons in Group, Summary and
28301 Message mode. You can also customize the tool bars: @kbd{M-x
28302 customize-apropos RET -tool-bar$} should get you started. This is a new
28303 feature in Gnus 5.10.10. (Only for Emacs, not in XEmacs.)
28305 @item The tool bar icons are now (de)activated correctly
28306 in the group buffer, see the variable @code{gnus-group-update-tool-bar}.
28307 Its default value depends on your Emacs version. This is a new feature
28312 @item Miscellaneous changes
28313 @c ************************
28320 The Gnus Agent has seen a major updated and is now enabled by default,
28321 and all nntp and nnimap servers from @code{gnus-select-method} and
28322 @code{gnus-secondary-select-method} are agentized by default. Earlier
28323 only the server in @code{gnus-select-method} was agentized by the
28324 default, and the agent was disabled by default. When the agent is
28325 enabled, headers are now also retrieved from the Agent cache instead
28326 of the back ends when possible. Earlier this only happened in the
28327 unplugged state. You can enroll or remove servers with @kbd{J a} and
28328 @kbd{J r} in the server buffer. Gnus will not download articles into
28329 the Agent cache, unless you instruct it to do so, though, by using
28330 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
28331 behavior of having the Agent disabled with @code{(setq gnus-agent
28332 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
28333 is not needed any more.
28336 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
28338 If one reads an article while plugged, and the article already exists
28339 in the Agent, it won't get downloaded once more. @code{(setq
28340 gnus-agent-cache nil)} reverts to the old behavior.
28345 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
28346 bindings in dired buffers to send a file as an attachment, open a file
28347 using the appropriate mailcap entry, and print a file using the mailcap
28351 The format spec @code{%C} for positioning point has changed to @code{%*}.
28354 @code{gnus-slave-unplugged}
28356 A new command which starts Gnus offline in slave mode.
28363 @subsubsection No Gnus
28366 New features in No Gnus:
28367 @c FIXME: Gnus 5.12?
28369 @include gnus-news.texi
28372 @subsubsection Ma Gnus
28375 I'm sure there will be lots of text here. It's really spelled 真
28378 New features in Ma Gnus:
28382 @item Changes in Message mode and related Gnus features
28383 @c ****************************************************
28388 The new hooks @code{gnus-gcc-pre-body-encode-hook} and
28389 @code{gnus-gcc-post-body-encode-hook} are run before/after encoding
28390 the message body of the Gcc copy of a sent message. See
28391 @xref{Archived Messages}.
28401 @section The Manual
28405 This manual was generated from a TeXinfo file and then run through
28406 either @code{texi2dvi}
28408 or my own home-brewed TeXinfo to \LaTeX\ transformer,
28409 and then run through @code{latex} and @code{dvips}
28411 to get what you hold in your hands now.
28413 The following conventions have been used:
28418 This is a @samp{string}
28421 This is a @kbd{keystroke}
28424 This is a @file{file}
28427 This is a @code{symbol}
28431 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
28435 (setq flargnoze "yes")
28438 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
28441 (setq flumphel 'yes)
28444 @samp{yes} and @code{yes} are two @emph{very} different things---don't
28445 ever get them confused.
28449 Of course, everything in this manual is of vital interest, so you should
28450 read it all. Several times. However, if you feel like skimming the
28451 manual, look for that gnu head you should see in the margin over
28452 there---it means that what's being discussed is of more importance than
28453 the rest of the stuff. (On the other hand, if everything is infinitely
28454 important, how can anything be more important than that? Just one more
28455 of the mysteries of this world, I guess.)
28461 @node On Writing Manuals
28462 @section On Writing Manuals
28464 I guess most manuals are written after-the-fact; documenting a program
28465 that's already there. This is not how this manual is written. When
28466 implementing something, I write the manual entry for that something
28467 straight away. I then see that it's difficult to explain the
28468 functionality, so I write how it's supposed to be, and then I change the
28469 implementation. Writing the documentation and writing the code go hand
28472 This, of course, means that this manual has no, or little, flow. It
28473 documents absolutely everything in Gnus, but often not where you're
28474 looking for it. It is a reference manual, and not a guide to how to get
28477 That would be a totally different book, that should be written using the
28478 reference manual as source material. It would look quite different.
28483 @section Terminology
28485 @cindex terminology
28490 This is what you are supposed to use this thing for---reading news.
28491 News is generally fetched from a nearby @acronym{NNTP} server, and is
28492 generally publicly available to everybody. If you post news, the entire
28493 world is likely to read just what you have written, and they'll all
28494 snigger mischievously. Behind your back.
28498 Everything that's delivered to you personally is mail. Some news/mail
28499 readers (like Gnus) blur the distinction between mail and news, but
28500 there is a difference. Mail is private. News is public. Mailing is
28501 not posting, and replying is not following up.
28505 Send a mail to the person who has written what you are reading.
28509 Post an article to the current newsgroup responding to the article you
28514 Gnus considers mail and news to be mostly the same, really. The only
28515 difference is how to access the actual articles. News articles are
28516 commonly fetched via the protocol @acronym{NNTP}, whereas mail
28517 messages could be read from a file on the local disk. The internal
28518 architecture of Gnus thus comprises a ``front end'' and a number of
28519 ``back ends''. Internally, when you enter a group (by hitting
28520 @key{RET}, say), you thereby invoke a function in the front end in
28521 Gnus. The front end then ``talks'' to a back end and says things like
28522 ``Give me the list of articles in the foo group'' or ``Show me article
28525 So a back end mainly defines either a protocol (the @code{nntp} back
28526 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
28527 accesses mail via @acronym{IMAP}) or a file format and directory
28528 layout (the @code{nnspool} back end accesses news via the common
28529 ``spool directory'' format, the @code{nnml} back end access mail via a
28530 file format and directory layout that's quite similar).
28532 Gnus does not handle the underlying media, so to speak---this is all
28533 done by the back ends. A back end is a collection of functions to
28534 access the articles.
28536 However, sometimes the term ``back end'' is also used where ``server''
28537 would have been more appropriate. And then there is the term ``select
28538 method'' which can mean either. The Gnus terminology can be quite
28543 Gnus will always use one method (and back end) as the @dfn{native}, or
28544 default, way of getting news. Groups from the native select method
28545 have names like @samp{gnu.emacs.gnus}.
28549 You can also have any number of foreign groups active at the same
28550 time. These are groups that use non-native non-secondary back ends
28551 for getting news. Foreign groups have names like
28552 @samp{nntp+news.gmane.org:gmane.emacs.gnus.devel}.
28556 Secondary back ends are somewhere half-way between being native and
28557 being foreign, but they mostly act like they are native, but they, too
28558 have names like @samp{nntp+news.gmane.org:gmane.emacs.gnus.devel}.
28562 A message that has been posted as news.
28565 @cindex mail message
28566 A message that has been mailed.
28570 A mail message or news article
28574 The top part of a message, where administrative information (etc.)@: is
28579 The rest of an article. Everything not in the head is in the
28584 A line from the head of an article.
28588 A collection of such lines, or a collection of heads. Or even a
28589 collection of @acronym{NOV} lines.
28591 @item @acronym{NOV}
28592 @cindex @acronym{NOV}
28593 @acronym{NOV} stands for News OverView, which is a type of news server
28594 header which provide datas containing the condensed header information
28595 of articles. They are produced by the server itself; in the @code{nntp}
28596 back end Gnus uses the ones that the @acronym{NNTP} server makes, but
28597 Gnus makes them by itself for some backends (in particular, @code{nnml}).
28599 When Gnus enters a group, it asks the back end for the headers of all
28600 unread articles in the group. Most servers support the News OverView
28601 format, which is more compact and much faster to read and parse than the
28602 normal @sc{head} format.
28604 The @acronym{NOV} data consist of one or more text lines (@pxref{Text
28605 Lines, ,Motion by Text Lines, elisp, The Emacs Lisp Reference Manual})
28606 where each line has the header information of one article. The header
28607 information is a tab-separated series of the header's contents including
28608 an article number, a subject, an author, a date, a message-id,
28611 Those data enable Gnus to generate summary lines quickly. However, if
28612 the server does not support @acronym{NOV} or you disable it purposely or
28613 for some reason, Gnus will try to generate the header information by
28614 parsing each article's headers one by one. It will take time.
28615 Therefore, it is not usually a good idea to set nn*-nov-is-evil
28616 (@pxref{Slow/Expensive Connection}) to a non-@code{nil} value unless you
28617 know that the server makes wrong @acronym{NOV} data.
28621 Each group is subscribed at some @dfn{level} or other (1--9). The ones
28622 that have a lower level are ``more'' subscribed than the groups with a
28623 higher level. In fact, groups on levels 1--5 are considered
28624 @dfn{subscribed}; 6--7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
28625 are @dfn{killed}. Commands for listing groups and scanning for new
28626 articles will all use the numeric prefix as @dfn{working level}.
28628 @item killed groups
28629 @cindex killed groups
28630 No information on killed groups is stored or updated, which makes killed
28631 groups much easier to handle than subscribed groups.
28633 @item zombie groups
28634 @cindex zombie groups
28635 Just like killed groups, only slightly less dead.
28638 @cindex active file
28639 The news server has to keep track of what articles it carries, and what
28640 groups exist. All this information in stored in the active file, which
28641 is rather large, as you might surmise.
28644 @cindex bogus groups
28645 A group that exists in the @file{.newsrc} file, but isn't known to the
28646 server (i.e., it isn't in the active file), is a @emph{bogus group}.
28647 This means that the group probably doesn't exist (any more).
28650 @cindex activating groups
28651 The act of asking the server for info on a group and computing the
28652 number of unread articles is called @dfn{activating the group}.
28653 Un-activated groups are listed with @samp{*} in the group buffer.
28657 News servers store their articles locally in one fashion or other.
28658 One old-fashioned storage method is to have just one file per
28659 article. That's called a ``traditional spool''.
28663 A machine one can connect to and get news (or mail) from.
28665 @item select method
28666 @cindex select method
28667 A structure that specifies the back end, the server and the virtual
28670 @item virtual server
28671 @cindex virtual server
28672 A named select method. Since a select method defines all there is to
28673 know about connecting to a (physical) server, taking the thing as a
28674 whole is a virtual server.
28678 Taking a buffer and running it through a filter of some sort. The
28679 result will (more often than not) be cleaner and more pleasing than the
28682 @item ephemeral groups
28683 @cindex ephemeral groups
28684 @cindex temporary groups
28685 Most groups store data on what articles you have read. @dfn{Ephemeral}
28686 groups are groups that will have no data stored---when you exit the
28687 group, it'll disappear into the aether.
28690 @cindex solid groups
28691 This is the opposite of ephemeral groups. All groups listed in the
28692 group buffer are solid groups.
28694 @item sparse articles
28695 @cindex sparse articles
28696 These are article placeholders shown in the summary buffer when
28697 @code{gnus-build-sparse-threads} has been switched on.
28701 To put responses to articles directly after the articles they respond
28702 to---in a hierarchical fashion.
28706 @cindex thread root
28707 The first article in a thread is the root. It is the ancestor of all
28708 articles in the thread.
28712 An article that has responses.
28716 An article that responds to a different article---its parent.
28720 A collection of messages in one file. The most common digest format is
28721 specified by RFC 1153.
28724 @cindex splitting, terminology
28725 @cindex mail sorting
28726 @cindex mail filtering (splitting)
28727 The action of sorting your emails according to certain rules. Sometimes
28728 incorrectly called mail filtering.
28734 @node Customization
28735 @section Customization
28736 @cindex general customization
28738 All variables are properly documented elsewhere in this manual. This
28739 section is designed to give general pointers on how to customize Gnus
28740 for some quite common situations.
28743 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
28744 * Slow Terminal Connection:: You run a remote Emacs.
28745 * Little Disk Space:: You feel that having large setup files is icky.
28746 * Slow Machine:: You feel like buying a faster machine.
28750 @node Slow/Expensive Connection
28751 @subsection Slow/Expensive Connection
28753 If you run Emacs on a machine locally, and get your news from a machine
28754 over some very thin strings, you want to cut down on the amount of data
28755 Gnus has to get from the server.
28759 @item gnus-read-active-file
28760 Set this to @code{nil}, which will inhibit Gnus from requesting the
28761 entire active file from the server. This file is often very large. You
28762 also have to set @code{gnus-check-new-newsgroups} and
28763 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
28764 doesn't suddenly decide to fetch the active file anyway.
28766 @item gnus-nov-is-evil
28767 @vindex gnus-nov-is-evil
28768 Usually this one must @emph{always} be @code{nil} (which is the
28769 default). If, for example, you wish to not use @acronym{NOV}
28770 (@pxref{Terminology}) with the @code{nntp} back end (@pxref{Crosspost
28771 Handling}), set @code{nntp-nov-is-evil} to a non-@code{nil} value
28772 instead of setting this. But you normally do not need to set
28773 @code{nntp-nov-is-evil} since Gnus by itself will detect whether the
28774 @acronym{NNTP} server supports @acronym{NOV}. Anyway, grabbing article
28775 headers from the @acronym{NNTP} server will not be very fast if you tell
28776 Gnus not to use @acronym{NOV}.
28778 As the variables for the other back ends, there are
28779 @code{nndiary-nov-is-evil}, @code{nndir-nov-is-evil},
28780 @code{nnfolder-nov-is-evil}, @code{nnimap-nov-is-evil},
28781 @code{nnml-nov-is-evil}, and @code{nnspool-nov-is-evil}. Note that a
28782 non-@code{nil} value for @code{gnus-nov-is-evil} overrides all those
28787 @node Slow Terminal Connection
28788 @subsection Slow Terminal Connection
28790 Let's say you use your home computer for dialing up the system that runs
28791 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
28792 possible) the amount of data sent over the wires.
28796 @item gnus-auto-center-summary
28797 Set this to @code{nil} to inhibit Gnus from re-centering the summary
28798 buffer all the time. If it is @code{vertical}, do only vertical
28799 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
28800 horizontal and vertical recentering.
28802 @item gnus-visible-headers
28803 Cut down on the headers included in the articles to the
28804 minimum. You can, in fact, make do without them altogether---most of the
28805 useful data is in the summary buffer, anyway. Set this variable to
28806 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
28808 Use the following to enable all the available hiding features:
28810 (setq gnus-treat-hide-headers 'head
28811 gnus-treat-hide-signature t
28812 gnus-treat-hide-citation t)
28815 @item gnus-use-full-window
28816 By setting this to @code{nil}, you can make all the windows smaller.
28817 While this doesn't really cut down much generally, it means that you
28818 have to see smaller portions of articles before deciding that you didn't
28819 want to read them anyway.
28821 @item gnus-thread-hide-subtree
28822 If this is non-@code{nil}, all threads in the summary buffer will be
28826 @item gnus-updated-mode-lines
28827 If this is @code{nil}, Gnus will not put information in the buffer mode
28828 lines, which might save some time.
28832 @node Little Disk Space
28833 @subsection Little Disk Space
28836 The startup files can get rather large, so you may want to cut their
28837 sizes a bit if you are running out of space.
28841 @item gnus-save-newsrc-file
28842 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
28843 only save @file{.newsrc.eld}. This means that you will not be able to
28844 use any other newsreaders than Gnus. This variable is @code{t} by
28847 @item gnus-read-newsrc-file
28848 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
28849 only read @file{.newsrc.eld}. This means that you will not be able to
28850 use any other newsreaders than Gnus. This variable is @code{t} by
28853 @item gnus-save-killed-list
28854 If this is @code{nil}, Gnus will not save the list of dead groups. You
28855 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
28856 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
28857 variable to @code{nil}. This variable is @code{t} by default.
28863 @subsection Slow Machine
28864 @cindex slow machine
28866 If you have a slow machine, or are just really impatient, there are a
28867 few things you can do to make Gnus run faster.
28869 Set @code{gnus-check-new-newsgroups} and
28870 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
28872 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
28873 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
28874 summary buffer faster. Also @pxref{Slow/Expensive Connection}.
28878 @node Troubleshooting
28879 @section Troubleshooting
28880 @cindex troubleshooting
28882 Gnus works @emph{so} well straight out of the box---I can't imagine any
28890 Make sure your computer is switched on.
28893 Make sure that you really load the current Gnus version. If you have
28894 been running @sc{gnus}, you need to exit Emacs and start it up again before
28898 Try doing an @kbd{M-x gnus-version}. If you get something that looks
28900 @samp{Gnus v5.13} @c Adjust ../Makefile.in if you change this line!
28902 you have the right files loaded. Otherwise you have some old @file{.el}
28903 files lying around. Delete these.
28906 Read the help group (@kbd{G h} in the group buffer) for a
28907 @acronym{FAQ} and a how-to.
28910 @vindex max-lisp-eval-depth
28911 Gnus works on many recursive structures, and in some extreme (and very
28912 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
28913 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
28914 something like that.
28917 If all else fails, report the problem as a bug.
28920 @cindex reporting bugs
28922 @kindex M-x gnus-bug
28924 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
28925 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
28926 me the backtrace. I will fix bugs, but I can only fix them if you send
28927 me a precise description as to how to reproduce the bug.
28929 You really can never be too detailed in a bug report. Always use the
28930 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
28931 a 10Kb mail each time you use it, and even if you have sent me your
28932 environment 500 times before. I don't care. I want the full info each
28935 It is also important to remember that I have no memory whatsoever. If
28936 you send a bug report, and I send you a reply, and then you just send
28937 back ``No, it's not! Moron!'', I will have no idea what you are
28938 insulting me about. Always over-explain everything. It's much easier
28939 for all of us---if I don't have all the information I need, I will just
28940 mail you and ask for more info, and everything takes more time.
28942 If the problem you're seeing is very visual, and you can't quite explain
28943 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
28944 it somewhere it can be reached, and include the URL of the picture in
28948 If you would like to contribute a patch to fix bugs or make
28949 improvements, please produce the patch using @samp{diff -u}.
28952 If you want to debug your problem further before reporting, possibly
28953 in order to solve the problem yourself and send a patch, you can use
28954 edebug. Debugging Lisp code is documented in the Elisp manual
28955 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
28956 Lisp Reference Manual}). To get you started with edebug, consider if
28957 you discover some weird behavior when pressing @kbd{c}, the first
28958 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
28959 the documentation buffer that leads you to the function definition,
28960 then press @kbd{M-x edebug-defun RET} with point inside that function,
28961 return to Gnus and press @kbd{c} to invoke the code. You will be
28962 placed in the lisp buffer and can single step using @kbd{SPC} and
28963 evaluate expressions using @kbd{M-:} or inspect variables using
28964 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
28965 @kbd{c} or @kbd{g}.
28970 Sometimes, a problem do not directly generate an elisp error but
28971 manifests itself by causing Gnus to be very slow. In these cases, you
28972 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
28973 slow, and then try to analyze the backtrace (repeating the procedure
28974 helps isolating the real problem areas).
28976 A fancier approach is to use the elisp profiler, ELP@. The profiler is
28977 (or should be) fully documented elsewhere, but to get you started
28978 there are a few steps that need to be followed. First, instrument the
28979 part of Gnus you are interested in for profiling, e.g., @kbd{M-x
28980 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
28981 RET message}. Then perform the operation that is slow and press
28982 @kbd{M-x elp-results}. You will then see which operations that takes
28983 time, and can debug them further. If the entire operation takes much
28984 longer than the time spent in the slowest function in the profiler
28985 output, you probably profiled the wrong part of Gnus. To reset
28986 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
28987 elp-restore-all} is supposed to remove profiling, but given the
28988 complexities and dynamic code generation in Gnus, it might not always
28991 @cindex gnu.emacs.gnus
28992 @cindex ding mailing list
28993 If you just need help, you are better off asking on
28994 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
28995 @email{ding@@gnus.org, the ding mailing list}. Write to
28996 @email{ding-request@@gnus.org} to subscribe.
29000 @node Gnus Reference Guide
29001 @section Gnus Reference Guide
29003 It is my hope that other people will figure out smart stuff that Gnus
29004 can do, and that other people will write those smart things as well. To
29005 facilitate that I thought it would be a good idea to describe the inner
29006 workings of Gnus. And some of the not-so-inner workings, while I'm at
29009 You can never expect the internals of a program not to change, but I
29010 will be defining (in some details) the interface between Gnus and its
29011 back ends (this is written in stone), the format of the score files
29012 (ditto), data structures (some are less likely to change than others)
29013 and general methods of operation.
29016 * Gnus Utility Functions:: Common functions and variable to use.
29017 * Back End Interface:: How Gnus communicates with the servers.
29018 * Score File Syntax:: A BNF definition of the score file standard.
29019 * Headers:: How Gnus stores headers internally.
29020 * Ranges:: A handy format for storing mucho numbers.
29021 * Group Info:: The group info format.
29022 * Extended Interactive:: Symbolic prefixes and stuff.
29023 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
29024 * Various File Formats:: Formats of files that Gnus use.
29028 @node Gnus Utility Functions
29029 @subsection Gnus Utility Functions
29030 @cindex Gnus utility functions
29031 @cindex utility functions
29033 @cindex internal variables
29035 When writing small functions to be run from hooks (and stuff), it's
29036 vital to have access to the Gnus internal functions and variables.
29037 Below is a list of the most common ones.
29041 @item gnus-newsgroup-name
29042 @vindex gnus-newsgroup-name
29043 This variable holds the name of the current newsgroup.
29045 @item gnus-find-method-for-group
29046 @findex gnus-find-method-for-group
29047 A function that returns the select method for @var{group}.
29049 @item gnus-group-real-name
29050 @findex gnus-group-real-name
29051 Takes a full (prefixed) Gnus group name, and returns the unprefixed
29054 @item gnus-group-prefixed-name
29055 @findex gnus-group-prefixed-name
29056 Takes an unprefixed group name and a select method, and returns the full
29057 (prefixed) Gnus group name.
29059 @item gnus-get-info
29060 @findex gnus-get-info
29061 Returns the group info list for @var{group} (@pxref{Group Info}).
29063 @item gnus-group-unread
29064 @findex gnus-group-unread
29065 The number of unread articles in @var{group}, or @code{t} if that is
29069 @findex gnus-active
29070 The active entry (i.e., a cons cell containing the lowest and highest
29071 article numbers) for @var{group}.
29073 @item gnus-set-active
29074 @findex gnus-set-active
29075 Set the active entry for @var{group}.
29077 @item gnus-add-current-to-buffer-list
29078 @findex gnus-add-current-to-buffer-list
29079 Adds the current buffer to the list of buffers to be killed on Gnus
29082 @item gnus-continuum-version
29083 @findex gnus-continuum-version
29084 Takes a Gnus version string as a parameter and returns a floating point
29085 number. Earlier versions will always get a lower number than later
29088 @item gnus-group-read-only-p
29089 @findex gnus-group-read-only-p
29090 Says whether @var{group} is read-only or not.
29092 @item gnus-news-group-p
29093 @findex gnus-news-group-p
29094 Says whether @var{group} came from a news back end.
29096 @item gnus-ephemeral-group-p
29097 @findex gnus-ephemeral-group-p
29098 Says whether @var{group} is ephemeral or not.
29100 @item gnus-server-to-method
29101 @findex gnus-server-to-method
29102 Returns the select method corresponding to @var{server}.
29104 @item gnus-server-equal
29105 @findex gnus-server-equal
29106 Says whether two virtual servers are essentially equal. For instance,
29107 two virtual servers may have server parameters in different order, but
29108 this function will consider them equal.
29110 @item gnus-group-native-p
29111 @findex gnus-group-native-p
29112 Says whether @var{group} is native or not.
29114 @item gnus-group-secondary-p
29115 @findex gnus-group-secondary-p
29116 Says whether @var{group} is secondary or not.
29118 @item gnus-group-foreign-p
29119 @findex gnus-group-foreign-p
29120 Says whether @var{group} is foreign or not.
29122 @item gnus-group-find-parameter
29123 @findex gnus-group-find-parameter
29124 Returns the parameter list of @var{group} (@pxref{Group Parameters}).
29125 If given a second parameter, returns the value of that parameter for
29128 @item gnus-group-set-parameter
29129 @findex gnus-group-set-parameter
29130 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
29132 @item gnus-narrow-to-body
29133 @findex gnus-narrow-to-body
29134 Narrows the current buffer to the body of the article.
29136 @item gnus-check-backend-function
29137 @findex gnus-check-backend-function
29138 Takes two parameters, @var{function} and @var{group}. If the back end
29139 @var{group} comes from supports @var{function}, return non-@code{nil}.
29142 (gnus-check-backend-function "request-scan" "nnml:misc")
29146 @item gnus-read-method
29147 @findex gnus-read-method
29148 Prompts the user for a select method.
29153 @node Back End Interface
29154 @subsection Back End Interface
29156 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
29157 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
29158 server is a @dfn{back end} and some @dfn{back end variables}. As examples
29159 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
29160 examples of the latter we have @code{nntp-port-number} and
29161 @code{nnmbox-directory}.
29163 When Gnus asks for information from a back end---say @code{nntp}---on
29164 something, it will normally include a virtual server name in the
29165 function parameters. (If not, the back end should use the ``current''
29166 virtual server.) For instance, @code{nntp-request-list} takes a virtual
29167 server as its only (optional) parameter. If this virtual server hasn't
29168 been opened, the function should fail.
29170 Note that a virtual server name has no relation to some physical server
29171 name. Take this example:
29175 (nntp-address "ifi.uio.no")
29176 (nntp-port-number 4324))
29179 Here the virtual server name is @samp{odd-one} while the name of
29180 the physical server is @samp{ifi.uio.no}.
29182 The back ends should be able to switch between several virtual servers.
29183 The standard back ends implement this by keeping an alist of virtual
29184 server environments that they pull down/push up when needed.
29186 There are two groups of interface functions: @dfn{required functions},
29187 which must be present, and @dfn{optional functions}, which Gnus will
29188 always check for presence before attempting to call 'em.
29190 All these functions are expected to return data in the buffer
29191 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
29192 unfortunately named, but we'll have to live with it. When I talk about
29193 @dfn{resulting data}, I always refer to the data in that buffer. When I
29194 talk about @dfn{return value}, I talk about the function value returned by
29195 the function call. Functions that fail should return @code{nil} as the
29198 Some back ends could be said to be @dfn{server-forming} back ends, and
29199 some might be said not to be. The latter are back ends that generally
29200 only operate on one group at a time, and have no concept of ``server'';
29201 they have a group, and they deliver info on that group and nothing
29204 Gnus identifies each message by way of group name and article number. A
29205 few remarks about these article numbers might be useful. First of all,
29206 the numbers are positive integers. Secondly, it is normally not
29207 possible for later articles to ``re-use'' older article numbers without
29208 confusing Gnus. That is, if a group has ever contained a message
29209 numbered 42, then no other message may get that number, or Gnus will get
29210 mightily confused.@footnote{See the function
29211 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
29212 Third, article numbers must be assigned in order of arrival in the
29213 group; this is not necessarily the same as the date of the message.
29215 The previous paragraph already mentions all the ``hard'' restrictions that
29216 article numbers must fulfill. But it seems that it might be useful to
29217 assign @emph{consecutive} article numbers, for Gnus gets quite confused
29218 if there are holes in the article numbering sequence. However, due to
29219 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
29220 also useful for the article numbers to start at 1 to avoid running out
29221 of numbers as long as possible.
29223 Note that by convention, back ends are named @code{nnsomething}, but
29224 Gnus also comes with some @code{nnnotbackends}, such as
29225 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
29227 In the examples and definitions I will refer to the imaginary back end
29230 @cindex @code{nnchoke}
29233 * Required Back End Functions:: Functions that must be implemented.
29234 * Optional Back End Functions:: Functions that need not be implemented.
29235 * Error Messaging:: How to get messages and report errors.
29236 * Writing New Back Ends:: Extending old back ends.
29237 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
29238 * Mail-like Back Ends:: Some tips on mail back ends.
29242 @node Required Back End Functions
29243 @subsubsection Required Back End Functions
29247 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
29249 @var{articles} is either a range of article numbers or a list of
29250 @code{Message-ID}s. Current back ends do not fully support either---only
29251 sequences (lists) of article numbers, and most back ends do not support
29252 retrieval of @code{Message-ID}s. But they should try for both.
29254 The result data should either be HEADs or @acronym{NOV} lines, and the result
29255 value should either be @code{headers} or @code{nov} to reflect this.
29256 This might later be expanded to @code{various}, which will be a mixture
29257 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
29259 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
29260 headers'', in some meaning of the word. This is generally done by
29261 fetching (at most) @var{fetch-old} extra headers less than the smallest
29262 article number in @code{articles}, and filling the gaps as well. The
29263 presence of this parameter can be ignored if the back end finds it
29264 cumbersome to follow the request. If this is non-@code{nil} and not a
29265 number, do maximum fetches.
29267 Here's an example HEAD:
29270 221 1056 Article retrieved.
29271 Path: ifi.uio.no!sturles
29272 From: sturles@@ifi.uio.no (Sturle Sunde)
29273 Newsgroups: ifi.discussion
29274 Subject: Re: Something very droll
29275 Date: 27 Oct 1994 14:02:57 +0100
29276 Organization: Dept. of Informatics, University of Oslo, Norway
29278 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
29279 References: <38jdmq$4qu@@visbur.ifi.uio.no>
29280 NNTP-Posting-Host: holmenkollen.ifi.uio.no
29284 So a @code{headers} return value would imply that there's a number of
29285 these in the data buffer.
29287 Here's a BNF definition of such a buffer:
29291 head = error / valid-head
29292 error-message = [ "4" / "5" ] 2number " " <error message> eol
29293 valid-head = valid-message *header "." eol
29294 valid-message = "221 " <number> " Article retrieved." eol
29295 header = <text> eol
29299 (The version of BNF used here is the one used in RFC822.)
29301 If the return value is @code{nov}, the data buffer should contain
29302 @dfn{network overview database} lines. These are basically fields
29306 nov-buffer = *nov-line
29307 nov-line = field 7*8[ <TAB> field ] eol
29308 field = <text except TAB>
29311 For a closer look at what should be in those fields,
29315 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
29317 @var{server} is here the virtual server name. @var{definitions} is a
29318 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
29320 If the server can't be opened, no error should be signaled. The back end
29321 may then choose to refuse further attempts at connecting to this
29322 server. In fact, it should do so.
29324 If the server is opened already, this function should return a
29325 non-@code{nil} value. There should be no data returned.
29328 @item (nnchoke-close-server &optional SERVER)
29330 Close connection to @var{server} and free all resources connected
29331 to it. Return @code{nil} if the server couldn't be closed for some
29334 There should be no data returned.
29337 @item (nnchoke-request-close)
29339 Close connection to all servers and free all resources that the back end
29340 have reserved. All buffers that have been created by that back end
29341 should be killed. (Not the @code{nntp-server-buffer}, though.) This
29342 function is generally only called when Gnus is shutting down.
29344 There should be no data returned.
29347 @item (nnchoke-server-opened &optional SERVER)
29349 If @var{server} is the current virtual server, and the connection to the
29350 physical server is alive, then this function should return a
29351 non-@code{nil} value. This function should under no circumstances
29352 attempt to reconnect to a server we have lost connection to.
29354 There should be no data returned.
29357 @item (nnchoke-status-message &optional SERVER)
29359 This function should return the last error message from @var{server}.
29361 There should be no data returned.
29364 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
29366 The result data from this function should be the article specified by
29367 @var{article}. This might either be a @code{Message-ID} or a number.
29368 It is optional whether to implement retrieval by @code{Message-ID}, but
29369 it would be nice if that were possible.
29371 If @var{to-buffer} is non-@code{nil}, the result data should be returned
29372 in this buffer instead of the normal data buffer. This is to make it
29373 possible to avoid copying large amounts of data from one buffer to
29374 another, while Gnus mainly requests articles to be inserted directly
29375 into its article buffer.
29377 If it is at all possible, this function should return a cons cell where
29378 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
29379 the article number. This will enable Gnus to find out what the real
29380 group and article numbers are when fetching articles by
29381 @code{Message-ID}. If this isn't possible, @code{t} should be returned
29382 on successful article retrieval.
29385 @item (nnchoke-request-group GROUP &optional SERVER FAST INFO)
29387 Get data on @var{group}. This function also has the side effect of
29388 making @var{group} the current group.
29390 If @var{fast}, don't bother to return useful data, just make @var{group}
29393 If @var{info}, it allows the backend to update the group info
29396 Here's an example of some result data and a definition of the same:
29399 211 56 1000 1059 ifi.discussion
29402 The first number is the status, which should be 211. Next is the
29403 total number of articles in the group, the lowest article number, the
29404 highest article number, and finally the group name. Note that the total
29405 number of articles may be less than one might think while just
29406 considering the highest and lowest article numbers, but some articles
29407 may have been canceled. Gnus just discards the total-number, so
29408 whether one should take the bother to generate it properly (if that is a
29409 problem) is left as an exercise to the reader. If the group contains no
29410 articles, the lowest article number should be reported as 1 and the
29414 group-status = [ error / info ] eol
29415 error = [ "4" / "5" ] 2<number> " " <Error message>
29416 info = "211 " 3* [ <number> " " ] <string>
29420 @item (nnchoke-close-group GROUP &optional SERVER)
29422 Close @var{group} and free any resources connected to it. This will be
29423 a no-op on most back ends.
29425 There should be no data returned.
29428 @item (nnchoke-request-list &optional SERVER)
29430 Return a list of all groups available on @var{server}. And that means
29433 Here's an example from a server that only carries two groups:
29436 ifi.test 0000002200 0000002000 y
29437 ifi.discussion 3324 3300 n
29440 On each line we have a group name, then the highest article number in
29441 that group, the lowest article number, and finally a flag. If the group
29442 contains no articles, the lowest article number should be reported as 1
29443 and the highest as 0.
29446 active-file = *active-line
29447 active-line = name " " <number> " " <number> " " flags eol
29449 flags = "n" / "y" / "m" / "x" / "j" / "=" name
29452 The flag says whether the group is read-only (@samp{n}), is moderated
29453 (@samp{m}), is dead (@samp{x}), is aliased to some other group
29454 (@samp{=other-group}) or none of the above (@samp{y}).
29457 @item (nnchoke-request-post &optional SERVER)
29459 This function should post the current buffer. It might return whether
29460 the posting was successful or not, but that's not required. If, for
29461 instance, the posting is done asynchronously, it has generally not been
29462 completed by the time this function concludes. In that case, this
29463 function should set up some kind of sentinel to beep the user loud and
29464 clear if the posting could not be completed.
29466 There should be no result data from this function.
29471 @node Optional Back End Functions
29472 @subsubsection Optional Back End Functions
29476 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
29478 @var{groups} is a list of groups, and this function should request data
29479 on all those groups. How it does it is of no concern to Gnus, but it
29480 should attempt to do this in a speedy fashion.
29482 The return value of this function can be either @code{active} or
29483 @code{group}, which says what the format of the result data is. The
29484 former is in the same format as the data from
29485 @code{nnchoke-request-list}, while the latter is a buffer full of lines
29486 in the same format as @code{nnchoke-request-group} gives.
29489 group-buffer = *active-line / *group-status
29493 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
29495 A Gnus group info (@pxref{Group Info}) is handed to the back end for
29496 alterations. This comes in handy if the back end really carries all
29497 the information (as is the case with virtual and imap groups). This
29498 function should destructively alter the info to suit its needs, and
29499 should return a non-@code{nil} value (exceptionally,
29500 @code{nntp-request-update-info} always returns @code{nil} not to waste
29501 the network resources).
29503 There should be no result data from this function.
29506 @item (nnchoke-request-type GROUP &optional ARTICLE)
29508 When the user issues commands for ``sending news'' (@kbd{F} in the
29509 summary buffer, for instance), Gnus has to know whether the article the
29510 user is following up on is news or mail. This function should return
29511 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
29512 is mail and @code{unknown} if the type can't be decided. (The
29513 @var{article} parameter is necessary in @code{nnvirtual} groups which
29514 might very well combine mail groups and news groups.) Both @var{group}
29515 and @var{article} may be @code{nil}.
29517 There should be no result data from this function.
29520 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
29522 Set/remove/add marks on articles. Normally Gnus handles the article
29523 marks (such as read, ticked, expired etc.)@: internally, and store them in
29524 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
29525 all information about the articles on the server, so Gnus need to
29526 propagate the mark information to the server.
29528 @var{action} is a list of mark setting requests, having this format:
29531 (RANGE ACTION MARK)
29534 @var{range} is a range of articles you wish to update marks on.
29535 @var{action} is @code{add} or @code{del}, used to add marks or remove
29536 marks (preserving all marks not mentioned). @var{mark} is a list of
29537 marks; where each mark is a symbol. Currently used marks are
29538 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
29539 @code{dormant}, @code{save}, @code{download}, @code{unsend}, and
29540 @code{forward}, but your back end should, if possible, not limit
29543 Given contradictory actions, the last action in the list should be the
29544 effective one. That is, if your action contains a request to add the
29545 @code{tick} mark on article 1 and, later in the list, a request to
29546 remove the mark on the same article, the mark should in fact be removed.
29548 An example action list:
29551 (((5 12 30) 'del '(tick))
29552 ((10 . 90) 'add '(read expire))
29553 ((92 94) 'del '(read)))
29556 The function should return a range of articles it wasn't able to set the
29557 mark on (currently not used for anything).
29559 There should be no result data from this function.
29561 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
29563 If the user tries to set a mark that the back end doesn't like, this
29564 function may change the mark. Gnus will use whatever this function
29565 returns as the mark for @var{article} instead of the original
29566 @var{mark}. If the back end doesn't care, it must return the original
29567 @var{mark}, and not @code{nil} or any other type of garbage.
29569 The only use for this I can see is what @code{nnvirtual} does with
29570 it---if a component group is auto-expirable, marking an article as read
29571 in the virtual group should result in the article being marked as
29574 There should be no result data from this function.
29577 @item (nnchoke-request-scan &optional GROUP SERVER)
29579 This function may be called at any time (by Gnus or anything else) to
29580 request that the back end check for incoming articles, in one way or
29581 another. A mail back end will typically read the spool file or query
29582 the @acronym{POP} server when this function is invoked. The
29583 @var{group} doesn't have to be heeded---if the back end decides that
29584 it is too much work just scanning for a single group, it may do a
29585 total scan of all groups. It would be nice, however, to keep things
29586 local if that's practical.
29588 There should be no result data from this function.
29591 @item (nnchoke-request-group-description GROUP &optional SERVER)
29593 The result data from this function should be a description of
29597 description-line = name <TAB> description eol
29599 description = <text>
29602 @item (nnchoke-request-list-newsgroups &optional SERVER)
29604 The result data from this function should be the description of all
29605 groups available on the server.
29608 description-buffer = *description-line
29612 @item (nnchoke-request-newgroups DATE &optional SERVER)
29614 The result data from this function should be all groups that were
29615 created after @samp{date}, which is in normal human-readable date format
29616 (i.e., the date format used in mail and news headers, and returned by
29617 the function @code{message-make-date} by default). The data should be
29618 in the active buffer format.
29620 It is okay for this function to return ``too many'' groups; some back ends
29621 might find it cheaper to return the full list of groups, rather than
29622 just the new groups. But don't do this for back ends with many groups.
29623 Normally, if the user creates the groups herself, there won't be too
29624 many groups, so @code{nnml} and the like are probably safe. But for
29625 back ends like @code{nntp}, where the groups have been created by the
29626 server, it is quite likely that there can be many groups.
29629 @item (nnchoke-request-create-group GROUP &optional SERVER)
29631 This function should create an empty group with name @var{group}.
29633 There should be no return data.
29636 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
29638 This function should run the expiry process on all articles in the
29639 @var{articles} range (which is currently a simple list of article
29640 numbers.) It is left up to the back end to decide how old articles
29641 should be before they are removed by this function. If @var{force} is
29642 non-@code{nil}, all @var{articles} should be deleted, no matter how new
29645 This function should return a list of articles that it did not/was not
29648 There should be no result data returned.
29651 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
29653 This function should move @var{article} (which is a number) from
29654 @var{group} by calling @var{accept-form}.
29656 This function should ready the article in question for moving by
29657 removing any header lines it has added to the article, and generally
29658 should ``tidy up'' the article. Then it should @code{eval}
29659 @var{accept-form} in the buffer where the ``tidy'' article is. This
29660 will do the actual copying. If this @code{eval} returns a
29661 non-@code{nil} value, the article should be removed.
29663 If @var{last} is @code{nil}, that means that there is a high likelihood
29664 that there will be more requests issued shortly, so that allows some
29667 The function should return a cons where the @code{car} is the group name and
29668 the @code{cdr} is the article number that the article was entered as.
29670 There should be no data returned.
29673 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
29675 This function takes the current buffer and inserts it into @var{group}.
29676 If @var{last} in @code{nil}, that means that there will be more calls to
29677 this function in short order.
29679 The function should return a cons where the @code{car} is the group name and
29680 the @code{cdr} is the article number that the article was entered as.
29682 The group should exist before the back end is asked to accept the
29683 article for that group.
29685 There should be no data returned.
29688 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
29690 This function should remove @var{article} (which is a number) from
29691 @var{group} and insert @var{buffer} there instead.
29693 There should be no data returned.
29696 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
29698 This function should delete @var{group}. If @var{force}, it should
29699 really delete all the articles in the group, and then delete the group
29700 itself. (If there is such a thing as ``the group itself''.)
29702 There should be no data returned.
29705 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
29707 This function should rename @var{group} into @var{new-name}. All
29708 articles in @var{group} should move to @var{new-name}.
29710 There should be no data returned.
29715 @node Error Messaging
29716 @subsubsection Error Messaging
29718 @findex nnheader-report
29719 @findex nnheader-get-report
29720 The back ends should use the function @code{nnheader-report} to report
29721 error conditions---they should not raise errors when they aren't able to
29722 perform a request. The first argument to this function is the back end
29723 symbol, and the rest are interpreted as arguments to @code{format} if
29724 there are multiple of them, or just a string if there is one of them.
29725 This function must always returns @code{nil}.
29728 (nnheader-report 'nnchoke "You did something totally bogus")
29730 (nnheader-report 'nnchoke "Could not request group %s" group)
29733 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
29734 @code{nil} back from a server, and this function returns the most
29735 recently reported message for the back end in question. This function
29736 takes one argument---the server symbol.
29738 Internally, these functions access @var{back-end}@code{-status-string},
29739 so the @code{nnchoke} back end will have its error message stored in
29740 @code{nnchoke-status-string}.
29743 @node Writing New Back Ends
29744 @subsubsection Writing New Back Ends
29746 Many back ends are quite similar. @code{nnml} is just like
29747 @code{nnspool}, but it allows you to edit the articles on the server.
29748 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
29749 and it doesn't maintain overview databases. @code{nndir} is just like
29750 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
29753 It would make sense if it were possible to ``inherit'' functions from
29754 back ends when writing new back ends. And, indeed, you can do that if you
29755 want to. (You don't have to if you don't want to, of course.)
29757 All the back ends declare their public variables and functions by using a
29758 package called @code{nnoo}.
29760 To inherit functions from other back ends (and allow other back ends to
29761 inherit functions from the current back end), you should use the
29767 This macro declares the first parameter to be a child of the subsequent
29768 parameters. For instance:
29771 (nnoo-declare nndir
29775 @code{nndir} has declared here that it intends to inherit functions from
29776 both @code{nnml} and @code{nnmh}.
29779 This macro is equivalent to @code{defvar}, but registers the variable as
29780 a public server variable. Most state-oriented variables should be
29781 declared with @code{defvoo} instead of @code{defvar}.
29783 In addition to the normal @code{defvar} parameters, it takes a list of
29784 variables in the parent back ends to map the variable to when executing
29785 a function in those back ends.
29788 (defvoo nndir-directory nil
29789 "Where nndir will look for groups."
29790 nnml-current-directory nnmh-current-directory)
29793 This means that @code{nnml-current-directory} will be set to
29794 @code{nndir-directory} when an @code{nnml} function is called on behalf
29795 of @code{nndir}. (The same with @code{nnmh}.)
29797 @item nnoo-define-basics
29798 This macro defines some common functions that almost all back ends should
29802 (nnoo-define-basics nndir)
29806 This macro is just like @code{defun} and takes the same parameters. In
29807 addition to doing the normal @code{defun} things, it registers the
29808 function as being public so that other back ends can inherit it.
29810 @item nnoo-map-functions
29811 This macro allows mapping of functions from the current back end to
29812 functions from the parent back ends.
29815 (nnoo-map-functions nndir
29816 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29817 (nnmh-request-article 0 nndir-current-group 0 0))
29820 This means that when @code{nndir-retrieve-headers} is called, the first,
29821 third, and fourth parameters will be passed on to
29822 @code{nnml-retrieve-headers}, while the second parameter is set to the
29823 value of @code{nndir-current-group}.
29826 This macro allows importing functions from back ends. It should be the
29827 last thing in the source file, since it will only define functions that
29828 haven't already been defined.
29834 nnmh-request-newgroups)
29838 This means that calls to @code{nndir-request-list} should just be passed
29839 on to @code{nnmh-request-list}, while all public functions from
29840 @code{nnml} that haven't been defined in @code{nndir} yet should be
29845 Below is a slightly shortened version of the @code{nndir} back end.
29848 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
29849 ;; @r{Copyright (C) 1995,1996 Free Software Foundation, Inc.}
29853 (require 'nnheader)
29857 (eval-when-compile (require 'cl))
29859 (nnoo-declare nndir
29862 (defvoo nndir-directory nil
29863 "Where nndir will look for groups."
29864 nnml-current-directory nnmh-current-directory)
29866 (defvoo nndir-nov-is-evil nil
29867 "*Non-nil means that nndir will never retrieve NOV headers."
29870 (defvoo nndir-current-group ""
29872 nnml-current-group nnmh-current-group)
29873 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
29874 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
29876 (defvoo nndir-status-string "" nil nnmh-status-string)
29877 (defconst nndir-version "nndir 1.0")
29879 ;;; @r{Interface functions.}
29881 (nnoo-define-basics nndir)
29883 (deffoo nndir-open-server (server &optional defs)
29884 (setq nndir-directory
29885 (or (cadr (assq 'nndir-directory defs))
29887 (unless (assq 'nndir-directory defs)
29888 (push `(nndir-directory ,server) defs))
29889 (push `(nndir-current-group
29890 ,(file-name-nondirectory
29891 (directory-file-name nndir-directory)))
29893 (push `(nndir-top-directory
29894 ,(file-name-directory (directory-file-name nndir-directory)))
29896 (nnoo-change-server 'nndir server defs))
29898 (nnoo-map-functions nndir
29899 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29900 (nnmh-request-article 0 nndir-current-group 0 0)
29901 (nnmh-request-group nndir-current-group 0 0)
29902 (nnmh-close-group nndir-current-group 0))
29906 nnmh-status-message
29908 nnmh-request-newgroups))
29914 @node Hooking New Back Ends Into Gnus
29915 @subsubsection Hooking New Back Ends Into Gnus
29917 @vindex gnus-valid-select-methods
29918 @findex gnus-declare-backend
29919 Having Gnus start using your new back end is rather easy---you just
29920 declare it with the @code{gnus-declare-backend} functions. This will
29921 enter the back end into the @code{gnus-valid-select-methods} variable.
29923 @code{gnus-declare-backend} takes two parameters---the back end name and
29924 an arbitrary number of @dfn{abilities}.
29929 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
29932 The above line would then go in the @file{nnchoke.el} file.
29934 The abilities can be:
29938 This is a mailish back end---followups should (probably) go via mail.
29940 This is a newsish back end---followups should (probably) go via news.
29942 This back end supports both mail and news.
29944 This is neither a post nor mail back end---it's something completely
29947 It supports respooling---or rather, it is able to modify its source
29948 articles and groups.
29950 The name of the server should be in the virtual server name. This is
29951 true for almost all back ends.
29952 @item prompt-address
29953 The user should be prompted for an address when doing commands like
29954 @kbd{B} in the group buffer. This is true for back ends like
29955 @code{nntp}, but not @code{nnmbox}, for instance.
29959 @node Mail-like Back Ends
29960 @subsubsection Mail-like Back Ends
29962 One of the things that separate the mail back ends from the rest of the
29963 back ends is the heavy dependence by most of the mail back ends on
29964 common functions in @file{nnmail.el}. For instance, here's the
29965 definition of @code{nnml-request-scan}:
29968 (deffoo nnml-request-scan (&optional group server)
29969 (setq nnml-article-file-alist nil)
29970 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
29973 It simply calls @code{nnmail-get-new-mail} with a few parameters,
29974 and @code{nnmail} takes care of all the moving and splitting of the
29977 This function takes four parameters.
29981 This should be a symbol to designate which back end is responsible for
29984 @item exit-function
29985 This function should be called after the splitting has been performed.
29987 @item temp-directory
29988 Where the temporary files should be stored.
29991 This optional argument should be a group name if the splitting is to be
29992 performed for one group only.
29995 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
29996 save each article. @var{back-end}@code{-active-number} will be called to
29997 find the article number assigned to this article.
29999 The function also uses the following variables:
30000 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
30001 this back end); and @var{back-end}@code{-group-alist} and
30002 @var{back-end}@code{-active-file} to generate the new active file.
30003 @var{back-end}@code{-group-alist} should be a group-active alist, like
30007 (("a-group" (1 . 10))
30008 ("some-group" (34 . 39)))
30012 @node Score File Syntax
30013 @subsection Score File Syntax
30015 Score files are meant to be easily parsable, but yet extremely
30016 malleable. It was decided that something that had the same read syntax
30017 as an Emacs Lisp list would fit that spec.
30019 Here's a typical score file:
30023 ("Windows 95" -10000 nil s)
30030 BNF definition of a score file:
30033 score-file = "" / "(" *element ")"
30034 element = rule / atom
30035 rule = string-rule / number-rule / date-rule
30036 string-rule = "(" quote string-header quote space *string-match ")"
30037 number-rule = "(" quote number-header quote space *number-match ")"
30038 date-rule = "(" quote date-header quote space *date-match ")"
30040 string-header = "subject" / "from" / "references" / "message-id" /
30041 "xref" / "body" / "head" / "all" / "followup"
30042 number-header = "lines" / "chars"
30043 date-header = "date"
30044 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
30045 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
30046 score = "nil" / <integer>
30047 date = "nil" / <natural number>
30048 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
30049 "r" / "regex" / "R" / "Regex" /
30050 "e" / "exact" / "E" / "Exact" /
30051 "f" / "fuzzy" / "F" / "Fuzzy"
30052 number-match = "(" <integer> [ "" / [ space score [ "" /
30053 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
30054 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
30055 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
30056 space date [ "" / [ space date-match-t ] ] ] ] ")"
30057 date-match-t = "nil" / "at" / "before" / "after"
30058 atom = "(" [ required-atom / optional-atom ] ")"
30059 required-atom = mark / expunge / mark-and-expunge / files /
30060 exclude-files / read-only / touched
30061 optional-atom = adapt / local / eval
30062 mark = "mark" space nil-or-number
30063 nil-or-number = "nil" / <integer>
30064 expunge = "expunge" space nil-or-number
30065 mark-and-expunge = "mark-and-expunge" space nil-or-number
30066 files = "files" *[ space <string> ]
30067 exclude-files = "exclude-files" *[ space <string> ]
30068 read-only = "read-only" [ space "nil" / space "t" ]
30069 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
30070 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
30071 local = "local" *[ space "(" <string> space <form> ")" ]
30072 eval = "eval" space <form>
30073 space = *[ " " / <TAB> / <NEWLINE> ]
30076 Any unrecognized elements in a score file should be ignored, but not
30079 As you can see, white space is needed, but the type and amount of white
30080 space is irrelevant. This means that formatting of the score file is
30081 left up to the programmer---if it's simpler to just spew it all out on
30082 one looong line, then that's ok.
30084 The meaning of the various atoms are explained elsewhere in this
30085 manual (@pxref{Score File Format}).
30089 @subsection Headers
30091 Internally Gnus uses a format for storing article headers that
30092 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
30093 almost suspect that the author looked at the @acronym{NOV} specification and
30094 just shamelessly @emph{stole} the entire thing, and one would be right.
30096 @dfn{Header} is a severely overloaded term. ``Header'' is used in
30097 RFC 1036 to talk about lines in the head of an article (e.g.,
30098 @code{From}). It is used by many people as a synonym for
30099 ``head''---``the header and the body''. (That should be avoided, in my
30100 opinion.) And Gnus uses a format internally that it calls ``header'',
30101 which is what I'm talking about here. This is a 9-element vector,
30102 basically, with each header (ouch) having one slot.
30104 These slots are, in order: @code{number}, @code{subject}, @code{from},
30105 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
30106 @code{xref}, and @code{extra}. There are macros for accessing and
30107 setting these slots---they all have predictable names beginning with
30108 @code{mail-header-} and @code{mail-header-set-}, respectively.
30110 All these slots contain strings, except the @code{extra} slot, which
30111 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
30117 @sc{gnus} introduced a concept that I found so useful that I've started
30118 using it a lot and have elaborated on it greatly.
30120 The question is simple: If you have a large amount of objects that are
30121 identified by numbers (say, articles, to take a @emph{wild} example)
30122 that you want to qualify as being ``included'', a normal sequence isn't
30123 very useful. (A 200,000 length sequence is a bit long-winded.)
30125 The solution is as simple as the question: You just collapse the
30129 (1 2 3 4 5 6 10 11 12)
30132 is transformed into
30135 ((1 . 6) (10 . 12))
30138 To avoid having those nasty @samp{(13 . 13)} elements to denote a
30139 lonesome object, a @samp{13} is a valid element:
30142 ((1 . 6) 7 (10 . 12))
30145 This means that comparing two ranges to find out whether they are equal
30146 is slightly tricky:
30149 ((1 . 5) 7 8 (10 . 12))
30155 ((1 . 5) (7 . 8) (10 . 12))
30158 are equal. In fact, any non-descending list is a range:
30164 is a perfectly valid range, although a pretty long-winded one. This is
30171 and is equal to the previous range.
30173 Here's a BNF definition of ranges. Of course, one must remember the
30174 semantic requirement that the numbers are non-descending. (Any number
30175 of repetition of the same number is allowed, but apt to disappear in
30179 range = simple-range / normal-range
30180 simple-range = "(" number " . " number ")"
30181 normal-range = "(" start-contents ")"
30182 contents = "" / simple-range *[ " " contents ] /
30183 number *[ " " contents ]
30186 Gnus currently uses ranges to keep track of read articles and article
30187 marks. I plan on implementing a number of range operators in C if The
30188 Powers That Be are willing to let me. (I haven't asked yet, because I
30189 need to do some more thinking on what operators I need to make life
30190 totally range-based without ever having to convert back to normal
30195 @subsection Group Info
30197 Gnus stores all permanent info on groups in a @dfn{group info} list.
30198 This list is from three to six elements (or more) long and exhaustively
30199 describes the group.
30201 Here are two example group infos; one is a very simple group while the
30202 second is a more complex one:
30205 ("no.group" 5 ((1 . 54324)))
30207 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
30208 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
30210 ((auto-expire . t) (to-address . "ding@@gnus.org")))
30213 The first element is the @dfn{group name}---as Gnus knows the group,
30214 anyway. The second element is the @dfn{subscription level}, which
30215 normally is a small integer. (It can also be the @dfn{rank}, which is a
30216 cons cell where the @code{car} is the level and the @code{cdr} is the
30217 score.) The third element is a list of ranges of read articles. The
30218 fourth element is a list of lists of article marks of various kinds.
30219 The fifth element is the select method (or virtual server, if you like).
30220 The sixth element is a list of @dfn{group parameters}, which is what
30221 this section is about.
30223 Any of the last three elements may be missing if they are not required.
30224 In fact, the vast majority of groups will normally only have the first
30225 three elements, which saves quite a lot of cons cells.
30227 Here's a BNF definition of the group info format:
30230 info = "(" group space ralevel space read
30231 [ "" / [ space marks-list [ "" / [ space method [ "" /
30232 space parameters ] ] ] ] ] ")"
30233 group = quote <string> quote
30234 ralevel = rank / level
30235 level = <integer in the range of 1 to inf>
30236 rank = "(" level "." score ")"
30237 score = <integer in the range of 1 to inf>
30239 marks-lists = nil / "(" *marks ")"
30240 marks = "(" <string> range ")"
30241 method = "(" <string> *elisp-forms ")"
30242 parameters = "(" *elisp-forms ")"
30245 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
30246 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
30249 If you have a Gnus info and want to access the elements, Gnus offers a
30250 series of macros for getting/setting these elements.
30253 @item gnus-info-group
30254 @itemx gnus-info-set-group
30255 @findex gnus-info-group
30256 @findex gnus-info-set-group
30257 Get/set the group name.
30259 @item gnus-info-rank
30260 @itemx gnus-info-set-rank
30261 @findex gnus-info-rank
30262 @findex gnus-info-set-rank
30263 Get/set the group rank (@pxref{Group Score}).
30265 @item gnus-info-level
30266 @itemx gnus-info-set-level
30267 @findex gnus-info-level
30268 @findex gnus-info-set-level
30269 Get/set the group level.
30271 @item gnus-info-score
30272 @itemx gnus-info-set-score
30273 @findex gnus-info-score
30274 @findex gnus-info-set-score
30275 Get/set the group score (@pxref{Group Score}).
30277 @item gnus-info-read
30278 @itemx gnus-info-set-read
30279 @findex gnus-info-read
30280 @findex gnus-info-set-read
30281 Get/set the ranges of read articles.
30283 @item gnus-info-marks
30284 @itemx gnus-info-set-marks
30285 @findex gnus-info-marks
30286 @findex gnus-info-set-marks
30287 Get/set the lists of ranges of marked articles.
30289 @item gnus-info-method
30290 @itemx gnus-info-set-method
30291 @findex gnus-info-method
30292 @findex gnus-info-set-method
30293 Get/set the group select method.
30295 @item gnus-info-params
30296 @itemx gnus-info-set-params
30297 @findex gnus-info-params
30298 @findex gnus-info-set-params
30299 Get/set the group parameters.
30302 All the getter functions take one parameter---the info list. The setter
30303 functions take two parameters---the info list and the new value.
30305 The last three elements in the group info aren't mandatory, so it may be
30306 necessary to extend the group info before setting the element. If this
30307 is necessary, you can just pass on a non-@code{nil} third parameter to
30308 the three final setter functions to have this happen automatically.
30311 @node Extended Interactive
30312 @subsection Extended Interactive
30313 @cindex interactive
30314 @findex gnus-interactive
30316 Gnus extends the standard Emacs @code{interactive} specification
30317 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
30318 Prefixes}). Here's an example of how this is used:
30321 (defun gnus-summary-increase-score (&optional score symp)
30322 (interactive (gnus-interactive "P\ny"))
30327 The best thing to do would have been to implement
30328 @code{gnus-interactive} as a macro which would have returned an
30329 @code{interactive} form, but this isn't possible since Emacs checks
30330 whether a function is interactive or not by simply doing an @code{assq}
30331 on the lambda form. So, instead we have @code{gnus-interactive}
30332 function that takes a string and returns values that are usable to
30333 @code{interactive}.
30335 This function accepts (almost) all normal @code{interactive} specs, but
30340 @vindex gnus-current-prefix-symbol
30341 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
30345 @vindex gnus-current-prefix-symbols
30346 A list of the current symbolic prefixes---the
30347 @code{gnus-current-prefix-symbol} variable.
30350 The current article number---the @code{gnus-summary-article-number}
30354 The current article header---the @code{gnus-summary-article-header}
30358 The current group name---the @code{gnus-group-group-name}
30364 @node Emacs/XEmacs Code
30365 @subsection Emacs/XEmacs Code
30369 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
30370 platforms must be the primary one. I chose Emacs. Not because I don't
30371 like XEmacs or Mule, but because it comes first alphabetically.
30373 This means that Gnus will byte-compile under Emacs with nary a warning,
30374 while XEmacs will pump out gigabytes of warnings while byte-compiling.
30375 As I use byte-compilation warnings to help me root out trivial errors in
30376 Gnus, that's very useful.
30378 I've also consistently used Emacs function interfaces, but have used
30379 Gnusey aliases for the functions. To take an example: Emacs defines a
30380 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
30381 function. I then define a function called @code{gnus-run-at-time} that
30382 takes the same parameters as the Emacs @code{run-at-time}. When running
30383 Gnus under Emacs, the former function is just an alias for the latter.
30384 However, when running under XEmacs, the former is an alias for the
30385 following function:
30388 (defun gnus-xmas-run-at-time (time repeat function &rest args)
30392 (,function ,@@args))
30396 This sort of thing has been done for bunches of functions. Gnus does
30397 not redefine any native Emacs functions while running under XEmacs---it
30398 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
30401 In the cases where the XEmacs function interface was obviously cleaner,
30402 I used it instead. For example @code{gnus-region-active-p} is an alias
30403 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
30405 Of course, I could have chosen XEmacs as my native platform and done
30406 mapping functions the other way around. But I didn't. The performance
30407 hit these indirections impose on Gnus under XEmacs should be slight.
30410 @node Various File Formats
30411 @subsection Various File Formats
30414 * Active File Format:: Information on articles and groups available.
30415 * Newsgroups File Format:: Group descriptions.
30419 @node Active File Format
30420 @subsubsection Active File Format
30422 The active file lists all groups available on the server in
30423 question. It also lists the highest and lowest current article numbers
30426 Here's an excerpt from a typical active file:
30429 soc.motss 296030 293865 y
30430 alt.binaries.pictures.fractals 3922 3913 n
30431 comp.sources.unix 1605 1593 m
30432 comp.binaries.ibm.pc 5097 5089 y
30433 no.general 1000 900 y
30436 Here's a pseudo-BNF definition of this file:
30439 active = *group-line
30440 group-line = group spc high-number spc low-number spc flag <NEWLINE>
30441 group = <non-white-space string>
30443 high-number = <non-negative integer>
30444 low-number = <positive integer>
30445 flag = "y" / "n" / "m" / "j" / "x" / "=" group
30448 For a full description of this file, see the manual pages for
30449 @samp{innd}, in particular @samp{active(5)}.
30452 @node Newsgroups File Format
30453 @subsubsection Newsgroups File Format
30455 The newsgroups file lists groups along with their descriptions. Not all
30456 groups on the server have to be listed, and not all groups in the file
30457 have to exist on the server. The file is meant purely as information to
30460 The format is quite simple; a group name, a tab, and the description.
30461 Here's the definition:
30465 line = group tab description <NEWLINE>
30466 group = <non-white-space string>
30468 description = <string>
30473 @node Emacs for Heathens
30474 @section Emacs for Heathens
30476 Believe it or not, but some people who use Gnus haven't really used
30477 Emacs much before they embarked on their journey on the Gnus Love Boat.
30478 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
30479 region'', and ``set @code{gnus-flargblossen} to an alist where the key
30480 is a regexp that is used for matching on the group name'' are magical
30481 phrases with little or no meaning, then this appendix is for you. If
30482 you are already familiar with Emacs, just ignore this and go fondle your
30486 * Keystrokes:: Entering text and executing commands.
30487 * Emacs Lisp:: The built-in Emacs programming language.
30492 @subsection Keystrokes
30496 Q: What is an experienced Emacs user?
30499 A: A person who wishes that the terminal had pedals.
30502 Yes, when you use Emacs, you are apt to use the control key, the shift
30503 key and the meta key a lot. This is very annoying to some people
30504 (notably @code{vi}le users), and the rest of us just love the hell out
30505 of it. Just give up and submit. Emacs really does stand for
30506 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
30507 may have heard from other disreputable sources (like the Emacs author).
30509 The shift keys are normally located near your pinky fingers, and are
30510 normally used to get capital letters and stuff. You probably use it all
30511 the time. The control key is normally marked ``CTRL'' or something like
30512 that. The meta key is, funnily enough, never marked as such on any
30513 keyboard. The one I'm currently at has a key that's marked ``Alt'',
30514 which is the meta key on this keyboard. It's usually located somewhere
30515 to the left hand side of the keyboard, usually on the bottom row.
30517 Now, us Emacs people don't say ``press the meta-control-m key'',
30518 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
30519 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
30520 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
30521 down the control key, and hold it down while you press @kbd{k}''.
30522 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
30523 the control key and then press @kbd{k}''. Simple, ay?
30525 This is somewhat complicated by the fact that not all keyboards have a
30526 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
30527 means ``press escape, release escape, press @kbd{k}''. That's much more
30528 work than if you have a meta key, so if that's the case, I respectfully
30529 suggest you get a real keyboard with a meta key. You can't live without
30535 @subsection Emacs Lisp
30537 Emacs is the King of Editors because it's really a Lisp interpreter.
30538 Each and every key you tap runs some Emacs Lisp code snippet, and since
30539 Emacs Lisp is an interpreted language, that means that you can configure
30540 any key to run any arbitrary code. You just, like, do it.
30542 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
30543 functions. (These are byte-compiled for speed, but it's still
30544 interpreted.) If you decide that you don't like the way Gnus does
30545 certain things, it's trivial to have it do something a different way.
30546 (Well, at least if you know how to write Lisp code.) However, that's
30547 beyond the scope of this manual, so we are simply going to talk about
30548 some common constructs that you normally use in your @file{~/.gnus.el}
30549 file to customize Gnus. (You can also use the @file{~/.emacs} file, but
30550 in order to set things of Gnus up, it is much better to use the
30551 @file{~/.gnus.el} file, @xref{Startup Files}.)
30553 If you want to set the variable @code{gnus-florgbnize} to four (4), you
30554 write the following:
30557 (setq gnus-florgbnize 4)
30560 This function (really ``special form'') @code{setq} is the one that can
30561 set a variable to some value. This is really all you need to know. Now
30562 you can go and fill your @file{~/.gnus.el} file with lots of these to
30563 change how Gnus works.
30565 If you have put that thing in your @file{~/.gnus.el} file, it will be
30566 read and @code{eval}ed (which is Lisp-ese for ``run'') the next time you
30567 start Gnus. If you want to change the variable right away, simply say
30568 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
30569 previous ``form'', which is a simple @code{setq} statement here.
30571 Go ahead---just try it, if you're located at your Emacs. After you
30572 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
30573 is the return value of the form you @code{eval}ed.
30577 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
30581 (setq gnus-read-active-file 'some)
30584 On the other hand, if the manual says ``set @code{gnus-nntp-server-file} to
30585 @samp{/etc/nntpserver}'', that means:
30588 (setq gnus-nntp-server-file "/etc/nntpserver")
30591 So be careful not to mix up strings (the latter) with symbols (the
30592 former). The manual is unambiguous, but it can be confusing.
30595 @include gnus-faq.texi
30597 @node GNU Free Documentation License
30598 @chapter GNU Free Documentation License
30599 @include doclicense.texi
30617 @c Local Variables: