4 @settitle T-gnus 6.17 Manual
9 @documentencoding ISO-8859-1
12 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001,
13 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.1 or
18 any later version published by the Free Software Foundation; with no
19 Invariant Sections, with the Front-Cover texts being ``A GNU
20 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
21 license is included in the section entitled ``GNU Free Documentation
22 License'' in the Emacs manual.
24 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
25 this GNU Manual, like GNU software. Copies published by the Free
26 Software Foundation raise funds for GNU development.''
28 This document is part of a collection distributed under the GNU Free
29 Documentation License. If you want to distribute this document
30 separately from the collection, you can do so by adding a copy of the
31 license to the document, as described in section 6 of the license.
37 \documentclass[twoside,a4paper,openright,11pt]{book}
38 \usepackage[latin1]{inputenc}
39 \usepackage{pagestyle}
42 \input{gnusconfig.tex}
44 \ifx\pdfoutput\undefined
46 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
54 \newcommand{\gnusversionname}{T-gnus v6.17}
55 \newcommand{\gnuschaptername}{}
56 \newcommand{\gnussectionname}{}
58 \newcommand{\gnusbackslash}{/}
60 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
61 \ifx\pdfoutput\undefined
62 \newcommand{\gnusuref}[1]{\gnustt{#1}}
64 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
66 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
67 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
69 \newcommand{\gnuskindex}[1]{\index{#1}}
70 \newcommand{\gnusindex}[1]{\index{#1}}
72 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
73 \newcommand{\gnuscode}[1]{\gnustt{#1}}
74 \newcommand{\gnusasis}[1]{\gnustt{#1}}
75 \newcommand{\gnusurl}[1]{\gnustt{#1}}
76 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
77 \newcommand{\gnusenv}[1]{\gnustt{#1}}
78 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
79 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
80 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
81 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
82 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
83 \newcommand{\gnusdfn}[1]{\textit{#1}}
84 \newcommand{\gnusi}[1]{\textit{#1}}
85 \newcommand{\gnusr}[1]{\textrm{#1}}
86 \newcommand{\gnusstrong}[1]{\textbf{#1}}
87 \newcommand{\gnusemph}[1]{\textit{#1}}
88 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
89 \newcommand{\gnussc}[1]{\textsc{#1}}
90 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
91 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
92 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
93 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
94 \newcommand{\gnusacronym}[1]{\textsc{#1}}
95 \newcommand{\gnusemail}[1]{\textit{#1}}
97 \newcommand{\gnusbullet}{{${\bullet}$}}
98 \newcommand{\gnusdollar}{\$}
99 \newcommand{\gnusampersand}{\&}
100 \newcommand{\gnuspercent}{\%}
101 \newcommand{\gnushash}{\#}
102 \newcommand{\gnushat}{\symbol{"5E}}
103 \newcommand{\gnusunderline}{\symbol{"5F}}
104 \newcommand{\gnusnot}{$\neg$}
105 \newcommand{\gnustilde}{\symbol{"7E}}
106 \newcommand{\gnusless}{{$<$}}
107 \newcommand{\gnusgreater}{{$>$}}
108 \newcommand{\gnusbraceleft}{{$>$}}
109 \newcommand{\gnusbraceright}{{$>$}}
111 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
112 \newcommand{\gnusinteresting}{
113 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
116 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
118 \newcommand{\gnuspagechapter}[1]{
122 \newdimen{\gnusdimen}
125 \newcommand{\gnuschapter}[2]{
127 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
129 \renewcommand{\gnussectionname}{}
130 \renewcommand{\gnuschaptername}{#2}
131 \thispagestyle{empty}
133 \begin{picture}(500,500)(0,0)
134 \put(480,350){\makebox(0,0)[tr]{#1}}
135 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
140 \newcommand{\gnusfigure}[3]{
142 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
149 \newcommand{\gnusicon}[1]{
150 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
153 \newcommand{\gnuspicon}[1]{
154 \margindex{\epsfig{figure=#1,width=2cm}}
157 \newcommand{\gnusxface}[2]{
158 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
161 \newcommand{\gnussmiley}[2]{
162 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
165 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
167 \newcommand{\gnussection}[1]{
168 \renewcommand{\gnussectionname}{#1}
172 \newenvironment{codelist}%
177 \newenvironment{asislist}%
182 \newenvironment{kbdlist}%
188 \newenvironment{dfnlist}%
193 \newenvironment{stronglist}%
198 \newenvironment{samplist}%
203 \newenvironment{varlist}%
208 \newenvironment{emphlist}%
213 \newlength\gnusheadtextwidth
214 \setlength{\gnusheadtextwidth}{\headtextwidth}
215 \addtolength{\gnusheadtextwidth}{1cm}
217 \newpagestyle{gnuspreamble}%
222 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
226 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
235 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
237 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
242 \newpagestyle{gnusindex}%
247 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
251 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
259 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
261 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
271 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
275 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
283 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
285 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
290 \pagenumbering{roman}
291 \pagestyle{gnuspreamble}
302 %\addtolength{\oddsidemargin}{-5cm}
303 %\addtolength{\evensidemargin}{-5cm}
305 \addtolength{\textheight}{2cm}
307 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
310 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
313 \gnusauthor{by Lars Magne Ingebrigtsen}
320 \thispagestyle{empty}
334 * Gnus: (gnus). The newsreader Gnus.
339 @setchapternewpage odd
344 @title T-gnus 6.17 Manual
346 @author by Lars Magne Ingebrigtsen
348 @vskip 0pt plus 1filll
354 @top The gnus Newsreader
358 You can read news (and mail) from within Emacs by using T-gnus. The news
359 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
360 spool or your mbox file. All at the same time, if you want to push your
363 T-gnus provides @acronym{MIME} features based on @acronym{SEMI} API. So
364 T-gnus supports your right to read strange messages including big images
365 or other various kinds of formats. T-gnus also supports
366 internationalization/localization and multiscript features based on MULE
367 API. So T-gnus does not discriminate various language communities. Oh,
368 if you are a Klingon, please wait Unicode Next Generation.
370 This manual corresponds to T-gnus 6.17.
381 Gnus is the advanced, self-documenting, customizable, extensible
382 unreal-time newsreader for GNU Emacs.
384 Oops. That sounds oddly familiar, so let's start over again to avoid
385 being accused of plagiarism:
387 Gnus is a message-reading laboratory. It will let you look at just
388 about anything as if it were a newsgroup. You can read mail with it,
389 you can browse directories with it, you can @code{ftp} with it---you
390 can even read news with it!
392 Gnus tries to empower people who read news the same way Emacs empowers
393 people who edit text. Gnus sets no limits to what the user should be
394 allowed to do. Users are encouraged to extend gnus to make it behave
395 like they want it to behave. A program should not control people;
396 people should be empowered to do what they want by using (or abusing)
402 * Starting Up:: Finding news can be a pain.
403 * Group Buffer:: Selecting, subscribing and killing groups.
404 * Summary Buffer:: Reading, saving and posting articles.
405 * Article Buffer:: Displaying and handling articles.
406 * Composing Messages:: Information on sending mail and news.
407 * Select Methods:: Gnus reads all messages from various select methods.
408 * Scoring:: Assigning values to articles.
409 * Various:: General purpose settings.
410 * The End:: Farewell and goodbye.
411 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
412 * Index:: Variable, function and concept index.
413 * Key Index:: Key Index.
415 Other related manuals
417 * Message:(message). Composing messages.
418 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
419 * Sieve:(sieve). Managing Sieve scripts in Emacs.
420 * PGG:(pgg). @acronym{PGP/MIME} with Gnus.
421 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
424 --- The Detailed Node Listing ---
428 * Finding the News:: Choosing a method for getting news.
429 * The First Time:: What does Gnus do the first time you start it?
430 * The Server is Down:: How can I read my mail then?
431 * Slave Gnusae:: You can have more than one Gnus active at a time.
432 * Fetching a Group:: Starting Gnus just to read a group.
433 * New Groups:: What is Gnus supposed to do with new groups?
434 * Changing Servers:: You may want to move from one server to another.
435 * Startup Files:: Those pesky startup files---@file{.newsrc}.
436 * Auto Save:: Recovering from a crash.
437 * The Active File:: Reading the active file over a slow line Takes Time.
438 * Startup Variables:: Other variables you might change.
442 * Checking New Groups:: Determining what groups are new.
443 * Subscription Methods:: What Gnus should do with new groups.
444 * Filtering New Groups:: Making Gnus ignore certain new groups.
448 * Group Buffer Format:: Information listed and how you can change it.
449 * Group Maneuvering:: Commands for moving in the group buffer.
450 * Selecting a Group:: Actually reading news.
451 * Subscription Commands:: Unsubscribing, killing, subscribing.
452 * Group Data:: Changing the info for a group.
453 * Group Levels:: Levels? What are those, then?
454 * Group Score:: A mechanism for finding out what groups you like.
455 * Marking Groups:: You can mark groups for later processing.
456 * Foreign Groups:: Creating and editing groups.
457 * Group Parameters:: Each group may have different parameters set.
458 * Listing Groups:: Gnus can list various subsets of the groups.
459 * Sorting Groups:: Re-arrange the group order.
460 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
461 * Browse Foreign Server:: You can browse a server. See what it has to offer.
462 * Exiting Gnus:: Stop reading news and get some work done.
463 * Group Topics:: A folding group mode divided into topics.
464 * Misc Group Stuff:: Other stuff that you can to do.
468 * Group Line Specification:: Deciding how the group buffer is to look.
469 * Group Mode Line Specification:: The group buffer mode line.
470 * Group Highlighting:: Having nice colors in the group buffer.
474 * Topic Commands:: Interactive E-Z commands.
475 * Topic Variables:: How to customize the topics the Lisp Way.
476 * Topic Sorting:: Sorting each topic individually.
477 * Topic Topology:: A map of the world.
478 * Topic Parameters:: Parameters that apply to all groups in a topic.
482 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
483 * Group Information:: Information and help on groups and Gnus.
484 * Group Timestamp:: Making Gnus keep track of when you last read a group.
485 * File Commands:: Reading and writing the Gnus files.
486 * Sieve Commands:: Managing Sieve scripts.
490 * Summary Buffer Format:: Deciding how the summary buffer is to look.
491 * Summary Maneuvering:: Moving around the summary buffer.
492 * Choosing Articles:: Reading articles.
493 * Paging the Article:: Scrolling the current article.
494 * Reply Followup and Post:: Posting articles.
495 * Delayed Articles:: Send articles at a later time.
496 * Marking Articles:: Marking articles as read, expirable, etc.
497 * Limiting:: You can limit the summary buffer.
498 * Threading:: How threads are made.
499 * Sorting the Summary Buffer:: How articles and threads are sorted.
500 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
501 * Article Caching:: You may store articles in a cache.
502 * Persistent Articles:: Making articles expiry-resistant.
503 * Article Backlog:: Having already read articles hang around.
504 * Saving Articles:: Ways of customizing article saving.
505 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
506 * Article Treatment:: The article buffer can be mangled at will.
507 * MIME Commands:: Doing MIMEy things with the articles.
508 * Charsets:: Character set issues.
509 * Article Commands:: Doing various things with the article buffer.
510 * Summary Sorting:: Sorting the summary buffer in various ways.
511 * Finding the Parent:: No child support? Get the parent.
512 * Alternative Approaches:: Reading using non-default summaries.
513 * Tree Display:: A more visual display of threads.
514 * Mail Group Commands:: Some commands can only be used in mail groups.
515 * Various Summary Stuff:: What didn't fit anywhere else.
516 * Exiting the Summary Buffer:: Returning to the Group buffer,
517 or reselecting the current group.
518 * Crosspost Handling:: How crossposted articles are dealt with.
519 * Duplicate Suppression:: An alternative when crosspost handling fails.
520 * Security:: Decrypt and Verify.
521 * Mailing List:: Mailing list minor mode.
523 Summary Buffer Format
525 * Summary Buffer Lines:: You can specify how summary lines should look.
526 * To From Newsgroups:: How to not display your own name.
527 * Summary Buffer Mode Line:: You can say how the mode line should look.
528 * Summary Highlighting:: Making the summary buffer all pretty and nice.
532 * Choosing Commands:: Commands for choosing articles.
533 * Choosing Variables:: Variables that influence these commands.
535 Reply, Followup and Post
537 * Summary Mail Commands:: Sending mail.
538 * Summary Post Commands:: Sending news.
539 * Summary Message Commands:: Other Message-related commands.
540 * Canceling and Superseding::
544 * Unread Articles:: Marks for unread articles.
545 * Read Articles:: Marks for read articles.
546 * Other Marks:: Marks that do not affect readedness.
547 * Setting Marks:: How to set and remove marks.
548 * Generic Marking Commands:: How to customize the marking.
549 * Setting Process Marks:: How to mark articles for later processing.
553 * Customizing Threading:: Variables you can change to affect the threading.
554 * Thread Commands:: Thread based commands in the summary buffer.
556 Customizing Threading
558 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
559 * Filling In Threads:: Making the threads displayed look fuller.
560 * More Threading:: Even more variables for fiddling with threads.
561 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
565 * Uuencoded Articles:: Uudecode articles.
566 * Shell Archives:: Unshar articles.
567 * PostScript Files:: Split PostScript.
568 * Other Files:: Plain save and binhex.
569 * Decoding Variables:: Variables for a happy decoding.
570 * Viewing Files:: You want to look at the result of the decoding?
574 * Rule Variables:: Variables that say how a file is to be viewed.
575 * Other Decode Variables:: Other decode variables.
576 * Uuencoding and Posting:: Variables for customizing uuencoding.
580 * Article Highlighting:: You want to make the article look like fruit salad.
581 * Article Fontisizing:: Making emphasized text look nice.
582 * Article Hiding:: You also want to make certain info go away.
583 * Article Washing:: Lots of way-neat functions to make life better.
584 * Article Header:: Doing various header transformations.
585 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
586 * Article Button Levels:: Controlling appearance of buttons.
587 * Article Date:: Grumble, UT!
588 * Article Display:: Display various stuff---X-Face, Picons, Smileys
589 * Article Signature:: What is a signature?
590 * Article Miscellanea:: Various other stuff.
592 Alternative Approaches
594 * Pick and Read:: First mark articles and then read them.
595 * Binary Groups:: Auto-decode all articles.
597 Various Summary Stuff
599 * Summary Group Information:: Information oriented commands.
600 * Searching for Articles:: Multiple article commands.
601 * Summary Generation Commands::
602 * Really Various Summary Commands:: Those pesky non-conformant commands.
606 * Hiding Headers:: Deciding what headers should be displayed.
607 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
608 * Customizing Articles:: Tailoring the look of the articles.
609 * Article Keymap:: Keystrokes available in the article buffer.
610 * Misc Article:: Other stuff.
614 * Mail:: Mailing and replying.
615 * Posting Server:: What server should you post and mail via?
616 * POP before SMTP:: You cannot send a mail unless you read a mail.
617 * Mail and Post:: Mailing and posting at the same time.
618 * Archived Messages:: Where Gnus stores the messages you've sent.
619 * Posting Styles:: An easier way to specify who you are.
620 * Drafts:: Postponing messages and rejected messages.
621 * Rejected Articles:: What happens if the server doesn't like your article?
622 * Signing and encrypting:: How to compose secure messages.
626 * Server Buffer:: Making and editing virtual servers.
627 * Getting News:: Reading USENET news with Gnus.
628 * Getting Mail:: Reading your personal mail with Gnus.
629 * Browsing the Web:: Getting messages from a plethora of Web sources.
630 * IMAP:: Using Gnus as a @acronym{IMAP} client.
631 * Other Sources:: Reading directories, files, SOUP packets.
632 * Combined Groups:: Combining groups into one group.
633 * Email Based Diary:: Using mails to manage diary events in Gnus.
634 * Gnus Unplugged:: Reading news and mail offline.
638 * Server Buffer Format:: You can customize the look of this buffer.
639 * Server Commands:: Commands to manipulate servers.
640 * Example Methods:: Examples server specifications.
641 * Creating a Virtual Server:: An example session.
642 * Server Variables:: Which variables to set.
643 * Servers and Methods:: You can use server names as select methods.
644 * Unavailable Servers:: Some servers you try to contact may be down.
648 * NNTP:: Reading news from an @acronym{NNTP} server.
649 * News Spool:: Reading news from the local spool.
653 * Direct Functions:: Connecting directly to the server.
654 * Indirect Functions:: Connecting indirectly to the server.
655 * Common Variables:: Understood by several connection functions.
656 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
660 * Mail in a Newsreader:: Important introductory notes.
661 * Getting Started Reading Mail:: A simple cookbook example.
662 * Splitting Mail:: How to create mail groups.
663 * Mail Sources:: How to tell Gnus where to get mail from.
664 * Mail Back End Variables:: Variables for customizing mail handling.
665 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
666 * Group Mail Splitting:: Use group customize to drive mail splitting.
667 * Incorporating Old Mail:: What about the old mail you have?
668 * Expiring Mail:: Getting rid of unwanted mail.
669 * Washing Mail:: Removing cruft from the mail you get.
670 * Duplicates:: Dealing with duplicated mail.
671 * Not Reading Mail:: Using mail back ends for reading other files.
672 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
676 * Mail Source Specifiers:: How to specify what a mail source is.
677 * Mail Source Customization:: Some variables that influence things.
678 * Fetching Mail:: Using the mail source specifiers.
680 Choosing a Mail Back End
682 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
683 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
684 * Mail Spool:: Store your mail in a private spool?
685 * MH Spool:: An mhspool-like back end.
686 * Maildir:: Another one-file-per-message format.
687 * Mail Folders:: Having one file for each group.
688 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
693 * Web Searches:: Creating groups from articles that match a string.
694 * Slashdot:: Reading the Slashdot comments.
695 * Ultimate:: The Ultimate Bulletin Board systems.
696 * Web Archive:: Reading mailing list archived on web.
697 * RSS:: Reading RDF site summary.
698 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
702 * Splitting in IMAP:: Splitting mail with nnimap.
703 * Expiring in IMAP:: Expiring mail with nnimap.
704 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
705 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
706 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
707 * Debugging IMAP:: What to do when things don't work.
711 * Directory Groups:: You can read a directory as if it was a newsgroup.
712 * Anything Groups:: Dired? Who needs dired?
713 * Document Groups:: Single files can be the basis of a group.
714 * SOUP:: Reading @sc{soup} packets ``offline''.
715 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
719 * Document Server Internals:: How to add your own document types.
723 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
724 * SOUP Groups:: A back end for reading @sc{soup} packets.
725 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
729 * Virtual Groups:: Combining articles from many groups.
730 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
734 * The NNDiary Back End:: Basic setup and usage.
735 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
736 * Sending or Not Sending:: A final note on sending diary messages.
740 * Diary Messages:: What makes a message valid for nndiary.
741 * Running NNDiary:: NNDiary has two modes of operation.
742 * Customizing NNDiary:: Bells and whistles.
744 The Gnus Diary Library
746 * Diary Summary Line Format:: A nicer summary buffer line format.
747 * Diary Articles Sorting:: A nicer way to sort messages.
748 * Diary Headers Generation:: Not doing it manually.
749 * Diary Group Parameters:: Not handling them manually.
753 * Agent Basics:: How it all is supposed to work.
754 * Agent Categories:: How to tell the Gnus Agent what to download.
755 * Agent Commands:: New commands for all the buffers.
756 * Agent Visuals:: Ways that the agent may effect your summary buffer.
757 * Agent as Cache:: The Agent is a big cache too.
758 * Agent Expiry:: How to make old articles go away.
759 * Agent Regeneration:: How to recover from lost connections and other accidents.
760 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
761 * Outgoing Messages:: What happens when you post/mail something?
762 * Agent Variables:: Customizing is fun.
763 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
764 * Batching Agents:: How to fetch news from a @code{cron} job.
765 * Agent Caveats:: What you think it'll do and what it does.
769 * Category Syntax:: What a category looks like.
770 * Category Buffer:: A buffer for maintaining categories.
771 * Category Variables:: Customize'r'Us.
775 * Group Agent Commands:: Configure groups and fetch their contents.
776 * Summary Agent Commands:: Manually select then fetch specific articles.
777 * Server Agent Commands:: Select the servers that are supported by the agent.
781 * Summary Score Commands:: Adding score entries for the current group.
782 * Group Score Commands:: General score commands.
783 * Score Variables:: Customize your scoring. (My, what terminology).
784 * Score File Format:: What a score file may contain.
785 * Score File Editing:: You can edit score files by hand as well.
786 * Adaptive Scoring:: Big Sister Gnus knows what you read.
787 * Home Score File:: How to say where new score entries are to go.
788 * Followups To Yourself:: Having Gnus notice when people answer you.
789 * Scoring On Other Headers:: Scoring on non-standard headers.
790 * Scoring Tips:: How to score effectively.
791 * Reverse Scoring:: That problem child of old is not problem.
792 * Global Score Files:: Earth-spanning, ear-splitting score files.
793 * Kill Files:: They are still here, but they can be ignored.
794 * Converting Kill Files:: Translating kill files to score files.
795 * Advanced Scoring:: Using logical expressions to build score rules.
796 * Score Decays:: It can be useful to let scores wither away.
800 * Advanced Scoring Syntax:: A definition.
801 * Advanced Scoring Examples:: What they look like.
802 * Advanced Scoring Tips:: Getting the most out of it.
806 * Process/Prefix:: A convention used by many treatment commands.
807 * Interactive:: Making Gnus ask you many questions.
808 * Symbolic Prefixes:: How to supply some Gnus functions with options.
809 * Formatting Variables:: You can specify what buffers should look like.
810 * Window Layout:: Configuring the Gnus buffer windows.
811 * Faces and Fonts:: How to change how faces look.
812 * Compilation:: How to speed Gnus up.
813 * Mode Lines:: Displaying information in the mode lines.
814 * Highlighting and Menus:: Making buffers look all nice and cozy.
815 * Buttons:: Get tendinitis in ten easy steps!
816 * Daemons:: Gnus can do things behind your back.
817 * NoCeM:: How to avoid spam and other fatty foods.
818 * Undo:: Some actions can be undone.
819 * Predicate Specifiers:: Specifying predicates.
820 * Moderation:: What to do if you're a moderator.
821 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
822 * Fuzzy Matching:: What's the big fuzz?
823 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
824 * Other modes:: Interaction with other modes.
825 * Various Various:: Things that are really various.
829 * Formatting Basics:: A formatting variable is basically a format string.
830 * Mode Line Formatting:: Some rules about mode line formatting variables.
831 * Advanced Formatting:: Modifying output in various ways.
832 * User-Defined Specs:: Having Gnus call your own functions.
833 * Formatting Fonts:: Making the formatting look colorful and nice.
834 * Positioning Point:: Moving point to a position after an operation.
835 * Tabulation:: Tabulating your output.
836 * Wide Characters:: Dealing with wide characters.
840 * X-Face:: Display a funky, teensy black-and-white image.
841 * Face:: Display a funkier, teensier colored image.
842 * Smileys:: Show all those happy faces the way they were meant to be shown.
843 * Picons:: How to display pictures of what you're reading.
844 * XVarious:: Other XEmacsy Gnusey variables.
848 * The problem of spam:: Some background, and some solutions
849 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
850 * SpamAssassin:: How to use external anti-spam tools.
851 * Hashcash:: Reduce spam by burning CPU time.
852 * Filtering Spam Using The Spam ELisp Package::
853 * Filtering Spam Using Statistics with spam-stat::
855 Filtering Spam Using The Spam ELisp Package
857 * Spam ELisp Package Sequence of Events::
858 * Spam ELisp Package Filtering of Incoming Mail::
859 * Spam ELisp Package Global Variables::
860 * Spam ELisp Package Configuration Examples::
861 * Blacklists and Whitelists::
863 * Gmane Spam Reporting::
864 * Anti-spam Hashcash Payments::
866 * Regular Expressions Header Matching::
868 * SpamAssassin back end::
869 * ifile spam filtering::
870 * spam-stat spam filtering::
872 * Extending the Spam ELisp package::
874 Filtering Spam Using Statistics with spam-stat
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 * Other Gnus Versions:: Other Gnus versions that also have been released.
896 * Why?:: What's the point of Gnus?
897 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
898 * Conformity:: Gnus tries to conform to all standards.
899 * Emacsen:: Gnus can be run on a few modern Emacsen.
900 * Gnus Development:: How Gnus is developed.
901 * Contributors:: Oodles of people.
902 * New Features:: Pointers to some of the new stuff in Gnus.
906 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
907 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
908 * Red Gnus:: Third time best---Gnus 5.4/5.5.
909 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
910 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
911 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
912 * No Gnus:: Lars, FIXME!
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
961 If your system administrator has set things up properly, starting gnus
962 and reading news is extremely easy---you just type @kbd{M-x gnus} in
965 @findex gnus-other-frame
966 @kindex M-x gnus-other-frame
967 If you want to start gnus in a different frame, you can use the command
968 @kbd{M-x gnus-other-frame} instead.
970 If things do not go smoothly at startup, you have to twiddle some
971 variables in your @file{~/.gnus.el} file. This file is similar to
972 @file{~/.emacs}, but is read when Gnus starts.
974 If you puzzle at any terms used in this manual, please refer to the
975 terminology section (@pxref{Terminology}).
978 * Finding the News:: Choosing a method for getting news.
979 * The First Time:: What does Gnus do the first time you start it?
980 * The Server is Down:: How can I read my mail then?
981 * Slave Gnusae:: You can have more than one Gnus active at a time.
982 * New Groups:: What is Gnus supposed to do with new groups?
983 * Changing Servers:: You may want to move from one server to another.
984 * Startup Files:: Those pesky startup files---@file{.newsrc}.
985 * Auto Save:: Recovering from a crash.
986 * The Active File:: Reading the active file over a slow line Takes Time.
987 * Startup Variables:: Other variables you might change.
991 @node Finding the News
992 @section Finding the News
995 @vindex gnus-select-method
997 The @code{gnus-select-method} variable says where gnus should look for
998 news. This variable should be a list where the first element says
999 @dfn{how} and the second element says @dfn{where}. This method is your
1000 native method. All groups not fetched with this method are
1003 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
1004 you want to get your daily dosage of news from, you'd say:
1007 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1010 If you want to read directly from the local spool, say:
1013 (setq gnus-select-method '(nnspool ""))
1016 If you can use a local spool, you probably should, as it will almost
1017 certainly be much faster. But do not use the local spool if your
1018 server is running Leafnode (which is a simple, standalone private news
1019 server); in this case, use @code{(nntp "localhost")}.
1021 @vindex gnus-nntpserver-file
1023 @cindex @acronym{NNTP} server
1024 If this variable is not set, gnus will take a look at the
1025 @env{NNTPSERVER} environment variable. If that variable isn't set,
1026 gnus will see whether @code{gnus-nntpserver-file}
1027 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1028 If that fails as well, gnus will try to use the machine running Emacs
1029 as an @acronym{NNTP} server. That's a long shot, though.
1031 @vindex gnus-nntp-server
1032 If @code{gnus-nntp-server} is set, this variable will override
1033 @code{gnus-select-method}. You should therefore set
1034 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1036 @vindex gnus-secondary-servers
1037 @vindex gnus-nntp-server
1038 You can also make gnus prompt you interactively for the name of an
1039 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1040 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
1041 in the @code{gnus-secondary-servers} list (if any). You can also just
1042 type in the name of any server you feel like visiting. (Note that this
1043 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1044 gnus} later in the same Emacs session, Gnus will contact the same
1047 @findex gnus-group-browse-foreign-server
1049 However, if you use one @acronym{NNTP} server regularly and are just
1050 interested in a couple of groups from a different server, you would be
1051 better served by using the @kbd{B} command in the group buffer. It will
1052 let you have a look at what groups are available, and you can subscribe
1053 to any of the groups you want to. This also makes @file{.newsrc}
1054 maintenance much tidier. @xref{Foreign Groups}.
1056 @vindex gnus-secondary-select-methods
1058 A slightly different approach to foreign groups is to set the
1059 @code{gnus-secondary-select-methods} variable. The select methods
1060 listed in this variable are in many ways just as native as the
1061 @code{gnus-select-method} server. They will also be queried for active
1062 files during startup (if that's required), and new newsgroups that
1063 appear on these servers will be subscribed (or not) just as native
1066 For instance, if you use the @code{nnmbox} back end to read your mail,
1067 you would typically set this variable to
1070 (setq gnus-secondary-select-methods '((nnmbox "")))
1073 Note: the @acronym{NNTP} back end stores marks in marks files
1074 (@pxref{NNTP marks}). This feature makes it easy to share marks between
1075 several Gnus installations, but may slow down things a bit when fetching
1076 new articles. @xref{NNTP marks}, for more information.
1079 @node The First Time
1080 @section The First Time
1081 @cindex first time usage
1083 If no startup files exist (@pxref{Startup Files}), gnus will try to
1084 determine what groups should be subscribed by default.
1086 @vindex gnus-default-subscribed-newsgroups
1087 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1088 will subscribe you to just those groups in that list, leaving the rest
1089 killed. Your system administrator should have set this variable to
1092 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1093 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1094 here as @dfn{whatever Lars thinks you should read}.)
1096 You'll also be subscribed to the gnus documentation group, which should
1097 help you with most common problems.
1099 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1100 use the normal functions for handling new groups, and not do anything
1104 @node The Server is Down
1105 @section The Server is Down
1106 @cindex server errors
1108 If the default server is down, gnus will understandably have some
1109 problems starting. However, if you have some mail groups in addition to
1110 the news groups, you may want to start gnus anyway.
1112 Gnus, being the trusting sort of program, will ask whether to proceed
1113 without a native select method if that server can't be contacted. This
1114 will happen whether the server doesn't actually exist (i.e., you have
1115 given the wrong address) or the server has just momentarily taken ill
1116 for some reason or other. If you decide to continue and have no foreign
1117 groups, you'll find it difficult to actually do anything in the group
1118 buffer. But, hey, that's your problem. Blllrph!
1120 @findex gnus-no-server
1121 @kindex M-x gnus-no-server
1123 If you know that the server is definitely down, or you just want to read
1124 your mail without bothering with the server at all, you can use the
1125 @code{gnus-no-server} command to start gnus. That might come in handy
1126 if you're in a hurry as well. This command will not attempt to contact
1127 your primary server---instead, it will just activate all groups on level
1128 1 and 2. (You should preferably keep no native groups on those two
1129 levels.) Also @pxref{Group Levels}.
1133 @section Slave Gnusae
1136 You might want to run more than one Emacs with more than one gnus at the
1137 same time. If you are using different @file{.newsrc} files (e.g., if you
1138 are using the two different gnusae to read from two different servers),
1139 that is no problem whatsoever. You just do it.
1141 The problem appears when you want to run two Gnusae that use the same
1142 @file{.newsrc} file.
1144 To work around that problem some, we here at the Think-Tank at the gnus
1145 Towers have come up with a new concept: @dfn{Masters} and
1146 @dfn{slaves}. (We have applied for a patent on this concept, and have
1147 taken out a copyright on those words. If you wish to use those words in
1148 conjunction with each other, you have to send $1 per usage instance to
1149 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1150 Applications}) will be much more expensive, of course.)
1153 Anyway, you start one gnus up the normal way with @kbd{M-x gnus} (or
1154 however you do it). Each subsequent slave gnusae should be started with
1155 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1156 files, but instead save @dfn{slave files} that contain information only
1157 on what groups have been read in the slave session. When a master gnus
1158 starts, it will read (and delete) these slave files, incorporating all
1159 information from them. (The slave files will be read in the sequence
1160 they were created, so the latest changes will have precedence.)
1162 Information from the slave files has, of course, precedence over the
1163 information in the normal (i.e., master) @file{.newsrc} file.
1165 If the @file{.newsrc*} files have not been saved in the master when the
1166 slave starts, you may be prompted as to whether to read an auto-save
1167 file. If you answer ``yes'', the unsaved changes to the master will be
1168 incorporated into the slave. If you answer ``no'', the slave may see some
1169 messages as unread that have been read in the master.
1176 @cindex subscription
1178 @vindex gnus-check-new-newsgroups
1179 If you are satisfied that you really never want to see any new groups,
1180 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1181 also save you some time at startup. Even if this variable is
1182 @code{nil}, you can always subscribe to the new groups just by pressing
1183 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1184 is @code{ask-server} by default. If you set this variable to
1185 @code{always}, then Gnus will query the back ends for new groups even
1186 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1189 * Checking New Groups:: Determining what groups are new.
1190 * Subscription Methods:: What Gnus should do with new groups.
1191 * Filtering New Groups:: Making Gnus ignore certain new groups.
1195 @node Checking New Groups
1196 @subsection Checking New Groups
1198 Gnus normally determines whether a group is new or not by comparing the
1199 list of groups from the active file(s) with the lists of subscribed and
1200 dead groups. This isn't a particularly fast method. If
1201 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1202 server for new groups since the last time. This is both faster and
1203 cheaper. This also means that you can get rid of the list of killed
1204 groups altogether, so you may set @code{gnus-save-killed-list} to
1205 @code{nil}, which will save time both at startup, at exit, and all over.
1206 Saves disk space, too. Why isn't this the default, then?
1207 Unfortunately, not all servers support this command.
1209 I bet I know what you're thinking now: How do I find out whether my
1210 server supports @code{ask-server}? No? Good, because I don't have a
1211 fail-safe answer. I would suggest just setting this variable to
1212 @code{ask-server} and see whether any new groups appear within the next
1213 few days. If any do, then it works. If none do, then it doesn't
1214 work. I could write a function to make gnus guess whether the server
1215 supports @code{ask-server}, but it would just be a guess. So I won't.
1216 You could @code{telnet} to the server and say @code{HELP} and see
1217 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1218 it does, then it might work. (But there are servers that lists
1219 @samp{NEWGROUPS} without supporting the function properly.)
1221 This variable can also be a list of select methods. If so, gnus will
1222 issue an @code{ask-server} command to each of the select methods, and
1223 subscribe them (or not) using the normal methods. This might be handy
1224 if you are monitoring a few servers for new groups. A side effect is
1225 that startup will take much longer, so you can meditate while waiting.
1226 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1229 @node Subscription Methods
1230 @subsection Subscription Methods
1232 @vindex gnus-subscribe-newsgroup-method
1233 What gnus does when it encounters a new group is determined by the
1234 @code{gnus-subscribe-newsgroup-method} variable.
1236 This variable should contain a function. This function will be called
1237 with the name of the new group as the only parameter.
1239 Some handy pre-fab functions are:
1243 @item gnus-subscribe-zombies
1244 @vindex gnus-subscribe-zombies
1245 Make all new groups zombies. This is the default. You can browse the
1246 zombies later (with @kbd{A z}) and either kill them all off properly
1247 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1249 @item gnus-subscribe-randomly
1250 @vindex gnus-subscribe-randomly
1251 Subscribe all new groups in arbitrary order. This really means that all
1252 new groups will be added at ``the top'' of the group buffer.
1254 @item gnus-subscribe-alphabetically
1255 @vindex gnus-subscribe-alphabetically
1256 Subscribe all new groups in alphabetical order.
1258 @item gnus-subscribe-hierarchically
1259 @vindex gnus-subscribe-hierarchically
1260 Subscribe all new groups hierarchically. The difference between this
1261 function and @code{gnus-subscribe-alphabetically} is slight.
1262 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1263 alphabetical fashion, while this function will enter groups into its
1264 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1265 @samp{comp} hierarchy, this function will not mess that configuration
1266 up. Or something like that.
1268 @item gnus-subscribe-interactively
1269 @vindex gnus-subscribe-interactively
1270 Subscribe new groups interactively. This means that gnus will ask
1271 you about @strong{all} new groups. The groups you choose to subscribe
1272 to will be subscribed hierarchically.
1274 @item gnus-subscribe-killed
1275 @vindex gnus-subscribe-killed
1276 Kill all new groups.
1278 @item gnus-subscribe-topics
1279 @vindex gnus-subscribe-topics
1280 Put the groups into the topic that has a matching @code{subscribe} topic
1281 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1282 topic parameter that looks like
1288 will mean that all groups that match that regex will be subscribed under
1291 If no topics match the groups, the groups will be subscribed in the
1296 @vindex gnus-subscribe-hierarchical-interactive
1297 A closely related variable is
1298 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1299 mouthful.) If this variable is non-@code{nil}, gnus will ask you in a
1300 hierarchical fashion whether to subscribe to new groups or not. Gnus
1301 will ask you for each sub-hierarchy whether you want to descend the
1304 One common mistake is to set the variable a few paragraphs above
1305 (@code{gnus-subscribe-newsgroup-method}) to
1306 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1307 will not work. This is ga-ga. So don't do it.
1310 @node Filtering New Groups
1311 @subsection Filtering New Groups
1313 A nice and portable way to control which new newsgroups should be
1314 subscribed (or ignored) is to put an @dfn{options} line at the start of
1315 the @file{.newsrc} file. Here's an example:
1318 options -n !alt.all !rec.all sci.all
1321 @vindex gnus-subscribe-options-newsgroup-method
1322 This line obviously belongs to a serious-minded intellectual scientific
1323 person (or she may just be plain old boring), because it says that all
1324 groups that have names beginning with @samp{alt} and @samp{rec} should
1325 be ignored, and all groups with names beginning with @samp{sci} should
1326 be subscribed. Gnus will not use the normal subscription method for
1327 subscribing these groups.
1328 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1329 variable defaults to @code{gnus-subscribe-alphabetically}.
1331 @vindex gnus-options-not-subscribe
1332 @vindex gnus-options-subscribe
1333 If you don't want to mess with your @file{.newsrc} file, you can just
1334 set the two variables @code{gnus-options-subscribe} and
1335 @code{gnus-options-not-subscribe}. These two variables do exactly the
1336 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1337 and if the new group matches the former, it will be unconditionally
1338 subscribed, and if it matches the latter, it will be ignored.
1340 @vindex gnus-auto-subscribed-groups
1341 Yet another variable that meddles here is
1342 @code{gnus-auto-subscribed-groups}. It works exactly like
1343 @code{gnus-options-subscribe}, and is therefore really superfluous,
1344 but I thought it would be nice to have two of these. This variable is
1345 more meant for setting some ground rules, while the other variable is
1346 used more for user fiddling. By default this variable makes all new
1347 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1348 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1349 subscribed. If you don't like that, just set this variable to
1352 New groups that match this regexp are subscribed using
1353 @code{gnus-subscribe-options-newsgroup-method}.
1356 @node Changing Servers
1357 @section Changing Servers
1358 @cindex changing servers
1360 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1361 This happens very rarely, but perhaps you change jobs, or one server is
1362 very flaky and you want to use another.
1364 Changing the server is pretty easy, right? You just change
1365 @code{gnus-select-method} to point to the new server?
1369 Article numbers are not (in any way) kept synchronized between different
1370 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1371 you have read is by keeping track of article numbers. So when you
1372 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1375 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1376 file from one server to another. They all have one thing in
1377 common---they take a looong time to run. You don't want to use these
1378 functions more than absolutely necessary.
1380 @kindex M-x gnus-change-server
1381 @findex gnus-change-server
1382 If you have access to both servers, Gnus can request the headers for all
1383 the articles you have read and compare @code{Message-ID}s and map the
1384 article numbers of the read articles and article marks. The @kbd{M-x
1385 gnus-change-server} command will do this for all your native groups. It
1386 will prompt for the method you want to move to.
1388 @kindex M-x gnus-group-move-group-to-server
1389 @findex gnus-group-move-group-to-server
1390 You can also move individual groups with the @kbd{M-x
1391 gnus-group-move-group-to-server} command. This is useful if you want to
1392 move a (foreign) group from one server to another.
1394 @kindex M-x gnus-group-clear-data-on-native-groups
1395 @findex gnus-group-clear-data-on-native-groups
1396 If you don't have access to both the old and new server, all your marks
1397 and read ranges have become worthless. You can use the @kbd{M-x
1398 gnus-group-clear-data-on-native-groups} command to clear out all data
1399 that you have on your native groups. Use with caution.
1401 @kindex M-x gnus-group-clear-data
1402 @findex gnus-group-clear-data
1403 Clear the data from the current group only---nix out marks and the
1404 list of read articles (@code{gnus-group-clear-data}).
1406 After changing servers, you @strong{must} move the cache hierarchy away,
1407 since the cached articles will have wrong article numbers, which will
1408 affect which articles Gnus thinks are read.
1409 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1410 to have it done automatically; for @code{gnus-group-clear-data}, you
1411 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1412 cache for all groups).
1416 @section Startup Files
1417 @cindex startup files
1422 Most common Unix news readers use a shared startup file called
1423 @file{.newsrc}. This file contains all the information about what
1424 groups are subscribed, and which articles in these groups have been
1427 Things got a bit more complicated with @sc{gnus}. In addition to
1428 keeping the @file{.newsrc} file updated, it also used a file called
1429 @file{.newsrc.el} for storing all the information that didn't fit into
1430 the @file{.newsrc} file. (Actually, it also duplicated everything in
1431 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1432 files was the most recently saved, which enabled people to swap between
1433 @sc{gnus} and other newsreaders.
1435 That was kinda silly, so Gnus went one better: In addition to the
1436 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1437 @file{.newsrc.eld}. It will read whichever of these files that are most
1438 recent, but it will never write a @file{.newsrc.el} file. You should
1439 never delete the @file{.newsrc.eld} file---it contains much information
1440 not stored in the @file{.newsrc} file.
1442 @vindex gnus-save-newsrc-file
1443 @vindex gnus-read-newsrc-file
1444 You can turn off writing the @file{.newsrc} file by setting
1445 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1446 the file and save some space, as well as exiting from gnus faster.
1447 However, this will make it impossible to use other newsreaders than
1448 gnus. But hey, who would want to, right? Similarly, setting
1449 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1450 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which can be
1451 convenient if you use a different news reader occasionally, and you
1452 want to read a different subset of the available groups with that
1455 @vindex gnus-save-killed-list
1456 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1457 will not save the list of killed groups to the startup file. This will
1458 save both time (when starting and quitting) and space (on disk). It
1459 will also mean that Gnus has no record of what groups are new or old,
1460 so the automatic new groups subscription methods become meaningless.
1461 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1462 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1463 Groups}). This variable can also be a regular expression. If that's
1464 the case, remove all groups that do not match this regexp before
1465 saving. This can be useful in certain obscure situations that involve
1466 several servers where not all servers support @code{ask-server}.
1468 @vindex gnus-startup-file
1469 @vindex gnus-backup-startup-file
1470 @vindex version-control
1471 The @code{gnus-startup-file} variable says where the startup files are.
1472 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1473 file being whatever that one is, with a @samp{.eld} appended.
1474 If you want version control for this file, set
1475 @code{gnus-backup-startup-file}. It respects the same values as the
1476 @code{version-control} variable.
1478 @vindex gnus-save-newsrc-hook
1479 @vindex gnus-save-quick-newsrc-hook
1480 @vindex gnus-save-standard-newsrc-hook
1481 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1482 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1483 saving the @file{.newsrc.eld} file, and
1484 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1485 @file{.newsrc} file. The latter two are commonly used to turn version
1486 control on or off. Version control is on by default when saving the
1487 startup files. If you want to turn backup creation off, say something like:
1490 (defun turn-off-backup ()
1491 (set (make-local-variable 'backup-inhibited) t))
1493 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1494 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1497 @vindex gnus-init-file
1498 @vindex gnus-site-init-file
1499 When Gnus starts, it will read the @code{gnus-site-init-file}
1500 (@file{.../site-lisp/gnus-init} by default) and @code{gnus-init-file}
1501 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1502 and can be used to avoid cluttering your @file{~/.emacs} and
1503 @file{site-init} files with Gnus stuff. Gnus will also check for files
1504 with the same names as these, but with @file{.elc} and @file{.el}
1505 suffixes. In other words, if you have set @code{gnus-init-file} to
1506 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1507 and finally @file{~/.gnus} (in this order). If Emacs was invoked with
1508 the @option{-q} or @option{--no-init-file} options (@pxref{Initial
1509 Options, ,Initial Options, emacs, The Emacs Manual}), Gnus doesn't read
1510 @code{gnus-init-file}.
1515 @cindex dribble file
1518 Whenever you do something that changes the gnus data (reading articles,
1519 catching up, killing/subscribing groups), the change is added to a
1520 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1521 Emacs way. If your Emacs should crash before you have saved the
1522 @file{.newsrc} files, all changes you have made can be recovered from
1525 If gnus detects this file at startup, it will ask the user whether to
1526 read it. The auto save file is deleted whenever the real startup file is
1529 @vindex gnus-use-dribble-file
1530 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1531 maintain a dribble buffer. The default is @code{t}.
1533 @vindex gnus-dribble-directory
1534 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1535 this variable is @code{nil}, which it is by default, gnus will dribble
1536 into the directory where the @file{.newsrc} file is located. (This is
1537 normally the user's home directory.) The dribble file will get the same
1538 file permissions as the @file{.newsrc} file.
1540 @vindex gnus-always-read-dribble-file
1541 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1542 read the dribble file on startup without querying the user.
1545 @node The Active File
1546 @section The Active File
1548 @cindex ignored groups
1550 When gnus starts, or indeed whenever it tries to determine whether new
1551 articles have arrived, it reads the active file. This is a very large
1552 file that lists all the active groups and articles on the server.
1554 @vindex gnus-ignored-newsgroups
1555 Before examining the active file, gnus deletes all lines that match the
1556 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1557 any groups with bogus names, but you can use this variable to make gnus
1558 ignore hierarchies you aren't ever interested in. However, this is not
1559 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1560 Groups} for an overview of other variables that can be used instead.
1563 @c @code{nil} by default, and will slow down active file handling somewhat
1564 @c if you set it to anything else.
1566 @vindex gnus-read-active-file
1568 The active file can be rather Huge, so if you have a slow network, you
1569 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1570 reading the active file. This variable is @code{some} by default.
1572 Gnus will try to make do by getting information just on the groups that
1573 you actually subscribe to.
1575 Note that if you subscribe to lots and lots of groups, setting this
1576 variable to @code{nil} will probably make gnus slower, not faster. At
1577 present, having this variable @code{nil} will slow gnus down
1578 considerably, unless you read news over a 2400 baud modem.
1580 This variable can also have the value @code{some}. Gnus will then
1581 attempt to read active info only on the subscribed groups. On some
1582 servers this is quite fast (on sparkling, brand new INN servers that
1583 support the @code{LIST ACTIVE group} command), on others this isn't fast
1584 at all. In any case, @code{some} should be faster than @code{nil}, and
1585 is certainly faster than @code{t} over slow lines.
1587 Some news servers (old versions of Leafnode and old versions of INN, for
1588 instance) do not support the @code{LIST ACTIVE group}. For these
1589 servers, @code{nil} is probably the most efficient value for this
1592 If this variable is @code{nil}, gnus will ask for group info in total
1593 lock-step, which isn't very fast. If it is @code{some} and you use an
1594 @acronym{NNTP} server, gnus will pump out commands as fast as it can, and
1595 read all the replies in one swoop. This will normally result in better
1596 performance, but if the server does not support the aforementioned
1597 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1599 If you think that starting up Gnus takes too long, try all the three
1600 different values for this variable and see what works best for you.
1602 In any case, if you use @code{some} or @code{nil}, you should definitely
1603 kill all groups that you aren't interested in to speed things up.
1605 Note that this variable also affects active file retrieval from
1606 secondary select methods.
1609 @node Startup Variables
1610 @section Startup Variables
1614 @item gnus-load-hook
1615 @vindex gnus-load-hook
1616 A hook run while gnus is being loaded. Note that this hook will
1617 normally be run just once in each Emacs session, no matter how many
1618 times you start gnus.
1620 @item gnus-before-startup-hook
1621 @vindex gnus-before-startup-hook
1622 A hook run after starting up gnus successfully.
1624 @item gnus-startup-hook
1625 @vindex gnus-startup-hook
1626 A hook run as the very last thing after starting up gnus
1628 @item gnus-started-hook
1629 @vindex gnus-started-hook
1630 A hook that is run as the very last thing after starting up gnus
1633 @item gnus-setup-news-hook
1634 @vindex gnus-setup-news-hook
1635 A hook that is run after reading the @file{.newsrc} file(s), but before
1636 generating the group buffer.
1638 @item gnus-check-bogus-newsgroups
1639 @vindex gnus-check-bogus-newsgroups
1640 If non-@code{nil}, gnus will check for and delete all bogus groups at
1641 startup. A @dfn{bogus group} is a group that you have in your
1642 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1643 bogus groups can take quite a while, so to save time and resources it's
1644 best to leave this option off, and do the checking for bogus groups once
1645 in a while from the group buffer instead (@pxref{Group Maintenance}).
1647 @item gnus-inhibit-startup-message
1648 @vindex gnus-inhibit-startup-message
1649 If non-@code{nil}, the startup message won't be displayed. That way,
1650 your boss might not notice as easily that you are reading news instead
1651 of doing your job. Note that this variable is used before
1652 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1654 @item gnus-no-groups-message
1655 @vindex gnus-no-groups-message
1656 Message displayed by gnus when no groups are available.
1658 @item gnus-play-startup-jingle
1659 @vindex gnus-play-startup-jingle
1660 If non-@code{nil}, play the gnus jingle at startup.
1662 @item gnus-startup-jingle
1663 @vindex gnus-startup-jingle
1664 Jingle to be played if the above variable is non-@code{nil}. The
1665 default is @samp{Tuxedomoon.Jingle4.au}.
1671 @chapter Group Buffer
1672 @cindex group buffer
1674 @c Alex Schroeder suggests to rearrange this as follows:
1676 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1677 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1678 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1679 @c 7. Group Score, 8. Group Buffer Format
1680 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1681 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1682 @c <kensanata> First, "Gnus considers groups... (default 9)."
1683 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1684 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1685 @c <kensanata> Then expand the next paragraph or add some more to it.
1686 @c This short one sentence explains levels 1 and 2, therefore I understand
1687 @c that I should keep important news at 3 and boring news at 4.
1688 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1689 @c Maybe keep those that you don't want to read temporarily at 6,
1690 @c those that you never want to read at 8, those that offend your
1691 @c human rights at 9...
1694 The @dfn{group buffer} lists all (or parts) of the available groups. It
1695 is the first buffer shown when gnus starts, and will never be killed as
1696 long as gnus is active.
1700 \gnusfigure{The Group Buffer}{320}{
1701 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1702 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1703 \put(120,38){\vector(1,2){10}}
1704 \put(40,60){\makebox(0,0)[r]{Mode line}}
1705 \put(40,58){\vector(1,0){30}}
1706 \put(200,28){\makebox(0,0)[t]{Native select method}}
1707 \put(200,26){\vector(-1,2){15}}
1713 * Group Buffer Format:: Information listed and how you can change it.
1714 * Group Maneuvering:: Commands for moving in the group buffer.
1715 * Selecting a Group:: Actually reading news.
1716 * Subscription Commands:: Unsubscribing, killing, subscribing.
1717 * Group Data:: Changing the info for a group.
1718 * Group Levels:: Levels? What are those, then?
1719 * Group Score:: A mechanism for finding out what groups you like.
1720 * Marking Groups:: You can mark groups for later processing.
1721 * Foreign Groups:: Creating and editing groups.
1722 * Group Parameters:: Each group may have different parameters set.
1723 * Listing Groups:: Gnus can list various subsets of the groups.
1724 * Sorting Groups:: Re-arrange the group order.
1725 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1726 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1727 * Exiting Gnus:: Stop reading news and get some work done.
1728 * Group Topics:: A folding group mode divided into topics.
1729 * Misc Group Stuff:: Other stuff that you can to do.
1733 @node Group Buffer Format
1734 @section Group Buffer Format
1737 * Group Line Specification:: Deciding how the group buffer is to look.
1738 * Group Mode Line Specification:: The group buffer mode line.
1739 * Group Highlighting:: Having nice colors in the group buffer.
1743 @node Group Line Specification
1744 @subsection Group Line Specification
1745 @cindex group buffer format
1747 The default format of the group buffer is nice and dull, but you can
1748 make it as exciting and ugly as you feel like.
1750 Here's a couple of example group lines:
1753 25: news.announce.newusers
1754 * 0: alt.fan.andrea-dworkin
1759 You can see that there are 25 unread articles in
1760 @samp{news.announce.newusers}. There are no unread articles, but some
1761 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1762 asterisk at the beginning of the line?).
1764 @vindex gnus-group-line-format
1765 You can change that format to whatever you want by fiddling with the
1766 @code{gnus-group-line-format} variable. This variable works along the
1767 lines of a @code{format} specification, which is pretty much the same as
1768 a @code{printf} specifications, for those of you who use (feh!) C.
1769 @xref{Formatting Variables}.
1771 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1773 There should always be a colon on the line; the cursor always moves to
1774 the colon after performing an operation. @xref{Positioning
1775 Point}. Nothing else is required---not even the group name. All
1776 displayed text is just window dressing, and is never examined by Gnus.
1777 Gnus stores all real information it needs using text properties.
1779 (Note that if you make a really strange, wonderful, spreadsheet-like
1780 layout, everybody will believe you are hard at work with the accounting
1781 instead of wasting time reading news.)
1783 Here's a list of all available format characters:
1788 An asterisk if the group only has marked articles.
1791 Whether the group is subscribed.
1794 Level of subscribedness.
1797 Number of unread articles.
1800 Number of dormant articles.
1803 Number of ticked articles.
1806 Number of read articles.
1809 Number of unseen articles.
1812 Estimated total number of articles. (This is really @var{max-number}
1813 minus @var{min-number} plus 1.)
1815 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1816 efficient access to @var{max-number} and @var{min-number} but getting
1817 the true unread message count is not possible efficiently. For
1818 hysterical raisins, even the mail back ends, where the true number of
1819 unread messages might be available efficiently, use the same limited
1820 interface. To remove this restriction from Gnus means that the back
1821 end interface has to be changed, which is not an easy job. If you
1822 want to work on this, please contact the Gnus mailing list.
1825 Number of unread, unticked, non-dormant articles.
1828 Number of ticked and dormant articles.
1837 Group comment (@pxref{Group Parameters}) or group name if there is no
1838 comment element in the group parameters.
1841 Newsgroup description. You need to read the group descriptions
1842 before these will appear, and to do that, you either have to set
1843 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1847 @samp{m} if moderated.
1850 @samp{(m)} if moderated.
1856 If the summary buffer for the group is open or not.
1862 A string that looks like @samp{<%s:%n>} if a foreign select method is
1866 Indentation based on the level of the topic (@pxref{Group Topics}).
1869 @vindex gnus-group-uncollapsed-levels
1870 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1871 variable says how many levels to leave at the end of the group name.
1872 The default is 1---this will mean that group names like
1873 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1876 @vindex gnus-new-mail-mark
1878 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1882 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1885 A string that says when you last read the group (@pxref{Group
1889 The disk space used by the articles fetched by both the cache and
1890 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1891 megabytes(M), or gigabytes(G) to minimize the column width. A format
1892 of %7F is sufficient for a fixed-width column.
1895 User defined specifier. The next character in the format string should
1896 be a letter. Gnus will call the function
1897 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1898 following @samp{%u}. The function will be passed a single dummy
1899 parameter as argument. The function should return a string, which will
1900 be inserted into the buffer just like information from any other
1905 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1906 if no info is available---for instance, if it is a non-activated foreign
1907 group, or a bogus native group.
1910 @node Group Mode Line Specification
1911 @subsection Group Mode Line Specification
1912 @cindex group mode line
1914 @vindex gnus-group-mode-line-format
1915 The mode line can be changed by setting
1916 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1917 doesn't understand that many format specifiers:
1921 The native news server.
1923 The native select method.
1927 @node Group Highlighting
1928 @subsection Group Highlighting
1929 @cindex highlighting
1930 @cindex group highlighting
1932 @vindex gnus-group-highlight
1933 Highlighting in the group buffer is controlled by the
1934 @code{gnus-group-highlight} variable. This is an alist with elements
1935 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1936 something non-@code{nil}, the @var{face} will be used on the line.
1938 Here's an example value for this variable that might look nice if the
1942 (cond (window-system
1943 (setq custom-background-mode 'light)
1944 (defface my-group-face-1
1945 '((t (:foreground "Red" :bold t))) "First group face")
1946 (defface my-group-face-2
1947 '((t (:foreground "DarkSeaGreen4" :bold t)))
1948 "Second group face")
1949 (defface my-group-face-3
1950 '((t (:foreground "Green4" :bold t))) "Third group face")
1951 (defface my-group-face-4
1952 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1953 (defface my-group-face-5
1954 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1956 (setq gnus-group-highlight
1957 '(((> unread 200) . my-group-face-1)
1958 ((and (< level 3) (zerop unread)) . my-group-face-2)
1959 ((< level 3) . my-group-face-3)
1960 ((zerop unread) . my-group-face-4)
1961 (t . my-group-face-5)))
1964 Also @pxref{Faces and Fonts}.
1966 Variables that are dynamically bound when the forms are evaluated
1973 The number of unread articles in the group.
1977 Whether the group is a mail group.
1979 The level of the group.
1981 The score of the group.
1983 The number of ticked articles in the group.
1985 The total number of articles in the group. Or rather,
1986 @var{max-number} minus @var{min-number} plus one.
1988 When using the topic minor mode, this variable is bound to the current
1989 topic being inserted.
1992 When the forms are @code{eval}ed, point is at the beginning of the line
1993 of the group in question, so you can use many of the normal gnus
1994 functions for snarfing info on the group.
1996 @vindex gnus-group-update-hook
1997 @findex gnus-group-highlight-line
1998 @code{gnus-group-update-hook} is called when a group line is changed.
1999 It will not be called when @code{gnus-visual} is @code{nil}. This hook
2000 calls @code{gnus-group-highlight-line} by default.
2003 @node Group Maneuvering
2004 @section Group Maneuvering
2005 @cindex group movement
2007 All movement commands understand the numeric prefix and will behave as
2008 expected, hopefully.
2014 @findex gnus-group-next-unread-group
2015 Go to the next group that has unread articles
2016 (@code{gnus-group-next-unread-group}).
2022 @findex gnus-group-prev-unread-group
2023 Go to the previous group that has unread articles
2024 (@code{gnus-group-prev-unread-group}).
2028 @findex gnus-group-next-group
2029 Go to the next group (@code{gnus-group-next-group}).
2033 @findex gnus-group-prev-group
2034 Go to the previous group (@code{gnus-group-prev-group}).
2038 @findex gnus-group-next-unread-group-same-level
2039 Go to the next unread group on the same (or lower) level
2040 (@code{gnus-group-next-unread-group-same-level}).
2044 @findex gnus-group-prev-unread-group-same-level
2045 Go to the previous unread group on the same (or lower) level
2046 (@code{gnus-group-prev-unread-group-same-level}).
2049 Three commands for jumping to groups:
2055 @findex gnus-group-jump-to-group
2056 Jump to a group (and make it visible if it isn't already)
2057 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2062 @findex gnus-group-best-unread-group
2063 Jump to the unread group with the lowest level
2064 (@code{gnus-group-best-unread-group}).
2068 @findex gnus-group-first-unread-group
2069 Jump to the first group with unread articles
2070 (@code{gnus-group-first-unread-group}).
2073 @vindex gnus-group-goto-unread
2074 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2075 commands will move to the next group, not the next unread group. Even
2076 the commands that say they move to the next unread group. The default
2080 @node Selecting a Group
2081 @section Selecting a Group
2082 @cindex group selection
2087 @kindex SPACE (Group)
2088 @findex gnus-group-read-group
2089 Select the current group, switch to the summary buffer and display the
2090 first unread article (@code{gnus-group-read-group}). If there are no
2091 unread articles in the group, or if you give a non-numerical prefix to
2092 this command, gnus will offer to fetch all the old articles in this
2093 group from the server. If you give a numerical prefix @var{n}, @var{n}
2094 determines the number of articles Gnus will fetch. If @var{n} is
2095 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2096 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2098 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2099 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2100 - 4 2 SPC} fetches the 42 oldest ones.
2102 When you are in the group (in the Summary buffer), you can type
2103 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2108 @findex gnus-group-select-group
2109 Select the current group and switch to the summary buffer
2110 (@code{gnus-group-select-group}). Takes the same arguments as
2111 @code{gnus-group-read-group}---the only difference is that this command
2112 does not display the first unread article automatically upon group
2116 @kindex M-RET (Group)
2117 @findex gnus-group-quick-select-group
2118 This does the same as the command above, but tries to do it with the
2119 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2120 scoring/killing will be performed, there will be no highlights and no
2121 expunging. This might be useful if you're in a real hurry and have to
2122 enter some humongous group. If you give a 0 prefix to this command
2123 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
2124 which is useful if you want to toggle threading before generating the
2125 summary buffer (@pxref{Summary Generation Commands}).
2128 @kindex M-SPACE (Group)
2129 @findex gnus-group-visible-select-group
2130 This is yet one more command that does the same as the @kbd{RET}
2131 command, but this one does it without expunging and hiding dormants
2132 (@code{gnus-group-visible-select-group}).
2135 @kindex C-M-RET (Group)
2136 @findex gnus-group-select-group-ephemerally
2137 Finally, this command selects the current group ephemerally without
2138 doing any processing of its contents
2139 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2140 turned off. Everything you do in the group after selecting it in this
2141 manner will have no permanent effects.
2145 @vindex gnus-large-newsgroup
2146 The @code{gnus-large-newsgroup} variable says what Gnus should
2147 consider to be a big group. If it is @code{nil}, no groups are
2148 considered big. The default value is 200. If the group has more
2149 (unread and/or ticked) articles than this, gnus will query the user
2150 before entering the group. The user can then specify how many
2151 articles should be fetched from the server. If the user specifies a
2152 negative number (@var{-n}), the @var{n} oldest articles will be
2153 fetched. If it is positive, the @var{n} articles that have arrived
2154 most recently will be fetched.
2156 @vindex gnus-large-ephemeral-newsgroup
2157 @code{gnus-large-ephemeral-newsgroup} is the same as
2158 @code{gnus-large-newsgroup}, but is only used for ephemeral
2161 @vindex gnus-select-group-hook
2162 @vindex gnus-auto-select-first
2163 @vindex gnus-auto-select-subject
2164 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2165 automatically when entering a group with the @kbd{SPACE} command.
2166 Which article this is is controlled by the
2167 @code{gnus-auto-select-subject} variable. Valid values for this
2173 Place point on the subject line of the first unread article.
2176 Place point on the subject line of the first article.
2179 Place point on the subject line of the first unseen article.
2181 @item unseen-or-unread
2182 Place point on the subject line of the first unseen article, and if
2183 there is no such article, place point on the subject line of the first
2187 Place point on the subject line of the highest-scored unread article.
2191 This variable can also be a function. In that case, that function
2192 will be called to place point on a subject line.
2194 If you want to prevent automatic selection in some group (say, in a
2195 binary group with Huge articles) you can set the
2196 @code{gnus-auto-select-first} variable to @code{nil} in
2197 @code{gnus-select-group-hook}, which is called when a group is
2201 @node Subscription Commands
2202 @section Subscription Commands
2203 @cindex subscription
2211 @findex gnus-group-unsubscribe-current-group
2212 @c @icon{gnus-group-unsubscribe}
2213 Toggle subscription to the current group
2214 (@code{gnus-group-unsubscribe-current-group}).
2220 @findex gnus-group-unsubscribe-group
2221 Prompt for a group to subscribe, and then subscribe it. If it was
2222 subscribed already, unsubscribe it instead
2223 (@code{gnus-group-unsubscribe-group}).
2229 @findex gnus-group-kill-group
2230 @c @icon{gnus-group-kill-group}
2231 Kill the current group (@code{gnus-group-kill-group}).
2237 @findex gnus-group-yank-group
2238 Yank the last killed group (@code{gnus-group-yank-group}).
2241 @kindex C-x C-t (Group)
2242 @findex gnus-group-transpose-groups
2243 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2244 really a subscription command, but you can use it instead of a
2245 kill-and-yank sequence sometimes.
2251 @findex gnus-group-kill-region
2252 Kill all groups in the region (@code{gnus-group-kill-region}).
2256 @findex gnus-group-kill-all-zombies
2257 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2260 @kindex S C-k (Group)
2261 @findex gnus-group-kill-level
2262 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2263 These groups can't be yanked back after killing, so this command should
2264 be used with some caution. The only time where this command comes in
2265 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2266 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2267 kill off all unsubscribed groups that do not have message numbers in the
2268 @file{.newsrc} file.
2272 Also @pxref{Group Levels}.
2282 @findex gnus-group-catchup-current
2283 @vindex gnus-group-catchup-group-hook
2284 @c @icon{gnus-group-catchup-current}
2285 Mark all unticked articles in this group as read
2286 (@code{gnus-group-catchup-current}).
2287 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2292 @findex gnus-group-catchup-current-all
2293 Mark all articles in this group, even the ticked ones, as read
2294 (@code{gnus-group-catchup-current-all}).
2298 @findex gnus-group-clear-data
2299 Clear the data from the current group---nix out marks and the list of
2300 read articles (@code{gnus-group-clear-data}).
2302 @item M-x gnus-group-clear-data-on-native-groups
2303 @kindex M-x gnus-group-clear-data-on-native-groups
2304 @findex gnus-group-clear-data-on-native-groups
2305 If you have switched from one @acronym{NNTP} server to another, all your marks
2306 and read ranges have become worthless. You can use this command to
2307 clear out all data that you have on your native groups. Use with
2314 @section Group Levels
2318 All groups have a level of @dfn{subscribedness}. For instance, if a
2319 group is on level 2, it is more subscribed than a group on level 5. You
2320 can ask gnus to just list groups on a given level or lower
2321 (@pxref{Listing Groups}), or to just check for new articles in groups on
2322 a given level or lower (@pxref{Scanning New Messages}).
2324 Remember: The higher the level of the group, the less important it is.
2330 @findex gnus-group-set-current-level
2331 Set the level of the current group. If a numeric prefix is given, the
2332 next @var{n} groups will have their levels set. The user will be
2333 prompted for a level.
2336 @vindex gnus-level-killed
2337 @vindex gnus-level-zombie
2338 @vindex gnus-level-unsubscribed
2339 @vindex gnus-level-subscribed
2340 Gnus considers groups from levels 1 to
2341 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2342 @code{gnus-level-subscribed} (exclusive) and
2343 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2344 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2345 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2346 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2347 same, but zombie and killed groups have no information on what articles
2348 you have read, etc, stored. This distinction between dead and living
2349 groups isn't done because it is nice or clever, it is done purely for
2350 reasons of efficiency.
2352 It is recommended that you keep all your mail groups (if any) on quite
2353 low levels (e.g. 1 or 2).
2355 Maybe the following description of the default behavior of Gnus helps to
2356 understand what these levels are all about. By default, Gnus shows you
2357 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2358 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2359 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2360 groups are hidden, in a way.
2362 Zombie and killed groups are similar to unsubscribed groups in that they
2363 are hidden by default. But they are different from subscribed and
2364 unsubscribed groups in that Gnus doesn't ask the news server for
2365 information (number of messages, number of unread messages) on zombie
2366 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2367 aren't interested in. If most groups are killed, Gnus is faster.
2369 Why does Gnus distinguish between zombie and killed groups? Well, when
2370 a new group arrives on the server, Gnus by default makes it a zombie
2371 group. This means that you are normally not bothered with new groups,
2372 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2373 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2374 list of killed groups.)
2376 If you want to play with the level variables, you should show some care.
2377 Set them once, and don't touch them ever again. Better yet, don't touch
2378 them at all unless you know exactly what you're doing.
2380 @vindex gnus-level-default-unsubscribed
2381 @vindex gnus-level-default-subscribed
2382 Two closely related variables are @code{gnus-level-default-subscribed}
2383 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2384 which are the levels that new groups will be put on if they are
2385 (un)subscribed. These two variables should, of course, be inside the
2386 relevant valid ranges.
2388 @vindex gnus-keep-same-level
2389 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2390 will only move to groups of the same level (or lower). In
2391 particular, going from the last article in one group to the next group
2392 will go to the next group of the same level (or lower). This might be
2393 handy if you want to read the most important groups before you read the
2396 If this variable is @code{best}, Gnus will make the next newsgroup the
2397 one with the best level.
2399 @vindex gnus-group-default-list-level
2400 All groups with a level less than or equal to
2401 @code{gnus-group-default-list-level} will be listed in the group buffer
2404 @vindex gnus-group-list-inactive-groups
2405 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2406 groups will be listed along with the unread groups. This variable is
2407 @code{t} by default. If it is @code{nil}, inactive groups won't be
2410 @vindex gnus-group-use-permanent-levels
2411 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2412 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2413 use this level as the ``work'' level.
2415 @vindex gnus-activate-level
2416 Gnus will normally just activate (i. e., query the server about) groups
2417 on level @code{gnus-activate-level} or less. If you don't want to
2418 activate unsubscribed groups, for instance, you might set this variable
2419 to 5. The default is 6.
2423 @section Group Score
2428 You would normally keep important groups on high levels, but that scheme
2429 is somewhat restrictive. Don't you wish you could have Gnus sort the
2430 group buffer according to how often you read groups, perhaps? Within
2433 This is what @dfn{group score} is for. You can have Gnus assign a score
2434 to each group through the mechanism described below. You can then sort
2435 the group buffer based on this score. Alternatively, you can sort on
2436 score and then level. (Taken together, the level and the score is
2437 called the @dfn{rank} of the group. A group that is on level 4 and has
2438 a score of 1 has a higher rank than a group on level 5 that has a score
2439 of 300. (The level is the most significant part and the score is the
2440 least significant part.))
2442 @findex gnus-summary-bubble-group
2443 If you want groups you read often to get higher scores than groups you
2444 read seldom you can add the @code{gnus-summary-bubble-group} function to
2445 the @code{gnus-summary-exit-hook} hook. This will result (after
2446 sorting) in a bubbling sort of action. If you want to see that in
2447 action after each summary exit, you can add
2448 @code{gnus-group-sort-groups-by-rank} or
2449 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2450 slow things down somewhat.
2453 @node Marking Groups
2454 @section Marking Groups
2455 @cindex marking groups
2457 If you want to perform some command on several groups, and they appear
2458 subsequently in the group buffer, you would normally just give a
2459 numerical prefix to the command. Most group commands will then do your
2460 bidding on those groups.
2462 However, if the groups are not in sequential order, you can still
2463 perform a command on several groups. You simply mark the groups first
2464 with the process mark and then execute the command.
2472 @findex gnus-group-mark-group
2473 Set the mark on the current group (@code{gnus-group-mark-group}).
2479 @findex gnus-group-unmark-group
2480 Remove the mark from the current group
2481 (@code{gnus-group-unmark-group}).
2485 @findex gnus-group-unmark-all-groups
2486 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2490 @findex gnus-group-mark-region
2491 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2495 @findex gnus-group-mark-buffer
2496 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2500 @findex gnus-group-mark-regexp
2501 Mark all groups that match some regular expression
2502 (@code{gnus-group-mark-regexp}).
2505 Also @pxref{Process/Prefix}.
2507 @findex gnus-group-universal-argument
2508 If you want to execute some command on all groups that have been marked
2509 with the process mark, you can use the @kbd{M-&}
2510 (@code{gnus-group-universal-argument}) command. It will prompt you for
2511 the command to be executed.
2514 @node Foreign Groups
2515 @section Foreign Groups
2516 @cindex foreign groups
2518 Below are some group mode commands for making and editing general foreign
2519 groups, as well as commands to ease the creation of a few
2520 special-purpose groups. All these commands insert the newly created
2521 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2528 @findex gnus-group-make-group
2529 @cindex making groups
2530 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2531 for a name, a method and possibly an @dfn{address}. For an easier way
2532 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2536 @findex gnus-group-read-ephemeral-group
2537 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2538 will prompt you for a name, a method and an @dfn{address}.
2542 @findex gnus-group-rename-group
2543 @cindex renaming groups
2544 Rename the current group to something else
2545 (@code{gnus-group-rename-group}). This is valid only on some
2546 groups---mail groups mostly. This command might very well be quite slow
2552 @findex gnus-group-customize
2553 Customize the group parameters (@code{gnus-group-customize}).
2557 @findex gnus-group-edit-group-method
2558 @cindex renaming groups
2559 Enter a buffer where you can edit the select method of the current
2560 group (@code{gnus-group-edit-group-method}).
2564 @findex gnus-group-edit-group-parameters
2565 Enter a buffer where you can edit the group parameters
2566 (@code{gnus-group-edit-group-parameters}).
2570 @findex gnus-group-edit-group
2571 Enter a buffer where you can edit the group info
2572 (@code{gnus-group-edit-group}).
2576 @findex gnus-group-make-directory-group
2578 Make a directory group (@pxref{Directory Groups}). You will be prompted
2579 for a directory name (@code{gnus-group-make-directory-group}).
2584 @findex gnus-group-make-help-group
2585 Make the gnus help group (@code{gnus-group-make-help-group}).
2589 @cindex (ding) archive
2590 @cindex archive group
2591 @findex gnus-group-make-archive-group
2592 @vindex gnus-group-archive-directory
2593 @vindex gnus-group-recent-archive-directory
2594 Make a gnus archive group (@code{gnus-group-make-archive-group}). By
2595 default a group pointing to the most recent articles will be created
2596 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2597 group will be created from @code{gnus-group-archive-directory}.
2601 @findex gnus-group-make-kiboze-group
2603 Make a kiboze group. You will be prompted for a name, for a regexp to
2604 match groups to be ``included'' in the kiboze group, and a series of
2605 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2606 @xref{Kibozed Groups}.
2610 @findex gnus-group-enter-directory
2612 Read an arbitrary directory as if it were a newsgroup with the
2613 @code{nneething} back end (@code{gnus-group-enter-directory}).
2614 @xref{Anything Groups}.
2618 @findex gnus-group-make-doc-group
2619 @cindex ClariNet Briefs
2621 Make a group based on some file or other
2622 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2623 command, you will be prompted for a file name and a file type.
2624 Currently supported types are @code{mbox}, @code{babyl},
2625 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2626 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2627 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2628 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2629 you run this command without a prefix, Gnus will guess at the file
2630 type. @xref{Document Groups}.
2634 @vindex gnus-useful-groups
2635 @findex gnus-group-make-useful-group
2636 Create one of the groups mentioned in @code{gnus-useful-groups}
2637 (@code{gnus-group-make-useful-group}).
2641 @findex gnus-group-make-web-group
2645 Make an ephemeral group based on a web search
2646 (@code{gnus-group-make-web-group}). If you give a prefix to this
2647 command, make a solid group instead. You will be prompted for the
2648 search engine type and the search string. Valid search engine types
2649 include @code{google}, @code{dejanews}, and @code{gmane}.
2650 @xref{Web Searches}.
2652 If you use the @code{google} search engine, you can limit the search
2653 to a particular group by using a match string like
2654 @samp{shaving group:alt.sysadmin.recovery}.
2658 @findex gnus-group-make-rss-group
2659 Make a group based on an @acronym{RSS} feed
2660 (@code{gnus-group-make-rss-group}). You will be prompted for an URL.
2664 @kindex G DEL (Group)
2665 @findex gnus-group-delete-group
2666 This function will delete the current group
2667 (@code{gnus-group-delete-group}). If given a prefix, this function will
2668 actually delete all the articles in the group, and forcibly remove the
2669 group itself from the face of the Earth. Use a prefix only if you are
2670 absolutely sure of what you are doing. This command can't be used on
2671 read-only groups (like @code{nntp} groups), though.
2675 @findex gnus-group-make-empty-virtual
2676 Make a new, fresh, empty @code{nnvirtual} group
2677 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2681 @findex gnus-group-add-to-virtual
2682 Add the current group to an @code{nnvirtual} group
2683 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2686 @xref{Select Methods}, for more information on the various select
2689 @vindex gnus-activate-foreign-newsgroups
2690 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2691 gnus will check all foreign groups with this level or lower at startup.
2692 This might take quite a while, especially if you subscribe to lots of
2693 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2694 @code{gnus-activate-level} also affects activation of foreign
2698 @node Group Parameters
2699 @section Group Parameters
2700 @cindex group parameters
2702 The group parameters store information local to a particular group.
2703 Here's an example group parameter list:
2706 ((to-address . "ding@@gnus.org")
2710 We see that each element consists of a ``dotted pair''---the thing before
2711 the dot is the key, while the thing after the dot is the value. All the
2712 parameters have this form @emph{except} local variable specs, which are
2713 not dotted pairs, but proper lists.
2715 Some parameters have correspondent customizable variables, each of which
2716 is an alist of regexps and values.
2718 The following group parameters can be used:
2723 Address used by when doing followups and new posts.
2726 (to-address . "some@@where.com")
2729 This is primarily useful in mail groups that represent closed mailing
2730 lists---mailing lists where it's expected that everybody that writes to
2731 the mailing list is subscribed to it. Since using this parameter
2732 ensures that the mail only goes to the mailing list itself, it means
2733 that members won't receive two copies of your followups.
2735 Using @code{to-address} will actually work whether the group is foreign
2736 or not. Let's say there's a group on the server that is called
2737 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2738 the articles from a mail-to-news gateway. Posting directly to this
2739 group is therefore impossible---you have to send mail to the mailing
2740 list address instead.
2742 See also @code{gnus-parameter-to-address-alist}.
2746 Address used when doing @kbd{a} in that group.
2749 (to-list . "some@@where.com")
2752 It is totally ignored
2753 when doing a followup---except that if it is present in a news group,
2754 you'll get mail group semantics when doing @kbd{f}.
2756 If you do an @kbd{a} command in a mail group and you have neither a
2757 @code{to-list} group parameter nor a @code{to-address} group parameter,
2758 then a @code{to-list} group parameter will be added automatically upon
2759 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2760 @vindex gnus-add-to-list
2762 @findex gnus-mailing-list-mode
2763 @cindex mail list groups
2764 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2765 entering summary buffer.
2767 See also @code{gnus-parameter-to-list-alist}.
2772 @cindex Mail-Followup-To
2773 @findex gnus-find-subscribed-addresses
2774 If this parameter is set to @code{t}, Gnus will consider the
2775 to-address and to-list parameters for this group as addresses of
2776 mailing lists you are subscribed to. Giving Gnus this information is
2777 (only) a first step in getting it to generate correct Mail-Followup-To
2778 headers for your posts to these lists. The second step is to put the
2779 following in your @file{.gnus.el}
2782 (setq message-subscribed-address-functions
2783 '(gnus-find-subscribed-addresses))
2786 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2787 a complete treatment of available MFT support.
2791 If the group parameter list has the element @code{(visible . t)},
2792 that group will always be visible in the Group buffer, regardless
2793 of whether it has any unread articles.
2795 @item broken-reply-to
2796 @cindex broken-reply-to
2797 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2798 headers in this group are to be ignored, and for the header to be hidden
2799 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2800 can be useful if you're reading a mailing list group where the listserv
2801 has inserted @code{Reply-To} headers that point back to the listserv
2802 itself. That is broken behavior. So there!
2806 Elements like @code{(to-group . "some.group.name")} means that all
2807 posts in that group will be sent to @code{some.group.name}.
2811 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2812 will treat all responses as if they were responses to news articles.
2813 This can be useful if you have a mail group that's really a mirror of a
2818 If @code{(gcc-self . t)} is present in the group parameter list, newly
2819 composed messages will be @code{Gcc}'d to the current group. If
2820 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2821 generated, if @code{(gcc-self . "string")} is present, this string will
2822 be inserted literally as a @code{gcc} header. This parameter takes
2823 precedence over any default @code{Gcc} rules as described later
2824 (@pxref{Archived Messages}).
2826 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2827 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2828 doesn't accept articles.
2832 If the group parameter has an element that looks like @code{(auto-expire
2833 . t)}, all articles read will be marked as expirable. For an
2834 alternative approach, @pxref{Expiring Mail}.
2836 See also @code{gnus-auto-expirable-newsgroups}.
2839 @cindex total-expire
2840 If the group parameter has an element that looks like
2841 @code{(total-expire . t)}, all read articles will be put through the
2842 expiry process, even if they are not marked as expirable. Use with
2843 caution. Unread, ticked and dormant articles are not eligible for
2846 See also @code{gnus-total-expirable-newsgroups}.
2850 @vindex nnmail-expiry-wait-function
2851 If the group parameter has an element that looks like
2852 @code{(expiry-wait . 10)}, this value will override any
2853 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2854 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2855 can either be a number of days (not necessarily an integer) or the
2856 symbols @code{never} or @code{immediate}.
2859 @cindex expiry-target
2860 Where expired messages end up. This parameter overrides
2861 @code{nnmail-expiry-target}.
2864 @cindex score file group parameter
2865 Elements that look like @code{(score-file . "file")} will make
2866 @file{file} into the current score file for the group in question. All
2867 interactive score entries will be put into this file.
2870 @cindex adapt file group parameter
2871 Elements that look like @code{(adapt-file . "file")} will make
2872 @file{file} into the current adaptive file for the group in question.
2873 All adaptive score entries will be put into this file.
2876 @cindex admin-address
2877 When unsubscribing from a mailing list you should never send the
2878 unsubscription notice to the mailing list itself. Instead, you'd send
2879 messages to the administrative address. This parameter allows you to
2880 put the admin address somewhere convenient.
2884 Elements that look like @code{(display . MODE)} say which articles to
2885 display on entering the group. Valid values are:
2889 Display all articles, both read and unread.
2892 Display the last @var{integer} articles in the group. This is the same as
2893 entering the group with @kbd{C-u @var{integer}}.
2896 Display the default visible articles, which normally includes unread and
2900 Display articles that satisfy a predicate.
2902 Here are some examples:
2906 Display only unread articles.
2909 Display everything except expirable articles.
2911 @item [and (not reply) (not expire)]
2912 Display everything except expirable and articles you've already
2916 The available operators are @code{not}, @code{and} and @code{or}.
2917 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2918 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2919 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2920 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2924 The @code{display} parameter works by limiting the summary buffer to
2925 the subset specified. You can pop the limit by using the @kbd{/ w}
2926 command (@pxref{Limiting}).
2930 Elements that look like @code{(comment . "This is a comment")} are
2931 arbitrary comments on the group. You can display comments in the
2932 group line (@pxref{Group Line Specification}).
2936 Elements that look like @code{(charset . iso-8859-1)} will make
2937 @code{iso-8859-1} the default charset; that is, the charset that will be
2938 used for all articles that do not specify a charset.
2940 See also @code{gnus-group-charset-alist}.
2942 @item ignored-charsets
2943 @cindex ignored-charset
2944 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2945 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2946 default charset will be used for decoding articles.
2948 See also @code{gnus-group-ignored-charsets-alist}.
2951 @cindex posting-style
2952 You can store additional posting style information for this group
2953 here (@pxref{Posting Styles}). The format is that of an entry in the
2954 @code{gnus-posting-styles} alist, except that there's no regexp matching
2955 the group name (of course). Style elements in this group parameter will
2956 take precedence over the ones found in @code{gnus-posting-styles}.
2958 For instance, if you want a funky name and signature in this group only,
2959 instead of hacking @code{gnus-posting-styles}, you could put something
2960 like this in the group parameters:
2965 ("X-My-Header" "Funky Value")
2966 (signature "Funky Signature"))
2971 If it is set, the value is used as the method for posting message
2972 instead of @code{gnus-post-method}.
2976 An item like @code{(banner . @var{regexp})} causes any part of an article
2977 that matches the regular expression @var{regexp} to be stripped. Instead of
2978 @var{regexp}, you can also use the symbol @code{signature} which strips the
2979 last signature or any of the elements of the alist
2980 @code{gnus-article-banner-alist}.
2984 This parameter contains a Sieve test that should match incoming mail
2985 that should be placed in this group. From this group parameter, a
2986 Sieve @samp{IF} control structure is generated, having the test as the
2987 condition and @samp{fileinto "group.name";} as the body.
2989 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
2990 address "sender" "sieve-admin@@extundo.com")} group parameter, when
2991 translating the group parameter into a Sieve script (@pxref{Sieve
2992 Commands}) the following Sieve code is generated:
2995 if address "sender" "sieve-admin@@extundo.com" @{
2996 fileinto "INBOX.list.sieve";
3000 To generate tests for multiple email-addresses use a group parameter
3001 like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}.
3002 When generating a sieve script (@pxref{Sieve Commands}) Sieve code
3003 like the following is generated:
3006 if address "sender" ["name@@one.org", "else@@two.org"] @{
3007 fileinto "INBOX.list.sieve";
3011 See @pxref{Sieve Commands} for commands and variables that might be of
3012 interest in relation to the sieve parameter.
3014 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3015 Top, sieve, Emacs Sieve}.
3017 @item (agent parameters)
3018 If the agent has been enabled, you can set any of the its parameters
3019 to control the behavior of the agent in individual groups. See Agent
3020 Parameters in @ref{Category Syntax}. Most users will choose to set
3021 agent parameters in either an agent category or group topic to
3022 minimize the configuration effort.
3024 @item (@var{variable} @var{form})
3025 You can use the group parameters to set variables local to the group you
3026 are entering. If you want to turn threading off in @samp{news.answers},
3027 you could put @code{(gnus-show-threads nil)} in the group parameters of
3028 that group. @code{gnus-show-threads} will be made into a local variable
3029 in the summary buffer you enter, and the form @code{nil} will be
3030 @code{eval}ed there.
3032 Note that this feature sets the variable locally to the summary buffer.
3033 But some variables are evaluated in the article buffer, or in the
3034 message buffer (of a reply or followup or otherwise newly created
3035 message). As a workaround, it might help to add the variable in
3036 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3037 Stuff}. So if you want to set @code{message-from-style} via the group
3038 parameters, then you may need the following statement elsewhere in your
3039 @file{~/.gnus} file:
3042 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3045 @vindex gnus-list-identifiers
3046 A use for this feature is to remove a mailing list identifier tag in
3047 the subject fields of articles. E.g. if the news group
3050 nntp+news.gnus.org:gmane.text.docbook.apps
3053 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3054 tag can be removed from the article subjects in the summary buffer for
3055 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3056 into the group parameters for the group.
3058 This can also be used as a group-specific hook function. If you want to
3059 hear a beep when you enter a group, you could put something like
3060 @code{(dummy-variable (ding))} in the parameters of that group.
3061 @code{dummy-variable} will be set to the (meaningless) result of the
3064 Alternatively, since the VARIABLE becomes local to the group, this
3065 pattern can be used to temporarily change a hook. For example, if the
3066 following is added to a group parameter
3069 (gnus-summary-prepared-hook
3070 '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3073 when the group is entered, the 'd' key will not mark the article as
3078 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3079 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3080 presents you with a Customize-like interface. The latter helps avoid
3081 silly Lisp errors.) You might also be interested in reading about topic
3082 parameters (@pxref{Topic Parameters}).
3084 @vindex gnus-parameters
3085 Group parameters can be set via the @code{gnus-parameters} variable too.
3086 But some variables, such as @code{visible}, have no effect. For
3090 (setq gnus-parameters
3092 (gnus-show-threads nil)
3093 (gnus-use-scoring nil)
3094 (gnus-summary-line-format
3095 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3099 ("^nnimap:\\(foo.bar\\)$"
3103 (gnus-use-scoring t))
3107 (broken-reply-to . t))))
3110 String value of parameters will be subjected to regexp substitution, as
3111 the @code{to-group} example shows.
3114 @node Listing Groups
3115 @section Listing Groups
3116 @cindex group listing
3118 These commands all list various slices of the groups available.
3126 @findex gnus-group-list-groups
3127 List all groups that have unread articles
3128 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3129 command will list only groups of level ARG and lower. By default, it
3130 only lists groups of level five (i.e.,
3131 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3138 @findex gnus-group-list-all-groups
3139 List all groups, whether they have unread articles or not
3140 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3141 this command will list only groups of level ARG and lower. By default,
3142 it lists groups of level seven or lower (i.e., just subscribed and
3143 unsubscribed groups).
3147 @findex gnus-group-list-level
3148 List all unread groups on a specific level
3149 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3150 with no unread articles.
3154 @findex gnus-group-list-killed
3155 List all killed groups (@code{gnus-group-list-killed}). If given a
3156 prefix argument, really list all groups that are available, but aren't
3157 currently (un)subscribed. This could entail reading the active file
3162 @findex gnus-group-list-zombies
3163 List all zombie groups (@code{gnus-group-list-zombies}).
3167 @findex gnus-group-list-matching
3168 List all unread, subscribed groups with names that match a regexp
3169 (@code{gnus-group-list-matching}).
3173 @findex gnus-group-list-all-matching
3174 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3178 @findex gnus-group-list-active
3179 List absolutely all groups in the active file(s) of the
3180 server(s) you are connected to (@code{gnus-group-list-active}). This
3181 might very well take quite a while. It might actually be a better idea
3182 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3183 thing to match on. Also note that this command may list groups that
3184 don't exist (yet)---these will be listed as if they were killed groups.
3185 Take the output with some grains of salt.
3189 @findex gnus-group-apropos
3190 List all groups that have names that match a regexp
3191 (@code{gnus-group-apropos}).
3195 @findex gnus-group-description-apropos
3196 List all groups that have names or descriptions that match a regexp
3197 (@code{gnus-group-description-apropos}).
3201 @findex gnus-group-list-cached
3202 List all groups with cached articles (@code{gnus-group-list-cached}).
3206 @findex gnus-group-list-dormant
3207 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3211 @findex gnus-group-list-limit
3212 List groups limited within the current selection
3213 (@code{gnus-group-list-limit}).
3217 @findex gnus-group-list-flush
3218 Flush groups from the current selection (@code{gnus-group-list-flush}).
3222 @findex gnus-group-list-plus
3223 List groups plus the current selection (@code{gnus-group-list-plus}).
3227 @vindex gnus-permanently-visible-groups
3228 @cindex visible group parameter
3229 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3230 always be shown, whether they have unread articles or not. You can also
3231 add the @code{visible} element to the group parameters in question to
3232 get the same effect.
3234 @vindex gnus-list-groups-with-ticked-articles
3235 Groups that have just ticked articles in it are normally listed in the
3236 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3237 @code{nil}, these groups will be treated just like totally empty
3238 groups. It is @code{t} by default.
3241 @node Sorting Groups
3242 @section Sorting Groups
3243 @cindex sorting groups
3245 @kindex C-c C-s (Group)
3246 @findex gnus-group-sort-groups
3247 @vindex gnus-group-sort-function
3248 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3249 group buffer according to the function(s) given by the
3250 @code{gnus-group-sort-function} variable. Available sorting functions
3255 @item gnus-group-sort-by-alphabet
3256 @findex gnus-group-sort-by-alphabet
3257 Sort the group names alphabetically. This is the default.
3259 @item gnus-group-sort-by-real-name
3260 @findex gnus-group-sort-by-real-name
3261 Sort the group alphabetically on the real (unprefixed) group names.
3263 @item gnus-group-sort-by-level
3264 @findex gnus-group-sort-by-level
3265 Sort by group level.
3267 @item gnus-group-sort-by-score
3268 @findex gnus-group-sort-by-score
3269 Sort by group score. @xref{Group Score}.
3271 @item gnus-group-sort-by-rank
3272 @findex gnus-group-sort-by-rank
3273 Sort by group score and then the group level. The level and the score
3274 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3276 @item gnus-group-sort-by-unread
3277 @findex gnus-group-sort-by-unread
3278 Sort by number of unread articles.
3280 @item gnus-group-sort-by-method
3281 @findex gnus-group-sort-by-method
3282 Sort alphabetically on the select method.
3284 @item gnus-group-sort-by-server
3285 @findex gnus-group-sort-by-server
3286 Sort alphabetically on the Gnus server name.
3291 @code{gnus-group-sort-function} can also be a list of sorting
3292 functions. In that case, the most significant sort key function must be
3296 There are also a number of commands for sorting directly according to
3297 some sorting criteria:
3301 @kindex G S a (Group)
3302 @findex gnus-group-sort-groups-by-alphabet
3303 Sort the group buffer alphabetically by group name
3304 (@code{gnus-group-sort-groups-by-alphabet}).
3307 @kindex G S u (Group)
3308 @findex gnus-group-sort-groups-by-unread
3309 Sort the group buffer by the number of unread articles
3310 (@code{gnus-group-sort-groups-by-unread}).
3313 @kindex G S l (Group)
3314 @findex gnus-group-sort-groups-by-level
3315 Sort the group buffer by group level
3316 (@code{gnus-group-sort-groups-by-level}).
3319 @kindex G S v (Group)
3320 @findex gnus-group-sort-groups-by-score
3321 Sort the group buffer by group score
3322 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3325 @kindex G S r (Group)
3326 @findex gnus-group-sort-groups-by-rank
3327 Sort the group buffer by group rank
3328 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3331 @kindex G S m (Group)
3332 @findex gnus-group-sort-groups-by-method
3333 Sort the group buffer alphabetically by back end name@*
3334 (@code{gnus-group-sort-groups-by-method}).
3337 @kindex G S n (Group)
3338 @findex gnus-group-sort-groups-by-real-name
3339 Sort the group buffer alphabetically by real (unprefixed) group name
3340 (@code{gnus-group-sort-groups-by-real-name}).
3344 All the commands below obey the process/prefix convention
3345 (@pxref{Process/Prefix}).
3347 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3348 commands will sort in reverse order.
3350 You can also sort a subset of the groups:
3354 @kindex G P a (Group)
3355 @findex gnus-group-sort-selected-groups-by-alphabet
3356 Sort the groups alphabetically by group name
3357 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3360 @kindex G P u (Group)
3361 @findex gnus-group-sort-selected-groups-by-unread
3362 Sort the groups by the number of unread articles
3363 (@code{gnus-group-sort-selected-groups-by-unread}).
3366 @kindex G P l (Group)
3367 @findex gnus-group-sort-selected-groups-by-level
3368 Sort the groups by group level
3369 (@code{gnus-group-sort-selected-groups-by-level}).
3372 @kindex G P v (Group)
3373 @findex gnus-group-sort-selected-groups-by-score
3374 Sort the groups by group score
3375 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3378 @kindex G P r (Group)
3379 @findex gnus-group-sort-selected-groups-by-rank
3380 Sort the groups by group rank
3381 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3384 @kindex G P m (Group)
3385 @findex gnus-group-sort-selected-groups-by-method
3386 Sort the groups alphabetically by back end name@*
3387 (@code{gnus-group-sort-selected-groups-by-method}).
3390 @kindex G P n (Group)
3391 @findex gnus-group-sort-selected-groups-by-real-name
3392 Sort the groups alphabetically by real (unprefixed) group name
3393 (@code{gnus-group-sort-selected-groups-by-real-name}).
3396 @kindex G P s (Group)
3397 @findex gnus-group-sort-selected-groups
3398 Sort the groups according to @code{gnus-group-sort-function}.
3402 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3406 @node Group Maintenance
3407 @section Group Maintenance
3408 @cindex bogus groups
3413 @findex gnus-group-check-bogus-groups
3414 Find bogus groups and delete them
3415 (@code{gnus-group-check-bogus-groups}).
3419 @findex gnus-group-find-new-groups
3420 Find new groups and process them (@code{gnus-group-find-new-groups}).
3421 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3422 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3423 to query the server for new groups, and subscribe the new groups as
3427 @kindex C-c C-x (Group)
3428 @findex gnus-group-expire-articles
3429 Run all expirable articles in the current group through the expiry
3430 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3431 all expirable articles in the group that have been around for a while.
3432 (@pxref{Expiring Mail}).
3435 @kindex C-c C-M-x (Group)
3436 @findex gnus-group-expire-all-groups
3437 Run all expirable articles in all groups through the expiry process
3438 (@code{gnus-group-expire-all-groups}).
3443 @node Browse Foreign Server
3444 @section Browse Foreign Server
3445 @cindex foreign servers
3446 @cindex browsing servers
3451 @findex gnus-group-browse-foreign-server
3452 You will be queried for a select method and a server name. Gnus will
3453 then attempt to contact this server and let you browse the groups there
3454 (@code{gnus-group-browse-foreign-server}).
3457 @findex gnus-browse-mode
3458 A new buffer with a list of available groups will appear. This buffer
3459 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3460 a lot) like a normal group buffer.
3462 Here's a list of keystrokes available in the browse mode:
3467 @findex gnus-group-next-group
3468 Go to the next group (@code{gnus-group-next-group}).
3472 @findex gnus-group-prev-group
3473 Go to the previous group (@code{gnus-group-prev-group}).
3476 @kindex SPACE (Browse)
3477 @findex gnus-browse-read-group
3478 Enter the current group and display the first article
3479 (@code{gnus-browse-read-group}).
3482 @kindex RET (Browse)
3483 @findex gnus-browse-select-group
3484 Enter the current group (@code{gnus-browse-select-group}).
3488 @findex gnus-browse-unsubscribe-current-group
3489 Unsubscribe to the current group, or, as will be the case here,
3490 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3496 @findex gnus-browse-exit
3497 Exit browse mode (@code{gnus-browse-exit}).
3501 @findex gnus-browse-describe-group
3502 Describe the current group (@code{gnus-browse-describe-group}).
3506 @findex gnus-browse-describe-briefly
3507 Describe browse mode briefly (well, there's not much to describe, is
3508 there) (@code{gnus-browse-describe-briefly}).
3513 @section Exiting gnus
3514 @cindex exiting gnus
3516 Yes, gnus is ex(c)iting.
3521 @findex gnus-group-suspend
3522 Suspend gnus (@code{gnus-group-suspend}). This doesn't really exit gnus,
3523 but it kills all buffers except the Group buffer. I'm not sure why this
3524 is a gain, but then who am I to judge?
3528 @findex gnus-group-exit
3529 @c @icon{gnus-group-exit}
3530 Quit gnus (@code{gnus-group-exit}).
3534 @findex gnus-group-quit
3535 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3536 The dribble file will be saved, though (@pxref{Auto Save}).
3539 @vindex gnus-exit-gnus-hook
3540 @vindex gnus-suspend-gnus-hook
3541 @vindex gnus-after-exiting-gnus-hook
3542 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3543 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3544 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3550 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3551 numbly heavy and herself fall into a hazy trance as the boy sitting
3552 behind her drew repeated lines with his pencil across the back of her
3558 @section Group Topics
3561 If you read lots and lots of groups, it might be convenient to group
3562 them hierarchically according to topics. You put your Emacs groups over
3563 here, your sex groups over there, and the rest (what, two groups or so?)
3564 you put in some misc section that you never bother with anyway. You can
3565 even group the Emacs sex groups as a sub-topic to either the Emacs
3566 groups or the sex groups---or both! Go wild!
3570 \gnusfigure{Group Topics}{400}{
3571 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3582 2: alt.religion.emacs
3585 0: comp.talk.emacs.recovery
3587 8: comp.binaries.fractals
3588 13: comp.sources.unix
3591 @findex gnus-topic-mode
3593 To get this @emph{fab} functionality you simply turn on (ooh!) the
3594 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3595 is a toggling command.)
3597 Go ahead, just try it. I'll still be here when you get back. La de
3598 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3599 Yes, and now press @kbd{l}. There. All your groups are now listed
3600 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3603 If you want this permanently enabled, you should add that minor mode to
3604 the hook for the group mode. Put the following line in your
3605 @file{~/.gnus.el} file:
3608 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3612 * Topic Commands:: Interactive E-Z commands.
3613 * Topic Variables:: How to customize the topics the Lisp Way.
3614 * Topic Sorting:: Sorting each topic individually.
3615 * Topic Topology:: A map of the world.
3616 * Topic Parameters:: Parameters that apply to all groups in a topic.
3620 @node Topic Commands
3621 @subsection Topic Commands
3622 @cindex topic commands
3624 When the topic minor mode is turned on, a new @kbd{T} submap will be
3625 available. In addition, a few of the standard keys change their
3626 definitions slightly.
3628 In general, the following kinds of operations are possible on topics.
3629 First of all, you want to create topics. Secondly, you want to put
3630 groups in topics and to move them around until you have an order you
3631 like. The third kind of operation is to show/hide parts of the whole
3632 shebang. You might want to hide a topic including its subtopics and
3633 groups, to get a better overview of the other groups.
3635 Here is a list of the basic keys that you might need to set up topics
3642 @findex gnus-topic-create-topic
3643 Prompt for a new topic name and create it
3644 (@code{gnus-topic-create-topic}).
3648 @kindex T TAB (Topic)
3650 @findex gnus-topic-indent
3651 ``Indent'' the current topic so that it becomes a sub-topic of the
3652 previous topic (@code{gnus-topic-indent}). If given a prefix,
3653 ``un-indent'' the topic instead.
3656 @kindex M-TAB (Topic)
3657 @findex gnus-topic-unindent
3658 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3659 parent of its current parent (@code{gnus-topic-unindent}).
3663 The following two keys can be used to move groups and topics around.
3664 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3665 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3666 kill and yank rather than cut and paste.
3672 @findex gnus-topic-kill-group
3673 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3674 topic will be removed along with the topic.
3678 @findex gnus-topic-yank-group
3679 Yank the previously killed group or topic
3680 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3683 So, to move a topic to the beginning of the list of topics, just hit
3684 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3685 move the cursor to the beginning of the buffer (just below the ``Gnus''
3686 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3687 paste. Like I said -- E-Z.
3689 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3690 you can move topics around as well as groups.
3694 After setting up the topics the way you like them, you might wish to
3695 hide a topic, or to show it again. That's why we have the following
3702 @findex gnus-topic-select-group
3704 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3705 When you perform this command on a group, you'll enter the group, as
3706 usual. When done on a topic line, the topic will be folded (if it was
3707 visible) or unfolded (if it was folded already). So it's basically a
3708 toggling command on topics. In addition, if you give a numerical
3709 prefix, group on that level (and lower) will be displayed.
3713 Now for a list of other commands, in no particular order.
3719 @findex gnus-topic-move-group
3720 Move the current group to some other topic
3721 (@code{gnus-topic-move-group}). This command uses the process/prefix
3722 convention (@pxref{Process/Prefix}).
3726 @findex gnus-topic-jump-to-topic
3727 Go to a topic (@code{gnus-topic-jump-to-topic}).
3731 @findex gnus-topic-copy-group
3732 Copy the current group to some other topic
3733 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3734 convention (@pxref{Process/Prefix}).
3738 @findex gnus-topic-hide-topic
3739 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3740 a prefix, hide the topic permanently.
3744 @findex gnus-topic-show-topic
3745 Show the current topic (@code{gnus-topic-show-topic}). If given
3746 a prefix, show the topic permanently.
3750 @findex gnus-topic-remove-group
3751 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3752 This command is mainly useful if you have the same group in several
3753 topics and wish to remove it from one of the topics. You may also
3754 remove a group from all topics, but in that case, Gnus will add it to
3755 the root topic the next time you start Gnus. In fact, all new groups
3756 (which, naturally, don't belong to any topic) will show up in the root
3759 This command uses the process/prefix convention
3760 (@pxref{Process/Prefix}).
3764 @findex gnus-topic-move-matching
3765 Move all groups that match some regular expression to a topic
3766 (@code{gnus-topic-move-matching}).
3770 @findex gnus-topic-copy-matching
3771 Copy all groups that match some regular expression to a topic
3772 (@code{gnus-topic-copy-matching}).
3776 @findex gnus-topic-toggle-display-empty-topics
3777 Toggle hiding empty topics
3778 (@code{gnus-topic-toggle-display-empty-topics}).
3782 @findex gnus-topic-mark-topic
3783 Mark all groups in the current topic with the process mark
3784 (@code{gnus-topic-mark-topic}). This command works recursively on
3785 sub-topics unless given a prefix.
3788 @kindex T M-# (Topic)
3789 @findex gnus-topic-unmark-topic
3790 Remove the process mark from all groups in the current topic
3791 (@code{gnus-topic-unmark-topic}). This command works recursively on
3792 sub-topics unless given a prefix.
3795 @kindex C-c C-x (Topic)
3796 @findex gnus-topic-expire-articles
3797 Run all expirable articles in the current group or topic through the
3798 expiry process (if any)
3799 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3803 @findex gnus-topic-rename
3804 Rename a topic (@code{gnus-topic-rename}).
3807 @kindex T DEL (Topic)
3808 @findex gnus-topic-delete
3809 Delete an empty topic (@code{gnus-topic-delete}).
3813 @findex gnus-topic-list-active
3814 List all groups that gnus knows about in a topics-ified way
3815 (@code{gnus-topic-list-active}).
3818 @kindex T M-n (Topic)
3819 @findex gnus-topic-goto-next-topic
3820 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3823 @kindex T M-p (Topic)
3824 @findex gnus-topic-goto-previous-topic
3825 Go to the previous topic (@code{gnus-topic-goto-previous-topic}).
3829 @findex gnus-topic-edit-parameters
3830 @cindex group parameters
3831 @cindex topic parameters
3833 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3834 @xref{Topic Parameters}.
3839 @node Topic Variables
3840 @subsection Topic Variables
3841 @cindex topic variables
3843 The previous section told you how to tell Gnus which topics to display.
3844 This section explains how to tell Gnus what to display about each topic.
3846 @vindex gnus-topic-line-format
3847 The topic lines themselves are created according to the
3848 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3861 Number of groups in the topic.
3863 Number of unread articles in the topic.
3865 Number of unread articles in the topic and all its subtopics.
3868 @vindex gnus-topic-indent-level
3869 Each sub-topic (and the groups in the sub-topics) will be indented with
3870 @code{gnus-topic-indent-level} times the topic level number of spaces.
3873 @vindex gnus-topic-mode-hook
3874 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3876 @vindex gnus-topic-display-empty-topics
3877 The @code{gnus-topic-display-empty-topics} says whether to display even
3878 topics that have no unread articles in them. The default is @code{t}.
3882 @subsection Topic Sorting
3883 @cindex topic sorting
3885 You can sort the groups in each topic individually with the following
3891 @kindex T S a (Topic)
3892 @findex gnus-topic-sort-groups-by-alphabet
3893 Sort the current topic alphabetically by group name
3894 (@code{gnus-topic-sort-groups-by-alphabet}).
3897 @kindex T S u (Topic)
3898 @findex gnus-topic-sort-groups-by-unread
3899 Sort the current topic by the number of unread articles
3900 (@code{gnus-topic-sort-groups-by-unread}).
3903 @kindex T S l (Topic)
3904 @findex gnus-topic-sort-groups-by-level
3905 Sort the current topic by group level
3906 (@code{gnus-topic-sort-groups-by-level}).
3909 @kindex T S v (Topic)
3910 @findex gnus-topic-sort-groups-by-score
3911 Sort the current topic by group score
3912 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3915 @kindex T S r (Topic)
3916 @findex gnus-topic-sort-groups-by-rank
3917 Sort the current topic by group rank
3918 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3921 @kindex T S m (Topic)
3922 @findex gnus-topic-sort-groups-by-method
3923 Sort the current topic alphabetically by back end name
3924 (@code{gnus-topic-sort-groups-by-method}).
3927 @kindex T S e (Topic)
3928 @findex gnus-topic-sort-groups-by-server
3929 Sort the current topic alphabetically by server name
3930 (@code{gnus-topic-sort-groups-by-server}).
3933 @kindex T S s (Topic)
3934 @findex gnus-topic-sort-groups
3935 Sort the current topic according to the function(s) given by the
3936 @code{gnus-group-sort-function} variable
3937 (@code{gnus-topic-sort-groups}).
3941 When given a prefix argument, all these commands will sort in reverse
3942 order. @xref{Sorting Groups}, for more information about group
3946 @node Topic Topology
3947 @subsection Topic Topology
3948 @cindex topic topology
3951 So, let's have a look at an example group buffer:
3958 2: alt.religion.emacs
3961 0: comp.talk.emacs.recovery
3963 8: comp.binaries.fractals
3964 13: comp.sources.unix
3968 So, here we have one top-level topic (@samp{Gnus}), two topics under
3969 that, and one sub-topic under one of the sub-topics. (There is always
3970 just one (1) top-level topic). This topology can be expressed as
3975 (("Emacs -- I wuw it!" visible)
3976 (("Naughty Emacs" visible)))
3980 @vindex gnus-topic-topology
3981 This is in fact how the variable @code{gnus-topic-topology} would look
3982 for the display above. That variable is saved in the @file{.newsrc.eld}
3983 file, and shouldn't be messed with manually---unless you really want
3984 to. Since this variable is read from the @file{.newsrc.eld} file,
3985 setting it in any other startup files will have no effect.
3987 This topology shows what topics are sub-topics of what topics (right),
3988 and which topics are visible. Two settings are currently
3989 allowed---@code{visible} and @code{invisible}.
3992 @node Topic Parameters
3993 @subsection Topic Parameters
3994 @cindex topic parameters
3996 All groups in a topic will inherit group parameters from the parent
3997 (and ancestor) topic parameters. All valid group parameters are valid
3998 topic parameters (@pxref{Group Parameters}). When the agent is
3999 enabled, all agent parameters (See Agent Parameters in @ref{Category
4000 Syntax}) are also valid topic parameters.
4002 In addition, the following parameters are only valid as topic
4007 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4008 @code{subscribe} topic parameter says what groups go in what topic. Its
4009 value should be a regexp to match the groups that should go in that
4012 @item subscribe-level
4013 When subscribing new groups by topic (see the @code{subscribe} parameter),
4014 the group will be subscribed with the level specified in the
4015 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4019 Group parameters (of course) override topic parameters, and topic
4020 parameters in sub-topics override topic parameters in super-topics. You
4021 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4022 verb, although you may feel free to disagree with me here.)
4029 2: alt.religion.emacs
4033 0: comp.talk.emacs.recovery
4035 8: comp.binaries.fractals
4036 13: comp.sources.unix
4041 The @samp{Emacs} topic has the topic parameter @code{(score-file
4042 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4043 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4044 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4045 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4046 . "religion.SCORE")}.
4048 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4049 will get the @file{relief.SCORE} home score file. If you enter the same
4050 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4051 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4052 get the @file{religion.SCORE} home score file.
4054 This seems rather simple and self-evident, doesn't it? Well, yes. But
4055 there are some problems, especially with the @code{total-expiry}
4056 parameter. Say you have a mail group in two topics; one with
4057 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4058 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4059 of these topics you mean to expire articles from, so anything may
4060 happen. In fact, I hereby declare that it is @dfn{undefined} what
4061 happens. You just have to be careful if you do stuff like that.
4064 @node Misc Group Stuff
4065 @section Misc Group Stuff
4068 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4069 * Group Information:: Information and help on groups and Gnus.
4070 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4071 * File Commands:: Reading and writing the Gnus files.
4072 * Sieve Commands:: Managing Sieve scripts.
4079 @findex gnus-group-enter-server-mode
4080 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4081 @xref{Server Buffer}.
4085 @findex gnus-group-post-news
4086 Start composing a message (a news by default)
4087 (@code{gnus-group-post-news}). If given a prefix, post to the group
4088 under the point. If the prefix is 1, prompt for a group to post to.
4089 Contrary to what the name of this function suggests, the prepared
4090 article might be a mail instead of a news, if a mail group is specified
4091 with the prefix argument. @xref{Composing Messages}.
4095 @findex gnus-group-mail
4096 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4097 use the posting style of the group under the point. If the prefix is 1,
4098 prompt for a group name to find the posting style.
4099 @xref{Composing Messages}.
4103 @findex gnus-group-news
4104 Start composing a news (@code{gnus-group-news}). If given a prefix,
4105 post to the group under the point. If the prefix is 1, prompt
4106 for group to post to. @xref{Composing Messages}.
4108 This function actually prepares a news even when using mail groups.
4109 This is useful for ``posting'' messages to mail groups without actually
4110 sending them over the network: they're just saved directly to the group
4111 in question. The corresponding back end must have a request-post method
4112 for this to work though.
4116 Variables for the group buffer:
4120 @item gnus-group-mode-hook
4121 @vindex gnus-group-mode-hook
4122 is called after the group buffer has been
4125 @item gnus-group-prepare-hook
4126 @vindex gnus-group-prepare-hook
4127 is called after the group buffer is
4128 generated. It may be used to modify the buffer in some strange,
4131 @item gnus-group-prepared-hook
4132 @vindex gnus-group-prepare-hook
4133 is called as the very last thing after the group buffer has been
4134 generated. It may be used to move point around, for instance.
4136 @item gnus-permanently-visible-groups
4137 @vindex gnus-permanently-visible-groups
4138 Groups matching this regexp will always be listed in the group buffer,
4139 whether they are empty or not.
4141 @item gnus-group-name-charset-method-alist
4142 @vindex gnus-group-name-charset-method-alist
4143 An alist of method and the charset for group names. It is used to show
4144 non-@acronym{ASCII} group names.
4148 (setq gnus-group-name-charset-method-alist
4149 '(((nntp "news.com.cn") . cn-gb-2312)))
4152 @item gnus-group-name-charset-group-alist
4153 @cindex UTF-8 group names
4154 @vindex gnus-group-name-charset-group-alist
4155 An alist of regexp of group name and the charset for group names. It
4156 is used to show non-@acronym{ASCII} group names. @code{((".*"
4157 utf-8))} is the default value if UTF-8 is supported, otherwise the
4158 default is @code{nil}.
4162 (setq gnus-group-name-charset-group-alist
4163 '(("\\.com\\.cn:" . cn-gb-2312)))
4168 @node Scanning New Messages
4169 @subsection Scanning New Messages
4170 @cindex new messages
4171 @cindex scanning new news
4177 @findex gnus-group-get-new-news
4178 @c @icon{gnus-group-get-new-news}
4179 Check the server(s) for new articles. If the numerical prefix is used,
4180 this command will check only groups of level @var{arg} and lower
4181 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4182 command will force a total re-reading of the active file(s) from the
4187 @findex gnus-group-get-new-news-this-group
4188 @vindex gnus-goto-next-group-when-activating
4189 @c @icon{gnus-group-get-new-news-this-group}
4190 Check whether new articles have arrived in the current group
4191 (@code{gnus-group-get-new-news-this-group}).
4192 @code{gnus-goto-next-group-when-activating} says whether this command is
4193 to move point to the next group or not. It is @code{t} by default.
4195 @findex gnus-activate-all-groups
4196 @cindex activating groups
4198 @kindex C-c M-g (Group)
4199 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4204 @findex gnus-group-restart
4205 Restart gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4206 file(s), closes the connection to all servers, clears up all run-time
4207 gnus variables, and then starts gnus all over again.
4211 @vindex gnus-get-new-news-hook
4212 @code{gnus-get-new-news-hook} is run just before checking for new news.
4214 @vindex gnus-after-getting-new-news-hook
4215 @code{gnus-after-getting-new-news-hook} is run after checking for new
4219 @node Group Information
4220 @subsection Group Information
4221 @cindex group information
4222 @cindex information on groups
4229 @findex gnus-group-fetch-faq
4230 @vindex gnus-group-faq-directory
4233 Try to fetch the @acronym{FAQ} for the current group
4234 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4235 from @code{gnus-group-faq-directory}, which is usually a directory on
4236 a remote machine. This variable can also be a list of directories.
4237 In that case, giving a prefix to this command will allow you to choose
4238 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4239 used for fetching the file.
4241 If fetching from the first site is unsuccessful, gnus will attempt to go
4242 through @code{gnus-group-faq-directory} and try to open them one by one.
4246 @findex gnus-group-fetch-charter
4247 @vindex gnus-group-charter-alist
4249 Try to open the charter for the current group in a web browser
4250 (@code{gnus-group-fetch-charter}). Query for a group if given a
4253 Gnus will use @code{gnus-group-charter-alist} to find the location of
4254 the charter. If no location is known, Gnus will fetch the control
4255 messages for the group, which in some cases includes the charter.
4259 @findex gnus-group-fetch-control
4260 @vindex gnus-group-fetch-control-use-browse-url
4261 @cindex control message
4262 Fetch the control messages for the group from the archive at
4263 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4264 group if given a prefix argument.
4266 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4267 Gnus will open the control messages in a browser using
4268 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4269 and displayed in an ephemeral group.
4271 Note that the control messages are compressed. To use this command
4272 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4273 Files, ,Compressed Files, emacs, The Emacs Manual}).
4277 @c @icon{gnus-group-describe-group}
4279 @kindex C-c C-d (Group)
4280 @cindex describing groups
4281 @cindex group description
4282 @findex gnus-group-describe-group
4283 Describe the current group (@code{gnus-group-describe-group}). If given
4284 a prefix, force Gnus to re-read the description from the server.
4288 @findex gnus-group-describe-all-groups
4289 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4290 prefix, force gnus to re-read the description file from the server.
4297 @findex gnus-version
4298 Display current gnus version numbers (@code{gnus-version}).
4302 @findex gnus-group-describe-briefly
4303 Give a very short help message (@code{gnus-group-describe-briefly}).
4306 @kindex C-c C-i (Group)
4309 @findex gnus-info-find-node
4310 Go to the gnus info node (@code{gnus-info-find-node}).
4314 @node Group Timestamp
4315 @subsection Group Timestamp
4317 @cindex group timestamps
4319 It can be convenient to let gnus keep track of when you last read a
4320 group. To set the ball rolling, you should add
4321 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4324 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4327 After doing this, each time you enter a group, it'll be recorded.
4329 This information can be displayed in various ways---the easiest is to
4330 use the @samp{%d} spec in the group line format:
4333 (setq gnus-group-line-format
4334 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4337 This will result in lines looking like:
4340 * 0: mail.ding 19961002T012943
4341 0: custom 19961002T012713
4344 As you can see, the date is displayed in compact ISO 8601 format. This
4345 may be a bit too much, so to just display the date, you could say
4349 (setq gnus-group-line-format
4350 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4353 If you would like greater control of the time format, you can use a
4354 user-defined format spec. Something like the following should do the
4358 (setq gnus-group-line-format
4359 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4360 (defun gnus-user-format-function-d (headers)
4361 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4363 (format-time-string "%b %d %H:%M" time)
4369 @subsection File Commands
4370 @cindex file commands
4376 @findex gnus-group-read-init-file
4377 @vindex gnus-init-file
4378 @cindex reading init file
4379 Re-read the init file (@code{gnus-init-file}, which defaults to
4380 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4384 @findex gnus-group-save-newsrc
4385 @cindex saving .newsrc
4386 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4387 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4388 file(s) whether Gnus thinks it is necessary or not.
4391 @c @kindex Z (Group)
4392 @c @findex gnus-group-clear-dribble
4393 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4398 @node Sieve Commands
4399 @subsection Sieve Commands
4400 @cindex group sieve commands
4402 Sieve is a server-side mail filtering language. In Gnus you can use
4403 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4404 sieve rules that should apply to each group. Gnus provides two
4405 commands to translate all these group parameters into a proper Sieve
4406 script that can be transfered to the server somehow.
4408 @vindex gnus-sieve-file
4409 @vindex gnus-sieve-region-start
4410 @vindex gnus-sieve-region-end
4411 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4412 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4413 between two delimiters, @code{gnus-sieve-region-start} and
4414 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4415 outside these delimiters that will not be removed the next time you
4416 regenerate the Sieve script.
4418 @vindex gnus-sieve-crosspost
4419 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4420 is generated. If it is non-@code{nil} (the default) articles is
4421 placed in all groups that have matching rules, otherwise the article
4422 is only placed in the group with the first matching rule. For
4423 example, the group parameter @samp{(sieve address "sender"
4424 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4425 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4426 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4427 except that the line containing the call to @code{stop} is removed.)
4430 if address "sender" "owner-ding@@hpc.uh.edu" @{
4431 fileinto "INBOX.ding";
4436 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4442 @findex gnus-sieve-generate
4443 @vindex gnus-sieve-file
4444 @cindex generating sieve script
4445 Regenerate a Sieve script from the @code{sieve} group parameters and
4446 put you into the @code{gnus-sieve-file} without saving it.
4450 @findex gnus-sieve-update
4451 @vindex gnus-sieve-file
4452 @cindex updating sieve script
4453 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4454 @code{sieve} group parameters, save the file and upload it to the
4455 server using the @code{sieveshell} program.
4460 @node Summary Buffer
4461 @chapter Summary Buffer
4462 @cindex summary buffer
4464 A line for each article is displayed in the summary buffer. You can
4465 move around, read articles, post articles and reply to articles.
4467 The most common way to a summary buffer is to select a group from the
4468 group buffer (@pxref{Selecting a Group}).
4470 You can have as many summary buffers open as you wish.
4473 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4474 * Summary Maneuvering:: Moving around the summary buffer.
4475 * Choosing Articles:: Reading articles.
4476 * Paging the Article:: Scrolling the current article.
4477 * Reply Followup and Post:: Posting articles.
4478 * Delayed Articles:: Send articles at a later time.
4479 * Marking Articles:: Marking articles as read, expirable, etc.
4480 * Limiting:: You can limit the summary buffer.
4481 * Threading:: How threads are made.
4482 * Sorting the Summary Buffer:: How articles and threads are sorted.
4483 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4484 * Article Caching:: You may store articles in a cache.
4485 * Persistent Articles:: Making articles expiry-resistant.
4486 * Article Backlog:: Having already read articles hang around.
4487 * Saving Articles:: Ways of customizing article saving.
4488 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4489 * Article Treatment:: The article buffer can be mangled at will.
4490 * MIME Commands:: Doing MIMEy things with the articles.
4491 * Charsets:: Character set issues.
4492 * Article Commands:: Doing various things with the article buffer.
4493 * Summary Sorting:: Sorting the summary buffer in various ways.
4494 * Finding the Parent:: No child support? Get the parent.
4495 * Alternative Approaches:: Reading using non-default summaries.
4496 * Tree Display:: A more visual display of threads.
4497 * Mail Group Commands:: Some commands can only be used in mail groups.
4498 * Various Summary Stuff:: What didn't fit anywhere else.
4499 * Exiting the Summary Buffer:: Returning to the Group buffer,
4500 or reselecting the current group.
4501 * Crosspost Handling:: How crossposted articles are dealt with.
4502 * Duplicate Suppression:: An alternative when crosspost handling fails.
4503 * Security:: Decrypt and Verify.
4504 * Mailing List:: Mailing list minor mode.
4508 @node Summary Buffer Format
4509 @section Summary Buffer Format
4510 @cindex summary buffer format
4514 \gnusfigure{The Summary Buffer}{180}{
4515 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4516 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4522 * Summary Buffer Lines:: You can specify how summary lines should look.
4523 * To From Newsgroups:: How to not display your own name.
4524 * Summary Buffer Mode Line:: You can say how the mode line should look.
4525 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4528 @findex mail-extract-address-components
4529 @findex gnus-extract-address-components
4530 @vindex gnus-extract-address-components
4531 Gnus will use the value of the @code{gnus-extract-address-components}
4532 variable as a function for getting the name and address parts of a
4533 @code{From} header. Three pre-defined functions exist:
4534 @code{gnus-extract-address-components}, which is the default, quite
4535 fast, and too simplistic solution;
4536 @code{mail-extract-address-components}, which works nicely, but is
4537 slower; and @code{std11-extract-address-components}, which works very
4538 nicely, but is slower. The default function will return the wrong
4539 answer in 5% of the cases. If this is unacceptable to you, use the
4540 other function instead:
4543 (setq gnus-extract-address-components
4544 'mail-extract-address-components)
4547 @vindex gnus-summary-same-subject
4548 @code{gnus-summary-same-subject} is a string indicating that the current
4549 article has the same subject as the previous. This string will be used
4550 with those specs that require it. The default is @code{""}.
4553 @node Summary Buffer Lines
4554 @subsection Summary Buffer Lines
4556 @vindex gnus-summary-line-format
4557 You can change the format of the lines in the summary buffer by changing
4558 the @code{gnus-summary-line-format} variable. It works along the same
4559 lines as a normal @code{format} string, with some extensions
4560 (@pxref{Formatting Variables}).
4562 There should always be a colon or a point position marker on the line;
4563 the cursor always moves to the point position marker or the colon after
4564 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4565 possible to change this. Just write a new function
4566 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4567 @xref{Positioning Point}.
4569 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4571 The following format specification characters and extended format
4572 specification(s) are understood:
4578 Subject string. List identifiers stripped,
4579 @code{gnus-list-identifies}. @xref{Article Hiding}.
4581 Subject if the article is the root of the thread or the previous article
4582 had a different subject, @code{gnus-summary-same-subject} otherwise.
4583 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4585 Full @code{From} header.
4587 The name (from the @code{From} header).
4589 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4592 The name (from the @code{From} header). This differs from the @code{n}
4593 spec in that it uses the function designated by the
4594 @code{gnus-extract-address-components} variable, which is slower, but
4595 may be more thorough.
4597 The address (from the @code{From} header). This works the same way as
4600 Number of lines in the article.
4602 Number of characters in the article. This specifier is not supported
4603 in some methods (like nnfolder).
4605 Pretty-printed version of the number of characters in the article;
4606 for example, @samp{1.2k} or @samp{0.4M}.
4608 Indentation based on thread level (@pxref{Customizing Threading}).
4610 A complex trn-style thread tree, showing response-connecting trace
4611 lines. A thread could be drawn like this:
4624 You can customize the appearance with the following options. Note
4625 that it is possible to make the thread display look really neat by
4626 replacing the default @acronym{ASCII} characters with graphic
4627 line-drawing glyphs.
4629 @item gnus-sum-thread-tree-root
4630 @vindex gnus-sum-thread-tree-root
4631 Used for the root of a thread. If @code{nil}, use subject
4632 instead. The default is @samp{> }.
4634 @item gnus-sum-thread-tree-false-root
4635 @vindex gnus-sum-thread-tree-false-root
4636 Used for the false root of a thread (@pxref{Loose Threads}). If
4637 @code{nil}, use subject instead. The default is @samp{> }.
4639 @item gnus-sum-thread-tree-single-indent
4640 @vindex gnus-sum-thread-tree-single-indent
4641 Used for a thread with just one message. If @code{nil}, use subject
4642 instead. The default is @samp{}.
4644 @item gnus-sum-thread-tree-vertical
4645 @vindex gnus-sum-thread-tree-vertical
4646 Used for drawing a vertical line. The default is @samp{| }.
4648 @item gnus-sum-thread-tree-indent
4649 @vindex gnus-sum-thread-tree-indent
4650 Used for indenting. The default is @samp{ }.
4652 @item gnus-sum-thread-tree-leaf-with-other
4653 @vindex gnus-sum-thread-tree-leaf-with-other
4654 Used for a leaf with brothers. The default is @samp{+-> }.
4656 @item gnus-sum-thread-tree-single-leaf
4657 @vindex gnus-sum-thread-tree-single-leaf
4658 Used for a leaf without brothers. The default is @samp{\-> }
4663 Nothing if the article is a root and lots of spaces if it isn't (it
4664 pushes everything after it off the screen).
4666 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4667 for adopted articles (@pxref{Customizing Threading}).
4669 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4670 for adopted articles.
4672 One space for each thread level.
4674 Twenty minus thread level spaces.
4676 Unread. @xref{Read Articles}.
4679 This misleadingly named specifier is the @dfn{secondary mark}. This
4680 mark will say whether the article has been replied to, has been cached,
4681 or has been saved. @xref{Other Marks}.
4684 Score as a number (@pxref{Scoring}).
4686 @vindex gnus-summary-zcore-fuzz
4687 Zcore, @samp{+} if above the default level and @samp{-} if below the
4688 default level. If the difference between
4689 @code{gnus-summary-default-score} and the score is less than
4690 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4698 The @code{Date} in @code{DD-MMM} format.
4700 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4706 Number of articles in the current sub-thread. Using this spec will slow
4707 down summary buffer generation somewhat.
4709 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4710 article has any children.
4716 Age sensitive date format. Various date format is defined in
4717 @code{gnus-user-date-format-alist}.
4719 User defined specifier. The next character in the format string should
4720 be a letter. Gnus will call the function
4721 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4722 following @samp{%u}. The function will be passed the current header as
4723 argument. The function should return a string, which will be inserted
4724 into the summary just like information from any other summary specifier.
4727 Text between @samp{%(} and @samp{%)} will be highlighted with
4728 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4729 There can only be one such area.
4731 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4732 have to be handled with care. For reasons of efficiency, gnus will
4733 compute what column these characters will end up in, and ``hard-code''
4734 that. This means that it is invalid to have these specs after a
4735 variable-length spec. Well, you might not be arrested, but your summary
4736 buffer will look strange, which is bad enough.
4738 The smart choice is to have these specs as far to the left as possible.
4739 (Isn't that the case with everything, though? But I digress.)
4741 This restriction may disappear in later versions of gnus.
4744 @node To From Newsgroups
4745 @subsection To From Newsgroups
4749 In some groups (particularly in archive groups), the @code{From} header
4750 isn't very interesting, since all the articles there are written by
4751 you. To display the information in the @code{To} or @code{Newsgroups}
4752 headers instead, you need to decide three things: What information to
4753 gather; where to display it; and when to display it.
4757 @vindex gnus-extra-headers
4758 The reading of extra header information is controlled by the
4759 @code{gnus-extra-headers}. This is a list of header symbols. For
4763 (setq gnus-extra-headers
4764 '(To Newsgroups X-Newsreader))
4767 This will result in Gnus trying to obtain these three headers, and
4768 storing it in header structures for later easy retrieval.
4771 @findex gnus-extra-header
4772 The value of these extra headers can be accessed via the
4773 @code{gnus-extra-header} function. Here's a format line spec that will
4774 access the @code{X-Newsreader} header:
4777 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4781 @vindex gnus-ignored-from-addresses
4782 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4783 summary line spec returns the @code{To}, @code{Newsreader} or
4784 @code{From} header. If this regexp matches the contents of the
4785 @code{From} header, the value of the @code{To} or @code{Newsreader}
4786 headers are used instead.
4788 To distinguish regular articles from those where the @code{From} field
4789 has been swapped, a string is prefixed to the @code{To} or
4790 @code{Newsgroups} header in the summary line. By default the string is
4791 @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can
4792 customize these strings with @code{gnus-summary-to-prefix} and
4793 @code{gnus-summary-newsgroup-prefix}.
4797 @vindex nnmail-extra-headers
4798 A related variable is @code{nnmail-extra-headers}, which controls when
4799 to include extra headers when generating overview (@acronym{NOV}) files.
4800 If you have old overview files, you should regenerate them after
4801 changing this variable, by entering the server buffer using @kbd{^},
4802 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
4805 @vindex gnus-summary-line-format
4806 You also have to instruct Gnus to display the data by changing the
4807 @code{%n} spec to the @code{%f} spec in the
4808 @code{gnus-summary-line-format} variable.
4810 In summary, you'd typically put something like the following in
4814 (setq gnus-extra-headers
4816 (setq nnmail-extra-headers gnus-extra-headers)
4817 (setq gnus-summary-line-format
4818 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4819 (setq gnus-ignored-from-addresses
4823 (The values listed above are the default values in Gnus. Alter them
4826 A note for news server administrators, or for users who wish to try to
4827 convince their news server administrator to provide some additional
4830 The above is mostly useful for mail groups, where you have control over
4831 the @acronym{NOV} files that are created. However, if you can persuade your
4832 nntp admin to add (in the usual implementation, notably INN):
4838 to the end of her @file{overview.fmt} file, then you can use that just
4839 as you would the extra headers from the mail groups.
4842 @node Summary Buffer Mode Line
4843 @subsection Summary Buffer Mode Line
4845 @vindex gnus-summary-mode-line-format
4846 You can also change the format of the summary mode bar (@pxref{Mode Line
4847 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4848 like. The default is @samp{Gnus: %%b [%A] %Z}.
4850 Here are the elements you can play with:
4856 Unprefixed group name.
4858 Current article number.
4860 Current article score.
4864 Number of unread articles in this group.
4866 Number of unread articles in this group that aren't displayed in the
4869 A string with the number of unread and unselected articles represented
4870 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4871 articles, and just as @samp{<%U more>} if there are just unread articles
4872 and no unselected ones.
4874 Shortish group name. For instance, @samp{rec.arts.anime} will be
4875 shortened to @samp{r.a.anime}.
4877 Subject of the current article.
4879 User-defined spec (@pxref{User-Defined Specs}).
4881 Name of the current score file (@pxref{Scoring}).
4883 Number of dormant articles (@pxref{Unread Articles}).
4885 Number of ticked articles (@pxref{Unread Articles}).
4887 Number of articles that have been marked as read in this session.
4889 Number of articles expunged by the score files.
4893 @node Summary Highlighting
4894 @subsection Summary Highlighting
4898 @item gnus-visual-mark-article-hook
4899 @vindex gnus-visual-mark-article-hook
4900 This hook is run after selecting an article. It is meant to be used for
4901 highlighting the article in some way. It is not run if
4902 @code{gnus-visual} is @code{nil}.
4904 @item gnus-summary-update-hook
4905 @vindex gnus-summary-update-hook
4906 This hook is called when a summary line is changed. It is not run if
4907 @code{gnus-visual} is @code{nil}.
4909 @item gnus-summary-selected-face
4910 @vindex gnus-summary-selected-face
4911 This is the face (or @dfn{font} as some people call it) used to
4912 highlight the current article in the summary buffer.
4914 @item gnus-summary-highlight
4915 @vindex gnus-summary-highlight
4916 Summary lines are highlighted according to this variable, which is a
4917 list where the elements are of the format @code{(@var{form}
4918 . @var{face})}. If you would, for instance, like ticked articles to be
4919 italic and high-scored articles to be bold, you could set this variable
4922 (((eq mark gnus-ticked-mark) . italic)
4923 ((> score default) . bold))
4925 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4926 @var{face} will be applied to the line.
4930 @node Summary Maneuvering
4931 @section Summary Maneuvering
4932 @cindex summary movement
4934 All the straight movement commands understand the numeric prefix and
4935 behave pretty much as you'd expect.
4937 None of these commands select articles.
4942 @kindex M-n (Summary)
4943 @kindex G M-n (Summary)
4944 @findex gnus-summary-next-unread-subject
4945 Go to the next summary line of an unread article
4946 (@code{gnus-summary-next-unread-subject}).
4950 @kindex M-p (Summary)
4951 @kindex G M-p (Summary)
4952 @findex gnus-summary-prev-unread-subject
4953 Go to the previous summary line of an unread article
4954 (@code{gnus-summary-prev-unread-subject}).
4957 @kindex G g (Summary)
4958 @findex gnus-summary-goto-subject
4959 Ask for an article number and then go to the summary line of that article
4960 without displaying the article (@code{gnus-summary-goto-subject}).
4963 If gnus asks you to press a key to confirm going to the next group, you
4964 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4965 buffer, searching for the next group to read without actually returning
4966 to the group buffer.
4968 Variables related to summary movement:
4972 @vindex gnus-auto-select-next
4973 @item gnus-auto-select-next
4974 If you issue one of the movement commands (like @kbd{n}) and there are
4975 no more unread articles after the current one, gnus will offer to go to
4976 the next group. If this variable is @code{t} and the next group is
4977 empty, gnus will exit summary mode and return to the group buffer. If
4978 this variable is neither @code{t} nor @code{nil}, gnus will select the
4979 next group with unread articles. As a special case, if this variable
4980 is @code{quietly}, Gnus will select the next group without asking for
4981 confirmation. If this variable is @code{almost-quietly}, the same
4982 will happen only if you are located on the last article in the group.
4983 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
4984 command will go to the next group without confirmation. Also
4985 @pxref{Group Levels}.
4987 @item gnus-auto-select-same
4988 @vindex gnus-auto-select-same
4989 If non-@code{nil}, all the movement commands will try to go to the next
4990 article with the same subject as the current. (@dfn{Same} here might
4991 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4992 for details (@pxref{Customizing Threading}).) If there are no more
4993 articles with the same subject, go to the first unread article.
4995 This variable is not particularly useful if you use a threaded display.
4997 @item gnus-summary-check-current
4998 @vindex gnus-summary-check-current
4999 If non-@code{nil}, all the ``unread'' movement commands will not proceed
5000 to the next (or previous) article if the current article is unread.
5001 Instead, they will choose the current article.
5003 @item gnus-auto-center-summary
5004 @vindex gnus-auto-center-summary
5005 If non-@code{nil}, gnus will keep the point in the summary buffer
5006 centered at all times. This makes things quite tidy, but if you have a
5007 slow network connection, or simply do not like this un-Emacsism, you can
5008 set this variable to @code{nil} to get the normal Emacs scrolling
5009 action. This will also inhibit horizontal re-centering of the summary
5010 buffer, which might make it more inconvenient to read extremely long
5013 This variable can also be a number. In that case, center the window at
5014 the given number of lines from the top.
5019 @node Choosing Articles
5020 @section Choosing Articles
5021 @cindex selecting articles
5024 * Choosing Commands:: Commands for choosing articles.
5025 * Choosing Variables:: Variables that influence these commands.
5029 @node Choosing Commands
5030 @subsection Choosing Commands
5032 None of the following movement commands understand the numeric prefix,
5033 and they all select and display an article.
5035 If you want to fetch new articles or redisplay the group, see
5036 @ref{Exiting the Summary Buffer}.
5040 @kindex SPACE (Summary)
5041 @findex gnus-summary-next-page
5042 Select the current article, or, if that one's read already, the next
5043 unread article (@code{gnus-summary-next-page}).
5045 If you have an article window open already and you press @kbd{SPACE}
5046 again, the article will be scrolled. This lets you conveniently
5047 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5052 @kindex G n (Summary)
5053 @findex gnus-summary-next-unread-article
5054 @c @icon{gnus-summary-next-unread}
5055 Go to next unread article (@code{gnus-summary-next-unread-article}).
5060 @findex gnus-summary-prev-unread-article
5061 @c @icon{gnus-summary-prev-unread}
5062 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5067 @kindex G N (Summary)
5068 @findex gnus-summary-next-article
5069 Go to the next article (@code{gnus-summary-next-article}).
5074 @kindex G P (Summary)
5075 @findex gnus-summary-prev-article
5076 Go to the previous article (@code{gnus-summary-prev-article}).
5079 @kindex G C-n (Summary)
5080 @findex gnus-summary-next-same-subject
5081 Go to the next article with the same subject
5082 (@code{gnus-summary-next-same-subject}).
5085 @kindex G C-p (Summary)
5086 @findex gnus-summary-prev-same-subject
5087 Go to the previous article with the same subject
5088 (@code{gnus-summary-prev-same-subject}).
5092 @kindex G f (Summary)
5094 @findex gnus-summary-first-unread-article
5095 Go to the first unread article
5096 (@code{gnus-summary-first-unread-article}).
5100 @kindex G b (Summary)
5102 @findex gnus-summary-best-unread-article
5103 Go to the unread article with the highest score
5104 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5105 go to the first unread article that has a score over the default score.
5110 @kindex G l (Summary)
5111 @findex gnus-summary-goto-last-article
5112 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5115 @kindex G o (Summary)
5116 @findex gnus-summary-pop-article
5118 @cindex article history
5119 Pop an article off the summary history and go to this article
5120 (@code{gnus-summary-pop-article}). This command differs from the
5121 command above in that you can pop as many previous articles off the
5122 history as you like, while @kbd{l} toggles the two last read articles.
5123 For a somewhat related issue (if you use these commands a lot),
5124 @pxref{Article Backlog}.
5129 @kindex G j (Summary)
5130 @findex gnus-summary-goto-article
5131 Ask for an article number or @code{Message-ID}, and then go to that
5132 article (@code{gnus-summary-goto-article}).
5137 @node Choosing Variables
5138 @subsection Choosing Variables
5140 Some variables relevant for moving and selecting articles:
5143 @item gnus-auto-extend-newsgroup
5144 @vindex gnus-auto-extend-newsgroup
5145 All the movement commands will try to go to the previous (or next)
5146 article, even if that article isn't displayed in the Summary buffer if
5147 this variable is non-@code{nil}. Gnus will then fetch the article from
5148 the server and display it in the article buffer.
5150 @item gnus-select-article-hook
5151 @vindex gnus-select-article-hook
5152 This hook is called whenever an article is selected. The default is
5153 @code{nil}. If you would like each article to be saved in the Agent as
5154 you read it, putting @code{gnus-agent-fetch-selected-article} on this
5157 @item gnus-mark-article-hook
5158 @vindex gnus-mark-article-hook
5159 @findex gnus-summary-mark-unread-as-read
5160 @findex gnus-summary-mark-read-and-unread-as-read
5161 @findex gnus-unread-mark
5162 This hook is called whenever an article is selected. It is intended to
5163 be used for marking articles as read. The default value is
5164 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5165 mark of almost any article you read to @code{gnus-read-mark}. The only
5166 articles not affected by this function are ticked, dormant, and
5167 expirable articles. If you'd instead like to just have unread articles
5168 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5169 instead. It will leave marks like @code{gnus-low-score-mark},
5170 @code{gnus-del-mark} (and so on) alone.
5175 @node Paging the Article
5176 @section Scrolling the Article
5177 @cindex article scrolling
5182 @kindex SPACE (Summary)
5183 @findex gnus-summary-next-page
5184 Pressing @kbd{SPACE} will scroll the current article forward one page,
5185 or, if you have come to the end of the current article, will choose the
5186 next article (@code{gnus-summary-next-page}).
5188 @vindex gnus-article-boring-faces
5189 @vindex gnus-article-skip-boring
5190 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5191 the article consists only of citations and signature, then it will be
5192 skipped; the next article will be shown instead. You can customize
5193 what is considered uninteresting with
5194 @code{gnus-article-boring-faces}. You can manually view the article's
5195 pages, no matter how boring, using @kbd{C-M-v}.
5198 @kindex DEL (Summary)
5199 @findex gnus-summary-prev-page
5200 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5203 @kindex RET (Summary)
5204 @findex gnus-summary-scroll-up
5205 Scroll the current article one line forward
5206 (@code{gnus-summary-scroll-up}).
5209 @kindex M-RET (Summary)
5210 @findex gnus-summary-scroll-down
5211 Scroll the current article one line backward
5212 (@code{gnus-summary-scroll-down}).
5216 @kindex A g (Summary)
5218 @findex gnus-summary-show-article
5219 @vindex gnus-summary-show-article-charset-alist
5220 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5221 given a prefix, fetch the current article, but don't run any of the
5222 article treatment functions. This will give you a ``raw'' article, just
5223 the way it came from the server.
5225 If given a numerical prefix, you can do semi-manual charset stuff.
5226 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5227 encoded in the @code{cn-gb-2312} charset. If you have
5230 (setq gnus-summary-show-article-charset-alist
5235 then you can say @kbd{C-u 1 g} to get the same effect.
5240 @kindex A < (Summary)
5241 @findex gnus-summary-beginning-of-article
5242 Scroll to the beginning of the article
5243 (@code{gnus-summary-beginning-of-article}).
5248 @kindex A > (Summary)
5249 @findex gnus-summary-end-of-article
5250 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5254 @kindex A s (Summary)
5256 @findex gnus-summary-isearch-article
5257 Perform an isearch in the article buffer
5258 (@code{gnus-summary-isearch-article}).
5262 @findex gnus-summary-select-article-buffer
5263 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5268 @node Reply Followup and Post
5269 @section Reply, Followup and Post
5272 * Summary Mail Commands:: Sending mail.
5273 * Summary Post Commands:: Sending news.
5274 * Summary Message Commands:: Other Message-related commands.
5275 * Canceling and Superseding::
5279 @node Summary Mail Commands
5280 @subsection Summary Mail Commands
5282 @cindex composing mail
5284 Commands for composing a mail message:
5290 @kindex S r (Summary)
5292 @findex gnus-summary-reply
5293 @c @icon{gnus-summary-mail-reply}
5294 @c @icon{gnus-summary-reply}
5295 Mail a reply to the author of the current article
5296 (@code{gnus-summary-reply}).
5301 @kindex S R (Summary)
5302 @findex gnus-summary-reply-with-original
5303 @c @icon{gnus-summary-reply-with-original}
5304 Mail a reply to the author of the current article and include the
5305 original message (@code{gnus-summary-reply-with-original}). This
5306 command uses the process/prefix convention.
5309 @kindex S w (Summary)
5310 @findex gnus-summary-wide-reply
5311 Mail a wide reply to the author of the current article
5312 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5313 goes out to all people listed in the @code{To}, @code{From} (or
5314 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5315 present, that's used instead.
5318 @kindex S W (Summary)
5319 @findex gnus-summary-wide-reply-with-original
5320 Mail a wide reply to the current article and include the original
5321 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5322 the process/prefix convention.
5325 @kindex S v (Summary)
5326 @findex gnus-summary-very-wide-reply
5327 Mail a very wide reply to the author of the current article
5328 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5329 that goes out to all people listed in the @code{To}, @code{From} (or
5330 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5331 articles. This command uses the process/prefix convention.
5334 @kindex S V (Summary)
5335 @findex gnus-summary-very-wide-reply-with-original
5336 Mail a very wide reply to the author of the current article and include the
5337 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5338 command uses the process/prefix convention.
5341 @kindex S B r (Summary)
5342 @findex gnus-summary-reply-broken-reply-to
5343 Mail a reply to the author of the current article but ignore the
5344 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5345 If you need this because a mailing list incorrectly sets a
5346 @code{Reply-To} header pointing to the list, you probably want to set
5347 the @code{broken-reply-to} group parameter instead, so things will work
5348 correctly. @xref{Group Parameters}.
5351 @kindex S B R (Summary)
5352 @findex gnus-summary-reply-broken-reply-to-with-original
5353 Mail a reply to the author of the current article and include the
5354 original message but ignore the @code{Reply-To} field
5355 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5359 @kindex S o m (Summary)
5360 @kindex C-c C-f (Summary)
5361 @findex gnus-summary-mail-forward
5362 @c @icon{gnus-summary-mail-forward}
5363 Forward the current article to some other person
5364 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
5365 headers of the forwarded article.
5370 @kindex S m (Summary)
5371 @findex gnus-summary-mail-other-window
5372 @c @icon{gnus-summary-mail-originate}
5373 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5374 the posting style of the current group. If given a prefix, disable that.
5375 If the prefix is 1, prompt for a group name to find the posting style.
5380 @kindex S i (Summary)
5381 @findex gnus-summary-news-other-window
5382 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5383 post to the current group. If given a prefix, disable that. If the
5384 prefix is 1, prompt for a group to post to.
5386 This function actually prepares a news even when using mail groups.
5387 This is useful for ``posting'' messages to mail groups without actually
5388 sending them over the network: they're just saved directly to the group
5389 in question. The corresponding back end must have a request-post method
5390 for this to work though.
5393 @kindex S D b (Summary)
5394 @findex gnus-summary-resend-bounced-mail
5395 @cindex bouncing mail
5396 If you have sent a mail, but the mail was bounced back to you for some
5397 reason (wrong address, transient failure), you can use this command to
5398 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5399 will be popped into a mail buffer where you can edit the headers before
5400 sending the mail off again. If you give a prefix to this command, and
5401 the bounced mail is a reply to some other mail, gnus will try to fetch
5402 that mail and display it for easy perusal of its headers. This might
5403 very well fail, though.
5406 @kindex S D r (Summary)
5407 @findex gnus-summary-resend-message
5408 Not to be confused with the previous command,
5409 @code{gnus-summary-resend-message} will prompt you for an address to
5410 send the current message off to, and then send it to that place. The
5411 headers of the message won't be altered---but lots of headers that say
5412 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5413 means that you actually send a mail to someone that has a @code{To}
5414 header that (probably) points to yourself. This will confuse people.
5415 So, natcherly you'll only do that if you're really eVIl.
5417 This command is mainly used if you have several accounts and want to
5418 ship a mail to a different account of yours. (If you're both
5419 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5420 to the @code{root} account, you may want to resend it to
5421 @code{postmaster}. Ordnung muss sein!
5423 This command understands the process/prefix convention
5424 (@pxref{Process/Prefix}).
5427 @kindex S D e (Summary)
5428 @findex gnus-summary-resend-message-edit
5430 Like the previous command, but will allow you to edit the message as
5431 if it were a new message before resending.
5434 @kindex S O m (Summary)
5435 @findex gnus-summary-digest-mail-forward
5436 Digest the current series (@pxref{Decoding Articles}) and forward the
5437 result using mail (@code{gnus-summary-digest-mail-forward}). This
5438 command uses the process/prefix convention (@pxref{Process/Prefix}).
5441 @kindex S M-c (Summary)
5442 @findex gnus-summary-mail-crosspost-complaint
5443 @cindex crossposting
5444 @cindex excessive crossposting
5445 Send a complaint about excessive crossposting to the author of the
5446 current article (@code{gnus-summary-mail-crosspost-complaint}).
5448 @findex gnus-crosspost-complaint
5449 This command is provided as a way to fight back against the current
5450 crossposting pandemic that's sweeping Usenet. It will compose a reply
5451 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5452 command understands the process/prefix convention
5453 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5457 Also @xref{Header Commands, ,Header Commands, message, The Message
5458 Manual}, for more information.
5461 @node Summary Post Commands
5462 @subsection Summary Post Commands
5464 @cindex composing news
5466 Commands for posting a news article:
5472 @kindex S p (Summary)
5473 @findex gnus-summary-post-news
5474 @c @icon{gnus-summary-post-news}
5475 Prepare for posting an article (@code{gnus-summary-post-news}). By
5476 default, post to the current group. If given a prefix, disable that.
5477 If the prefix is 1, prompt for another group instead.
5482 @kindex S f (Summary)
5483 @findex gnus-summary-followup
5484 @c @icon{gnus-summary-followup}
5485 Post a followup to the current article (@code{gnus-summary-followup}).
5489 @kindex S F (Summary)
5491 @c @icon{gnus-summary-followup-with-original}
5492 @findex gnus-summary-followup-with-original
5493 Post a followup to the current article and include the original message
5494 (@code{gnus-summary-followup-with-original}). This command uses the
5495 process/prefix convention.
5498 @kindex S n (Summary)
5499 @findex gnus-summary-followup-to-mail
5500 Post a followup to the current article via news, even if you got the
5501 message through mail (@code{gnus-summary-followup-to-mail}).
5504 @kindex S N (Summary)
5505 @findex gnus-summary-followup-to-mail-with-original
5506 Post a followup to the current article via news, even if you got the
5507 message through mail and include the original message
5508 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5509 the process/prefix convention.
5512 @kindex S o p (Summary)
5513 @findex gnus-summary-post-forward
5514 Forward the current article to a newsgroup
5515 (@code{gnus-summary-post-forward}). If given a prefix, include the full
5516 headers of the forwarded article.
5519 @kindex S O p (Summary)
5520 @findex gnus-summary-digest-post-forward
5522 @cindex making digests
5523 Digest the current series and forward the result to a newsgroup
5524 (@code{gnus-summary-digest-post-forward}). This command uses the
5525 process/prefix convention.
5528 @kindex S u (Summary)
5529 @findex gnus-uu-post-news
5530 @c @icon{gnus-uu-post-news}
5531 Uuencode a file, split it into parts, and post it as a series
5532 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5535 Also @xref{Header Commands, ,Header Commands, message, The Message
5536 Manual}, for more information.
5539 @node Summary Message Commands
5540 @subsection Summary Message Commands
5544 @kindex S y (Summary)
5545 @findex gnus-summary-yank-message
5546 Yank the current article into an already existing Message composition
5547 buffer (@code{gnus-summary-yank-message}). This command prompts for
5548 what message buffer you want to yank into, and understands the
5549 process/prefix convention (@pxref{Process/Prefix}).
5554 @node Canceling and Superseding
5555 @subsection Canceling Articles
5556 @cindex canceling articles
5557 @cindex superseding articles
5559 Have you ever written something, and then decided that you really,
5560 really, really wish you hadn't posted that?
5562 Well, you can't cancel mail, but you can cancel posts.
5564 @findex gnus-summary-cancel-article
5566 @c @icon{gnus-summary-cancel-article}
5567 Find the article you wish to cancel (you can only cancel your own
5568 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5569 c} (@code{gnus-summary-cancel-article}). Your article will be
5570 canceled---machines all over the world will be deleting your article.
5571 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5573 Be aware, however, that not all sites honor cancels, so your article may
5574 live on here and there, while most sites will delete the article in
5577 Gnus will use the ``current'' select method when canceling. If you
5578 want to use the standard posting method, use the @samp{a} symbolic
5579 prefix (@pxref{Symbolic Prefixes}).
5581 Gnus ensures that only you can cancel your own messages using a
5582 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5583 message, Message Manual}).
5585 If you discover that you have made some mistakes and want to do some
5586 corrections, you can post a @dfn{superseding} article that will replace
5587 your original article.
5589 @findex gnus-summary-supersede-article
5591 Go to the original article and press @kbd{S s}
5592 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5593 where you can edit the article all you want before sending it off the
5596 The same goes for superseding as for canceling, only more so: Some
5597 sites do not honor superseding. On those sites, it will appear that you
5598 have posted almost the same article twice.
5600 If you have just posted the article, and change your mind right away,
5601 there is a trick you can use to cancel/supersede the article without
5602 waiting for the article to appear on your site first. You simply return
5603 to the post buffer (which is called @code{*sent ...*}). There you will
5604 find the article you just posted, with all the headers intact. Change
5605 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5606 header by substituting one of those words for the word
5607 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5608 you would do normally. The previous article will be
5609 canceled/superseded.
5611 Just remember, kids: There is no 'c' in 'supersede'.
5613 @node Delayed Articles
5614 @section Delayed Articles
5615 @cindex delayed sending
5616 @cindex send delayed
5618 Sometimes, you might wish to delay the sending of a message. For
5619 example, you might wish to arrange for a message to turn up just in time
5620 to remind your about the birthday of your Significant Other. For this,
5621 there is the @code{gnus-delay} package. Setup is simple:
5624 (gnus-delay-initialize)
5627 @findex gnus-delay-article
5628 Normally, to send a message you use the @kbd{C-c C-c} command from
5629 Message mode. To delay a message, use @kbd{C-c C-j}
5630 (@code{gnus-delay-article}) instead. This will ask you for how long the
5631 message should be delayed. Possible answers are:
5635 A time span. Consists of an integer and a letter. For example,
5636 @code{42d} means to delay for 42 days. Available letters are @code{m}
5637 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5638 (months) and @code{Y} (years).
5641 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5642 delayed until that day, at a specific time (eight o'clock by default).
5643 See also @code{gnus-delay-default-hour}.
5646 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5647 stuff. The deadline will be at that time today, except if that time has
5648 already passed, then it's at the given time tomorrow. So if it's ten
5649 o'clock in the morning and you specify @code{11:15}, then the deadline
5650 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5651 that means a time tomorrow.
5654 The action of the @code{gnus-delay-article} command is influenced by a
5655 couple of variables:
5658 @item gnus-delay-default-hour
5659 @vindex gnus-delay-default-hour
5660 When you specify a specific date, the message will be due on that hour
5661 on the given date. Possible values are integers 0 through 23.
5663 @item gnus-delay-default-delay
5664 @vindex gnus-delay-default-delay
5665 This is a string and gives the default delay. It can be of any of the
5666 formats described above.
5668 @item gnus-delay-group
5669 @vindex gnus-delay-group
5670 Delayed articles will be kept in this group on the drafts server until
5671 they are due. You probably don't need to change this. The default
5672 value is @code{"delayed"}.
5674 @item gnus-delay-header
5675 @vindex gnus-delay-header
5676 The deadline for each article will be stored in a header. This variable
5677 is a string and gives the header name. You probably don't need to
5678 change this. The default value is @code{"X-Gnus-Delayed"}.
5681 The way delaying works is like this: when you use the
5682 @code{gnus-delay-article} command, you give a certain delay. Gnus
5683 calculates the deadline of the message and stores it in the
5684 @code{X-Gnus-Delayed} header and puts the message in the
5685 @code{nndraft:delayed} group.
5687 @findex gnus-delay-send-queue
5688 And whenever you get new news, Gnus looks through the group for articles
5689 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5690 function for this. By default, this function is added to the hook
5691 @code{gnus-get-new-news-hook}. But of course, you can change this.
5692 Maybe you want to use the demon to send drafts? Just tell the demon to
5693 execute the @code{gnus-delay-send-queue} function.
5696 @item gnus-delay-initialize
5697 @findex gnus-delay-initialize
5699 By default, this function installs @code{gnus-delay-send-queue} in
5700 @code{gnus-get-new-news-hook}. But it accepts the optional second
5701 argument @code{no-check}. If it is non-@code{nil},
5702 @code{gnus-get-new-news-hook} is not changed. The optional first
5703 argument is ignored.
5705 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5706 Presumably, you want to use the demon for sending due delayed articles.
5707 Just don't forget to set that up :-)
5711 @node Marking Articles
5712 @section Marking Articles
5713 @cindex article marking
5714 @cindex article ticking
5717 There are several marks you can set on an article.
5719 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5720 neologism ohoy!) of the article. Alphabetic marks generally mean
5721 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5723 In addition, you also have marks that do not affect readedness.
5726 There's a plethora of commands for manipulating these marks.
5730 * Unread Articles:: Marks for unread articles.
5731 * Read Articles:: Marks for read articles.
5732 * Other Marks:: Marks that do not affect readedness.
5733 * Setting Marks:: How to set and remove marks.
5734 * Generic Marking Commands:: How to customize the marking.
5735 * Setting Process Marks:: How to mark articles for later processing.
5739 @node Unread Articles
5740 @subsection Unread Articles
5742 The following marks mark articles as (kinda) unread, in one form or
5747 @vindex gnus-ticked-mark
5748 Marked as ticked (@code{gnus-ticked-mark}).
5750 @dfn{Ticked articles} are articles that will remain visible always. If
5751 you see an article that you find interesting, or you want to put off
5752 reading it, or replying to it, until sometime later, you'd typically
5753 tick it. However, articles can be expired (from news servers by the
5754 news server software, Gnus itself never expires ticked messages), so if
5755 you want to keep an article forever, you'll have to make it persistent
5756 (@pxref{Persistent Articles}).
5759 @vindex gnus-dormant-mark
5760 Marked as dormant (@code{gnus-dormant-mark}).
5762 @dfn{Dormant articles} will only appear in the summary buffer if there
5763 are followups to it. If you want to see them even if they don't have
5764 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5765 Otherwise (except for the visibility issue), they are just like ticked
5769 @vindex gnus-unread-mark
5770 Marked as unread (@code{gnus-unread-mark}).
5772 @dfn{Unread articles} are articles that haven't been read at all yet.
5777 @subsection Read Articles
5778 @cindex expirable mark
5780 All the following marks mark articles as read.
5785 @vindex gnus-del-mark
5786 These are articles that the user has marked as read with the @kbd{d}
5787 command manually, more or less (@code{gnus-del-mark}).
5790 @vindex gnus-read-mark
5791 Articles that have actually been read (@code{gnus-read-mark}).
5794 @vindex gnus-ancient-mark
5795 Articles that were marked as read in previous sessions and are now
5796 @dfn{old} (@code{gnus-ancient-mark}).
5799 @vindex gnus-killed-mark
5800 Marked as killed (@code{gnus-killed-mark}).
5803 @vindex gnus-kill-file-mark
5804 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5807 @vindex gnus-low-score-mark
5808 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5811 @vindex gnus-catchup-mark
5812 Marked as read by a catchup (@code{gnus-catchup-mark}).
5815 @vindex gnus-canceled-mark
5816 Canceled article (@code{gnus-canceled-mark})
5819 @vindex gnus-souped-mark
5820 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5823 @vindex gnus-sparse-mark
5824 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5828 @vindex gnus-duplicate-mark
5829 Article marked as read by duplicate suppression
5830 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5834 All these marks just mean that the article is marked as read, really.
5835 They are interpreted differently when doing adaptive scoring, though.
5837 One more special mark, though:
5841 @vindex gnus-expirable-mark
5842 Marked as expirable (@code{gnus-expirable-mark}).
5844 Marking articles as @dfn{expirable} (or have them marked as such
5845 automatically) doesn't make much sense in normal groups---a user doesn't
5846 control expiring of news articles, but in mail groups, for instance,
5847 articles marked as @dfn{expirable} can be deleted by gnus at
5853 @subsection Other Marks
5854 @cindex process mark
5857 There are some marks that have nothing to do with whether the article is
5863 You can set a bookmark in the current article. Say you are reading a
5864 long thesis on cats' urinary tracts, and have to go home for dinner
5865 before you've finished reading the thesis. You can then set a bookmark
5866 in the article, and gnus will jump to this bookmark the next time it
5867 encounters the article. @xref{Setting Marks}.
5870 @vindex gnus-replied-mark
5871 All articles that you have replied to or made a followup to (i.e., have
5872 answered) will be marked with an @samp{A} in the second column
5873 (@code{gnus-replied-mark}).
5876 @vindex gnus-forwarded-mark
5877 All articles that you have forwarded will be marked with an @samp{F} in
5878 the second column (@code{gnus-forwarded-mark}).
5881 @vindex gnus-cached-mark
5882 Articles stored in the article cache will be marked with an @samp{*} in
5883 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5886 @vindex gnus-saved-mark
5887 Articles ``saved'' (in some manner or other; not necessarily
5888 religiously) are marked with an @samp{S} in the second column
5889 (@code{gnus-saved-mark}).
5892 @vindex gnus-recent-mark
5893 Articles that according to the server haven't been shown to the user
5894 before are marked with a @samp{N} in the second column
5895 (@code{gnus-recent-mark}). Note that not all servers support this
5896 mark, in which case it simply never appears. Compare with
5897 @code{gnus-unseen-mark}.
5900 @vindex gnus-unseen-mark
5901 Articles that haven't been seen before in Gnus by the user are marked
5902 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5903 Compare with @code{gnus-recent-mark}.
5906 @vindex gnus-downloaded-mark
5907 When using the Gnus agent (@pxref{Agent Basics}), articles may be
5908 downloaded for unplugged (offline) viewing. If you are using the
5909 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
5910 (The variable @code{gnus-downloaded-mark} controls which character to
5914 @vindex gnus-undownloaded-mark
5915 When using the Gnus agent (@pxref{Agent Basics}), some articles might
5916 not have been downloaded. Such articles cannot be viewed while you
5917 are unplugged (offline). If you are using the @samp{%O} spec, these
5918 articles get the @samp{-} mark in that spec. (The variable
5919 @code{gnus-undownloaded-mark} controls which character to use.)
5922 @vindex gnus-downloadable-mark
5923 The Gnus agent (@pxref{Agent Basics}) downloads some articles
5924 automatically, but it is also possible to explicitly mark articles for
5925 download, even if they would not be downloaded automatically. Such
5926 explicitly-marked articles get the @samp{%} mark in the first column.
5927 (The variable @code{gnus-downloadable-mark} controls which character to
5931 @vindex gnus-not-empty-thread-mark
5932 @vindex gnus-empty-thread-mark
5933 If the @samp{%e} spec is used, the presence of threads or not will be
5934 marked with @code{gnus-not-empty-thread-mark} and
5935 @code{gnus-empty-thread-mark} in the third column, respectively.
5938 @vindex gnus-process-mark
5939 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5940 variety of commands react to the presence of the process mark. For
5941 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5942 all articles that have been marked with the process mark. Articles
5943 marked with the process mark have a @samp{#} in the second column.
5947 You might have noticed that most of these ``non-readedness'' marks
5948 appear in the second column by default. So if you have a cached, saved,
5949 replied article that you have process-marked, what will that look like?
5951 Nothing much. The precedence rules go as follows: process -> cache ->
5952 replied -> saved. So if the article is in the cache and is replied,
5953 you'll only see the cache mark and not the replied mark.
5957 @subsection Setting Marks
5958 @cindex setting marks
5960 All the marking commands understand the numeric prefix.
5965 @kindex M c (Summary)
5966 @kindex M-u (Summary)
5967 @findex gnus-summary-clear-mark-forward
5968 @cindex mark as unread
5969 Clear all readedness-marks from the current article
5970 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5976 @kindex M t (Summary)
5977 @findex gnus-summary-tick-article-forward
5978 Tick the current article (@code{gnus-summary-tick-article-forward}).
5979 @xref{Article Caching}.
5984 @kindex M ? (Summary)
5985 @findex gnus-summary-mark-as-dormant
5986 Mark the current article as dormant
5987 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5991 @kindex M d (Summary)
5993 @findex gnus-summary-mark-as-read-forward
5994 Mark the current article as read
5995 (@code{gnus-summary-mark-as-read-forward}).
5999 @findex gnus-summary-mark-as-read-backward
6000 Mark the current article as read and move point to the previous line
6001 (@code{gnus-summary-mark-as-read-backward}).
6006 @kindex M k (Summary)
6007 @findex gnus-summary-kill-same-subject-and-select
6008 Mark all articles that have the same subject as the current one as read,
6009 and then select the next unread article
6010 (@code{gnus-summary-kill-same-subject-and-select}).
6014 @kindex M K (Summary)
6015 @kindex C-k (Summary)
6016 @findex gnus-summary-kill-same-subject
6017 Mark all articles that have the same subject as the current one as read
6018 (@code{gnus-summary-kill-same-subject}).
6021 @kindex M C (Summary)
6022 @findex gnus-summary-catchup
6023 @c @icon{gnus-summary-catchup}
6024 Mark all unread articles as read (@code{gnus-summary-catchup}).
6027 @kindex M C-c (Summary)
6028 @findex gnus-summary-catchup-all
6029 Mark all articles in the group as read---even the ticked and dormant
6030 articles (@code{gnus-summary-catchup-all}).
6033 @kindex M H (Summary)
6034 @findex gnus-summary-catchup-to-here
6035 Catchup the current group to point (before the point)
6036 (@code{gnus-summary-catchup-to-here}).
6039 @kindex M h (Summary)
6040 @findex gnus-summary-catchup-from-here
6041 Catchup the current group from point (after the point)
6042 (@code{gnus-summary-catchup-from-here}).
6045 @kindex C-w (Summary)
6046 @findex gnus-summary-mark-region-as-read
6047 Mark all articles between point and mark as read
6048 (@code{gnus-summary-mark-region-as-read}).
6051 @kindex M V k (Summary)
6052 @findex gnus-summary-kill-below
6053 Kill all articles with scores below the default score (or below the
6054 numeric prefix) (@code{gnus-summary-kill-below}).
6058 @kindex M e (Summary)
6060 @findex gnus-summary-mark-as-expirable
6061 Mark the current article as expirable
6062 (@code{gnus-summary-mark-as-expirable}).
6065 @kindex M b (Summary)
6066 @findex gnus-summary-set-bookmark
6067 Set a bookmark in the current article
6068 (@code{gnus-summary-set-bookmark}).
6071 @kindex M B (Summary)
6072 @findex gnus-summary-remove-bookmark
6073 Remove the bookmark from the current article
6074 (@code{gnus-summary-remove-bookmark}).
6077 @kindex M V c (Summary)
6078 @findex gnus-summary-clear-above
6079 Clear all marks from articles with scores over the default score (or
6080 over the numeric prefix) (@code{gnus-summary-clear-above}).
6083 @kindex M V u (Summary)
6084 @findex gnus-summary-tick-above
6085 Tick all articles with scores over the default score (or over the
6086 numeric prefix) (@code{gnus-summary-tick-above}).
6089 @kindex M V m (Summary)
6090 @findex gnus-summary-mark-above
6091 Prompt for a mark, and mark all articles with scores over the default
6092 score (or over the numeric prefix) with this mark
6093 (@code{gnus-summary-clear-above}).
6096 @vindex gnus-summary-goto-unread
6097 The @code{gnus-summary-goto-unread} variable controls what action should
6098 be taken after setting a mark. If non-@code{nil}, point will move to
6099 the next/previous unread article. If @code{nil}, point will just move
6100 one line up or down. As a special case, if this variable is
6101 @code{never}, all the marking commands as well as other commands (like
6102 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6103 The default is @code{t}.
6106 @node Generic Marking Commands
6107 @subsection Generic Marking Commands
6109 Some people would like the command that ticks an article (@kbd{!}) go to
6110 the next article. Others would like it to go to the next unread
6111 article. Yet others would like it to stay on the current article. And
6112 even though I haven't heard of anybody wanting it to go to the
6113 previous (unread) article, I'm sure there are people that want that as
6116 Multiply these five behaviors with five different marking commands, and
6117 you get a potentially complex set of variable to control what each
6120 To sidestep that mess, Gnus provides commands that do all these
6121 different things. They can be found on the @kbd{M M} map in the summary
6122 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6123 to list in this manual.
6125 While you can use these commands directly, most users would prefer
6126 altering the summary mode keymap. For instance, if you would like the
6127 @kbd{!} command to go to the next article instead of the next unread
6128 article, you could say something like:
6132 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6133 (defun my-alter-summary-map ()
6134 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6142 (defun my-alter-summary-map ()
6143 (local-set-key "!" "MM!n"))
6147 @node Setting Process Marks
6148 @subsection Setting Process Marks
6149 @cindex setting process marks
6151 Process marks are displayed as @code{#} in the summary buffer, and are
6152 used for marking articles in such a way that other commands will
6153 process these articles. For instance, if you process mark four
6154 articles and then use the @kbd{*} command, Gnus will enter these four
6155 commands into the cache. For more information,
6156 @pxref{Process/Prefix}.
6163 @kindex M P p (Summary)
6164 @findex gnus-summary-mark-as-processable
6165 Mark the current article with the process mark
6166 (@code{gnus-summary-mark-as-processable}).
6167 @findex gnus-summary-unmark-as-processable
6171 @kindex M P u (Summary)
6172 @kindex M-# (Summary)
6173 Remove the process mark, if any, from the current article
6174 (@code{gnus-summary-unmark-as-processable}).
6177 @kindex M P U (Summary)
6178 @findex gnus-summary-unmark-all-processable
6179 Remove the process mark from all articles
6180 (@code{gnus-summary-unmark-all-processable}).
6183 @kindex M P i (Summary)
6184 @findex gnus-uu-invert-processable
6185 Invert the list of process marked articles
6186 (@code{gnus-uu-invert-processable}).
6189 @kindex M P R (Summary)
6190 @findex gnus-uu-mark-by-regexp
6191 Mark articles that have a @code{Subject} header that matches a regular
6192 expression (@code{gnus-uu-mark-by-regexp}).
6195 @kindex M P G (Summary)
6196 @findex gnus-uu-unmark-by-regexp
6197 Unmark articles that have a @code{Subject} header that matches a regular
6198 expression (@code{gnus-uu-unmark-by-regexp}).
6201 @kindex M P r (Summary)
6202 @findex gnus-uu-mark-region
6203 Mark articles in region (@code{gnus-uu-mark-region}).
6206 @kindex M P g (Summary)
6207 @findex gnus-uu-unmark-region
6208 Unmark articles in region (@code{gnus-uu-unmark-region}).
6211 @kindex M P t (Summary)
6212 @findex gnus-uu-mark-thread
6213 Mark all articles in the current (sub)thread
6214 (@code{gnus-uu-mark-thread}).
6217 @kindex M P T (Summary)
6218 @findex gnus-uu-unmark-thread
6219 Unmark all articles in the current (sub)thread
6220 (@code{gnus-uu-unmark-thread}).
6223 @kindex M P v (Summary)
6224 @findex gnus-uu-mark-over
6225 Mark all articles that have a score above the prefix argument
6226 (@code{gnus-uu-mark-over}).
6229 @kindex M P s (Summary)
6230 @findex gnus-uu-mark-series
6231 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6234 @kindex M P S (Summary)
6235 @findex gnus-uu-mark-sparse
6236 Mark all series that have already had some articles marked
6237 (@code{gnus-uu-mark-sparse}).
6240 @kindex M P a (Summary)
6241 @findex gnus-uu-mark-all
6242 Mark all articles in series order (@code{gnus-uu-mark-all}).
6245 @kindex M P b (Summary)
6246 @findex gnus-uu-mark-buffer
6247 Mark all articles in the buffer in the order they appear
6248 (@code{gnus-uu-mark-buffer}).
6251 @kindex M P k (Summary)
6252 @findex gnus-summary-kill-process-mark
6253 Push the current process mark set onto the stack and unmark all articles
6254 (@code{gnus-summary-kill-process-mark}).
6257 @kindex M P y (Summary)
6258 @findex gnus-summary-yank-process-mark
6259 Pop the previous process mark set from the stack and restore it
6260 (@code{gnus-summary-yank-process-mark}).
6263 @kindex M P w (Summary)
6264 @findex gnus-summary-save-process-mark
6265 Push the current process mark set onto the stack
6266 (@code{gnus-summary-save-process-mark}).
6270 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6271 set process marks based on article body contents.
6278 It can be convenient to limit the summary buffer to just show some
6279 subset of the articles currently in the group. The effect most limit
6280 commands have is to remove a few (or many) articles from the summary
6283 All limiting commands work on subsets of the articles already fetched
6284 from the servers. None of these commands query the server for
6285 additional articles.
6291 @kindex / / (Summary)
6292 @findex gnus-summary-limit-to-subject
6293 Limit the summary buffer to articles that match some subject
6294 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6298 @kindex / a (Summary)
6299 @findex gnus-summary-limit-to-author
6300 Limit the summary buffer to articles that match some author
6301 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6305 @kindex / R (Summary)
6306 @findex gnus-summary-limit-to-recipient
6307 Limit the summary buffer to articles that match some recipient
6308 (@code{gnus-summary-limit-to-recipient}). If given a prefix, exclude
6312 @kindex / x (Summary)
6313 @findex gnus-summary-limit-to-extra
6314 Limit the summary buffer to articles that match one of the ``extra''
6315 headers (@pxref{To From Newsgroups})
6316 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6321 @kindex / u (Summary)
6323 @findex gnus-summary-limit-to-unread
6324 Limit the summary buffer to articles not marked as read
6325 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6326 buffer to articles strictly unread. This means that ticked and
6327 dormant articles will also be excluded.
6330 @kindex / m (Summary)
6331 @findex gnus-summary-limit-to-marks
6332 Ask for a mark and then limit to all articles that have been marked
6333 with that mark (@code{gnus-summary-limit-to-marks}).
6336 @kindex / t (Summary)
6337 @findex gnus-summary-limit-to-age
6338 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6339 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6340 articles younger than that number of days.
6343 @kindex / n (Summary)
6344 @findex gnus-summary-limit-to-articles
6345 Limit the summary buffer to the current article
6346 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
6347 convention (@pxref{Process/Prefix}).
6350 @kindex / w (Summary)
6351 @findex gnus-summary-pop-limit
6352 Pop the previous limit off the stack and restore it
6353 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6357 @kindex / . (Summary)
6358 @findex gnus-summary-limit-to-unseen
6359 Limit the summary buffer to the unseen articles
6360 (@code{gnus-summary-limit-to-unseen}).
6363 @kindex / v (Summary)
6364 @findex gnus-summary-limit-to-score
6365 Limit the summary buffer to articles that have a score at or above some
6366 score (@code{gnus-summary-limit-to-score}).
6369 @kindex / p (Summary)
6370 @findex gnus-summary-limit-to-display-predicate
6371 Limit the summary buffer to articles that satisfy the @code{display}
6372 group parameter predicate
6373 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6374 Parameters}, for more on this predicate.
6377 @kindex / r (Summary)
6378 @findex gnus-summary-limit-to-replied
6379 Limit the summary buffer to replied articles
6380 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6385 @kindex M S (Summary)
6386 @kindex / E (Summary)
6387 @findex gnus-summary-limit-include-expunged
6388 Include all expunged articles in the limit
6389 (@code{gnus-summary-limit-include-expunged}).
6392 @kindex / D (Summary)
6393 @findex gnus-summary-limit-include-dormant
6394 Include all dormant articles in the limit
6395 (@code{gnus-summary-limit-include-dormant}).
6398 @kindex / * (Summary)
6399 @findex gnus-summary-limit-include-cached
6400 Include all cached articles in the limit
6401 (@code{gnus-summary-limit-include-cached}).
6404 @kindex / d (Summary)
6405 @findex gnus-summary-limit-exclude-dormant
6406 Exclude all dormant articles from the limit
6407 (@code{gnus-summary-limit-exclude-dormant}).
6410 @kindex / M (Summary)
6411 @findex gnus-summary-limit-exclude-marks
6412 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6415 @kindex / T (Summary)
6416 @findex gnus-summary-limit-include-thread
6417 Include all the articles in the current thread in the limit.
6420 @kindex / c (Summary)
6421 @findex gnus-summary-limit-exclude-childless-dormant
6422 Exclude all dormant articles that have no children from the limit@*
6423 (@code{gnus-summary-limit-exclude-childless-dormant}).
6426 @kindex / C (Summary)
6427 @findex gnus-summary-limit-mark-excluded-as-read
6428 Mark all excluded unread articles as read
6429 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6430 also mark excluded ticked and dormant articles as read.
6433 @kindex / N (Summary)
6434 @findex gnus-summary-insert-new-articles
6435 Insert all new articles in the summary buffer. It scans for new emails
6436 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6439 @kindex / o (Summary)
6440 @findex gnus-summary-insert-old-articles
6441 Insert all old articles in the summary buffer. If given a numbered
6442 prefix, fetch this number of articles.
6450 @cindex article threading
6452 Gnus threads articles by default. @dfn{To thread} is to put responses
6453 to articles directly after the articles they respond to---in a
6454 hierarchical fashion.
6456 Threading is done by looking at the @code{References} headers of the
6457 articles. In a perfect world, this would be enough to build pretty
6458 trees, but unfortunately, the @code{References} header is often broken
6459 or simply missing. Weird news propagation exacerbates the problem,
6460 so one has to employ other heuristics to get pleasing results. A
6461 plethora of approaches exists, as detailed in horrible detail in
6462 @ref{Customizing Threading}.
6464 First, a quick overview of the concepts:
6468 The top-most article in a thread; the first article in the thread.
6471 A tree-like article structure.
6474 A small(er) section of this tree-like structure.
6477 Threads often lose their roots due to article expiry, or due to the root
6478 already having been read in a previous session, and not displayed in the
6479 summary buffer. We then typically have many sub-threads that really
6480 belong to one thread, but are without connecting roots. These are
6481 called loose threads.
6483 @item thread gathering
6484 An attempt to gather loose threads into bigger threads.
6486 @item sparse threads
6487 A thread where the missing articles have been ``guessed'' at, and are
6488 displayed as empty lines in the summary buffer.
6494 * Customizing Threading:: Variables you can change to affect the threading.
6495 * Thread Commands:: Thread based commands in the summary buffer.
6499 @node Customizing Threading
6500 @subsection Customizing Threading
6501 @cindex customizing threading
6504 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6505 * Filling In Threads:: Making the threads displayed look fuller.
6506 * More Threading:: Even more variables for fiddling with threads.
6507 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6512 @subsubsection Loose Threads
6515 @cindex loose threads
6518 @item gnus-summary-make-false-root
6519 @vindex gnus-summary-make-false-root
6520 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
6521 and create a dummy root at the top. (Wait a minute. Root at the top?
6522 Yup.) Loose subtrees occur when the real root has expired, or you've
6523 read or killed the root in a previous session.
6525 When there is no real root of a thread, gnus will have to fudge
6526 something. This variable says what fudging method gnus should use.
6527 There are four possible values:
6531 \gnusfigure{The Summary Buffer}{390}{
6532 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6533 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6534 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6535 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6540 @cindex adopting articles
6545 Gnus will make the first of the orphaned articles the parent. This
6546 parent will adopt all the other articles. The adopted articles will be
6547 marked as such by pointy brackets (@samp{<>}) instead of the standard
6548 square brackets (@samp{[]}). This is the default method.
6551 @vindex gnus-summary-dummy-line-format
6552 @vindex gnus-summary-make-false-root-always
6553 Gnus will create a dummy summary line that will pretend to be the
6554 parent. This dummy line does not correspond to any real article, so
6555 selecting it will just select the first real article after the dummy
6556 article. @code{gnus-summary-dummy-line-format} is used to specify the
6557 format of the dummy roots. It accepts only one format spec: @samp{S},
6558 which is the subject of the article. @xref{Formatting Variables}.
6559 If you want all threads to have a dummy root, even the non-gathered
6560 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6563 Gnus won't actually make any article the parent, but simply leave the
6564 subject field of all orphans except the first empty. (Actually, it will
6565 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6569 Don't make any article parent at all. Just gather the threads and
6570 display them after one another.
6573 Don't gather loose threads.
6576 @item gnus-summary-gather-subject-limit
6577 @vindex gnus-summary-gather-subject-limit
6578 Loose threads are gathered by comparing subjects of articles. If this
6579 variable is @code{nil}, gnus requires an exact match between the
6580 subjects of the loose threads before gathering them into one big
6581 super-thread. This might be too strict a requirement, what with the
6582 presence of stupid newsreaders that chop off long subject lines. If
6583 you think so, set this variable to, say, 20 to require that only the
6584 first 20 characters of the subjects have to match. If you set this
6585 variable to a really low number, you'll find that gnus will gather
6586 everything in sight into one thread, which isn't very helpful.
6588 @cindex fuzzy article gathering
6589 If you set this variable to the special value @code{fuzzy}, gnus will
6590 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6593 @item gnus-simplify-subject-fuzzy-regexp
6594 @vindex gnus-simplify-subject-fuzzy-regexp
6595 This can either be a regular expression or list of regular expressions
6596 that match strings that will be removed from subjects if fuzzy subject
6597 simplification is used.
6599 @item gnus-simplify-ignored-prefixes
6600 @vindex gnus-simplify-ignored-prefixes
6601 If you set @code{gnus-summary-gather-subject-limit} to something as low
6602 as 10, you might consider setting this variable to something sensible:
6604 @c Written by Michael Ernst <mernst@cs.rice.edu>
6606 (setq gnus-simplify-ignored-prefixes
6612 "wanted" "followup" "summary\\( of\\)?"
6613 "help" "query" "problem" "question"
6614 "answer" "reference" "announce"
6615 "How can I" "How to" "Comparison of"
6620 (mapconcat 'identity
6621 '("for" "for reference" "with" "about")
6623 "\\)?\\]?:?[ \t]*"))
6626 All words that match this regexp will be removed before comparing two
6629 @item gnus-simplify-subject-functions
6630 @vindex gnus-simplify-subject-functions
6631 If non-@code{nil}, this variable overrides
6632 @code{gnus-summary-gather-subject-limit}. This variable should be a
6633 list of functions to apply to the @code{Subject} string iteratively to
6634 arrive at the simplified version of the string.
6636 Useful functions to put in this list include:
6639 @item gnus-simplify-subject-re
6640 @findex gnus-simplify-subject-re
6641 Strip the leading @samp{Re:}.
6643 @item gnus-simplify-subject-fuzzy
6644 @findex gnus-simplify-subject-fuzzy
6647 @item gnus-simplify-whitespace
6648 @findex gnus-simplify-whitespace
6649 Remove excessive whitespace.
6651 @item gnus-simplify-all-whitespace
6652 @findex gnus-simplify-all-whitespace
6653 Remove all whitespace.
6656 You may also write your own functions, of course.
6659 @item gnus-summary-gather-exclude-subject
6660 @vindex gnus-summary-gather-exclude-subject
6661 Since loose thread gathering is done on subjects only, that might lead
6662 to many false hits, especially with certain common subjects like
6663 @samp{} and @samp{(none)}. To make the situation slightly better,
6664 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6665 what subjects should be excluded from the gathering process.@*
6666 The default is @samp{^ *$\\|^(none)$}.
6668 @item gnus-summary-thread-gathering-function
6669 @vindex gnus-summary-thread-gathering-function
6670 Gnus gathers threads by looking at @code{Subject} headers. This means
6671 that totally unrelated articles may end up in the same ``thread'', which
6672 is confusing. An alternate approach is to look at all the
6673 @code{Message-ID}s in all the @code{References} headers to find matches.
6674 This will ensure that no gathered threads ever include unrelated
6675 articles, but it also means that people who have posted with broken
6676 newsreaders won't be gathered properly. The choice is yours---plague or
6680 @item gnus-gather-threads-by-subject
6681 @findex gnus-gather-threads-by-subject
6682 This function is the default gathering function and looks at
6683 @code{Subject}s exclusively.
6685 @item gnus-gather-threads-by-references
6686 @findex gnus-gather-threads-by-references
6687 This function looks at @code{References} headers exclusively.
6690 If you want to test gathering by @code{References}, you could say
6694 (setq gnus-summary-thread-gathering-function
6695 'gnus-gather-threads-by-references)
6701 @node Filling In Threads
6702 @subsubsection Filling In Threads
6705 @item gnus-fetch-old-headers
6706 @vindex gnus-fetch-old-headers
6707 If non-@code{nil}, gnus will attempt to build old threads by fetching
6708 more old headers---headers to articles marked as read. If you would
6709 like to display as few summary lines as possible, but still connect as
6710 many loose threads as possible, you should set this variable to
6711 @code{some} or a number. If you set it to a number, no more than that
6712 number of extra old headers will be fetched. In either case, fetching
6713 old headers only works if the back end you are using carries overview
6714 files---this would normally be @code{nntp}, @code{nnspool},
6715 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
6716 the thread has been expired by the server, there's not much Gnus can
6719 This variable can also be set to @code{invisible}. This won't have any
6720 visible effects, but is useful if you use the @kbd{A T} command a lot
6721 (@pxref{Finding the Parent}).
6723 @item gnus-fetch-old-ephemeral-headers
6724 @vindex gnus-fetch-old-ephemeral-headers
6725 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
6728 @item gnus-build-sparse-threads
6729 @vindex gnus-build-sparse-threads
6730 Fetching old headers can be slow. A low-rent similar effect can be
6731 gotten by setting this variable to @code{some}. Gnus will then look at
6732 the complete @code{References} headers of all articles and try to string
6733 together articles that belong in the same thread. This will leave
6734 @dfn{gaps} in the threading display where gnus guesses that an article
6735 is missing from the thread. (These gaps appear like normal summary
6736 lines. If you select a gap, gnus will try to fetch the article in
6737 question.) If this variable is @code{t}, gnus will display all these
6738 ``gaps'' without regard for whether they are useful for completing the
6739 thread or not. Finally, if this variable is @code{more}, gnus won't cut
6740 off sparse leaf nodes that don't lead anywhere. This variable is
6741 @code{nil} by default.
6743 @item gnus-read-all-available-headers
6744 @vindex gnus-read-all-available-headers
6745 This is a rather obscure variable that few will find useful. It's
6746 intended for those non-news newsgroups where the back end has to fetch
6747 quite a lot to present the summary buffer, and where it's impossible to
6748 go back to parents of articles. This is mostly the case in the
6749 web-based groups, like the @code{nnultimate} groups.
6751 If you don't use those, then it's safe to leave this as the default
6752 @code{nil}. If you want to use this variable, it should be a regexp
6753 that matches the group name, or @code{t} for all groups.
6758 @node More Threading
6759 @subsubsection More Threading
6762 @item gnus-show-threads
6763 @vindex gnus-show-threads
6764 If this variable is @code{nil}, no threading will be done, and all of
6765 the rest of the variables here will have no effect. Turning threading
6766 off will speed group selection up a bit, but it is sure to make reading
6767 slower and more awkward.
6769 @item gnus-thread-hide-subtree
6770 @vindex gnus-thread-hide-subtree
6771 If non-@code{nil}, all threads will be hidden when the summary buffer is
6774 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6775 Available predicates are @code{gnus-article-unread-p} and
6776 @code{gnus-article-unseen-p}.
6781 (setq gnus-thread-hide-subtree
6782 '(or gnus-article-unread-p
6783 gnus-article-unseen-p))
6786 (It's a pretty nonsensical example, since all unseen articles are also
6787 unread, but you get my drift.)
6790 @item gnus-thread-expunge-below
6791 @vindex gnus-thread-expunge-below
6792 All threads that have a total score (as defined by
6793 @code{gnus-thread-score-function}) less than this number will be
6794 expunged. This variable is @code{nil} by default, which means that no
6795 threads are expunged.
6797 @item gnus-thread-hide-killed
6798 @vindex gnus-thread-hide-killed
6799 if you kill a thread and this variable is non-@code{nil}, the subtree
6802 @item gnus-thread-ignore-subject
6803 @vindex gnus-thread-ignore-subject
6804 Sometimes somebody changes the subject in the middle of a thread. If
6805 this variable is non-@code{nil}, which is the default, the subject
6806 change is ignored. If it is @code{nil}, a change in the subject will
6807 result in a new thread.
6809 @item gnus-thread-indent-level
6810 @vindex gnus-thread-indent-level
6811 This is a number that says how much each sub-thread should be indented.
6814 @item gnus-sort-gathered-threads-function
6815 @vindex gnus-sort-gathered-threads-function
6816 Sometimes, particularly with mailing lists, the order in which mails
6817 arrive locally is not necessarily the same as the order in which they
6818 arrived on the mailing list. Consequently, when sorting sub-threads
6819 using the default @code{gnus-thread-sort-by-number}, responses can end
6820 up appearing before the article to which they are responding to.
6821 Setting this variable to an alternate value
6822 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6823 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6824 more logical sub-thread ordering in such instances.
6829 @node Low-Level Threading
6830 @subsubsection Low-Level Threading
6834 @item gnus-parse-headers-hook
6835 @vindex gnus-parse-headers-hook
6836 Hook run before parsing any headers. The default value is
6837 @code{(gnus-set-summary-default-charset)}, which sets up local value of
6838 @code{default-mime-charset} in summary buffer based on variable
6839 @code{gnus-newsgroup-default-charset-alist}.
6841 @item gnus-alter-header-function
6842 @vindex gnus-alter-header-function
6843 If non-@code{nil}, this function will be called to allow alteration of
6844 article header structures. The function is called with one parameter,
6845 the article header vector, which it may alter in any way. For instance,
6846 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6847 in systematic ways (by adding prefixes and such), you can use this
6848 variable to un-scramble the @code{Message-ID}s so that they are more
6849 meaningful. Here's one example:
6852 (setq gnus-alter-header-function 'my-alter-message-id)
6854 (defun my-alter-message-id (header)
6855 (let ((id (mail-header-id header)))
6857 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6859 (concat (match-string 1 id) "@@" (match-string 2 id))
6866 @node Thread Commands
6867 @subsection Thread Commands
6868 @cindex thread commands
6874 @kindex T k (Summary)
6875 @kindex C-M-k (Summary)
6876 @findex gnus-summary-kill-thread
6877 Mark all articles in the current (sub-)thread as read
6878 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
6879 remove all marks instead. If the prefix argument is negative, tick
6884 @kindex T l (Summary)
6885 @kindex C-M-l (Summary)
6886 @findex gnus-summary-lower-thread
6887 Lower the score of the current (sub-)thread
6888 (@code{gnus-summary-lower-thread}).
6891 @kindex T i (Summary)
6892 @findex gnus-summary-raise-thread
6893 Increase the score of the current (sub-)thread
6894 (@code{gnus-summary-raise-thread}).
6897 @kindex T # (Summary)
6898 @findex gnus-uu-mark-thread
6899 Set the process mark on the current (sub-)thread
6900 (@code{gnus-uu-mark-thread}).
6903 @kindex T M-# (Summary)
6904 @findex gnus-uu-unmark-thread
6905 Remove the process mark from the current (sub-)thread
6906 (@code{gnus-uu-unmark-thread}).
6909 @kindex T T (Summary)
6910 @findex gnus-summary-toggle-threads
6911 Toggle threading (@code{gnus-summary-toggle-threads}).
6914 @kindex T s (Summary)
6915 @findex gnus-summary-show-thread
6916 Expose the (sub-)thread hidden under the current article, if any@*
6917 (@code{gnus-summary-show-thread}).
6920 @kindex T h (Summary)
6921 @findex gnus-summary-hide-thread
6922 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6925 @kindex T S (Summary)
6926 @findex gnus-summary-show-all-threads
6927 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6930 @kindex T H (Summary)
6931 @findex gnus-summary-hide-all-threads
6932 Hide all threads (@code{gnus-summary-hide-all-threads}).
6935 @kindex T t (Summary)
6936 @findex gnus-summary-rethread-current
6937 Re-thread the current article's thread
6938 (@code{gnus-summary-rethread-current}). This works even when the
6939 summary buffer is otherwise unthreaded.
6942 @kindex T ^ (Summary)
6943 @findex gnus-summary-reparent-thread
6944 Make the current article the child of the marked (or previous) article
6945 (@code{gnus-summary-reparent-thread}).
6949 The following commands are thread movement commands. They all
6950 understand the numeric prefix.
6955 @kindex T n (Summary)
6957 @kindex C-M-n (Summary)
6959 @kindex M-down (Summary)
6960 @findex gnus-summary-next-thread
6961 Go to the next thread (@code{gnus-summary-next-thread}).
6964 @kindex T p (Summary)
6966 @kindex C-M-p (Summary)
6968 @kindex M-up (Summary)
6969 @findex gnus-summary-prev-thread
6970 Go to the previous thread (@code{gnus-summary-prev-thread}).
6973 @kindex T d (Summary)
6974 @findex gnus-summary-down-thread
6975 Descend the thread (@code{gnus-summary-down-thread}).
6978 @kindex T u (Summary)
6979 @findex gnus-summary-up-thread
6980 Ascend the thread (@code{gnus-summary-up-thread}).
6983 @kindex T o (Summary)
6984 @findex gnus-summary-top-thread
6985 Go to the top of the thread (@code{gnus-summary-top-thread}).
6988 @vindex gnus-thread-operation-ignore-subject
6989 If you ignore subject while threading, you'll naturally end up with
6990 threads that have several different subjects in them. If you then issue
6991 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
6992 wish to kill the entire thread, but just those parts of the thread that
6993 have the same subject as the current article. If you like this idea,
6994 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6995 is non-@code{nil} (which it is by default), subjects will be ignored
6996 when doing thread commands. If this variable is @code{nil}, articles in
6997 the same thread with different subjects will not be included in the
6998 operation in question. If this variable is @code{fuzzy}, only articles
6999 that have subjects fuzzily equal will be included (@pxref{Fuzzy
7003 @node Sorting the Summary Buffer
7004 @section Sorting the Summary Buffer
7006 @findex gnus-thread-sort-by-total-score
7007 @findex gnus-thread-sort-by-date
7008 @findex gnus-thread-sort-by-score
7009 @findex gnus-thread-sort-by-subject
7010 @findex gnus-thread-sort-by-author
7011 @c @findex gnus-thread-sort-by-recipient
7012 @findex gnus-thread-sort-by-number
7013 @findex gnus-thread-sort-by-random
7014 @vindex gnus-thread-sort-functions
7015 @findex gnus-thread-sort-by-most-recent-number
7016 @findex gnus-thread-sort-by-most-recent-date
7017 If you are using a threaded summary display, you can sort the threads by
7018 setting @code{gnus-thread-sort-functions}, which can be either a single
7019 function, a list of functions, or a list containing functions and
7020 @code{(not some-function)} elements.
7022 By default, sorting is done on article numbers. Ready-made sorting
7023 predicate functions include @code{gnus-thread-sort-by-number},
7024 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
7025 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score},
7026 @code{gnus-thread-sort-by-most-recent-number},
7027 @code{gnus-thread-sort-by-most-recent-date},
7028 @code{gnus-thread-sort-by-random} and
7029 @code{gnus-thread-sort-by-total-score}.
7031 Each function takes two threads and returns non-@code{nil} if the first
7032 thread should be sorted before the other. Note that sorting really is
7033 normally done by looking only at the roots of each thread.
7035 If you use more than one function, the primary sort key should be the
7036 last function in the list. You should probably always include
7037 @code{gnus-thread-sort-by-number} in the list of sorting
7038 functions---preferably first. This will ensure that threads that are
7039 equal with respect to the other sort criteria will be displayed in
7040 ascending article order.
7042 If you would like to sort by reverse score, then by subject, and finally
7043 by number, you could do something like:
7046 (setq gnus-thread-sort-functions
7047 '(gnus-thread-sort-by-number
7048 gnus-thread-sort-by-subject
7049 (not gnus-thread-sort-by-total-score)))
7052 The threads that have highest score will be displayed first in the
7053 summary buffer. When threads have the same score, they will be sorted
7054 alphabetically. The threads that have the same score and the same
7055 subject will be sorted by number, which is (normally) the sequence in
7056 which the articles arrived.
7058 If you want to sort by score and then reverse arrival order, you could
7062 (setq gnus-thread-sort-functions
7064 (not (gnus-thread-sort-by-number t1 t2)))
7065 gnus-thread-sort-by-score))
7068 @vindex gnus-thread-score-function
7069 The function in the @code{gnus-thread-score-function} variable (default
7070 @code{+}) is used for calculating the total score of a thread. Useful
7071 functions might be @code{max}, @code{min}, or squared means, or whatever
7074 @findex gnus-article-sort-functions
7075 @findex gnus-article-sort-by-date
7076 @findex gnus-article-sort-by-score
7077 @findex gnus-article-sort-by-subject
7078 @findex gnus-article-sort-by-author
7079 @findex gnus-article-sort-by-random
7080 @findex gnus-article-sort-by-number
7081 If you are using an unthreaded display for some strange reason or
7082 other, you have to fiddle with the @code{gnus-article-sort-functions}
7083 variable. It is very similar to the
7084 @code{gnus-thread-sort-functions}, except that it uses slightly
7085 different functions for article comparison. Available sorting
7086 predicate functions are @code{gnus-article-sort-by-number},
7087 @code{gnus-article-sort-by-author},
7088 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7089 @code{gnus-article-sort-by-random}, and
7090 @code{gnus-article-sort-by-score}.
7092 If you want to sort an unthreaded summary display by subject, you could
7096 (setq gnus-article-sort-functions
7097 '(gnus-article-sort-by-number
7098 gnus-article-sort-by-subject))
7103 @node Asynchronous Fetching
7104 @section Asynchronous Article Fetching
7105 @cindex asynchronous article fetching
7106 @cindex article pre-fetch
7109 If you read your news from an @acronym{NNTP} server that's far away, the
7110 network latencies may make reading articles a chore. You have to wait
7111 for a while after pressing @kbd{n} to go to the next article before the
7112 article appears. Why can't gnus just go ahead and fetch the article
7113 while you are reading the previous one? Why not, indeed.
7115 First, some caveats. There are some pitfalls to using asynchronous
7116 article fetching, especially the way gnus does it.
7118 Let's say you are reading article 1, which is short, and article 2 is
7119 quite long, and you are not interested in reading that. Gnus does not
7120 know this, so it goes ahead and fetches article 2. You decide to read
7121 article 3, but since gnus is in the process of fetching article 2, the
7122 connection is blocked.
7124 To avoid these situations, gnus will open two (count 'em two)
7125 connections to the server. Some people may think this isn't a very nice
7126 thing to do, but I don't see any real alternatives. Setting up that
7127 extra connection takes some time, so gnus startup will be slower.
7129 Gnus will fetch more articles than you will read. This will mean that
7130 the link between your machine and the @acronym{NNTP} server will become more
7131 loaded than if you didn't use article pre-fetch. The server itself will
7132 also become more loaded---both with the extra article requests, and the
7135 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7138 @vindex gnus-asynchronous
7139 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7140 happen automatically.
7142 @vindex gnus-use-article-prefetch
7143 You can control how many articles are to be pre-fetched by setting
7144 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7145 that when you read an article in the group, the back end will pre-fetch
7146 the next 30 articles. If this variable is @code{t}, the back end will
7147 pre-fetch all the articles it can without bound. If it is
7148 @code{nil}, no pre-fetching will be done.
7150 @vindex gnus-async-prefetch-article-p
7151 @findex gnus-async-read-p
7152 There are probably some articles that you don't want to pre-fetch---read
7153 articles, for instance. The @code{gnus-async-prefetch-article-p}
7154 variable controls whether an article is to be pre-fetched. This
7155 function should return non-@code{nil} when the article in question is
7156 to be pre-fetched. The default is @code{gnus-async-read-p}, which
7157 returns @code{nil} on read articles. The function is called with an
7158 article data structure as the only parameter.
7160 If, for instance, you wish to pre-fetch only unread articles shorter
7161 than 100 lines, you could say something like:
7164 (defun my-async-short-unread-p (data)
7165 "Return non-nil for short, unread articles."
7166 (and (gnus-data-unread-p data)
7167 (< (mail-header-lines (gnus-data-header data))
7170 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7173 These functions will be called many, many times, so they should
7174 preferably be short and sweet to avoid slowing down gnus too much.
7175 It's probably a good idea to byte-compile things like this.
7177 @vindex gnus-prefetched-article-deletion-strategy
7178 Articles have to be removed from the asynch buffer sooner or later. The
7179 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7180 articles. This is a list that may contain the following elements:
7184 Remove articles when they are read.
7187 Remove articles when exiting the group.
7190 The default value is @code{(read exit)}.
7192 @c @vindex gnus-use-header-prefetch
7193 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7194 @c from the next group.
7197 @node Article Caching
7198 @section Article Caching
7199 @cindex article caching
7202 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7203 consider turning article caching on. Each article will then be stored
7204 locally under your home directory. As you may surmise, this could
7205 potentially use @emph{huge} amounts of disk space, as well as eat up all
7206 your inodes so fast it will make your head swim. In vodka.
7208 Used carefully, though, it could be just an easier way to save articles.
7210 @vindex gnus-use-long-file-name
7211 @vindex gnus-cache-directory
7212 @vindex gnus-use-cache
7213 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7214 all articles ticked or marked as dormant will then be copied
7215 over to your local cache (@code{gnus-cache-directory}). Whether this
7216 cache is flat or hierarchical is controlled by the
7217 @code{gnus-use-long-file-name} variable, as usual.
7219 When re-selecting a ticked or dormant article, it will be fetched from the
7220 cache instead of from the server. As articles in your cache will never
7221 expire, this might serve as a method of saving articles while still
7222 keeping them where they belong. Just mark all articles you want to save
7223 as dormant, and don't worry.
7225 When an article is marked as read, is it removed from the cache.
7227 @vindex gnus-cache-remove-articles
7228 @vindex gnus-cache-enter-articles
7229 The entering/removal of articles from the cache is controlled by the
7230 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7231 variables. Both are lists of symbols. The first is @code{(ticked
7232 dormant)} by default, meaning that ticked and dormant articles will be
7233 put in the cache. The latter is @code{(read)} by default, meaning that
7234 articles marked as read are removed from the cache. Possibly
7235 symbols in these two lists are @code{ticked}, @code{dormant},
7236 @code{unread} and @code{read}.
7238 @findex gnus-jog-cache
7239 So where does the massive article-fetching and storing come into the
7240 picture? The @code{gnus-jog-cache} command will go through all
7241 subscribed newsgroups, request all unread articles, score them, and
7242 store them in the cache. You should only ever, ever ever ever, use this
7243 command if 1) your connection to the @acronym{NNTP} server is really, really,
7244 really slow and 2) you have a really, really, really huge disk.
7245 Seriously. One way to cut down on the number of articles downloaded is
7246 to score unwanted articles down and have them marked as read. They will
7247 not then be downloaded by this command.
7249 @vindex gnus-uncacheable-groups
7250 @vindex gnus-cacheable-groups
7251 It is likely that you do not want caching on all groups. For instance,
7252 if your @code{nnml} mail is located under your home directory, it makes no
7253 sense to cache it somewhere else under your home directory. Unless you
7254 feel that it's neat to use twice as much space.
7256 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7257 regexp of groups to cache, @samp{^nntp} for instance, or set the
7258 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7259 Both variables are @code{nil} by default. If a group matches both
7260 variables, the group is not cached.
7262 @findex gnus-cache-generate-nov-databases
7263 @findex gnus-cache-generate-active
7264 @vindex gnus-cache-active-file
7265 The cache stores information on what articles it contains in its active
7266 file (@code{gnus-cache-active-file}). If this file (or any other parts
7267 of the cache) becomes all messed up for some reason or other, gnus
7268 offers two functions that will try to set things right. @kbd{M-x
7269 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7270 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7273 @findex gnus-cache-move-cache
7274 @code{gnus-cache-move-cache} will move your whole
7275 @code{gnus-cache-directory} to some other location. You get asked to
7276 where, isn't that cool?
7278 @node Persistent Articles
7279 @section Persistent Articles
7280 @cindex persistent articles
7282 Closely related to article caching, we have @dfn{persistent articles}.
7283 In fact, it's just a different way of looking at caching, and much more
7284 useful in my opinion.
7286 Say you're reading a newsgroup, and you happen on to some valuable gem
7287 that you want to keep and treasure forever. You'd normally just save it
7288 (using one of the many saving commands) in some file. The problem with
7289 that is that it's just, well, yucky. Ideally you'd prefer just having
7290 the article remain in the group where you found it forever; untouched by
7291 the expiry going on at the news server.
7293 This is what a @dfn{persistent article} is---an article that just won't
7294 be deleted. It's implemented using the normal cache functions, but
7295 you use two explicit commands for managing persistent articles:
7301 @findex gnus-cache-enter-article
7302 Make the current article persistent (@code{gnus-cache-enter-article}).
7305 @kindex M-* (Summary)
7306 @findex gnus-cache-remove-article
7307 Remove the current article from the persistent articles
7308 (@code{gnus-cache-remove-article}). This will normally delete the
7312 Both these commands understand the process/prefix convention.
7314 To avoid having all ticked articles (and stuff) entered into the cache,
7315 you should set @code{gnus-use-cache} to @code{passive} if you're just
7316 interested in persistent articles:
7319 (setq gnus-use-cache 'passive)
7323 @node Article Backlog
7324 @section Article Backlog
7326 @cindex article backlog
7328 If you have a slow connection, but the idea of using caching seems
7329 unappealing to you (and it is, really), you can help the situation some
7330 by switching on the @dfn{backlog}. This is where gnus will buffer
7331 already read articles so that it doesn't have to re-fetch articles
7332 you've already read. This only helps if you are in the habit of
7333 re-selecting articles you've recently read, of course. If you never do
7334 that, turning the backlog on will slow gnus down a little bit, and
7335 increase memory usage some.
7337 @vindex gnus-keep-backlog
7338 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
7339 at most @var{n} old articles in a buffer for later re-fetching. If this
7340 variable is non-@code{nil} and is not a number, gnus will store
7341 @emph{all} read articles, which means that your Emacs will grow without
7342 bound before exploding and taking your machine down with you. I put
7343 that in there just to keep y'all on your toes.
7345 The default value is 20.
7348 @node Saving Articles
7349 @section Saving Articles
7350 @cindex saving articles
7352 Gnus can save articles in a number of ways. Below is the documentation
7353 for saving articles in a fairly straight-forward fashion (i.e., little
7354 processing of the article is done before it is saved). For a different
7355 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7356 (@pxref{Decoding Articles}).
7358 For the commands listed here, the target is a file. If you want to
7359 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7360 command (@pxref{Mail Group Commands}).
7362 @vindex gnus-save-all-headers
7363 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
7364 unwanted headers before saving the article.
7366 @vindex gnus-saved-headers
7367 If the preceding variable is @code{nil}, all headers that match the
7368 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7369 deleted before saving.
7375 @kindex O o (Summary)
7377 @findex gnus-summary-save-article
7378 @c @icon{gnus-summary-save-article}
7379 Save the current article using the default article saver
7380 (@code{gnus-summary-save-article}).
7383 @kindex O m (Summary)
7384 @findex gnus-summary-save-article-mail
7385 Save the current article in mail format
7386 (@code{gnus-summary-save-article-mail}).
7389 @kindex O r (Summary)
7390 @findex gnus-summary-save-article-rmail
7391 Save the current article in Rmail format
7392 (@code{gnus-summary-save-article-rmail}).
7395 @kindex O f (Summary)
7396 @findex gnus-summary-save-article-file
7397 @c @icon{gnus-summary-save-article-file}
7398 Save the current article in plain file format
7399 (@code{gnus-summary-save-article-file}).
7402 @kindex O F (Summary)
7403 @findex gnus-summary-write-article-file
7404 Write the current article in plain file format, overwriting any previous
7405 file contents (@code{gnus-summary-write-article-file}).
7408 @kindex O b (Summary)
7409 @findex gnus-summary-save-article-body-file
7410 Save the current article body in plain file format
7411 (@code{gnus-summary-save-article-body-file}).
7414 @kindex O h (Summary)
7415 @findex gnus-summary-save-article-folder
7416 Save the current article in mh folder format
7417 (@code{gnus-summary-save-article-folder}).
7420 @kindex O v (Summary)
7421 @findex gnus-summary-save-article-vm
7422 Save the current article in a VM folder
7423 (@code{gnus-summary-save-article-vm}).
7427 @kindex O p (Summary)
7429 @findex gnus-summary-pipe-output
7430 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7431 the current article to a process (@code{gnus-summary-pipe-output}).
7432 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7433 complete headers in the piped output.
7436 @kindex O P (Summary)
7437 @findex gnus-summary-muttprint
7438 @vindex gnus-summary-muttprint-program
7439 Save the current article into muttprint. That is, print it using the
7440 external program @uref{http://muttprint.sourceforge.net/,
7441 Muttprint}. The program name and options to use is controlled by the
7442 variable @code{gnus-summary-muttprint-program}.
7443 (@code{gnus-summary-muttprint}).
7447 @vindex gnus-prompt-before-saving
7448 All these commands use the process/prefix convention
7449 (@pxref{Process/Prefix}). If you save bunches of articles using these
7450 functions, you might get tired of being prompted for files to save each
7451 and every article in. The prompting action is controlled by
7452 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7453 default, giving you that excessive prompting action you know and
7454 loathe. If you set this variable to @code{t} instead, you'll be prompted
7455 just once for each series of articles you save. If you like to really
7456 have Gnus do all your thinking for you, you can even set this variable
7457 to @code{nil}, which means that you will never be prompted for files to
7458 save articles in. Gnus will simply save all the articles in the default
7462 @vindex gnus-default-article-saver
7463 You can customize the @code{gnus-default-article-saver} variable to make
7464 gnus do what you want it to. You can use any of the six ready-made
7465 functions below, or you can create your own.
7469 @item gnus-summary-save-in-rmail
7470 @findex gnus-summary-save-in-rmail
7471 @vindex gnus-rmail-save-name
7472 @findex gnus-plain-save-name
7473 This is the default format, @dfn{Babyl}. Uses the function in the
7474 @code{gnus-rmail-save-name} variable to get a file name to save the
7475 article in. The default is @code{gnus-plain-save-name}.
7477 @item gnus-summary-save-in-mail
7478 @findex gnus-summary-save-in-mail
7479 @vindex gnus-mail-save-name
7480 Save in a Unix mail (mbox) file. Uses the function in the
7481 @code{gnus-mail-save-name} variable to get a file name to save the
7482 article in. The default is @code{gnus-plain-save-name}.
7484 @item gnus-summary-save-in-file
7485 @findex gnus-summary-save-in-file
7486 @vindex gnus-file-save-name
7487 @findex gnus-numeric-save-name
7488 Append the article straight to an ordinary file. Uses the function in
7489 the @code{gnus-file-save-name} variable to get a file name to save the
7490 article in. The default is @code{gnus-numeric-save-name}.
7492 @item gnus-summary-write-to-file
7493 @findex gnus-summary-write-to-file
7494 Write the article straight to an ordinary file. The file is
7495 overwritten if it exists. Uses the function in the
7496 @code{gnus-file-save-name} variable to get a file name to save the
7497 article in. The default is @code{gnus-numeric-save-name}.
7499 @item gnus-summary-save-body-in-file
7500 @findex gnus-summary-save-body-in-file
7501 Append the article body to an ordinary file. Uses the function in the
7502 @code{gnus-file-save-name} variable to get a file name to save the
7503 article in. The default is @code{gnus-numeric-save-name}.
7505 @item gnus-summary-save-in-folder
7506 @findex gnus-summary-save-in-folder
7507 @findex gnus-folder-save-name
7508 @findex gnus-Folder-save-name
7509 @vindex gnus-folder-save-name
7512 Save the article to an MH folder using @code{rcvstore} from the MH
7513 library. Uses the function in the @code{gnus-folder-save-name} variable
7514 to get a file name to save the article in. The default is
7515 @code{gnus-folder-save-name}, but you can also use
7516 @code{gnus-Folder-save-name}, which creates capitalized names.
7518 @item gnus-summary-save-in-vm
7519 @findex gnus-summary-save-in-vm
7520 Save the article in a VM folder. You have to have the VM mail
7521 reader to use this setting.
7524 @vindex gnus-article-save-directory
7525 All of these functions, except for the last one, will save the article
7526 in the @code{gnus-article-save-directory}, which is initialized from the
7527 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7530 As you can see above, the functions use different functions to find a
7531 suitable name of a file to save the article in. Below is a list of
7532 available functions that generate names:
7536 @item gnus-Numeric-save-name
7537 @findex gnus-Numeric-save-name
7538 File names like @file{~/News/Alt.andrea-dworkin/45}.
7540 @item gnus-numeric-save-name
7541 @findex gnus-numeric-save-name
7542 File names like @file{~/News/alt.andrea-dworkin/45}.
7544 @item gnus-Plain-save-name
7545 @findex gnus-Plain-save-name
7546 File names like @file{~/News/Alt.andrea-dworkin}.
7548 @item gnus-plain-save-name
7549 @findex gnus-plain-save-name
7550 File names like @file{~/News/alt.andrea-dworkin}.
7552 @item gnus-sender-save-name
7553 @findex gnus-sender-save-name
7554 File names like @file{~/News/larsi}.
7557 @vindex gnus-split-methods
7558 You can have gnus suggest where to save articles by plonking a regexp into
7559 the @code{gnus-split-methods} alist. For instance, if you would like to
7560 save articles related to gnus in the file @file{gnus-stuff}, and articles
7561 related to VM in @file{vm-stuff}, you could set this variable to something
7565 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7566 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7567 (my-choosing-function "../other-dir/my-stuff")
7568 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7571 We see that this is a list where each element is a list that has two
7572 elements---the @dfn{match} and the @dfn{file}. The match can either be
7573 a string (in which case it is used as a regexp to match on the article
7574 head); it can be a symbol (which will be called as a function with the
7575 group name as a parameter); or it can be a list (which will be
7576 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7577 the @dfn{file} will be used as a default prompt. In addition, the
7578 result of the operation itself will be used if the function or form
7579 called returns a string or a list of strings.
7581 You basically end up with a list of file names that might be used when
7582 saving the current article. (All ``matches'' will be used.) You will
7583 then be prompted for what you really want to use as a name, with file
7584 name completion over the results from applying this variable.
7586 This variable is @code{((gnus-article-archive-name))} by default, which
7587 means that gnus will look at the articles it saves for an
7588 @code{Archive-name} line and use that as a suggestion for the file
7591 Here's an example function to clean up file names somewhat. If you have
7592 lots of mail groups called things like
7593 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7594 these group names before creating the file name to save to. The
7595 following will do just that:
7598 (defun my-save-name (group)
7599 (when (string-match "^nnml:mail." group)
7600 (substring group (match-end 0))))
7602 (setq gnus-split-methods
7603 '((gnus-article-archive-name)
7608 @vindex gnus-use-long-file-name
7609 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7610 @code{nil}, all the preceding functions will replace all periods
7611 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7612 the functions will generate hierarchies of directories instead of having
7613 all the files in the top level directory
7614 (@file{~/News/alt/andrea-dworkin} instead of
7615 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7616 on most systems. However, for historical reasons, this is @code{nil} on
7617 Xenix and usg-unix-v machines by default.
7619 This function also affects kill and score file names. If this variable
7620 is a list, and the list contains the element @code{not-score}, long file
7621 names will not be used for score files, if it contains the element
7622 @code{not-save}, long file names will not be used for saving, and if it
7623 contains the element @code{not-kill}, long file names will not be used
7626 If you'd like to save articles in a hierarchy that looks something like
7630 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
7631 (setq gnus-default-article-saver
7632 'gnus-summary-save-in-file) ; @r{no encoding}
7635 Then just save with @kbd{o}. You'd then read this hierarchy with
7636 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7637 the top level directory as the argument (@file{~/News/}). Then just walk
7638 around to the groups/directories with @code{nneething}.
7641 @node Decoding Articles
7642 @section Decoding Articles
7643 @cindex decoding articles
7645 Sometime users post articles (or series of articles) that have been
7646 encoded in some way or other. Gnus can decode them for you.
7649 * Uuencoded Articles:: Uudecode articles.
7650 * Shell Archives:: Unshar articles.
7651 * PostScript Files:: Split PostScript.
7652 * Other Files:: Plain save and binhex.
7653 * Decoding Variables:: Variables for a happy decoding.
7654 * Viewing Files:: You want to look at the result of the decoding?
7658 @cindex article series
7659 All these functions use the process/prefix convention
7660 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7661 the extension that a ``single article'' means ``a single series''. Gnus
7662 can find out by itself what articles belong to a series, decode all the
7663 articles and unpack/view/save the resulting file(s).
7665 Gnus guesses what articles are in the series according to the following
7666 simplish rule: The subjects must be (nearly) identical, except for the
7667 last two numbers of the line. (Spaces are largely ignored, however.)
7669 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
7670 will find all the articles that match the regexp @samp{^cat.gif
7671 ([0-9]+/[0-9]+).*$}.
7673 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7674 series}, will not be properly recognized by any of the automatic viewing
7675 commands, and you have to mark the articles manually with @kbd{#}.
7678 @node Uuencoded Articles
7679 @subsection Uuencoded Articles
7681 @cindex uuencoded articles
7686 @kindex X u (Summary)
7687 @findex gnus-uu-decode-uu
7688 @c @icon{gnus-uu-decode-uu}
7689 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7692 @kindex X U (Summary)
7693 @findex gnus-uu-decode-uu-and-save
7694 Uudecodes and saves the current series
7695 (@code{gnus-uu-decode-uu-and-save}).
7698 @kindex X v u (Summary)
7699 @findex gnus-uu-decode-uu-view
7700 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7703 @kindex X v U (Summary)
7704 @findex gnus-uu-decode-uu-and-save-view
7705 Uudecodes, views and saves the current series
7706 (@code{gnus-uu-decode-uu-and-save-view}).
7710 Remember that these all react to the presence of articles marked with
7711 the process mark. If, for instance, you'd like to decode and save an
7712 entire newsgroup, you'd typically do @kbd{M P a}
7713 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7714 (@code{gnus-uu-decode-uu-and-save}).
7716 All this is very much different from how @code{gnus-uu} worked with
7717 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7718 the sun. This version of @code{gnus-uu} generally assumes that you mark
7719 articles in some way (@pxref{Setting Process Marks}) and then press
7722 @vindex gnus-uu-notify-files
7723 Note: When trying to decode articles that have names matching
7724 @code{gnus-uu-notify-files}, which is hard-coded to
7725 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7726 automatically post an article on @samp{comp.unix.wizards} saying that
7727 you have just viewed the file in question. This feature can't be turned
7731 @node Shell Archives
7732 @subsection Shell Archives
7734 @cindex shell archives
7735 @cindex shared articles
7737 Shell archives (``shar files'') used to be a popular way to distribute
7738 sources, but it isn't used all that much today. In any case, we have
7739 some commands to deal with these:
7744 @kindex X s (Summary)
7745 @findex gnus-uu-decode-unshar
7746 Unshars the current series (@code{gnus-uu-decode-unshar}).
7749 @kindex X S (Summary)
7750 @findex gnus-uu-decode-unshar-and-save
7751 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7754 @kindex X v s (Summary)
7755 @findex gnus-uu-decode-unshar-view
7756 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7759 @kindex X v S (Summary)
7760 @findex gnus-uu-decode-unshar-and-save-view
7761 Unshars, views and saves the current series
7762 (@code{gnus-uu-decode-unshar-and-save-view}).
7766 @node PostScript Files
7767 @subsection PostScript Files
7773 @kindex X p (Summary)
7774 @findex gnus-uu-decode-postscript
7775 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7778 @kindex X P (Summary)
7779 @findex gnus-uu-decode-postscript-and-save
7780 Unpack and save the current PostScript series
7781 (@code{gnus-uu-decode-postscript-and-save}).
7784 @kindex X v p (Summary)
7785 @findex gnus-uu-decode-postscript-view
7786 View the current PostScript series
7787 (@code{gnus-uu-decode-postscript-view}).
7790 @kindex X v P (Summary)
7791 @findex gnus-uu-decode-postscript-and-save-view
7792 View and save the current PostScript series
7793 (@code{gnus-uu-decode-postscript-and-save-view}).
7798 @subsection Other Files
7802 @kindex X o (Summary)
7803 @findex gnus-uu-decode-save
7804 Save the current series
7805 (@code{gnus-uu-decode-save}).
7808 @kindex X b (Summary)
7809 @findex gnus-uu-decode-binhex
7810 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7811 doesn't really work yet.
7815 @node Decoding Variables
7816 @subsection Decoding Variables
7818 Adjective, not verb.
7821 * Rule Variables:: Variables that say how a file is to be viewed.
7822 * Other Decode Variables:: Other decode variables.
7823 * Uuencoding and Posting:: Variables for customizing uuencoding.
7827 @node Rule Variables
7828 @subsubsection Rule Variables
7829 @cindex rule variables
7831 Gnus uses @dfn{rule variables} to decide how to view a file. All these
7832 variables are of the form
7835 (list '(regexp1 command2)
7842 @item gnus-uu-user-view-rules
7843 @vindex gnus-uu-user-view-rules
7845 This variable is consulted first when viewing files. If you wish to use,
7846 for instance, @code{sox} to convert an @file{.au} sound file, you could
7849 (setq gnus-uu-user-view-rules
7850 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7853 @item gnus-uu-user-view-rules-end
7854 @vindex gnus-uu-user-view-rules-end
7855 This variable is consulted if gnus couldn't make any matches from the
7856 user and default view rules.
7858 @item gnus-uu-user-archive-rules
7859 @vindex gnus-uu-user-archive-rules
7860 This variable can be used to say what commands should be used to unpack
7865 @node Other Decode Variables
7866 @subsubsection Other Decode Variables
7869 @vindex gnus-uu-grabbed-file-functions
7871 @item gnus-uu-grabbed-file-functions
7872 All functions in this list will be called right after each file has been
7873 successfully decoded---so that you can move or view files right away,
7874 and don't have to wait for all files to be decoded before you can do
7875 anything. Ready-made functions you can put in this list are:
7879 @item gnus-uu-grab-view
7880 @findex gnus-uu-grab-view
7883 @item gnus-uu-grab-move
7884 @findex gnus-uu-grab-move
7885 Move the file (if you're using a saving function.)
7888 @item gnus-uu-be-dangerous
7889 @vindex gnus-uu-be-dangerous
7890 Specifies what to do if unusual situations arise during decoding. If
7891 @code{nil}, be as conservative as possible. If @code{t}, ignore things
7892 that didn't work, and overwrite existing files. Otherwise, ask each
7895 @item gnus-uu-ignore-files-by-name
7896 @vindex gnus-uu-ignore-files-by-name
7897 Files with name matching this regular expression won't be viewed.
7899 @item gnus-uu-ignore-files-by-type
7900 @vindex gnus-uu-ignore-files-by-type
7901 Files with a @acronym{MIME} type matching this variable won't be viewed.
7902 Note that Gnus tries to guess what type the file is based on the name.
7903 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
7906 @item gnus-uu-tmp-dir
7907 @vindex gnus-uu-tmp-dir
7908 Where @code{gnus-uu} does its work.
7910 @item gnus-uu-do-not-unpack-archives
7911 @vindex gnus-uu-do-not-unpack-archives
7912 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7913 looking for files to display.
7915 @item gnus-uu-view-and-save
7916 @vindex gnus-uu-view-and-save
7917 Non-@code{nil} means that the user will always be asked to save a file
7920 @item gnus-uu-ignore-default-view-rules
7921 @vindex gnus-uu-ignore-default-view-rules
7922 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7925 @item gnus-uu-ignore-default-archive-rules
7926 @vindex gnus-uu-ignore-default-archive-rules
7927 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7930 @item gnus-uu-kill-carriage-return
7931 @vindex gnus-uu-kill-carriage-return
7932 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7935 @item gnus-uu-unmark-articles-not-decoded
7936 @vindex gnus-uu-unmark-articles-not-decoded
7937 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7938 decoded articles as unread.
7940 @item gnus-uu-correct-stripped-uucode
7941 @vindex gnus-uu-correct-stripped-uucode
7942 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7943 uuencoded files that have had trailing spaces deleted.
7945 @item gnus-uu-pre-uudecode-hook
7946 @vindex gnus-uu-pre-uudecode-hook
7947 Hook run before sending a message to @code{uudecode}.
7949 @item gnus-uu-view-with-metamail
7950 @vindex gnus-uu-view-with-metamail
7952 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7953 commands defined by the rule variables and just fudge a @acronym{MIME}
7954 content type based on the file name. The result will be fed to
7955 @code{metamail} for viewing.
7957 @item gnus-uu-save-in-digest
7958 @vindex gnus-uu-save-in-digest
7959 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7960 decoding, will save in digests. If this variable is @code{nil},
7961 @code{gnus-uu} will just save everything in a file without any
7962 embellishments. The digesting almost conforms to RFC 1153---no easy way
7963 to specify any meaningful volume and issue numbers were found, so I
7964 simply dropped them.
7969 @node Uuencoding and Posting
7970 @subsubsection Uuencoding and Posting
7974 @item gnus-uu-post-include-before-composing
7975 @vindex gnus-uu-post-include-before-composing
7976 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7977 before you compose the article. If this variable is @code{t}, you can
7978 either include an encoded file with @kbd{C-c C-i} or have one included
7979 for you when you post the article.
7981 @item gnus-uu-post-length
7982 @vindex gnus-uu-post-length
7983 Maximum length of an article. The encoded file will be split into how
7984 many articles it takes to post the entire file.
7986 @item gnus-uu-post-threaded
7987 @vindex gnus-uu-post-threaded
7988 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7989 thread. This may not be smart, as no other decoder I have seen is able
7990 to follow threads when collecting uuencoded articles. (Well, I have
7991 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7992 think that counts@dots{}) Default is @code{nil}.
7994 @item gnus-uu-post-separate-description
7995 @vindex gnus-uu-post-separate-description
7996 Non-@code{nil} means that the description will be posted in a separate
7997 article. The first article will typically be numbered (0/x). If this
7998 variable is @code{nil}, the description the user enters will be included
7999 at the beginning of the first article, which will be numbered (1/x).
8000 Default is @code{t}.
8006 @subsection Viewing Files
8007 @cindex viewing files
8008 @cindex pseudo-articles
8010 After decoding, if the file is some sort of archive, gnus will attempt
8011 to unpack the archive and see if any of the files in the archive can be
8012 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
8013 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
8014 uncompress and de-tar the main file, and then view the two pictures.
8015 This unpacking process is recursive, so if the archive contains archives
8016 of archives, it'll all be unpacked.
8018 Finally, gnus will normally insert a @dfn{pseudo-article} for each
8019 extracted file into the summary buffer. If you go to these
8020 ``articles'', you will be prompted for a command to run (usually Gnus
8021 will make a suggestion), and then the command will be run.
8023 @vindex gnus-view-pseudo-asynchronously
8024 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
8025 until the viewing is done before proceeding.
8027 @vindex gnus-view-pseudos
8028 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8029 the pseudo-articles into the summary buffer, but view them
8030 immediately. If this variable is @code{not-confirm}, the user won't even
8031 be asked for a confirmation before viewing is done.
8033 @vindex gnus-view-pseudos-separately
8034 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8035 pseudo-article will be created for each file to be viewed. If
8036 @code{nil}, all files that use the same viewing command will be given as
8037 a list of parameters to that command.
8039 @vindex gnus-insert-pseudo-articles
8040 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8041 pseudo-articles when decoding. It is @code{t} by default.
8043 So; there you are, reading your @emph{pseudo-articles} in your
8044 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8045 Why isn't anything real anymore? How did we get here?
8048 @node Article Treatment
8049 @section Article Treatment
8051 Reading through this huge manual, you may have quite forgotten that the
8052 object of newsreaders is to actually, like, read what people have
8053 written. Reading articles. Unfortunately, people are quite bad at
8054 writing, so there are tons of functions and variables to make reading
8055 these articles easier.
8058 * Article Highlighting:: You want to make the article look like fruit salad.
8059 * Article Fontisizing:: Making emphasized text look nice.
8060 * Article Hiding:: You also want to make certain info go away.
8061 * Article Washing:: Lots of way-neat functions to make life better.
8062 * Article Header:: Doing various header transformations.
8063 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8064 * Article Button Levels:: Controlling appearance of buttons.
8065 * Article Date:: Grumble, UT!
8066 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8067 * Article Signature:: What is a signature?
8068 * Article Miscellanea:: Various other stuff.
8072 @node Article Highlighting
8073 @subsection Article Highlighting
8074 @cindex highlighting
8076 Not only do you want your article buffer to look like fruit salad, but
8077 you want it to look like technicolor fruit salad.
8082 @kindex W H a (Summary)
8083 @findex gnus-article-highlight
8084 @findex gnus-article-maybe-highlight
8085 Do much highlighting of the current article
8086 (@code{gnus-article-highlight}). This function highlights header, cited
8087 text, the signature, and adds buttons to the body and the head.
8090 @kindex W H h (Summary)
8091 @findex gnus-article-highlight-headers
8092 @vindex gnus-header-face-alist
8093 Highlight the headers (@code{gnus-article-highlight-headers}). The
8094 highlighting will be done according to the @code{gnus-header-face-alist}
8095 variable, which is a list where each element has the form
8096 @code{(@var{regexp} @var{name} @var{content})}.
8097 @var{regexp} is a regular expression for matching the
8098 header, @var{name} is the face used for highlighting the header name
8099 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8100 the header value. The first match made will be used. Note that
8101 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8104 @kindex W H c (Summary)
8105 @findex gnus-article-highlight-citation
8106 Highlight cited text (@code{gnus-article-highlight-citation}).
8108 Some variables to customize the citation highlights:
8111 @vindex gnus-cite-parse-max-size
8113 @item gnus-cite-parse-max-size
8114 If the article size if bigger than this variable (which is 25000 by
8115 default), no citation highlighting will be performed.
8117 @item gnus-cite-max-prefix
8118 @vindex gnus-cite-max-prefix
8119 Maximum possible length for a citation prefix (default 20).
8121 @item gnus-cite-face-list
8122 @vindex gnus-cite-face-list
8123 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8124 When there are citations from multiple articles in the same message,
8125 gnus will try to give each citation from each article its own face.
8126 This should make it easier to see who wrote what.
8128 @item gnus-supercite-regexp
8129 @vindex gnus-supercite-regexp
8130 Regexp matching normal Supercite attribution lines.
8132 @item gnus-supercite-secondary-regexp
8133 @vindex gnus-supercite-secondary-regexp
8134 Regexp matching mangled Supercite attribution lines.
8136 @item gnus-cite-minimum-match-count
8137 @vindex gnus-cite-minimum-match-count
8138 Minimum number of identical prefixes we have to see before we believe
8139 that it's a citation.
8141 @item gnus-cite-attribution-prefix
8142 @vindex gnus-cite-attribution-prefix
8143 Regexp matching the beginning of an attribution line.
8145 @item gnus-cite-attribution-suffix
8146 @vindex gnus-cite-attribution-suffix
8147 Regexp matching the end of an attribution line.
8149 @item gnus-cite-attribution-face
8150 @vindex gnus-cite-attribution-face
8151 Face used for attribution lines. It is merged with the face for the
8152 cited text belonging to the attribution.
8154 @item gnus-cite-ignore-quoted-from
8155 @vindex gnus-cite-ignore-quoted-from
8156 If non-@code{nil}, no citation highlighting will be performed on lines
8157 beginning with @samp{>From }. Those lines may have been quoted by MTAs
8158 in order not to mix up with the envelope From line. The default value
8165 @kindex W H s (Summary)
8166 @vindex gnus-signature-separator
8167 @vindex gnus-signature-face
8168 @findex gnus-article-highlight-signature
8169 Highlight the signature (@code{gnus-article-highlight-signature}).
8170 Everything after @code{gnus-signature-separator} (@pxref{Article
8171 Signature}) in an article will be considered a signature and will be
8172 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8177 @xref{Customizing Articles}, for how to highlight articles automatically.
8180 @node Article Fontisizing
8181 @subsection Article Fontisizing
8183 @cindex article emphasis
8185 @findex gnus-article-emphasize
8186 @kindex W e (Summary)
8187 People commonly add emphasis to words in news articles by writing things
8188 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8189 this look nicer by running the article through the @kbd{W e}
8190 (@code{gnus-article-emphasize}) command.
8192 @vindex gnus-emphasis-alist
8193 How the emphasis is computed is controlled by the
8194 @code{gnus-emphasis-alist} variable. This is an alist where the first
8195 element is a regular expression to be matched. The second is a number
8196 that says what regular expression grouping is used to find the entire
8197 emphasized word. The third is a number that says what regexp grouping
8198 should be displayed and highlighted. (The text between these two
8199 groupings will be hidden.) The fourth is the face used for
8203 (setq gnus-emphasis-alist
8204 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8205 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8214 @vindex gnus-emphasis-underline
8215 @vindex gnus-emphasis-bold
8216 @vindex gnus-emphasis-italic
8217 @vindex gnus-emphasis-underline-bold
8218 @vindex gnus-emphasis-underline-italic
8219 @vindex gnus-emphasis-bold-italic
8220 @vindex gnus-emphasis-underline-bold-italic
8221 By default, there are seven rules, and they use the following faces:
8222 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8223 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8224 @code{gnus-emphasis-underline-italic},
8225 @code{gnus-emphasis-underline-bold}, and
8226 @code{gnus-emphasis-underline-bold-italic}.
8228 If you want to change these faces, you can either use @kbd{M-x
8229 customize}, or you can use @code{copy-face}. For instance, if you want
8230 to make @code{gnus-emphasis-italic} use a red face instead, you could
8234 (copy-face 'red 'gnus-emphasis-italic)
8237 @vindex gnus-group-highlight-words-alist
8239 If you want to highlight arbitrary words, you can use the
8240 @code{gnus-group-highlight-words-alist} variable, which uses the same
8241 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8242 parameter (@pxref{Group Parameters}) can also be used.
8244 @xref{Customizing Articles}, for how to fontize articles automatically.
8247 @node Article Hiding
8248 @subsection Article Hiding
8249 @cindex article hiding
8251 Or rather, hiding certain things in each article. There usually is much
8252 too much cruft in most articles.
8257 @kindex W W a (Summary)
8258 @findex gnus-article-hide
8259 Do quite a lot of hiding on the article buffer
8260 (@kbd{gnus-article-hide}). In particular, this function will hide
8261 headers, @acronym{PGP}, cited text and the signature.
8264 @kindex W W h (Summary)
8265 @findex gnus-article-hide-headers
8266 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8270 @kindex W W b (Summary)
8271 @findex gnus-article-hide-boring-headers
8272 Hide headers that aren't particularly interesting
8273 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8276 @kindex W W s (Summary)
8277 @findex gnus-article-hide-signature
8278 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8282 @kindex W W l (Summary)
8283 @findex gnus-article-hide-list-identifiers
8284 @vindex gnus-list-identifiers
8285 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8286 are strings some mailing list servers add to the beginning of all
8287 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8288 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8289 may not contain @code{\\(..\\)}.
8293 @item gnus-list-identifiers
8294 @vindex gnus-list-identifiers
8295 A regular expression that matches list identifiers to be removed from
8296 subject. This can also be a list of regular expressions.
8301 @kindex W W P (Summary)
8302 @findex gnus-article-hide-pem
8303 Hide @acronym{PEM} (privacy enhanced messages) cruft
8304 (@code{gnus-article-hide-pem}).
8307 @kindex W W B (Summary)
8308 @findex gnus-article-strip-banner
8309 @vindex gnus-article-banner-alist
8310 @vindex gnus-article-address-banner-alist
8313 @cindex stripping advertisements
8314 @cindex advertisements
8315 Strip the banner specified by the @code{banner} group parameter
8316 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8317 annoying banners and/or signatures that some mailing lists and moderated
8318 groups adds to all the messages. The way to use this function is to add
8319 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8320 group you want banners stripped from. The parameter either be a string,
8321 which will be interpreted as a regular expression matching text to be
8322 removed, or the symbol @code{signature}, meaning that the (last)
8323 signature should be removed, or other symbol, meaning that the
8324 corresponding regular expression in @code{gnus-article-banner-alist} is
8327 Regardless of a group, you can hide things like advertisements only when
8328 the sender of an article has a certain mail address specified in
8329 @code{gnus-article-address-banner-alist}.
8333 @item gnus-article-address-banner-alist
8334 @vindex gnus-article-address-banner-alist
8335 Alist of mail addresses and banners. Each element has the form
8336 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8337 matching a mail address in the From header, @var{banner} is one of a
8338 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8339 a regexp and @code{nil}. If @var{address} matches author's mail
8340 address, it will remove things like advertisements. For example, if a
8341 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8342 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8343 sends, you can use the following element to remove them:
8346 ("@@yoo-hoo\\.co\\.jp\\'" .
8347 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8353 @kindex W W c (Summary)
8354 @findex gnus-article-hide-citation
8355 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8356 customizing the hiding:
8360 @item gnus-cited-opened-text-button-line-format
8361 @itemx gnus-cited-closed-text-button-line-format
8362 @vindex gnus-cited-closed-text-button-line-format
8363 @vindex gnus-cited-opened-text-button-line-format
8364 Gnus adds buttons to show where the cited text has been hidden, and to
8365 allow toggle hiding the text. The format of the variable is specified
8366 by these format-like variable (@pxref{Formatting Variables}). These
8371 Starting point of the hidden text.
8373 Ending point of the hidden text.
8375 Number of characters in the hidden region.
8377 Number of lines of hidden text.
8380 @item gnus-cited-lines-visible
8381 @vindex gnus-cited-lines-visible
8382 The number of lines at the beginning of the cited text to leave
8383 shown. This can also be a cons cell with the number of lines at the top
8384 and bottom of the text, respectively, to remain visible.
8389 @kindex W W C-c (Summary)
8390 @findex gnus-article-hide-citation-maybe
8392 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8393 following two variables:
8396 @item gnus-cite-hide-percentage
8397 @vindex gnus-cite-hide-percentage
8398 If the cited text is of a bigger percentage than this variable (default
8399 50), hide the cited text.
8401 @item gnus-cite-hide-absolute
8402 @vindex gnus-cite-hide-absolute
8403 The cited text must have at least this length (default 10) before it
8408 @kindex W W C (Summary)
8409 @findex gnus-article-hide-citation-in-followups
8410 Hide cited text in articles that aren't roots
8411 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8412 useful as an interactive command, but might be a handy function to stick
8413 have happen automatically (@pxref{Customizing Articles}).
8417 All these ``hiding'' commands are toggles, but if you give a negative
8418 prefix to these commands, they will show what they have previously
8419 hidden. If you give a positive prefix, they will always hide.
8421 Also @pxref{Article Highlighting} for further variables for
8422 citation customization.
8424 @xref{Customizing Articles}, for how to hide article elements
8428 @node Article Washing
8429 @subsection Article Washing
8431 @cindex article washing
8433 We call this ``article washing'' for a really good reason. Namely, the
8434 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8436 @dfn{Washing} is defined by us as ``changing something from something to
8437 something else'', but normally results in something looking better.
8440 @xref{Customizing Articles}, if you want to change how Gnus displays
8441 articles by default.
8446 This is not really washing, it's sort of the opposite of washing. If
8447 you type this, you see the article exactly as it exists on disk or on
8451 Force redisplaying of the current article
8452 (@code{gnus-summary-show-article}). This is also not really washing.
8453 If you type this, you see the article without any previously applied
8454 interactive Washing functions but with all default treatments
8455 (@pxref{Customizing Articles}).
8458 @kindex W l (Summary)
8459 @findex gnus-summary-stop-page-breaking
8460 Remove page breaks from the current article
8461 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8465 @kindex W r (Summary)
8466 @findex gnus-summary-caesar-message
8467 @c @icon{gnus-summary-caesar-message}
8468 Do a Caesar rotate (rot13) on the article buffer
8469 (@code{gnus-summary-caesar-message}).
8470 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8471 (Typically offensive jokes and such.)
8473 It's commonly called ``rot13'' because each letter is rotated 13
8474 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8475 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8476 is rumored to have employed this form of, uh, somewhat weak encryption.
8479 @kindex W m (Summary)
8480 @findex gnus-summary-morse-message
8481 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8484 @kindex W i (Summary)
8485 @findex gnus-summary-idna-message
8486 Decode IDNA encoded domain names in the current articles. IDNA
8487 encoded domain names looks like @samp{xn--bar}. If a string remain
8488 unencoded after running invoking this, it is likely an invalid IDNA
8489 string (@samp{xn--bar} is invalid). You must have GNU Libidn
8490 (@url{http://www.gnu.org/software/libidn/}) installed for this command
8495 @kindex W t (Summary)
8497 @findex gnus-summary-toggle-header
8498 Toggle whether to display all headers in the article buffer
8499 (@code{gnus-summary-toggle-header}).
8502 @kindex W v (Summary)
8503 @findex gnus-summary-verbose-headers
8504 Toggle whether to display all headers in the article buffer permanently
8505 (@code{gnus-summary-verbose-headers}).
8508 @kindex W m (Summary)
8509 @findex gnus-summary-toggle-mime
8510 Toggle whether to run the article through @acronym{MIME} before
8511 displaying (@code{gnus-summary-toggle-mime}).
8514 @kindex W o (Summary)
8515 @findex gnus-article-treat-overstrike
8516 Treat overstrike (@code{gnus-article-treat-overstrike}).
8519 @kindex W d (Summary)
8520 @findex gnus-article-treat-dumbquotes
8521 @vindex gnus-article-dumbquotes-map
8523 @cindex M****s*** sm*rtq**t*s
8525 Treat M****s*** sm*rtq**t*s according to
8526 @code{gnus-article-dumbquotes-map}
8527 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8528 whether a character is a sm*rtq**t* or not, so it should only be used
8531 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8532 an attempt to provide more quoting characters. If you see something
8533 like @code{\222} or @code{\264} where you're expecting some kind of
8534 apostrophe or quotation mark, then try this wash.
8537 @kindex W Y f (Summary)
8538 @findex gnus-article-outlook-deuglify-article
8539 @cindex Outlook Express
8540 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8541 unwrap lines, repair attribution and rearrange citation.
8542 (@code{gnus-article-outlook-deuglify-article}).
8545 @kindex W Y u (Summary)
8546 @findex gnus-article-outlook-unwrap-lines
8547 @vindex gnus-outlook-deuglify-unwrap-min
8548 @vindex gnus-outlook-deuglify-unwrap-max
8549 Unwrap lines that appear to be wrapped citation lines. You can control
8550 what lines will be unwrapped by frobbing
8551 @code{gnus-outlook-deuglify-unwrap-min} and
8552 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8553 maximum length of an unwrapped citation line.
8554 (@code{gnus-article-outlook-unwrap-lines}).
8557 @kindex W Y a (Summary)
8558 @findex gnus-article-outlook-repair-attribution
8559 Repair a broken attribution line.@*
8560 (@code{gnus-article-outlook-repair-attribution}).
8563 @kindex W Y c (Summary)
8564 @findex gnus-article-outlook-rearrange-citation
8565 Repair broken citations by rearranging the text.
8566 (@code{gnus-article-outlook-rearrange-citation}).
8569 @kindex W w (Summary)
8570 @findex gnus-article-fill-cited-article
8571 Do word wrap (@code{gnus-article-fill-cited-article}).
8573 You can give the command a numerical prefix to specify the width to use
8577 @kindex W Q (Summary)
8578 @findex gnus-article-fill-long-lines
8579 Fill long lines (@code{gnus-article-fill-long-lines}).
8582 @kindex W C (Summary)
8583 @findex gnus-article-capitalize-sentences
8584 Capitalize the first word in each sentence
8585 (@code{gnus-article-capitalize-sentences}).
8588 @kindex W c (Summary)
8589 @findex gnus-article-remove-cr
8590 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8591 (this takes care of DOS line endings), and then translate any remaining
8592 CRs into LF (this takes care of Mac line endings)
8593 (@code{gnus-article-remove-cr}).
8595 @kindex W q (Summary)
8596 @findex gnus-article-de-quoted-unreadable
8597 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8598 Quoted-Printable is one common @acronym{MIME} encoding employed when
8599 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8600 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
8601 which doesn't look very readable to me. Note that this is usually
8602 done automatically by Gnus if the message in question has a
8603 @code{Content-Transfer-Encoding} header that says that this encoding
8604 has been done. If a prefix is given, a charset will be asked for.
8607 @kindex W 6 (Summary)
8608 @findex gnus-article-de-base64-unreadable
8609 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8610 one common @acronym{MIME} encoding employed when sending
8611 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8612 usually done automatically by Gnus if the message in question has a
8613 @code{Content-Transfer-Encoding} header that says that this encoding
8614 has been done. If a prefix is given, a charset will be asked for.
8617 @kindex W Z (Summary)
8618 @findex gnus-article-decode-HZ
8619 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8620 common encoding employed when sending Chinese articles. It typically
8621 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8624 @kindex W A (Summary)
8625 @findex gnus-article-treat-ansi-sequences
8626 @cindex @acronym{ANSI} control sequences
8627 Translate @acronym{ANSI} SGR control sequences into overlays or
8628 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
8629 sequences are used in some Chinese hierarchies for highlighting.
8632 @kindex W u (Summary)
8633 @findex gnus-article-unsplit-urls
8634 Remove newlines from within URLs. Some mailers insert newlines into
8635 outgoing email messages to keep lines short. This reformatting can
8636 split long URLs onto multiple lines. Repair those URLs by removing
8637 the newlines (@code{gnus-article-unsplit-urls}).
8640 @kindex W h (Summary)
8641 @findex gnus-article-wash-html
8642 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
8643 usually done automatically by Gnus if the message in question has a
8644 @code{Content-Type} header that says that the message is @acronym{HTML}.
8646 If a prefix is given, a charset will be asked for.
8648 @vindex gnus-article-wash-function
8649 The default is to use the function specified by
8650 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
8651 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8652 @acronym{HTML}, but this is controlled by the
8653 @code{gnus-article-wash-function} variable. Pre-defined functions you
8661 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
8664 Use @uref{http://links.sf.net/, Links}.
8667 Use @uref{http://lynx.isc.org/, Lynx}.
8670 Use html2text---a simple @acronym{HTML} converter included with Gnus.
8675 @kindex W b (Summary)
8676 @findex gnus-article-add-buttons
8677 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8678 @xref{Article Buttons}.
8681 @kindex W B (Summary)
8682 @findex gnus-article-add-buttons-to-head
8683 Add clickable buttons to the article headers
8684 (@code{gnus-article-add-buttons-to-head}).
8687 @kindex W p (Summary)
8688 @findex gnus-article-verify-x-pgp-sig
8689 Verify a signed control message
8690 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
8691 @code{newgroup} and @code{checkgroups} are usually signed by the
8692 hierarchy maintainer. You need to add the @acronym{PGP} public key of
8693 the maintainer to your keyring to verify the
8694 message.@footnote{@acronym{PGP} keys for many hierarchies are
8695 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8698 @kindex W s (Summary)
8699 @findex gnus-summary-force-verify-and-decrypt
8700 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
8701 @acronym{S/MIME}) message
8702 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8705 @kindex W a (Summary)
8706 @findex gnus-article-strip-headers-in-body
8707 Strip headers like the @code{X-No-Archive} header from the beginning of
8708 article bodies (@code{gnus-article-strip-headers-in-body}).
8711 @kindex W E l (Summary)
8712 @findex gnus-article-strip-leading-blank-lines
8713 Remove all blank lines from the beginning of the article
8714 (@code{gnus-article-strip-leading-blank-lines}).
8717 @kindex W E m (Summary)
8718 @findex gnus-article-strip-multiple-blank-lines
8719 Replace all blank lines with empty lines and then all multiple empty
8720 lines with a single empty line.
8721 (@code{gnus-article-strip-multiple-blank-lines}).
8724 @kindex W E t (Summary)
8725 @findex gnus-article-remove-trailing-blank-lines
8726 Remove all blank lines at the end of the article
8727 (@code{gnus-article-remove-trailing-blank-lines}).
8730 @kindex W E a (Summary)
8731 @findex gnus-article-strip-blank-lines
8732 Do all the three commands above
8733 (@code{gnus-article-strip-blank-lines}).
8736 @kindex W E A (Summary)
8737 @findex gnus-article-strip-all-blank-lines
8738 Remove all blank lines
8739 (@code{gnus-article-strip-all-blank-lines}).
8742 @kindex W E s (Summary)
8743 @findex gnus-article-strip-leading-space
8744 Remove all white space from the beginning of all lines of the article
8745 body (@code{gnus-article-strip-leading-space}).
8748 @kindex W E e (Summary)
8749 @findex gnus-article-strip-trailing-space
8750 Remove all white space from the end of all lines of the article
8751 body (@code{gnus-article-strip-trailing-space}).
8755 @xref{Customizing Articles}, for how to wash articles automatically.
8758 @node Article Header
8759 @subsection Article Header
8761 These commands perform various transformations of article header.
8766 @kindex W G u (Summary)
8767 @findex gnus-article-treat-unfold-headers
8768 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8771 @kindex W G n (Summary)
8772 @findex gnus-article-treat-fold-newsgroups
8773 Fold the @code{Newsgroups} and @code{Followup-To} headers
8774 (@code{gnus-article-treat-fold-newsgroups}).
8777 @kindex W G f (Summary)
8778 @findex gnus-article-treat-fold-headers
8779 Fold all the message headers
8780 (@code{gnus-article-treat-fold-headers}).
8783 @kindex W E w (Summary)
8784 @findex gnus-article-remove-leading-whitespace
8785 Remove excessive whitespace from all headers
8786 (@code{gnus-article-remove-leading-whitespace}).
8791 @node Article Buttons
8792 @subsection Article Buttons
8795 People often include references to other stuff in articles, and it would
8796 be nice if Gnus could just fetch whatever it is that people talk about
8797 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8798 button on these references.
8800 @vindex gnus-button-man-handler
8801 Gnus adds @dfn{buttons} to certain standard references by default:
8802 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
8803 Emacs or Gnus related references. This is controlled by two variables,
8804 one that handles article bodies and one that handles article heads:
8808 @item gnus-button-alist
8809 @vindex gnus-button-alist
8810 This is an alist where each entry has this form:
8813 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8819 All text that match this regular expression (case insensitive) will be
8820 considered an external reference. Here's a typical regexp that matches
8821 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
8822 variable containing a regexp, useful variables to use include
8823 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
8826 Gnus has to know which parts of the matches is to be highlighted. This
8827 is a number that says what sub-expression of the regexp is to be
8828 highlighted. If you want it all highlighted, you use 0 here.
8831 This form will be @code{eval}ed, and if the result is non-@code{nil},
8832 this is considered a match. This is useful if you want extra sifting to
8833 avoid false matches. Often variables named
8834 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
8835 Levels}, but any other form may be used too.
8837 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
8840 This function will be called when you click on this button.
8843 As with @var{button-par}, this is a sub-expression number, but this one
8844 says which part of the match is to be sent as data to @var{function}.
8848 So the full entry for buttonizing URLs is then
8851 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8854 @item gnus-header-button-alist
8855 @vindex gnus-header-button-alist
8856 This is just like the other alist, except that it is applied to the
8857 article head only, and that each entry has an additional element that is
8858 used to say what headers to apply the buttonize coding to:
8861 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8864 @var{header} is a regular expression.
8867 @subsubsection Related variables and functions
8870 @item gnus-button-@var{*}-level
8871 @xref{Article Button Levels}.
8873 @c Stuff related to gnus-button-browse-level
8875 @item gnus-button-url-regexp
8876 @vindex gnus-button-url-regexp
8877 A regular expression that matches embedded URLs. It is used in the
8878 default values of the variables above.
8880 @c Stuff related to gnus-button-man-level
8882 @item gnus-button-man-handler
8883 @vindex gnus-button-man-handler
8884 The function to use for displaying man pages. It must take at least one
8885 argument with a string naming the man page.
8887 @c Stuff related to gnus-button-message-level
8889 @item gnus-button-mid-or-mail-regexp
8890 @vindex gnus-button-mid-or-mail-regexp
8891 Regular expression that matches a message ID or a mail address.
8893 @item gnus-button-prefer-mid-or-mail
8894 @vindex gnus-button-prefer-mid-or-mail
8895 This variable determines what to do when the button on a string as
8896 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
8897 message ID or a mail address. If it is one of the symbols @code{mid} or
8898 @code{mail}, Gnus will always assume that the string is a message ID or
8899 a mail address, respectively. If this variable is set to the symbol
8900 @code{ask}, always query the user what do do. If it is a function, this
8901 function will be called with the string as its only argument. The
8902 function must return @code{mid}, @code{mail}, @code{invalid} or
8903 @code{ask}. The default value is the function
8904 @code{gnus-button-mid-or-mail-heuristic}.
8906 @item gnus-button-mid-or-mail-heuristic
8907 @findex gnus-button-mid-or-mail-heuristic
8908 Function that guesses whether its argument is a message ID or a mail
8909 address. Returns @code{mid} if it's a message IDs, @code{mail} if
8910 it's a mail address, @code{ask} if unsure and @code{invalid} if the
8913 @item gnus-button-mid-or-mail-heuristic-alist
8914 @vindex gnus-button-mid-or-mail-heuristic-alist
8915 An alist of @code{(RATE . REGEXP)} pairs used by the function
8916 @code{gnus-button-mid-or-mail-heuristic}.
8918 @c Stuff related to gnus-button-tex-level
8920 @item gnus-button-ctan-handler
8921 @findex gnus-button-ctan-handler
8922 The function to use for displaying CTAN links. It must take one
8923 argument, the string naming the URL.
8926 @vindex gnus-ctan-url
8927 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
8928 by @code{gnus-button-ctan-handler}.
8932 @item gnus-article-button-face
8933 @vindex gnus-article-button-face
8934 Face used on buttons.
8936 @item gnus-article-mouse-face
8937 @vindex gnus-article-mouse-face
8938 Face used when the mouse cursor is over a button.
8942 @xref{Customizing Articles}, for how to buttonize articles automatically.
8945 @node Article Button Levels
8946 @subsection Article button levels
8947 @cindex button levels
8948 The higher the value of the variables @code{gnus-button-@var{*}-level},
8949 the more buttons will appear. If the level is zero, no corresponding
8950 buttons are displayed. With the default value (which is 5) you should
8951 already see quite a lot of buttons. With higher levels, you will see
8952 more buttons, but you may also get more false positives. To avoid them,
8953 you can set the variables @code{gnus-button-@var{*}-level} local to
8954 specific groups (@pxref{Group Parameters}). Here's an example for the
8955 variable @code{gnus-parameters}:
8958 ;; @r{increase @code{gnus-button-*-level} in some groups:}
8959 (setq gnus-parameters
8960 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
8961 ("\\<unix\\>" (gnus-button-man-level 10))
8962 ("\\<tex\\>" (gnus-button-tex-level 10))))
8967 @item gnus-button-browse-level
8968 @vindex gnus-button-browse-level
8969 Controls the display of references to message IDs, mail addresses and
8970 news URLs. Related variables and functions include
8971 @code{gnus-button-url-regexp}, @code{browse-url}, and
8972 @code{browse-url-browser-function}.
8974 @item gnus-button-emacs-level
8975 @vindex gnus-button-emacs-level
8976 Controls the display of Emacs or Gnus references. Related functions are
8977 @code{gnus-button-handle-custom},
8978 @code{gnus-button-handle-describe-function},
8979 @code{gnus-button-handle-describe-variable},
8980 @code{gnus-button-handle-symbol},
8981 @code{gnus-button-handle-describe-key},
8982 @code{gnus-button-handle-apropos},
8983 @code{gnus-button-handle-apropos-command},
8984 @code{gnus-button-handle-apropos-variable},
8985 @code{gnus-button-handle-apropos-documentation}, and
8986 @code{gnus-button-handle-library}.
8988 @item gnus-button-man-level
8989 @vindex gnus-button-man-level
8990 Controls the display of references to (Unix) man pages.
8991 See @code{gnus-button-man-handler}.
8993 @item gnus-button-message-level
8994 @vindex gnus-button-message-level
8995 Controls the display of message IDs, mail addresses and news URLs.
8996 Related variables and functions include
8997 @code{gnus-button-mid-or-mail-regexp},
8998 @code{gnus-button-prefer-mid-or-mail},
8999 @code{gnus-button-mid-or-mail-heuristic}, and
9000 @code{gnus-button-mid-or-mail-heuristic-alist}.
9002 @item gnus-button-tex-level
9003 @vindex gnus-button-tex-level
9004 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
9005 URLs. See the variables @code{gnus-ctan-url},
9006 @code{gnus-button-ctan-handler},
9007 @code{gnus-button-ctan-directory-regexp}, and
9008 @code{gnus-button-handle-ctan-bogus-regexp}.
9014 @subsection Article Date
9016 The date is most likely generated in some obscure timezone you've never
9017 heard of, so it's quite nice to be able to find out what the time was
9018 when the article was sent.
9023 @kindex W T u (Summary)
9024 @findex gnus-article-date-ut
9025 Display the date in UT (aka. GMT, aka ZULU)
9026 (@code{gnus-article-date-ut}).
9029 @kindex W T i (Summary)
9030 @findex gnus-article-date-iso8601
9032 Display the date in international format, aka. ISO 8601
9033 (@code{gnus-article-date-iso8601}).
9036 @kindex W T l (Summary)
9037 @findex gnus-article-date-local
9038 Display the date in the local timezone (@code{gnus-article-date-local}).
9041 @kindex W T p (Summary)
9042 @findex gnus-article-date-english
9043 Display the date in a format that's easily pronounceable in English
9044 (@code{gnus-article-date-english}).
9047 @kindex W T s (Summary)
9048 @vindex gnus-article-time-format
9049 @findex gnus-article-date-user
9050 @findex format-time-string
9051 Display the date using a user-defined format
9052 (@code{gnus-article-date-user}). The format is specified by the
9053 @code{gnus-article-time-format} variable, and is a string that's passed
9054 to @code{format-time-string}. See the documentation of that variable
9055 for a list of possible format specs.
9058 @kindex W T e (Summary)
9059 @findex gnus-article-date-lapsed
9060 @findex gnus-start-date-timer
9061 @findex gnus-stop-date-timer
9062 Say how much time has elapsed between the article was posted and now
9063 (@code{gnus-article-date-lapsed}). It looks something like:
9066 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9069 @vindex gnus-article-date-lapsed-new-header
9070 The value of @code{gnus-article-date-lapsed-new-header} determines
9071 whether this header will just be added below the old Date one, or will
9074 An advantage of using Gnus to read mail is that it converts simple bugs
9075 into wonderful absurdities.
9077 If you want to have this line updated continually, you can put
9080 (gnus-start-date-timer)
9083 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9084 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9088 @kindex W T o (Summary)
9089 @findex gnus-article-date-original
9090 Display the original date (@code{gnus-article-date-original}). This can
9091 be useful if you normally use some other conversion function and are
9092 worried that it might be doing something totally wrong. Say, claiming
9093 that the article was posted in 1854. Although something like that is
9094 @emph{totally} impossible. Don't you trust me? *titter*
9098 @xref{Customizing Articles}, for how to display the date in your
9099 preferred format automatically.
9102 @node Article Display
9103 @subsection Article Display
9108 These commands add various frivolous display gimmicks to the article
9109 buffer in Emacs versions that support them.
9111 @code{X-Face} headers are small black-and-white images supplied by the
9112 message headers (@pxref{X-Face}).
9114 @code{Face} headers are small colored images supplied by the message
9115 headers (@pxref{Face}).
9117 Smileys are those little @samp{:-)} symbols that people like to litter
9118 their messages with (@pxref{Smileys}).
9120 Picons, on the other hand, reside on your own system, and Gnus will
9121 try to match the headers to what you have (@pxref{Picons}).
9123 All these functions are toggles---if the elements already exist,
9128 @kindex W D x (Summary)
9129 @findex gnus-article-display-x-face
9130 Display an @code{X-Face} in the @code{From} header.
9131 (@code{gnus-article-display-x-face}).
9134 @kindex W D d (Summary)
9135 @findex gnus-article-display-face
9136 Display a @code{Face} in the @code{From} header.
9137 (@code{gnus-article-display-face}).
9140 @kindex W D s (Summary)
9141 @findex gnus-treat-smiley
9142 Display smileys (@code{gnus-treat-smiley}).
9145 @kindex W D f (Summary)
9146 @findex gnus-treat-from-picon
9147 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9150 @kindex W D m (Summary)
9151 @findex gnus-treat-mail-picon
9152 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9153 (@code{gnus-treat-mail-picon}).
9156 @kindex W D n (Summary)
9157 @findex gnus-treat-newsgroups-picon
9158 Piconify all news headers (i. e., @code{Newsgroups} and
9159 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9162 @kindex W D D (Summary)
9163 @findex gnus-article-remove-images
9164 Remove all images from the article buffer
9165 (@code{gnus-article-remove-images}).
9171 @node Article Signature
9172 @subsection Article Signature
9174 @cindex article signature
9176 @vindex gnus-signature-separator
9177 Each article is divided into two parts---the head and the body. The
9178 body can be divided into a signature part and a text part. The variable
9179 that says what is to be considered a signature is
9180 @code{gnus-signature-separator}. This is normally the standard
9181 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9182 non-standard signature separators, so this variable can also be a list
9183 of regular expressions to be tested, one by one. (Searches are done
9184 from the end of the body towards the beginning.) One likely value is:
9187 (setq gnus-signature-separator
9188 '("^-- $" ; @r{The standard}
9189 "^-- *$" ; @r{A common mangling}
9190 "^-------*$" ; @r{Many people just use a looong}
9191 ; @r{line of dashes. Shame!}
9192 "^ *--------*$" ; @r{Double-shame!}
9193 "^________*$" ; @r{Underscores are also popular}
9194 "^========*$")) ; @r{Pervert!}
9197 The more permissive you are, the more likely it is that you'll get false
9200 @vindex gnus-signature-limit
9201 @code{gnus-signature-limit} provides a limit to what is considered a
9202 signature when displaying articles.
9206 If it is an integer, no signature may be longer (in characters) than
9209 If it is a floating point number, no signature may be longer (in lines)
9212 If it is a function, the function will be called without any parameters,
9213 and if it returns @code{nil}, there is no signature in the buffer.
9215 If it is a string, it will be used as a regexp. If it matches, the text
9216 in question is not a signature.
9219 This variable can also be a list where the elements may be of the types
9220 listed above. Here's an example:
9223 (setq gnus-signature-limit
9224 '(200.0 "^---*Forwarded article"))
9227 This means that if there are more than 200 lines after the signature
9228 separator, or the text after the signature separator is matched by
9229 the regular expression @samp{^---*Forwarded article}, then it isn't a
9230 signature after all.
9233 @node Article Miscellanea
9234 @subsection Article Miscellanea
9238 @kindex A t (Summary)
9239 @findex gnus-article-babel
9240 Translate the article from one language to another
9241 (@code{gnus-article-babel}).
9247 @section MIME Commands
9248 @cindex MIME decoding
9250 @cindex viewing attachments
9252 The following commands all understand the numerical prefix. For
9253 instance, @kbd{3 b} means ``view the third @acronym{MIME} part''.
9259 @kindex K v (Summary)
9260 View the @acronym{MIME} part.
9263 @kindex K o (Summary)
9264 Save the @acronym{MIME} part.
9267 @kindex K c (Summary)
9268 Copy the @acronym{MIME} part.
9271 @kindex K e (Summary)
9272 View the @acronym{MIME} part externally.
9275 @kindex K i (Summary)
9276 View the @acronym{MIME} part internally.
9279 @kindex K | (Summary)
9280 Pipe the @acronym{MIME} part to an external command.
9283 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9288 @kindex K b (Summary)
9289 Make all the @acronym{MIME} parts have buttons in front of them. This is
9290 mostly useful if you wish to save (or perform other actions) on inlined
9294 @kindex K m (Summary)
9295 @findex gnus-summary-repair-multipart
9296 Some multipart messages are transmitted with missing or faulty headers.
9297 This command will attempt to ``repair'' these messages so that they can
9298 be viewed in a more pleasant manner
9299 (@code{gnus-summary-repair-multipart}).
9302 @kindex X m (Summary)
9303 @findex gnus-summary-save-parts
9304 Save all parts matching a @acronym{MIME} type to a directory
9305 (@code{gnus-summary-save-parts}). Understands the process/prefix
9306 convention (@pxref{Process/Prefix}).
9309 @kindex M-t (Summary)
9310 @findex gnus-summary-toggle-display-buttonized
9311 Toggle the buttonized display of the article buffer
9312 (@code{gnus-summary-toggle-display-buttonized}).
9315 @kindex W M w (Summary)
9316 @findex gnus-article-decode-mime-words
9317 Decode RFC 2047-encoded words in the article headers
9318 (@code{gnus-article-decode-mime-words}).
9321 @kindex W M c (Summary)
9322 @findex gnus-article-decode-charset
9323 Decode encoded article bodies as well as charsets
9324 (@code{gnus-article-decode-charset}).
9326 This command looks in the @code{Content-Type} header to determine the
9327 charset. If there is no such header in the article, you can give it a
9328 prefix, which will prompt for the charset to decode as. In regional
9329 groups where people post using some common encoding (but do not
9330 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9331 parameter to the required charset (@pxref{Group Parameters}).
9334 @kindex W M v (Summary)
9335 @findex gnus-mime-view-all-parts
9336 View all the @acronym{MIME} parts in the current article
9337 (@code{gnus-mime-view-all-parts}).
9344 @item gnus-ignored-mime-types
9345 @vindex gnus-ignored-mime-types
9346 This is a list of regexps. @acronym{MIME} types that match a regexp from
9347 this list will be completely ignored by Gnus. The default value is
9350 To have all Vcards be ignored, you'd say something like this:
9353 (setq gnus-ignored-mime-types
9357 @item gnus-article-loose-mime
9358 @vindex gnus-article-loose-mime
9359 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9360 before interpreting the message as a @acronym{MIME} message. This helps
9361 when reading messages from certain broken mail user agents. The
9362 default is @code{nil}.
9364 @item gnus-article-emulate-mime
9365 @vindex gnus-article-emulate-mime
9366 There are other, non-@acronym{MIME} encoding methods used. The most common
9367 is @samp{uuencode}, but yEncode is also getting to be popular. If
9368 this variable is non-@code{nil}, Gnus will look in message bodies to
9369 see if it finds these encodings, and if so, it'll run them through the
9370 Gnus @acronym{MIME} machinery. The default is @code{t}.
9372 @item gnus-unbuttonized-mime-types
9373 @vindex gnus-unbuttonized-mime-types
9374 This is a list of regexps. @acronym{MIME} types that match a regexp from
9375 this list won't have @acronym{MIME} buttons inserted unless they aren't
9376 displayed or this variable is overridden by
9377 @code{gnus-buttonized-mime-types}. The default value is
9378 @code{(".*/.*")}. This variable is only used when
9379 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9381 @item gnus-buttonized-mime-types
9382 @vindex gnus-buttonized-mime-types
9383 This is a list of regexps. @acronym{MIME} types that match a regexp from
9384 this list will have @acronym{MIME} buttons inserted unless they aren't
9385 displayed. This variable overrides
9386 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9387 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9390 To see e.g. security buttons but no other buttons, you could set this
9391 variable to @code{("multipart/signed")} and leave
9392 @code{gnus-unbuttonized-mime-types} at the default value.
9394 @item gnus-inhibit-mime-unbuttonizing
9395 @vindex gnus-inhibit-mime-unbuttonizing
9396 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9397 default value is @code{nil}.
9399 @item gnus-article-mime-part-function
9400 @vindex gnus-article-mime-part-function
9401 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9402 handle as the parameter. The function is meant to be used to allow
9403 users to gather information from the article (e. g., add Vcard info to
9404 the bbdb database) or to do actions based on parts (e. g., automatically
9405 save all jpegs into some directory).
9407 Here's an example function the does the latter:
9410 (defun my-save-all-jpeg-parts (handle)
9411 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9413 (insert (mm-get-part handle))
9414 (write-region (point-min) (point-max)
9415 (read-file-name "Save jpeg to: ")))))
9416 (setq gnus-article-mime-part-function
9417 'my-save-all-jpeg-parts)
9420 @vindex gnus-mime-multipart-functions
9421 @item gnus-mime-multipart-functions
9422 Alist of @acronym{MIME} multipart types and functions to handle them.
9424 @vindex gnus-mime-display-multipart-alternative-as-mixed
9425 @item gnus-mime-display-multipart-alternative-as-mixed
9426 Display "multipart/alternative" parts as "multipart/mixed".
9428 @vindex gnus-mime-display-multipart-related-as-mixed
9429 @item gnus-mime-display-multipart-related-as-mixed
9430 Display "multipart/related" parts as "multipart/mixed".
9432 If displaying "text/html" is discouraged, see
9433 @code{mm-discouraged-alternatives} in @ref{Display Customization,
9434 Display Customization, , emacs-mime, Emacs-Mime Manual}. Images or
9435 other material inside a "multipart/related" part might be overlooked
9436 when this variable is @code{nil}.
9438 @vindex gnus-mime-display-multipart-as-mixed
9439 @item gnus-mime-display-multipart-as-mixed
9440 Display "multipart" parts as "multipart/mixed". If @code{t}, it
9441 overrides @code{nil} values of
9442 @code{gnus-mime-display-multipart-alternative-as-mixed} and
9443 @code{gnus-mime-display-multipart-related-as-mixed}.
9445 @vindex mm-file-name-rewrite-functions
9446 @item mm-file-name-rewrite-functions
9447 List of functions used for rewriting file names of @acronym{MIME} parts.
9448 Each function takes a file name as input and returns a file name.
9450 Ready-made functions include@*
9451 @code{mm-file-name-delete-whitespace},
9452 @code{mm-file-name-trim-whitespace},
9453 @code{mm-file-name-collapse-whitespace}, and
9454 @code{mm-file-name-replace-whitespace}. The later uses the value of
9455 the variable @code{mm-file-name-replace-whitespace} to replace each
9456 whitespace character in a file name with that string; default value
9457 is @code{"_"} (a single underscore).
9458 @findex mm-file-name-delete-whitespace
9459 @findex mm-file-name-trim-whitespace
9460 @findex mm-file-name-collapse-whitespace
9461 @findex mm-file-name-replace-whitespace
9462 @vindex mm-file-name-replace-whitespace
9464 The standard functions @code{capitalize}, @code{downcase},
9465 @code{upcase}, and @code{upcase-initials} may be useful, too.
9467 Everybody knows that whitespace characters in file names are evil,
9468 except those who don't know. If you receive lots of attachments from
9469 such unenlightened users, you can make live easier by adding
9472 (setq mm-file-name-rewrite-functions
9473 '(mm-file-name-trim-whitespace
9474 mm-file-name-collapse-whitespace
9475 mm-file-name-replace-whitespace))
9479 to your @file{~/.gnus.el} file.
9488 People use different charsets, and we have @acronym{MIME} to let us know what
9489 charsets they use. Or rather, we wish we had. Many people use
9490 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9491 just send out messages without saying what character sets they use. To
9492 help a bit with this, some local news hierarchies have policies that say
9493 what character set is the default. For instance, the @samp{fj}
9494 hierarchy uses @code{iso-2022-jp}.
9496 @vindex gnus-group-charset-alist
9497 This knowledge is encoded in the @code{gnus-group-charset-alist}
9498 variable, which is an alist of regexps (use the first item to match full
9499 group names) and default charsets to be used when reading these groups.
9501 @vindex gnus-newsgroup-ignored-charsets
9502 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9503 aren't. These blithely mark messages as being in @code{iso-8859-1}
9504 even if they really are in @code{koi-8}. To help here, the
9505 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9506 charsets that are listed here will be ignored. The variable can be
9507 set on a group-by-group basis using the group parameters (@pxref{Group
9508 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9509 which includes values some agents insist on having in there.
9511 @vindex gnus-group-posting-charset-alist
9512 When posting, @code{gnus-group-posting-charset-alist} is used to
9513 determine which charsets should not be encoded using the @acronym{MIME}
9514 encodings. For instance, some hierarchies discourage using
9515 quoted-printable header encoding.
9517 This variable is an alist of regexps and permitted unencoded charsets
9518 for posting. Each element of the alist has the form @code{(}@var{test
9519 header body-list}@code{)}, where:
9523 is either a regular expression matching the newsgroup header or a
9526 is the charset which may be left unencoded in the header (@code{nil}
9527 means encode all charsets),
9529 is a list of charsets which may be encoded using 8bit content-transfer
9530 encoding in the body, or one of the special values @code{nil} (always
9531 encode using quoted-printable) or @code{t} (always use 8bit).
9538 @cindex coding system aliases
9539 @cindex preferred charset
9541 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
9542 The Emacs MIME Manual}, for additional variables that control which
9543 MIME charsets are used when sending messages.
9545 Other charset tricks that may be useful, although not Gnus-specific:
9547 If there are several @acronym{MIME} charsets that encode the same Emacs
9548 charset, you can choose what charset to use by saying the following:
9551 (put-charset-property 'cyrillic-iso8859-5
9552 'preferred-coding-system 'koi8-r)
9555 This means that Russian will be encoded using @code{koi8-r} instead of
9556 the default @code{iso-8859-5} @acronym{MIME} charset.
9558 If you want to read messages in @code{koi8-u}, you can cheat and say
9561 (define-coding-system-alias 'koi8-u 'koi8-r)
9564 This will almost do the right thing.
9566 And finally, to read charsets like @code{windows-1251}, you can say
9570 (codepage-setup 1251)
9571 (define-coding-system-alias 'windows-1251 'cp1251)
9575 @node Article Commands
9576 @section Article Commands
9583 @kindex A P (Summary)
9584 @vindex gnus-ps-print-hook
9585 @findex gnus-summary-print-article
9586 Generate and print a PostScript image of the article buffer
9587 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9588 be run just before printing the buffer. An alternative way to print
9589 article is to use Muttprint (@pxref{Saving Articles}).
9594 @node Summary Sorting
9595 @section Summary Sorting
9596 @cindex summary sorting
9598 You can have the summary buffer sorted in various ways, even though I
9599 can't really see why you'd want that.
9604 @kindex C-c C-s C-n (Summary)
9605 @findex gnus-summary-sort-by-number
9606 Sort by article number (@code{gnus-summary-sort-by-number}).
9609 @kindex C-c C-s C-a (Summary)
9610 @findex gnus-summary-sort-by-author
9611 Sort by author (@code{gnus-summary-sort-by-author}).
9614 @kindex C-c C-s C-t (Summary)
9615 @findex gnus-summary-sort-by-recipient
9616 Sort by recipient (@code{gnus-summary-sort-by-recipient}).
9619 @kindex C-c C-s C-s (Summary)
9620 @findex gnus-summary-sort-by-subject
9621 Sort by subject (@code{gnus-summary-sort-by-subject}).
9624 @kindex C-c C-s C-d (Summary)
9625 @findex gnus-summary-sort-by-date
9626 Sort by date (@code{gnus-summary-sort-by-date}).
9629 @kindex C-c C-s C-l (Summary)
9630 @findex gnus-summary-sort-by-lines
9631 Sort by lines (@code{gnus-summary-sort-by-lines}).
9634 @kindex C-c C-s C-c (Summary)
9635 @findex gnus-summary-sort-by-chars
9636 Sort by article length (@code{gnus-summary-sort-by-chars}).
9639 @kindex C-c C-s C-i (Summary)
9640 @findex gnus-summary-sort-by-score
9641 Sort by score (@code{gnus-summary-sort-by-score}).
9644 @kindex C-c C-s C-r (Summary)
9645 @findex gnus-summary-sort-by-random
9646 Randomize (@code{gnus-summary-sort-by-random}).
9649 @kindex C-c C-s C-o (Summary)
9650 @findex gnus-summary-sort-by-original
9651 Sort using the default sorting method
9652 (@code{gnus-summary-sort-by-original}).
9655 These functions will work both when you use threading and when you don't
9656 use threading. In the latter case, all summary lines will be sorted,
9657 line by line. In the former case, sorting will be done on a
9658 root-by-root basis, which might not be what you were looking for. To
9659 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9663 @node Finding the Parent
9664 @section Finding the Parent
9665 @cindex parent articles
9666 @cindex referring articles
9671 @findex gnus-summary-refer-parent-article
9672 If you'd like to read the parent of the current article, and it is not
9673 displayed in the summary buffer, you might still be able to. That is,
9674 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
9675 and the @code{References} in the current article are not mangled, you
9676 can just press @kbd{^} or @kbd{A r}
9677 (@code{gnus-summary-refer-parent-article}). If everything goes well,
9678 you'll get the parent. If the parent is already displayed in the
9679 summary buffer, point will just move to this article.
9681 If given a positive numerical prefix, fetch that many articles back into
9682 the ancestry. If given a negative numerical prefix, fetch just that
9683 ancestor. So if you say @kbd{3 ^}, gnus will fetch the parent, the
9684 grandparent and the grandgrandparent of the current article. If you say
9685 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
9689 @findex gnus-summary-refer-references
9690 @kindex A R (Summary)
9691 Fetch all articles mentioned in the @code{References} header of the
9692 article (@code{gnus-summary-refer-references}).
9695 @findex gnus-summary-refer-thread
9696 @kindex A T (Summary)
9697 Display the full thread where the current article appears
9698 (@code{gnus-summary-refer-thread}). This command has to fetch all the
9699 headers in the current group to work, so it usually takes a while. If
9700 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9701 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
9702 visible effects normally, but it'll make this command work a whole lot
9703 faster. Of course, it'll make group entry somewhat slow.
9705 @vindex gnus-refer-thread-limit
9706 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9707 articles before the first displayed in the current group) headers to
9708 fetch when doing this command. The default is 200. If @code{t}, all
9709 the available headers will be fetched. This variable can be overridden
9710 by giving the @kbd{A T} command a numerical prefix.
9713 @findex gnus-summary-refer-article
9714 @kindex M-^ (Summary)
9716 @cindex fetching by Message-ID
9717 You can also ask the @acronym{NNTP} server for an arbitrary article, no
9718 matter what group it belongs to. @kbd{M-^}
9719 (@code{gnus-summary-refer-article}) will ask you for a
9720 @code{Message-ID}, which is one of those long, hard-to-read thingies
9721 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
9722 have to get it all exactly right. No fuzzy searches, I'm afraid.
9725 The current select method will be used when fetching by
9726 @code{Message-ID} from non-news select method, but you can override this
9727 by giving this command a prefix.
9729 @vindex gnus-refer-article-method
9730 If the group you are reading is located on a back end that does not
9731 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9732 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
9733 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
9734 updating the spool you are reading from, but that's not really
9737 It can also be a list of select methods, as well as the special symbol
9738 @code{current}, which means to use the current select method. If it
9739 is a list, Gnus will try all the methods in the list until it finds a
9742 Here's an example setting that will first try the current method, and
9743 then ask Google if that fails:
9746 (setq gnus-refer-article-method
9748 (nnweb "google" (nnweb-type google))))
9751 Most of the mail back ends support fetching by @code{Message-ID}, but
9752 do not do a particularly excellent job at it. That is, @code{nnmbox},
9753 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
9754 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
9755 only able to locate articles that have been posted to the current
9756 group. (Anything else would be too time consuming.) @code{nnmh} does
9757 not support this at all.
9760 @node Alternative Approaches
9761 @section Alternative Approaches
9763 Different people like to read news using different methods. This being
9764 gnus, we offer a small selection of minor modes for the summary buffers.
9767 * Pick and Read:: First mark articles and then read them.
9768 * Binary Groups:: Auto-decode all articles.
9773 @subsection Pick and Read
9774 @cindex pick and read
9776 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9777 a two-phased reading interface. The user first marks in a summary
9778 buffer the articles she wants to read. Then she starts reading the
9779 articles with just an article buffer displayed.
9781 @findex gnus-pick-mode
9782 @kindex M-x gnus-pick-mode
9783 Gnus provides a summary buffer minor mode that allows
9784 this---@code{gnus-pick-mode}. This basically means that a few process
9785 mark commands become one-keystroke commands to allow easy marking, and
9786 it provides one additional command for switching to the summary buffer.
9788 Here are the available keystrokes when using pick mode:
9793 @findex gnus-pick-article-or-thread
9794 Pick the article or thread on the current line
9795 (@code{gnus-pick-article-or-thread}). If the variable
9796 @code{gnus-thread-hide-subtree} is true, then this key selects the
9797 entire thread when used at the first article of the thread. Otherwise,
9798 it selects just the article. If given a numerical prefix, go to that
9799 thread or article and pick it. (The line number is normally displayed
9800 at the beginning of the summary pick lines.)
9803 @kindex SPACE (Pick)
9804 @findex gnus-pick-next-page
9805 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
9806 at the end of the buffer, start reading the picked articles.
9810 @findex gnus-pick-unmark-article-or-thread.
9811 Unpick the thread or article
9812 (@code{gnus-pick-unmark-article-or-thread}). If the variable
9813 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9814 thread if used at the first article of the thread. Otherwise it unpicks
9815 just the article. You can give this key a numerical prefix to unpick
9816 the thread or article at that line.
9820 @findex gnus-pick-start-reading
9821 @vindex gnus-pick-display-summary
9822 Start reading the picked articles (@code{gnus-pick-start-reading}). If
9823 given a prefix, mark all unpicked articles as read first. If
9824 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9825 will still be visible when you are reading.
9829 All the normal summary mode commands are still available in the
9830 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
9831 which is mapped to the same function
9832 @code{gnus-summary-tick-article-forward}.
9834 If this sounds like a good idea to you, you could say:
9837 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9840 @vindex gnus-pick-mode-hook
9841 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9843 @vindex gnus-mark-unpicked-articles-as-read
9844 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9845 all unpicked articles as read. The default is @code{nil}.
9847 @vindex gnus-summary-pick-line-format
9848 The summary line format in pick mode is slightly different from the
9849 standard format. At the beginning of each line the line number is
9850 displayed. The pick mode line format is controlled by the
9851 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9852 Variables}). It accepts the same format specs that
9853 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9857 @subsection Binary Groups
9858 @cindex binary groups
9860 @findex gnus-binary-mode
9861 @kindex M-x gnus-binary-mode
9862 If you spend much time in binary groups, you may grow tired of hitting
9863 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
9864 is a minor mode for summary buffers that makes all ordinary Gnus article
9865 selection functions uudecode series of articles and display the result
9866 instead of just displaying the articles the normal way.
9869 @findex gnus-binary-show-article
9870 The only way, in fact, to see the actual articles is the @kbd{g}
9871 command, when you have turned on this mode
9872 (@code{gnus-binary-show-article}).
9874 @vindex gnus-binary-mode-hook
9875 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9879 @section Tree Display
9882 @vindex gnus-use-trees
9883 If you don't like the normal gnus summary display, you might try setting
9884 @code{gnus-use-trees} to @code{t}. This will create (by default) an
9885 additional @dfn{tree buffer}. You can execute all summary mode commands
9888 There are a few variables to customize the tree display, of course:
9891 @item gnus-tree-mode-hook
9892 @vindex gnus-tree-mode-hook
9893 A hook called in all tree mode buffers.
9895 @item gnus-tree-mode-line-format
9896 @vindex gnus-tree-mode-line-format
9897 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9898 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
9899 of valid specs, @pxref{Summary Buffer Mode Line}.
9901 @item gnus-selected-tree-face
9902 @vindex gnus-selected-tree-face
9903 Face used for highlighting the selected article in the tree buffer. The
9904 default is @code{modeline}.
9906 @item gnus-tree-line-format
9907 @vindex gnus-tree-line-format
9908 A format string for the tree nodes. The name is a bit of a misnomer,
9909 though---it doesn't define a line, but just the node. The default value
9910 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9911 the name of the poster. It is vital that all nodes are of the same
9912 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9918 The name of the poster.
9920 The @code{From} header.
9922 The number of the article.
9924 The opening bracket.
9926 The closing bracket.
9931 @xref{Formatting Variables}.
9933 Variables related to the display are:
9936 @item gnus-tree-brackets
9937 @vindex gnus-tree-brackets
9938 This is used for differentiating between ``real'' articles and
9939 ``sparse'' articles. The format is
9941 ((@var{real-open} . @var{real-close})
9942 (@var{sparse-open} . @var{sparse-close})
9943 (@var{dummy-open} . @var{dummy-close}))
9945 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
9947 @item gnus-tree-parent-child-edges
9948 @vindex gnus-tree-parent-child-edges
9949 This is a list that contains the characters used for connecting parent
9950 nodes to their children. The default is @code{(?- ?\\ ?|)}.
9954 @item gnus-tree-minimize-window
9955 @vindex gnus-tree-minimize-window
9956 If this variable is non-@code{nil}, gnus will try to keep the tree
9957 buffer as small as possible to allow more room for the other gnus
9958 windows. If this variable is a number, the tree buffer will never be
9959 higher than that number. The default is @code{t}. Note that if you
9960 have several windows displayed side-by-side in a frame and the tree
9961 buffer is one of these, minimizing the tree window will also resize all
9962 other windows displayed next to it.
9964 You may also wish to add the following hook to keep the window minimized
9968 (add-hook 'gnus-configure-windows-hook
9969 'gnus-tree-perhaps-minimize)
9972 @item gnus-generate-tree-function
9973 @vindex gnus-generate-tree-function
9974 @findex gnus-generate-horizontal-tree
9975 @findex gnus-generate-vertical-tree
9976 The function that actually generates the thread tree. Two predefined
9977 functions are available: @code{gnus-generate-horizontal-tree} and
9978 @code{gnus-generate-vertical-tree} (which is the default).
9982 Here's an example from a horizontal tree buffer:
9985 @{***@}-(***)-[odd]-[Gun]
9995 Here's the same thread displayed in a vertical tree buffer:
10000 |--------------------------\-----\-----\
10001 (***) [Bjo] [Gun] [Gun]
10003 [odd] [Jan] [odd] (***) [Jor]
10005 [Gun] [Eri] [Eri] [odd]
10011 If you're using horizontal trees, it might be nice to display the trees
10012 side-by-side with the summary buffer. You could add something like the
10013 following to your @file{~/.gnus.el} file:
10016 (setq gnus-use-trees t
10017 gnus-generate-tree-function 'gnus-generate-horizontal-tree
10018 gnus-tree-minimize-window nil)
10019 (gnus-add-configuration
10023 (summary 0.75 point)
10028 @xref{Window Layout}.
10031 @node Mail Group Commands
10032 @section Mail Group Commands
10033 @cindex mail group commands
10035 Some commands only make sense in mail groups. If these commands are
10036 invalid in the current group, they will raise a hell and let you know.
10038 All these commands (except the expiry and edit commands) use the
10039 process/prefix convention (@pxref{Process/Prefix}).
10044 @kindex B e (Summary)
10045 @findex gnus-summary-expire-articles
10046 Run all expirable articles in the current group through the expiry
10047 process (@code{gnus-summary-expire-articles}). That is, delete all
10048 expirable articles in the group that have been around for a while.
10049 (@pxref{Expiring Mail}).
10052 @kindex B C-M-e (Summary)
10053 @findex gnus-summary-expire-articles-now
10054 Delete all the expirable articles in the group
10055 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
10056 articles eligible for expiry in the current group will
10057 disappear forever into that big @file{/dev/null} in the sky.
10060 @kindex B DEL (Summary)
10061 @findex gnus-summary-delete-article
10062 @c @icon{gnus-summary-mail-delete}
10063 Delete the mail article. This is ``delete'' as in ``delete it from your
10064 disk forever and ever, never to return again.'' Use with caution.
10065 (@code{gnus-summary-delete-article}).
10068 @kindex B m (Summary)
10070 @findex gnus-summary-move-article
10071 @vindex gnus-preserve-marks
10072 Move the article from one mail group to another
10073 (@code{gnus-summary-move-article}). Marks will be preserved if
10074 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10077 @kindex B c (Summary)
10079 @findex gnus-summary-copy-article
10080 @c @icon{gnus-summary-mail-copy}
10081 Copy the article from one group (mail group or not) to a mail group
10082 (@code{gnus-summary-copy-article}). Marks will be preserved if
10083 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10086 @kindex B B (Summary)
10087 @cindex crosspost mail
10088 @findex gnus-summary-crosspost-article
10089 Crosspost the current article to some other group
10090 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10091 the article in the other group, and the Xref headers of the article will
10092 be properly updated.
10095 @kindex B i (Summary)
10096 @findex gnus-summary-import-article
10097 Import an arbitrary file into the current mail newsgroup
10098 (@code{gnus-summary-import-article}). You will be prompted for a file
10099 name, a @code{From} header and a @code{Subject} header.
10102 @kindex B I (Summary)
10103 @findex gnus-summary-create-article
10104 Create an empty article in the current mail newsgroups
10105 (@code{gnus-summary-create-article}). You will be prompted for a
10106 @code{From} header and a @code{Subject} header.
10109 @kindex B r (Summary)
10110 @findex gnus-summary-respool-article
10111 @vindex gnus-summary-respool-default-method
10112 Respool the mail article (@code{gnus-summary-respool-article}).
10113 @code{gnus-summary-respool-default-method} will be used as the default
10114 select method when respooling. This variable is @code{nil} by default,
10115 which means that the current group select method will be used instead.
10116 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10117 (which is the default).
10121 @kindex B w (Summary)
10122 @kindex e (Summary)
10123 @findex gnus-summary-edit-article
10124 @kindex C-c C-c (Article)
10125 @findex gnus-summary-edit-article-done
10126 Edit the current article (@code{gnus-summary-edit-article}). To finish
10127 editing and make the changes permanent, type @kbd{C-c C-c}
10128 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10129 @kbd{C-c C-c} command, gnus won't re-highlight the article.
10132 @kindex B q (Summary)
10133 @findex gnus-summary-respool-query
10134 If you want to re-spool an article, you might be curious as to what group
10135 the article will end up in before you do the re-spooling. This command
10136 will tell you (@code{gnus-summary-respool-query}).
10139 @kindex B t (Summary)
10140 @findex gnus-summary-respool-trace
10141 Similarly, this command will display all fancy splitting patterns used
10142 when respooling, if any (@code{gnus-summary-respool-trace}).
10145 @kindex B p (Summary)
10146 @findex gnus-summary-article-posted-p
10147 Some people have a tendency to send you ``courtesy'' copies when they
10148 follow up to articles you have posted. These usually have a
10149 @code{Newsgroups} header in them, but not always. This command
10150 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10151 article from your news server (or rather, from
10152 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10153 report back whether it found the article or not. Even if it says that
10154 it didn't find the article, it may have been posted anyway---mail
10155 propagation is much faster than news propagation, and the news copy may
10156 just not have arrived yet.
10159 @kindex K E (Summary)
10160 @findex gnus-article-encrypt-body
10161 @vindex gnus-article-encrypt-protocol
10162 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10163 The body is encrypted with the encryption protocol specified by the
10164 variable @code{gnus-article-encrypt-protocol}.
10168 @vindex gnus-move-split-methods
10169 @cindex moving articles
10170 If you move (or copy) articles regularly, you might wish to have gnus
10171 suggest where to put the articles. @code{gnus-move-split-methods} is a
10172 variable that uses the same syntax as @code{gnus-split-methods}
10173 (@pxref{Saving Articles}). You may customize that variable to create
10174 suggestions you find reasonable. (Note that
10175 @code{gnus-move-split-methods} uses group names where
10176 @code{gnus-split-methods} uses file names.)
10179 (setq gnus-move-split-methods
10180 '(("^From:.*Lars Magne" "nnml:junk")
10181 ("^Subject:.*gnus" "nnfolder:important")
10182 (".*" "nnml:misc")))
10186 @node Various Summary Stuff
10187 @section Various Summary Stuff
10190 * Summary Group Information:: Information oriented commands.
10191 * Searching for Articles:: Multiple article commands.
10192 * Summary Generation Commands::
10193 * Really Various Summary Commands:: Those pesky non-conformant commands.
10197 @vindex gnus-summary-display-while-building
10198 @item gnus-summary-display-while-building
10199 If non-@code{nil}, show and update the summary buffer as it's being
10200 built. If @code{t}, update the buffer after every line is inserted.
10201 If the value is an integer, @var{n}, update the display every @var{n}
10202 lines. The default is @code{nil}.
10204 @vindex gnus-summary-display-arrow
10205 @item gnus-summary-display-arrow
10206 If non-@code{nil}, display an arrow in the fringe to indicate the
10209 @vindex gnus-summary-mode-hook
10210 @item gnus-summary-mode-hook
10211 This hook is called when creating a summary mode buffer.
10213 @vindex gnus-summary-generate-hook
10214 @item gnus-summary-generate-hook
10215 This is called as the last thing before doing the threading and the
10216 generation of the summary buffer. It's quite convenient for customizing
10217 the threading variables based on what data the newsgroup has. This hook
10218 is called from the summary buffer after most summary buffer variables
10221 @vindex gnus-summary-prepare-hook
10222 @item gnus-summary-prepare-hook
10223 It is called after the summary buffer has been generated. You might use
10224 it to, for instance, highlight lines or modify the look of the buffer in
10225 some other ungodly manner. I don't care.
10227 @vindex gnus-summary-prepared-hook
10228 @item gnus-summary-prepared-hook
10229 A hook called as the very last thing after the summary buffer has been
10232 @vindex gnus-summary-ignore-duplicates
10233 @item gnus-summary-ignore-duplicates
10234 When gnus discovers two articles that have the same @code{Message-ID},
10235 it has to do something drastic. No articles are allowed to have the
10236 same @code{Message-ID}, but this may happen when reading mail from some
10237 sources. Gnus allows you to customize what happens with this variable.
10238 If it is @code{nil} (which is the default), gnus will rename the
10239 @code{Message-ID} (for display purposes only) and display the article as
10240 any other article. If this variable is @code{t}, it won't display the
10241 article---it'll be as if it never existed.
10243 @vindex gnus-alter-articles-to-read-function
10244 @item gnus-alter-articles-to-read-function
10245 This function, which takes two parameters (the group name and the list
10246 of articles to be selected), is called to allow the user to alter the
10247 list of articles to be selected.
10249 For instance, the following function adds the list of cached articles to
10250 the list in one particular group:
10253 (defun my-add-cached-articles (group articles)
10254 (if (string= group "some.group")
10255 (append gnus-newsgroup-cached articles)
10259 @vindex gnus-newsgroup-variables
10260 @item gnus-newsgroup-variables
10261 A list of newsgroup (summary buffer) local variables, or cons of
10262 variables and their default expressions to be evalled (when the default
10263 values are not @code{nil}), that should be made global while the summary
10266 Note: The default expressions will be evaluated (using function
10267 @code{eval}) before assignment to the local variable rather than just
10268 assigned to it. If the default expression is the symbol @code{global},
10269 that symbol will not be evaluated but the global value of the local
10270 variable will be used instead.
10272 These variables can be used to set variables in the group parameters
10273 while still allowing them to affect operations done in other
10274 buffers. For example:
10277 (setq gnus-newsgroup-variables
10278 '(message-use-followup-to
10279 (gnus-visible-headers .
10280 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10283 Also @pxref{Group Parameters}.
10287 @node Summary Group Information
10288 @subsection Summary Group Information
10293 @kindex H f (Summary)
10294 @findex gnus-summary-fetch-faq
10295 @vindex gnus-group-faq-directory
10296 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10297 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10298 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10299 is usually a directory on a remote machine. This variable can also be
10300 a list of directories. In that case, giving a prefix to this command
10301 will allow you to choose between the various sites. @code{ange-ftp}
10302 or @code{efs} will probably be used for fetching the file.
10305 @kindex H d (Summary)
10306 @findex gnus-summary-describe-group
10307 Give a brief description of the current group
10308 (@code{gnus-summary-describe-group}). If given a prefix, force
10309 rereading the description from the server.
10312 @kindex H h (Summary)
10313 @findex gnus-summary-describe-briefly
10314 Give an extremely brief description of the most important summary
10315 keystrokes (@code{gnus-summary-describe-briefly}).
10318 @kindex H i (Summary)
10319 @findex gnus-info-find-node
10320 Go to the gnus info node (@code{gnus-info-find-node}).
10324 @node Searching for Articles
10325 @subsection Searching for Articles
10330 @kindex M-s (Summary)
10331 @findex gnus-summary-search-article-forward
10332 Search through all subsequent (raw) articles for a regexp
10333 (@code{gnus-summary-search-article-forward}).
10336 @kindex M-r (Summary)
10337 @findex gnus-summary-search-article-backward
10338 Search through all previous (raw) articles for a regexp
10339 (@code{gnus-summary-search-article-backward}).
10342 @kindex & (Summary)
10343 @findex gnus-summary-execute-command
10344 This command will prompt you for a header, a regular expression to match
10345 on this field, and a command to be executed if the match is made
10346 (@code{gnus-summary-execute-command}). If the header is an empty
10347 string, the match is done on the entire article. If given a prefix,
10348 search backward instead.
10350 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10351 all articles that have heads or bodies that match @samp{some.*string}.
10354 @kindex M-& (Summary)
10355 @findex gnus-summary-universal-argument
10356 Perform any operation on all articles that have been marked with
10357 the process mark (@code{gnus-summary-universal-argument}).
10360 @node Summary Generation Commands
10361 @subsection Summary Generation Commands
10366 @kindex Y g (Summary)
10367 @findex gnus-summary-prepare
10368 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10371 @kindex Y c (Summary)
10372 @findex gnus-summary-insert-cached-articles
10373 Pull all cached articles (for the current group) into the summary buffer
10374 (@code{gnus-summary-insert-cached-articles}).
10377 @kindex Y d (Summary)
10378 @findex gnus-summary-insert-dormant-articles
10379 Pull all dormant articles (for the current group) into the summary buffer
10380 (@code{gnus-summary-insert-dormant-articles}).
10385 @node Really Various Summary Commands
10386 @subsection Really Various Summary Commands
10392 @kindex C-d (Summary)
10393 @kindex A D (Summary)
10394 @findex gnus-summary-enter-digest-group
10395 If the current article is a collection of other articles (for instance,
10396 a digest), you might use this command to enter a group based on the that
10397 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10398 guess what article type is currently displayed unless you give a prefix
10399 to this command, which forces a ``digest'' interpretation. Basically,
10400 whenever you see a message that is a collection of other messages of
10401 some format, you @kbd{C-d} and read these messages in a more convenient
10405 @kindex C-M-d (Summary)
10406 @findex gnus-summary-read-document
10407 This command is very similar to the one above, but lets you gather
10408 several documents into one biiig group
10409 (@code{gnus-summary-read-document}). It does this by opening several
10410 @code{nndoc} groups for each document, and then opening an
10411 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10412 command understands the process/prefix convention
10413 (@pxref{Process/Prefix}).
10416 @kindex C-t (Summary)
10417 @findex gnus-summary-toggle-truncation
10418 Toggle truncation of summary lines
10419 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10420 line centering function in the summary buffer, so it's not a good idea
10421 to have truncation switched off while reading articles.
10424 @kindex = (Summary)
10425 @findex gnus-summary-expand-window
10426 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10427 If given a prefix, force an @code{article} window configuration.
10430 @kindex C-M-e (Summary)
10431 @findex gnus-summary-edit-parameters
10432 Edit the group parameters (@pxref{Group Parameters}) of the current
10433 group (@code{gnus-summary-edit-parameters}).
10436 @kindex C-M-a (Summary)
10437 @findex gnus-summary-customize-parameters
10438 Customize the group parameters (@pxref{Group Parameters}) of the current
10439 group (@code{gnus-summary-customize-parameters}).
10444 @node Exiting the Summary Buffer
10445 @section Exiting the Summary Buffer
10446 @cindex summary exit
10447 @cindex exiting groups
10449 Exiting from the summary buffer will normally update all info on the
10450 group and return you to the group buffer.
10457 @kindex Z Z (Summary)
10458 @kindex Z Q (Summary)
10459 @kindex q (Summary)
10460 @findex gnus-summary-exit
10461 @vindex gnus-summary-exit-hook
10462 @vindex gnus-summary-prepare-exit-hook
10463 @vindex gnus-group-no-more-groups-hook
10464 @c @icon{gnus-summary-exit}
10465 Exit the current group and update all information on the group
10466 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10467 called before doing much of the exiting, which calls
10468 @code{gnus-summary-expire-articles} by default.
10469 @code{gnus-summary-exit-hook} is called after finishing the exit
10470 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10471 group mode having no more (unread) groups.
10475 @kindex Z E (Summary)
10476 @kindex Q (Summary)
10477 @findex gnus-summary-exit-no-update
10478 Exit the current group without updating any information on the group
10479 (@code{gnus-summary-exit-no-update}).
10483 @kindex Z c (Summary)
10484 @kindex c (Summary)
10485 @findex gnus-summary-catchup-and-exit
10486 @c @icon{gnus-summary-catchup-and-exit}
10487 Mark all unticked articles in the group as read and then exit
10488 (@code{gnus-summary-catchup-and-exit}).
10491 @kindex Z C (Summary)
10492 @findex gnus-summary-catchup-all-and-exit
10493 Mark all articles, even the ticked ones, as read and then exit
10494 (@code{gnus-summary-catchup-all-and-exit}).
10497 @kindex Z n (Summary)
10498 @findex gnus-summary-catchup-and-goto-next-group
10499 Mark all articles as read and go to the next group
10500 (@code{gnus-summary-catchup-and-goto-next-group}).
10504 @kindex Z R (Summary)
10505 @kindex C-x C-s (Summary)
10506 @findex gnus-summary-reselect-current-group
10507 Exit this group, and then enter it again
10508 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10509 all articles, both read and unread.
10513 @kindex Z G (Summary)
10514 @kindex M-g (Summary)
10515 @findex gnus-summary-rescan-group
10516 @c @icon{gnus-summary-mail-get}
10517 Exit the group, check for new articles in the group, and select the
10518 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10519 articles, both read and unread.
10522 @kindex Z N (Summary)
10523 @findex gnus-summary-next-group
10524 Exit the group and go to the next group
10525 (@code{gnus-summary-next-group}).
10528 @kindex Z P (Summary)
10529 @findex gnus-summary-prev-group
10530 Exit the group and go to the previous group
10531 (@code{gnus-summary-prev-group}).
10534 @kindex Z s (Summary)
10535 @findex gnus-summary-save-newsrc
10536 Save the current number of read/marked articles in the dribble buffer
10537 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10538 given a prefix, also save the @file{.newsrc} file(s). Using this
10539 command will make exit without updating (the @kbd{Q} command) worthless.
10542 @vindex gnus-exit-group-hook
10543 @code{gnus-exit-group-hook} is called when you exit the current group
10544 with an ``updating'' exit. For instance @kbd{Q}
10545 (@code{gnus-summary-exit-no-update}) does not call this hook.
10547 @findex gnus-summary-wake-up-the-dead
10548 @findex gnus-dead-summary-mode
10549 @vindex gnus-kill-summary-on-exit
10550 If you're in the habit of exiting groups, and then changing your mind
10551 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10552 If you do that, gnus won't kill the summary buffer when you exit it.
10553 (Quelle surprise!) Instead it will change the name of the buffer to
10554 something like @samp{*Dead Summary ... *} and install a minor mode
10555 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
10556 buffer, you'll find that all keys are mapped to a function called
10557 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
10558 summary buffer will result in a live, normal summary buffer.
10560 There will never be more than one dead summary buffer at any one time.
10562 @vindex gnus-use-cross-reference
10563 The data on the current group will be updated (which articles you have
10564 read, which articles you have replied to, etc.) when you exit the
10565 summary buffer. If the @code{gnus-use-cross-reference} variable is
10566 @code{t} (which is the default), articles that are cross-referenced to
10567 this group and are marked as read, will also be marked as read in the
10568 other subscribed groups they were cross-posted to. If this variable is
10569 neither @code{nil} nor @code{t}, the article will be marked as read in
10570 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10573 @node Crosspost Handling
10574 @section Crosspost Handling
10578 Marking cross-posted articles as read ensures that you'll never have to
10579 read the same article more than once. Unless, of course, somebody has
10580 posted it to several groups separately. Posting the same article to
10581 several groups (not cross-posting) is called @dfn{spamming}, and you are
10582 by law required to send nasty-grams to anyone who perpetrates such a
10583 heinous crime. You may want to try NoCeM handling to filter out spam
10586 Remember: Cross-posting is kinda ok, but posting the same article
10587 separately to several groups is not. Massive cross-posting (aka.
10588 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10589 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10590 excessive crossposting (@pxref{Summary Mail Commands}).
10592 @cindex cross-posting
10594 @cindex @acronym{NOV}
10595 One thing that may cause Gnus to not do the cross-posting thing
10596 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
10597 (which is very nice, because it speeds things up considerably) which
10598 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
10599 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
10600 even with @sc{xover} by registering the @code{Xref} lines of all
10601 articles you actually read, but if you kill the articles, or just mark
10602 them as read without reading them, Gnus will not get a chance to snoop
10603 the @code{Xref} lines out of these articles, and will be unable to use
10604 the cross reference mechanism.
10606 @cindex LIST overview.fmt
10607 @cindex overview.fmt
10608 To check whether your @acronym{NNTP} server includes the @code{Xref} header
10609 in its overview files, try @samp{telnet your.nntp.server nntp},
10610 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10611 overview.fmt}. This may not work, but if it does, and the last line you
10612 get does not read @samp{Xref:full}, then you should shout and whine at
10613 your news admin until she includes the @code{Xref} header in the
10616 @vindex gnus-nov-is-evil
10617 If you want Gnus to get the @code{Xref}s right all the time, you have to
10618 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10623 For an alternative approach, @pxref{Duplicate Suppression}.
10626 @node Duplicate Suppression
10627 @section Duplicate Suppression
10629 By default, gnus tries to make sure that you don't have to read the same
10630 article more than once by utilizing the crossposting mechanism
10631 (@pxref{Crosspost Handling}). However, that simple and efficient
10632 approach may not work satisfactory for some users for various
10637 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
10638 is evil and not very common.
10641 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
10642 @file{.overview} data bases. This is evil and all too common, alas.
10645 You may be reading the same group (or several related groups) from
10646 different @acronym{NNTP} servers.
10649 You may be getting mail that duplicates articles posted to groups.
10652 I'm sure there are other situations where @code{Xref} handling fails as
10653 well, but these four are the most common situations.
10655 If, and only if, @code{Xref} handling fails for you, then you may
10656 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
10657 will remember the @code{Message-ID}s of all articles you have read or
10658 otherwise marked as read, and then, as if by magic, mark them as read
10659 all subsequent times you see them---in @emph{all} groups. Using this
10660 mechanism is quite likely to be somewhat inefficient, but not overly
10661 so. It's certainly preferable to reading the same articles more than
10664 Duplicate suppression is not a very subtle instrument. It's more like a
10665 sledge hammer than anything else. It works in a very simple
10666 fashion---if you have marked an article as read, it adds this Message-ID
10667 to a cache. The next time it sees this Message-ID, it will mark the
10668 article as read with the @samp{M} mark. It doesn't care what group it
10669 saw the article in.
10672 @item gnus-suppress-duplicates
10673 @vindex gnus-suppress-duplicates
10674 If non-@code{nil}, suppress duplicates.
10676 @item gnus-save-duplicate-list
10677 @vindex gnus-save-duplicate-list
10678 If non-@code{nil}, save the list of duplicates to a file. This will
10679 make startup and shutdown take longer, so the default is @code{nil}.
10680 However, this means that only duplicate articles read in a single gnus
10681 session are suppressed.
10683 @item gnus-duplicate-list-length
10684 @vindex gnus-duplicate-list-length
10685 This variable says how many @code{Message-ID}s to keep in the duplicate
10686 suppression list. The default is 10000.
10688 @item gnus-duplicate-file
10689 @vindex gnus-duplicate-file
10690 The name of the file to store the duplicate suppression list in. The
10691 default is @file{~/News/suppression}.
10694 If you have a tendency to stop and start gnus often, setting
10695 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
10696 you leave gnus running for weeks on end, you may have it @code{nil}. On
10697 the other hand, saving the list makes startup and shutdown much slower,
10698 so that means that if you stop and start gnus often, you should set
10699 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
10700 to you to figure out, I think.
10705 Gnus is able to verify signed messages or decrypt encrypted messages.
10706 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
10707 and @acronym{S/MIME}, however you need some external programs to get
10712 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
10713 install an OpenPGP implementation such as GnuPG. The Lisp interface
10714 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
10715 Manual}), but Mailcrypt and gpg.el are also supported.
10718 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
10719 or newer is recommended.
10723 More information on how to set things up can be found in the message
10724 manual (@pxref{Security, ,Security, message, Message Manual}).
10727 @item mm-verify-option
10728 @vindex mm-verify-option
10729 Option of verifying signed parts. @code{never}, not verify;
10730 @code{always}, always verify; @code{known}, only verify known
10731 protocols. Otherwise, ask user.
10733 @item mm-decrypt-option
10734 @vindex mm-decrypt-option
10735 Option of decrypting encrypted parts. @code{never}, no decryption;
10736 @code{always}, always decrypt; @code{known}, only decrypt known
10737 protocols. Otherwise, ask user.
10740 @vindex mml1991-use
10741 Symbol indicating elisp interface to OpenPGP implementation for
10742 @acronym{PGP} messages. The default is @code{pgg}, but
10743 @code{mailcrypt} and @code{gpg} are also supported although
10747 @vindex mml2015-use
10748 Symbol indicating elisp interface to OpenPGP implementation for
10749 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
10750 @code{mailcrypt} and @code{gpg} are also supported although
10755 @cindex snarfing keys
10756 @cindex importing PGP keys
10757 @cindex PGP key ring import
10758 Snarfing OpenPGP keys (i.e., importing keys from articles into your
10759 key ring) is not supported explicitly through a menu item or command,
10760 rather Gnus do detect and label keys as @samp{application/pgp-keys},
10761 allowing you to specify whatever action you think is appropriate
10762 through the usual @acronym{MIME} infrastructure. You can use a
10763 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
10764 Emacs MIME Manual}) such as the following to import keys using GNU
10765 Privacy Guard when you click on the @acronym{MIME} button
10766 (@pxref{Using MIME}).
10769 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
10772 This happens to also be the default action defined in
10773 @code{mailcap-mime-data}.
10776 @section Mailing List
10777 @cindex mailing list
10780 @kindex A M (summary)
10781 @findex gnus-mailing-list-insinuate
10782 Gnus understands some mailing list fields of RFC 2369. To enable it,
10783 add a @code{to-list} group parameter (@pxref{Group Parameters}),
10784 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10787 That enables the following commands to the summary buffer:
10792 @kindex C-c C-n h (Summary)
10793 @findex gnus-mailing-list-help
10794 Send a message to fetch mailing list help, if List-Help field exists.
10797 @kindex C-c C-n s (Summary)
10798 @findex gnus-mailing-list-subscribe
10799 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10802 @kindex C-c C-n u (Summary)
10803 @findex gnus-mailing-list-unsubscribe
10804 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10808 @kindex C-c C-n p (Summary)
10809 @findex gnus-mailing-list-post
10810 Post to the mailing list, if List-Post field exists.
10813 @kindex C-c C-n o (Summary)
10814 @findex gnus-mailing-list-owner
10815 Send a message to the mailing list owner, if List-Owner field exists.
10818 @kindex C-c C-n a (Summary)
10819 @findex gnus-mailing-list-archive
10820 Browse the mailing list archive, if List-Archive field exists.
10825 @node Article Buffer
10826 @chapter Article Buffer
10827 @cindex article buffer
10829 The articles are displayed in the article buffer, of which there is only
10830 one. All the summary buffers share the same article buffer unless you
10831 tell gnus otherwise.
10834 * Hiding Headers:: Deciding what headers should be displayed.
10835 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
10836 * Customizing Articles:: Tailoring the look of the articles.
10837 * Article Keymap:: Keystrokes available in the article buffer.
10838 * Misc Article:: Other stuff.
10842 @node Hiding Headers
10843 @section Hiding Headers
10844 @cindex hiding headers
10845 @cindex deleting headers
10847 The top section of each article is the @dfn{head}. (The rest is the
10848 @dfn{body}, but you may have guessed that already.)
10850 @vindex gnus-show-all-headers
10851 There is a lot of useful information in the head: the name of the person
10852 who wrote the article, the date it was written and the subject of the
10853 article. That's well and nice, but there's also lots of information
10854 most people do not want to see---what systems the article has passed
10855 through before reaching you, the @code{Message-ID}, the
10856 @code{References}, etc. ad nauseam---and you'll probably want to get rid
10857 of some of those lines. If you want to keep all those lines in the
10858 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10860 Gnus provides you with two variables for sifting headers:
10864 @item gnus-visible-headers
10865 @vindex gnus-visible-headers
10866 If this variable is non-@code{nil}, it should be a regular expression
10867 that says what headers you wish to keep in the article buffer. All
10868 headers that do not match this variable will be hidden.
10870 For instance, if you only want to see the name of the person who wrote
10871 the article and the subject, you'd say:
10874 (setq gnus-visible-headers "^From:\\|^Subject:")
10877 This variable can also be a list of regexps to match headers to
10880 @item gnus-ignored-headers
10881 @vindex gnus-ignored-headers
10882 This variable is the reverse of @code{gnus-visible-headers}. If this
10883 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10884 should be a regular expression that matches all lines that you want to
10885 hide. All lines that do not match this variable will remain visible.
10887 For instance, if you just want to get rid of the @code{References} field
10888 and the @code{Xref} field, you might say:
10891 (setq gnus-ignored-headers "^References:\\|^Xref:")
10894 This variable can also be a list of regexps to match headers to
10897 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10898 variable will have no effect.
10902 @vindex gnus-sorted-header-list
10903 Gnus can also sort the headers for you. (It does this by default.) You
10904 can control the sorting by setting the @code{gnus-sorted-header-list}
10905 variable. It is a list of regular expressions that says in what order
10906 the headers are to be displayed.
10908 For instance, if you want the name of the author of the article first,
10909 and then the subject, you might say something like:
10912 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10915 Any headers that are to remain visible, but are not listed in this
10916 variable, will be displayed in random order after all the headers listed in this variable.
10918 @findex gnus-article-hide-boring-headers
10919 @vindex gnus-boring-article-headers
10920 You can hide further boring headers by setting
10921 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
10922 does depends on the @code{gnus-boring-article-headers} variable. It's a
10923 list, but this list doesn't actually contain header names. Instead it
10924 lists various @dfn{boring conditions} that Gnus can check and remove
10927 These conditions are:
10930 Remove all empty headers.
10932 Remove the @code{Followup-To} header if it is identical to the
10933 @code{Newsgroups} header.
10935 Remove the @code{Reply-To} header if it lists the same addresses as
10936 the @code{From} header, or if the @code{broken-reply-to} group
10939 Remove the @code{Newsgroups} header if it only contains the current group
10942 Remove the @code{To} header if it only contains the address identical to
10943 the current group's @code{to-address} parameter.
10945 Remove the @code{To} header if it only contains the address identical to
10946 the current group's @code{to-list} parameter.
10948 Remove the @code{CC} header if it only contains the address identical to
10949 the current group's @code{to-list} parameter.
10951 Remove the @code{Date} header if the article is less than three days
10954 Remove the @code{To} header if it is very long.
10956 Remove all @code{To} headers if there are more than one.
10959 To include these three elements, you could say something like:
10962 (setq gnus-boring-article-headers
10963 '(empty followup-to reply-to))
10966 This is also the default value for this variable.
10970 @section Using MIME
10971 @cindex @acronym{MIME}
10973 Mime is a standard for waving your hands through the air, aimlessly,
10974 while people stand around yawning.
10976 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
10977 while all newsreaders die of fear.
10979 @acronym{MIME} may specify what character set the article uses, the encoding
10980 of the characters, and it also makes it possible to embed pictures and
10981 other naughty stuff in innocent-looking articles.
10983 @vindex gnus-show-mime
10984 @vindex gnus-article-display-method-for-mime
10985 @findex gnus-article-display-mime-message
10986 gnus handles @acronym{MIME} by pushing the articles through
10987 @code{gnus-article-display-method-for-mime}, which is
10988 @code{gnus-article-display-mime-message} by default. This function
10989 calls the @acronym{SEMI} MIME-View program to actually do the work. For
10990 more information on @acronym{SEMI} MIME-View, see its manual page
10991 (however it is not existed yet, sorry).
10993 Set @code{gnus-show-mime} to @code{t} if you want to use
10994 @acronym{MIME} all the time. If you have @code{gnus-show-mime} set,
10995 then you'll see some unfortunate display glitches in the article buffer.
10996 These can't be avoided.
10998 In GNUS or Gnus, it might be best to just use the toggling functions
10999 from the summary buffer to avoid getting nasty surprises. (For instance,
11000 you enter the group @samp{alt.sing-a-long} and, before you know it,
11001 @acronym{MIME} has decoded the sound file in the article and some
11002 horrible sing-a-long song comes screaming out your speakers, and you
11003 can't find the volume button, because there isn't one, and people are
11004 starting to look at you, and you try to stop the program, but you can't,
11005 and you can't find the program to control the volume, and everybody else
11006 in the room suddenly decides to look at you disdainfully, and you'll
11007 feel rather stupid.)
11009 Any similarity to real events and people is purely coincidental. Ahem.
11011 To avoid such kind of situation, gnus stops to use
11012 @code{metamail-buffer}. So now, you can set @code{gnus-show-mime} to
11013 non-@code{nil} every-time, then you can push button in the article
11014 buffer when there are nobody else.
11016 Also @pxref{MIME Commands}.
11019 @node Customizing Articles
11020 @section Customizing Articles
11021 @cindex article customization
11023 A slew of functions for customizing how the articles are to look like
11024 exist. You can call these functions interactively
11025 (@pxref{Article Washing}), or you can have them
11026 called automatically when you select the articles.
11028 To have them called automatically, you should set the corresponding
11029 ``treatment'' variable. For instance, to have headers hidden, you'd set
11030 @code{gnus-treat-hide-headers}. Below is a list of variables that can
11031 be set, but first we discuss the values these variables can have.
11033 Note: Some values, while valid, make little sense. Check the list below
11034 for sensible values.
11038 @code{nil}: Don't do this treatment.
11041 @code{t}: Do this treatment on all body parts.
11044 @code{head}: Do the treatment on the headers.
11047 @code{last}: Do this treatment on the last part.
11050 An integer: Do this treatment on all body parts that have a length less
11054 A list of strings: Do this treatment on all body parts that are in
11055 articles that are read in groups that have names that match one of the
11056 regexps in the list.
11059 A list where the first element is not a string:
11061 The list is evaluated recursively. The first element of the list is a
11062 predicate. The following predicates are recognized: @code{or},
11063 @code{and}, @code{not} and @code{typep}. Here's an example:
11067 (typep "text/x-vcard"))
11071 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
11076 You may have noticed that the word @dfn{part} is used here. This refers
11077 to the fact that some messages are @acronym{MIME} multipart articles that may
11078 be divided into several parts. Articles that are not multiparts are
11079 considered to contain just a single part.
11081 @vindex gnus-article-treat-types
11082 Are the treatments applied to all sorts of multipart parts? Yes, if you
11083 want to, but by default, only @samp{text/plain} parts are given the
11084 treatment. This is controlled by the @code{gnus-article-treat-types}
11085 variable, which is a list of regular expressions that are matched to the
11086 type of the part. This variable is ignored if the value of the
11087 controlling variable is a predicate list, as described above.
11089 The following treatment options are available. The easiest way to
11090 customize this is to examine the @code{gnus-article-treat} customization
11091 group. Values in parenthesis are suggested sensible values. Others are
11092 possible but those listed are probably sufficient for most people.
11095 @item gnus-treat-buttonize (t, integer)
11096 @item gnus-treat-buttonize-head (head)
11098 @xref{Article Buttons}.
11100 @item gnus-treat-capitalize-sentences (t, integer)
11101 @item gnus-treat-overstrike (t, integer)
11102 @item gnus-treat-strip-cr (t, integer)
11103 @item gnus-treat-strip-headers-in-body (t, integer)
11104 @item gnus-treat-strip-leading-blank-lines (t, integer)
11105 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11106 @item gnus-treat-strip-pem (t, last, integer)
11107 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11108 @item gnus-treat-unsplit-urls (t, integer)
11109 @item gnus-treat-wash-html (t, integer)
11110 @item gnus-treat-decode-article-as-default-mime-charset (t, integer)
11112 @xref{Article Washing}.
11114 @item gnus-treat-date-english (head)
11115 @item gnus-treat-date-iso8601 (head)
11116 @item gnus-treat-date-lapsed (head)
11117 @item gnus-treat-date-local (head)
11118 @item gnus-treat-date-original (head)
11119 @item gnus-treat-date-user-defined (head)
11120 @item gnus-treat-date-ut (head)
11122 @xref{Article Date}.
11124 @item gnus-treat-from-picon (head)
11125 @item gnus-treat-mail-picon (head)
11126 @item gnus-treat-newsgroups-picon (head)
11130 @item gnus-treat-display-smileys (t, integer)
11132 @item gnus-treat-body-boundary (head)
11134 @vindex gnus-body-boundary-delimiter
11135 Adds a delimiter between header and body, the string used as delimiter
11136 is controlled by @code{gnus-body-boundary-delimiter}.
11140 @item gnus-treat-display-x-face (head)
11144 @item gnus-treat-display-face (head)
11148 @item gnus-treat-emphasize (t, head, integer)
11149 @item gnus-treat-fill-article (t, integer)
11150 @item gnus-treat-fill-long-lines (t, integer)
11151 @item gnus-treat-hide-boring-headers (head)
11152 @item gnus-treat-hide-citation (t, integer)
11153 @item gnus-treat-hide-citation-maybe (t, integer)
11154 @item gnus-treat-hide-headers (head)
11155 @item gnus-treat-hide-signature (t, last)
11156 @item gnus-treat-strip-banner (t, last)
11157 @item gnus-treat-strip-list-identifiers (head)
11159 @xref{Article Hiding}.
11161 @item gnus-treat-highlight-citation (t, integer)
11162 @item gnus-treat-highlight-headers (head)
11163 @item gnus-treat-highlight-signature (t, last, integer)
11165 @xref{Article Highlighting}.
11167 @item gnus-treat-play-sounds
11168 @item gnus-treat-translate
11169 @item gnus-treat-ansi-sequences (t)
11170 @item gnus-treat-x-pgp-sig (head)
11172 @item gnus-treat-unfold-headers (head)
11173 @item gnus-treat-fold-headers (head)
11174 @item gnus-treat-fold-newsgroups (head)
11175 @item gnus-treat-leading-whitespace (head)
11177 @xref{Article Header}.
11182 @vindex gnus-part-display-hook
11183 You can, of course, write your own functions to be called from
11184 @code{gnus-part-display-hook}. The functions are called narrowed to the
11185 part, and you can do anything you like, pretty much. There is no
11186 information that you have to keep in the buffer---you can change
11190 @node Article Keymap
11191 @section Article Keymap
11193 Most of the keystrokes in the summary buffer can also be used in the
11194 article buffer. They should behave as if you typed them in the summary
11195 buffer, which means that you don't actually have to have a summary
11196 buffer displayed while reading. You can do it all from the article
11199 A few additional keystrokes are available:
11204 @kindex SPACE (Article)
11205 @findex gnus-article-next-page
11206 Scroll forwards one page (@code{gnus-article-next-page}).
11207 This is exactly the same as @kbd{h SPACE h}.
11210 @kindex DEL (Article)
11211 @findex gnus-article-prev-page
11212 Scroll backwards one page (@code{gnus-article-prev-page}).
11213 This is exactly the same as @kbd{h DEL h}.
11216 @kindex C-c ^ (Article)
11217 @findex gnus-article-refer-article
11218 If point is in the neighborhood of a @code{Message-ID} and you press
11219 @kbd{C-c ^}, Gnus will try to get that article from the server
11220 (@code{gnus-article-refer-article}).
11223 @kindex C-c C-m (Article)
11224 @findex gnus-article-mail
11225 Send a reply to the address near point (@code{gnus-article-mail}). If
11226 given a prefix, include the mail.
11229 @kindex s (Article)
11230 @findex gnus-article-show-summary
11231 Reconfigure the buffers so that the summary buffer becomes visible
11232 (@code{gnus-article-show-summary}).
11235 @kindex ? (Article)
11236 @findex gnus-article-describe-briefly
11237 Give a very brief description of the available keystrokes
11238 (@code{gnus-article-describe-briefly}).
11241 @kindex TAB (Article)
11242 @findex gnus-article-next-button
11243 Go to the next button, if any (@code{gnus-article-next-button}). This
11244 only makes sense if you have buttonizing turned on.
11247 @kindex M-TAB (Article)
11248 @findex gnus-article-prev-button
11249 Go to the previous button, if any (@code{gnus-article-prev-button}).
11252 @kindex R (Article)
11253 @findex gnus-article-reply-with-original
11254 Send a reply to the current article and yank the current article
11255 (@code{gnus-article-reply-with-original}). If given a prefix, make a
11256 wide reply. If the region is active, only yank the text in the
11260 @kindex F (Article)
11261 @findex gnus-article-followup-with-original
11262 Send a followup to the current article and yank the current article
11263 (@code{gnus-article-followup-with-original}). If given a prefix, make
11264 a wide reply. If the region is active, only yank the text in the
11272 @section Misc Article
11276 @item gnus-single-article-buffer
11277 @vindex gnus-single-article-buffer
11278 If non-@code{nil}, use the same article buffer for all the groups.
11279 (This is the default.) If @code{nil}, each group will have its own
11282 @vindex gnus-article-decode-hook
11283 @item gnus-article-decode-hook
11284 @cindex @acronym{MIME}
11285 Hook used to decode @acronym{MIME} articles. The default value is
11286 @code{(article-decode-charset article-decode-encoded-words)}
11288 @vindex gnus-article-prepare-hook
11289 @item gnus-article-prepare-hook
11290 This hook is called right after the article has been inserted into the
11291 article buffer. It is mainly intended for functions that do something
11292 depending on the contents; it should probably not be used for changing
11293 the contents of the article buffer.
11295 @item gnus-article-mode-hook
11296 @vindex gnus-article-mode-hook
11297 Hook called in article mode buffers.
11299 @item gnus-article-mode-syntax-table
11300 @vindex gnus-article-mode-syntax-table
11301 Syntax table used in article buffers. It is initialized from
11302 @code{text-mode-syntax-table}.
11304 @vindex gnus-article-over-scroll
11305 @item gnus-article-over-scroll
11306 If non-@code{nil}, allow scrolling the article buffer even when there
11307 no more new text to scroll in. The default is @code{nil}.
11309 @vindex gnus-article-mode-line-format
11310 @item gnus-article-mode-line-format
11311 This variable is a format string along the same lines as
11312 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
11313 Line}). It accepts the same format specifications as that variable,
11314 with two extensions:
11319 The @dfn{wash status} of the article. This is a short string with one
11320 character for each possible article wash operation that may have been
11321 performed. The characters and their meaning:
11326 Displayed when cited text may be hidden in the article buffer.
11329 Displayed when headers are hidden in the article buffer.
11332 Displayed when article is digitally signed or encrypted, and Gnus has
11333 hidden the security headers. (N.B. does not tell anything about
11334 security status, i.e. good or bad signature.)
11337 Displayed when the signature has been hidden in the Article buffer.
11340 Displayed when Gnus has treated overstrike characters in the article buffer.
11343 Displayed when Gnus has treated emphasised strings in the article buffer.
11348 The number of @acronym{MIME} parts in the article.
11352 @vindex gnus-break-pages
11354 @item gnus-break-pages
11355 Controls whether @dfn{page breaking} is to take place. If this variable
11356 is non-@code{nil}, the articles will be divided into pages whenever a
11357 page delimiter appears in the article. If this variable is @code{nil},
11358 paging will not be done.
11360 @item gnus-page-delimiter
11361 @vindex gnus-page-delimiter
11362 This is the delimiter mentioned above. By default, it is @samp{^L}
11366 @cindex internationalized domain names
11367 @vindex gnus-use-idna
11368 @item gnus-use-idna
11369 This variable controls whether Gnus performs IDNA decoding of
11370 internationalized domain names inside @samp{From}, @samp{To} and
11371 @samp{Cc} headers. @xref{IDNA, ,IDNA,message, The Message Manual},
11372 for how to compose such messages. This requires
11373 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
11374 variable is only enabled if you have installed it.
11379 @node Composing Messages
11380 @chapter Composing Messages
11381 @cindex composing messages
11384 @cindex sending mail
11389 @cindex using s/mime
11390 @cindex using smime
11392 @kindex C-c C-c (Post)
11393 All commands for posting and mailing will put you in a message buffer
11394 where you can edit the article all you like, before you send the
11395 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
11396 Message Manual}. Where the message will be posted/mailed to depends
11397 on your setup (@pxref{Posting Server}).
11400 * Mail:: Mailing and replying.
11401 * Posting Server:: What server should you post and mail via?
11402 * POP before SMTP:: You cannot send a mail unless you read a mail.
11403 * Mail and Post:: Mailing and posting at the same time.
11404 * Archived Messages:: Where Gnus stores the messages you've sent.
11405 * Posting Styles:: An easier way to specify who you are.
11406 * Drafts:: Postponing messages and rejected messages.
11407 * Rejected Articles:: What happens if the server doesn't like your article?
11408 * Signing and encrypting:: How to compose secure messages.
11411 Also @pxref{Canceling and Superseding} for information on how to
11412 remove articles you shouldn't have posted.
11418 Variables for customizing outgoing mail:
11421 @item gnus-uu-digest-headers
11422 @vindex gnus-uu-digest-headers
11423 List of regexps to match headers included in digested messages. The
11424 headers will be included in the sequence they are matched. If
11425 @code{nil} include all headers.
11427 @item gnus-add-to-list
11428 @vindex gnus-add-to-list
11429 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11430 that have none when you do a @kbd{a}.
11432 @item gnus-confirm-mail-reply-to-news
11433 @vindex gnus-confirm-mail-reply-to-news
11434 This can also be a function receiving the group name as the only
11435 parameter which should return non-@code{nil} if a confirmation is
11436 needed, or a regular expression matching group names, where
11437 confirmation is should be asked for.
11439 If you find yourself never wanting to reply to mail, but occasionally
11440 press R anyway, this variable might be for you.
11442 @item gnus-confirm-treat-mail-like-news
11443 @vindex gnus-confirm-treat-mail-like-news
11444 If non-@code{nil}, Gnus also requests confirmation according to
11445 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
11446 useful for treating mailing lists like newsgroups.
11451 @node Posting Server
11452 @section Posting Server
11454 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11455 (extremely intelligent, of course) article, where does it go?
11457 Thank you for asking. I hate you.
11459 It can be quite complicated.
11461 @vindex gnus-post-method
11462 When posting news, Message usually invokes @code{message-send-news}
11463 (@pxref{News Variables, , News Variables, message, Message Manual}).
11464 Normally, Gnus will post using the same select method as you're
11465 reading from (which might be convenient if you're reading lots of
11466 groups from different private servers). However. If the server
11467 you're reading from doesn't allow posting, just reading, you probably
11468 want to use some other server to post your (extremely intelligent and
11469 fabulously interesting) articles. You can then set the
11470 @code{gnus-post-method} to some other method:
11473 (setq gnus-post-method '(nnspool ""))
11476 Now, if you've done this, and then this server rejects your article, or
11477 this server is down, what do you do then? To override this variable you
11478 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11479 the ``current'' server, to get back the default behavior, for posting.
11481 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11482 gnus will prompt you for what method to use for posting.
11484 You can also set @code{gnus-post-method} to a list of select methods.
11485 If that's the case, gnus will always prompt you for what method to use
11488 Finally, if you want to always post using the native select method,
11489 you can set this variable to @code{native}.
11491 When sending mail, Message invokes @code{message-send-mail-function}.
11492 The default function, @code{message-send-mail-with-sendmail}, pipes
11493 your article to the @code{sendmail} binary for further queuing and
11494 sending. When your local system is not configured for sending mail
11495 using @code{sendmail}, and you have access to a remote @acronym{SMTP}
11496 server, you can set @code{message-send-mail-function} to
11497 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11498 package correctly. An example:
11501 (setq message-send-mail-function 'smtpmail-send-it
11502 smtpmail-default-smtp-server "YOUR SMTP HOST")
11503 ;; @r{The following variable needs to be set if you are using smtpmail.el}
11504 ;; @r{distributed with FLIM, lesser than the version 1.14.6.}
11505 (setq smtp-default-server "YOUR SMTP HOST")
11508 To the thing similar to this, there is
11509 @code{message-smtpmail-send-it}. It is useful if your @acronym{ISP}
11510 requires the @acronym{POP}-before-@acronym{SMTP} authentication.
11511 @xref{POP before SMTP}.
11513 Other possible choices for @code{message-send-mail-function} includes
11514 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11515 and @code{feedmail-send-it}.
11517 @node POP before SMTP
11518 @section POP before SMTP
11519 @cindex pop before smtp
11520 @findex message-smtpmail-send-it
11521 @findex mail-source-touch-pop
11523 Does your @acronym{ISP} require the @acronym{POP}-before-@acronym{SMTP}
11524 authentication? It is whether you need to connect to the @acronym{POP}
11525 mail server within a certain time before sending mails. If so, there is
11526 a convenient way. To do that, put the following lines in your
11527 @file{~/.gnus.el} file:
11530 (setq message-send-mail-function 'message-smtpmail-send-it)
11531 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
11535 It means to let Gnus connect to the @acronym{POP} mail server in advance
11536 whenever you send a mail. The @code{mail-source-touch-pop} function
11537 does only a @acronym{POP} authentication according to the value of
11538 @code{mail-sources} without fetching mails, just before sending a mail.
11539 Note that you have to use @code{message-smtpmail-send-it} which runs
11540 @code{message-send-mail-hook} rather than @code{smtpmail-send-it} and
11541 set the value of @code{mail-sources} for a @acronym{POP} connection
11542 correctly. @xref{Mail Sources}.
11544 If you have two or more @acronym{POP} mail servers set in
11545 @code{mail-sources}, you may want to specify one of them to
11546 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
11547 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
11548 is your primary @acronym{POP} mail server (i.e., you are fetching mails
11549 mainly from that server), you can set it permanently as follows:
11552 (setq mail-source-primary-source
11553 '(pop :server "pop3.mail.server"
11554 :password "secret"))
11558 Otherwise, bind it dynamically only when performing the
11559 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
11562 (add-hook 'message-send-mail-hook
11564 (let ((mail-source-primary-source
11565 '(pop :server "pop3.mail.server"
11566 :password "secret")))
11567 (mail-source-touch-pop))))
11570 @node Mail and Post
11571 @section Mail and Post
11573 Here's a list of variables relevant to both mailing and
11577 @item gnus-mailing-list-groups
11578 @findex gnus-mailing-list-groups
11579 @cindex mailing lists
11581 If your news server offers groups that are really mailing lists
11582 gatewayed to the @acronym{NNTP} server, you can read those groups without
11583 problems, but you can't post/followup to them without some difficulty.
11584 One solution is to add a @code{to-address} to the group parameters
11585 (@pxref{Group Parameters}). An easier thing to do is set the
11586 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
11587 really are mailing lists. Then, at least, followups to the mailing
11588 lists will work most of the time. Posting to these groups (@kbd{a}) is
11589 still a pain, though.
11591 @item gnus-user-agent
11592 @vindex gnus-user-agent
11595 This variable controls which information should be exposed in the
11596 User-Agent header. It can be one of the symbols @code{gnus} (show only
11597 Gnus version), @code{emacs-gnus} (show only Emacs and Gnus versions),
11598 @code{emacs-gnus-config} (same as @code{emacs-gnus} plus system
11599 configuration), @code{emacs-gnus-type} (same as @code{emacs-gnus} plus
11600 system type) or a custom string. If you set it to a string, be sure to
11601 use a valid format, see RFC 2616.
11605 You may want to do spell-checking on messages that you send out. Or, if
11606 you don't want to spell-check by hand, you could add automatic
11607 spell-checking via the @code{ispell} package:
11610 @findex ispell-message
11612 (add-hook 'message-send-hook 'ispell-message)
11615 If you want to change the @code{ispell} dictionary based on what group
11616 you're in, you could say something like the following:
11619 (add-hook 'gnus-select-group-hook
11623 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
11624 (ispell-change-dictionary "deutsch"))
11626 (ispell-change-dictionary "english")))))
11629 Modify to suit your needs.
11632 @node Archived Messages
11633 @section Archived Messages
11634 @cindex archived messages
11635 @cindex sent messages
11637 Gnus provides a few different methods for storing the mail and news you
11638 send. The default method is to use the @dfn{archive virtual server} to
11639 store the messages. If you want to disable this completely, the
11640 @code{gnus-message-archive-group} variable should be @code{nil}, which
11643 For archiving interesting messages in a group you read, see the
11644 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
11647 @vindex gnus-message-archive-method
11648 @code{gnus-message-archive-method} says what virtual server gnus is to
11649 use to store sent messages. The default is:
11652 (nnfolder "archive"
11653 (nnfolder-directory "~/Mail/archive")
11654 (nnfolder-active-file "~/Mail/archive/active")
11655 (nnfolder-get-new-mail nil)
11656 (nnfolder-inhibit-expiry t))
11659 You can, however, use any mail select method (@code{nnml},
11660 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
11661 for doing this sort of thing, though. If you don't like the default
11662 directory chosen, you could say something like:
11665 (setq gnus-message-archive-method
11666 '(nnfolder "archive"
11667 (nnfolder-inhibit-expiry t)
11668 (nnfolder-active-file "~/News/sent-mail/active")
11669 (nnfolder-directory "~/News/sent-mail/")))
11672 @vindex gnus-message-archive-group
11674 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11675 to one or more group(s) on that server. Which group to use is
11676 determined by the @code{gnus-message-archive-group} variable.
11678 This variable can be used to do the following:
11682 Messages will be saved in that group.
11684 Note that you can include a select method in the group name, then the
11685 message will not be stored in the select method given by
11686 @code{gnus-message-archive-method}, but in the select method specified
11687 by the group name, instead. Suppose @code{gnus-message-archive-method}
11688 has the default value shown above. Then setting
11689 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11690 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11691 value @code{"nnml:foo"}, then outgoing messages will be stored in
11694 @item a list of strings
11695 Messages will be saved in all those groups.
11697 @item an alist of regexps, functions and forms
11698 When a key ``matches'', the result is used.
11701 No message archiving will take place. This is the default.
11706 Just saving to a single group called @samp{MisK}:
11708 (setq gnus-message-archive-group "MisK")
11711 Saving to two groups, @samp{MisK} and @samp{safe}:
11713 (setq gnus-message-archive-group '("MisK" "safe"))
11716 Save to different groups based on what group you are in:
11718 (setq gnus-message-archive-group
11719 '(("^alt" "sent-to-alt")
11720 ("mail" "sent-to-mail")
11721 (".*" "sent-to-misc")))
11724 More complex stuff:
11726 (setq gnus-message-archive-group
11727 '((if (message-news-p)
11732 How about storing all news messages in one file, but storing all mail
11733 messages in one file per month:
11736 (setq gnus-message-archive-group
11737 '((if (message-news-p)
11739 (concat "mail." (format-time-string "%Y-%m")))))
11742 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11743 @c use a different value for @code{gnus-message-archive-group} there.)
11745 Now, when you send a message off, it will be stored in the appropriate
11746 group. (If you want to disable storing for just one particular message,
11747 you can just remove the @code{Gcc} header that has been inserted.) The
11748 archive group will appear in the group buffer the next time you start
11749 gnus, or the next time you press @kbd{F} in the group buffer. You can
11750 enter it and read the articles in it just like you'd read any other
11751 group. If the group gets really big and annoying, you can simply rename
11752 if (using @kbd{G r} in the group buffer) to something
11753 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
11754 continue to be stored in the old (now empty) group.
11756 That's the default method of archiving sent messages. Gnus offers a
11757 different way for the people who don't like the default method. In that
11758 case you should set @code{gnus-message-archive-group} to @code{nil};
11759 this will disable archiving.
11762 @item gnus-outgoing-message-group
11763 @vindex gnus-outgoing-message-group
11764 All outgoing messages will be put in this group. If you want to store
11765 all your outgoing mail and articles in the group @samp{nnml:archive},
11766 you set this variable to that value. This variable can also be a list of
11769 If you want to have greater control over what group to put each
11770 message in, you can set this variable to a function that checks the
11771 current newsgroup name and then returns a suitable group name (or list
11774 This variable can be used instead of @code{gnus-message-archive-group},
11775 but the latter is the preferred method.
11777 @item gnus-gcc-mark-as-read
11778 @vindex gnus-gcc-mark-as-read
11779 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11781 @item gnus-gcc-externalize-attachments
11782 @vindex gnus-gcc-externalize-attachments
11783 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11784 and matches the Gcc group name, attach files as external parts; if it is
11785 @code{all}, attach local files as external parts; if it is other
11786 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11787 changed in the future.
11792 @node Posting Styles
11793 @section Posting Styles
11794 @cindex posting styles
11797 All them variables, they make my head swim.
11799 So what if you want a different @code{Organization} and signature based
11800 on what groups you post to? And you post both from your home machine
11801 and your work machine, and you want different @code{From} lines, and so
11804 @vindex gnus-posting-styles
11805 One way to do stuff like that is to write clever hooks that change the
11806 variables you need to have changed. That's a bit boring, so somebody
11807 came up with the bright idea of letting the user specify these things in
11808 a handy alist. Here's an example of a @code{gnus-posting-styles}
11813 (signature "Peace and happiness")
11814 (organization "What me?"))
11816 (signature "Death to everybody"))
11817 ("comp.emacs.i-love-it"
11818 (organization "Emacs is it")))
11821 As you might surmise from this example, this alist consists of several
11822 @dfn{styles}. Each style will be applicable if the first element
11823 ``matches'', in some form or other. The entire alist will be iterated
11824 over, from the beginning towards the end, and each match will be
11825 applied, which means that attributes in later styles that match override
11826 the same attributes in earlier matching styles. So
11827 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11828 signature and the @samp{What me?} @code{Organization} header.
11830 The first element in each style is called the @code{match}. If it's a
11831 string, then Gnus will try to regexp match it against the group name.
11832 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
11833 will look in the original article for a header whose name is
11834 @var{match} and compare that @var{regexp}. @var{match} and
11835 @var{regexp} are strings. (The original article is the one you are
11836 replying or following up to. If you are not composing a reply or a
11837 followup, then there is nothing to match against.) If the
11838 @code{match} is a function symbol, that function will be called with
11839 no arguments. If it's a variable symbol, then the variable will be
11840 referenced. If it's a list, then that list will be @code{eval}ed. In
11841 any case, if this returns a non-@code{nil} value, then the style is
11842 said to @dfn{match}.
11844 Each style may contain an arbitrary amount of @dfn{attributes}. Each
11845 attribute consists of a @code{(@var{name} @var{value})} pair. In
11846 addition, you can also use the @code{(@var{name} :file @var{value})}
11847 form or the @code{(@var{name} :value @var{value})} form. Where
11848 @code{:file} signifies @var{value} represents a file name and its
11849 contents should be used as the attribute value, @code{:value} signifies
11850 @var{value} does not represent a file name explicitly. The attribute
11851 name can be one of:
11854 @item @code{signature}
11855 @item @code{signature-file}
11856 @item @code{x-face-file}
11857 @item @code{address}, overriding @code{user-mail-address}
11858 @item @code{name}, overriding @code{(user-full-name)}
11862 The attribute name can also be a string or a symbol. In that case,
11863 this will be used as a header name, and the value will be inserted in
11864 the headers of the article; if the value is @code{nil}, the header
11865 name will be removed. If the attribute name is @code{eval}, the form
11866 is evaluated, and the result is thrown away.
11868 The attribute value can be a string (used verbatim), a function with
11869 zero arguments (the return value will be used), a variable (its value
11870 will be used) or a list (it will be @code{eval}ed and the return value
11871 will be used). The functions and sexps are called/@code{eval}ed in the
11872 message buffer that is being set up. The headers of the current article
11873 are available through the @code{message-reply-headers} variable, which
11874 is a vector of the following headers: number subject from date id
11875 references chars lines xref extra.
11877 @vindex message-reply-headers
11879 If you wish to check whether the message you are about to compose is
11880 meant to be a news article or a mail message, you can check the values
11881 of the @code{message-news-p} and @code{message-mail-p} functions.
11883 @findex message-mail-p
11884 @findex message-news-p
11886 So here's a new example:
11889 (setq gnus-posting-styles
11891 (signature-file "~/.signature")
11893 ("X-Home-Page" (getenv "WWW_HOME"))
11894 (organization "People's Front Against MWM"))
11896 (signature my-funny-signature-randomizer))
11897 ((equal (system-name) "gnarly") ;; @r{A form}
11898 (signature my-quote-randomizer))
11899 (message-news-p ;; @r{A function symbol}
11900 (signature my-news-signature))
11901 (window-system ;; @r{A value symbol}
11902 ("X-Window-System" (format "%s" window-system)))
11903 ;; @r{If I'm replying to Larsi, set the Organization header.}
11904 ((header "from" "larsi.*org")
11905 (Organization "Somewhere, Inc."))
11906 ((posting-from-work-p) ;; @r{A user defined function}
11907 (signature-file "~/.work-signature")
11908 (address "user@@bar.foo")
11909 (body "You are fired.\n\nSincerely, your boss.")
11910 (organization "Important Work, Inc"))
11912 (From (save-excursion
11913 (set-buffer gnus-article-buffer)
11914 (message-fetch-field "to"))))
11916 (signature-file "~/.mail-signature"))))
11919 The @samp{nnml:.*} rule means that you use the @code{To} address as the
11920 @code{From} address in all your outgoing replies, which might be handy
11921 if you fill many roles.
11923 Setting the @code{gnus-named-posting-styles} variable will make
11924 posting-styles allow to have distinctive names. You can specify an
11925 arbitrary posting-style when article posting with @kbd{S P} in the
11926 summary buffer. @code{gnus-named-posting-styles} is an alist which maps
11927 the names to styles. Once a posting-style is added to the alist, we can
11928 import it from @code{gnus-posting-styles}. If an attribute whose name
11929 is @code{import} is found, Gnus will look for the attribute value in
11930 @code{gnus-named-posting-styles} and expand it in place.
11935 (setq gnus-named-posting-styles
11937 (signature-file "~/.signature")
11939 ("X-Home-Page" (getenv "WWW_HOME"))
11940 (organization "People's Front Against MWM"))
11943 (organization "The Church of Emacs"))))
11946 The posting-style named "Emacs" will inherit all the attributes from
11947 "Default" except @code{organization}.
11954 If you are writing a message (mail or news) and suddenly remember that
11955 you have a steak in the oven (or some pesto in the food processor, you
11956 craaazy vegetarians), you'll probably wish there was a method to save
11957 the message you are writing so that you can continue editing it some
11958 other day, and send it when you feel its finished.
11960 Well, don't worry about it. Whenever you start composing a message of
11961 some sort using the gnus mail and post commands, the buffer you get will
11962 automatically associate to an article in a special @dfn{draft} group.
11963 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
11964 article will be saved there. (Auto-save files also go to the draft
11968 @vindex nndraft-directory
11969 The draft group is a special group (which is implemented as an
11970 @code{nndraft} group, if you absolutely have to know) called
11971 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
11972 @code{nndraft} is to store its files. What makes this group special is
11973 that you can't tick any articles in it or mark any articles as
11974 read---all articles in the group are permanently unread.
11976 If the group doesn't exist, it will be created and you'll be subscribed
11977 to it. The only way to make it disappear from the Group buffer is to
11978 unsubscribe it. The special properties of the draft group comes from
11979 a group property (@pxref{Group Parameters}), and if lost the group
11980 behaves like any other group. This means the commands below will not
11981 be available. To restore the special properties of the group, the
11982 simplest way is to kill the group, using @kbd{C-k}, and restart
11983 Gnus. The group is automatically created again with the
11984 correct parameters. The content of the group is not lost.
11986 @c @findex gnus-dissociate-buffer-from-draft
11987 @c @kindex C-c M-d (Mail)
11988 @c @kindex C-c M-d (Post)
11989 @c @findex gnus-associate-buffer-with-draft
11990 @c @kindex C-c C-d (Mail)
11991 @c @kindex C-c C-d (Post)
11992 @c If you're writing some super-secret message that you later want to
11993 @c encode with PGP before sending, you may wish to turn the auto-saving
11994 @c (and association with the draft group) off. You never know who might be
11995 @c interested in reading all your extremely valuable and terribly horrible
11996 @c and interesting secrets. The @kbd{C-c M-d}
11997 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
11998 @c If you change your mind and want to turn the auto-saving back on again,
11999 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
12001 @c @vindex gnus-use-draft
12002 @c To leave association with the draft group off by default, set
12003 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
12005 @findex gnus-draft-edit-message
12006 @kindex D e (Draft)
12007 When you want to continue editing the article, you simply enter the
12008 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
12009 that. You will be placed in a buffer where you left off.
12011 Rejected articles will also be put in this draft group (@pxref{Rejected
12014 @findex gnus-draft-send-all-messages
12015 @kindex D s (Draft)
12016 @findex gnus-draft-send-message
12017 @kindex D S (Draft)
12018 If you have lots of rejected messages you want to post (or mail) without
12019 doing further editing, you can use the @kbd{D s} command
12020 (@code{gnus-draft-send-message}). This command understands the
12021 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
12022 command (@code{gnus-draft-send-all-messages}) will ship off all messages
12025 @findex gnus-draft-toggle-sending
12026 @kindex D t (Draft)
12027 If you have some messages that you wish not to send, you can use the
12028 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
12029 as unsendable. This is a toggling command.
12032 @node Rejected Articles
12033 @section Rejected Articles
12034 @cindex rejected articles
12036 Sometimes a news server will reject an article. Perhaps the server
12037 doesn't like your face. Perhaps it just feels miserable. Perhaps
12038 @emph{there be demons}. Perhaps you have included too much cited text.
12039 Perhaps the disk is full. Perhaps the server is down.
12041 These situations are, of course, totally beyond the control of gnus.
12042 (Gnus, of course, loves the way you look, always feels great, has angels
12043 fluttering around inside of it, doesn't care about how much cited text
12044 you include, never runs full and never goes down.) So gnus saves these
12045 articles until some later time when the server feels better.
12047 The rejected articles will automatically be put in a special draft group
12048 (@pxref{Drafts}). When the server comes back up again, you'd then
12049 typically enter that group and send all the articles off.
12051 @node Signing and encrypting
12052 @section Signing and encrypting
12054 @cindex using s/mime
12055 @cindex using smime
12057 Gnus can digitally sign and encrypt your messages, using vanilla
12058 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
12059 decoding such messages, see the @code{mm-verify-option} and
12060 @code{mm-decrypt-option} options (@pxref{Security}).
12062 @vindex gnus-message-replysign
12063 @vindex gnus-message-replyencrypt
12064 @vindex gnus-message-replysignencrypted
12065 Often, you would like to sign replies to people who send you signed
12066 messages. Even more often, you might want to encrypt messages which
12067 are in reply to encrypted messages. Gnus offers
12068 @code{gnus-message-replysign} to enable the former, and
12069 @code{gnus-message-replyencrypt} for the latter. In addition, setting
12070 @code{gnus-message-replysignencrypted} (on by default) will sign
12071 automatically encrypted messages.
12073 Instructing @acronym{MML} to perform security operations on a
12074 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
12075 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
12080 @kindex C-c C-m s s (Message)
12081 @findex mml-secure-message-sign-smime
12083 Digitally sign current message using @acronym{S/MIME}.
12086 @kindex C-c C-m s o (Message)
12087 @findex mml-secure-message-sign-pgp
12089 Digitally sign current message using @acronym{PGP}.
12092 @kindex C-c C-m s p (Message)
12093 @findex mml-secure-message-sign-pgp
12095 Digitally sign current message using @acronym{PGP/MIME}.
12098 @kindex C-c C-m c s (Message)
12099 @findex mml-secure-message-encrypt-smime
12101 Digitally encrypt current message using @acronym{S/MIME}.
12104 @kindex C-c C-m c o (Message)
12105 @findex mml-secure-message-encrypt-pgp
12107 Digitally encrypt current message using @acronym{PGP}.
12110 @kindex C-c C-m c p (Message)
12111 @findex mml-secure-message-encrypt-pgpmime
12113 Digitally encrypt current message using @acronym{PGP/MIME}.
12116 @kindex C-c C-m C-n (Message)
12117 @findex mml-unsecure-message
12118 Remove security related @acronym{MML} tags from message.
12122 @xref{Security, ,Security, message, Message Manual}, for more information.
12124 @node Select Methods
12125 @chapter Select Methods
12126 @cindex foreign groups
12127 @cindex select methods
12129 A @dfn{foreign group} is a group not read by the usual (or
12130 default) means. It could be, for instance, a group from a different
12131 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12132 personal mail group.
12134 A foreign group (or any group, really) is specified by a @dfn{name} and
12135 a @dfn{select method}. To take the latter first, a select method is a
12136 list where the first element says what back end to use (e.g. @code{nntp},
12137 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12138 name}. There may be additional elements in the select method, where the
12139 value may have special meaning for the back end in question.
12141 One could say that a select method defines a @dfn{virtual server}---so
12142 we do just that (@pxref{Server Buffer}).
12144 The @dfn{name} of the group is the name the back end will recognize the
12147 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12148 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12149 method @code{(nntp "some.where.edu")}. Gnus will call this group
12150 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12151 back end just knows this group as @samp{soc.motss}.
12153 The different methods all have their peculiarities, of course.
12156 * Server Buffer:: Making and editing virtual servers.
12157 * Getting News:: Reading USENET news with Gnus.
12158 * Getting Mail:: Reading your personal mail with Gnus.
12159 * Browsing the Web:: Getting messages from a plethora of Web sources.
12160 * IMAP:: Using Gnus as a @acronym{IMAP} client.
12161 * Other Sources:: Reading directories, files, SOUP packets.
12162 * Combined Groups:: Combining groups into one group.
12163 * Email Based Diary:: Using mails to manage diary events in Gnus.
12164 * Gnus Unplugged:: Reading news and mail offline.
12168 @node Server Buffer
12169 @section Server Buffer
12171 Traditionally, a @dfn{server} is a machine or a piece of software that
12172 one connects to, and then requests information from. Gnus does not
12173 connect directly to any real servers, but does all transactions through
12174 one back end or other. But that's just putting one layer more between
12175 the actual media and Gnus, so we might just as well say that each
12176 back end represents a virtual server.
12178 For instance, the @code{nntp} back end may be used to connect to several
12179 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12180 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12181 use, and what parameters to set by specifying a @dfn{select method}.
12183 These select method specifications can sometimes become quite
12184 complicated---say, for instance, that you want to read from the
12185 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12186 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12187 Anyway, if you had to specify that for each group that used this
12188 server, that would be too much work, so Gnus offers a way of naming
12189 select methods, which is what you do in the server buffer.
12191 To enter the server buffer, use the @kbd{^}
12192 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12195 * Server Buffer Format:: You can customize the look of this buffer.
12196 * Server Commands:: Commands to manipulate servers.
12197 * Example Methods:: Examples server specifications.
12198 * Creating a Virtual Server:: An example session.
12199 * Server Variables:: Which variables to set.
12200 * Servers and Methods:: You can use server names as select methods.
12201 * Unavailable Servers:: Some servers you try to contact may be down.
12204 @vindex gnus-server-mode-hook
12205 @code{gnus-server-mode-hook} is run when creating the server buffer.
12208 @node Server Buffer Format
12209 @subsection Server Buffer Format
12210 @cindex server buffer format
12212 @vindex gnus-server-line-format
12213 You can change the look of the server buffer lines by changing the
12214 @code{gnus-server-line-format} variable. This is a @code{format}-like
12215 variable, with some simple extensions:
12220 How the news is fetched---the back end name.
12223 The name of this server.
12226 Where the news is to be fetched from---the address.
12229 The opened/closed/denied status of the server.
12232 @vindex gnus-server-mode-line-format
12233 The mode line can also be customized by using the
12234 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12235 Formatting}). The following specs are understood:
12245 Also @pxref{Formatting Variables}.
12248 @node Server Commands
12249 @subsection Server Commands
12250 @cindex server commands
12256 @findex gnus-server-add-server
12257 Add a new server (@code{gnus-server-add-server}).
12261 @findex gnus-server-edit-server
12262 Edit a server (@code{gnus-server-edit-server}).
12265 @kindex SPACE (Server)
12266 @findex gnus-server-read-server
12267 Browse the current server (@code{gnus-server-read-server}).
12271 @findex gnus-server-exit
12272 Return to the group buffer (@code{gnus-server-exit}).
12276 @findex gnus-server-kill-server
12277 Kill the current server (@code{gnus-server-kill-server}).
12281 @findex gnus-server-yank-server
12282 Yank the previously killed server (@code{gnus-server-yank-server}).
12286 @findex gnus-server-copy-server
12287 Copy the current server (@code{gnus-server-copy-server}).
12291 @findex gnus-server-list-servers
12292 List all servers (@code{gnus-server-list-servers}).
12296 @findex gnus-server-scan-server
12297 Request that the server scan its sources for new articles
12298 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12303 @findex gnus-server-regenerate-server
12304 Request that the server regenerate all its data structures
12305 (@code{gnus-server-regenerate-server}). This can be useful if you have
12306 a mail back end that has gotten out of sync.
12311 @node Example Methods
12312 @subsection Example Methods
12314 Most select methods are pretty simple and self-explanatory:
12317 (nntp "news.funet.fi")
12320 Reading directly from the spool is even simpler:
12326 As you can see, the first element in a select method is the name of the
12327 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12330 After these two elements, there may be an arbitrary number of
12331 @code{(@var{variable} @var{form})} pairs.
12333 To go back to the first example---imagine that you want to read from
12334 port 15 on that machine. This is what the select method should
12338 (nntp "news.funet.fi" (nntp-port-number 15))
12341 You should read the documentation to each back end to find out what
12342 variables are relevant, but here's an @code{nnmh} example:
12344 @code{nnmh} is a mail back end that reads a spool-like structure. Say
12345 you have two structures that you wish to access: One is your private
12346 mail spool, and the other is a public one. Here's the possible spec for
12350 (nnmh "private" (nnmh-directory "~/private/mail/"))
12353 (This server is then called @samp{private}, but you may have guessed
12356 Here's the method for a public spool:
12360 (nnmh-directory "/usr/information/spool/")
12361 (nnmh-get-new-mail nil))
12367 If you are behind a firewall and only have access to the @acronym{NNTP}
12368 server from the firewall machine, you can instruct Gnus to @code{rlogin}
12369 on the firewall machine and telnet from there to the @acronym{NNTP} server.
12370 Doing this can be rather fiddly, but your virtual server definition
12371 should probably look something like this:
12375 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
12376 (nntp-via-address "the.firewall.machine")
12377 (nntp-address "the.real.nntp.host")
12378 (nntp-end-of-line "\n"))
12381 If you want to use the wonderful @code{ssh} program to provide a
12382 compressed connection over the modem line, you could add the following
12383 configuration to the example above:
12386 (nntp-via-rlogin-command "ssh")
12389 See also @code{nntp-via-rlogin-command-switches}.
12391 If you're behind a firewall, but have direct access to the outside world
12392 through a wrapper command like "runsocks", you could open a socksified
12393 telnet connection to the news server as follows:
12397 (nntp-pre-command "runsocks")
12398 (nntp-open-connection-function nntp-open-via-telnet)
12399 (nntp-address "the.news.server")
12400 (nntp-end-of-line "\n"))
12403 This means that you have to have set up @code{ssh-agent} correctly to
12404 provide automatic authorization, of course. And to get a compressed
12405 connection, you have to have the @samp{Compression} option in the
12406 @code{ssh} @file{config} file.
12409 @node Creating a Virtual Server
12410 @subsection Creating a Virtual Server
12412 If you're saving lots of articles in the cache by using persistent
12413 articles, you may want to create a virtual server to read the cache.
12415 First you need to add a new server. The @kbd{a} command does that. It
12416 would probably be best to use @code{nnml} to read the cache. You
12417 could also use @code{nnspool} or @code{nnmh}, though.
12419 Type @kbd{a nnml RET cache RET}.
12421 You should now have a brand new @code{nnml} virtual server called
12422 @samp{cache}. You now need to edit it to have the right definitions.
12423 Type @kbd{e} to edit the server. You'll be entered into a buffer that
12424 will contain the following:
12434 (nnml-directory "~/News/cache/")
12435 (nnml-active-file "~/News/cache/active"))
12438 Type @kbd{C-c C-c} to return to the server buffer. If you now press
12439 @kbd{RET} over this virtual server, you should be entered into a browse
12440 buffer, and you should be able to enter any of the groups displayed.
12443 @node Server Variables
12444 @subsection Server Variables
12445 @cindex server variables
12446 @cindex server parameters
12448 One sticky point when defining variables (both on back ends and in Emacs
12449 in general) is that some variables are typically initialized from other
12450 variables when the definition of the variables is being loaded. If you
12451 change the ``base'' variable after the variables have been loaded, you
12452 won't change the ``derived'' variables.
12454 This typically affects directory and file variables. For instance,
12455 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
12456 directory variables are initialized from that variable, so
12457 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
12458 new virtual @code{nnml} server, it will @emph{not} suffice to set just
12459 @code{nnml-directory}---you have to explicitly set all the file
12460 variables to be what you want them to be. For a complete list of
12461 variables for each back end, see each back end's section later in this
12462 manual, but here's an example @code{nnml} definition:
12466 (nnml-directory "~/my-mail/")
12467 (nnml-active-file "~/my-mail/active")
12468 (nnml-newsgroups-file "~/my-mail/newsgroups"))
12471 Server variables are often called @dfn{server parameters}.
12473 @node Servers and Methods
12474 @subsection Servers and Methods
12476 Wherever you would normally use a select method
12477 (e.g. @code{gnus-secondary-select-method}, in the group select method,
12478 when browsing a foreign server) you can use a virtual server name
12479 instead. This could potentially save lots of typing. And it's nice all
12483 @node Unavailable Servers
12484 @subsection Unavailable Servers
12486 If a server seems to be unreachable, Gnus will mark that server as
12487 @code{denied}. That means that any subsequent attempt to make contact
12488 with that server will just be ignored. ``It can't be opened,'' Gnus
12489 will tell you, without making the least effort to see whether that is
12490 actually the case or not.
12492 That might seem quite naughty, but it does make sense most of the time.
12493 Let's say you have 10 groups subscribed to on server
12494 @samp{nephelococcygia.com}. This server is located somewhere quite far
12495 away from you and the machine is quite slow, so it takes 1 minute just
12496 to find out that it refuses connection to you today. If Gnus were to
12497 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12498 attempt to do that. Once it has gotten a single ``connection refused'',
12499 it will regard that server as ``down''.
12501 So, what happens if the machine was only feeling unwell temporarily?
12502 How do you test to see whether the machine has come up again?
12504 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12505 with the following commands:
12511 @findex gnus-server-open-server
12512 Try to establish connection to the server on the current line
12513 (@code{gnus-server-open-server}).
12517 @findex gnus-server-close-server
12518 Close the connection (if any) to the server
12519 (@code{gnus-server-close-server}).
12523 @findex gnus-server-deny-server
12524 Mark the current server as unreachable
12525 (@code{gnus-server-deny-server}).
12528 @kindex M-o (Server)
12529 @findex gnus-server-open-all-servers
12530 Open the connections to all servers in the buffer
12531 (@code{gnus-server-open-all-servers}).
12534 @kindex M-c (Server)
12535 @findex gnus-server-close-all-servers
12536 Close the connections to all servers in the buffer
12537 (@code{gnus-server-close-all-servers}).
12541 @findex gnus-server-remove-denials
12542 Remove all marks to whether Gnus was denied connection from any servers
12543 (@code{gnus-server-remove-denials}).
12547 @findex gnus-server-offline-server
12548 Set server status to offline (@code{gnus-server-offline-server}).
12554 @section Getting News
12555 @cindex reading news
12556 @cindex news back ends
12558 A newsreader is normally used for reading news. Gnus currently provides
12559 only two methods of getting news---it can read from an @acronym{NNTP} server,
12560 or it can read from a local spool.
12563 * NNTP:: Reading news from an @acronym{NNTP} server.
12564 * News Spool:: Reading news from the local spool.
12572 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
12573 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
12574 server as the, uhm, address.
12576 If the @acronym{NNTP} server is located at a non-standard port, setting the
12577 third element of the select method to this port number should allow you
12578 to connect to the right port. You'll have to edit the group info for
12579 that (@pxref{Foreign Groups}).
12581 The name of the foreign group can be the same as a native group. In
12582 fact, you can subscribe to the same group from as many different servers
12583 you feel like. There will be no name collisions.
12585 The following variables can be used to create a virtual @code{nntp}
12590 @item nntp-server-opened-hook
12591 @vindex nntp-server-opened-hook
12592 @cindex @sc{mode reader}
12594 @cindex authentification
12595 @cindex nntp authentification
12596 @findex nntp-send-authinfo
12597 @findex nntp-send-mode-reader
12598 is run after a connection has been made. It can be used to send
12599 commands to the @acronym{NNTP} server after it has been contacted. By
12600 default it sends the command @code{MODE READER} to the server with the
12601 @code{nntp-send-mode-reader} function. This function should always be
12602 present in this hook.
12604 @item nntp-authinfo-function
12605 @vindex nntp-authinfo-function
12606 @findex nntp-send-authinfo
12607 @vindex nntp-authinfo-file
12608 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
12609 server. The default function is @code{nntp-send-authinfo}, which looks
12610 through your @file{~/.authinfo} (or whatever you've set the
12611 @code{nntp-authinfo-file} variable to) for applicable entries. If none
12612 are found, it will prompt you for a login name and a password. The
12613 format of the @file{~/.authinfo} file is (almost) the same as the
12614 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
12615 manual page, but here are the salient facts:
12619 The file contains one or more line, each of which define one server.
12622 Each line may contain an arbitrary number of token/value pairs.
12624 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
12625 @samp{default}. In addition Gnus introduces two new tokens, not present
12626 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
12627 @samp{force}. (This is the only way the @file{.authinfo} file format
12628 deviates from the @file{.netrc} file format.) @samp{port} is used to
12629 indicate what port on the server the credentials apply to and
12630 @samp{force} is explained below.
12634 Here's an example file:
12637 machine news.uio.no login larsi password geheimnis
12638 machine nntp.ifi.uio.no login larsi force yes
12641 The token/value pairs may appear in any order; @samp{machine} doesn't
12642 have to be first, for instance.
12644 In this example, both login name and password have been supplied for the
12645 former server, while the latter has only the login name listed, and the
12646 user will be prompted for the password. The latter also has the
12647 @samp{force} tag, which means that the authinfo will be sent to the
12648 @var{nntp} server upon connection; the default (i.e., when there is not
12649 @samp{force} tag) is to not send authinfo to the @var{nntp} server
12650 until the @var{nntp} server asks for it.
12652 You can also add @samp{default} lines that will apply to all servers
12653 that don't have matching @samp{machine} lines.
12659 This will force sending @samp{AUTHINFO} commands to all servers not
12660 previously mentioned.
12662 Remember to not leave the @file{~/.authinfo} file world-readable.
12664 @item nntp-server-action-alist
12665 @vindex nntp-server-action-alist
12666 This is a list of regexps to match on server types and actions to be
12667 taken when matches are made. For instance, if you want Gnus to beep
12668 every time you connect to innd, you could say something like:
12671 (setq nntp-server-action-alist
12672 '(("innd" (ding))))
12675 You probably don't want to do that, though.
12677 The default value is
12680 '(("nntpd 1\\.5\\.11t"
12681 (remove-hook 'nntp-server-opened-hook
12682 'nntp-send-mode-reader)))
12685 This ensures that Gnus doesn't send the @code{MODE READER} command to
12686 nntpd 1.5.11t, since that command chokes that server, I've been told.
12688 @item nntp-maximum-request
12689 @vindex nntp-maximum-request
12690 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
12691 will collect headers by sending a series of @code{head} commands. To
12692 speed things up, the back end sends lots of these commands without
12693 waiting for reply, and then reads all the replies. This is controlled
12694 by the @code{nntp-maximum-request} variable, and is 400 by default. If
12695 your network is buggy, you should set this to 1.
12697 @item nntp-connection-timeout
12698 @vindex nntp-connection-timeout
12699 If you have lots of foreign @code{nntp} groups that you connect to
12700 regularly, you're sure to have problems with @acronym{NNTP} servers not
12701 responding properly, or being too loaded to reply within reasonable
12702 time. This is can lead to awkward problems, which can be helped
12703 somewhat by setting @code{nntp-connection-timeout}. This is an integer
12704 that says how many seconds the @code{nntp} back end should wait for a
12705 connection before giving up. If it is @code{nil}, which is the default,
12706 no timeouts are done.
12708 @c @item nntp-command-timeout
12709 @c @vindex nntp-command-timeout
12710 @c @cindex PPP connections
12711 @c @cindex dynamic IP addresses
12712 @c If you're running Gnus on a machine that has a dynamically assigned
12713 @c address, Gnus may become confused. If the address of your machine
12714 @c changes after connecting to the @acronym{NNTP} server, Gnus will simply sit
12715 @c waiting forever for replies from the server. To help with this
12716 @c unfortunate problem, you can set this command to a number. Gnus will
12717 @c then, if it sits waiting for a reply from the server longer than that
12718 @c number of seconds, shut down the connection, start a new one, and resend
12719 @c the command. This should hopefully be transparent to the user. A
12720 @c likely number is 30 seconds.
12722 @c @item nntp-retry-on-break
12723 @c @vindex nntp-retry-on-break
12724 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
12725 @c hangs. This will have much the same effect as the command timeout
12726 @c described above.
12728 @item nntp-server-hook
12729 @vindex nntp-server-hook
12730 This hook is run as the last step when connecting to an @acronym{NNTP}
12733 @item nntp-buggy-select
12734 @vindex nntp-buggy-select
12735 Set this to non-@code{nil} if your select routine is buggy.
12737 @item nntp-nov-is-evil
12738 @vindex nntp-nov-is-evil
12739 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
12740 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
12743 @item nntp-xover-commands
12744 @vindex nntp-xover-commands
12745 @cindex @acronym{NOV}
12747 List of strings used as commands to fetch @acronym{NOV} lines from a
12748 server. The default value of this variable is @code{("XOVER"
12752 @vindex nntp-nov-gap
12753 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
12754 the server. The server responds with one huge list of lines. However,
12755 if you have read articles 2-5000 in the group, and only want to read
12756 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
12757 lines that you will not need. This variable says how
12758 big a gap between two consecutive articles is allowed to be before the
12759 @code{XOVER} request is split into several request. Note that if your
12760 network is fast, setting this variable to a really small number means
12761 that fetching will probably be slower. If this variable is @code{nil},
12762 @code{nntp} will never split requests. The default is 5.
12764 @item nntp-prepare-server-hook
12765 @vindex nntp-prepare-server-hook
12766 A hook run before attempting to connect to an @acronym{NNTP} server.
12768 @item nntp-warn-about-losing-connection
12769 @vindex nntp-warn-about-losing-connection
12770 If this variable is non-@code{nil}, some noise will be made when a
12771 server closes connection.
12773 @item nntp-record-commands
12774 @vindex nntp-record-commands
12775 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12776 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
12777 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
12778 that doesn't seem to work.
12780 @item nntp-open-connection-function
12781 @vindex nntp-open-connection-function
12782 It is possible to customize how the connection to the nntp server will
12783 be opened. If you specify an @code{nntp-open-connection-function}
12784 parameter, Gnus will use that function to establish the connection.
12785 Five pre-made functions are supplied. These functions can be grouped in
12786 two categories: direct connection functions (three pre-made), and
12787 indirect ones (two pre-made).
12789 @item nntp-prepare-post-hook
12790 @vindex nntp-prepare-post-hook
12791 A hook run just before posting an article. If there is no
12792 @code{Message-ID} header in the article and the news server provides the
12793 recommended ID, it will be added to the article before running this
12794 hook. It is useful to make @code{Cancel-Lock} headers even if you
12795 inhibit Gnus to add a @code{Message-ID} header, you could say:
12798 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12801 Note that not all servers support the recommended ID. This works for
12802 INN versions 2.3.0 and later, for instance.
12804 @item nntp-read-timeout
12805 @vindex nntp-read-timeout
12806 How long nntp should wait between checking for the end of output.
12807 Shorter values mean quicker response, but is more CPU intensive. The
12808 default is 0.1 seconds. If you have a slow line to the server (and
12809 don't like to see Emacs eat your available CPU power), you might set
12812 @item nntp-list-options
12813 @vindex nntp-list-options
12814 List of newsgroup name used for a option of the LIST command to restrict
12815 the listing output to only the specified newsgroups. Each newsgroup name
12816 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
12817 etc. Fortunately, if the server can accept such a option, it will
12818 probably make gnus run faster. You may use it as a server variable as
12822 (setq gnus-select-method
12823 '(nntp "news.somewhere.edu"
12824 (nntp-list-options ("fj.*" "japan.*"))))
12827 @item nntp-options-subscribe
12828 @vindex nntp-options-subscribe
12829 Regexp matching the newsgroup names which will be subscribed
12830 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12831 It may be effective as well as @code{nntp-list-options} even though the
12832 server could not accept a shell-style wildcard as a option of the LIST
12833 command. You may use it as a server variable as follows:
12836 (setq gnus-select-method
12837 '(nntp "news.somewhere.edu"
12838 (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
12841 @item nntp-options-not-subscribe
12842 @vindex nntp-options-not-subscribe
12843 Regexp matching the newsgroup names which will not be subscribed
12844 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12845 It may be effective as well as @code{nntp-list-options} even though the
12846 server could not accept a shell-style wildcard as a option of the LIST
12847 command. You may use it as a server variable as follows:
12850 (setq gnus-select-method
12851 '(nntp "news.somewhere.edu"
12852 (nntp-options-not-subscribe "\\.binaries\\.")))
12857 * Direct Functions:: Connecting directly to the server.
12858 * Indirect Functions:: Connecting indirectly to the server.
12859 * Common Variables:: Understood by several connection functions.
12860 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
12864 @node Direct Functions
12865 @subsubsection Direct Functions
12866 @cindex direct connection functions
12868 These functions are called direct because they open a direct connection
12869 between your machine and the @acronym{NNTP} server. The behavior of these
12870 functions is also affected by commonly understood variables
12871 (@pxref{Common Variables}).
12874 @findex nntp-open-network-stream
12875 @item nntp-open-network-stream
12876 This is the default, and simply connects to some port or other on the
12879 @findex nntp-open-tls-stream
12880 @item nntp-open-tls-stream
12881 Opens a connection to a server over a @dfn{secure} channel. To use
12882 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
12883 installed. You then define a server as follows:
12886 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
12887 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
12889 (nntp "snews.bar.com"
12890 (nntp-open-connection-function nntp-open-tls-stream)
12891 (nntp-port-number )
12892 (nntp-address "snews.bar.com"))
12895 @findex nntp-open-ssl-stream
12896 @item nntp-open-ssl-stream
12897 Opens a connection to a server over a @dfn{secure} channel. To use
12898 this you must have @uref{http://www.openssl.org, OpenSSL} or
12899 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
12900 then define a server as follows:
12903 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
12904 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
12906 (nntp "snews.bar.com"
12907 (nntp-open-connection-function nntp-open-ssl-stream)
12908 (nntp-port-number 563)
12909 (nntp-address "snews.bar.com"))
12912 @findex nntp-open-telnet-stream
12913 @item nntp-open-telnet-stream
12914 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
12915 it. You might wonder why this function exists, since we have the
12916 default @code{nntp-open-network-stream} which would do the job. (One
12917 of) the reason(s) is that if you are behind a firewall but have direct
12918 connections to the outside world thanks to a command wrapper like
12919 @code{runsocks}, you can use it like this:
12923 (nntp-pre-command "runsocks")
12924 (nntp-open-connection-function nntp-open-telnet-stream)
12925 (nntp-address "the.news.server"))
12928 With the default method, you would need to wrap your whole Emacs
12929 session, which is not a good idea.
12933 @node Indirect Functions
12934 @subsubsection Indirect Functions
12935 @cindex indirect connection functions
12937 These functions are called indirect because they connect to an
12938 intermediate host before actually connecting to the @acronym{NNTP} server.
12939 All of these functions and related variables are also said to belong to
12940 the ``via'' family of connection: they're all prefixed with ``via'' to make
12941 things cleaner. The behavior of these functions is also affected by
12942 commonly understood variables (@pxref{Common Variables}).
12945 @item nntp-open-via-rlogin-and-telnet
12946 @findex nntp-open-via-rlogin-and-telnet
12947 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
12948 to the real @acronym{NNTP} server from there. This is useful for instance if
12949 you need to connect to a firewall machine first.
12951 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
12954 @item nntp-via-rlogin-command
12955 @vindex nntp-via-rlogin-command
12956 Command used to log in on the intermediate host. The default is
12957 @samp{rsh}, but @samp{ssh} is a popular alternative.
12959 @item nntp-via-rlogin-command-switches
12960 @vindex nntp-via-rlogin-command-switches
12961 List of strings to be used as the switches to
12962 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
12963 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
12964 @samp{("-C")} in order to compress all data connections, otherwise set
12965 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
12966 the telnet command requires a pseudo-tty allocation on an intermediate
12970 Note that you may want to change the value for @code{nntp-end-of-line}
12971 to @samp{\n} (@pxref{Common Variables}).
12973 @item nntp-open-via-rlogin-and-netcat
12974 @findex nntp-open-via-rlogin-and-netcat
12975 Does essentially the same, but uses @samp{netcat}
12976 (@uref{http://netcat.sourceforge.net/}) instead of @samp{telnet} to
12977 connect to the real @acronym{NNTP} server from the intermediate host.
12979 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
12982 @item nntp-via-netcat-command
12983 @vindex nntp-via-netcat-command
12984 Command used to connect to the real @acronym{NNTP} server from the
12985 intermediate host. The default is @samp{nc}. You can also use other
12986 programs like @samp{connect}
12987 (@uref{http://www.imasy.or.jp/~gotoh/ssh/connect.html}) instead.
12989 @item nntp-via-netcat-switches
12990 @vindex nntp-via-netcat-switches
12991 List of strings to be used as the switches to the
12992 @code{nntp-via-telnet-command} command. The default is @code{nil}.
12994 @item nntp-via-rlogin-command
12995 Command used to log in on the intermediate host. The default is
12996 @samp{rsh}, but @samp{ssh} is a popular alternative.
12998 @item nntp-via-rlogin-command-switches
12999 List of strings to be used as the switches to
13000 @code{nntp-via-rlogin-command}. The default is @code{nil}.
13003 @item nntp-open-via-telnet-and-telnet
13004 @findex nntp-open-via-telnet-and-telnet
13005 Does essentially also the same, but uses @samp{telnet} instead of
13006 @samp{rlogin} to connect to the intermediate host.
13008 @code{nntp-open-via-telnet-and-telnet}-specific variables:
13011 @item nntp-via-telnet-command
13012 @vindex nntp-via-telnet-command
13013 Command used to @code{telnet} the intermediate host. The default is
13016 @item nntp-via-telnet-switches
13017 @vindex nntp-via-telnet-switches
13018 List of strings to be used as the switches to the
13019 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
13021 @item nntp-via-user-password
13022 @vindex nntp-via-user-password
13023 Password to use when logging in on the intermediate host.
13025 @item nntp-via-envuser
13026 @vindex nntp-via-envuser
13027 If non-@code{nil}, the intermediate @code{telnet} session (client and
13028 server both) will support the @code{ENVIRON} option and not prompt for
13029 login name. This works for Solaris @code{telnet}, for instance.
13031 @item nntp-via-shell-prompt
13032 @vindex nntp-via-shell-prompt
13033 Regexp matching the shell prompt on the intermediate host. The default
13034 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
13038 Note that you may want to change the value for @code{nntp-end-of-line}
13039 to @samp{\n} (@pxref{Common Variables}).
13043 Here are some additional variables that are understood by all the above
13048 @item nntp-via-user-name
13049 @vindex nntp-via-user-name
13050 User name to use when connecting to the intermediate host.
13052 @item nntp-via-address
13053 @vindex nntp-via-address
13054 Address of the intermediate host to connect to.
13059 @node Common Variables
13060 @subsubsection Common Variables
13062 The following variables affect the behavior of all, or several of the
13063 pre-made connection functions. When not specified, all functions are
13068 @item nntp-pre-command
13069 @vindex nntp-pre-command
13070 A command wrapper to use when connecting through a non native
13071 connection function (all except @code{nntp-open-network-stream},
13072 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}. This is
13073 where you would put a @samp{SOCKS} wrapper for instance.
13076 @vindex nntp-address
13077 The address of the @acronym{NNTP} server.
13079 @item nntp-port-number
13080 @vindex nntp-port-number
13081 Port number to connect to the @acronym{NNTP} server. The default is
13082 @samp{nntp}. If you use @acronym{NNTP} over
13083 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
13084 than named ports (i.e, use @samp{563} instead of @samp{snews} or
13085 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
13086 not work with named ports.
13088 @item nntp-end-of-line
13089 @vindex nntp-end-of-line
13090 String to use as end-of-line marker when talking to the @acronym{NNTP}
13091 server. This is @samp{\r\n} by default, but should be @samp{\n} when
13092 using a non native telnet connection function.
13094 @item nntp-telnet-command
13095 @vindex nntp-telnet-command
13096 Command to use when connecting to the @acronym{NNTP} server through
13097 @samp{telnet}. This is @emph{not} for an intermediate host. This is
13098 just for the real @acronym{NNTP} server. The default is
13101 @item nntp-telnet-switches
13102 @vindex nntp-telnet-switches
13103 A list of switches to pass to @code{nntp-telnet-command}. The default
13109 @subsubsection NNTP marks
13110 @cindex storing NNTP marks
13112 Gnus stores marks (@pxref{Marking Articles}) for @acronym{NNTP}
13113 servers in marks files. A marks file records what marks you have set
13114 in a group and each file is specific to the corresponding server.
13115 Marks files are stored in @file{~/News/marks}
13116 (@code{nntp-marks-directory}) under a classic hierarchy resembling
13117 that of a news server, for example marks for the group
13118 @samp{gmane.discuss} on the news.gmane.org server will be stored in
13119 the file @file{~/News/marks/news.gmane.org/gmane/discuss/.marks}.
13121 Marks files are useful because you can copy the @file{~/News/marks}
13122 directory (using rsync, scp or whatever) to another Gnus installation,
13123 and it will realize what articles you have read and marked. The data
13124 in @file{~/News/marks} has priority over the same data in
13125 @file{~/.newsrc.eld}.
13127 Note that marks files are very much server-specific: Gnus remembers
13128 the article numbers so if you don't use the same servers on both
13129 installations things are most likely to break (most @acronym{NNTP}
13130 servers do not use the same article numbers as any other server).
13131 However, if you use servers A, B, C on one installation and servers A,
13132 D, E on the other, you can sync the marks files for A and then you'll
13133 get synchronization for that server between the two installations.
13135 Using @acronym{NNTP} marks can possibly incur a performance penalty so
13136 if Gnus feels sluggish, try setting the @code{nntp-marks-is-evil}
13137 variable to @code{t}. Marks will then be stored in @file{~/.newsrc.eld}.
13143 @item nntp-marks-is-evil
13144 @vindex nntp-marks-is-evil
13145 If non-@code{nil}, this back end will ignore any marks files. The
13146 default is @code{nil}.
13148 @item nntp-marks-directory
13149 @vindex nntp-marks-directory
13150 The directory where marks for nntp groups will be stored.
13156 @subsection News Spool
13160 Subscribing to a foreign group from the local spool is extremely easy,
13161 and might be useful, for instance, to speed up reading groups that
13162 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
13165 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
13166 anything else) as the address.
13168 If you have access to a local spool, you should probably use that as the
13169 native select method (@pxref{Finding the News}). It is normally faster
13170 than using an @code{nntp} select method, but might not be. It depends.
13171 You just have to try to find out what's best at your site.
13175 @item nnspool-inews-program
13176 @vindex nnspool-inews-program
13177 Program used to post an article.
13179 @item nnspool-inews-switches
13180 @vindex nnspool-inews-switches
13181 Parameters given to the inews program when posting an article.
13183 @item nnspool-spool-directory
13184 @vindex nnspool-spool-directory
13185 Where @code{nnspool} looks for the articles. This is normally
13186 @file{/usr/spool/news/}.
13188 @item nnspool-nov-directory
13189 @vindex nnspool-nov-directory
13190 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
13191 @file{/usr/spool/news/over.view/}.
13193 @item nnspool-lib-dir
13194 @vindex nnspool-lib-dir
13195 Where the news lib dir is (@file{/usr/lib/news/} by default).
13197 @item nnspool-active-file
13198 @vindex nnspool-active-file
13199 The name of the active file.
13201 @item nnspool-newsgroups-file
13202 @vindex nnspool-newsgroups-file
13203 The name of the group descriptions file.
13205 @item nnspool-history-file
13206 @vindex nnspool-history-file
13207 The name of the news history file.
13209 @item nnspool-active-times-file
13210 @vindex nnspool-active-times-file
13211 The name of the active date file.
13213 @item nnspool-nov-is-evil
13214 @vindex nnspool-nov-is-evil
13215 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13218 @item nnspool-sift-nov-with-sed
13219 @vindex nnspool-sift-nov-with-sed
13221 If non-@code{nil}, which is the default, use @code{sed} to get the
13222 relevant portion from the overview file. If @code{nil},
13223 @code{nnspool} will load the entire file into a buffer and process it
13230 @section Getting Mail
13231 @cindex reading mail
13234 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13238 * Mail in a Newsreader:: Important introductory notes.
13239 * Getting Started Reading Mail:: A simple cookbook example.
13240 * Splitting Mail:: How to create mail groups.
13241 * Mail Sources:: How to tell Gnus where to get mail from.
13242 * Mail Back End Variables:: Variables for customizing mail handling.
13243 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
13244 * Group Mail Splitting:: Use group customize to drive mail splitting.
13245 * Incorporating Old Mail:: What about the old mail you have?
13246 * Expiring Mail:: Getting rid of unwanted mail.
13247 * Washing Mail:: Removing cruft from the mail you get.
13248 * Duplicates:: Dealing with duplicated mail.
13249 * Not Reading Mail:: Using mail back ends for reading other files.
13250 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
13254 @node Mail in a Newsreader
13255 @subsection Mail in a Newsreader
13257 If you are used to traditional mail readers, but have decided to switch
13258 to reading mail with Gnus, you may find yourself experiencing something
13259 of a culture shock.
13261 Gnus does not behave like traditional mail readers. If you want to make
13262 it behave that way, you can, but it's an uphill battle.
13264 Gnus, by default, handles all its groups using the same approach. This
13265 approach is very newsreaderly---you enter a group, see the new/unread
13266 messages, and when you read the messages, they get marked as read, and
13267 you don't see them any more. (Unless you explicitly ask for them.)
13269 In particular, you do not do anything explicitly to delete messages.
13271 Does this mean that all the messages that have been marked as read are
13272 deleted? How awful!
13274 But, no, it means that old messages are @dfn{expired} according to some
13275 scheme or other. For news messages, the expire process is controlled by
13276 the news administrator; for mail, the expire process is controlled by
13277 you. The expire process for mail is covered in depth in @ref{Expiring
13280 What many Gnus users find, after using it a while for both news and
13281 mail, is that the transport mechanism has very little to do with how
13282 they want to treat a message.
13284 Many people subscribe to several mailing lists. These are transported
13285 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13286 answering, or even reading these messages very carefully. We may not
13287 need to save them because if we should need to read one again, they are
13288 archived somewhere else.
13290 Some people have local news groups which have only a handful of readers.
13291 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13292 to read and answer a large fraction of the messages very carefully in
13293 order to do our work. And there may not be an archive, so we may need
13294 to save the interesting messages the same way we would personal mail.
13296 The important distinction turns out to be not the transport mechanism,
13297 but other factors such as how interested we are in the subject matter,
13298 or how easy it is to retrieve the message if we need to read it again.
13300 Gnus provides many options for sorting mail into ``groups'' which behave
13301 like newsgroups, and for treating each group (whether mail or news)
13304 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13305 that Gnus should grow up and be a male, er, mail reader. It is possible
13306 to whip Gnus into a more mailreaderly being, but, as said before, it's
13307 not easy. People who prefer proper mail readers should try @sc{vm}
13308 instead, which is an excellent, and proper, mail reader.
13310 I don't mean to scare anybody off, but I want to make it clear that you
13311 may be required to learn a new way of thinking about messages. After
13312 you've been subjected to The Gnus Way, you will come to love it. I can
13313 guarantee it. (At least the guy who sold me the Emacs Subliminal
13314 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13315 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13319 @node Getting Started Reading Mail
13320 @subsection Getting Started Reading Mail
13322 It's quite easy to use Gnus to read your new mail. You just plonk the
13323 mail back end of your choice into @code{gnus-secondary-select-methods},
13324 and things will happen automatically.
13326 For instance, if you want to use @code{nnml} (which is a ``one file per
13327 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13330 (setq gnus-secondary-select-methods '((nnml "")))
13333 Now, the next time you start Gnus, this back end will be queried for new
13334 articles, and it will move all the messages in your spool file to its
13335 directory, which is @file{~/Mail/} by default. The new group that will
13336 be created (@samp{mail.misc}) will be subscribed, and you can read it
13337 like any other group.
13339 You will probably want to split the mail into several groups, though:
13342 (setq nnmail-split-methods
13343 '(("junk" "^From:.*Lars Ingebrigtsen")
13344 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13348 This will result in three new @code{nnml} mail groups being created:
13349 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
13350 mail that doesn't fit into the first two groups will be placed in the
13353 This should be sufficient for reading mail with Gnus. You might want to
13354 give the other sections in this part of the manual a perusal, though.
13355 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13358 @node Splitting Mail
13359 @subsection Splitting Mail
13360 @cindex splitting mail
13361 @cindex mail splitting
13362 @cindex mail filtering (splitting)
13364 @vindex nnmail-split-methods
13365 The @code{nnmail-split-methods} variable says how the incoming mail is
13366 to be split into groups.
13369 (setq nnmail-split-methods
13370 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
13371 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
13372 ("mail.other" "")))
13375 This variable is a list of lists, where the first element of each of
13376 these lists is the name of the mail group (they do not have to be called
13377 something beginning with @samp{mail}, by the way), and the second
13378 element is a regular expression used on the header of each mail to
13379 determine if it belongs in this mail group. The first string may
13380 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
13381 insert sub-expressions from the matched text. For instance:
13384 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
13388 In that case, @code{nnmail-split-lowercase-expanded} controls whether
13389 the inserted text should be made lowercase. @xref{Fancy Mail Splitting}.
13391 The second element can also be a function. In that case, it will be
13392 called narrowed to the headers with the first element of the rule as the
13393 argument. It should return a non-@code{nil} value if it thinks that the
13394 mail belongs in that group.
13396 @cindex @samp{bogus} group
13397 The last of these groups should always be a general one, and the regular
13398 expression should @emph{always} be @samp{""} so that it matches any mails
13399 that haven't been matched by any of the other regexps. (These rules are
13400 processed from the beginning of the alist toward the end. The first rule
13401 to make a match will ``win'', unless you have crossposting enabled. In
13402 that case, all matching rules will ``win''.) If no rule matched, the mail
13403 will end up in the @samp{bogus} group. When new groups are created by
13404 splitting mail, you may want to run @code{gnus-group-find-new-groups} to
13405 see the new groups. This also applies to the @samp{bogus} group.
13407 If you like to tinker with this yourself, you can set this variable to a
13408 function of your choice. This function will be called without any
13409 arguments in a buffer narrowed to the headers of an incoming mail
13410 message. The function should return a list of group names that it
13411 thinks should carry this mail message.
13413 Note that the mail back ends are free to maul the poor, innocent,
13414 incoming headers all they want to. They all add @code{Lines} headers;
13415 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
13416 @code{From<SPACE>} line to something else.
13418 @vindex nnmail-crosspost
13419 The mail back ends all support cross-posting. If several regexps match,
13420 the mail will be ``cross-posted'' to all those groups.
13421 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
13422 that no articles are crossposted to the general (@samp{""}) group.
13424 @vindex nnmail-crosspost-link-function
13427 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
13428 the crossposted articles. However, not all file systems support hard
13429 links. If that's the case for you, set
13430 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
13431 variable is @code{add-name-to-file} by default.)
13433 @kindex M-x nnmail-split-history
13434 @findex nnmail-split-history
13435 If you wish to see where the previous mail split put the messages, you
13436 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
13437 where re-spooling messages would put the messages, you can use
13438 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
13441 @vindex nnmail-split-header-length-limit
13442 Header lines longer than the value of
13443 @code{nnmail-split-header-length-limit} are excluded from the split
13446 @vindex nnmail-mail-splitting-charset
13447 @vindex nnmail-mail-splitting-decodes
13448 By default the splitting codes @acronym{MIME} decodes headers so you
13449 can match on non-@acronym{ASCII} strings. The
13450 @code{nnmail-mail-splitting-charset} variable specifies the default
13451 charset for decoding. The behavior can be turned off completely by
13452 binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is
13453 useful if you want to match articles based on the raw header data.
13455 @vindex nnmail-resplit-incoming
13456 By default, splitting is performed on all incoming messages. If you
13457 specify a @code{directory} entry for the variable @code{mail-sources}
13458 (@pxref{Mail Source Specifiers}), however, then splitting does
13459 @emph{not} happen by default. You can set the variable
13460 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
13461 splitting happen even in this case. (This variable has no effect on
13462 other kinds of entries.)
13464 Gnus gives you all the opportunity you could possibly want for shooting
13465 yourself in the foot. Let's say you create a group that will contain
13466 all the mail you get from your boss. And then you accidentally
13467 unsubscribe from the group. Gnus will still put all the mail from your
13468 boss in the unsubscribed group, and so, when your boss mails you ``Have
13469 that report ready by Monday or you're fired!'', you'll never see it and,
13470 come Tuesday, you'll still believe that you're gainfully employed while
13471 you really should be out collecting empty bottles to save up for next
13472 month's rent money.
13476 @subsection Mail Sources
13478 Mail can be gotten from many different sources---the mail spool, from
13479 a @acronym{POP} mail server, from a procmail directory, or from a
13480 maildir, for instance.
13483 * Mail Source Specifiers:: How to specify what a mail source is.
13484 * Mail Source Customization:: Some variables that influence things.
13485 * Fetching Mail:: Using the mail source specifiers.
13489 @node Mail Source Specifiers
13490 @subsubsection Mail Source Specifiers
13492 @cindex mail server
13495 @cindex mail source
13497 You tell Gnus how to fetch mail by setting @code{mail-sources}
13498 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
13503 (pop :server "pop3.mailserver.com" :user "myname")
13506 As can be observed, a mail source specifier is a list where the first
13507 element is a @dfn{mail source type}, followed by an arbitrary number of
13508 @dfn{keywords}. Keywords that are not explicitly specified are given
13511 The following mail source types are available:
13515 Get mail from a single file; typically from the mail spool.
13521 The file name. Defaults to the value of the @env{MAIL}
13522 environment variable or the value of @code{rmail-spool-directory}
13523 (usually something like @file{/usr/mail/spool/user-name}).
13527 Script run before/after fetching mail.
13530 An example file mail source:
13533 (file :path "/usr/spool/mail/user-name")
13536 Or using the default file name:
13542 If the mail spool file is not located on the local machine, it's best
13543 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
13544 You can not use ange-ftp file names here---it has no way to lock the
13545 mail spool while moving the mail.
13547 If it's impossible to set up a proper server, you can use ssh instead.
13551 '((file :prescript "ssh host bin/getmail >%t")))
13554 The @samp{getmail} script would look something like the following:
13558 # getmail - move mail from spool to stdout
13561 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
13563 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
13566 Alter this script to fit find the @samp{movemail} you want to use.
13570 @vindex nnmail-scan-directory-mail-source-once
13571 Get mail from several files in a directory. This is typically used
13572 when you have procmail split the incoming mail into several files.
13573 That is, there is a one-to-one correspondence between files in that
13574 directory and groups, so that mail from the file @file{foo.bar.spool}
13575 will be put in the group @code{foo.bar}. (You can change the suffix
13576 to be used instead of @code{.spool}.) Setting
13577 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
13578 Gnus to scan the mail source only once. This is particularly useful
13579 if you want to scan mail groups at a specified level.
13581 @vindex nnmail-resplit-incoming
13582 There is also the variable @code{nnmail-resplit-incoming}, if you set
13583 that to a non-@code{nil} value, then the normal splitting process is
13584 applied to all the files from the directory, @ref{Splitting Mail}.
13590 The name of the directory where the files are. There is no default
13594 Only files ending with this suffix are used. The default is
13598 Only files that have this predicate return non-@code{nil} are returned.
13599 The default is @code{identity}. This is used as an additional
13600 filter---only files that have the right suffix @emph{and} satisfy this
13601 predicate are considered.
13605 Script run before/after fetching mail.
13609 An example directory mail source:
13612 (directory :path "/home/user-name/procmail-dir/"
13617 Get mail from a @acronym{POP} server.
13623 The name of the @acronym{POP} server. The default is taken from the
13624 @env{MAILHOST} environment variable.
13627 The port number of the @acronym{POP} server. This can be a number (eg,
13628 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
13629 string, it should be a service name as listed in @file{/etc/services} on
13630 Unix systems. The default is @samp{"pop3"}. On some systems you might
13631 need to specify it as @samp{"pop-3"} instead.
13634 The user name to give to the @acronym{POP} server. The default is the login
13638 The password to give to the @acronym{POP} server. If not specified,
13639 the user is prompted.
13642 The program to use to fetch mail from the @acronym{POP} server. This
13643 should be a @code{format}-like string. Here's an example:
13646 fetchmail %u@@%s -P %p %t
13649 The valid format specifier characters are:
13653 The name of the file the mail is to be moved to. This must always be
13654 included in this string.
13657 The name of the server.
13660 The port number of the server.
13663 The user name to use.
13666 The password to use.
13669 The values used for these specs are taken from the values you give the
13670 corresponding keywords.
13673 A script to be run before fetching the mail. The syntax is the same as
13674 the @code{:program} keyword. This can also be a function to be run.
13677 A script to be run after fetching the mail. The syntax is the same as
13678 the @code{:program} keyword. This can also be a function to be run.
13681 The function to use to fetch mail from the @acronym{POP} server. The
13682 function is called with one parameter---the name of the file where the
13683 mail should be moved to.
13685 @item :authentication
13686 This can be either the symbol @code{password} or the symbol @code{apop}
13687 and says what authentication scheme to use. The default is
13691 What stream to use for connecting to the server, this can be the symbol
13692 @code{ssl}, the symbol @code{tls} or others. The default is @code{nil}
13693 and use insecure connections. Note that for SSL/TLS, you need external
13694 programs and libraries:
13698 @dfn{ssl:} Connect through SSL@. Requires OpenSSL (the program
13699 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
13700 library @samp{ssl.el}.
13702 @dfn{starttls:} Connect via the STARTTLS extension (similar to SSL)@.
13703 Requires the external library @samp{starttls.el} and program
13708 Non-@code{nil} if mail is to be left on the server and UIDL used for
13709 message retrieval. The default is @code{nil}.
13713 @vindex pop3-movemail
13714 @vindex pop3-leave-mail-on-server
13715 If the @code{:program} and @code{:function} keywords aren't specified,
13716 @code{pop3-movemail} will be used. If the
13717 @code{pop3-leave-mail-on-server} is non-@code{nil} the mail is to be
13718 left on the @acronym{POP} server after fetching when using
13719 @code{pop3-movemail}. Note that POP servers maintain no state
13720 information between sessions, so what the client believes is there and
13721 what is actually there may not match up. If they do not, then the whole
13722 thing can fall apart and leave you with a corrupt mailbox.
13724 Here are some examples. Fetch from the default @acronym{POP} server,
13725 using the default user name, and default fetcher:
13731 Fetch from a named server with a named user and password:
13734 (pop :server "my.pop.server"
13735 :user "user-name" :password "secret")
13738 Use @samp{movemail} to move the mail:
13741 (pop :program "movemail po:%u %t %p")
13745 Get mail from a maildir. This is a type of mailbox that is supported by
13746 at least qmail and postfix, where each file in a special directory
13747 contains exactly one mail.
13753 The name of the directory where the mails are stored. The default is
13754 taken from the @env{MAILDIR} environment variable or
13757 The subdirectories of the Maildir. The default is
13758 @samp{("new" "cur")}.
13760 @c If you sometimes look at your mail through a pop3 daemon before fetching
13761 @c them with Gnus, you may also have to fetch your mails from the
13762 @c @code{cur} directory inside the maildir, like in the first example
13765 You can also get mails from remote hosts (because maildirs don't suffer
13766 from locking problems).
13770 Two example maildir mail sources:
13773 (maildir :path "/home/user-name/Maildir/"
13774 :subdirs ("cur" "new"))
13778 (maildir :path "/user@@remotehost.org:~/Maildir/"
13783 Get mail from a @acronym{IMAP} server. If you don't want to use
13784 @acronym{IMAP} as intended, as a network mail reading protocol (ie
13785 with nnimap), for some reason or other, Gnus let you treat it similar
13786 to a @acronym{POP} server and fetches articles from a given
13787 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
13789 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
13790 may need external programs and libraries, @xref{IMAP}.
13796 The name of the @acronym{IMAP} server. The default is taken from the
13797 @env{MAILHOST} environment variable.
13800 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
13801 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
13804 The user name to give to the @acronym{IMAP} server. The default is the login
13808 The password to give to the @acronym{IMAP} server. If not specified, the user is
13812 What stream to use for connecting to the server, this is one of the
13813 symbols in @code{imap-stream-alist}. Right now, this means
13814 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
13815 @samp{ssl}, @samp{shell} or the default @samp{network}.
13817 @item :authentication
13818 Which authenticator to use for authenticating to the server, this is
13819 one of the symbols in @code{imap-authenticator-alist}. Right now,
13820 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13821 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13824 When using the `shell' :stream, the contents of this variable is
13825 mapped into the @code{imap-shell-program} variable. This should be a
13826 @code{format}-like string (or list of strings). Here's an example:
13832 The valid format specifier characters are:
13836 The name of the server.
13839 User name from @code{imap-default-user}.
13842 The port number of the server.
13845 The values used for these specs are taken from the values you give the
13846 corresponding keywords.
13849 The name of the mailbox to get mail from. The default is @samp{INBOX}
13850 which normally is the mailbox which receive incoming mail.
13853 The predicate used to find articles to fetch. The default, @samp{UNSEEN
13854 UNDELETED}, is probably the best choice for most people, but if you
13855 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
13856 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13857 Then all articles in the mailbox is fetched, no matter what. For a
13858 complete list of predicates, see RFC 2060 section 6.4.4.
13861 How to flag fetched articles on the server, the default @samp{\Deleted}
13862 will mark them as deleted, an alternative would be @samp{\Seen} which
13863 would simply mark them as read. These are the two most likely choices,
13864 but more flags are defined in RFC 2060 section 2.3.2.
13867 If non-@code{nil}, don't remove all articles marked as deleted in the
13868 mailbox after finishing the fetch.
13872 An example @acronym{IMAP} mail source:
13875 (imap :server "mail.mycorp.com"
13877 :fetchflag "\\Seen")
13881 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
13882 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
13883 @uref{http://mail.yahoo.com/}.
13885 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
13886 required for url "4.0pre.46".
13888 WARNING: Mails may be lost. NO WARRANTY.
13894 The type of the webmail server. The default is @code{hotmail}. The
13895 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13898 The user name to give to the webmail server. The default is the login
13902 The password to give to the webmail server. If not specified, the user is
13906 If non-@code{nil}, only fetch unread articles and don't move them to
13907 trash folder after finishing the fetch.
13911 An example webmail source:
13914 (webmail :subtype 'hotmail
13916 :password "secret")
13921 @item Common Keywords
13922 Common keywords can be used in any type of mail source.
13928 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
13929 use directory source to get mail, you can specify it as in this
13934 '((directory :path "/home/pavel/.Spool/"
13939 Gnus will then fetch your mail even when you are unplugged. This is
13940 useful when you use local mail and news.
13945 @subsubsection Function Interface
13947 Some of the above keywords specify a Lisp function to be executed.
13948 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
13949 the value of the keyword while the function is executing. For example,
13950 consider the following mail-source setting:
13953 (setq mail-sources '((pop :user "jrl"
13954 :server "pophost" :function fetchfunc)))
13957 While the function @code{fetchfunc} is executing, the symbol @code{user}
13958 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
13959 @code{"pophost"}. The symbols @code{port}, @code{password},
13960 @code{program}, @code{prescript}, @code{postscript}, @code{function},
13961 and @code{authentication} are also bound (to their default values).
13963 See above for a list of keywords for each type of mail source.
13966 @node Mail Source Customization
13967 @subsubsection Mail Source Customization
13969 The following is a list of variables that influence how the mail is
13970 fetched. You would normally not need to set or change any of these
13974 @item mail-source-crash-box
13975 @vindex mail-source-crash-box
13976 File where mail will be stored while processing it. The default is@*
13977 @file{~/.emacs-mail-crash-box}.
13979 @item mail-source-delete-incoming
13980 @vindex mail-source-delete-incoming
13981 If non-@code{nil}, delete incoming files after handling them. If
13982 @code{t}, delete the files immediately, if @code{nil}, never delete any
13983 files. If a positive number, delete files older than number of days
13984 (This will only happen, when receiving new mail). You may also set
13985 @code{mail-source-delete-incoming} to @code{nil} and call
13986 @code{mail-source-delete-old-incoming} from a hook or interactively.
13988 @item mail-source-delete-old-incoming-confirm
13989 @vindex mail-source-delete-old-incoming-confirm
13990 If non-@code{nil}, ask for for confirmation before deleting old incoming
13991 files. This variable only applies when
13992 @code{mail-source-delete-incoming} is a positive number.
13994 @item mail-source-ignore-errors
13995 @vindex mail-source-ignore-errors
13996 If non-@code{nil}, ignore errors when reading mail from a mail source.
13998 @item mail-source-directory
13999 @vindex mail-source-directory
14000 Directory where incoming mail source files (if any) will be stored. The
14001 default is @file{~/Mail/}. At present, the only thing this is used for
14002 is to say where the incoming files will be stored if the variable
14003 @code{mail-source-delete-incoming} is @code{nil} or a number.
14005 @item mail-source-incoming-file-prefix
14006 @vindex mail-source-incoming-file-prefix
14007 Prefix for file name for storing incoming mail. The default is
14008 @file{Incoming}, in which case files will end up with names like
14009 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
14010 relevant if @code{mail-source-delete-incoming} is @code{nil}.
14012 @item mail-source-default-file-modes
14013 @vindex mail-source-default-file-modes
14014 All new mail files will get this file mode. The default is 384.
14016 @item mail-source-movemail-program
14017 @vindex mail-source-movemail-program
14018 If non-@code{nil}, name of program for fetching new mail. If
14019 @code{nil}, @code{movemail} in @var{exec-directory}.
14024 @node Fetching Mail
14025 @subsubsection Fetching Mail
14027 @vindex mail-sources
14028 @vindex nnmail-spool-file
14029 The way to actually tell Gnus where to get new mail from is to set
14030 @code{mail-sources} to a list of mail source specifiers
14031 (@pxref{Mail Source Specifiers}).
14033 If this variable (and the obsolescent @code{nnmail-spool-file}) is
14034 @code{nil}, the mail back ends will never attempt to fetch mail by
14037 If you want to fetch mail both from your local spool as well as a
14038 @acronym{POP} mail server, you'd say something like:
14043 (pop :server "pop3.mail.server"
14044 :password "secret")))
14047 Or, if you don't want to use any of the keyword defaults:
14051 '((file :path "/var/spool/mail/user-name")
14052 (pop :server "pop3.mail.server"
14055 :password "secret")))
14059 When you use a mail back end, Gnus will slurp all your mail from your
14060 inbox and plonk it down in your home directory. Gnus doesn't move any
14061 mail if you're not using a mail back end---you have to do a lot of magic
14062 invocations first. At the time when you have finished drawing the
14063 pentagram, lightened the candles, and sacrificed the goat, you really
14064 shouldn't be too surprised when Gnus moves your mail.
14068 @node Mail Back End Variables
14069 @subsection Mail Back End Variables
14071 These variables are (for the most part) pertinent to all the various
14075 @vindex nnmail-read-incoming-hook
14076 @item nnmail-read-incoming-hook
14077 The mail back ends all call this hook after reading new mail. You can
14078 use this hook to notify any mail watch programs, if you want to.
14080 @vindex nnmail-split-hook
14081 @item nnmail-split-hook
14082 @findex gnus-article-decode-encoded-words
14083 @cindex RFC 1522 decoding
14084 @cindex RFC 2047 decoding
14085 Hook run in the buffer where the mail headers of each message is kept
14086 just before the splitting based on these headers is done. The hook is
14087 free to modify the buffer contents in any way it sees fit---the buffer
14088 is discarded after the splitting has been done, and no changes performed
14089 in the buffer will show up in any files.
14090 @code{gnus-article-decode-encoded-words} is one likely function to add
14093 @vindex nnmail-pre-get-new-mail-hook
14094 @vindex nnmail-post-get-new-mail-hook
14095 @item nnmail-pre-get-new-mail-hook
14096 @itemx nnmail-post-get-new-mail-hook
14097 These are two useful hooks executed when treating new incoming
14098 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
14099 starting to handle the new mail) and
14100 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
14101 is done). Here's and example of using these two hooks to change the
14102 default file modes the new mail files get:
14105 (add-hook 'nnmail-pre-get-new-mail-hook
14106 (lambda () (set-default-file-modes 511)))
14108 (add-hook 'nnmail-post-get-new-mail-hook
14109 (lambda () (set-default-file-modes 551)))
14112 @item nnmail-use-long-file-names
14113 @vindex nnmail-use-long-file-names
14114 If non-@code{nil}, the mail back ends will use long file and directory
14115 names. Groups like @samp{mail.misc} will end up in directories
14116 (assuming use of @code{nnml} back end) or files (assuming use of
14117 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
14118 the same group will end up in @file{mail/misc}.
14120 @item nnmail-delete-file-function
14121 @vindex nnmail-delete-file-function
14122 @findex delete-file
14123 Function called to delete files. It is @code{delete-file} by default.
14125 @item nnmail-cache-accepted-message-ids
14126 @vindex nnmail-cache-accepted-message-ids
14127 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
14128 the back end (via @code{Gcc}, for instance) into the mail duplication
14129 discovery cache. The default is @code{nil}.
14131 @item nnmail-cache-ignore-groups
14132 @vindex nnmail-cache-ignore-groups
14133 This can be a regular expression or a list of regular expressions.
14134 Group names that match any of the regular expressions will never be
14135 recorded in the @code{Message-ID} cache.
14137 This can be useful, for example, when using Fancy Splitting
14138 (@pxref{Fancy Mail Splitting}) together with the function
14139 @code{nnmail-split-fancy-with-parent}.
14144 @node Fancy Mail Splitting
14145 @subsection Fancy Mail Splitting
14146 @cindex mail splitting
14147 @cindex fancy mail splitting
14149 @vindex nnmail-split-fancy
14150 @findex nnmail-split-fancy
14151 If the rather simple, standard method for specifying how to split mail
14152 doesn't allow you to do what you want, you can set
14153 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
14154 play with the @code{nnmail-split-fancy} variable.
14156 Let's look at an example value of this variable first:
14159 ;; @r{Messages from the mailer daemon are not crossposted to any of}
14160 ;; @r{the ordinary groups. Warnings are put in a separate group}
14161 ;; @r{from real errors.}
14162 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
14164 ;; @r{Non-error messages are crossposted to all relevant}
14165 ;; @r{groups, but we don't crosspost between the group for the}
14166 ;; @r{(ding) list and the group for other (ding) related mail.}
14167 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
14168 ("subject" "ding" "ding.misc"))
14169 ;; @r{Other mailing lists@dots{}}
14170 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
14171 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
14172 ;; @r{Both lists below have the same suffix, so prevent}
14173 ;; @r{cross-posting to mkpkg.list of messages posted only to}
14174 ;; @r{the bugs- list, but allow cross-posting when the}
14175 ;; @r{message was really cross-posted.}
14176 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
14177 (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list")
14178 ;; @r{People@dots{}}
14179 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
14180 ;; @r{Unmatched mail goes to the catch all group.}
14184 This variable has the format of a @dfn{split}. A split is a
14185 (possibly) recursive structure where each split may contain other
14186 splits. Here are the possible split syntaxes:
14191 If the split is a string, that will be taken as a group name. Normal
14192 regexp match expansion will be done. See below for examples.
14194 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split})
14195 If the split is a list, the first element of which is a string, then
14196 store the message as specified by @var{split}, if header @var{field}
14197 (a regexp) contains @var{value} (also a regexp). If @var{restrict}
14198 (yet another regexp) matches some string after @var{field} and before
14199 the end of the matched @var{value}, the @var{split} is ignored. If
14200 none of the @var{restrict} clauses match, @var{split} is processed.
14202 @item (| @var{split} @dots{})
14203 If the split is a list, and the first element is @code{|} (vertical
14204 bar), then process each @var{split} until one of them matches. A
14205 @var{split} is said to match if it will cause the mail message to be
14206 stored in one or more groups.
14208 @item (& @var{split} @dots{})
14209 If the split is a list, and the first element is @code{&}, then
14210 process all @var{split}s in the list.
14213 If the split is the symbol @code{junk}, then don't save (i.e., delete)
14214 this message. Use with extreme caution.
14216 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
14217 If the split is a list, and the first element is @samp{:}, then the
14218 second element will be called as a function with @var{args} given as
14219 arguments. The function should return a @var{split}.
14222 For instance, the following function could be used to split based on the
14223 body of the messages:
14226 (defun split-on-body ()
14230 (goto-char (point-min))
14231 (when (re-search-forward "Some.*string" nil t)
14235 The buffer is narrowed to the message in question when @var{function}
14236 is run. That's why @code{(widen)} needs to be called after
14237 @code{save-excursion} and @code{save-restriction} in the example
14238 above. Also note that with the nnimap back end, message bodies will
14239 not be downloaded by default. You need to set
14240 @code{nnimap-split-download-body} to @code{t} to do that
14241 (@pxref{Splitting in IMAP}).
14243 @item (! @var{func} @var{split})
14244 If the split is a list, and the first element is @code{!}, then
14245 @var{split} will be processed, and @var{func} will be called as a
14246 function with the result of @var{split} as argument. @var{func}
14247 should return a split.
14250 If the split is @code{nil}, it is ignored.
14254 In these splits, @var{field} must match a complete field name.
14255 @var{value} must match a complete word according to the fundamental mode
14256 syntax table. You can use @code{.*} in the regexps to match partial
14257 field names or words. In other words, all @var{value}'s are wrapped in
14258 @samp{\<} and @samp{\>} pairs.
14260 @vindex nnmail-split-abbrev-alist
14261 @var{field} and @var{value} can also be Lisp symbols, in that case
14262 they are expanded as specified by the variable
14263 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
14264 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14265 contains the associated value. Predefined entries in
14266 @code{nnmail-split-abbrev-alist} include:
14270 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14272 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14273 @samp{Resent-To} and @samp{Resent-Cc} fields.
14275 Is the union of the @code{from} and @code{to} entries.
14278 @vindex nnmail-split-fancy-syntax-table
14279 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14280 when all this splitting is performed.
14282 If you want to have Gnus create groups dynamically based on some
14283 information in the headers (i.e., do @code{replace-match}-like
14284 substitutions in the group names), you can say things like:
14287 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14290 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14291 will be filed in @samp{mail.debian.foo}.
14293 If the string contains the element @samp{\&}, then the previously
14294 matched string will be substituted. Similarly, the elements @samp{\\1}
14295 up to @samp{\\9} will be substituted with the text matched by the
14296 groupings 1 through 9.
14298 @vindex nnmail-split-lowercase-expanded
14299 Where @code{nnmail-split-lowercase-expanded} controls whether the
14300 lowercase of the matched string should be used for the substitution.
14301 Setting it as non-@code{nil} is useful to avoid the creation of multiple
14302 groups when users send to an address using different case
14303 (i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value
14306 @vindex nnmail-split-fancy-match-partial-words
14307 @code{nnmail-split-fancy-match-partial-words} controls whether partial
14308 words are matched during fancy splitting.
14310 Normally, regular expressions given in @code{nnmail-split-fancy} are
14311 implicitly surrounded by @code{\<...\>} markers, which are word
14312 delimiters. If this variable is true, they are not implicitly
14313 surrounded by anything.
14316 (any "joe" "joemail")
14319 In this example, messages sent from @samp{joedavis@@foo.org} will
14320 normally not be filed in @samp{joemail}. With
14321 @code{nnmail-split-fancy-match-partial-words} set to @code{t},
14322 however, the match will happen. In effect, the requirement of a word
14323 boundary is removed and instead the match becomes more like a grep.
14325 @findex nnmail-split-fancy-with-parent
14326 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14327 split followups into the same groups their parents are in. Sometimes
14328 you can't make splitting rules for all your mail. For example, your
14329 boss might send you personal mail regarding different projects you are
14330 working on, and as you can't tell your boss to put a distinguishing
14331 string into the subject line, you have to resort to manually moving the
14332 messages into the right group. With this function, you only have to do
14333 it once per thread.
14335 To use this feature, you have to set @code{nnmail-treat-duplicates}
14336 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14337 value. And then you can include @code{nnmail-split-fancy-with-parent}
14338 using the colon feature, like so:
14340 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
14341 nnmail-cache-accepted-message-ids t
14343 '(| (: nnmail-split-fancy-with-parent)
14344 ;; @r{other splits go here}
14348 This feature works as follows: when @code{nnmail-treat-duplicates} is
14349 non-@code{nil}, Gnus records the message id of every message it sees
14350 in the file specified by the variable
14351 @code{nnmail-message-id-cache-file}, together with the group it is in
14352 (the group is omitted for non-mail messages). When mail splitting is
14353 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
14354 at the References (and In-Reply-To) header of each message to split
14355 and searches the file specified by @code{nnmail-message-id-cache-file}
14356 for the message ids. When it has found a parent, it returns the
14357 corresponding group name unless the group name matches the regexp
14358 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
14359 recommended that you set @code{nnmail-message-id-cache-length} to a
14360 somewhat higher number than the default so that the message ids are
14361 still in the cache. (A value of 5000 appears to create a file some
14362 300 kBytes in size.)
14363 @vindex nnmail-cache-accepted-message-ids
14364 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
14365 also records the message ids of moved articles, so that the followup
14366 messages goes into the new group.
14368 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
14369 want certain groups to be recorded in the cache. For example, if all
14370 outgoing messages are written to an ``outgoing'' group, you could set
14371 @code{nnmail-cache-ignore-groups} to match that group name.
14372 Otherwise, answers to all your messages would end up in the
14373 ``outgoing'' group.
14376 @node Group Mail Splitting
14377 @subsection Group Mail Splitting
14378 @cindex mail splitting
14379 @cindex group mail splitting
14381 @findex gnus-group-split
14382 If you subscribe to dozens of mailing lists but you don't want to
14383 maintain mail splitting rules manually, group mail splitting is for you.
14384 You just have to set @code{to-list} and/or @code{to-address} in group
14385 parameters or group customization and set @code{nnmail-split-methods} to
14386 @code{gnus-group-split}. This splitting function will scan all groups
14387 for those parameters and split mail accordingly, i.e., messages posted
14388 from or to the addresses specified in the parameters @code{to-list} or
14389 @code{to-address} of a mail group will be stored in that group.
14391 Sometimes, mailing lists have multiple addresses, and you may want mail
14392 splitting to recognize them all: just set the @code{extra-aliases} group
14393 parameter to the list of additional addresses and it's done. If you'd
14394 rather use a regular expression, set @code{split-regexp}.
14396 All these parameters in a group will be used to create an
14397 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
14398 the @var{value} is a single regular expression that matches
14399 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
14400 matches of @code{split-regexp}, and the @var{split} is the name of the
14401 group. @var{restrict}s are also supported: just set the
14402 @code{split-exclude} parameter to a list of regular expressions.
14404 If you can't get the right split to be generated using all these
14405 parameters, or you just need something fancier, you can set the
14406 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
14407 this case, all other aforementioned parameters will be ignored by
14408 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
14409 @code{nil}, in which case the group will be ignored by
14410 @code{gnus-group-split}.
14412 @vindex gnus-group-split-default-catch-all-group
14413 @code{gnus-group-split} will do cross-posting on all groups that match,
14414 by defining a single @code{&} fancy split containing one split for each
14415 group. If a message doesn't match any split, it will be stored in the
14416 group named in @code{gnus-group-split-default-catch-all-group}, unless
14417 some group has @code{split-spec} set to @code{catch-all}, in which case
14418 that group is used as the catch-all group. Even though this variable is
14419 often used just to name a group, it may also be set to an arbitrarily
14420 complex fancy split (after all, a group name is a fancy split), and this
14421 may be useful to split mail that doesn't go to any mailing list to
14422 personal mail folders. Note that this fancy split is added as the last
14423 element of a @code{|} split list that also contains a @code{&} split
14424 with the rules extracted from group parameters.
14426 It's time for an example. Assume the following group parameters have
14431 ((to-address . "bar@@femail.com")
14432 (split-regexp . ".*@@femail\\.com"))
14434 ((to-list . "foo@@nowhere.gov")
14435 (extra-aliases "foo@@localhost" "foo-redist@@home")
14436 (split-exclude "bugs-foo" "rambling-foo")
14437 (admin-address . "foo-request@@nowhere.gov"))
14439 ((split-spec . catch-all))
14442 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
14443 behave as if @code{nnmail-split-fancy} had been selected and variable
14444 @code{nnmail-split-fancy} had been set as follows:
14447 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
14448 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
14449 - "bugs-foo" - "rambling-foo" "mail.foo"))
14453 @findex gnus-group-split-fancy
14454 If you'd rather not use group splitting for all your mail groups, you
14455 may use it for only some of them, by using @code{nnmail-split-fancy}
14459 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
14462 @var{groups} may be a regular expression or a list of group names whose
14463 parameters will be scanned to generate the output split.
14464 @var{no-crosspost} can be used to disable cross-posting; in this case, a
14465 single @code{|} split will be output. @var{catch-all} is the fall back
14466 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
14467 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
14468 empty string in any selected group, no catch-all split will be issued.
14469 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
14470 this group will override the value of the @var{catch-all} argument.
14472 @findex gnus-group-split-setup
14473 Unfortunately, scanning all groups and their parameters can be quite
14474 slow, especially considering that it has to be done for every message.
14475 But don't despair! The function @code{gnus-group-split-setup} can be
14476 used to enable @code{gnus-group-split} in a much more efficient way. It
14477 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
14478 @code{nnmail-split-fancy} to the split produced by
14479 @code{gnus-group-split-fancy}. Thus, the group parameters are only
14480 scanned once, no matter how many messages are split.
14482 @findex gnus-group-split-update
14483 However, if you change group parameters, you'd have to update
14484 @code{nnmail-split-fancy} manually. You can do it by running
14485 @code{gnus-group-split-update}. If you'd rather have it updated
14486 automatically, just tell @code{gnus-group-split-setup} to do it for
14487 you. For example, add to your @file{~/.gnus.el}:
14490 (gnus-group-split-setup @var{auto-update} @var{catch-all})
14493 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
14494 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
14495 have to worry about updating @code{nnmail-split-fancy} again. If you
14496 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
14497 @code{gnus-group-split-default-catch-all-group} will be set to its
14500 @vindex gnus-group-split-updated-hook
14501 Because you may want to change @code{nnmail-split-fancy} after it is set
14502 by @code{gnus-group-split-update}, this function will run
14503 @code{gnus-group-split-updated-hook} just before finishing.
14505 @node Incorporating Old Mail
14506 @subsection Incorporating Old Mail
14507 @cindex incorporating old mail
14508 @cindex import old mail
14510 Most people have lots of old mail stored in various file formats. If
14511 you have set up Gnus to read mail using one of the spiffy Gnus mail
14512 back ends, you'll probably wish to have that old mail incorporated into
14515 Doing so can be quite easy.
14517 To take an example: You're reading mail using @code{nnml}
14518 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
14519 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
14520 file filled with important, but old, mail. You want to move it into
14521 your @code{nnml} groups.
14527 Go to the group buffer.
14530 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
14531 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
14534 Type @kbd{SPACE} to enter the newly created group.
14537 Type @kbd{M P b} to process-mark all articles in this group's buffer
14538 (@pxref{Setting Process Marks}).
14541 Type @kbd{B r} to respool all the process-marked articles, and answer
14542 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
14545 All the mail messages in the mbox file will now also be spread out over
14546 all your @code{nnml} groups. Try entering them and check whether things
14547 have gone without a glitch. If things look ok, you may consider
14548 deleting the mbox file, but I wouldn't do that unless I was absolutely
14549 sure that all the mail has ended up where it should be.
14551 Respooling is also a handy thing to do if you're switching from one mail
14552 back end to another. Just respool all the mail in the old mail groups
14553 using the new mail back end.
14556 @node Expiring Mail
14557 @subsection Expiring Mail
14558 @cindex article expiry
14560 Traditional mail readers have a tendency to remove mail articles when
14561 you mark them as read, in some way. Gnus takes a fundamentally
14562 different approach to mail reading.
14564 Gnus basically considers mail just to be news that has been received in
14565 a rather peculiar manner. It does not think that it has the power to
14566 actually change the mail, or delete any mail messages. If you enter a
14567 mail group, and mark articles as ``read'', or kill them in some other
14568 fashion, the mail articles will still exist on the system. I repeat:
14569 Gnus will not delete your old, read mail. Unless you ask it to, of
14572 To make Gnus get rid of your unwanted mail, you have to mark the
14573 articles as @dfn{expirable}. (With the default key bindings, this means
14574 that you have to type @kbd{E}.) This does not mean that the articles
14575 will disappear right away, however. In general, a mail article will be
14576 deleted from your system if, 1) it is marked as expirable, AND 2) it is
14577 more than one week old. If you do not mark an article as expirable, it
14578 will remain on your system until hell freezes over. This bears
14579 repeating one more time, with some spurious capitalizations: IF you do
14580 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
14582 You do not have to mark articles as expirable by hand. Gnus provides
14583 two features, called ``auto-expire'' and ``total-expire'', that can help you
14584 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
14585 for you when you select an article. And ``total-expire'' means that Gnus
14586 considers all articles as expirable that are read. So, in addition to
14587 the articles marked @samp{E}, also the articles marked @samp{r},
14588 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
14591 When should either auto-expire or total-expire be used? Most people
14592 who are subscribed to mailing lists split each list into its own group
14593 and then turn on auto-expire or total-expire for those groups.
14594 (@xref{Splitting Mail}, for more information on splitting each list
14595 into its own group.)
14597 Which one is better, auto-expire or total-expire? It's not easy to
14598 answer. Generally speaking, auto-expire is probably faster. Another
14599 advantage of auto-expire is that you get more marks to work with: for
14600 the articles that are supposed to stick around, you can still choose
14601 between tick and dormant and read marks. But with total-expire, you
14602 only have dormant and ticked to choose from. The advantage of
14603 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
14604 Scoring}). Auto-expire works with normal scoring but not with adaptive
14607 @vindex gnus-auto-expirable-newsgroups
14608 Groups that match the regular expression
14609 @code{gnus-auto-expirable-newsgroups} will have all articles that you
14610 read marked as expirable automatically. All articles marked as
14611 expirable have an @samp{E} in the first column in the summary buffer.
14613 By default, if you have auto expiry switched on, Gnus will mark all the
14614 articles you read as expirable, no matter if they were read or unread
14615 before. To avoid having articles marked as read marked as expirable
14616 automatically, you can put something like the following in your
14617 @file{~/.gnus.el} file:
14619 @vindex gnus-mark-article-hook
14621 (remove-hook 'gnus-mark-article-hook
14622 'gnus-summary-mark-read-and-unread-as-read)
14623 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
14626 Note that making a group auto-expirable doesn't mean that all read
14627 articles are expired---only the articles marked as expirable
14628 will be expired. Also note that using the @kbd{d} command won't make
14629 articles expirable---only semi-automatic marking of articles as read will
14630 mark the articles as expirable in auto-expirable groups.
14632 Let's say you subscribe to a couple of mailing lists, and you want the
14633 articles you have read to disappear after a while:
14636 (setq gnus-auto-expirable-newsgroups
14637 "mail.nonsense-list\\|mail.nice-list")
14640 Another way to have auto-expiry happen is to have the element
14641 @code{auto-expire} in the group parameters of the group.
14643 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
14644 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
14645 don't really mix very well.
14647 @vindex nnmail-expiry-wait
14648 The @code{nnmail-expiry-wait} variable supplies the default time an
14649 expirable article has to live. Gnus starts counting days from when the
14650 message @emph{arrived}, not from when it was sent. The default is seven
14653 Gnus also supplies a function that lets you fine-tune how long articles
14654 are to live, based on what group they are in. Let's say you want to
14655 have one month expiry period in the @samp{mail.private} group, a one day
14656 expiry period in the @samp{mail.junk} group, and a six day expiry period
14659 @vindex nnmail-expiry-wait-function
14661 (setq nnmail-expiry-wait-function
14663 (cond ((string= group "mail.private")
14665 ((string= group "mail.junk")
14667 ((string= group "important")
14673 The group names this function is fed are ``unadorned'' group
14674 names---no @samp{nnml:} prefixes and the like.
14676 The @code{nnmail-expiry-wait} variable and
14677 @code{nnmail-expiry-wait-function} function can either be a number (not
14678 necessarily an integer) or one of the symbols @code{immediate} or
14681 You can also use the @code{expiry-wait} group parameter to selectively
14682 change the expiry period (@pxref{Group Parameters}).
14684 @vindex nnmail-expiry-target
14685 The normal action taken when expiring articles is to delete them.
14686 However, in some circumstances it might make more sense to move them
14687 to other groups instead of deleting them. The variable
14688 @code{nnmail-expiry-target} (and the @code{expiry-target} group
14689 parameter) controls this. The variable supplies a default value for
14690 all groups, which can be overridden for specific groups by the group
14691 parameter. default value is @code{delete}, but this can also be a
14692 string (which should be the name of the group the message should be
14693 moved to), or a function (which will be called in a buffer narrowed to
14694 the message in question, and with the name of the group being moved
14695 from as its parameter) which should return a target---either a group
14696 name or @code{delete}.
14698 Here's an example for specifying a group name:
14700 (setq nnmail-expiry-target "nnml:expired")
14703 @findex nnmail-fancy-expiry-target
14704 @vindex nnmail-fancy-expiry-targets
14705 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
14706 expire mail to groups according to the variable
14707 @code{nnmail-fancy-expiry-targets}. Here's an example:
14710 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
14711 nnmail-fancy-expiry-targets
14712 '((to-from "boss" "nnfolder:Work")
14713 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
14714 ("from" ".*" "nnfolder:Archive-%Y")))
14717 With this setup, any mail that has @code{IMPORTANT} in its Subject
14718 header and was sent in the year @code{YYYY} and month @code{MMM}, will
14719 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
14720 From or To header contains the string @code{boss}, it will get expired
14721 to @code{nnfolder:Work}. All other mail will get expired to
14722 @code{nnfolder:Archive-YYYY}.
14724 @vindex nnmail-keep-last-article
14725 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
14726 expire the final article in a mail newsgroup. This is to make life
14727 easier for procmail users.
14729 @vindex gnus-total-expirable-newsgroups
14730 By the way: That line up there, about Gnus never expiring non-expirable
14731 articles, is a lie. If you put @code{total-expire} in the group
14732 parameters, articles will not be marked as expirable, but all read
14733 articles will be put through the expiry process. Use with extreme
14734 caution. Even more dangerous is the
14735 @code{gnus-total-expirable-newsgroups} variable. All groups that match
14736 this regexp will have all read articles put through the expiry process,
14737 which means that @emph{all} old mail articles in the groups in question
14738 will be deleted after a while. Use with extreme caution, and don't come
14739 crying to me when you discover that the regexp you used matched the
14740 wrong group and all your important mail has disappeared. Be a
14741 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
14744 Most people make most of their mail groups total-expirable, though.
14746 @vindex gnus-inhibit-user-auto-expire
14747 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
14748 commands will not mark an article as expirable, even if the group has
14749 auto-expire turned on.
14753 @subsection Washing Mail
14754 @cindex mail washing
14755 @cindex list server brain damage
14756 @cindex incoming mail treatment
14758 Mailers and list servers are notorious for doing all sorts of really,
14759 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
14760 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
14761 end of all lines passing through our server, so let's do that!!!!1!''
14762 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
14763 considered to be self-evident were not discussed. So. Here we are.
14765 Case in point: The German version of Microsoft Exchange adds @samp{AW:
14766 } to the subjects of replies instead of @samp{Re: }. I could pretend to
14767 be shocked and dismayed by this, but I haven't got the energy. It is to
14770 Gnus provides a plethora of functions for washing articles while
14771 displaying them, but it might be nicer to do the filtering before
14772 storing the mail to disk. For that purpose, we have three hooks and
14773 various functions that can be put in these hooks.
14776 @item nnmail-prepare-incoming-hook
14777 @vindex nnmail-prepare-incoming-hook
14778 This hook is called before doing anything with the mail and is meant for
14779 grand, sweeping gestures. It is called in a buffer that contains all
14780 the new, incoming mail. Functions to be used include:
14783 @item nnheader-ms-strip-cr
14784 @findex nnheader-ms-strip-cr
14785 Remove trailing carriage returns from each line. This is default on
14786 Emacs running on MS machines.
14790 @item nnmail-prepare-incoming-header-hook
14791 @vindex nnmail-prepare-incoming-header-hook
14792 This hook is called narrowed to each header. It can be used when
14793 cleaning up the headers. Functions that can be used include:
14796 @item nnmail-remove-leading-whitespace
14797 @findex nnmail-remove-leading-whitespace
14798 Clear leading white space that ``helpful'' listservs have added to the
14799 headers to make them look nice. Aaah.
14801 (Note that this function works on both the header on the body of all
14802 messages, so it is a potentially dangerous function to use (if a body
14803 of a message contains something that looks like a header line). So
14804 rather than fix the bug, it is of course the right solution to make it
14805 into a feature by documenting it.)
14807 @item nnmail-remove-list-identifiers
14808 @findex nnmail-remove-list-identifiers
14809 Some list servers add an identifier---for example, @samp{(idm)}---to the
14810 beginning of all @code{Subject} headers. I'm sure that's nice for
14811 people who use stone age mail readers. This function will remove
14812 strings that match the @code{nnmail-list-identifiers} regexp, which can
14813 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
14816 For instance, if you want to remove the @samp{(idm)} and the
14817 @samp{nagnagnag} identifiers:
14820 (setq nnmail-list-identifiers
14821 '("(idm)" "nagnagnag"))
14824 This can also be done non-destructively with
14825 @code{gnus-list-identifiers}, @xref{Article Hiding}.
14827 @item nnmail-remove-tabs
14828 @findex nnmail-remove-tabs
14829 Translate all @samp{TAB} characters into @samp{SPACE} characters.
14831 @item nnmail-fix-eudora-headers
14832 @findex nnmail-fix-eudora-headers
14834 Eudora produces broken @code{References} headers, but OK
14835 @code{In-Reply-To} headers. This function will get rid of the
14836 @code{References} headers.
14840 @item nnmail-prepare-incoming-message-hook
14841 @vindex nnmail-prepare-incoming-message-hook
14842 This hook is called narrowed to each message. Functions to be used
14846 @item article-de-quoted-unreadable
14847 @findex article-de-quoted-unreadable
14848 Decode Quoted Readable encoding.
14855 @subsection Duplicates
14857 @vindex nnmail-treat-duplicates
14858 @vindex nnmail-message-id-cache-length
14859 @vindex nnmail-message-id-cache-file
14860 @cindex duplicate mails
14861 If you are a member of a couple of mailing lists, you will sometimes
14862 receive two copies of the same mail. This can be quite annoying, so
14863 @code{nnmail} checks for and treats any duplicates it might find. To do
14864 this, it keeps a cache of old @code{Message-ID}s---
14865 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
14866 default. The approximate maximum number of @code{Message-ID}s stored
14867 there is controlled by the @code{nnmail-message-id-cache-length}
14868 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
14869 stored.) If all this sounds scary to you, you can set
14870 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
14871 default), and @code{nnmail} won't delete duplicate mails. Instead it
14872 will insert a warning into the head of the mail saying that it thinks
14873 that this is a duplicate of a different message.
14875 This variable can also be a function. If that's the case, the function
14876 will be called from a buffer narrowed to the message in question with
14877 the @code{Message-ID} as a parameter. The function must return either
14878 @code{nil}, @code{warn}, or @code{delete}.
14880 You can turn this feature off completely by setting the variable to
14883 If you want all the duplicate mails to be put into a special
14884 @dfn{duplicates} group, you could do that using the normal mail split
14888 (setq nnmail-split-fancy
14889 '(| ;; @r{Messages duplicates go to a separate group.}
14890 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14891 ;; @r{Message from daemons, postmaster, and the like to another.}
14892 (any mail "mail.misc")
14893 ;; @r{Other rules.}
14899 (setq nnmail-split-methods
14900 '(("duplicates" "^Gnus-Warning:.*duplicate")
14901 ;; @r{Other rules.}
14905 Here's a neat feature: If you know that the recipient reads her mail
14906 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14907 @code{delete}, you can send her as many insults as you like, just by
14908 using a @code{Message-ID} of a mail that you know that she's already
14909 received. Think of all the fun! She'll never see any of it! Whee!
14912 @node Not Reading Mail
14913 @subsection Not Reading Mail
14915 If you start using any of the mail back ends, they have the annoying
14916 habit of assuming that you want to read mail with them. This might not
14917 be unreasonable, but it might not be what you want.
14919 If you set @code{mail-sources} and @code{nnmail-spool-file} to
14920 @code{nil}, none of the back ends will ever attempt to read incoming
14921 mail, which should help.
14923 @vindex nnbabyl-get-new-mail
14924 @vindex nnmbox-get-new-mail
14925 @vindex nnml-get-new-mail
14926 @vindex nnmh-get-new-mail
14927 @vindex nnfolder-get-new-mail
14928 This might be too much, if, for instance, you are reading mail quite
14929 happily with @code{nnml} and just want to peek at some old Rmail
14930 file you have stashed away with @code{nnbabyl}. All back ends have
14931 variables called back-end-@code{get-new-mail}. If you want to disable
14932 the @code{nnbabyl} mail reading, you edit the virtual server for the
14933 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
14935 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
14936 narrowed to the article to be saved before saving it when reading
14940 @node Choosing a Mail Back End
14941 @subsection Choosing a Mail Back End
14943 Gnus will read the mail spool when you activate a mail group. The mail
14944 file is first copied to your home directory. What happens after that
14945 depends on what format you want to store your mail in.
14947 There are six different mail back ends in the standard Gnus, and more
14948 back ends are available separately. The mail back end most people use
14949 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
14953 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
14954 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
14955 * Mail Spool:: Store your mail in a private spool?
14956 * MH Spool:: An mhspool-like back end.
14957 * Maildir:: Another one-file-per-message format.
14958 * Mail Folders:: Having one file for each group.
14959 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
14963 @node Unix Mail Box
14964 @subsubsection Unix Mail Box
14966 @cindex unix mail box
14968 @vindex nnmbox-active-file
14969 @vindex nnmbox-mbox-file
14970 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
14971 mail. @code{nnmbox} will add extra headers to each mail article to say
14972 which group it belongs in.
14974 Virtual server settings:
14977 @item nnmbox-mbox-file
14978 @vindex nnmbox-mbox-file
14979 The name of the mail box in the user's home directory. Default is
14982 @item nnmbox-active-file
14983 @vindex nnmbox-active-file
14984 The name of the active file for the mail box. Default is
14985 @file{~/.mbox-active}.
14987 @item nnmbox-get-new-mail
14988 @vindex nnmbox-get-new-mail
14989 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
14990 into groups. Default is @code{t}.
14995 @subsubsection Rmail Babyl
14999 @vindex nnbabyl-active-file
15000 @vindex nnbabyl-mbox-file
15001 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
15002 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
15003 mail article to say which group it belongs in.
15005 Virtual server settings:
15008 @item nnbabyl-mbox-file
15009 @vindex nnbabyl-mbox-file
15010 The name of the Rmail mbox file. The default is @file{~/RMAIL}
15012 @item nnbabyl-active-file
15013 @vindex nnbabyl-active-file
15014 The name of the active file for the rmail box. The default is
15015 @file{~/.rmail-active}
15017 @item nnbabyl-get-new-mail
15018 @vindex nnbabyl-get-new-mail
15019 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
15025 @subsubsection Mail Spool
15027 @cindex mail @acronym{NOV} spool
15029 The @dfn{nnml} spool mail format isn't compatible with any other known
15030 format. It should be used with some caution.
15032 @vindex nnml-directory
15033 If you use this back end, Gnus will split all incoming mail into files,
15034 one file for each mail, and put the articles into the corresponding
15035 directories under the directory specified by the @code{nnml-directory}
15036 variable. The default value is @file{~/Mail/}.
15038 You do not have to create any directories beforehand; Gnus will take
15041 If you have a strict limit as to how many files you are allowed to store
15042 in your account, you should not use this back end. As each mail gets its
15043 own file, you might very well occupy thousands of inodes within a few
15044 weeks. If this is no problem for you, and it isn't a problem for you
15045 having your friendly systems administrator walking around, madly,
15046 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
15047 know that this is probably the fastest format to use. You do not have
15048 to trudge through a big mbox file just to read your new mail.
15050 @code{nnml} is probably the slowest back end when it comes to article
15051 splitting. It has to create lots of files, and it also generates
15052 @acronym{NOV} databases for the incoming mails. This makes it possibly the
15053 fastest back end when it comes to reading mail.
15055 @cindex self contained nnml servers
15057 When the marks file is used (which it is by default), @code{nnml}
15058 servers have the property that you may backup them using @code{tar} or
15059 similar, and later be able to restore them into Gnus (by adding the
15060 proper @code{nnml} server) and have all your marks be preserved. Marks
15061 for a group is usually stored in the @code{.marks} file (but see
15062 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
15063 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
15064 to restore the group (after restoring the backup into the nnml
15067 If for some reason you believe your @file{.marks} files are screwed
15068 up, you can just delete them all. Gnus will then correctly regenerate
15069 them next time it starts.
15071 Virtual server settings:
15074 @item nnml-directory
15075 @vindex nnml-directory
15076 All @code{nnml} directories will be placed under this directory. The
15077 default is the value of @code{message-directory} (whose default value
15080 @item nnml-active-file
15081 @vindex nnml-active-file
15082 The active file for the @code{nnml} server. The default is
15083 @file{~/Mail/active}.
15085 @item nnml-newsgroups-file
15086 @vindex nnml-newsgroups-file
15087 The @code{nnml} group descriptions file. @xref{Newsgroups File
15088 Format}. The default is @file{~/Mail/newsgroups}.
15090 @item nnml-get-new-mail
15091 @vindex nnml-get-new-mail
15092 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
15095 @item nnml-nov-is-evil
15096 @vindex nnml-nov-is-evil
15097 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15098 default is @code{nil}.
15100 @item nnml-nov-file-name
15101 @vindex nnml-nov-file-name
15102 The name of the @acronym{NOV} files. The default is @file{.overview}.
15104 @item nnml-prepare-save-mail-hook
15105 @vindex nnml-prepare-save-mail-hook
15106 Hook run narrowed to an article before saving.
15108 @item nnml-marks-is-evil
15109 @vindex nnml-marks-is-evil
15110 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15111 default is @code{nil}.
15113 @item nnml-marks-file-name
15114 @vindex nnml-marks-file-name
15115 The name of the @dfn{marks} files. The default is @file{.marks}.
15117 @item nnml-use-compressed-files
15118 @vindex nnml-use-compressed-files
15119 If non-@code{nil}, @code{nnml} will allow using compressed message
15124 @findex nnml-generate-nov-databases
15125 If your @code{nnml} groups and @acronym{NOV} files get totally out of
15126 whack, you can do a complete update by typing @kbd{M-x
15127 nnml-generate-nov-databases}. This command will trawl through the
15128 entire @code{nnml} hierarchy, looking at each and every article, so it
15129 might take a while to complete. A better interface to this
15130 functionality can be found in the server buffer (@pxref{Server
15135 @subsubsection MH Spool
15137 @cindex mh-e mail spool
15139 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
15140 @acronym{NOV} databases and it doesn't keep an active file or marks
15141 file. This makes @code{nnmh} a @emph{much} slower back end than
15142 @code{nnml}, but it also makes it easier to write procmail scripts
15145 Virtual server settings:
15148 @item nnmh-directory
15149 @vindex nnmh-directory
15150 All @code{nnmh} directories will be located under this directory. The
15151 default is the value of @code{message-directory} (whose default is
15154 @item nnmh-get-new-mail
15155 @vindex nnmh-get-new-mail
15156 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
15160 @vindex nnmh-be-safe
15161 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
15162 sure that the articles in the folder are actually what Gnus thinks
15163 they are. It will check date stamps and stat everything in sight, so
15164 setting this to @code{t} will mean a serious slow-down. If you never
15165 use anything but Gnus to read the @code{nnmh} articles, you do not
15166 have to set this variable to @code{t}. The default is @code{nil}.
15171 @subsubsection Maildir
15175 @code{nnmaildir} stores mail in the maildir format, with each maildir
15176 corresponding to a group in Gnus. This format is documented here:
15177 @uref{http://cr.yp.to/proto/maildir.html} and here:
15178 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
15179 also stores extra information in the @file{.nnmaildir/} directory
15182 Maildir format was designed to allow concurrent deliveries and
15183 reading, without needing locks. With other back ends, you would have
15184 your mail delivered to a spool of some kind, and then you would
15185 configure Gnus to split mail from that spool into your groups. You
15186 can still do that with @code{nnmaildir}, but the more common
15187 configuration is to have your mail delivered directly to the maildirs
15188 that appear as group in Gnus.
15190 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
15191 never corrupt its data in memory, and @code{SIGKILL} will never
15192 corrupt its data in the filesystem.
15194 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
15195 maildir. So you can copy a whole maildir from one Gnus setup to
15196 another, and you will keep your marks.
15198 Virtual server settings:
15202 For each of your @code{nnmaildir} servers (it's very unlikely that
15203 you'd need more than one), you need to create a directory and populate
15204 it with maildirs or symlinks to maildirs (and nothing else; do not
15205 choose a directory already used for other purposes). Each maildir
15206 will be represented in Gnus as a newsgroup on that server; the
15207 filename of the symlink will be the name of the group. Any filenames
15208 in the directory starting with @samp{.} are ignored. The directory is
15209 scanned when you first start Gnus, and each time you type @kbd{g} in
15210 the group buffer; if any maildirs have been removed or added,
15211 @code{nnmaildir} notices at these times.
15213 The value of the @code{directory} parameter should be a Lisp form
15214 which is processed by @code{eval} and @code{expand-file-name} to get
15215 the path of the directory for this server. The form is @code{eval}ed
15216 only when the server is opened; the resulting string is used until the
15217 server is closed. (If you don't know about forms and @code{eval},
15218 don't worry---a simple string will work.) This parameter is not
15219 optional; you must specify it. I don't recommend using
15220 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
15221 use that directory by default for various things, and may get confused
15222 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
15225 @item target-prefix
15226 This should be a Lisp form which is processed by @code{eval} and
15227 @code{expand-file-name}. The form is @code{eval}ed only when the
15228 server is opened; the resulting string is used until the server is
15231 When you create a group on an @code{nnmaildir} server, the maildir is
15232 created with @code{target-prefix} prepended to its name, and a symlink
15233 pointing to that maildir is created, named with the plain group name.
15234 So if @code{directory} is @code{"~/.nnmaildir"} and
15235 @code{target-prefix} is @code{"../maildirs/"}, then when you create
15236 the group @code{foo}, @code{nnmaildir} will create
15237 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
15238 @file{~/.nnmaildir/foo} as a symlink pointing to
15239 @file{../maildirs/foo}.
15241 You can set @code{target-prefix} to a string without any slashes to
15242 create both maildirs and symlinks in the same @code{directory}; in
15243 this case, any maildirs found in @code{directory} whose names start
15244 with @code{target-prefix} will not be listed as groups (but the
15245 symlinks pointing to them will be).
15247 As a special case, if @code{target-prefix} is @code{""} (the default),
15248 then when you create a group, the maildir will be created in
15249 @code{directory} without a corresponding symlink. Beware that you
15250 cannot use @code{gnus-group-delete-group} on such groups without the
15251 @code{force} argument.
15253 @item directory-files
15254 This should be a function with the same interface as
15255 @code{directory-files} (such as @code{directory-files} itself). It is
15256 used to scan the server's @code{directory} for maildirs. This
15257 parameter is optional; the default is
15258 @code{nnheader-directory-files-safe} if
15259 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15260 @code{directory-files} otherwise.
15261 (@code{nnheader-directory-files-is-safe} is checked only once when the
15262 server is opened; if you want to check it each time the directory is
15263 scanned, you'll have to provide your own function that does that.)
15266 If non-@code{nil}, then after scanning for new mail in the group
15267 maildirs themselves as usual, this server will also incorporate mail
15268 the conventional Gnus way, from @code{mail-sources} according to
15269 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
15270 value is @code{nil}.
15272 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15273 an @code{nnmaildir} group. The results might happen to be useful, but
15274 that would be by chance, not by design, and the results might be
15275 different in the future. If your split rules create new groups,
15276 remember to supply a @code{create-directory} server parameter.
15279 @subsubsection Group parameters
15281 @code{nnmaildir} uses several group parameters. It's safe to ignore
15282 all this; the default behavior for @code{nnmaildir} is the same as the
15283 default behavior for other mail back ends: articles are deleted after
15284 one week, etc. Except for the expiry parameters, all this
15285 functionality is unique to @code{nnmaildir}, so you can ignore it if
15286 you're just trying to duplicate the behavior you already have with
15289 If the value of any of these parameters is a vector, the first element
15290 is evaluated as a Lisp form and the result is used, rather than the
15291 original value. If the value is not a vector, the value itself is
15292 evaluated as a Lisp form. (This is why these parameters use names
15293 different from those of other, similar parameters supported by other
15294 back ends: they have different, though similar, meanings.) (For
15295 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15296 @code{eval} business again; for other values, remember to use an extra
15297 quote and wrap the value in a vector when appropriate.)
15301 An integer specifying the minimum age, in seconds, of an article
15302 before it will be expired, or the symbol @code{never} to specify that
15303 articles should never be expired. If this parameter is not set,
15304 @code{nnmaildir} falls back to the usual
15305 @code{nnmail-expiry-wait}(@code{-function}) variables (overrideable by
15306 the @code{expiry-wait}(@code{-function}) group parameters. If you
15307 wanted a value of 3 days, you could use something like @code{[(* 3 24
15308 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15309 An article's age is measured starting from the article file's
15310 modification time. Normally, this is the same as the article's
15311 delivery time, but editing an article makes it younger. Moving an
15312 article (other than via expiry) may also make an article younger.
15315 If this is set to a string such as a full Gnus group name, like
15317 "backend+server.address.string:group.name"
15319 and if it is not the name of the same group that the parameter belongs
15320 to, then articles will be moved to the specified group during expiry
15321 before being deleted. @emph{If this is set to an @code{nnmaildir}
15322 group, the article will be just as old in the destination group as it
15323 was in the source group.} So be careful with @code{expire-age} in the
15324 destination group. If this is set to the name of the same group that
15325 the parameter belongs to, then the article is not expired at all. If
15326 you use the vector form, the first element is evaluated once for each
15327 article. So that form can refer to
15328 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15329 article. @emph{If this parameter is not set, @code{nnmaildir} does
15330 not fall back to the @code{expiry-target} group parameter or the
15331 @code{nnmail-expiry-target} variable.}
15334 If this is set to @code{t}, @code{nnmaildir} will treat the articles
15335 in this maildir as read-only. This means: articles are not renamed
15336 from @file{new/} into @file{cur/}; articles are only found in
15337 @file{new/}, not @file{cur/}; articles are never deleted; articles
15338 cannot be edited. @file{new/} is expected to be a symlink to the
15339 @file{new/} directory of another maildir---e.g., a system-wide mailbox
15340 containing a mailing list of common interest. Everything in the
15341 maildir outside @file{new/} is @emph{not} treated as read-only, so for
15342 a shared mailbox, you do still need to set up your own maildir (or
15343 have write permission to the shared mailbox); your maildir just won't
15344 contain extra copies of the articles.
15346 @item directory-files
15347 A function with the same interface as @code{directory-files}. It is
15348 used to scan the directories in the maildir corresponding to this
15349 group to find articles. The default is the function specified by the
15350 server's @code{directory-files} parameter.
15352 @item distrust-Lines:
15353 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
15354 article, rather than use the @code{Lines:} header field. If
15355 @code{nil}, the header field will be used if present.
15358 A list of mark symbols, such as @code{['(read expire)]}. Whenever
15359 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15360 say that all articles have these marks, regardless of whether the
15361 marks stored in the filesystem say so. This is a proof-of-concept
15362 feature that will probably be removed eventually; it ought to be done
15363 in Gnus proper, or abandoned if it's not worthwhile.
15366 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
15367 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15368 say that no articles have these marks, regardless of whether the marks
15369 stored in the filesystem say so. @code{never-marks} overrides
15370 @code{always-marks}. This is a proof-of-concept feature that will
15371 probably be removed eventually; it ought to be done in Gnus proper, or
15372 abandoned if it's not worthwhile.
15374 @item nov-cache-size
15375 An integer specifying the size of the @acronym{NOV} memory cache. To
15376 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
15377 for a limited number of articles in each group. (This is probably not
15378 worthwhile, and will probably be removed in the future.) This
15379 parameter's value is noticed only the first time a group is seen after
15380 the server is opened---i.e., when you first start Gnus, typically.
15381 The @acronym{NOV} cache is never resized until the server is closed
15382 and reopened. The default is an estimate of the number of articles
15383 that would be displayed in the summary buffer: a count of articles
15384 that are either marked with @code{tick} or not marked with
15385 @code{read}, plus a little extra.
15388 @subsubsection Article identification
15389 Articles are stored in the @file{cur/} subdirectory of each maildir.
15390 Each article file is named like @code{uniq:info}, where @code{uniq}
15391 contains no colons. @code{nnmaildir} ignores, but preserves, the
15392 @code{:info} part. (Other maildir readers typically use this part of
15393 the filename to store marks.) The @code{uniq} part uniquely
15394 identifies the article, and is used in various places in the
15395 @file{.nnmaildir/} subdirectory of the maildir to store information
15396 about the corresponding article. The full pathname of an article is
15397 available in the variable @code{nnmaildir-article-file-name} after you
15398 request the article in the summary buffer.
15400 @subsubsection NOV data
15401 An article identified by @code{uniq} has its @acronym{NOV} data (used
15402 to generate lines in the summary buffer) stored in
15403 @code{.nnmaildir/nov/uniq}. There is no
15404 @code{nnmaildir-generate-nov-databases} function. (There isn't much
15405 need for it---an article's @acronym{NOV} data is updated automatically
15406 when the article or @code{nnmail-extra-headers} has changed.) You can
15407 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
15408 single article simply by deleting the corresponding @acronym{NOV}
15409 file, but @emph{beware}: this will also cause @code{nnmaildir} to
15410 assign a new article number for this article, which may cause trouble
15411 with @code{seen} marks, the Agent, and the cache.
15413 @subsubsection Article marks
15414 An article identified by @code{uniq} is considered to have the mark
15415 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
15416 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
15417 looks for such files and reports the set of marks it finds. When Gnus
15418 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
15419 creates and deletes the corresponding files as needed. (Actually,
15420 rather than create a new file for each mark, it just creates hard
15421 links to @file{.nnmaildir/markfile}, to save inodes.)
15423 You can invent new marks by creating a new directory in
15424 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
15425 your server, untar it later, and keep your marks. You can add and
15426 remove marks yourself by creating and deleting mark files. If you do
15427 this while Gnus is running and your @code{nnmaildir} server is open,
15428 it's best to exit all summary buffers for @code{nnmaildir} groups and
15429 type @kbd{s} in the group buffer first, and to type @kbd{g} or
15430 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
15431 pick up the changes, and might undo them.
15435 @subsubsection Mail Folders
15437 @cindex mbox folders
15438 @cindex mail folders
15440 @code{nnfolder} is a back end for storing each mail group in a
15441 separate file. Each file is in the standard Un*x mbox format.
15442 @code{nnfolder} will add extra headers to keep track of article
15443 numbers and arrival dates.
15445 @cindex self contained nnfolder servers
15447 When the marks file is used (which it is by default), @code{nnfolder}
15448 servers have the property that you may backup them using @code{tar} or
15449 similar, and later be able to restore them into Gnus (by adding the
15450 proper @code{nnfolder} server) and have all your marks be preserved.
15451 Marks for a group is usually stored in a file named as the mbox file
15452 with @code{.mrk} concatenated to it (but see
15453 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
15454 directory. Individual @code{nnfolder} groups are also possible to
15455 backup, use @kbd{G m} to restore the group (after restoring the backup
15456 into the @code{nnfolder} directory).
15458 Virtual server settings:
15461 @item nnfolder-directory
15462 @vindex nnfolder-directory
15463 All the @code{nnfolder} mail boxes will be stored under this
15464 directory. The default is the value of @code{message-directory}
15465 (whose default is @file{~/Mail})
15467 @item nnfolder-active-file
15468 @vindex nnfolder-active-file
15469 The name of the active file. The default is @file{~/Mail/active}.
15471 @item nnfolder-newsgroups-file
15472 @vindex nnfolder-newsgroups-file
15473 The name of the group descriptions file. @xref{Newsgroups File
15474 Format}. The default is @file{~/Mail/newsgroups}
15476 @item nnfolder-get-new-mail
15477 @vindex nnfolder-get-new-mail
15478 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
15479 default is @code{t}
15481 @item nnfolder-save-buffer-hook
15482 @vindex nnfolder-save-buffer-hook
15483 @cindex backup files
15484 Hook run before saving the folders. Note that Emacs does the normal
15485 backup renaming of files even with the @code{nnfolder} buffers. If
15486 you wish to switch this off, you could say something like the
15487 following in your @file{.emacs} file:
15490 (defun turn-off-backup ()
15491 (set (make-local-variable 'backup-inhibited) t))
15493 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
15496 @item nnfolder-delete-mail-hook
15497 @vindex nnfolder-delete-mail-hook
15498 Hook run in a buffer narrowed to the message that is to be deleted.
15499 This function can be used to copy the message to somewhere else, or to
15500 extract some information from it before removing it.
15502 @item nnfolder-nov-is-evil
15503 @vindex nnfolder-nov-is-evil
15504 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15505 default is @code{nil}.
15507 @item nnfolder-nov-file-suffix
15508 @vindex nnfolder-nov-file-suffix
15509 The extension for @acronym{NOV} files. The default is @file{.nov}.
15511 @item nnfolder-nov-directory
15512 @vindex nnfolder-nov-directory
15513 The directory where the @acronym{NOV} files should be stored. If
15514 @code{nil}, @code{nnfolder-directory} is used.
15516 @item nnfolder-marks-is-evil
15517 @vindex nnfolder-marks-is-evil
15518 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15519 default is @code{nil}.
15521 @item nnfolder-marks-file-suffix
15522 @vindex nnfolder-marks-file-suffix
15523 The extension for @sc{marks} files. The default is @file{.mrk}.
15525 @item nnfolder-marks-directory
15526 @vindex nnfolder-marks-directory
15527 The directory where the @sc{marks} files should be stored. If
15528 @code{nil}, @code{nnfolder-directory} is used.
15533 @findex nnfolder-generate-active-file
15534 @kindex M-x nnfolder-generate-active-file
15535 If you have lots of @code{nnfolder}-like files you'd like to read with
15536 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
15537 command to make @code{nnfolder} aware of all likely files in
15538 @code{nnfolder-directory}. This only works if you use long file names,
15541 @node Comparing Mail Back Ends
15542 @subsubsection Comparing Mail Back Ends
15544 First, just for terminology, the @dfn{back end} is the common word for a
15545 low-level access method---a transport, if you will, by which something
15546 is acquired. The sense is that one's mail has to come from somewhere,
15547 and so selection of a suitable back end is required in order to get that
15548 mail within spitting distance of Gnus.
15550 The same concept exists for Usenet itself: Though access to articles is
15551 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
15552 in the world got at Usenet by running a reader on the machine where the
15553 articles lay (the machine which today we call an @acronym{NNTP} server), and
15554 access was by the reader stepping into the articles' directory spool
15555 area directly. One can still select between either the @code{nntp} or
15556 @code{nnspool} back ends, to select between these methods, if one happens
15557 actually to live on the server (or can see its spool directly, anyway,
15560 The goal in selecting a mail back end is to pick one which
15561 simultaneously represents a suitable way of dealing with the original
15562 format plus leaving mail in a form that is convenient to use in the
15563 future. Here are some high and low points on each:
15568 UNIX systems have historically had a single, very common, and well-
15569 defined format. All messages arrive in a single @dfn{spool file}, and
15570 they are delineated by a line whose regular expression matches
15571 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
15572 to make it clear in this instance that this is not the RFC-specified
15573 @samp{From:} header.) Because Emacs and therefore Gnus emanate
15574 historically from the Unix environment, it is simplest if one does not
15575 mess a great deal with the original mailbox format, so if one chooses
15576 this back end, Gnus' primary activity in getting mail from the real spool
15577 area to Gnus' preferred directory is simply to copy it, with no
15578 (appreciable) format change in the process. It is the ``dumbest'' way
15579 to move mail into availability in the Gnus environment. This makes it
15580 fast to move into place, but slow to parse, when Gnus has to look at
15585 Once upon a time, there was the DEC-10 and DEC-20, running operating
15586 systems called TOPS and related things, and the usual (only?) mail
15587 reading environment was a thing called Babyl. I don't know what format
15588 was used for mail landing on the system, but Babyl had its own internal
15589 format to which mail was converted, primarily involving creating a
15590 spool-file-like entity with a scheme for inserting Babyl-specific
15591 headers and status bits above the top of each message in the file.
15592 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
15593 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
15594 to understand the mail files folks already had in existence. Gnus (and
15595 VM, for that matter) continue to support this format because it's
15596 perceived as having some good qualities in those mailer-specific
15597 headers/status bits stuff. Rmail itself still exists as well, of
15598 course, and is still maintained by Stallman.
15600 Both of the above forms leave your mail in a single file on your
15601 file system, and they must parse that entire file each time you take a
15606 @code{nnml} is the back end which smells the most as though you were
15607 actually operating with an @code{nnspool}-accessed Usenet system. (In
15608 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
15609 lo these years ago.) One's mail is taken from the original spool file,
15610 and is then cut up into individual message files, 1:1. It maintains a
15611 Usenet-style active file (analogous to what one finds in an INN- or
15612 CNews-based news system in (for instance) @file{/var/lib/news/active},
15613 or what is returned via the @samp{NNTP LIST} verb) and also creates
15614 @dfn{overview} files for efficient group entry, as has been defined for
15615 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
15616 due to the creation of lots of files, updates to the @code{nnml} active
15617 file, and additions to overview files on a per-message basis, but it is
15618 extremely fast on access because of what amounts to the indexing support
15619 provided by the active file and overviews.
15621 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
15622 resource which defines available places in the file system to put new
15623 files. Sysadmins take a dim view of heavy inode occupation within
15624 tight, shared file systems. But if you live on a personal machine where
15625 the file system is your own and space is not at a premium, @code{nnml}
15628 It is also problematic using this back end if you are living in a
15629 FAT16-based Windows world, since much space will be wasted on all these
15634 The Rand MH mail-reading system has been around UNIX systems for a very
15635 long time; it operates by splitting one's spool file of messages into
15636 individual files, but with little or no indexing support---@code{nnmh}
15637 is considered to be semantically equivalent to ``@code{nnml} without
15638 active file or overviews''. This is arguably the worst choice, because
15639 one gets the slowness of individual file creation married to the
15640 slowness of access parsing when learning what's new in one's groups.
15644 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
15645 method described above) on a per-group basis. That is, @code{nnmbox}
15646 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
15647 little bit of optimization to this so that each of one's mail groups has
15648 a Unix mail box file. It's faster than @code{nnmbox} because each group
15649 can be parsed separately, and still provides the simple Unix mail box
15650 format requiring minimal effort in moving the mail around. In addition,
15651 it maintains an ``active'' file making it much faster for Gnus to figure
15652 out how many messages there are in each separate group.
15654 If you have groups that are expected to have a massive amount of
15655 messages, @code{nnfolder} is not the best choice, but if you receive
15656 only a moderate amount of mail, @code{nnfolder} is probably the most
15657 friendly mail back end all over.
15661 For configuring expiry and other things, @code{nnmaildir} uses
15662 incompatible group parameters, slightly different from those of other
15665 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
15666 differences. Each message is stored in a separate file, but the
15667 filename is unrelated to the article number in Gnus. @code{nnmaildir}
15668 also stores the equivalent of @code{nnml}'s overview files in one file
15669 per article, so it uses about twice as many inodes as @code{nnml}. (Use
15670 @code{df -i} to see how plentiful your inode supply is.) If this slows
15671 you down or takes up very much space, consider switching to
15672 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
15675 Since maildirs don't require locking for delivery, the maildirs you use
15676 as groups can also be the maildirs your mail is directly delivered to.
15677 This means you can skip Gnus' mail splitting if your mail is already
15678 organized into different mailboxes during delivery. A @code{directory}
15679 entry in @code{mail-sources} would have a similar effect, but would
15680 require one set of mailboxes for spooling deliveries (in mbox format,
15681 thus damaging message bodies), and another set to be used as groups (in
15682 whatever format you like). A maildir has a built-in spool, in the
15683 @code{new/} subdirectory. Beware that currently, mail moved from
15684 @code{new/} to @code{cur/} instead of via mail splitting will not
15685 undergo treatment such as duplicate checking.
15687 @code{nnmaildir} stores article marks for a given group in the
15688 corresponding maildir, in a way designed so that it's easy to manipulate
15689 them from outside Gnus. You can tar up a maildir, unpack it somewhere
15690 else, and still have your marks. @code{nnml} also stores marks, but
15691 it's not as easy to work with them from outside Gnus as with
15694 @code{nnmaildir} uses a significant amount of memory to speed things up.
15695 (It keeps in memory some of the things that @code{nnml} stores in files
15696 and that @code{nnmh} repeatedly parses out of message files.) If this
15697 is a problem for you, you can set the @code{nov-cache-size} group
15698 parameter to something small (0 would probably not work, but 1 probably
15699 would) to make it use less memory. This caching will probably be
15700 removed in the future.
15702 Startup is likely to be slower with @code{nnmaildir} than with other
15703 back ends. Everything else is likely to be faster, depending in part
15704 on your file system.
15706 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
15707 to write an @code{nnmaildir}-derived back end.
15712 @node Browsing the Web
15713 @section Browsing the Web
15715 @cindex browsing the web
15719 Web-based discussion forums are getting more and more popular. On many
15720 subjects, the web-based forums have become the most important forums,
15721 eclipsing the importance of mailing lists and news groups. The reason
15722 is easy to understand---they are friendly to new users; you just point
15723 and click, and there's the discussion. With mailing lists, you have to
15724 go through a cumbersome subscription procedure, and most people don't
15725 even know what a news group is.
15727 The problem with this scenario is that web browsers are not very good at
15728 being newsreaders. They do not keep track of what articles you've read;
15729 they do not allow you to score on subjects you're interested in; they do
15730 not allow off-line browsing; they require you to click around and drive
15731 you mad in the end.
15733 So---if web browsers suck at reading discussion forums, why not use Gnus
15736 Gnus has been getting a bit of a collection of back ends for providing
15737 interfaces to these sources.
15741 * Web Searches:: Creating groups from articles that match a string.
15742 * Slashdot:: Reading the Slashdot comments.
15743 * Ultimate:: The Ultimate Bulletin Board systems.
15744 * Web Archive:: Reading mailing list archived on web.
15745 * RSS:: Reading RDF site summary.
15746 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
15749 All the web sources require Emacs/w3 and the url library to work.
15751 The main caveat with all these web sources is that they probably won't
15752 work for a very long time. Gleaning information from the @acronym{HTML} data
15753 is guesswork at best, and when the layout is altered, the Gnus back end
15754 will fail. If you have reasonably new versions of these back ends,
15755 though, you should be ok.
15757 One thing all these Web methods have in common is that the Web sources
15758 are often down, unavailable or just plain too slow to be fun. In those
15759 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
15760 Unplugged}) handle downloading articles, and then you can read them at
15761 leisure from your local disk. No more World Wide Wait for you.
15763 @node Archiving Mail
15764 @subsection Archiving Mail
15765 @cindex archiving mail
15766 @cindex backup of mail
15768 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
15769 @code{nnmaildir}, now actually store the article marks with each group.
15770 For these servers, archiving and restoring a group while preserving
15771 marks is fairly simple.
15773 (Preserving the group level and group parameters as well still
15774 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
15777 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
15778 server, take a recursive copy of the server directory. There is no need
15779 to shut down Gnus, so archiving may be invoked by @code{cron} or
15780 similar. You restore the data by restoring the directory tree, and
15781 adding a server definition pointing to that directory in Gnus. The
15782 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
15783 might interfere with overwriting data, so you may want to shut down Gnus
15784 before you restore the data.
15786 It is also possible to archive individual @code{nnml},
15787 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
15788 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
15789 directory. For @code{nnfolder} you need to copy both the base folder
15790 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
15791 this example). Restoring the group is done with @kbd{G m} from the Group
15792 buffer. The last step makes Gnus notice the new directory.
15793 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
15794 is unnecessary in that case.
15797 @subsection Web Searches
15802 @cindex Usenet searches
15803 @cindex searching the Usenet
15805 It's, like, too neat to search the Usenet for articles that match a
15806 string, but it, like, totally @emph{sucks}, like, totally, to use one of
15807 those, like, Web browsers, and you, like, have to, rilly, like, look at
15808 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
15809 searches without having to use a browser.
15811 The @code{nnweb} back end allows an easy interface to the mighty search
15812 engine. You create an @code{nnweb} group, enter a search pattern, and
15813 then enter the group and read the articles like you would any normal
15814 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
15815 Groups}) will do this in an easy-to-use fashion.
15817 @code{nnweb} groups don't really lend themselves to being solid
15818 groups---they have a very fleeting idea of article numbers. In fact,
15819 each time you enter an @code{nnweb} group (not even changing the search
15820 pattern), you are likely to get the articles ordered in a different
15821 manner. Not even using duplicate suppression (@pxref{Duplicate
15822 Suppression}) will help, since @code{nnweb} doesn't even know the
15823 @code{Message-ID} of the articles before reading them using some search
15824 engines (Google, for instance). The only possible way to keep track
15825 of which articles you've read is by scoring on the @code{Date}
15826 header---mark all articles posted before the last date you read the
15829 If the search engine changes its output substantially, @code{nnweb}
15830 won't be able to parse it and will fail. One could hardly fault the Web
15831 providers if they were to do this---their @emph{raison d'@^etre} is to
15832 make money off of advertisements, not to provide services to the
15833 community. Since @code{nnweb} washes the ads off all the articles, one
15834 might think that the providers might be somewhat miffed. We'll see.
15836 You must have the @code{url} and @code{w3} package installed to be able
15837 to use @code{nnweb}.
15839 Virtual server variables:
15844 What search engine type is being used. The currently supported types
15845 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
15846 @code{dejanews} is an alias to @code{google}.
15849 @vindex nnweb-search
15850 The search string to feed to the search engine.
15852 @item nnweb-max-hits
15853 @vindex nnweb-max-hits
15854 Advisory maximum number of hits per search to display. The default is
15857 @item nnweb-type-definition
15858 @vindex nnweb-type-definition
15859 Type-to-definition alist. This alist says what @code{nnweb} should do
15860 with the various search engine types. The following elements must be
15865 Function to decode the article and provide something that Gnus
15869 Function to create an article number to message header and URL alist.
15872 Function to send the search string to the search engine.
15875 The address the aforementioned function should send the search string
15879 Format string URL to fetch an article by @code{Message-ID}.
15886 @subsection Slashdot
15890 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
15891 lively discussion following the news articles. @code{nnslashdot} will
15892 let you read this forum in a convenient manner.
15894 The easiest way to read this source is to put something like the
15895 following in your @file{~/.gnus.el} file:
15898 (setq gnus-secondary-select-methods
15899 '((nnslashdot "")))
15902 This will make Gnus query the @code{nnslashdot} back end for new comments
15903 and groups. The @kbd{F} command will subscribe each new news article as
15904 a new Gnus group, and you can read the comments by entering these
15905 groups. (Note that the default subscription method is to subscribe new
15906 groups as zombies. Other methods are available (@pxref{Subscription
15909 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
15910 command is the most handy tool (@pxref{Foreign Groups}).
15912 When following up to @code{nnslashdot} comments (or posting new
15913 comments), some light @acronym{HTML}izations will be performed. In
15914 particular, text quoted with @samp{> } will be quoted with
15915 @samp{blockquote} instead, and signatures will have @samp{br} added to
15916 the end of each line. Other than that, you can just write @acronym{HTML}
15917 directly into the message buffer. Note that Slashdot filters out some
15918 @acronym{HTML} forms.
15920 The following variables can be altered to change its behavior:
15923 @item nnslashdot-threaded
15924 Whether @code{nnslashdot} should display threaded groups or not. The
15925 default is @code{t}. To be able to display threads, @code{nnslashdot}
15926 has to retrieve absolutely all comments in a group upon entry. If a
15927 threaded display is not required, @code{nnslashdot} will only retrieve
15928 the comments that are actually wanted by the user. Threading is nicer,
15929 but much, much slower than unthreaded.
15931 @item nnslashdot-login-name
15932 @vindex nnslashdot-login-name
15933 The login name to use when posting.
15935 @item nnslashdot-password
15936 @vindex nnslashdot-password
15937 The password to use when posting.
15939 @item nnslashdot-directory
15940 @vindex nnslashdot-directory
15941 Where @code{nnslashdot} will store its files. The default is
15942 @file{~/News/slashdot/}.
15944 @item nnslashdot-active-url
15945 @vindex nnslashdot-active-url
15946 The @acronym{URL} format string that will be used to fetch the
15947 information on news articles and comments. The default is@*
15948 @samp{http://slashdot.org/search.pl?section=&min=%d}.
15950 @item nnslashdot-comments-url
15951 @vindex nnslashdot-comments-url
15952 The @acronym{URL} format string that will be used to fetch comments.
15954 @item nnslashdot-article-url
15955 @vindex nnslashdot-article-url
15956 The @acronym{URL} format string that will be used to fetch the news
15957 article. The default is
15958 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
15960 @item nnslashdot-threshold
15961 @vindex nnslashdot-threshold
15962 The score threshold. The default is -1.
15964 @item nnslashdot-group-number
15965 @vindex nnslashdot-group-number
15966 The number of old groups, in addition to the ten latest, to keep
15967 updated. The default is 0.
15974 @subsection Ultimate
15976 @cindex Ultimate Bulletin Board
15978 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
15979 probably the most popular Web bulletin board system used. It has a
15980 quite regular and nice interface, and it's possible to get the
15981 information Gnus needs to keep groups updated.
15983 The easiest way to get started with @code{nnultimate} is to say
15984 something like the following in the group buffer: @kbd{B nnultimate RET
15985 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
15986 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
15987 you're interested in; there's quite a list of them on the Ultimate web
15988 site.) Then subscribe to the groups you're interested in from the
15989 server buffer, and read them from the group buffer.
15991 The following @code{nnultimate} variables can be altered:
15994 @item nnultimate-directory
15995 @vindex nnultimate-directory
15996 The directory where @code{nnultimate} stores its files. The default is@*
15997 @file{~/News/ultimate/}.
16002 @subsection Web Archive
16004 @cindex Web Archive
16006 Some mailing lists only have archives on Web servers, such as
16007 @uref{http://www.egroups.com/} and
16008 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
16009 interface, and it's possible to get the information Gnus needs to keep
16012 @findex gnus-group-make-warchive-group
16013 The easiest way to get started with @code{nnwarchive} is to say
16014 something like the following in the group buffer: @kbd{M-x
16015 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
16016 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
16017 @var{an_egroup} with the mailing list you subscribed, the
16018 @var{your@@email.address} with your email address.), or to browse the
16019 back end by @kbd{B nnwarchive RET mail-archive RET}.
16021 The following @code{nnwarchive} variables can be altered:
16024 @item nnwarchive-directory
16025 @vindex nnwarchive-directory
16026 The directory where @code{nnwarchive} stores its files. The default is@*
16027 @file{~/News/warchive/}.
16029 @item nnwarchive-login
16030 @vindex nnwarchive-login
16031 The account name on the web server.
16033 @item nnwarchive-passwd
16034 @vindex nnwarchive-passwd
16035 The password for your account on the web server.
16043 Some web sites have an RDF Site Summary (@acronym{RSS}).
16044 @acronym{RSS} is a format for summarizing headlines from news related
16045 sites (such as BBC or CNN). But basically anything list-like can be
16046 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
16047 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
16049 @acronym{RSS} has a quite regular and nice interface, and it's
16050 possible to get the information Gnus needs to keep groups updated.
16052 Note: you had better use Emacs which supports the @code{utf-8} coding
16053 system because @acronym{RSS} uses UTF-8 for encoding non-@acronym{ASCII}
16054 text by default. It is also used by default for non-@acronym{ASCII}
16057 @kindex G R (Summary)
16058 Use @kbd{G R} from the summary buffer to subscribe to a feed---you will
16059 be prompted for the location, the title and the description of the feed.
16060 The title, which allows any characters, will be used for the group name
16061 and the name of the group data file. The description can be omitted.
16063 An easy way to get started with @code{nnrss} is to say something like
16064 the following in the group buffer: @kbd{B nnrss RET RET y}, then
16065 subscribe to groups.
16067 The @code{nnrss} back end saves the group data file in
16068 @code{nnrss-directory} (see below) for each @code{nnrss} group. File
16069 names containing non-@acronym{ASCII} characters will be encoded by the
16070 coding system specified with the @code{nnmail-pathname-coding-system}
16071 variable. If it is @code{nil}, in Emacs the coding system defaults to
16072 the value of @code{default-file-name-coding-system}. If you are using
16073 XEmacs and want to use non-@acronym{ASCII} group names, you should set
16074 the value for the @code{nnmail-pathname-coding-system} variable properly.
16077 You can also use the following commands to import and export your
16078 subscriptions from a file in @acronym{OPML} format (Outline Processor
16081 @defun nnrss-opml-import file
16082 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
16086 @defun nnrss-opml-export
16087 Write your current @acronym{RSS} subscriptions to a buffer in
16088 @acronym{OPML} format.
16091 The following @code{nnrss} variables can be altered:
16094 @item nnrss-directory
16095 @vindex nnrss-directory
16096 The directory where @code{nnrss} stores its files. The default is
16097 @file{~/News/rss/}.
16099 @item nnrss-file-coding-system
16100 @vindex nnrss-file-coding-system
16101 The coding system used when reading and writing the @code{nnrss} groups
16102 data files. The default is the value of
16103 @code{mm-universal-coding-system} (which defaults to @code{emacs-mule}
16104 in Emacs or @code{escape-quoted} in XEmacs).
16106 @item nnrss-use-local
16107 @vindex nnrss-use-local
16108 @findex nnrss-generate-download-script
16109 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
16110 the feeds from local files in @code{nnrss-directory}. You can use
16111 the command @code{nnrss-generate-download-script} to generate a
16112 download script using @command{wget}.
16115 The following code may be helpful, if you want to show the description in
16116 the summary buffer.
16119 (add-to-list 'nnmail-extra-headers nnrss-description-field)
16120 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
16122 (defun gnus-user-format-function-X (header)
16124 (assq nnrss-description-field (mail-header-extra header))))
16125 (if descr (concat "\n\t" (cdr descr)) "")))
16128 The following code may be useful to open an nnrss url directly from the
16131 (require 'browse-url)
16133 (defun browse-nnrss-url( arg )
16135 (let ((url (assq nnrss-url-field
16138 (assq (gnus-summary-article-number)
16139 gnus-newsgroup-data))))))
16142 (browse-url (cdr url))
16143 (gnus-summary-mark-as-read-forward 1))
16144 (gnus-summary-scroll-up arg))))
16146 (eval-after-load "gnus"
16147 #'(define-key gnus-summary-mode-map
16148 (kbd "<RET>") 'browse-nnrss-url))
16149 (add-to-list 'nnmail-extra-headers nnrss-url-field)
16152 @node Customizing w3
16153 @subsection Customizing w3
16159 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
16160 pages. Emacs/w3 is documented in its own manual, but there are some
16161 things that may be more relevant for Gnus users.
16163 For instance, a common question is how to make Emacs/w3 follow links
16164 using the @code{browse-url} functions (which will call some external web
16165 browser like Netscape). Here's one way:
16168 (eval-after-load "w3"
16170 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
16171 (defun w3-fetch (&optional url target)
16172 (interactive (list (w3-read-url-with-default)))
16173 (if (eq major-mode 'gnus-article-mode)
16175 (w3-fetch-orig url target)))))
16178 Put that in your @file{.emacs} file, and hitting links in w3-rendered
16179 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
16186 @cindex @acronym{IMAP}
16188 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
16189 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
16190 server is much similar to connecting to a news server, you just
16191 specify the network address of the server.
16193 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
16194 everything that @acronym{POP} can, it can hence be viewed as a
16195 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
16196 similar to @acronym{NNTP} being a news storage protocol---however,
16197 @acronym{IMAP} offers more features than @acronym{NNTP} because news
16198 is more or less read-only whereas mail is read-write.
16200 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
16201 entry in @code{mail-sources}. With this, Gnus will fetch mails from
16202 the @acronym{IMAP} server and store them on the local disk. This is
16203 not the usage described in this section---@xref{Mail Sources}.
16205 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
16206 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
16207 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
16208 usage explained in this section.
16210 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
16211 servers might look something like the following. (Note that for
16212 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
16216 (setq gnus-secondary-select-methods
16217 '((nnimap "simpleserver") ; @r{no special configuration}
16218 ; @r{perhaps a ssh port forwarded server:}
16220 (nnimap-address "localhost")
16221 (nnimap-server-port 1430))
16222 ; @r{a UW server running on localhost}
16224 (nnimap-server-port 143)
16225 (nnimap-address "localhost")
16226 (nnimap-list-pattern ("INBOX" "mail/*")))
16227 ; @r{anonymous public cyrus server:}
16228 (nnimap "cyrus.andrew.cmu.edu"
16229 (nnimap-authenticator anonymous)
16230 (nnimap-list-pattern "archive.*")
16231 (nnimap-stream network))
16232 ; @r{a ssl server on a non-standard port:}
16234 (nnimap-address "vic20.somewhere.com")
16235 (nnimap-server-port 9930)
16236 (nnimap-stream ssl))))
16239 After defining the new server, you can subscribe to groups on the
16240 server using normal Gnus commands such as @kbd{U} in the Group Buffer
16241 (@pxref{Subscription Commands}) or via the Server Buffer
16242 (@pxref{Server Buffer}).
16244 The following variables can be used to create a virtual @code{nnimap}
16249 @item nnimap-address
16250 @vindex nnimap-address
16252 The address of the remote @acronym{IMAP} server. Defaults to the virtual
16253 server name if not specified.
16255 @item nnimap-server-port
16256 @vindex nnimap-server-port
16257 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
16259 Note that this should be an integer, example server specification:
16262 (nnimap "mail.server.com"
16263 (nnimap-server-port 4711))
16266 @item nnimap-list-pattern
16267 @vindex nnimap-list-pattern
16268 String or list of strings of mailboxes to limit available groups to.
16269 This is used when the server has very many mailboxes and you're only
16270 interested in a few---some servers export your home directory via
16271 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
16272 @file{~/Mail/*} then.
16274 The string can also be a cons of REFERENCE and the string as above, what
16275 REFERENCE is used for is server specific, but on the University of
16276 Washington server it's a directory that will be concatenated with the
16279 Example server specification:
16282 (nnimap "mail.server.com"
16283 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
16284 ("~friend/Mail/" . "list/*"))))
16287 @item nnimap-stream
16288 @vindex nnimap-stream
16289 The type of stream used to connect to your server. By default, nnimap
16290 will detect and automatically use all of the below, with the exception
16291 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
16292 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
16293 be automatically detected, but it's not widely deployed yet.)
16295 Example server specification:
16298 (nnimap "mail.server.com"
16299 (nnimap-stream ssl))
16302 Please note that the value of @code{nnimap-stream} is a symbol!
16306 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
16307 @samp{gsasl} or @samp{imtest} program.
16309 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
16311 @dfn{starttls:} Connect via the STARTTLS extension (similar to
16312 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
16315 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
16316 @samp{gnutls-cli}).
16318 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
16319 @samp{openssl}) or SSLeay (@samp{s_client}).
16321 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
16323 @dfn{network:} Plain, TCP/IP network connection.
16326 @vindex imap-kerberos4-program
16327 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
16328 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
16329 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
16330 to make @code{imap.el} use a pty instead of a pipe when communicating
16331 with @samp{imtest}. You will then suffer from a line length
16332 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
16333 indefinitely if you have many articles in a mailbox. The variable
16334 @code{imap-kerberos4-program} contain parameters to pass to the imtest
16337 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
16338 needed. It is available from
16339 @uref{http://www.gnu.org/software/gnutls/}.
16341 @vindex imap-gssapi-program
16342 This parameter specifies a list of command lines that invoke a GSSAPI
16343 authenticated @acronym{IMAP} stream in a subshell. They are tried
16344 sequentially until a connection is made, or the list has been
16345 exhausted. By default, @samp{gsasl} from GNU SASL, available from
16346 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
16347 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
16350 @vindex imap-ssl-program
16351 For @acronym{SSL} connections, the OpenSSL program is available from
16352 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
16353 and nnimap support it too---although the most recent versions of
16354 SSLeay, 0.9.x, are known to have serious bugs making it
16355 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
16356 work. The variable @code{imap-ssl-program} contain parameters to pass
16359 @vindex imap-shell-program
16360 @vindex imap-shell-host
16361 For @acronym{IMAP} connections using the @code{shell} stream, the variable
16362 @code{imap-shell-program} specify what program to call.
16364 @item nnimap-authenticator
16365 @vindex nnimap-authenticator
16367 The authenticator used to connect to the server. By default, nnimap
16368 will use the most secure authenticator your server is capable of.
16370 Example server specification:
16373 (nnimap "mail.server.com"
16374 (nnimap-authenticator anonymous))
16377 Please note that the value of @code{nnimap-authenticator} is a symbol!
16381 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
16382 external program @code{gsasl} or @code{imtest}.
16384 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
16387 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
16388 external library @code{digest-md5.el}.
16390 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
16392 @dfn{login:} Plain-text username/password via LOGIN.
16394 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
16397 @item nnimap-expunge-on-close
16399 @vindex nnimap-expunge-on-close
16400 Unlike Parmenides the @acronym{IMAP} designers have decided things that
16401 don't exist actually do exist. More specifically, @acronym{IMAP} has
16402 this concept of marking articles @code{Deleted} which doesn't actually
16403 delete them, and this (marking them @code{Deleted}, that is) is what
16404 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
16407 Since the articles aren't really removed when we mark them with the
16408 @code{Deleted} flag we'll need a way to actually delete them. Feel like
16409 running in circles yet?
16411 Traditionally, nnimap has removed all articles marked as @code{Deleted}
16412 when closing a mailbox but this is now configurable by this server
16415 The possible options are:
16420 The default behavior, delete all articles marked as ``Deleted'' when
16423 Never actually delete articles. Currently there is no way of showing
16424 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
16425 may allow you to do this. If you ever want to run the EXPUNGE command
16426 manually, @xref{Expunging mailboxes}.
16428 When closing mailboxes, nnimap will ask if you wish to expunge deleted
16433 @item nnimap-importantize-dormant
16434 @vindex nnimap-importantize-dormant
16436 If non-@code{nil} (the default), marks dormant articles as ticked (as
16437 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
16438 naturally still (only) be marked as dormant. This is to make dormant
16439 articles stand out, just like ticked articles, in other @acronym{IMAP}
16440 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
16443 Probably the only reason for frobing this would be if you're trying
16444 enable per-user persistent dormant flags, using something like:
16447 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
16448 (format "gnus-dormant-%s" (user-login-name)))
16449 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
16450 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
16453 In this case, you would not want the per-user dormant flag showing up
16454 as ticked for other users.
16456 @item nnimap-expunge-search-string
16458 @vindex nnimap-expunge-search-string
16460 This variable contain the @acronym{IMAP} search command sent to server when
16461 searching for articles eligible for expiring. The default is
16462 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
16463 UID set and the second @code{%s} is replaced by a date.
16465 Probably the only useful value to change this to is
16466 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
16467 messages instead of the internal article date. See section 6.4.4 of
16468 RFC 2060 for more information on valid strings.
16470 @item nnimap-authinfo-file
16471 @vindex nnimap-authinfo-file
16473 A file containing credentials used to log in on servers. The format is
16474 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
16475 variable @code{nntp-authinfo-file} for exact syntax; also see
16476 @ref{NNTP}. An example of an .authinfo line for an IMAP server, is:
16479 machine students.uio.no login larsi password geheimnis port imap
16482 Note that it should be @code{port imap}, or @code{port 143}, if you
16483 use a @code{nnimap-stream} of @code{tls} or @code{ssl}, even if the
16484 actual port number used is port 993 for secured IMAP. For
16485 convenience, Gnus will accept @code{port imaps} as a synonym of
16488 @item nnimap-need-unselect-to-notice-new-mail
16489 @vindex nnimap-need-unselect-to-notice-new-mail
16491 Unselect mailboxes before looking for new mail in them. Some servers
16492 seem to need this under some circumstances; it was reported that
16498 * Splitting in IMAP:: Splitting mail with nnimap.
16499 * Expiring in IMAP:: Expiring mail with nnimap.
16500 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
16501 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
16502 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
16503 * Debugging IMAP:: What to do when things don't work.
16508 @node Splitting in IMAP
16509 @subsection Splitting in IMAP
16510 @cindex splitting imap mail
16512 Splitting is something Gnus users have loved and used for years, and now
16513 the rest of the world is catching up. Yeah, dream on, not many
16514 @acronym{IMAP} servers have server side splitting and those that have
16515 splitting seem to use some non-standard protocol. This means that
16516 @acronym{IMAP} support for Gnus has to do its own splitting.
16520 (Incidentally, people seem to have been dreaming on, and Sieve has
16521 gaining a market share and is supported by several IMAP servers.
16522 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
16524 Here are the variables of interest:
16528 @item nnimap-split-crosspost
16529 @cindex splitting, crosspost
16531 @vindex nnimap-split-crosspost
16533 If non-@code{nil}, do crossposting if several split methods match the
16534 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
16535 found will be used.
16537 Nnmail equivalent: @code{nnmail-crosspost}.
16539 @item nnimap-split-inbox
16540 @cindex splitting, inbox
16542 @vindex nnimap-split-inbox
16544 A string or a list of strings that gives the name(s) of @acronym{IMAP}
16545 mailboxes to split from. Defaults to @code{nil}, which means that
16546 splitting is disabled!
16549 (setq nnimap-split-inbox
16550 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
16553 No nnmail equivalent.
16555 @item nnimap-split-rule
16556 @cindex splitting, rules
16557 @vindex nnimap-split-rule
16559 New mail found in @code{nnimap-split-inbox} will be split according to
16562 This variable contains a list of lists, where the first element in the
16563 sublist gives the name of the @acronym{IMAP} mailbox to move articles
16564 matching the regexp in the second element in the sublist. Got that?
16565 Neither did I, we need examples.
16568 (setq nnimap-split-rule
16570 "^Sender: owner-nnimap@@vic20.globalcom.se")
16571 ("INBOX.junk" "^Subject:.*MAKE MONEY")
16572 ("INBOX.private" "")))
16575 This will put all articles from the nnimap mailing list into mailbox
16576 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
16577 into INBOX.junk and everything else in INBOX.private.
16579 The first string may contain @samp{\\1} forms, like the ones used by
16580 replace-match to insert sub-expressions from the matched text. For
16584 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
16587 The first element can also be the symbol @code{junk} to indicate that
16588 matching messages should simply be deleted. Use with care.
16590 The second element can also be a function. In that case, it will be
16591 called with the first element of the rule as the argument, in a buffer
16592 containing the headers of the article. It should return a
16593 non-@code{nil} value if it thinks that the mail belongs in that group.
16595 Nnmail users might recollect that the last regexp had to be empty to
16596 match all articles (like in the example above). This is not required in
16597 nnimap. Articles not matching any of the regexps will not be moved out
16598 of your inbox. (This might affect performance if you keep lots of
16599 unread articles in your inbox, since the splitting code would go over
16600 them every time you fetch new mail.)
16602 These rules are processed from the beginning of the alist toward the
16603 end. The first rule to make a match will ``win'', unless you have
16604 crossposting enabled. In that case, all matching rules will ``win''.
16606 This variable can also have a function as its value, the function will
16607 be called with the headers narrowed and should return a group where it
16608 thinks the article should be split to. See @code{nnimap-split-fancy}.
16610 The splitting code tries to create mailboxes if it needs to.
16612 To allow for different split rules on different virtual servers, and
16613 even different split rules in different inboxes on the same server,
16614 the syntax of this variable have been extended along the lines of:
16617 (setq nnimap-split-rule
16618 '(("my1server" (".*" (("ding" "ding@@gnus.org")
16619 ("junk" "From:.*Simon"))))
16620 ("my2server" ("INBOX" nnimap-split-fancy))
16621 ("my[34]server" (".*" (("private" "To:.*Simon")
16622 ("junk" my-junk-func))))))
16625 The virtual server name is in fact a regexp, so that the same rules
16626 may apply to several servers. In the example, the servers
16627 @code{my3server} and @code{my4server} both use the same rules.
16628 Similarly, the inbox string is also a regexp. The actual splitting
16629 rules are as before, either a function, or a list with group/regexp or
16630 group/function elements.
16632 Nnmail equivalent: @code{nnmail-split-methods}.
16634 @item nnimap-split-predicate
16636 @vindex nnimap-split-predicate
16638 Mail matching this predicate in @code{nnimap-split-inbox} will be
16639 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
16641 This might be useful if you use another @acronym{IMAP} client to read mail in
16642 your inbox but would like Gnus to split all articles in the inbox
16643 regardless of readedness. Then you might change this to
16646 @item nnimap-split-fancy
16647 @cindex splitting, fancy
16648 @findex nnimap-split-fancy
16649 @vindex nnimap-split-fancy
16651 It's possible to set @code{nnimap-split-rule} to
16652 @code{nnmail-split-fancy} if you want to use fancy
16653 splitting. @xref{Fancy Mail Splitting}.
16655 However, to be able to have different fancy split rules for nnmail and
16656 nnimap back ends you can set @code{nnimap-split-rule} to
16657 @code{nnimap-split-fancy} and define the nnimap specific fancy split
16658 rule in @code{nnimap-split-fancy}.
16663 (setq nnimap-split-rule 'nnimap-split-fancy
16664 nnimap-split-fancy ...)
16667 Nnmail equivalent: @code{nnmail-split-fancy}.
16669 @item nnimap-split-download-body
16670 @findex nnimap-split-download-body
16671 @vindex nnimap-split-download-body
16673 Set to non-@code{nil} to download entire articles during splitting.
16674 This is generally not required, and will slow things down
16675 considerably. You may need it if you want to use an advanced
16676 splitting function that analyzes the body to split the article.
16680 @node Expiring in IMAP
16681 @subsection Expiring in IMAP
16682 @cindex expiring imap mail
16684 Even though @code{nnimap} is not a proper @code{nnmail} derived back
16685 end, it supports most features in regular expiring (@pxref{Expiring
16686 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
16687 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
16688 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
16689 follows below are the variables used by the @code{nnimap} expiry
16692 A note on how the expire mark is stored on the @acronym{IMAP} server is
16693 appropriate here as well. The expire mark is translated into a
16694 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
16695 message. This means that likely only Gnus will understand and treat
16696 the @code{gnus-expire} mark properly, although other clients may allow
16697 you to view client specific flags on the message. It also means that
16698 your server must support permanent storage of client specific flags on
16699 messages. Most do, fortunately.
16703 @item nnmail-expiry-wait
16704 @item nnmail-expiry-wait-function
16706 These variables are fully supported. The expire value can be a
16707 number, the symbol @code{immediate} or @code{never}.
16709 @item nnmail-expiry-target
16711 This variable is supported, and internally implemented by calling the
16712 @code{nnmail} functions that handle this. It contains an optimization
16713 that if the destination is a @acronym{IMAP} group on the same server, the
16714 article is copied instead of appended (that is, uploaded again).
16718 @node Editing IMAP ACLs
16719 @subsection Editing IMAP ACLs
16720 @cindex editing imap acls
16721 @cindex Access Control Lists
16722 @cindex Editing @acronym{IMAP} ACLs
16723 @kindex G l (Group)
16724 @findex gnus-group-nnimap-edit-acl
16726 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
16727 limiting (or enabling) other users access to your mail boxes. Not all
16728 @acronym{IMAP} servers support this, this function will give an error if it
16731 To edit an ACL for a mailbox, type @kbd{G l}
16732 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
16733 editing window with detailed instructions.
16735 Some possible uses:
16739 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
16740 on your mailing list mailboxes enables other users on the same server to
16741 follow the list without subscribing to it.
16743 At least with the Cyrus server, you are required to give the user
16744 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
16745 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
16749 @node Expunging mailboxes
16750 @subsection Expunging mailboxes
16754 @cindex manual expunging
16755 @kindex G x (Group)
16756 @findex gnus-group-nnimap-expunge
16758 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
16759 you may want the option of expunging all deleted articles in a mailbox
16760 manually. This is exactly what @kbd{G x} does.
16762 Currently there is no way of showing deleted articles, you can just
16765 @node A note on namespaces
16766 @subsection A note on namespaces
16767 @cindex IMAP namespace
16770 The @acronym{IMAP} protocol has a concept called namespaces, described
16771 by the following text in the RFC:
16774 5.1.2. Mailbox Namespace Naming Convention
16776 By convention, the first hierarchical element of any mailbox name
16777 which begins with "#" identifies the "namespace" of the remainder of
16778 the name. This makes it possible to disambiguate between different
16779 types of mailbox stores, each of which have their own namespaces.
16781 For example, implementations which offer access to USENET
16782 newsgroups MAY use the "#news" namespace to partition the USENET
16783 newsgroup namespace from that of other mailboxes. Thus, the
16784 comp.mail.misc newsgroup would have an mailbox name of
16785 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
16786 to a different object (e.g. a user's private mailbox).
16789 While there is nothing in this text that warrants concern for the
16790 @acronym{IMAP} implementation in Gnus, some servers use namespace
16791 prefixes in a way that does not work with how Gnus uses mailbox names.
16793 Specifically, University of Washington's @acronym{IMAP} server uses
16794 mailbox names like @code{#driver.mbx/read-mail} which are valid only
16795 in the @sc{create} and @sc{append} commands. After the mailbox is
16796 created (or a messages is appended to a mailbox), it must be accessed
16797 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
16798 not make it possible for the user to guarantee that user entered
16799 mailbox names will only be used with the CREATE and APPEND commands,
16800 you should simply not use the namespace prefixed mailbox names in
16803 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
16804 for more information on how to use the prefixes. They are a power
16805 tool and should be used only if you are sure what the effects are.
16807 @node Debugging IMAP
16808 @subsection Debugging IMAP
16809 @cindex IMAP debugging
16810 @cindex protocol dump (IMAP)
16812 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
16813 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
16814 best to fix them right away. If you encounter odd behavior, chances
16815 are that either the server or Gnus is buggy.
16817 If you are familiar with network protocols in general, you will
16818 probably be able to extract some clues from the protocol dump of the
16819 exchanges between Gnus and the server. Even if you are not familiar
16820 with network protocols, when you include the protocol dump in
16821 @acronym{IMAP}-related bug reports you are helping us with data
16822 critical to solving the problem. Therefore, we strongly encourage you
16823 to include the protocol dump when reporting IMAP bugs in Gnus.
16827 Because the protocol dump, when enabled, generates lots of data, it is
16828 disabled by default. You can enable it by setting @code{imap-log} as
16835 This instructs the @code{imap.el} package to log any exchanges with
16836 the server. The log is stored in the buffer @samp{*imap-log*}. Look
16837 for error messages, which sometimes are tagged with the keyword
16838 @code{BAD}---but when submitting a bug, make sure to include all the
16841 @node Other Sources
16842 @section Other Sources
16844 Gnus can do more than just read news or mail. The methods described
16845 below allow Gnus to view directories and files as if they were
16849 * Directory Groups:: You can read a directory as if it was a newsgroup.
16850 * Anything Groups:: Dired? Who needs dired?
16851 * Document Groups:: Single files can be the basis of a group.
16852 * SOUP:: Reading @sc{soup} packets ``offline''.
16853 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
16857 @node Directory Groups
16858 @subsection Directory Groups
16860 @cindex directory groups
16862 If you have a directory that has lots of articles in separate files in
16863 it, you might treat it as a newsgroup. The files have to have numerical
16866 This might be an opportune moment to mention @code{ange-ftp} (and its
16867 successor @code{efs}), that most wonderful of all wonderful Emacs
16868 packages. When I wrote @code{nndir}, I didn't think much about it---a
16869 back end to read directories. Big deal.
16871 @code{ange-ftp} changes that picture dramatically. For instance, if you
16872 enter the @code{ange-ftp} file name
16873 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
16874 @code{ange-ftp} or @code{efs} will actually allow you to read this
16875 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
16877 @code{nndir} will use @acronym{NOV} files if they are present.
16879 @code{nndir} is a ``read-only'' back end---you can't delete or expire
16880 articles with this method. You can use @code{nnmh} or @code{nnml} for
16881 whatever you use @code{nndir} for, so you could switch to any of those
16882 methods if you feel the need to have a non-read-only @code{nndir}.
16885 @node Anything Groups
16886 @subsection Anything Groups
16889 From the @code{nndir} back end (which reads a single spool-like
16890 directory), it's just a hop and a skip to @code{nneething}, which
16891 pretends that any arbitrary directory is a newsgroup. Strange, but
16894 When @code{nneething} is presented with a directory, it will scan this
16895 directory and assign article numbers to each file. When you enter such
16896 a group, @code{nneething} must create ``headers'' that Gnus can use.
16897 After all, Gnus is a newsreader, in case you're forgetting.
16898 @code{nneething} does this in a two-step process. First, it snoops each
16899 file in question. If the file looks like an article (i.e., the first
16900 few lines look like headers), it will use this as the head. If this is
16901 just some arbitrary file without a head (e.g. a C source file),
16902 @code{nneething} will cobble up a header out of thin air. It will use
16903 file ownership, name and date and do whatever it can with these
16906 All this should happen automatically for you, and you will be presented
16907 with something that looks very much like a newsgroup. Totally like a
16908 newsgroup, to be precise. If you select an article, it will be displayed
16909 in the article buffer, just as usual.
16911 If you select a line that represents a directory, Gnus will pop you into
16912 a new summary buffer for this @code{nneething} group. And so on. You can
16913 traverse the entire disk this way, if you feel like, but remember that
16914 Gnus is not dired, really, and does not intend to be, either.
16916 There are two overall modes to this action---ephemeral or solid. When
16917 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
16918 will not store information on what files you have read, and what files
16919 are new, and so on. If you create a solid @code{nneething} group the
16920 normal way with @kbd{G m}, Gnus will store a mapping table between
16921 article numbers and file names, and you can treat this group like any
16922 other groups. When you activate a solid @code{nneething} group, you will
16923 be told how many unread articles it contains, etc., etc.
16928 @item nneething-map-file-directory
16929 @vindex nneething-map-file-directory
16930 All the mapping files for solid @code{nneething} groups will be stored
16931 in this directory, which defaults to @file{~/.nneething/}.
16933 @item nneething-exclude-files
16934 @vindex nneething-exclude-files
16935 All files that match this regexp will be ignored. Nice to use to exclude
16936 auto-save files and the like, which is what it does by default.
16938 @item nneething-include-files
16939 @vindex nneething-include-files
16940 Regexp saying what files to include in the group. If this variable is
16941 non-@code{nil}, only files matching this regexp will be included.
16943 @item nneething-map-file
16944 @vindex nneething-map-file
16945 Name of the map files.
16949 @node Document Groups
16950 @subsection Document Groups
16952 @cindex documentation group
16955 @code{nndoc} is a cute little thing that will let you read a single file
16956 as a newsgroup. Several files types are supported:
16963 The Babyl (Rmail) mail box.
16968 The standard Unix mbox file.
16970 @cindex MMDF mail box
16972 The MMDF mail box format.
16975 Several news articles appended into a file.
16978 @cindex rnews batch files
16979 The rnews batch transport format.
16980 @cindex forwarded messages
16983 Forwarded articles.
16986 Netscape mail boxes.
16989 @acronym{MIME} multipart messages.
16991 @item standard-digest
16992 The standard (RFC 1153) digest format.
16995 A @acronym{MIME} digest of messages.
16997 @item lanl-gov-announce
16998 Announcement messages from LANL Gov Announce.
17000 @item rfc822-forward
17001 A message forwarded according to RFC822.
17004 The Outlook mail box.
17007 The Outlook Express dbx mail box.
17010 A bounce message from the Exim MTA.
17013 A message forwarded according to informal rules.
17016 An RFC934-forwarded message.
17022 A digest of Clarinet brief news items.
17025 Non-standard digest format---matches most things, but does it badly.
17031 You can also use the special ``file type'' @code{guess}, which means
17032 that @code{nndoc} will try to guess what file type it is looking at.
17033 @code{digest} means that @code{nndoc} should guess what digest type the
17036 @code{nndoc} will not try to change the file or insert any extra headers into
17037 it---it will simply, like, let you use the file as the basis for a
17038 group. And that's it.
17040 If you have some old archived articles that you want to insert into your
17041 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
17042 that. Say you have an old @file{RMAIL} file with mail that you now want
17043 to split into your new @code{nnml} groups. You look at that file using
17044 @code{nndoc} (using the @kbd{G f} command in the group buffer
17045 (@pxref{Foreign Groups})), set the process mark on all the articles in
17046 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
17047 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
17048 file is now also stored in lots of @code{nnml} directories, and you can
17049 delete that pesky @file{RMAIL} file. If you have the guts!
17051 Virtual server variables:
17054 @item nndoc-article-type
17055 @vindex nndoc-article-type
17056 This should be one of @code{mbox}, @code{babyl}, @code{digest},
17057 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
17058 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
17059 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
17060 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
17062 @item nndoc-post-type
17063 @vindex nndoc-post-type
17064 This variable says whether Gnus is to consider the group a news group or
17065 a mail group. There are two valid values: @code{mail} (the default)
17070 * Document Server Internals:: How to add your own document types.
17074 @node Document Server Internals
17075 @subsubsection Document Server Internals
17077 Adding new document types to be recognized by @code{nndoc} isn't
17078 difficult. You just have to whip up a definition of what the document
17079 looks like, write a predicate function to recognize that document type,
17080 and then hook into @code{nndoc}.
17082 First, here's an example document type definition:
17086 (article-begin . "^\^A\^A\^A\^A\n")
17087 (body-end . "^\^A\^A\^A\^A\n"))
17090 The definition is simply a unique @dfn{name} followed by a series of
17091 regexp pseudo-variable settings. Below are the possible
17092 variables---don't be daunted by the number of variables; most document
17093 types can be defined with very few settings:
17096 @item first-article
17097 If present, @code{nndoc} will skip past all text until it finds
17098 something that match this regexp. All text before this will be
17101 @item article-begin
17102 This setting has to be present in all document type definitions. It
17103 says what the beginning of each article looks like.
17105 @item head-begin-function
17106 If present, this should be a function that moves point to the head of
17109 @item nndoc-head-begin
17110 If present, this should be a regexp that matches the head of the
17113 @item nndoc-head-end
17114 This should match the end of the head of the article. It defaults to
17115 @samp{^$}---the empty line.
17117 @item body-begin-function
17118 If present, this function should move point to the beginning of the body
17122 This should match the beginning of the body of the article. It defaults
17125 @item body-end-function
17126 If present, this function should move point to the end of the body of
17130 If present, this should match the end of the body of the article.
17133 If present, this should match the end of the file. All text after this
17134 regexp will be totally ignored.
17138 So, using these variables @code{nndoc} is able to dissect a document
17139 file into a series of articles, each with a head and a body. However, a
17140 few more variables are needed since not all document types are all that
17141 news-like---variables needed to transform the head or the body into
17142 something that's palatable for Gnus:
17145 @item prepare-body-function
17146 If present, this function will be called when requesting an article. It
17147 will be called with point at the start of the body, and is useful if the
17148 document has encoded some parts of its contents.
17150 @item article-transform-function
17151 If present, this function is called when requesting an article. It's
17152 meant to be used for more wide-ranging transformation of both head and
17153 body of the article.
17155 @item generate-head-function
17156 If present, this function is called to generate a head that Gnus can
17157 understand. It is called with the article number as a parameter, and is
17158 expected to generate a nice head for the article in question. It is
17159 called when requesting the headers of all articles.
17163 Let's look at the most complicated example I can come up with---standard
17168 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
17169 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
17170 (prepare-body-function . nndoc-unquote-dashes)
17171 (body-end-function . nndoc-digest-body-end)
17172 (head-end . "^ ?$")
17173 (body-begin . "^ ?\n")
17174 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
17175 (subtype digest guess))
17178 We see that all text before a 70-width line of dashes is ignored; all
17179 text after a line that starts with that @samp{^End of} is also ignored;
17180 each article begins with a 30-width line of dashes; the line separating
17181 the head from the body may contain a single space; and that the body is
17182 run through @code{nndoc-unquote-dashes} before being delivered.
17184 To hook your own document definition into @code{nndoc}, use the
17185 @code{nndoc-add-type} function. It takes two parameters---the first
17186 is the definition itself and the second (optional) parameter says
17187 where in the document type definition alist to put this definition.
17188 The alist is traversed sequentially, and
17189 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
17190 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
17191 @code{mmdf} type, and so on. These type predicates should return
17192 @code{nil} if the document is not of the correct type; @code{t} if it
17193 is of the correct type; and a number if the document might be of the
17194 correct type. A high number means high probability; a low number
17195 means low probability with @samp{0} being the lowest valid number.
17203 In the PC world people often talk about ``offline'' newsreaders. These
17204 are thingies that are combined reader/news transport monstrosities.
17205 With built-in modem programs. Yecchh!
17207 Of course, us Unix Weenie types of human beans use things like
17208 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
17209 transport things like Ghod intended. And then we just use normal
17212 However, it can sometimes be convenient to do something that's a bit
17213 easier on the brain if you have a very slow modem, and you're not really
17214 that interested in doing things properly.
17216 A file format called @sc{soup} has been developed for transporting news
17217 and mail from servers to home machines and back again. It can be a bit
17220 First some terminology:
17225 This is the machine that is connected to the outside world and where you
17226 get news and/or mail from.
17229 This is the machine that you want to do the actual reading and responding
17230 on. It is typically not connected to the rest of the world in any way.
17233 Something that contains messages and/or commands. There are two kinds
17237 @item message packets
17238 These are packets made at the server, and typically contain lots of
17239 messages for you to read. These are called @file{SoupoutX.tgz} by
17240 default, where @var{x} is a number.
17242 @item response packets
17243 These are packets made at the home machine, and typically contains
17244 replies that you've written. These are called @file{SoupinX.tgz} by
17245 default, where @var{x} is a number.
17255 You log in on the server and create a @sc{soup} packet. You can either
17256 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
17257 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
17258 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
17261 You transfer the packet home. Rail, boat, car or modem will do fine.
17264 You put the packet in your home directory.
17267 You fire up Gnus on your home machine using the @code{nnsoup} back end as
17268 the native or secondary server.
17271 You read articles and mail and answer and followup to the things you
17272 want (@pxref{SOUP Replies}).
17275 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
17279 You transfer this packet to the server.
17282 You use Gnus to mail this packet out with the @kbd{G s s} command.
17285 You then repeat until you die.
17289 So you basically have a bipartite system---you use @code{nnsoup} for
17290 reading and Gnus for packing/sending these @sc{soup} packets.
17293 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
17294 * SOUP Groups:: A back end for reading @sc{soup} packets.
17295 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
17299 @node SOUP Commands
17300 @subsubsection SOUP Commands
17302 These are commands for creating and manipulating @sc{soup} packets.
17306 @kindex G s b (Group)
17307 @findex gnus-group-brew-soup
17308 Pack all unread articles in the current group
17309 (@code{gnus-group-brew-soup}). This command understands the
17310 process/prefix convention.
17313 @kindex G s w (Group)
17314 @findex gnus-soup-save-areas
17315 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
17318 @kindex G s s (Group)
17319 @findex gnus-soup-send-replies
17320 Send all replies from the replies packet
17321 (@code{gnus-soup-send-replies}).
17324 @kindex G s p (Group)
17325 @findex gnus-soup-pack-packet
17326 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
17329 @kindex G s r (Group)
17330 @findex nnsoup-pack-replies
17331 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
17334 @kindex O s (Summary)
17335 @findex gnus-soup-add-article
17336 This summary-mode command adds the current article to a @sc{soup} packet
17337 (@code{gnus-soup-add-article}). It understands the process/prefix
17338 convention (@pxref{Process/Prefix}).
17343 There are a few variables to customize where Gnus will put all these
17348 @item gnus-soup-directory
17349 @vindex gnus-soup-directory
17350 Directory where Gnus will save intermediate files while composing
17351 @sc{soup} packets. The default is @file{~/SoupBrew/}.
17353 @item gnus-soup-replies-directory
17354 @vindex gnus-soup-replies-directory
17355 This is what Gnus will use as a temporary directory while sending our
17356 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
17358 @item gnus-soup-prefix-file
17359 @vindex gnus-soup-prefix-file
17360 Name of the file where Gnus stores the last used prefix. The default is
17361 @samp{gnus-prefix}.
17363 @item gnus-soup-packer
17364 @vindex gnus-soup-packer
17365 A format string command for packing a @sc{soup} packet. The default is
17366 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
17368 @item gnus-soup-unpacker
17369 @vindex gnus-soup-unpacker
17370 Format string command for unpacking a @sc{soup} packet. The default is
17371 @samp{gunzip -c %s | tar xvf -}.
17373 @item gnus-soup-packet-directory
17374 @vindex gnus-soup-packet-directory
17375 Where Gnus will look for reply packets. The default is @file{~/}.
17377 @item gnus-soup-packet-regexp
17378 @vindex gnus-soup-packet-regexp
17379 Regular expression matching @sc{soup} reply packets in
17380 @code{gnus-soup-packet-directory}.
17386 @subsubsection SOUP Groups
17389 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
17390 read incoming packets, unpack them, and put them in a directory where
17391 you can read them at leisure.
17393 These are the variables you can use to customize its behavior:
17397 @item nnsoup-tmp-directory
17398 @vindex nnsoup-tmp-directory
17399 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
17400 directory. (@file{/tmp/} by default.)
17402 @item nnsoup-directory
17403 @vindex nnsoup-directory
17404 @code{nnsoup} then moves each message and index file to this directory.
17405 The default is @file{~/SOUP/}.
17407 @item nnsoup-replies-directory
17408 @vindex nnsoup-replies-directory
17409 All replies will be stored in this directory before being packed into a
17410 reply packet. The default is @file{~/SOUP/replies/}.
17412 @item nnsoup-replies-format-type
17413 @vindex nnsoup-replies-format-type
17414 The @sc{soup} format of the replies packets. The default is @samp{?n}
17415 (rnews), and I don't think you should touch that variable. I probably
17416 shouldn't even have documented it. Drats! Too late!
17418 @item nnsoup-replies-index-type
17419 @vindex nnsoup-replies-index-type
17420 The index type of the replies packet. The default is @samp{?n}, which
17421 means ``none''. Don't fiddle with this one either!
17423 @item nnsoup-active-file
17424 @vindex nnsoup-active-file
17425 Where @code{nnsoup} stores lots of information. This is not an ``active
17426 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
17427 this file or mess it up in any way, you're dead. The default is
17428 @file{~/SOUP/active}.
17430 @item nnsoup-packer
17431 @vindex nnsoup-packer
17432 Format string command for packing a reply @sc{soup} packet. The default
17433 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
17435 @item nnsoup-unpacker
17436 @vindex nnsoup-unpacker
17437 Format string command for unpacking incoming @sc{soup} packets. The
17438 default is @samp{gunzip -c %s | tar xvf -}.
17440 @item nnsoup-packet-directory
17441 @vindex nnsoup-packet-directory
17442 Where @code{nnsoup} will look for incoming packets. The default is
17445 @item nnsoup-packet-regexp
17446 @vindex nnsoup-packet-regexp
17447 Regular expression matching incoming @sc{soup} packets. The default is
17450 @item nnsoup-always-save
17451 @vindex nnsoup-always-save
17452 If non-@code{nil}, save the replies buffer after each posted message.
17458 @subsubsection SOUP Replies
17460 Just using @code{nnsoup} won't mean that your postings and mailings end
17461 up in @sc{soup} reply packets automagically. You have to work a bit
17462 more for that to happen.
17464 @findex nnsoup-set-variables
17465 The @code{nnsoup-set-variables} command will set the appropriate
17466 variables to ensure that all your followups and replies end up in the
17469 In specific, this is what it does:
17472 (setq message-send-news-function 'nnsoup-request-post)
17473 (setq message-send-mail-function 'nnsoup-request-mail)
17476 And that's it, really. If you only want news to go into the @sc{soup}
17477 system you just use the first line. If you only want mail to be
17478 @sc{soup}ed you use the second.
17481 @node Mail-To-News Gateways
17482 @subsection Mail-To-News Gateways
17483 @cindex mail-to-news gateways
17486 If your local @code{nntp} server doesn't allow posting, for some reason
17487 or other, you can post using one of the numerous mail-to-news gateways.
17488 The @code{nngateway} back end provides the interface.
17490 Note that you can't read anything from this back end---it can only be
17496 @item nngateway-address
17497 @vindex nngateway-address
17498 This is the address of the mail-to-news gateway.
17500 @item nngateway-header-transformation
17501 @vindex nngateway-header-transformation
17502 News headers often have to be transformed in some odd way or other
17503 for the mail-to-news gateway to accept it. This variable says what
17504 transformation should be called, and defaults to
17505 @code{nngateway-simple-header-transformation}. The function is called
17506 narrowed to the headers to be transformed and with one parameter---the
17509 This default function just inserts a new @code{To} header based on the
17510 @code{Newsgroups} header and the gateway address.
17511 For instance, an article with this @code{Newsgroups} header:
17514 Newsgroups: alt.religion.emacs
17517 will get this @code{To} header inserted:
17520 To: alt-religion-emacs@@GATEWAY
17523 The following pre-defined functions exist:
17525 @findex nngateway-simple-header-transformation
17528 @item nngateway-simple-header-transformation
17529 Creates a @code{To} header that looks like
17530 @var{newsgroup}@@@code{nngateway-address}.
17532 @findex nngateway-mail2news-header-transformation
17534 @item nngateway-mail2news-header-transformation
17535 Creates a @code{To} header that looks like
17536 @code{nngateway-address}.
17544 (setq gnus-post-method
17546 "mail2news@@replay.com"
17547 (nngateway-header-transformation
17548 nngateway-mail2news-header-transformation)))
17551 So, to use this, simply say something like:
17554 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17559 @node Combined Groups
17560 @section Combined Groups
17562 Gnus allows combining a mixture of all the other group types into bigger
17566 * Virtual Groups:: Combining articles from many groups.
17567 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
17571 @node Virtual Groups
17572 @subsection Virtual Groups
17574 @cindex virtual groups
17575 @cindex merging groups
17577 An @dfn{nnvirtual group} is really nothing more than a collection of
17580 For instance, if you are tired of reading many small groups, you can
17581 put them all in one big group, and then grow tired of reading one
17582 big, unwieldy group. The joys of computing!
17584 You specify @code{nnvirtual} as the method. The address should be a
17585 regexp to match component groups.
17587 All marks in the virtual group will stick to the articles in the
17588 component groups. So if you tick an article in a virtual group, the
17589 article will also be ticked in the component group from whence it
17590 came. (And vice versa---marks from the component groups will also be
17591 shown in the virtual group.). To create an empty virtual group, run
17592 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17593 and edit the method regexp with @kbd{M-e}
17594 (@code{gnus-group-edit-group-method})
17596 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17597 newsgroups into one, big, happy newsgroup:
17600 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17603 The component groups can be native or foreign; everything should work
17604 smoothly, but if your computer explodes, it was probably my fault.
17606 Collecting the same group from several servers might actually be a good
17607 idea if users have set the Distribution header to limit distribution.
17608 If you would like to read @samp{soc.motss} both from a server in Japan
17609 and a server in Norway, you could use the following as the group regexp:
17612 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17615 (Remember, though, that if you're creating the group with @kbd{G m}, you
17616 shouldn't double the backslashes, and you should leave off the quote
17617 characters at the beginning and the end of the string.)
17619 This should work kinda smoothly---all articles from both groups should
17620 end up in this one, and there should be no duplicates. Threading (and
17621 the rest) will still work as usual, but there might be problems with the
17622 sequence of articles. Sorting on date might be an option here
17623 (@pxref{Selecting a Group}).
17625 One limitation, however---all groups included in a virtual
17626 group have to be alive (i.e., subscribed or unsubscribed). Killed or
17627 zombie groups can't be component groups for @code{nnvirtual} groups.
17629 @vindex nnvirtual-always-rescan
17630 If the @code{nnvirtual-always-rescan} is non-@code{nil},
17631 @code{nnvirtual} will always scan groups for unread articles when
17632 entering a virtual group. If this variable is @code{nil} (which is the
17633 default) and you read articles in a component group after the virtual
17634 group has been activated, the read articles from the component group
17635 will show up when you enter the virtual group. You'll also see this
17636 effect if you have two virtual groups that have a component group in
17637 common. If that's the case, you should set this variable to @code{t}.
17638 Or you can just tap @code{M-g} on the virtual group every time before
17639 you enter it---it'll have much the same effect.
17641 @code{nnvirtual} can have both mail and news groups as component groups.
17642 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17643 has to ask the back end of the component group the article comes from
17644 whether it is a news or mail back end. However, when you do a @kbd{^},
17645 there is typically no sure way for the component back end to know this,
17646 and in that case @code{nnvirtual} tells Gnus that the article came from a
17647 not-news back end. (Just to be on the safe side.)
17649 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17650 line from the article you respond to in these cases.
17652 @code{nnvirtual} groups do not inherit anything but articles and marks
17653 from component groups---group parameters, for instance, are not
17657 @node Kibozed Groups
17658 @subsection Kibozed Groups
17662 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
17663 (parts of) the news feed''. @code{nnkiboze} is a back end that will
17664 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
17665 down to a halt with useless requests! Oh happiness!
17667 @kindex G k (Group)
17668 To create a kibozed group, use the @kbd{G k} command in the group
17671 The address field of the @code{nnkiboze} method is, as with
17672 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
17673 @code{nnkiboze} group. That's where most similarities between
17674 @code{nnkiboze} and @code{nnvirtual} end.
17676 In addition to this regexp detailing component groups, an
17677 @code{nnkiboze} group must have a score file to say what articles are
17678 to be included in the group (@pxref{Scoring}).
17680 @kindex M-x nnkiboze-generate-groups
17681 @findex nnkiboze-generate-groups
17682 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
17683 @code{nnkiboze} groups you want to have. This command will take time.
17684 Lots of time. Oodles and oodles of time. Gnus has to fetch the
17685 headers from all the articles in all the component groups and run them
17686 through the scoring process to determine if there are any articles in
17687 the groups that are to be part of the @code{nnkiboze} groups.
17689 Please limit the number of component groups by using restrictive
17690 regexps. Otherwise your sysadmin may become annoyed with you, and the
17691 @acronym{NNTP} site may throw you off and never let you back in again.
17692 Stranger things have happened.
17694 @code{nnkiboze} component groups do not have to be alive---they can be dead,
17695 and they can be foreign. No restrictions.
17697 @vindex nnkiboze-directory
17698 The generation of an @code{nnkiboze} group means writing two files in
17699 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
17700 One contains the @acronym{NOV} header lines for all the articles in
17701 the group, and the other is an additional @file{.newsrc} file to store
17702 information on what groups have been searched through to find
17703 component articles.
17705 Articles marked as read in the @code{nnkiboze} group will have
17706 their @acronym{NOV} lines removed from the @acronym{NOV} file.
17709 @node Email Based Diary
17710 @section Email Based Diary
17712 @cindex email based diary
17715 This section describes a special mail back end called @code{nndiary},
17716 and its companion library @code{gnus-diary}. It is ``special'' in the
17717 sense that it is not meant to be one of the standard alternatives for
17718 reading mail with Gnus. See @ref{Choosing a Mail Back End} for that.
17719 Instead, it is used to treat @emph{some} of your mails in a special way,
17720 namely, as event reminders.
17722 Here is a typical scenario:
17726 You've got a date with Andy Mc Dowell or Bruce Willis (select according
17727 to your sexual preference) in one month. You don't want to forget it.
17729 So you send a ``reminder'' message (actually, a diary one) to yourself.
17731 You forget all about it and keep on getting and reading new mail, as usual.
17733 From time to time, as you type `g' in the group buffer and as the date
17734 is getting closer, the message will pop up again to remind you of your
17735 appointment, just as if it were new and unread.
17737 Read your ``new'' messages, this one included, and start dreaming again
17738 of the night you're gonna have.
17740 Once the date is over (you actually fell asleep just after dinner), the
17741 message will be automatically deleted if it is marked as expirable.
17744 The Gnus Diary back end has the ability to handle regular appointments
17745 (that wouldn't ever be deleted) as well as punctual ones, operates as a
17746 real mail back end and is configurable in many ways. All of this is
17747 explained in the sections below.
17750 * The NNDiary Back End:: Basic setup and usage.
17751 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
17752 * Sending or Not Sending:: A final note on sending diary messages.
17756 @node The NNDiary Back End
17757 @subsection The NNDiary Back End
17759 @cindex the nndiary back end
17761 @code{nndiary} is a back end very similar to @code{nnml} (@pxref{Mail
17762 Spool}). Actually, it could appear as a mix of @code{nnml} and
17763 @code{nndraft}. If you know @code{nnml}, you're already familiar with
17764 the message storing scheme of @code{nndiary}: one file per message, one
17765 directory per group.
17767 Before anything, there is one requirement to be able to run
17768 @code{nndiary} properly: you @emph{must} use the group timestamp feature
17769 of Gnus. This adds a timestamp to each group's parameters. @ref{Group
17770 Timestamp} to see how it's done.
17773 * Diary Messages:: What makes a message valid for nndiary.
17774 * Running NNDiary:: NNDiary has two modes of operation.
17775 * Customizing NNDiary:: Bells and whistles.
17778 @node Diary Messages
17779 @subsubsection Diary Messages
17780 @cindex nndiary messages
17781 @cindex nndiary mails
17783 @code{nndiary} messages are just normal ones, except for the mandatory
17784 presence of 7 special headers. These headers are of the form
17785 @code{X-Diary-<something>}, @code{<something>} being one of
17786 @code{Minute}, @code{Hour}, @code{Dom}, @code{Month}, @code{Year},
17787 @code{Time-Zone} and @code{Dow}. @code{Dom} means ``Day of Month'', and
17788 @code{dow} means ``Day of Week''. These headers actually behave like
17789 crontab specifications and define the event date(s):
17793 For all headers except the @code{Time-Zone} one, a header value is
17794 either a star (meaning all possible values), or a list of fields
17795 (separated by a comma).
17797 A field is either an integer, or a range.
17799 A range is two integers separated by a dash.
17801 Possible integer values are 0--59 for @code{Minute}, 0--23 for
17802 @code{Hour}, 1--31 for @code{Dom}, 1--12 for @code{Month}, above 1971
17803 for @code{Year} and 0--6 for @code{Dow} (0 meaning Sunday).
17805 As a special case, a star in either @code{Dom} or @code{Dow} doesn't
17806 mean ``all possible values'', but ``use only the other field''. Note
17807 that if both are star'ed, the use of either one gives the same result.
17809 The @code{Time-Zone} header is special in that it can only have one
17810 value (@code{GMT}, for instance). A star doesn't mean ``all possible
17811 values'' (because it makes no sense), but ``the current local time
17812 zone''. Most of the time, you'll be using a star here. However, for a
17813 list of available time zone values, see the variable
17814 @code{nndiary-headers}.
17817 As a concrete example, here are the diary headers to add to your message
17818 for specifying ``Each Monday and each 1st of month, at 12:00, 20:00,
17819 21:00, 22:00, 23:00 and 24:00, from 1999 to 2010'' (I'll let you find
17824 X-Diary-Hour: 12, 20-24
17827 X-Diary-Year: 1999-2010
17829 X-Diary-Time-Zone: *
17832 @node Running NNDiary
17833 @subsubsection Running NNDiary
17834 @cindex running nndiary
17835 @cindex nndiary operation modes
17837 @code{nndiary} has two modes of operation: ``traditional'' (the default)
17838 and ``autonomous''. In traditional mode, @code{nndiary} does not get new
17839 mail by itself. You have to move (@kbd{B m}) or copy (@kbd{B c}) mails
17840 from your primary mail back end to nndiary groups in order to handle them
17841 as diary messages. In autonomous mode, @code{nndiary} retrieves its own
17842 mail and handles it independently from your primary mail back end.
17844 One should note that Gnus is not inherently designed to allow several
17845 ``master'' mail back ends at the same time. However, this does make
17846 sense with @code{nndiary}: you really want to send and receive diary
17847 messages to your diary groups directly. So, @code{nndiary} supports
17848 being sort of a ``second primary mail back end'' (to my knowledge, it is
17849 the only back end offering this feature). However, there is a limitation
17850 (which I hope to fix some day): respooling doesn't work in autonomous
17853 In order to use @code{nndiary} in autonomous mode, you have several
17858 Allow @code{nndiary} to retrieve new mail by itself. Put the following
17859 line in your @file{gnusrc} file:
17862 (setq nndiary-get-new-mail t)
17865 You must arrange for diary messages (those containing @code{X-Diary-*}
17866 headers) to be split in a private folder @emph{before} Gnus treat them.
17867 Again, this is needed because Gnus cannot (yet ?) properly handle
17868 multiple primary mail back ends. Getting those messages from a separate
17869 source will compensate this misfeature to some extent.
17871 As an example, here's my procmailrc entry to store diary files in
17872 @file{~/.nndiary} (the default @code{nndiary} mail source file):
17881 Once this is done, you might want to customize the following two options
17882 that affect the diary mail retrieval and splitting processes:
17884 @defvar nndiary-mail-sources
17885 This is the diary-specific replacement for the standard
17886 @code{mail-sources} variable. It obeys the same syntax, and defaults to
17887 @code{(file :path "~/.nndiary")}.
17890 @defvar nndiary-split-methods
17891 This is the diary-specific replacement for the standard
17892 @code{nnmail-split-methods} variable. It obeys the same syntax.
17895 Finally, you may add a permanent @code{nndiary} virtual server
17896 (something like @code{(nndiary "diary")} should do) to your
17897 @code{gnus-secondary-select-methods}.
17899 Hopefully, almost everything (see the TODO section in
17900 @file{nndiary.el}) will work as expected when you restart Gnus: in
17901 autonomous mode, typing @kbd{g} and @kbd{M-g} in the group buffer, will
17902 also get your new diary mails and split them according to your
17903 diary-specific rules, @kbd{F} will find your new diary groups etc.
17905 @node Customizing NNDiary
17906 @subsubsection Customizing NNDiary
17907 @cindex customizing nndiary
17908 @cindex nndiary customization
17910 Now that @code{nndiary} is up and running, it's time to customize it.
17911 The custom group is called @code{nndiary} (no, really ?!). You should
17912 browse it to figure out which options you'd like to tweak. The following
17913 two variables are probably the only ones you will want to change:
17915 @defvar nndiary-reminders
17916 This is the list of times when you want to be reminded of your
17917 appointements (e.g. 3 weeks before, then 2 days before, then 1 hour
17918 before and that's it). Remember that ``being reminded'' means that the
17919 diary message will pop up as brand new and unread again when you get new
17923 @defvar nndiary-week-starts-on-monday
17924 Rather self-explanatory. Otherwise, Sunday is assumed (this is the
17929 @node The Gnus Diary Library
17930 @subsection The Gnus Diary Library
17932 @cindex the gnus diary library
17934 Using @code{nndiary} manually (I mean, writing the headers by hand and
17935 so on) would be rather boring. Fortunately, there is a library called
17936 @code{gnus-diary} written on top of @code{nndiary}, that does many
17937 useful things for you.
17939 In order to use it, add the following line to your @file{gnusrc} file:
17942 (require 'gnus-diary)
17945 Also, you shouldn't use any @code{gnus-user-format-function-[d|D]}
17946 (@pxref{Summary Buffer Lines}). @code{gnus-diary} provides both of these
17947 (sorry if you used them before).
17951 * Diary Summary Line Format:: A nicer summary buffer line format.
17952 * Diary Articles Sorting:: A nicer way to sort messages.
17953 * Diary Headers Generation:: Not doing it manually.
17954 * Diary Group Parameters:: Not handling them manually.
17957 @node Diary Summary Line Format
17958 @subsubsection Diary Summary Line Format
17959 @cindex diary summary buffer line
17960 @cindex diary summary line format
17962 Displaying diary messages in standard summary line format (usually
17963 something like @samp{From Joe: Subject}) is pretty useless. Most of
17964 the time, you're the one who wrote the message, and you mostly want to
17965 see the event's date.
17967 @code{gnus-diary} provides two supplemental user formats to be used in
17968 summary line formats. @code{D} corresponds to a formatted time string
17969 for the next occurrence of the event (e.g. ``Sat, Sep 22 01, 12:00''),
17970 while @code{d} corresponds to an approximative remaining time until the
17971 next occurrence of the event (e.g. ``in 6 months, 1 week'').
17973 For example, here's how Joe's birthday is displayed in my
17974 @code{nndiary+diary:birthdays} summary buffer (note that the message is
17975 expirable, but will never be deleted, as it specifies a periodic event):
17978 E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week)
17981 In order to get something like the above, you would normally add the
17982 following line to your diary groups'parameters:
17985 (gnus-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n")
17988 However, @code{gnus-diary} does it automatically (@pxref{Diary Group
17989 Parameters}). You can however customize the provided summary line format
17990 with the following user options:
17992 @defvar gnus-diary-summary-line-format
17993 Defines the summary line format used for diary groups (@pxref{Summary
17994 Buffer Lines}). @code{gnus-diary} uses it to automatically update the
17995 diary groups'parameters.
17998 @defvar gnus-diary-time-format
17999 Defines the format to display dates in diary summary buffers. This is
18000 used by the @code{D} user format. See the docstring for details.
18003 @defvar gnus-diary-delay-format-function
18004 Defines the format function to use for displaying delays (remaining
18005 times) in diary summary buffers. This is used by the @code{d} user
18006 format. There are currently built-in functions for English and French;
18007 you can also define your own. See the docstring for details.
18010 @node Diary Articles Sorting
18011 @subsubsection Diary Articles Sorting
18012 @cindex diary articles sorting
18013 @cindex diary summary lines sorting
18014 @findex gnus-summary-sort-by-schedule
18015 @findex gnus-thread-sort-by-schedule
18016 @findex gnus-article-sort-by-schedule
18018 @code{gnus-diary} provides new sorting functions (@pxref{Sorting the
18019 Summary Buffer} ) called @code{gnus-summary-sort-by-schedule},
18020 @code{gnus-thread-sort-by-schedule} and
18021 @code{gnus-article-sort-by-schedule}. These functions let you organize
18022 your diary summary buffers from the closest event to the farthest one.
18024 @code{gnus-diary} automatically installs
18025 @code{gnus-summary-sort-by-schedule} as a menu item in the summary
18026 buffer's ``sort'' menu, and the two others as the primary (hence
18027 default) sorting functions in the group parameters (@pxref{Diary Group
18030 @node Diary Headers Generation
18031 @subsubsection Diary Headers Generation
18032 @cindex diary headers generation
18033 @findex gnus-diary-check-message
18035 @code{gnus-diary} provides a function called
18036 @code{gnus-diary-check-message} to help you handle the @code{X-Diary-*}
18037 headers. This function ensures that the current message contains all the
18038 required diary headers, and prompts you for values or corrections if
18041 This function is hooked into the @code{nndiary} back end, so that
18042 moving or copying an article to a diary group will trigger it
18043 automatically. It is also bound to @kbd{C-c D c} in @code{message-mode}
18044 and @code{article-edit-mode} in order to ease the process of converting
18045 a usual mail to a diary one.
18047 This function takes a prefix argument which will force prompting of
18048 all diary headers, regardless of their presence or validity. That way,
18049 you can very easily reschedule an already valid diary message, for
18052 @node Diary Group Parameters
18053 @subsubsection Diary Group Parameters
18054 @cindex diary group parameters
18056 When you create a new diary group, or visit one, @code{gnus-diary}
18057 automatically checks your group parameters and if needed, sets the
18058 summary line format to the diary-specific value, installs the
18059 diary-specific sorting functions, and also adds the different
18060 @code{X-Diary-*} headers to the group's posting-style. It is then easier
18061 to send a diary message, because if you use @kbd{C-u a} or @kbd{C-u m}
18062 on a diary group to prepare a message, these headers will be inserted
18063 automatically (although not filled with proper values yet).
18065 @node Sending or Not Sending
18066 @subsection Sending or Not Sending
18068 Well, assuming you've read of of the above, here are two final notes on
18069 mail sending with @code{nndiary}:
18073 @code{nndiary} is a @emph{real} mail back end. You really send real diary
18074 messsages for real. This means for instance that you can give
18075 appointements to anybody (provided they use Gnus and @code{nndiary}) by
18076 sending the diary message to them as well.
18078 However, since @code{nndiary} also has a @code{request-post} method, you
18079 can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the
18080 message won't actually be sent; just stored locally in the group. This
18081 comes in very handy for private appointments.
18084 @node Gnus Unplugged
18085 @section Gnus Unplugged
18090 @cindex Gnus unplugged
18092 In olden times (ca. February '88), people used to run their newsreaders
18093 on big machines with permanent connections to the net. News transport
18094 was dealt with by news servers, and all the newsreaders had to do was to
18095 read news. Believe it or not.
18097 Nowadays most people read news and mail at home, and use some sort of
18098 modem to connect to the net. To avoid running up huge phone bills, it
18099 would be nice to have a way to slurp down all the news and mail, hang up
18100 the phone, read for several hours, and then upload any responses you
18101 have to make. And then you repeat the procedure.
18103 Of course, you can use news servers for doing this as well. I've used
18104 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
18105 for some years, but doing that's a bore. Moving the news server
18106 functionality up to the newsreader makes sense if you're the only person
18107 reading news on a machine.
18109 Setting up Gnus as an ``offline'' newsreader is quite simple. In
18110 fact, you don't have to configure anything as the agent is now enabled
18111 by default (@pxref{Agent Variables, gnus-agent}).
18113 Of course, to use it as such, you have to learn a few new commands.
18116 * Agent Basics:: How it all is supposed to work.
18117 * Agent Categories:: How to tell the Gnus Agent what to download.
18118 * Agent Commands:: New commands for all the buffers.
18119 * Agent Visuals:: Ways that the agent may effect your summary buffer.
18120 * Agent as Cache:: The Agent is a big cache too.
18121 * Agent Expiry:: How to make old articles go away.
18122 * Agent Regeneration:: How to recover from lost connections and other accidents.
18123 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
18124 * Outgoing Messages:: What happens when you post/mail something?
18125 * Agent Variables:: Customizing is fun.
18126 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
18127 * Batching Agents:: How to fetch news from a @code{cron} job.
18128 * Agent Caveats:: What you think it'll do and what it does.
18133 @subsection Agent Basics
18135 First, let's get some terminology out of the way.
18137 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
18138 connection to the net (and notified the Agent that this is the case).
18139 When the connection to the net is up again (and Gnus knows this), the
18140 Agent is @dfn{plugged}.
18142 The @dfn{local} machine is the one you're running on, and which isn't
18143 connected to the net continuously.
18145 @dfn{Downloading} means fetching things from the net to your local
18146 machine. @dfn{Uploading} is doing the opposite.
18148 You know that Gnus gives you all the opportunity you'd ever want for
18149 shooting yourself in the foot. Some people call it flexibility. Gnus
18150 is also customizable to a great extent, which means that the user has a
18151 say on how Gnus behaves. Other newsreaders might unconditionally shoot
18152 you in your foot, but with Gnus, you have a choice!
18154 Gnus is never really in plugged or unplugged state. Rather, it applies
18155 that state to each server individually. This means that some servers
18156 can be plugged while others can be unplugged. Additionally, some
18157 servers can be ignored by the Agent altogether (which means that
18158 they're kinda like plugged always).
18160 So when you unplug the Agent and then wonder why is Gnus opening a
18161 connection to the Net, the next step to do is to look whether all
18162 servers are agentized. If there is an unagentized server, you found
18165 Another thing is the @dfn{offline} state. Sometimes, servers aren't
18166 reachable. When Gnus notices this, it asks you whether you want the
18167 server to be switched to offline state. If you say yes, then the
18168 server will behave somewhat as if it was unplugged, except that Gnus
18169 will ask you whether you want to switch it back online again.
18171 Let's take a typical Gnus session using the Agent.
18176 @findex gnus-unplugged
18177 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
18178 Agent in a disconnected state. You can read all the news that you have
18179 already fetched while in this mode.
18182 You then decide to see whether any new news has arrived. You connect
18183 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
18184 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
18185 as usual. To check for new mail in unplugged mode (@pxref{Mail
18186 Source Specifiers}).
18189 You can then read the new news immediately, or you can download the
18190 news onto your local machine. If you want to do the latter, you press
18191 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
18192 all the eligible articles in all the groups. (To let Gnus know which
18193 articles you want to download, @pxref{Agent Categories}).
18196 After fetching the articles, you press @kbd{J j} to make Gnus become
18197 unplugged again, and you shut down the PPP thing (or whatever). And
18198 then you read the news offline.
18201 And then you go to step 2.
18204 Here are some things you should do the first time (or so) that you use
18210 Decide which servers should be covered by the Agent. If you have a mail
18211 back end, it would probably be nonsensical to have it covered by the
18212 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
18213 @kbd{J a} on the server (or servers) that you wish to have covered by the
18214 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
18215 added servers you do not wish to have covered by the Agent. By default,
18216 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
18217 @code{gnus-secondary-select-methods} are agentized.
18220 Decide on download policy. It's fairly simple once you decide whether
18221 you are going to use agent categories, topic parameters, and/or group
18222 parameters to implement your policy. If you're new to gnus, it
18223 is probably best to start with a category, @xref{Agent Categories}.
18225 Both topic parameters (@pxref{Topic Parameters}) and agent categories
18226 (@pxref{Agent Categories}) provide for setting a policy that applies
18227 to multiple groups. Which you use is entirely up to you. Topic
18228 parameters do override categories so, if you mix the two, you'll have
18229 to take that into account. If you have a few groups that deviate from
18230 your policy, you can use group parameters (@pxref{Group Parameters}) to
18234 Uhm@dots{} that's it.
18238 @node Agent Categories
18239 @subsection Agent Categories
18241 One of the main reasons to integrate the news transport layer into the
18242 newsreader is to allow greater control over what articles to download.
18243 There's not much point in downloading huge amounts of articles, just to
18244 find out that you're not interested in reading any of them. It's better
18245 to be somewhat more conservative in choosing what to download, and then
18246 mark the articles for downloading manually if it should turn out that
18247 you're interested in the articles anyway.
18249 One of the more effective methods for controlling what is to be
18250 downloaded is to create a @dfn{category} and then assign some (or all)
18251 groups to this category. Groups that do not belong in any other
18252 category belong to the @code{default} category. Gnus has its own
18253 buffer for creating and managing categories.
18255 If you prefer, you can also use group parameters (@pxref{Group
18256 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
18257 alternative approach to controlling the agent. The only real
18258 difference is that categories are specific to the agent (so there is
18259 less to learn) while group and topic parameters include the kitchen
18262 Since you can set agent parameters in several different places we have
18263 a rule to decide which source to believe. This rule specifies that
18264 the parameter sources are checked in the following order: group
18265 parameters, topic parameters, agent category, and finally customizable
18266 variables. So you can mix all of these sources to produce a wide range
18267 of behavior, just don't blame me if you don't remember where you put
18271 * Category Syntax:: What a category looks like.
18272 * Category Buffer:: A buffer for maintaining categories.
18273 * Category Variables:: Customize'r'Us.
18277 @node Category Syntax
18278 @subsubsection Category Syntax
18280 A category consists of a name, the list of groups belonging to the
18281 category, and a number of optional parameters that override the
18282 customizable variables. The complete list of agent parameters are
18285 @cindex Agent Parameters
18287 @item agent-cat-name
18288 The name of the category.
18291 The list of groups that are in this category.
18293 @item agent-predicate
18294 A predicate which (generally) gives a rough outline of which articles
18295 are eligible for downloading; and
18297 @item agent-score-file
18298 a score rule which (generally) gives you a finer granularity when
18299 deciding what articles to download. (Note that this @dfn{download
18300 score} is not necessarily related to normal scores.)
18302 @item agent-enable-expiration
18303 a boolean indicating whether the agent should expire old articles in
18304 this group. Most groups should be expired to conserve disk space. In
18305 fact, its probably safe to say that the gnus.* hierarchy contains the
18306 only groups that should not be expired.
18308 @item agent-days-until-old
18309 an integer indicating the number of days that the agent should wait
18310 before deciding that a read article is safe to expire.
18312 @item agent-low-score
18313 an integer that overrides the value of @code{gnus-agent-low-score}.
18315 @item agent-high-score
18316 an integer that overrides the value of @code{gnus-agent-high-score}.
18318 @item agent-length-when-short
18319 an integer that overrides the value of
18320 @code{gnus-agent-short-article}.
18322 @item agent-length-when-long
18323 an integer that overrides the value of @code{gnus-agent-long-article}.
18325 @item agent-enable-undownloaded-faces
18326 a symbol indicating whether the summary buffer should display
18327 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
18328 faces. Any symbol other than @code{nil} will enable the use of
18329 undownloaded faces.
18332 The name of a category can not be changed once the category has been
18335 Each category maintains a list of groups that are exclusive members of
18336 that category. The exclusivity rule is automatically enforced, add a
18337 group to a new category and it is automatically removed from its old
18340 A predicate in its simplest form can be a single predicate such as
18341 @code{true} or @code{false}. These two will download every available
18342 article or nothing respectively. In the case of these two special
18343 predicates an additional score rule is superfluous.
18345 Predicates of @code{high} or @code{low} download articles in respect of
18346 their scores in relationship to @code{gnus-agent-high-score} and
18347 @code{gnus-agent-low-score} as described below.
18349 To gain even finer control of what is to be regarded eligible for
18350 download a predicate can consist of a number of predicates with logical
18351 operators sprinkled in between.
18353 Perhaps some examples are in order.
18355 Here's a simple predicate. (It's the default predicate, in fact, used
18356 for all groups that don't belong to any other category.)
18362 Quite simple, eh? This predicate is true if and only if the article is
18363 short (for some value of ``short'').
18365 Here's a more complex predicate:
18374 This means that an article should be downloaded if it has a high score,
18375 or if the score is not low and the article is not long. You get the
18378 The available logical operators are @code{or}, @code{and} and
18379 @code{not}. (If you prefer, you can use the more ``C''-ish operators
18380 @samp{|}, @code{&} and @code{!} instead.)
18382 The following predicates are pre-defined, but if none of these fit what
18383 you want to do, you can write your own.
18385 When evaluating each of these predicates, the named constant will be
18386 bound to the value determined by calling
18387 @code{gnus-agent-find-parameter} on the appropriate parameter. For
18388 example, gnus-agent-short-article will be bound to
18389 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
18390 means that you can specify a predicate in your category then tune that
18391 predicate to individual groups.
18395 True iff the article is shorter than @code{gnus-agent-short-article}
18396 lines; default 100.
18399 True iff the article is longer than @code{gnus-agent-long-article}
18400 lines; default 200.
18403 True iff the article has a download score less than
18404 @code{gnus-agent-low-score}; default 0.
18407 True iff the article has a download score greater than
18408 @code{gnus-agent-high-score}; default 0.
18411 True iff the Gnus Agent guesses that the article is spam. The
18412 heuristics may change over time, but at present it just computes a
18413 checksum and sees whether articles match.
18422 If you want to create your own predicate function, here's what you have
18423 to know: The functions are called with no parameters, but the
18424 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
18427 For example, you could decide that you don't want to download articles
18428 that were posted more than a certain number of days ago (e.g. posted
18429 more than @code{gnus-agent-expire-days} ago) you might write a function
18430 something along the lines of the following:
18433 (defun my-article-old-p ()
18434 "Say whether an article is old."
18435 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
18436 (- (time-to-days (current-time)) gnus-agent-expire-days)))
18439 with the predicate then defined as:
18442 (not my-article-old-p)
18445 or you could append your predicate to the predefined
18446 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
18450 (require 'gnus-agent)
18451 (setq gnus-category-predicate-alist
18452 (append gnus-category-predicate-alist
18453 '((old . my-article-old-p))))
18456 and simply specify your predicate as:
18462 If/when using something like the above, be aware that there are many
18463 misconfigured systems/mailers out there and so an article's date is not
18464 always a reliable indication of when it was posted. Hell, some people
18465 just don't give a damn.
18467 The above predicates apply to @emph{all} the groups which belong to the
18468 category. However, if you wish to have a specific predicate for an
18469 individual group within a category, or you're just too lazy to set up a
18470 new category, you can enter a group's individual predicate in its group
18471 parameters like so:
18474 (agent-predicate . short)
18477 This is the group/topic parameter equivalent of the agent category default.
18478 Note that when specifying a single word predicate like this, the
18479 @code{agent-predicate} specification must be in dotted pair notation.
18481 The equivalent of the longer example from above would be:
18484 (agent-predicate or high (and (not low) (not long)))
18487 The outer parenthesis required in the category specification are not
18488 entered here as, not being in dotted pair notation, the value of the
18489 predicate is assumed to be a list.
18492 Now, the syntax of the download score is the same as the syntax of
18493 normal score files, except that all elements that require actually
18494 seeing the article itself are verboten. This means that only the
18495 following headers can be scored on: @code{Subject}, @code{From},
18496 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
18497 @code{Lines}, and @code{Xref}.
18499 As with predicates, the specification of the @code{download score rule}
18500 to use in respect of a group can be in either the category definition if
18501 it's to be applicable to all groups in therein, or a group's parameters
18502 if it's to be specific to that group.
18504 In both of these places the @code{download score rule} can take one of
18511 This has the same syntax as a normal Gnus score file except only a
18512 subset of scoring keywords are available as mentioned above.
18518 Category specification
18522 ("Lars Ingebrigtsen" 1000000 nil s))
18528 Group/Topic Parameter specification
18531 (agent-score ("from"
18532 ("Lars Ingebrigtsen" 1000000 nil s))
18537 Again, note the omission of the outermost parenthesis here.
18543 These score files must @emph{only} contain the permitted scoring
18544 keywords stated above.
18550 Category specification
18553 ("~/News/agent.SCORE")
18559 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
18563 Group Parameter specification
18566 (agent-score "~/News/agent.SCORE")
18569 Additional score files can be specified as above. Need I say anything
18574 Use @code{normal} score files
18576 If you don't want to maintain two sets of scoring rules for a group, and
18577 your desired @code{downloading} criteria for a group are the same as your
18578 @code{reading} criteria then you can tell the agent to refer to your
18579 @code{normal} score files when deciding what to download.
18581 These directives in either the category definition or a group's
18582 parameters will cause the agent to read in all the applicable score
18583 files for a group, @emph{filtering out} those sections that do not
18584 relate to one of the permitted subset of scoring keywords.
18588 Category Specification
18595 Group Parameter specification
18598 (agent-score . file)
18603 @node Category Buffer
18604 @subsubsection Category Buffer
18606 You'd normally do all category maintenance from the category buffer.
18607 When you enter it for the first time (with the @kbd{J c} command from
18608 the group buffer), you'll only see the @code{default} category.
18610 The following commands are available in this buffer:
18614 @kindex q (Category)
18615 @findex gnus-category-exit
18616 Return to the group buffer (@code{gnus-category-exit}).
18619 @kindex e (Category)
18620 @findex gnus-category-customize-category
18621 Use a customization buffer to set all of the selected category's
18622 parameters at one time (@code{gnus-category-customize-category}).
18625 @kindex k (Category)
18626 @findex gnus-category-kill
18627 Kill the current category (@code{gnus-category-kill}).
18630 @kindex c (Category)
18631 @findex gnus-category-copy
18632 Copy the current category (@code{gnus-category-copy}).
18635 @kindex a (Category)
18636 @findex gnus-category-add
18637 Add a new category (@code{gnus-category-add}).
18640 @kindex p (Category)
18641 @findex gnus-category-edit-predicate
18642 Edit the predicate of the current category
18643 (@code{gnus-category-edit-predicate}).
18646 @kindex g (Category)
18647 @findex gnus-category-edit-groups
18648 Edit the list of groups belonging to the current category
18649 (@code{gnus-category-edit-groups}).
18652 @kindex s (Category)
18653 @findex gnus-category-edit-score
18654 Edit the download score rule of the current category
18655 (@code{gnus-category-edit-score}).
18658 @kindex l (Category)
18659 @findex gnus-category-list
18660 List all the categories (@code{gnus-category-list}).
18664 @node Category Variables
18665 @subsubsection Category Variables
18668 @item gnus-category-mode-hook
18669 @vindex gnus-category-mode-hook
18670 Hook run in category buffers.
18672 @item gnus-category-line-format
18673 @vindex gnus-category-line-format
18674 Format of the lines in the category buffer (@pxref{Formatting
18675 Variables}). Valid elements are:
18679 The name of the category.
18682 The number of groups in the category.
18685 @item gnus-category-mode-line-format
18686 @vindex gnus-category-mode-line-format
18687 Format of the category mode line (@pxref{Mode Line Formatting}).
18689 @item gnus-agent-short-article
18690 @vindex gnus-agent-short-article
18691 Articles that have fewer lines than this are short. Default 100.
18693 @item gnus-agent-long-article
18694 @vindex gnus-agent-long-article
18695 Articles that have more lines than this are long. Default 200.
18697 @item gnus-agent-low-score
18698 @vindex gnus-agent-low-score
18699 Articles that have a score lower than this have a low score. Default
18702 @item gnus-agent-high-score
18703 @vindex gnus-agent-high-score
18704 Articles that have a score higher than this have a high score. Default
18707 @item gnus-agent-expire-days
18708 @vindex gnus-agent-expire-days
18709 The number of days that a @samp{read} article must stay in the agent's
18710 local disk before becoming eligible for expiration (While the name is
18711 the same, this doesn't mean expiring the article on the server. It
18712 just means deleting the local copy of the article). What is also
18713 important to understand is that the counter starts with the time the
18714 article was written to the local disk and not the time the article was
18718 @item gnus-agent-enable-expiration
18719 @vindex gnus-agent-enable-expiration
18720 Determines whether articles in a group are, by default, expired or
18721 retained indefinitely. The default is @code{ENABLE} which means that
18722 you'll have to disable expiration when desired. On the other hand,
18723 you could set this to @code{DISABLE}. In that case, you would then
18724 have to enable expiration in selected groups.
18729 @node Agent Commands
18730 @subsection Agent Commands
18731 @findex gnus-agent-toggle-plugged
18732 @kindex J j (Agent)
18734 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
18735 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18736 toggles the plugged/unplugged state of the Gnus Agent.
18740 * Group Agent Commands:: Configure groups and fetch their contents.
18741 * Summary Agent Commands:: Manually select then fetch specific articles.
18742 * Server Agent Commands:: Select the servers that are supported by the agent.
18748 @node Group Agent Commands
18749 @subsubsection Group Agent Commands
18753 @kindex J u (Agent Group)
18754 @findex gnus-agent-fetch-groups
18755 Fetch all eligible articles in the current group
18756 (@code{gnus-agent-fetch-groups}).
18759 @kindex J c (Agent Group)
18760 @findex gnus-enter-category-buffer
18761 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18764 @kindex J s (Agent Group)
18765 @findex gnus-agent-fetch-session
18766 Fetch all eligible articles in all groups
18767 (@code{gnus-agent-fetch-session}).
18770 @kindex J S (Agent Group)
18771 @findex gnus-group-send-queue
18772 Send all sendable messages in the queue group
18773 (@code{gnus-group-send-queue}). @xref{Drafts}.
18776 @kindex J a (Agent Group)
18777 @findex gnus-agent-add-group
18778 Add the current group to an Agent category
18779 (@code{gnus-agent-add-group}). This command understands the
18780 process/prefix convention (@pxref{Process/Prefix}).
18783 @kindex J r (Agent Group)
18784 @findex gnus-agent-remove-group
18785 Remove the current group from its category, if any
18786 (@code{gnus-agent-remove-group}). This command understands the
18787 process/prefix convention (@pxref{Process/Prefix}).
18790 @kindex J Y (Agent Group)
18791 @findex gnus-agent-synchronize-flags
18792 Synchronize flags changed while unplugged with remote server, if any.
18798 @node Summary Agent Commands
18799 @subsubsection Summary Agent Commands
18803 @kindex J # (Agent Summary)
18804 @findex gnus-agent-mark-article
18805 Mark the article for downloading (@code{gnus-agent-mark-article}).
18808 @kindex J M-# (Agent Summary)
18809 @findex gnus-agent-unmark-article
18810 Remove the downloading mark from the article
18811 (@code{gnus-agent-unmark-article}).
18815 @kindex @@ (Agent Summary)
18816 @findex gnus-agent-toggle-mark
18817 Toggle whether to download the article
18818 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
18822 @kindex J c (Agent Summary)
18823 @findex gnus-agent-catchup
18824 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18827 @kindex J S (Agent Summary)
18828 @findex gnus-agent-fetch-group
18829 Download all eligible (@pxref{Agent Categories}) articles in this group.
18830 (@code{gnus-agent-fetch-group}).
18833 @kindex J s (Agent Summary)
18834 @findex gnus-agent-fetch-series
18835 Download all processable articles in this group.
18836 (@code{gnus-agent-fetch-series}).
18839 @kindex J u (Agent Summary)
18840 @findex gnus-agent-summary-fetch-group
18841 Download all downloadable articles in the current group
18842 (@code{gnus-agent-summary-fetch-group}).
18847 @node Server Agent Commands
18848 @subsubsection Server Agent Commands
18852 @kindex J a (Agent Server)
18853 @findex gnus-agent-add-server
18854 Add the current server to the list of servers covered by the Gnus Agent
18855 (@code{gnus-agent-add-server}).
18858 @kindex J r (Agent Server)
18859 @findex gnus-agent-remove-server
18860 Remove the current server from the list of servers covered by the Gnus
18861 Agent (@code{gnus-agent-remove-server}).
18866 @node Agent Visuals
18867 @subsection Agent Visuals
18869 If you open a summary while unplugged and, Gnus knows from the group's
18870 active range that there are more articles than the headers currently
18871 stored in the Agent, you may see some articles whose subject looks
18872 something like @samp{[Undownloaded article #####]}. These are
18873 placeholders for the missing headers. Aside from setting a mark,
18874 there is not much that can be done with one of these placeholders.
18875 When Gnus finally gets a chance to fetch the group's headers, the
18876 placeholders will automatically be replaced by the actual headers.
18877 You can configure the summary buffer's maneuvering to skip over the
18878 placeholders if you care (See @code{gnus-auto-goto-ignores}).
18880 While it may be obvious to all, the only headers and articles
18881 available while unplugged are those headers and articles that were
18882 fetched into the Agent while previously plugged. To put it another
18883 way, ``If you forget to fetch something while plugged, you might have a
18884 less than satisfying unplugged session''. For this reason, the Agent
18885 adds two visual effects to your summary buffer. These effects display
18886 the download status of each article so that you always know which
18887 articles will be available when unplugged.
18889 The first visual effect is the @samp{%O} spec. If you customize
18890 @code{gnus-summary-line-format} to include this specifier, you will add
18891 a single character field that indicates an article's download status.
18892 Articles that have been fetched into either the Agent or the Cache,
18893 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
18894 other articles will display @code{gnus-undownloaded-mark} (defaults to
18895 @samp{-}). If you open a group that has not been agentized, a space
18896 (@samp{ }) will be displayed.
18898 The second visual effect are the undownloaded faces. The faces, there
18899 are three indicating the article's score (low, normal, high), seem to
18900 result in a love/hate response from many Gnus users. The problem is
18901 that the face selection is controlled by a list of condition tests and
18902 face names (See @code{gnus-summary-highlight}). Each condition is
18903 tested in the order in which it appears in the list so early
18904 conditions have precedence over later conditions. All of this means
18905 that, if you tick an undownloaded article, the article will continue
18906 to be displayed in the undownloaded face rather than the ticked face.
18908 If you use the Agent as a cache (to avoid downloading the same article
18909 each time you visit it or to minimize your connection time), the
18910 undownloaded face will probably seem like a good idea. The reason
18911 being that you do all of our work (marking, reading, deleting) with
18912 downloaded articles so the normal faces always appear. For those
18913 users using the agent to improve online performance by caching the NOV
18914 database (most users since 5.10.2), the undownloaded faces may appear
18915 to be an absolutely horrible idea. The issue being that, since none
18916 of their articles have been fetched into the Agent, all of the
18917 normal faces will be obscured by the undownloaded faces.
18919 If you would like to use the undownloaded faces, you must enable the
18920 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
18921 group parameter to @code{t}. This parameter, like all other agent
18922 parameters, may be set on an Agent Category (@pxref{Agent Categories}),
18923 a Group Topic (@pxref{Topic Parameters}), or an individual group
18924 (@pxref{Group Parameters}).
18926 The one problem common to all users using the agent is how quickly it
18927 can consume disk space. If you using the agent on many groups, it is
18928 even more difficult to effectively recover disk space. One solution
18929 is the @samp{%F} format available in @code{gnus-group-line-format}.
18930 This format will display the actual disk space used by articles
18931 fetched into both the agent and cache. By knowing which groups use
18932 the most space, users know where to focus their efforts when ``agent
18933 expiring'' articles.
18935 @node Agent as Cache
18936 @subsection Agent as Cache
18938 When Gnus is plugged, it is not efficient to download headers or
18939 articles from the server again, if they are already stored in the
18940 Agent. So, Gnus normally only downloads headers once, and stores them
18941 in the Agent. These headers are later used when generating the summary
18942 buffer, regardless of whether you are plugged or unplugged. Articles
18943 are not cached in the Agent by default though (that would potentially
18944 consume lots of disk space), but if you have already downloaded an
18945 article into the Agent, Gnus will not download the article from the
18946 server again but use the locally stored copy instead.
18948 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
18949 @pxref{Agent Variables}) to always download headers and articles while
18950 plugged. Gnus will almost certainly be slower, but it will be kept
18951 synchronized with the server. That last point probably won't make any
18952 sense if you are using a nntp or nnimap back end.
18955 @subsection Agent Expiry
18957 @vindex gnus-agent-expire-days
18958 @findex gnus-agent-expire
18959 @kindex M-x gnus-agent-expire
18960 @kindex M-x gnus-agent-expire-group
18961 @findex gnus-agent-expire-group
18962 @cindex agent expiry
18963 @cindex Gnus agent expiry
18966 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
18967 least it doesn't handle it like other back ends. Instead, there are
18968 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
18969 commands that will expire all read articles that are older than
18970 @code{gnus-agent-expire-days} days. They can be run whenever you feel
18971 that you're running out of space. Neither are particularly fast or
18972 efficient, and it's not a particularly good idea to interrupt them (with
18973 @kbd{C-g} or anything else) once you've started one of them.
18975 Note that other functions, e.g. @code{gnus-request-expire-articles},
18976 might run @code{gnus-agent-expire} for you to keep the agent
18977 synchronized with the group.
18979 The agent parameter @code{agent-enable-expiration} may be used to
18980 prevent expiration in selected groups.
18982 @vindex gnus-agent-expire-all
18983 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
18984 expiration commands will expire all articles---unread, read, ticked
18985 and dormant. If @code{nil} (which is the default), only read articles
18986 are eligible for expiry, and unread, ticked and dormant articles will
18987 be kept indefinitely.
18989 If you find that some articles eligible for expiry are never expired,
18990 perhaps some Gnus Agent files are corrupted. There's are special
18991 commands, @code{gnus-agent-regenerate} and
18992 @code{gnus-agent-regenerate-group}, to fix possible problems.
18994 @node Agent Regeneration
18995 @subsection Agent Regeneration
18997 @cindex agent regeneration
18998 @cindex Gnus agent regeneration
18999 @cindex regeneration
19001 The local data structures used by @code{nnagent} may become corrupted
19002 due to certain exceptional conditions. When this happens,
19003 @code{nnagent} functionality may degrade or even fail. The solution
19004 to this problem is to repair the local data structures by removing all
19005 internal inconsistencies.
19007 For example, if your connection to your server is lost while
19008 downloaded articles into the agent, the local data structures will not
19009 know about articles successfully downloaded prior to the connection
19010 failure. Running @code{gnus-agent-regenerate} or
19011 @code{gnus-agent-regenerate-group} will update the data structures
19012 such that you don't need to download these articles a second time.
19014 @findex gnus-agent-regenerate
19015 @kindex M-x gnus-agent-regenerate
19016 The command @code{gnus-agent-regenerate} will perform
19017 @code{gnus-agent-regenerate-group} on every agentized group. While
19018 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
19019 recommended that you first close all summary buffers.
19021 @findex gnus-agent-regenerate-group
19022 @kindex M-x gnus-agent-regenerate-group
19023 The command @code{gnus-agent-regenerate-group} uses the local copies
19024 of individual articles to repair the local @acronym{NOV}(header) database. It
19025 then updates the internal data structures that document which articles
19026 are stored locally. An optional argument will mark articles in the
19029 @node Agent and IMAP
19030 @subsection Agent and IMAP
19032 The Agent works with any Gnus back end, including nnimap. However,
19033 since there are some conceptual differences between @acronym{NNTP} and
19034 @acronym{IMAP}, this section (should) provide you with some information to
19035 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
19037 The first thing to keep in mind is that all flags (read, ticked, etc)
19038 are kept on the @acronym{IMAP} server, rather than in @file{.newsrc} as is the
19039 case for nntp. Thus Gnus need to remember flag changes when
19040 disconnected, and synchronize these flags when you plug back in.
19042 Gnus keeps track of flag changes when reading nnimap groups under the
19043 Agent. When you plug back in, Gnus will check if you have any changed
19044 any flags and ask if you wish to synchronize these with the server.
19045 The 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 Some things are currently not implemented in the Agent that you'd might
19060 expect from a disconnected @acronym{IMAP} client, including:
19065 Copying/moving articles into nnimap groups when unplugged.
19068 Creating/deleting nnimap groups when unplugged.
19072 Technical note: the synchronization algorithm does not work by ``pushing''
19073 all local flags to the server, but rather incrementally update the
19074 server view of flags by changing only those flags that were changed by
19075 the user. Thus, if you set one flag on an article, quit the group and
19076 re-select the group and remove the flag; the flag will be set and
19077 removed from the server when you ``synchronize''. The queued flag
19078 operations can be found in the per-server @code{flags} file in the Agent
19079 directory. It's emptied when you synchronize flags.
19082 @node Outgoing Messages
19083 @subsection Outgoing Messages
19085 By default, when Gnus is unplugged, all outgoing messages (both mail
19086 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
19087 You can view them there after posting, and edit them at will.
19089 You can control the circumstances under which outgoing mail is queued
19090 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
19091 news is always queued when Gnus is unplugged, and never otherwise.
19093 You can send the messages either from the draft group with the special
19094 commands available there, or you can use the @kbd{J S} command in the
19095 group buffer to send all the sendable messages in the draft group.
19096 Posting news will only work when Gnus is plugged, but you can send
19099 If sending mail while unplugged does not work for you and you worry
19100 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
19101 ask you to confirm your action (see
19102 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
19104 @node Agent Variables
19105 @subsection Agent Variables
19110 Is the agent enabled? The default is @code{t}. When first enabled,
19111 the agent will use @code{gnus-agent-auto-agentize-methods} to
19112 automatically mark some back ends as agentized. You may change which
19113 back ends are agentized using the agent commands in the server buffer.
19115 To enter the server buffer, use the @kbd{^}
19116 (@code{gnus-group-enter-server-mode}) command in the group buffer.
19119 @item gnus-agent-directory
19120 @vindex gnus-agent-directory
19121 Where the Gnus Agent will store its files. The default is
19122 @file{~/News/agent/}.
19124 @item gnus-agent-handle-level
19125 @vindex gnus-agent-handle-level
19126 Groups on levels (@pxref{Group Levels}) higher than this variable will
19127 be ignored by the Agent. The default is @code{gnus-level-subscribed},
19128 which means that only subscribed group will be considered by the Agent
19131 @item gnus-agent-plugged-hook
19132 @vindex gnus-agent-plugged-hook
19133 Hook run when connecting to the network.
19135 @item gnus-agent-unplugged-hook
19136 @vindex gnus-agent-unplugged-hook
19137 Hook run when disconnecting from the network.
19139 @item gnus-agent-fetched-hook
19140 @vindex gnus-agent-fetched-hook
19141 Hook run when finished fetching articles.
19143 @item gnus-agent-cache
19144 @vindex gnus-agent-cache
19145 Variable to control whether use the locally stored @acronym{NOV} and
19146 articles when plugged, e.g. essentially using the Agent as a cache.
19147 The default is non-@code{nil}, which means to use the Agent as a cache.
19149 @item gnus-agent-go-online
19150 @vindex gnus-agent-go-online
19151 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
19152 automatically switch offline servers into online status. If it is
19153 @code{ask}, the default, the Agent will ask if you wish to switch
19154 offline servers into online status when you re-connect. If it has any
19155 other value, all offline servers will be automatically switched into
19158 @item gnus-agent-mark-unread-after-downloaded
19159 @vindex gnus-agent-mark-unread-after-downloaded
19160 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
19161 mark articles as unread after downloading. This is usually a safe
19162 thing to do as the newly downloaded article has obviously not been
19163 read. The default is @code{t}.
19165 @item gnus-agent-consider-all-articles
19166 @vindex gnus-agent-consider-all-articles
19167 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
19168 agent will let the agent predicate decide whether articles need to be
19169 downloaded or not, for all articles. When @code{nil}, the default,
19170 the agent will only let the predicate decide whether unread articles
19171 are downloaded or not. If you enable this, you may also want to look
19172 into the agent expiry settings (@pxref{Category Variables}), so that
19173 the agent doesn't download articles which the agent will later expire,
19174 over and over again.
19176 @item gnus-agent-max-fetch-size
19177 @vindex gnus-agent-max-fetch-size
19178 The agent fetches articles into a temporary buffer prior to parsing
19179 them into individual files. To avoid exceeding the max. buffer size,
19180 the agent alternates between fetching and parsing until all articles
19181 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
19182 limit to control how often the cycling occurs. A large value improves
19183 performance. A small value minimizes the time lost should the
19184 connection be lost while fetching (You may need to run
19185 @code{gnus-agent-regenerate-group} to update the group's state.
19186 However, all articles parsed prior to loosing the connection will be
19187 available while unplugged). The default is 10M so it is unusual to
19190 @item gnus-server-unopen-status
19191 @vindex gnus-server-unopen-status
19192 Perhaps not an Agent variable, but closely related to the Agent, this
19193 variable says what will happen if Gnus cannot open a server. If the
19194 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
19195 whether to deny the server or whether to unplug the agent. If the
19196 Agent is disabled, Gnus always simply deny the server. Other choices
19197 for this variable include @code{denied} and @code{offline} the latter
19198 is only valid if the Agent is used.
19200 @item gnus-auto-goto-ignores
19201 @vindex gnus-auto-goto-ignores
19202 Another variable that isn't an Agent variable, yet so closely related
19203 that most will look for it here, this variable tells the summary
19204 buffer how to maneuver around undownloaded (only headers stored in the
19205 agent) and unfetched (neither article nor headers stored) articles.
19207 The valid values are @code{nil} (maneuver to any article),
19208 @code{undownloaded} (maneuvering while unplugged ignores articles that
19209 have not been fetched), @code{always-undownloaded} (maneuvering always
19210 ignores articles that have not been fetched), @code{unfetched}
19211 (maneuvering ignores articles whose headers have not been fetched).
19213 @item gnus-agent-queue-mail
19214 @vindex gnus-agent-queue-mail
19215 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
19216 queue mail rather than sending it straight away. When @code{t}, Gnus
19217 will queue mail when unplugged only. When @code{nil}, never queue
19218 mail. The default is @code{t}.
19220 @item gnus-agent-prompt-send-queue
19221 @vindex gnus-agent-prompt-send-queue
19222 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
19223 prompt you to confirm that you really wish to proceed if you hit
19224 @kbd{J S} while unplugged. The default is @code{nil}.
19226 @item gnus-agent-auto-agentize-methods
19227 @vindex gnus-agent-auto-agentize-methods
19228 If you have never used the Agent before (or more technically, if
19229 @file{~/News/agent/lib/servers} does not exist), Gnus will
19230 automatically agentize a few servers for you. This variable control
19231 which back ends should be auto-agentized. It is typically only useful
19232 to agentize remote back ends. The auto-agentizing has the same effect
19233 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
19234 If the file exist, you must manage the servers manually by adding or
19235 removing them, this variable is only applicable the first time you
19236 start Gnus. The default is @samp{(nntp nnimap)}.
19241 @node Example Setup
19242 @subsection Example Setup
19244 If you don't want to read this manual, and you have a fairly standard
19245 setup, you may be able to use something like the following as your
19246 @file{~/.gnus.el} file to get started.
19249 ;;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
19250 ;;; @r{from your ISP's server.}
19251 (setq gnus-select-method '(nntp "news.your-isp.com"))
19253 ;;; @r{Define how Gnus is to read your mail. We read mail from}
19254 ;;; @r{your ISP's @acronym{POP} server.}
19255 (setq mail-sources '((pop :server "pop.your-isp.com")))
19257 ;;; @r{Say how Gnus is to store the mail. We use nnml groups.}
19258 (setq gnus-secondary-select-methods '((nnml "")))
19260 ;;; @r{Make Gnus into an offline newsreader.}
19261 ;;; (gnus-agentize) ; @r{The obsolete setting.}
19262 ;;; (setq gnus-agent t) ; @r{Now the default.}
19265 That should be it, basically. Put that in your @file{~/.gnus.el} file,
19266 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
19269 If this is the first time you've run Gnus, you will be subscribed
19270 automatically to a few default newsgroups. You'll probably want to
19271 subscribe to more groups, and to do that, you have to query the
19272 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
19273 command. This usually takes quite a while, but you only have to do it
19276 After reading and parsing a while, you'll be presented with a list of
19277 groups. Subscribe to the ones you want to read with the @kbd{u}
19278 command. @kbd{l} to make all the killed groups disappear after you've
19279 subscribe to all the groups you want to read. (@kbd{A k} will bring
19280 back all the killed groups.)
19282 You can now read the groups at once, or you can download the articles
19283 with the @kbd{J s} command. And then read the rest of this manual to
19284 find out which of the other gazillion things you want to customize.
19287 @node Batching Agents
19288 @subsection Batching Agents
19289 @findex gnus-agent-batch
19291 Having the Gnus Agent fetch articles (and post whatever messages you've
19292 written) is quite easy once you've gotten things set up properly. The
19293 following shell script will do everything that is necessary:
19295 You can run a complete batch command from the command line with the
19296 following incantation:
19300 emacs -batch -l ~/.emacs -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1
19304 @node Agent Caveats
19305 @subsection Agent Caveats
19307 The Gnus Agent doesn't seem to work like most other offline
19308 newsreaders. Here are some common questions that some imaginary people
19312 @item If I read an article while plugged, do they get entered into the Agent?
19314 @strong{No}. If you want this behavior, add
19315 @code{gnus-agent-fetch-selected-article} to
19316 @code{gnus-select-article-hook}.
19318 @item If I read an article while plugged, and the article already exists in
19319 the Agent, will it get downloaded once more?
19321 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
19325 In short, when Gnus is unplugged, it only looks into the locally stored
19326 articles; when it's plugged, it talks to your ISP and may also use the
19327 locally stored articles.
19334 Other people use @dfn{kill files}, but we here at Gnus Towers like
19335 scoring better than killing, so we'd rather switch than fight. They do
19336 something completely different as well, so sit up straight and pay
19339 @vindex gnus-summary-mark-below
19340 All articles have a default score (@code{gnus-summary-default-score}),
19341 which is 0 by default. This score may be raised or lowered either
19342 interactively or by score files. Articles that have a score lower than
19343 @code{gnus-summary-mark-below} are marked as read.
19345 Gnus will read any @dfn{score files} that apply to the current group
19346 before generating the summary buffer.
19348 There are several commands in the summary buffer that insert score
19349 entries based on the current article. You can, for instance, ask Gnus to
19350 lower or increase the score of all articles with a certain subject.
19352 There are two sorts of scoring entries: Permanent and temporary.
19353 Temporary score entries are self-expiring entries. Any entries that are
19354 temporary and have not been used for, say, a week, will be removed
19355 silently to help keep the sizes of the score files down.
19358 * Summary Score Commands:: Adding score entries for the current group.
19359 * Group Score Commands:: General score commands.
19360 * Score Variables:: Customize your scoring. (My, what terminology).
19361 * Score File Format:: What a score file may contain.
19362 * Score File Editing:: You can edit score files by hand as well.
19363 * Adaptive Scoring:: Big Sister Gnus knows what you read.
19364 * Home Score File:: How to say where new score entries are to go.
19365 * Followups To Yourself:: Having Gnus notice when people answer you.
19366 * Scoring On Other Headers:: Scoring on non-standard headers.
19367 * Scoring Tips:: How to score effectively.
19368 * Reverse Scoring:: That problem child of old is not problem.
19369 * Global Score Files:: Earth-spanning, ear-splitting score files.
19370 * Kill Files:: They are still here, but they can be ignored.
19371 * Converting Kill Files:: Translating kill files to score files.
19372 * Advanced Scoring:: Using logical expressions to build score rules.
19373 * Score Decays:: It can be useful to let scores wither away.
19377 @node Summary Score Commands
19378 @section Summary Score Commands
19379 @cindex score commands
19381 The score commands that alter score entries do not actually modify real
19382 score files. That would be too inefficient. Gnus maintains a cache of
19383 previously loaded score files, one of which is considered the
19384 @dfn{current score file alist}. The score commands simply insert
19385 entries into this list, and upon group exit, this list is saved.
19387 The current score file is by default the group's local score file, even
19388 if no such score file actually exists. To insert score commands into
19389 some other score file (e.g. @file{all.SCORE}), you must first make this
19390 score file the current one.
19392 General score commands that don't actually change the score file:
19397 @kindex V s (Summary)
19398 @findex gnus-summary-set-score
19399 Set the score of the current article (@code{gnus-summary-set-score}).
19402 @kindex V S (Summary)
19403 @findex gnus-summary-current-score
19404 Display the score of the current article
19405 (@code{gnus-summary-current-score}).
19408 @kindex V t (Summary)
19409 @findex gnus-score-find-trace
19410 Display all score rules that have been used on the current article
19411 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
19412 may type @kbd{e} to edit score file corresponding to the score rule on
19413 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
19414 score file and edit it.
19417 @kindex V w (Summary)
19418 @findex gnus-score-find-favourite-words
19419 List words used in scoring (@code{gnus-score-find-favourite-words}).
19422 @kindex V R (Summary)
19423 @findex gnus-summary-rescore
19424 Run the current summary through the scoring process
19425 (@code{gnus-summary-rescore}). This might be useful if you're playing
19426 around with your score files behind Gnus' back and want to see the
19427 effect you're having.
19430 @kindex V c (Summary)
19431 @findex gnus-score-change-score-file
19432 Make a different score file the current
19433 (@code{gnus-score-change-score-file}).
19436 @kindex V e (Summary)
19437 @findex gnus-score-edit-current-scores
19438 Edit the current score file (@code{gnus-score-edit-current-scores}).
19439 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
19443 @kindex V f (Summary)
19444 @findex gnus-score-edit-file
19445 Edit a score file and make this score file the current one
19446 (@code{gnus-score-edit-file}).
19449 @kindex V F (Summary)
19450 @findex gnus-score-flush-cache
19451 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
19452 after editing score files.
19455 @kindex V C (Summary)
19456 @findex gnus-score-customize
19457 Customize a score file in a visually pleasing manner
19458 (@code{gnus-score-customize}).
19462 The rest of these commands modify the local score file.
19467 @kindex V m (Summary)
19468 @findex gnus-score-set-mark-below
19469 Prompt for a score, and mark all articles with a score below this as
19470 read (@code{gnus-score-set-mark-below}).
19473 @kindex V x (Summary)
19474 @findex gnus-score-set-expunge-below
19475 Prompt for a score, and add a score rule to the current score file to
19476 expunge all articles below this score
19477 (@code{gnus-score-set-expunge-below}).
19480 The keystrokes for actually making score entries follow a very regular
19481 pattern, so there's no need to list all the commands. (Hundreds of
19484 @findex gnus-summary-increase-score
19485 @findex gnus-summary-lower-score
19489 The first key is either @kbd{I} (upper case i) for increasing the score
19490 or @kbd{L} for lowering the score.
19492 The second key says what header you want to score on. The following
19493 keys are available:
19497 Score on the author name.
19500 Score on the subject line.
19503 Score on the @code{Xref} line---i.e., the cross-posting line.
19506 Score on the @code{References} line.
19512 Score on the number of lines.
19515 Score on the @code{Message-ID} header.
19518 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
19519 if your @acronym{NNTP} server tracks additional header data in overviews.
19522 Score on followups---this matches the author name, and adds scores to
19523 the followups to this author. (Using this key leads to the creation of
19524 @file{ADAPT} files.)
19533 Score on thread. (Using this key leads to the creation of @file{ADAPT}
19539 The third key is the match type. Which match types are valid depends on
19540 what headers you are scoring on.
19552 Substring matching.
19555 Fuzzy matching (@pxref{Fuzzy Matching}).
19584 Greater than number.
19589 The fourth and usually final key says whether this is a temporary (i.e.,
19590 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
19591 or whether it is to be done immediately, without adding to the score
19596 Temporary score entry.
19599 Permanent score entry.
19602 Immediately scoring.
19606 If you are scoring on `e' (extra) headers, you will then be prompted for
19607 the header name on which you wish to score. This must be a header named
19608 in gnus-extra-headers, and @samp{TAB} completion is available.
19612 So, let's say you want to increase the score on the current author with
19613 exact matching permanently: @kbd{I a e p}. If you want to lower the
19614 score based on the subject line, using substring matching, and make a
19615 temporary score entry: @kbd{L s s t}. Pretty easy.
19617 To make things a bit more complicated, there are shortcuts. If you use
19618 a capital letter on either the second or third keys, Gnus will use
19619 defaults for the remaining one or two keystrokes. The defaults are
19620 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
19621 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
19623 These functions take both the numerical prefix and the symbolic prefix
19624 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
19625 (or increase) the score of the article. A symbolic prefix of @code{a}
19626 says to use the @file{all.SCORE} file for the command instead of the
19627 current score file.
19629 @vindex gnus-score-mimic-keymap
19630 The @code{gnus-score-mimic-keymap} says whether these commands will
19631 pretend they are keymaps or not.
19634 @node Group Score Commands
19635 @section Group Score Commands
19636 @cindex group score commands
19638 There aren't many of these as yet, I'm afraid.
19643 @kindex W e (Group)
19644 @findex gnus-score-edit-all-score
19645 Edit the apply-to-all-groups all.SCORE file. You will be popped into
19646 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
19649 @kindex W f (Group)
19650 @findex gnus-score-flush-cache
19651 Gnus maintains a cache of score alists to avoid having to reload them
19652 all the time. This command will flush the cache
19653 (@code{gnus-score-flush-cache}).
19657 You can do scoring from the command line by saying something like:
19659 @findex gnus-batch-score
19660 @cindex batch scoring
19662 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
19666 @node Score Variables
19667 @section Score Variables
19668 @cindex score variables
19672 @item gnus-use-scoring
19673 @vindex gnus-use-scoring
19674 If @code{nil}, Gnus will not check for score files, and will not, in
19675 general, do any score-related work. This is @code{t} by default.
19677 @item gnus-kill-killed
19678 @vindex gnus-kill-killed
19679 If this variable is @code{nil}, Gnus will never apply score files to
19680 articles that have already been through the kill process. While this
19681 may save you lots of time, it also means that if you apply a kill file
19682 to a group, and then change the kill file and want to run it over you
19683 group again to kill more articles, it won't work. You have to set this
19684 variable to @code{t} to do that. (It is @code{t} by default.)
19686 @item gnus-kill-files-directory
19687 @vindex gnus-kill-files-directory
19688 All kill and score files will be stored in this directory, which is
19689 initialized from the @env{SAVEDIR} environment variable by default.
19690 This is @file{~/News/} by default.
19692 @item gnus-score-file-suffix
19693 @vindex gnus-score-file-suffix
19694 Suffix to add to the group name to arrive at the score file name
19695 (@file{SCORE} by default.)
19697 @item gnus-score-uncacheable-files
19698 @vindex gnus-score-uncacheable-files
19699 @cindex score cache
19700 All score files are normally cached to avoid excessive re-loading of
19701 score files. However, if this might make your Emacs grow big and
19702 bloated, so this regexp can be used to weed out score files unlikely
19703 to be needed again. It would be a bad idea to deny caching of
19704 @file{all.SCORE}, while it might be a good idea to not cache
19705 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
19706 variable is @samp{ADAPT$} by default, so no adaptive score files will
19709 @item gnus-save-score
19710 @vindex gnus-save-score
19711 If you have really complicated score files, and do lots of batch
19712 scoring, then you might set this variable to @code{t}. This will make
19713 Gnus save the scores into the @file{.newsrc.eld} file.
19715 If you do not set this to @code{t}, then manual scores (like those set
19716 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
19717 across group visits.
19719 @item gnus-score-interactive-default-score
19720 @vindex gnus-score-interactive-default-score
19721 Score used by all the interactive raise/lower commands to raise/lower
19722 score with. Default is 1000, which may seem excessive, but this is to
19723 ensure that the adaptive scoring scheme gets enough room to play with.
19724 We don't want the small changes from the adaptive scoring to overwrite
19725 manually entered data.
19727 @item gnus-summary-default-score
19728 @vindex gnus-summary-default-score
19729 Default score of an article, which is 0 by default.
19731 @item gnus-summary-expunge-below
19732 @vindex gnus-summary-expunge-below
19733 Don't display the summary lines of articles that have scores lower than
19734 this variable. This is @code{nil} by default, which means that no
19735 articles will be hidden. This variable is local to the summary buffers,
19736 and has to be set from @code{gnus-summary-mode-hook}.
19738 @item gnus-score-over-mark
19739 @vindex gnus-score-over-mark
19740 Mark (in the third column) used for articles with a score over the
19741 default. Default is @samp{+}.
19743 @item gnus-score-below-mark
19744 @vindex gnus-score-below-mark
19745 Mark (in the third column) used for articles with a score below the
19746 default. Default is @samp{-}.
19748 @item gnus-score-find-score-files-function
19749 @vindex gnus-score-find-score-files-function
19750 Function used to find score files for the current group. This function
19751 is called with the name of the group as the argument.
19753 Predefined functions available are:
19756 @item gnus-score-find-single
19757 @findex gnus-score-find-single
19758 Only apply the group's own score file.
19760 @item gnus-score-find-bnews
19761 @findex gnus-score-find-bnews
19762 Apply all score files that match, using bnews syntax. This is the
19763 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
19764 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
19765 @file{gnu.all.SCORE} would all apply. In short, the instances of
19766 @samp{all} in the score file names are translated into @samp{.*}, and
19767 then a regexp match is done.
19769 This means that if you have some score entries that you want to apply to
19770 all groups, then you put those entries in the @file{all.SCORE} file.
19772 The score files are applied in a semi-random order, although Gnus will
19773 try to apply the more general score files before the more specific score
19774 files. It does this by looking at the number of elements in the score
19775 file names---discarding the @samp{all} elements.
19777 @item gnus-score-find-hierarchical
19778 @findex gnus-score-find-hierarchical
19779 Apply all score files from all the parent groups. This means that you
19780 can't have score files like @file{all.SCORE}, but you can have
19781 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19785 This variable can also be a list of functions. In that case, all
19786 these functions will be called with the group name as argument, and
19787 all the returned lists of score files will be applied. These
19788 functions can also return lists of lists of score alists directly. In
19789 that case, the functions that return these non-file score alists
19790 should probably be placed before the ``real'' score file functions, to
19791 ensure that the last score file returned is the local score file.
19794 For example, to do hierarchical scoring but use a non-server-specific
19795 overall score file, you could use the value
19797 (list (lambda (group) ("all.SCORE"))
19798 'gnus-score-find-hierarchical)
19801 @item gnus-score-expiry-days
19802 @vindex gnus-score-expiry-days
19803 This variable says how many days should pass before an unused score file
19804 entry is expired. If this variable is @code{nil}, no score file entries
19805 are expired. It's 7 by default.
19807 @item gnus-update-score-entry-dates
19808 @vindex gnus-update-score-entry-dates
19809 If this variable is non-@code{nil}, temporary score entries that have
19810 been triggered (matched) will have their dates updated. (This is how Gnus
19811 controls expiry---all non-matched-entries will become too old while
19812 matched entries will stay fresh and young.) However, if you set this
19813 variable to @code{nil}, even matched entries will grow old and will
19814 have to face that oh-so grim reaper.
19816 @item gnus-score-after-write-file-function
19817 @vindex gnus-score-after-write-file-function
19818 Function called with the name of the score file just written.
19820 @item gnus-score-thread-simplify
19821 @vindex gnus-score-thread-simplify
19822 If this variable is non-@code{nil}, article subjects will be
19823 simplified for subject scoring purposes in the same manner as with
19824 threading---according to the current value of
19825 @code{gnus-simplify-subject-functions}. If the scoring entry uses
19826 @code{substring} or @code{exact} matching, the match will also be
19827 simplified in this manner.
19832 @node Score File Format
19833 @section Score File Format
19834 @cindex score file format
19836 A score file is an @code{emacs-lisp} file that normally contains just a
19837 single form. Casual users are not expected to edit these files;
19838 everything can be changed from the summary buffer.
19840 Anyway, if you'd like to dig into it yourself, here's an example:
19844 ("Lars Ingebrigtsen" -10000)
19846 ("larsi\\|lmi" -50000 nil R))
19848 ("Ding is Badd" nil 728373))
19850 ("alt.politics" -1000 728372 s))
19855 (mark-and-expunge -10)
19859 (files "/hom/larsi/News/gnu.SCORE")
19860 (exclude-files "all.SCORE")
19861 (local (gnus-newsgroup-auto-expire t)
19862 (gnus-summary-make-false-root empty))
19866 This example demonstrates most score file elements. @xref{Advanced
19867 Scoring}, for a different approach.
19869 Even though this looks much like Lisp code, nothing here is actually
19870 @code{eval}ed. The Lisp reader is used to read this form, though, so it
19871 has to be valid syntactically, if not semantically.
19873 Six keys are supported by this alist:
19878 If the key is a string, it is the name of the header to perform the
19879 match on. Scoring can only be performed on these eight headers:
19880 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
19881 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
19882 these headers, there are three strings to tell Gnus to fetch the entire
19883 article and do the match on larger parts of the article: @code{Body}
19884 will perform the match on the body of the article, @code{Head} will
19885 perform the match on the head of the article, and @code{All} will
19886 perform the match on the entire article. Note that using any of these
19887 last three keys will slow down group entry @emph{considerably}. The
19888 final ``header'' you can score on is @code{Followup}. These score
19889 entries will result in new score entries being added for all follow-ups
19890 to articles that matches these score entries.
19892 Following this key is an arbitrary number of score entries, where each
19893 score entry has one to four elements.
19897 The first element is the @dfn{match element}. On most headers this will
19898 be a string, but on the Lines and Chars headers, this must be an
19902 If the second element is present, it should be a number---the @dfn{score
19903 element}. This number should be an integer in the neginf to posinf
19904 interval. This number is added to the score of the article if the match
19905 is successful. If this element is not present, the
19906 @code{gnus-score-interactive-default-score} number will be used
19907 instead. This is 1000 by default.
19910 If the third element is present, it should be a number---the @dfn{date
19911 element}. This date says when the last time this score entry matched,
19912 which provides a mechanism for expiring the score entries. It this
19913 element is not present, the score entry is permanent. The date is
19914 represented by the number of days since December 31, 1 BCE.
19917 If the fourth element is present, it should be a symbol---the @dfn{type
19918 element}. This element specifies what function should be used to see
19919 whether this score entry matches the article. What match types that can
19920 be used depends on what header you wish to perform the match on.
19923 @item From, Subject, References, Xref, Message-ID
19924 For most header types, there are the @code{r} and @code{R} (regexp), as
19925 well as @code{s} and @code{S} (substring) types, and @code{e} and
19926 @code{E} (exact match), and @code{w} (word match) types. If this
19927 element is not present, Gnus will assume that substring matching should
19928 be used. @code{R}, @code{S}, and @code{E} differ from the others in
19929 that the matches will be done in a case-sensitive manner. All these
19930 one-letter types are really just abbreviations for the @code{regexp},
19931 @code{string}, @code{exact}, and @code{word} types, which you can use
19932 instead, if you feel like.
19935 Just as for the standard string overview headers, if you are using
19936 gnus-extra-headers, you can score on these headers' values. In this
19937 case, there is a 5th element in the score entry, being the name of the
19938 header to be scored. The following entry is useful in your
19939 @file{all.SCORE} file in case of spam attacks from a single origin
19940 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
19944 ("111.222.333.444" -1000 nil s
19945 "NNTP-Posting-Host")
19949 These two headers use different match types: @code{<}, @code{>},
19950 @code{=}, @code{>=} and @code{<=}.
19952 These predicates are true if
19955 (PREDICATE HEADER MATCH)
19958 evaluates to non-@code{nil}. For instance, the advanced match
19959 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
19966 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
19967 the match, we get the score added if the article has less than 4 lines.
19968 (It's easy to get confused and think it's the other way around. But
19969 it's not. I think.)
19971 When matching on @code{Lines}, be careful because some back ends (like
19972 @code{nndir}) do not generate @code{Lines} header, so every article ends
19973 up being marked as having 0 lines. This can lead to strange results if
19974 you happen to lower score of the articles with few lines.
19977 For the Date header we have three kinda silly match types:
19978 @code{before}, @code{at} and @code{after}. I can't really imagine this
19979 ever being useful, but, like, it would feel kinda silly not to provide
19980 this function. Just in case. You never know. Better safe than sorry.
19981 Once burnt, twice shy. Don't judge a book by its cover. Never not have
19982 sex on a first date. (I have been told that at least one person, and I
19983 quote, ``found this function indispensable'', however.)
19987 A more useful match type is @code{regexp}. With it, you can match the
19988 date string using a regular expression. The date is normalized to
19989 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
19990 you want to match all articles that have been posted on April 1st in
19991 every year, you could use @samp{....0401.........} as a match string,
19992 for instance. (Note that the date is kept in its original time zone, so
19993 this will match articles that were posted when it was April 1st where
19994 the article was posted from. Time zones are such wholesome fun for the
19997 @item Head, Body, All
19998 These three match keys use the same match types as the @code{From} (etc)
20002 This match key is somewhat special, in that it will match the
20003 @code{From} header, and affect the score of not only the matching
20004 articles, but also all followups to the matching articles. This allows
20005 you e.g. increase the score of followups to your own articles, or
20006 decrease the score of followups to the articles of some known
20007 trouble-maker. Uses the same match types as the @code{From} header
20008 uses. (Using this match key will lead to creation of @file{ADAPT}
20012 This match key works along the same lines as the @code{Followup} match
20013 key. If you say that you want to score on a (sub-)thread started by an
20014 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
20015 match. This will add a new @samp{thread} match for each article that
20016 has @var{x} in its @code{References} header. (These new @samp{thread}
20017 matches will use the @code{Message-ID}s of these matching articles.)
20018 This will ensure that you can raise/lower the score of an entire thread,
20019 even though some articles in the thread may not have complete
20020 @code{References} headers. Note that using this may lead to
20021 undeterministic scores of the articles in the thread. (Using this match
20022 key will lead to creation of @file{ADAPT} files.)
20026 @cindex score file atoms
20028 The value of this entry should be a number. Any articles with a score
20029 lower than this number will be marked as read.
20032 The value of this entry should be a number. Any articles with a score
20033 lower than this number will be removed from the summary buffer.
20035 @item mark-and-expunge
20036 The value of this entry should be a number. Any articles with a score
20037 lower than this number will be marked as read and removed from the
20040 @item thread-mark-and-expunge
20041 The value of this entry should be a number. All articles that belong to
20042 a thread that has a total score below this number will be marked as read
20043 and removed from the summary buffer. @code{gnus-thread-score-function}
20044 says how to compute the total score for a thread.
20047 The value of this entry should be any number of file names. These files
20048 are assumed to be score files as well, and will be loaded the same way
20051 @item exclude-files
20052 The clue of this entry should be any number of files. These files will
20053 not be loaded, even though they would normally be so, for some reason or
20057 The value of this entry will be @code{eval}el. This element will be
20058 ignored when handling global score files.
20061 Read-only score files will not be updated or saved. Global score files
20062 should feature this atom (@pxref{Global Score Files}). (Note:
20063 @dfn{Global} here really means @dfn{global}; not your personal
20064 apply-to-all-groups score files.)
20067 The value of this entry should be a number. Articles that do not have
20068 parents will get this number added to their scores. Imagine you follow
20069 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
20070 will only follow a few of the threads, also want to see any new threads.
20072 You can do this with the following two score file entries:
20076 (mark-and-expunge -100)
20079 When you enter the group the first time, you will only see the new
20080 threads. You then raise the score of the threads that you find
20081 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
20082 rest. Next time you enter the group, you will see new articles in the
20083 interesting threads, plus any new threads.
20085 I.e.---the orphan score atom is for high-volume groups where a few
20086 interesting threads which can't be found automatically by ordinary
20087 scoring rules exist.
20090 This entry controls the adaptive scoring. If it is @code{t}, the
20091 default adaptive scoring rules will be used. If it is @code{ignore}, no
20092 adaptive scoring will be performed on this group. If it is a list, this
20093 list will be used as the adaptive scoring rules. If it isn't present,
20094 or is something other than @code{t} or @code{ignore}, the default
20095 adaptive scoring rules will be used. If you want to use adaptive
20096 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
20097 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
20098 not want adaptive scoring. If you only want adaptive scoring in a few
20099 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
20100 insert @code{(adapt t)} in the score files of the groups where you want
20104 All adaptive score entries will go to the file named by this entry. It
20105 will also be applied when entering the group. This atom might be handy
20106 if you want to adapt on several groups at once, using the same adaptive
20107 file for a number of groups.
20110 @cindex local variables
20111 The value of this entry should be a list of @code{(@var{var}
20112 @var{value})} pairs. Each @var{var} will be made buffer-local to the
20113 current summary buffer, and set to the value specified. This is a
20114 convenient, if somewhat strange, way of setting variables in some
20115 groups if you don't like hooks much. Note that the @var{value} won't
20120 @node Score File Editing
20121 @section Score File Editing
20123 You normally enter all scoring commands from the summary buffer, but you
20124 might feel the urge to edit them by hand as well, so we've supplied you
20125 with a mode for that.
20127 It's simply a slightly customized @code{emacs-lisp} mode, with these
20128 additional commands:
20133 @kindex C-c C-c (Score)
20134 @findex gnus-score-edit-done
20135 Save the changes you have made and return to the summary buffer
20136 (@code{gnus-score-edit-done}).
20139 @kindex C-c C-d (Score)
20140 @findex gnus-score-edit-insert-date
20141 Insert the current date in numerical format
20142 (@code{gnus-score-edit-insert-date}). This is really the day number, if
20143 you were wondering.
20146 @kindex C-c C-p (Score)
20147 @findex gnus-score-pretty-print
20148 The adaptive score files are saved in an unformatted fashion. If you
20149 intend to read one of these files, you want to @dfn{pretty print} it
20150 first. This command (@code{gnus-score-pretty-print}) does that for
20155 Type @kbd{M-x gnus-score-mode} to use this mode.
20157 @vindex gnus-score-mode-hook
20158 @code{gnus-score-menu-hook} is run in score mode buffers.
20160 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
20161 @kbd{V t} to begin editing score files.
20164 @node Adaptive Scoring
20165 @section Adaptive Scoring
20166 @cindex adaptive scoring
20168 If all this scoring is getting you down, Gnus has a way of making it all
20169 happen automatically---as if by magic. Or rather, as if by artificial
20170 stupidity, to be precise.
20172 @vindex gnus-use-adaptive-scoring
20173 When you read an article, or mark an article as read, or kill an
20174 article, you leave marks behind. On exit from the group, Gnus can sniff
20175 these marks and add score elements depending on what marks it finds.
20176 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
20177 @code{t} or @code{(line)}. If you want score adaptively on separate
20178 words appearing in the subjects, you should set this variable to
20179 @code{(word)}. If you want to use both adaptive methods, set this
20180 variable to @code{(word line)}.
20182 @vindex gnus-default-adaptive-score-alist
20183 To give you complete control over the scoring process, you can customize
20184 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
20185 might look something like this:
20188 (setq gnus-default-adaptive-score-alist
20189 '((gnus-unread-mark)
20190 (gnus-ticked-mark (from 4))
20191 (gnus-dormant-mark (from 5))
20192 (gnus-del-mark (from -4) (subject -1))
20193 (gnus-read-mark (from 4) (subject 2))
20194 (gnus-expirable-mark (from -1) (subject -1))
20195 (gnus-killed-mark (from -1) (subject -3))
20196 (gnus-kill-file-mark)
20197 (gnus-ancient-mark)
20198 (gnus-low-score-mark)
20199 (gnus-catchup-mark (from -1) (subject -1))))
20202 As you see, each element in this alist has a mark as a key (either a
20203 variable name or a ``real'' mark---a character). Following this key is
20204 a arbitrary number of header/score pairs. If there are no header/score
20205 pairs following the key, no adaptive scoring will be done on articles
20206 that have that key as the article mark. For instance, articles with
20207 @code{gnus-unread-mark} in the example above will not get adaptive score
20210 Each article can have only one mark, so just a single of these rules
20211 will be applied to each article.
20213 To take @code{gnus-del-mark} as an example---this alist says that all
20214 articles that have that mark (i.e., are marked with @samp{e}) will have a
20215 score entry added to lower based on the @code{From} header by -4, and
20216 lowered by @code{Subject} by -1. Change this to fit your prejudices.
20218 If you have marked 10 articles with the same subject with
20219 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
20220 That means that that subject will get a score of ten times -1, which
20221 should be, unless I'm much mistaken, -10.
20223 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
20224 the read articles will be marked with the @samp{E} mark. This'll
20225 probably make adaptive scoring slightly impossible, so auto-expiring and
20226 adaptive scoring doesn't really mix very well.
20228 The headers you can score on are @code{from}, @code{subject},
20229 @code{message-id}, @code{references}, @code{xref}, @code{lines},
20230 @code{chars} and @code{date}. In addition, you can score on
20231 @code{followup}, which will create an adaptive score entry that matches
20232 on the @code{References} header using the @code{Message-ID} of the
20233 current article, thereby matching the following thread.
20235 If you use this scheme, you should set the score file atom @code{mark}
20236 to something small---like -300, perhaps, to avoid having small random
20237 changes result in articles getting marked as read.
20239 After using adaptive scoring for a week or so, Gnus should start to
20240 become properly trained and enhance the authors you like best, and kill
20241 the authors you like least, without you having to say so explicitly.
20243 You can control what groups the adaptive scoring is to be performed on
20244 by using the score files (@pxref{Score File Format}). This will also
20245 let you use different rules in different groups.
20247 @vindex gnus-adaptive-file-suffix
20248 The adaptive score entries will be put into a file where the name is the
20249 group name with @code{gnus-adaptive-file-suffix} appended. The default
20252 @vindex gnus-adaptive-pretty-print
20253 Adaptive score files can get huge and are not meant to be edited by
20254 human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the
20255 deafult) those files will not be written in a human readable way.
20257 @vindex gnus-score-exact-adapt-limit
20258 When doing adaptive scoring, substring or fuzzy matching would probably
20259 give you the best results in most cases. However, if the header one
20260 matches is short, the possibility for false positives is great, so if
20261 the length of the match is less than
20262 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
20263 this variable is @code{nil}, exact matching will always be used to avoid
20266 @vindex gnus-default-adaptive-word-score-alist
20267 As mentioned above, you can adapt either on individual words or entire
20268 headers. If you adapt on words, the
20269 @code{gnus-default-adaptive-word-score-alist} variable says what score
20270 each instance of a word should add given a mark.
20273 (setq gnus-default-adaptive-word-score-alist
20274 `((,gnus-read-mark . 30)
20275 (,gnus-catchup-mark . -10)
20276 (,gnus-killed-mark . -20)
20277 (,gnus-del-mark . -15)))
20280 This is the default value. If you have adaption on words enabled, every
20281 word that appears in subjects of articles marked with
20282 @code{gnus-read-mark} will result in a score rule that increase the
20283 score with 30 points.
20285 @vindex gnus-default-ignored-adaptive-words
20286 @vindex gnus-ignored-adaptive-words
20287 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
20288 will be ignored. If you wish to add more words to be ignored, use the
20289 @code{gnus-ignored-adaptive-words} list instead.
20291 @vindex gnus-adaptive-word-length-limit
20292 Some may feel that short words shouldn't count when doing adaptive
20293 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
20294 an integer. Words shorter than this number will be ignored. This
20295 variable defaults to @code{nil}.
20297 @vindex gnus-adaptive-word-syntax-table
20298 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
20299 syntax table in effect. It is similar to the standard syntax table, but
20300 it considers numbers to be non-word-constituent characters.
20302 @vindex gnus-adaptive-word-minimum
20303 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
20304 word scoring process will never bring down the score of an article to
20305 below this number. The default is @code{nil}.
20307 @vindex gnus-adaptive-word-no-group-words
20308 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
20309 won't adaptively word score any of the words in the group name. Useful
20310 for groups like @samp{comp.editors.emacs}, where most of the subject
20311 lines contain the word @samp{emacs}.
20313 After using this scheme for a while, it might be nice to write a
20314 @code{gnus-psychoanalyze-user} command to go through the rules and see
20315 what words you like and what words you don't like. Or perhaps not.
20317 Note that the adaptive word scoring thing is highly experimental and is
20318 likely to change in the future. Initial impressions seem to indicate
20319 that it's totally useless as it stands. Some more work (involving more
20320 rigorous statistical methods) will have to be done to make this useful.
20323 @node Home Score File
20324 @section Home Score File
20326 The score file where new score file entries will go is called the
20327 @dfn{home score file}. This is normally (and by default) the score file
20328 for the group itself. For instance, the home score file for
20329 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
20331 However, this may not be what you want. It is often convenient to share
20332 a common home score file among many groups---all @samp{emacs} groups
20333 could perhaps use the same home score file.
20335 @vindex gnus-home-score-file
20336 The variable that controls this is @code{gnus-home-score-file}. It can
20341 A string. Then this file will be used as the home score file for all
20345 A function. The result of this function will be used as the home score
20346 file. The function will be called with the name of the group as the
20350 A list. The elements in this list can be:
20354 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
20355 group name, the @var{file-name} will be used as the home score file.
20358 A function. If the function returns non-@code{nil}, the result will
20359 be used as the home score file.
20362 A string. Use the string as the home score file.
20365 The list will be traversed from the beginning towards the end looking
20370 So, if you want to use just a single score file, you could say:
20373 (setq gnus-home-score-file
20374 "my-total-score-file.SCORE")
20377 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
20378 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
20380 @findex gnus-hierarchial-home-score-file
20382 (setq gnus-home-score-file
20383 'gnus-hierarchial-home-score-file)
20386 This is a ready-made function provided for your convenience.
20387 Other functions include
20390 @item gnus-current-home-score-file
20391 @findex gnus-current-home-score-file
20392 Return the ``current'' regular score file. This will make scoring
20393 commands add entry to the ``innermost'' matching score file.
20397 If you want to have one score file for the @samp{emacs} groups and
20398 another for the @samp{comp} groups, while letting all other groups use
20399 their own home score files:
20402 (setq gnus-home-score-file
20403 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
20404 '(("\\.emacs" "emacs.SCORE")
20405 ;; @r{All the comp groups in one score file}
20406 ("^comp" "comp.SCORE")))
20409 @vindex gnus-home-adapt-file
20410 @code{gnus-home-adapt-file} works exactly the same way as
20411 @code{gnus-home-score-file}, but says what the home adaptive score file
20412 is instead. All new adaptive file entries will go into the file
20413 specified by this variable, and the same syntax is allowed.
20415 In addition to using @code{gnus-home-score-file} and
20416 @code{gnus-home-adapt-file}, you can also use group parameters
20417 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
20418 Parameters}) to achieve much the same. Group and topic parameters take
20419 precedence over this variable.
20422 @node Followups To Yourself
20423 @section Followups To Yourself
20425 Gnus offers two commands for picking out the @code{Message-ID} header in
20426 the current buffer. Gnus will then add a score rule that scores using
20427 this @code{Message-ID} on the @code{References} header of other
20428 articles. This will, in effect, increase the score of all articles that
20429 respond to the article in the current buffer. Quite useful if you want
20430 to easily note when people answer what you've said.
20434 @item gnus-score-followup-article
20435 @findex gnus-score-followup-article
20436 This will add a score to articles that directly follow up your own
20439 @item gnus-score-followup-thread
20440 @findex gnus-score-followup-thread
20441 This will add a score to all articles that appear in a thread ``below''
20445 @vindex message-sent-hook
20446 These two functions are both primarily meant to be used in hooks like
20447 @code{message-sent-hook}, like this:
20449 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
20453 If you look closely at your own @code{Message-ID}, you'll notice that
20454 the first two or three characters are always the same. Here's two of
20458 <x6u3u47icf.fsf@@eyesore.no>
20459 <x6sp9o7ibw.fsf@@eyesore.no>
20462 So ``my'' ident on this machine is @samp{x6}. This can be
20463 exploited---the following rule will raise the score on all followups to
20468 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
20472 Whether it's the first two or first three characters that are ``yours''
20473 is system-dependent.
20476 @node Scoring On Other Headers
20477 @section Scoring On Other Headers
20478 @cindex scoring on other headers
20480 Gnus is quite fast when scoring the ``traditional''
20481 headers---@samp{From}, @samp{Subject} and so on. However, scoring
20482 other headers requires writing a @code{head} scoring rule, which means
20483 that Gnus has to request every single article from the back end to find
20484 matches. This takes a long time in big groups.
20486 Now, there's not much you can do about this for news groups, but for
20487 mail groups, you have greater control. In @ref{To From Newsgroups},
20488 it's explained in greater detail what this mechanism does, but here's
20489 a cookbook example for @code{nnml} on how to allow scoring on the
20490 @samp{To} and @samp{Cc} headers.
20492 Put the following in your @file{~/.gnus.el} file.
20495 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
20496 nnmail-extra-headers gnus-extra-headers)
20499 Restart Gnus and rebuild your @code{nnml} overview files with the
20500 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
20501 time if you have much mail.
20503 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
20504 so: @kbd{I e s p To RET <your name> RET}.
20510 @section Scoring Tips
20511 @cindex scoring tips
20517 @cindex scoring crossposts
20518 If you want to lower the score of crossposts, the line to match on is
20519 the @code{Xref} header.
20521 ("xref" (" talk.politics.misc:" -1000))
20524 @item Multiple crossposts
20525 If you want to lower the score of articles that have been crossposted to
20526 more than, say, 3 groups:
20529 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
20533 @item Matching on the body
20534 This is generally not a very good idea---it takes a very long time.
20535 Gnus actually has to fetch each individual article from the server. But
20536 you might want to anyway, I guess. Even though there are three match
20537 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
20538 and stick with it in each score file. If you use any two, each article
20539 will be fetched @emph{twice}. If you want to match a bit on the
20540 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
20543 @item Marking as read
20544 You will probably want to mark articles that have scores below a certain
20545 number as read. This is most easily achieved by putting the following
20546 in your @file{all.SCORE} file:
20550 You may also consider doing something similar with @code{expunge}.
20552 @item Negated character classes
20553 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
20554 That will match newlines, which might lead to, well, The Unknown. Say
20555 @code{[^abcd\n]*} instead.
20559 @node Reverse Scoring
20560 @section Reverse Scoring
20561 @cindex reverse scoring
20563 If you want to keep just articles that have @samp{Sex with Emacs} in the
20564 subject header, and expunge all other articles, you could put something
20565 like this in your score file:
20569 ("Sex with Emacs" 2))
20574 So, you raise all articles that match @samp{Sex with Emacs} and mark the
20575 rest as read, and expunge them to boot.
20578 @node Global Score Files
20579 @section Global Score Files
20580 @cindex global score files
20582 Sure, other newsreaders have ``global kill files''. These are usually
20583 nothing more than a single kill file that applies to all groups, stored
20584 in the user's home directory. Bah! Puny, weak newsreaders!
20586 What I'm talking about here are Global Score Files. Score files from
20587 all over the world, from users everywhere, uniting all nations in one
20588 big, happy score file union! Ange-score! New and untested!
20590 @vindex gnus-global-score-files
20591 All you have to do to use other people's score files is to set the
20592 @code{gnus-global-score-files} variable. One entry for each score file,
20593 or each score file directory. Gnus will decide by itself what score
20594 files are applicable to which group.
20596 To use the score file
20597 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
20598 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
20602 (setq gnus-global-score-files
20603 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
20604 "/ftp@@ftp.some-where:/pub/score/"))
20607 @findex gnus-score-search-global-directories
20609 Simple, eh? Directory names must end with a @samp{/}. These
20610 directories are typically scanned only once during each Gnus session.
20611 If you feel the need to manually re-scan the remote directories, you can
20612 use the @code{gnus-score-search-global-directories} command.
20614 Note that, at present, using this option will slow down group entry
20615 somewhat. (That is---a lot.)
20617 If you want to start maintaining score files for other people to use,
20618 just put your score file up for anonymous ftp and announce it to the
20619 world. Become a retro-moderator! Participate in the retro-moderator
20620 wars sure to ensue, where retro-moderators battle it out for the
20621 sympathy of the people, luring them to use their score files on false
20622 premises! Yay! The net is saved!
20624 Here are some tips for the would-be retro-moderator, off the top of my
20630 Articles heavily crossposted are probably junk.
20632 To lower a single inappropriate article, lower by @code{Message-ID}.
20634 Particularly brilliant authors can be raised on a permanent basis.
20636 Authors that repeatedly post off-charter for the group can safely be
20637 lowered out of existence.
20639 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
20640 articles completely.
20643 Use expiring score entries to keep the size of the file down. You
20644 should probably have a long expiry period, though, as some sites keep
20645 old articles for a long time.
20648 @dots{} I wonder whether other newsreaders will support global score files
20649 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
20650 Wave, xrn and 1stReader are bound to implement scoring. Should we start
20651 holding our breath yet?
20655 @section Kill Files
20658 Gnus still supports those pesky old kill files. In fact, the kill file
20659 entries can now be expiring, which is something I wrote before Daniel
20660 Quinlan thought of doing score files, so I've left the code in there.
20662 In short, kill processing is a lot slower (and I do mean @emph{a lot})
20663 than score processing, so it might be a good idea to rewrite your kill
20664 files into score files.
20666 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
20667 forms into this file, which means that you can use kill files as some
20668 sort of primitive hook function to be run on group entry, even though
20669 that isn't a very good idea.
20671 Normal kill files look like this:
20674 (gnus-kill "From" "Lars Ingebrigtsen")
20675 (gnus-kill "Subject" "ding")
20679 This will mark every article written by me as read, and remove the
20680 marked articles from the summary buffer. Very useful, you'll agree.
20682 Other programs use a totally different kill file syntax. If Gnus
20683 encounters what looks like a @code{rn} kill file, it will take a stab at
20686 Two summary functions for editing a @sc{gnus} kill file:
20691 @kindex M-k (Summary)
20692 @findex gnus-summary-edit-local-kill
20693 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
20696 @kindex M-K (Summary)
20697 @findex gnus-summary-edit-global-kill
20698 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
20701 Two group mode functions for editing the kill files:
20706 @kindex M-k (Group)
20707 @findex gnus-group-edit-local-kill
20708 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
20711 @kindex M-K (Group)
20712 @findex gnus-group-edit-global-kill
20713 Edit the general kill file (@code{gnus-group-edit-global-kill}).
20716 Kill file variables:
20719 @item gnus-kill-file-name
20720 @vindex gnus-kill-file-name
20721 A kill file for the group @samp{soc.motss} is normally called
20722 @file{soc.motss.KILL}. The suffix appended to the group name to get
20723 this file name is detailed by the @code{gnus-kill-file-name} variable.
20724 The ``global'' kill file (not in the score file sense of ``global'', of
20725 course) is just called @file{KILL}.
20727 @vindex gnus-kill-save-kill-file
20728 @item gnus-kill-save-kill-file
20729 If this variable is non-@code{nil}, Gnus will save the
20730 kill file after processing, which is necessary if you use expiring
20733 @item gnus-apply-kill-hook
20734 @vindex gnus-apply-kill-hook
20735 @findex gnus-apply-kill-file-unless-scored
20736 @findex gnus-apply-kill-file
20737 A hook called to apply kill files to a group. It is
20738 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
20739 kill file if you have a score file for the same group, you can set this
20740 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
20741 kill files to be processed, you should set this variable to @code{nil}.
20743 @item gnus-kill-file-mode-hook
20744 @vindex gnus-kill-file-mode-hook
20745 A hook called in kill-file mode buffers.
20750 @node Converting Kill Files
20751 @section Converting Kill Files
20753 @cindex converting kill files
20755 If you have loads of old kill files, you may want to convert them into
20756 score files. If they are ``regular'', you can use
20757 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
20760 The kill to score conversion package isn't included in Gnus by default.
20761 You can fetch it from
20762 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
20764 If your old kill files are very complex---if they contain more
20765 non-@code{gnus-kill} forms than not, you'll have to convert them by
20766 hand. Or just let them be as they are. Gnus will still use them as
20770 @node Advanced Scoring
20771 @section Advanced Scoring
20773 Scoring on Subjects and From headers is nice enough, but what if you're
20774 really interested in what a person has to say only when she's talking
20775 about a particular subject? Or what if you really don't want to
20776 read what person A has to say when she's following up to person B, but
20777 want to read what she says when she's following up to person C?
20779 By using advanced scoring rules you may create arbitrarily complex
20783 * Advanced Scoring Syntax:: A definition.
20784 * Advanced Scoring Examples:: What they look like.
20785 * Advanced Scoring Tips:: Getting the most out of it.
20789 @node Advanced Scoring Syntax
20790 @subsection Advanced Scoring Syntax
20792 Ordinary scoring rules have a string as the first element in the rule.
20793 Advanced scoring rules have a list as the first element. The second
20794 element is the score to be applied if the first element evaluated to a
20795 non-@code{nil} value.
20797 These lists may consist of three logical operators, one redirection
20798 operator, and various match operators.
20805 This logical operator will evaluate each of its arguments until it finds
20806 one that evaluates to @code{false}, and then it'll stop. If all arguments
20807 evaluate to @code{true} values, then this operator will return
20812 This logical operator will evaluate each of its arguments until it finds
20813 one that evaluates to @code{true}. If no arguments are @code{true},
20814 then this operator will return @code{false}.
20819 This logical operator only takes a single argument. It returns the
20820 logical negation of the value of its argument.
20824 There is an @dfn{indirection operator} that will make its arguments
20825 apply to the ancestors of the current article being scored. For
20826 instance, @code{1-} will make score rules apply to the parent of the
20827 current article. @code{2-} will make score rules apply to the
20828 grandparent of the current article. Alternatively, you can write
20829 @code{^^}, where the number of @code{^}s (carets) says how far back into
20830 the ancestry you want to go.
20832 Finally, we have the match operators. These are the ones that do the
20833 real work. Match operators are header name strings followed by a match
20834 and a match type. A typical match operator looks like @samp{("from"
20835 "Lars Ingebrigtsen" s)}. The header names are the same as when using
20836 simple scoring, and the match types are also the same.
20839 @node Advanced Scoring Examples
20840 @subsection Advanced Scoring Examples
20842 Please note that the following examples are score file rules. To
20843 make a complete score file from them, surround them with another pair
20846 Let's say you want to increase the score of articles written by Lars
20847 when he's talking about Gnus:
20852 ("from" "Lars Ingebrigtsen")
20853 ("subject" "Gnus"))
20860 When he writes long articles, he sometimes has something nice to say:
20864 ("from" "Lars Ingebrigtsen")
20871 However, when he responds to things written by Reig Eigil Logge, you
20872 really don't want to read what he's written:
20876 ("from" "Lars Ingebrigtsen")
20877 (1- ("from" "Reig Eigir Logge")))
20881 Everybody that follows up Redmondo when he writes about disappearing
20882 socks should have their scores raised, but only when they talk about
20883 white socks. However, when Lars talks about socks, it's usually not
20890 ("from" "redmondo@@.*no" r)
20891 ("body" "disappearing.*socks" t)))
20892 (! ("from" "Lars Ingebrigtsen"))
20893 ("body" "white.*socks"))
20897 The possibilities are endless.
20900 @node Advanced Scoring Tips
20901 @subsection Advanced Scoring Tips
20903 The @code{&} and @code{|} logical operators do short-circuit logic.
20904 That is, they stop processing their arguments when it's clear what the
20905 result of the operation will be. For instance, if one of the arguments
20906 of an @code{&} evaluates to @code{false}, there's no point in evaluating
20907 the rest of the arguments. This means that you should put slow matches
20908 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
20909 @samp{subject}) first.
20911 The indirection arguments (@code{1-} and so on) will make their
20912 arguments work on previous generations of the thread. If you say
20923 Then that means ``score on the from header of the grandparent of the
20924 current article''. An indirection is quite fast, but it's better to say:
20930 ("subject" "Gnus")))
20937 (1- ("from" "Lars"))
20938 (1- ("subject" "Gnus")))
20943 @section Score Decays
20944 @cindex score decays
20947 You may find that your scores have a tendency to grow without
20948 bounds, especially if you're using adaptive scoring. If scores get too
20949 big, they lose all meaning---they simply max out and it's difficult to
20950 use them in any sensible way.
20952 @vindex gnus-decay-scores
20953 @findex gnus-decay-score
20954 @vindex gnus-decay-score-function
20955 Gnus provides a mechanism for decaying scores to help with this problem.
20956 When score files are loaded and @code{gnus-decay-scores} is
20957 non-@code{nil}, Gnus will run the score files through the decaying
20958 mechanism thereby lowering the scores of all non-permanent score rules.
20959 If @code{gnus-decay-scores} is a regexp, only score files matching this
20960 regexp are treated. E.g. you may set it to @samp{\\.ADAPT\\'} if only
20961 @emph{adaptive} score files should be decayed. The decay itself if
20962 performed by the @code{gnus-decay-score-function} function, which is
20963 @code{gnus-decay-score} by default. Here's the definition of that
20967 (defun gnus-decay-score (score)
20968 "Decay SCORE according to `gnus-score-decay-constant'
20969 and `gnus-score-decay-scale'."
20971 (* (if (< score 0) -1 1)
20973 (max gnus-score-decay-constant
20975 gnus-score-decay-scale)))))))
20976 (if (and (featurep 'xemacs)
20977 ;; XEmacs' floor can handle only the floating point
20978 ;; number below the half of the maximum integer.
20979 (> (abs n) (lsh -1 -2)))
20981 (car (split-string (number-to-string n) "\\.")))
20985 @vindex gnus-score-decay-scale
20986 @vindex gnus-score-decay-constant
20987 @code{gnus-score-decay-constant} is 3 by default and
20988 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
20992 Scores between -3 and 3 will be set to 0 when this function is called.
20995 Scores with magnitudes between 3 and 60 will be shrunk by 3.
20998 Scores with magnitudes greater than 60 will be shrunk by 5% of the
21002 If you don't like this decay function, write your own. It is called
21003 with the score to be decayed as its only parameter, and it should return
21004 the new score, which should be an integer.
21006 Gnus will try to decay scores once a day. If you haven't run Gnus for
21007 four days, Gnus will decay the scores four times, for instance.
21012 @include message.texi
21013 @chapter Emacs MIME
21014 @include emacs-mime.texi
21016 @include sieve.texi
21018 @c @include pgg.texi
21020 @c @include sasl.texi
21028 * Process/Prefix:: A convention used by many treatment commands.
21029 * Interactive:: Making Gnus ask you many questions.
21030 * Symbolic Prefixes:: How to supply some Gnus functions with options.
21031 * Formatting Variables:: You can specify what buffers should look like.
21032 * Window Layout:: Configuring the Gnus buffer windows.
21033 * Faces and Fonts:: How to change how faces look.
21034 * Compilation:: How to speed Gnus up.
21035 * Mode Lines:: Displaying information in the mode lines.
21036 * Highlighting and Menus:: Making buffers look all nice and cozy.
21037 * Buttons:: Get tendinitis in ten easy steps!
21038 * Daemons:: Gnus can do things behind your back.
21039 * NoCeM:: How to avoid spam and other fatty foods.
21040 * Undo:: Some actions can be undone.
21041 * Predicate Specifiers:: Specifying predicates.
21042 * Moderation:: What to do if you're a moderator.
21043 * Fetching a Group:: Starting Gnus just to read a group.
21044 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
21045 * Fuzzy Matching:: What's the big fuzz?
21046 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
21047 * Other modes:: Interaction with other modes.
21048 * Various Various:: Things that are really various.
21052 @node Process/Prefix
21053 @section Process/Prefix
21054 @cindex process/prefix convention
21056 Many functions, among them functions for moving, decoding and saving
21057 articles, use what is known as the @dfn{Process/Prefix convention}.
21059 This is a method for figuring out what articles the user wants the
21060 command to be performed on.
21064 If the numeric prefix is N, perform the operation on the next N
21065 articles, starting with the current one. If the numeric prefix is
21066 negative, perform the operation on the previous N articles, starting
21067 with the current one.
21069 @vindex transient-mark-mode
21070 If @code{transient-mark-mode} in non-@code{nil} and the region is
21071 active, all articles in the region will be worked upon.
21073 If there is no numeric prefix, but some articles are marked with the
21074 process mark, perform the operation on the articles marked with
21077 If there is neither a numeric prefix nor any articles marked with the
21078 process mark, just perform the operation on the current article.
21080 Quite simple, really, but it needs to be made clear so that surprises
21083 Commands that react to the process mark will push the current list of
21084 process marked articles onto a stack and will then clear all process
21085 marked articles. You can restore the previous configuration with the
21086 @kbd{M P y} command (@pxref{Setting Process Marks}).
21088 @vindex gnus-summary-goto-unread
21089 One thing that seems to shock & horrify lots of people is that, for
21090 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
21091 Since each @kbd{d} (which marks the current article as read) by default
21092 goes to the next unread article after marking, this means that @kbd{3 d}
21093 will mark the next three unread articles as read, no matter what the
21094 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
21095 @code{nil} for a more straightforward action.
21097 Many commands do not use the process/prefix convention. All commands
21098 that do explicitly say so in this manual. To apply the process/prefix
21099 convention to commands that do not use it, you can use the @kbd{M-&}
21100 command. For instance, to mark all the articles in the group as
21101 expirable, you could say @kbd{M P b M-& E}.
21105 @section Interactive
21106 @cindex interaction
21110 @item gnus-novice-user
21111 @vindex gnus-novice-user
21112 If this variable is non-@code{nil}, you are either a newcomer to the
21113 World of Usenet, or you are very cautious, which is a nice thing to be,
21114 really. You will be given questions of the type ``Are you sure you want
21115 to do this?'' before doing anything dangerous. This is @code{t} by
21118 @item gnus-expert-user
21119 @vindex gnus-expert-user
21120 If this variable is non-@code{nil}, you will seldom be asked any
21121 questions by Gnus. It will simply assume you know what you're doing, no
21122 matter how strange.
21124 @item gnus-interactive-catchup
21125 @vindex gnus-interactive-catchup
21126 Require confirmation before catching up a group if non-@code{nil}. It
21127 is @code{t} by default.
21129 @item gnus-interactive-exit
21130 @vindex gnus-interactive-exit
21131 Require confirmation before exiting Gnus. This variable is @code{t} by
21136 @node Symbolic Prefixes
21137 @section Symbolic Prefixes
21138 @cindex symbolic prefixes
21140 Quite a lot of Emacs commands react to the (numeric) prefix. For
21141 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
21142 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
21143 rule of 900 to the current article.
21145 This is all nice and well, but what if you want to give a command some
21146 additional information? Well, what most commands do is interpret the
21147 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
21148 doesn't want a backup file to be created when saving the current buffer,
21149 for instance. But what if you want to save without making a backup
21150 file, and you want Emacs to flash lights and play a nice tune at the
21151 same time? You can't, and you're probably perfectly happy that way.
21153 @kindex M-i (Summary)
21154 @findex gnus-symbolic-argument
21155 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
21156 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
21157 character typed in is the value. You can stack as many @kbd{M-i}
21158 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
21159 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
21160 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
21161 @code{b}''. You get the drift.
21163 Typing in symbolic prefixes to commands that don't accept them doesn't
21164 hurt, but it doesn't do any good either. Currently not many Gnus
21165 functions make use of the symbolic prefix.
21167 If you're interested in how Gnus implements this, @pxref{Extended
21171 @node Formatting Variables
21172 @section Formatting Variables
21173 @cindex formatting variables
21175 Throughout this manual you've probably noticed lots of variables called
21176 things like @code{gnus-group-line-format} and
21177 @code{gnus-summary-mode-line-format}. These control how Gnus is to
21178 output lines in the various buffers. There's quite a lot of them.
21179 Fortunately, they all use the same syntax, so there's not that much to
21182 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
21183 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
21184 lots of percentages everywhere.
21187 * Formatting Basics:: A formatting variable is basically a format string.
21188 * Mode Line Formatting:: Some rules about mode line formatting variables.
21189 * Advanced Formatting:: Modifying output in various ways.
21190 * User-Defined Specs:: Having Gnus call your own functions.
21191 * Formatting Fonts:: Making the formatting look colorful and nice.
21192 * Positioning Point:: Moving point to a position after an operation.
21193 * Tabulation:: Tabulating your output.
21194 * Wide Characters:: Dealing with wide characters.
21197 Currently Gnus uses the following formatting variables:
21198 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
21199 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
21200 @code{gnus-group-mode-line-format},
21201 @code{gnus-summary-mode-line-format},
21202 @code{gnus-article-mode-line-format},
21203 @code{gnus-server-mode-line-format}, and
21204 @code{gnus-summary-pick-line-format}.
21206 All these format variables can also be arbitrary elisp forms. In that
21207 case, they will be @code{eval}ed to insert the required lines.
21209 @kindex M-x gnus-update-format
21210 @findex gnus-update-format
21211 Gnus includes a command to help you while creating your own format
21212 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
21213 update the spec in question and pop you to a buffer where you can
21214 examine the resulting Lisp code to be run to generate the line.
21218 @node Formatting Basics
21219 @subsection Formatting Basics
21221 Each @samp{%} element will be replaced by some string or other when the
21222 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
21223 spec, and pad with spaces to get a 5-character field''.
21225 As with normal C and Emacs Lisp formatting strings, the numerical
21226 modifier between the @samp{%} and the formatting type character will
21227 @dfn{pad} the output so that it is always at least that long.
21228 @samp{%5y} will make the field always (at least) five characters wide by
21229 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
21232 You may also wish to limit the length of the field to protect against
21233 particularly wide values. For that you can say @samp{%4,6y}, which
21234 means that the field will never be more than 6 characters wide and never
21235 less than 4 characters wide.
21237 Also Gnus supports some extended format specifications, such as
21238 @samp{%&user-date;}.
21241 @node Mode Line Formatting
21242 @subsection Mode Line Formatting
21244 Mode line formatting variables (e.g.,
21245 @code{gnus-summary-mode-line-format}) follow the same rules as other,
21246 buffer line oriented formatting variables (@pxref{Formatting Basics})
21247 with the following two differences:
21252 There must be no newline (@samp{\n}) at the end.
21255 The special @samp{%%b} spec can be used to display the buffer name.
21256 Well, it's no spec at all, really---@samp{%%} is just a way to quote
21257 @samp{%} to allow it to pass through the formatting machinery unmangled,
21258 so that Emacs receives @samp{%b}, which is something the Emacs mode line
21259 display interprets to mean ``show the buffer name''. For a full list of
21260 mode line specs Emacs understands, see the documentation of the
21261 @code{mode-line-format} variable.
21266 @node Advanced Formatting
21267 @subsection Advanced Formatting
21269 It is frequently useful to post-process the fields in some way.
21270 Padding, limiting, cutting off parts and suppressing certain values can
21271 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
21272 look like @samp{%~(cut 3)~(ignore "0")y}.
21274 These are the valid modifiers:
21279 Pad the field to the left with spaces until it reaches the required
21283 Pad the field to the right with spaces until it reaches the required
21288 Cut off characters from the left until it reaches the specified length.
21291 Cut off characters from the right until it reaches the specified
21296 Cut off the specified number of characters from the left.
21299 Cut off the specified number of characters from the right.
21302 Return an empty string if the field is equal to the specified value.
21305 Use the specified form as the field value when the @samp{@@} spec is
21311 "~(form (current-time-string))@@"
21316 Let's take an example. The @samp{%o} spec in the summary mode lines
21317 will return a date in compact ISO8601 format---@samp{19960809T230410}.
21318 This is quite a mouthful, so we want to shave off the century number and
21319 the time, leaving us with a six-character date. That would be
21320 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
21321 maxing, and we need the padding to ensure that the date is never less
21322 than 6 characters to make it look nice in columns.)
21324 Ignoring is done first; then cutting; then maxing; and then as the very
21325 last operation, padding.
21327 @vindex gnus-compile-user-specs
21328 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
21329 default) with your strong personality, and use a lots of these advanced
21330 thingies, you'll find that Gnus gets quite slow. This can be helped
21331 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
21332 the look of your lines.
21333 @xref{Compilation}.
21336 @node User-Defined Specs
21337 @subsection User-Defined Specs
21339 All the specs allow for inserting user defined specifiers---@samp{u}.
21340 The next character in the format string should be a letter. Gnus
21341 will call the function @code{gnus-user-format-function-}@samp{X}, where
21342 @samp{X} is the letter following @samp{%u}. The function will be passed
21343 a single parameter---what the parameter means depends on what buffer
21344 it's being called from. The function should return a string, which will
21345 be inserted into the buffer just like information from any other
21346 specifier. This function may also be called with dummy values, so it
21347 should protect against that.
21349 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
21350 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
21352 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
21353 much the same without defining new functions. Here's an example:
21354 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
21355 given here will be evaluated to yield the current line number, and then
21359 @node Formatting Fonts
21360 @subsection Formatting Fonts
21362 There are specs for highlighting, and these are shared by all the format
21363 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
21364 the special @code{mouse-face} property set, which means that it will be
21365 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
21368 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
21369 normal faces set using @code{gnus-face-0}, which is @code{bold} by
21370 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
21371 and so on. Create as many faces as you wish. The same goes for the
21372 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
21373 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
21375 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
21376 special @code{balloon-help} property set to
21377 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
21378 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
21379 variables should be either strings or symbols naming functions that
21380 return a string. When the mouse passes over text with this property
21381 set, a balloon window will appear and display the string. Please
21382 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
21383 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
21384 XEmacs) for more information on this. (For technical reasons, the
21385 guillemets have been approximated as @samp{<<} and @samp{>>} in this
21388 Here's an alternative recipe for the group buffer:
21391 ;; @r{Create three face types.}
21392 (setq gnus-face-1 'bold)
21393 (setq gnus-face-3 'italic)
21395 ;; @r{We want the article count to be in}
21396 ;; @r{a bold and green face. So we create}
21397 ;; @r{a new face called @code{my-green-bold}.}
21398 (copy-face 'bold 'my-green-bold)
21399 ;; @r{Set the color.}
21400 (set-face-foreground 'my-green-bold "ForestGreen")
21401 (setq gnus-face-2 'my-green-bold)
21403 ;; @r{Set the new & fancy format.}
21404 (setq gnus-group-line-format
21405 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
21408 I'm sure you'll be able to use this scheme to create totally unreadable
21409 and extremely vulgar displays. Have fun!
21411 Note that the @samp{%(} specs (and friends) do not make any sense on the
21412 mode-line variables.
21414 @node Positioning Point
21415 @subsection Positioning Point
21417 Gnus usually moves point to a pre-defined place on each line in most
21418 buffers. By default, point move to the first colon character on the
21419 line. You can customize this behavior in three different ways.
21421 You can move the colon character to somewhere else on the line.
21423 @findex gnus-goto-colon
21424 You can redefine the function that moves the point to the colon. The
21425 function is called @code{gnus-goto-colon}.
21427 But perhaps the most convenient way to deal with this, if you don't want
21428 to have a colon in your line, is to use the @samp{%*} specifier. If you
21429 put a @samp{%*} somewhere in your format line definition, Gnus will
21434 @subsection Tabulation
21436 You can usually line up your displays by padding and cutting your
21437 strings. However, when combining various strings of different size, it
21438 can often be more convenient to just output the strings, and then worry
21439 about lining up the following text afterwards.
21441 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
21442 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
21444 @samp{%50=} will insert space characters to pad the line up to column
21445 50. If the text is already past column 50, nothing will be inserted.
21446 This is the soft tabulator.
21448 @samp{%-50=} will insert space characters to pad the line up to column
21449 50. If the text is already past column 50, the excess text past column
21450 50 will be removed. This is the hard tabulator.
21453 @node Wide Characters
21454 @subsection Wide Characters
21456 Fixed width fonts in most countries have characters of the same width.
21457 Some countries, however, use Latin characters mixed with wider
21458 characters---most notable East Asian countries.
21460 The problem is that when formatting, Gnus assumes that if a string is 10
21461 characters wide, it'll be 10 Latin characters wide on the screen. In
21462 these countries, that's not true.
21464 @vindex gnus-use-correct-string-widths
21465 To help fix this, you can set @code{gnus-use-correct-string-widths} to
21466 @code{t}. This makes buffer generation slower, but the results will be
21467 prettier. The default value under XEmacs is @code{t} but @code{nil}
21471 @node Window Layout
21472 @section Window Layout
21473 @cindex window layout
21475 No, there's nothing here about X, so be quiet.
21477 @vindex gnus-use-full-window
21478 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
21479 other windows and occupy the entire Emacs screen by itself. It is
21480 @code{t} by default.
21482 Setting this variable to @code{nil} kinda works, but there are
21483 glitches. Use at your own peril.
21485 @vindex gnus-buffer-configuration
21486 @code{gnus-buffer-configuration} describes how much space each Gnus
21487 buffer should be given. Here's an excerpt of this variable:
21490 ((group (vertical 1.0 (group 1.0 point)
21491 (if gnus-carpal (group-carpal 4))))
21492 (article (vertical 1.0 (summary 0.25 point)
21496 This is an alist. The @dfn{key} is a symbol that names some action or
21497 other. For instance, when displaying the group buffer, the window
21498 configuration function will use @code{group} as the key. A full list of
21499 possible names is listed below.
21501 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
21502 should occupy. To take the @code{article} split as an example -
21505 (article (vertical 1.0 (summary 0.25 point)
21509 This @dfn{split} says that the summary buffer should occupy 25% of upper
21510 half of the screen, and that it is placed over the article buffer. As
21511 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
21512 reaching for that calculator there). However, the special number
21513 @code{1.0} is used to signal that this buffer should soak up all the
21514 rest of the space available after the rest of the buffers have taken
21515 whatever they need. There should be only one buffer with the @code{1.0}
21516 size spec per split.
21518 Point will be put in the buffer that has the optional third element
21519 @code{point}. In a @code{frame} split, the last subsplit having a leaf
21520 split where the tag @code{frame-focus} is a member (i.e. is the third or
21521 fourth element in the list, depending on whether the @code{point} tag is
21522 present) gets focus.
21524 Here's a more complicated example:
21527 (article (vertical 1.0 (group 4)
21528 (summary 0.25 point)
21529 (if gnus-carpal (summary-carpal 4))
21533 If the size spec is an integer instead of a floating point number,
21534 then that number will be used to say how many lines a buffer should
21535 occupy, not a percentage.
21537 If the @dfn{split} looks like something that can be @code{eval}ed (to be
21538 precise---if the @code{car} of the split is a function or a subr), this
21539 split will be @code{eval}ed. If the result is non-@code{nil}, it will
21540 be used as a split. This means that there will be three buffers if
21541 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
21544 Not complicated enough for you? Well, try this on for size:
21547 (article (horizontal 1.0
21552 (summary 0.25 point)
21557 Whoops. Two buffers with the mystery 100% tag. And what's that
21558 @code{horizontal} thingie?
21560 If the first element in one of the split is @code{horizontal}, Gnus will
21561 split the window horizontally, giving you two windows side-by-side.
21562 Inside each of these strips you may carry on all you like in the normal
21563 fashion. The number following @code{horizontal} says what percentage of
21564 the screen is to be given to this strip.
21566 For each split, there @emph{must} be one element that has the 100% tag.
21567 The splitting is never accurate, and this buffer will eat any leftover
21568 lines from the splits.
21570 To be slightly more formal, here's a definition of what a valid split
21575 split = frame | horizontal | vertical | buffer | form
21576 frame = "(frame " size *split ")"
21577 horizontal = "(horizontal " size *split ")"
21578 vertical = "(vertical " size *split ")"
21579 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
21580 size = number | frame-params
21581 buf-name = group | article | summary ...
21585 The limitations are that the @code{frame} split can only appear as the
21586 top-level split. @var{form} should be an Emacs Lisp form that should
21587 return a valid split. We see that each split is fully recursive, and
21588 may contain any number of @code{vertical} and @code{horizontal} splits.
21590 @vindex gnus-window-min-width
21591 @vindex gnus-window-min-height
21592 @cindex window height
21593 @cindex window width
21594 Finding the right sizes can be a bit complicated. No window may be less
21595 than @code{gnus-window-min-height} (default 1) characters high, and all
21596 windows must be at least @code{gnus-window-min-width} (default 1)
21597 characters wide. Gnus will try to enforce this before applying the
21598 splits. If you want to use the normal Emacs window width/height limit,
21599 you can just set these two variables to @code{nil}.
21601 If you're not familiar with Emacs terminology, @code{horizontal} and
21602 @code{vertical} splits may work the opposite way of what you'd expect.
21603 Windows inside a @code{horizontal} split are shown side-by-side, and
21604 windows within a @code{vertical} split are shown above each other.
21606 @findex gnus-configure-frame
21607 If you want to experiment with window placement, a good tip is to call
21608 @code{gnus-configure-frame} directly with a split. This is the function
21609 that does all the real work when splitting buffers. Below is a pretty
21610 nonsensical configuration with 5 windows; two for the group buffer and
21611 three for the article buffer. (I said it was nonsensical.) If you
21612 @code{eval} the statement below, you can get an idea of how that would
21613 look straight away, without going through the normal Gnus channels.
21614 Play with it until you're satisfied, and then use
21615 @code{gnus-add-configuration} to add your new creation to the buffer
21616 configuration list.
21619 (gnus-configure-frame
21623 (article 0.3 point))
21631 You might want to have several frames as well. No prob---just use the
21632 @code{frame} split:
21635 (gnus-configure-frame
21638 (summary 0.25 point frame-focus)
21640 (vertical ((height . 5) (width . 15)
21641 (user-position . t)
21642 (left . -1) (top . 1))
21647 This split will result in the familiar summary/article window
21648 configuration in the first (or ``main'') frame, while a small additional
21649 frame will be created where picons will be shown. As you can see,
21650 instead of the normal @code{1.0} top-level spec, each additional split
21651 should have a frame parameter alist as the size spec.
21652 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
21653 Reference Manual}. Under XEmacs, a frame property list will be
21654 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
21656 The list of all possible keys for @code{gnus-buffer-configuration} can
21657 be found in its default value.
21659 Note that the @code{message} key is used for both
21660 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
21661 it is desirable to distinguish between the two, something like this
21665 (message (horizontal 1.0
21666 (vertical 1.0 (message 1.0 point))
21668 (if (buffer-live-p gnus-summary-buffer)
21673 One common desire for a multiple frame split is to have a separate frame
21674 for composing mail and news while leaving the original frame intact. To
21675 accomplish that, something like the following can be done:
21680 (if (not (buffer-live-p gnus-summary-buffer))
21681 (car (cdr (assoc 'group gnus-buffer-configuration)))
21682 (car (cdr (assoc 'summary gnus-buffer-configuration))))
21683 (vertical ((user-position . t) (top . 1) (left . 1)
21684 (name . "Message"))
21685 (message 1.0 point))))
21688 @findex gnus-add-configuration
21689 Since the @code{gnus-buffer-configuration} variable is so long and
21690 complicated, there's a function you can use to ease changing the config
21691 of a single setting: @code{gnus-add-configuration}. If, for instance,
21692 you want to change the @code{article} setting, you could say:
21695 (gnus-add-configuration
21696 '(article (vertical 1.0
21698 (summary .25 point)
21702 You'd typically stick these @code{gnus-add-configuration} calls in your
21703 @file{~/.gnus.el} file or in some startup hook---they should be run after
21704 Gnus has been loaded.
21706 @vindex gnus-always-force-window-configuration
21707 If all windows mentioned in the configuration are already visible, Gnus
21708 won't change the window configuration. If you always want to force the
21709 ``right'' window configuration, you can set
21710 @code{gnus-always-force-window-configuration} to non-@code{nil}.
21712 If you're using tree displays (@pxref{Tree Display}), and the tree
21713 window is displayed vertically next to another window, you may also want
21714 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
21717 @subsection Example Window Configurations
21721 Narrow left hand side occupied by group buffer. Right hand side split
21722 between summary buffer (top one-sixth) and article buffer (bottom).
21737 (gnus-add-configuration
21740 (vertical 25 (group 1.0))
21742 (summary 0.16 point)
21745 (gnus-add-configuration
21748 (vertical 25 (group 1.0))
21749 (vertical 1.0 (summary 1.0 point)))))
21755 @node Faces and Fonts
21756 @section Faces and Fonts
21761 Fiddling with fonts and faces used to be very difficult, but these days
21762 it is very simple. You simply say @kbd{M-x customize-face}, pick out
21763 the face you want to alter, and alter it via the standard Customize
21768 @section Compilation
21769 @cindex compilation
21770 @cindex byte-compilation
21772 @findex gnus-compile
21774 Remember all those line format specification variables?
21775 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
21776 on. By default, T-gnus will use the byte-compiled codes of these
21777 variables and we can keep a slow-down to a minimum. However, if you set
21778 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
21779 unfortunately, changing them will mean a quite significant slow-down.
21780 (The default values of these variables have byte-compiled functions
21781 associated with them, while the user-generated versions do not, of
21784 To help with this, you can run @kbd{M-x gnus-compile} after you've
21785 fiddled around with the variables and feel that you're (kind of)
21786 satisfied. This will result in the new specs being byte-compiled, and
21787 you'll get top speed again. Note that T-gnus will not save these
21788 compiled specs in the @file{.newsrc.eld} file.
21791 @item gnus-compile-user-specs
21792 @vindex gnus-compile-user-specs
21793 If it is non-nil, the user-defined format specs will be byte-compiled
21794 automatically. The default value of this variable is @code{t}. It has
21795 an effect on the values of @code{gnus-*-line-format-spec}.
21800 @section Mode Lines
21803 @vindex gnus-updated-mode-lines
21804 @code{gnus-updated-mode-lines} says what buffers should keep their mode
21805 lines updated. It is a list of symbols. Supported symbols include
21806 @code{group}, @code{article}, @code{summary}, @code{server},
21807 @code{browse}, and @code{tree}. If the corresponding symbol is present,
21808 Gnus will keep that mode line updated with information that may be
21809 pertinent. If this variable is @code{nil}, screen refresh may be
21812 @cindex display-time
21814 @vindex gnus-mode-non-string-length
21815 By default, Gnus displays information on the current article in the mode
21816 lines of the summary and article buffers. The information Gnus wishes
21817 to display (e.g. the subject of the article) is often longer than the
21818 mode lines, and therefore have to be cut off at some point. The
21819 @code{gnus-mode-non-string-length} variable says how long the other
21820 elements on the line is (i.e., the non-info part). If you put
21821 additional elements on the mode line (e.g. a clock), you should modify
21824 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
21826 (add-hook 'display-time-hook
21827 (lambda () (setq gnus-mode-non-string-length
21829 (if line-number-mode 5 0)
21830 (if column-number-mode 4 0)
21831 (length display-time-string)))))
21834 If this variable is @code{nil} (which is the default), the mode line
21835 strings won't be chopped off, and they won't be padded either. Note
21836 that the default is unlikely to be desirable, as even the percentage
21837 complete in the buffer may be crowded off the mode line; the user should
21838 configure this variable appropriately for her configuration.
21841 @node Highlighting and Menus
21842 @section Highlighting and Menus
21844 @cindex highlighting
21847 @vindex gnus-visual
21848 The @code{gnus-visual} variable controls most of the Gnus-prettifying
21849 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
21850 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
21853 This variable can be a list of visual properties that are enabled. The
21854 following elements are valid, and are all included by default:
21857 @item group-highlight
21858 Do highlights in the group buffer.
21859 @item summary-highlight
21860 Do highlights in the summary buffer.
21861 @item article-highlight
21862 Do highlights in the article buffer.
21864 Turn on highlighting in all buffers.
21866 Create menus in the group buffer.
21868 Create menus in the summary buffers.
21870 Create menus in the article buffer.
21872 Create menus in the browse buffer.
21874 Create menus in the server buffer.
21876 Create menus in the score buffers.
21878 Create menus in all buffers.
21881 So if you only want highlighting in the article buffer and menus in all
21882 buffers, you could say something like:
21885 (setq gnus-visual '(article-highlight menu))
21888 If you want highlighting only and no menus whatsoever, you'd say:
21891 (setq gnus-visual '(highlight))
21894 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
21895 in all Gnus buffers.
21897 Other general variables that influence the look of all buffers include:
21900 @item gnus-mouse-face
21901 @vindex gnus-mouse-face
21902 This is the face (i.e., font) used for mouse highlighting in Gnus. No
21903 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
21907 There are hooks associated with the creation of all the different menus:
21911 @item gnus-article-menu-hook
21912 @vindex gnus-article-menu-hook
21913 Hook called after creating the article mode menu.
21915 @item gnus-group-menu-hook
21916 @vindex gnus-group-menu-hook
21917 Hook called after creating the group mode menu.
21919 @item gnus-summary-menu-hook
21920 @vindex gnus-summary-menu-hook
21921 Hook called after creating the summary mode menu.
21923 @item gnus-server-menu-hook
21924 @vindex gnus-server-menu-hook
21925 Hook called after creating the server mode menu.
21927 @item gnus-browse-menu-hook
21928 @vindex gnus-browse-menu-hook
21929 Hook called after creating the browse mode menu.
21931 @item gnus-score-menu-hook
21932 @vindex gnus-score-menu-hook
21933 Hook called after creating the score mode menu.
21944 Those new-fangled @dfn{mouse} contraptions is very popular with the
21945 young, hep kids who don't want to learn the proper way to do things
21946 these days. Why, I remember way back in the summer of '89, when I was
21947 using Emacs on a Tops 20 system. Three hundred users on one single
21948 machine, and every user was running Simula compilers. Bah!
21952 @vindex gnus-carpal
21953 Well, you can make Gnus display bufferfuls of buttons you can click to
21954 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
21955 really. Tell the chiropractor I sent you.
21960 @item gnus-carpal-mode-hook
21961 @vindex gnus-carpal-mode-hook
21962 Hook run in all carpal mode buffers.
21964 @item gnus-carpal-button-face
21965 @vindex gnus-carpal-button-face
21966 Face used on buttons.
21968 @item gnus-carpal-header-face
21969 @vindex gnus-carpal-header-face
21970 Face used on carpal buffer headers.
21972 @item gnus-carpal-group-buffer-buttons
21973 @vindex gnus-carpal-group-buffer-buttons
21974 Buttons in the group buffer.
21976 @item gnus-carpal-summary-buffer-buttons
21977 @vindex gnus-carpal-summary-buffer-buttons
21978 Buttons in the summary buffer.
21980 @item gnus-carpal-server-buffer-buttons
21981 @vindex gnus-carpal-server-buffer-buttons
21982 Buttons in the server buffer.
21984 @item gnus-carpal-browse-buffer-buttons
21985 @vindex gnus-carpal-browse-buffer-buttons
21986 Buttons in the browse buffer.
21989 All the @code{buttons} variables are lists. The elements in these list
21990 are either cons cells where the @code{car} contains a text to be displayed and
21991 the @code{cdr} contains a function symbol, or a simple string.
21999 Gnus, being larger than any program ever written (allegedly), does lots
22000 of strange stuff that you may wish to have done while you're not
22001 present. For instance, you may want it to check for new mail once in a
22002 while. Or you may want it to close down all connections to all servers
22003 when you leave Emacs idle. And stuff like that.
22005 Gnus will let you do stuff like that by defining various
22006 @dfn{handlers}. Each handler consists of three elements: A
22007 @var{function}, a @var{time}, and an @var{idle} parameter.
22009 Here's an example of a handler that closes connections when Emacs has
22010 been idle for thirty minutes:
22013 (gnus-demon-close-connections nil 30)
22016 Here's a handler that scans for @acronym{PGP} headers every hour when
22020 (gnus-demon-scan-pgp 60 t)
22023 This @var{time} parameter and that @var{idle} parameter work together
22024 in a strange, but wonderful fashion. Basically, if @var{idle} is
22025 @code{nil}, then the function will be called every @var{time} minutes.
22027 If @var{idle} is @code{t}, then the function will be called after
22028 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
22029 the function will never be called. But once Emacs goes idle, the
22030 function will be called every @var{time} minutes.
22032 If @var{idle} is a number and @var{time} is a number, the function will
22033 be called every @var{time} minutes only when Emacs has been idle for
22034 @var{idle} minutes.
22036 If @var{idle} is a number and @var{time} is @code{nil}, the function
22037 will be called once every time Emacs has been idle for @var{idle}
22040 And if @var{time} is a string, it should look like @samp{07:31}, and
22041 the function will then be called once every day somewhere near that
22042 time. Modified by the @var{idle} parameter, of course.
22044 @vindex gnus-demon-timestep
22045 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
22046 seconds. This is 60 by default. If you change that variable,
22047 all the timings in the handlers will be affected.)
22049 So, if you want to add a handler, you could put something like this in
22050 your @file{~/.gnus.el} file:
22052 @findex gnus-demon-add-handler
22054 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
22057 @findex gnus-demon-add-nocem
22058 @findex gnus-demon-add-scanmail
22059 @findex gnus-demon-add-rescan
22060 @findex gnus-demon-add-scan-timestamps
22061 @findex gnus-demon-add-disconnection
22062 Some ready-made functions to do this have been created:
22063 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
22064 @code{gnus-demon-add-nntp-close-connection},
22065 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
22066 @code{gnus-demon-add-scanmail}. Just put those functions in your
22067 @file{~/.gnus.el} if you want those abilities.
22069 @findex gnus-demon-init
22070 @findex gnus-demon-cancel
22071 @vindex gnus-demon-handlers
22072 If you add handlers to @code{gnus-demon-handlers} directly, you should
22073 run @code{gnus-demon-init} to make the changes take hold. To cancel all
22074 daemons, you can use the @code{gnus-demon-cancel} function.
22076 Note that adding daemons can be pretty naughty if you over do it. Adding
22077 functions that scan all news and mail from all servers every two seconds
22078 is a sure-fire way of getting booted off any respectable system. So
22087 @dfn{Spamming} is posting the same article lots and lots of times.
22088 Spamming is bad. Spamming is evil.
22090 Spamming is usually canceled within a day or so by various anti-spamming
22091 agencies. These agencies usually also send out @dfn{NoCeM} messages.
22092 NoCeM is pronounced ``no see-'em'', and means what the name
22093 implies---these are messages that make the offending articles, like, go
22096 What use are these NoCeM messages if the articles are canceled anyway?
22097 Some sites do not honor cancel messages and some sites just honor cancels
22098 from a select few people. Then you may wish to make use of the NoCeM
22099 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
22101 Gnus can read and parse the messages in this group automatically, and
22102 this will make spam disappear.
22104 There are some variables to customize, of course:
22107 @item gnus-use-nocem
22108 @vindex gnus-use-nocem
22109 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
22112 @item gnus-nocem-groups
22113 @vindex gnus-nocem-groups
22114 Gnus will look for NoCeM messages in the groups in this list. The
22117 ("news.lists.filters" "news.admin.net-abuse.bulletins"
22118 "alt.nocem.misc" "news.admin.net-abuse.announce")
22121 @item gnus-nocem-issuers
22122 @vindex gnus-nocem-issuers
22123 There are many people issuing NoCeM messages. This list says what
22124 people you want to listen to. The default is
22126 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
22127 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
22129 fine, upstanding citizens all of them.
22131 Known despammers that you can put in this list are listed at@*
22132 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
22134 You do not have to heed NoCeM messages from all these people---just the
22135 ones you want to listen to. You also don't have to accept all NoCeM
22136 messages from the people you like. Each NoCeM message has a @dfn{type}
22137 header that gives the message a (more or less, usually less) rigorous
22138 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
22139 @samp{binary}, and @samp{troll}. To specify this, you have to use
22140 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
22141 Each condition is either a string (which is a regexp that matches types
22142 you want to use) or a list on the form @code{(not @var{string})}, where
22143 @var{string} is a regexp that matches types you don't want to use.
22145 For instance, if you want all NoCeM messages from Chris Lewis except his
22146 @samp{troll} messages, you'd say:
22149 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
22152 On the other hand, if you just want nothing but his @samp{spam} and
22153 @samp{spew} messages, you'd say:
22156 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
22159 The specs are applied left-to-right.
22162 @item gnus-nocem-verifyer
22163 @vindex gnus-nocem-verifyer
22164 @findex pgg-verify-region
22165 This should be a function for verifying that the NoCeM issuer is who she
22166 says she is. The default is the function using @code{pgg-verify-region}
22171 (pgg-verify-region (point-min) (point-max)))
22174 It returns non-@code{nil} if the verification is successful, otherwise
22175 (including the case the NoCeM message was not signed) returns
22176 @code{nil}. If this is too slow and you don't care for verification
22177 (which may be dangerous), you can set this variable to @code{nil}.
22179 Formerly the default was @code{mc-verify}, which is a Mailcrypt
22180 function. While you can still use it, you can change it into the
22181 default function running with GnuPG if you are willing to add the
22182 @acronym{PGP} public keys to GnuPG's keyring.
22184 @item gnus-nocem-directory
22185 @vindex gnus-nocem-directory
22186 This is where Gnus will store its NoCeM cache files. The default is@*
22187 @file{~/News/NoCeM/}.
22189 @item gnus-nocem-expiry-wait
22190 @vindex gnus-nocem-expiry-wait
22191 The number of days before removing old NoCeM entries from the cache.
22192 The default is 15. If you make it shorter Gnus will be faster, but you
22193 might then see old spam.
22195 @item gnus-nocem-check-from
22196 @vindex gnus-nocem-check-from
22197 Non-@code{nil} means check for valid issuers in message bodies.
22198 Otherwise don't bother fetching articles unless their author matches a
22199 valid issuer; that is much faster if you are selective about the
22202 @item gnus-nocem-check-article-limit
22203 @vindex gnus-nocem-check-article-limit
22204 If non-@code{nil}, the maximum number of articles to check in any NoCeM
22205 group. NoCeM groups can be huge and very slow to process.
22209 Using NoCeM could potentially be a memory hog. If you have many living
22210 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
22211 big. If this is a problem, you should kill off all (or most) of your
22212 unsubscribed groups (@pxref{Subscription Commands}).
22219 It is very useful to be able to undo actions one has done. In normal
22220 Emacs buffers, it's easy enough---you just push the @code{undo} button.
22221 In Gnus buffers, however, it isn't that simple.
22223 The things Gnus displays in its buffer is of no value whatsoever to
22224 Gnus---it's all just data designed to look nice to the user.
22225 Killing a group in the group buffer with @kbd{C-k} makes the line
22226 disappear, but that's just a side-effect of the real action---the
22227 removal of the group in question from the internal Gnus structures.
22228 Undoing something like that can't be done by the normal Emacs
22229 @code{undo} function.
22231 Gnus tries to remedy this somewhat by keeping track of what the user
22232 does and coming up with actions that would reverse the actions the user
22233 takes. When the user then presses the @code{undo} key, Gnus will run
22234 the code to reverse the previous action, or the previous actions.
22235 However, not all actions are easily reversible, so Gnus currently offers
22236 a few key functions to be undoable. These include killing groups,
22237 yanking groups, and changing the list of read articles of groups.
22238 That's it, really. More functions may be added in the future, but each
22239 added function means an increase in data to be stored, so Gnus will
22240 never be totally undoable.
22242 @findex gnus-undo-mode
22243 @vindex gnus-use-undo
22245 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
22246 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
22247 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
22248 command, which should feel kinda like the normal Emacs @code{undo}
22252 @node Predicate Specifiers
22253 @section Predicate Specifiers
22254 @cindex predicate specifiers
22256 Some Gnus variables are @dfn{predicate specifiers}. This is a special
22257 form that allows flexible specification of predicates without having
22258 to type all that much.
22260 These specifiers are lists consisting of functions, symbols and lists.
22265 (or gnus-article-unseen-p
22266 gnus-article-unread-p)
22269 The available symbols are @code{or}, @code{and} and @code{not}. The
22270 functions all take one parameter.
22272 @findex gnus-make-predicate
22273 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
22274 to create a function that can be called. This input parameter to this
22275 function will be passed along to all the functions in the predicate
22280 @section Moderation
22283 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
22284 It is not included in the standard Gnus package. Write a mail to
22285 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
22288 The moderation package is implemented as a minor mode for summary
22292 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
22295 in your @file{~/.gnus.el} file.
22297 If you are the moderator of @samp{rec.zoofle}, this is how it's
22302 You split your incoming mail by matching on
22303 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
22304 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
22307 You enter that group once in a while and post articles using the @kbd{e}
22308 (edit-and-post) or @kbd{s} (just send unedited) commands.
22311 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
22312 articles that weren't approved by you, you can cancel them with the
22316 To use moderation mode in these two groups, say:
22319 (setq gnus-moderated-list
22320 "^nnml:rec.zoofle$\\|^rec.zoofle$")
22324 @node Fetching a Group
22325 @section Fetching a Group
22326 @cindex fetching a group
22328 @findex gnus-fetch-group
22329 It is sometimes convenient to be able to just say ``I want to read this
22330 group and I don't care whether Gnus has been started or not''. This is
22331 perhaps more useful for people who write code than for users, but the
22332 command @code{gnus-fetch-group} provides this functionality in any case.
22333 It takes the group name as a parameter.
22336 @node Image Enhancements
22337 @section Image Enhancements
22339 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
22340 support images yet.}, is able to display pictures and stuff, so Gnus has
22341 taken advantage of that.
22344 * X-Face:: Display a funky, teensy black-and-white image.
22345 * Face:: Display a funkier, teensier colored image.
22346 * Smileys:: Show all those happy faces the way they were meant to be shown.
22347 * Picons:: How to display pictures of what you're reading.
22348 * XVarious:: Other XEmacsy Gnusey variables.
22356 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
22357 depth) image that's supposed to represent the author of the message.
22358 It seems to be supported by an ever-growing number of mail and news
22362 @findex gnus-article-display-x-face
22363 @vindex gnus-article-x-face-command
22364 @vindex gnus-article-x-face-too-ugly
22372 Decoding an @code{X-Face} header either requires an Emacs that has
22373 @samp{compface} support (which most XEmacs versions has), or that you
22374 have @samp{compface} installed on your system. If either is true,
22375 Gnus will default to displaying @code{X-Face} headers.
22377 The variable that controls this is the
22378 @code{gnus-article-x-face-command} variable. If this variable is a
22379 string, this string will be executed in a sub-shell. If it is a
22380 function, this function will be called with the face as the argument.
22381 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
22382 the @code{From} header, the face will not be shown.
22384 The default action under Emacs 20 is to fork off the @code{display}
22385 program@footnote{@code{display} is from the ImageMagick package. For
22386 the @code{uncompface} and @code{icontopbm} programs look for a package
22387 like @code{compface} or @code{faces-xface} on a GNU/Linux system.} to
22390 Under XEmacs or Emacs 21+ with suitable image support, the default
22391 action is to display the face before the @code{From} header. (It's
22392 nicer if XEmacs has been compiled with @code{X-Face} support---that
22393 will make display somewhat faster. If there's no native @code{X-Face}
22394 support, Gnus will try to convert the @code{X-Face} header using
22395 external programs from the @code{pbmplus} package and
22396 friends.@footnote{On a GNU/Linux system look for packages with names
22397 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
22399 (Note: @code{x-face} is used in the variable/function names, not
22407 @vindex gnus-x-face
22408 Face to show X-Face. The colors from this face are used as the
22409 foreground and background colors of the displayed X-Faces. The
22410 default colors are black and white.
22412 @item gnus-face-properties-alist
22413 @vindex gnus-face-properties-alist
22414 Alist of image types and properties applied to Face (@pxref{Face}) and
22415 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
22416 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
22417 XEmacs. Here are examples:
22420 ;; Specify the altitude of Face and X-Face images in the From header.
22421 (setq gnus-face-properties-alist
22422 '((pbm . (:face gnus-x-face :ascent 80))
22423 (png . (:ascent 80))))
22425 ;; Show Face and X-Face images as pressed buttons.
22426 (setq gnus-face-properties-alist
22427 '((pbm . (:face gnus-x-face :relief -2))
22428 (png . (:relief -2))))
22431 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
22432 Reference Manual} for the valid properties for various image types.
22433 Currently, @code{pbm} is used for X-Face images and @code{png} is used
22434 for Face images in Emacs. Only the @code{:face} property is effective
22435 on the @code{xface} image type in XEmacs if it is built with the
22436 @samp{libcompface} library.
22439 Gnus provides a few convenience functions and variables to allow
22440 easier insertion of X-Face headers in outgoing messages.
22442 @findex gnus-random-x-face
22443 @vindex gnus-convert-pbm-to-x-face-command
22444 @vindex gnus-x-face-directory
22445 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
22446 @code{gnus-x-face-directory} and picks one at random, and then
22447 converts it to the X-Face format by using the
22448 @code{gnus-convert-pbm-to-x-face-command} shell command. The
22449 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
22450 header data as a string.
22452 @findex gnus-insert-random-x-face-header
22453 @code{gnus-insert-random-x-face-header} calls
22454 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
22455 randomly generated data.
22457 @findex gnus-x-face-from-file
22458 @vindex gnus-convert-image-to-x-face-command
22459 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
22460 converts the file to X-Face format by using the
22461 @code{gnus-convert-image-to-x-face-command} shell command.
22463 Here's how you would typically use the first function. Put something
22464 like the following in your @file{~/.gnus.el} file:
22467 (setq message-required-news-headers
22468 (nconc message-required-news-headers
22469 (list '(X-Face . gnus-random-x-face))))
22472 Using the last function would be something like this:
22475 (setq message-required-news-headers
22476 (nconc message-required-news-headers
22477 (list '(X-Face . (lambda ()
22478 (gnus-x-face-from-file
22479 "~/My-face.gif"))))))
22487 @c #### FIXME: faces and x-faces'implementations should really be harmonized.
22489 @code{Face} headers are essentially a funkier version of @code{X-Face}
22490 ones. They describe a 48x48 pixel colored image that's supposed to
22491 represent the author of the message.
22494 @findex gnus-article-display-face
22495 The contents of a @code{Face} header must be a base64 encoded PNG image.
22496 See @uref{http://quimby.gnus.org/circus/face/} for the precise
22499 The @code{gnus-face-properties-alist} variable affects the appearance of
22500 displayed Face images. @xref{X-Face}.
22502 Gnus provides a few convenience functions and variables to allow
22503 easier insertion of Face headers in outgoing messages.
22505 @findex gnus-convert-png-to-face
22506 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
22507 726 bytes long, and converts it to a face.
22509 @findex gnus-face-from-file
22510 @vindex gnus-convert-image-to-face-command
22511 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
22512 converts the file to Face format by using the
22513 @code{gnus-convert-image-to-face-command} shell command.
22515 Here's how you would typically use this function. Put something like the
22516 following in your @file{~/.gnus.el} file:
22519 (setq message-required-news-headers
22520 (nconc message-required-news-headers
22521 (list '(Face . (lambda ()
22522 (gnus-face-from-file "~/face.jpg"))))))
22527 @subsection Smileys
22532 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
22537 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
22538 currently the only package that uses Smiley, it is documented here.
22540 In short---to use Smiley in Gnus, put the following in your
22541 @file{~/.gnus.el} file:
22544 (setq gnus-treat-display-smileys t)
22547 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
22548 the like---to pictures and displays those instead of the text smiley
22549 faces. The conversion is controlled by a list of regexps that matches
22550 text and maps that to file names.
22552 @vindex smiley-regexp-alist
22553 The alist used is specified by the @code{smiley-regexp-alist}
22554 variable. The first item in each element is the regexp to be matched;
22555 the second element is the regexp match group that is to be replaced by
22556 the picture; and the third element is the name of the file to be
22559 The following variables customize where Smiley will look for these
22564 @item smiley-data-directory
22565 @vindex smiley-data-directory
22566 Where Smiley will look for smiley faces files.
22568 @item gnus-smiley-file-types
22569 @vindex gnus-smiley-file-types
22570 List of suffixes on smiley file names to try.
22584 So@dots{} You want to slow down your news reader even more! This is a
22585 good way to do so. It's also a great way to impress people staring
22586 over your shoulder as you read news.
22588 What are Picons? To quote directly from the Picons Web site:
22597 @dfn{Picons} is short for ``personal icons''. They're small,
22598 constrained images used to represent users and domains on the net,
22599 organized into databases so that the appropriate image for a given
22600 e-mail address can be found. Besides users and domains, there are picon
22601 databases for Usenet newsgroups and weather forecasts. The picons are
22602 in either monochrome @code{XBM} format or color @code{XPM} and
22603 @code{GIF} formats.
22606 @vindex gnus-picon-databases
22607 For instructions on obtaining and installing the picons databases,
22608 point your Web browser at
22609 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
22611 If you are using Debian GNU/Linux, saying @samp{apt-get install
22612 picons.*} will install the picons where Gnus can find them.
22614 To enable displaying picons, simply make sure that
22615 @code{gnus-picon-databases} points to the directory containing the
22618 @vindex gnus-picon-style
22619 The variable @code{gnus-picon-style} controls how picons are displayed.
22620 If @code{inline}, the textual representation is replaced. If
22621 @code{right}, picons are added right to the textual representation.
22623 The following variables offer control over where things are located.
22627 @item gnus-picon-databases
22628 @vindex gnus-picon-databases
22629 The location of the picons database. This is a list of directories
22630 containing the @file{news}, @file{domains}, @file{users} (and so on)
22631 subdirectories. Defaults to @code{("/usr/lib/picon"
22632 "/usr/local/faces")}.
22634 @item gnus-picon-news-directories
22635 @vindex gnus-picon-news-directories
22636 List of subdirectories to search in @code{gnus-picon-databases} for
22637 newsgroups faces. @code{("news")} is the default.
22639 @item gnus-picon-user-directories
22640 @vindex gnus-picon-user-directories
22641 List of subdirectories to search in @code{gnus-picon-databases} for user
22642 faces. @code{("users" "usenix" "local" "misc")} is the default.
22644 @item gnus-picon-domain-directories
22645 @vindex gnus-picon-domain-directories
22646 List of subdirectories to search in @code{gnus-picon-databases} for
22647 domain name faces. Defaults to @code{("domains")}. Some people may
22648 want to add @samp{"unknown"} to this list.
22650 @item gnus-picon-file-types
22651 @vindex gnus-picon-file-types
22652 Ordered list of suffixes on picon file names to try. Defaults to
22653 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
22659 @subsection Various XEmacs Variables
22662 @item gnus-xmas-glyph-directory
22663 @vindex gnus-xmas-glyph-directory
22664 This is where Gnus will look for pictures. Gnus will normally
22665 auto-detect this directory, but you may set it manually if you have an
22666 unusual directory structure.
22668 @item gnus-xmas-logo-color-alist
22669 @vindex gnus-xmas-logo-color-alist
22670 This is an alist where the key is a type symbol and the values are the
22671 foreground and background color of the splash page glyph.
22673 @item gnus-xmas-logo-color-style
22674 @vindex gnus-xmas-logo-color-style
22675 This is the key used to look up the color in the alist described above.
22676 Valid values include @code{flame}, @code{pine}, @code{moss},
22677 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
22678 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
22680 @item gnus-xmas-modeline-glyph
22681 @vindex gnus-xmas-modeline-glyph
22682 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
22687 @subsubsection Toolbar
22691 @item gnus-use-toolbar
22692 @vindex gnus-use-toolbar
22693 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
22694 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
22695 @code{right-toolbar}, or @code{left-toolbar}.
22697 @item gnus-group-toolbar
22698 @vindex gnus-group-toolbar
22699 The toolbar in the group buffer.
22701 @item gnus-summary-toolbar
22702 @vindex gnus-summary-toolbar
22703 The toolbar in the summary buffer.
22705 @item gnus-summary-mail-toolbar
22706 @vindex gnus-summary-mail-toolbar
22707 The toolbar in the summary buffer of mail groups.
22718 @node Fuzzy Matching
22719 @section Fuzzy Matching
22720 @cindex fuzzy matching
22722 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
22723 things like scoring, thread gathering and thread comparison.
22725 As opposed to regular expression matching, fuzzy matching is very fuzzy.
22726 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
22727 means, and the implementation has changed over time.
22729 Basically, it tries to remove all noise from lines before comparing.
22730 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
22731 out of the strings before comparing the results. This often leads to
22732 adequate results---even when faced with strings generated by text
22733 manglers masquerading as newsreaders.
22736 @node Thwarting Email Spam
22737 @section Thwarting Email Spam
22741 @cindex unsolicited commercial email
22743 In these last days of the Usenet, commercial vultures are hanging about
22744 and grepping through news like crazy to find email addresses they can
22745 foist off their scams and products to. As a reaction to this, many
22746 people have started putting nonsense addresses into their @code{From}
22747 lines. I think this is counterproductive---it makes it difficult for
22748 people to send you legitimate mail in response to things you write, as
22749 well as making it difficult to see who wrote what. This rewriting may
22750 perhaps be a bigger menace than the unsolicited commercial email itself
22753 The biggest problem I have with email spam is that it comes in under
22754 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
22755 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
22756 mail group, only to find two pyramid schemes, seven advertisements
22757 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
22758 and one mail asking me to repent and find some god.
22760 This is annoying. Here's what you can do about it.
22763 * The problem of spam:: Some background, and some solutions
22764 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
22765 * SpamAssassin:: How to use external anti-spam tools.
22766 * Hashcash:: Reduce spam by burning CPU time.
22767 * Filtering Spam Using The Spam ELisp Package::
22768 * Filtering Spam Using Statistics with spam-stat::
22771 @node The problem of spam
22772 @subsection The problem of spam
22774 @cindex spam filtering approaches
22775 @cindex filtering approaches, spam
22777 @cindex unsolicited commercial email
22779 First, some background on spam.
22781 If you have access to e-mail, you are familiar with spam (technically
22782 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
22783 exists because e-mail delivery is very cheap compared to paper mail,
22784 so only a very small percentage of people need to respond to an UCE to
22785 make it worthwhile to the advertiser. Ironically, one of the most
22786 common spams is the one offering a database of e-mail addresses for
22787 further spamming. Senders of spam are usually called @emph{spammers},
22788 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
22789 @emph{morons} are in common use as well.
22791 Spam comes from a wide variety of sources. It is simply impossible to
22792 dispose of all spam without discarding useful messages. A good
22793 example is the TMDA system, which requires senders
22794 unknown to you to confirm themselves as legitimate senders before
22795 their e-mail can reach you. Without getting into the technical side
22796 of TMDA, a downside is clearly that e-mail from legitimate sources may
22797 be discarded if those sources can't or won't confirm themselves
22798 through the TMDA system. Another problem with TMDA is that it
22799 requires its users to have a basic understanding of e-mail delivery
22802 The simplest approach to filtering spam is filtering, at the mail
22803 server or when you sort through incoming mail. If you get 200 spam
22804 messages per day from @samp{random-address@@vmadmin.com}, you block
22805 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
22806 discard all messages with @samp{VIAGRA} in the message. If you get
22807 lots of spam from Bulgaria, for example, you try to filter all mail
22808 from Bulgarian IPs.
22810 This, unfortunately, is a great way to discard legitimate e-mail. The
22811 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
22812 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
22813 you should be obvious, so don't do it if you have the choice.
22815 In another instance, the very informative and useful RISKS digest has
22816 been blocked by overzealous mail filters because it @strong{contained}
22817 words that were common in spam messages. Nevertheless, in isolated
22818 cases, with great care, direct filtering of mail can be useful.
22820 Another approach to filtering e-mail is the distributed spam
22821 processing, for instance DCC implements such a system. In essence,
22822 @var{N} systems around the world agree that a machine @var{X} in
22823 Ghana, Estonia, or California is sending out spam e-mail, and these
22824 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
22825 database. The criteria for spam detection vary---it may be the number
22826 of messages sent, the content of the messages, and so on. When a user
22827 of the distributed processing system wants to find out if a message is
22828 spam, he consults one of those @var{N} systems.
22830 Distributed spam processing works very well against spammers that send
22831 a large number of messages at once, but it requires the user to set up
22832 fairly complicated checks. There are commercial and free distributed
22833 spam processing systems. Distributed spam processing has its risks as
22834 well. For instance legitimate e-mail senders have been accused of
22835 sending spam, and their web sites and mailing lists have been shut
22836 down for some time because of the incident.
22838 The statistical approach to spam filtering is also popular. It is
22839 based on a statistical analysis of previous spam messages. Usually
22840 the analysis is a simple word frequency count, with perhaps pairs of
22841 words or 3-word combinations thrown into the mix. Statistical
22842 analysis of spam works very well in most of the cases, but it can
22843 classify legitimate e-mail as spam in some cases. It takes time to
22844 run the analysis, the full message must be analyzed, and the user has
22845 to store the database of spam analyses. Statistical analysis on the
22846 server is gaining popularity. This has the advantage of letting the
22847 user Just Read Mail, but has the disadvantage that it's harder to tell
22848 the server that it has misclassified mail.
22850 Fighting spam is not easy, no matter what anyone says. There is no
22851 magic switch that will distinguish Viagra ads from Mom's e-mails.
22852 Even people are having a hard time telling spam apart from non-spam,
22853 because spammers are actively looking to fool us into thinking they
22854 are Mom, essentially. Spamming is irritating, irresponsible, and
22855 idiotic behavior from a bunch of people who think the world owes them
22856 a favor. We hope the following sections will help you in fighting the
22859 @node Anti-Spam Basics
22860 @subsection Anti-Spam Basics
22864 @cindex unsolicited commercial email
22866 One way of dealing with spam is having Gnus split out all spam into a
22867 @samp{spam} mail group (@pxref{Splitting Mail}).
22869 First, pick one (1) valid mail address that you can be reached at, and
22870 put it in your @code{From} header of all your news articles. (I've
22871 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
22872 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
22873 sysadmin whether your sendmail installation accepts keywords in the local
22874 part of the mail address.)
22877 (setq message-default-news-headers
22878 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
22881 Then put the following split rule in @code{nnmail-split-fancy}
22882 (@pxref{Fancy Mail Splitting}):
22886 (to "larsi@@trym.ifi.uio.no"
22887 (| ("subject" "re:.*" "misc")
22888 ("references" ".*@@.*" "misc")
22893 This says that all mail to this address is suspect, but if it has a
22894 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
22895 header, it's probably ok. All the rest goes to the @samp{spam} group.
22896 (This idea probably comes from Tim Pierce.)
22898 In addition, many mail spammers talk directly to your @acronym{SMTP} server
22899 and do not include your email address explicitly in the @code{To}
22900 header. Why they do this is unknown---perhaps it's to thwart this
22901 thwarting scheme? In any case, this is trivial to deal with---you just
22902 put anything not addressed to you in the @samp{spam} group by ending
22903 your fancy split rule in this way:
22908 (to "larsi" "misc")
22912 In my experience, this will sort virtually everything into the right
22913 group. You still have to check the @samp{spam} group from time to time to
22914 check for legitimate mail, though. If you feel like being a good net
22915 citizen, you can even send off complaints to the proper authorities on
22916 each unsolicited commercial email---at your leisure.
22918 This works for me. It allows people an easy way to contact me (they can
22919 just press @kbd{r} in the usual way), and I'm not bothered at all with
22920 spam. It's a win-win situation. Forging @code{From} headers to point
22921 to non-existent domains is yucky, in my opinion.
22923 Be careful with this approach. Spammers are wise to it.
22927 @subsection SpamAssassin, Vipul's Razor, DCC, etc
22928 @cindex SpamAssassin
22929 @cindex Vipul's Razor
22932 The days where the hints in the previous section were sufficient in
22933 avoiding spam are coming to an end. There are many tools out there
22934 that claim to reduce the amount of spam you get. This section could
22935 easily become outdated fast, as new products replace old, but
22936 fortunately most of these tools seem to have similar interfaces. Even
22937 though this section will use SpamAssassin as an example, it should be
22938 easy to adapt it to most other tools.
22940 Note that this section does not involve the @code{spam.el} package,
22941 which is discussed in the next section. If you don't care for all
22942 the features of @code{spam.el}, you can make do with these simple
22945 If the tool you are using is not installed on the mail server, you
22946 need to invoke it yourself. Ideas on how to use the
22947 @code{:postscript} mail source parameter (@pxref{Mail Source
22948 Specifiers}) follow.
22952 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
22956 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
22959 Once you manage to process your incoming spool somehow, thus making
22960 the mail contain e.g.@: a header indicating it is spam, you are ready to
22961 filter it out. Using normal split methods (@pxref{Splitting Mail}):
22964 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
22968 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
22971 (setq nnmail-split-methods 'nnmail-split-fancy
22972 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
22976 Some people might not like the idea of piping the mail through various
22977 programs using a @code{:prescript} (if some program is buggy, you
22978 might lose all mail). If you are one of them, another solution is to
22979 call the external tools during splitting. Example fancy split method:
22982 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
22984 (defun kevin-spamassassin ()
22988 (if (eq 1 (call-process-region (point-min) (point-max)
22989 "spamc" nil nil nil "-c"))
22993 Note that with the nnimap back end, message bodies will not be
22994 downloaded by default. You need to set
22995 @code{nnimap-split-download-body} to @code{t} to do that
22996 (@pxref{Splitting in IMAP}).
22998 That is about it. As some spam is likely to get through anyway, you
22999 might want to have a nifty function to call when you happen to read
23000 spam. And here is the nifty function:
23003 (defun my-gnus-raze-spam ()
23004 "Submit SPAM to Vipul's Razor, then mark it as expirable."
23006 (gnus-summary-show-raw-article)
23007 (gnus-summary-save-in-pipe "razor-report -f -d")
23008 (gnus-summary-mark-as-expirable 1))
23012 @subsection Hashcash
23015 A novel technique to fight spam is to require senders to do something
23016 costly and demonstrably unique for each message they send. This has
23017 the obvious drawback that you cannot rely on everyone in the world
23018 using this technique, since it is not part of the Internet standards,
23019 but it may be useful in smaller communities.
23021 While the tools in the previous section work well in practice, they
23022 work only because the tools are constantly maintained and updated as
23023 new form of spam appears. This means that a small percentage of spam
23024 will always get through. It also means that somewhere, someone needs
23025 to read lots of spam to update these tools. Hashcash avoids that, but
23026 instead prefers that everyone you contact through e-mail supports the
23027 scheme. You can view the two approaches as pragmatic vs dogmatic.
23028 The approaches have their own advantages and disadvantages, but as
23029 often in the real world, a combination of them is stronger than either
23030 one of them separately.
23033 The ``something costly'' is to burn CPU time, more specifically to
23034 compute a hash collision up to a certain number of bits. The
23035 resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header.
23036 For more details, and for the external application @code{hashcash} you
23037 need to install to use this feature, see
23038 @uref{http://www.hashcash.org/}. Even more information can be found
23039 at @uref{http://www.camram.org/}.
23041 If you wish to generate hashcash for each message you send, you can
23042 customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail
23043 Headers,message, The Message Manual}), as in:
23046 (setq message-generate-hashcash t)
23049 You will need to set up some additional variables as well:
23053 @item hashcash-default-payment
23054 @vindex hashcash-default-payment
23055 This variable indicates the default number of bits the hash collision
23056 should consist of. By default this is 20. Suggested useful values
23059 @item hashcash-payment-alist
23060 @vindex hashcash-payment-alist
23061 Some receivers may require you to spend burn more CPU time than the
23062 default. This variable contains a list of @samp{(@var{addr}
23063 @var{amount})} cells, where @var{addr} is the receiver (email address
23064 or newsgroup) and @var{amount} is the number of bits in the collision
23065 that is needed. It can also contain @samp{(@var{addr} @var{string}
23066 @var{amount})} cells, where the @var{string} is the string to use
23067 (normally the email address or newsgroup name is used).
23069 @item hashcash-path
23070 @vindex hashcash-path
23071 Where the @code{hashcash} binary is installed. This variable should
23072 be automatically set by @code{executable-find}, but if it's @code{nil}
23073 (usually because the @code{hashcash} binary is not in your path)
23074 you'll get a warning when you check hashcash payments and an error
23075 when you generate hashcash payments.
23079 Gnus can verify hashcash cookies, although this can also be done by
23080 hand customized mail filtering scripts. To verify a hashcash cookie
23081 in a message, use the @code{mail-check-payment} function in the
23082 @code{hashcash.el} library. You can also use the @code{spam.el}
23083 package with the @code{spam-use-hashcash} back end to validate hashcash
23084 cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam
23085 Hashcash Payments}).
23087 @node Filtering Spam Using The Spam ELisp Package
23088 @subsection Filtering Spam Using The Spam ELisp Package
23089 @cindex spam filtering
23092 The idea behind @code{spam.el} is to have a control center for spam detection
23093 and filtering in Gnus. To that end, @code{spam.el} does two things: it
23094 filters new mail, and it analyzes mail known to be spam or ham.
23095 @dfn{Ham} is the name used throughout @code{spam.el} to indicate
23098 Make sure you read the section on the @code{spam.el} sequence of
23099 events. See @xref{Spam ELisp Package Sequence of Events}.
23101 @cindex spam-initialize
23102 To use @code{spam.el}, you @strong{must} run the function
23103 @code{spam-initialize} to autoload @file{spam.el} and to install the
23104 @code{spam.el} hooks. There is one exception: if you use the
23105 @code{spam-use-stat} (@pxref{spam-stat spam filtering}) setting, you
23106 should turn it on before @code{spam-initialize}:
23109 (setq spam-use-stat t) ;; if needed
23113 So, what happens when you load @file{spam.el}?
23115 First, some hooks will get installed by @code{spam-initialize}. There
23116 are some hooks for @code{spam-stat} so it can save its databases, and
23117 there are hooks so interesting things will happen when you enter and
23118 leave a group. More on the sequence of events later (@pxref{Spam
23119 ELisp Package Sequence of Events}).
23121 You get the following keyboard commands:
23131 @findex gnus-summary-mark-as-spam
23132 @code{gnus-summary-mark-as-spam}.
23134 Mark current article as spam, showing it with the @samp{$} mark.
23135 Whenever you see a spam article, make sure to mark its summary line
23136 with @kbd{M-d} before leaving the group. This is done automatically
23137 for unread articles in @emph{spam} groups.
23143 @findex spam-bogofilter-score
23144 @code{spam-bogofilter-score}.
23146 You must have Bogofilter installed for that command to work properly.
23152 Also, when you load @file{spam.el}, you will be able to customize its
23153 variables. Try @code{customize-group} on the @samp{spam} variable
23157 * Spam ELisp Package Sequence of Events::
23158 * Spam ELisp Package Filtering of Incoming Mail::
23159 * Spam ELisp Package Global Variables::
23160 * Spam ELisp Package Sorting and Score Display in Summary Buffer::
23161 * Spam ELisp Package Configuration Examples::
23162 * Blacklists and Whitelists::
23163 * BBDB Whitelists::
23164 * Gmane Spam Reporting::
23165 * Anti-spam Hashcash Payments::
23167 * Regular Expressions Header Matching::
23169 * SpamAssassin back end::
23170 * ifile spam filtering::
23171 * spam-stat spam filtering::
23173 * Extending the Spam ELisp package::
23176 @node Spam ELisp Package Sequence of Events
23177 @subsubsection Spam ELisp Package Sequence of Events
23178 @cindex spam filtering
23179 @cindex spam filtering sequence of events
23181 You must read this section to understand how @code{spam.el} works.
23182 Do not skip, speed-read, or glance through this section.
23184 There are two @emph{contact points}, if you will, between
23185 @code{spam.el} and the rest of Gnus: checking new mail for spam, and
23188 Getting new mail in Gnus is done in one of two ways. You can either
23189 split your incoming mail or you can classify new articles as ham or
23190 spam when you enter the group.
23192 Splitting incoming mail is better suited to mail back ends such as
23193 @code{nnml} or @code{nnimap} where new mail appears in a single file
23194 called a @dfn{Spool File}. See @xref{Spam ELisp Package Filtering of
23197 @vindex gnus-spam-autodetect
23198 @vindex gnus-spam-autodetect-methods
23199 For back ends such as @code{nntp} there is no incoming mail spool, so
23200 an alternate mechanism must be used. This may also happen for
23201 back ends where the server is in charge of splitting incoming mail, and
23202 Gnus does not do further splitting. The @code{spam-autodetect} and
23203 @code{spam-autodetect-methods} group parameters (accessible with
23204 @kbd{G c} and @kbd{G p} as usual), and the corresponding variables
23205 @code{gnus-spam-autodetect} and @code{gnus-spam-autodetect-methods}
23206 (accessible with @kbd{M-x customize-variable} as usual) can help.
23208 When @code{spam-autodetect} is used (you can turn it on for a
23209 group/topic or wholesale by regular expression matches, as needed), it
23210 hooks into the process of entering a group. Thus, entering a group
23211 with unseen or unread articles becomes the substitute for checking
23212 incoming mail. Whether only unseen articles or all unread articles
23213 will be processed is determined by the
23214 @code{spam-autodetect-recheck-messages}. When set to @code{t}, unread
23215 messages will be rechecked. You should probably stick with the
23216 default of only checking unseen messages.
23218 @code{spam-autodetect} grants the user at once more and less control
23219 of spam filtering. The user will have more control over each group's
23220 spam methods, so for instance the @samp{ding} group may have
23221 @code{spam-use-BBDB} as the autodetection method, while the
23222 @samp{suspect} group may have the @code{spam-use-blacklist} and
23223 @code{spam-use-bogofilter} methods enabled. Every article detected to
23224 be spam will be marked with the spam mark @samp{$} and processed on
23225 exit from the group as normal spam. The user has less control over
23226 the @emph{sequence} of checks, as he might with @code{spam-split}.
23228 When the newly split mail goes into groups, or messages are
23229 autodetected to be ham or spam, those groups must be exited (after
23230 entering, if needed) for further spam processing to happen. It
23231 matters whether the group is considered a ham group, a spam group, or
23232 is unclassified, based on its @code{spam-content} parameter
23233 (@pxref{Spam ELisp Package Global Variables}). Spam groups have the
23234 additional characteristic that, when entered, any unseen or unread
23235 articles (depending on the @code{spam-mark-only-unseen-as-spam}
23236 variable) will be marked as spam. Thus, mail split into a spam group
23237 gets automatically marked as spam when you enter the group.
23239 Thus, when you exit a group, the @code{spam-processors} are applied,
23240 if any are set, and the processed mail is moved to the
23241 @code{ham-process-destination} or the @code{spam-process-destination}
23242 depending on the article's classification. If the
23243 @code{ham-process-destination} or the @code{spam-process-destination},
23244 whichever is appropriate, are @code{nil}, the article is left in the
23247 If a spam is found in any group (this can be changed to only non-spam
23248 groups with @code{spam-move-spam-nonspam-groups-only}), it is
23249 processed by the active @code{spam-processors} (@pxref{Spam ELisp
23250 Package Global Variables}) when the group is exited. Furthermore, the
23251 spam is moved to the @code{spam-process-destination} (@pxref{Spam
23252 ELisp Package Global Variables}) for further training or deletion.
23253 You have to load the @code{gnus-registry.el} package and enable the
23254 @code{spam-log-to-registry} variable if you want spam to be processed
23255 no more than once. Thus, spam is detected and processed everywhere,
23256 which is what most people want. If the
23257 @code{spam-process-destination} is @code{nil}, the spam is marked as
23258 expired, which is usually the right thing to do.
23260 If spam can not be moved---because of a read-only back end such as
23261 @acronym{NNTP}, for example, it will be copied.
23263 If a ham mail is found in a ham group, as determined by the
23264 @code{ham-marks} parameter, it is processed as ham by the active ham
23265 @code{spam-processor} when the group is exited. With the variables
23266 @code{spam-process-ham-in-spam-groups} and
23267 @code{spam-process-ham-in-nonham-groups} the behavior can be further
23268 altered so ham found anywhere can be processed. You have to load the
23269 @code{gnus-registry.el} package and enable the
23270 @code{spam-log-to-registry} variable if you want ham to be processed
23271 no more than once. Thus, ham is detected and processed only when
23272 necessary, which is what most people want. More on this in
23273 @xref{Spam ELisp Package Configuration Examples}.
23275 If ham can not be moved---because of a read-only back end such as
23276 @acronym{NNTP}, for example, it will be copied.
23278 If all this seems confusing, don't worry. Soon it will be as natural
23279 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
23280 50 years in the future yet. Just trust us, it's not so bad.
23282 @node Spam ELisp Package Filtering of Incoming Mail
23283 @subsubsection Spam ELisp Package Filtering of Incoming Mail
23284 @cindex spam filtering
23285 @cindex spam filtering incoming mail
23288 To use the @code{spam.el} facilities for incoming mail filtering, you
23289 must add the following to your fancy split list
23290 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
23296 Note that the fancy split may be called @code{nnmail-split-fancy} or
23297 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
23298 nnimap back ends to retrieve your mail.
23300 Also, @code{spam-split} will not modify incoming mail in any way.
23302 The @code{spam-split} function will process incoming mail and send the
23303 mail considered to be spam into the group name given by the variable
23304 @code{spam-split-group}. By default that group name is @samp{spam},
23305 but you can customize @code{spam-split-group}. Make sure the contents
23306 of @code{spam-split-group} are an @emph{unqualified} group name, for
23307 instance in an @code{nnimap} server @samp{your-server} the value
23308 @samp{spam} will turn out to be @samp{nnimap+your-server:spam}. The
23309 value @samp{nnimap+server:spam}, therefore, is wrong and will
23310 actually give you the group
23311 @samp{nnimap+your-server:nnimap+server:spam} which may or may not
23312 work depending on your server's tolerance for strange group names.
23314 You can also give @code{spam-split} a parameter,
23315 e.g. @code{spam-use-regex-headers} or @code{"maybe-spam"}. Why is
23318 Take these split rules (with @code{spam-use-regex-headers} and
23319 @code{spam-use-blackholes} set):
23322 nnimap-split-fancy '(|
23323 (any "ding" "ding")
23325 ;; @r{default mailbox}
23329 Now, the problem is that you want all ding messages to make it to the
23330 ding folder. But that will let obvious spam (for example, spam
23331 detected by SpamAssassin, and @code{spam-use-regex-headers}) through,
23332 when it's sent to the ding list. On the other hand, some messages to
23333 the ding list are from a mail server in the blackhole list, so the
23334 invocation of @code{spam-split} can't be before the ding rule.
23336 You can let SpamAssassin headers supersede ding rules, but all other
23337 @code{spam-split} rules (including a second invocation of the
23338 regex-headers check) will be after the ding rule:
23343 ;; @r{all spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
23344 (: spam-split "regex-spam" 'spam-use-regex-headers)
23345 (any "ding" "ding")
23346 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
23348 ;; @r{default mailbox}
23352 This lets you invoke specific @code{spam-split} checks depending on
23353 your particular needs, and to target the results of those checks to a
23354 particular spam group. You don't have to throw all mail into all the
23355 spam tests. Another reason why this is nice is that messages to
23356 mailing lists you have rules for don't have to have resource-intensive
23357 blackhole checks performed on them. You could also specify different
23358 spam checks for your nnmail split vs. your nnimap split. Go crazy.
23360 You should still have specific checks such as
23361 @code{spam-use-regex-headers} set to @code{t}, even if you
23362 specifically invoke @code{spam-split} with the check. The reason is
23363 that when loading @file{spam.el}, some conditional loading is done
23364 depending on what @code{spam-use-xyz} variables you have set. This
23365 is usually not critical, though.
23367 @emph{Note for IMAP users}
23369 The boolean variable @code{nnimap-split-download-body} needs to be
23370 set, if you want to split based on the whole message instead of just
23371 the headers. By default, the nnimap back end will only retrieve the
23372 message headers. If you use a @emph{statistical} filter,
23373 e.g. @code{spam-check-bogofilter}, @code{spam-check-ifile}, or
23374 @code{spam-check-stat} (the splitters that can benefit from the full
23375 message body), this variable will be set automatically. It is not set
23376 for non-statistical back ends by default because it will slow
23377 @acronym{IMAP} down.
23379 @xref{Splitting in IMAP}.
23381 @node Spam ELisp Package Global Variables
23382 @subsubsection Spam ELisp Package Global Variables
23383 @cindex spam filtering
23384 @cindex spam filtering variables
23385 @cindex spam variables
23388 @vindex gnus-spam-process-newsgroups
23389 The concepts of ham processors and spam processors are very important.
23390 Ham processors and spam processors for a group can be set with the
23391 @code{spam-process} group parameter, or the
23392 @code{gnus-spam-process-newsgroups} variable. Ham processors take
23393 mail known to be non-spam (@emph{ham}) and process it in some way so
23394 that later similar mail will also be considered non-spam. Spam
23395 processors take mail known to be spam and process it so similar spam
23396 will be detected later.
23398 The format of the spam or ham processor entry used to be a symbol,
23399 but now it is a @sc{cons} cell. See the individual spam processor entries
23400 for more information.
23402 @vindex gnus-spam-newsgroup-contents
23403 Gnus learns from the spam you get. You have to collect your spam in
23404 one or more spam groups, and set or customize the variable
23405 @code{spam-junk-mailgroups} as appropriate. You can also declare
23406 groups to contain spam by setting their group parameter
23407 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
23408 by customizing the corresponding variable
23409 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
23410 parameter and the @code{gnus-spam-newsgroup-contents} variable can
23411 also be used to declare groups as @emph{ham} groups if you set their
23412 classification to @code{gnus-group-spam-classification-ham}. If
23413 groups are not classified by means of @code{spam-junk-mailgroups},
23414 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
23415 considered @emph{unclassified}. All groups are unclassified by
23418 @vindex gnus-spam-mark
23420 In spam groups, all messages are considered to be spam by default:
23421 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
23422 group. If you have seen a message, had it marked as spam, then
23423 unmarked it, it won't be marked as spam when you enter the group
23424 thereafter. You can disable that behavior, so all unread messages
23425 will get the @samp{$} mark, if you set the
23426 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
23427 should remove the @samp{$} mark when you are in the group summary
23428 buffer for every message that is not spam after all. To remove the
23429 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
23430 @kbd{d} for declaring it read the non-spam way. When you leave a
23431 group, all spam-marked (@samp{$}) articles are sent to a spam
23432 processor which will study them as spam samples.
23434 Messages may also be deleted in various other ways, and unless
23435 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
23436 and @samp{r} for default read or explicit delete, marks @samp{X} and
23437 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
23438 low scores, are all considered to be associated with articles which
23439 are not spam. This assumption might be false, in particular if you
23440 use kill files or score files as means for detecting genuine spam, you
23441 should then adjust the @code{ham-marks} group parameter.
23444 You can customize this group or topic parameter to be the list of
23445 marks you want to consider ham. By default, the list contains the
23446 deleted, read, killed, kill-filed, and low-score marks (the idea is
23447 that these articles have been read, but are not spam). It can be
23448 useful to also include the tick mark in the ham marks. It is not
23449 recommended to make the unread mark a ham mark, because it normally
23450 indicates a lack of classification. But you can do it, and we'll be
23455 You can customize this group or topic parameter to be the list of
23456 marks you want to consider spam. By default, the list contains only
23457 the spam mark. It is not recommended to change that, but you can if
23458 you really want to.
23461 When you leave @emph{any} group, regardless of its
23462 @code{spam-contents} classification, all spam-marked articles are sent
23463 to a spam processor, which will study these as spam samples. If you
23464 explicit kill a lot, you might sometimes end up with articles marked
23465 @samp{K} which you never saw, and which might accidentally contain
23466 spam. Best is to make sure that real spam is marked with @samp{$},
23469 @vindex gnus-ham-process-destinations
23470 When you leave a @emph{spam} group, all spam-marked articles are
23471 marked as expired after processing with the spam processor. This is
23472 not done for @emph{unclassified} or @emph{ham} groups. Also, any
23473 @strong{ham} articles in a spam group will be moved to a location
23474 determined by either the @code{ham-process-destination} group
23475 parameter or a match in the @code{gnus-ham-process-destinations}
23476 variable, which is a list of regular expressions matched with group
23477 names (it's easiest to customize this variable with @kbd{M-x
23478 customize-variable @key{RET} gnus-ham-process-destinations}). Each
23479 group name list is a standard Lisp list, if you prefer to customize
23480 the variable manually. If the @code{ham-process-destination}
23481 parameter is not set, ham articles are left in place. If the
23482 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
23483 set, the ham articles are marked as unread before being moved.
23485 If ham can not be moved---because of a read-only back end such as
23486 @acronym{NNTP}, for example, it will be copied.
23488 Note that you can use multiples destinations per group or regular
23489 expression! This enables you to send your ham to a regular mail
23490 group and to a @emph{ham training} group.
23492 When you leave a @emph{ham} group, all ham-marked articles are sent to
23493 a ham processor, which will study these as non-spam samples.
23495 @vindex spam-process-ham-in-spam-groups
23496 By default the variable @code{spam-process-ham-in-spam-groups} is
23497 @code{nil}. Set it to @code{t} if you want ham found in spam groups
23498 to be processed. Normally this is not done, you are expected instead
23499 to send your ham to a ham group and process it there.
23501 @vindex spam-process-ham-in-nonham-groups
23502 By default the variable @code{spam-process-ham-in-nonham-groups} is
23503 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
23504 or unclassified) groups to be processed. Normally this is not done,
23505 you are expected instead to send your ham to a ham group and process
23508 @vindex gnus-spam-process-destinations
23509 When you leave a @emph{ham} or @emph{unclassified} group, all
23510 @strong{spam} articles are moved to a location determined by either
23511 the @code{spam-process-destination} group parameter or a match in the
23512 @code{gnus-spam-process-destinations} variable, which is a list of
23513 regular expressions matched with group names (it's easiest to
23514 customize this variable with @kbd{M-x customize-variable @key{RET}
23515 gnus-spam-process-destinations}). Each group name list is a standard
23516 Lisp list, if you prefer to customize the variable manually. If the
23517 @code{spam-process-destination} parameter is not set, the spam
23518 articles are only expired. The group name is fully qualified, meaning
23519 that if you see @samp{nntp:servername} before the group name in the
23520 group buffer then you need it here as well.
23522 If spam can not be moved---because of a read-only back end such as
23523 @acronym{NNTP}, for example, it will be copied.
23525 Note that you can use multiples destinations per group or regular
23526 expression! This enables you to send your spam to multiple @emph{spam
23529 @vindex spam-log-to-registry
23530 The problem with processing ham and spam is that Gnus doesn't track
23531 this processing by default. Enable the @code{spam-log-to-registry}
23532 variable so @code{spam.el} will use @code{gnus-registry.el} to track
23533 what articles have been processed, and avoid processing articles
23534 multiple times. Keep in mind that if you limit the number of registry
23535 entries, this won't work as well as it does without a limit.
23537 @vindex spam-mark-only-unseen-as-spam
23538 Set this variable if you want only unseen articles in spam groups to
23539 be marked as spam. By default, it is set. If you set it to
23540 @code{nil}, unread articles will also be marked as spam.
23542 @vindex spam-mark-ham-unread-before-move-from-spam-group
23543 Set this variable if you want ham to be unmarked before it is moved
23544 out of the spam group. This is very useful when you use something
23545 like the tick mark @samp{!} to mark ham---the article will be placed
23546 in your @code{ham-process-destination}, unmarked as if it came fresh
23547 from the mail server.
23549 @vindex spam-autodetect-recheck-messages
23550 When autodetecting spam, this variable tells @code{spam.el} whether
23551 only unseen articles or all unread articles should be checked for
23552 spam. It is recommended that you leave it off.
23554 @node Spam ELisp Package Sorting and Score Display in Summary Buffer
23555 @subsubsection Spam ELisp Package Sorting and Score Display in Summary Buffer
23556 @cindex spam scoring
23557 @cindex spam sorting
23558 @cindex spam score summary buffer
23559 @cindex spam sort summary buffer
23562 You can display the spam score of articles in your summary buffer, and
23563 you can sort articles by their spam score.
23565 First you need to decide which back end you will be using. If you use
23566 the @code{spam-use-spamassassin},
23567 @code{spam-use-spamassassin-headers}, or @code{spam-use-regex-headers}
23568 back end, the @code{X-Spam-Status} header will be used. If you use
23569 @code{spam-use-bogofilter}, the @code{X-Bogosity} header will be used.
23570 If you use @code{spam-use-crm114}, any header that matches the CRM114
23571 score format will be used. As long as you set the appropriate back end
23572 variable to t @emph{before} you load @file{spam.el}, you will be
23573 fine. @code{spam.el} will automatically add the right header to the
23574 internal Gnus list of required headers.
23576 To show the spam score in your summary buffer, add this line to your
23577 @code{gnus.el} file (note @code{spam.el} does not do that by default
23578 so it won't override any existing @code{S} formats you may have).
23581 (defalias 'gnus-user-format-function-S 'spam-user-format-function-S)
23584 Now just set your summary line format to use @code{%uS}. Here's an
23585 example that formats the spam score in a 5-character field:
23588 (setq gnus-summary-line-format
23589 "%U%R %10&user-date; $%5uS %6k %B %(%4L: %*%-25,25a%) %s \n")
23592 Finally, to sort by spam status, either do it globally:
23596 gnus-show-threads nil
23597 gnus-article-sort-functions
23598 '(spam-article-sort-by-spam-status))
23601 or per group (@pxref{Sorting the Summary Buffer}).
23603 @node Spam ELisp Package Configuration Examples
23604 @subsubsection Spam ELisp Package Configuration Examples
23605 @cindex spam filtering
23606 @cindex spam filtering configuration examples
23607 @cindex spam configuration examples
23610 @subsubheading Ted's setup
23612 From Ted Zlatanov <tzz@@lifelogs.com>.
23614 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
23615 ;; @r{see @file{gnus-registry.el} for more information}
23616 (gnus-registry-initialize)
23619 ;; @r{I like @kbd{C-s} for marking spam}
23620 (define-key gnus-summary-mode-map "\C-s" 'gnus-summary-mark-as-spam)
23623 spam-log-to-registry t ; @r{for spam autodetection}
23625 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
23626 ;; @r{all groups with @samp{spam} in the name contain spam}
23627 gnus-spam-newsgroup-contents
23628 '(("spam" gnus-group-spam-classification-spam))
23629 ;; @r{see documentation for these}
23630 spam-move-spam-nonspam-groups-only nil
23631 spam-mark-only-unseen-as-spam t
23632 spam-mark-ham-unread-before-move-from-spam-group t
23633 nnimap-split-rule 'nnimap-split-fancy
23634 ;; @r{understand what this does before you copy it to your own setup!}
23635 nnimap-split-fancy '(|
23636 ;; @r{trace references to parents and put in their group}
23637 (: gnus-registry-split-fancy-with-parent)
23638 ;; @r{this will catch server-side SpamAssassin tags}
23639 (: spam-split 'spam-use-regex-headers)
23640 (any "ding" "ding")
23641 ;; @r{note that spam by default will go to @samp{spam}}
23643 ;; @r{default mailbox}
23646 ;; @r{my parameters, set with @kbd{G p}}
23648 ;; @r{all nnml groups, and all nnimap groups except}
23649 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
23650 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
23651 ;; @r{because it must have been detected manually}
23653 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23655 ;; @r{all @acronym{NNTP} groups}
23656 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
23657 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
23658 ;; @r{send all spam to the training group}
23659 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23661 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
23662 ((spam-autodetect . t))
23664 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
23666 ;; @r{this is a spam group}
23667 ((spam-contents gnus-group-spam-classification-spam)
23669 ;; @r{any spam (which happens when I enter for all unseen messages,}
23670 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
23671 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
23673 (spam-process-destination "nnimap+mail.lifelogs.com:train")
23675 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
23676 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
23678 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
23679 "nnimap+mail.lifelogs.com:trainham")
23680 ;; @r{in this group, only @samp{!} marks are ham}
23682 (gnus-ticked-mark))
23683 ;; @r{remembers senders in the blacklist on the way out---this is}
23684 ;; @r{definitely not needed, it just makes me feel better}
23685 (spam-process (gnus-group-spam-exit-processor-blacklist)))
23687 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
23688 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
23689 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
23693 @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server
23694 From Reiner Steib <reiner.steib@@gmx.de>.
23696 My provider has set up bogofilter (in combination with @acronym{DCC}) on
23697 the mail server (@acronym{IMAP}). Recognized spam goes to
23698 @samp{spam.detected}, the rest goes through the normal filter rules,
23699 i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
23700 positives or negatives is done by copying or moving the article to
23701 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
23702 the server feeds those to bogofilter with the suitable ham or spam
23703 options and deletes them from the @samp{training.ham} and
23704 @samp{training.spam} folders.
23706 With the following entries in @code{gnus-parameters}, @code{spam.el}
23707 does most of the job for me:
23710 ("nnimap:spam\\.detected"
23711 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
23712 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
23713 (spam-contents gnus-group-spam-classification-spam))
23714 ("nnimap:\\(INBOX\\|other-folders\\)"
23715 (spam-process-destination . "nnimap:training.spam")
23716 (spam-contents gnus-group-spam-classification-ham))
23721 @item @b{The Spam folder:}
23723 In the folder @samp{spam.detected}, I have to check for false positives
23724 (i.e. legitimate mails, that were wrongly judged as spam by
23725 bogofilter or DCC).
23727 Because of the @code{gnus-group-spam-classification-spam} entry, all
23728 messages are marked as spam (with @code{$}). When I find a false
23729 positive, I mark the message with some other ham mark (@code{ham-marks},
23730 @ref{Spam ELisp Package Global Variables}). On group exit, those
23731 messages are copied to both groups, @samp{INBOX} (where I want to have
23732 the article) and @samp{training.ham} (for training bogofilter) and
23733 deleted from the @samp{spam.detected} folder.
23735 The @code{gnus-article-sort-by-chars} entry simplifies detection of
23736 false positives for me. I receive lots of worms (sweN, @dots{}), that all
23737 have a similar size. Grouping them by size (i.e. chars) makes finding
23738 other false positives easier. (Of course worms aren't @i{spam}
23739 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
23740 an excellent tool for filtering those unwanted mails for me.)
23742 @item @b{Ham folders:}
23744 In my ham folders, I just hit @kbd{S x}
23745 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
23746 mail (false negative). On group exit, those messages are moved to
23747 @samp{training.spam}.
23750 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
23752 From Reiner Steib <reiner.steib@@gmx.de>.
23754 With following entry in @code{gnus-parameters}, @kbd{S x}
23755 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
23756 groups as spam and reports the to Gmane at group exit:
23760 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
23763 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
23764 because I don't read the groups directly from news.gmane.org, but
23765 through my local news server (leafnode). I.e. the article numbers are
23766 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
23767 the @code{X-Report-Spam} header to find the correct number.
23769 @node Blacklists and Whitelists
23770 @subsubsection Blacklists and Whitelists
23771 @cindex spam filtering
23772 @cindex whitelists, spam filtering
23773 @cindex blacklists, spam filtering
23776 @defvar spam-use-blacklist
23778 Set this variable to @code{t} if you want to use blacklists when
23779 splitting incoming mail. Messages whose senders are in the blacklist
23780 will be sent to the @code{spam-split-group}. This is an explicit
23781 filter, meaning that it acts only on mail senders @emph{declared} to
23786 @defvar spam-use-whitelist
23788 Set this variable to @code{t} if you want to use whitelists when
23789 splitting incoming mail. Messages whose senders are not in the
23790 whitelist will be sent to the next spam-split rule. This is an
23791 explicit filter, meaning that unless someone is in the whitelist, their
23792 messages are not assumed to be spam or ham.
23796 @defvar spam-use-whitelist-exclusive
23798 Set this variable to @code{t} if you want to use whitelists as an
23799 implicit filter, meaning that every message will be considered spam
23800 unless the sender is in the whitelist. Use with care.
23804 @defvar gnus-group-spam-exit-processor-blacklist
23806 Add this symbol to a group's @code{spam-process} parameter by
23807 customizing the group parameters or the
23808 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23809 added to a group's @code{spam-process} parameter, the senders of
23810 spam-marked articles will be added to the blacklist.
23814 Instead of the obsolete
23815 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
23816 that you use @code{'(spam spam-use-blacklist)}. Everything will work
23817 the same way, we promise.
23821 @defvar gnus-group-ham-exit-processor-whitelist
23823 Add this symbol to a group's @code{spam-process} parameter by
23824 customizing the group parameters or the
23825 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23826 added to a group's @code{spam-process} parameter, the senders of
23827 ham-marked articles in @emph{ham} groups will be added to the
23832 Instead of the obsolete
23833 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
23834 that you use @code{'(ham spam-use-whitelist)}. Everything will work
23835 the same way, we promise.
23839 Blacklists are lists of regular expressions matching addresses you
23840 consider to be spam senders. For instance, to block mail from any
23841 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
23842 blacklist. You start out with an empty blacklist. Blacklist entries
23843 use the Emacs regular expression syntax.
23845 Conversely, whitelists tell Gnus what addresses are considered
23846 legitimate. All messages from whitelisted addresses are considered
23847 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
23848 Emacs regular expression syntax.
23850 The blacklist and whitelist file locations can be customized with the
23851 @code{spam-directory} variable (@file{~/News/spam} by default), or
23852 the @code{spam-whitelist} and @code{spam-blacklist} variables
23853 directly. The whitelist and blacklist files will by default be in the
23854 @code{spam-directory} directory, named @file{whitelist} and
23855 @file{blacklist} respectively.
23857 @node BBDB Whitelists
23858 @subsubsection BBDB Whitelists
23859 @cindex spam filtering
23860 @cindex BBDB whitelists, spam filtering
23861 @cindex BBDB, spam filtering
23864 @defvar spam-use-BBDB
23866 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
23867 Whitelists}), but uses the BBDB as the source of whitelisted
23868 addresses, without regular expressions. You must have the BBDB loaded
23869 for @code{spam-use-BBDB} to work properly. Messages whose senders are
23870 not in the BBDB will be sent to the next spam-split rule. This is an
23871 explicit filter, meaning that unless someone is in the BBDB, their
23872 messages are not assumed to be spam or ham.
23876 @defvar spam-use-BBDB-exclusive
23878 Set this variable to @code{t} if you want to use the BBDB as an
23879 implicit filter, meaning that every message will be considered spam
23880 unless the sender is in the BBDB. Use with care. Only sender
23881 addresses in the BBDB will be allowed through; all others will be
23882 classified as spammers.
23884 While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias
23885 for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is
23886 @emph{not} a separate back end. If you set
23887 @code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting
23892 @defvar gnus-group-ham-exit-processor-BBDB
23894 Add this symbol to a group's @code{spam-process} parameter by
23895 customizing the group parameters or the
23896 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23897 added to a group's @code{spam-process} parameter, the senders of
23898 ham-marked articles in @emph{ham} groups will be added to the
23903 Instead of the obsolete
23904 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
23905 that you use @code{'(ham spam-use-BBDB)}. Everything will work
23906 the same way, we promise.
23910 @node Gmane Spam Reporting
23911 @subsubsection Gmane Spam Reporting
23912 @cindex spam reporting
23913 @cindex Gmane, spam reporting
23914 @cindex Gmane, spam reporting
23917 @defvar gnus-group-spam-exit-processor-report-gmane
23919 Add this symbol to a group's @code{spam-process} parameter by
23920 customizing the group parameters or the
23921 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23922 added to a group's @code{spam-process} parameter, the spam-marked
23923 articles groups will be reported to the Gmane administrators via a
23926 Gmane can be found at @uref{http://gmane.org}.
23930 Instead of the obsolete
23931 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
23932 that you use @code{'(spam spam-use-gmane)}. Everything will work the
23933 same way, we promise.
23937 @defvar spam-report-gmane-use-article-number
23939 This variable is @code{t} by default. Set it to @code{nil} if you are
23940 running your own news server, for instance, and the local article
23941 numbers don't correspond to the Gmane article numbers. When
23942 @code{spam-report-gmane-use-article-number} is @code{nil},
23943 @code{spam-report.el} will use the @code{X-Report-Spam} header that
23948 @node Anti-spam Hashcash Payments
23949 @subsubsection Anti-spam Hashcash Payments
23950 @cindex spam filtering
23951 @cindex hashcash, spam filtering
23954 @defvar spam-use-hashcash
23956 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
23957 Whitelists}), but uses hashcash tokens for whitelisting messages
23958 instead of the sender address. Messages without a hashcash payment
23959 token will be sent to the next spam-split rule. This is an explicit
23960 filter, meaning that unless a hashcash token is found, the messages
23961 are not assumed to be spam or ham.
23966 @subsubsection Blackholes
23967 @cindex spam filtering
23968 @cindex blackholes, spam filtering
23971 @defvar spam-use-blackholes
23973 This option is disabled by default. You can let Gnus consult the
23974 blackhole-type distributed spam processing systems (DCC, for instance)
23975 when you set this option. The variable @code{spam-blackhole-servers}
23976 holds the list of blackhole servers Gnus will consult. The current
23977 list is fairly comprehensive, but make sure to let us know if it
23978 contains outdated servers.
23980 The blackhole check uses the @code{dig.el} package, but you can tell
23981 @code{spam.el} to use @code{dns.el} instead for better performance if
23982 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
23983 this time to set @code{spam-use-dig} to @code{nil} despite the
23984 possible performance improvements, because some users may be unable to
23985 use it, but you can try it and see if it works for you.
23989 @defvar spam-blackhole-servers
23991 The list of servers to consult for blackhole checks.
23995 @defvar spam-blackhole-good-server-regex
23997 A regular expression for IPs that should not be checked against the
23998 blackhole server list. When set to @code{nil}, it has no effect.
24002 @defvar spam-use-dig
24004 Use the @code{dig.el} package instead of the @code{dns.el} package.
24005 The default setting of @code{t} is recommended.
24009 Blackhole checks are done only on incoming mail. There is no spam or
24010 ham processor for blackholes.
24012 @node Regular Expressions Header Matching
24013 @subsubsection Regular Expressions Header Matching
24014 @cindex spam filtering
24015 @cindex regular expressions header matching, spam filtering
24018 @defvar spam-use-regex-headers
24020 This option is disabled by default. You can let Gnus check the
24021 message headers against lists of regular expressions when you set this
24022 option. The variables @code{spam-regex-headers-spam} and
24023 @code{spam-regex-headers-ham} hold the list of regular expressions.
24024 Gnus will check against the message headers to determine if the
24025 message is spam or ham, respectively.
24029 @defvar spam-regex-headers-spam
24031 The list of regular expressions that, when matched in the headers of
24032 the message, positively identify it as spam.
24036 @defvar spam-regex-headers-ham
24038 The list of regular expressions that, when matched in the headers of
24039 the message, positively identify it as ham.
24043 Regular expression header checks are done only on incoming mail.
24044 There is no specific spam or ham processor for regular expressions.
24047 @subsubsection Bogofilter
24048 @cindex spam filtering
24049 @cindex bogofilter, spam filtering
24052 @defvar spam-use-bogofilter
24054 Set this variable if you want @code{spam-split} to use Eric Raymond's
24057 With a minimum of care for associating the @samp{$} mark for spam
24058 articles only, Bogofilter training all gets fairly automatic. You
24059 should do this until you get a few hundreds of articles in each
24060 category, spam or not. The command @kbd{S t} in summary mode, either
24061 for debugging or for curiosity, shows the @emph{spamicity} score of
24062 the current article (between 0.0 and 1.0).
24064 Bogofilter determines if a message is spam based on a specific
24065 threshold. That threshold can be customized, consult the Bogofilter
24068 If the @code{bogofilter} executable is not in your path, Bogofilter
24069 processing will be turned off.
24071 You should not enable this if you use @code{spam-use-bogofilter-headers}.
24075 @defvar spam-use-bogofilter-headers
24077 Set this variable if you want @code{spam-split} to use Eric Raymond's
24078 speedy Bogofilter, looking only at the message headers. It works
24079 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
24080 must be in the message already. Normally you would do this with a
24081 procmail recipe or something similar; consult the Bogofilter
24082 installation documents for details.
24084 You should not enable this if you use @code{spam-use-bogofilter}.
24088 @defvar gnus-group-spam-exit-processor-bogofilter
24089 Add this symbol to a group's @code{spam-process} parameter by
24090 customizing the group parameters or the
24091 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24092 added to a group's @code{spam-process} parameter, spam-marked articles
24093 will be added to the Bogofilter spam database.
24097 Instead of the obsolete
24098 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
24099 that you use @code{'(spam spam-use-bogofilter)}. Everything will work
24100 the same way, we promise.
24103 @defvar gnus-group-ham-exit-processor-bogofilter
24104 Add this symbol to a group's @code{spam-process} parameter by
24105 customizing the group parameters or the
24106 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24107 added to a group's @code{spam-process} parameter, the ham-marked
24108 articles in @emph{ham} groups will be added to the Bogofilter database
24109 of non-spam messages.
24113 Instead of the obsolete
24114 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
24115 that you use @code{'(ham spam-use-bogofilter)}. Everything will work
24116 the same way, we promise.
24119 @defvar spam-bogofilter-database-directory
24121 This is the directory where Bogofilter will store its databases. It
24122 is not specified by default, so Bogofilter will use its own default
24123 database directory.
24127 The Bogofilter mail classifier is similar to @command{ifile} in intent and
24128 purpose. A ham and a spam processor are provided, plus the
24129 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
24130 variables to indicate to spam-split that Bogofilter should either be
24131 used, or has already been used on the article. The 0.9.2.1 version of
24132 Bogofilter was used to test this functionality.
24134 @node SpamAssassin back end
24135 @subsubsection SpamAssassin back end
24136 @cindex spam filtering
24137 @cindex spamassassin, spam filtering
24140 @defvar spam-use-spamassassin
24142 Set this variable if you want @code{spam-split} to use SpamAssassin.
24144 SpamAssassin assigns a score to each article based on a set of rules
24145 and tests, including a Bayesian filter. The Bayesian filter can be
24146 trained by associating the @samp{$} mark for spam articles. The
24147 spam score can be viewed by using the command @kbd{S t} in summary
24150 If you set this variable, each article will be processed by
24151 SpamAssassin when @code{spam-split} is called. If your mail is
24152 preprocessed by SpamAssassin, and you want to just use the
24153 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
24156 You should not enable this is you use
24157 @code{spam-use-spamassassin-headers}.
24161 @defvar spam-use-spamassassin-headers
24163 Set this variable if your mail is preprocessed by SpamAssassin and
24164 want @code{spam-split} to split based on the SpamAssassin headers.
24166 You should not enable this is you use @code{spam-use-spamassassin}.
24170 @defvar spam-spamassassin-path
24172 This variable points to the SpamAssassin executable. If you have
24173 @code{spamd} running, you can set this variable to the @code{spamc}
24174 executable for faster processing. See the SpamAssassin documentation
24175 for more information on @code{spamd}/@code{spamc}.
24179 SpamAssassin is a powerful and flexible spam filter that uses a wide
24180 variety of tests to identify spam. A ham and a spam processors are
24181 provided, plus the @code{spam-use-spamassassin} and
24182 @code{spam-use-spamassassin-headers} variables to indicate to
24183 spam-split that SpamAssassin should be either used, or has already
24184 been used on the article. The 2.63 version of SpamAssassin was used
24185 to test this functionality.
24187 @node ifile spam filtering
24188 @subsubsection ifile spam filtering
24189 @cindex spam filtering
24190 @cindex ifile, spam filtering
24193 @defvar spam-use-ifile
24195 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
24196 statistical analyzer similar to Bogofilter.
24200 @defvar spam-ifile-all-categories
24202 Enable this variable if you want @code{spam-use-ifile} to give you all
24203 the ifile categories, not just spam/non-spam. If you use this, make
24204 sure you train ifile as described in its documentation.
24208 @defvar spam-ifile-spam-category
24210 This is the category of spam messages as far as ifile is concerned.
24211 The actual string used is irrelevant, but you probably want to leave
24212 the default value of @samp{spam}.
24215 @defvar spam-ifile-database-path
24217 This is the filename for the ifile database. It is not specified by
24218 default, so ifile will use its own default database name.
24222 The ifile mail classifier is similar to Bogofilter in intent and
24223 purpose. A ham and a spam processor are provided, plus the
24224 @code{spam-use-ifile} variable to indicate to spam-split that ifile
24225 should be used. The 1.2.1 version of ifile was used to test this
24228 @node spam-stat spam filtering
24229 @subsubsection spam-stat spam filtering
24230 @cindex spam filtering
24231 @cindex spam-stat, spam filtering
24235 @xref{Filtering Spam Using Statistics with spam-stat}.
24237 @defvar spam-use-stat
24239 Enable this variable if you want @code{spam-split} to use
24240 spam-stat.el, an Emacs Lisp statistical analyzer.
24244 @defvar gnus-group-spam-exit-processor-stat
24245 Add this symbol to a group's @code{spam-process} parameter by
24246 customizing the group parameters or the
24247 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24248 added to a group's @code{spam-process} parameter, the spam-marked
24249 articles will be added to the spam-stat database of spam messages.
24253 Instead of the obsolete
24254 @code{gnus-group-spam-exit-processor-stat}, it is recommended
24255 that you use @code{'(spam spam-use-stat)}. Everything will work
24256 the same way, we promise.
24259 @defvar gnus-group-ham-exit-processor-stat
24260 Add this symbol to a group's @code{spam-process} parameter by
24261 customizing the group parameters or the
24262 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24263 added to a group's @code{spam-process} parameter, the ham-marked
24264 articles in @emph{ham} groups will be added to the spam-stat database
24265 of non-spam messages.
24269 Instead of the obsolete
24270 @code{gnus-group-ham-exit-processor-stat}, it is recommended
24271 that you use @code{'(ham spam-use-stat)}. Everything will work
24272 the same way, we promise.
24275 This enables @code{spam.el} to cooperate with @file{spam-stat.el}.
24276 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
24277 which unlike ifile or Bogofilter does not require external programs.
24278 A spam and a ham processor, and the @code{spam-use-stat} variable for
24279 @code{spam-split} are provided.
24282 @subsubsection Using SpamOracle with Gnus
24283 @cindex spam filtering
24287 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
24288 statistical mail filtering tool written by Xavier Leroy and needs to be
24289 installed separately.
24291 There are several ways to use SpamOracle with Gnus. In all cases, your
24292 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
24293 then enter an @samp{X-Spam} header indicating whether it regards the
24294 mail as a spam mail or not.
24296 One possibility is to run SpamOracle as a @code{:prescript} from the
24297 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
24298 the advantage that the user can see the @emph{X-Spam} headers.
24300 The easiest method is to make @code{spam.el} (@pxref{Filtering Spam
24301 Using The Spam ELisp Package}) call SpamOracle.
24303 @vindex spam-use-spamoracle
24304 To enable SpamOracle usage by @code{spam.el}, set the variable
24305 @code{spam-use-spamoracle} to @code{t} and configure the
24306 @code{nnmail-split-fancy} or @code{nnimap-split-fancy} as described in
24307 the section @xref{Filtering Spam Using The Spam ELisp Package}. In
24308 this example the @samp{INBOX} of an nnimap server is filtered using
24309 SpamOracle. Mails recognized as spam mails will be moved to
24310 @code{spam-split-group}, @samp{Junk} in this case. Ham messages stay
24314 (setq spam-use-spamoracle t
24315 spam-split-group "Junk"
24316 nnimap-split-inbox '("INBOX")
24317 nnimap-split-rule 'nnimap-split-fancy
24318 nnimap-split-fancy '(| (: spam-split) "INBOX"))
24321 @defvar spam-use-spamoracle
24322 Set to @code{t} if you want Gnus to enable spam filtering using
24326 @defvar spam-spamoracle-binary
24327 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
24328 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
24332 @defvar spam-spamoracle-database
24333 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
24334 store its analyses. This is controlled by the variable
24335 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
24336 the default SpamOracle database will be used. In case you want your
24337 database to live somewhere special, set
24338 @code{spam-spamoracle-database} to this path.
24341 SpamOracle employs a statistical algorithm to determine whether a
24342 message is spam or ham. In order to get good results, meaning few
24343 false hits or misses, SpamOracle needs training. SpamOracle learns the
24344 characteristics of your spam mails. Using the @emph{add} mode
24345 (training mode) one has to feed good (ham) and spam mails to
24346 SpamOracle. This can be done by pressing @kbd{|} in the Summary buffer
24347 and pipe the mail to a SpamOracle process or using @code{spam.el}'s
24348 spam- and ham-processors, which is much more convenient. For a
24349 detailed description of spam- and ham-processors, @xref{Filtering Spam
24350 Using The Spam ELisp Package}.
24352 @defvar gnus-group-spam-exit-processor-spamoracle
24353 Add this symbol to a group's @code{spam-process} parameter by
24354 customizing the group parameter or the
24355 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
24356 to a group's @code{spam-process} parameter, spam-marked articles will be
24357 sent to SpamOracle as spam samples.
24361 Instead of the obsolete
24362 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
24363 that you use @code{'(spam spam-use-spamoracle)}. Everything will work
24364 the same way, we promise.
24367 @defvar gnus-group-ham-exit-processor-spamoracle
24368 Add this symbol to a group's @code{spam-process} parameter by
24369 customizing the group parameter or the
24370 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
24371 to a group's @code{spam-process} parameter, the ham-marked articles in
24372 @emph{ham} groups will be sent to the SpamOracle as samples of ham
24377 Instead of the obsolete
24378 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
24379 that you use @code{'(ham spam-use-spamoracle)}. Everything will work
24380 the same way, we promise.
24383 @emph{Example:} These are the Group Parameters of a group that has been
24384 classified as a ham group, meaning that it should only contain ham
24387 ((spam-contents gnus-group-spam-classification-ham)
24388 (spam-process ((ham spam-use-spamoracle)
24389 (spam spam-use-spamoracle))))
24391 For this group the @code{spam-use-spamoracle} is installed for both
24392 ham and spam processing. If the group contains spam message
24393 (e.g. because SpamOracle has not had enough sample messages yet) and
24394 the user marks some messages as spam messages, these messages will be
24395 processed by SpamOracle. The processor sends the messages to
24396 SpamOracle as new samples for spam.
24398 @node Extending the Spam ELisp package
24399 @subsubsection Extending the Spam ELisp package
24400 @cindex spam filtering
24401 @cindex spam elisp package, extending
24402 @cindex extending the spam elisp package
24404 Say you want to add a new back end called blackbox. For filtering
24405 incoming mail, provide the following:
24413 (defvar spam-use-blackbox nil
24414 "True if blackbox should be used.")
24417 Write @code{spam-check-blackbox} if Blackbox can check incoming mail.
24419 Write @code{spam-blackbox-register-routine} and
24420 @code{spam-blackbox-unregister-routine} using the bogofilter
24421 register/unregister routines as a start, or other restister/unregister
24422 routines more appropriate to Blackbox, if Blackbox can
24423 register/unregister spam and ham.
24428 The @code{spam-check-blackbox} function should return @samp{nil} or
24429 @code{spam-split-group}, observing the other conventions. See the
24430 existing @code{spam-check-*} functions for examples of what you can
24431 do, and stick to the template unless you fully understand the reasons
24436 For processing spam and ham messages, provide the following:
24443 Note you don't have to provide a spam or a ham processor. Only
24444 provide them if Blackbox supports spam or ham processing.
24446 Also, ham and spam processors are being phased out as single
24447 variables. Instead the form @code{'(spam spam-use-blackbox)} or
24448 @code{'(ham spam-use-blackbox)} is favored. For now, spam/ham
24449 processor variables are still around but they won't be for long.
24452 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
24453 "The Blackbox summary exit spam processor.
24454 Only applicable to spam groups.")
24456 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
24457 "The whitelist summary exit ham processor.
24458 Only applicable to non-spam (unclassified and ham) groups.")
24467 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
24468 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
24470 to the @code{spam-process} group parameter in @code{gnus.el}. Make
24471 sure you do it twice, once for the parameter and once for the
24472 variable customization.
24476 (variable-item spam-use-blackbox)
24478 to the @code{spam-autodetect-methods} group parameter in
24479 @code{gnus.el} if Blackbox can check incoming mail for spam contents.
24481 Finally, use the appropriate @code{spam-install-*-backend} function in
24482 @code{spam.el}. Here are the available functions.
24488 @code{spam-install-backend-alias}
24490 This function will simply install an alias for a back end that does
24491 everything like the original back end. It is currently only used to
24492 make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}.
24495 @code{spam-install-nocheck-backend}
24497 This function installs a back end that has no check function, but can
24498 register/unregister ham or spam. The @code{spam-use-gmane} back end is
24502 @code{spam-install-checkonly-backend}
24504 This function will install a back end that can only check incoming mail
24505 for spam contents. It can't register or unregister messages.
24506 @code{spam-use-blackholes} and @code{spam-use-hashcash} are such
24510 @code{spam-install-statistical-checkonly-backend}
24512 This function installs a statistical back end (one which requires the
24513 full body of a message to check it) that can only check incoming mail
24514 for contents. @code{spam-use-regex-body} is such a filter.
24517 @code{spam-install-statistical-backend}
24519 This function install a statistical back end with incoming checks and
24520 registration/unregistration routines. @code{spam-use-bogofilter} is
24524 @code{spam-install-backend}
24526 This is the most normal back end installation, where a back end that can
24527 check and register/unregister messages is set up without statistical
24528 abilities. The @code{spam-use-BBDB} is such a back end.
24531 @code{spam-install-mover-backend}
24533 Mover back ends are internal to @code{spam.el} and specifically move
24534 articles around when the summary is exited. You will very probably
24535 never install such a back end.
24541 @node Filtering Spam Using Statistics with spam-stat
24542 @subsection Filtering Spam Using Statistics with spam-stat
24543 @cindex Paul Graham
24544 @cindex Graham, Paul
24545 @cindex naive Bayesian spam filtering
24546 @cindex Bayesian spam filtering, naive
24547 @cindex spam filtering, naive Bayesian
24549 Paul Graham has written an excellent essay about spam filtering using
24550 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
24551 Spam}. In it he describes the inherent deficiency of rule-based
24552 filtering as used by SpamAssassin, for example: Somebody has to write
24553 the rules, and everybody else has to install these rules. You are
24554 always late. It would be much better, he argues, to filter mail based
24555 on whether it somehow resembles spam or non-spam. One way to measure
24556 this is word distribution. He then goes on to describe a solution
24557 that checks whether a new mail resembles any of your other spam mails
24560 The basic idea is this: Create a two collections of your mail, one
24561 with spam, one with non-spam. Count how often each word appears in
24562 either collection, weight this by the total number of mails in the
24563 collections, and store this information in a dictionary. For every
24564 word in a new mail, determine its probability to belong to a spam or a
24565 non-spam mail. Use the 15 most conspicuous words, compute the total
24566 probability of the mail being spam. If this probability is higher
24567 than a certain threshold, the mail is considered to be spam.
24569 Gnus supports this kind of filtering. But it needs some setting up.
24570 First, you need two collections of your mail, one with spam, one with
24571 non-spam. Then you need to create a dictionary using these two
24572 collections, and save it. And last but not least, you need to use
24573 this dictionary in your fancy mail splitting rules.
24576 * Creating a spam-stat dictionary::
24577 * Splitting mail using spam-stat::
24578 * Low-level interface to the spam-stat dictionary::
24581 @node Creating a spam-stat dictionary
24582 @subsubsection Creating a spam-stat dictionary
24584 Before you can begin to filter spam based on statistics, you must
24585 create these statistics based on two mail collections, one with spam,
24586 one with non-spam. These statistics are then stored in a dictionary
24587 for later use. In order for these statistics to be meaningful, you
24588 need several hundred emails in both collections.
24590 Gnus currently supports only the nnml back end for automated dictionary
24591 creation. The nnml back end stores all mails in a directory, one file
24592 per mail. Use the following:
24594 @defun spam-stat-process-spam-directory
24595 Create spam statistics for every file in this directory. Every file
24596 is treated as one spam mail.
24599 @defun spam-stat-process-non-spam-directory
24600 Create non-spam statistics for every file in this directory. Every
24601 file is treated as one non-spam mail.
24604 Usually you would call @code{spam-stat-process-spam-directory} on a
24605 directory such as @file{~/Mail/mail/spam} (this usually corresponds
24606 the the group @samp{nnml:mail.spam}), and you would call
24607 @code{spam-stat-process-non-spam-directory} on a directory such as
24608 @file{~/Mail/mail/misc} (this usually corresponds the the group
24609 @samp{nnml:mail.misc}).
24611 When you are using @acronym{IMAP}, you won't have the mails available
24612 locally, so that will not work. One solution is to use the Gnus Agent
24613 to cache the articles. Then you can use directories such as
24614 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
24615 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
24618 This variable holds the hash-table with all the statistics---the
24619 dictionary we have been talking about. For every word in either
24620 collection, this hash-table stores a vector describing how often the
24621 word appeared in spam and often it appeared in non-spam mails.
24624 If you want to regenerate the statistics from scratch, you need to
24625 reset the dictionary.
24627 @defun spam-stat-reset
24628 Reset the @code{spam-stat} hash-table, deleting all the statistics.
24631 When you are done, you must save the dictionary. The dictionary may
24632 be rather large. If you will not update the dictionary incrementally
24633 (instead, you will recreate it once a month, for example), then you
24634 can reduce the size of the dictionary by deleting all words that did
24635 not appear often enough or that do not clearly belong to only spam or
24636 only non-spam mails.
24638 @defun spam-stat-reduce-size
24639 Reduce the size of the dictionary. Use this only if you do not want
24640 to update the dictionary incrementally.
24643 @defun spam-stat-save
24644 Save the dictionary.
24647 @defvar spam-stat-file
24648 The filename used to store the dictionary. This defaults to
24649 @file{~/.spam-stat.el}.
24652 @node Splitting mail using spam-stat
24653 @subsubsection Splitting mail using spam-stat
24655 In order to use @code{spam-stat} to split your mail, you need to add the
24656 following to your @file{~/.gnus.el} file:
24659 (require 'spam-stat)
24663 This will load the necessary Gnus code, and the dictionary you
24666 Next, you need to adapt your fancy splitting rules: You need to
24667 determine how to use @code{spam-stat}. The following examples are for
24668 the nnml back end. Using the nnimap back end works just as well. Just
24669 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
24671 In the simplest case, you only have two groups, @samp{mail.misc} and
24672 @samp{mail.spam}. The following expression says that mail is either
24673 spam or it should go into @samp{mail.misc}. If it is spam, then
24674 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
24677 (setq nnmail-split-fancy
24678 `(| (: spam-stat-split-fancy)
24682 @defvar spam-stat-split-fancy-spam-group
24683 The group to use for spam. Default is @samp{mail.spam}.
24686 If you also filter mail with specific subjects into other groups, use
24687 the following expression. Only mails not matching the regular
24688 expression are considered potential spam.
24691 (setq nnmail-split-fancy
24692 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
24693 (: spam-stat-split-fancy)
24697 If you want to filter for spam first, then you must be careful when
24698 creating the dictionary. Note that @code{spam-stat-split-fancy} must
24699 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
24700 non-spam, therefore both should be in your collection of non-spam
24701 mails, when creating the dictionary!
24704 (setq nnmail-split-fancy
24705 `(| (: spam-stat-split-fancy)
24706 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24710 You can combine this with traditional filtering. Here, we move all
24711 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
24712 @code{spam-stat-split-fancy} will never see them, the mails in
24713 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
24714 nor in your collection of non-spam mails, when creating the
24718 (setq nnmail-split-fancy
24719 `(| ("Content-Type" "text/html" "mail.spam.filtered")
24720 (: spam-stat-split-fancy)
24721 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24726 @node Low-level interface to the spam-stat dictionary
24727 @subsubsection Low-level interface to the spam-stat dictionary
24729 The main interface to using @code{spam-stat}, are the following functions:
24731 @defun spam-stat-buffer-is-spam
24732 Called in a buffer, that buffer is considered to be a new spam mail.
24733 Use this for new mail that has not been processed before.
24736 @defun spam-stat-buffer-is-no-spam
24737 Called in a buffer, that buffer is considered to be a new non-spam
24738 mail. Use this for new mail that has not been processed before.
24741 @defun spam-stat-buffer-change-to-spam
24742 Called in a buffer, that buffer is no longer considered to be normal
24743 mail but spam. Use this to change the status of a mail that has
24744 already been processed as non-spam.
24747 @defun spam-stat-buffer-change-to-non-spam
24748 Called in a buffer, that buffer is no longer considered to be spam but
24749 normal mail. Use this to change the status of a mail that has already
24750 been processed as spam.
24753 @defun spam-stat-save
24754 Save the hash table to the file. The filename used is stored in the
24755 variable @code{spam-stat-file}.
24758 @defun spam-stat-load
24759 Load the hash table from a file. The filename used is stored in the
24760 variable @code{spam-stat-file}.
24763 @defun spam-stat-score-word
24764 Return the spam score for a word.
24767 @defun spam-stat-score-buffer
24768 Return the spam score for a buffer.
24771 @defun spam-stat-split-fancy
24772 Use this function for fancy mail splitting. Add the rule @samp{(:
24773 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
24776 Make sure you load the dictionary before using it. This requires the
24777 following in your @file{~/.gnus.el} file:
24780 (require 'spam-stat)
24784 Typical test will involve calls to the following functions:
24787 Reset: (setq spam-stat (make-hash-table :test 'equal))
24788 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24789 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24790 Save table: (spam-stat-save)
24791 File size: (nth 7 (file-attributes spam-stat-file))
24792 Number of words: (hash-table-count spam-stat)
24793 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24794 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24795 Reduce table size: (spam-stat-reduce-size)
24796 Save table: (spam-stat-save)
24797 File size: (nth 7 (file-attributes spam-stat-file))
24798 Number of words: (hash-table-count spam-stat)
24799 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24800 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24803 Here is how you would create your dictionary:
24806 Reset: (setq spam-stat (make-hash-table :test 'equal))
24807 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24808 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24809 Repeat for any other non-spam group you need...
24810 Reduce table size: (spam-stat-reduce-size)
24811 Save table: (spam-stat-save)
24815 @section Interaction with other modes
24820 @code{gnus-dired-minor-mode} provided some useful functions for dired
24821 buffers. It is enabled with
24823 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
24828 @findex gnus-dired-attach
24829 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
24830 You will be prompted for a message buffer.
24833 @findex gnus-dired-find-file-mailcap
24834 Visit a file according to the appropriate mailcap entry
24835 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
24839 @findex gnus-dired-print
24840 Print file according to the mailcap entry (@code{gnus-dired-print}). If
24841 there is no print command, print in a PostScript image.
24844 @node Various Various
24845 @section Various Various
24851 @item gnus-home-directory
24852 @vindex gnus-home-directory
24853 All Gnus file and directory variables will be initialized from this
24854 variable, which defaults to @file{~/}.
24856 @item gnus-directory
24857 @vindex gnus-directory
24858 Most Gnus storage file and directory variables will be initialized from
24859 this variable, which defaults to the @env{SAVEDIR} environment
24860 variable, or @file{~/News/} if that variable isn't set.
24862 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
24863 This means that other directory variables that are initialized from this
24864 variable won't be set properly if you set this variable in
24865 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
24867 @item gnus-default-directory
24868 @vindex gnus-default-directory
24869 Not related to the above variable at all---this variable says what the
24870 default directory of all Gnus buffers should be. If you issue commands
24871 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
24872 default directory. If this variable is @code{nil} (which is the
24873 default), the default directory will be the default directory of the
24874 buffer you were in when you started Gnus.
24877 @vindex gnus-verbose
24878 This variable is an integer between zero and ten. The higher the value,
24879 the more messages will be displayed. If this variable is zero, Gnus
24880 will never flash any messages, if it is seven (which is the default),
24881 most important messages will be shown, and if it is ten, Gnus won't ever
24882 shut up, but will flash so many messages it will make your head swim.
24884 @item gnus-verbose-backends
24885 @vindex gnus-verbose-backends
24886 This variable works the same way as @code{gnus-verbose}, but it applies
24887 to the Gnus back ends instead of Gnus proper.
24889 @item nnheader-max-head-length
24890 @vindex nnheader-max-head-length
24891 When the back ends read straight heads of articles, they all try to read
24892 as little as possible. This variable (default 4096) specifies
24893 the absolute max length the back ends will try to read before giving up
24894 on finding a separator line between the head and the body. If this
24895 variable is @code{nil}, there is no upper read bound. If it is
24896 @code{t}, the back ends won't try to read the articles piece by piece,
24897 but read the entire articles. This makes sense with some versions of
24898 @code{ange-ftp} or @code{efs}.
24900 @item nnheader-head-chop-length
24901 @vindex nnheader-head-chop-length
24902 This variable (default 2048) says how big a piece of each article to
24903 read when doing the operation described above.
24905 @item nnheader-file-name-translation-alist
24906 @vindex nnheader-file-name-translation-alist
24908 @cindex invalid characters in file names
24909 @cindex characters in file names
24910 This is an alist that says how to translate characters in file names.
24911 For instance, if @samp{:} is invalid as a file character in file names
24912 on your system (you OS/2 user you), you could say something like:
24916 (setq nnheader-file-name-translation-alist
24921 In fact, this is the default value for this variable on OS/2 and MS
24922 Windows (phooey) systems.
24924 @item gnus-hidden-properties
24925 @vindex gnus-hidden-properties
24926 This is a list of properties to use to hide ``invisible'' text. It is
24927 @code{(invisible t intangible t)} by default on most systems, which
24928 makes invisible text invisible and intangible.
24930 @item gnus-parse-headers-hook
24931 @vindex gnus-parse-headers-hook
24932 A hook called before parsing headers. It can be used, for instance, to
24933 gather statistics on the headers fetched, or perhaps you'd like to prune
24934 some headers. I don't see why you'd want that, though.
24936 @item gnus-shell-command-separator
24937 @vindex gnus-shell-command-separator
24938 String used to separate two shell commands. The default is @samp{;}.
24940 @item gnus-invalid-group-regexp
24941 @vindex gnus-invalid-group-regexp
24943 Regexp to match ``invalid'' group names when querying user for a group
24944 name. The default value catches some @strong{really} invalid group
24945 names who could possibly mess up Gnus internally (like allowing
24946 @samp{:} in a group name, which is normally used to delimit method and
24949 @acronym{IMAP} users might want to allow @samp{/} in group names though.
24957 Well, that's the manual---you can get on with your life now. Keep in
24958 touch. Say hello to your cats from me.
24960 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
24962 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
24968 Not because of victories @*
24971 but for the common sunshine,@*
24973 the largess of the spring.
24977 but for the day's work done@*
24978 as well as I was able;@*
24979 not for a seat upon the dais@*
24980 but at the common table.@*
24985 @chapter Appendices
24988 * XEmacs:: Requirements for installing under XEmacs.
24989 * History:: How Gnus got where it is today.
24990 * On Writing Manuals:: Why this is not a beginner's guide.
24991 * Terminology:: We use really difficult, like, words here.
24992 * Customization:: Tailoring Gnus to your needs.
24993 * Troubleshooting:: What you might try if things do not work.
24994 * Gnus Reference Guide:: Rilly, rilly technical stuff.
24995 * Emacs for Heathens:: A short introduction to Emacsian terms.
24996 * Frequently Asked Questions:: The Gnus FAQ
25003 @cindex installing under XEmacs
25005 XEmacs is distributed as a collection of packages. You should install
25006 whatever packages the Gnus XEmacs package requires. The current
25007 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
25008 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
25009 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{w3},
25010 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
25017 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
25018 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
25020 If you want to investigate the person responsible for this outrage,
25021 you can point your (feh!) web browser to
25022 @uref{http://quimby.gnus.org/}. This is also the primary
25023 distribution point for the new and spiffy versions of Gnus, and is
25024 known as The Site That Destroys Newsrcs And Drives People Mad.
25026 During the first extended alpha period of development, the new Gnus was
25027 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
25028 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
25029 (Besides, the ``Gnus'' in this abbreviation should probably be
25030 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
25031 appropriate name, don't you think?)
25033 In any case, after spending all that energy on coming up with a new and
25034 spunky name, we decided that the name was @emph{too} spunky, so we
25035 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
25036 ``@sc{gnus}''. New vs. old.
25039 * Gnus Versions:: What Gnus versions have been released.
25040 * Other Gnus Versions:: Other Gnus versions that also have been released.
25041 * Why?:: What's the point of Gnus?
25042 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
25043 * Conformity:: Gnus tries to conform to all standards.
25044 * Emacsen:: Gnus can be run on a few modern Emacsen.
25045 * Gnus Development:: How Gnus is developed.
25046 * Contributors:: Oodles of people.
25047 * New Features:: Pointers to some of the new stuff in Gnus.
25051 @node Gnus Versions
25052 @subsection Gnus Versions
25054 @cindex September Gnus
25056 @cindex Quassia Gnus
25057 @cindex Pterodactyl Gnus
25060 @cindex Gnus versions
25062 The first ``proper'' release of Gnus 5 was done in November 1995 when it
25063 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
25064 plus 15 Gnus 5.0 releases).
25066 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
25067 releases)) was released under the name ``Gnus 5.2'' (40 releases).
25069 On July 28th 1996 work on Red Gnus was begun, and it was released on
25070 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
25072 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
25073 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
25075 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
25076 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
25079 On the 26th of October 2000, Oort Gnus was begun.
25081 If you happen upon a version of Gnus that has a prefixed name --
25082 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
25083 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
25084 that you're frightened. Back away. Slowly. Whatever you do, don't
25085 run. Walk away, calmly, until you're out of its reach. Find a proper
25086 released version of Gnus and snuggle up to that instead.
25089 @node Other Gnus Versions
25090 @subsection Other Gnus Versions
25093 In addition to the versions of Gnus which have had their releases
25094 coordinated by Lars, one major development has been Semi-gnus from
25095 Japan. It's based on a library called @acronym{SEMI}, which provides
25096 @acronym{MIME} capabilities.
25098 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
25099 Collectively, they are called ``Semi-gnus'', and different strains are
25100 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
25101 @acronym{MIME} and multilingualization things, especially important for
25108 What's the point of Gnus?
25110 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
25111 newsreader, that lets you do anything you can think of. That was my
25112 original motivation, but while working on Gnus, it has become clear to
25113 me that this generation of newsreaders really belong in the stone age.
25114 Newsreaders haven't developed much since the infancy of the net. If the
25115 volume continues to rise with the current rate of increase, all current
25116 newsreaders will be pretty much useless. How do you deal with
25117 newsgroups that have thousands of new articles each day? How do you
25118 keep track of millions of people who post?
25120 Gnus offers no real solutions to these questions, but I would very much
25121 like to see Gnus being used as a testing ground for new methods of
25122 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
25123 to separate the newsreader from the back ends, Gnus now offers a simple
25124 interface for anybody who wants to write new back ends for fetching mail
25125 and news from different sources. I have added hooks for customizations
25126 everywhere I could imagine it being useful. By doing so, I'm inviting
25127 every one of you to explore and invent.
25129 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
25130 @kbd{C-u 100 M-x all-hail-xemacs}.
25133 @node Compatibility
25134 @subsection Compatibility
25136 @cindex compatibility
25137 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
25138 bindings have been kept. More key bindings have been added, of course,
25139 but only in one or two obscure cases have old bindings been changed.
25144 @center In a cloud bones of steel.
25148 All commands have kept their names. Some internal functions have changed
25151 The @code{gnus-uu} package has changed drastically. @xref{Decoding
25154 One major compatibility question is the presence of several summary
25155 buffers. All variables relevant while reading a group are
25156 buffer-local to the summary buffer they belong in. Although many
25157 important variables have their values copied into their global
25158 counterparts whenever a command is executed in the summary buffer, this
25159 change might lead to incorrect values being used unless you are careful.
25161 All code that relies on knowledge of @sc{gnus} internals will probably
25162 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
25163 changing it in any way, as a matter of fact) is strictly verboten. Gnus
25164 maintains a hash table that points to the entries in this alist (which
25165 speeds up many functions), and changing the alist directly will lead to
25169 @cindex highlighting
25170 Old hilit19 code does not work at all. In fact, you should probably
25171 remove all hilit code from all Gnus hooks
25172 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
25173 Gnus provides various integrated functions for highlighting. These are
25174 faster and more accurate. To make life easier for everybody, Gnus will
25175 by default remove all hilit calls from all hilit hooks. Uncleanliness!
25178 Packages like @code{expire-kill} will no longer work. As a matter of
25179 fact, you should probably remove all old @sc{gnus} packages (and other
25180 code) when you start using Gnus. More likely than not, Gnus already
25181 does what you have written code to make @sc{gnus} do. (Snicker.)
25183 Even though old methods of doing things are still supported, only the
25184 new methods are documented in this manual. If you detect a new method of
25185 doing something while reading this manual, that does not mean you have
25186 to stop doing it the old way.
25188 Gnus understands all @sc{gnus} startup files.
25190 @kindex M-x gnus-bug
25192 @cindex reporting bugs
25194 Overall, a casual user who hasn't written much code that depends on
25195 @sc{gnus} internals should suffer no problems. If problems occur,
25196 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
25198 @vindex gnus-bug-create-help-buffer
25199 If you are in the habit of sending bug reports @emph{very} often, you
25200 may find the helpful help buffer annoying after a while. If so, set
25201 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
25206 @subsection Conformity
25208 No rebels without a clue here, ma'am. We conform to all standards known
25209 to (wo)man. Except for those standards and/or conventions we disagree
25217 There are no known breaches of this standard.
25221 There are no known breaches of this standard, either.
25223 @item Son-of-RFC 1036
25224 @cindex Son-of-RFC 1036
25225 We do have some breaches to this one.
25231 These are considered to be ``vanity headers'', while I consider them
25232 to be consumer information. After seeing so many badly formatted
25233 articles coming from @code{tin} and @code{Netscape} I know not to use
25234 either of those for posting articles. I would not have known that if
25235 it wasn't for the @code{X-Newsreader} header.
25240 USEFOR is an IETF working group writing a successor to RFC 1036, based
25241 on Son-of-RFC 1036. They have produced a number of drafts proposing
25242 various changes to the format of news articles. The Gnus towers will
25243 look into implementing the changes when the draft is accepted as an RFC.
25245 @item MIME - RFC 2045-2049 etc
25246 @cindex @acronym{MIME}
25247 All the various @acronym{MIME} RFCs are supported.
25249 @item Disposition Notifications - RFC 2298
25250 Message Mode is able to request notifications from the receiver.
25252 @item PGP - RFC 1991 and RFC 2440
25255 RFC 1991 is the original @acronym{PGP} message specification,
25256 published as an informational RFC. RFC 2440 was the follow-up, now
25257 called Open PGP, and put on the Standards Track. Both document a
25258 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
25259 encoding (signing and encryption) and decoding (verification and
25262 @item PGP/MIME - RFC 2015/3156
25263 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
25264 1991) describes the @acronym{MIME}-wrapping around the RF 1991/2440 format.
25265 Gnus supports both encoding and decoding.
25267 @item S/MIME - RFC 2633
25268 RFC 2633 describes the @acronym{S/MIME} format.
25270 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
25271 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
25272 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
25273 authentication for @acronym{IMAP}. RFC 2086 describes access control
25274 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
25275 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
25276 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
25277 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
25281 If you ever notice Gnus acting non-compliant with regards to the texts
25282 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
25287 @subsection Emacsen
25293 Gnus should work on:
25301 XEmacs 21.4 and up.
25305 This Gnus version will absolutely not work on any Emacsen older than
25306 that. Not reliably, at least. Older versions of Gnus may work on older
25307 Emacs versions. However, T-gnus does support ``Mule 2.3 based on Emacs
25308 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
25309 See the file ``README'' in the T-gnus distribution for more details.
25311 There are some vague differences between Gnus on the various
25312 platforms---XEmacs features more graphics (a logo and a toolbar)---but
25313 other than that, things should look pretty much the same under all
25317 @node Gnus Development
25318 @subsection Gnus Development
25320 Gnus is developed in a two-phased cycle. The first phase involves much
25321 discussion on the @samp{ding@@gnus.org} mailing list, where people
25322 propose changes and new features, post patches and new back ends. This
25323 phase is called the @dfn{alpha} phase, since the Gnusae released in this
25324 phase are @dfn{alpha releases}, or (perhaps more commonly in other
25325 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
25326 unstable and should not be used by casual users. Gnus alpha releases
25327 have names like ``Red Gnus'' and ``Quassia Gnus''.
25329 After futzing around for 50-100 alpha releases, Gnus is declared
25330 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
25331 and is called things like ``Gnus 5.6.32'' instead. Normal people are
25332 supposed to be able to use these, and these are mostly discussed on the
25333 @samp{gnu.emacs.gnus} newsgroup.
25336 @vindex mail-source-delete-incoming
25337 Some variable defaults differ between alpha Gnusae and released Gnusae.
25338 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
25339 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
25340 lossage of mail if an alpha release hiccups while handling the mail.
25342 The division of discussion between the ding mailing list and the Gnus
25343 newsgroup is not purely based on publicity concerns. It's true that
25344 having people write about the horrible things that an alpha Gnus release
25345 can do (sometimes) in a public forum may scare people off, but more
25346 importantly, talking about new experimental features that have been
25347 introduced may confuse casual users. New features are frequently
25348 introduced, fiddled with, and judged to be found wanting, and then
25349 either discarded or totally rewritten. People reading the mailing list
25350 usually keep up with these rapid changes, while people on the newsgroup
25351 can't be assumed to do so.
25356 @subsection Contributors
25357 @cindex contributors
25359 The new Gnus version couldn't have been done without the help of all the
25360 people on the (ding) mailing list. Every day for over a year I have
25361 gotten billions of nice bug reports from them, filling me with joy,
25362 every single one of them. Smooches. The people on the list have been
25363 tried beyond endurance, what with my ``oh, that's a neat idea <type
25364 type>, yup, I'll release it right away <ship off> no wait, that doesn't
25365 work at all <type type>, yup, I'll ship that one off right away <ship
25366 off> no, wait, that absolutely does not work'' policy for releases.
25367 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
25368 ``worser''? ``much worser''? ``worsest''?)
25370 I would like to take this opportunity to thank the Academy for@dots{} oops,
25376 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
25379 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
25380 nnwarchive and many, many other things connected with @acronym{MIME} and
25381 other types of en/decoding, as well as general bug fixing, new
25382 functionality and stuff.
25385 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
25386 well as numerous other things).
25389 Luis Fernandes---design and graphics.
25392 Joe Reiss---creator of the smiley faces.
25395 Justin Sheehy---the @acronym{FAQ} maintainer.
25398 Erik Naggum---help, ideas, support, code and stuff.
25401 Wes Hardaker---@file{gnus-picon.el} and the manual section on
25402 @dfn{picons} (@pxref{Picons}).
25405 Kim-Minh Kaplan---further work on the picon code.
25408 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
25411 Sudish Joseph---innumerable bug fixes.
25414 Ilja Weis---@file{gnus-topic.el}.
25417 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
25420 Vladimir Alexiev---the refcard and reference booklets.
25423 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
25424 distribution by Felix Lee and JWZ.
25427 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
25430 Peter Mutsaers---orphan article scoring code.
25433 Ken Raeburn---POP mail support.
25436 Hallvard B Furuseth---various bits and pieces, especially dealing with
25440 Brian Edmonds---@file{gnus-bbdb.el}.
25443 David Moore---rewrite of @file{nnvirtual.el} and many other things.
25446 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
25449 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
25450 well as autoconf support.
25454 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
25455 Borges, and Jost Krieger proof-reading parts of the manual.
25457 The following people have contributed many patches and suggestions:
25472 Jason L. Tibbitts, III,
25474 Katsumi Yamaoka, @c Yamaoka
25478 Also thanks to the following for patches and stuff:
25488 Alexei V. Barantsev,
25503 Massimo Campostrini,
25508 Jae-you Chung, @c ?
25509 James H. Cloos, Jr.,
25513 Andrew J. Cosgriff,
25516 Geoffrey T. Dairiki,
25522 Michael Welsh Duggan,
25527 Enami Tsugutomo, @c Enami
25531 Nelson Jose dos Santos Ferreira,
25539 Arne Georg Gleditsch,
25541 Michelangelo Grigni,
25545 Kenichi Handa, @c Handa
25547 Yoshiki Hayashi, @c Hayashi
25549 Hisashige Kenji, @c Hisashige
25556 Fran@,{c}ois Felix Ingrand,
25557 Tatsuya Ichikawa, @c Ichikawa
25558 Ishikawa Ichiro, @c Ishikawa
25560 Iwamuro Motonori, @c Iwamuro
25570 Peter Skov Knudsen,
25571 Shuhei Kobayashi, @c Kobayashi
25573 Koseki Yoshinori, @c Koseki
25574 Thor Kristoffersen,
25577 Seokchan Lee, @c Lee
25595 Morioka Tomohiko, @c Morioka
25596 Erik Toubro Nielsen,
25603 Masaharu Onishi, @c Onishi
25608 Jens-Ulrik Holger Petersen,
25612 John McClary Prevost,
25618 Lars Balker Rasmussen,
25623 Christian von Roques,
25626 Wolfgang Rupprecht,
25633 Philippe Schnoebelen,
25635 Randal L. Schwartz,
25649 Kiyokazu Suto, @c Suto
25654 Tozawa Akihiko, @c Tozawa
25674 For a full overview of what each person has done, the ChangeLogs
25675 included in the Gnus alpha distributions should give ample reading
25676 (550kB and counting).
25678 Apologies to everybody that I've forgotten, of which there are many, I'm
25681 Gee, that's quite a list of people. I guess that must mean that there
25682 actually are people who are using Gnus. Who'd'a thunk it!
25686 @subsection New Features
25687 @cindex new features
25690 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
25691 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
25692 * Red Gnus:: Third time best---Gnus 5.4/5.5.
25693 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
25694 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
25695 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
25696 * No Gnus:: Lars, FIXME!
25699 These lists are, of course, just @emph{short} overviews of the
25700 @emph{most} important new features. No, really. There are tons more.
25701 Yes, we have feeping creaturism in full effect.
25704 @subsubsection (ding) Gnus
25706 New features in Gnus 5.0/5.1:
25711 The look of all buffers can be changed by setting format-like variables
25712 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
25715 Local spool and several @acronym{NNTP} servers can be used at once
25716 (@pxref{Select Methods}).
25719 You can combine groups into virtual groups (@pxref{Virtual Groups}).
25722 You can read a number of different mail formats (@pxref{Getting Mail}).
25723 All the mail back ends implement a convenient mail expiry scheme
25724 (@pxref{Expiring Mail}).
25727 Gnus can use various strategies for gathering threads that have lost
25728 their roots (thereby gathering loose sub-threads into one thread) or it
25729 can go back and retrieve enough headers to build a complete thread
25730 (@pxref{Customizing Threading}).
25733 Killed groups can be displayed in the group buffer, and you can read
25734 them as well (@pxref{Listing Groups}).
25737 Gnus can do partial group updates---you do not have to retrieve the
25738 entire active file just to check for new articles in a few groups
25739 (@pxref{The Active File}).
25742 Gnus implements a sliding scale of subscribedness to groups
25743 (@pxref{Group Levels}).
25746 You can score articles according to any number of criteria
25747 (@pxref{Scoring}). You can even get Gnus to find out how to score
25748 articles for you (@pxref{Adaptive Scoring}).
25751 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
25752 manner, so it should be difficult to lose much data on what you have
25753 read if your machine should go down (@pxref{Auto Save}).
25756 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
25757 cluttering up the @file{.emacs} file.
25760 You can set the process mark on both groups and articles and perform
25761 operations on all the marked items (@pxref{Process/Prefix}).
25764 You can grep through a subset of groups and create a group from the
25765 results (@pxref{Kibozed Groups}).
25768 You can list subsets of groups according to, well, anything
25769 (@pxref{Listing Groups}).
25772 You can browse foreign servers and subscribe to groups from those
25773 servers (@pxref{Browse Foreign Server}).
25776 Gnus can fetch articles, asynchronously, on a second connection to the
25777 server (@pxref{Asynchronous Fetching}).
25780 You can cache articles locally (@pxref{Article Caching}).
25783 The uudecode functions have been expanded and generalized
25784 (@pxref{Decoding Articles}).
25787 You can still post uuencoded articles, which was a little-known feature
25788 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
25791 Fetching parents (and other articles) now actually works without
25792 glitches (@pxref{Finding the Parent}).
25795 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
25798 Digests (and other files) can be used as the basis for groups
25799 (@pxref{Document Groups}).
25802 Articles can be highlighted and customized (@pxref{Customizing
25806 URLs and other external references can be buttonized (@pxref{Article
25810 You can do lots of strange stuff with the Gnus window & frame
25811 configuration (@pxref{Window Layout}).
25814 You can click on buttons instead of using the keyboard
25820 @node September Gnus
25821 @subsubsection September Gnus
25825 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
25829 New features in Gnus 5.2/5.3:
25834 A new message composition mode is used. All old customization variables
25835 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
25839 Gnus is now able to generate @dfn{sparse} threads---threads where
25840 missing articles are represented by empty nodes (@pxref{Customizing
25844 (setq gnus-build-sparse-threads 'some)
25848 Outgoing articles are stored on a special archive server
25849 (@pxref{Archived Messages}).
25852 Partial thread regeneration now happens when articles are
25856 Gnus can make use of GroupLens predictions.
25859 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
25862 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
25865 (setq gnus-use-trees t)
25869 An @code{nn}-like pick-and-read minor mode is available for the summary
25870 buffers (@pxref{Pick and Read}).
25873 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
25877 In binary groups you can use a special binary minor mode (@pxref{Binary
25881 Groups can be grouped in a folding topic hierarchy (@pxref{Group
25885 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
25889 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
25892 Groups can now have a score, and bubbling based on entry frequency
25893 is possible (@pxref{Group Score}).
25896 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
25900 Groups can be process-marked, and commands can be performed on
25901 groups of groups (@pxref{Marking Groups}).
25904 Caching is possible in virtual groups.
25907 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
25908 news batches, ClariNet briefs collections, and just about everything
25909 else (@pxref{Document Groups}).
25912 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
25916 The Gnus cache is much faster.
25919 Groups can be sorted according to many criteria (@pxref{Sorting
25923 New group parameters have been introduced to set list-addresses and
25924 expiry times (@pxref{Group Parameters}).
25927 All formatting specs allow specifying faces to be used
25928 (@pxref{Formatting Fonts}).
25931 There are several more commands for setting/removing/acting on process
25932 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
25935 The summary buffer can be limited to show parts of the available
25936 articles based on a wide range of criteria. These commands have been
25937 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
25940 Articles can be made persistent with the @kbd{*} command
25941 (@pxref{Persistent Articles}).
25944 All functions for hiding article elements are now toggles.
25947 Article headers can be buttonized (@pxref{Article Washing}).
25950 All mail back ends support fetching articles by @code{Message-ID}.
25953 Duplicate mail can now be treated properly (@pxref{Duplicates}).
25956 All summary mode commands are available directly from the article
25957 buffer (@pxref{Article Keymap}).
25960 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
25964 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
25967 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
25972 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
25975 (setq gnus-use-nocem t)
25979 Groups can be made permanently visible (@pxref{Listing Groups}).
25982 (setq gnus-permanently-visible-groups "^nnml:")
25986 Many new hooks have been introduced to make customizing easier.
25989 Gnus respects the @code{Mail-Copies-To} header.
25992 Threads can be gathered by looking at the @code{References} header
25993 (@pxref{Customizing Threading}).
25996 (setq gnus-summary-thread-gathering-function
25997 'gnus-gather-threads-by-references)
26001 Read articles can be stored in a special backlog buffer to avoid
26002 refetching (@pxref{Article Backlog}).
26005 (setq gnus-keep-backlog 50)
26009 A clean copy of the current article is always stored in a separate
26010 buffer to allow easier treatment.
26013 Gnus can suggest where to save articles (@pxref{Saving Articles}).
26016 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
26020 (setq gnus-prompt-before-saving t)
26024 @code{gnus-uu} can view decoded files asynchronously while fetching
26025 articles (@pxref{Other Decode Variables}).
26028 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
26032 Filling in the article buffer now works properly on cited text
26033 (@pxref{Article Washing}).
26036 Hiding cited text adds buttons to toggle hiding, and how much
26037 cited text to hide is now customizable (@pxref{Article Hiding}).
26040 (setq gnus-cited-lines-visible 2)
26044 Boring headers can be hidden (@pxref{Article Hiding}).
26047 Default scoring values can now be set from the menu bar.
26050 Further syntax checking of outgoing articles have been added.
26056 @subsubsection Red Gnus
26058 New features in Gnus 5.4/5.5:
26062 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
26069 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
26072 Article prefetching functionality has been moved up into
26073 Gnus (@pxref{Asynchronous Fetching}).
26076 Scoring can now be performed with logical operators like @code{and},
26077 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
26081 Article washing status can be displayed in the
26082 article mode line (@pxref{Misc Article}).
26085 @file{gnus.el} has been split into many smaller files.
26088 Suppression of duplicate articles based on Message-ID can be done
26089 (@pxref{Duplicate Suppression}).
26092 (setq gnus-suppress-duplicates t)
26096 New variables for specifying what score and adapt files are to be
26097 considered home score and adapt files (@pxref{Home Score File}) have
26101 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
26102 Server Internals}).
26105 Groups can inherit group parameters from parent topics (@pxref{Topic
26109 Article editing has been revamped and is now actually usable.
26112 Signatures can be recognized in more intelligent fashions
26113 (@pxref{Article Signature}).
26116 Summary pick mode has been made to look more @code{nn}-like. Line
26117 numbers are displayed and the @kbd{.} command can be used to pick
26118 articles (@code{Pick and Read}).
26121 Commands for moving the @file{.newsrc.eld} from one server to
26122 another have been added (@pxref{Changing Servers}).
26125 There's a way now to specify that ``uninteresting'' fields be suppressed
26126 when generating lines in buffers (@pxref{Advanced Formatting}).
26129 Several commands in the group buffer can be undone with @kbd{C-M-_}
26133 Scoring can be done on words using the new score type @code{w}
26134 (@pxref{Score File Format}).
26137 Adaptive scoring can be done on a Subject word-by-word basis
26138 (@pxref{Adaptive Scoring}).
26141 (setq gnus-use-adaptive-scoring '(word))
26145 Scores can be decayed (@pxref{Score Decays}).
26148 (setq gnus-decay-scores t)
26152 Scoring can be performed using a regexp on the Date header. The Date is
26153 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
26156 A new command has been added to remove all data on articles from
26157 the native server (@pxref{Changing Servers}).
26160 A new command for reading collections of documents
26161 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
26162 (@pxref{Really Various Summary Commands}).
26165 Process mark sets can be pushed and popped (@pxref{Setting Process
26169 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
26170 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
26173 A new back end for reading searches from Web search engines
26174 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
26175 (@pxref{Web Searches}).
26178 Groups inside topics can now be sorted using the standard sorting
26179 functions, and each topic can be sorted independently (@pxref{Topic
26183 Subsets of the groups can be sorted independently (@code{Sorting
26187 Cached articles can be pulled into the groups (@pxref{Summary Generation
26191 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
26196 Score files are now applied in a more reliable order (@pxref{Score
26200 Reports on where mail messages end up can be generated (@pxref{Splitting
26204 More hooks and functions have been added to remove junk from incoming
26205 mail before saving the mail (@pxref{Washing Mail}).
26208 Emphasized text can be properly fontisized:
26214 @subsubsection Quassia Gnus
26216 New features in Gnus 5.6:
26221 New functionality for using Gnus as an offline newsreader has been
26222 added. A plethora of new commands and modes have been added.
26223 @xref{Gnus Unplugged}, for the full story.
26226 The @code{nndraft} back end has returned, but works differently than
26227 before. All Message buffers are now also articles in the @code{nndraft}
26228 group, which is created automatically.
26231 @code{gnus-alter-header-function} can now be used to alter header
26235 @code{gnus-summary-goto-article} now accept Message-ID's.
26238 A new Message command for deleting text in the body of a message
26239 outside the region: @kbd{C-c C-v}.
26242 You can now post to component group in @code{nnvirtual} groups with
26246 @code{nntp-rlogin-program}---new variable to ease customization.
26249 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
26250 re-highlighting of the article buffer.
26253 New element in @code{gnus-boring-article-headers}---@code{long-to}.
26256 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
26260 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
26261 @kbd{a} to add the score rule to the @file{all.SCORE} file.
26264 @code{gnus-simplify-subject-functions} variable to allow greater
26265 control over simplification.
26268 @kbd{A T}---new command for fetching the current thread.
26271 @kbd{/ T}---new command for including the current thread in the
26275 @kbd{M-RET} is a new Message command for breaking cited text.
26278 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
26281 The @code{custom-face-lookup} function has been removed.
26282 If you used this function in your initialization files, you must
26283 rewrite them to use @code{face-spec-set} instead.
26286 Canceling now uses the current select method. Symbolic prefix
26287 @kbd{a} forces normal posting method.
26290 New command to translate M******** sm*rtq**t*s into proper
26294 For easier debugging of @code{nntp}, you can set
26295 @code{nntp-record-commands} to a non-@code{nil} value.
26298 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
26299 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
26302 A command for editing group parameters from the summary buffer
26306 A history of where mails have been split is available.
26309 A new article date command has been added---@code{article-date-iso8601}.
26312 Subjects can be simplified when threading by setting
26313 @code{gnus-score-thread-simplify}.
26316 A new function for citing in Message has been
26317 added---@code{message-cite-original-without-signature}.
26320 @code{article-strip-all-blank-lines}---new article command.
26323 A new Message command to kill to the end of the article has
26327 A minimum adaptive score can be specified by using the
26328 @code{gnus-adaptive-word-minimum} variable.
26331 The ``lapsed date'' article header can be kept continually
26332 updated by the @code{gnus-start-date-timer} command.
26335 Web listserv archives can be read with the @code{nnlistserv} back end.
26338 Old dejanews archives can now be read by @code{nnweb}.
26342 @node Pterodactyl Gnus
26343 @subsubsection Pterodactyl Gnus
26345 New features in Gnus 5.8:
26350 The mail-fetching functions have changed. See the manual for the
26351 many details. In particular, all procmail fetching variables are gone.
26353 If you used procmail like in
26356 (setq nnmail-use-procmail t)
26357 (setq nnmail-spool-file 'procmail)
26358 (setq nnmail-procmail-directory "~/mail/incoming/")
26359 (setq nnmail-procmail-suffix "\\.in")
26362 this now has changed to
26366 '((directory :path "~/mail/incoming/"
26370 @xref{Mail Source Specifiers}.
26373 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
26374 Gnus, and adds a slew of new commands. See the manual for details.
26377 Gnus has also been multilingualized. This also affects too
26378 many parts of Gnus to summarize here, and adds many new variables.
26381 @code{gnus-auto-select-first} can now be a function to be
26382 called to position point.
26385 The user can now decide which extra headers should be included in
26386 summary buffers and @acronym{NOV} files.
26389 @code{gnus-article-display-hook} has been removed. Instead, a number
26390 of variables starting with @code{gnus-treat-} have been added.
26393 The Gnus posting styles have been redone again and now works in a
26394 subtly different manner.
26397 New web-based back ends have been added: @code{nnslashdot},
26398 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
26399 again, to keep up with ever-changing layouts.
26402 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
26407 @subsubsection Oort Gnus
26410 New features in Gnus 5.10:
26415 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
26416 (@code{gnus-article-reply-with-original}) only yank the text in the
26417 region if the region is active.
26420 @code{gnus-group-read-ephemeral-group} can be called interactively,
26424 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
26425 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
26428 The revised Gnus @acronym{FAQ} is included in the manual,
26429 @xref{Frequently Asked Questions}.
26432 Upgrading from previous (stable) version if you have used Oort.
26434 If you have tried Oort (the unstable Gnus branch leading to this
26435 release) but went back to a stable version, be careful when upgrading to
26436 this version. In particular, you will probably want to remove all
26437 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
26438 read from your @file{.newsrc.eld} instead of from the
26439 @file{.marks}/@file{.mrk} file where this release store flags. See a
26440 later entry for more information about marks. Note that downgrading
26441 isn't save in general.
26446 More buttons for URLs, mail addresses, Message-IDs, Info links, man
26447 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
26448 variables @code{gnus-button-@var{*}-level} can be used to control the
26449 appearance of all article buttons. @xref{Article Button Levels}.
26454 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
26455 bindings in dired buffers to send a file as an attachment, open a file
26456 using the appropriate mailcap entry, and print a file using the mailcap
26460 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
26463 Single-part yenc encoded attachments can be decoded.
26468 The picons code has been reimplemented to work in GNU Emacs---some of
26469 the previous options have been removed or renamed.
26471 Picons are small ``personal icons'' representing users, domain and
26472 newsgroups, which can be displayed in the Article buffer.
26476 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
26477 boundary line is drawn at the end of the headers.
26480 Retrieval of charters and control messages
26482 There are new commands for fetching newsgroup charters (@kbd{H c}) and
26483 control messages (@kbd{H C}).
26488 You can delay the sending of a message with @kbd{C-c C-j} in the Message
26489 buffer. The messages are delivered at specified time. This is useful
26490 for sending yourself reminders. @xref{Delayed Articles}.
26493 If @code{auto-compression-mode} is enabled, attachments are automatically
26494 decompressed when activated.
26497 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
26498 the nnml back end allows compressed message files.
26501 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
26504 The Summary Buffer uses an arrow in the fringe to indicate the current
26505 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
26508 Warn about email replies to news
26510 Do you often find yourself replying to news by email by mistake? Then
26511 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
26515 If the new option @code{gnus-summary-display-while-building} is
26516 non-@code{nil}, the summary buffer is shown and updated as it's being
26520 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
26521 opposed to old but unread messages).
26524 The new option @code{gnus-gcc-mark-as-read} automatically marks
26525 Gcc articles as read.
26528 The nndoc back end now supports mailman digests and exim bounces.
26531 Gnus supports RFC 2369 mailing list headers, and adds a number of
26532 related commands in mailing list groups. @xref{Mailing List}.
26535 The Date header can be displayed in a format that can be read aloud
26536 in English. @xref{Article Date}.
26539 The envelope sender address can be customized when using Sendmail.
26540 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
26543 diffs are automatically highlighted in groups matching
26544 @code{mm-uu-diff-groups-regexp}
26547 @acronym{TLS} wrapper shipped with Gnus
26549 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
26550 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
26551 @acronym{TLS}/@acronym{SSL} support via (external third party)
26552 @file{ssl.el} and OpenSSL still works.
26555 New @file{make.bat} for compiling and installing Gnus under MS Windows
26557 Use @file{make.bat} if you want to install Gnus under MS Windows, the
26558 first argument to the batch-program should be the directory where
26559 @file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want
26560 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
26561 the second parameter.
26563 @file{make.bat} has been rewritten from scratch, it now features
26564 automatic recognition of XEmacs and GNU Emacs, generates
26565 @file{gnus-load.el}, checks if errors occur while compilation and
26566 generation of info files and reports them at the end of the build
26567 process. It now uses @code{makeinfo} if it is available and falls
26568 back to @file{infohack.el} otherwise. @file{make.bat} should now
26569 install all files which are necessary to run Gnus and be generally a
26570 complete replacement for the @code{configure; make; make install}
26571 cycle used under Unix systems.
26573 The new @file{make.bat} makes @file{make-x.bat} superfluous, so it has
26577 Support for non-@acronym{ASCII} domain names
26579 Message supports non-@acronym{ASCII} domain names in From:, To: and
26580 Cc: and will query you whether to perform encoding when you try to
26581 send a message. The variable @code{message-use-idna} controls this.
26582 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
26583 and Cc: when you view a message. The variable @code{gnus-use-idna}
26587 Better handling of Microsoft citation styles
26589 Gnus now tries to recognize the mangled header block that some Microsoft
26590 mailers use to indicate that the rest of the message is a citation, even
26591 though it is not quoted in any way. The variable
26592 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
26596 @code{gnus-article-skip-boring}
26598 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
26599 not scroll down to show you a page that contains only boring text,
26600 which by default means cited text and signature. You can customize
26601 what is skippable using @code{gnus-article-boring-faces}.
26603 This feature is especially useful if you read many articles that
26604 consist of a little new content at the top with a long, untrimmed
26605 message cited below.
26608 The format spec @code{%C} for positioning point has changed to @code{%*}.
26611 The new variable @code{gnus-parameters} can be used to set group parameters.
26613 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
26614 the parameters in @file{~/.newsrc.eld}, but via this variable you can
26615 enjoy the powers of customize, and simplified backups since you set the
26616 variable in @file{~/.emacs} instead of @file{~/.newsrc.eld}. The
26617 variable maps regular expressions matching group names to group
26620 (setq gnus-parameters
26622 (gnus-show-threads nil)
26623 (gnus-use-scoring nil))
26624 ("^nnimap:\\(foo.bar\\)$"
26625 (to-group . "\\1"))))
26629 Smileys (@samp{:-)}, @samp{;-)} etc) are now iconized for Emacs too.
26631 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.emacs} to
26635 Gnus no longer generate the Sender: header automatically.
26637 Earlier it was generated iff the user configurable email address was
26638 different from the Gnus guessed default user address. As the guessing
26639 algorithm is rarely correct these days, and (more controversially) the
26640 only use of the Sender: header was to check if you are entitled to
26641 cancel/supersede news (which is now solved by Cancel Locks instead,
26642 see another entry), generation of the header has been disabled by
26643 default. See the variables @code{message-required-headers},
26644 @code{message-required-news-headers}, and
26645 @code{message-required-mail-headers}.
26648 Features from third party @file{message-utils.el} added to @file{message.el}.
26650 Message now asks if you wish to remove @samp{(was: <old subject>)} from
26651 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
26652 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
26653 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
26654 appropriate headers and a note in the body for cross-postings and
26655 followups (see the variables @code{message-cross-post-@var{*}}).
26658 References and X-Draft-Headers are no longer generated when you start
26659 composing messages and @code{message-generate-headers-first} is
26663 Improved anti-spam features.
26665 Gnus is now able to take out spam from your mail and news streams
26666 using a wide variety of programs and filter rules. Among the supported
26667 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
26668 for easy use of external packages such as SpamAssassin and Hashcash
26669 are also new. @xref{Thwarting Email Spam}.
26672 Easy inclusion of X-Faces headers.
26675 Face headers handling.
26678 In the summary buffer, the new command @kbd{/ N} inserts new messages
26679 and @kbd{/ o} inserts old messages.
26682 Gnus decodes morse encoded messages if you press @kbd{W m}.
26685 Unread count correct in nnimap groups.
26687 The estimated number of unread articles in the group buffer should now
26688 be correct for nnimap groups. This is achieved by calling
26689 @code{nnimap-fixup-unread-after-getting-new-news} from the
26690 @code{gnus-setup-news-hook} (called on startup) and
26691 @code{gnus-after-getting-new-news-hook}. (called after getting new
26692 mail). If you have modified those variables from the default, you may
26693 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
26694 you were happy with the estimate and want to save some (minimal) time
26695 when getting new mail, remove the function.
26698 Group Carbon Copy (GCC) quoting
26700 To support groups that contains SPC and other weird characters, groups
26701 are quoted before they are placed in the Gcc: header. This means
26702 variables such as @code{gnus-message-archive-group} should no longer
26703 contain quote characters to make groups containing SPC work. Also, if
26704 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
26705 into two groups) you must change it to return the list
26706 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
26707 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
26708 was incorrect earlier, it just didn't generate any problems since it
26709 was inserted directly.
26712 @file{~/News/overview/} not used.
26714 As a result of the following change, the @file{~/News/overview/}
26715 directory is not used any more. You can safely delete the entire
26721 The Gnus Agent has seen a major updated and is now enabled by default,
26722 and all nntp and nnimap servers from @code{gnus-select-method} and
26723 @code{gnus-secondary-select-method} are agentized by default. Earlier
26724 only the server in @code{gnus-select-method} was agentized by the
26725 default, and the agent was disabled by default. When the agent is
26726 enabled, headers are now also retrieved from the Agent cache instead
26727 of the back ends when possible. Earlier this only happened in the
26728 unplugged state. You can enroll or remove servers with @kbd{J a} and
26729 @kbd{J r} in the server buffer. Gnus will not download articles into
26730 the Agent cache, unless you instruct it to do so, though, by using
26731 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
26732 behavior of having the Agent disabled with @code{(setq gnus-agent
26733 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
26734 is not needed any more.
26737 @code{gnus-summary-line-format}
26739 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
26740 %s\n}. Moreover @code{gnus-extra-headers},
26741 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
26742 changed their default so that the users name will be replaced by the
26743 recipient's name or the group name posting to for @acronym{NNTP}
26747 @file{deuglify.el} (@code{gnus-article-outlook-deuglify-article})
26749 A new file from Raymond Scholz @email{rscholz@@zonix.de} for deuglifying
26750 broken Outlook (Express) articles.
26753 @code{(require 'gnus-load)}
26755 If you use a stand-alone Gnus distribution, you'd better add
26756 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
26757 lisp directory into load-path.
26759 File @file{gnus-load.el} contains autoload commands, functions and variables,
26760 some of which may not be included in distributions of Emacsen.
26763 @code{gnus-slave-unplugged}
26765 A new command which starts Gnus offline in slave mode.
26768 @code{message-insinuate-rmail}
26770 Adding @code{(message-insinuate-rmail)} and @code{(setq
26771 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
26772 compose, reply and forward messages in message-mode, where you can
26773 enjoy the power of @acronym{MML}.
26776 @code{message-minibuffer-local-map}
26778 The line below enables BBDB in resending a message:
26780 (define-key message-minibuffer-local-map [(tab)]
26781 'bbdb-complete-name)
26785 Externalizing and deleting of attachments.
26787 If @code{gnus-gcc-externalize-attachments} or
26788 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
26789 local files as external parts.
26791 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
26792 on @acronym{MIME} buttons) saves a part and replaces the part with an
26793 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
26794 @acronym{MIME} buttons) removes a part. It works only on back ends
26795 that support editing.
26798 @code{gnus-default-charset}
26800 The default value is determined from the
26801 @code{current-language-environment} variable, instead of
26802 @code{iso-8859-1}. Also the @samp{.*} item in
26803 @code{gnus-group-charset-alist} is removed.
26806 @code{gnus-posting-styles}
26808 Add a new format of match like
26810 ((header "to" "larsi.*org")
26811 (Organization "Somewhere, Inc."))
26813 The old format like the lines below is obsolete, but still accepted.
26815 (header "to" "larsi.*org"
26816 (Organization "Somewhere, Inc."))
26820 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
26822 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
26823 added into these two variables. If you customized those, perhaps you
26824 need add those two headers too.
26827 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
26829 If one reads an article while plugged, and the article already exists
26830 in the Agent, it won't get downloaded once more. @code{(setq
26831 gnus-agent-cache nil)} reverts to the old behavior.
26834 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
26835 composing messages, it is enabled by @code{use-hard-newlines}.
26836 Decoding format=flowed was present but not documented in earlier
26840 Gnus supports the generation of RFC 2298 Disposition Notification requests.
26842 This is invoked with the @kbd{C-c M-n} key binding from message mode.
26845 Gnus supports Maildir groups.
26847 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
26850 Printing capabilities are enhanced.
26852 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
26853 Article buffers. Also, each individual @acronym{MIME} part can be
26854 printed using @kbd{p} on the @acronym{MIME} button.
26857 Message supports the Importance: (RFC 2156) header.
26859 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
26863 Gnus supports Cancel Locks in News.
26865 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
26866 used to determine if you wrote an article or not (for canceling and
26867 superseding). Gnus generates a random password string the first time
26868 you post a message, and saves it in your @file{~/.emacs} using the Custom
26869 system. While the variable is called @code{canlock-password}, it is not
26870 security sensitive data. Publishing your canlock string on the web
26871 will not allow anyone to be able to anything she could not already do.
26872 The behavior can be changed by customizing @code{message-insert-canlock}.
26875 Gnus supports server-side mail filtering using Sieve.
26877 Sieve rules can be added as Group Parameters for groups, and the
26878 complete Sieve script is generated using @kbd{D g} from the Group
26879 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
26880 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
26881 manual @ref{Top, , Top, sieve, Emacs Sieve}.
26884 Extended format specs.
26886 Format spec @samp{%&user-date;} is added into
26887 @code{gnus-summary-line-format-alist}. Also, user defined extended
26888 format specs are supported. The extended format specs look like
26889 @samp{%u&foo;}, which invokes function
26890 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
26891 escape character, old user defined format @samp{%u&} is no longer supported.
26894 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
26896 It was aliased to @kbd{Y c}
26897 (@code{gnus-summary-insert-cached-articles}). The new function filters
26898 out other articles.
26900 @item Some limiting commands accept a @kbd{C-u} prefix to negate the match.
26902 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
26903 s}, @kbd{/ a}, and @kbd{/ x}
26904 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
26905 result will be to display all articles that do not match the expression.
26908 Group names are treated as UTF-8 by default.
26910 This is supposedly what USEFOR wanted to migrate to. See
26911 @code{gnus-group-name-charset-group-alist} and
26912 @code{gnus-group-name-charset-method-alist} for customization.
26915 The nnml and nnfolder back ends store marks for each groups.
26917 This makes it possible to take backup of nnml/nnfolder servers/groups
26918 separately of @file{~/.newsrc.eld}, while preserving marks. It also
26919 makes it possible to share articles and marks between users (without
26920 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
26921 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
26922 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
26923 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
26924 another machine, Gnus will automatically use the @file{.marks} or
26925 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
26926 The new server variables @code{nnml-marks-is-evil} and
26927 @code{nnfolder-marks-is-evil} can be used to disable this feature.
26930 The menu bar item (in Group and Summary buffer) named ``Misc'' has
26931 been renamed to ``Gnus''.
26934 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
26935 renamed to ``Attachments''. Note that this menu also contains security
26936 related stuff, like signing and encryption (@pxref{Security, Security,,
26937 message, Message Manual}).
26940 @code{gnus-group-charset-alist} and
26941 @code{gnus-group-ignored-charsets-alist}.
26943 The regexps in these variables are compared with full group names
26944 instead of real group names in 5.8. Users who customize these
26945 variables should change those regexps accordingly. For example:
26947 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
26951 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
26952 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
26954 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
26955 additional Lisp libraries. This add several menu items to the
26956 Attachments menu, and @kbd{C-c RET} key bindings, when composing
26957 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
26960 Gnus inlines external parts (message/external).
26963 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
26966 This change was made to avoid conflict with the standard binding of
26967 @code{back-to-indentation}, which is also useful in message mode.
26970 The default for @code{message-forward-show-mml} changed to symbol @code{best}.
26972 The behavior for the @code{best} value is to show @acronym{MML} (i.e.,
26973 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
26974 used when forwarding signed or encrypted messages, as the conversion
26975 invalidate the digital signature.
26979 @subsubsection No Gnus
26982 New features in No Gnus:
26983 @c FIXME: Gnus 5.12?
26985 @include gnus-news.texi
26991 @section The Manual
26995 This manual was generated from a TeXinfo file and then run through
26996 either @code{texi2dvi}
26998 or my own home-brewed TeXinfo to \LaTeX\ transformer,
26999 and then run through @code{latex} and @code{dvips}
27001 to get what you hold in your hands now.
27003 The following conventions have been used:
27008 This is a @samp{string}
27011 This is a @kbd{keystroke}
27014 This is a @file{file}
27017 This is a @code{symbol}
27021 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
27025 (setq flargnoze "yes")
27028 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
27031 (setq flumphel 'yes)
27034 @samp{yes} and @code{yes} are two @emph{very} different things---don't
27035 ever get them confused.
27039 Of course, everything in this manual is of vital interest, so you should
27040 read it all. Several times. However, if you feel like skimming the
27041 manual, look for that gnu head you should see in the margin over
27042 there---it means that what's being discussed is of more importance than
27043 the rest of the stuff. (On the other hand, if everything is infinitely
27044 important, how can anything be more important than that? Just one more
27045 of the mysteries of this world, I guess.)
27051 @node On Writing Manuals
27052 @section On Writing Manuals
27054 I guess most manuals are written after-the-fact; documenting a program
27055 that's already there. This is not how this manual is written. When
27056 implementing something, I write the manual entry for that something
27057 straight away. I then see that it's difficult to explain the
27058 functionality, so I write how it's supposed to be, and then I change the
27059 implementation. Writing the documentation and writing the code goes
27062 This, of course, means that this manual has no, or little, flow. It
27063 documents absolutely everything in Gnus, but often not where you're
27064 looking for it. It is a reference manual, and not a guide to how to get
27067 That would be a totally different book, that should be written using the
27068 reference manual as source material. It would look quite differently.
27073 @section Terminology
27075 @cindex terminology
27080 This is what you are supposed to use this thing for---reading news.
27081 News is generally fetched from a nearby @acronym{NNTP} server, and is
27082 generally publicly available to everybody. If you post news, the entire
27083 world is likely to read just what you have written, and they'll all
27084 snigger mischievously. Behind your back.
27088 Everything that's delivered to you personally is mail. Some news/mail
27089 readers (like Gnus) blur the distinction between mail and news, but
27090 there is a difference. Mail is private. News is public. Mailing is
27091 not posting, and replying is not following up.
27095 Send a mail to the person who has written what you are reading.
27099 Post an article to the current newsgroup responding to the article you
27104 Gnus considers mail and news to be mostly the same, really. The only
27105 difference is how to access the actual articles. News articles are
27106 commonly fetched via the protocol @acronym{NNTP}, whereas mail
27107 messages could be read from a file on the local disk. The internal
27108 architecture of Gnus thus comprises a ``front end'' and a number of
27109 ``back ends''. Internally, when you enter a group (by hitting
27110 @key{RET}, say), you thereby invoke a function in the front end in
27111 Gnus. The front end then ``talks'' to a back end and says things like
27112 ``Give me the list of articles in the foo group'' or ``Show me article
27115 So a back end mainly defines either a protocol (the @code{nntp} back
27116 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
27117 accesses mail via @acronym{IMAP}) or a file format and directory
27118 layout (the @code{nnspool} back end accesses news via the common
27119 ``spool directory'' format, the @code{nnml} back end access mail via a
27120 file format and directory layout that's quite similar).
27122 Gnus does not handle the underlying media, so to speak---this is all
27123 done by the back ends. A back end is a collection of functions to
27124 access the articles.
27126 However, sometimes the term ``back end'' is also used where ``server''
27127 would have been more appropriate. And then there is the term ``select
27128 method'' which can mean either. The Gnus terminology can be quite
27133 Gnus will always use one method (and back end) as the @dfn{native}, or
27134 default, way of getting news.
27138 You can also have any number of foreign groups active at the same time.
27139 These are groups that use non-native non-secondary back ends for getting
27144 Secondary back ends are somewhere half-way between being native and being
27145 foreign, but they mostly act like they are native.
27149 A message that has been posted as news.
27152 @cindex mail message
27153 A message that has been mailed.
27157 A mail message or news article
27161 The top part of a message, where administrative information (etc.) is
27166 The rest of an article. Everything not in the head is in the
27171 A line from the head of an article.
27175 A collection of such lines, or a collection of heads. Or even a
27176 collection of @acronym{NOV} lines.
27178 @item @acronym{NOV}
27179 @cindex @acronym{NOV}
27180 When Gnus enters a group, it asks the back end for the headers of all
27181 unread articles in the group. Most servers support the News OverView
27182 format, which is more compact and much faster to read and parse than the
27183 normal @sc{head} format.
27187 Each group is subscribed at some @dfn{level} or other (1-9). The ones
27188 that have a lower level are ``more'' subscribed than the groups with a
27189 higher level. In fact, groups on levels 1-5 are considered
27190 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
27191 are @dfn{killed}. Commands for listing groups and scanning for new
27192 articles will all use the numeric prefix as @dfn{working level}.
27194 @item killed groups
27195 @cindex killed groups
27196 No information on killed groups is stored or updated, which makes killed
27197 groups much easier to handle than subscribed groups.
27199 @item zombie groups
27200 @cindex zombie groups
27201 Just like killed groups, only slightly less dead.
27204 @cindex active file
27205 The news server has to keep track of what articles it carries, and what
27206 groups exist. All this information in stored in the active file, which
27207 is rather large, as you might surmise.
27210 @cindex bogus groups
27211 A group that exists in the @file{.newsrc} file, but isn't known to the
27212 server (i.e., it isn't in the active file), is a @emph{bogus group}.
27213 This means that the group probably doesn't exist (any more).
27216 @cindex activating groups
27217 The act of asking the server for info on a group and computing the
27218 number of unread articles is called @dfn{activating the group}.
27219 Un-activated groups are listed with @samp{*} in the group buffer.
27223 News servers store their articles locally in one fashion or other.
27224 One old-fashioned storage method is to have just one file per
27225 article. That's called a ``traditional spool''.
27229 A machine one can connect to and get news (or mail) from.
27231 @item select method
27232 @cindex select method
27233 A structure that specifies the back end, the server and the virtual
27236 @item virtual server
27237 @cindex virtual server
27238 A named select method. Since a select method defines all there is to
27239 know about connecting to a (physical) server, taking the thing as a
27240 whole is a virtual server.
27244 Taking a buffer and running it through a filter of some sort. The
27245 result will (more often than not) be cleaner and more pleasing than the
27248 @item ephemeral groups
27249 @cindex ephemeral groups
27250 @cindex temporary groups
27251 Most groups store data on what articles you have read. @dfn{Ephemeral}
27252 groups are groups that will have no data stored---when you exit the
27253 group, it'll disappear into the aether.
27256 @cindex solid groups
27257 This is the opposite of ephemeral groups. All groups listed in the
27258 group buffer are solid groups.
27260 @item sparse articles
27261 @cindex sparse articles
27262 These are article placeholders shown in the summary buffer when
27263 @code{gnus-build-sparse-threads} has been switched on.
27267 To put responses to articles directly after the articles they respond
27268 to---in a hierarchical fashion.
27272 @cindex thread root
27273 The first article in a thread is the root. It is the ancestor of all
27274 articles in the thread.
27278 An article that has responses.
27282 An article that responds to a different article---its parent.
27286 A collection of messages in one file. The most common digest format is
27287 specified by RFC 1153.
27290 @cindex splitting, terminolgy
27291 @cindex mail sorting
27292 @cindex mail filtering (splitting)
27293 The action of sorting your emails according to certain rules. Sometimes
27294 incorrectly called mail filtering.
27300 @node Customization
27301 @section Customization
27302 @cindex general customization
27304 All variables are properly documented elsewhere in this manual. This
27305 section is designed to give general pointers on how to customize Gnus
27306 for some quite common situations.
27309 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
27310 * Slow Terminal Connection:: You run a remote Emacs.
27311 * Little Disk Space:: You feel that having large setup files is icky.
27312 * Slow Machine:: You feel like buying a faster machine.
27316 @node Slow/Expensive Connection
27317 @subsection Slow/Expensive NNTP Connection
27319 If you run Emacs on a machine locally, and get your news from a machine
27320 over some very thin strings, you want to cut down on the amount of data
27321 Gnus has to get from the @acronym{NNTP} server.
27325 @item gnus-read-active-file
27326 Set this to @code{nil}, which will inhibit Gnus from requesting the
27327 entire active file from the server. This file is often very large. You
27328 also have to set @code{gnus-check-new-newsgroups} and
27329 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
27330 doesn't suddenly decide to fetch the active file anyway.
27332 @item gnus-nov-is-evil
27333 This one has to be @code{nil}. If not, grabbing article headers from
27334 the @acronym{NNTP} server will not be very fast. Not all @acronym{NNTP} servers
27335 support @sc{xover}; Gnus will detect this by itself.
27339 @node Slow Terminal Connection
27340 @subsection Slow Terminal Connection
27342 Let's say you use your home computer for dialing up the system that runs
27343 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
27344 possible) the amount of data sent over the wires.
27348 @item gnus-auto-center-summary
27349 Set this to @code{nil} to inhibit Gnus from re-centering the summary
27350 buffer all the time. If it is @code{vertical}, do only vertical
27351 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
27352 horizontal and vertical recentering.
27354 @item gnus-visible-headers
27355 Cut down on the headers included in the articles to the
27356 minimum. You can, in fact, make do without them altogether---most of the
27357 useful data is in the summary buffer, anyway. Set this variable to
27358 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
27360 Set this hook to all the available hiding commands:
27362 (setq gnus-treat-hide-headers 'head
27363 gnus-treat-hide-signature t
27364 gnus-treat-hide-citation t)
27367 @item gnus-use-full-window
27368 By setting this to @code{nil}, you can make all the windows smaller.
27369 While this doesn't really cut down much generally, it means that you
27370 have to see smaller portions of articles before deciding that you didn't
27371 want to read them anyway.
27373 @item gnus-thread-hide-subtree
27374 If this is non-@code{nil}, all threads in the summary buffer will be
27378 @item gnus-updated-mode-lines
27379 If this is @code{nil}, Gnus will not put information in the buffer mode
27380 lines, which might save some time.
27384 @node Little Disk Space
27385 @subsection Little Disk Space
27388 The startup files can get rather large, so you may want to cut their
27389 sizes a bit if you are running out of space.
27393 @item gnus-save-newsrc-file
27394 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
27395 only save @file{.newsrc.eld}. This means that you will not be able to
27396 use any other newsreaders than Gnus. This variable is @code{t} by
27399 @item gnus-read-newsrc-file
27400 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
27401 only read @file{.newsrc.eld}. This means that you will not be able to
27402 use any other newsreaders than Gnus. This variable is @code{t} by
27405 @item gnus-save-killed-list
27406 If this is @code{nil}, Gnus will not save the list of dead groups. You
27407 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
27408 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
27409 variable to @code{nil}. This variable is @code{t} by default.
27415 @subsection Slow Machine
27416 @cindex slow machine
27418 If you have a slow machine, or are just really impatient, there are a
27419 few things you can do to make Gnus run faster.
27421 Set @code{gnus-check-new-newsgroups} and
27422 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
27424 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
27425 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
27426 summary buffer faster.
27430 @node Troubleshooting
27431 @section Troubleshooting
27432 @cindex troubleshooting
27434 Gnus works @emph{so} well straight out of the box---I can't imagine any
27442 Make sure your computer is switched on.
27445 Make sure that you really load the current Gnus version. If you have
27446 been running @sc{gnus}, you need to exit Emacs and start it up again before
27450 Try doing an @kbd{M-x gnus-version}. If you get something that looks
27451 like @samp{T-gnus 6.17.* (based on Gnus v5.10.*; for SEMI 1.1*, FLIM
27452 1.1*)} you have the right files loaded. Otherwise you have some old
27453 @file{.el} files lying around. Delete these.
27456 Read the help group (@kbd{G h} in the group buffer) for a
27457 @acronym{FAQ} and a how-to.
27460 @vindex max-lisp-eval-depth
27461 Gnus works on many recursive structures, and in some extreme (and very
27462 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
27463 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
27464 something like that.
27467 If all else fails, report the problem as a bug.
27470 @cindex reporting bugs
27472 @kindex M-x gnus-bug
27474 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
27475 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
27476 me the backtrace. I will fix bugs, but I can only fix them if you send
27477 me a precise description as to how to reproduce the bug.
27479 You really can never be too detailed in a bug report. Always use the
27480 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
27481 a 10Kb mail each time you use it, and even if you have sent me your
27482 environment 500 times before. I don't care. I want the full info each
27485 It is also important to remember that I have no memory whatsoever. If
27486 you send a bug report, and I send you a reply, and then you just send
27487 back ``No, it's not! Moron!'', I will have no idea what you are
27488 insulting me about. Always over-explain everything. It's much easier
27489 for all of us---if I don't have all the information I need, I will just
27490 mail you and ask for more info, and everything takes more time.
27492 If the problem you're seeing is very visual, and you can't quite explain
27493 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
27494 it somewhere it can be reached, and include the URL of the picture in
27498 If you would like to contribute a patch to fix bugs or make
27499 improvements, please produce the patch using @samp{diff -u}.
27502 If you want to debug your problem further before reporting, possibly
27503 in order to solve the problem yourself and send a patch, you can use
27504 edebug. Debugging Lisp code is documented in the Elisp manual
27505 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
27506 Lisp Reference Manual}). To get you started with edebug, consider if
27507 you discover some weird behavior when pressing @kbd{c}, the first
27508 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
27509 the documentation buffer that leads you to the function definition,
27510 then press @kbd{M-x edebug-defun RET} with point inside that function,
27511 return to Gnus and press @kbd{c} to invoke the code. You will be
27512 placed in the lisp buffer and can single step using @kbd{SPC} and
27513 evaluate expressions using @kbd{M-:} or inspect variables using
27514 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
27515 @kbd{c} or @kbd{g}.
27520 Sometimes, a problem do not directly generate an elisp error but
27521 manifests itself by causing Gnus to be very slow. In these cases, you
27522 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
27523 slow, and then try to analyze the backtrace (repeating the procedure
27524 helps isolating the real problem areas).
27526 A fancier approach is to use the elisp profiler, ELP. The profiler is
27527 (or should be) fully documented elsewhere, but to get you started
27528 there are a few steps that need to be followed. First, instrument the
27529 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
27530 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
27531 RET message}. Then perform the operation that is slow and press
27532 @kbd{M-x elp-results}. You will then see which operations that takes
27533 time, and can debug them further. If the entire operation takes much
27534 longer than the time spent in the slowest function in the profiler
27535 output, you probably profiled the wrong part of Gnus. To reset
27536 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
27537 elp-restore-all} is supposed to remove profiling, but given the
27538 complexities and dynamic code generation in Gnus, it might not always
27541 @cindex gnu.emacs.gnus
27542 @cindex ding mailing list
27543 If you just need help, you are better off asking on
27544 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
27545 @email{ding@@gnus.org, the ding mailing list}. Write to
27546 @email{ding-request@@gnus.org} to subscribe.
27550 @node Gnus Reference Guide
27551 @section Gnus Reference Guide
27553 It is my hope that other people will figure out smart stuff that Gnus
27554 can do, and that other people will write those smart things as well. To
27555 facilitate that I thought it would be a good idea to describe the inner
27556 workings of Gnus. And some of the not-so-inner workings, while I'm at
27559 You can never expect the internals of a program not to change, but I
27560 will be defining (in some details) the interface between Gnus and its
27561 back ends (this is written in stone), the format of the score files
27562 (ditto), data structures (some are less likely to change than others)
27563 and general methods of operation.
27566 * Gnus Utility Functions:: Common functions and variable to use.
27567 * Back End Interface:: How Gnus communicates with the servers.
27568 * Score File Syntax:: A BNF definition of the score file standard.
27569 * Headers:: How Gnus stores headers internally.
27570 * Ranges:: A handy format for storing mucho numbers.
27571 * Group Info:: The group info format.
27572 * Extended Interactive:: Symbolic prefixes and stuff.
27573 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
27574 * Various File Formats:: Formats of files that Gnus use.
27578 @node Gnus Utility Functions
27579 @subsection Gnus Utility Functions
27580 @cindex Gnus utility functions
27581 @cindex utility functions
27583 @cindex internal variables
27585 When writing small functions to be run from hooks (and stuff), it's
27586 vital to have access to the Gnus internal functions and variables.
27587 Below is a list of the most common ones.
27591 @item gnus-newsgroup-name
27592 @vindex gnus-newsgroup-name
27593 This variable holds the name of the current newsgroup.
27595 @item gnus-find-method-for-group
27596 @findex gnus-find-method-for-group
27597 A function that returns the select method for @var{group}.
27599 @item gnus-group-real-name
27600 @findex gnus-group-real-name
27601 Takes a full (prefixed) Gnus group name, and returns the unprefixed
27604 @item gnus-group-prefixed-name
27605 @findex gnus-group-prefixed-name
27606 Takes an unprefixed group name and a select method, and returns the full
27607 (prefixed) Gnus group name.
27609 @item gnus-get-info
27610 @findex gnus-get-info
27611 Returns the group info list for @var{group}.
27613 @item gnus-group-unread
27614 @findex gnus-group-unread
27615 The number of unread articles in @var{group}, or @code{t} if that is
27619 @findex gnus-active
27620 The active entry for @var{group}.
27622 @item gnus-set-active
27623 @findex gnus-set-active
27624 Set the active entry for @var{group}.
27626 @item gnus-add-current-to-buffer-list
27627 @findex gnus-add-current-to-buffer-list
27628 Adds the current buffer to the list of buffers to be killed on Gnus
27631 @item gnus-continuum-version
27632 @findex gnus-continuum-version
27633 Takes a Gnus version string as a parameter and returns a floating point
27634 number. Earlier versions will always get a lower number than later
27637 @item gnus-group-read-only-p
27638 @findex gnus-group-read-only-p
27639 Says whether @var{group} is read-only or not.
27641 @item gnus-news-group-p
27642 @findex gnus-news-group-p
27643 Says whether @var{group} came from a news back end.
27645 @item gnus-ephemeral-group-p
27646 @findex gnus-ephemeral-group-p
27647 Says whether @var{group} is ephemeral or not.
27649 @item gnus-server-to-method
27650 @findex gnus-server-to-method
27651 Returns the select method corresponding to @var{server}.
27653 @item gnus-server-equal
27654 @findex gnus-server-equal
27655 Says whether two virtual servers are equal.
27657 @item gnus-group-native-p
27658 @findex gnus-group-native-p
27659 Says whether @var{group} is native or not.
27661 @item gnus-group-secondary-p
27662 @findex gnus-group-secondary-p
27663 Says whether @var{group} is secondary or not.
27665 @item gnus-group-foreign-p
27666 @findex gnus-group-foreign-p
27667 Says whether @var{group} is foreign or not.
27669 @item gnus-group-find-parameter
27670 @findex gnus-group-find-parameter
27671 Returns the parameter list of @var{group}. If given a second parameter,
27672 returns the value of that parameter for @var{group}.
27674 @item gnus-group-set-parameter
27675 @findex gnus-group-set-parameter
27676 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
27678 @item gnus-narrow-to-body
27679 @findex gnus-narrow-to-body
27680 Narrows the current buffer to the body of the article.
27682 @item gnus-check-backend-function
27683 @findex gnus-check-backend-function
27684 Takes two parameters, @var{function} and @var{group}. If the back end
27685 @var{group} comes from supports @var{function}, return non-@code{nil}.
27688 (gnus-check-backend-function "request-scan" "nnml:misc")
27692 @item gnus-read-method
27693 @findex gnus-read-method
27694 Prompts the user for a select method.
27699 @node Back End Interface
27700 @subsection Back End Interface
27702 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
27703 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
27704 server is a @dfn{back end} and some @dfn{back end variables}. As examples
27705 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
27706 examples of the latter we have @code{nntp-port-number} and
27707 @code{nnmbox-directory}.
27709 When Gnus asks for information from a back end---say @code{nntp}---on
27710 something, it will normally include a virtual server name in the
27711 function parameters. (If not, the back end should use the ``current''
27712 virtual server.) For instance, @code{nntp-request-list} takes a virtual
27713 server as its only (optional) parameter. If this virtual server hasn't
27714 been opened, the function should fail.
27716 Note that a virtual server name has no relation to some physical server
27717 name. Take this example:
27721 (nntp-address "ifi.uio.no")
27722 (nntp-port-number 4324))
27725 Here the virtual server name is @samp{odd-one} while the name of
27726 the physical server is @samp{ifi.uio.no}.
27728 The back ends should be able to switch between several virtual servers.
27729 The standard back ends implement this by keeping an alist of virtual
27730 server environments that they pull down/push up when needed.
27732 There are two groups of interface functions: @dfn{required functions},
27733 which must be present, and @dfn{optional functions}, which Gnus will
27734 always check for presence before attempting to call 'em.
27736 All these functions are expected to return data in the buffer
27737 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
27738 unfortunately named, but we'll have to live with it. When I talk about
27739 @dfn{resulting data}, I always refer to the data in that buffer. When I
27740 talk about @dfn{return value}, I talk about the function value returned by
27741 the function call. Functions that fail should return @code{nil} as the
27744 Some back ends could be said to be @dfn{server-forming} back ends, and
27745 some might be said not to be. The latter are back ends that generally
27746 only operate on one group at a time, and have no concept of ``server''
27747 ---they have a group, and they deliver info on that group and nothing
27750 Gnus identifies each message by way of group name and article number. A
27751 few remarks about these article numbers might be useful. First of all,
27752 the numbers are positive integers. Secondly, it is normally not
27753 possible for later articles to ``re-use'' older article numbers without
27754 confusing Gnus. That is, if a group has ever contained a message
27755 numbered 42, then no other message may get that number, or Gnus will get
27756 mightily confused.@footnote{See the function
27757 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
27758 Third, article numbers must be assigned in order of arrival in the
27759 group; this is not necessarily the same as the date of the message.
27761 The previous paragraph already mentions all the ``hard'' restrictions that
27762 article numbers must fulfill. But it seems that it might be useful to
27763 assign @emph{consecutive} article numbers, for Gnus gets quite confused
27764 if there are holes in the article numbering sequence. However, due to
27765 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
27766 also useful for the article numbers to start at 1 to avoid running out
27767 of numbers as long as possible.
27769 Note that by convention, back ends are named @code{nnsomething}, but
27770 Gnus also comes with some @code{nnnotbackends}, such as
27771 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
27773 In the examples and definitions I will refer to the imaginary back end
27776 @cindex @code{nnchoke}
27779 * Required Back End Functions:: Functions that must be implemented.
27780 * Optional Back End Functions:: Functions that need not be implemented.
27781 * Error Messaging:: How to get messages and report errors.
27782 * Writing New Back Ends:: Extending old back ends.
27783 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
27784 * Mail-like Back Ends:: Some tips on mail back ends.
27788 @node Required Back End Functions
27789 @subsubsection Required Back End Functions
27793 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
27795 @var{articles} is either a range of article numbers or a list of
27796 @code{Message-ID}s. Current back ends do not fully support either---only
27797 sequences (lists) of article numbers, and most back ends do not support
27798 retrieval of @code{Message-ID}s. But they should try for both.
27800 The result data should either be HEADs or @acronym{NOV} lines, and the result
27801 value should either be @code{headers} or @code{nov} to reflect this.
27802 This might later be expanded to @code{various}, which will be a mixture
27803 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
27805 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
27806 headers'', in some meaning of the word. This is generally done by
27807 fetching (at most) @var{fetch-old} extra headers less than the smallest
27808 article number in @code{articles}, and filling the gaps as well. The
27809 presence of this parameter can be ignored if the back end finds it
27810 cumbersome to follow the request. If this is non-@code{nil} and not a
27811 number, do maximum fetches.
27813 Here's an example HEAD:
27816 221 1056 Article retrieved.
27817 Path: ifi.uio.no!sturles
27818 From: sturles@@ifi.uio.no (Sturle Sunde)
27819 Newsgroups: ifi.discussion
27820 Subject: Re: Something very droll
27821 Date: 27 Oct 1994 14:02:57 +0100
27822 Organization: Dept. of Informatics, University of Oslo, Norway
27824 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
27825 References: <38jdmq$4qu@@visbur.ifi.uio.no>
27826 NNTP-Posting-Host: holmenkollen.ifi.uio.no
27830 So a @code{headers} return value would imply that there's a number of
27831 these in the data buffer.
27833 Here's a BNF definition of such a buffer:
27837 head = error / valid-head
27838 error-message = [ "4" / "5" ] 2number " " <error message> eol
27839 valid-head = valid-message *header "." eol
27840 valid-message = "221 " <number> " Article retrieved." eol
27841 header = <text> eol
27845 (The version of BNF used here is the one used in RFC822.)
27847 If the return value is @code{nov}, the data buffer should contain
27848 @dfn{network overview database} lines. These are basically fields
27852 nov-buffer = *nov-line
27853 nov-line = field 7*8[ <TAB> field ] eol
27854 field = <text except TAB>
27857 For a closer look at what should be in those fields,
27861 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
27863 @var{server} is here the virtual server name. @var{definitions} is a
27864 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
27866 If the server can't be opened, no error should be signaled. The back end
27867 may then choose to refuse further attempts at connecting to this
27868 server. In fact, it should do so.
27870 If the server is opened already, this function should return a
27871 non-@code{nil} value. There should be no data returned.
27874 @item (nnchoke-close-server &optional SERVER)
27876 Close connection to @var{server} and free all resources connected
27877 to it. Return @code{nil} if the server couldn't be closed for some
27880 There should be no data returned.
27883 @item (nnchoke-request-close)
27885 Close connection to all servers and free all resources that the back end
27886 have reserved. All buffers that have been created by that back end
27887 should be killed. (Not the @code{nntp-server-buffer}, though.) This
27888 function is generally only called when Gnus is shutting down.
27890 There should be no data returned.
27893 @item (nnchoke-server-opened &optional SERVER)
27895 If @var{server} is the current virtual server, and the connection to the
27896 physical server is alive, then this function should return a
27897 non-@code{nil} value. This function should under no circumstances
27898 attempt to reconnect to a server we have lost connection to.
27900 There should be no data returned.
27903 @item (nnchoke-status-message &optional SERVER)
27905 This function should return the last error message from @var{server}.
27907 There should be no data returned.
27910 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
27912 The result data from this function should be the article specified by
27913 @var{article}. This might either be a @code{Message-ID} or a number.
27914 It is optional whether to implement retrieval by @code{Message-ID}, but
27915 it would be nice if that were possible.
27917 If @var{to-buffer} is non-@code{nil}, the result data should be returned
27918 in this buffer instead of the normal data buffer. This is to make it
27919 possible to avoid copying large amounts of data from one buffer to
27920 another, while Gnus mainly requests articles to be inserted directly
27921 into its article buffer.
27923 If it is at all possible, this function should return a cons cell where
27924 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
27925 the article number. This will enable Gnus to find out what the real
27926 group and article numbers are when fetching articles by
27927 @code{Message-ID}. If this isn't possible, @code{t} should be returned
27928 on successful article retrieval.
27931 @item (nnchoke-request-group GROUP &optional SERVER FAST)
27933 Get data on @var{group}. This function also has the side effect of
27934 making @var{group} the current group.
27936 If @var{fast}, don't bother to return useful data, just make @var{group}
27939 Here's an example of some result data and a definition of the same:
27942 211 56 1000 1059 ifi.discussion
27945 The first number is the status, which should be 211. Next is the
27946 total number of articles in the group, the lowest article number, the
27947 highest article number, and finally the group name. Note that the total
27948 number of articles may be less than one might think while just
27949 considering the highest and lowest article numbers, but some articles
27950 may have been canceled. Gnus just discards the total-number, so
27951 whether one should take the bother to generate it properly (if that is a
27952 problem) is left as an exercise to the reader. If the group contains no
27953 articles, the lowest article number should be reported as 1 and the
27957 group-status = [ error / info ] eol
27958 error = [ "4" / "5" ] 2<number> " " <Error message>
27959 info = "211 " 3* [ <number> " " ] <string>
27963 @item (nnchoke-close-group GROUP &optional SERVER)
27965 Close @var{group} and free any resources connected to it. This will be
27966 a no-op on most back ends.
27968 There should be no data returned.
27971 @item (nnchoke-request-list &optional SERVER)
27973 Return a list of all groups available on @var{server}. And that means
27976 Here's an example from a server that only carries two groups:
27979 ifi.test 0000002200 0000002000 y
27980 ifi.discussion 3324 3300 n
27983 On each line we have a group name, then the highest article number in
27984 that group, the lowest article number, and finally a flag. If the group
27985 contains no articles, the lowest article number should be reported as 1
27986 and the highest as 0.
27989 active-file = *active-line
27990 active-line = name " " <number> " " <number> " " flags eol
27992 flags = "n" / "y" / "m" / "x" / "j" / "=" name
27995 The flag says whether the group is read-only (@samp{n}), is moderated
27996 (@samp{m}), is dead (@samp{x}), is aliased to some other group
27997 (@samp{=other-group}) or none of the above (@samp{y}).
28000 @item (nnchoke-request-post &optional SERVER)
28002 This function should post the current buffer. It might return whether
28003 the posting was successful or not, but that's not required. If, for
28004 instance, the posting is done asynchronously, it has generally not been
28005 completed by the time this function concludes. In that case, this
28006 function should set up some kind of sentinel to beep the user loud and
28007 clear if the posting could not be completed.
28009 There should be no result data from this function.
28014 @node Optional Back End Functions
28015 @subsubsection Optional Back End Functions
28019 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
28021 @var{groups} is a list of groups, and this function should request data
28022 on all those groups. How it does it is of no concern to Gnus, but it
28023 should attempt to do this in a speedy fashion.
28025 The return value of this function can be either @code{active} or
28026 @code{group}, which says what the format of the result data is. The
28027 former is in the same format as the data from
28028 @code{nnchoke-request-list}, while the latter is a buffer full of lines
28029 in the same format as @code{nnchoke-request-group} gives.
28032 group-buffer = *active-line / *group-status
28036 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
28038 A Gnus group info (@pxref{Group Info}) is handed to the back end for
28039 alterations. This comes in handy if the back end really carries all
28040 the information (as is the case with virtual and imap groups). This
28041 function should destructively alter the info to suit its needs, and
28042 should return a non-@code{nil} value (exceptionally,
28043 @code{nntp-request-update-info} always returns @code{nil} not to waste
28044 the network resources).
28046 There should be no result data from this function.
28049 @item (nnchoke-request-type GROUP &optional ARTICLE)
28051 When the user issues commands for ``sending news'' (@kbd{F} in the
28052 summary buffer, for instance), Gnus has to know whether the article the
28053 user is following up on is news or mail. This function should return
28054 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
28055 is mail and @code{unknown} if the type can't be decided. (The
28056 @var{article} parameter is necessary in @code{nnvirtual} groups which
28057 might very well combine mail groups and news groups.) Both @var{group}
28058 and @var{article} may be @code{nil}.
28060 There should be no result data from this function.
28063 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
28065 Set/remove/add marks on articles. Normally Gnus handles the article
28066 marks (such as read, ticked, expired etc) internally, and store them in
28067 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
28068 all information about the articles on the server, so Gnus need to
28069 propagate the mark information to the server.
28071 @var{action} is a list of mark setting requests, having this format:
28074 (RANGE ACTION MARK)
28077 @var{range} is a range of articles you wish to update marks on.
28078 @var{action} is @code{add} or @code{del}, used to add marks or remove
28079 marks (preserving all marks not mentioned). @var{mark} is a list of
28080 marks; where each mark is a symbol. Currently used marks are
28081 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
28082 @code{dormant}, @code{save}, @code{download}, @code{unsend},
28083 @code{forward} and @code{recent}, but your back end should, if
28084 possible, not limit itself to these.
28086 Given contradictory actions, the last action in the list should be the
28087 effective one. That is, if your action contains a request to add the
28088 @code{tick} mark on article 1 and, later in the list, a request to
28089 remove the mark on the same article, the mark should in fact be removed.
28091 An example action list:
28094 (((5 12 30) 'del '(tick))
28095 ((10 . 90) 'add '(read expire))
28096 ((92 94) 'del '(read)))
28099 The function should return a range of articles it wasn't able to set the
28100 mark on (currently not used for anything).
28102 There should be no result data from this function.
28104 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
28106 If the user tries to set a mark that the back end doesn't like, this
28107 function may change the mark. Gnus will use whatever this function
28108 returns as the mark for @var{article} instead of the original
28109 @var{mark}. If the back end doesn't care, it must return the original
28110 @var{mark}, and not @code{nil} or any other type of garbage.
28112 The only use for this I can see is what @code{nnvirtual} does with
28113 it---if a component group is auto-expirable, marking an article as read
28114 in the virtual group should result in the article being marked as
28117 There should be no result data from this function.
28120 @item (nnchoke-request-scan &optional GROUP SERVER)
28122 This function may be called at any time (by Gnus or anything else) to
28123 request that the back end check for incoming articles, in one way or
28124 another. A mail back end will typically read the spool file or query
28125 the @acronym{POP} server when this function is invoked. The
28126 @var{group} doesn't have to be heeded---if the back end decides that
28127 it is too much work just scanning for a single group, it may do a
28128 total scan of all groups. It would be nice, however, to keep things
28129 local if that's practical.
28131 There should be no result data from this function.
28134 @item (nnchoke-request-group-description GROUP &optional SERVER)
28136 The result data from this function should be a description of
28140 description-line = name <TAB> description eol
28142 description = <text>
28145 @item (nnchoke-request-list-newsgroups &optional SERVER)
28147 The result data from this function should be the description of all
28148 groups available on the server.
28151 description-buffer = *description-line
28155 @item (nnchoke-request-newgroups DATE &optional SERVER)
28157 The result data from this function should be all groups that were
28158 created after @samp{date}, which is in normal human-readable date format
28159 (i.e., the date format used in mail and news headers, and returned by
28160 the function @code{message-make-date} by default). The data should be
28161 in the active buffer format.
28163 It is okay for this function to return ``too many'' groups; some back ends
28164 might find it cheaper to return the full list of groups, rather than
28165 just the new groups. But don't do this for back ends with many groups.
28166 Normally, if the user creates the groups herself, there won't be too
28167 many groups, so @code{nnml} and the like are probably safe. But for
28168 back ends like @code{nntp}, where the groups have been created by the
28169 server, it is quite likely that there can be many groups.
28172 @item (nnchoke-request-create-group GROUP &optional SERVER)
28174 This function should create an empty group with name @var{group}.
28176 There should be no return data.
28179 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
28181 This function should run the expiry process on all articles in the
28182 @var{articles} range (which is currently a simple list of article
28183 numbers.) It is left up to the back end to decide how old articles
28184 should be before they are removed by this function. If @var{force} is
28185 non-@code{nil}, all @var{articles} should be deleted, no matter how new
28188 This function should return a list of articles that it did not/was not
28191 There should be no result data returned.
28194 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
28196 This function should move @var{article} (which is a number) from
28197 @var{group} by calling @var{accept-form}.
28199 This function should ready the article in question for moving by
28200 removing any header lines it has added to the article, and generally
28201 should ``tidy up'' the article. Then it should @code{eval}
28202 @var{accept-form} in the buffer where the ``tidy'' article is. This
28203 will do the actual copying. If this @code{eval} returns a
28204 non-@code{nil} value, the article should be removed.
28206 If @var{last} is @code{nil}, that means that there is a high likelihood
28207 that there will be more requests issued shortly, so that allows some
28210 The function should return a cons where the @code{car} is the group name and
28211 the @code{cdr} is the article number that the article was entered as.
28213 The group should exist before the back end is asked to accept the
28214 article for that group.
28216 There should be no data returned.
28219 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
28221 This function takes the current buffer and inserts it into @var{group}.
28222 If @var{last} in @code{nil}, that means that there will be more calls to
28223 this function in short order.
28225 The function should return a cons where the @code{car} is the group name and
28226 the @code{cdr} is the article number that the article was entered as.
28228 There should be no data returned.
28231 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
28233 This function should remove @var{article} (which is a number) from
28234 @var{group} and insert @var{buffer} there instead.
28236 There should be no data returned.
28239 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
28241 This function should delete @var{group}. If @var{force}, it should
28242 really delete all the articles in the group, and then delete the group
28243 itself. (If there is such a thing as ``the group itself''.)
28245 There should be no data returned.
28248 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
28250 This function should rename @var{group} into @var{new-name}. All
28251 articles in @var{group} should move to @var{new-name}.
28253 There should be no data returned.
28258 @node Error Messaging
28259 @subsubsection Error Messaging
28261 @findex nnheader-report
28262 @findex nnheader-get-report
28263 The back ends should use the function @code{nnheader-report} to report
28264 error conditions---they should not raise errors when they aren't able to
28265 perform a request. The first argument to this function is the back end
28266 symbol, and the rest are interpreted as arguments to @code{format} if
28267 there are multiple of them, or just a string if there is one of them.
28268 This function must always returns @code{nil}.
28271 (nnheader-report 'nnchoke "You did something totally bogus")
28273 (nnheader-report 'nnchoke "Could not request group %s" group)
28276 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
28277 @code{nil} back from a server, and this function returns the most
28278 recently reported message for the back end in question. This function
28279 takes one argument---the server symbol.
28281 Internally, these functions access @var{back-end}@code{-status-string},
28282 so the @code{nnchoke} back end will have its error message stored in
28283 @code{nnchoke-status-string}.
28286 @node Writing New Back Ends
28287 @subsubsection Writing New Back Ends
28289 Many back ends are quite similar. @code{nnml} is just like
28290 @code{nnspool}, but it allows you to edit the articles on the server.
28291 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
28292 and it doesn't maintain overview databases. @code{nndir} is just like
28293 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
28296 It would make sense if it were possible to ``inherit'' functions from
28297 back ends when writing new back ends. And, indeed, you can do that if you
28298 want to. (You don't have to if you don't want to, of course.)
28300 All the back ends declare their public variables and functions by using a
28301 package called @code{nnoo}.
28303 To inherit functions from other back ends (and allow other back ends to
28304 inherit functions from the current back end), you should use the
28310 This macro declares the first parameter to be a child of the subsequent
28311 parameters. For instance:
28314 (nnoo-declare nndir
28318 @code{nndir} has declared here that it intends to inherit functions from
28319 both @code{nnml} and @code{nnmh}.
28322 This macro is equivalent to @code{defvar}, but registers the variable as
28323 a public server variable. Most state-oriented variables should be
28324 declared with @code{defvoo} instead of @code{defvar}.
28326 In addition to the normal @code{defvar} parameters, it takes a list of
28327 variables in the parent back ends to map the variable to when executing
28328 a function in those back ends.
28331 (defvoo nndir-directory nil
28332 "Where nndir will look for groups."
28333 nnml-current-directory nnmh-current-directory)
28336 This means that @code{nnml-current-directory} will be set to
28337 @code{nndir-directory} when an @code{nnml} function is called on behalf
28338 of @code{nndir}. (The same with @code{nnmh}.)
28340 @item nnoo-define-basics
28341 This macro defines some common functions that almost all back ends should
28345 (nnoo-define-basics nndir)
28349 This macro is just like @code{defun} and takes the same parameters. In
28350 addition to doing the normal @code{defun} things, it registers the
28351 function as being public so that other back ends can inherit it.
28353 @item nnoo-map-functions
28354 This macro allows mapping of functions from the current back end to
28355 functions from the parent back ends.
28358 (nnoo-map-functions nndir
28359 (nnml-retrieve-headers 0 nndir-current-group 0 0)
28360 (nnmh-request-article 0 nndir-current-group 0 0))
28363 This means that when @code{nndir-retrieve-headers} is called, the first,
28364 third, and fourth parameters will be passed on to
28365 @code{nnml-retrieve-headers}, while the second parameter is set to the
28366 value of @code{nndir-current-group}.
28369 This macro allows importing functions from back ends. It should be the
28370 last thing in the source file, since it will only define functions that
28371 haven't already been defined.
28377 nnmh-request-newgroups)
28381 This means that calls to @code{nndir-request-list} should just be passed
28382 on to @code{nnmh-request-list}, while all public functions from
28383 @code{nnml} that haven't been defined in @code{nndir} yet should be
28388 Below is a slightly shortened version of the @code{nndir} back end.
28391 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
28392 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
28396 (require 'nnheader)
28400 (eval-when-compile (require 'cl))
28402 (nnoo-declare nndir
28405 (defvoo nndir-directory nil
28406 "Where nndir will look for groups."
28407 nnml-current-directory nnmh-current-directory)
28409 (defvoo nndir-nov-is-evil nil
28410 "*Non-nil means that nndir will never retrieve NOV headers."
28413 (defvoo nndir-current-group ""
28415 nnml-current-group nnmh-current-group)
28416 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
28417 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
28419 (defvoo nndir-status-string "" nil nnmh-status-string)
28420 (defconst nndir-version "nndir 1.0")
28422 ;;; @r{Interface functions.}
28424 (nnoo-define-basics nndir)
28426 (deffoo nndir-open-server (server &optional defs)
28427 (setq nndir-directory
28428 (or (cadr (assq 'nndir-directory defs))
28430 (unless (assq 'nndir-directory defs)
28431 (push `(nndir-directory ,server) defs))
28432 (push `(nndir-current-group
28433 ,(file-name-nondirectory
28434 (directory-file-name nndir-directory)))
28436 (push `(nndir-top-directory
28437 ,(file-name-directory (directory-file-name nndir-directory)))
28439 (nnoo-change-server 'nndir server defs))
28441 (nnoo-map-functions nndir
28442 (nnml-retrieve-headers 0 nndir-current-group 0 0)
28443 (nnmh-request-article 0 nndir-current-group 0 0)
28444 (nnmh-request-group nndir-current-group 0 0)
28445 (nnmh-close-group nndir-current-group 0))
28449 nnmh-status-message
28451 nnmh-request-newgroups))
28457 @node Hooking New Back Ends Into Gnus
28458 @subsubsection Hooking New Back Ends Into Gnus
28460 @vindex gnus-valid-select-methods
28461 @findex gnus-declare-backend
28462 Having Gnus start using your new back end is rather easy---you just
28463 declare it with the @code{gnus-declare-backend} functions. This will
28464 enter the back end into the @code{gnus-valid-select-methods} variable.
28466 @code{gnus-declare-backend} takes two parameters---the back end name and
28467 an arbitrary number of @dfn{abilities}.
28472 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
28475 The above line would then go in the @file{nnchoke.el} file.
28477 The abilities can be:
28481 This is a mailish back end---followups should (probably) go via mail.
28483 This is a newsish back end---followups should (probably) go via news.
28485 This back end supports both mail and news.
28487 This is neither a post nor mail back end---it's something completely
28490 It supports respooling---or rather, it is able to modify its source
28491 articles and groups.
28493 The name of the server should be in the virtual server name. This is
28494 true for almost all back ends.
28495 @item prompt-address
28496 The user should be prompted for an address when doing commands like
28497 @kbd{B} in the group buffer. This is true for back ends like
28498 @code{nntp}, but not @code{nnmbox}, for instance.
28502 @node Mail-like Back Ends
28503 @subsubsection Mail-like Back Ends
28505 One of the things that separate the mail back ends from the rest of the
28506 back ends is the heavy dependence by most of the mail back ends on
28507 common functions in @file{nnmail.el}. For instance, here's the
28508 definition of @code{nnml-request-scan}:
28511 (deffoo nnml-request-scan (&optional group server)
28512 (setq nnml-article-file-alist nil)
28513 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
28516 It simply calls @code{nnmail-get-new-mail} with a few parameters,
28517 and @code{nnmail} takes care of all the moving and splitting of the
28520 This function takes four parameters.
28524 This should be a symbol to designate which back end is responsible for
28527 @item exit-function
28528 This function should be called after the splitting has been performed.
28530 @item temp-directory
28531 Where the temporary files should be stored.
28534 This optional argument should be a group name if the splitting is to be
28535 performed for one group only.
28538 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
28539 save each article. @var{back-end}@code{-active-number} will be called to
28540 find the article number assigned to this article.
28542 The function also uses the following variables:
28543 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
28544 this back end); and @var{back-end}@code{-group-alist} and
28545 @var{back-end}@code{-active-file} to generate the new active file.
28546 @var{back-end}@code{-group-alist} should be a group-active alist, like
28550 (("a-group" (1 . 10))
28551 ("some-group" (34 . 39)))
28555 @node Score File Syntax
28556 @subsection Score File Syntax
28558 Score files are meant to be easily parseable, but yet extremely
28559 mallable. It was decided that something that had the same read syntax
28560 as an Emacs Lisp list would fit that spec.
28562 Here's a typical score file:
28566 ("win95" -10000 nil s)
28573 BNF definition of a score file:
28576 score-file = "" / "(" *element ")"
28577 element = rule / atom
28578 rule = string-rule / number-rule / date-rule
28579 string-rule = "(" quote string-header quote space *string-match ")"
28580 number-rule = "(" quote number-header quote space *number-match ")"
28581 date-rule = "(" quote date-header quote space *date-match ")"
28583 string-header = "subject" / "from" / "references" / "message-id" /
28584 "xref" / "body" / "head" / "all" / "followup"
28585 number-header = "lines" / "chars"
28586 date-header = "date"
28587 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
28588 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
28589 score = "nil" / <integer>
28590 date = "nil" / <natural number>
28591 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
28592 "r" / "regex" / "R" / "Regex" /
28593 "e" / "exact" / "E" / "Exact" /
28594 "f" / "fuzzy" / "F" / "Fuzzy"
28595 number-match = "(" <integer> [ "" / [ space score [ "" /
28596 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
28597 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
28598 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
28599 space date [ "" / [ space date-match-t ] ] ] ] ")"
28600 date-match-t = "nil" / "at" / "before" / "after"
28601 atom = "(" [ required-atom / optional-atom ] ")"
28602 required-atom = mark / expunge / mark-and-expunge / files /
28603 exclude-files / read-only / touched
28604 optional-atom = adapt / local / eval
28605 mark = "mark" space nil-or-number
28606 nil-or-number = "nil" / <integer>
28607 expunge = "expunge" space nil-or-number
28608 mark-and-expunge = "mark-and-expunge" space nil-or-number
28609 files = "files" *[ space <string> ]
28610 exclude-files = "exclude-files" *[ space <string> ]
28611 read-only = "read-only" [ space "nil" / space "t" ]
28612 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
28613 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
28614 local = "local" *[ space "(" <string> space <form> ")" ]
28615 eval = "eval" space <form>
28616 space = *[ " " / <TAB> / <NEWLINE> ]
28619 Any unrecognized elements in a score file should be ignored, but not
28622 As you can see, white space is needed, but the type and amount of white
28623 space is irrelevant. This means that formatting of the score file is
28624 left up to the programmer---if it's simpler to just spew it all out on
28625 one looong line, then that's ok.
28627 The meaning of the various atoms are explained elsewhere in this
28628 manual (@pxref{Score File Format}).
28632 @subsection Headers
28634 Internally Gnus uses a format for storing article headers that
28635 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
28636 almost suspect that the author looked at the @acronym{NOV} specification and
28637 just shamelessly @emph{stole} the entire thing, and one would be right.
28639 @dfn{Header} is a severely overloaded term. ``Header'' is used in
28640 RFC 1036 to talk about lines in the head of an article (e.g.,
28641 @code{From}). It is used by many people as a synonym for
28642 ``head''---``the header and the body''. (That should be avoided, in my
28643 opinion.) And Gnus uses a format internally that it calls ``header'',
28644 which is what I'm talking about here. This is a 9-element vector,
28645 basically, with each header (ouch) having one slot.
28647 These slots are, in order: @code{number}, @code{subject}, @code{from},
28648 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
28649 @code{xref}, and @code{extra}. There are macros for accessing and
28650 setting these slots---they all have predictable names beginning with
28651 @code{mail-header-} and @code{mail-header-set-}, respectively.
28653 All these slots contain strings, except the @code{extra} slot, which
28654 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
28660 @sc{gnus} introduced a concept that I found so useful that I've started
28661 using it a lot and have elaborated on it greatly.
28663 The question is simple: If you have a large amount of objects that are
28664 identified by numbers (say, articles, to take a @emph{wild} example)
28665 that you want to qualify as being ``included'', a normal sequence isn't
28666 very useful. (A 200,000 length sequence is a bit long-winded.)
28668 The solution is as simple as the question: You just collapse the
28672 (1 2 3 4 5 6 10 11 12)
28675 is transformed into
28678 ((1 . 6) (10 . 12))
28681 To avoid having those nasty @samp{(13 . 13)} elements to denote a
28682 lonesome object, a @samp{13} is a valid element:
28685 ((1 . 6) 7 (10 . 12))
28688 This means that comparing two ranges to find out whether they are equal
28689 is slightly tricky:
28692 ((1 . 5) 7 8 (10 . 12))
28698 ((1 . 5) (7 . 8) (10 . 12))
28701 are equal. In fact, any non-descending list is a range:
28707 is a perfectly valid range, although a pretty long-winded one. This is
28714 and is equal to the previous range.
28716 Here's a BNF definition of ranges. Of course, one must remember the
28717 semantic requirement that the numbers are non-descending. (Any number
28718 of repetition of the same number is allowed, but apt to disappear in
28722 range = simple-range / normal-range
28723 simple-range = "(" number " . " number ")"
28724 normal-range = "(" start-contents ")"
28725 contents = "" / simple-range *[ " " contents ] /
28726 number *[ " " contents ]
28729 Gnus currently uses ranges to keep track of read articles and article
28730 marks. I plan on implementing a number of range operators in C if The
28731 Powers That Be are willing to let me. (I haven't asked yet, because I
28732 need to do some more thinking on what operators I need to make life
28733 totally range-based without ever having to convert back to normal
28738 @subsection Group Info
28740 Gnus stores all permanent info on groups in a @dfn{group info} list.
28741 This list is from three to six elements (or more) long and exhaustively
28742 describes the group.
28744 Here are two example group infos; one is a very simple group while the
28745 second is a more complex one:
28748 ("no.group" 5 ((1 . 54324)))
28750 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
28751 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
28753 ((auto-expire . t) (to-address . "ding@@gnus.org")))
28756 The first element is the @dfn{group name}---as Gnus knows the group,
28757 anyway. The second element is the @dfn{subscription level}, which
28758 normally is a small integer. (It can also be the @dfn{rank}, which is a
28759 cons cell where the @code{car} is the level and the @code{cdr} is the
28760 score.) The third element is a list of ranges of read articles. The
28761 fourth element is a list of lists of article marks of various kinds.
28762 The fifth element is the select method (or virtual server, if you like).
28763 The sixth element is a list of @dfn{group parameters}, which is what
28764 this section is about.
28766 Any of the last three elements may be missing if they are not required.
28767 In fact, the vast majority of groups will normally only have the first
28768 three elements, which saves quite a lot of cons cells.
28770 Here's a BNF definition of the group info format:
28773 info = "(" group space ralevel space read
28774 [ "" / [ space marks-list [ "" / [ space method [ "" /
28775 space parameters ] ] ] ] ] ")"
28776 group = quote <string> quote
28777 ralevel = rank / level
28778 level = <integer in the range of 1 to inf>
28779 rank = "(" level "." score ")"
28780 score = <integer in the range of 1 to inf>
28782 marks-lists = nil / "(" *marks ")"
28783 marks = "(" <string> range ")"
28784 method = "(" <string> *elisp-forms ")"
28785 parameters = "(" *elisp-forms ")"
28788 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
28789 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
28792 If you have a Gnus info and want to access the elements, Gnus offers a
28793 series of macros for getting/setting these elements.
28796 @item gnus-info-group
28797 @itemx gnus-info-set-group
28798 @findex gnus-info-group
28799 @findex gnus-info-set-group
28800 Get/set the group name.
28802 @item gnus-info-rank
28803 @itemx gnus-info-set-rank
28804 @findex gnus-info-rank
28805 @findex gnus-info-set-rank
28806 Get/set the group rank (@pxref{Group Score}).
28808 @item gnus-info-level
28809 @itemx gnus-info-set-level
28810 @findex gnus-info-level
28811 @findex gnus-info-set-level
28812 Get/set the group level.
28814 @item gnus-info-score
28815 @itemx gnus-info-set-score
28816 @findex gnus-info-score
28817 @findex gnus-info-set-score
28818 Get/set the group score (@pxref{Group Score}).
28820 @item gnus-info-read
28821 @itemx gnus-info-set-read
28822 @findex gnus-info-read
28823 @findex gnus-info-set-read
28824 Get/set the ranges of read articles.
28826 @item gnus-info-marks
28827 @itemx gnus-info-set-marks
28828 @findex gnus-info-marks
28829 @findex gnus-info-set-marks
28830 Get/set the lists of ranges of marked articles.
28832 @item gnus-info-method
28833 @itemx gnus-info-set-method
28834 @findex gnus-info-method
28835 @findex gnus-info-set-method
28836 Get/set the group select method.
28838 @item gnus-info-params
28839 @itemx gnus-info-set-params
28840 @findex gnus-info-params
28841 @findex gnus-info-set-params
28842 Get/set the group parameters.
28845 All the getter functions take one parameter---the info list. The setter
28846 functions take two parameters---the info list and the new value.
28848 The last three elements in the group info aren't mandatory, so it may be
28849 necessary to extend the group info before setting the element. If this
28850 is necessary, you can just pass on a non-@code{nil} third parameter to
28851 the three final setter functions to have this happen automatically.
28854 @node Extended Interactive
28855 @subsection Extended Interactive
28856 @cindex interactive
28857 @findex gnus-interactive
28859 Gnus extends the standard Emacs @code{interactive} specification
28860 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
28861 Prefixes}). Here's an example of how this is used:
28864 (defun gnus-summary-increase-score (&optional score symp)
28865 (interactive (gnus-interactive "P\ny"))
28870 The best thing to do would have been to implement
28871 @code{gnus-interactive} as a macro which would have returned an
28872 @code{interactive} form, but this isn't possible since Emacs checks
28873 whether a function is interactive or not by simply doing an @code{assq}
28874 on the lambda form. So, instead we have @code{gnus-interactive}
28875 function that takes a string and returns values that are usable to
28876 @code{interactive}.
28878 This function accepts (almost) all normal @code{interactive} specs, but
28883 @vindex gnus-current-prefix-symbol
28884 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
28888 @vindex gnus-current-prefix-symbols
28889 A list of the current symbolic prefixes---the
28890 @code{gnus-current-prefix-symbol} variable.
28893 The current article number---the @code{gnus-summary-article-number}
28897 The current article header---the @code{gnus-summary-article-header}
28901 The current group name---the @code{gnus-group-group-name}
28907 @node Emacs/XEmacs Code
28908 @subsection Emacs/XEmacs Code
28912 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
28913 platforms must be the primary one. I chose Emacs. Not because I don't
28914 like XEmacs or Mule, but because it comes first alphabetically.
28916 This means that Gnus will byte-compile under Emacs with nary a warning,
28917 while XEmacs will pump out gigabytes of warnings while byte-compiling.
28918 As I use byte-compilation warnings to help me root out trivial errors in
28919 Gnus, that's very useful.
28921 I've also consistently used Emacs function interfaces, but have used
28922 Gnusey aliases for the functions. To take an example: Emacs defines a
28923 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
28924 function. I then define a function called @code{gnus-run-at-time} that
28925 takes the same parameters as the Emacs @code{run-at-time}. When running
28926 Gnus under Emacs, the former function is just an alias for the latter.
28927 However, when running under XEmacs, the former is an alias for the
28928 following function:
28931 (defun gnus-xmas-run-at-time (time repeat function &rest args)
28935 (,function ,@@args))
28939 This sort of thing has been done for bunches of functions. Gnus does
28940 not redefine any native Emacs functions while running under XEmacs---it
28941 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
28944 In the cases where the XEmacs function interface was obviously cleaner,
28945 I used it instead. For example @code{gnus-region-active-p} is an alias
28946 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
28948 Of course, I could have chosen XEmacs as my native platform and done
28949 mapping functions the other way around. But I didn't. The performance
28950 hit these indirections impose on Gnus under XEmacs should be slight.
28953 @node Various File Formats
28954 @subsection Various File Formats
28957 * Active File Format:: Information on articles and groups available.
28958 * Newsgroups File Format:: Group descriptions.
28962 @node Active File Format
28963 @subsubsection Active File Format
28965 The active file lists all groups available on the server in
28966 question. It also lists the highest and lowest current article numbers
28969 Here's an excerpt from a typical active file:
28972 soc.motss 296030 293865 y
28973 alt.binaries.pictures.fractals 3922 3913 n
28974 comp.sources.unix 1605 1593 m
28975 comp.binaries.ibm.pc 5097 5089 y
28976 no.general 1000 900 y
28979 Here's a pseudo-BNF definition of this file:
28982 active = *group-line
28983 group-line = group spc high-number spc low-number spc flag <NEWLINE>
28984 group = <non-white-space string>
28986 high-number = <non-negative integer>
28987 low-number = <positive integer>
28988 flag = "y" / "n" / "m" / "j" / "x" / "=" group
28991 For a full description of this file, see the manual pages for
28992 @samp{innd}, in particular @samp{active(5)}.
28995 @node Newsgroups File Format
28996 @subsubsection Newsgroups File Format
28998 The newsgroups file lists groups along with their descriptions. Not all
28999 groups on the server have to be listed, and not all groups in the file
29000 have to exist on the server. The file is meant purely as information to
29003 The format is quite simple; a group name, a tab, and the description.
29004 Here's the definition:
29008 line = group tab description <NEWLINE>
29009 group = <non-white-space string>
29011 description = <string>
29016 @node Emacs for Heathens
29017 @section Emacs for Heathens
29019 Believe it or not, but some people who use Gnus haven't really used
29020 Emacs much before they embarked on their journey on the Gnus Love Boat.
29021 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
29022 region'', and ``set @code{gnus-flargblossen} to an alist where the key
29023 is a regexp that is used for matching on the group name'' are magical
29024 phrases with little or no meaning, then this appendix is for you. If
29025 you are already familiar with Emacs, just ignore this and go fondle your
29029 * Keystrokes:: Entering text and executing commands.
29030 * Emacs Lisp:: The built-in Emacs programming language.
29035 @subsection Keystrokes
29039 Q: What is an experienced Emacs user?
29042 A: A person who wishes that the terminal had pedals.
29045 Yes, when you use Emacs, you are apt to use the control key, the shift
29046 key and the meta key a lot. This is very annoying to some people
29047 (notably @code{vi}le users), and the rest of us just love the hell out
29048 of it. Just give up and submit. Emacs really does stand for
29049 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
29050 may have heard from other disreputable sources (like the Emacs author).
29052 The shift keys are normally located near your pinky fingers, and are
29053 normally used to get capital letters and stuff. You probably use it all
29054 the time. The control key is normally marked ``CTRL'' or something like
29055 that. The meta key is, funnily enough, never marked as such on any
29056 keyboard. The one I'm currently at has a key that's marked ``Alt'',
29057 which is the meta key on this keyboard. It's usually located somewhere
29058 to the left hand side of the keyboard, usually on the bottom row.
29060 Now, us Emacs people don't say ``press the meta-control-m key'',
29061 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
29062 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
29063 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
29064 down the control key, and hold it down while you press @kbd{k}''.
29065 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
29066 the control key and then press @kbd{k}''. Simple, ay?
29068 This is somewhat complicated by the fact that not all keyboards have a
29069 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
29070 means ``press escape, release escape, press @kbd{k}''. That's much more
29071 work than if you have a meta key, so if that's the case, I respectfully
29072 suggest you get a real keyboard with a meta key. You can't live without
29078 @subsection Emacs Lisp
29080 Emacs is the King of Editors because it's really a Lisp interpreter.
29081 Each and every key you tap runs some Emacs Lisp code snippet, and since
29082 Emacs Lisp is an interpreted language, that means that you can configure
29083 any key to run any arbitrary code. You just, like, do it.
29085 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
29086 functions. (These are byte-compiled for speed, but it's still
29087 interpreted.) If you decide that you don't like the way Gnus does
29088 certain things, it's trivial to have it do something a different way.
29089 (Well, at least if you know how to write Lisp code.) However, that's
29090 beyond the scope of this manual, so we are simply going to talk about
29091 some common constructs that you normally use in your @file{.emacs} file
29094 If you want to set the variable @code{gnus-florgbnize} to four (4), you
29095 write the following:
29098 (setq gnus-florgbnize 4)
29101 This function (really ``special form'') @code{setq} is the one that can
29102 set a variable to some value. This is really all you need to know. Now
29103 you can go and fill your @file{.emacs} file with lots of these to change
29106 If you have put that thing in your @file{.emacs} file, it will be read
29107 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
29108 start Emacs. If you want to change the variable right away, simply say
29109 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
29110 previous ``form'', which is a simple @code{setq} statement here.
29112 Go ahead---just try it, if you're located at your Emacs. After you
29113 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
29114 is the return value of the form you @code{eval}ed.
29118 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
29122 (setq gnus-read-active-file 'some)
29125 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
29126 @samp{nntp.ifi.uio.no}'', that means:
29129 (setq gnus-nntp-server "nntp.ifi.uio.no")
29132 So be careful not to mix up strings (the latter) with symbols (the
29133 former). The manual is unambiguous, but it can be confusing.
29136 @include gnus-faq.texi
29156 @c Local Variables:
29158 @c coding: iso-8859-1