10 * Gnus: (gnus). The newsreader Gnus.
12 @documentencoding ISO-8859-1
16 @setchapternewpage odd
20 \documentclass[twoside,a4paper,openright,11pt]{book}
21 \usepackage[latin1]{inputenc}
22 \usepackage{pagestyle}
25 \input{gnusconfig.tex}
27 \ifx\pdfoutput\undefined
29 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
37 \newcommand{\gnusversionname}{Gnus v5.10.6}
38 \newcommand{\gnuschaptername}{}
39 \newcommand{\gnussectionname}{}
41 \newcommand{\gnusbackslash}{/}
43 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
44 \ifx\pdfoutput\undefined
45 \newcommand{\gnusuref}[1]{\gnustt{#1}}
47 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
49 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
50 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
52 \newcommand{\gnuskindex}[1]{\index{#1}}
53 \newcommand{\gnusindex}[1]{\index{#1}}
55 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
56 \newcommand{\gnuscode}[1]{\gnustt{#1}}
57 \newcommand{\gnusasis}[1]{\gnustt{#1}}
58 \newcommand{\gnusurl}[1]{\gnustt{#1}}
59 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
60 \newcommand{\gnusenv}[1]{\gnustt{#1}}
61 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
62 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
63 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
64 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
65 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
66 \newcommand{\gnusdfn}[1]{\textit{#1}}
67 \newcommand{\gnusi}[1]{\textit{#1}}
68 \newcommand{\gnusr}[1]{\textrm{#1}}
69 \newcommand{\gnusstrong}[1]{\textbf{#1}}
70 \newcommand{\gnusemph}[1]{\textit{#1}}
71 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
72 \newcommand{\gnussc}[1]{\textsc{#1}}
73 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
74 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
75 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
76 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
77 \newcommand{\gnusacronym}[1]{\textsc{#1}}
78 \newcommand{\gnusemail}[1]{\textit{#1}}
80 \newcommand{\gnusbullet}{{${\bullet}$}}
81 \newcommand{\gnusdollar}{\$}
82 \newcommand{\gnusampersand}{\&}
83 \newcommand{\gnuspercent}{\%}
84 \newcommand{\gnushash}{\#}
85 \newcommand{\gnushat}{\symbol{"5E}}
86 \newcommand{\gnusunderline}{\symbol{"5F}}
87 \newcommand{\gnusnot}{$\neg$}
88 \newcommand{\gnustilde}{\symbol{"7E}}
89 \newcommand{\gnusless}{{$<$}}
90 \newcommand{\gnusgreater}{{$>$}}
91 \newcommand{\gnusbraceleft}{{$>$}}
92 \newcommand{\gnusbraceright}{{$>$}}
94 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
95 \newcommand{\gnusinteresting}{
96 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
99 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
101 \newcommand{\gnuspagechapter}[1]{
105 \newdimen{\gnusdimen}
108 \newcommand{\gnuschapter}[2]{
110 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
112 \renewcommand{\gnussectionname}{}
113 \renewcommand{\gnuschaptername}{#2}
114 \thispagestyle{empty}
116 \begin{picture}(500,500)(0,0)
117 \put(480,350){\makebox(0,0)[tr]{#1}}
118 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
123 \newcommand{\gnusfigure}[3]{
125 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
132 \newcommand{\gnusicon}[1]{
133 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
136 \newcommand{\gnuspicon}[1]{
137 \margindex{\epsfig{figure=#1,width=2cm}}
140 \newcommand{\gnusxface}[2]{
141 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
144 \newcommand{\gnussmiley}[2]{
145 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
148 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
150 \newcommand{\gnussection}[1]{
151 \renewcommand{\gnussectionname}{#1}
155 \newenvironment{codelist}%
160 \newenvironment{asislist}%
165 \newenvironment{kbdlist}%
171 \newenvironment{dfnlist}%
176 \newenvironment{stronglist}%
181 \newenvironment{samplist}%
186 \newenvironment{varlist}%
191 \newenvironment{emphlist}%
196 \newlength\gnusheadtextwidth
197 \setlength{\gnusheadtextwidth}{\headtextwidth}
198 \addtolength{\gnusheadtextwidth}{1cm}
200 \newpagestyle{gnuspreamble}%
205 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
209 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
218 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
220 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
225 \newpagestyle{gnusindex}%
230 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
234 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
242 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
244 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
254 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
258 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
266 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
268 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
273 \pagenumbering{roman}
274 \pagestyle{gnuspreamble}
284 %\addtolength{\oddsidemargin}{-5cm}
285 %\addtolength{\evensidemargin}{-5cm}
287 \addtolength{\textheight}{2cm}
289 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
292 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
295 \gnusauthor{by Lars Magne Ingebrigtsen}
302 \thispagestyle{empty}
304 Copyright \copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
306 Free Software Foundation, Inc.
309 Permission is granted to copy, distribute and/or modify this document
310 under the terms of the GNU Free Documentation License, Version 1.1 or
311 any later version published by the Free Software Foundation; with no
312 Invariant Sections, with the Front-Cover texts being ``A GNU
313 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
314 license is included in the section entitled ``GNU Free Documentation
315 License'' in the Emacs manual.
317 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
318 this GNU Manual, like GNU software. Copies published by the Free
319 Software Foundation raise funds for GNU development.''
321 This document is part of a collection distributed under the GNU Free
322 Documentation License. If you want to distribute this document
323 separately from the collection, you can do so by adding a copy of the
324 license to the document, as described in section 6 of the license.
332 This file documents Gnus, the GNU Emacs newsreader.
334 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
335 Free Software Foundation, Inc.
337 Permission is granted to copy, distribute and/or modify this document
338 under the terms of the GNU Free Documentation License, Version 1.1 or
339 any later version published by the Free Software Foundation; with the
340 Invariant Sections being none, with the Front-Cover texts being ``A GNU
341 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
342 license is included in the section entitled ``GNU Free Documentation
343 License'' in the Emacs manual.
345 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
346 this GNU Manual, like GNU software. Copies published by the Free
347 Software Foundation raise funds for GNU development.''
349 This document is part of a collection distributed under the GNU Free
350 Documentation License. If you want to distribute this document
351 separately from the collection, you can do so by adding a copy of the
352 license to the document, as described in section 6 of the license.
360 @author by Lars Magne Ingebrigtsen
363 @vskip 0pt plus 1filll
364 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
366 Free Software Foundation, Inc.
368 Permission is granted to copy, distribute and/or modify this document
369 under the terms of the GNU Free Documentation License, Version 1.1 or
370 any later version published by the Free Software Foundation; with no
371 Invariant Sections, with the Front-Cover texts being ``A GNU
372 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
373 license is included in the section entitled ``GNU Free Documentation
374 License'' in the Emacs manual.
376 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
377 this GNU Manual, like GNU software. Copies published by the Free
378 Software Foundation raise funds for GNU development.''
380 This document is part of a collection distributed under the GNU Free
381 Documentation License. If you want to distribute this document
382 separately from the collection, you can do so by adding a copy of the
383 license to the document, as described in section 6 of the license.
392 @top The Gnus Newsreader
396 You can read news (and mail) from within Emacs by using Gnus. The news
397 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
398 spool or your mbox file. All at the same time, if you want to push your
401 This manual corresponds to Gnus v5.10.6.
412 Gnus is the advanced, self-documenting, customizable, extensible
413 unreal-time newsreader for GNU Emacs.
415 Oops. That sounds oddly familiar, so let's start over again to avoid
416 being accused of plagiarism:
418 Gnus is a message-reading laboratory. It will let you look at just
419 about anything as if it were a newsgroup. You can read mail with it,
420 you can browse directories with it, you can @code{ftp} with it---you
421 can even read news with it!
423 Gnus tries to empower people who read news the same way Emacs empowers
424 people who edit text. Gnus sets no limits to what the user should be
425 allowed to do. Users are encouraged to extend Gnus to make it behave
426 like they want it to behave. A program should not control people;
427 people should be empowered to do what they want by using (or abusing)
433 * Starting Up:: Finding news can be a pain.
434 * Group Buffer:: Selecting, subscribing and killing groups.
435 * Summary Buffer:: Reading, saving and posting articles.
436 * Article Buffer:: Displaying and handling articles.
437 * Composing Messages:: Information on sending mail and news.
438 * Select Methods:: Gnus reads all messages from various select methods.
439 * Scoring:: Assigning values to articles.
440 * Various:: General purpose settings.
441 * The End:: Farewell and goodbye.
442 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
443 * Index:: Variable, function and concept index.
444 * Key Index:: Key Index.
446 Other related manuals
448 * Message:(message). Composing messages.
449 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
450 * Sieve:(sieve). Managing Sieve scripts in Emacs.
451 * PGG:(pgg). @acronym{PGP/MIME} with Gnus.
452 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
455 --- The Detailed Node Listing ---
459 * Finding the News:: Choosing a method for getting news.
460 * The First Time:: What does Gnus do the first time you start it?
461 * The Server is Down:: How can I read my mail then?
462 * Slave Gnusae:: You can have more than one Gnus active at a time.
463 * Fetching a Group:: Starting Gnus just to read a group.
464 * New Groups:: What is Gnus supposed to do with new groups?
465 * Changing Servers:: You may want to move from one server to another.
466 * Startup Files:: Those pesky startup files---@file{.newsrc}.
467 * Auto Save:: Recovering from a crash.
468 * The Active File:: Reading the active file over a slow line Takes Time.
469 * Startup Variables:: Other variables you might change.
473 * Checking New Groups:: Determining what groups are new.
474 * Subscription Methods:: What Gnus should do with new groups.
475 * Filtering New Groups:: Making Gnus ignore certain new groups.
479 * Group Buffer Format:: Information listed and how you can change it.
480 * Group Maneuvering:: Commands for moving in the group buffer.
481 * Selecting a Group:: Actually reading news.
482 * Subscription Commands:: Unsubscribing, killing, subscribing.
483 * Group Data:: Changing the info for a group.
484 * Group Levels:: Levels? What are those, then?
485 * Group Score:: A mechanism for finding out what groups you like.
486 * Marking Groups:: You can mark groups for later processing.
487 * Foreign Groups:: Creating and editing groups.
488 * Group Parameters:: Each group may have different parameters set.
489 * Listing Groups:: Gnus can list various subsets of the groups.
490 * Sorting Groups:: Re-arrange the group order.
491 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
492 * Browse Foreign Server:: You can browse a server. See what it has to offer.
493 * Exiting Gnus:: Stop reading news and get some work done.
494 * Group Topics:: A folding group mode divided into topics.
495 * Misc Group Stuff:: Other stuff that you can to do.
499 * Group Line Specification:: Deciding how the group buffer is to look.
500 * Group Mode Line Specification:: The group buffer mode line.
501 * Group Highlighting:: Having nice colors in the group buffer.
505 * Topic Commands:: Interactive E-Z commands.
506 * Topic Variables:: How to customize the topics the Lisp Way.
507 * Topic Sorting:: Sorting each topic individually.
508 * Topic Topology:: A map of the world.
509 * Topic Parameters:: Parameters that apply to all groups in a topic.
513 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
514 * Group Information:: Information and help on groups and Gnus.
515 * Group Timestamp:: Making Gnus keep track of when you last read a group.
516 * File Commands:: Reading and writing the Gnus files.
517 * Sieve Commands:: Managing Sieve scripts.
521 * Summary Buffer Format:: Deciding how the summary buffer is to look.
522 * Summary Maneuvering:: Moving around the summary buffer.
523 * Choosing Articles:: Reading articles.
524 * Paging the Article:: Scrolling the current article.
525 * Reply Followup and Post:: Posting articles.
526 * Delayed Articles:: Send articles at a later time.
527 * Marking Articles:: Marking articles as read, expirable, etc.
528 * Limiting:: You can limit the summary buffer.
529 * Threading:: How threads are made.
530 * Sorting the Summary Buffer:: How articles and threads are sorted.
531 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
532 * Article Caching:: You may store articles in a cache.
533 * Persistent Articles:: Making articles expiry-resistant.
534 * Article Backlog:: Having already read articles hang around.
535 * Saving Articles:: Ways of customizing article saving.
536 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
537 * Article Treatment:: The article buffer can be mangled at will.
538 * MIME Commands:: Doing MIMEy things with the articles.
539 * Charsets:: Character set issues.
540 * Article Commands:: Doing various things with the article buffer.
541 * Summary Sorting:: Sorting the summary buffer in various ways.
542 * Finding the Parent:: No child support? Get the parent.
543 * Alternative Approaches:: Reading using non-default summaries.
544 * Tree Display:: A more visual display of threads.
545 * Mail Group Commands:: Some commands can only be used in mail groups.
546 * Various Summary Stuff:: What didn't fit anywhere else.
547 * Exiting the Summary Buffer:: Returning to the Group buffer,
548 or reselecting the current group.
549 * Crosspost Handling:: How crossposted articles are dealt with.
550 * Duplicate Suppression:: An alternative when crosspost handling fails.
551 * Security:: Decrypt and Verify.
552 * Mailing List:: Mailing list minor mode.
554 Summary Buffer Format
556 * Summary Buffer Lines:: You can specify how summary lines should look.
557 * To From Newsgroups:: How to not display your own name.
558 * Summary Buffer Mode Line:: You can say how the mode line should look.
559 * Summary Highlighting:: Making the summary buffer all pretty and nice.
563 * Choosing Commands:: Commands for choosing articles.
564 * Choosing Variables:: Variables that influence these commands.
566 Reply, Followup and Post
568 * Summary Mail Commands:: Sending mail.
569 * Summary Post Commands:: Sending news.
570 * Summary Message Commands:: Other Message-related commands.
571 * Canceling and Superseding::
575 * Unread Articles:: Marks for unread articles.
576 * Read Articles:: Marks for read articles.
577 * Other Marks:: Marks that do not affect readedness.
581 * Setting Marks:: How to set and remove marks.
582 * Generic Marking Commands:: How to customize the marking.
583 * Setting Process Marks:: How to mark articles for later processing.
587 * Customizing Threading:: Variables you can change to affect the threading.
588 * Thread Commands:: Thread based commands in the summary buffer.
590 Customizing Threading
592 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
593 * Filling In Threads:: Making the threads displayed look fuller.
594 * More Threading:: Even more variables for fiddling with threads.
595 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
599 * Uuencoded Articles:: Uudecode articles.
600 * Shell Archives:: Unshar articles.
601 * PostScript Files:: Split PostScript.
602 * Other Files:: Plain save and binhex.
603 * Decoding Variables:: Variables for a happy decoding.
604 * Viewing Files:: You want to look at the result of the decoding?
608 * Rule Variables:: Variables that say how a file is to be viewed.
609 * Other Decode Variables:: Other decode variables.
610 * Uuencoding and Posting:: Variables for customizing uuencoding.
614 * Article Highlighting:: You want to make the article look like fruit salad.
615 * Article Fontisizing:: Making emphasized text look nice.
616 * Article Hiding:: You also want to make certain info go away.
617 * Article Washing:: Lots of way-neat functions to make life better.
618 * Article Header:: Doing various header transformations.
619 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
620 * Article Button Levels:: Controlling appearance of buttons.
621 * Article Date:: Grumble, UT!
622 * Article Display:: Display various stuff---X-Face, Picons, Smileys
623 * Article Signature:: What is a signature?
624 * Article Miscellanea:: Various other stuff.
626 Alternative Approaches
628 * Pick and Read:: First mark articles and then read them.
629 * Binary Groups:: Auto-decode all articles.
631 Various Summary Stuff
633 * Summary Group Information:: Information oriented commands.
634 * Searching for Articles:: Multiple article commands.
635 * Summary Generation Commands::
636 * Really Various Summary Commands:: Those pesky non-conformant commands.
640 * Hiding Headers:: Deciding what headers should be displayed.
641 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
642 * Customizing Articles:: Tailoring the look of the articles.
643 * Article Keymap:: Keystrokes available in the article buffer.
644 * Misc Article:: Other stuff.
648 * Mail:: Mailing and replying.
649 * Posting Server:: What server should you post and mail via?
650 * POP before SMTP:: You cannot send a mail unless you read a mail.
651 * Mail and Post:: Mailing and posting at the same time.
652 * Archived Messages:: Where Gnus stores the messages you've sent.
653 * Posting Styles:: An easier way to specify who you are.
654 * Drafts:: Postponing messages and rejected messages.
655 * Rejected Articles:: What happens if the server doesn't like your article?
656 * Signing and encrypting:: How to compose secure messages.
660 * Server Buffer:: Making and editing virtual servers.
661 * Getting News:: Reading USENET news with Gnus.
662 * Getting Mail:: Reading your personal mail with Gnus.
663 * Browsing the Web:: Getting messages from a plethora of Web sources.
664 * IMAP:: Using Gnus as a @acronym{IMAP} client.
665 * Other Sources:: Reading directories, files, SOUP packets.
666 * Combined Groups:: Combining groups into one group.
667 * Gnus Unplugged:: Reading news and mail offline.
671 * Server Buffer Format:: You can customize the look of this buffer.
672 * Server Commands:: Commands to manipulate servers.
673 * Example Methods:: Examples server specifications.
674 * Creating a Virtual Server:: An example session.
675 * Server Variables:: Which variables to set.
676 * Servers and Methods:: You can use server names as select methods.
677 * Unavailable Servers:: Some servers you try to contact may be down.
681 * NNTP:: Reading news from an @acronym{NNTP} server.
682 * News Spool:: Reading news from the local spool.
686 * Direct Functions:: Connecting directly to the server.
687 * Indirect Functions:: Connecting indirectly to the server.
688 * Common Variables:: Understood by several connection functions.
692 * Mail in a Newsreader:: Important introductory notes.
693 * Getting Started Reading Mail:: A simple cookbook example.
694 * Splitting Mail:: How to create mail groups.
695 * Mail Sources:: How to tell Gnus where to get mail from.
696 * Mail Back End Variables:: Variables for customizing mail handling.
697 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
698 * Group Mail Splitting:: Use group customize to drive mail splitting.
699 * Incorporating Old Mail:: What about the old mail you have?
700 * Expiring Mail:: Getting rid of unwanted mail.
701 * Washing Mail:: Removing cruft from the mail you get.
702 * Duplicates:: Dealing with duplicated mail.
703 * Not Reading Mail:: Using mail back ends for reading other files.
704 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
708 * Mail Source Specifiers:: How to specify what a mail source is.
709 * Mail Source Customization:: Some variables that influence things.
710 * Fetching Mail:: Using the mail source specifiers.
712 Choosing a Mail Back End
714 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
715 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
716 * Mail Spool:: Store your mail in a private spool?
717 * MH Spool:: An mhspool-like back end.
718 * Maildir:: Another one-file-per-message format.
719 * Mail Folders:: Having one file for each group.
720 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
725 * Web Searches:: Creating groups from articles that match a string.
726 * Slashdot:: Reading the Slashdot comments.
727 * Ultimate:: The Ultimate Bulletin Board systems.
728 * Web Archive:: Reading mailing list archived on web.
729 * RSS:: Reading RDF site summary.
730 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
734 * Splitting in IMAP:: Splitting mail with nnimap.
735 * Expiring in IMAP:: Expiring mail with nnimap.
736 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
737 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
738 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
739 * Debugging IMAP:: What to do when things don't work.
743 * Directory Groups:: You can read a directory as if it was a newsgroup.
744 * Anything Groups:: Dired? Who needs dired?
745 * Document Groups:: Single files can be the basis of a group.
746 * SOUP:: Reading @sc{soup} packets ``offline''.
747 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
751 * Document Server Internals:: How to add your own document types.
755 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
756 * SOUP Groups:: A back end for reading @sc{soup} packets.
757 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
761 * Virtual Groups:: Combining articles from many groups.
762 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
766 * Agent Basics:: How it all is supposed to work.
767 * Agent Categories:: How to tell the Gnus Agent what to download.
768 * Agent Commands:: New commands for all the buffers.
769 * Agent Visuals:: Ways that the agent may effect your summary buffer.
770 * Agent as Cache:: The Agent is a big cache too.
771 * Agent Expiry:: How to make old articles go away.
772 * Agent Regeneration:: How to recover from lost connections and other accidents.
773 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
774 * Outgoing Messages:: What happens when you post/mail something?
775 * Agent Variables:: Customizing is fun.
776 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
777 * Batching Agents:: How to fetch news from a @code{cron} job.
778 * Agent Caveats:: What you think it'll do and what it does.
782 * Category Syntax:: What a category looks like.
783 * Category Buffer:: A buffer for maintaining categories.
784 * Category Variables:: Customize'r'Us.
788 * Group Agent Commands:: Configure groups and fetch their contents.
789 * Summary Agent Commands:: Manually select then fetch specific articles.
790 * Server Agent Commands:: Select the servers that are supported by the agent.
794 * Summary Score Commands:: Adding score entries for the current group.
795 * Group Score Commands:: General score commands.
796 * Score Variables:: Customize your scoring. (My, what terminology).
797 * Score File Format:: What a score file may contain.
798 * Score File Editing:: You can edit score files by hand as well.
799 * Adaptive Scoring:: Big Sister Gnus knows what you read.
800 * Home Score File:: How to say where new score entries are to go.
801 * Followups To Yourself:: Having Gnus notice when people answer you.
802 * Scoring On Other Headers:: Scoring on non-standard headers.
803 * Scoring Tips:: How to score effectively.
804 * Reverse Scoring:: That problem child of old is not problem.
805 * Global Score Files:: Earth-spanning, ear-splitting score files.
806 * Kill Files:: They are still here, but they can be ignored.
807 * Converting Kill Files:: Translating kill files to score files.
808 * Advanced Scoring:: Using logical expressions to build score rules.
809 * Score Decays:: It can be useful to let scores wither away.
813 * Advanced Scoring Syntax:: A definition.
814 * Advanced Scoring Examples:: What they look like.
815 * Advanced Scoring Tips:: Getting the most out of it.
819 * Process/Prefix:: A convention used by many treatment commands.
820 * Interactive:: Making Gnus ask you many questions.
821 * Symbolic Prefixes:: How to supply some Gnus functions with options.
822 * Formatting Variables:: You can specify what buffers should look like.
823 * Window Layout:: Configuring the Gnus buffer windows.
824 * Faces and Fonts:: How to change how faces look.
825 * Compilation:: How to speed Gnus up.
826 * Mode Lines:: Displaying information in the mode lines.
827 * Highlighting and Menus:: Making buffers look all nice and cozy.
828 * Buttons:: Get tendinitis in ten easy steps!
829 * Daemons:: Gnus can do things behind your back.
830 * NoCeM:: How to avoid spam and other fatty foods.
831 * Undo:: Some actions can be undone.
832 * Predicate Specifiers:: Specifying predicates.
833 * Moderation:: What to do if you're a moderator.
834 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
835 * Fuzzy Matching:: What's the big fuzz?
836 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
837 * Other modes:: Interaction with other modes.
838 * Various Various:: Things that are really various.
842 * Formatting Basics:: A formatting variable is basically a format string.
843 * Mode Line Formatting:: Some rules about mode line formatting variables.
844 * Advanced Formatting:: Modifying output in various ways.
845 * User-Defined Specs:: Having Gnus call your own functions.
846 * Formatting Fonts:: Making the formatting look colorful and nice.
847 * Positioning Point:: Moving point to a position after an operation.
848 * Tabulation:: Tabulating your output.
849 * Wide Characters:: Dealing with wide characters.
853 * X-Face:: Display a funky, teensy black-and-white image.
854 * Face:: Display a funkier, teensier colored image.
855 * Smileys:: Show all those happy faces the way they were meant to be shown.
856 * Picons:: How to display pictures of what you're reading.
857 * XVarious:: Other XEmacsy Gnusey variables.
861 * The problem of spam:: Some background, and some solutions
862 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
863 * SpamAssassin:: How to use external anti-spam tools.
864 * Hashcash:: Reduce spam by burning CPU time.
865 * Filtering Spam Using The Spam ELisp Package::
866 * Filtering Spam Using Statistics with spam-stat::
868 Filtering Spam Using The Spam ELisp Package
870 * Spam ELisp Package Sequence of Events::
871 * Spam ELisp Package Filtering of Incoming Mail::
872 * Spam ELisp Package Global Variables::
873 * Spam ELisp Package Configuration Examples::
874 * Blacklists and Whitelists::
876 * Gmane Spam Reporting::
877 * Anti-spam Hashcash Payments::
879 * Regular Expressions Header Matching::
881 * SpamAssassin backend::
882 * ifile spam filtering::
883 * spam-stat spam filtering::
885 * Extending the Spam ELisp package::
887 Filtering Spam Using Statistics with spam-stat
889 * Creating a spam-stat dictionary::
890 * Splitting mail using spam-stat::
891 * Low-level interface to the spam-stat dictionary::
895 * XEmacs:: Requirements for installing under XEmacs.
896 * History:: How Gnus got where it is today.
897 * On Writing Manuals:: Why this is not a beginner's guide.
898 * Terminology:: We use really difficult, like, words here.
899 * Customization:: Tailoring Gnus to your needs.
900 * Troubleshooting:: What you might try if things do not work.
901 * Gnus Reference Guide:: Rilly, rilly technical stuff.
902 * Emacs for Heathens:: A short introduction to Emacsian terms.
903 * Frequently Asked Questions:: The Gnus FAQ
907 * Gnus Versions:: What Gnus versions have been released.
908 * Other Gnus Versions:: Other Gnus versions that also have been released.
909 * Why?:: What's the point of Gnus?
910 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
911 * Conformity:: Gnus tries to conform to all standards.
912 * Emacsen:: Gnus can be run on a few modern Emacsen.
913 * Gnus Development:: How Gnus is developed.
914 * Contributors:: Oodles of people.
915 * New Features:: Pointers to some of the new stuff in Gnus.
919 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
920 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
921 * Red Gnus:: Third time best---Gnus 5.4/5.5.
922 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
923 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
924 * Oort Gnus:: It's big. It's far out. Gnus 5.10.
925 * No Gnus:: Lars, FIXME!
929 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
930 * Slow Terminal Connection:: You run a remote Emacs.
931 * Little Disk Space:: You feel that having large setup files is icky.
932 * Slow Machine:: You feel like buying a faster machine.
936 * Gnus Utility Functions:: Common functions and variable to use.
937 * Back End Interface:: How Gnus communicates with the servers.
938 * Score File Syntax:: A BNF definition of the score file standard.
939 * Headers:: How Gnus stores headers internally.
940 * Ranges:: A handy format for storing mucho numbers.
941 * Group Info:: The group info format.
942 * Extended Interactive:: Symbolic prefixes and stuff.
943 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
944 * Various File Formats:: Formats of files that Gnus use.
948 * Required Back End Functions:: Functions that must be implemented.
949 * Optional Back End Functions:: Functions that need not be implemented.
950 * Error Messaging:: How to get messages and report errors.
951 * Writing New Back Ends:: Extending old back ends.
952 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
953 * Mail-like Back Ends:: Some tips on mail back ends.
957 * Active File Format:: Information on articles and groups available.
958 * Newsgroups File Format:: Group descriptions.
962 * Keystrokes:: Entering text and executing commands.
963 * Emacs Lisp:: The built-in Emacs programming language.
969 @chapter Starting Gnus
974 If your system administrator has set things up properly, starting Gnus
975 and reading news is extremely easy---you just type @kbd{M-x gnus} in
978 @findex gnus-other-frame
979 @kindex M-x gnus-other-frame
980 If you want to start Gnus in a different frame, you can use the command
981 @kbd{M-x gnus-other-frame} instead.
983 If things do not go smoothly at startup, you have to twiddle some
984 variables in your @file{~/.gnus.el} file. This file is similar to
985 @file{~/.emacs}, but is read when Gnus starts.
987 If you puzzle at any terms used in this manual, please refer to the
988 terminology section (@pxref{Terminology}).
991 * Finding the News:: Choosing a method for getting news.
992 * The First Time:: What does Gnus do the first time you start it?
993 * The Server is Down:: How can I read my mail then?
994 * Slave Gnusae:: You can have more than one Gnus active at a time.
995 * Fetching a Group:: Starting Gnus just to read a group.
996 * New Groups:: What is Gnus supposed to do with new groups?
997 * Changing Servers:: You may want to move from one server to another.
998 * Startup Files:: Those pesky startup files---@file{.newsrc}.
999 * Auto Save:: Recovering from a crash.
1000 * The Active File:: Reading the active file over a slow line Takes Time.
1001 * Startup Variables:: Other variables you might change.
1005 @node Finding the News
1006 @section Finding the News
1007 @cindex finding news
1009 @vindex gnus-select-method
1011 The @code{gnus-select-method} variable says where Gnus should look for
1012 news. This variable should be a list where the first element says
1013 @dfn{how} and the second element says @dfn{where}. This method is your
1014 native method. All groups not fetched with this method are
1017 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
1018 you want to get your daily dosage of news from, you'd say:
1021 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1024 If you want to read directly from the local spool, say:
1027 (setq gnus-select-method '(nnspool ""))
1030 If you can use a local spool, you probably should, as it will almost
1031 certainly be much faster. But do not use the local spool if your
1032 server is running Leafnode; in this case, use @code{(nntp "localhost")}.
1034 @vindex gnus-nntpserver-file
1036 @cindex @acronym{NNTP} server
1037 If this variable is not set, Gnus will take a look at the
1038 @env{NNTPSERVER} environment variable. If that variable isn't set,
1039 Gnus will see whether @code{gnus-nntpserver-file}
1040 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1041 If that fails as well, Gnus will try to use the machine running Emacs
1042 as an @acronym{NNTP} server. That's a long shot, though.
1044 @vindex gnus-nntp-server
1045 If @code{gnus-nntp-server} is set, this variable will override
1046 @code{gnus-select-method}. You should therefore set
1047 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1049 @vindex gnus-secondary-servers
1050 @vindex gnus-nntp-server
1051 You can also make Gnus prompt you interactively for the name of an
1052 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1053 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
1054 in the @code{gnus-secondary-servers} list (if any). You can also just
1055 type in the name of any server you feel like visiting. (Note that this
1056 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1057 gnus} later in the same Emacs session, Gnus will contact the same
1060 @findex gnus-group-browse-foreign-server
1062 However, if you use one @acronym{NNTP} server regularly and are just
1063 interested in a couple of groups from a different server, you would be
1064 better served by using the @kbd{B} command in the group buffer. It will
1065 let you have a look at what groups are available, and you can subscribe
1066 to any of the groups you want to. This also makes @file{.newsrc}
1067 maintenance much tidier. @xref{Foreign Groups}.
1069 @vindex gnus-secondary-select-methods
1071 A slightly different approach to foreign groups is to set the
1072 @code{gnus-secondary-select-methods} variable. The select methods
1073 listed in this variable are in many ways just as native as the
1074 @code{gnus-select-method} server. They will also be queried for active
1075 files during startup (if that's required), and new newsgroups that
1076 appear on these servers will be subscribed (or not) just as native
1079 For instance, if you use the @code{nnmbox} back end to read your mail,
1080 you would typically set this variable to
1083 (setq gnus-secondary-select-methods '((nnmbox "")))
1087 @node The First Time
1088 @section The First Time
1089 @cindex first time usage
1091 If no startup files exist, Gnus will try to determine what groups should
1092 be subscribed by default.
1094 @vindex gnus-default-subscribed-newsgroups
1095 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
1096 will subscribe you to just those groups in that list, leaving the rest
1097 killed. Your system administrator should have set this variable to
1100 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1101 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1102 here as @dfn{whatever Lars thinks you should read}.)
1104 You'll also be subscribed to the Gnus documentation group, which should
1105 help you with most common problems.
1107 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1108 use the normal functions for handling new groups, and not do anything
1112 @node The Server is Down
1113 @section The Server is Down
1114 @cindex server errors
1116 If the default server is down, Gnus will understandably have some
1117 problems starting. However, if you have some mail groups in addition to
1118 the news groups, you may want to start Gnus anyway.
1120 Gnus, being the trusting sort of program, will ask whether to proceed
1121 without a native select method if that server can't be contacted. This
1122 will happen whether the server doesn't actually exist (i.e., you have
1123 given the wrong address) or the server has just momentarily taken ill
1124 for some reason or other. If you decide to continue and have no foreign
1125 groups, you'll find it difficult to actually do anything in the group
1126 buffer. But, hey, that's your problem. Blllrph!
1128 @findex gnus-no-server
1129 @kindex M-x gnus-no-server
1131 If you know that the server is definitely down, or you just want to read
1132 your mail without bothering with the server at all, you can use the
1133 @code{gnus-no-server} command to start Gnus. That might come in handy
1134 if you're in a hurry as well. This command will not attempt to contact
1135 your primary server---instead, it will just activate all groups on level
1136 1 and 2. (You should preferably keep no native groups on those two
1137 levels.) Also @pxref{Group Levels}.
1141 @section Slave Gnusae
1144 You might want to run more than one Emacs with more than one Gnus at the
1145 same time. If you are using different @file{.newsrc} files (e.g., if you
1146 are using the two different Gnusae to read from two different servers),
1147 that is no problem whatsoever. You just do it.
1149 The problem appears when you want to run two Gnusae that use the same
1150 @file{.newsrc} file.
1152 To work around that problem some, we here at the Think-Tank at the Gnus
1153 Towers have come up with a new concept: @dfn{Masters} and
1154 @dfn{slaves}. (We have applied for a patent on this concept, and have
1155 taken out a copyright on those words. If you wish to use those words in
1156 conjunction with each other, you have to send $1 per usage instance to
1157 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1158 Applications}) will be much more expensive, of course.)
1161 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1162 however you do it). Each subsequent slave Gnusae should be started with
1163 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1164 files, but instead save @dfn{slave files} that contain information only
1165 on what groups have been read in the slave session. When a master Gnus
1166 starts, it will read (and delete) these slave files, incorporating all
1167 information from them. (The slave files will be read in the sequence
1168 they were created, so the latest changes will have precedence.)
1170 Information from the slave files has, of course, precedence over the
1171 information in the normal (i.e., master) @file{.newsrc} file.
1173 If the @file{.newsrc*} files have not been saved in the master when the
1174 slave starts, you may be prompted as to whether to read an auto-save
1175 file. If you answer ``yes'', the unsaved changes to the master will be
1176 incorporated into the slave. If you answer ``no'', the slave may see some
1177 messages as unread that have been read in the master.
1179 @node Fetching a Group
1180 @section Fetching a Group
1181 @cindex fetching a group
1183 @findex gnus-fetch-group
1184 It is sometimes convenient to be able to just say ``I want to read this
1185 group and I don't care whether Gnus has been started or not''. This is
1186 perhaps more useful for people who write code than for users, but the
1187 command @code{gnus-fetch-group} provides this functionality in any case.
1188 It takes the group name as a parameter.
1194 @cindex subscription
1196 @vindex gnus-check-new-newsgroups
1197 If you are satisfied that you really never want to see any new groups,
1198 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1199 also save you some time at startup. Even if this variable is
1200 @code{nil}, you can always subscribe to the new groups just by pressing
1201 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1202 is @code{ask-server} by default. If you set this variable to
1203 @code{always}, then Gnus will query the back ends for new groups even
1204 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1207 * Checking New Groups:: Determining what groups are new.
1208 * Subscription Methods:: What Gnus should do with new groups.
1209 * Filtering New Groups:: Making Gnus ignore certain new groups.
1213 @node Checking New Groups
1214 @subsection Checking New Groups
1216 Gnus normally determines whether a group is new or not by comparing the
1217 list of groups from the active file(s) with the lists of subscribed and
1218 dead groups. This isn't a particularly fast method. If
1219 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1220 server for new groups since the last time. This is both faster and
1221 cheaper. This also means that you can get rid of the list of killed
1222 groups altogether, so you may set @code{gnus-save-killed-list} to
1223 @code{nil}, which will save time both at startup, at exit, and all over.
1224 Saves disk space, too. Why isn't this the default, then?
1225 Unfortunately, not all servers support this command.
1227 I bet I know what you're thinking now: How do I find out whether my
1228 server supports @code{ask-server}? No? Good, because I don't have a
1229 fail-safe answer. I would suggest just setting this variable to
1230 @code{ask-server} and see whether any new groups appear within the next
1231 few days. If any do, then it works. If none do, then it doesn't
1232 work. I could write a function to make Gnus guess whether the server
1233 supports @code{ask-server}, but it would just be a guess. So I won't.
1234 You could @code{telnet} to the server and say @code{HELP} and see
1235 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1236 it does, then it might work. (But there are servers that lists
1237 @samp{NEWGROUPS} without supporting the function properly.)
1239 This variable can also be a list of select methods. If so, Gnus will
1240 issue an @code{ask-server} command to each of the select methods, and
1241 subscribe them (or not) using the normal methods. This might be handy
1242 if you are monitoring a few servers for new groups. A side effect is
1243 that startup will take much longer, so you can meditate while waiting.
1244 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1247 @node Subscription Methods
1248 @subsection Subscription Methods
1250 @vindex gnus-subscribe-newsgroup-method
1251 What Gnus does when it encounters a new group is determined by the
1252 @code{gnus-subscribe-newsgroup-method} variable.
1254 This variable should contain a function. This function will be called
1255 with the name of the new group as the only parameter.
1257 Some handy pre-fab functions are:
1261 @item gnus-subscribe-zombies
1262 @vindex gnus-subscribe-zombies
1263 Make all new groups zombies. This is the default. You can browse the
1264 zombies later (with @kbd{A z}) and either kill them all off properly
1265 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1267 @item gnus-subscribe-randomly
1268 @vindex gnus-subscribe-randomly
1269 Subscribe all new groups in arbitrary order. This really means that all
1270 new groups will be added at ``the top'' of the group buffer.
1272 @item gnus-subscribe-alphabetically
1273 @vindex gnus-subscribe-alphabetically
1274 Subscribe all new groups in alphabetical order.
1276 @item gnus-subscribe-hierarchically
1277 @vindex gnus-subscribe-hierarchically
1278 Subscribe all new groups hierarchically. The difference between this
1279 function and @code{gnus-subscribe-alphabetically} is slight.
1280 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1281 alphabetical fashion, while this function will enter groups into its
1282 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1283 @samp{comp} hierarchy, this function will not mess that configuration
1284 up. Or something like that.
1286 @item gnus-subscribe-interactively
1287 @vindex gnus-subscribe-interactively
1288 Subscribe new groups interactively. This means that Gnus will ask
1289 you about @strong{all} new groups. The groups you choose to subscribe
1290 to will be subscribed hierarchically.
1292 @item gnus-subscribe-killed
1293 @vindex gnus-subscribe-killed
1294 Kill all new groups.
1296 @item gnus-subscribe-topics
1297 @vindex gnus-subscribe-topics
1298 Put the groups into the topic that has a matching @code{subscribe} topic
1299 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1300 topic parameter that looks like
1306 will mean that all groups that match that regex will be subscribed under
1309 If no topics match the groups, the groups will be subscribed in the
1314 @vindex gnus-subscribe-hierarchical-interactive
1315 A closely related variable is
1316 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1317 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1318 hierarchical fashion whether to subscribe to new groups or not. Gnus
1319 will ask you for each sub-hierarchy whether you want to descend the
1322 One common mistake is to set the variable a few paragraphs above
1323 (@code{gnus-subscribe-newsgroup-method}) to
1324 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1325 will not work. This is ga-ga. So don't do it.
1328 @node Filtering New Groups
1329 @subsection Filtering New Groups
1331 A nice and portable way to control which new newsgroups should be
1332 subscribed (or ignored) is to put an @dfn{options} line at the start of
1333 the @file{.newsrc} file. Here's an example:
1336 options -n !alt.all !rec.all sci.all
1339 @vindex gnus-subscribe-options-newsgroup-method
1340 This line obviously belongs to a serious-minded intellectual scientific
1341 person (or she may just be plain old boring), because it says that all
1342 groups that have names beginning with @samp{alt} and @samp{rec} should
1343 be ignored, and all groups with names beginning with @samp{sci} should
1344 be subscribed. Gnus will not use the normal subscription method for
1345 subscribing these groups.
1346 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1347 variable defaults to @code{gnus-subscribe-alphabetically}.
1349 @vindex gnus-options-not-subscribe
1350 @vindex gnus-options-subscribe
1351 If you don't want to mess with your @file{.newsrc} file, you can just
1352 set the two variables @code{gnus-options-subscribe} and
1353 @code{gnus-options-not-subscribe}. These two variables do exactly the
1354 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1355 and if the new group matches the former, it will be unconditionally
1356 subscribed, and if it matches the latter, it will be ignored.
1358 @vindex gnus-auto-subscribed-groups
1359 Yet another variable that meddles here is
1360 @code{gnus-auto-subscribed-groups}. It works exactly like
1361 @code{gnus-options-subscribe}, and is therefore really superfluous,
1362 but I thought it would be nice to have two of these. This variable is
1363 more meant for setting some ground rules, while the other variable is
1364 used more for user fiddling. By default this variable makes all new
1365 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1366 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1367 subscribed. If you don't like that, just set this variable to
1370 New groups that match this regexp are subscribed using
1371 @code{gnus-subscribe-options-newsgroup-method}.
1374 @node Changing Servers
1375 @section Changing Servers
1376 @cindex changing servers
1378 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1379 This happens very rarely, but perhaps you change jobs, or one server is
1380 very flaky and you want to use another.
1382 Changing the server is pretty easy, right? You just change
1383 @code{gnus-select-method} to point to the new server?
1387 Article numbers are not (in any way) kept synchronized between different
1388 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1389 you have read is by keeping track of article numbers. So when you
1390 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1393 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1394 file from one server to another. They all have one thing in
1395 common---they take a looong time to run. You don't want to use these
1396 functions more than absolutely necessary.
1398 @kindex M-x gnus-change-server
1399 @findex gnus-change-server
1400 If you have access to both servers, Gnus can request the headers for all
1401 the articles you have read and compare @code{Message-ID}s and map the
1402 article numbers of the read articles and article marks. The @kbd{M-x
1403 gnus-change-server} command will do this for all your native groups. It
1404 will prompt for the method you want to move to.
1406 @kindex M-x gnus-group-move-group-to-server
1407 @findex gnus-group-move-group-to-server
1408 You can also move individual groups with the @kbd{M-x
1409 gnus-group-move-group-to-server} command. This is useful if you want to
1410 move a (foreign) group from one server to another.
1412 @kindex M-x gnus-group-clear-data-on-native-groups
1413 @findex gnus-group-clear-data-on-native-groups
1414 If you don't have access to both the old and new server, all your marks
1415 and read ranges have become worthless. You can use the @kbd{M-x
1416 gnus-group-clear-data-on-native-groups} command to clear out all data
1417 that you have on your native groups. Use with caution.
1419 @kindex M-x gnus-group-clear-data
1420 @findex gnus-group-clear-data
1421 Clear the data from the current group only---nix out marks and the
1422 list of read articles (@code{gnus-group-clear-data}).
1424 After changing servers, you @strong{must} move the cache hierarchy away,
1425 since the cached articles will have wrong article numbers, which will
1426 affect which articles Gnus thinks are read.
1427 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1428 to have it done automatically; for @code{gnus-group-clear-data}, you
1429 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1430 cache for all groups).
1434 @section Startup Files
1435 @cindex startup files
1440 Now, you all know about the @file{.newsrc} file. All subscription
1441 information is traditionally stored in this file.
1443 Things got a bit more complicated with @sc{gnus}. In addition to
1444 keeping the @file{.newsrc} file updated, it also used a file called
1445 @file{.newsrc.el} for storing all the information that didn't fit into
1446 the @file{.newsrc} file. (Actually, it also duplicated everything in
1447 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1448 files was the most recently saved, which enabled people to swap between
1449 @sc{gnus} and other newsreaders.
1451 That was kinda silly, so Gnus went one better: In addition to the
1452 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1453 @file{.newsrc.eld}. It will read whichever of these files that are most
1454 recent, but it will never write a @file{.newsrc.el} file. You should
1455 never delete the @file{.newsrc.eld} file---it contains much information
1456 not stored in the @file{.newsrc} file.
1458 @vindex gnus-save-newsrc-file
1459 @vindex gnus-read-newsrc-file
1460 You can turn off writing the @file{.newsrc} file by setting
1461 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1462 the file and save some space, as well as exiting from Gnus faster.
1463 However, this will make it impossible to use other newsreaders than
1464 Gnus. But hey, who would want to, right? Similarly, setting
1465 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1466 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1467 convenient if you have a tendency to use Netscape once in a while.
1469 @vindex gnus-save-killed-list
1470 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1471 will not save the list of killed groups to the startup file. This will
1472 save both time (when starting and quitting) and space (on disk). It
1473 will also mean that Gnus has no record of what groups are new or old,
1474 so the automatic new groups subscription methods become meaningless.
1475 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1476 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1477 Groups}). This variable can also be a regular expression. If that's
1478 the case, remove all groups that do not match this regexp before
1479 saving. This can be useful in certain obscure situations that involve
1480 several servers where not all servers support @code{ask-server}.
1482 @vindex gnus-startup-file
1483 @vindex gnus-backup-startup-file
1484 @vindex version-control
1485 The @code{gnus-startup-file} variable says where the startup files are.
1486 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1487 file being whatever that one is, with a @samp{.eld} appended.
1488 If you want version control for this file, set
1489 @code{gnus-backup-startup-file}. It respects the same values as the
1490 @code{version-control} variable.
1492 @vindex gnus-save-newsrc-hook
1493 @vindex gnus-save-quick-newsrc-hook
1494 @vindex gnus-save-standard-newsrc-hook
1495 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1496 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1497 saving the @file{.newsrc.eld} file, and
1498 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1499 @file{.newsrc} file. The latter two are commonly used to turn version
1500 control on or off. Version control is on by default when saving the
1501 startup files. If you want to turn backup creation off, say something like:
1504 (defun turn-off-backup ()
1505 (set (make-local-variable 'backup-inhibited) t))
1507 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1508 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1511 @vindex gnus-init-file
1512 @vindex gnus-site-init-file
1513 When Gnus starts, it will read the @code{gnus-site-init-file}
1514 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1515 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1516 and can be used to avoid cluttering your @file{~/.emacs} and
1517 @file{site-init} files with Gnus stuff. Gnus will also check for files
1518 with the same names as these, but with @file{.elc} and @file{.el}
1519 suffixes. In other words, if you have set @code{gnus-init-file} to
1520 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1521 and finally @file{~/.gnus} (in this order).
1527 @cindex dribble file
1530 Whenever you do something that changes the Gnus data (reading articles,
1531 catching up, killing/subscribing groups), the change is added to a
1532 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1533 Emacs way. If your Emacs should crash before you have saved the
1534 @file{.newsrc} files, all changes you have made can be recovered from
1537 If Gnus detects this file at startup, it will ask the user whether to
1538 read it. The auto save file is deleted whenever the real startup file is
1541 @vindex gnus-use-dribble-file
1542 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1543 maintain a dribble buffer. The default is @code{t}.
1545 @vindex gnus-dribble-directory
1546 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1547 this variable is @code{nil}, which it is by default, Gnus will dribble
1548 into the directory where the @file{.newsrc} file is located. (This is
1549 normally the user's home directory.) The dribble file will get the same
1550 file permissions as the @file{.newsrc} file.
1552 @vindex gnus-always-read-dribble-file
1553 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1554 read the dribble file on startup without querying the user.
1557 @node The Active File
1558 @section The Active File
1560 @cindex ignored groups
1562 When Gnus starts, or indeed whenever it tries to determine whether new
1563 articles have arrived, it reads the active file. This is a very large
1564 file that lists all the active groups and articles on the server.
1566 @vindex gnus-ignored-newsgroups
1567 Before examining the active file, Gnus deletes all lines that match the
1568 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1569 any groups with bogus names, but you can use this variable to make Gnus
1570 ignore hierarchies you aren't ever interested in. However, this is not
1571 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1572 Groups} for an overview of other variables that can be used instead.
1575 @c @code{nil} by default, and will slow down active file handling somewhat
1576 @c if you set it to anything else.
1578 @vindex gnus-read-active-file
1580 The active file can be rather Huge, so if you have a slow network, you
1581 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1582 reading the active file. This variable is @code{some} by default.
1584 Gnus will try to make do by getting information just on the groups that
1585 you actually subscribe to.
1587 Note that if you subscribe to lots and lots of groups, setting this
1588 variable to @code{nil} will probably make Gnus slower, not faster. At
1589 present, having this variable @code{nil} will slow Gnus down
1590 considerably, unless you read news over a 2400 baud modem.
1592 This variable can also have the value @code{some}. Gnus will then
1593 attempt to read active info only on the subscribed groups. On some
1594 servers this is quite fast (on sparkling, brand new INN servers that
1595 support the @code{LIST ACTIVE group} command), on others this isn't fast
1596 at all. In any case, @code{some} should be faster than @code{nil}, and
1597 is certainly faster than @code{t} over slow lines.
1599 Some news servers (old versions of Leafnode and old versions of INN, for
1600 instance) do not support the @code{LIST ACTIVE group}. For these
1601 servers, @code{nil} is probably the most efficient value for this
1604 If this variable is @code{nil}, Gnus will ask for group info in total
1605 lock-step, which isn't very fast. If it is @code{some} and you use an
1606 @acronym{NNTP} server, Gnus will pump out commands as fast as it can, and
1607 read all the replies in one swoop. This will normally result in better
1608 performance, but if the server does not support the aforementioned
1609 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1611 If you think that starting up Gnus takes too long, try all the three
1612 different values for this variable and see what works best for you.
1614 In any case, if you use @code{some} or @code{nil}, you should definitely
1615 kill all groups that you aren't interested in to speed things up.
1617 Note that this variable also affects active file retrieval from
1618 secondary select methods.
1621 @node Startup Variables
1622 @section Startup Variables
1626 @item gnus-load-hook
1627 @vindex gnus-load-hook
1628 A hook run while Gnus is being loaded. Note that this hook will
1629 normally be run just once in each Emacs session, no matter how many
1630 times you start Gnus.
1632 @item gnus-before-startup-hook
1633 @vindex gnus-before-startup-hook
1634 A hook run after starting up Gnus successfully.
1636 @item gnus-startup-hook
1637 @vindex gnus-startup-hook
1638 A hook run as the very last thing after starting up Gnus
1640 @item gnus-started-hook
1641 @vindex gnus-started-hook
1642 A hook that is run as the very last thing after starting up Gnus
1645 @item gnus-setup-news-hook
1646 @vindex gnus-setup-news-hook
1647 A hook that is run after reading the @file{.newsrc} file(s), but before
1648 generating the group buffer.
1650 @item gnus-check-bogus-newsgroups
1651 @vindex gnus-check-bogus-newsgroups
1652 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1653 startup. A @dfn{bogus group} is a group that you have in your
1654 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1655 bogus groups can take quite a while, so to save time and resources it's
1656 best to leave this option off, and do the checking for bogus groups once
1657 in a while from the group buffer instead (@pxref{Group Maintenance}).
1659 @item gnus-inhibit-startup-message
1660 @vindex gnus-inhibit-startup-message
1661 If non-@code{nil}, the startup message won't be displayed. That way,
1662 your boss might not notice as easily that you are reading news instead
1663 of doing your job. Note that this variable is used before
1664 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1666 @item gnus-no-groups-message
1667 @vindex gnus-no-groups-message
1668 Message displayed by Gnus when no groups are available.
1670 @item gnus-play-startup-jingle
1671 @vindex gnus-play-startup-jingle
1672 If non-@code{nil}, play the Gnus jingle at startup.
1674 @item gnus-startup-jingle
1675 @vindex gnus-startup-jingle
1676 Jingle to be played if the above variable is non-@code{nil}. The
1677 default is @samp{Tuxedomoon.Jingle4.au}.
1683 @chapter Group Buffer
1684 @cindex group buffer
1686 @c Alex Schroeder suggests to rearrange this as follows:
1688 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1689 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1690 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1691 @c 7. Group Score, 8. Group Buffer Format
1692 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1693 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1694 @c <kensanata> First, "Gnus considers groups... (default 9)."
1695 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1696 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1697 @c <kensanata> Then expand the next paragraph or add some more to it.
1698 @c This short one sentence explains levels 1 and 2, therefore I understand
1699 @c that I should keep important news at 3 and boring news at 4.
1700 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1701 @c Maybe keep those that you don't want to read temporarily at 6,
1702 @c those that you never want to read at 8, those that offend your
1703 @c human rights at 9...
1706 The @dfn{group buffer} lists all (or parts) of the available groups. It
1707 is the first buffer shown when Gnus starts, and will never be killed as
1708 long as Gnus is active.
1712 \gnusfigure{The Group Buffer}{320}{
1713 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1714 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1715 \put(120,38){\vector(1,2){10}}
1716 \put(40,60){\makebox(0,0)[r]{Mode line}}
1717 \put(40,58){\vector(1,0){30}}
1718 \put(200,28){\makebox(0,0)[t]{Native select method}}
1719 \put(200,26){\vector(-1,2){15}}
1725 * Group Buffer Format:: Information listed and how you can change it.
1726 * Group Maneuvering:: Commands for moving in the group buffer.
1727 * Selecting a Group:: Actually reading news.
1728 * Subscription Commands:: Unsubscribing, killing, subscribing.
1729 * Group Data:: Changing the info for a group.
1730 * Group Levels:: Levels? What are those, then?
1731 * Group Score:: A mechanism for finding out what groups you like.
1732 * Marking Groups:: You can mark groups for later processing.
1733 * Foreign Groups:: Creating and editing groups.
1734 * Group Parameters:: Each group may have different parameters set.
1735 * Listing Groups:: Gnus can list various subsets of the groups.
1736 * Sorting Groups:: Re-arrange the group order.
1737 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1738 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1739 * Exiting Gnus:: Stop reading news and get some work done.
1740 * Group Topics:: A folding group mode divided into topics.
1741 * Misc Group Stuff:: Other stuff that you can to do.
1745 @node Group Buffer Format
1746 @section Group Buffer Format
1749 * Group Line Specification:: Deciding how the group buffer is to look.
1750 * Group Mode Line Specification:: The group buffer mode line.
1751 * Group Highlighting:: Having nice colors in the group buffer.
1755 @node Group Line Specification
1756 @subsection Group Line Specification
1757 @cindex group buffer format
1759 The default format of the group buffer is nice and dull, but you can
1760 make it as exciting and ugly as you feel like.
1762 Here's a couple of example group lines:
1765 25: news.announce.newusers
1766 * 0: alt.fan.andrea-dworkin
1771 You can see that there are 25 unread articles in
1772 @samp{news.announce.newusers}. There are no unread articles, but some
1773 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1774 asterisk at the beginning of the line?).
1776 @vindex gnus-group-line-format
1777 You can change that format to whatever you want by fiddling with the
1778 @code{gnus-group-line-format} variable. This variable works along the
1779 lines of a @code{format} specification, which is pretty much the same as
1780 a @code{printf} specifications, for those of you who use (feh!) C.
1781 @xref{Formatting Variables}.
1783 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1785 There should always be a colon on the line; the cursor always moves to
1786 the colon after performing an operation. @xref{Positioning
1787 Point}. Nothing else is required---not even the group name. All
1788 displayed text is just window dressing, and is never examined by Gnus.
1789 Gnus stores all real information it needs using text properties.
1791 (Note that if you make a really strange, wonderful, spreadsheet-like
1792 layout, everybody will believe you are hard at work with the accounting
1793 instead of wasting time reading news.)
1795 Here's a list of all available format characters:
1800 An asterisk if the group only has marked articles.
1803 Whether the group is subscribed.
1806 Level of subscribedness.
1809 Number of unread articles.
1812 Number of dormant articles.
1815 Number of ticked articles.
1818 Number of read articles.
1821 Number of unseen articles.
1824 Estimated total number of articles. (This is really @var{max-number}
1825 minus @var{min-number} plus 1.)
1827 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1828 efficient access to @var{max-number} and @var{min-number} but getting
1829 the true unread message count is not possible efficiently. For
1830 hysterical raisins, even the mail back ends, where the true number of
1831 unread messages might be available efficiently, use the same limited
1832 interface. To remove this restriction from Gnus means that the back
1833 end interface has to be changed, which is not an easy job. If you
1834 want to work on this, please contact the Gnus mailing list.
1837 Number of unread, unticked, non-dormant articles.
1840 Number of ticked and dormant articles.
1849 Group comment (@pxref{Group Parameters}) or group name if there is no
1850 comment element in the group parameters.
1853 Newsgroup description. You need to read the group descriptions
1854 before these will appear, and to do that, you either have to set
1855 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1859 @samp{m} if moderated.
1862 @samp{(m)} if moderated.
1868 If the summary buffer for the group is open or not.
1874 A string that looks like @samp{<%s:%n>} if a foreign select method is
1878 Indentation based on the level of the topic (@pxref{Group Topics}).
1881 @vindex gnus-group-uncollapsed-levels
1882 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1883 variable says how many levels to leave at the end of the group name.
1884 The default is 1---this will mean that group names like
1885 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1888 @vindex gnus-new-mail-mark
1890 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1894 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1897 A string that says when you last read the group (@pxref{Group
1901 The disk space used by the articles fetched by both the cache and
1902 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1903 megabytes(M), or gigabytes(G) to minimize the column width. A format
1904 of %7F is sufficient for a fixed-width column.
1907 User defined specifier. The next character in the format string should
1908 be a letter. Gnus will call the function
1909 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1910 following @samp{%u}. The function will be passed a single dummy
1911 parameter as argument. The function should return a string, which will
1912 be inserted into the buffer just like information from any other
1917 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1918 if no info is available---for instance, if it is a non-activated foreign
1919 group, or a bogus native group.
1922 @node Group Mode Line Specification
1923 @subsection Group Mode Line Specification
1924 @cindex group mode line
1926 @vindex gnus-group-mode-line-format
1927 The mode line can be changed by setting
1928 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1929 doesn't understand that many format specifiers:
1933 The native news server.
1935 The native select method.
1939 @node Group Highlighting
1940 @subsection Group Highlighting
1941 @cindex highlighting
1942 @cindex group highlighting
1944 @vindex gnus-group-highlight
1945 Highlighting in the group buffer is controlled by the
1946 @code{gnus-group-highlight} variable. This is an alist with elements
1947 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1948 something non-@code{nil}, the @var{face} will be used on the line.
1950 Here's an example value for this variable that might look nice if the
1954 (cond (window-system
1955 (setq custom-background-mode 'light)
1956 (defface my-group-face-1
1957 '((t (:foreground "Red" :bold t))) "First group face")
1958 (defface my-group-face-2
1959 '((t (:foreground "DarkSeaGreen4" :bold t)))
1960 "Second group face")
1961 (defface my-group-face-3
1962 '((t (:foreground "Green4" :bold t))) "Third group face")
1963 (defface my-group-face-4
1964 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1965 (defface my-group-face-5
1966 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1968 (setq gnus-group-highlight
1969 '(((> unread 200) . my-group-face-1)
1970 ((and (< level 3) (zerop unread)) . my-group-face-2)
1971 ((< level 3) . my-group-face-3)
1972 ((zerop unread) . my-group-face-4)
1973 (t . my-group-face-5)))
1976 Also @pxref{Faces and Fonts}.
1978 Variables that are dynamically bound when the forms are evaluated
1985 The number of unread articles in the group.
1989 Whether the group is a mail group.
1991 The level of the group.
1993 The score of the group.
1995 The number of ticked articles in the group.
1997 The total number of articles in the group. Or rather,
1998 @var{max-number} minus @var{min-number} plus one.
2000 When using the topic minor mode, this variable is bound to the current
2001 topic being inserted.
2004 When the forms are @code{eval}ed, point is at the beginning of the line
2005 of the group in question, so you can use many of the normal Gnus
2006 functions for snarfing info on the group.
2008 @vindex gnus-group-update-hook
2009 @findex gnus-group-highlight-line
2010 @code{gnus-group-update-hook} is called when a group line is changed.
2011 It will not be called when @code{gnus-visual} is @code{nil}. This hook
2012 calls @code{gnus-group-highlight-line} by default.
2015 @node Group Maneuvering
2016 @section Group Maneuvering
2017 @cindex group movement
2019 All movement commands understand the numeric prefix and will behave as
2020 expected, hopefully.
2026 @findex gnus-group-next-unread-group
2027 Go to the next group that has unread articles
2028 (@code{gnus-group-next-unread-group}).
2034 @findex gnus-group-prev-unread-group
2035 Go to the previous group that has unread articles
2036 (@code{gnus-group-prev-unread-group}).
2040 @findex gnus-group-next-group
2041 Go to the next group (@code{gnus-group-next-group}).
2045 @findex gnus-group-prev-group
2046 Go to the previous group (@code{gnus-group-prev-group}).
2050 @findex gnus-group-next-unread-group-same-level
2051 Go to the next unread group on the same (or lower) level
2052 (@code{gnus-group-next-unread-group-same-level}).
2056 @findex gnus-group-prev-unread-group-same-level
2057 Go to the previous unread group on the same (or lower) level
2058 (@code{gnus-group-prev-unread-group-same-level}).
2061 Three commands for jumping to groups:
2067 @findex gnus-group-jump-to-group
2068 Jump to a group (and make it visible if it isn't already)
2069 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2074 @findex gnus-group-best-unread-group
2075 Jump to the unread group with the lowest level
2076 (@code{gnus-group-best-unread-group}).
2080 @findex gnus-group-first-unread-group
2081 Jump to the first group with unread articles
2082 (@code{gnus-group-first-unread-group}).
2085 @vindex gnus-group-goto-unread
2086 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2087 commands will move to the next group, not the next unread group. Even
2088 the commands that say they move to the next unread group. The default
2092 @node Selecting a Group
2093 @section Selecting a Group
2094 @cindex group selection
2099 @kindex SPACE (Group)
2100 @findex gnus-group-read-group
2101 Select the current group, switch to the summary buffer and display the
2102 first unread article (@code{gnus-group-read-group}). If there are no
2103 unread articles in the group, or if you give a non-numerical prefix to
2104 this command, Gnus will offer to fetch all the old articles in this
2105 group from the server. If you give a numerical prefix @var{n}, @var{n}
2106 determines the number of articles Gnus will fetch. If @var{n} is
2107 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2108 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2110 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2111 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2112 - 4 2 SPC} fetches the 42 oldest ones.
2114 When you are in the group (in the Summary buffer), you can type
2115 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2120 @findex gnus-group-select-group
2121 Select the current group and switch to the summary buffer
2122 (@code{gnus-group-select-group}). Takes the same arguments as
2123 @code{gnus-group-read-group}---the only difference is that this command
2124 does not display the first unread article automatically upon group
2128 @kindex M-RET (Group)
2129 @findex gnus-group-quick-select-group
2130 This does the same as the command above, but tries to do it with the
2131 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2132 scoring/killing will be performed, there will be no highlights and no
2133 expunging. This might be useful if you're in a real hurry and have to
2134 enter some humongous group. If you give a 0 prefix to this command
2135 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
2136 which is useful if you want to toggle threading before generating the
2137 summary buffer (@pxref{Summary Generation Commands}).
2140 @kindex M-SPACE (Group)
2141 @findex gnus-group-visible-select-group
2142 This is yet one more command that does the same as the @kbd{RET}
2143 command, but this one does it without expunging and hiding dormants
2144 (@code{gnus-group-visible-select-group}).
2147 @kindex C-M-RET (Group)
2148 @findex gnus-group-select-group-ephemerally
2149 Finally, this command selects the current group ephemerally without
2150 doing any processing of its contents
2151 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2152 turned off. Everything you do in the group after selecting it in this
2153 manner will have no permanent effects.
2157 @vindex gnus-large-newsgroup
2158 The @code{gnus-large-newsgroup} variable says what Gnus should
2159 consider to be a big group. If it is @code{nil}, no groups are
2160 considered big. The default value is 200. If the group has more
2161 (unread and/or ticked) articles than this, Gnus will query the user
2162 before entering the group. The user can then specify how many
2163 articles should be fetched from the server. If the user specifies a
2164 negative number (@var{-n}), the @var{n} oldest articles will be
2165 fetched. If it is positive, the @var{n} articles that have arrived
2166 most recently will be fetched.
2168 @vindex gnus-large-ephemeral-newsgroup
2169 @code{gnus-large-ephemeral-newsgroup} is the same as
2170 @code{gnus-large-newsgroup}, but is only used for ephemeral
2173 @vindex gnus-select-group-hook
2174 @vindex gnus-auto-select-first
2175 @vindex gnus-auto-select-subject
2176 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2177 automatically when entering a group with the @kbd{SPACE} command.
2178 Which article this is is controlled by the
2179 @code{gnus-auto-select-subject} variable. Valid values for this
2185 Place point on the subject line of the first unread article.
2188 Place point on the subject line of the first article.
2191 Place point on the subject line of the first unseen article.
2193 @item unseen-or-unread
2194 Place point on the subject line of the first unseen article, and if
2195 there is no such article, place point on the subject line of the first
2199 Place point on the subject line of the highest-scored unread article.
2203 This variable can also be a function. In that case, that function
2204 will be called to place point on a subject line.
2206 If you want to prevent automatic selection in some group (say, in a
2207 binary group with Huge articles) you can set the
2208 @code{gnus-auto-select-first} variable to @code{nil} in
2209 @code{gnus-select-group-hook}, which is called when a group is
2213 @node Subscription Commands
2214 @section Subscription Commands
2215 @cindex subscription
2223 @findex gnus-group-unsubscribe-current-group
2224 @c @icon{gnus-group-unsubscribe}
2225 Toggle subscription to the current group
2226 (@code{gnus-group-unsubscribe-current-group}).
2232 @findex gnus-group-unsubscribe-group
2233 Prompt for a group to subscribe, and then subscribe it. If it was
2234 subscribed already, unsubscribe it instead
2235 (@code{gnus-group-unsubscribe-group}).
2241 @findex gnus-group-kill-group
2242 @c @icon{gnus-group-kill-group}
2243 Kill the current group (@code{gnus-group-kill-group}).
2249 @findex gnus-group-yank-group
2250 Yank the last killed group (@code{gnus-group-yank-group}).
2253 @kindex C-x C-t (Group)
2254 @findex gnus-group-transpose-groups
2255 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2256 really a subscription command, but you can use it instead of a
2257 kill-and-yank sequence sometimes.
2263 @findex gnus-group-kill-region
2264 Kill all groups in the region (@code{gnus-group-kill-region}).
2268 @findex gnus-group-kill-all-zombies
2269 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2272 @kindex S C-k (Group)
2273 @findex gnus-group-kill-level
2274 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2275 These groups can't be yanked back after killing, so this command should
2276 be used with some caution. The only time where this command comes in
2277 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2278 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2279 kill off all unsubscribed groups that do not have message numbers in the
2280 @file{.newsrc} file.
2284 Also @pxref{Group Levels}.
2294 @findex gnus-group-catchup-current
2295 @vindex gnus-group-catchup-group-hook
2296 @c @icon{gnus-group-catchup-current}
2297 Mark all unticked articles in this group as read
2298 (@code{gnus-group-catchup-current}).
2299 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2304 @findex gnus-group-catchup-current-all
2305 Mark all articles in this group, even the ticked ones, as read
2306 (@code{gnus-group-catchup-current-all}).
2310 @findex gnus-group-clear-data
2311 Clear the data from the current group---nix out marks and the list of
2312 read articles (@code{gnus-group-clear-data}).
2314 @item M-x gnus-group-clear-data-on-native-groups
2315 @kindex M-x gnus-group-clear-data-on-native-groups
2316 @findex gnus-group-clear-data-on-native-groups
2317 If you have switched from one @acronym{NNTP} server to another, all your marks
2318 and read ranges have become worthless. You can use this command to
2319 clear out all data that you have on your native groups. Use with
2326 @section Group Levels
2330 All groups have a level of @dfn{subscribedness}. For instance, if a
2331 group is on level 2, it is more subscribed than a group on level 5. You
2332 can ask Gnus to just list groups on a given level or lower
2333 (@pxref{Listing Groups}), or to just check for new articles in groups on
2334 a given level or lower (@pxref{Scanning New Messages}).
2336 Remember: The higher the level of the group, the less important it is.
2342 @findex gnus-group-set-current-level
2343 Set the level of the current group. If a numeric prefix is given, the
2344 next @var{n} groups will have their levels set. The user will be
2345 prompted for a level.
2348 @vindex gnus-level-killed
2349 @vindex gnus-level-zombie
2350 @vindex gnus-level-unsubscribed
2351 @vindex gnus-level-subscribed
2352 Gnus considers groups from levels 1 to
2353 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2354 @code{gnus-level-subscribed} (exclusive) and
2355 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2356 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2357 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2358 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2359 same, but zombie and killed groups have no information on what articles
2360 you have read, etc, stored. This distinction between dead and living
2361 groups isn't done because it is nice or clever, it is done purely for
2362 reasons of efficiency.
2364 It is recommended that you keep all your mail groups (if any) on quite
2365 low levels (e.g. 1 or 2).
2367 Maybe the following description of the default behavior of Gnus helps to
2368 understand what these levels are all about. By default, Gnus shows you
2369 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2370 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2371 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2372 groups are hidden, in a way.
2374 Zombie and killed groups are similar to unsubscribed groups in that they
2375 are hidden by default. But they are different from subscribed and
2376 unsubscribed groups in that Gnus doesn't ask the news server for
2377 information (number of messages, number of unread messages) on zombie
2378 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2379 aren't interested in. If most groups are killed, Gnus is faster.
2381 Why does Gnus distinguish between zombie and killed groups? Well, when
2382 a new group arrives on the server, Gnus by default makes it a zombie
2383 group. This means that you are normally not bothered with new groups,
2384 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2385 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2386 list of killed groups.)
2388 If you want to play with the level variables, you should show some care.
2389 Set them once, and don't touch them ever again. Better yet, don't touch
2390 them at all unless you know exactly what you're doing.
2392 @vindex gnus-level-default-unsubscribed
2393 @vindex gnus-level-default-subscribed
2394 Two closely related variables are @code{gnus-level-default-subscribed}
2395 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2396 which are the levels that new groups will be put on if they are
2397 (un)subscribed. These two variables should, of course, be inside the
2398 relevant valid ranges.
2400 @vindex gnus-keep-same-level
2401 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2402 will only move to groups of the same level (or lower). In
2403 particular, going from the last article in one group to the next group
2404 will go to the next group of the same level (or lower). This might be
2405 handy if you want to read the most important groups before you read the
2408 If this variable is @code{best}, Gnus will make the next newsgroup the
2409 one with the best level.
2411 @vindex gnus-group-default-list-level
2412 All groups with a level less than or equal to
2413 @code{gnus-group-default-list-level} will be listed in the group buffer
2416 @vindex gnus-group-list-inactive-groups
2417 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2418 groups will be listed along with the unread groups. This variable is
2419 @code{t} by default. If it is @code{nil}, inactive groups won't be
2422 @vindex gnus-group-use-permanent-levels
2423 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2424 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2425 use this level as the ``work'' level.
2427 @vindex gnus-activate-level
2428 Gnus will normally just activate (i. e., query the server about) groups
2429 on level @code{gnus-activate-level} or less. If you don't want to
2430 activate unsubscribed groups, for instance, you might set this variable
2431 to 5. The default is 6.
2435 @section Group Score
2440 You would normally keep important groups on high levels, but that scheme
2441 is somewhat restrictive. Don't you wish you could have Gnus sort the
2442 group buffer according to how often you read groups, perhaps? Within
2445 This is what @dfn{group score} is for. You can have Gnus assign a score
2446 to each group through the mechanism described below. You can then sort
2447 the group buffer based on this score. Alternatively, you can sort on
2448 score and then level. (Taken together, the level and the score is
2449 called the @dfn{rank} of the group. A group that is on level 4 and has
2450 a score of 1 has a higher rank than a group on level 5 that has a score
2451 of 300. (The level is the most significant part and the score is the
2452 least significant part.))
2454 @findex gnus-summary-bubble-group
2455 If you want groups you read often to get higher scores than groups you
2456 read seldom you can add the @code{gnus-summary-bubble-group} function to
2457 the @code{gnus-summary-exit-hook} hook. This will result (after
2458 sorting) in a bubbling sort of action. If you want to see that in
2459 action after each summary exit, you can add
2460 @code{gnus-group-sort-groups-by-rank} or
2461 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2462 slow things down somewhat.
2465 @node Marking Groups
2466 @section Marking Groups
2467 @cindex marking groups
2469 If you want to perform some command on several groups, and they appear
2470 subsequently in the group buffer, you would normally just give a
2471 numerical prefix to the command. Most group commands will then do your
2472 bidding on those groups.
2474 However, if the groups are not in sequential order, you can still
2475 perform a command on several groups. You simply mark the groups first
2476 with the process mark and then execute the command.
2484 @findex gnus-group-mark-group
2485 Set the mark on the current group (@code{gnus-group-mark-group}).
2491 @findex gnus-group-unmark-group
2492 Remove the mark from the current group
2493 (@code{gnus-group-unmark-group}).
2497 @findex gnus-group-unmark-all-groups
2498 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2502 @findex gnus-group-mark-region
2503 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2507 @findex gnus-group-mark-buffer
2508 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2512 @findex gnus-group-mark-regexp
2513 Mark all groups that match some regular expression
2514 (@code{gnus-group-mark-regexp}).
2517 Also @pxref{Process/Prefix}.
2519 @findex gnus-group-universal-argument
2520 If you want to execute some command on all groups that have been marked
2521 with the process mark, you can use the @kbd{M-&}
2522 (@code{gnus-group-universal-argument}) command. It will prompt you for
2523 the command to be executed.
2526 @node Foreign Groups
2527 @section Foreign Groups
2528 @cindex foreign groups
2530 Below are some group mode commands for making and editing general foreign
2531 groups, as well as commands to ease the creation of a few
2532 special-purpose groups. All these commands insert the newly created
2533 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2540 @findex gnus-group-make-group
2541 @cindex making groups
2542 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2543 for a name, a method and possibly an @dfn{address}. For an easier way
2544 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2548 @findex gnus-group-read-ephemeral-group
2549 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2550 will prompt you for a name, a method and an @dfn{address}.
2554 @findex gnus-group-rename-group
2555 @cindex renaming groups
2556 Rename the current group to something else
2557 (@code{gnus-group-rename-group}). This is valid only on some
2558 groups---mail groups mostly. This command might very well be quite slow
2564 @findex gnus-group-customize
2565 Customize the group parameters (@code{gnus-group-customize}).
2569 @findex gnus-group-edit-group-method
2570 @cindex renaming groups
2571 Enter a buffer where you can edit the select method of the current
2572 group (@code{gnus-group-edit-group-method}).
2576 @findex gnus-group-edit-group-parameters
2577 Enter a buffer where you can edit the group parameters
2578 (@code{gnus-group-edit-group-parameters}).
2582 @findex gnus-group-edit-group
2583 Enter a buffer where you can edit the group info
2584 (@code{gnus-group-edit-group}).
2588 @findex gnus-group-make-directory-group
2590 Make a directory group (@pxref{Directory Groups}). You will be prompted
2591 for a directory name (@code{gnus-group-make-directory-group}).
2596 @findex gnus-group-make-help-group
2597 Make the Gnus help group (@code{gnus-group-make-help-group}).
2601 @cindex (ding) archive
2602 @cindex archive group
2603 @findex gnus-group-make-archive-group
2604 @vindex gnus-group-archive-directory
2605 @vindex gnus-group-recent-archive-directory
2606 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
2607 default a group pointing to the most recent articles will be created
2608 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2609 group will be created from @code{gnus-group-archive-directory}.
2613 @findex gnus-group-make-kiboze-group
2615 Make a kiboze group. You will be prompted for a name, for a regexp to
2616 match groups to be ``included'' in the kiboze group, and a series of
2617 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2618 @xref{Kibozed Groups}.
2622 @findex gnus-group-enter-directory
2624 Read an arbitrary directory as if it were a newsgroup with the
2625 @code{nneething} back end (@code{gnus-group-enter-directory}).
2626 @xref{Anything Groups}.
2630 @findex gnus-group-make-doc-group
2631 @cindex ClariNet Briefs
2633 Make a group based on some file or other
2634 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2635 command, you will be prompted for a file name and a file type.
2636 Currently supported types are @code{mbox}, @code{babyl},
2637 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2638 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2639 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2640 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2641 you run this command without a prefix, Gnus will guess at the file
2642 type. @xref{Document Groups}.
2646 @vindex gnus-useful-groups
2647 @findex gnus-group-make-useful-group
2648 Create one of the groups mentioned in @code{gnus-useful-groups}
2649 (@code{gnus-group-make-useful-group}).
2653 @findex gnus-group-make-web-group
2657 Make an ephemeral group based on a web search
2658 (@code{gnus-group-make-web-group}). If you give a prefix to this
2659 command, make a solid group instead. You will be prompted for the
2660 search engine type and the search string. Valid search engine types
2661 include @code{google}, @code{dejanews}, and @code{gmane}.
2662 @xref{Web Searches}.
2664 If you use the @code{google} search engine, you can limit the search
2665 to a particular group by using a match string like
2666 @samp{shaving group:alt.sysadmin.recovery}.
2670 @findex gnus-group-make-rss-group
2671 Make a group based on an @acronym{RSS} feed
2672 (@code{gnus-group-make-rss-group}). You will be prompted for an URL.
2676 @kindex G DEL (Group)
2677 @findex gnus-group-delete-group
2678 This function will delete the current group
2679 (@code{gnus-group-delete-group}). If given a prefix, this function will
2680 actually delete all the articles in the group, and forcibly remove the
2681 group itself from the face of the Earth. Use a prefix only if you are
2682 absolutely sure of what you are doing. This command can't be used on
2683 read-only groups (like @code{nntp} groups), though.
2687 @findex gnus-group-make-empty-virtual
2688 Make a new, fresh, empty @code{nnvirtual} group
2689 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2693 @findex gnus-group-add-to-virtual
2694 Add the current group to an @code{nnvirtual} group
2695 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2698 @xref{Select Methods}, for more information on the various select
2701 @vindex gnus-activate-foreign-newsgroups
2702 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2703 Gnus will check all foreign groups with this level or lower at startup.
2704 This might take quite a while, especially if you subscribe to lots of
2705 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2706 @code{gnus-activate-level} also affects activation of foreign
2710 @node Group Parameters
2711 @section Group Parameters
2712 @cindex group parameters
2714 The group parameters store information local to a particular group.
2715 Here's an example group parameter list:
2718 ((to-address . "ding@@gnus.org")
2722 We see that each element consists of a ``dotted pair''---the thing before
2723 the dot is the key, while the thing after the dot is the value. All the
2724 parameters have this form @emph{except} local variable specs, which are
2725 not dotted pairs, but proper lists.
2727 Some parameters have correspondent customizable variables, each of which
2728 is an alist of regexps and values.
2730 The following group parameters can be used:
2735 Address used by when doing followups and new posts.
2738 (to-address . "some@@where.com")
2741 This is primarily useful in mail groups that represent closed mailing
2742 lists---mailing lists where it's expected that everybody that writes to
2743 the mailing list is subscribed to it. Since using this parameter
2744 ensures that the mail only goes to the mailing list itself, it means
2745 that members won't receive two copies of your followups.
2747 Using @code{to-address} will actually work whether the group is foreign
2748 or not. Let's say there's a group on the server that is called
2749 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2750 the articles from a mail-to-news gateway. Posting directly to this
2751 group is therefore impossible---you have to send mail to the mailing
2752 list address instead.
2754 See also @code{gnus-parameter-to-address-alist}.
2758 Address used when doing @kbd{a} in that group.
2761 (to-list . "some@@where.com")
2764 It is totally ignored
2765 when doing a followup---except that if it is present in a news group,
2766 you'll get mail group semantics when doing @kbd{f}.
2768 If you do an @kbd{a} command in a mail group and you have neither a
2769 @code{to-list} group parameter nor a @code{to-address} group parameter,
2770 then a @code{to-list} group parameter will be added automatically upon
2771 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2772 @vindex gnus-add-to-list
2774 @findex gnus-mailing-list-mode
2775 @cindex mail list groups
2776 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2777 entering summary buffer.
2779 See also @code{gnus-parameter-to-list-alist}.
2784 @cindex Mail-Followup-To
2785 @findex gnus-find-subscribed-addresses
2786 If this parameter is set to @code{t}, Gnus will consider the
2787 to-address and to-list parameters for this group as addresses of
2788 mailing lists you are subscribed to. Giving Gnus this information is
2789 (only) a first step in getting it to generate correct Mail-Followup-To
2790 headers for your posts to these lists. The second step is to put the
2791 following in your @file{.gnus.el}
2794 (setq message-subscribed-address-functions
2795 '(gnus-find-subscribed-addresses))
2798 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2799 a complete treatment of available MFT support.
2803 If the group parameter list has the element @code{(visible . t)},
2804 that group will always be visible in the Group buffer, regardless
2805 of whether it has any unread articles.
2807 @item broken-reply-to
2808 @cindex broken-reply-to
2809 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2810 headers in this group are to be ignored, and for the header to be hidden
2811 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2812 can be useful if you're reading a mailing list group where the listserv
2813 has inserted @code{Reply-To} headers that point back to the listserv
2814 itself. That is broken behavior. So there!
2818 Elements like @code{(to-group . "some.group.name")} means that all
2819 posts in that group will be sent to @code{some.group.name}.
2823 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2824 will treat all responses as if they were responses to news articles.
2825 This can be useful if you have a mail group that's really a mirror of a
2830 If @code{(gcc-self . t)} is present in the group parameter list, newly
2831 composed messages will be @code{Gcc}'d to the current group. If
2832 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2833 generated, if @code{(gcc-self . "string")} is present, this string will
2834 be inserted literally as a @code{gcc} header. This parameter takes
2835 precedence over any default @code{Gcc} rules as described later
2836 (@pxref{Archived Messages}).
2838 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2839 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2840 doesn't accept articles.
2844 If the group parameter has an element that looks like @code{(auto-expire
2845 . t)}, all articles read will be marked as expirable. For an
2846 alternative approach, @pxref{Expiring Mail}.
2848 See also @code{gnus-auto-expirable-newsgroups}.
2851 @cindex total-expire
2852 If the group parameter has an element that looks like
2853 @code{(total-expire . t)}, all read articles will be put through the
2854 expiry process, even if they are not marked as expirable. Use with
2855 caution. Unread, ticked and dormant articles are not eligible for
2858 See also @code{gnus-total-expirable-newsgroups}.
2862 @vindex nnmail-expiry-wait-function
2863 If the group parameter has an element that looks like
2864 @code{(expiry-wait . 10)}, this value will override any
2865 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2866 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2867 can either be a number of days (not necessarily an integer) or the
2868 symbols @code{never} or @code{immediate}.
2871 @cindex expiry-target
2872 Where expired messages end up. This parameter overrides
2873 @code{nnmail-expiry-target}.
2876 @cindex score file group parameter
2877 Elements that look like @code{(score-file . "file")} will make
2878 @file{file} into the current score file for the group in question. All
2879 interactive score entries will be put into this file.
2882 @cindex adapt file group parameter
2883 Elements that look like @code{(adapt-file . "file")} will make
2884 @file{file} into the current adaptive file for the group in question.
2885 All adaptive score entries will be put into this file.
2888 @cindex admin-address
2889 When unsubscribing from a mailing list you should never send the
2890 unsubscription notice to the mailing list itself. Instead, you'd send
2891 messages to the administrative address. This parameter allows you to
2892 put the admin address somewhere convenient.
2896 Elements that look like @code{(display . MODE)} say which articles to
2897 display on entering the group. Valid values are:
2901 Display all articles, both read and unread.
2904 Display the last @var{integer} articles in the group. This is the same as
2905 entering the group with @kbd{C-u @var{integer}}.
2908 Display the default visible articles, which normally includes unread and
2912 Display articles that satisfy a predicate.
2914 Here are some examples:
2918 Display only unread articles.
2921 Display everything except expirable articles.
2923 @item [and (not reply) (not expire)]
2924 Display everything except expirable and articles you've already
2928 The available operators are @code{not}, @code{and} and @code{or}.
2929 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2930 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2931 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2932 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2936 The @code{display} parameter works by limiting the summary buffer to
2937 the subset specified. You can pop the limit by using the @kbd{/ w}
2938 command (@pxref{Limiting}).
2942 Elements that look like @code{(comment . "This is a comment")} are
2943 arbitrary comments on the group. You can display comments in the
2944 group line (@pxref{Group Line Specification}).
2948 Elements that look like @code{(charset . iso-8859-1)} will make
2949 @code{iso-8859-1} the default charset; that is, the charset that will be
2950 used for all articles that do not specify a charset.
2952 See also @code{gnus-group-charset-alist}.
2954 @item ignored-charsets
2955 @cindex ignored-charset
2956 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2957 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2958 default charset will be used for decoding articles.
2960 See also @code{gnus-group-ignored-charsets-alist}.
2963 @cindex posting-style
2964 You can store additional posting style information for this group
2965 here (@pxref{Posting Styles}). The format is that of an entry in the
2966 @code{gnus-posting-styles} alist, except that there's no regexp matching
2967 the group name (of course). Style elements in this group parameter will
2968 take precedence over the ones found in @code{gnus-posting-styles}.
2970 For instance, if you want a funky name and signature in this group only,
2971 instead of hacking @code{gnus-posting-styles}, you could put something
2972 like this in the group parameters:
2977 ("X-My-Header" "Funky Value")
2978 (signature "Funky Signature"))
2983 If it is set, the value is used as the method for posting message
2984 instead of @code{gnus-post-method}.
2988 An item like @code{(banner . @var{regexp})} causes any part of an article
2989 that matches the regular expression @var{regexp} to be stripped. Instead of
2990 @var{regexp}, you can also use the symbol @code{signature} which strips the
2991 last signature or any of the elements of the alist
2992 @code{gnus-article-banner-alist}.
2996 This parameter contains a Sieve test that should match incoming mail
2997 that should be placed in this group. From this group parameter, a
2998 Sieve @samp{IF} control structure is generated, having the test as the
2999 condition and @samp{fileinto "group.name";} as the body.
3001 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
3002 address "sender" "sieve-admin@@extundo.com")} group parameter, when
3003 translating the group parameter into a Sieve script (@pxref{Sieve
3004 Commands}) the following Sieve code is generated:
3007 if address \"sender\" \"sieve-admin@@extundo.com\" @{
3008 fileinto \"INBOX.list.sieve\";
3012 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3013 Top, sieve, Emacs Sieve}.
3015 @item (agent parameters)
3016 If the agent has been enabled, you can set any of the its parameters
3017 to control the behavior of the agent in individual groups. See Agent
3018 Parameters in @ref{Category Syntax}. Most users will choose to set
3019 agent parameters in either an agent category or group topic to
3020 minimize the configuration effort.
3022 @item (@var{variable} @var{form})
3023 You can use the group parameters to set variables local to the group you
3024 are entering. If you want to turn threading off in @samp{news.answers},
3025 you could put @code{(gnus-show-threads nil)} in the group parameters of
3026 that group. @code{gnus-show-threads} will be made into a local variable
3027 in the summary buffer you enter, and the form @code{nil} will be
3028 @code{eval}ed there.
3030 Note that this feature sets the variable locally to the summary buffer.
3031 But some variables are evaluated in the article buffer, or in the
3032 message buffer (of a reply or followup or otherwise newly created
3033 message). As a workaround, it might help to add the variable in
3034 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3035 Stuff}. So if you want to set @code{message-from-style} via the group
3036 parameters, then you may need the following statement elsewhere in your
3037 @file{~/.gnus} file:
3040 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3043 @vindex gnus-list-identifiers
3044 A use for this feature is to remove a mailing list identifier tag in
3045 the subject fields of articles. E.g. if the news group
3048 nntp+news.gnus.org:gmane.text.docbook.apps
3051 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3052 tag can be removed from the article subjects in the summary buffer for
3053 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3054 into the group parameters for the group.
3056 This can also be used as a group-specific hook function. If you want to
3057 hear a beep when you enter a group, you could put something like
3058 @code{(dummy-variable (ding))} in the parameters of that group.
3059 @code{dummy-variable} will be set to the (meaningless) result of the
3062 Alternatively, since the VARIABLE becomes local to the group, this
3063 pattern can be used to temporarily change a hook. For example, if the
3064 following is added to a group parameter
3067 (gnus-summary-prepared-hook
3068 '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3071 when the group is entered, the 'd' key will not mark the article as
3076 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3077 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3078 presents you with a Customize-like interface. The latter helps avoid
3079 silly Lisp errors.) You might also be interested in reading about topic
3080 parameters (@pxref{Topic Parameters}).
3082 @vindex gnus-parameters
3083 Group parameters can be set via the @code{gnus-parameters} variable too.
3084 But some variables, such as @code{visible}, have no effect. For
3088 (setq gnus-parameters
3090 (gnus-show-threads nil)
3091 (gnus-use-scoring nil)
3092 (gnus-summary-line-format
3093 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3097 ("^nnimap:\\(foo.bar\\)$"
3101 (gnus-use-scoring t))
3105 (broken-reply-to . t))))
3108 String value of parameters will be subjected to regexp substitution, as
3109 the @code{to-group} example shows.
3112 @node Listing Groups
3113 @section Listing Groups
3114 @cindex group listing
3116 These commands all list various slices of the groups available.
3124 @findex gnus-group-list-groups
3125 List all groups that have unread articles
3126 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3127 command will list only groups of level ARG and lower. By default, it
3128 only lists groups of level five (i.e.,
3129 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3136 @findex gnus-group-list-all-groups
3137 List all groups, whether they have unread articles or not
3138 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3139 this command will list only groups of level ARG and lower. By default,
3140 it lists groups of level seven or lower (i.e., just subscribed and
3141 unsubscribed groups).
3145 @findex gnus-group-list-level
3146 List all unread groups on a specific level
3147 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3148 with no unread articles.
3152 @findex gnus-group-list-killed
3153 List all killed groups (@code{gnus-group-list-killed}). If given a
3154 prefix argument, really list all groups that are available, but aren't
3155 currently (un)subscribed. This could entail reading the active file
3160 @findex gnus-group-list-zombies
3161 List all zombie groups (@code{gnus-group-list-zombies}).
3165 @findex gnus-group-list-matching
3166 List all unread, subscribed groups with names that match a regexp
3167 (@code{gnus-group-list-matching}).
3171 @findex gnus-group-list-all-matching
3172 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3176 @findex gnus-group-list-active
3177 List absolutely all groups in the active file(s) of the
3178 server(s) you are connected to (@code{gnus-group-list-active}). This
3179 might very well take quite a while. It might actually be a better idea
3180 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3181 thing to match on. Also note that this command may list groups that
3182 don't exist (yet)---these will be listed as if they were killed groups.
3183 Take the output with some grains of salt.
3187 @findex gnus-group-apropos
3188 List all groups that have names that match a regexp
3189 (@code{gnus-group-apropos}).
3193 @findex gnus-group-description-apropos
3194 List all groups that have names or descriptions that match a regexp
3195 (@code{gnus-group-description-apropos}).
3199 @findex gnus-group-list-cached
3200 List all groups with cached articles (@code{gnus-group-list-cached}).
3204 @findex gnus-group-list-dormant
3205 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3209 @findex gnus-group-list-limit
3210 List groups limited within the current selection
3211 (@code{gnus-group-list-limit}).
3215 @findex gnus-group-list-flush
3216 Flush groups from the current selection (@code{gnus-group-list-flush}).
3220 @findex gnus-group-list-plus
3221 List groups plus the current selection (@code{gnus-group-list-plus}).
3225 @vindex gnus-permanently-visible-groups
3226 @cindex visible group parameter
3227 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3228 always be shown, whether they have unread articles or not. You can also
3229 add the @code{visible} element to the group parameters in question to
3230 get the same effect.
3232 @vindex gnus-list-groups-with-ticked-articles
3233 Groups that have just ticked articles in it are normally listed in the
3234 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3235 @code{nil}, these groups will be treated just like totally empty
3236 groups. It is @code{t} by default.
3239 @node Sorting Groups
3240 @section Sorting Groups
3241 @cindex sorting groups
3243 @kindex C-c C-s (Group)
3244 @findex gnus-group-sort-groups
3245 @vindex gnus-group-sort-function
3246 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3247 group buffer according to the function(s) given by the
3248 @code{gnus-group-sort-function} variable. Available sorting functions
3253 @item gnus-group-sort-by-alphabet
3254 @findex gnus-group-sort-by-alphabet
3255 Sort the group names alphabetically. This is the default.
3257 @item gnus-group-sort-by-real-name
3258 @findex gnus-group-sort-by-real-name
3259 Sort the group alphabetically on the real (unprefixed) group names.
3261 @item gnus-group-sort-by-level
3262 @findex gnus-group-sort-by-level
3263 Sort by group level.
3265 @item gnus-group-sort-by-score
3266 @findex gnus-group-sort-by-score
3267 Sort by group score. @xref{Group Score}.
3269 @item gnus-group-sort-by-rank
3270 @findex gnus-group-sort-by-rank
3271 Sort by group score and then the group level. The level and the score
3272 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3274 @item gnus-group-sort-by-unread
3275 @findex gnus-group-sort-by-unread
3276 Sort by number of unread articles.
3278 @item gnus-group-sort-by-method
3279 @findex gnus-group-sort-by-method
3280 Sort alphabetically on the select method.
3282 @item gnus-group-sort-by-server
3283 @findex gnus-group-sort-by-server
3284 Sort alphabetically on the Gnus server name.
3289 @code{gnus-group-sort-function} can also be a list of sorting
3290 functions. In that case, the most significant sort key function must be
3294 There are also a number of commands for sorting directly according to
3295 some sorting criteria:
3299 @kindex G S a (Group)
3300 @findex gnus-group-sort-groups-by-alphabet
3301 Sort the group buffer alphabetically by group name
3302 (@code{gnus-group-sort-groups-by-alphabet}).
3305 @kindex G S u (Group)
3306 @findex gnus-group-sort-groups-by-unread
3307 Sort the group buffer by the number of unread articles
3308 (@code{gnus-group-sort-groups-by-unread}).
3311 @kindex G S l (Group)
3312 @findex gnus-group-sort-groups-by-level
3313 Sort the group buffer by group level
3314 (@code{gnus-group-sort-groups-by-level}).
3317 @kindex G S v (Group)
3318 @findex gnus-group-sort-groups-by-score
3319 Sort the group buffer by group score
3320 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3323 @kindex G S r (Group)
3324 @findex gnus-group-sort-groups-by-rank
3325 Sort the group buffer by group rank
3326 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3329 @kindex G S m (Group)
3330 @findex gnus-group-sort-groups-by-method
3331 Sort the group buffer alphabetically by back end name@*
3332 (@code{gnus-group-sort-groups-by-method}).
3335 @kindex G S n (Group)
3336 @findex gnus-group-sort-groups-by-real-name
3337 Sort the group buffer alphabetically by real (unprefixed) group name
3338 (@code{gnus-group-sort-groups-by-real-name}).
3342 All the commands below obey the process/prefix convention
3343 (@pxref{Process/Prefix}).
3345 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3346 commands will sort in reverse order.
3348 You can also sort a subset of the groups:
3352 @kindex G P a (Group)
3353 @findex gnus-group-sort-selected-groups-by-alphabet
3354 Sort the groups alphabetically by group name
3355 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3358 @kindex G P u (Group)
3359 @findex gnus-group-sort-selected-groups-by-unread
3360 Sort the groups by the number of unread articles
3361 (@code{gnus-group-sort-selected-groups-by-unread}).
3364 @kindex G P l (Group)
3365 @findex gnus-group-sort-selected-groups-by-level
3366 Sort the groups by group level
3367 (@code{gnus-group-sort-selected-groups-by-level}).
3370 @kindex G P v (Group)
3371 @findex gnus-group-sort-selected-groups-by-score
3372 Sort the groups by group score
3373 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3376 @kindex G P r (Group)
3377 @findex gnus-group-sort-selected-groups-by-rank
3378 Sort the groups by group rank
3379 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3382 @kindex G P m (Group)
3383 @findex gnus-group-sort-selected-groups-by-method
3384 Sort the groups alphabetically by back end name@*
3385 (@code{gnus-group-sort-selected-groups-by-method}).
3388 @kindex G P n (Group)
3389 @findex gnus-group-sort-selected-groups-by-real-name
3390 Sort the groups alphabetically by real (unprefixed) group name
3391 (@code{gnus-group-sort-selected-groups-by-real-name}).
3394 @kindex G P s (Group)
3395 @findex gnus-group-sort-selected-groups
3396 Sort the groups according to @code{gnus-group-sort-function}.
3400 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3404 @node Group Maintenance
3405 @section Group Maintenance
3406 @cindex bogus groups
3411 @findex gnus-group-check-bogus-groups
3412 Find bogus groups and delete them
3413 (@code{gnus-group-check-bogus-groups}).
3417 @findex gnus-group-find-new-groups
3418 Find new groups and process them (@code{gnus-group-find-new-groups}).
3419 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3420 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3421 to query the server for new groups, and subscribe the new groups as
3425 @kindex C-c C-x (Group)
3426 @findex gnus-group-expire-articles
3427 Run all expirable articles in the current group through the expiry
3428 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3429 all expirable articles in the group that have been around for a while.
3430 (@pxref{Expiring Mail}).
3433 @kindex C-c C-M-x (Group)
3434 @findex gnus-group-expire-all-groups
3435 Run all expirable articles in all groups through the expiry process
3436 (@code{gnus-group-expire-all-groups}).
3441 @node Browse Foreign Server
3442 @section Browse Foreign Server
3443 @cindex foreign servers
3444 @cindex browsing servers
3449 @findex gnus-group-browse-foreign-server
3450 You will be queried for a select method and a server name. Gnus will
3451 then attempt to contact this server and let you browse the groups there
3452 (@code{gnus-group-browse-foreign-server}).
3455 @findex gnus-browse-mode
3456 A new buffer with a list of available groups will appear. This buffer
3457 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3458 a lot) like a normal group buffer.
3460 Here's a list of keystrokes available in the browse mode:
3465 @findex gnus-group-next-group
3466 Go to the next group (@code{gnus-group-next-group}).
3470 @findex gnus-group-prev-group
3471 Go to the previous group (@code{gnus-group-prev-group}).
3474 @kindex SPACE (Browse)
3475 @findex gnus-browse-read-group
3476 Enter the current group and display the first article
3477 (@code{gnus-browse-read-group}).
3480 @kindex RET (Browse)
3481 @findex gnus-browse-select-group
3482 Enter the current group (@code{gnus-browse-select-group}).
3486 @findex gnus-browse-unsubscribe-current-group
3487 Unsubscribe to the current group, or, as will be the case here,
3488 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3494 @findex gnus-browse-exit
3495 Exit browse mode (@code{gnus-browse-exit}).
3499 @findex gnus-browse-describe-group
3500 Describe the current group (@code{gnus-browse-describe-group}).
3504 @findex gnus-browse-describe-briefly
3505 Describe browse mode briefly (well, there's not much to describe, is
3506 there) (@code{gnus-browse-describe-briefly}).
3511 @section Exiting Gnus
3512 @cindex exiting Gnus
3514 Yes, Gnus is ex(c)iting.
3519 @findex gnus-group-suspend
3520 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3521 but it kills all buffers except the Group buffer. I'm not sure why this
3522 is a gain, but then who am I to judge?
3526 @findex gnus-group-exit
3527 @c @icon{gnus-group-exit}
3528 Quit Gnus (@code{gnus-group-exit}).
3532 @findex gnus-group-quit
3533 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3534 The dribble file will be saved, though (@pxref{Auto Save}).
3537 @vindex gnus-exit-gnus-hook
3538 @vindex gnus-suspend-gnus-hook
3539 @vindex gnus-after-exiting-gnus-hook
3540 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3541 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3542 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3548 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3549 numbly heavy and herself fall into a hazy trance as the boy sitting
3550 behind her drew repeated lines with his pencil across the back of her
3556 @section Group Topics
3559 If you read lots and lots of groups, it might be convenient to group
3560 them hierarchically according to topics. You put your Emacs groups over
3561 here, your sex groups over there, and the rest (what, two groups or so?)
3562 you put in some misc section that you never bother with anyway. You can
3563 even group the Emacs sex groups as a sub-topic to either the Emacs
3564 groups or the sex groups---or both! Go wild!
3568 \gnusfigure{Group Topics}{400}{
3569 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3580 2: alt.religion.emacs
3583 0: comp.talk.emacs.recovery
3585 8: comp.binaries.fractals
3586 13: comp.sources.unix
3589 @findex gnus-topic-mode
3591 To get this @emph{fab} functionality you simply turn on (ooh!) the
3592 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3593 is a toggling command.)
3595 Go ahead, just try it. I'll still be here when you get back. La de
3596 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3597 Yes, and now press @kbd{l}. There. All your groups are now listed
3598 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3601 If you want this permanently enabled, you should add that minor mode to
3602 the hook for the group mode. Put the following line in your
3603 @file{~/.gnus.el} file:
3606 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3610 * Topic Commands:: Interactive E-Z commands.
3611 * Topic Variables:: How to customize the topics the Lisp Way.
3612 * Topic Sorting:: Sorting each topic individually.
3613 * Topic Topology:: A map of the world.
3614 * Topic Parameters:: Parameters that apply to all groups in a topic.
3618 @node Topic Commands
3619 @subsection Topic Commands
3620 @cindex topic commands
3622 When the topic minor mode is turned on, a new @kbd{T} submap will be
3623 available. In addition, a few of the standard keys change their
3624 definitions slightly.
3626 In general, the following kinds of operations are possible on topics.
3627 First of all, you want to create topics. Secondly, you want to put
3628 groups in topics and to move them around until you have an order you
3629 like. The third kind of operation is to show/hide parts of the whole
3630 shebang. You might want to hide a topic including its subtopics and
3631 groups, to get a better overview of the other groups.
3633 Here is a list of the basic keys that you might need to set up topics
3640 @findex gnus-topic-create-topic
3641 Prompt for a new topic name and create it
3642 (@code{gnus-topic-create-topic}).
3646 @kindex T TAB (Topic)
3648 @findex gnus-topic-indent
3649 ``Indent'' the current topic so that it becomes a sub-topic of the
3650 previous topic (@code{gnus-topic-indent}). If given a prefix,
3651 ``un-indent'' the topic instead.
3654 @kindex M-TAB (Topic)
3655 @findex gnus-topic-unindent
3656 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3657 parent of its current parent (@code{gnus-topic-unindent}).
3661 The following two keys can be used to move groups and topics around.
3662 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3663 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3664 kill and yank rather than cut and paste.
3670 @findex gnus-topic-kill-group
3671 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3672 topic will be removed along with the topic.
3676 @findex gnus-topic-yank-group
3677 Yank the previously killed group or topic
3678 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3681 So, to move a topic to the beginning of the list of topics, just hit
3682 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3683 move the cursor to the beginning of the buffer (just below the ``Gnus''
3684 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3685 paste. Like I said -- E-Z.
3687 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3688 you can move topics around as well as groups.
3692 After setting up the topics the way you like them, you might wish to
3693 hide a topic, or to show it again. That's why we have the following
3700 @findex gnus-topic-select-group
3702 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3703 When you perform this command on a group, you'll enter the group, as
3704 usual. When done on a topic line, the topic will be folded (if it was
3705 visible) or unfolded (if it was folded already). So it's basically a
3706 toggling command on topics. In addition, if you give a numerical
3707 prefix, group on that level (and lower) will be displayed.
3711 Now for a list of other commands, in no particular order.
3717 @findex gnus-topic-move-group
3718 Move the current group to some other topic
3719 (@code{gnus-topic-move-group}). This command uses the process/prefix
3720 convention (@pxref{Process/Prefix}).
3724 @findex gnus-topic-jump-to-topic
3725 Go to a topic (@code{gnus-topic-jump-to-topic}).
3729 @findex gnus-topic-copy-group
3730 Copy the current group to some other topic
3731 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3732 convention (@pxref{Process/Prefix}).
3736 @findex gnus-topic-hide-topic
3737 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3738 a prefix, hide the topic permanently.
3742 @findex gnus-topic-show-topic
3743 Show the current topic (@code{gnus-topic-show-topic}). If given
3744 a prefix, show the topic permanently.
3748 @findex gnus-topic-remove-group
3749 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3750 This command is mainly useful if you have the same group in several
3751 topics and wish to remove it from one of the topics. You may also
3752 remove a group from all topics, but in that case, Gnus will add it to
3753 the root topic the next time you start Gnus. In fact, all new groups
3754 (which, naturally, don't belong to any topic) will show up in the root
3757 This command uses the process/prefix convention
3758 (@pxref{Process/Prefix}).
3762 @findex gnus-topic-move-matching
3763 Move all groups that match some regular expression to a topic
3764 (@code{gnus-topic-move-matching}).
3768 @findex gnus-topic-copy-matching
3769 Copy all groups that match some regular expression to a topic
3770 (@code{gnus-topic-copy-matching}).
3774 @findex gnus-topic-toggle-display-empty-topics
3775 Toggle hiding empty topics
3776 (@code{gnus-topic-toggle-display-empty-topics}).
3780 @findex gnus-topic-mark-topic
3781 Mark all groups in the current topic with the process mark
3782 (@code{gnus-topic-mark-topic}). This command works recursively on
3783 sub-topics unless given a prefix.
3786 @kindex T M-# (Topic)
3787 @findex gnus-topic-unmark-topic
3788 Remove the process mark from all groups in the current topic
3789 (@code{gnus-topic-unmark-topic}). This command works recursively on
3790 sub-topics unless given a prefix.
3793 @kindex C-c C-x (Topic)
3794 @findex gnus-topic-expire-articles
3795 Run all expirable articles in the current group or topic through the
3796 expiry process (if any)
3797 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3801 @findex gnus-topic-rename
3802 Rename a topic (@code{gnus-topic-rename}).
3805 @kindex T DEL (Topic)
3806 @findex gnus-topic-delete
3807 Delete an empty topic (@code{gnus-topic-delete}).
3811 @findex gnus-topic-list-active
3812 List all groups that Gnus knows about in a topics-ified way
3813 (@code{gnus-topic-list-active}).
3816 @kindex T M-n (Topic)
3817 @findex gnus-topic-goto-next-topic
3818 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3821 @kindex T M-p (Topic)
3822 @findex gnus-topic-goto-previous-topic
3823 Go to the next topic (@code{gnus-topic-goto-previous-topic}).
3827 @findex gnus-topic-edit-parameters
3828 @cindex group parameters
3829 @cindex topic parameters
3831 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3832 @xref{Topic Parameters}.
3837 @node Topic Variables
3838 @subsection Topic Variables
3839 @cindex topic variables
3841 The previous section told you how to tell Gnus which topics to display.
3842 This section explains how to tell Gnus what to display about each topic.
3844 @vindex gnus-topic-line-format
3845 The topic lines themselves are created according to the
3846 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3859 Number of groups in the topic.
3861 Number of unread articles in the topic.
3863 Number of unread articles in the topic and all its subtopics.
3866 @vindex gnus-topic-indent-level
3867 Each sub-topic (and the groups in the sub-topics) will be indented with
3868 @code{gnus-topic-indent-level} times the topic level number of spaces.
3871 @vindex gnus-topic-mode-hook
3872 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3874 @vindex gnus-topic-display-empty-topics
3875 The @code{gnus-topic-display-empty-topics} says whether to display even
3876 topics that have no unread articles in them. The default is @code{t}.
3880 @subsection Topic Sorting
3881 @cindex topic sorting
3883 You can sort the groups in each topic individually with the following
3889 @kindex T S a (Topic)
3890 @findex gnus-topic-sort-groups-by-alphabet
3891 Sort the current topic alphabetically by group name
3892 (@code{gnus-topic-sort-groups-by-alphabet}).
3895 @kindex T S u (Topic)
3896 @findex gnus-topic-sort-groups-by-unread
3897 Sort the current topic by the number of unread articles
3898 (@code{gnus-topic-sort-groups-by-unread}).
3901 @kindex T S l (Topic)
3902 @findex gnus-topic-sort-groups-by-level
3903 Sort the current topic by group level
3904 (@code{gnus-topic-sort-groups-by-level}).
3907 @kindex T S v (Topic)
3908 @findex gnus-topic-sort-groups-by-score
3909 Sort the current topic by group score
3910 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3913 @kindex T S r (Topic)
3914 @findex gnus-topic-sort-groups-by-rank
3915 Sort the current topic by group rank
3916 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3919 @kindex T S m (Topic)
3920 @findex gnus-topic-sort-groups-by-method
3921 Sort the current topic alphabetically by back end name
3922 (@code{gnus-topic-sort-groups-by-method}).
3925 @kindex T S e (Topic)
3926 @findex gnus-topic-sort-groups-by-server
3927 Sort the current topic alphabetically by server name
3928 (@code{gnus-topic-sort-groups-by-server}).
3931 @kindex T S s (Topic)
3932 @findex gnus-topic-sort-groups
3933 Sort the current topic according to the function(s) given by the
3934 @code{gnus-group-sort-function} variable
3935 (@code{gnus-topic-sort-groups}).
3939 When given a prefix argument, all these commands will sort in reverse
3940 order. @xref{Sorting Groups}, for more information about group
3944 @node Topic Topology
3945 @subsection Topic Topology
3946 @cindex topic topology
3949 So, let's have a look at an example group buffer:
3956 2: alt.religion.emacs
3959 0: comp.talk.emacs.recovery
3961 8: comp.binaries.fractals
3962 13: comp.sources.unix
3966 So, here we have one top-level topic (@samp{Gnus}), two topics under
3967 that, and one sub-topic under one of the sub-topics. (There is always
3968 just one (1) top-level topic). This topology can be expressed as
3973 (("Emacs -- I wuw it!" visible)
3974 (("Naughty Emacs" visible)))
3978 @vindex gnus-topic-topology
3979 This is in fact how the variable @code{gnus-topic-topology} would look
3980 for the display above. That variable is saved in the @file{.newsrc.eld}
3981 file, and shouldn't be messed with manually---unless you really want
3982 to. Since this variable is read from the @file{.newsrc.eld} file,
3983 setting it in any other startup files will have no effect.
3985 This topology shows what topics are sub-topics of what topics (right),
3986 and which topics are visible. Two settings are currently
3987 allowed---@code{visible} and @code{invisible}.
3990 @node Topic Parameters
3991 @subsection Topic Parameters
3992 @cindex topic parameters
3994 All groups in a topic will inherit group parameters from the parent
3995 (and ancestor) topic parameters. All valid group parameters are valid
3996 topic parameters (@pxref{Group Parameters}). When the agent is
3997 enabled, all agent parameters (See Agent Parameters in @ref{Category
3998 Syntax}) are also valid topic parameters.
4000 In addition, the following parameters are only valid as topic
4005 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4006 @code{subscribe} topic parameter says what groups go in what topic. Its
4007 value should be a regexp to match the groups that should go in that
4010 @item subscribe-level
4011 When subscribing new groups by topic (see the @code{subscribe} parameter),
4012 the group will be subscribed with the level specified in the
4013 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4017 Group parameters (of course) override topic parameters, and topic
4018 parameters in sub-topics override topic parameters in super-topics. You
4019 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4020 verb, although you may feel free to disagree with me here.)
4027 2: alt.religion.emacs
4031 0: comp.talk.emacs.recovery
4033 8: comp.binaries.fractals
4034 13: comp.sources.unix
4039 The @samp{Emacs} topic has the topic parameter @code{(score-file
4040 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4041 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4042 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4043 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4044 . "religion.SCORE")}.
4046 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4047 will get the @file{relief.SCORE} home score file. If you enter the same
4048 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4049 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4050 get the @file{religion.SCORE} home score file.
4052 This seems rather simple and self-evident, doesn't it? Well, yes. But
4053 there are some problems, especially with the @code{total-expiry}
4054 parameter. Say you have a mail group in two topics; one with
4055 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4056 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4057 of these topics you mean to expire articles from, so anything may
4058 happen. In fact, I hereby declare that it is @dfn{undefined} what
4059 happens. You just have to be careful if you do stuff like that.
4062 @node Misc Group Stuff
4063 @section Misc Group Stuff
4066 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4067 * Group Information:: Information and help on groups and Gnus.
4068 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4069 * File Commands:: Reading and writing the Gnus files.
4070 * Sieve Commands:: Managing Sieve scripts.
4077 @findex gnus-group-enter-server-mode
4078 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4079 @xref{Server Buffer}.
4083 @findex gnus-group-post-news
4084 Start composing a message (a news by default)
4085 (@code{gnus-group-post-news}). If given a prefix, post to the group
4086 under the point. If the prefix is 1, prompt for a group to post to.
4087 Contrary to what the name of this function suggests, the prepared
4088 article might be a mail instead of a news, if a mail group is specified
4089 with the prefix argument. @xref{Composing Messages}.
4093 @findex gnus-group-mail
4094 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4095 use the posting style of the group under the point. If the prefix is 1,
4096 prompt for a group name to find the posting style.
4097 @xref{Composing Messages}.
4101 @findex gnus-group-news
4102 Start composing a news (@code{gnus-group-news}). If given a prefix,
4103 post to the group under the point. If the prefix is 1, prompt
4104 for group to post to. @xref{Composing Messages}.
4106 This function actually prepares a news even when using mail groups.
4107 This is useful for ``posting'' messages to mail groups without actually
4108 sending them over the network: they're just saved directly to the group
4109 in question. The corresponding back end must have a request-post method
4110 for this to work though.
4114 Variables for the group buffer:
4118 @item gnus-group-mode-hook
4119 @vindex gnus-group-mode-hook
4120 is called after the group buffer has been
4123 @item gnus-group-prepare-hook
4124 @vindex gnus-group-prepare-hook
4125 is called after the group buffer is
4126 generated. It may be used to modify the buffer in some strange,
4129 @item gnus-group-prepared-hook
4130 @vindex gnus-group-prepare-hook
4131 is called as the very last thing after the group buffer has been
4132 generated. It may be used to move point around, for instance.
4134 @item gnus-permanently-visible-groups
4135 @vindex gnus-permanently-visible-groups
4136 Groups matching this regexp will always be listed in the group buffer,
4137 whether they are empty or not.
4139 @item gnus-group-name-charset-method-alist
4140 @vindex gnus-group-name-charset-method-alist
4141 An alist of method and the charset for group names. It is used to show
4142 non-@acronym{ASCII} group names.
4146 (setq gnus-group-name-charset-method-alist
4147 '(((nntp "news.com.cn") . cn-gb-2312)))
4150 @item gnus-group-name-charset-group-alist
4151 @cindex UTF-8 group names
4152 @vindex gnus-group-name-charset-group-alist
4153 An alist of regexp of group name and the charset for group names. It
4154 is used to show non-@acronym{ASCII} group names. @code{((".*"
4155 utf-8))} is the default value if UTF-8 is supported, otherwise the
4156 default is @code{nil}.
4160 (setq gnus-group-name-charset-group-alist
4161 '(("\\.com\\.cn:" . cn-gb-2312)))
4166 @node Scanning New Messages
4167 @subsection Scanning New Messages
4168 @cindex new messages
4169 @cindex scanning new news
4175 @findex gnus-group-get-new-news
4176 @c @icon{gnus-group-get-new-news}
4177 Check the server(s) for new articles. If the numerical prefix is used,
4178 this command will check only groups of level @var{arg} and lower
4179 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4180 command will force a total re-reading of the active file(s) from the
4185 @findex gnus-group-get-new-news-this-group
4186 @vindex gnus-goto-next-group-when-activating
4187 @c @icon{gnus-group-get-new-news-this-group}
4188 Check whether new articles have arrived in the current group
4189 (@code{gnus-group-get-new-news-this-group}).
4190 @code{gnus-goto-next-group-when-activating} says whether this command is
4191 to move point to the next group or not. It is @code{t} by default.
4193 @findex gnus-activate-all-groups
4194 @cindex activating groups
4196 @kindex C-c M-g (Group)
4197 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4202 @findex gnus-group-restart
4203 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4204 file(s), closes the connection to all servers, clears up all run-time
4205 Gnus variables, and then starts Gnus all over again.
4209 @vindex gnus-get-new-news-hook
4210 @code{gnus-get-new-news-hook} is run just before checking for new news.
4212 @vindex gnus-after-getting-new-news-hook
4213 @code{gnus-after-getting-new-news-hook} is run after checking for new
4217 @node Group Information
4218 @subsection Group Information
4219 @cindex group information
4220 @cindex information on groups
4227 @findex gnus-group-fetch-faq
4228 @vindex gnus-group-faq-directory
4231 Try to fetch the @acronym{FAQ} for the current group
4232 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4233 from @code{gnus-group-faq-directory}, which is usually a directory on
4234 a remote machine. This variable can also be a list of directories.
4235 In that case, giving a prefix to this command will allow you to choose
4236 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4237 used for fetching the file.
4239 If fetching from the first site is unsuccessful, Gnus will attempt to go
4240 through @code{gnus-group-faq-directory} and try to open them one by one.
4244 @findex gnus-group-fetch-charter
4245 @vindex gnus-group-charter-alist
4247 Try to open the charter for the current group in a web browser
4248 (@code{gnus-group-fetch-charter}). Query for a group if given a
4251 Gnus will use @code{gnus-group-charter-alist} to find the location of
4252 the charter. If no location is known, Gnus will fetch the control
4253 messages for the group, which in some cases includes the charter.
4257 @findex gnus-group-fetch-control
4258 @vindex gnus-group-fetch-control-use-browse-url
4259 @cindex control message
4260 Fetch the control messages for the group from the archive at
4261 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4262 group if given a prefix argument.
4264 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4265 Gnus will open the control messages in a browser using
4266 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4267 and displayed in an ephemeral group.
4269 Note that the control messages are compressed. To use this command
4270 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4271 Files, ,Compressed Files, emacs, The Emacs Manual}).
4275 @c @icon{gnus-group-describe-group}
4277 @kindex C-c C-d (Group)
4278 @cindex describing groups
4279 @cindex group description
4280 @findex gnus-group-describe-group
4281 Describe the current group (@code{gnus-group-describe-group}). If given
4282 a prefix, force Gnus to re-read the description from the server.
4286 @findex gnus-group-describe-all-groups
4287 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4288 prefix, force Gnus to re-read the description file from the server.
4295 @findex gnus-version
4296 Display current Gnus version numbers (@code{gnus-version}).
4300 @findex gnus-group-describe-briefly
4301 Give a very short help message (@code{gnus-group-describe-briefly}).
4304 @kindex C-c C-i (Group)
4307 @findex gnus-info-find-node
4308 Go to the Gnus info node (@code{gnus-info-find-node}).
4312 @node Group Timestamp
4313 @subsection Group Timestamp
4315 @cindex group timestamps
4317 It can be convenient to let Gnus keep track of when you last read a
4318 group. To set the ball rolling, you should add
4319 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4322 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4325 After doing this, each time you enter a group, it'll be recorded.
4327 This information can be displayed in various ways---the easiest is to
4328 use the @samp{%d} spec in the group line format:
4331 (setq gnus-group-line-format
4332 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4335 This will result in lines looking like:
4338 * 0: mail.ding 19961002T012943
4339 0: custom 19961002T012713
4342 As you can see, the date is displayed in compact ISO 8601 format. This
4343 may be a bit too much, so to just display the date, you could say
4347 (setq gnus-group-line-format
4348 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4351 If you would like greater control of the time format, you can use a
4352 user-defined format spec. Something like the following should do the
4356 (setq gnus-group-line-format
4357 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4358 (defun gnus-user-format-function-d (headers)
4359 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4361 (format-time-string "%b %d %H:%M" time)
4367 @subsection File Commands
4368 @cindex file commands
4374 @findex gnus-group-read-init-file
4375 @vindex gnus-init-file
4376 @cindex reading init file
4377 Re-read the init file (@code{gnus-init-file}, which defaults to
4378 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4382 @findex gnus-group-save-newsrc
4383 @cindex saving .newsrc
4384 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4385 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4386 file(s) whether Gnus thinks it is necessary or not.
4389 @c @kindex Z (Group)
4390 @c @findex gnus-group-clear-dribble
4391 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4396 @node Sieve Commands
4397 @subsection Sieve Commands
4398 @cindex group sieve commands
4400 Sieve is a server-side mail filtering language. In Gnus you can use
4401 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4402 sieve rules that should apply to each group. Gnus provides two
4403 commands to translate all these group parameters into a proper Sieve
4404 script that can be transfered to the server somehow.
4406 @vindex gnus-sieve-file
4407 @vindex gnus-sieve-region-start
4408 @vindex gnus-sieve-region-end
4409 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4410 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4411 between two delimiters, @code{gnus-sieve-region-start} and
4412 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4413 outside these delimiters that will not be removed the next time you
4414 regenerate the Sieve script.
4416 @vindex gnus-sieve-crosspost
4417 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4418 is generated. If it is non-@code{nil} (the default) articles is
4419 placed in all groups that have matching rules, otherwise the article
4420 is only placed in the group with the first matching rule. For
4421 example, the group parameter @samp{(sieve address "sender"
4422 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4423 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4424 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4425 except that the line containing the call to @code{stop} is removed.)
4428 if address "sender" "owner-ding@@hpc.uh.edu" @{
4429 fileinto "INBOX.ding";
4434 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4440 @findex gnus-sieve-generate
4441 @vindex gnus-sieve-file
4442 @cindex generating sieve script
4443 Regenerate a Sieve script from the @code{sieve} group parameters and
4444 put you into the @code{gnus-sieve-file} without saving it.
4448 @findex gnus-sieve-update
4449 @vindex gnus-sieve-file
4450 @cindex updating sieve script
4451 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4452 @code{sieve} group parameters, save the file and upload it to the
4453 server using the @code{sieveshell} program.
4458 @node Summary Buffer
4459 @chapter Summary Buffer
4460 @cindex summary buffer
4462 A line for each article is displayed in the summary buffer. You can
4463 move around, read articles, post articles and reply to articles.
4465 The most common way to a summary buffer is to select a group from the
4466 group buffer (@pxref{Selecting a Group}).
4468 You can have as many summary buffers open as you wish.
4471 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4472 * Summary Maneuvering:: Moving around the summary buffer.
4473 * Choosing Articles:: Reading articles.
4474 * Paging the Article:: Scrolling the current article.
4475 * Reply Followup and Post:: Posting articles.
4476 * Delayed Articles:: Send articles at a later time.
4477 * Marking Articles:: Marking articles as read, expirable, etc.
4478 * Limiting:: You can limit the summary buffer.
4479 * Threading:: How threads are made.
4480 * Sorting the Summary Buffer:: How articles and threads are sorted.
4481 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4482 * Article Caching:: You may store articles in a cache.
4483 * Persistent Articles:: Making articles expiry-resistant.
4484 * Article Backlog:: Having already read articles hang around.
4485 * Saving Articles:: Ways of customizing article saving.
4486 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4487 * Article Treatment:: The article buffer can be mangled at will.
4488 * MIME Commands:: Doing MIMEy things with the articles.
4489 * Charsets:: Character set issues.
4490 * Article Commands:: Doing various things with the article buffer.
4491 * Summary Sorting:: Sorting the summary buffer in various ways.
4492 * Finding the Parent:: No child support? Get the parent.
4493 * Alternative Approaches:: Reading using non-default summaries.
4494 * Tree Display:: A more visual display of threads.
4495 * Mail Group Commands:: Some commands can only be used in mail groups.
4496 * Various Summary Stuff:: What didn't fit anywhere else.
4497 * Exiting the Summary Buffer:: Returning to the Group buffer,
4498 or reselecting the current group.
4499 * Crosspost Handling:: How crossposted articles are dealt with.
4500 * Duplicate Suppression:: An alternative when crosspost handling fails.
4501 * Security:: Decrypt and Verify.
4502 * Mailing List:: Mailing list minor mode.
4506 @node Summary Buffer Format
4507 @section Summary Buffer Format
4508 @cindex summary buffer format
4512 \gnusfigure{The Summary Buffer}{180}{
4513 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4514 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4520 * Summary Buffer Lines:: You can specify how summary lines should look.
4521 * To From Newsgroups:: How to not display your own name.
4522 * Summary Buffer Mode Line:: You can say how the mode line should look.
4523 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4526 @findex mail-extract-address-components
4527 @findex gnus-extract-address-components
4528 @vindex gnus-extract-address-components
4529 Gnus will use the value of the @code{gnus-extract-address-components}
4530 variable as a function for getting the name and address parts of a
4531 @code{From} header. Two pre-defined functions exist:
4532 @code{gnus-extract-address-components}, which is the default, quite
4533 fast, and too simplistic solution; and
4534 @code{mail-extract-address-components}, which works very nicely, but is
4535 slower. The default function will return the wrong answer in 5% of the
4536 cases. If this is unacceptable to you, use the other function instead:
4539 (setq gnus-extract-address-components
4540 'mail-extract-address-components)
4543 @vindex gnus-summary-same-subject
4544 @code{gnus-summary-same-subject} is a string indicating that the current
4545 article has the same subject as the previous. This string will be used
4546 with those specs that require it. The default is @code{""}.
4549 @node Summary Buffer Lines
4550 @subsection Summary Buffer Lines
4552 @vindex gnus-summary-line-format
4553 You can change the format of the lines in the summary buffer by changing
4554 the @code{gnus-summary-line-format} variable. It works along the same
4555 lines as a normal @code{format} string, with some extensions
4556 (@pxref{Formatting Variables}).
4558 There should always be a colon or a point position marker on the line;
4559 the cursor always moves to the point position marker or the colon after
4560 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4561 possible to change this. Just write a new function
4562 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4563 @xref{Positioning Point}.
4565 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4567 The following format specification characters and extended format
4568 specification(s) are understood:
4574 Subject string. List identifiers stripped,
4575 @code{gnus-list-identifies}. @xref{Article Hiding}.
4577 Subject if the article is the root of the thread or the previous article
4578 had a different subject, @code{gnus-summary-same-subject} otherwise.
4579 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4581 Full @code{From} header.
4583 The name (from the @code{From} header).
4585 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4588 The name (from the @code{From} header). This differs from the @code{n}
4589 spec in that it uses the function designated by the
4590 @code{gnus-extract-address-components} variable, which is slower, but
4591 may be more thorough.
4593 The address (from the @code{From} header). This works the same way as
4596 Number of lines in the article.
4598 Number of characters in the article. This specifier is not supported
4599 in some methods (like nnfolder).
4601 Pretty-printed version of the number of characters in the article;
4602 for example, @samp{1.2k} or @samp{0.4M}.
4604 Indentation based on thread level (@pxref{Customizing Threading}).
4606 A complex trn-style thread tree, showing response-connecting trace
4607 lines. A thread could be drawn like this:
4620 You can customize the appearance with the following options. Note
4621 that it is possible to make the thread display look really neat by
4622 replacing the default @acronym{ASCII} characters with graphic
4623 line-drawing glyphs.
4625 @item gnus-sum-thread-tree-root
4626 @vindex gnus-sum-thread-tree-root
4627 Used for the root of a thread. If @code{nil}, use subject
4628 instead. The default is @samp{> }.
4630 @item gnus-sum-thread-tree-false-root
4631 @vindex gnus-sum-thread-tree-false-root
4632 Used for the false root of a thread (@pxref{Loose Threads}). If
4633 @code{nil}, use subject instead. The default is @samp{> }.
4635 @item gnus-sum-thread-tree-single-indent
4636 @vindex gnus-sum-thread-tree-single-indent
4637 Used for a thread with just one message. If @code{nil}, use subject
4638 instead. The default is @samp{}.
4640 @item gnus-sum-thread-tree-vertical
4641 @vindex gnus-sum-thread-tree-vertical
4642 Used for drawing a vertical line. The default is @samp{| }.
4644 @item gnus-sum-thread-tree-indent
4645 @vindex gnus-sum-thread-tree-indent
4646 Used for indenting. The default is @samp{ }.
4648 @item gnus-sum-thread-tree-leaf-with-other
4649 @vindex gnus-sum-thread-tree-leaf-with-other
4650 Used for a leaf with brothers. The default is @samp{+-> }.
4652 @item gnus-sum-thread-tree-single-leaf
4653 @vindex gnus-sum-thread-tree-single-leaf
4654 Used for a leaf without brothers. The default is @samp{\-> }
4659 Nothing if the article is a root and lots of spaces if it isn't (it
4660 pushes everything after it off the screen).
4662 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4663 for adopted articles (@pxref{Customizing Threading}).
4665 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4666 for adopted articles.
4668 One space for each thread level.
4670 Twenty minus thread level spaces.
4672 Unread. @xref{Read Articles}.
4675 This misleadingly named specifier is the @dfn{secondary mark}. This
4676 mark will say whether the article has been replied to, has been cached,
4677 or has been saved. @xref{Other Marks}.
4680 Score as a number (@pxref{Scoring}).
4682 @vindex gnus-summary-zcore-fuzz
4683 Zcore, @samp{+} if above the default level and @samp{-} if below the
4684 default level. If the difference between
4685 @code{gnus-summary-default-score} and the score is less than
4686 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4694 The @code{Date} in @code{DD-MMM} format.
4696 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4702 Number of articles in the current sub-thread. Using this spec will slow
4703 down summary buffer generation somewhat.
4705 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4706 article has any children.
4712 Age sensitive date format. Various date format is defined in
4713 @code{gnus-user-date-format-alist}.
4715 User defined specifier. The next character in the format string should
4716 be a letter. Gnus will call the function
4717 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4718 following @samp{%u}. The function will be passed the current header as
4719 argument. The function should return a string, which will be inserted
4720 into the summary just like information from any other summary specifier.
4723 Text between @samp{%(} and @samp{%)} will be highlighted with
4724 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4725 There can only be one such area.
4727 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4728 have to be handled with care. For reasons of efficiency, Gnus will
4729 compute what column these characters will end up in, and ``hard-code''
4730 that. This means that it is invalid to have these specs after a
4731 variable-length spec. Well, you might not be arrested, but your summary
4732 buffer will look strange, which is bad enough.
4734 The smart choice is to have these specs as far to the left as possible.
4735 (Isn't that the case with everything, though? But I digress.)
4737 This restriction may disappear in later versions of Gnus.
4740 @node To From Newsgroups
4741 @subsection To From Newsgroups
4745 In some groups (particularly in archive groups), the @code{From} header
4746 isn't very interesting, since all the articles there are written by
4747 you. To display the information in the @code{To} or @code{Newsgroups}
4748 headers instead, you need to decide three things: What information to
4749 gather; where to display it; and when to display it.
4753 @vindex gnus-extra-headers
4754 The reading of extra header information is controlled by the
4755 @code{gnus-extra-headers}. This is a list of header symbols. For
4759 (setq gnus-extra-headers
4760 '(To Newsgroups X-Newsreader))
4763 This will result in Gnus trying to obtain these three headers, and
4764 storing it in header structures for later easy retrieval.
4767 @findex gnus-extra-header
4768 The value of these extra headers can be accessed via the
4769 @code{gnus-extra-header} function. Here's a format line spec that will
4770 access the @code{X-Newsreader} header:
4773 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4777 @vindex gnus-ignored-from-addresses
4778 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4779 summary line spec returns the @code{To}, @code{Newsreader} or
4780 @code{From} header. If this regexp matches the contents of the
4781 @code{From} header, the value of the @code{To} or @code{Newsreader}
4782 headers are used instead.
4786 @vindex nnmail-extra-headers
4787 A related variable is @code{nnmail-extra-headers}, which controls when
4788 to include extra headers when generating overview (@acronym{NOV}) files.
4789 If you have old overview files, you should regenerate them after
4790 changing this variable, by entering the server buffer using @kbd{^},
4791 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
4794 @vindex gnus-summary-line-format
4795 You also have to instruct Gnus to display the data by changing the
4796 @code{%n} spec to the @code{%f} spec in the
4797 @code{gnus-summary-line-format} variable.
4799 In summary, you'd typically put something like the following in
4803 (setq gnus-extra-headers
4805 (setq nnmail-extra-headers gnus-extra-headers)
4806 (setq gnus-summary-line-format
4807 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4808 (setq gnus-ignored-from-addresses
4812 (The values listed above are the default values in Gnus. Alter them
4815 A note for news server administrators, or for users who wish to try to
4816 convince their news server administrator to provide some additional
4819 The above is mostly useful for mail groups, where you have control over
4820 the @acronym{NOV} files that are created. However, if you can persuade your
4821 nntp admin to add (in the usual implementation, notably INN):
4827 to the end of her @file{overview.fmt} file, then you can use that just
4828 as you would the extra headers from the mail groups.
4831 @node Summary Buffer Mode Line
4832 @subsection Summary Buffer Mode Line
4834 @vindex gnus-summary-mode-line-format
4835 You can also change the format of the summary mode bar (@pxref{Mode Line
4836 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4837 like. The default is @samp{Gnus: %%b [%A] %Z}.
4839 Here are the elements you can play with:
4845 Unprefixed group name.
4847 Current article number.
4849 Current article score.
4853 Number of unread articles in this group.
4855 Number of unread articles in this group that aren't displayed in the
4858 A string with the number of unread and unselected articles represented
4859 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4860 articles, and just as @samp{<%U more>} if there are just unread articles
4861 and no unselected ones.
4863 Shortish group name. For instance, @samp{rec.arts.anime} will be
4864 shortened to @samp{r.a.anime}.
4866 Subject of the current article.
4868 User-defined spec (@pxref{User-Defined Specs}).
4870 Name of the current score file (@pxref{Scoring}).
4872 Number of dormant articles (@pxref{Unread Articles}).
4874 Number of ticked articles (@pxref{Unread Articles}).
4876 Number of articles that have been marked as read in this session.
4878 Number of articles expunged by the score files.
4882 @node Summary Highlighting
4883 @subsection Summary Highlighting
4887 @item gnus-visual-mark-article-hook
4888 @vindex gnus-visual-mark-article-hook
4889 This hook is run after selecting an article. It is meant to be used for
4890 highlighting the article in some way. It is not run if
4891 @code{gnus-visual} is @code{nil}.
4893 @item gnus-summary-update-hook
4894 @vindex gnus-summary-update-hook
4895 This hook is called when a summary line is changed. It is not run if
4896 @code{gnus-visual} is @code{nil}.
4898 @item gnus-summary-selected-face
4899 @vindex gnus-summary-selected-face
4900 This is the face (or @dfn{font} as some people call it) used to
4901 highlight the current article in the summary buffer.
4903 @item gnus-summary-highlight
4904 @vindex gnus-summary-highlight
4905 Summary lines are highlighted according to this variable, which is a
4906 list where the elements are of the format @code{(@var{form}
4907 . @var{face})}. If you would, for instance, like ticked articles to be
4908 italic and high-scored articles to be bold, you could set this variable
4911 (((eq mark gnus-ticked-mark) . italic)
4912 ((> score default) . bold))
4914 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4915 @var{face} will be applied to the line.
4919 @node Summary Maneuvering
4920 @section Summary Maneuvering
4921 @cindex summary movement
4923 All the straight movement commands understand the numeric prefix and
4924 behave pretty much as you'd expect.
4926 None of these commands select articles.
4931 @kindex M-n (Summary)
4932 @kindex G M-n (Summary)
4933 @findex gnus-summary-next-unread-subject
4934 Go to the next summary line of an unread article
4935 (@code{gnus-summary-next-unread-subject}).
4939 @kindex M-p (Summary)
4940 @kindex G M-p (Summary)
4941 @findex gnus-summary-prev-unread-subject
4942 Go to the previous summary line of an unread article
4943 (@code{gnus-summary-prev-unread-subject}).
4946 @kindex G g (Summary)
4947 @findex gnus-summary-goto-subject
4948 Ask for an article number and then go to the summary line of that article
4949 without displaying the article (@code{gnus-summary-goto-subject}).
4952 If Gnus asks you to press a key to confirm going to the next group, you
4953 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4954 buffer, searching for the next group to read without actually returning
4955 to the group buffer.
4957 Variables related to summary movement:
4961 @vindex gnus-auto-select-next
4962 @item gnus-auto-select-next
4963 If you issue one of the movement commands (like @kbd{n}) and there are
4964 no more unread articles after the current one, Gnus will offer to go to
4965 the next group. If this variable is @code{t} and the next group is
4966 empty, Gnus will exit summary mode and return to the group buffer. If
4967 this variable is neither @code{t} nor @code{nil}, Gnus will select the
4968 next group with unread articles. As a special case, if this variable
4969 is @code{quietly}, Gnus will select the next group without asking for
4970 confirmation. If this variable is @code{almost-quietly}, the same
4971 will happen only if you are located on the last article in the group.
4972 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
4973 command will go to the next group without confirmation. Also
4974 @pxref{Group Levels}.
4976 @item gnus-auto-select-same
4977 @vindex gnus-auto-select-same
4978 If non-@code{nil}, all the movement commands will try to go to the next
4979 article with the same subject as the current. (@dfn{Same} here might
4980 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4981 for details (@pxref{Customizing Threading}).) If there are no more
4982 articles with the same subject, go to the first unread article.
4984 This variable is not particularly useful if you use a threaded display.
4986 @item gnus-summary-check-current
4987 @vindex gnus-summary-check-current
4988 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4989 to the next (or previous) article if the current article is unread.
4990 Instead, they will choose the current article.
4992 @item gnus-auto-center-summary
4993 @vindex gnus-auto-center-summary
4994 If non-@code{nil}, Gnus will keep the point in the summary buffer
4995 centered at all times. This makes things quite tidy, but if you have a
4996 slow network connection, or simply do not like this un-Emacsism, you can
4997 set this variable to @code{nil} to get the normal Emacs scrolling
4998 action. This will also inhibit horizontal re-centering of the summary
4999 buffer, which might make it more inconvenient to read extremely long
5002 This variable can also be a number. In that case, center the window at
5003 the given number of lines from the top.
5008 @node Choosing Articles
5009 @section Choosing Articles
5010 @cindex selecting articles
5013 * Choosing Commands:: Commands for choosing articles.
5014 * Choosing Variables:: Variables that influence these commands.
5018 @node Choosing Commands
5019 @subsection Choosing Commands
5021 None of the following movement commands understand the numeric prefix,
5022 and they all select and display an article.
5024 If you want to fetch new articles or redisplay the group, see
5025 @ref{Exiting the Summary Buffer}.
5029 @kindex SPACE (Summary)
5030 @findex gnus-summary-next-page
5031 Select the current article, or, if that one's read already, the next
5032 unread article (@code{gnus-summary-next-page}).
5034 If you have an article window open already and you press @kbd{SPACE}
5035 again, the article will be scrolled. This lets you conveniently
5036 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5041 @kindex G n (Summary)
5042 @findex gnus-summary-next-unread-article
5043 @c @icon{gnus-summary-next-unread}
5044 Go to next unread article (@code{gnus-summary-next-unread-article}).
5049 @findex gnus-summary-prev-unread-article
5050 @c @icon{gnus-summary-prev-unread}
5051 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5056 @kindex G N (Summary)
5057 @findex gnus-summary-next-article
5058 Go to the next article (@code{gnus-summary-next-article}).
5063 @kindex G P (Summary)
5064 @findex gnus-summary-prev-article
5065 Go to the previous article (@code{gnus-summary-prev-article}).
5068 @kindex G C-n (Summary)
5069 @findex gnus-summary-next-same-subject
5070 Go to the next article with the same subject
5071 (@code{gnus-summary-next-same-subject}).
5074 @kindex G C-p (Summary)
5075 @findex gnus-summary-prev-same-subject
5076 Go to the previous article with the same subject
5077 (@code{gnus-summary-prev-same-subject}).
5081 @kindex G f (Summary)
5083 @findex gnus-summary-first-unread-article
5084 Go to the first unread article
5085 (@code{gnus-summary-first-unread-article}).
5089 @kindex G b (Summary)
5091 @findex gnus-summary-best-unread-article
5092 Go to the unread article with the highest score
5093 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5094 go to the first unread article that has a score over the default score.
5099 @kindex G l (Summary)
5100 @findex gnus-summary-goto-last-article
5101 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5104 @kindex G o (Summary)
5105 @findex gnus-summary-pop-article
5107 @cindex article history
5108 Pop an article off the summary history and go to this article
5109 (@code{gnus-summary-pop-article}). This command differs from the
5110 command above in that you can pop as many previous articles off the
5111 history as you like, while @kbd{l} toggles the two last read articles.
5112 For a somewhat related issue (if you use these commands a lot),
5113 @pxref{Article Backlog}.
5118 @kindex G j (Summary)
5119 @findex gnus-summary-goto-article
5120 Ask for an article number or @code{Message-ID}, and then go to that
5121 article (@code{gnus-summary-goto-article}).
5126 @node Choosing Variables
5127 @subsection Choosing Variables
5129 Some variables relevant for moving and selecting articles:
5132 @item gnus-auto-extend-newsgroup
5133 @vindex gnus-auto-extend-newsgroup
5134 All the movement commands will try to go to the previous (or next)
5135 article, even if that article isn't displayed in the Summary buffer if
5136 this variable is non-@code{nil}. Gnus will then fetch the article from
5137 the server and display it in the article buffer.
5139 @item gnus-select-article-hook
5140 @vindex gnus-select-article-hook
5141 This hook is called whenever an article is selected. By default it
5142 exposes any threads hidden under the selected article. If you would
5143 like each article to be saved in the Agent as you read it, putting
5144 @code{gnus-agent-fetch-selected-article} on this hook will do so.
5146 @item gnus-mark-article-hook
5147 @vindex gnus-mark-article-hook
5148 @findex gnus-summary-mark-unread-as-read
5149 @findex gnus-summary-mark-read-and-unread-as-read
5150 @findex gnus-unread-mark
5151 This hook is called whenever an article is selected. It is intended to
5152 be used for marking articles as read. The default value is
5153 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5154 mark of almost any article you read to @code{gnus-unread-mark}. The
5155 only articles not affected by this function are ticked, dormant, and
5156 expirable articles. If you'd instead like to just have unread articles
5157 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5158 instead. It will leave marks like @code{gnus-low-score-mark},
5159 @code{gnus-del-mark} (and so on) alone.
5164 @node Paging the Article
5165 @section Scrolling the Article
5166 @cindex article scrolling
5171 @kindex SPACE (Summary)
5172 @findex gnus-summary-next-page
5173 Pressing @kbd{SPACE} will scroll the current article forward one page,
5174 or, if you have come to the end of the current article, will choose the
5175 next article (@code{gnus-summary-next-page}).
5177 @vindex gnus-article-boring-faces
5178 @vindex gnus-article-skip-boring
5179 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5180 the article consists only of citations and signature, then it will be
5181 skipped; the next article will be shown instead. You can customize
5182 what is considered uninteresting with
5183 @code{gnus-article-boring-faces}. You can manually view the article's
5184 pages, no matter how boring, using @kbd{C-M-v}.
5187 @kindex DEL (Summary)
5188 @findex gnus-summary-prev-page
5189 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5192 @kindex RET (Summary)
5193 @findex gnus-summary-scroll-up
5194 Scroll the current article one line forward
5195 (@code{gnus-summary-scroll-up}).
5198 @kindex M-RET (Summary)
5199 @findex gnus-summary-scroll-down
5200 Scroll the current article one line backward
5201 (@code{gnus-summary-scroll-down}).
5205 @kindex A g (Summary)
5207 @findex gnus-summary-show-article
5208 @vindex gnus-summary-show-article-charset-alist
5209 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5210 given a prefix, fetch the current article, but don't run any of the
5211 article treatment functions. This will give you a ``raw'' article, just
5212 the way it came from the server.
5214 If given a numerical prefix, you can do semi-manual charset stuff.
5215 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5216 encoded in the @code{cn-gb-2312} charset. If you have
5219 (setq gnus-summary-show-article-charset-alist
5224 then you can say @kbd{C-u 1 g} to get the same effect.
5229 @kindex A < (Summary)
5230 @findex gnus-summary-beginning-of-article
5231 Scroll to the beginning of the article
5232 (@code{gnus-summary-beginning-of-article}).
5237 @kindex A > (Summary)
5238 @findex gnus-summary-end-of-article
5239 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5243 @kindex A s (Summary)
5245 @findex gnus-summary-isearch-article
5246 Perform an isearch in the article buffer
5247 (@code{gnus-summary-isearch-article}).
5251 @findex gnus-summary-select-article-buffer
5252 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5257 @node Reply Followup and Post
5258 @section Reply, Followup and Post
5261 * Summary Mail Commands:: Sending mail.
5262 * Summary Post Commands:: Sending news.
5263 * Summary Message Commands:: Other Message-related commands.
5264 * Canceling and Superseding::
5268 @node Summary Mail Commands
5269 @subsection Summary Mail Commands
5271 @cindex composing mail
5273 Commands for composing a mail message:
5279 @kindex S r (Summary)
5281 @findex gnus-summary-reply
5282 @c @icon{gnus-summary-mail-reply}
5283 @c @icon{gnus-summary-reply}
5284 Mail a reply to the author of the current article
5285 (@code{gnus-summary-reply}).
5290 @kindex S R (Summary)
5291 @findex gnus-summary-reply-with-original
5292 @c @icon{gnus-summary-reply-with-original}
5293 Mail a reply to the author of the current article and include the
5294 original message (@code{gnus-summary-reply-with-original}). This
5295 command uses the process/prefix convention.
5298 @kindex S w (Summary)
5299 @findex gnus-summary-wide-reply
5300 Mail a wide reply to the author of the current article
5301 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5302 goes out to all people listed in the @code{To}, @code{From} (or
5303 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5304 present, that's used instead.
5307 @kindex S W (Summary)
5308 @findex gnus-summary-wide-reply-with-original
5309 Mail a wide reply to the current article and include the original
5310 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5311 the process/prefix convention.
5314 @kindex S v (Summary)
5315 @findex gnus-summary-very-wide-reply
5316 Mail a very wide reply to the author of the current article
5317 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5318 that goes out to all people listed in the @code{To}, @code{From} (or
5319 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5320 articles. This command uses the process/prefix convention.
5323 @kindex S V (Summary)
5324 @findex gnus-summary-very-wide-reply-with-original
5325 Mail a very wide reply to the author of the current article and include the
5326 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5327 command uses the process/prefix convention.
5330 @kindex S B r (Summary)
5331 @findex gnus-summary-reply-broken-reply-to
5332 Mail a reply to the author of the current article but ignore the
5333 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5334 If you need this because a mailing list incorrectly sets a
5335 @code{Reply-To} header pointing to the list, you probably want to set
5336 the @code{broken-reply-to} group parameter instead, so things will work
5337 correctly. @xref{Group Parameters}.
5340 @kindex S B R (Summary)
5341 @findex gnus-summary-reply-broken-reply-to-with-original
5342 Mail a reply to the author of the current article and include the
5343 original message but ignore the @code{Reply-To} field
5344 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5348 @kindex S o m (Summary)
5349 @kindex C-c C-f (Summary)
5350 @findex gnus-summary-mail-forward
5351 @c @icon{gnus-summary-mail-forward}
5352 Forward the current article to some other person
5353 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
5354 is forwarded according to the value of (@code{message-forward-as-mime})
5355 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
5356 message and forward directly inline; if the prefix is 2, forward message
5357 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5358 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5359 directly inline; otherwise, the message is forwarded as no prefix given
5360 but use the flipped value of (@code{message-forward-as-mime}). By
5361 default, the message is decoded and forwarded as an rfc822 @acronym{MIME}
5367 @kindex S m (Summary)
5368 @findex gnus-summary-mail-other-window
5369 @c @icon{gnus-summary-mail-originate}
5370 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5371 the posting style of the current group. If given a prefix, disable that.
5372 If the prefix is 1, prompt for a group name to find the posting style.
5377 @kindex S i (Summary)
5378 @findex gnus-summary-news-other-window
5379 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5380 post to the current group. If given a prefix, disable that. If the
5381 prefix is 1, prompt for a group to post to.
5383 This function actually prepares a news even when using mail groups.
5384 This is useful for ``posting'' messages to mail groups without actually
5385 sending them over the network: they're just saved directly to the group
5386 in question. The corresponding back end must have a request-post method
5387 for this to work though.
5390 @kindex S D b (Summary)
5391 @findex gnus-summary-resend-bounced-mail
5392 @cindex bouncing mail
5393 If you have sent a mail, but the mail was bounced back to you for some
5394 reason (wrong address, transient failure), you can use this command to
5395 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5396 will be popped into a mail buffer where you can edit the headers before
5397 sending the mail off again. If you give a prefix to this command, and
5398 the bounced mail is a reply to some other mail, Gnus will try to fetch
5399 that mail and display it for easy perusal of its headers. This might
5400 very well fail, though.
5403 @kindex S D r (Summary)
5404 @findex gnus-summary-resend-message
5405 Not to be confused with the previous command,
5406 @code{gnus-summary-resend-message} will prompt you for an address to
5407 send the current message off to, and then send it to that place. The
5408 headers of the message won't be altered---but lots of headers that say
5409 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5410 means that you actually send a mail to someone that has a @code{To}
5411 header that (probably) points to yourself. This will confuse people.
5412 So, natcherly you'll only do that if you're really eVIl.
5414 This command is mainly used if you have several accounts and want to
5415 ship a mail to a different account of yours. (If you're both
5416 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5417 to the @code{root} account, you may want to resend it to
5418 @code{postmaster}. Ordnung muss sein!
5420 This command understands the process/prefix convention
5421 (@pxref{Process/Prefix}).
5424 @kindex S D e (Summary)
5425 @findex gnus-summary-resend-message-edit
5427 Like the previous command, but will allow you to edit the message as
5428 if it were a new message before resending.
5431 @kindex S O m (Summary)
5432 @findex gnus-uu-digest-mail-forward
5433 Digest the current series (@pxref{Decoding Articles}) and forward the
5434 result using mail (@code{gnus-uu-digest-mail-forward}). This command
5435 uses the process/prefix convention (@pxref{Process/Prefix}).
5438 @kindex S M-c (Summary)
5439 @findex gnus-summary-mail-crosspost-complaint
5440 @cindex crossposting
5441 @cindex excessive crossposting
5442 Send a complaint about excessive crossposting to the author of the
5443 current article (@code{gnus-summary-mail-crosspost-complaint}).
5445 @findex gnus-crosspost-complaint
5446 This command is provided as a way to fight back against the current
5447 crossposting pandemic that's sweeping Usenet. It will compose a reply
5448 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5449 command understands the process/prefix convention
5450 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5454 Also @xref{Header Commands, ,Header Commands, message, The Message
5455 Manual}, for more information.
5458 @node Summary Post Commands
5459 @subsection Summary Post Commands
5461 @cindex composing news
5463 Commands for posting a news article:
5469 @kindex S p (Summary)
5470 @findex gnus-summary-post-news
5471 @c @icon{gnus-summary-post-news}
5472 Prepare for posting an article (@code{gnus-summary-post-news}). By
5473 default, post to the current group. If given a prefix, disable that.
5474 If the prefix is 1, prompt for another group instead.
5479 @kindex S f (Summary)
5480 @findex gnus-summary-followup
5481 @c @icon{gnus-summary-followup}
5482 Post a followup to the current article (@code{gnus-summary-followup}).
5486 @kindex S F (Summary)
5488 @c @icon{gnus-summary-followup-with-original}
5489 @findex gnus-summary-followup-with-original
5490 Post a followup to the current article and include the original message
5491 (@code{gnus-summary-followup-with-original}). This command uses the
5492 process/prefix convention.
5495 @kindex S n (Summary)
5496 @findex gnus-summary-followup-to-mail
5497 Post a followup to the current article via news, even if you got the
5498 message through mail (@code{gnus-summary-followup-to-mail}).
5501 @kindex S N (Summary)
5502 @findex gnus-summary-followup-to-mail-with-original
5503 Post a followup to the current article via news, even if you got the
5504 message through mail and include the original message
5505 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5506 the process/prefix convention.
5509 @kindex S o p (Summary)
5510 @findex gnus-summary-post-forward
5511 Forward the current article to a newsgroup
5512 (@code{gnus-summary-post-forward}).
5513 If no prefix is given, the message is forwarded according to the value
5514 of (@code{message-forward-as-mime}) and
5515 (@code{message-forward-show-mml}); if the prefix is 1, decode the
5516 message and forward directly inline; if the prefix is 2, forward message
5517 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5518 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5519 directly inline; otherwise, the message is forwarded as no prefix given
5520 but use the flipped value of (@code{message-forward-as-mime}). By
5521 default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section.
5524 @kindex S O p (Summary)
5525 @findex gnus-uu-digest-post-forward
5527 @cindex making digests
5528 Digest the current series and forward the result to a newsgroup
5529 (@code{gnus-uu-digest-mail-forward}). This command uses the
5530 process/prefix convention.
5533 @kindex S u (Summary)
5534 @findex gnus-uu-post-news
5535 @c @icon{gnus-uu-post-news}
5536 Uuencode a file, split it into parts, and post it as a series
5537 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5540 Also @xref{Header Commands, ,Header Commands, message, The Message
5541 Manual}, for more information.
5544 @node Summary Message Commands
5545 @subsection Summary Message Commands
5549 @kindex S y (Summary)
5550 @findex gnus-summary-yank-message
5551 Yank the current article into an already existing Message composition
5552 buffer (@code{gnus-summary-yank-message}). This command prompts for
5553 what message buffer you want to yank into, and understands the
5554 process/prefix convention (@pxref{Process/Prefix}).
5559 @node Canceling and Superseding
5560 @subsection Canceling Articles
5561 @cindex canceling articles
5562 @cindex superseding articles
5564 Have you ever written something, and then decided that you really,
5565 really, really wish you hadn't posted that?
5567 Well, you can't cancel mail, but you can cancel posts.
5569 @findex gnus-summary-cancel-article
5571 @c @icon{gnus-summary-cancel-article}
5572 Find the article you wish to cancel (you can only cancel your own
5573 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5574 c} (@code{gnus-summary-cancel-article}). Your article will be
5575 canceled---machines all over the world will be deleting your article.
5576 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5578 Be aware, however, that not all sites honor cancels, so your article may
5579 live on here and there, while most sites will delete the article in
5582 Gnus will use the ``current'' select method when canceling. If you
5583 want to use the standard posting method, use the @samp{a} symbolic
5584 prefix (@pxref{Symbolic Prefixes}).
5586 Gnus ensures that only you can cancel your own messages using a
5587 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5588 message, Message Manual}).
5590 If you discover that you have made some mistakes and want to do some
5591 corrections, you can post a @dfn{superseding} article that will replace
5592 your original article.
5594 @findex gnus-summary-supersede-article
5596 Go to the original article and press @kbd{S s}
5597 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5598 where you can edit the article all you want before sending it off the
5601 The same goes for superseding as for canceling, only more so: Some
5602 sites do not honor superseding. On those sites, it will appear that you
5603 have posted almost the same article twice.
5605 If you have just posted the article, and change your mind right away,
5606 there is a trick you can use to cancel/supersede the article without
5607 waiting for the article to appear on your site first. You simply return
5608 to the post buffer (which is called @code{*sent ...*}). There you will
5609 find the article you just posted, with all the headers intact. Change
5610 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5611 header by substituting one of those words for the word
5612 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5613 you would do normally. The previous article will be
5614 canceled/superseded.
5616 Just remember, kids: There is no 'c' in 'supersede'.
5618 @node Delayed Articles
5619 @section Delayed Articles
5620 @cindex delayed sending
5621 @cindex send delayed
5623 Sometimes, you might wish to delay the sending of a message. For
5624 example, you might wish to arrange for a message to turn up just in time
5625 to remind your about the birthday of your Significant Other. For this,
5626 there is the @code{gnus-delay} package. Setup is simple:
5629 (gnus-delay-initialize)
5632 @findex gnus-delay-article
5633 Normally, to send a message you use the @kbd{C-c C-c} command from
5634 Message mode. To delay a message, use @kbd{C-c C-j}
5635 (@code{gnus-delay-article}) instead. This will ask you for how long the
5636 message should be delayed. Possible answers are:
5640 A time span. Consists of an integer and a letter. For example,
5641 @code{42d} means to delay for 42 days. Available letters are @code{m}
5642 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5643 (months) and @code{Y} (years).
5646 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5647 delayed until that day, at a specific time (eight o'clock by default).
5648 See also @code{gnus-delay-default-hour}.
5651 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5652 stuff. The deadline will be at that time today, except if that time has
5653 already passed, then it's at the given time tomorrow. So if it's ten
5654 o'clock in the morning and you specify @code{11:15}, then the deadline
5655 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5656 that means a time tomorrow.
5659 The action of the @code{gnus-delay-article} command is influenced by a
5660 couple of variables:
5663 @item gnus-delay-default-hour
5664 @vindex gnus-delay-default-hour
5665 When you specify a specific date, the message will be due on that hour
5666 on the given date. Possible values are integers 0 through 23.
5668 @item gnus-delay-default-delay
5669 @vindex gnus-delay-default-delay
5670 This is a string and gives the default delay. It can be of any of the
5671 formats described above.
5673 @item gnus-delay-group
5674 @vindex gnus-delay-group
5675 Delayed articles will be kept in this group on the drafts server until
5676 they are due. You probably don't need to change this. The default
5677 value is @code{"delayed"}.
5679 @item gnus-delay-header
5680 @vindex gnus-delay-header
5681 The deadline for each article will be stored in a header. This variable
5682 is a string and gives the header name. You probably don't need to
5683 change this. The default value is @code{"X-Gnus-Delayed"}.
5686 The way delaying works is like this: when you use the
5687 @code{gnus-delay-article} command, you give a certain delay. Gnus
5688 calculates the deadline of the message and stores it in the
5689 @code{X-Gnus-Delayed} header and puts the message in the
5690 @code{nndraft:delayed} group.
5692 @findex gnus-delay-send-queue
5693 And whenever you get new news, Gnus looks through the group for articles
5694 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5695 function for this. By default, this function is added to the hook
5696 @code{gnus-get-new-news-hook}. But of course, you can change this.
5697 Maybe you want to use the demon to send drafts? Just tell the demon to
5698 execute the @code{gnus-delay-send-queue} function.
5701 @item gnus-delay-initialize
5702 @findex gnus-delay-initialize
5703 By default, this function installs @code{gnus-delay-send-queue} in
5704 @code{gnus-get-new-news-hook}. But it accepts the optional second
5705 argument @code{no-check}. If it is non-@code{nil},
5706 @code{gnus-get-new-news-hook} is not changed. The optional first
5707 argument is ignored.
5709 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5710 Presumably, you want to use the demon for sending due delayed articles.
5711 Just don't forget to set that up :-)
5715 @node Marking Articles
5716 @section Marking Articles
5717 @cindex article marking
5718 @cindex article ticking
5721 There are several marks you can set on an article.
5723 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5724 neologism ohoy!) of the article. Alphabetic marks generally mean
5725 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5727 In addition, you also have marks that do not affect readedness.
5730 * Unread Articles:: Marks for unread articles.
5731 * Read Articles:: Marks for read articles.
5732 * Other Marks:: Marks that do not affect readedness.
5736 There's a plethora of commands for manipulating these marks:
5740 * Setting Marks:: How to set and remove marks.
5741 * Generic Marking Commands:: How to customize the marking.
5742 * Setting Process Marks:: How to mark articles for later processing.
5746 @node Unread Articles
5747 @subsection Unread Articles
5749 The following marks mark articles as (kinda) unread, in one form or
5754 @vindex gnus-ticked-mark
5755 Marked as ticked (@code{gnus-ticked-mark}).
5757 @dfn{Ticked articles} are articles that will remain visible always. If
5758 you see an article that you find interesting, or you want to put off
5759 reading it, or replying to it, until sometime later, you'd typically
5760 tick it. However, articles can be expired (from news servers by the
5761 news server software, Gnus itself never expires ticked messages), so if
5762 you want to keep an article forever, you'll have to make it persistent
5763 (@pxref{Persistent Articles}).
5766 @vindex gnus-dormant-mark
5767 Marked as dormant (@code{gnus-dormant-mark}).
5769 @dfn{Dormant articles} will only appear in the summary buffer if there
5770 are followups to it. If you want to see them even if they don't have
5771 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5772 Otherwise (except for the visibility issue), they are just like ticked
5776 @vindex gnus-unread-mark
5777 Marked as unread (@code{gnus-unread-mark}).
5779 @dfn{Unread articles} are articles that haven't been read at all yet.
5784 @subsection Read Articles
5785 @cindex expirable mark
5787 All the following marks mark articles as read.
5792 @vindex gnus-del-mark
5793 These are articles that the user has marked as read with the @kbd{d}
5794 command manually, more or less (@code{gnus-del-mark}).
5797 @vindex gnus-read-mark
5798 Articles that have actually been read (@code{gnus-read-mark}).
5801 @vindex gnus-ancient-mark
5802 Articles that were marked as read in previous sessions and are now
5803 @dfn{old} (@code{gnus-ancient-mark}).
5806 @vindex gnus-killed-mark
5807 Marked as killed (@code{gnus-killed-mark}).
5810 @vindex gnus-kill-file-mark
5811 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5814 @vindex gnus-low-score-mark
5815 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5818 @vindex gnus-catchup-mark
5819 Marked as read by a catchup (@code{gnus-catchup-mark}).
5822 @vindex gnus-canceled-mark
5823 Canceled article (@code{gnus-canceled-mark})
5826 @vindex gnus-souped-mark
5827 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5830 @vindex gnus-sparse-mark
5831 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5835 @vindex gnus-duplicate-mark
5836 Article marked as read by duplicate suppression
5837 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5841 All these marks just mean that the article is marked as read, really.
5842 They are interpreted differently when doing adaptive scoring, though.
5844 One more special mark, though:
5848 @vindex gnus-expirable-mark
5849 Marked as expirable (@code{gnus-expirable-mark}).
5851 Marking articles as @dfn{expirable} (or have them marked as such
5852 automatically) doesn't make much sense in normal groups---a user doesn't
5853 control expiring of news articles, but in mail groups, for instance,
5854 articles marked as @dfn{expirable} can be deleted by Gnus at
5860 @subsection Other Marks
5861 @cindex process mark
5864 There are some marks that have nothing to do with whether the article is
5870 You can set a bookmark in the current article. Say you are reading a
5871 long thesis on cats' urinary tracts, and have to go home for dinner
5872 before you've finished reading the thesis. You can then set a bookmark
5873 in the article, and Gnus will jump to this bookmark the next time it
5874 encounters the article. @xref{Setting Marks}.
5877 @vindex gnus-replied-mark
5878 All articles that you have replied to or made a followup to (i.e., have
5879 answered) will be marked with an @samp{A} in the second column
5880 (@code{gnus-replied-mark}).
5883 @vindex gnus-forwarded-mark
5884 All articles that you have forwarded will be marked with an @samp{F} in
5885 the second column (@code{gnus-forwarded-mark}).
5888 @vindex gnus-cached-mark
5889 Articles stored in the article cache will be marked with an @samp{*} in
5890 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5893 @vindex gnus-saved-mark
5894 Articles ``saved'' (in some manner or other; not necessarily
5895 religiously) are marked with an @samp{S} in the second column
5896 (@code{gnus-saved-mark}).
5899 @vindex gnus-recent-mark
5900 Articles that according to the server haven't been shown to the user
5901 before are marked with a @samp{N} in the second column
5902 (@code{gnus-recent-mark}). Note that not all servers support this
5903 mark, in which case it simply never appears. Compare with
5904 @code{gnus-unseen-mark}.
5907 @vindex gnus-unseen-mark
5908 Articles that haven't been seen before in Gnus by the user are marked
5909 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5910 Compare with @code{gnus-recent-mark}.
5913 @vindex gnus-downloaded-mark
5914 When using the Gnus agent (@pxref{Agent Basics}), articles may be
5915 downloaded for unplugged (offline) viewing. If you are using the
5916 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
5917 (The variable @code{gnus-downloaded-mark} controls which character to
5921 @vindex gnus-undownloaded-mark
5922 When using the Gnus agent (@pxref{Agent Basics}), some articles might
5923 not have been downloaded. Such articles cannot be viewed while you
5924 are unplugged (offline). If you are using the @samp{%O} spec, these
5925 articles get the @samp{-} mark in that spec. (The variable
5926 @code{gnus-undownloaded-mark} controls which character to use.)
5929 @vindex gnus-downloadable-mark
5930 The Gnus agent (@pxref{Agent Basics}) downloads some articles
5931 automatically, but it is also possible to explicitly mark articles for
5932 download, even if they would not be downloaded automatically. Such
5933 explicitly-marked articles get the @samp{%} mark in the first column.
5934 (The variable @code{gnus-downloadable-mark} controls which character to
5938 @vindex gnus-not-empty-thread-mark
5939 @vindex gnus-empty-thread-mark
5940 If the @samp{%e} spec is used, the presence of threads or not will be
5941 marked with @code{gnus-not-empty-thread-mark} and
5942 @code{gnus-empty-thread-mark} in the third column, respectively.
5945 @vindex gnus-process-mark
5946 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5947 variety of commands react to the presence of the process mark. For
5948 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5949 all articles that have been marked with the process mark. Articles
5950 marked with the process mark have a @samp{#} in the second column.
5954 You might have noticed that most of these ``non-readedness'' marks
5955 appear in the second column by default. So if you have a cached, saved,
5956 replied article that you have process-marked, what will that look like?
5958 Nothing much. The precedence rules go as follows: process -> cache ->
5959 replied -> saved. So if the article is in the cache and is replied,
5960 you'll only see the cache mark and not the replied mark.
5964 @subsection Setting Marks
5965 @cindex setting marks
5967 All the marking commands understand the numeric prefix.
5972 @kindex M c (Summary)
5973 @kindex M-u (Summary)
5974 @findex gnus-summary-clear-mark-forward
5975 @cindex mark as unread
5976 Clear all readedness-marks from the current article
5977 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5983 @kindex M t (Summary)
5984 @findex gnus-summary-tick-article-forward
5985 Tick the current article (@code{gnus-summary-tick-article-forward}).
5986 @xref{Article Caching}.
5991 @kindex M ? (Summary)
5992 @findex gnus-summary-mark-as-dormant
5993 Mark the current article as dormant
5994 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5998 @kindex M d (Summary)
6000 @findex gnus-summary-mark-as-read-forward
6001 Mark the current article as read
6002 (@code{gnus-summary-mark-as-read-forward}).
6006 @findex gnus-summary-mark-as-read-backward
6007 Mark the current article as read and move point to the previous line
6008 (@code{gnus-summary-mark-as-read-backward}).
6013 @kindex M k (Summary)
6014 @findex gnus-summary-kill-same-subject-and-select
6015 Mark all articles that have the same subject as the current one as read,
6016 and then select the next unread article
6017 (@code{gnus-summary-kill-same-subject-and-select}).
6021 @kindex M K (Summary)
6022 @kindex C-k (Summary)
6023 @findex gnus-summary-kill-same-subject
6024 Mark all articles that have the same subject as the current one as read
6025 (@code{gnus-summary-kill-same-subject}).
6028 @kindex M C (Summary)
6029 @findex gnus-summary-catchup
6030 @c @icon{gnus-summary-catchup}
6031 Mark all unread articles as read (@code{gnus-summary-catchup}).
6034 @kindex M C-c (Summary)
6035 @findex gnus-summary-catchup-all
6036 Mark all articles in the group as read---even the ticked and dormant
6037 articles (@code{gnus-summary-catchup-all}).
6040 @kindex M H (Summary)
6041 @findex gnus-summary-catchup-to-here
6042 Catchup the current group to point (before the point)
6043 (@code{gnus-summary-catchup-to-here}).
6046 @kindex M h (Summary)
6047 @findex gnus-summary-catchup-from-here
6048 Catchup the current group from point (after the point)
6049 (@code{gnus-summary-catchup-from-here}).
6052 @kindex C-w (Summary)
6053 @findex gnus-summary-mark-region-as-read
6054 Mark all articles between point and mark as read
6055 (@code{gnus-summary-mark-region-as-read}).
6058 @kindex M V k (Summary)
6059 @findex gnus-summary-kill-below
6060 Kill all articles with scores below the default score (or below the
6061 numeric prefix) (@code{gnus-summary-kill-below}).
6065 @kindex M e (Summary)
6067 @findex gnus-summary-mark-as-expirable
6068 Mark the current article as expirable
6069 (@code{gnus-summary-mark-as-expirable}).
6072 @kindex M b (Summary)
6073 @findex gnus-summary-set-bookmark
6074 Set a bookmark in the current article
6075 (@code{gnus-summary-set-bookmark}).
6078 @kindex M B (Summary)
6079 @findex gnus-summary-remove-bookmark
6080 Remove the bookmark from the current article
6081 (@code{gnus-summary-remove-bookmark}).
6084 @kindex M V c (Summary)
6085 @findex gnus-summary-clear-above
6086 Clear all marks from articles with scores over the default score (or
6087 over the numeric prefix) (@code{gnus-summary-clear-above}).
6090 @kindex M V u (Summary)
6091 @findex gnus-summary-tick-above
6092 Tick all articles with scores over the default score (or over the
6093 numeric prefix) (@code{gnus-summary-tick-above}).
6096 @kindex M V m (Summary)
6097 @findex gnus-summary-mark-above
6098 Prompt for a mark, and mark all articles with scores over the default
6099 score (or over the numeric prefix) with this mark
6100 (@code{gnus-summary-clear-above}).
6103 @vindex gnus-summary-goto-unread
6104 The @code{gnus-summary-goto-unread} variable controls what action should
6105 be taken after setting a mark. If non-@code{nil}, point will move to
6106 the next/previous unread article. If @code{nil}, point will just move
6107 one line up or down. As a special case, if this variable is
6108 @code{never}, all the marking commands as well as other commands (like
6109 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6110 The default is @code{t}.
6113 @node Generic Marking Commands
6114 @subsection Generic Marking Commands
6116 Some people would like the command that ticks an article (@kbd{!}) go to
6117 the next article. Others would like it to go to the next unread
6118 article. Yet others would like it to stay on the current article. And
6119 even though I haven't heard of anybody wanting it to go to the
6120 previous (unread) article, I'm sure there are people that want that as
6123 Multiply these five behaviors with five different marking commands, and
6124 you get a potentially complex set of variable to control what each
6127 To sidestep that mess, Gnus provides commands that do all these
6128 different things. They can be found on the @kbd{M M} map in the summary
6129 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6130 to list in this manual.
6132 While you can use these commands directly, most users would prefer
6133 altering the summary mode keymap. For instance, if you would like the
6134 @kbd{!} command to go to the next article instead of the next unread
6135 article, you could say something like:
6139 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6140 (defun my-alter-summary-map ()
6141 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6149 (defun my-alter-summary-map ()
6150 (local-set-key "!" "MM!n"))
6154 @node Setting Process Marks
6155 @subsection Setting Process Marks
6156 @cindex setting process marks
6158 Process marks are displayed as @code{#} in the summary buffer, and are
6159 used for marking articles in such a way that other commands will
6160 process these articles. For instance, if you process mark four
6161 articles and then use the @kbd{*} command, Gnus will enter these four
6162 commands into the cache. For more information,
6163 @pxref{Process/Prefix}.
6170 @kindex M P p (Summary)
6171 @findex gnus-summary-mark-as-processable
6172 Mark the current article with the process mark
6173 (@code{gnus-summary-mark-as-processable}).
6174 @findex gnus-summary-unmark-as-processable
6178 @kindex M P u (Summary)
6179 @kindex M-# (Summary)
6180 Remove the process mark, if any, from the current article
6181 (@code{gnus-summary-unmark-as-processable}).
6184 @kindex M P U (Summary)
6185 @findex gnus-summary-unmark-all-processable
6186 Remove the process mark from all articles
6187 (@code{gnus-summary-unmark-all-processable}).
6190 @kindex M P i (Summary)
6191 @findex gnus-uu-invert-processable
6192 Invert the list of process marked articles
6193 (@code{gnus-uu-invert-processable}).
6196 @kindex M P R (Summary)
6197 @findex gnus-uu-mark-by-regexp
6198 Mark articles that have a @code{Subject} header that matches a regular
6199 expression (@code{gnus-uu-mark-by-regexp}).
6202 @kindex M P G (Summary)
6203 @findex gnus-uu-unmark-by-regexp
6204 Unmark articles that have a @code{Subject} header that matches a regular
6205 expression (@code{gnus-uu-unmark-by-regexp}).
6208 @kindex M P r (Summary)
6209 @findex gnus-uu-mark-region
6210 Mark articles in region (@code{gnus-uu-mark-region}).
6213 @kindex M P g (Summary)
6214 @findex gnus-uu-unmark-region
6215 Unmark articles in region (@code{gnus-uu-unmark-region}).
6218 @kindex M P t (Summary)
6219 @findex gnus-uu-mark-thread
6220 Mark all articles in the current (sub)thread
6221 (@code{gnus-uu-mark-thread}).
6224 @kindex M P T (Summary)
6225 @findex gnus-uu-unmark-thread
6226 Unmark all articles in the current (sub)thread
6227 (@code{gnus-uu-unmark-thread}).
6230 @kindex M P v (Summary)
6231 @findex gnus-uu-mark-over
6232 Mark all articles that have a score above the prefix argument
6233 (@code{gnus-uu-mark-over}).
6236 @kindex M P s (Summary)
6237 @findex gnus-uu-mark-series
6238 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6241 @kindex M P S (Summary)
6242 @findex gnus-uu-mark-sparse
6243 Mark all series that have already had some articles marked
6244 (@code{gnus-uu-mark-sparse}).
6247 @kindex M P a (Summary)
6248 @findex gnus-uu-mark-all
6249 Mark all articles in series order (@code{gnus-uu-mark-series}).
6252 @kindex M P b (Summary)
6253 @findex gnus-uu-mark-buffer
6254 Mark all articles in the buffer in the order they appear
6255 (@code{gnus-uu-mark-buffer}).
6258 @kindex M P k (Summary)
6259 @findex gnus-summary-kill-process-mark
6260 Push the current process mark set onto the stack and unmark all articles
6261 (@code{gnus-summary-kill-process-mark}).
6264 @kindex M P y (Summary)
6265 @findex gnus-summary-yank-process-mark
6266 Pop the previous process mark set from the stack and restore it
6267 (@code{gnus-summary-yank-process-mark}).
6270 @kindex M P w (Summary)
6271 @findex gnus-summary-save-process-mark
6272 Push the current process mark set onto the stack
6273 (@code{gnus-summary-save-process-mark}).
6277 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6278 set process marks based on article body contents.
6285 It can be convenient to limit the summary buffer to just show some
6286 subset of the articles currently in the group. The effect most limit
6287 commands have is to remove a few (or many) articles from the summary
6290 All limiting commands work on subsets of the articles already fetched
6291 from the servers. None of these commands query the server for
6292 additional articles.
6298 @kindex / / (Summary)
6299 @findex gnus-summary-limit-to-subject
6300 Limit the summary buffer to articles that match some subject
6301 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6305 @kindex / a (Summary)
6306 @findex gnus-summary-limit-to-author
6307 Limit the summary buffer to articles that match some author
6308 (@code{gnus-summary-limit-to-author}). 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.
6838 @item gnus-alter-header-function
6839 @vindex gnus-alter-header-function
6840 If non-@code{nil}, this function will be called to allow alteration of
6841 article header structures. The function is called with one parameter,
6842 the article header vector, which it may alter in any way. For instance,
6843 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6844 in systematic ways (by adding prefixes and such), you can use this
6845 variable to un-scramble the @code{Message-ID}s so that they are more
6846 meaningful. Here's one example:
6849 (setq gnus-alter-header-function 'my-alter-message-id)
6851 (defun my-alter-message-id (header)
6852 (let ((id (mail-header-id header)))
6854 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6856 (concat (match-string 1 id) "@@" (match-string 2 id))
6863 @node Thread Commands
6864 @subsection Thread Commands
6865 @cindex thread commands
6871 @kindex T k (Summary)
6872 @kindex C-M-k (Summary)
6873 @findex gnus-summary-kill-thread
6874 Mark all articles in the current (sub-)thread as read
6875 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
6876 remove all marks instead. If the prefix argument is negative, tick
6881 @kindex T l (Summary)
6882 @kindex C-M-l (Summary)
6883 @findex gnus-summary-lower-thread
6884 Lower the score of the current (sub-)thread
6885 (@code{gnus-summary-lower-thread}).
6888 @kindex T i (Summary)
6889 @findex gnus-summary-raise-thread
6890 Increase the score of the current (sub-)thread
6891 (@code{gnus-summary-raise-thread}).
6894 @kindex T # (Summary)
6895 @findex gnus-uu-mark-thread
6896 Set the process mark on the current (sub-)thread
6897 (@code{gnus-uu-mark-thread}).
6900 @kindex T M-# (Summary)
6901 @findex gnus-uu-unmark-thread
6902 Remove the process mark from the current (sub-)thread
6903 (@code{gnus-uu-unmark-thread}).
6906 @kindex T T (Summary)
6907 @findex gnus-summary-toggle-threads
6908 Toggle threading (@code{gnus-summary-toggle-threads}).
6911 @kindex T s (Summary)
6912 @findex gnus-summary-show-thread
6913 Expose the (sub-)thread hidden under the current article, if any@*
6914 (@code{gnus-summary-show-thread}).
6917 @kindex T h (Summary)
6918 @findex gnus-summary-hide-thread
6919 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6922 @kindex T S (Summary)
6923 @findex gnus-summary-show-all-threads
6924 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6927 @kindex T H (Summary)
6928 @findex gnus-summary-hide-all-threads
6929 Hide all threads (@code{gnus-summary-hide-all-threads}).
6932 @kindex T t (Summary)
6933 @findex gnus-summary-rethread-current
6934 Re-thread the current article's thread
6935 (@code{gnus-summary-rethread-current}). This works even when the
6936 summary buffer is otherwise unthreaded.
6939 @kindex T ^ (Summary)
6940 @findex gnus-summary-reparent-thread
6941 Make the current article the child of the marked (or previous) article
6942 (@code{gnus-summary-reparent-thread}).
6946 The following commands are thread movement commands. They all
6947 understand the numeric prefix.
6952 @kindex T n (Summary)
6954 @kindex C-M-n (Summary)
6956 @kindex M-down (Summary)
6957 @findex gnus-summary-next-thread
6958 Go to the next thread (@code{gnus-summary-next-thread}).
6961 @kindex T p (Summary)
6963 @kindex C-M-p (Summary)
6965 @kindex M-up (Summary)
6966 @findex gnus-summary-prev-thread
6967 Go to the previous thread (@code{gnus-summary-prev-thread}).
6970 @kindex T d (Summary)
6971 @findex gnus-summary-down-thread
6972 Descend the thread (@code{gnus-summary-down-thread}).
6975 @kindex T u (Summary)
6976 @findex gnus-summary-up-thread
6977 Ascend the thread (@code{gnus-summary-up-thread}).
6980 @kindex T o (Summary)
6981 @findex gnus-summary-top-thread
6982 Go to the top of the thread (@code{gnus-summary-top-thread}).
6985 @vindex gnus-thread-operation-ignore-subject
6986 If you ignore subject while threading, you'll naturally end up with
6987 threads that have several different subjects in them. If you then issue
6988 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
6989 wish to kill the entire thread, but just those parts of the thread that
6990 have the same subject as the current article. If you like this idea,
6991 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6992 is non-@code{nil} (which it is by default), subjects will be ignored
6993 when doing thread commands. If this variable is @code{nil}, articles in
6994 the same thread with different subjects will not be included in the
6995 operation in question. If this variable is @code{fuzzy}, only articles
6996 that have subjects fuzzily equal will be included (@pxref{Fuzzy
7000 @node Sorting the Summary Buffer
7001 @section Sorting the Summary Buffer
7003 @findex gnus-thread-sort-by-total-score
7004 @findex gnus-thread-sort-by-date
7005 @findex gnus-thread-sort-by-score
7006 @findex gnus-thread-sort-by-subject
7007 @findex gnus-thread-sort-by-author
7008 @findex gnus-thread-sort-by-number
7009 @findex gnus-thread-sort-by-random
7010 @vindex gnus-thread-sort-functions
7011 @findex gnus-thread-sort-by-most-recent-number
7012 @findex gnus-thread-sort-by-most-recent-date
7013 If you are using a threaded summary display, you can sort the threads by
7014 setting @code{gnus-thread-sort-functions}, which can be either a single
7015 function, a list of functions, or a list containing functions and
7016 @code{(not some-function)} elements.
7018 By default, sorting is done on article numbers. Ready-made sorting
7019 predicate functions include @code{gnus-thread-sort-by-number},
7020 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
7021 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score},
7022 @code{gnus-thread-sort-by-most-recent-number},
7023 @code{gnus-thread-sort-by-most-recent-date},
7024 @code{gnus-thread-sort-by-random} and
7025 @code{gnus-thread-sort-by-total-score}.
7027 Each function takes two threads and returns non-@code{nil} if the first
7028 thread should be sorted before the other. Note that sorting really is
7029 normally done by looking only at the roots of each thread.
7031 If you use more than one function, the primary sort key should be the
7032 last function in the list. You should probably always include
7033 @code{gnus-thread-sort-by-number} in the list of sorting
7034 functions---preferably first. This will ensure that threads that are
7035 equal with respect to the other sort criteria will be displayed in
7036 ascending article order.
7038 If you would like to sort by reverse score, then by subject, and finally
7039 by number, you could do something like:
7042 (setq gnus-thread-sort-functions
7043 '(gnus-thread-sort-by-number
7044 gnus-thread-sort-by-subject
7045 (not gnus-thread-sort-by-total-score)))
7048 The threads that have highest score will be displayed first in the
7049 summary buffer. When threads have the same score, they will be sorted
7050 alphabetically. The threads that have the same score and the same
7051 subject will be sorted by number, which is (normally) the sequence in
7052 which the articles arrived.
7054 If you want to sort by score and then reverse arrival order, you could
7058 (setq gnus-thread-sort-functions
7060 (not (gnus-thread-sort-by-number t1 t2)))
7061 gnus-thread-sort-by-score))
7064 @vindex gnus-thread-score-function
7065 The function in the @code{gnus-thread-score-function} variable (default
7066 @code{+}) is used for calculating the total score of a thread. Useful
7067 functions might be @code{max}, @code{min}, or squared means, or whatever
7070 @findex gnus-article-sort-functions
7071 @findex gnus-article-sort-by-date
7072 @findex gnus-article-sort-by-score
7073 @findex gnus-article-sort-by-subject
7074 @findex gnus-article-sort-by-author
7075 @findex gnus-article-sort-by-random
7076 @findex gnus-article-sort-by-number
7077 If you are using an unthreaded display for some strange reason or
7078 other, you have to fiddle with the @code{gnus-article-sort-functions}
7079 variable. It is very similar to the
7080 @code{gnus-thread-sort-functions}, except that it uses slightly
7081 different functions for article comparison. Available sorting
7082 predicate functions are @code{gnus-article-sort-by-number},
7083 @code{gnus-article-sort-by-author},
7084 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7085 @code{gnus-article-sort-by-random}, and
7086 @code{gnus-article-sort-by-score}.
7088 If you want to sort an unthreaded summary display by subject, you could
7092 (setq gnus-article-sort-functions
7093 '(gnus-article-sort-by-number
7094 gnus-article-sort-by-subject))
7099 @node Asynchronous Fetching
7100 @section Asynchronous Article Fetching
7101 @cindex asynchronous article fetching
7102 @cindex article pre-fetch
7105 If you read your news from an @acronym{NNTP} server that's far away, the
7106 network latencies may make reading articles a chore. You have to wait
7107 for a while after pressing @kbd{n} to go to the next article before the
7108 article appears. Why can't Gnus just go ahead and fetch the article
7109 while you are reading the previous one? Why not, indeed.
7111 First, some caveats. There are some pitfalls to using asynchronous
7112 article fetching, especially the way Gnus does it.
7114 Let's say you are reading article 1, which is short, and article 2 is
7115 quite long, and you are not interested in reading that. Gnus does not
7116 know this, so it goes ahead and fetches article 2. You decide to read
7117 article 3, but since Gnus is in the process of fetching article 2, the
7118 connection is blocked.
7120 To avoid these situations, Gnus will open two (count 'em two)
7121 connections to the server. Some people may think this isn't a very nice
7122 thing to do, but I don't see any real alternatives. Setting up that
7123 extra connection takes some time, so Gnus startup will be slower.
7125 Gnus will fetch more articles than you will read. This will mean that
7126 the link between your machine and the @acronym{NNTP} server will become more
7127 loaded than if you didn't use article pre-fetch. The server itself will
7128 also become more loaded---both with the extra article requests, and the
7131 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7134 @vindex gnus-asynchronous
7135 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7136 happen automatically.
7138 @vindex gnus-use-article-prefetch
7139 You can control how many articles are to be pre-fetched by setting
7140 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7141 that when you read an article in the group, the back end will pre-fetch
7142 the next 30 articles. If this variable is @code{t}, the back end will
7143 pre-fetch all the articles it can without bound. If it is
7144 @code{nil}, no pre-fetching will be done.
7146 @vindex gnus-async-prefetch-article-p
7147 @findex gnus-async-read-p
7148 There are probably some articles that you don't want to pre-fetch---read
7149 articles, for instance. The @code{gnus-async-prefetch-article-p}
7150 variable controls whether an article is to be pre-fetched. This
7151 function should return non-@code{nil} when the article in question is
7152 to be pre-fetched. The default is @code{gnus-async-read-p}, which
7153 returns @code{nil} on read articles. The function is called with an
7154 article data structure as the only parameter.
7156 If, for instance, you wish to pre-fetch only unread articles shorter
7157 than 100 lines, you could say something like:
7160 (defun my-async-short-unread-p (data)
7161 "Return non-nil for short, unread articles."
7162 (and (gnus-data-unread-p data)
7163 (< (mail-header-lines (gnus-data-header data))
7166 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7169 These functions will be called many, many times, so they should
7170 preferably be short and sweet to avoid slowing down Gnus too much.
7171 It's probably a good idea to byte-compile things like this.
7173 @vindex gnus-prefetched-article-deletion-strategy
7174 Articles have to be removed from the asynch buffer sooner or later. The
7175 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7176 articles. This is a list that may contain the following elements:
7180 Remove articles when they are read.
7183 Remove articles when exiting the group.
7186 The default value is @code{(read exit)}.
7188 @c @vindex gnus-use-header-prefetch
7189 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7190 @c from the next group.
7193 @node Article Caching
7194 @section Article Caching
7195 @cindex article caching
7198 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7199 consider turning article caching on. Each article will then be stored
7200 locally under your home directory. As you may surmise, this could
7201 potentially use @emph{huge} amounts of disk space, as well as eat up all
7202 your inodes so fast it will make your head swim. In vodka.
7204 Used carefully, though, it could be just an easier way to save articles.
7206 @vindex gnus-use-long-file-name
7207 @vindex gnus-cache-directory
7208 @vindex gnus-use-cache
7209 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7210 all articles ticked or marked as dormant will then be copied
7211 over to your local cache (@code{gnus-cache-directory}). Whether this
7212 cache is flat or hierarchical is controlled by the
7213 @code{gnus-use-long-file-name} variable, as usual.
7215 When re-selecting a ticked or dormant article, it will be fetched from the
7216 cache instead of from the server. As articles in your cache will never
7217 expire, this might serve as a method of saving articles while still
7218 keeping them where they belong. Just mark all articles you want to save
7219 as dormant, and don't worry.
7221 When an article is marked as read, is it removed from the cache.
7223 @vindex gnus-cache-remove-articles
7224 @vindex gnus-cache-enter-articles
7225 The entering/removal of articles from the cache is controlled by the
7226 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7227 variables. Both are lists of symbols. The first is @code{(ticked
7228 dormant)} by default, meaning that ticked and dormant articles will be
7229 put in the cache. The latter is @code{(read)} by default, meaning that
7230 articles marked as read are removed from the cache. Possibly
7231 symbols in these two lists are @code{ticked}, @code{dormant},
7232 @code{unread} and @code{read}.
7234 @findex gnus-jog-cache
7235 So where does the massive article-fetching and storing come into the
7236 picture? The @code{gnus-jog-cache} command will go through all
7237 subscribed newsgroups, request all unread articles, score them, and
7238 store them in the cache. You should only ever, ever ever ever, use this
7239 command if 1) your connection to the @acronym{NNTP} server is really, really,
7240 really slow and 2) you have a really, really, really huge disk.
7241 Seriously. One way to cut down on the number of articles downloaded is
7242 to score unwanted articles down and have them marked as read. They will
7243 not then be downloaded by this command.
7245 @vindex gnus-uncacheable-groups
7246 @vindex gnus-cacheable-groups
7247 It is likely that you do not want caching on all groups. For instance,
7248 if your @code{nnml} mail is located under your home directory, it makes no
7249 sense to cache it somewhere else under your home directory. Unless you
7250 feel that it's neat to use twice as much space.
7252 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7253 regexp of groups to cache, @samp{^nntp} for instance, or set the
7254 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7255 Both variables are @code{nil} by default. If a group matches both
7256 variables, the group is not cached.
7258 @findex gnus-cache-generate-nov-databases
7259 @findex gnus-cache-generate-active
7260 @vindex gnus-cache-active-file
7261 The cache stores information on what articles it contains in its active
7262 file (@code{gnus-cache-active-file}). If this file (or any other parts
7263 of the cache) becomes all messed up for some reason or other, Gnus
7264 offers two functions that will try to set things right. @kbd{M-x
7265 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7266 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7269 @findex gnus-cache-move-cache
7270 @code{gnus-cache-move-cache} will move your whole
7271 @code{gnus-cache-directory} to some other location. You get asked to
7272 where, isn't that cool?
7274 @node Persistent Articles
7275 @section Persistent Articles
7276 @cindex persistent articles
7278 Closely related to article caching, we have @dfn{persistent articles}.
7279 In fact, it's just a different way of looking at caching, and much more
7280 useful in my opinion.
7282 Say you're reading a newsgroup, and you happen on to some valuable gem
7283 that you want to keep and treasure forever. You'd normally just save it
7284 (using one of the many saving commands) in some file. The problem with
7285 that is that it's just, well, yucky. Ideally you'd prefer just having
7286 the article remain in the group where you found it forever; untouched by
7287 the expiry going on at the news server.
7289 This is what a @dfn{persistent article} is---an article that just won't
7290 be deleted. It's implemented using the normal cache functions, but
7291 you use two explicit commands for managing persistent articles:
7297 @findex gnus-cache-enter-article
7298 Make the current article persistent (@code{gnus-cache-enter-article}).
7301 @kindex M-* (Summary)
7302 @findex gnus-cache-remove-article
7303 Remove the current article from the persistent articles
7304 (@code{gnus-cache-remove-article}). This will normally delete the
7308 Both these commands understand the process/prefix convention.
7310 To avoid having all ticked articles (and stuff) entered into the cache,
7311 you should set @code{gnus-use-cache} to @code{passive} if you're just
7312 interested in persistent articles:
7315 (setq gnus-use-cache 'passive)
7319 @node Article Backlog
7320 @section Article Backlog
7322 @cindex article backlog
7324 If you have a slow connection, but the idea of using caching seems
7325 unappealing to you (and it is, really), you can help the situation some
7326 by switching on the @dfn{backlog}. This is where Gnus will buffer
7327 already read articles so that it doesn't have to re-fetch articles
7328 you've already read. This only helps if you are in the habit of
7329 re-selecting articles you've recently read, of course. If you never do
7330 that, turning the backlog on will slow Gnus down a little bit, and
7331 increase memory usage some.
7333 @vindex gnus-keep-backlog
7334 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
7335 at most @var{n} old articles in a buffer for later re-fetching. If this
7336 variable is non-@code{nil} and is not a number, Gnus will store
7337 @emph{all} read articles, which means that your Emacs will grow without
7338 bound before exploding and taking your machine down with you. I put
7339 that in there just to keep y'all on your toes.
7341 The default value is 20.
7344 @node Saving Articles
7345 @section Saving Articles
7346 @cindex saving articles
7348 Gnus can save articles in a number of ways. Below is the documentation
7349 for saving articles in a fairly straight-forward fashion (i.e., little
7350 processing of the article is done before it is saved). For a different
7351 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7352 (@pxref{Decoding Articles}).
7354 For the commands listed here, the target is a file. If you want to
7355 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7356 command (@pxref{Mail Group Commands}).
7358 @vindex gnus-save-all-headers
7359 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
7360 unwanted headers before saving the article.
7362 @vindex gnus-saved-headers
7363 If the preceding variable is @code{nil}, all headers that match the
7364 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7365 deleted before saving.
7371 @kindex O o (Summary)
7373 @findex gnus-summary-save-article
7374 @c @icon{gnus-summary-save-article}
7375 Save the current article using the default article saver
7376 (@code{gnus-summary-save-article}).
7379 @kindex O m (Summary)
7380 @findex gnus-summary-save-article-mail
7381 Save the current article in mail format
7382 (@code{gnus-summary-save-article-mail}).
7385 @kindex O r (Summary)
7386 @findex gnus-summary-save-article-rmail
7387 Save the current article in Rmail format
7388 (@code{gnus-summary-save-article-rmail}).
7391 @kindex O f (Summary)
7392 @findex gnus-summary-save-article-file
7393 @c @icon{gnus-summary-save-article-file}
7394 Save the current article in plain file format
7395 (@code{gnus-summary-save-article-file}).
7398 @kindex O F (Summary)
7399 @findex gnus-summary-write-article-file
7400 Write the current article in plain file format, overwriting any previous
7401 file contents (@code{gnus-summary-write-article-file}).
7404 @kindex O b (Summary)
7405 @findex gnus-summary-save-article-body-file
7406 Save the current article body in plain file format
7407 (@code{gnus-summary-save-article-body-file}).
7410 @kindex O h (Summary)
7411 @findex gnus-summary-save-article-folder
7412 Save the current article in mh folder format
7413 (@code{gnus-summary-save-article-folder}).
7416 @kindex O v (Summary)
7417 @findex gnus-summary-save-article-vm
7418 Save the current article in a VM folder
7419 (@code{gnus-summary-save-article-vm}).
7423 @kindex O p (Summary)
7425 @findex gnus-summary-pipe-output
7426 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7427 the current article to a process (@code{gnus-summary-pipe-output}).
7428 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7429 complete headers in the piped output.
7432 @kindex O P (Summary)
7433 @findex gnus-summary-muttprint
7434 @vindex gnus-summary-muttprint-program
7435 Save the current article into muttprint. That is, print it using the
7436 external program @uref{http://muttprint.sourceforge.net/,
7437 Muttprint}. The program name and options to use is controlled by the
7438 variable @code{gnus-summary-muttprint-program}.
7439 (@code{gnus-summary-muttprint}).
7443 @vindex gnus-prompt-before-saving
7444 All these commands use the process/prefix convention
7445 (@pxref{Process/Prefix}). If you save bunches of articles using these
7446 functions, you might get tired of being prompted for files to save each
7447 and every article in. The prompting action is controlled by
7448 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7449 default, giving you that excessive prompting action you know and
7450 loathe. If you set this variable to @code{t} instead, you'll be prompted
7451 just once for each series of articles you save. If you like to really
7452 have Gnus do all your thinking for you, you can even set this variable
7453 to @code{nil}, which means that you will never be prompted for files to
7454 save articles in. Gnus will simply save all the articles in the default
7458 @vindex gnus-default-article-saver
7459 You can customize the @code{gnus-default-article-saver} variable to make
7460 Gnus do what you want it to. You can use any of the six ready-made
7461 functions below, or you can create your own.
7465 @item gnus-summary-save-in-rmail
7466 @findex gnus-summary-save-in-rmail
7467 @vindex gnus-rmail-save-name
7468 @findex gnus-plain-save-name
7469 This is the default format, @dfn{Babyl}. Uses the function in the
7470 @code{gnus-rmail-save-name} variable to get a file name to save the
7471 article in. The default is @code{gnus-plain-save-name}.
7473 @item gnus-summary-save-in-mail
7474 @findex gnus-summary-save-in-mail
7475 @vindex gnus-mail-save-name
7476 Save in a Unix mail (mbox) file. Uses the function in the
7477 @code{gnus-mail-save-name} variable to get a file name to save the
7478 article in. The default is @code{gnus-plain-save-name}.
7480 @item gnus-summary-save-in-file
7481 @findex gnus-summary-save-in-file
7482 @vindex gnus-file-save-name
7483 @findex gnus-numeric-save-name
7484 Append the article straight to an ordinary file. Uses the function in
7485 the @code{gnus-file-save-name} variable to get a file name to save the
7486 article in. The default is @code{gnus-numeric-save-name}.
7488 @item gnus-summary-write-to-file
7489 @findex gnus-summary-write-to-file
7490 Write the article straight to an ordinary file. The file is
7491 overwritten if it exists. Uses the function in the
7492 @code{gnus-file-save-name} variable to get a file name to save the
7493 article in. The default is @code{gnus-numeric-save-name}.
7495 @item gnus-summary-save-body-in-file
7496 @findex gnus-summary-save-body-in-file
7497 Append the article body to an ordinary file. Uses the function in the
7498 @code{gnus-file-save-name} variable to get a file name to save the
7499 article in. The default is @code{gnus-numeric-save-name}.
7501 @item gnus-summary-save-in-folder
7502 @findex gnus-summary-save-in-folder
7503 @findex gnus-folder-save-name
7504 @findex gnus-Folder-save-name
7505 @vindex gnus-folder-save-name
7508 Save the article to an MH folder using @code{rcvstore} from the MH
7509 library. Uses the function in the @code{gnus-folder-save-name} variable
7510 to get a file name to save the article in. The default is
7511 @code{gnus-folder-save-name}, but you can also use
7512 @code{gnus-Folder-save-name}, which creates capitalized names.
7514 @item gnus-summary-save-in-vm
7515 @findex gnus-summary-save-in-vm
7516 Save the article in a VM folder. You have to have the VM mail
7517 reader to use this setting.
7520 @vindex gnus-article-save-directory
7521 All of these functions, except for the last one, will save the article
7522 in the @code{gnus-article-save-directory}, which is initialized from the
7523 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7526 As you can see above, the functions use different functions to find a
7527 suitable name of a file to save the article in. Below is a list of
7528 available functions that generate names:
7532 @item gnus-Numeric-save-name
7533 @findex gnus-Numeric-save-name
7534 File names like @file{~/News/Alt.andrea-dworkin/45}.
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-Plain-save-name
7541 @findex gnus-Plain-save-name
7542 File names like @file{~/News/Alt.andrea-dworkin}.
7544 @item gnus-plain-save-name
7545 @findex gnus-plain-save-name
7546 File names like @file{~/News/alt.andrea-dworkin}.
7548 @item gnus-sender-save-name
7549 @findex gnus-sender-save-name
7550 File names like @file{~/News/larsi}.
7553 @vindex gnus-split-methods
7554 You can have Gnus suggest where to save articles by plonking a regexp into
7555 the @code{gnus-split-methods} alist. For instance, if you would like to
7556 save articles related to Gnus in the file @file{gnus-stuff}, and articles
7557 related to VM in @file{vm-stuff}, you could set this variable to something
7561 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7562 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7563 (my-choosing-function "../other-dir/my-stuff")
7564 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7567 We see that this is a list where each element is a list that has two
7568 elements---the @dfn{match} and the @dfn{file}. The match can either be
7569 a string (in which case it is used as a regexp to match on the article
7570 head); it can be a symbol (which will be called as a function with the
7571 group name as a parameter); or it can be a list (which will be
7572 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7573 the @dfn{file} will be used as a default prompt. In addition, the
7574 result of the operation itself will be used if the function or form
7575 called returns a string or a list of strings.
7577 You basically end up with a list of file names that might be used when
7578 saving the current article. (All ``matches'' will be used.) You will
7579 then be prompted for what you really want to use as a name, with file
7580 name completion over the results from applying this variable.
7582 This variable is @code{((gnus-article-archive-name))} by default, which
7583 means that Gnus will look at the articles it saves for an
7584 @code{Archive-name} line and use that as a suggestion for the file
7587 Here's an example function to clean up file names somewhat. If you have
7588 lots of mail groups called things like
7589 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7590 these group names before creating the file name to save to. The
7591 following will do just that:
7594 (defun my-save-name (group)
7595 (when (string-match "^nnml:mail." group)
7596 (substring group (match-end 0))))
7598 (setq gnus-split-methods
7599 '((gnus-article-archive-name)
7604 @vindex gnus-use-long-file-name
7605 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7606 @code{nil}, all the preceding functions will replace all periods
7607 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7608 the functions will generate hierarchies of directories instead of having
7609 all the files in the top level directory
7610 (@file{~/News/alt/andrea-dworkin} instead of
7611 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7612 on most systems. However, for historical reasons, this is @code{nil} on
7613 Xenix and usg-unix-v machines by default.
7615 This function also affects kill and score file names. If this variable
7616 is a list, and the list contains the element @code{not-score}, long file
7617 names will not be used for score files, if it contains the element
7618 @code{not-save}, long file names will not be used for saving, and if it
7619 contains the element @code{not-kill}, long file names will not be used
7622 If you'd like to save articles in a hierarchy that looks something like
7626 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
7627 (setq gnus-default-article-saver
7628 'gnus-summary-save-in-file) ; @r{no encoding}
7631 Then just save with @kbd{o}. You'd then read this hierarchy with
7632 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7633 the top level directory as the argument (@file{~/News/}). Then just walk
7634 around to the groups/directories with @code{nneething}.
7637 @node Decoding Articles
7638 @section Decoding Articles
7639 @cindex decoding articles
7641 Sometime users post articles (or series of articles) that have been
7642 encoded in some way or other. Gnus can decode them for you.
7645 * Uuencoded Articles:: Uudecode articles.
7646 * Shell Archives:: Unshar articles.
7647 * PostScript Files:: Split PostScript.
7648 * Other Files:: Plain save and binhex.
7649 * Decoding Variables:: Variables for a happy decoding.
7650 * Viewing Files:: You want to look at the result of the decoding?
7654 @cindex article series
7655 All these functions use the process/prefix convention
7656 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7657 the extension that a ``single article'' means ``a single series''. Gnus
7658 can find out by itself what articles belong to a series, decode all the
7659 articles and unpack/view/save the resulting file(s).
7661 Gnus guesses what articles are in the series according to the following
7662 simplish rule: The subjects must be (nearly) identical, except for the
7663 last two numbers of the line. (Spaces are largely ignored, however.)
7665 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
7666 will find all the articles that match the regexp @samp{^cat.gif
7667 ([0-9]+/[0-9]+).*$}.
7669 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7670 series}, will not be properly recognized by any of the automatic viewing
7671 commands, and you have to mark the articles manually with @kbd{#}.
7674 @node Uuencoded Articles
7675 @subsection Uuencoded Articles
7677 @cindex uuencoded articles
7682 @kindex X u (Summary)
7683 @findex gnus-uu-decode-uu
7684 @c @icon{gnus-uu-decode-uu}
7685 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7688 @kindex X U (Summary)
7689 @findex gnus-uu-decode-uu-and-save
7690 Uudecodes and saves the current series
7691 (@code{gnus-uu-decode-uu-and-save}).
7694 @kindex X v u (Summary)
7695 @findex gnus-uu-decode-uu-view
7696 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7699 @kindex X v U (Summary)
7700 @findex gnus-uu-decode-uu-and-save-view
7701 Uudecodes, views and saves the current series
7702 (@code{gnus-uu-decode-uu-and-save-view}).
7706 Remember that these all react to the presence of articles marked with
7707 the process mark. If, for instance, you'd like to decode and save an
7708 entire newsgroup, you'd typically do @kbd{M P a}
7709 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7710 (@code{gnus-uu-decode-uu-and-save}).
7712 All this is very much different from how @code{gnus-uu} worked with
7713 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7714 the sun. This version of @code{gnus-uu} generally assumes that you mark
7715 articles in some way (@pxref{Setting Process Marks}) and then press
7718 @vindex gnus-uu-notify-files
7719 Note: When trying to decode articles that have names matching
7720 @code{gnus-uu-notify-files}, which is hard-coded to
7721 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7722 automatically post an article on @samp{comp.unix.wizards} saying that
7723 you have just viewed the file in question. This feature can't be turned
7727 @node Shell Archives
7728 @subsection Shell Archives
7730 @cindex shell archives
7731 @cindex shared articles
7733 Shell archives (``shar files'') used to be a popular way to distribute
7734 sources, but it isn't used all that much today. In any case, we have
7735 some commands to deal with these:
7740 @kindex X s (Summary)
7741 @findex gnus-uu-decode-unshar
7742 Unshars the current series (@code{gnus-uu-decode-unshar}).
7745 @kindex X S (Summary)
7746 @findex gnus-uu-decode-unshar-and-save
7747 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7750 @kindex X v s (Summary)
7751 @findex gnus-uu-decode-unshar-view
7752 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7755 @kindex X v S (Summary)
7756 @findex gnus-uu-decode-unshar-and-save-view
7757 Unshars, views and saves the current series
7758 (@code{gnus-uu-decode-unshar-and-save-view}).
7762 @node PostScript Files
7763 @subsection PostScript Files
7769 @kindex X p (Summary)
7770 @findex gnus-uu-decode-postscript
7771 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7774 @kindex X P (Summary)
7775 @findex gnus-uu-decode-postscript-and-save
7776 Unpack and save the current PostScript series
7777 (@code{gnus-uu-decode-postscript-and-save}).
7780 @kindex X v p (Summary)
7781 @findex gnus-uu-decode-postscript-view
7782 View the current PostScript series
7783 (@code{gnus-uu-decode-postscript-view}).
7786 @kindex X v P (Summary)
7787 @findex gnus-uu-decode-postscript-and-save-view
7788 View and save the current PostScript series
7789 (@code{gnus-uu-decode-postscript-and-save-view}).
7794 @subsection Other Files
7798 @kindex X o (Summary)
7799 @findex gnus-uu-decode-save
7800 Save the current series
7801 (@code{gnus-uu-decode-save}).
7804 @kindex X b (Summary)
7805 @findex gnus-uu-decode-binhex
7806 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7807 doesn't really work yet.
7811 @node Decoding Variables
7812 @subsection Decoding Variables
7814 Adjective, not verb.
7817 * Rule Variables:: Variables that say how a file is to be viewed.
7818 * Other Decode Variables:: Other decode variables.
7819 * Uuencoding and Posting:: Variables for customizing uuencoding.
7823 @node Rule Variables
7824 @subsubsection Rule Variables
7825 @cindex rule variables
7827 Gnus uses @dfn{rule variables} to decide how to view a file. All these
7828 variables are of the form
7831 (list '(regexp1 command2)
7838 @item gnus-uu-user-view-rules
7839 @vindex gnus-uu-user-view-rules
7841 This variable is consulted first when viewing files. If you wish to use,
7842 for instance, @code{sox} to convert an @file{.au} sound file, you could
7845 (setq gnus-uu-user-view-rules
7846 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7849 @item gnus-uu-user-view-rules-end
7850 @vindex gnus-uu-user-view-rules-end
7851 This variable is consulted if Gnus couldn't make any matches from the
7852 user and default view rules.
7854 @item gnus-uu-user-archive-rules
7855 @vindex gnus-uu-user-archive-rules
7856 This variable can be used to say what commands should be used to unpack
7861 @node Other Decode Variables
7862 @subsubsection Other Decode Variables
7865 @vindex gnus-uu-grabbed-file-functions
7867 @item gnus-uu-grabbed-file-functions
7868 All functions in this list will be called right after each file has been
7869 successfully decoded---so that you can move or view files right away,
7870 and don't have to wait for all files to be decoded before you can do
7871 anything. Ready-made functions you can put in this list are:
7875 @item gnus-uu-grab-view
7876 @findex gnus-uu-grab-view
7879 @item gnus-uu-grab-move
7880 @findex gnus-uu-grab-move
7881 Move the file (if you're using a saving function.)
7884 @item gnus-uu-be-dangerous
7885 @vindex gnus-uu-be-dangerous
7886 Specifies what to do if unusual situations arise during decoding. If
7887 @code{nil}, be as conservative as possible. If @code{t}, ignore things
7888 that didn't work, and overwrite existing files. Otherwise, ask each
7891 @item gnus-uu-ignore-files-by-name
7892 @vindex gnus-uu-ignore-files-by-name
7893 Files with name matching this regular expression won't be viewed.
7895 @item gnus-uu-ignore-files-by-type
7896 @vindex gnus-uu-ignore-files-by-type
7897 Files with a @acronym{MIME} type matching this variable won't be viewed.
7898 Note that Gnus tries to guess what type the file is based on the name.
7899 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
7902 @item gnus-uu-tmp-dir
7903 @vindex gnus-uu-tmp-dir
7904 Where @code{gnus-uu} does its work.
7906 @item gnus-uu-do-not-unpack-archives
7907 @vindex gnus-uu-do-not-unpack-archives
7908 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7909 looking for files to display.
7911 @item gnus-uu-view-and-save
7912 @vindex gnus-uu-view-and-save
7913 Non-@code{nil} means that the user will always be asked to save a file
7916 @item gnus-uu-ignore-default-view-rules
7917 @vindex gnus-uu-ignore-default-view-rules
7918 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7921 @item gnus-uu-ignore-default-archive-rules
7922 @vindex gnus-uu-ignore-default-archive-rules
7923 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7926 @item gnus-uu-kill-carriage-return
7927 @vindex gnus-uu-kill-carriage-return
7928 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7931 @item gnus-uu-unmark-articles-not-decoded
7932 @vindex gnus-uu-unmark-articles-not-decoded
7933 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7934 decoded articles as unread.
7936 @item gnus-uu-correct-stripped-uucode
7937 @vindex gnus-uu-correct-stripped-uucode
7938 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7939 uuencoded files that have had trailing spaces deleted.
7941 @item gnus-uu-pre-uudecode-hook
7942 @vindex gnus-uu-pre-uudecode-hook
7943 Hook run before sending a message to @code{uudecode}.
7945 @item gnus-uu-view-with-metamail
7946 @vindex gnus-uu-view-with-metamail
7948 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7949 commands defined by the rule variables and just fudge a @acronym{MIME}
7950 content type based on the file name. The result will be fed to
7951 @code{metamail} for viewing.
7953 @item gnus-uu-save-in-digest
7954 @vindex gnus-uu-save-in-digest
7955 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7956 decoding, will save in digests. If this variable is @code{nil},
7957 @code{gnus-uu} will just save everything in a file without any
7958 embellishments. The digesting almost conforms to RFC 1153---no easy way
7959 to specify any meaningful volume and issue numbers were found, so I
7960 simply dropped them.
7965 @node Uuencoding and Posting
7966 @subsubsection Uuencoding and Posting
7970 @item gnus-uu-post-include-before-composing
7971 @vindex gnus-uu-post-include-before-composing
7972 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7973 before you compose the article. If this variable is @code{t}, you can
7974 either include an encoded file with @kbd{C-c C-i} or have one included
7975 for you when you post the article.
7977 @item gnus-uu-post-length
7978 @vindex gnus-uu-post-length
7979 Maximum length of an article. The encoded file will be split into how
7980 many articles it takes to post the entire file.
7982 @item gnus-uu-post-threaded
7983 @vindex gnus-uu-post-threaded
7984 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7985 thread. This may not be smart, as no other decoder I have seen is able
7986 to follow threads when collecting uuencoded articles. (Well, I have
7987 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7988 think that counts@dots{}) Default is @code{nil}.
7990 @item gnus-uu-post-separate-description
7991 @vindex gnus-uu-post-separate-description
7992 Non-@code{nil} means that the description will be posted in a separate
7993 article. The first article will typically be numbered (0/x). If this
7994 variable is @code{nil}, the description the user enters will be included
7995 at the beginning of the first article, which will be numbered (1/x).
7996 Default is @code{t}.
8002 @subsection Viewing Files
8003 @cindex viewing files
8004 @cindex pseudo-articles
8006 After decoding, if the file is some sort of archive, Gnus will attempt
8007 to unpack the archive and see if any of the files in the archive can be
8008 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
8009 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
8010 uncompress and de-tar the main file, and then view the two pictures.
8011 This unpacking process is recursive, so if the archive contains archives
8012 of archives, it'll all be unpacked.
8014 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
8015 extracted file into the summary buffer. If you go to these
8016 ``articles'', you will be prompted for a command to run (usually Gnus
8017 will make a suggestion), and then the command will be run.
8019 @vindex gnus-view-pseudo-asynchronously
8020 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
8021 until the viewing is done before proceeding.
8023 @vindex gnus-view-pseudos
8024 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8025 the pseudo-articles into the summary buffer, but view them
8026 immediately. If this variable is @code{not-confirm}, the user won't even
8027 be asked for a confirmation before viewing is done.
8029 @vindex gnus-view-pseudos-separately
8030 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8031 pseudo-article will be created for each file to be viewed. If
8032 @code{nil}, all files that use the same viewing command will be given as
8033 a list of parameters to that command.
8035 @vindex gnus-insert-pseudo-articles
8036 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8037 pseudo-articles when decoding. It is @code{t} by default.
8039 So; there you are, reading your @emph{pseudo-articles} in your
8040 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8041 Why isn't anything real anymore? How did we get here?
8044 @node Article Treatment
8045 @section Article Treatment
8047 Reading through this huge manual, you may have quite forgotten that the
8048 object of newsreaders is to actually, like, read what people have
8049 written. Reading articles. Unfortunately, people are quite bad at
8050 writing, so there are tons of functions and variables to make reading
8051 these articles easier.
8054 * Article Highlighting:: You want to make the article look like fruit salad.
8055 * Article Fontisizing:: Making emphasized text look nice.
8056 * Article Hiding:: You also want to make certain info go away.
8057 * Article Washing:: Lots of way-neat functions to make life better.
8058 * Article Header:: Doing various header transformations.
8059 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8060 * Article Button Levels:: Controlling appearance of buttons.
8061 * Article Date:: Grumble, UT!
8062 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8063 * Article Signature:: What is a signature?
8064 * Article Miscellanea:: Various other stuff.
8068 @node Article Highlighting
8069 @subsection Article Highlighting
8070 @cindex highlighting
8072 Not only do you want your article buffer to look like fruit salad, but
8073 you want it to look like technicolor fruit salad.
8078 @kindex W H a (Summary)
8079 @findex gnus-article-highlight
8080 @findex gnus-article-maybe-highlight
8081 Do much highlighting of the current article
8082 (@code{gnus-article-highlight}). This function highlights header, cited
8083 text, the signature, and adds buttons to the body and the head.
8086 @kindex W H h (Summary)
8087 @findex gnus-article-highlight-headers
8088 @vindex gnus-header-face-alist
8089 Highlight the headers (@code{gnus-article-highlight-headers}). The
8090 highlighting will be done according to the @code{gnus-header-face-alist}
8091 variable, which is a list where each element has the form
8092 @code{(@var{regexp} @var{name} @var{content})}.
8093 @var{regexp} is a regular expression for matching the
8094 header, @var{name} is the face used for highlighting the header name
8095 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8096 the header value. The first match made will be used. Note that
8097 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8100 @kindex W H c (Summary)
8101 @findex gnus-article-highlight-citation
8102 Highlight cited text (@code{gnus-article-highlight-citation}).
8104 Some variables to customize the citation highlights:
8107 @vindex gnus-cite-parse-max-size
8109 @item gnus-cite-parse-max-size
8110 If the article size if bigger than this variable (which is 25000 by
8111 default), no citation highlighting will be performed.
8113 @item gnus-cite-max-prefix
8114 @vindex gnus-cite-max-prefix
8115 Maximum possible length for a citation prefix (default 20).
8117 @item gnus-cite-face-list
8118 @vindex gnus-cite-face-list
8119 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8120 When there are citations from multiple articles in the same message,
8121 Gnus will try to give each citation from each article its own face.
8122 This should make it easier to see who wrote what.
8124 @item gnus-supercite-regexp
8125 @vindex gnus-supercite-regexp
8126 Regexp matching normal Supercite attribution lines.
8128 @item gnus-supercite-secondary-regexp
8129 @vindex gnus-supercite-secondary-regexp
8130 Regexp matching mangled Supercite attribution lines.
8132 @item gnus-cite-minimum-match-count
8133 @vindex gnus-cite-minimum-match-count
8134 Minimum number of identical prefixes we have to see before we believe
8135 that it's a citation.
8137 @item gnus-cite-attribution-prefix
8138 @vindex gnus-cite-attribution-prefix
8139 Regexp matching the beginning of an attribution line.
8141 @item gnus-cite-attribution-suffix
8142 @vindex gnus-cite-attribution-suffix
8143 Regexp matching the end of an attribution line.
8145 @item gnus-cite-attribution-face
8146 @vindex gnus-cite-attribution-face
8147 Face used for attribution lines. It is merged with the face for the
8148 cited text belonging to the attribution.
8154 @kindex W H s (Summary)
8155 @vindex gnus-signature-separator
8156 @vindex gnus-signature-face
8157 @findex gnus-article-highlight-signature
8158 Highlight the signature (@code{gnus-article-highlight-signature}).
8159 Everything after @code{gnus-signature-separator} (@pxref{Article
8160 Signature}) in an article will be considered a signature and will be
8161 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8166 @xref{Customizing Articles}, for how to highlight articles automatically.
8169 @node Article Fontisizing
8170 @subsection Article Fontisizing
8172 @cindex article emphasis
8174 @findex gnus-article-emphasize
8175 @kindex W e (Summary)
8176 People commonly add emphasis to words in news articles by writing things
8177 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8178 this look nicer by running the article through the @kbd{W e}
8179 (@code{gnus-article-emphasize}) command.
8181 @vindex gnus-emphasis-alist
8182 How the emphasis is computed is controlled by the
8183 @code{gnus-emphasis-alist} variable. This is an alist where the first
8184 element is a regular expression to be matched. The second is a number
8185 that says what regular expression grouping is used to find the entire
8186 emphasized word. The third is a number that says what regexp grouping
8187 should be displayed and highlighted. (The text between these two
8188 groupings will be hidden.) The fourth is the face used for
8192 (setq gnus-emphasis-alist
8193 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8194 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8203 @vindex gnus-emphasis-underline
8204 @vindex gnus-emphasis-bold
8205 @vindex gnus-emphasis-italic
8206 @vindex gnus-emphasis-underline-bold
8207 @vindex gnus-emphasis-underline-italic
8208 @vindex gnus-emphasis-bold-italic
8209 @vindex gnus-emphasis-underline-bold-italic
8210 By default, there are seven rules, and they use the following faces:
8211 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8212 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8213 @code{gnus-emphasis-underline-italic},
8214 @code{gnus-emphasis-underline-bold}, and
8215 @code{gnus-emphasis-underline-bold-italic}.
8217 If you want to change these faces, you can either use @kbd{M-x
8218 customize}, or you can use @code{copy-face}. For instance, if you want
8219 to make @code{gnus-emphasis-italic} use a red face instead, you could
8223 (copy-face 'red 'gnus-emphasis-italic)
8226 @vindex gnus-group-highlight-words-alist
8228 If you want to highlight arbitrary words, you can use the
8229 @code{gnus-group-highlight-words-alist} variable, which uses the same
8230 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8231 parameter (@pxref{Group Parameters}) can also be used.
8233 @xref{Customizing Articles}, for how to fontize articles automatically.
8236 @node Article Hiding
8237 @subsection Article Hiding
8238 @cindex article hiding
8240 Or rather, hiding certain things in each article. There usually is much
8241 too much cruft in most articles.
8246 @kindex W W a (Summary)
8247 @findex gnus-article-hide
8248 Do quite a lot of hiding on the article buffer
8249 (@kbd{gnus-article-hide}). In particular, this function will hide
8250 headers, @acronym{PGP}, cited text and the signature.
8253 @kindex W W h (Summary)
8254 @findex gnus-article-hide-headers
8255 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8259 @kindex W W b (Summary)
8260 @findex gnus-article-hide-boring-headers
8261 Hide headers that aren't particularly interesting
8262 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8265 @kindex W W s (Summary)
8266 @findex gnus-article-hide-signature
8267 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8271 @kindex W W l (Summary)
8272 @findex gnus-article-hide-list-identifiers
8273 @vindex gnus-list-identifiers
8274 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8275 are strings some mailing list servers add to the beginning of all
8276 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8277 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8278 may not contain @code{\\(..\\)}.
8282 @item gnus-list-identifiers
8283 @vindex gnus-list-identifiers
8284 A regular expression that matches list identifiers to be removed from
8285 subject. This can also be a list of regular expressions.
8290 @kindex W W P (Summary)
8291 @findex gnus-article-hide-pem
8292 Hide @acronym{PEM} (privacy enhanced messages) cruft
8293 (@code{gnus-article-hide-pem}).
8296 @kindex W W B (Summary)
8297 @findex gnus-article-strip-banner
8298 @vindex gnus-article-banner-alist
8299 @vindex gnus-article-address-banner-alist
8302 @cindex stripping advertisements
8303 @cindex advertisements
8304 Strip the banner specified by the @code{banner} group parameter
8305 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8306 annoying banners and/or signatures that some mailing lists and moderated
8307 groups adds to all the messages. The way to use this function is to add
8308 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8309 group you want banners stripped from. The parameter either be a string,
8310 which will be interpreted as a regular expression matching text to be
8311 removed, or the symbol @code{signature}, meaning that the (last)
8312 signature should be removed, or other symbol, meaning that the
8313 corresponding regular expression in @code{gnus-article-banner-alist} is
8316 Regardless of a group, you can hide things like advertisements only when
8317 the sender of an article has a certain mail address specified in
8318 @code{gnus-article-address-banner-alist}.
8322 @item gnus-article-address-banner-alist
8323 @vindex gnus-article-address-banner-alist
8324 Alist of mail addresses and banners. Each element has the form
8325 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8326 matching a mail address in the From header, @var{banner} is one of a
8327 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8328 a regexp and @code{nil}. If @var{address} matches author's mail
8329 address, it will remove things like advertisements. For example, if a
8330 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8331 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8332 sends, you can use the following element to remove them:
8335 ("@@yoo-hoo\\.co\\.jp\\'" .
8336 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8342 @kindex W W c (Summary)
8343 @findex gnus-article-hide-citation
8344 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8345 customizing the hiding:
8349 @item gnus-cited-opened-text-button-line-format
8350 @itemx gnus-cited-closed-text-button-line-format
8351 @vindex gnus-cited-closed-text-button-line-format
8352 @vindex gnus-cited-opened-text-button-line-format
8353 Gnus adds buttons to show where the cited text has been hidden, and to
8354 allow toggle hiding the text. The format of the variable is specified
8355 by these format-like variable (@pxref{Formatting Variables}). These
8360 Starting point of the hidden text.
8362 Ending point of the hidden text.
8364 Number of characters in the hidden region.
8366 Number of lines of hidden text.
8369 @item gnus-cited-lines-visible
8370 @vindex gnus-cited-lines-visible
8371 The number of lines at the beginning of the cited text to leave
8372 shown. This can also be a cons cell with the number of lines at the top
8373 and bottom of the text, respectively, to remain visible.
8378 @kindex W W C-c (Summary)
8379 @findex gnus-article-hide-citation-maybe
8381 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8382 following two variables:
8385 @item gnus-cite-hide-percentage
8386 @vindex gnus-cite-hide-percentage
8387 If the cited text is of a bigger percentage than this variable (default
8388 50), hide the cited text.
8390 @item gnus-cite-hide-absolute
8391 @vindex gnus-cite-hide-absolute
8392 The cited text must have at least this length (default 10) before it
8397 @kindex W W C (Summary)
8398 @findex gnus-article-hide-citation-in-followups
8399 Hide cited text in articles that aren't roots
8400 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8401 useful as an interactive command, but might be a handy function to stick
8402 have happen automatically (@pxref{Customizing Articles}).
8406 All these ``hiding'' commands are toggles, but if you give a negative
8407 prefix to these commands, they will show what they have previously
8408 hidden. If you give a positive prefix, they will always hide.
8410 Also @pxref{Article Highlighting} for further variables for
8411 citation customization.
8413 @xref{Customizing Articles}, for how to hide article elements
8417 @node Article Washing
8418 @subsection Article Washing
8420 @cindex article washing
8422 We call this ``article washing'' for a really good reason. Namely, the
8423 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8425 @dfn{Washing} is defined by us as ``changing something from something to
8426 something else'', but normally results in something looking better.
8429 @xref{Customizing Articles}, if you want to change how Gnus displays
8430 articles by default.
8435 This is not really washing, it's sort of the opposite of washing. If
8436 you type this, you see the article exactly as it exists on disk or on
8440 Force redisplaying of the current article
8441 (@code{gnus-summary-show-article}). This is also not really washing.
8442 If you type this, you see the article without any previously applied
8443 interactive Washing functions but with all default treatments
8444 (@pxref{Customizing Articles}).
8447 @kindex W l (Summary)
8448 @findex gnus-summary-stop-page-breaking
8449 Remove page breaks from the current article
8450 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8454 @kindex W r (Summary)
8455 @findex gnus-summary-caesar-message
8456 @c @icon{gnus-summary-caesar-message}
8457 Do a Caesar rotate (rot13) on the article buffer
8458 (@code{gnus-summary-caesar-message}).
8459 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8460 (Typically offensive jokes and such.)
8462 It's commonly called ``rot13'' because each letter is rotated 13
8463 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8464 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8465 is rumored to have employed this form of, uh, somewhat weak encryption.
8468 @kindex W m (Summary)
8469 @findex gnus-summary-morse-message
8470 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8474 @kindex W t (Summary)
8476 @findex gnus-summary-toggle-header
8477 Toggle whether to display all headers in the article buffer
8478 (@code{gnus-summary-toggle-header}).
8481 @kindex W v (Summary)
8482 @findex gnus-summary-verbose-headers
8483 Toggle whether to display all headers in the article buffer permanently
8484 (@code{gnus-summary-verbose-headers}).
8487 @kindex W o (Summary)
8488 @findex gnus-article-treat-overstrike
8489 Treat overstrike (@code{gnus-article-treat-overstrike}).
8492 @kindex W d (Summary)
8493 @findex gnus-article-treat-dumbquotes
8494 @vindex gnus-article-dumbquotes-map
8496 @cindex M****s*** sm*rtq**t*s
8498 Treat M****s*** sm*rtq**t*s according to
8499 @code{gnus-article-dumbquotes-map}
8500 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8501 whether a character is a sm*rtq**t* or not, so it should only be used
8504 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8505 an attempt to provide more quoting characters. If you see something
8506 like @code{\222} or @code{\264} where you're expecting some kind of
8507 apostrophe or quotation mark, then try this wash.
8510 @kindex W Y f (Summary)
8511 @findex gnus-article-outlook-deuglify-article
8512 @cindex Outlook Express
8513 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8514 unwrap lines, repair attribution and rearrange citation.
8515 (@code{gnus-article-outlook-deuglify-article}).
8518 @kindex W Y u (Summary)
8519 @findex gnus-article-outlook-unwrap-lines
8520 @vindex gnus-outlook-deuglify-unwrap-min
8521 @vindex gnus-outlook-deuglify-unwrap-max
8522 Unwrap lines that appear to be wrapped citation lines. You can control
8523 what lines will be unwrapped by frobbing
8524 @code{gnus-outlook-deuglify-unwrap-min} and
8525 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8526 maximum length of an unwrapped citation line.
8527 (@code{gnus-article-outlook-unwrap-lines}).
8530 @kindex W Y a (Summary)
8531 @findex gnus-article-outlook-repair-attribution
8532 Repair a broken attribution line.@*
8533 (@code{gnus-article-outlook-repair-attribution}).
8536 @kindex W Y c (Summary)
8537 @findex gnus-article-outlook-rearrange-citation
8538 Repair broken citations by rearranging the text.
8539 (@code{gnus-article-outlook-rearrange-citation}).
8542 @kindex W w (Summary)
8543 @findex gnus-article-fill-cited-article
8544 Do word wrap (@code{gnus-article-fill-cited-article}).
8546 You can give the command a numerical prefix to specify the width to use
8550 @kindex W Q (Summary)
8551 @findex gnus-article-fill-long-lines
8552 Fill long lines (@code{gnus-article-fill-long-lines}).
8555 @kindex W C (Summary)
8556 @findex gnus-article-capitalize-sentences
8557 Capitalize the first word in each sentence
8558 (@code{gnus-article-capitalize-sentences}).
8561 @kindex W c (Summary)
8562 @findex gnus-article-remove-cr
8563 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8564 (this takes care of DOS line endings), and then translate any remaining
8565 CRs into LF (this takes care of Mac line endings)
8566 (@code{gnus-article-remove-cr}).
8569 @kindex W q (Summary)
8570 @findex gnus-article-de-quoted-unreadable
8571 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8572 Quoted-Printable is one common @acronym{MIME} encoding employed when
8573 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8574 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
8575 which doesn't look very readable to me. Note that this is usually
8576 done automatically by Gnus if the message in question has a
8577 @code{Content-Transfer-Encoding} header that says that this encoding
8578 has been done. If a prefix is given, a charset will be asked for.
8581 @kindex W 6 (Summary)
8582 @findex gnus-article-de-base64-unreadable
8583 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8584 one common @acronym{MIME} encoding employed when sending
8585 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8586 usually done automatically by Gnus if the message in question has a
8587 @code{Content-Transfer-Encoding} header that says that this encoding
8588 has been done. If a prefix is given, a charset will be asked for.
8591 @kindex W Z (Summary)
8592 @findex gnus-article-decode-HZ
8593 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8594 common encoding employed when sending Chinese articles. It typically
8595 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8598 @kindex W A (Summary)
8599 @findex gnus-article-treat-ansi-sequences
8600 @cindex @acronym{ANSI} control sequences
8601 Translate @acronym{ANSI} SGR control sequences into overlays or
8602 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
8603 sequences are used in some Chinese hierarchies for highlighting.
8606 @kindex W u (Summary)
8607 @findex gnus-article-unsplit-urls
8608 Remove newlines from within URLs. Some mailers insert newlines into
8609 outgoing email messages to keep lines short. This reformatting can
8610 split long URLs onto multiple lines. Repair those URLs by removing
8611 the newlines (@code{gnus-article-unsplit-urls}).
8614 @kindex W h (Summary)
8615 @findex gnus-article-wash-html
8616 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
8617 usually done automatically by Gnus if the message in question has a
8618 @code{Content-Type} header that says that the message is @acronym{HTML}.
8620 If a prefix is given, a charset will be asked for.
8622 @vindex gnus-article-wash-function
8623 The default is to use the function specified by
8624 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
8625 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8626 @acronym{HTML}, but this is controlled by the
8627 @code{gnus-article-wash-function} variable. Pre-defined functions you
8635 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
8638 Use @uref{http://links.sf.net/, Links}.
8641 Use @uref{http://lynx.isc.org/, Lynx}.
8644 Use html2text---a simple @acronym{HTML} converter included with Gnus.
8649 @kindex W b (Summary)
8650 @findex gnus-article-add-buttons
8651 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8652 @xref{Article Buttons}.
8655 @kindex W B (Summary)
8656 @findex gnus-article-add-buttons-to-head
8657 Add clickable buttons to the article headers
8658 (@code{gnus-article-add-buttons-to-head}).
8661 @kindex W p (Summary)
8662 @findex gnus-article-verify-x-pgp-sig
8663 Verify a signed control message
8664 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
8665 @code{newgroup} and @code{checkgroups} are usually signed by the
8666 hierarchy maintainer. You need to add the @acronym{PGP} public key of
8667 the maintainer to your keyring to verify the
8668 message.@footnote{@acronym{PGP} keys for many hierarchies are
8669 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8672 @kindex W s (Summary)
8673 @findex gnus-summary-force-verify-and-decrypt
8674 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
8675 @acronym{S/MIME}) message
8676 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8679 @kindex W a (Summary)
8680 @findex gnus-article-strip-headers-in-body
8681 Strip headers like the @code{X-No-Archive} header from the beginning of
8682 article bodies (@code{gnus-article-strip-headers-in-body}).
8685 @kindex W E l (Summary)
8686 @findex gnus-article-strip-leading-blank-lines
8687 Remove all blank lines from the beginning of the article
8688 (@code{gnus-article-strip-leading-blank-lines}).
8691 @kindex W E m (Summary)
8692 @findex gnus-article-strip-multiple-blank-lines
8693 Replace all blank lines with empty lines and then all multiple empty
8694 lines with a single empty line.
8695 (@code{gnus-article-strip-multiple-blank-lines}).
8698 @kindex W E t (Summary)
8699 @findex gnus-article-remove-trailing-blank-lines
8700 Remove all blank lines at the end of the article
8701 (@code{gnus-article-remove-trailing-blank-lines}).
8704 @kindex W E a (Summary)
8705 @findex gnus-article-strip-blank-lines
8706 Do all the three commands above
8707 (@code{gnus-article-strip-blank-lines}).
8710 @kindex W E A (Summary)
8711 @findex gnus-article-strip-all-blank-lines
8712 Remove all blank lines
8713 (@code{gnus-article-strip-all-blank-lines}).
8716 @kindex W E s (Summary)
8717 @findex gnus-article-strip-leading-space
8718 Remove all white space from the beginning of all lines of the article
8719 body (@code{gnus-article-strip-leading-space}).
8722 @kindex W E e (Summary)
8723 @findex gnus-article-strip-trailing-space
8724 Remove all white space from the end of all lines of the article
8725 body (@code{gnus-article-strip-trailing-space}).
8729 @xref{Customizing Articles}, for how to wash articles automatically.
8732 @node Article Header
8733 @subsection Article Header
8735 These commands perform various transformations of article header.
8740 @kindex W G u (Summary)
8741 @findex gnus-article-treat-unfold-headers
8742 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8745 @kindex W G n (Summary)
8746 @findex gnus-article-treat-fold-newsgroups
8747 Fold the @code{Newsgroups} and @code{Followup-To} headers
8748 (@code{gnus-article-treat-fold-newsgroups}).
8751 @kindex W G f (Summary)
8752 @findex gnus-article-treat-fold-headers
8753 Fold all the message headers
8754 (@code{gnus-article-treat-fold-headers}).
8757 @kindex W E w (Summary)
8758 @findex gnus-article-remove-leading-whitespace
8759 Remove excessive whitespace from all headers
8760 (@code{gnus-article-remove-leading-whitespace}).
8765 @node Article Buttons
8766 @subsection Article Buttons
8769 People often include references to other stuff in articles, and it would
8770 be nice if Gnus could just fetch whatever it is that people talk about
8771 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8772 button on these references.
8774 @vindex gnus-button-man-handler
8775 Gnus adds @dfn{buttons} to certain standard references by default:
8776 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
8777 Emacs or Gnus related references. This is controlled by two variables,
8778 one that handles article bodies and one that handles article heads:
8782 @item gnus-button-alist
8783 @vindex gnus-button-alist
8784 This is an alist where each entry has this form:
8787 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8793 All text that match this regular expression (case insensitive) will be
8794 considered an external reference. Here's a typical regexp that matches
8795 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
8796 variable containing a regexp, useful variables to use include
8797 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
8800 Gnus has to know which parts of the matches is to be highlighted. This
8801 is a number that says what sub-expression of the regexp is to be
8802 highlighted. If you want it all highlighted, you use 0 here.
8805 This form will be @code{eval}ed, and if the result is non-@code{nil},
8806 this is considered a match. This is useful if you want extra sifting to
8807 avoid false matches. Often variables named
8808 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
8809 Levels}, but any other form may be used too.
8811 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
8814 This function will be called when you click on this button.
8817 As with @var{button-par}, this is a sub-expression number, but this one
8818 says which part of the match is to be sent as data to @var{function}.
8822 So the full entry for buttonizing URLs is then
8825 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8828 @item gnus-header-button-alist
8829 @vindex gnus-header-button-alist
8830 This is just like the other alist, except that it is applied to the
8831 article head only, and that each entry has an additional element that is
8832 used to say what headers to apply the buttonize coding to:
8835 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8838 @var{header} is a regular expression.
8841 @subsubsection Related variables and functions
8844 @item gnus-button-@var{*}-level
8845 @xref{Article Button Levels}.
8847 @c Stuff related to gnus-button-browse-level
8849 @item gnus-button-url-regexp
8850 @vindex gnus-button-url-regexp
8851 A regular expression that matches embedded URLs. It is used in the
8852 default values of the variables above.
8854 @c Stuff related to gnus-button-man-level
8856 @item gnus-button-man-handler
8857 @vindex gnus-button-man-handler
8858 The function to use for displaying man pages. It must take at least one
8859 argument with a string naming the man page.
8861 @c Stuff related to gnus-button-message-level
8863 @item gnus-button-mid-or-mail-regexp
8864 @vindex gnus-button-mid-or-mail-regexp
8865 Regular expression that matches a message ID or a mail address.
8867 @item gnus-button-prefer-mid-or-mail
8868 @vindex gnus-button-prefer-mid-or-mail
8869 This variable determines what to do when the button on a string as
8870 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
8871 message ID or a mail address. If it is one of the symbols @code{mid} or
8872 @code{mail}, Gnus will always assume that the string is a message ID or
8873 a mail address, respectively. If this variable is set to the symbol
8874 @code{ask}, always query the user what do do. If it is a function, this
8875 function will be called with the string as its only argument. The
8876 function must return @code{mid}, @code{mail}, @code{invalid} or
8877 @code{ask}. The default value is the function
8878 @code{gnus-button-mid-or-mail-heuristic}.
8880 @item gnus-button-mid-or-mail-heuristic
8881 @findex gnus-button-mid-or-mail-heuristic
8882 Function that guesses whether its argument is a message ID or a mail
8883 address. Returns @code{mid} if it's a message IDs, @code{mail} if
8884 it's a mail address, @code{ask} if unsure and @code{invalid} if the
8887 @item gnus-button-mid-or-mail-heuristic-alist
8888 @vindex gnus-button-mid-or-mail-heuristic-alist
8889 An alist of @code{(RATE . REGEXP)} pairs used by the function
8890 @code{gnus-button-mid-or-mail-heuristic}.
8892 @c Stuff related to gnus-button-tex-level
8894 @item gnus-button-ctan-handler
8895 @findex gnus-button-ctan-handler
8896 The function to use for displaying CTAN links. It must take one
8897 argument, the string naming the URL.
8900 @vindex gnus-ctan-url
8901 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
8902 by @code{gnus-button-ctan-handler}.
8906 @item gnus-article-button-face
8907 @vindex gnus-article-button-face
8908 Face used on buttons.
8910 @item gnus-article-mouse-face
8911 @vindex gnus-article-mouse-face
8912 Face used when the mouse cursor is over a button.
8916 @xref{Customizing Articles}, for how to buttonize articles automatically.
8919 @node Article Button Levels
8920 @subsection Article button levels
8921 @cindex button levels
8922 The higher the value of the variables @code{gnus-button-@var{*}-level},
8923 the more buttons will appear. If the level is zero, no corresponding
8924 buttons are displayed. With the default value (which is 5) you should
8925 already see quite a lot of buttons. With higher levels, you will see
8926 more buttons, but you may also get more false positives. To avoid them,
8927 you can set the variables @code{gnus-button-@var{*}-level} local to
8928 specific groups (@pxref{Group Parameters}). Here's an example for the
8929 variable @code{gnus-parameters}:
8932 ;; @r{increase @code{gnus-button-*-level} in some groups:}
8933 (setq gnus-parameters
8934 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
8935 ("\\<unix\\>" (gnus-button-man-level 10))
8936 ("\\<tex\\>" (gnus-button-tex-level 10))))
8941 @item gnus-button-browse-level
8942 @vindex gnus-button-browse-level
8943 Controls the display of references to message IDs, mail addresses and
8944 news URLs. Related variables and functions include
8945 @code{gnus-button-url-regexp}, @code{browse-url}, and
8946 @code{browse-url-browser-function}.
8948 @item gnus-button-emacs-level
8949 @vindex gnus-button-emacs-level
8950 Controls the display of Emacs or Gnus references. Related functions are
8951 @code{gnus-button-handle-custom},
8952 @code{gnus-button-handle-describe-function},
8953 @code{gnus-button-handle-describe-variable},
8954 @code{gnus-button-handle-symbol},
8955 @code{gnus-button-handle-describe-key},
8956 @code{gnus-button-handle-apropos},
8957 @code{gnus-button-handle-apropos-command},
8958 @code{gnus-button-handle-apropos-variable},
8959 @code{gnus-button-handle-apropos-documentation}, and
8960 @code{gnus-button-handle-library}.
8962 @item gnus-button-man-level
8963 @vindex gnus-button-man-level
8964 Controls the display of references to (Unix) man pages.
8965 See @code{gnus-button-man-handler}.
8967 @item gnus-button-message-level
8968 @vindex gnus-button-message-level
8969 Controls the display of message IDs, mail addresses and news URLs.
8970 Related variables and functions include
8971 @code{gnus-button-mid-or-mail-regexp},
8972 @code{gnus-button-prefer-mid-or-mail},
8973 @code{gnus-button-mid-or-mail-heuristic}, and
8974 @code{gnus-button-mid-or-mail-heuristic-alist}.
8976 @item gnus-button-tex-level
8977 @vindex gnus-button-tex-level
8978 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
8979 URLs. See the variables @code{gnus-ctan-url},
8980 @code{gnus-button-ctan-handler},
8981 @code{gnus-button-ctan-directory-regexp}, and
8982 @code{gnus-button-handle-ctan-bogus-regexp}.
8988 @subsection Article Date
8990 The date is most likely generated in some obscure timezone you've never
8991 heard of, so it's quite nice to be able to find out what the time was
8992 when the article was sent.
8997 @kindex W T u (Summary)
8998 @findex gnus-article-date-ut
8999 Display the date in UT (aka. GMT, aka ZULU)
9000 (@code{gnus-article-date-ut}).
9003 @kindex W T i (Summary)
9004 @findex gnus-article-date-iso8601
9006 Display the date in international format, aka. ISO 8601
9007 (@code{gnus-article-date-iso8601}).
9010 @kindex W T l (Summary)
9011 @findex gnus-article-date-local
9012 Display the date in the local timezone (@code{gnus-article-date-local}).
9015 @kindex W T p (Summary)
9016 @findex gnus-article-date-english
9017 Display the date in a format that's easily pronounceable in English
9018 (@code{gnus-article-date-english}).
9021 @kindex W T s (Summary)
9022 @vindex gnus-article-time-format
9023 @findex gnus-article-date-user
9024 @findex format-time-string
9025 Display the date using a user-defined format
9026 (@code{gnus-article-date-user}). The format is specified by the
9027 @code{gnus-article-time-format} variable, and is a string that's passed
9028 to @code{format-time-string}. See the documentation of that variable
9029 for a list of possible format specs.
9032 @kindex W T e (Summary)
9033 @findex gnus-article-date-lapsed
9034 @findex gnus-start-date-timer
9035 @findex gnus-stop-date-timer
9036 Say how much time has elapsed between the article was posted and now
9037 (@code{gnus-article-date-lapsed}). It looks something like:
9040 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9043 @vindex gnus-article-date-lapsed-new-header
9044 The value of @code{gnus-article-date-lapsed-new-header} determines
9045 whether this header will just be added below the old Date one, or will
9048 An advantage of using Gnus to read mail is that it converts simple bugs
9049 into wonderful absurdities.
9051 If you want to have this line updated continually, you can put
9054 (gnus-start-date-timer)
9057 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9058 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9062 @kindex W T o (Summary)
9063 @findex gnus-article-date-original
9064 Display the original date (@code{gnus-article-date-original}). This can
9065 be useful if you normally use some other conversion function and are
9066 worried that it might be doing something totally wrong. Say, claiming
9067 that the article was posted in 1854. Although something like that is
9068 @emph{totally} impossible. Don't you trust me? *titter*
9072 @xref{Customizing Articles}, for how to display the date in your
9073 preferred format automatically.
9076 @node Article Display
9077 @subsection Article Display
9082 These commands add various frivolous display gimmicks to the article
9083 buffer in Emacs versions that support them.
9085 @code{X-Face} headers are small black-and-white images supplied by the
9086 message headers (@pxref{X-Face}).
9088 @code{Face} headers are small colored images supplied by the message
9089 headers (@pxref{Face}).
9091 Smileys are those little @samp{:-)} symbols that people like to litter
9092 their messages with (@pxref{Smileys}).
9094 Picons, on the other hand, reside on your own system, and Gnus will
9095 try to match the headers to what you have (@pxref{Picons}).
9097 All these functions are toggles---if the elements already exist,
9102 @kindex W D x (Summary)
9103 @findex gnus-article-display-x-face
9104 Display an @code{X-Face} in the @code{From} header.
9105 (@code{gnus-article-display-x-face}).
9108 @kindex W D d (Summary)
9109 @findex gnus-article-display-face
9110 Display a @code{Face} in the @code{From} header.
9111 (@code{gnus-article-display-face}).
9114 @kindex W D s (Summary)
9115 @findex gnus-treat-smiley
9116 Display smileys (@code{gnus-treat-smiley}).
9119 @kindex W D f (Summary)
9120 @findex gnus-treat-from-picon
9121 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9124 @kindex W D m (Summary)
9125 @findex gnus-treat-mail-picon
9126 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9127 (@code{gnus-treat-mail-picon}).
9130 @kindex W D n (Summary)
9131 @findex gnus-treat-newsgroups-picon
9132 Piconify all news headers (i. e., @code{Newsgroups} and
9133 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9136 @kindex W D D (Summary)
9137 @findex gnus-article-remove-images
9138 Remove all images from the article buffer
9139 (@code{gnus-article-remove-images}).
9145 @node Article Signature
9146 @subsection Article Signature
9148 @cindex article signature
9150 @vindex gnus-signature-separator
9151 Each article is divided into two parts---the head and the body. The
9152 body can be divided into a signature part and a text part. The variable
9153 that says what is to be considered a signature is
9154 @code{gnus-signature-separator}. This is normally the standard
9155 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9156 non-standard signature separators, so this variable can also be a list
9157 of regular expressions to be tested, one by one. (Searches are done
9158 from the end of the body towards the beginning.) One likely value is:
9161 (setq gnus-signature-separator
9162 '("^-- $" ; @r{The standard}
9163 "^-- *$" ; @r{A common mangling}
9164 "^-------*$" ; @r{Many people just use a looong}
9165 ; @r{line of dashes. Shame!}
9166 "^ *--------*$" ; @r{Double-shame!}
9167 "^________*$" ; @r{Underscores are also popular}
9168 "^========*$")) ; @r{Pervert!}
9171 The more permissive you are, the more likely it is that you'll get false
9174 @vindex gnus-signature-limit
9175 @code{gnus-signature-limit} provides a limit to what is considered a
9176 signature when displaying articles.
9180 If it is an integer, no signature may be longer (in characters) than
9183 If it is a floating point number, no signature may be longer (in lines)
9186 If it is a function, the function will be called without any parameters,
9187 and if it returns @code{nil}, there is no signature in the buffer.
9189 If it is a string, it will be used as a regexp. If it matches, the text
9190 in question is not a signature.
9193 This variable can also be a list where the elements may be of the types
9194 listed above. Here's an example:
9197 (setq gnus-signature-limit
9198 '(200.0 "^---*Forwarded article"))
9201 This means that if there are more than 200 lines after the signature
9202 separator, or the text after the signature separator is matched by
9203 the regular expression @samp{^---*Forwarded article}, then it isn't a
9204 signature after all.
9207 @node Article Miscellanea
9208 @subsection Article Miscellanea
9212 @kindex A t (Summary)
9213 @findex gnus-article-babel
9214 Translate the article from one language to another
9215 (@code{gnus-article-babel}).
9221 @section MIME Commands
9222 @cindex MIME decoding
9224 @cindex viewing attachments
9226 The following commands all understand the numerical prefix. For
9227 instance, @kbd{3 b} means ``view the third @acronym{MIME} part''.
9233 @kindex K v (Summary)
9234 View the @acronym{MIME} part.
9237 @kindex K o (Summary)
9238 Save the @acronym{MIME} part.
9241 @kindex K c (Summary)
9242 Copy the @acronym{MIME} part.
9245 @kindex K e (Summary)
9246 View the @acronym{MIME} part externally.
9249 @kindex K i (Summary)
9250 View the @acronym{MIME} part internally.
9253 @kindex K | (Summary)
9254 Pipe the @acronym{MIME} part to an external command.
9257 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9262 @kindex K b (Summary)
9263 Make all the @acronym{MIME} parts have buttons in front of them. This is
9264 mostly useful if you wish to save (or perform other actions) on inlined
9268 @kindex K m (Summary)
9269 @findex gnus-summary-repair-multipart
9270 Some multipart messages are transmitted with missing or faulty headers.
9271 This command will attempt to ``repair'' these messages so that they can
9272 be viewed in a more pleasant manner
9273 (@code{gnus-summary-repair-multipart}).
9276 @kindex X m (Summary)
9277 @findex gnus-summary-save-parts
9278 Save all parts matching a @acronym{MIME} type to a directory
9279 (@code{gnus-summary-save-parts}). Understands the process/prefix
9280 convention (@pxref{Process/Prefix}).
9283 @kindex M-t (Summary)
9284 @findex gnus-summary-toggle-display-buttonized
9285 Toggle the buttonized display of the article buffer
9286 (@code{gnus-summary-toggle-display-buttonized}).
9289 @kindex W M w (Summary)
9290 @findex gnus-article-decode-mime-words
9291 Decode RFC 2047-encoded words in the article headers
9292 (@code{gnus-article-decode-mime-words}).
9295 @kindex W M c (Summary)
9296 @findex gnus-article-decode-charset
9297 Decode encoded article bodies as well as charsets
9298 (@code{gnus-article-decode-charset}).
9300 This command looks in the @code{Content-Type} header to determine the
9301 charset. If there is no such header in the article, you can give it a
9302 prefix, which will prompt for the charset to decode as. In regional
9303 groups where people post using some common encoding (but do not
9304 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9305 parameter to the required charset (@pxref{Group Parameters}).
9308 @kindex W M v (Summary)
9309 @findex gnus-mime-view-all-parts
9310 View all the @acronym{MIME} parts in the current article
9311 (@code{gnus-mime-view-all-parts}).
9318 @item gnus-ignored-mime-types
9319 @vindex gnus-ignored-mime-types
9320 This is a list of regexps. @acronym{MIME} types that match a regexp from
9321 this list will be completely ignored by Gnus. The default value is
9324 To have all Vcards be ignored, you'd say something like this:
9327 (setq gnus-ignored-mime-types
9331 @item gnus-article-loose-mime
9332 @vindex gnus-article-loose-mime
9333 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9334 before interpreting the message as a @acronym{MIME} message. This helps
9335 when reading messages from certain broken mail user agents. The
9336 default is @code{nil}.
9338 @item gnus-article-emulate-mime
9339 @vindex gnus-article-emulate-mime
9340 There are other, non-@acronym{MIME} encoding methods used. The most common
9341 is @samp{uuencode}, but yEncode is also getting to be popular. If
9342 this variable is non-@code{nil}, Gnus will look in message bodies to
9343 see if it finds these encodings, and if so, it'll run them through the
9344 Gnus @acronym{MIME} machinery. The default is @code{t}.
9346 @item gnus-unbuttonized-mime-types
9347 @vindex gnus-unbuttonized-mime-types
9348 This is a list of regexps. @acronym{MIME} types that match a regexp from
9349 this list won't have @acronym{MIME} buttons inserted unless they aren't
9350 displayed or this variable is overridden by
9351 @code{gnus-buttonized-mime-types}. The default value is
9352 @code{(".*/.*")}. This variable is only used when
9353 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9355 @item gnus-buttonized-mime-types
9356 @vindex gnus-buttonized-mime-types
9357 This is a list of regexps. @acronym{MIME} types that match a regexp from
9358 this list will have @acronym{MIME} buttons inserted unless they aren't
9359 displayed. This variable overrides
9360 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9361 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9364 To see e.g. security buttons but no other buttons, you could set this
9365 variable to @code{("multipart/signed")} and leave
9366 @code{gnus-unbuttonized-mime-types} at the default value.
9368 @item gnus-inhibit-mime-unbuttonizing
9369 @vindex gnus-inhibit-mime-unbuttonizing
9370 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9371 default value is @code{nil}.
9373 @item gnus-article-mime-part-function
9374 @vindex gnus-article-mime-part-function
9375 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9376 handle as the parameter. The function is meant to be used to allow
9377 users to gather information from the article (e. g., add Vcard info to
9378 the bbdb database) or to do actions based on parts (e. g., automatically
9379 save all jpegs into some directory).
9381 Here's an example function the does the latter:
9384 (defun my-save-all-jpeg-parts (handle)
9385 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9387 (insert (mm-get-part handle))
9388 (write-region (point-min) (point-max)
9389 (read-file-name "Save jpeg to: ")))))
9390 (setq gnus-article-mime-part-function
9391 'my-save-all-jpeg-parts)
9394 @vindex gnus-mime-multipart-functions
9395 @item gnus-mime-multipart-functions
9396 Alist of @acronym{MIME} multipart types and functions to handle them.
9398 @vindex gnus-mime-display-multipart-alternative-as-mixed
9399 @item gnus-mime-display-multipart-alternative-as-mixed
9400 Display "multipart/alternative" parts as "multipart/mixed".
9402 @vindex gnus-mime-display-multipart-related-as-mixed
9403 @item gnus-mime-display-multipart-related-as-mixed
9404 Display "multipart/related" parts as "multipart/mixed".
9406 If displaying "text/html" is discouraged, see
9407 @code{mm-discouraged-alternatives} in @ref{Display Customization,
9408 Display Customization, , emacs-mime, Emacs-Mime Manual}. Images or
9409 other material inside a "multipart/related" part might be overlooked
9410 when this variable is nil.
9412 @vindex gnus-mime-display-multipart-as-mixed
9413 @item gnus-mime-display-multipart-as-mixed
9414 Display "multipart" parts as "multipart/mixed". If t, it overrides nil
9415 values of @code{gnus-mime-display-multipart-alternative-as-mixed} and
9416 @code{gnus-mime-display-multipart-related-as-mixed}.
9418 @vindex mm-file-name-rewrite-functions
9419 @item mm-file-name-rewrite-functions
9420 List of functions used for rewriting file names of @acronym{MIME} parts.
9421 Each function takes a file name as input and returns a file name.
9423 Ready-made functions include@*
9424 @code{mm-file-name-delete-whitespace},
9425 @code{mm-file-name-trim-whitespace},
9426 @code{mm-file-name-collapse-whitespace}, and
9427 @code{mm-file-name-replace-whitespace}. The later uses the value of
9428 the variable @code{mm-file-name-replace-whitespace} to replace each
9429 whitespace character in a file name with that string; default value
9430 is @code{"_"} (a single underscore).
9431 @findex mm-file-name-delete-whitespace
9432 @findex mm-file-name-trim-whitespace
9433 @findex mm-file-name-collapse-whitespace
9434 @findex mm-file-name-replace-whitespace
9435 @vindex mm-file-name-replace-whitespace
9437 The standard functions @code{capitalize}, @code{downcase},
9438 @code{upcase}, and @code{upcase-initials} may be useful, too.
9440 Everybody knows that whitespace characters in file names are evil,
9441 except those who don't know. If you receive lots of attachments from
9442 such unenlightened users, you can make live easier by adding
9445 (setq mm-file-name-rewrite-functions
9446 '(mm-file-name-trim-whitespace
9447 mm-file-name-collapse-whitespace
9448 mm-file-name-replace-whitespace))
9452 to your @file{~/.gnus.el} file.
9461 People use different charsets, and we have @acronym{MIME} to let us know what
9462 charsets they use. Or rather, we wish we had. Many people use
9463 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9464 just send out messages without saying what character sets they use. To
9465 help a bit with this, some local news hierarchies have policies that say
9466 what character set is the default. For instance, the @samp{fj}
9467 hierarchy uses @code{iso-2022-jp-2}.
9469 @vindex gnus-group-charset-alist
9470 This knowledge is encoded in the @code{gnus-group-charset-alist}
9471 variable, which is an alist of regexps (use the first item to match full
9472 group names) and default charsets to be used when reading these groups.
9474 @vindex gnus-newsgroup-ignored-charsets
9475 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9476 aren't. These blithely mark messages as being in @code{iso-8859-1}
9477 even if they really are in @code{koi-8}. To help here, the
9478 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9479 charsets that are listed here will be ignored. The variable can be
9480 set on a group-by-group basis using the group parameters (@pxref{Group
9481 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9482 which includes values some agents insist on having in there.
9484 @vindex gnus-group-posting-charset-alist
9485 When posting, @code{gnus-group-posting-charset-alist} is used to
9486 determine which charsets should not be encoded using the @acronym{MIME}
9487 encodings. For instance, some hierarchies discourage using
9488 quoted-printable header encoding.
9490 This variable is an alist of regexps and permitted unencoded charsets
9491 for posting. Each element of the alist has the form @code{(}@var{test
9492 header body-list}@code{)}, where:
9496 is either a regular expression matching the newsgroup header or a
9499 is the charset which may be left unencoded in the header (@code{nil}
9500 means encode all charsets),
9502 is a list of charsets which may be encoded using 8bit content-transfer
9503 encoding in the body, or one of the special values @code{nil} (always
9504 encode using quoted-printable) or @code{t} (always use 8bit).
9511 @cindex coding system aliases
9512 @cindex preferred charset
9514 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
9515 The Emacs MIME Manual}, for additional variables that control which
9516 MIME charsets are used when sending messages.
9518 Other charset tricks that may be useful, although not Gnus-specific:
9520 If there are several @acronym{MIME} charsets that encode the same Emacs
9521 charset, you can choose what charset to use by saying the following:
9524 (put-charset-property 'cyrillic-iso8859-5
9525 'preferred-coding-system 'koi8-r)
9528 This means that Russian will be encoded using @code{koi8-r} instead of
9529 the default @code{iso-8859-5} @acronym{MIME} charset.
9531 If you want to read messages in @code{koi8-u}, you can cheat and say
9534 (define-coding-system-alias 'koi8-u 'koi8-r)
9537 This will almost do the right thing.
9539 And finally, to read charsets like @code{windows-1251}, you can say
9543 (codepage-setup 1251)
9544 (define-coding-system-alias 'windows-1251 'cp1251)
9548 @node Article Commands
9549 @section Article Commands
9556 @kindex A P (Summary)
9557 @vindex gnus-ps-print-hook
9558 @findex gnus-summary-print-article
9559 Generate and print a PostScript image of the article buffer
9560 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9561 be run just before printing the buffer. An alternative way to print
9562 article is to use Muttprint (@pxref{Saving Articles}).
9567 @node Summary Sorting
9568 @section Summary Sorting
9569 @cindex summary sorting
9571 You can have the summary buffer sorted in various ways, even though I
9572 can't really see why you'd want that.
9577 @kindex C-c C-s C-n (Summary)
9578 @findex gnus-summary-sort-by-number
9579 Sort by article number (@code{gnus-summary-sort-by-number}).
9582 @kindex C-c C-s C-a (Summary)
9583 @findex gnus-summary-sort-by-author
9584 Sort by author (@code{gnus-summary-sort-by-author}).
9587 @kindex C-c C-s C-s (Summary)
9588 @findex gnus-summary-sort-by-subject
9589 Sort by subject (@code{gnus-summary-sort-by-subject}).
9592 @kindex C-c C-s C-d (Summary)
9593 @findex gnus-summary-sort-by-date
9594 Sort by date (@code{gnus-summary-sort-by-date}).
9597 @kindex C-c C-s C-l (Summary)
9598 @findex gnus-summary-sort-by-lines
9599 Sort by lines (@code{gnus-summary-sort-by-lines}).
9602 @kindex C-c C-s C-c (Summary)
9603 @findex gnus-summary-sort-by-chars
9604 Sort by article length (@code{gnus-summary-sort-by-chars}).
9607 @kindex C-c C-s C-i (Summary)
9608 @findex gnus-summary-sort-by-score
9609 Sort by score (@code{gnus-summary-sort-by-score}).
9612 @kindex C-c C-s C-r (Summary)
9613 @findex gnus-summary-sort-by-random
9614 Randomize (@code{gnus-summary-sort-by-random}).
9617 @kindex C-c C-s C-o (Summary)
9618 @findex gnus-summary-sort-by-original
9619 Sort using the default sorting method
9620 (@code{gnus-summary-sort-by-original}).
9623 These functions will work both when you use threading and when you don't
9624 use threading. In the latter case, all summary lines will be sorted,
9625 line by line. In the former case, sorting will be done on a
9626 root-by-root basis, which might not be what you were looking for. To
9627 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9631 @node Finding the Parent
9632 @section Finding the Parent
9633 @cindex parent articles
9634 @cindex referring articles
9639 @findex gnus-summary-refer-parent-article
9640 If you'd like to read the parent of the current article, and it is not
9641 displayed in the summary buffer, you might still be able to. That is,
9642 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
9643 and the @code{References} in the current article are not mangled, you
9644 can just press @kbd{^} or @kbd{A r}
9645 (@code{gnus-summary-refer-parent-article}). If everything goes well,
9646 you'll get the parent. If the parent is already displayed in the
9647 summary buffer, point will just move to this article.
9649 If given a positive numerical prefix, fetch that many articles back into
9650 the ancestry. If given a negative numerical prefix, fetch just that
9651 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
9652 grandparent and the grandgrandparent of the current article. If you say
9653 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
9657 @findex gnus-summary-refer-references
9658 @kindex A R (Summary)
9659 Fetch all articles mentioned in the @code{References} header of the
9660 article (@code{gnus-summary-refer-references}).
9663 @findex gnus-summary-refer-thread
9664 @kindex A T (Summary)
9665 Display the full thread where the current article appears
9666 (@code{gnus-summary-refer-thread}). This command has to fetch all the
9667 headers in the current group to work, so it usually takes a while. If
9668 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9669 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
9670 visible effects normally, but it'll make this command work a whole lot
9671 faster. Of course, it'll make group entry somewhat slow.
9673 @vindex gnus-refer-thread-limit
9674 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9675 articles before the first displayed in the current group) headers to
9676 fetch when doing this command. The default is 200. If @code{t}, all
9677 the available headers will be fetched. This variable can be overridden
9678 by giving the @kbd{A T} command a numerical prefix.
9681 @findex gnus-summary-refer-article
9682 @kindex M-^ (Summary)
9684 @cindex fetching by Message-ID
9685 You can also ask the @acronym{NNTP} server for an arbitrary article, no
9686 matter what group it belongs to. @kbd{M-^}
9687 (@code{gnus-summary-refer-article}) will ask you for a
9688 @code{Message-ID}, which is one of those long, hard-to-read thingies
9689 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
9690 have to get it all exactly right. No fuzzy searches, I'm afraid.
9693 The current select method will be used when fetching by
9694 @code{Message-ID} from non-news select method, but you can override this
9695 by giving this command a prefix.
9697 @vindex gnus-refer-article-method
9698 If the group you are reading is located on a back end that does not
9699 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9700 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
9701 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
9702 updating the spool you are reading from, but that's not really
9705 It can also be a list of select methods, as well as the special symbol
9706 @code{current}, which means to use the current select method. If it
9707 is a list, Gnus will try all the methods in the list until it finds a
9710 Here's an example setting that will first try the current method, and
9711 then ask Google if that fails:
9714 (setq gnus-refer-article-method
9716 (nnweb "google" (nnweb-type google))))
9719 Most of the mail back ends support fetching by @code{Message-ID}, but
9720 do not do a particularly excellent job at it. That is, @code{nnmbox},
9721 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
9722 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
9723 only able to locate articles that have been posted to the current
9724 group. (Anything else would be too time consuming.) @code{nnmh} does
9725 not support this at all.
9728 @node Alternative Approaches
9729 @section Alternative Approaches
9731 Different people like to read news using different methods. This being
9732 Gnus, we offer a small selection of minor modes for the summary buffers.
9735 * Pick and Read:: First mark articles and then read them.
9736 * Binary Groups:: Auto-decode all articles.
9741 @subsection Pick and Read
9742 @cindex pick and read
9744 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9745 a two-phased reading interface. The user first marks in a summary
9746 buffer the articles she wants to read. Then she starts reading the
9747 articles with just an article buffer displayed.
9749 @findex gnus-pick-mode
9750 @kindex M-x gnus-pick-mode
9751 Gnus provides a summary buffer minor mode that allows
9752 this---@code{gnus-pick-mode}. This basically means that a few process
9753 mark commands become one-keystroke commands to allow easy marking, and
9754 it provides one additional command for switching to the summary buffer.
9756 Here are the available keystrokes when using pick mode:
9761 @findex gnus-pick-article-or-thread
9762 Pick the article or thread on the current line
9763 (@code{gnus-pick-article-or-thread}). If the variable
9764 @code{gnus-thread-hide-subtree} is true, then this key selects the
9765 entire thread when used at the first article of the thread. Otherwise,
9766 it selects just the article. If given a numerical prefix, go to that
9767 thread or article and pick it. (The line number is normally displayed
9768 at the beginning of the summary pick lines.)
9771 @kindex SPACE (Pick)
9772 @findex gnus-pick-next-page
9773 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
9774 at the end of the buffer, start reading the picked articles.
9778 @findex gnus-pick-unmark-article-or-thread.
9779 Unpick the thread or article
9780 (@code{gnus-pick-unmark-article-or-thread}). If the variable
9781 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9782 thread if used at the first article of the thread. Otherwise it unpicks
9783 just the article. You can give this key a numerical prefix to unpick
9784 the thread or article at that line.
9788 @findex gnus-pick-start-reading
9789 @vindex gnus-pick-display-summary
9790 Start reading the picked articles (@code{gnus-pick-start-reading}). If
9791 given a prefix, mark all unpicked articles as read first. If
9792 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9793 will still be visible when you are reading.
9797 All the normal summary mode commands are still available in the
9798 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
9799 which is mapped to the same function
9800 @code{gnus-summary-tick-article-forward}.
9802 If this sounds like a good idea to you, you could say:
9805 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9808 @vindex gnus-pick-mode-hook
9809 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9811 @vindex gnus-mark-unpicked-articles-as-read
9812 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9813 all unpicked articles as read. The default is @code{nil}.
9815 @vindex gnus-summary-pick-line-format
9816 The summary line format in pick mode is slightly different from the
9817 standard format. At the beginning of each line the line number is
9818 displayed. The pick mode line format is controlled by the
9819 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9820 Variables}). It accepts the same format specs that
9821 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9825 @subsection Binary Groups
9826 @cindex binary groups
9828 @findex gnus-binary-mode
9829 @kindex M-x gnus-binary-mode
9830 If you spend much time in binary groups, you may grow tired of hitting
9831 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
9832 is a minor mode for summary buffers that makes all ordinary Gnus article
9833 selection functions uudecode series of articles and display the result
9834 instead of just displaying the articles the normal way.
9837 @findex gnus-binary-show-article
9838 The only way, in fact, to see the actual articles is the @kbd{g}
9839 command, when you have turned on this mode
9840 (@code{gnus-binary-show-article}).
9842 @vindex gnus-binary-mode-hook
9843 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9847 @section Tree Display
9850 @vindex gnus-use-trees
9851 If you don't like the normal Gnus summary display, you might try setting
9852 @code{gnus-use-trees} to @code{t}. This will create (by default) an
9853 additional @dfn{tree buffer}. You can execute all summary mode commands
9856 There are a few variables to customize the tree display, of course:
9859 @item gnus-tree-mode-hook
9860 @vindex gnus-tree-mode-hook
9861 A hook called in all tree mode buffers.
9863 @item gnus-tree-mode-line-format
9864 @vindex gnus-tree-mode-line-format
9865 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9866 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
9867 of valid specs, @pxref{Summary Buffer Mode Line}.
9869 @item gnus-selected-tree-face
9870 @vindex gnus-selected-tree-face
9871 Face used for highlighting the selected article in the tree buffer. The
9872 default is @code{modeline}.
9874 @item gnus-tree-line-format
9875 @vindex gnus-tree-line-format
9876 A format string for the tree nodes. The name is a bit of a misnomer,
9877 though---it doesn't define a line, but just the node. The default value
9878 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9879 the name of the poster. It is vital that all nodes are of the same
9880 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9886 The name of the poster.
9888 The @code{From} header.
9890 The number of the article.
9892 The opening bracket.
9894 The closing bracket.
9899 @xref{Formatting Variables}.
9901 Variables related to the display are:
9904 @item gnus-tree-brackets
9905 @vindex gnus-tree-brackets
9906 This is used for differentiating between ``real'' articles and
9907 ``sparse'' articles. The format is
9909 ((@var{real-open} . @var{real-close})
9910 (@var{sparse-open} . @var{sparse-close})
9911 (@var{dummy-open} . @var{dummy-close}))
9913 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
9915 @item gnus-tree-parent-child-edges
9916 @vindex gnus-tree-parent-child-edges
9917 This is a list that contains the characters used for connecting parent
9918 nodes to their children. The default is @code{(?- ?\\ ?|)}.
9922 @item gnus-tree-minimize-window
9923 @vindex gnus-tree-minimize-window
9924 If this variable is non-@code{nil}, Gnus will try to keep the tree
9925 buffer as small as possible to allow more room for the other Gnus
9926 windows. If this variable is a number, the tree buffer will never be
9927 higher than that number. The default is @code{t}. Note that if you
9928 have several windows displayed side-by-side in a frame and the tree
9929 buffer is one of these, minimizing the tree window will also resize all
9930 other windows displayed next to it.
9932 You may also wish to add the following hook to keep the window minimized
9936 (add-hook 'gnus-configure-windows-hook
9937 'gnus-tree-perhaps-minimize)
9940 @item gnus-generate-tree-function
9941 @vindex gnus-generate-tree-function
9942 @findex gnus-generate-horizontal-tree
9943 @findex gnus-generate-vertical-tree
9944 The function that actually generates the thread tree. Two predefined
9945 functions are available: @code{gnus-generate-horizontal-tree} and
9946 @code{gnus-generate-vertical-tree} (which is the default).
9950 Here's an example from a horizontal tree buffer:
9953 @{***@}-(***)-[odd]-[Gun]
9963 Here's the same thread displayed in a vertical tree buffer:
9968 |--------------------------\-----\-----\
9969 (***) [Bjo] [Gun] [Gun]
9971 [odd] [Jan] [odd] (***) [Jor]
9973 [Gun] [Eri] [Eri] [odd]
9979 If you're using horizontal trees, it might be nice to display the trees
9980 side-by-side with the summary buffer. You could add something like the
9981 following to your @file{~/.gnus.el} file:
9984 (setq gnus-use-trees t
9985 gnus-generate-tree-function 'gnus-generate-horizontal-tree
9986 gnus-tree-minimize-window nil)
9987 (gnus-add-configuration
9991 (summary 0.75 point)
9996 @xref{Window Layout}.
9999 @node Mail Group Commands
10000 @section Mail Group Commands
10001 @cindex mail group commands
10003 Some commands only make sense in mail groups. If these commands are
10004 invalid in the current group, they will raise a hell and let you know.
10006 All these commands (except the expiry and edit commands) use the
10007 process/prefix convention (@pxref{Process/Prefix}).
10012 @kindex B e (Summary)
10013 @findex gnus-summary-expire-articles
10014 Run all expirable articles in the current group through the expiry
10015 process (@code{gnus-summary-expire-articles}). That is, delete all
10016 expirable articles in the group that have been around for a while.
10017 (@pxref{Expiring Mail}).
10020 @kindex B C-M-e (Summary)
10021 @findex gnus-summary-expire-articles-now
10022 Delete all the expirable articles in the group
10023 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
10024 articles eligible for expiry in the current group will
10025 disappear forever into that big @file{/dev/null} in the sky.
10028 @kindex B DEL (Summary)
10029 @findex gnus-summary-delete-article
10030 @c @icon{gnus-summary-mail-delete}
10031 Delete the mail article. This is ``delete'' as in ``delete it from your
10032 disk forever and ever, never to return again.'' Use with caution.
10033 (@code{gnus-summary-delete-article}).
10036 @kindex B m (Summary)
10038 @findex gnus-summary-move-article
10039 @vindex gnus-preserve-marks
10040 Move the article from one mail group to another
10041 (@code{gnus-summary-move-article}). Marks will be preserved if
10042 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10045 @kindex B c (Summary)
10047 @findex gnus-summary-copy-article
10048 @c @icon{gnus-summary-mail-copy}
10049 Copy the article from one group (mail group or not) to a mail group
10050 (@code{gnus-summary-copy-article}). Marks will be preserved if
10051 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10054 @kindex B B (Summary)
10055 @cindex crosspost mail
10056 @findex gnus-summary-crosspost-article
10057 Crosspost the current article to some other group
10058 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10059 the article in the other group, and the Xref headers of the article will
10060 be properly updated.
10063 @kindex B i (Summary)
10064 @findex gnus-summary-import-article
10065 Import an arbitrary file into the current mail newsgroup
10066 (@code{gnus-summary-import-article}). You will be prompted for a file
10067 name, a @code{From} header and a @code{Subject} header.
10070 @kindex B I (Summary)
10071 @findex gnus-summary-create-article
10072 Create an empty article in the current mail newsgroups
10073 (@code{gnus-summary-create-article}). You will be prompted for a
10074 @code{From} header and a @code{Subject} header.
10077 @kindex B r (Summary)
10078 @findex gnus-summary-respool-article
10079 @vindex gnus-summary-respool-default-method
10080 Respool the mail article (@code{gnus-summary-respool-article}).
10081 @code{gnus-summary-respool-default-method} will be used as the default
10082 select method when respooling. This variable is @code{nil} by default,
10083 which means that the current group select method will be used instead.
10084 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10085 (which is the default).
10089 @kindex B w (Summary)
10090 @kindex e (Summary)
10091 @findex gnus-summary-edit-article
10092 @kindex C-c C-c (Article)
10093 @findex gnus-summary-edit-article-done
10094 Edit the current article (@code{gnus-summary-edit-article}). To finish
10095 editing and make the changes permanent, type @kbd{C-c C-c}
10096 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10097 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
10100 @kindex B q (Summary)
10101 @findex gnus-summary-respool-query
10102 If you want to re-spool an article, you might be curious as to what group
10103 the article will end up in before you do the re-spooling. This command
10104 will tell you (@code{gnus-summary-respool-query}).
10107 @kindex B t (Summary)
10108 @findex gnus-summary-respool-trace
10109 Similarly, this command will display all fancy splitting patterns used
10110 when respooling, if any (@code{gnus-summary-respool-trace}).
10113 @kindex B p (Summary)
10114 @findex gnus-summary-article-posted-p
10115 Some people have a tendency to send you ``courtesy'' copies when they
10116 follow up to articles you have posted. These usually have a
10117 @code{Newsgroups} header in them, but not always. This command
10118 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10119 article from your news server (or rather, from
10120 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10121 report back whether it found the article or not. Even if it says that
10122 it didn't find the article, it may have been posted anyway---mail
10123 propagation is much faster than news propagation, and the news copy may
10124 just not have arrived yet.
10127 @kindex K E (Summary)
10128 @findex gnus-article-encrypt-body
10129 @vindex gnus-article-encrypt-protocol
10130 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10131 The body is encrypted with the encryption protocol specified by the
10132 variable @code{gnus-article-encrypt-protocol}.
10136 @vindex gnus-move-split-methods
10137 @cindex moving articles
10138 If you move (or copy) articles regularly, you might wish to have Gnus
10139 suggest where to put the articles. @code{gnus-move-split-methods} is a
10140 variable that uses the same syntax as @code{gnus-split-methods}
10141 (@pxref{Saving Articles}). You may customize that variable to create
10142 suggestions you find reasonable. (Note that
10143 @code{gnus-move-split-methods} uses group names where
10144 @code{gnus-split-methods} uses file names.)
10147 (setq gnus-move-split-methods
10148 '(("^From:.*Lars Magne" "nnml:junk")
10149 ("^Subject:.*gnus" "nnfolder:important")
10150 (".*" "nnml:misc")))
10154 @node Various Summary Stuff
10155 @section Various Summary Stuff
10158 * Summary Group Information:: Information oriented commands.
10159 * Searching for Articles:: Multiple article commands.
10160 * Summary Generation Commands::
10161 * Really Various Summary Commands:: Those pesky non-conformant commands.
10165 @vindex gnus-summary-display-while-building
10166 @item gnus-summary-display-while-building
10167 If non-@code{nil}, show and update the summary buffer as it's being
10168 built. If @code{t}, update the buffer after every line is inserted.
10169 If the value is an integer, @var{n}, update the display every @var{n}
10170 lines. The default is @code{nil}.
10172 @vindex gnus-summary-display-arrow
10173 @item gnus-summary-display-arrow
10174 If non-@code{nil}, display an arrow in the fringe to indicate the
10177 @vindex gnus-summary-mode-hook
10178 @item gnus-summary-mode-hook
10179 This hook is called when creating a summary mode buffer.
10181 @vindex gnus-summary-generate-hook
10182 @item gnus-summary-generate-hook
10183 This is called as the last thing before doing the threading and the
10184 generation of the summary buffer. It's quite convenient for customizing
10185 the threading variables based on what data the newsgroup has. This hook
10186 is called from the summary buffer after most summary buffer variables
10189 @vindex gnus-summary-prepare-hook
10190 @item gnus-summary-prepare-hook
10191 It is called after the summary buffer has been generated. You might use
10192 it to, for instance, highlight lines or modify the look of the buffer in
10193 some other ungodly manner. I don't care.
10195 @vindex gnus-summary-prepared-hook
10196 @item gnus-summary-prepared-hook
10197 A hook called as the very last thing after the summary buffer has been
10200 @vindex gnus-summary-ignore-duplicates
10201 @item gnus-summary-ignore-duplicates
10202 When Gnus discovers two articles that have the same @code{Message-ID},
10203 it has to do something drastic. No articles are allowed to have the
10204 same @code{Message-ID}, but this may happen when reading mail from some
10205 sources. Gnus allows you to customize what happens with this variable.
10206 If it is @code{nil} (which is the default), Gnus will rename the
10207 @code{Message-ID} (for display purposes only) and display the article as
10208 any other article. If this variable is @code{t}, it won't display the
10209 article---it'll be as if it never existed.
10211 @vindex gnus-alter-articles-to-read-function
10212 @item gnus-alter-articles-to-read-function
10213 This function, which takes two parameters (the group name and the list
10214 of articles to be selected), is called to allow the user to alter the
10215 list of articles to be selected.
10217 For instance, the following function adds the list of cached articles to
10218 the list in one particular group:
10221 (defun my-add-cached-articles (group articles)
10222 (if (string= group "some.group")
10223 (append gnus-newsgroup-cached articles)
10227 @vindex gnus-newsgroup-variables
10228 @item gnus-newsgroup-variables
10229 A list of newsgroup (summary buffer) local variables, or cons of
10230 variables and their default expressions to be evalled (when the default
10231 values are not @code{nil}), that should be made global while the summary
10234 Note: The default expressions will be evaluated (using function
10235 @code{eval}) before assignment to the local variable rather than just
10236 assigned to it. If the default expression is the symbol @code{global},
10237 that symbol will not be evaluated but the global value of the local
10238 variable will be used instead.
10240 These variables can be used to set variables in the group parameters
10241 while still allowing them to affect operations done in other
10242 buffers. For example:
10245 (setq gnus-newsgroup-variables
10246 '(message-use-followup-to
10247 (gnus-visible-headers .
10248 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10251 Also @pxref{Group Parameters}.
10255 @node Summary Group Information
10256 @subsection Summary Group Information
10261 @kindex H f (Summary)
10262 @findex gnus-summary-fetch-faq
10263 @vindex gnus-group-faq-directory
10264 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10265 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10266 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10267 is usually a directory on a remote machine. This variable can also be
10268 a list of directories. In that case, giving a prefix to this command
10269 will allow you to choose between the various sites. @code{ange-ftp}
10270 or @code{efs} will probably be used for fetching the file.
10273 @kindex H d (Summary)
10274 @findex gnus-summary-describe-group
10275 Give a brief description of the current group
10276 (@code{gnus-summary-describe-group}). If given a prefix, force
10277 rereading the description from the server.
10280 @kindex H h (Summary)
10281 @findex gnus-summary-describe-briefly
10282 Give an extremely brief description of the most important summary
10283 keystrokes (@code{gnus-summary-describe-briefly}).
10286 @kindex H i (Summary)
10287 @findex gnus-info-find-node
10288 Go to the Gnus info node (@code{gnus-info-find-node}).
10292 @node Searching for Articles
10293 @subsection Searching for Articles
10298 @kindex M-s (Summary)
10299 @findex gnus-summary-search-article-forward
10300 Search through all subsequent (raw) articles for a regexp
10301 (@code{gnus-summary-search-article-forward}).
10304 @kindex M-r (Summary)
10305 @findex gnus-summary-search-article-backward
10306 Search through all previous (raw) articles for a regexp
10307 (@code{gnus-summary-search-article-backward}).
10310 @kindex & (Summary)
10311 @findex gnus-summary-execute-command
10312 This command will prompt you for a header, a regular expression to match
10313 on this field, and a command to be executed if the match is made
10314 (@code{gnus-summary-execute-command}). If the header is an empty
10315 string, the match is done on the entire article. If given a prefix,
10316 search backward instead.
10318 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10319 all articles that have heads or bodies that match @samp{some.*string}.
10322 @kindex M-& (Summary)
10323 @findex gnus-summary-universal-argument
10324 Perform any operation on all articles that have been marked with
10325 the process mark (@code{gnus-summary-universal-argument}).
10328 @node Summary Generation Commands
10329 @subsection Summary Generation Commands
10334 @kindex Y g (Summary)
10335 @findex gnus-summary-prepare
10336 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10339 @kindex Y c (Summary)
10340 @findex gnus-summary-insert-cached-articles
10341 Pull all cached articles (for the current group) into the summary buffer
10342 (@code{gnus-summary-insert-cached-articles}).
10345 @kindex Y d (Summary)
10346 @findex gnus-summary-insert-dormant-articles
10347 Pull all dormant articles (for the current group) into the summary buffer
10348 (@code{gnus-summary-insert-dormant-articles}).
10353 @node Really Various Summary Commands
10354 @subsection Really Various Summary Commands
10360 @kindex C-d (Summary)
10361 @kindex A D (Summary)
10362 @findex gnus-summary-enter-digest-group
10363 If the current article is a collection of other articles (for instance,
10364 a digest), you might use this command to enter a group based on the that
10365 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10366 guess what article type is currently displayed unless you give a prefix
10367 to this command, which forces a ``digest'' interpretation. Basically,
10368 whenever you see a message that is a collection of other messages of
10369 some format, you @kbd{C-d} and read these messages in a more convenient
10373 @kindex C-M-d (Summary)
10374 @findex gnus-summary-read-document
10375 This command is very similar to the one above, but lets you gather
10376 several documents into one biiig group
10377 (@code{gnus-summary-read-document}). It does this by opening several
10378 @code{nndoc} groups for each document, and then opening an
10379 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10380 command understands the process/prefix convention
10381 (@pxref{Process/Prefix}).
10384 @kindex C-t (Summary)
10385 @findex gnus-summary-toggle-truncation
10386 Toggle truncation of summary lines
10387 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10388 line centering function in the summary buffer, so it's not a good idea
10389 to have truncation switched off while reading articles.
10392 @kindex = (Summary)
10393 @findex gnus-summary-expand-window
10394 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10395 If given a prefix, force an @code{article} window configuration.
10398 @kindex C-M-e (Summary)
10399 @findex gnus-summary-edit-parameters
10400 Edit the group parameters (@pxref{Group Parameters}) of the current
10401 group (@code{gnus-summary-edit-parameters}).
10404 @kindex C-M-a (Summary)
10405 @findex gnus-summary-customize-parameters
10406 Customize the group parameters (@pxref{Group Parameters}) of the current
10407 group (@code{gnus-summary-customize-parameters}).
10412 @node Exiting the Summary Buffer
10413 @section Exiting the Summary Buffer
10414 @cindex summary exit
10415 @cindex exiting groups
10417 Exiting from the summary buffer will normally update all info on the
10418 group and return you to the group buffer.
10425 @kindex Z Z (Summary)
10426 @kindex Z Q (Summary)
10427 @kindex q (Summary)
10428 @findex gnus-summary-exit
10429 @vindex gnus-summary-exit-hook
10430 @vindex gnus-summary-prepare-exit-hook
10431 @vindex gnus-group-no-more-groups-hook
10432 @c @icon{gnus-summary-exit}
10433 Exit the current group and update all information on the group
10434 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10435 called before doing much of the exiting, which calls
10436 @code{gnus-summary-expire-articles} by default.
10437 @code{gnus-summary-exit-hook} is called after finishing the exit
10438 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10439 group mode having no more (unread) groups.
10443 @kindex Z E (Summary)
10444 @kindex Q (Summary)
10445 @findex gnus-summary-exit-no-update
10446 Exit the current group without updating any information on the group
10447 (@code{gnus-summary-exit-no-update}).
10451 @kindex Z c (Summary)
10452 @kindex c (Summary)
10453 @findex gnus-summary-catchup-and-exit
10454 @c @icon{gnus-summary-catchup-and-exit}
10455 Mark all unticked articles in the group as read and then exit
10456 (@code{gnus-summary-catchup-and-exit}).
10459 @kindex Z C (Summary)
10460 @findex gnus-summary-catchup-all-and-exit
10461 Mark all articles, even the ticked ones, as read and then exit
10462 (@code{gnus-summary-catchup-all-and-exit}).
10465 @kindex Z n (Summary)
10466 @findex gnus-summary-catchup-and-goto-next-group
10467 Mark all articles as read and go to the next group
10468 (@code{gnus-summary-catchup-and-goto-next-group}).
10472 @kindex Z R (Summary)
10473 @kindex C-x C-s (Summary)
10474 @findex gnus-summary-reselect-current-group
10475 Exit this group, and then enter it again
10476 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10477 all articles, both read and unread.
10481 @kindex Z G (Summary)
10482 @kindex M-g (Summary)
10483 @findex gnus-summary-rescan-group
10484 @c @icon{gnus-summary-mail-get}
10485 Exit the group, check for new articles in the group, and select the
10486 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10487 articles, both read and unread.
10490 @kindex Z N (Summary)
10491 @findex gnus-summary-next-group
10492 Exit the group and go to the next group
10493 (@code{gnus-summary-next-group}).
10496 @kindex Z P (Summary)
10497 @findex gnus-summary-prev-group
10498 Exit the group and go to the previous group
10499 (@code{gnus-summary-prev-group}).
10502 @kindex Z s (Summary)
10503 @findex gnus-summary-save-newsrc
10504 Save the current number of read/marked articles in the dribble buffer
10505 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10506 given a prefix, also save the @file{.newsrc} file(s). Using this
10507 command will make exit without updating (the @kbd{Q} command) worthless.
10510 @vindex gnus-exit-group-hook
10511 @code{gnus-exit-group-hook} is called when you exit the current group
10512 with an ``updating'' exit. For instance @kbd{Q}
10513 (@code{gnus-summary-exit-no-update}) does not call this hook.
10515 @findex gnus-summary-wake-up-the-dead
10516 @findex gnus-dead-summary-mode
10517 @vindex gnus-kill-summary-on-exit
10518 If you're in the habit of exiting groups, and then changing your mind
10519 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10520 If you do that, Gnus won't kill the summary buffer when you exit it.
10521 (Quelle surprise!) Instead it will change the name of the buffer to
10522 something like @samp{*Dead Summary ... *} and install a minor mode
10523 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
10524 buffer, you'll find that all keys are mapped to a function called
10525 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
10526 summary buffer will result in a live, normal summary buffer.
10528 There will never be more than one dead summary buffer at any one time.
10530 @vindex gnus-use-cross-reference
10531 The data on the current group will be updated (which articles you have
10532 read, which articles you have replied to, etc.) when you exit the
10533 summary buffer. If the @code{gnus-use-cross-reference} variable is
10534 @code{t} (which is the default), articles that are cross-referenced to
10535 this group and are marked as read, will also be marked as read in the
10536 other subscribed groups they were cross-posted to. If this variable is
10537 neither @code{nil} nor @code{t}, the article will be marked as read in
10538 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10541 @node Crosspost Handling
10542 @section Crosspost Handling
10546 Marking cross-posted articles as read ensures that you'll never have to
10547 read the same article more than once. Unless, of course, somebody has
10548 posted it to several groups separately. Posting the same article to
10549 several groups (not cross-posting) is called @dfn{spamming}, and you are
10550 by law required to send nasty-grams to anyone who perpetrates such a
10551 heinous crime. You may want to try NoCeM handling to filter out spam
10554 Remember: Cross-posting is kinda ok, but posting the same article
10555 separately to several groups is not. Massive cross-posting (aka.
10556 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10557 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10558 excessive crossposting (@pxref{Summary Mail Commands}).
10560 @cindex cross-posting
10562 @cindex @acronym{NOV}
10563 One thing that may cause Gnus to not do the cross-posting thing
10564 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
10565 (which is very nice, because it speeds things up considerably) which
10566 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
10567 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
10568 even with @sc{xover} by registering the @code{Xref} lines of all
10569 articles you actually read, but if you kill the articles, or just mark
10570 them as read without reading them, Gnus will not get a chance to snoop
10571 the @code{Xref} lines out of these articles, and will be unable to use
10572 the cross reference mechanism.
10574 @cindex LIST overview.fmt
10575 @cindex overview.fmt
10576 To check whether your @acronym{NNTP} server includes the @code{Xref} header
10577 in its overview files, try @samp{telnet your.nntp.server nntp},
10578 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10579 overview.fmt}. This may not work, but if it does, and the last line you
10580 get does not read @samp{Xref:full}, then you should shout and whine at
10581 your news admin until she includes the @code{Xref} header in the
10584 @vindex gnus-nov-is-evil
10585 If you want Gnus to get the @code{Xref}s right all the time, you have to
10586 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10591 For an alternative approach, @pxref{Duplicate Suppression}.
10594 @node Duplicate Suppression
10595 @section Duplicate Suppression
10597 By default, Gnus tries to make sure that you don't have to read the same
10598 article more than once by utilizing the crossposting mechanism
10599 (@pxref{Crosspost Handling}). However, that simple and efficient
10600 approach may not work satisfactory for some users for various
10605 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
10606 is evil and not very common.
10609 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
10610 @file{.overview} data bases. This is evil and all too common, alas.
10613 You may be reading the same group (or several related groups) from
10614 different @acronym{NNTP} servers.
10617 You may be getting mail that duplicates articles posted to groups.
10620 I'm sure there are other situations where @code{Xref} handling fails as
10621 well, but these four are the most common situations.
10623 If, and only if, @code{Xref} handling fails for you, then you may
10624 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
10625 will remember the @code{Message-ID}s of all articles you have read or
10626 otherwise marked as read, and then, as if by magic, mark them as read
10627 all subsequent times you see them---in @emph{all} groups. Using this
10628 mechanism is quite likely to be somewhat inefficient, but not overly
10629 so. It's certainly preferable to reading the same articles more than
10632 Duplicate suppression is not a very subtle instrument. It's more like a
10633 sledge hammer than anything else. It works in a very simple
10634 fashion---if you have marked an article as read, it adds this Message-ID
10635 to a cache. The next time it sees this Message-ID, it will mark the
10636 article as read with the @samp{M} mark. It doesn't care what group it
10637 saw the article in.
10640 @item gnus-suppress-duplicates
10641 @vindex gnus-suppress-duplicates
10642 If non-@code{nil}, suppress duplicates.
10644 @item gnus-save-duplicate-list
10645 @vindex gnus-save-duplicate-list
10646 If non-@code{nil}, save the list of duplicates to a file. This will
10647 make startup and shutdown take longer, so the default is @code{nil}.
10648 However, this means that only duplicate articles read in a single Gnus
10649 session are suppressed.
10651 @item gnus-duplicate-list-length
10652 @vindex gnus-duplicate-list-length
10653 This variable says how many @code{Message-ID}s to keep in the duplicate
10654 suppression list. The default is 10000.
10656 @item gnus-duplicate-file
10657 @vindex gnus-duplicate-file
10658 The name of the file to store the duplicate suppression list in. The
10659 default is @file{~/News/suppression}.
10662 If you have a tendency to stop and start Gnus often, setting
10663 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
10664 you leave Gnus running for weeks on end, you may have it @code{nil}. On
10665 the other hand, saving the list makes startup and shutdown much slower,
10666 so that means that if you stop and start Gnus often, you should set
10667 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
10668 to you to figure out, I think.
10673 Gnus is able to verify signed messages or decrypt encrypted messages.
10674 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
10675 and @acronym{S/MIME}, however you need some external programs to get
10680 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
10681 install an OpenPGP implementation such as GnuPG. The Lisp interface
10682 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
10683 Manual}), but Mailcrypt and gpg.el are also supported.
10686 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
10687 or newer is recommended.
10691 More information on how to set things up can be found in the message
10692 manual (@pxref{Security, ,Security, message, Message Manual}).
10695 @item mm-verify-option
10696 @vindex mm-verify-option
10697 Option of verifying signed parts. @code{never}, not verify;
10698 @code{always}, always verify; @code{known}, only verify known
10699 protocols. Otherwise, ask user.
10701 @item mm-decrypt-option
10702 @vindex mm-decrypt-option
10703 Option of decrypting encrypted parts. @code{never}, no decryption;
10704 @code{always}, always decrypt; @code{known}, only decrypt known
10705 protocols. Otherwise, ask user.
10708 @vindex mml1991-use
10709 Symbol indicating elisp interface to OpenPGP implementation for
10710 @acronym{PGP} messages. The default is @code{pgg}, but
10711 @code{mailcrypt} and @code{gpg} are also supported although
10715 @vindex mml2015-use
10716 Symbol indicating elisp interface to OpenPGP implementation for
10717 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
10718 @code{mailcrypt} and @code{gpg} are also supported although
10723 @cindex snarfing keys
10724 @cindex importing PGP keys
10725 @cindex PGP key ring import
10726 Snarfing OpenPGP keys (i.e., importing keys from articles into your
10727 key ring) is not supported explicitly through a menu item or command,
10728 rather Gnus do detect and label keys as @samp{application/pgp-keys},
10729 allowing you to specify whatever action you think is appropriate
10730 through the usual @acronym{MIME} infrastructure. You can use a
10731 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
10732 Emacs MIME Manual}) such as the following to import keys using GNU
10733 Privacy Guard when you click on the @acronym{MIME} button
10734 (@pxref{Using MIME}).
10737 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
10740 This happens to also be the default action defined in
10741 @code{mailcap-mime-data}.
10744 @section Mailing List
10745 @cindex mailing list
10748 @kindex A M (summary)
10749 @findex gnus-mailing-list-insinuate
10750 Gnus understands some mailing list fields of RFC 2369. To enable it,
10751 add a @code{to-list} group parameter (@pxref{Group Parameters}),
10752 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10755 That enables the following commands to the summary buffer:
10760 @kindex C-c C-n h (Summary)
10761 @findex gnus-mailing-list-help
10762 Send a message to fetch mailing list help, if List-Help field exists.
10765 @kindex C-c C-n s (Summary)
10766 @findex gnus-mailing-list-subscribe
10767 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10770 @kindex C-c C-n u (Summary)
10771 @findex gnus-mailing-list-unsubscribe
10772 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10776 @kindex C-c C-n p (Summary)
10777 @findex gnus-mailing-list-post
10778 Post to the mailing list, if List-Post field exists.
10781 @kindex C-c C-n o (Summary)
10782 @findex gnus-mailing-list-owner
10783 Send a message to the mailing list owner, if List-Owner field exists.
10786 @kindex C-c C-n a (Summary)
10787 @findex gnus-mailing-list-archive
10788 Browse the mailing list archive, if List-Archive field exists.
10793 @node Article Buffer
10794 @chapter Article Buffer
10795 @cindex article buffer
10797 The articles are displayed in the article buffer, of which there is only
10798 one. All the summary buffers share the same article buffer unless you
10799 tell Gnus otherwise.
10802 * Hiding Headers:: Deciding what headers should be displayed.
10803 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
10804 * Customizing Articles:: Tailoring the look of the articles.
10805 * Article Keymap:: Keystrokes available in the article buffer.
10806 * Misc Article:: Other stuff.
10810 @node Hiding Headers
10811 @section Hiding Headers
10812 @cindex hiding headers
10813 @cindex deleting headers
10815 The top section of each article is the @dfn{head}. (The rest is the
10816 @dfn{body}, but you may have guessed that already.)
10818 @vindex gnus-show-all-headers
10819 There is a lot of useful information in the head: the name of the person
10820 who wrote the article, the date it was written and the subject of the
10821 article. That's well and nice, but there's also lots of information
10822 most people do not want to see---what systems the article has passed
10823 through before reaching you, the @code{Message-ID}, the
10824 @code{References}, etc. ad nauseam---and you'll probably want to get rid
10825 of some of those lines. If you want to keep all those lines in the
10826 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10828 Gnus provides you with two variables for sifting headers:
10832 @item gnus-visible-headers
10833 @vindex gnus-visible-headers
10834 If this variable is non-@code{nil}, it should be a regular expression
10835 that says what headers you wish to keep in the article buffer. All
10836 headers that do not match this variable will be hidden.
10838 For instance, if you only want to see the name of the person who wrote
10839 the article and the subject, you'd say:
10842 (setq gnus-visible-headers "^From:\\|^Subject:")
10845 This variable can also be a list of regexps to match headers to
10848 @item gnus-ignored-headers
10849 @vindex gnus-ignored-headers
10850 This variable is the reverse of @code{gnus-visible-headers}. If this
10851 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10852 should be a regular expression that matches all lines that you want to
10853 hide. All lines that do not match this variable will remain visible.
10855 For instance, if you just want to get rid of the @code{References} line
10856 and the @code{Xref} line, you might say:
10859 (setq gnus-ignored-headers "^References:\\|^Xref:")
10862 This variable can also be a list of regexps to match headers to
10865 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10866 variable will have no effect.
10870 @vindex gnus-sorted-header-list
10871 Gnus can also sort the headers for you. (It does this by default.) You
10872 can control the sorting by setting the @code{gnus-sorted-header-list}
10873 variable. It is a list of regular expressions that says in what order
10874 the headers are to be displayed.
10876 For instance, if you want the name of the author of the article first,
10877 and then the subject, you might say something like:
10880 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10883 Any headers that are to remain visible, but are not listed in this
10884 variable, will be displayed in random order after all the headers listed in this variable.
10886 @findex gnus-article-hide-boring-headers
10887 @vindex gnus-boring-article-headers
10888 You can hide further boring headers by setting
10889 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
10890 does depends on the @code{gnus-boring-article-headers} variable. It's a
10891 list, but this list doesn't actually contain header names. Instead it
10892 lists various @dfn{boring conditions} that Gnus can check and remove
10895 These conditions are:
10898 Remove all empty headers.
10900 Remove the @code{Followup-To} header if it is identical to the
10901 @code{Newsgroups} header.
10903 Remove the @code{Reply-To} header if it lists the same addresses as
10904 the @code{From} header, or if the @code{broken-reply-to} group
10907 Remove the @code{Newsgroups} header if it only contains the current group
10910 Remove the @code{To} header if it only contains the address identical to
10911 the current group's @code{to-address} parameter.
10913 Remove the @code{To} header if it only contains the address identical to
10914 the current group's @code{to-list} parameter.
10916 Remove the @code{CC} header if it only contains the address identical to
10917 the current group's @code{to-list} parameter.
10919 Remove the @code{Date} header if the article is less than three days
10922 Remove the @code{To} header if it is very long.
10924 Remove all @code{To} headers if there are more than one.
10927 To include these three elements, you could say something like:
10930 (setq gnus-boring-article-headers
10931 '(empty followup-to reply-to))
10934 This is also the default value for this variable.
10938 @section Using MIME
10939 @cindex @acronym{MIME}
10941 Mime is a standard for waving your hands through the air, aimlessly,
10942 while people stand around yawning.
10944 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
10945 while all newsreaders die of fear.
10947 @acronym{MIME} may specify what character set the article uses, the encoding
10948 of the characters, and it also makes it possible to embed pictures and
10949 other naughty stuff in innocent-looking articles.
10951 @vindex gnus-display-mime-function
10952 @findex gnus-display-mime
10953 Gnus pushes @acronym{MIME} articles through @code{gnus-display-mime-function}
10954 to display the @acronym{MIME} parts. This is @code{gnus-display-mime} by
10955 default, which creates a bundle of clickable buttons that can be used to
10956 display, save and manipulate the @acronym{MIME} objects.
10958 The following commands are available when you have placed point over a
10959 @acronym{MIME} button:
10962 @findex gnus-article-press-button
10963 @item RET (Article)
10964 @kindex RET (Article)
10965 @itemx BUTTON-2 (Article)
10966 Toggle displaying of the @acronym{MIME} object
10967 (@code{gnus-article-press-button}). If built-in viewers can not display
10968 the object, Gnus resorts to external viewers in the @file{mailcap}
10969 files. If a viewer has the @samp{copiousoutput} specification, the
10970 object is displayed inline.
10972 @findex gnus-mime-view-part
10973 @item M-RET (Article)
10974 @kindex M-RET (Article)
10976 Prompt for a method, and then view the @acronym{MIME} object using this
10977 method (@code{gnus-mime-view-part}).
10979 @findex gnus-mime-view-part-as-type
10981 @kindex t (Article)
10982 View the @acronym{MIME} object as if it were a different @acronym{MIME} media type
10983 (@code{gnus-mime-view-part-as-type}).
10985 @findex gnus-mime-view-part-as-charset
10987 @kindex C (Article)
10988 Prompt for a charset, and then view the @acronym{MIME} object using this
10989 charset (@code{gnus-mime-view-part-as-charset}).
10991 @findex gnus-mime-save-part
10993 @kindex o (Article)
10994 Prompt for a file name, and then save the @acronym{MIME} object
10995 (@code{gnus-mime-save-part}).
10997 @findex gnus-mime-save-part-and-strip
10998 @item C-o (Article)
10999 @kindex C-o (Article)
11000 Prompt for a file name, then save the @acronym{MIME} object and strip it from
11001 the article. Then proceed to article editing, where a reasonable
11002 suggestion is being made on how the altered article should look
11003 like. The stripped @acronym{MIME} object will be referred via the
11004 message/external-body @acronym{MIME} type.
11005 (@code{gnus-mime-save-part-and-strip}).
11007 @findex gnus-mime-delete-part
11009 @kindex d (Article)
11010 Delete the @acronym{MIME} object from the article and replace it with some
11011 information about the removed @acronym{MIME} object
11012 (@code{gnus-mime-delete-part}).
11014 @findex gnus-mime-copy-part
11016 @kindex c (Article)
11017 Copy the @acronym{MIME} object to a fresh buffer and display this buffer
11018 (@code{gnus-mime-copy-part}). Compressed files like @file{.gz} and
11019 @file{.bz2} are automatically decompressed if
11020 @code{auto-compression-mode} is enabled (@pxref{Compressed Files,,
11021 Accessing Compressed Files, emacs, The Emacs Editor}).
11023 @findex gnus-mime-print-part
11025 @kindex p (Article)
11026 Print the @acronym{MIME} object (@code{gnus-mime-print-part}). This
11027 command respects the @samp{print=} specifications in the
11028 @file{.mailcap} file.
11030 @findex gnus-mime-inline-part
11032 @kindex i (Article)
11033 Insert the contents of the @acronym{MIME} object into the buffer
11034 (@code{gnus-mime-inline-part}) as text/plain. If given a prefix, insert
11035 the raw contents without decoding. If given a numerical prefix, you can
11036 do semi-manual charset stuff (see
11037 @code{gnus-summary-show-article-charset-alist} in @ref{Paging the
11040 @findex gnus-mime-view-part-internally
11042 @kindex E (Article)
11043 View the @acronym{MIME} object with an internal viewer. If no internal
11044 viewer is available, use an external viewer
11045 (@code{gnus-mime-view-part-internally}).
11047 @findex gnus-mime-view-part-externally
11049 @kindex e (Article)
11050 View the @acronym{MIME} object with an external viewer.
11051 (@code{gnus-mime-view-part-externally}).
11053 @findex gnus-mime-pipe-part
11055 @kindex | (Article)
11056 Output the @acronym{MIME} object to a process (@code{gnus-mime-pipe-part}).
11058 @findex gnus-mime-action-on-part
11060 @kindex . (Article)
11061 Interactively run an action on the @acronym{MIME} object
11062 (@code{gnus-mime-action-on-part}).
11066 Gnus will display some @acronym{MIME} objects automatically. The way Gnus
11067 determines which parts to do this with is described in the Emacs
11068 @acronym{MIME} manual.
11070 It might be best to just use the toggling functions from the article
11071 buffer to avoid getting nasty surprises. (For instance, you enter the
11072 group @samp{alt.sing-a-long} and, before you know it, @acronym{MIME} has
11073 decoded the sound file in the article and some horrible sing-a-long song
11074 comes screaming out your speakers, and you can't find the volume button,
11075 because there isn't one, and people are starting to look at you, and you
11076 try to stop the program, but you can't, and you can't find the program
11077 to control the volume, and everybody else in the room suddenly decides
11078 to look at you disdainfully, and you'll feel rather stupid.)
11080 Any similarity to real events and people is purely coincidental. Ahem.
11082 Also @pxref{MIME Commands}.
11085 @node Customizing Articles
11086 @section Customizing Articles
11087 @cindex article customization
11089 A slew of functions for customizing how the articles are to look like
11090 exist. You can call these functions interactively
11091 (@pxref{Article Washing}), or you can have them
11092 called automatically when you select the articles.
11094 To have them called automatically, you should set the corresponding
11095 ``treatment'' variable. For instance, to have headers hidden, you'd set
11096 @code{gnus-treat-hide-headers}. Below is a list of variables that can
11097 be set, but first we discuss the values these variables can have.
11099 Note: Some values, while valid, make little sense. Check the list below
11100 for sensible values.
11104 @code{nil}: Don't do this treatment.
11107 @code{t}: Do this treatment on all body parts.
11110 @code{head}: Do the treatment on the headers.
11113 @code{last}: Do this treatment on the last part.
11116 An integer: Do this treatment on all body parts that have a length less
11120 A list of strings: Do this treatment on all body parts that are in
11121 articles that are read in groups that have names that match one of the
11122 regexps in the list.
11125 A list where the first element is not a string:
11127 The list is evaluated recursively. The first element of the list is a
11128 predicate. The following predicates are recognized: @code{or},
11129 @code{and}, @code{not} and @code{typep}. Here's an example:
11133 (typep "text/x-vcard"))
11138 You may have noticed that the word @dfn{part} is used here. This refers
11139 to the fact that some messages are @acronym{MIME} multipart articles that may
11140 be divided into several parts. Articles that are not multiparts are
11141 considered to contain just a single part.
11143 @vindex gnus-article-treat-types
11144 Are the treatments applied to all sorts of multipart parts? Yes, if you
11145 want to, but by default, only @samp{text/plain} parts are given the
11146 treatment. This is controlled by the @code{gnus-article-treat-types}
11147 variable, which is a list of regular expressions that are matched to the
11148 type of the part. This variable is ignored if the value of the
11149 controlling variable is a predicate list, as described above.
11151 The following treatment options are available. The easiest way to
11152 customize this is to examine the @code{gnus-article-treat} customization
11153 group. Values in parenthesis are suggested sensible values. Others are
11154 possible but those listed are probably sufficient for most people.
11157 @item gnus-treat-buttonize (t, integer)
11158 @item gnus-treat-buttonize-head (head)
11160 @xref{Article Buttons}.
11162 @item gnus-treat-capitalize-sentences (t, integer)
11163 @item gnus-treat-overstrike (t, integer)
11164 @item gnus-treat-strip-cr (t, integer)
11165 @item gnus-treat-strip-headers-in-body (t, integer)
11166 @item gnus-treat-strip-leading-blank-lines (t, integer)
11167 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11168 @item gnus-treat-strip-pem (t, last, integer)
11169 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11170 @item gnus-treat-unsplit-urls (t, integer)
11171 @item gnus-treat-wash-html (t, integer)
11173 @xref{Article Washing}.
11175 @item gnus-treat-date-english (head)
11176 @item gnus-treat-date-iso8601 (head)
11177 @item gnus-treat-date-lapsed (head)
11178 @item gnus-treat-date-local (head)
11179 @item gnus-treat-date-original (head)
11180 @item gnus-treat-date-user-defined (head)
11181 @item gnus-treat-date-ut (head)
11183 @xref{Article Date}.
11185 @item gnus-treat-from-picon (head)
11186 @item gnus-treat-mail-picon (head)
11187 @item gnus-treat-newsgroups-picon (head)
11191 @item gnus-treat-display-smileys (t, integer)
11193 @item gnus-treat-body-boundary (head)
11195 @vindex gnus-body-boundary-delimiter
11196 Adds a delimiter between header and body, the string used as delimiter
11197 is controlled by @code{gnus-body-boundary-delimiter}.
11201 @item gnus-treat-display-x-face (head)
11205 @item gnus-treat-display-face (head)
11209 @item gnus-treat-emphasize (t, head, integer)
11210 @item gnus-treat-fill-article (t, integer)
11211 @item gnus-treat-fill-long-lines (t, integer)
11212 @item gnus-treat-hide-boring-headers (head)
11213 @item gnus-treat-hide-citation (t, integer)
11214 @item gnus-treat-hide-citation-maybe (t, integer)
11215 @item gnus-treat-hide-headers (head)
11216 @item gnus-treat-hide-signature (t, last)
11217 @item gnus-treat-strip-banner (t, last)
11218 @item gnus-treat-strip-list-identifiers (head)
11220 @xref{Article Hiding}.
11222 @item gnus-treat-highlight-citation (t, integer)
11223 @item gnus-treat-highlight-headers (head)
11224 @item gnus-treat-highlight-signature (t, last, integer)
11226 @xref{Article Highlighting}.
11228 @item gnus-treat-play-sounds
11229 @item gnus-treat-translate
11230 @item gnus-treat-ansi-sequences (t)
11231 @item gnus-treat-x-pgp-sig (head)
11233 @item gnus-treat-unfold-headers (head)
11234 @item gnus-treat-fold-headers (head)
11235 @item gnus-treat-fold-newsgroups (head)
11236 @item gnus-treat-leading-whitespace (head)
11238 @xref{Article Header}.
11243 @vindex gnus-part-display-hook
11244 You can, of course, write your own functions to be called from
11245 @code{gnus-part-display-hook}. The functions are called narrowed to the
11246 part, and you can do anything you like, pretty much. There is no
11247 information that you have to keep in the buffer---you can change
11251 @node Article Keymap
11252 @section Article Keymap
11254 Most of the keystrokes in the summary buffer can also be used in the
11255 article buffer. They should behave as if you typed them in the summary
11256 buffer, which means that you don't actually have to have a summary
11257 buffer displayed while reading. You can do it all from the article
11260 A few additional keystrokes are available:
11265 @kindex SPACE (Article)
11266 @findex gnus-article-next-page
11267 Scroll forwards one page (@code{gnus-article-next-page}).
11268 This is exactly the same as @kbd{h SPACE h}.
11271 @kindex DEL (Article)
11272 @findex gnus-article-prev-page
11273 Scroll backwards one page (@code{gnus-article-prev-page}).
11274 This is exactly the same as @kbd{h DEL h}.
11277 @kindex C-c ^ (Article)
11278 @findex gnus-article-refer-article
11279 If point is in the neighborhood of a @code{Message-ID} and you press
11280 @kbd{C-c ^}, Gnus will try to get that article from the server
11281 (@code{gnus-article-refer-article}).
11284 @kindex C-c C-m (Article)
11285 @findex gnus-article-mail
11286 Send a reply to the address near point (@code{gnus-article-mail}). If
11287 given a prefix, include the mail.
11290 @kindex s (Article)
11291 @findex gnus-article-show-summary
11292 Reconfigure the buffers so that the summary buffer becomes visible
11293 (@code{gnus-article-show-summary}).
11296 @kindex ? (Article)
11297 @findex gnus-article-describe-briefly
11298 Give a very brief description of the available keystrokes
11299 (@code{gnus-article-describe-briefly}).
11302 @kindex TAB (Article)
11303 @findex gnus-article-next-button
11304 Go to the next button, if any (@code{gnus-article-next-button}). This
11305 only makes sense if you have buttonizing turned on.
11308 @kindex M-TAB (Article)
11309 @findex gnus-article-prev-button
11310 Go to the previous button, if any (@code{gnus-article-prev-button}).
11313 @kindex R (Article)
11314 @findex gnus-article-reply-with-original
11315 Send a reply to the current article and yank the current article
11316 (@code{gnus-article-reply-with-original}). If given a prefix, make a
11317 wide reply. If the region is active, only yank the text in the
11321 @kindex F (Article)
11322 @findex gnus-article-followup-with-original
11323 Send a followup to the current article and yank the current article
11324 (@code{gnus-article-followup-with-original}). If given a prefix, make
11325 a wide reply. If the region is active, only yank the text in the
11333 @section Misc Article
11337 @item gnus-single-article-buffer
11338 @vindex gnus-single-article-buffer
11339 If non-@code{nil}, use the same article buffer for all the groups.
11340 (This is the default.) If @code{nil}, each group will have its own
11343 @vindex gnus-article-decode-hook
11344 @item gnus-article-decode-hook
11345 @cindex @acronym{MIME}
11346 Hook used to decode @acronym{MIME} articles. The default value is
11347 @code{(article-decode-charset article-decode-encoded-words)}
11349 @vindex gnus-article-prepare-hook
11350 @item gnus-article-prepare-hook
11351 This hook is called right after the article has been inserted into the
11352 article buffer. It is mainly intended for functions that do something
11353 depending on the contents; it should probably not be used for changing
11354 the contents of the article buffer.
11356 @item gnus-article-mode-hook
11357 @vindex gnus-article-mode-hook
11358 Hook called in article mode buffers.
11360 @item gnus-article-mode-syntax-table
11361 @vindex gnus-article-mode-syntax-table
11362 Syntax table used in article buffers. It is initialized from
11363 @code{text-mode-syntax-table}.
11365 @vindex gnus-article-over-scroll
11366 @item gnus-article-over-scroll
11367 If non-@code{nil}, allow scrolling the article buffer even when there
11368 no more new text to scroll in. The default is @code{nil}.
11370 @vindex gnus-article-mode-line-format
11371 @item gnus-article-mode-line-format
11372 This variable is a format string along the same lines as
11373 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
11374 Line}). It accepts the same format specifications as that variable,
11375 with two extensions:
11380 The @dfn{wash status} of the article. This is a short string with one
11381 character for each possible article wash operation that may have been
11382 performed. The characters and their meaning:
11387 Displayed when cited text may be hidden in the article buffer.
11390 Displayed when headers are hidden in the article buffer.
11393 Displayed when article is digitally signed or encrypted, and Gnus has
11394 hidden the security headers. (N.B. does not tell anything about
11395 security status, i.e. good or bad signature.)
11398 Displayed when the signature has been hidden in the Article buffer.
11401 Displayed when Gnus has treated overstrike characters in the article buffer.
11404 Displayed when Gnus has treated emphasised strings in the article buffer.
11409 The number of @acronym{MIME} parts in the article.
11413 @vindex gnus-break-pages
11415 @item gnus-break-pages
11416 Controls whether @dfn{page breaking} is to take place. If this variable
11417 is non-@code{nil}, the articles will be divided into pages whenever a
11418 page delimiter appears in the article. If this variable is @code{nil},
11419 paging will not be done.
11421 @item gnus-page-delimiter
11422 @vindex gnus-page-delimiter
11423 This is the delimiter mentioned above. By default, it is @samp{^L}
11427 @cindex internationalized domain names
11428 @vindex gnus-use-idna
11429 @item gnus-use-idna
11430 This variable controls whether Gnus performs IDNA decoding of
11431 internationalized domain names inside @samp{From}, @samp{To} and
11432 @samp{Cc} headers. This requires
11433 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
11434 variable is only enabled if you have installed it.
11439 @node Composing Messages
11440 @chapter Composing Messages
11441 @cindex composing messages
11444 @cindex sending mail
11449 @cindex using s/mime
11450 @cindex using smime
11452 @kindex C-c C-c (Post)
11453 All commands for posting and mailing will put you in a message buffer
11454 where you can edit the article all you like, before you send the
11455 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
11456 Message Manual}. Where the message will be posted/mailed to depends
11457 on your setup (@pxref{Posting Server}).
11460 * Mail:: Mailing and replying.
11461 * Posting Server:: What server should you post and mail via?
11462 * POP before SMTP:: You cannot send a mail unless you read a mail.
11463 * Mail and Post:: Mailing and posting at the same time.
11464 * Archived Messages:: Where Gnus stores the messages you've sent.
11465 * Posting Styles:: An easier way to specify who you are.
11466 * Drafts:: Postponing messages and rejected messages.
11467 * Rejected Articles:: What happens if the server doesn't like your article?
11468 * Signing and encrypting:: How to compose secure messages.
11471 Also @pxref{Canceling and Superseding} for information on how to
11472 remove articles you shouldn't have posted.
11478 Variables for customizing outgoing mail:
11481 @item gnus-uu-digest-headers
11482 @vindex gnus-uu-digest-headers
11483 List of regexps to match headers included in digested messages. The
11484 headers will be included in the sequence they are matched. If
11485 @code{nil} include all headers.
11487 @item gnus-add-to-list
11488 @vindex gnus-add-to-list
11489 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11490 that have none when you do a @kbd{a}.
11492 @item gnus-confirm-mail-reply-to-news
11493 @vindex gnus-confirm-mail-reply-to-news
11494 This can also be a function receiving the group name as the only
11495 parameter which should return non-@code{nil} if a confirmation is
11496 needed, or a regular expression matching group names, where
11497 confirmation is should be asked for.
11499 If you find yourself never wanting to reply to mail, but occasionally
11500 press R anyway, this variable might be for you.
11502 @item gnus-confirm-treat-mail-like-news
11503 @vindex gnus-confirm-treat-mail-like-news
11504 If non-@code{nil}, Gnus also requests confirmation according to
11505 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
11506 useful for treating mailing lists like newsgroups.
11511 @node Posting Server
11512 @section Posting Server
11514 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11515 (extremely intelligent, of course) article, where does it go?
11517 Thank you for asking. I hate you.
11519 It can be quite complicated.
11521 @vindex gnus-post-method
11522 When posting news, Message usually invokes @code{message-send-news}
11523 (@pxref{News Variables, , News Variables, message, Message Manual}).
11524 Normally, Gnus will post using the same select method as you're
11525 reading from (which might be convenient if you're reading lots of
11526 groups from different private servers). However. If the server
11527 you're reading from doesn't allow posting, just reading, you probably
11528 want to use some other server to post your (extremely intelligent and
11529 fabulously interesting) articles. You can then set the
11530 @code{gnus-post-method} to some other method:
11533 (setq gnus-post-method '(nnspool ""))
11536 Now, if you've done this, and then this server rejects your article, or
11537 this server is down, what do you do then? To override this variable you
11538 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11539 the ``current'' server, to get back the default behavior, for posting.
11541 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11542 Gnus will prompt you for what method to use for posting.
11544 You can also set @code{gnus-post-method} to a list of select methods.
11545 If that's the case, Gnus will always prompt you for what method to use
11548 Finally, if you want to always post using the native select method,
11549 you can set this variable to @code{native}.
11551 When sending mail, Message invokes @code{message-send-mail-function}.
11552 The default function, @code{message-send-mail-with-sendmail}, pipes
11553 your article to the @code{sendmail} binary for further queuing and
11554 sending. When your local system is not configured for sending mail
11555 using @code{sendmail}, and you have access to a remote @acronym{SMTP}
11556 server, you can set @code{message-send-mail-function} to
11557 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11558 package correctly. An example:
11561 (setq message-send-mail-function 'smtpmail-send-it
11562 smtpmail-default-smtp-server "YOUR SMTP HOST")
11565 To the thing similar to this, there is
11566 @code{message-smtpmail-send-it}. It is useful if your @acronym{ISP}
11567 requires the @acronym{POP}-before-@acronym{SMTP} authentication.
11568 @xref{POP before SMTP}.
11570 Other possible choices for @code{message-send-mail-function} includes
11571 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11572 and @code{feedmail-send-it}.
11574 @node POP before SMTP
11575 @section POP before SMTP
11576 @cindex pop before smtp
11577 @findex message-smtpmail-send-it
11578 @findex mail-source-touch-pop
11580 Does your @acronym{ISP} require the @acronym{POP}-before-@acronym{SMTP}
11581 authentication? It is whether you need to connect to the @acronym{POP}
11582 mail server within a certain time before sending mails. If so, there is
11583 a convenient way. To do that, put the following lines in your
11584 @file{~/.gnus.el} file:
11587 (setq message-send-mail-function 'message-smtpmail-send-it)
11588 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
11592 It means to let Gnus connect to the @acronym{POP} mail server in advance
11593 whenever you send a mail. The @code{mail-source-touch-pop} function
11594 does only a @acronym{POP} authentication according to the value of
11595 @code{mail-sources} without fetching mails, just before sending a mail.
11596 Note that you have to use @code{message-smtpmail-send-it} which runs
11597 @code{message-send-mail-hook} rather than @code{smtpmail-send-it} and
11598 set the value of @code{mail-sources} for a @acronym{POP} connection
11599 correctly. @xref{Mail Sources}.
11601 If you have two or more @acronym{POP} mail servers set in
11602 @code{mail-sources}, you may want to specify one of them to
11603 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
11604 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
11605 is your primary @acronym{POP} mail server (i.e., you are fetching mails
11606 mainly from that server), you can set it permanently as follows:
11609 (setq mail-source-primary-source
11610 '(pop :server "pop3.mail.server"
11611 :password "secret"))
11615 Otherwise, bind it dynamically only when performing the
11616 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
11619 (add-hook 'message-send-mail-hook
11621 (let ((mail-source-primary-source
11622 '(pop :server "pop3.mail.server"
11623 :password "secret")))
11624 (mail-source-touch-pop))))
11627 @node Mail and Post
11628 @section Mail and Post
11630 Here's a list of variables relevant to both mailing and
11634 @item gnus-mailing-list-groups
11635 @findex gnus-mailing-list-groups
11636 @cindex mailing lists
11638 If your news server offers groups that are really mailing lists
11639 gatewayed to the @acronym{NNTP} server, you can read those groups without
11640 problems, but you can't post/followup to them without some difficulty.
11641 One solution is to add a @code{to-address} to the group parameters
11642 (@pxref{Group Parameters}). An easier thing to do is set the
11643 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
11644 really are mailing lists. Then, at least, followups to the mailing
11645 lists will work most of the time. Posting to these groups (@kbd{a}) is
11646 still a pain, though.
11648 @item gnus-user-agent
11649 @vindex gnus-user-agent
11652 This variable controls which information should be exposed in the
11653 User-Agent header. It can be one of the symbols @code{gnus} (show only
11654 Gnus version), @code{emacs-gnus} (show only Emacs and Gnus versions),
11655 @code{emacs-gnus-config} (same as @code{emacs-gnus} plus system
11656 configuration), @code{emacs-gnus-type} (same as @code{emacs-gnus} plus
11657 system type) or a custom string. If you set it to a string, be sure to
11658 use a valid format, see RFC 2616.
11662 You may want to do spell-checking on messages that you send out. Or, if
11663 you don't want to spell-check by hand, you could add automatic
11664 spell-checking via the @code{ispell} package:
11667 @findex ispell-message
11669 (add-hook 'message-send-hook 'ispell-message)
11672 If you want to change the @code{ispell} dictionary based on what group
11673 you're in, you could say something like the following:
11676 (add-hook 'gnus-select-group-hook
11680 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
11681 (ispell-change-dictionary "deutsch"))
11683 (ispell-change-dictionary "english")))))
11686 Modify to suit your needs.
11689 @node Archived Messages
11690 @section Archived Messages
11691 @cindex archived messages
11692 @cindex sent messages
11694 Gnus provides a few different methods for storing the mail and news you
11695 send. The default method is to use the @dfn{archive virtual server} to
11696 store the messages. If you want to disable this completely, the
11697 @code{gnus-message-archive-group} variable should be @code{nil}, which
11700 For archiving interesting messages in a group you read, see the
11701 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
11704 @vindex gnus-message-archive-method
11705 @code{gnus-message-archive-method} says what virtual server Gnus is to
11706 use to store sent messages. The default is:
11709 (nnfolder "archive"
11710 (nnfolder-directory "~/Mail/archive")
11711 (nnfolder-active-file "~/Mail/archive/active")
11712 (nnfolder-get-new-mail nil)
11713 (nnfolder-inhibit-expiry t))
11716 You can, however, use any mail select method (@code{nnml},
11717 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
11718 for doing this sort of thing, though. If you don't like the default
11719 directory chosen, you could say something like:
11722 (setq gnus-message-archive-method
11723 '(nnfolder "archive"
11724 (nnfolder-inhibit-expiry t)
11725 (nnfolder-active-file "~/News/sent-mail/active")
11726 (nnfolder-directory "~/News/sent-mail/")))
11729 @vindex gnus-message-archive-group
11731 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11732 to one or more group(s) on that server. Which group to use is
11733 determined by the @code{gnus-message-archive-group} variable.
11735 This variable can be used to do the following:
11739 Messages will be saved in that group.
11741 Note that you can include a select method in the group name, then the
11742 message will not be stored in the select method given by
11743 @code{gnus-message-archive-method}, but in the select method specified
11744 by the group name, instead. Suppose @code{gnus-message-archive-method}
11745 has the default value shown above. Then setting
11746 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11747 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11748 value @code{"nnml:foo"}, then outgoing messages will be stored in
11751 @item a list of strings
11752 Messages will be saved in all those groups.
11754 @item an alist of regexps, functions and forms
11755 When a key ``matches'', the result is used.
11758 No message archiving will take place. This is the default.
11763 Just saving to a single group called @samp{MisK}:
11765 (setq gnus-message-archive-group "MisK")
11768 Saving to two groups, @samp{MisK} and @samp{safe}:
11770 (setq gnus-message-archive-group '("MisK" "safe"))
11773 Save to different groups based on what group you are in:
11775 (setq gnus-message-archive-group
11776 '(("^alt" "sent-to-alt")
11777 ("mail" "sent-to-mail")
11778 (".*" "sent-to-misc")))
11781 More complex stuff:
11783 (setq gnus-message-archive-group
11784 '((if (message-news-p)
11789 How about storing all news messages in one file, but storing all mail
11790 messages in one file per month:
11793 (setq gnus-message-archive-group
11794 '((if (message-news-p)
11796 (concat "mail." (format-time-string "%Y-%m")))))
11799 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11800 @c use a different value for @code{gnus-message-archive-group} there.)
11802 Now, when you send a message off, it will be stored in the appropriate
11803 group. (If you want to disable storing for just one particular message,
11804 you can just remove the @code{Gcc} header that has been inserted.) The
11805 archive group will appear in the group buffer the next time you start
11806 Gnus, or the next time you press @kbd{F} in the group buffer. You can
11807 enter it and read the articles in it just like you'd read any other
11808 group. If the group gets really big and annoying, you can simply rename
11809 if (using @kbd{G r} in the group buffer) to something
11810 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
11811 continue to be stored in the old (now empty) group.
11813 That's the default method of archiving sent messages. Gnus offers a
11814 different way for the people who don't like the default method. In that
11815 case you should set @code{gnus-message-archive-group} to @code{nil};
11816 this will disable archiving.
11819 @item gnus-outgoing-message-group
11820 @vindex gnus-outgoing-message-group
11821 All outgoing messages will be put in this group. If you want to store
11822 all your outgoing mail and articles in the group @samp{nnml:archive},
11823 you set this variable to that value. This variable can also be a list of
11826 If you want to have greater control over what group to put each
11827 message in, you can set this variable to a function that checks the
11828 current newsgroup name and then returns a suitable group name (or list
11831 This variable can be used instead of @code{gnus-message-archive-group},
11832 but the latter is the preferred method.
11834 @item gnus-gcc-mark-as-read
11835 @vindex gnus-gcc-mark-as-read
11836 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11838 @item gnus-gcc-externalize-attachments
11839 @vindex gnus-gcc-externalize-attachments
11840 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11841 and matches the Gcc group name, attach files as external parts; if it is
11842 @code{all}, attach local files as external parts; if it is other
11843 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11844 changed in the future.
11849 @node Posting Styles
11850 @section Posting Styles
11851 @cindex posting styles
11854 All them variables, they make my head swim.
11856 So what if you want a different @code{Organization} and signature based
11857 on what groups you post to? And you post both from your home machine
11858 and your work machine, and you want different @code{From} lines, and so
11861 @vindex gnus-posting-styles
11862 One way to do stuff like that is to write clever hooks that change the
11863 variables you need to have changed. That's a bit boring, so somebody
11864 came up with the bright idea of letting the user specify these things in
11865 a handy alist. Here's an example of a @code{gnus-posting-styles}
11870 (signature "Peace and happiness")
11871 (organization "What me?"))
11873 (signature "Death to everybody"))
11874 ("comp.emacs.i-love-it"
11875 (organization "Emacs is it")))
11878 As you might surmise from this example, this alist consists of several
11879 @dfn{styles}. Each style will be applicable if the first element
11880 ``matches'', in some form or other. The entire alist will be iterated
11881 over, from the beginning towards the end, and each match will be
11882 applied, which means that attributes in later styles that match override
11883 the same attributes in earlier matching styles. So
11884 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11885 signature and the @samp{What me?} @code{Organization} header.
11887 The first element in each style is called the @code{match}. If it's a
11888 string, then Gnus will try to regexp match it against the group name.
11889 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
11890 will look in the original article for a header whose name is
11891 @var{match} and compare that @var{regexp}. @var{match} and
11892 @var{regexp} are strings. (The original article is the one you are
11893 replying or following up to. If you are not composing a reply or a
11894 followup, then there is nothing to match against.) If the
11895 @code{match} is a function symbol, that function will be called with
11896 no arguments. If it's a variable symbol, then the variable will be
11897 referenced. If it's a list, then that list will be @code{eval}ed. In
11898 any case, if this returns a non-@code{nil} value, then the style is
11899 said to @dfn{match}.
11901 Each style may contain an arbitrary amount of @dfn{attributes}. Each
11902 attribute consists of a @code{(@var{name} @var{value})} pair. The
11903 attribute name can be one of:
11906 @item @code{signature}
11907 @item @code{signature-file}
11908 @item @code{x-face-file}
11909 @item @code{address}, overriding @code{user-mail-address}
11910 @item @code{name}, overriding @code{(user-full-name)}
11914 The attribute name can also be a string or a symbol. In that case,
11915 this will be used as a header name, and the value will be inserted in
11916 the headers of the article; if the value is @code{nil}, the header
11917 name will be removed. If the attribute name is @code{eval}, the form
11918 is evaluated, and the result is thrown away.
11920 The attribute value can be a string (used verbatim), a function with
11921 zero arguments (the return value will be used), a variable (its value
11922 will be used) or a list (it will be @code{eval}ed and the return value
11923 will be used). The functions and sexps are called/@code{eval}ed in the
11924 message buffer that is being set up. The headers of the current article
11925 are available through the @code{message-reply-headers} variable, which
11926 is a vector of the following headers: number subject from date id
11927 references chars lines xref extra.
11929 @vindex message-reply-headers
11931 If you wish to check whether the message you are about to compose is
11932 meant to be a news article or a mail message, you can check the values
11933 of the @code{message-news-p} and @code{message-mail-p} functions.
11935 @findex message-mail-p
11936 @findex message-news-p
11938 So here's a new example:
11941 (setq gnus-posting-styles
11943 (signature-file "~/.signature")
11945 ("X-Home-Page" (getenv "WWW_HOME"))
11946 (organization "People's Front Against MWM"))
11948 (signature my-funny-signature-randomizer))
11949 ((equal (system-name) "gnarly") ;; @r{A form}
11950 (signature my-quote-randomizer))
11951 (message-news-p ;; @r{A function symbol}
11952 (signature my-news-signature))
11953 (window-system ;; @r{A value symbol}
11954 ("X-Window-System" (format "%s" window-system)))
11955 ;; @r{If I'm replying to Larsi, set the Organization header.}
11956 ((header "from" "larsi.*org")
11957 (Organization "Somewhere, Inc."))
11958 ((posting-from-work-p) ;; @r{A user defined function}
11959 (signature-file "~/.work-signature")
11960 (address "user@@bar.foo")
11961 (body "You are fired.\n\nSincerely, your boss.")
11962 (organization "Important Work, Inc"))
11964 (From (save-excursion
11965 (set-buffer gnus-article-buffer)
11966 (message-fetch-field "to"))))
11968 (signature-file "~/.mail-signature"))))
11971 The @samp{nnml:.*} rule means that you use the @code{To} address as the
11972 @code{From} address in all your outgoing replies, which might be handy
11973 if you fill many roles.
11980 If you are writing a message (mail or news) and suddenly remember that
11981 you have a steak in the oven (or some pesto in the food processor, you
11982 craaazy vegetarians), you'll probably wish there was a method to save
11983 the message you are writing so that you can continue editing it some
11984 other day, and send it when you feel its finished.
11986 Well, don't worry about it. Whenever you start composing a message of
11987 some sort using the Gnus mail and post commands, the buffer you get will
11988 automatically associate to an article in a special @dfn{draft} group.
11989 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
11990 article will be saved there. (Auto-save files also go to the draft
11994 @vindex nndraft-directory
11995 The draft group is a special group (which is implemented as an
11996 @code{nndraft} group, if you absolutely have to know) called
11997 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
11998 @code{nndraft} is to store its files. What makes this group special is
11999 that you can't tick any articles in it or mark any articles as
12000 read---all articles in the group are permanently unread.
12002 If the group doesn't exist, it will be created and you'll be subscribed
12003 to it. The only way to make it disappear from the Group buffer is to
12004 unsubscribe it. The special properties of the draft group comes from
12005 a group property (@pxref{Group Parameters}), and if lost the group
12006 behaves like any other group. This means the commands below will not
12007 be available. To restore the special properties of the group, the
12008 simplest way is to kill the group, using @kbd{C-k}, and restart
12009 Gnus. The group is automatically created again with the
12010 correct parameters. The content of the group is not lost.
12012 @c @findex gnus-dissociate-buffer-from-draft
12013 @c @kindex C-c M-d (Mail)
12014 @c @kindex C-c M-d (Post)
12015 @c @findex gnus-associate-buffer-with-draft
12016 @c @kindex C-c C-d (Mail)
12017 @c @kindex C-c C-d (Post)
12018 @c If you're writing some super-secret message that you later want to
12019 @c encode with PGP before sending, you may wish to turn the auto-saving
12020 @c (and association with the draft group) off. You never know who might be
12021 @c interested in reading all your extremely valuable and terribly horrible
12022 @c and interesting secrets. The @kbd{C-c M-d}
12023 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
12024 @c If you change your mind and want to turn the auto-saving back on again,
12025 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
12027 @c @vindex gnus-use-draft
12028 @c To leave association with the draft group off by default, set
12029 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
12031 @findex gnus-draft-edit-message
12032 @kindex D e (Draft)
12033 When you want to continue editing the article, you simply enter the
12034 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
12035 that. You will be placed in a buffer where you left off.
12037 Rejected articles will also be put in this draft group (@pxref{Rejected
12040 @findex gnus-draft-send-all-messages
12041 @kindex D s (Draft)
12042 @findex gnus-draft-send-message
12043 @kindex D S (Draft)
12044 If you have lots of rejected messages you want to post (or mail) without
12045 doing further editing, you can use the @kbd{D s} command
12046 (@code{gnus-draft-send-message}). This command understands the
12047 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
12048 command (@code{gnus-draft-send-all-messages}) will ship off all messages
12051 @findex gnus-draft-toggle-sending
12052 @kindex D t (Draft)
12053 If you have some messages that you wish not to send, you can use the
12054 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
12055 as unsendable. This is a toggling command.
12058 @node Rejected Articles
12059 @section Rejected Articles
12060 @cindex rejected articles
12062 Sometimes a news server will reject an article. Perhaps the server
12063 doesn't like your face. Perhaps it just feels miserable. Perhaps
12064 @emph{there be demons}. Perhaps you have included too much cited text.
12065 Perhaps the disk is full. Perhaps the server is down.
12067 These situations are, of course, totally beyond the control of Gnus.
12068 (Gnus, of course, loves the way you look, always feels great, has angels
12069 fluttering around inside of it, doesn't care about how much cited text
12070 you include, never runs full and never goes down.) So Gnus saves these
12071 articles until some later time when the server feels better.
12073 The rejected articles will automatically be put in a special draft group
12074 (@pxref{Drafts}). When the server comes back up again, you'd then
12075 typically enter that group and send all the articles off.
12077 @node Signing and encrypting
12078 @section Signing and encrypting
12080 @cindex using s/mime
12081 @cindex using smime
12083 Gnus can digitally sign and encrypt your messages, using vanilla
12084 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
12085 decoding such messages, see the @code{mm-verify-option} and
12086 @code{mm-decrypt-option} options (@pxref{Security}).
12088 @vindex gnus-message-replysign
12089 @vindex gnus-message-replyencrypt
12090 @vindex gnus-message-replysignencrypted
12091 Often, you would like to sign replies to people who send you signed
12092 messages. Even more often, you might want to encrypt messages which
12093 are in reply to encrypted messages. Gnus offers
12094 @code{gnus-message-replysign} to enable the former, and
12095 @code{gnus-message-replyencrypt} for the latter. In addition, setting
12096 @code{gnus-message-replysignencrypted} (on by default) will sign
12097 automatically encrypted messages.
12099 Instructing @acronym{MML} to perform security operations on a
12100 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
12101 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
12106 @kindex C-c C-m s s (Message)
12107 @findex mml-secure-message-sign-smime
12109 Digitally sign current message using @acronym{S/MIME}.
12112 @kindex C-c C-m s o (Message)
12113 @findex mml-secure-message-sign-pgp
12115 Digitally sign current message using @acronym{PGP}.
12118 @kindex C-c C-m s p (Message)
12119 @findex mml-secure-message-sign-pgp
12121 Digitally sign current message using @acronym{PGP/MIME}.
12124 @kindex C-c C-m c s (Message)
12125 @findex mml-secure-message-encrypt-smime
12127 Digitally encrypt current message using @acronym{S/MIME}.
12130 @kindex C-c C-m c o (Message)
12131 @findex mml-secure-message-encrypt-pgp
12133 Digitally encrypt current message using @acronym{PGP}.
12136 @kindex C-c C-m c p (Message)
12137 @findex mml-secure-message-encrypt-pgpmime
12139 Digitally encrypt current message using @acronym{PGP/MIME}.
12142 @kindex C-c C-m C-n (Message)
12143 @findex mml-unsecure-message
12144 Remove security related @acronym{MML} tags from message.
12148 @xref{Security, ,Security, message, Message Manual}, for more information.
12150 @node Select Methods
12151 @chapter Select Methods
12152 @cindex foreign groups
12153 @cindex select methods
12155 A @dfn{foreign group} is a group not read by the usual (or
12156 default) means. It could be, for instance, a group from a different
12157 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12158 personal mail group.
12160 A foreign group (or any group, really) is specified by a @dfn{name} and
12161 a @dfn{select method}. To take the latter first, a select method is a
12162 list where the first element says what back end to use (e.g. @code{nntp},
12163 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12164 name}. There may be additional elements in the select method, where the
12165 value may have special meaning for the back end in question.
12167 One could say that a select method defines a @dfn{virtual server}---so
12168 we do just that (@pxref{Server Buffer}).
12170 The @dfn{name} of the group is the name the back end will recognize the
12173 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12174 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12175 method @code{(nntp "some.where.edu")}. Gnus will call this group
12176 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12177 back end just knows this group as @samp{soc.motss}.
12179 The different methods all have their peculiarities, of course.
12182 * Server Buffer:: Making and editing virtual servers.
12183 * Getting News:: Reading USENET news with Gnus.
12184 * Getting Mail:: Reading your personal mail with Gnus.
12185 * Browsing the Web:: Getting messages from a plethora of Web sources.
12186 * IMAP:: Using Gnus as a @acronym{IMAP} client.
12187 * Other Sources:: Reading directories, files, SOUP packets.
12188 * Combined Groups:: Combining groups into one group.
12189 * Gnus Unplugged:: Reading news and mail offline.
12193 @node Server Buffer
12194 @section Server Buffer
12196 Traditionally, a @dfn{server} is a machine or a piece of software that
12197 one connects to, and then requests information from. Gnus does not
12198 connect directly to any real servers, but does all transactions through
12199 one back end or other. But that's just putting one layer more between
12200 the actual media and Gnus, so we might just as well say that each
12201 back end represents a virtual server.
12203 For instance, the @code{nntp} back end may be used to connect to several
12204 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12205 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12206 use, and what parameters to set by specifying a @dfn{select method}.
12208 These select method specifications can sometimes become quite
12209 complicated---say, for instance, that you want to read from the
12210 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12211 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12212 Anyway, if you had to specify that for each group that used this
12213 server, that would be too much work, so Gnus offers a way of naming
12214 select methods, which is what you do in the server buffer.
12216 To enter the server buffer, use the @kbd{^}
12217 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12220 * Server Buffer Format:: You can customize the look of this buffer.
12221 * Server Commands:: Commands to manipulate servers.
12222 * Example Methods:: Examples server specifications.
12223 * Creating a Virtual Server:: An example session.
12224 * Server Variables:: Which variables to set.
12225 * Servers and Methods:: You can use server names as select methods.
12226 * Unavailable Servers:: Some servers you try to contact may be down.
12229 @vindex gnus-server-mode-hook
12230 @code{gnus-server-mode-hook} is run when creating the server buffer.
12233 @node Server Buffer Format
12234 @subsection Server Buffer Format
12235 @cindex server buffer format
12237 @vindex gnus-server-line-format
12238 You can change the look of the server buffer lines by changing the
12239 @code{gnus-server-line-format} variable. This is a @code{format}-like
12240 variable, with some simple extensions:
12245 How the news is fetched---the back end name.
12248 The name of this server.
12251 Where the news is to be fetched from---the address.
12254 The opened/closed/denied status of the server.
12257 @vindex gnus-server-mode-line-format
12258 The mode line can also be customized by using the
12259 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12260 Formatting}). The following specs are understood:
12270 Also @pxref{Formatting Variables}.
12273 @node Server Commands
12274 @subsection Server Commands
12275 @cindex server commands
12281 @findex gnus-server-add-server
12282 Add a new server (@code{gnus-server-add-server}).
12286 @findex gnus-server-edit-server
12287 Edit a server (@code{gnus-server-edit-server}).
12290 @kindex SPACE (Server)
12291 @findex gnus-server-read-server
12292 Browse the current server (@code{gnus-server-read-server}).
12296 @findex gnus-server-exit
12297 Return to the group buffer (@code{gnus-server-exit}).
12301 @findex gnus-server-kill-server
12302 Kill the current server (@code{gnus-server-kill-server}).
12306 @findex gnus-server-yank-server
12307 Yank the previously killed server (@code{gnus-server-yank-server}).
12311 @findex gnus-server-copy-server
12312 Copy the current server (@code{gnus-server-copy-server}).
12316 @findex gnus-server-list-servers
12317 List all servers (@code{gnus-server-list-servers}).
12321 @findex gnus-server-scan-server
12322 Request that the server scan its sources for new articles
12323 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12328 @findex gnus-server-regenerate-server
12329 Request that the server regenerate all its data structures
12330 (@code{gnus-server-regenerate-server}). This can be useful if you have
12331 a mail back end that has gotten out of sync.
12336 @node Example Methods
12337 @subsection Example Methods
12339 Most select methods are pretty simple and self-explanatory:
12342 (nntp "news.funet.fi")
12345 Reading directly from the spool is even simpler:
12351 As you can see, the first element in a select method is the name of the
12352 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12355 After these two elements, there may be an arbitrary number of
12356 @code{(@var{variable} @var{form})} pairs.
12358 To go back to the first example---imagine that you want to read from
12359 port 15 on that machine. This is what the select method should
12363 (nntp "news.funet.fi" (nntp-port-number 15))
12366 You should read the documentation to each back end to find out what
12367 variables are relevant, but here's an @code{nnmh} example:
12369 @code{nnmh} is a mail back end that reads a spool-like structure. Say
12370 you have two structures that you wish to access: One is your private
12371 mail spool, and the other is a public one. Here's the possible spec for
12375 (nnmh "private" (nnmh-directory "~/private/mail/"))
12378 (This server is then called @samp{private}, but you may have guessed
12381 Here's the method for a public spool:
12385 (nnmh-directory "/usr/information/spool/")
12386 (nnmh-get-new-mail nil))
12392 If you are behind a firewall and only have access to the @acronym{NNTP}
12393 server from the firewall machine, you can instruct Gnus to @code{rlogin}
12394 on the firewall machine and telnet from there to the @acronym{NNTP} server.
12395 Doing this can be rather fiddly, but your virtual server definition
12396 should probably look something like this:
12400 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
12401 (nntp-via-address "the.firewall.machine")
12402 (nntp-address "the.real.nntp.host")
12403 (nntp-end-of-line "\n"))
12406 If you want to use the wonderful @code{ssh} program to provide a
12407 compressed connection over the modem line, you could add the following
12408 configuration to the example above:
12411 (nntp-via-rlogin-command "ssh")
12414 See also @code{nntp-via-rlogin-command-switches}.
12416 If you're behind a firewall, but have direct access to the outside world
12417 through a wrapper command like "runsocks", you could open a socksified
12418 telnet connection to the news server as follows:
12422 (nntp-pre-command "runsocks")
12423 (nntp-open-connection-function nntp-open-via-telnet)
12424 (nntp-address "the.news.server")
12425 (nntp-end-of-line "\n"))
12428 This means that you have to have set up @code{ssh-agent} correctly to
12429 provide automatic authorization, of course. And to get a compressed
12430 connection, you have to have the @samp{Compression} option in the
12431 @code{ssh} @file{config} file.
12434 @node Creating a Virtual Server
12435 @subsection Creating a Virtual Server
12437 If you're saving lots of articles in the cache by using persistent
12438 articles, you may want to create a virtual server to read the cache.
12440 First you need to add a new server. The @kbd{a} command does that. It
12441 would probably be best to use @code{nnml} to read the cache. You
12442 could also use @code{nnspool} or @code{nnmh}, though.
12444 Type @kbd{a nnml RET cache RET}.
12446 You should now have a brand new @code{nnml} virtual server called
12447 @samp{cache}. You now need to edit it to have the right definitions.
12448 Type @kbd{e} to edit the server. You'll be entered into a buffer that
12449 will contain the following:
12459 (nnml-directory "~/News/cache/")
12460 (nnml-active-file "~/News/cache/active"))
12463 Type @kbd{C-c C-c} to return to the server buffer. If you now press
12464 @kbd{RET} over this virtual server, you should be entered into a browse
12465 buffer, and you should be able to enter any of the groups displayed.
12468 @node Server Variables
12469 @subsection Server Variables
12470 @cindex server variables
12471 @cindex server parameters
12473 One sticky point when defining variables (both on back ends and in Emacs
12474 in general) is that some variables are typically initialized from other
12475 variables when the definition of the variables is being loaded. If you
12476 change the ``base'' variable after the variables have been loaded, you
12477 won't change the ``derived'' variables.
12479 This typically affects directory and file variables. For instance,
12480 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
12481 directory variables are initialized from that variable, so
12482 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
12483 new virtual @code{nnml} server, it will @emph{not} suffice to set just
12484 @code{nnml-directory}---you have to explicitly set all the file
12485 variables to be what you want them to be. For a complete list of
12486 variables for each back end, see each back end's section later in this
12487 manual, but here's an example @code{nnml} definition:
12491 (nnml-directory "~/my-mail/")
12492 (nnml-active-file "~/my-mail/active")
12493 (nnml-newsgroups-file "~/my-mail/newsgroups"))
12496 Server variables are often called @dfn{server parameters}.
12498 @node Servers and Methods
12499 @subsection Servers and Methods
12501 Wherever you would normally use a select method
12502 (e.g. @code{gnus-secondary-select-method}, in the group select method,
12503 when browsing a foreign server) you can use a virtual server name
12504 instead. This could potentially save lots of typing. And it's nice all
12508 @node Unavailable Servers
12509 @subsection Unavailable Servers
12511 If a server seems to be unreachable, Gnus will mark that server as
12512 @code{denied}. That means that any subsequent attempt to make contact
12513 with that server will just be ignored. ``It can't be opened,'' Gnus
12514 will tell you, without making the least effort to see whether that is
12515 actually the case or not.
12517 That might seem quite naughty, but it does make sense most of the time.
12518 Let's say you have 10 groups subscribed to on server
12519 @samp{nephelococcygia.com}. This server is located somewhere quite far
12520 away from you and the machine is quite slow, so it takes 1 minute just
12521 to find out that it refuses connection to you today. If Gnus were to
12522 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12523 attempt to do that. Once it has gotten a single ``connection refused'',
12524 it will regard that server as ``down''.
12526 So, what happens if the machine was only feeling unwell temporarily?
12527 How do you test to see whether the machine has come up again?
12529 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12530 with the following commands:
12536 @findex gnus-server-open-server
12537 Try to establish connection to the server on the current line
12538 (@code{gnus-server-open-server}).
12542 @findex gnus-server-close-server
12543 Close the connection (if any) to the server
12544 (@code{gnus-server-close-server}).
12548 @findex gnus-server-deny-server
12549 Mark the current server as unreachable
12550 (@code{gnus-server-deny-server}).
12553 @kindex M-o (Server)
12554 @findex gnus-server-open-all-servers
12555 Open the connections to all servers in the buffer
12556 (@code{gnus-server-open-all-servers}).
12559 @kindex M-c (Server)
12560 @findex gnus-server-close-all-servers
12561 Close the connections to all servers in the buffer
12562 (@code{gnus-server-close-all-servers}).
12566 @findex gnus-server-remove-denials
12567 Remove all marks to whether Gnus was denied connection from any servers
12568 (@code{gnus-server-remove-denials}).
12572 @findex gnus-server-offline-server
12573 Set server status to offline (@code{gnus-server-offline-server}).
12579 @section Getting News
12580 @cindex reading news
12581 @cindex news back ends
12583 A newsreader is normally used for reading news. Gnus currently provides
12584 only two methods of getting news---it can read from an @acronym{NNTP} server,
12585 or it can read from a local spool.
12588 * NNTP:: Reading news from an @acronym{NNTP} server.
12589 * News Spool:: Reading news from the local spool.
12597 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
12598 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
12599 server as the, uhm, address.
12601 If the @acronym{NNTP} server is located at a non-standard port, setting the
12602 third element of the select method to this port number should allow you
12603 to connect to the right port. You'll have to edit the group info for
12604 that (@pxref{Foreign Groups}).
12606 The name of the foreign group can be the same as a native group. In
12607 fact, you can subscribe to the same group from as many different servers
12608 you feel like. There will be no name collisions.
12610 The following variables can be used to create a virtual @code{nntp}
12615 @item nntp-server-opened-hook
12616 @vindex nntp-server-opened-hook
12617 @cindex @sc{mode reader}
12619 @cindex authentification
12620 @cindex nntp authentification
12621 @findex nntp-send-authinfo
12622 @findex nntp-send-mode-reader
12623 is run after a connection has been made. It can be used to send
12624 commands to the @acronym{NNTP} server after it has been contacted. By
12625 default it sends the command @code{MODE READER} to the server with the
12626 @code{nntp-send-mode-reader} function. This function should always be
12627 present in this hook.
12629 @item nntp-authinfo-function
12630 @vindex nntp-authinfo-function
12631 @findex nntp-send-authinfo
12632 @vindex nntp-authinfo-file
12633 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
12634 server. The default function is @code{nntp-send-authinfo}, which looks
12635 through your @file{~/.authinfo} (or whatever you've set the
12636 @code{nntp-authinfo-file} variable to) for applicable entries. If none
12637 are found, it will prompt you for a login name and a password. The
12638 format of the @file{~/.authinfo} file is (almost) the same as the
12639 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
12640 manual page, but here are the salient facts:
12644 The file contains one or more line, each of which define one server.
12647 Each line may contain an arbitrary number of token/value pairs.
12649 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
12650 @samp{default}. In addition Gnus introduces two new tokens, not present
12651 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
12652 @samp{force}. (This is the only way the @file{.authinfo} file format
12653 deviates from the @file{.netrc} file format.) @samp{port} is used to
12654 indicate what port on the server the credentials apply to and
12655 @samp{force} is explained below.
12659 Here's an example file:
12662 machine news.uio.no login larsi password geheimnis
12663 machine nntp.ifi.uio.no login larsi force yes
12666 The token/value pairs may appear in any order; @samp{machine} doesn't
12667 have to be first, for instance.
12669 In this example, both login name and password have been supplied for the
12670 former server, while the latter has only the login name listed, and the
12671 user will be prompted for the password. The latter also has the
12672 @samp{force} tag, which means that the authinfo will be sent to the
12673 @var{nntp} server upon connection; the default (i.e., when there is not
12674 @samp{force} tag) is to not send authinfo to the @var{nntp} server
12675 until the @var{nntp} server asks for it.
12677 You can also add @samp{default} lines that will apply to all servers
12678 that don't have matching @samp{machine} lines.
12684 This will force sending @samp{AUTHINFO} commands to all servers not
12685 previously mentioned.
12687 Remember to not leave the @file{~/.authinfo} file world-readable.
12689 @item nntp-server-action-alist
12690 @vindex nntp-server-action-alist
12691 This is a list of regexps to match on server types and actions to be
12692 taken when matches are made. For instance, if you want Gnus to beep
12693 every time you connect to innd, you could say something like:
12696 (setq nntp-server-action-alist
12697 '(("innd" (ding))))
12700 You probably don't want to do that, though.
12702 The default value is
12705 '(("nntpd 1\\.5\\.11t"
12706 (remove-hook 'nntp-server-opened-hook
12707 'nntp-send-mode-reader)))
12710 This ensures that Gnus doesn't send the @code{MODE READER} command to
12711 nntpd 1.5.11t, since that command chokes that server, I've been told.
12713 @item nntp-maximum-request
12714 @vindex nntp-maximum-request
12715 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
12716 will collect headers by sending a series of @code{head} commands. To
12717 speed things up, the back end sends lots of these commands without
12718 waiting for reply, and then reads all the replies. This is controlled
12719 by the @code{nntp-maximum-request} variable, and is 400 by default. If
12720 your network is buggy, you should set this to 1.
12722 @item nntp-connection-timeout
12723 @vindex nntp-connection-timeout
12724 If you have lots of foreign @code{nntp} groups that you connect to
12725 regularly, you're sure to have problems with @acronym{NNTP} servers not
12726 responding properly, or being too loaded to reply within reasonable
12727 time. This is can lead to awkward problems, which can be helped
12728 somewhat by setting @code{nntp-connection-timeout}. This is an integer
12729 that says how many seconds the @code{nntp} back end should wait for a
12730 connection before giving up. If it is @code{nil}, which is the default,
12731 no timeouts are done.
12733 @c @item nntp-command-timeout
12734 @c @vindex nntp-command-timeout
12735 @c @cindex PPP connections
12736 @c @cindex dynamic IP addresses
12737 @c If you're running Gnus on a machine that has a dynamically assigned
12738 @c address, Gnus may become confused. If the address of your machine
12739 @c changes after connecting to the @acronym{NNTP} server, Gnus will simply sit
12740 @c waiting forever for replies from the server. To help with this
12741 @c unfortunate problem, you can set this command to a number. Gnus will
12742 @c then, if it sits waiting for a reply from the server longer than that
12743 @c number of seconds, shut down the connection, start a new one, and resend
12744 @c the command. This should hopefully be transparent to the user. A
12745 @c likely number is 30 seconds.
12747 @c @item nntp-retry-on-break
12748 @c @vindex nntp-retry-on-break
12749 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
12750 @c hangs. This will have much the same effect as the command timeout
12751 @c described above.
12753 @item nntp-server-hook
12754 @vindex nntp-server-hook
12755 This hook is run as the last step when connecting to an @acronym{NNTP}
12758 @item nntp-buggy-select
12759 @vindex nntp-buggy-select
12760 Set this to non-@code{nil} if your select routine is buggy.
12762 @item nntp-nov-is-evil
12763 @vindex nntp-nov-is-evil
12764 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
12765 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
12768 @item nntp-xover-commands
12769 @vindex nntp-xover-commands
12770 @cindex @acronym{NOV}
12772 List of strings used as commands to fetch @acronym{NOV} lines from a
12773 server. The default value of this variable is @code{("XOVER"
12777 @vindex nntp-nov-gap
12778 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
12779 the server. The server responds with one huge list of lines. However,
12780 if you have read articles 2-5000 in the group, and only want to read
12781 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
12782 lines that you will not need. This variable says how
12783 big a gap between two consecutive articles is allowed to be before the
12784 @code{XOVER} request is split into several request. Note that if your
12785 network is fast, setting this variable to a really small number means
12786 that fetching will probably be slower. If this variable is @code{nil},
12787 @code{nntp} will never split requests. The default is 5.
12789 @item nntp-prepare-server-hook
12790 @vindex nntp-prepare-server-hook
12791 A hook run before attempting to connect to an @acronym{NNTP} server.
12793 @item nntp-warn-about-losing-connection
12794 @vindex nntp-warn-about-losing-connection
12795 If this variable is non-@code{nil}, some noise will be made when a
12796 server closes connection.
12798 @item nntp-record-commands
12799 @vindex nntp-record-commands
12800 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12801 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
12802 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
12803 that doesn't seem to work.
12805 @item nntp-open-connection-function
12806 @vindex nntp-open-connection-function
12807 It is possible to customize how the connection to the nntp server will
12808 be opened. If you specify an @code{nntp-open-connection-function}
12809 parameter, Gnus will use that function to establish the connection.
12810 Five pre-made functions are supplied. These functions can be grouped in
12811 two categories: direct connection functions (three pre-made), and
12812 indirect ones (two pre-made).
12814 @item nntp-prepare-post-hook
12815 @vindex nntp-prepare-post-hook
12816 A hook run just before posting an article. If there is no
12817 @code{Message-ID} header in the article and the news server provides the
12818 recommended ID, it will be added to the article before running this
12819 hook. It is useful to make @code{Cancel-Lock} headers even if you
12820 inhibit Gnus to add a @code{Message-ID} header, you could say:
12823 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12826 Note that not all servers support the recommended ID. This works for
12827 INN versions 2.3.0 and later, for instance.
12829 @item nntp-read-timeout
12830 @vindex nntp-read-timeout
12831 How long nntp should wait between checking for the end of output.
12832 Shorter values mean quicker response, but is more CPU intensive. The
12833 default is 0.1 seconds. If you have a slow line to the server (and
12834 don't like to see Emacs eat your available CPU power), you might set
12840 * Direct Functions:: Connecting directly to the server.
12841 * Indirect Functions:: Connecting indirectly to the server.
12842 * Common Variables:: Understood by several connection functions.
12846 @node Direct Functions
12847 @subsubsection Direct Functions
12848 @cindex direct connection functions
12850 These functions are called direct because they open a direct connection
12851 between your machine and the @acronym{NNTP} server. The behavior of these
12852 functions is also affected by commonly understood variables
12853 (@pxref{Common Variables}).
12856 @findex nntp-open-network-stream
12857 @item nntp-open-network-stream
12858 This is the default, and simply connects to some port or other on the
12861 @findex nntp-open-tls-stream
12862 @item nntp-open-tls-stream
12863 Opens a connection to a server over a @dfn{secure} channel. To use
12864 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
12865 installed. You then define a server as follows:
12868 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
12869 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
12871 (nntp "snews.bar.com"
12872 (nntp-open-connection-function nntp-open-tls-stream)
12873 (nntp-port-number )
12874 (nntp-address "snews.bar.com"))
12877 @findex nntp-open-ssl-stream
12878 @item nntp-open-ssl-stream
12879 Opens a connection to a server over a @dfn{secure} channel. To use
12880 this you must have @uref{http://www.openssl.org, OpenSSL} or
12881 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
12882 then define a server as follows:
12885 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
12886 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
12888 (nntp "snews.bar.com"
12889 (nntp-open-connection-function nntp-open-ssl-stream)
12890 (nntp-port-number 563)
12891 (nntp-address "snews.bar.com"))
12894 @findex nntp-open-telnet-stream
12895 @item nntp-open-telnet-stream
12896 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
12897 it. You might wonder why this function exists, since we have the
12898 default @code{nntp-open-network-stream} which would do the job. (One
12899 of) the reason(s) is that if you are behind a firewall but have direct
12900 connections to the outside world thanks to a command wrapper like
12901 @code{runsocks}, you can use it like this:
12905 (nntp-pre-command "runsocks")
12906 (nntp-open-connection-function nntp-open-telnet-stream)
12907 (nntp-address "the.news.server"))
12910 With the default method, you would need to wrap your whole Emacs
12911 session, which is not a good idea.
12915 @node Indirect Functions
12916 @subsubsection Indirect Functions
12917 @cindex indirect connection functions
12919 These functions are called indirect because they connect to an
12920 intermediate host before actually connecting to the @acronym{NNTP} server.
12921 All of these functions and related variables are also said to belong to
12922 the ``via'' family of connection: they're all prefixed with ``via'' to make
12923 things cleaner. The behavior of these functions is also affected by
12924 commonly understood variables (@pxref{Common Variables}).
12927 @item nntp-open-via-rlogin-and-telnet
12928 @findex nntp-open-via-rlogin-and-telnet
12929 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
12930 to the real @acronym{NNTP} server from there. This is useful for instance if
12931 you need to connect to a firewall machine first.
12933 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
12936 @item nntp-via-rlogin-command
12937 @vindex nntp-via-rlogin-command
12938 Command used to log in on the intermediate host. The default is
12939 @samp{rsh}, but @samp{ssh} is a popular alternative.
12941 @item nntp-via-rlogin-command-switches
12942 @vindex nntp-via-rlogin-command-switches
12943 List of strings to be used as the switches to
12944 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
12945 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
12946 @samp{("-C")} in order to compress all data connections, otherwise set
12947 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
12948 the telnet command requires a pseudo-tty allocation on an intermediate
12952 Note that you may want to change the value for @code{nntp-end-of-line}
12953 to @samp{\n} (@pxref{Common Variables}).
12955 @item nntp-open-via-rlogin-and-netcat
12956 @findex nntp-open-via-rlogin-and-netcat
12957 Does essentially the same, but uses
12958 @uref{http://netcat.sourceforge.net/, netcat} instead of @samp{telnet}
12959 to connect to the real @acronym{NNTP} server from the intermediate host.
12961 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
12964 @item nntp-via-netcat-command
12965 @vindex nntp-via-netcat-command
12966 Command used to connect to the real @acronym{NNTP} server from the
12967 intermediate host. The default is @samp{nc}. You can also use other
12968 programs like @uref{http://www.imasy.or.jp/~gotoh/ssh/connect.html,
12971 @item nntp-via-netcat-switches
12972 @vindex nntp-via-netcat-switches
12973 List of strings to be used as the switches to the
12974 @code{nntp-via-telnet-command} command. The default is @code{nil}.
12976 @item nntp-via-rlogin-command
12977 @vindex nntp-via-rlogin-command
12978 Command used to log in on the intermediate host. The default is
12979 @samp{rsh}, but @samp{ssh} is a popular alternative.
12981 @item nntp-via-rlogin-command-switches
12982 @vindex nntp-via-rlogin-command-switches
12983 List of strings to be used as the switches to
12984 @code{nntp-via-rlogin-command}. The default is @code{nil}.
12987 @item nntp-open-via-telnet-and-telnet
12988 @findex nntp-open-via-telnet-and-telnet
12989 Does essentially also the same, but uses @samp{telnet} instead of
12990 @samp{rlogin} to connect to the intermediate host.
12992 @code{nntp-open-via-telnet-and-telnet}-specific variables:
12995 @item nntp-via-telnet-command
12996 @vindex nntp-via-telnet-command
12997 Command used to @code{telnet} the intermediate host. The default is
13000 @item nntp-via-telnet-switches
13001 @vindex nntp-via-telnet-switches
13002 List of strings to be used as the switches to the
13003 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
13005 @item nntp-via-user-password
13006 @vindex nntp-via-user-password
13007 Password to use when logging in on the intermediate host.
13009 @item nntp-via-envuser
13010 @vindex nntp-via-envuser
13011 If non-@code{nil}, the intermediate @code{telnet} session (client and
13012 server both) will support the @code{ENVIRON} option and not prompt for
13013 login name. This works for Solaris @code{telnet}, for instance.
13015 @item nntp-via-shell-prompt
13016 @vindex nntp-via-shell-prompt
13017 Regexp matching the shell prompt on the intermediate host. The default
13018 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
13022 Note that you may want to change the value for @code{nntp-end-of-line}
13023 to @samp{\n} (@pxref{Common Variables}).
13027 Here are some additional variables that are understood by all the above
13032 @item nntp-via-user-name
13033 @vindex nntp-via-user-name
13034 User name to use when connecting to the intermediate host.
13036 @item nntp-via-address
13037 @vindex nntp-via-address
13038 Address of the intermediate host to connect to.
13043 @node Common Variables
13044 @subsubsection Common Variables
13046 The following variables affect the behavior of all, or several of the
13047 pre-made connection functions. When not specified, all functions are
13052 @item nntp-pre-command
13053 @vindex nntp-pre-command
13054 A command wrapper to use when connecting through a non native
13055 connection function (all except @code{nntp-open-network-stream},
13056 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}. This is
13057 where you would put a @samp{SOCKS} wrapper for instance.
13060 @vindex nntp-address
13061 The address of the @acronym{NNTP} server.
13063 @item nntp-port-number
13064 @vindex nntp-port-number
13065 Port number to connect to the @acronym{NNTP} server. The default is
13066 @samp{nntp}. If you use @acronym{NNTP} over
13067 @acronym{tls}/@acronym{ssl}, you may want to use integer ports rather
13068 than named ports (i.e, use @samp{563} instead of @samp{snews} or
13069 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
13070 not work with named ports.
13072 @item nntp-end-of-line
13073 @vindex nntp-end-of-line
13074 String to use as end-of-line marker when talking to the @acronym{NNTP}
13075 server. This is @samp{\r\n} by default, but should be @samp{\n} when
13076 using a non native telnet connection function.
13078 @item nntp-telnet-command
13079 @vindex nntp-telnet-command
13080 Command to use when connecting to the @acronym{NNTP} server through
13081 @samp{telnet}. This is @emph{not} for an intermediate host. This is
13082 just for the real @acronym{NNTP} server. The default is
13085 @item nntp-telnet-switches
13086 @vindex nntp-telnet-switches
13087 A list of switches to pass to @code{nntp-telnet-command}. The default
13094 @subsection News Spool
13098 Subscribing to a foreign group from the local spool is extremely easy,
13099 and might be useful, for instance, to speed up reading groups that
13100 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
13103 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
13104 anything else) as the address.
13106 If you have access to a local spool, you should probably use that as the
13107 native select method (@pxref{Finding the News}). It is normally faster
13108 than using an @code{nntp} select method, but might not be. It depends.
13109 You just have to try to find out what's best at your site.
13113 @item nnspool-inews-program
13114 @vindex nnspool-inews-program
13115 Program used to post an article.
13117 @item nnspool-inews-switches
13118 @vindex nnspool-inews-switches
13119 Parameters given to the inews program when posting an article.
13121 @item nnspool-spool-directory
13122 @vindex nnspool-spool-directory
13123 Where @code{nnspool} looks for the articles. This is normally
13124 @file{/usr/spool/news/}.
13126 @item nnspool-nov-directory
13127 @vindex nnspool-nov-directory
13128 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
13129 @file{/usr/spool/news/over.view/}.
13131 @item nnspool-lib-dir
13132 @vindex nnspool-lib-dir
13133 Where the news lib dir is (@file{/usr/lib/news/} by default).
13135 @item nnspool-active-file
13136 @vindex nnspool-active-file
13137 The name of the active file.
13139 @item nnspool-newsgroups-file
13140 @vindex nnspool-newsgroups-file
13141 The name of the group descriptions file.
13143 @item nnspool-history-file
13144 @vindex nnspool-history-file
13145 The name of the news history file.
13147 @item nnspool-active-times-file
13148 @vindex nnspool-active-times-file
13149 The name of the active date file.
13151 @item nnspool-nov-is-evil
13152 @vindex nnspool-nov-is-evil
13153 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13156 @item nnspool-sift-nov-with-sed
13157 @vindex nnspool-sift-nov-with-sed
13159 If non-@code{nil}, which is the default, use @code{sed} to get the
13160 relevant portion from the overview file. If @code{nil},
13161 @code{nnspool} will load the entire file into a buffer and process it
13168 @section Getting Mail
13169 @cindex reading mail
13172 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13176 * Mail in a Newsreader:: Important introductory notes.
13177 * Getting Started Reading Mail:: A simple cookbook example.
13178 * Splitting Mail:: How to create mail groups.
13179 * Mail Sources:: How to tell Gnus where to get mail from.
13180 * Mail Back End Variables:: Variables for customizing mail handling.
13181 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
13182 * Group Mail Splitting:: Use group customize to drive mail splitting.
13183 * Incorporating Old Mail:: What about the old mail you have?
13184 * Expiring Mail:: Getting rid of unwanted mail.
13185 * Washing Mail:: Removing cruft from the mail you get.
13186 * Duplicates:: Dealing with duplicated mail.
13187 * Not Reading Mail:: Using mail back ends for reading other files.
13188 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
13192 @node Mail in a Newsreader
13193 @subsection Mail in a Newsreader
13195 If you are used to traditional mail readers, but have decided to switch
13196 to reading mail with Gnus, you may find yourself experiencing something
13197 of a culture shock.
13199 Gnus does not behave like traditional mail readers. If you want to make
13200 it behave that way, you can, but it's an uphill battle.
13202 Gnus, by default, handles all its groups using the same approach. This
13203 approach is very newsreaderly---you enter a group, see the new/unread
13204 messages, and when you read the messages, they get marked as read, and
13205 you don't see them any more. (Unless you explicitly ask for them.)
13207 In particular, you do not do anything explicitly to delete messages.
13209 Does this mean that all the messages that have been marked as read are
13210 deleted? How awful!
13212 But, no, it means that old messages are @dfn{expired} according to some
13213 scheme or other. For news messages, the expire process is controlled by
13214 the news administrator; for mail, the expire process is controlled by
13215 you. The expire process for mail is covered in depth in @ref{Expiring
13218 What many Gnus users find, after using it a while for both news and
13219 mail, is that the transport mechanism has very little to do with how
13220 they want to treat a message.
13222 Many people subscribe to several mailing lists. These are transported
13223 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13224 answering, or even reading these messages very carefully. We may not
13225 need to save them because if we should need to read one again, they are
13226 archived somewhere else.
13228 Some people have local news groups which have only a handful of readers.
13229 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13230 to read and answer a large fraction of the messages very carefully in
13231 order to do our work. And there may not be an archive, so we may need
13232 to save the interesting messages the same way we would personal mail.
13234 The important distinction turns out to be not the transport mechanism,
13235 but other factors such as how interested we are in the subject matter,
13236 or how easy it is to retrieve the message if we need to read it again.
13238 Gnus provides many options for sorting mail into ``groups'' which behave
13239 like newsgroups, and for treating each group (whether mail or news)
13242 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13243 that Gnus should grow up and be a male, er, mail reader. It is possible
13244 to whip Gnus into a more mailreaderly being, but, as said before, it's
13245 not easy. People who prefer proper mail readers should try @sc{vm}
13246 instead, which is an excellent, and proper, mail reader.
13248 I don't mean to scare anybody off, but I want to make it clear that you
13249 may be required to learn a new way of thinking about messages. After
13250 you've been subjected to The Gnus Way, you will come to love it. I can
13251 guarantee it. (At least the guy who sold me the Emacs Subliminal
13252 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13253 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13257 @node Getting Started Reading Mail
13258 @subsection Getting Started Reading Mail
13260 It's quite easy to use Gnus to read your new mail. You just plonk the
13261 mail back end of your choice into @code{gnus-secondary-select-methods},
13262 and things will happen automatically.
13264 For instance, if you want to use @code{nnml} (which is a ``one file per
13265 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13268 (setq gnus-secondary-select-methods '((nnml "")))
13271 Now, the next time you start Gnus, this back end will be queried for new
13272 articles, and it will move all the messages in your spool file to its
13273 directory, which is @file{~/Mail/} by default. The new group that will
13274 be created (@samp{mail.misc}) will be subscribed, and you can read it
13275 like any other group.
13277 You will probably want to split the mail into several groups, though:
13280 (setq nnmail-split-methods
13281 '(("junk" "^From:.*Lars Ingebrigtsen")
13282 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13286 This will result in three new @code{nnml} mail groups being created:
13287 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
13288 mail that doesn't fit into the first two groups will be placed in the
13291 This should be sufficient for reading mail with Gnus. You might want to
13292 give the other sections in this part of the manual a perusal, though.
13293 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13296 @node Splitting Mail
13297 @subsection Splitting Mail
13298 @cindex splitting mail
13299 @cindex mail splitting
13300 @cindex mail filtering (splitting)
13302 @vindex nnmail-split-methods
13303 The @code{nnmail-split-methods} variable says how the incoming mail is
13304 to be split into groups.
13307 (setq nnmail-split-methods
13308 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
13309 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
13310 ("mail.other" "")))
13313 This variable is a list of lists, where the first element of each of
13314 these lists is the name of the mail group (they do not have to be called
13315 something beginning with @samp{mail}, by the way), and the second
13316 element is a regular expression used on the header of each mail to
13317 determine if it belongs in this mail group. The first string may
13318 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
13319 insert sub-expressions from the matched text. For instance:
13322 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
13325 The second element can also be a function. In that case, it will be
13326 called narrowed to the headers with the first element of the rule as the
13327 argument. It should return a non-@code{nil} value if it thinks that the
13328 mail belongs in that group.
13330 The last of these groups should always be a general one, and the regular
13331 expression should @emph{always} be @samp{*} so that it matches any mails
13332 that haven't been matched by any of the other regexps. (These rules are
13333 processed from the beginning of the alist toward the end. The first
13334 rule to make a match will ``win'', unless you have crossposting enabled.
13335 In that case, all matching rules will ``win''.)
13337 If you like to tinker with this yourself, you can set this variable to a
13338 function of your choice. This function will be called without any
13339 arguments in a buffer narrowed to the headers of an incoming mail
13340 message. The function should return a list of group names that it
13341 thinks should carry this mail message.
13343 Note that the mail back ends are free to maul the poor, innocent,
13344 incoming headers all they want to. They all add @code{Lines} headers;
13345 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
13346 @code{From<SPACE>} line to something else.
13348 @vindex nnmail-crosspost
13349 The mail back ends all support cross-posting. If several regexps match,
13350 the mail will be ``cross-posted'' to all those groups.
13351 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
13352 that no articles are crossposted to the general (@samp{*}) group.
13354 @vindex nnmail-crosspost-link-function
13357 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
13358 the crossposted articles. However, not all file systems support hard
13359 links. If that's the case for you, set
13360 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
13361 variable is @code{add-name-to-file} by default.)
13363 @kindex M-x nnmail-split-history
13364 @findex nnmail-split-history
13365 If you wish to see where the previous mail split put the messages, you
13366 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
13367 where re-spooling messages would put the messages, you can use
13368 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
13371 @vindex nnmail-split-header-length-limit
13372 Header lines longer than the value of
13373 @code{nnmail-split-header-length-limit} are excluded from the split
13376 @vindex nnmail-mail-splitting-charset
13377 @vindex nnmail-mail-splitting-decodes
13378 By default the splitting codes @acronym{MIME} decodes headers so you
13379 can match on non-@acronym{ASCII} strings. The
13380 @code{nnmail-mail-splitting-charset} variable specifies the default
13381 charset for decoding. The behaviour can be turned off completely by
13382 binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is
13383 useful if you want to match articles based on the raw header data.
13385 @vindex nnmail-resplit-incoming
13386 By default, splitting is performed on all incoming messages. If you
13387 specify a @code{directory} entry for the variable @code{mail-sources}
13388 (@pxref{Mail Source Specifiers}), however, then splitting does
13389 @emph{not} happen by default. You can set the variable
13390 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
13391 splitting happen even in this case. (This variable has no effect on
13392 other kinds of entries.)
13394 Gnus gives you all the opportunity you could possibly want for shooting
13395 yourself in the foot. Let's say you create a group that will contain
13396 all the mail you get from your boss. And then you accidentally
13397 unsubscribe from the group. Gnus will still put all the mail from your
13398 boss in the unsubscribed group, and so, when your boss mails you ``Have
13399 that report ready by Monday or you're fired!'', you'll never see it and,
13400 come Tuesday, you'll still believe that you're gainfully employed while
13401 you really should be out collecting empty bottles to save up for next
13402 month's rent money.
13406 @subsection Mail Sources
13408 Mail can be gotten from many different sources---the mail spool, from
13409 a @acronym{POP} mail server, from a procmail directory, or from a
13410 maildir, for instance.
13413 * Mail Source Specifiers:: How to specify what a mail source is.
13414 * Mail Source Customization:: Some variables that influence things.
13415 * Fetching Mail:: Using the mail source specifiers.
13419 @node Mail Source Specifiers
13420 @subsubsection Mail Source Specifiers
13422 @cindex mail server
13425 @cindex mail source
13427 You tell Gnus how to fetch mail by setting @code{mail-sources}
13428 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
13433 (pop :server "pop3.mailserver.com" :user "myname")
13436 As can be observed, a mail source specifier is a list where the first
13437 element is a @dfn{mail source type}, followed by an arbitrary number of
13438 @dfn{keywords}. Keywords that are not explicitly specified are given
13441 The following mail source types are available:
13445 Get mail from a single file; typically from the mail spool.
13451 The file name. Defaults to the value of the @env{MAIL}
13452 environment variable or the value of @code{rmail-spool-directory}
13453 (usually something like @file{/usr/mail/spool/user-name}).
13457 Script run before/after fetching mail.
13460 An example file mail source:
13463 (file :path "/usr/spool/mail/user-name")
13466 Or using the default file name:
13472 If the mail spool file is not located on the local machine, it's best
13473 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
13474 You can not use ange-ftp file names here---it has no way to lock the
13475 mail spool while moving the mail.
13477 If it's impossible to set up a proper server, you can use ssh instead.
13481 '((file :prescript "ssh host bin/getmail >%t")))
13484 The @samp{getmail} script would look something like the following:
13488 # getmail - move mail from spool to stdout
13491 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
13493 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
13496 Alter this script to fit find the @samp{movemail} you want to use.
13500 @vindex nnmail-scan-directory-mail-source-once
13501 Get mail from several files in a directory. This is typically used
13502 when you have procmail split the incoming mail into several files.
13503 That is, there is a one-to-one correspondence between files in that
13504 directory and groups, so that mail from the file @file{foo.bar.spool}
13505 will be put in the group @code{foo.bar}. (You can change the suffix
13506 to be used instead of @code{.spool}.) Setting
13507 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
13508 Gnus to scan the mail source only once. This is particularly useful
13509 if you want to scan mail groups at a specified level.
13511 @vindex nnmail-resplit-incoming
13512 There is also the variable @code{nnmail-resplit-incoming}, if you set
13513 that to a non-@code{nil} value, then the normal splitting process is
13514 applied to all the files from the directory, @ref{Splitting Mail}.
13520 The name of the directory where the files are. There is no default
13524 Only files ending with this suffix are used. The default is
13528 Only files that have this predicate return non-@code{nil} are returned.
13529 The default is @code{identity}. This is used as an additional
13530 filter---only files that have the right suffix @emph{and} satisfy this
13531 predicate are considered.
13535 Script run before/after fetching mail.
13539 An example directory mail source:
13542 (directory :path "/home/user-name/procmail-dir/"
13547 Get mail from a @acronym{POP} server.
13553 The name of the @acronym{POP} server. The default is taken from the
13554 @env{MAILHOST} environment variable.
13557 The port number of the @acronym{POP} server. This can be a number (eg,
13558 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
13559 string, it should be a service name as listed in @file{/etc/services} on
13560 Unix systems. The default is @samp{"pop3"}. On some systems you might
13561 need to specify it as @samp{"pop-3"} instead.
13564 The user name to give to the @acronym{POP} server. The default is the login
13568 The password to give to the @acronym{POP} server. If not specified,
13569 the user is prompted.
13572 The program to use to fetch mail from the @acronym{POP} server. This
13573 should be a @code{format}-like string. Here's an example:
13576 fetchmail %u@@%s -P %p %t
13579 The valid format specifier characters are:
13583 The name of the file the mail is to be moved to. This must always be
13584 included in this string.
13587 The name of the server.
13590 The port number of the server.
13593 The user name to use.
13596 The password to use.
13599 The values used for these specs are taken from the values you give the
13600 corresponding keywords.
13603 A script to be run before fetching the mail. The syntax is the same as
13604 the @code{:program} keyword. This can also be a function to be run.
13607 A script to be run after fetching the mail. The syntax is the same as
13608 the @code{:program} keyword. This can also be a function to be run.
13611 The function to use to fetch mail from the @acronym{POP} server. The
13612 function is called with one parameter---the name of the file where the
13613 mail should be moved to.
13615 @item :authentication
13616 This can be either the symbol @code{password} or the symbol @code{apop}
13617 and says what authentication scheme to use. The default is
13622 If the @code{:program} and @code{:function} keywords aren't specified,
13623 @code{pop3-movemail} will be used.
13625 Here are some examples. Fetch from the default @acronym{POP} server,
13626 using the default user name, and default fetcher:
13632 Fetch from a named server with a named user and password:
13635 (pop :server "my.pop.server"
13636 :user "user-name" :password "secret")
13639 Use @samp{movemail} to move the mail:
13642 (pop :program "movemail po:%u %t %p")
13646 Get mail from a maildir. This is a type of mailbox that is supported by
13647 at least qmail and postfix, where each file in a special directory
13648 contains exactly one mail.
13654 The name of the directory where the mails are stored. The default is
13655 taken from the @env{MAILDIR} environment variable or
13658 The subdirectories of the Maildir. The default is
13659 @samp{("new" "cur")}.
13661 @c If you sometimes look at your mail through a pop3 daemon before fetching
13662 @c them with Gnus, you may also have to fetch your mails from the
13663 @c @code{cur} directory inside the maildir, like in the first example
13666 You can also get mails from remote hosts (because maildirs don't suffer
13667 from locking problems).
13671 Two example maildir mail sources:
13674 (maildir :path "/home/user-name/Maildir/"
13675 :subdirs ("cur" "new"))
13679 (maildir :path "/user@@remotehost.org:~/Maildir/"
13684 Get mail from a @acronym{IMAP} server. If you don't want to use
13685 @acronym{IMAP} as intended, as a network mail reading protocol (ie
13686 with nnimap), for some reason or other, Gnus let you treat it similar
13687 to a @acronym{POP} server and fetches articles from a given
13688 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
13690 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
13691 may need external programs and libraries, @xref{IMAP}.
13697 The name of the @acronym{IMAP} server. The default is taken from the
13698 @env{MAILHOST} environment variable.
13701 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
13702 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
13705 The user name to give to the @acronym{IMAP} server. The default is the login
13709 The password to give to the @acronym{IMAP} server. If not specified, the user is
13713 What stream to use for connecting to the server, this is one of the
13714 symbols in @code{imap-stream-alist}. Right now, this means
13715 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
13716 @samp{ssl}, @samp{shell} or the default @samp{network}.
13718 @item :authentication
13719 Which authenticator to use for authenticating to the server, this is
13720 one of the symbols in @code{imap-authenticator-alist}. Right now,
13721 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13722 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13725 When using the `shell' :stream, the contents of this variable is
13726 mapped into the @code{imap-shell-program} variable. This should be a
13727 @code{format}-like string (or list of strings). Here's an example:
13733 The valid format specifier characters are:
13737 The name of the server.
13740 User name from @code{imap-default-user}.
13743 The port number of the server.
13746 The values used for these specs are taken from the values you give the
13747 corresponding keywords.
13750 The name of the mailbox to get mail from. The default is @samp{INBOX}
13751 which normally is the mailbox which receive incoming mail.
13754 The predicate used to find articles to fetch. The default, @samp{UNSEEN
13755 UNDELETED}, is probably the best choice for most people, but if you
13756 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
13757 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13758 Then all articles in the mailbox is fetched, no matter what. For a
13759 complete list of predicates, see RFC 2060 section 6.4.4.
13762 How to flag fetched articles on the server, the default @samp{\Deleted}
13763 will mark them as deleted, an alternative would be @samp{\Seen} which
13764 would simply mark them as read. These are the two most likely choices,
13765 but more flags are defined in RFC 2060 section 2.3.2.
13768 If non-@code{nil}, don't remove all articles marked as deleted in the
13769 mailbox after finishing the fetch.
13773 An example @acronym{IMAP} mail source:
13776 (imap :server "mail.mycorp.com"
13778 :fetchflag "\\Seen")
13782 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
13783 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
13784 @uref{http://mail.yahoo.com/}.
13786 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
13787 required for url "4.0pre.46".
13789 WARNING: Mails may be lost. NO WARRANTY.
13795 The type of the webmail server. The default is @code{hotmail}. The
13796 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13799 The user name to give to the webmail server. The default is the login
13803 The password to give to the webmail server. If not specified, the user is
13807 If non-@code{nil}, only fetch unread articles and don't move them to
13808 trash folder after finishing the fetch.
13812 An example webmail source:
13815 (webmail :subtype 'hotmail
13817 :password "secret")
13822 @item Common Keywords
13823 Common keywords can be used in any type of mail source.
13829 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
13830 use directory source to get mail, you can specify it as in this
13835 '((directory :path "/home/pavel/.Spool/"
13840 Gnus will then fetch your mail even when you are unplugged. This is
13841 useful when you use local mail and news.
13846 @subsubsection Function Interface
13848 Some of the above keywords specify a Lisp function to be executed.
13849 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
13850 the value of the keyword while the function is executing. For example,
13851 consider the following mail-source setting:
13854 (setq mail-sources '((pop :user "jrl"
13855 :server "pophost" :function fetchfunc)))
13858 While the function @code{fetchfunc} is executing, the symbol @code{user}
13859 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
13860 @code{"pophost"}. The symbols @code{port}, @code{password},
13861 @code{program}, @code{prescript}, @code{postscript}, @code{function},
13862 and @code{authentication} are also bound (to their default values).
13864 See above for a list of keywords for each type of mail source.
13867 @node Mail Source Customization
13868 @subsubsection Mail Source Customization
13870 The following is a list of variables that influence how the mail is
13871 fetched. You would normally not need to set or change any of these
13875 @item mail-source-crash-box
13876 @vindex mail-source-crash-box
13877 File where mail will be stored while processing it. The default is@*
13878 @file{~/.emacs-mail-crash-box}.
13880 @item mail-source-delete-incoming
13881 @vindex mail-source-delete-incoming
13882 If non-@code{nil}, delete incoming files after handling them. If
13883 @code{t}, delete the files immediately, if @code{nil}, never delete any
13884 files. If a positive number, delete files older than number of days
13885 (This will only happen, when receiving new mail). You may also set
13886 @code{mail-source-delete-incoming} to @code{nil} and call
13887 @code{mail-source-delete-old-incoming} from a hook or interactively.
13889 @item mail-source-delete-old-incoming-confirm
13890 @vindex mail-source-delete-old-incoming-confirm
13891 If non-@code{nil}, ask for for confirmation before deleting old incoming
13892 files. This variable only applies when
13893 @code{mail-source-delete-incoming} is a positive number.
13895 @item mail-source-ignore-errors
13896 @vindex mail-source-ignore-errors
13897 If non-@code{nil}, ignore errors when reading mail from a mail source.
13899 @item mail-source-directory
13900 @vindex mail-source-directory
13901 Directory where files (if any) will be stored. The default is
13902 @file{~/Mail/}. At present, the only thing this is used for is to say
13903 where the incoming files will be stored if the previous variable is
13906 @item mail-source-incoming-file-prefix
13907 @vindex mail-source-incoming-file-prefix
13908 Prefix for file name for storing incoming mail. The default is
13909 @file{Incoming}, in which case files will end up with names like
13910 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
13911 relevant if @code{mail-source-delete-incoming} is @code{nil}.
13913 @item mail-source-default-file-modes
13914 @vindex mail-source-default-file-modes
13915 All new mail files will get this file mode. The default is 384.
13917 @item mail-source-movemail-program
13918 @vindex mail-source-movemail-program
13919 If non-@code{nil}, name of program for fetching new mail. If
13920 @code{nil}, @code{movemail} in @var{exec-directory}.
13925 @node Fetching Mail
13926 @subsubsection Fetching Mail
13928 @vindex mail-sources
13929 @vindex nnmail-spool-file
13930 The way to actually tell Gnus where to get new mail from is to set
13931 @code{mail-sources} to a list of mail source specifiers
13932 (@pxref{Mail Source Specifiers}).
13934 If this variable (and the obsolescent @code{nnmail-spool-file}) is
13935 @code{nil}, the mail back ends will never attempt to fetch mail by
13938 If you want to fetch mail both from your local spool as well as a
13939 @acronym{POP} mail server, you'd say something like:
13944 (pop :server "pop3.mail.server"
13945 :password "secret")))
13948 Or, if you don't want to use any of the keyword defaults:
13952 '((file :path "/var/spool/mail/user-name")
13953 (pop :server "pop3.mail.server"
13956 :password "secret")))
13960 When you use a mail back end, Gnus will slurp all your mail from your
13961 inbox and plonk it down in your home directory. Gnus doesn't move any
13962 mail if you're not using a mail back end---you have to do a lot of magic
13963 invocations first. At the time when you have finished drawing the
13964 pentagram, lightened the candles, and sacrificed the goat, you really
13965 shouldn't be too surprised when Gnus moves your mail.
13969 @node Mail Back End Variables
13970 @subsection Mail Back End Variables
13972 These variables are (for the most part) pertinent to all the various
13976 @vindex nnmail-read-incoming-hook
13977 @item nnmail-read-incoming-hook
13978 The mail back ends all call this hook after reading new mail. You can
13979 use this hook to notify any mail watch programs, if you want to.
13981 @vindex nnmail-split-hook
13982 @item nnmail-split-hook
13983 @findex gnus-article-decode-encoded-words
13984 @cindex RFC 1522 decoding
13985 @cindex RFC 2047 decoding
13986 Hook run in the buffer where the mail headers of each message is kept
13987 just before the splitting based on these headers is done. The hook is
13988 free to modify the buffer contents in any way it sees fit---the buffer
13989 is discarded after the splitting has been done, and no changes performed
13990 in the buffer will show up in any files.
13991 @code{gnus-article-decode-encoded-words} is one likely function to add
13994 @vindex nnmail-pre-get-new-mail-hook
13995 @vindex nnmail-post-get-new-mail-hook
13996 @item nnmail-pre-get-new-mail-hook
13997 @itemx nnmail-post-get-new-mail-hook
13998 These are two useful hooks executed when treating new incoming
13999 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
14000 starting to handle the new mail) and
14001 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
14002 is done). Here's and example of using these two hooks to change the
14003 default file modes the new mail files get:
14006 (add-hook 'nnmail-pre-get-new-mail-hook
14007 (lambda () (set-default-file-modes 511)))
14009 (add-hook 'nnmail-post-get-new-mail-hook
14010 (lambda () (set-default-file-modes 551)))
14013 @item nnmail-use-long-file-names
14014 @vindex nnmail-use-long-file-names
14015 If non-@code{nil}, the mail back ends will use long file and directory
14016 names. Groups like @samp{mail.misc} will end up in directories
14017 (assuming use of @code{nnml} back end) or files (assuming use of
14018 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
14019 the same group will end up in @file{mail/misc}.
14021 @item nnmail-delete-file-function
14022 @vindex nnmail-delete-file-function
14023 @findex delete-file
14024 Function called to delete files. It is @code{delete-file} by default.
14026 @item nnmail-cache-accepted-message-ids
14027 @vindex nnmail-cache-accepted-message-ids
14028 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
14029 the back end (via @code{Gcc}, for instance) into the mail duplication
14030 discovery cache. The default is @code{nil}.
14032 @item nnmail-cache-ignore-groups
14033 @vindex nnmail-cache-ignore-groups
14034 This can be a regular expression or a list of regular expressions.
14035 Group names that match any of the regular expressions will never be
14036 recorded in the @code{Message-ID} cache.
14038 This can be useful, for example, when using Fancy Splitting
14039 (@pxref{Fancy Mail Splitting}) together with the function
14040 @code{nnmail-split-fancy-with-parent}.
14045 @node Fancy Mail Splitting
14046 @subsection Fancy Mail Splitting
14047 @cindex mail splitting
14048 @cindex fancy mail splitting
14050 @vindex nnmail-split-fancy
14051 @findex nnmail-split-fancy
14052 If the rather simple, standard method for specifying how to split mail
14053 doesn't allow you to do what you want, you can set
14054 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
14055 play with the @code{nnmail-split-fancy} variable.
14057 Let's look at an example value of this variable first:
14060 ;; @r{Messages from the mailer daemon are not crossposted to any of}
14061 ;; @r{the ordinary groups. Warnings are put in a separate group}
14062 ;; @r{from real errors.}
14063 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
14065 ;; @r{Non-error messages are crossposted to all relevant}
14066 ;; @r{groups, but we don't crosspost between the group for the}
14067 ;; @r{(ding) list and the group for other (ding) related mail.}
14068 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
14069 ("subject" "ding" "ding.misc"))
14070 ;; @r{Other mailing lists@dots{}}
14071 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
14072 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
14073 ;; @r{Both lists below have the same suffix, so prevent}
14074 ;; @r{cross-posting to mkpkg.list of messages posted only to}
14075 ;; @r{the bugs- list, but allow cross-posting when the}
14076 ;; @r{message was really cross-posted.}
14077 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
14078 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
14079 ;; @r{People@dots{}}
14080 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
14081 ;; @r{Unmatched mail goes to the catch all group.}
14085 This variable has the format of a @dfn{split}. A split is a
14086 (possibly) recursive structure where each split may contain other
14087 splits. Here are the possible split syntaxes:
14092 If the split is a string, that will be taken as a group name. Normal
14093 regexp match expansion will be done. See below for examples.
14095 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split})
14096 If the split is a list, the first element of which is a string, then
14097 store the message as specified by @var{split}, if header @var{field}
14098 (a regexp) contains @var{value} (also a regexp). If @var{restrict}
14099 (yet another regexp) matches some string after @var{field} and before
14100 the end of the matched @var{value}, the @var{split} is ignored. If
14101 none of the @var{restrict} clauses match, @var{split} is processed.
14103 @item (| @var{split} @dots{})
14104 If the split is a list, and the first element is @code{|} (vertical
14105 bar), then process each @var{split} until one of them matches. A
14106 @var{split} is said to match if it will cause the mail message to be
14107 stored in one or more groups.
14109 @item (& @var{split} @dots{})
14110 If the split is a list, and the first element is @code{&}, then
14111 process all @var{split}s in the list.
14114 If the split is the symbol @code{junk}, then don't save (i.e., delete)
14115 this message. Use with extreme caution.
14117 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
14118 If the split is a list, and the first element is @samp{:}, then the
14119 second element will be called as a function with @var{args} given as
14120 arguments. The function should return a @var{split}.
14123 For instance, the following function could be used to split based on the
14124 body of the messages:
14127 (defun split-on-body ()
14131 (goto-char (point-min))
14132 (when (re-search-forward "Some.*string" nil t)
14136 The buffer is narrowed to the message in question when @var{function}
14137 is run. That's why @code{(widen)} needs to be called after
14138 @code{save-excursion} and @code{save-restriction} in the example
14139 above. Also note that with the nnimap backend, message bodies will
14140 not be downloaded by default. You need to set
14141 @code{nnimap-split-download-body} to @code{t} to do that
14142 (@pxref{Splitting in IMAP}).
14144 @item (! @var{func} @var{split})
14145 If the split is a list, and the first element is @code{!}, then
14146 @var{split} will be processed, and @var{func} will be called as a
14147 function with the result of @var{split} as argument. @var{func}
14148 should return a split.
14151 If the split is @code{nil}, it is ignored.
14155 In these splits, @var{field} must match a complete field name.
14156 @var{value} must match a complete word according to the fundamental mode
14157 syntax table. You can use @code{.*} in the regexps to match partial
14158 field names or words. In other words, all @var{value}'s are wrapped in
14159 @samp{\<} and @samp{\>} pairs.
14161 @vindex nnmail-split-abbrev-alist
14162 @var{field} and @var{value} can also be Lisp symbols, in that case
14163 they are expanded as specified by the variable
14164 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
14165 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14166 contains the associated value. Predefined entries in
14167 @code{nnmail-split-abbrev-alist} include:
14171 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14173 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14174 @samp{Resent-To} and @samp{Resent-Cc} fields.
14176 Is the union of the @code{from} and @code{to} entries.
14179 @vindex nnmail-split-fancy-syntax-table
14180 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14181 when all this splitting is performed.
14183 If you want to have Gnus create groups dynamically based on some
14184 information in the headers (i.e., do @code{replace-match}-like
14185 substitutions in the group names), you can say things like:
14188 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14191 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14192 will be filed in @samp{mail.debian.foo}.
14194 If the string contains the element @samp{\&}, then the previously
14195 matched string will be substituted. Similarly, the elements @samp{\\1}
14196 up to @samp{\\9} will be substituted with the text matched by the
14197 groupings 1 through 9.
14199 @vindex nnmail-split-fancy-match-partial-words
14200 @code{nnmail-split-fancy-match-partial-words} controls whether partial
14201 words are matched during fancy splitting.
14203 Normally, regular expressions given in @code{nnmail-split-fancy} are
14204 implicitly surrounded by @code{\<...\>} markers, which are word
14205 delimiters. If this variable is true, they are not implicitly
14206 surrounded by anything.
14209 (any "joe" "joemail")
14212 In this example, messages sent from @samp{joedavis@@foo.org} will
14213 normally not be filed in @samp{joemail}. With
14214 @code{nnmail-split-fancy-match-partial-words} set to t, however, the
14215 match will happen. In effect, the requirement of a word boundary is
14216 removed and instead the match becomes more like a grep.
14218 @findex nnmail-split-fancy-with-parent
14219 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14220 split followups into the same groups their parents are in. Sometimes
14221 you can't make splitting rules for all your mail. For example, your
14222 boss might send you personal mail regarding different projects you are
14223 working on, and as you can't tell your boss to put a distinguishing
14224 string into the subject line, you have to resort to manually moving the
14225 messages into the right group. With this function, you only have to do
14226 it once per thread.
14228 To use this feature, you have to set @code{nnmail-treat-duplicates}
14229 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14230 value. And then you can include @code{nnmail-split-fancy-with-parent}
14231 using the colon feature, like so:
14233 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
14234 nnmail-cache-accepted-message-ids t
14236 '(| (: nnmail-split-fancy-with-parent)
14237 ;; @r{other splits go here}
14241 This feature works as follows: when @code{nnmail-treat-duplicates} is
14242 non-@code{nil}, Gnus records the message id of every message it sees
14243 in the file specified by the variable
14244 @code{nnmail-message-id-cache-file}, together with the group it is in
14245 (the group is omitted for non-mail messages). When mail splitting is
14246 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
14247 at the References (and In-Reply-To) header of each message to split
14248 and searches the file specified by @code{nnmail-message-id-cache-file}
14249 for the message ids. When it has found a parent, it returns the
14250 corresponding group name unless the group name matches the regexp
14251 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
14252 recommended that you set @code{nnmail-message-id-cache-length} to a
14253 somewhat higher number than the default so that the message ids are
14254 still in the cache. (A value of 5000 appears to create a file some
14255 300 kBytes in size.)
14256 @vindex nnmail-cache-accepted-message-ids
14257 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
14258 also records the message ids of moved articles, so that the followup
14259 messages goes into the new group.
14261 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
14262 want certain groups to be recorded in the cache. For example, if all
14263 outgoing messages are written to an ``outgoing'' group, you could set
14264 @code{nnmail-cache-ignore-groups} to match that group name.
14265 Otherwise, answers to all your messages would end up in the
14266 ``outgoing'' group.
14269 @node Group Mail Splitting
14270 @subsection Group Mail Splitting
14271 @cindex mail splitting
14272 @cindex group mail splitting
14274 @findex gnus-group-split
14275 If you subscribe to dozens of mailing lists but you don't want to
14276 maintain mail splitting rules manually, group mail splitting is for you.
14277 You just have to set @code{to-list} and/or @code{to-address} in group
14278 parameters or group customization and set @code{nnmail-split-methods} to
14279 @code{gnus-group-split}. This splitting function will scan all groups
14280 for those parameters and split mail accordingly, i.e., messages posted
14281 from or to the addresses specified in the parameters @code{to-list} or
14282 @code{to-address} of a mail group will be stored in that group.
14284 Sometimes, mailing lists have multiple addresses, and you may want mail
14285 splitting to recognize them all: just set the @code{extra-aliases} group
14286 parameter to the list of additional addresses and it's done. If you'd
14287 rather use a regular expression, set @code{split-regexp}.
14289 All these parameters in a group will be used to create an
14290 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
14291 the @var{value} is a single regular expression that matches
14292 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
14293 matches of @code{split-regexp}, and the @var{split} is the name of the
14294 group. @var{restrict}s are also supported: just set the
14295 @code{split-exclude} parameter to a list of regular expressions.
14297 If you can't get the right split to be generated using all these
14298 parameters, or you just need something fancier, you can set the
14299 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
14300 this case, all other aforementioned parameters will be ignored by
14301 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
14302 @code{nil}, in which case the group will be ignored by
14303 @code{gnus-group-split}.
14305 @vindex gnus-group-split-default-catch-all-group
14306 @code{gnus-group-split} will do cross-posting on all groups that match,
14307 by defining a single @code{&} fancy split containing one split for each
14308 group. If a message doesn't match any split, it will be stored in the
14309 group named in @code{gnus-group-split-default-catch-all-group}, unless
14310 some group has @code{split-spec} set to @code{catch-all}, in which case
14311 that group is used as the catch-all group. Even though this variable is
14312 often used just to name a group, it may also be set to an arbitrarily
14313 complex fancy split (after all, a group name is a fancy split), and this
14314 may be useful to split mail that doesn't go to any mailing list to
14315 personal mail folders. Note that this fancy split is added as the last
14316 element of a @code{|} split list that also contains a @code{&} split
14317 with the rules extracted from group parameters.
14319 It's time for an example. Assume the following group parameters have
14324 ((to-address . "bar@@femail.com")
14325 (split-regexp . ".*@@femail\\.com"))
14327 ((to-list . "foo@@nowhere.gov")
14328 (extra-aliases "foo@@localhost" "foo-redist@@home")
14329 (split-exclude "bugs-foo" "rambling-foo")
14330 (admin-address . "foo-request@@nowhere.gov"))
14332 ((split-spec . catch-all))
14335 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
14336 behave as if @code{nnmail-split-fancy} had been selected and variable
14337 @code{nnmail-split-fancy} had been set as follows:
14340 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
14341 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
14342 - "bugs-foo" - "rambling-foo" "mail.foo"))
14346 @findex gnus-group-split-fancy
14347 If you'd rather not use group splitting for all your mail groups, you
14348 may use it for only some of them, by using @code{nnmail-split-fancy}
14352 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
14355 @var{groups} may be a regular expression or a list of group names whose
14356 parameters will be scanned to generate the output split.
14357 @var{no-crosspost} can be used to disable cross-posting; in this case, a
14358 single @code{|} split will be output. @var{catch-all} is the fall back
14359 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
14360 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
14361 empty string in any selected group, no catch-all split will be issued.
14362 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
14363 this group will override the value of the @var{catch-all} argument.
14365 @findex gnus-group-split-setup
14366 Unfortunately, scanning all groups and their parameters can be quite
14367 slow, especially considering that it has to be done for every message.
14368 But don't despair! The function @code{gnus-group-split-setup} can be
14369 used to enable @code{gnus-group-split} in a much more efficient way. It
14370 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
14371 @code{nnmail-split-fancy} to the split produced by
14372 @code{gnus-group-split-fancy}. Thus, the group parameters are only
14373 scanned once, no matter how many messages are split.
14375 @findex gnus-group-split-update
14376 However, if you change group parameters, you'd have to update
14377 @code{nnmail-split-fancy} manually. You can do it by running
14378 @code{gnus-group-split-update}. If you'd rather have it updated
14379 automatically, just tell @code{gnus-group-split-setup} to do it for
14380 you. For example, add to your @file{~/.gnus.el}:
14383 (gnus-group-split-setup @var{auto-update} @var{catch-all})
14386 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
14387 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
14388 have to worry about updating @code{nnmail-split-fancy} again. If you
14389 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
14390 @code{gnus-group-split-default-catch-all-group} will be set to its
14393 @vindex gnus-group-split-updated-hook
14394 Because you may want to change @code{nnmail-split-fancy} after it is set
14395 by @code{gnus-group-split-update}, this function will run
14396 @code{gnus-group-split-updated-hook} just before finishing.
14398 @node Incorporating Old Mail
14399 @subsection Incorporating Old Mail
14400 @cindex incorporating old mail
14401 @cindex import old mail
14403 Most people have lots of old mail stored in various file formats. If
14404 you have set up Gnus to read mail using one of the spiffy Gnus mail
14405 back ends, you'll probably wish to have that old mail incorporated into
14408 Doing so can be quite easy.
14410 To take an example: You're reading mail using @code{nnml}
14411 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
14412 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
14413 file filled with important, but old, mail. You want to move it into
14414 your @code{nnml} groups.
14420 Go to the group buffer.
14423 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
14424 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
14427 Type @kbd{SPACE} to enter the newly created group.
14430 Type @kbd{M P b} to process-mark all articles in this group's buffer
14431 (@pxref{Setting Process Marks}).
14434 Type @kbd{B r} to respool all the process-marked articles, and answer
14435 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
14438 All the mail messages in the mbox file will now also be spread out over
14439 all your @code{nnml} groups. Try entering them and check whether things
14440 have gone without a glitch. If things look ok, you may consider
14441 deleting the mbox file, but I wouldn't do that unless I was absolutely
14442 sure that all the mail has ended up where it should be.
14444 Respooling is also a handy thing to do if you're switching from one mail
14445 back end to another. Just respool all the mail in the old mail groups
14446 using the new mail back end.
14449 @node Expiring Mail
14450 @subsection Expiring Mail
14451 @cindex article expiry
14453 Traditional mail readers have a tendency to remove mail articles when
14454 you mark them as read, in some way. Gnus takes a fundamentally
14455 different approach to mail reading.
14457 Gnus basically considers mail just to be news that has been received in
14458 a rather peculiar manner. It does not think that it has the power to
14459 actually change the mail, or delete any mail messages. If you enter a
14460 mail group, and mark articles as ``read'', or kill them in some other
14461 fashion, the mail articles will still exist on the system. I repeat:
14462 Gnus will not delete your old, read mail. Unless you ask it to, of
14465 To make Gnus get rid of your unwanted mail, you have to mark the
14466 articles as @dfn{expirable}. (With the default key bindings, this means
14467 that you have to type @kbd{E}.) This does not mean that the articles
14468 will disappear right away, however. In general, a mail article will be
14469 deleted from your system if, 1) it is marked as expirable, AND 2) it is
14470 more than one week old. If you do not mark an article as expirable, it
14471 will remain on your system until hell freezes over. This bears
14472 repeating one more time, with some spurious capitalizations: IF you do
14473 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
14475 You do not have to mark articles as expirable by hand. Gnus provides
14476 two features, called ``auto-expire'' and ``total-expire'', that can help you
14477 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
14478 for you when you select an article. And ``total-expire'' means that Gnus
14479 considers all articles as expirable that are read. So, in addition to
14480 the articles marked @samp{E}, also the articles marked @samp{r},
14481 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
14484 When should either auto-expire or total-expire be used? Most people
14485 who are subscribed to mailing lists split each list into its own group
14486 and then turn on auto-expire or total-expire for those groups.
14487 (@xref{Splitting Mail}, for more information on splitting each list
14488 into its own group.)
14490 Which one is better, auto-expire or total-expire? It's not easy to
14491 answer. Generally speaking, auto-expire is probably faster. Another
14492 advantage of auto-expire is that you get more marks to work with: for
14493 the articles that are supposed to stick around, you can still choose
14494 between tick and dormant and read marks. But with total-expire, you
14495 only have dormant and ticked to choose from. The advantage of
14496 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
14497 Scoring}). Auto-expire works with normal scoring but not with adaptive
14500 @vindex gnus-auto-expirable-newsgroups
14501 Groups that match the regular expression
14502 @code{gnus-auto-expirable-newsgroups} will have all articles that you
14503 read marked as expirable automatically. All articles marked as
14504 expirable have an @samp{E} in the first column in the summary buffer.
14506 By default, if you have auto expiry switched on, Gnus will mark all the
14507 articles you read as expirable, no matter if they were read or unread
14508 before. To avoid having articles marked as read marked as expirable
14509 automatically, you can put something like the following in your
14510 @file{~/.gnus.el} file:
14512 @vindex gnus-mark-article-hook
14514 (remove-hook 'gnus-mark-article-hook
14515 'gnus-summary-mark-read-and-unread-as-read)
14516 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
14519 Note that making a group auto-expirable doesn't mean that all read
14520 articles are expired---only the articles marked as expirable
14521 will be expired. Also note that using the @kbd{d} command won't make
14522 articles expirable---only semi-automatic marking of articles as read will
14523 mark the articles as expirable in auto-expirable groups.
14525 Let's say you subscribe to a couple of mailing lists, and you want the
14526 articles you have read to disappear after a while:
14529 (setq gnus-auto-expirable-newsgroups
14530 "mail.nonsense-list\\|mail.nice-list")
14533 Another way to have auto-expiry happen is to have the element
14534 @code{auto-expire} in the group parameters of the group.
14536 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
14537 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
14538 don't really mix very well.
14540 @vindex nnmail-expiry-wait
14541 The @code{nnmail-expiry-wait} variable supplies the default time an
14542 expirable article has to live. Gnus starts counting days from when the
14543 message @emph{arrived}, not from when it was sent. The default is seven
14546 Gnus also supplies a function that lets you fine-tune how long articles
14547 are to live, based on what group they are in. Let's say you want to
14548 have one month expiry period in the @samp{mail.private} group, a one day
14549 expiry period in the @samp{mail.junk} group, and a six day expiry period
14552 @vindex nnmail-expiry-wait-function
14554 (setq nnmail-expiry-wait-function
14556 (cond ((string= group "mail.private")
14558 ((string= group "mail.junk")
14560 ((string= group "important")
14566 The group names this function is fed are ``unadorned'' group
14567 names---no @samp{nnml:} prefixes and the like.
14569 The @code{nnmail-expiry-wait} variable and
14570 @code{nnmail-expiry-wait-function} function can either be a number (not
14571 necessarily an integer) or one of the symbols @code{immediate} or
14574 You can also use the @code{expiry-wait} group parameter to selectively
14575 change the expiry period (@pxref{Group Parameters}).
14577 @vindex nnmail-expiry-target
14578 The normal action taken when expiring articles is to delete them.
14579 However, in some circumstances it might make more sense to move them
14580 to other groups instead of deleting them. The variable
14581 @code{nnmail-expiry-target} (and the @code{expiry-target} group
14582 parameter) controls this. The variable supplies a default value for
14583 all groups, which can be overridden for specific groups by the group
14584 parameter. default value is @code{delete}, but this can also be a
14585 string (which should be the name of the group the message should be
14586 moved to), or a function (which will be called in a buffer narrowed to
14587 the message in question, and with the name of the group being moved
14588 from as its parameter) which should return a target---either a group
14589 name or @code{delete}.
14591 Here's an example for specifying a group name:
14593 (setq nnmail-expiry-target "nnml:expired")
14596 @findex nnmail-fancy-expiry-target
14597 @vindex nnmail-fancy-expiry-targets
14598 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
14599 expire mail to groups according to the variable
14600 @code{nnmail-fancy-expiry-targets}. Here's an example:
14603 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
14604 nnmail-fancy-expiry-targets
14605 '((to-from "boss" "nnfolder:Work")
14606 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
14607 ("from" ".*" "nnfolder:Archive-%Y")))
14610 With this setup, any mail that has @code{IMPORTANT} in its Subject
14611 header and was sent in the year @code{YYYY} and month @code{MMM}, will
14612 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
14613 From or To header contains the string @code{boss}, it will get expired
14614 to @code{nnfolder:Work}. All other mail will get expired to
14615 @code{nnfolder:Archive-YYYY}.
14617 @vindex nnmail-keep-last-article
14618 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
14619 expire the final article in a mail newsgroup. This is to make life
14620 easier for procmail users.
14622 @vindex gnus-total-expirable-newsgroups
14623 By the way: That line up there, about Gnus never expiring non-expirable
14624 articles, is a lie. If you put @code{total-expire} in the group
14625 parameters, articles will not be marked as expirable, but all read
14626 articles will be put through the expiry process. Use with extreme
14627 caution. Even more dangerous is the
14628 @code{gnus-total-expirable-newsgroups} variable. All groups that match
14629 this regexp will have all read articles put through the expiry process,
14630 which means that @emph{all} old mail articles in the groups in question
14631 will be deleted after a while. Use with extreme caution, and don't come
14632 crying to me when you discover that the regexp you used matched the
14633 wrong group and all your important mail has disappeared. Be a
14634 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
14637 Most people make most of their mail groups total-expirable, though.
14639 @vindex gnus-inhibit-user-auto-expire
14640 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
14641 commands will not mark an article as expirable, even if the group has
14642 auto-expire turned on.
14646 @subsection Washing Mail
14647 @cindex mail washing
14648 @cindex list server brain damage
14649 @cindex incoming mail treatment
14651 Mailers and list servers are notorious for doing all sorts of really,
14652 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
14653 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
14654 end of all lines passing through our server, so let's do that!!!!1!''
14655 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
14656 considered to be self-evident were not discussed. So. Here we are.
14658 Case in point: The German version of Microsoft Exchange adds @samp{AW:
14659 } to the subjects of replies instead of @samp{Re: }. I could pretend to
14660 be shocked and dismayed by this, but I haven't got the energy. It is to
14663 Gnus provides a plethora of functions for washing articles while
14664 displaying them, but it might be nicer to do the filtering before
14665 storing the mail to disk. For that purpose, we have three hooks and
14666 various functions that can be put in these hooks.
14669 @item nnmail-prepare-incoming-hook
14670 @vindex nnmail-prepare-incoming-hook
14671 This hook is called before doing anything with the mail and is meant for
14672 grand, sweeping gestures. It is called in a buffer that contains all
14673 the new, incoming mail. Functions to be used include:
14676 @item nnheader-ms-strip-cr
14677 @findex nnheader-ms-strip-cr
14678 Remove trailing carriage returns from each line. This is default on
14679 Emacs running on MS machines.
14683 @item nnmail-prepare-incoming-header-hook
14684 @vindex nnmail-prepare-incoming-header-hook
14685 This hook is called narrowed to each header. It can be used when
14686 cleaning up the headers. Functions that can be used include:
14689 @item nnmail-remove-leading-whitespace
14690 @findex nnmail-remove-leading-whitespace
14691 Clear leading white space that ``helpful'' listservs have added to the
14692 headers to make them look nice. Aaah.
14694 (Note that this function works on both the header on the body of all
14695 messages, so it is a potentially dangerous function to use (if a body
14696 of a message contains something that looks like a header line). So
14697 rather than fix the bug, it is of course the right solution to make it
14698 into a feature by documenting it.)
14700 @item nnmail-remove-list-identifiers
14701 @findex nnmail-remove-list-identifiers
14702 Some list servers add an identifier---for example, @samp{(idm)}---to the
14703 beginning of all @code{Subject} headers. I'm sure that's nice for
14704 people who use stone age mail readers. This function will remove
14705 strings that match the @code{nnmail-list-identifiers} regexp, which can
14706 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
14709 For instance, if you want to remove the @samp{(idm)} and the
14710 @samp{nagnagnag} identifiers:
14713 (setq nnmail-list-identifiers
14714 '("(idm)" "nagnagnag"))
14717 This can also be done non-destructively with
14718 @code{gnus-list-identifiers}, @xref{Article Hiding}.
14720 @item nnmail-remove-tabs
14721 @findex nnmail-remove-tabs
14722 Translate all @samp{TAB} characters into @samp{SPACE} characters.
14724 @item nnmail-fix-eudora-headers
14725 @findex nnmail-fix-eudora-headers
14727 Eudora produces broken @code{References} headers, but OK
14728 @code{In-Reply-To} headers. This function will get rid of the
14729 @code{References} headers.
14733 @item nnmail-prepare-incoming-message-hook
14734 @vindex nnmail-prepare-incoming-message-hook
14735 This hook is called narrowed to each message. Functions to be used
14739 @item article-de-quoted-unreadable
14740 @findex article-de-quoted-unreadable
14741 Decode Quoted Readable encoding.
14748 @subsection Duplicates
14750 @vindex nnmail-treat-duplicates
14751 @vindex nnmail-message-id-cache-length
14752 @vindex nnmail-message-id-cache-file
14753 @cindex duplicate mails
14754 If you are a member of a couple of mailing lists, you will sometimes
14755 receive two copies of the same mail. This can be quite annoying, so
14756 @code{nnmail} checks for and treats any duplicates it might find. To do
14757 this, it keeps a cache of old @code{Message-ID}s---
14758 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
14759 default. The approximate maximum number of @code{Message-ID}s stored
14760 there is controlled by the @code{nnmail-message-id-cache-length}
14761 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
14762 stored.) If all this sounds scary to you, you can set
14763 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
14764 default), and @code{nnmail} won't delete duplicate mails. Instead it
14765 will insert a warning into the head of the mail saying that it thinks
14766 that this is a duplicate of a different message.
14768 This variable can also be a function. If that's the case, the function
14769 will be called from a buffer narrowed to the message in question with
14770 the @code{Message-ID} as a parameter. The function must return either
14771 @code{nil}, @code{warn}, or @code{delete}.
14773 You can turn this feature off completely by setting the variable to
14776 If you want all the duplicate mails to be put into a special
14777 @dfn{duplicates} group, you could do that using the normal mail split
14781 (setq nnmail-split-fancy
14782 '(| ;; @r{Messages duplicates go to a separate group.}
14783 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14784 ;; @r{Message from daemons, postmaster, and the like to another.}
14785 (any mail "mail.misc")
14786 ;; @r{Other rules.}
14792 (setq nnmail-split-methods
14793 '(("duplicates" "^Gnus-Warning:.*duplicate")
14794 ;; @r{Other rules.}
14798 Here's a neat feature: If you know that the recipient reads her mail
14799 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14800 @code{delete}, you can send her as many insults as you like, just by
14801 using a @code{Message-ID} of a mail that you know that she's already
14802 received. Think of all the fun! She'll never see any of it! Whee!
14805 @node Not Reading Mail
14806 @subsection Not Reading Mail
14808 If you start using any of the mail back ends, they have the annoying
14809 habit of assuming that you want to read mail with them. This might not
14810 be unreasonable, but it might not be what you want.
14812 If you set @code{mail-sources} and @code{nnmail-spool-file} to
14813 @code{nil}, none of the back ends will ever attempt to read incoming
14814 mail, which should help.
14816 @vindex nnbabyl-get-new-mail
14817 @vindex nnmbox-get-new-mail
14818 @vindex nnml-get-new-mail
14819 @vindex nnmh-get-new-mail
14820 @vindex nnfolder-get-new-mail
14821 This might be too much, if, for instance, you are reading mail quite
14822 happily with @code{nnml} and just want to peek at some old Rmail
14823 file you have stashed away with @code{nnbabyl}. All back ends have
14824 variables called back-end-@code{get-new-mail}. If you want to disable
14825 the @code{nnbabyl} mail reading, you edit the virtual server for the
14826 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
14828 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
14829 narrowed to the article to be saved before saving it when reading
14833 @node Choosing a Mail Back End
14834 @subsection Choosing a Mail Back End
14836 Gnus will read the mail spool when you activate a mail group. The mail
14837 file is first copied to your home directory. What happens after that
14838 depends on what format you want to store your mail in.
14840 There are six different mail back ends in the standard Gnus, and more
14841 back ends are available separately. The mail back end most people use
14842 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
14846 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
14847 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
14848 * Mail Spool:: Store your mail in a private spool?
14849 * MH Spool:: An mhspool-like back end.
14850 * Maildir:: Another one-file-per-message format.
14851 * Mail Folders:: Having one file for each group.
14852 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
14856 @node Unix Mail Box
14857 @subsubsection Unix Mail Box
14859 @cindex unix mail box
14861 @vindex nnmbox-active-file
14862 @vindex nnmbox-mbox-file
14863 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
14864 mail. @code{nnmbox} will add extra headers to each mail article to say
14865 which group it belongs in.
14867 Virtual server settings:
14870 @item nnmbox-mbox-file
14871 @vindex nnmbox-mbox-file
14872 The name of the mail box in the user's home directory. Default is
14875 @item nnmbox-active-file
14876 @vindex nnmbox-active-file
14877 The name of the active file for the mail box. Default is
14878 @file{~/.mbox-active}.
14880 @item nnmbox-get-new-mail
14881 @vindex nnmbox-get-new-mail
14882 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
14883 into groups. Default is @code{t}.
14888 @subsubsection Rmail Babyl
14892 @vindex nnbabyl-active-file
14893 @vindex nnbabyl-mbox-file
14894 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
14895 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
14896 mail article to say which group it belongs in.
14898 Virtual server settings:
14901 @item nnbabyl-mbox-file
14902 @vindex nnbabyl-mbox-file
14903 The name of the Rmail mbox file. The default is @file{~/RMAIL}
14905 @item nnbabyl-active-file
14906 @vindex nnbabyl-active-file
14907 The name of the active file for the rmail box. The default is
14908 @file{~/.rmail-active}
14910 @item nnbabyl-get-new-mail
14911 @vindex nnbabyl-get-new-mail
14912 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
14918 @subsubsection Mail Spool
14920 @cindex mail @acronym{NOV} spool
14922 The @dfn{nnml} spool mail format isn't compatible with any other known
14923 format. It should be used with some caution.
14925 @vindex nnml-directory
14926 If you use this back end, Gnus will split all incoming mail into files,
14927 one file for each mail, and put the articles into the corresponding
14928 directories under the directory specified by the @code{nnml-directory}
14929 variable. The default value is @file{~/Mail/}.
14931 You do not have to create any directories beforehand; Gnus will take
14934 If you have a strict limit as to how many files you are allowed to store
14935 in your account, you should not use this back end. As each mail gets its
14936 own file, you might very well occupy thousands of inodes within a few
14937 weeks. If this is no problem for you, and it isn't a problem for you
14938 having your friendly systems administrator walking around, madly,
14939 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
14940 know that this is probably the fastest format to use. You do not have
14941 to trudge through a big mbox file just to read your new mail.
14943 @code{nnml} is probably the slowest back end when it comes to article
14944 splitting. It has to create lots of files, and it also generates
14945 @acronym{NOV} databases for the incoming mails. This makes it possibly the
14946 fastest back end when it comes to reading mail.
14948 @cindex self contained nnml servers
14950 When the marks file is used (which it is by default), @code{nnml}
14951 servers have the property that you may backup them using @code{tar} or
14952 similar, and later be able to restore them into Gnus (by adding the
14953 proper @code{nnml} server) and have all your marks be preserved. Marks
14954 for a group is usually stored in the @code{.marks} file (but see
14955 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
14956 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
14957 to restore the group (after restoring the backup into the nnml
14960 If for some reason you believe your @file{.marks} files are screwed
14961 up, you can just delete them all. Gnus will then correctly regenerate
14962 them next time it starts.
14964 Virtual server settings:
14967 @item nnml-directory
14968 @vindex nnml-directory
14969 All @code{nnml} directories will be placed under this directory. The
14970 default is the value of @code{message-directory} (whose default value
14973 @item nnml-active-file
14974 @vindex nnml-active-file
14975 The active file for the @code{nnml} server. The default is
14976 @file{~/Mail/active}.
14978 @item nnml-newsgroups-file
14979 @vindex nnml-newsgroups-file
14980 The @code{nnml} group descriptions file. @xref{Newsgroups File
14981 Format}. The default is @file{~/Mail/newsgroups}.
14983 @item nnml-get-new-mail
14984 @vindex nnml-get-new-mail
14985 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
14988 @item nnml-nov-is-evil
14989 @vindex nnml-nov-is-evil
14990 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
14991 default is @code{nil}.
14993 @item nnml-nov-file-name
14994 @vindex nnml-nov-file-name
14995 The name of the @acronym{NOV} files. The default is @file{.overview}.
14997 @item nnml-prepare-save-mail-hook
14998 @vindex nnml-prepare-save-mail-hook
14999 Hook run narrowed to an article before saving.
15001 @item nnml-marks-is-evil
15002 @vindex nnml-marks-is-evil
15003 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15004 default is @code{nil}.
15006 @item nnml-marks-file-name
15007 @vindex nnml-marks-file-name
15008 The name of the @dfn{marks} files. The default is @file{.marks}.
15010 @item nnml-use-compressed-files
15011 @vindex nnml-use-compressed-files
15012 If non-@code{nil}, @code{nnml} will allow using compressed message
15017 @findex nnml-generate-nov-databases
15018 If your @code{nnml} groups and @acronym{NOV} files get totally out of
15019 whack, you can do a complete update by typing @kbd{M-x
15020 nnml-generate-nov-databases}. This command will trawl through the
15021 entire @code{nnml} hierarchy, looking at each and every article, so it
15022 might take a while to complete. A better interface to this
15023 functionality can be found in the server buffer (@pxref{Server
15028 @subsubsection MH Spool
15030 @cindex mh-e mail spool
15032 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
15033 @acronym{NOV} databases and it doesn't keep an active file or marks
15034 file. This makes @code{nnmh} a @emph{much} slower back end than
15035 @code{nnml}, but it also makes it easier to write procmail scripts
15038 Virtual server settings:
15041 @item nnmh-directory
15042 @vindex nnmh-directory
15043 All @code{nnmh} directories will be located under this directory. The
15044 default is the value of @code{message-directory} (whose default is
15047 @item nnmh-get-new-mail
15048 @vindex nnmh-get-new-mail
15049 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
15053 @vindex nnmh-be-safe
15054 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
15055 sure that the articles in the folder are actually what Gnus thinks
15056 they are. It will check date stamps and stat everything in sight, so
15057 setting this to @code{t} will mean a serious slow-down. If you never
15058 use anything but Gnus to read the @code{nnmh} articles, you do not
15059 have to set this variable to @code{t}. The default is @code{nil}.
15064 @subsubsection Maildir
15068 @code{nnmaildir} stores mail in the maildir format, with each maildir
15069 corresponding to a group in Gnus. This format is documented here:
15070 @uref{http://cr.yp.to/proto/maildir.html} and here:
15071 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
15072 also stores extra information in the @file{.nnmaildir/} directory
15075 Maildir format was designed to allow concurrent deliveries and
15076 reading, without needing locks. With other back ends, you would have
15077 your mail delivered to a spool of some kind, and then you would
15078 configure Gnus to split mail from that spool into your groups. You
15079 can still do that with @code{nnmaildir}, but the more common
15080 configuration is to have your mail delivered directly to the maildirs
15081 that appear as group in Gnus.
15083 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
15084 never corrupt its data in memory, and @code{SIGKILL} will never
15085 corrupt its data in the filesystem.
15087 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
15088 maildir. So you can copy a whole maildir from one Gnus setup to
15089 another, and you will keep your marks.
15091 Virtual server settings:
15095 For each of your @code{nnmaildir} servers (it's very unlikely that
15096 you'd need more than one), you need to create a directory and populate
15097 it with maildirs or symlinks to maildirs (and nothing else; do not
15098 choose a directory already used for other purposes). Each maildir
15099 will be represented in Gnus as a newsgroup on that server; the
15100 filename of the symlink will be the name of the group. Any filenames
15101 in the directory starting with @samp{.} are ignored. The directory is
15102 scanned when you first start Gnus, and each time you type @kbd{g} in
15103 the group buffer; if any maildirs have been removed or added,
15104 @code{nnmaildir} notices at these times.
15106 The value of the @code{directory} parameter should be a Lisp form
15107 which is processed by @code{eval} and @code{expand-file-name} to get
15108 the path of the directory for this server. The form is @code{eval}ed
15109 only when the server is opened; the resulting string is used until the
15110 server is closed. (If you don't know about forms and @code{eval},
15111 don't worry---a simple string will work.) This parameter is not
15112 optional; you must specify it. I don't recommend using
15113 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
15114 use that directory by default for various things, and may get confused
15115 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
15118 @item target-prefix
15119 This should be a Lisp form which is processed by @code{eval} and
15120 @code{expand-file-name}. The form is @code{eval}ed only when the
15121 server is opened; the resulting string is used until the server is
15124 When you create a group on an @code{nnmaildir} server, the maildir is
15125 created with @code{target-prefix} prepended to its name, and a symlink
15126 pointing to that maildir is created, named with the plain group name.
15127 So if @code{directory} is @code{"~/.nnmaildir"} and
15128 @code{target-prefix} is @code{"../maildirs/"}, then when you create
15129 the group @code{foo}, @code{nnmaildir} will create
15130 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
15131 @file{~/.nnmaildir/foo} as a symlink pointing to
15132 @file{../maildirs/foo}.
15134 You can set @code{target-prefix} to a string without any slashes to
15135 create both maildirs and symlinks in the same @code{directory}; in
15136 this case, any maildirs found in @code{directory} whose names start
15137 with @code{target-prefix} will not be listed as groups (but the
15138 symlinks pointing to them will be).
15140 As a special case, if @code{target-prefix} is @code{""} (the default),
15141 then when you create a group, the maildir will be created in
15142 @code{directory} without a corresponding symlink. Beware that you
15143 cannot use @code{gnus-group-delete-group} on such groups without the
15144 @code{force} argument.
15146 @item directory-files
15147 This should be a function with the same interface as
15148 @code{directory-files} (such as @code{directory-files} itself). It is
15149 used to scan the server's @code{directory} for maildirs. This
15150 parameter is optional; the default is
15151 @code{nnheader-directory-files-safe} if
15152 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15153 @code{directory-files} otherwise.
15154 (@code{nnheader-directory-files-is-safe} is checked only once when the
15155 server is opened; if you want to check it each time the directory is
15156 scanned, you'll have to provide your own function that does that.)
15159 If non-@code{nil}, then after scanning for new mail in the group
15160 maildirs themselves as usual, this server will also incorporate mail
15161 the conventional Gnus way, from @code{mail-sources} according to
15162 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
15163 value is @code{nil}.
15165 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15166 an @code{nnmaildir} group. The results might happen to be useful, but
15167 that would be by chance, not by design, and the results might be
15168 different in the future. If your split rules create new groups,
15169 remember to supply a @code{create-directory} server parameter.
15172 @subsubsection Group parameters
15174 @code{nnmaildir} uses several group parameters. It's safe to ignore
15175 all this; the default behavior for @code{nnmaildir} is the same as the
15176 default behavior for other mail back ends: articles are deleted after
15177 one week, etc. Except for the expiry parameters, all this
15178 functionality is unique to @code{nnmaildir}, so you can ignore it if
15179 you're just trying to duplicate the behavior you already have with
15182 If the value of any of these parameters is a vector, the first element
15183 is evaluated as a Lisp form and the result is used, rather than the
15184 original value. If the value is not a vector, the value itself is
15185 evaluated as a Lisp form. (This is why these parameters use names
15186 different from those of other, similar parameters supported by other
15187 back ends: they have different, though similar, meanings.) (For
15188 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15189 @code{eval} business again; for other values, remember to use an extra
15190 quote and wrap the value in a vector when appropriate.)
15194 An integer specifying the minimum age, in seconds, of an article
15195 before it will be expired, or the symbol @code{never} to specify that
15196 articles should never be expired. If this parameter is not set,
15197 @code{nnmaildir} falls back to the usual
15198 @code{nnmail-expiry-wait}(@code{-function}) variables (overrideable by
15199 the @code{expiry-wait}(@code{-function}) group parameters. If you
15200 wanted a value of 3 days, you could use something like @code{[(* 3 24
15201 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15202 An article's age is measured starting from the article file's
15203 modification time. Normally, this is the same as the article's
15204 delivery time, but editing an article makes it younger. Moving an
15205 article (other than via expiry) may also make an article younger.
15208 If this is set to a string such as a full Gnus group name, like
15210 "backend+server.address.string:group.name"
15212 and if it is not the name of the same group that the parameter belongs
15213 to, then articles will be moved to the specified group during expiry
15214 before being deleted. @emph{If this is set to an @code{nnmaildir}
15215 group, the article will be just as old in the destination group as it
15216 was in the source group.} So be careful with @code{expire-age} in the
15217 destination group. If this is set to the name of the same group that
15218 the parameter belongs to, then the article is not expired at all. If
15219 you use the vector form, the first element is evaluated once for each
15220 article. So that form can refer to
15221 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15222 article. @emph{If this parameter is not set, @code{nnmaildir} does
15223 not fall back to the @code{expiry-target} group parameter or the
15224 @code{nnmail-expiry-target} variable.}
15227 If this is set to @code{t}, @code{nnmaildir} will treat the articles
15228 in this maildir as read-only. This means: articles are not renamed
15229 from @file{new/} into @file{cur/}; articles are only found in
15230 @file{new/}, not @file{cur/}; articles are never deleted; articles
15231 cannot be edited. @file{new/} is expected to be a symlink to the
15232 @file{new/} directory of another maildir---e.g., a system-wide mailbox
15233 containing a mailing list of common interest. Everything in the
15234 maildir outside @file{new/} is @emph{not} treated as read-only, so for
15235 a shared mailbox, you do still need to set up your own maildir (or
15236 have write permission to the shared mailbox); your maildir just won't
15237 contain extra copies of the articles.
15239 @item directory-files
15240 A function with the same interface as @code{directory-files}. It is
15241 used to scan the directories in the maildir corresponding to this
15242 group to find articles. The default is the function specified by the
15243 server's @code{directory-files} parameter.
15245 @item distrust-Lines:
15246 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
15247 article, rather than use the @code{Lines:} header field. If
15248 @code{nil}, the header field will be used if present.
15251 A list of mark symbols, such as @code{['(read expire)]}. Whenever
15252 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15253 say that all articles have these marks, regardless of whether the
15254 marks stored in the filesystem say so. This is a proof-of-concept
15255 feature that will probably be removed eventually; it ought to be done
15256 in Gnus proper, or abandoned if it's not worthwhile.
15259 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
15260 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15261 say that no articles have these marks, regardless of whether the marks
15262 stored in the filesystem say so. @code{never-marks} overrides
15263 @code{always-marks}. This is a proof-of-concept feature that will
15264 probably be removed eventually; it ought to be done in Gnus proper, or
15265 abandoned if it's not worthwhile.
15267 @item nov-cache-size
15268 An integer specifying the size of the @acronym{NOV} memory cache. To
15269 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
15270 for a limited number of articles in each group. (This is probably not
15271 worthwhile, and will probably be removed in the future.) This
15272 parameter's value is noticed only the first time a group is seen after
15273 the server is opened---i.e., when you first start Gnus, typically.
15274 The @acronym{NOV} cache is never resized until the server is closed
15275 and reopened. The default is an estimate of the number of articles
15276 that would be displayed in the summary buffer: a count of articles
15277 that are either marked with @code{tick} or not marked with
15278 @code{read}, plus a little extra.
15281 @subsubsection Article identification
15282 Articles are stored in the @file{cur/} subdirectory of each maildir.
15283 Each article file is named like @code{uniq:info}, where @code{uniq}
15284 contains no colons. @code{nnmaildir} ignores, but preserves, the
15285 @code{:info} part. (Other maildir readers typically use this part of
15286 the filename to store marks.) The @code{uniq} part uniquely
15287 identifies the article, and is used in various places in the
15288 @file{.nnmaildir/} subdirectory of the maildir to store information
15289 about the corresponding article. The full pathname of an article is
15290 available in the variable @code{nnmaildir-article-file-name} after you
15291 request the article in the summary buffer.
15293 @subsubsection NOV data
15294 An article identified by @code{uniq} has its @acronym{NOV} data (used
15295 to generate lines in the summary buffer) stored in
15296 @code{.nnmaildir/nov/uniq}. There is no
15297 @code{nnmaildir-generate-nov-databases} function. (There isn't much
15298 need for it---an article's @acronym{NOV} data is updated automatically
15299 when the article or @code{nnmail-extra-headers} has changed.) You can
15300 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
15301 single article simply by deleting the corresponding @acronym{NOV}
15302 file, but @emph{beware}: this will also cause @code{nnmaildir} to
15303 assign a new article number for this article, which may cause trouble
15304 with @code{seen} marks, the Agent, and the cache.
15306 @subsubsection Article marks
15307 An article identified by @code{uniq} is considered to have the mark
15308 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
15309 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
15310 looks for such files and reports the set of marks it finds. When Gnus
15311 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
15312 creates and deletes the corresponding files as needed. (Actually,
15313 rather than create a new file for each mark, it just creates hard
15314 links to @file{.nnmaildir/markfile}, to save inodes.)
15316 You can invent new marks by creating a new directory in
15317 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
15318 your server, untar it later, and keep your marks. You can add and
15319 remove marks yourself by creating and deleting mark files. If you do
15320 this while Gnus is running and your @code{nnmaildir} server is open,
15321 it's best to exit all summary buffers for @code{nnmaildir} groups and
15322 type @kbd{s} in the group buffer first, and to type @kbd{g} or
15323 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
15324 pick up the changes, and might undo them.
15328 @subsubsection Mail Folders
15330 @cindex mbox folders
15331 @cindex mail folders
15333 @code{nnfolder} is a back end for storing each mail group in a
15334 separate file. Each file is in the standard Un*x mbox format.
15335 @code{nnfolder} will add extra headers to keep track of article
15336 numbers and arrival dates.
15338 @cindex self contained nnfolder servers
15340 When the marks file is used (which it is by default), @code{nnfolder}
15341 servers have the property that you may backup them using @code{tar} or
15342 similar, and later be able to restore them into Gnus (by adding the
15343 proper @code{nnfolder} server) and have all your marks be preserved.
15344 Marks for a group is usually stored in a file named as the mbox file
15345 with @code{.mrk} concatenated to it (but see
15346 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
15347 directory. Individual @code{nnfolder} groups are also possible to
15348 backup, use @kbd{G m} to restore the group (after restoring the backup
15349 into the @code{nnfolder} directory).
15351 Virtual server settings:
15354 @item nnfolder-directory
15355 @vindex nnfolder-directory
15356 All the @code{nnfolder} mail boxes will be stored under this
15357 directory. The default is the value of @code{message-directory}
15358 (whose default is @file{~/Mail})
15360 @item nnfolder-active-file
15361 @vindex nnfolder-active-file
15362 The name of the active file. The default is @file{~/Mail/active}.
15364 @item nnfolder-newsgroups-file
15365 @vindex nnfolder-newsgroups-file
15366 The name of the group descriptions file. @xref{Newsgroups File
15367 Format}. The default is @file{~/Mail/newsgroups}
15369 @item nnfolder-get-new-mail
15370 @vindex nnfolder-get-new-mail
15371 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
15372 default is @code{t}
15374 @item nnfolder-save-buffer-hook
15375 @vindex nnfolder-save-buffer-hook
15376 @cindex backup files
15377 Hook run before saving the folders. Note that Emacs does the normal
15378 backup renaming of files even with the @code{nnfolder} buffers. If
15379 you wish to switch this off, you could say something like the
15380 following in your @file{.emacs} file:
15383 (defun turn-off-backup ()
15384 (set (make-local-variable 'backup-inhibited) t))
15386 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
15389 @item nnfolder-delete-mail-hook
15390 @vindex nnfolder-delete-mail-hook
15391 Hook run in a buffer narrowed to the message that is to be deleted.
15392 This function can be used to copy the message to somewhere else, or to
15393 extract some information from it before removing it.
15395 @item nnfolder-nov-is-evil
15396 @vindex nnfolder-nov-is-evil
15397 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15398 default is @code{nil}.
15400 @item nnfolder-nov-file-suffix
15401 @vindex nnfolder-nov-file-suffix
15402 The extension for @acronym{NOV} files. The default is @file{.nov}.
15404 @item nnfolder-nov-directory
15405 @vindex nnfolder-nov-directory
15406 The directory where the @acronym{NOV} files should be stored. If
15407 @code{nil}, @code{nnfolder-directory} is used.
15409 @item nnfolder-marks-is-evil
15410 @vindex nnfolder-marks-is-evil
15411 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15412 default is @code{nil}.
15414 @item nnfolder-marks-file-suffix
15415 @vindex nnfolder-marks-file-suffix
15416 The extension for @sc{marks} files. The default is @file{.mrk}.
15418 @item nnfolder-marks-directory
15419 @vindex nnfolder-marks-directory
15420 The directory where the @sc{marks} files should be stored. If
15421 @code{nil}, @code{nnfolder-directory} is used.
15426 @findex nnfolder-generate-active-file
15427 @kindex M-x nnfolder-generate-active-file
15428 If you have lots of @code{nnfolder}-like files you'd like to read with
15429 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
15430 command to make @code{nnfolder} aware of all likely files in
15431 @code{nnfolder-directory}. This only works if you use long file names,
15434 @node Comparing Mail Back Ends
15435 @subsubsection Comparing Mail Back Ends
15437 First, just for terminology, the @dfn{back end} is the common word for a
15438 low-level access method---a transport, if you will, by which something
15439 is acquired. The sense is that one's mail has to come from somewhere,
15440 and so selection of a suitable back end is required in order to get that
15441 mail within spitting distance of Gnus.
15443 The same concept exists for Usenet itself: Though access to articles is
15444 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
15445 in the world got at Usenet by running a reader on the machine where the
15446 articles lay (the machine which today we call an @acronym{NNTP} server), and
15447 access was by the reader stepping into the articles' directory spool
15448 area directly. One can still select between either the @code{nntp} or
15449 @code{nnspool} back ends, to select between these methods, if one happens
15450 actually to live on the server (or can see its spool directly, anyway,
15453 The goal in selecting a mail back end is to pick one which
15454 simultaneously represents a suitable way of dealing with the original
15455 format plus leaving mail in a form that is convenient to use in the
15456 future. Here are some high and low points on each:
15461 UNIX systems have historically had a single, very common, and well-
15462 defined format. All messages arrive in a single @dfn{spool file}, and
15463 they are delineated by a line whose regular expression matches
15464 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
15465 to make it clear in this instance that this is not the RFC-specified
15466 @samp{From:} header.) Because Emacs and therefore Gnus emanate
15467 historically from the Unix environment, it is simplest if one does not
15468 mess a great deal with the original mailbox format, so if one chooses
15469 this back end, Gnus' primary activity in getting mail from the real spool
15470 area to Gnus' preferred directory is simply to copy it, with no
15471 (appreciable) format change in the process. It is the ``dumbest'' way
15472 to move mail into availability in the Gnus environment. This makes it
15473 fast to move into place, but slow to parse, when Gnus has to look at
15478 Once upon a time, there was the DEC-10 and DEC-20, running operating
15479 systems called TOPS and related things, and the usual (only?) mail
15480 reading environment was a thing called Babyl. I don't know what format
15481 was used for mail landing on the system, but Babyl had its own internal
15482 format to which mail was converted, primarily involving creating a
15483 spool-file-like entity with a scheme for inserting Babyl-specific
15484 headers and status bits above the top of each message in the file.
15485 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
15486 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
15487 to understand the mail files folks already had in existence. Gnus (and
15488 VM, for that matter) continue to support this format because it's
15489 perceived as having some good qualities in those mailer-specific
15490 headers/status bits stuff. Rmail itself still exists as well, of
15491 course, and is still maintained by Stallman.
15493 Both of the above forms leave your mail in a single file on your
15494 file system, and they must parse that entire file each time you take a
15499 @code{nnml} is the back end which smells the most as though you were
15500 actually operating with an @code{nnspool}-accessed Usenet system. (In
15501 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
15502 lo these years ago.) One's mail is taken from the original spool file,
15503 and is then cut up into individual message files, 1:1. It maintains a
15504 Usenet-style active file (analogous to what one finds in an INN- or
15505 CNews-based news system in (for instance) @file{/var/lib/news/active},
15506 or what is returned via the @samp{NNTP LIST} verb) and also creates
15507 @dfn{overview} files for efficient group entry, as has been defined for
15508 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
15509 due to the creation of lots of files, updates to the @code{nnml} active
15510 file, and additions to overview files on a per-message basis, but it is
15511 extremely fast on access because of what amounts to the indexing support
15512 provided by the active file and overviews.
15514 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
15515 resource which defines available places in the file system to put new
15516 files. Sysadmins take a dim view of heavy inode occupation within
15517 tight, shared file systems. But if you live on a personal machine where
15518 the file system is your own and space is not at a premium, @code{nnml}
15521 It is also problematic using this back end if you are living in a
15522 FAT16-based Windows world, since much space will be wasted on all these
15527 The Rand MH mail-reading system has been around UNIX systems for a very
15528 long time; it operates by splitting one's spool file of messages into
15529 individual files, but with little or no indexing support---@code{nnmh}
15530 is considered to be semantically equivalent to ``@code{nnml} without
15531 active file or overviews''. This is arguably the worst choice, because
15532 one gets the slowness of individual file creation married to the
15533 slowness of access parsing when learning what's new in one's groups.
15537 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
15538 method described above) on a per-group basis. That is, @code{nnmbox}
15539 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
15540 little bit of optimization to this so that each of one's mail groups has
15541 a Unix mail box file. It's faster than @code{nnmbox} because each group
15542 can be parsed separately, and still provides the simple Unix mail box
15543 format requiring minimal effort in moving the mail around. In addition,
15544 it maintains an ``active'' file making it much faster for Gnus to figure
15545 out how many messages there are in each separate group.
15547 If you have groups that are expected to have a massive amount of
15548 messages, @code{nnfolder} is not the best choice, but if you receive
15549 only a moderate amount of mail, @code{nnfolder} is probably the most
15550 friendly mail back end all over.
15554 For configuring expiry and other things, @code{nnmaildir} uses
15555 incompatible group parameters, slightly different from those of other
15558 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
15559 differences. Each message is stored in a separate file, but the
15560 filename is unrelated to the article number in Gnus. @code{nnmaildir}
15561 also stores the equivalent of @code{nnml}'s overview files in one file
15562 per article, so it uses about twice as many inodes as @code{nnml}. (Use
15563 @code{df -i} to see how plentiful your inode supply is.) If this slows
15564 you down or takes up very much space, consider switching to
15565 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
15568 Since maildirs don't require locking for delivery, the maildirs you use
15569 as groups can also be the maildirs your mail is directly delivered to.
15570 This means you can skip Gnus' mail splitting if your mail is already
15571 organized into different mailboxes during delivery. A @code{directory}
15572 entry in @code{mail-sources} would have a similar effect, but would
15573 require one set of mailboxes for spooling deliveries (in mbox format,
15574 thus damaging message bodies), and another set to be used as groups (in
15575 whatever format you like). A maildir has a built-in spool, in the
15576 @code{new/} subdirectory. Beware that currently, mail moved from
15577 @code{new/} to @code{cur/} instead of via mail splitting will not
15578 undergo treatment such as duplicate checking.
15580 @code{nnmaildir} stores article marks for a given group in the
15581 corresponding maildir, in a way designed so that it's easy to manipulate
15582 them from outside Gnus. You can tar up a maildir, unpack it somewhere
15583 else, and still have your marks. @code{nnml} also stores marks, but
15584 it's not as easy to work with them from outside Gnus as with
15587 @code{nnmaildir} uses a significant amount of memory to speed things up.
15588 (It keeps in memory some of the things that @code{nnml} stores in files
15589 and that @code{nnmh} repeatedly parses out of message files.) If this
15590 is a problem for you, you can set the @code{nov-cache-size} group
15591 parameter to something small (0 would probably not work, but 1 probably
15592 would) to make it use less memory. This caching will probably be
15593 removed in the future.
15595 Startup is likely to be slower with @code{nnmaildir} than with other
15596 back ends. Everything else is likely to be faster, depending in part
15597 on your file system.
15599 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
15600 to write an @code{nnmaildir}-derived back end.
15605 @node Browsing the Web
15606 @section Browsing the Web
15608 @cindex browsing the web
15612 Web-based discussion forums are getting more and more popular. On many
15613 subjects, the web-based forums have become the most important forums,
15614 eclipsing the importance of mailing lists and news groups. The reason
15615 is easy to understand---they are friendly to new users; you just point
15616 and click, and there's the discussion. With mailing lists, you have to
15617 go through a cumbersome subscription procedure, and most people don't
15618 even know what a news group is.
15620 The problem with this scenario is that web browsers are not very good at
15621 being newsreaders. They do not keep track of what articles you've read;
15622 they do not allow you to score on subjects you're interested in; they do
15623 not allow off-line browsing; they require you to click around and drive
15624 you mad in the end.
15626 So---if web browsers suck at reading discussion forums, why not use Gnus
15629 Gnus has been getting a bit of a collection of back ends for providing
15630 interfaces to these sources.
15634 * Web Searches:: Creating groups from articles that match a string.
15635 * Slashdot:: Reading the Slashdot comments.
15636 * Ultimate:: The Ultimate Bulletin Board systems.
15637 * Web Archive:: Reading mailing list archived on web.
15638 * RSS:: Reading RDF site summary.
15639 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
15642 All the web sources require Emacs/w3 and the url library to work.
15644 The main caveat with all these web sources is that they probably won't
15645 work for a very long time. Gleaning information from the @acronym{HTML} data
15646 is guesswork at best, and when the layout is altered, the Gnus back end
15647 will fail. If you have reasonably new versions of these back ends,
15648 though, you should be ok.
15650 One thing all these Web methods have in common is that the Web sources
15651 are often down, unavailable or just plain too slow to be fun. In those
15652 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
15653 Unplugged}) handle downloading articles, and then you can read them at
15654 leisure from your local disk. No more World Wide Wait for you.
15656 @node Archiving Mail
15657 @subsection Archiving Mail
15658 @cindex archiving mail
15659 @cindex backup of mail
15661 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
15662 @code{nnmaildir}, now actually store the article marks with each group.
15663 For these servers, archiving and restoring a group while preserving
15664 marks is fairly simple.
15666 (Preserving the group level and group parameters as well still
15667 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
15670 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
15671 server, take a recursive copy of the server directory. There is no need
15672 to shut down Gnus, so archiving may be invoked by @code{cron} or
15673 similar. You restore the data by restoring the directory tree, and
15674 adding a server definition pointing to that directory in Gnus. The
15675 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
15676 might interfere with overwriting data, so you may want to shut down Gnus
15677 before you restore the data.
15679 It is also possible to archive individual @code{nnml},
15680 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
15681 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
15682 directory. For @code{nnfolder} you need to copy both the base folder
15683 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
15684 this example). Restoring the group is done with @kbd{G m} from the Group
15685 buffer. The last step makes Gnus notice the new directory.
15686 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
15687 is unnecessary in that case.
15690 @subsection Web Searches
15695 @cindex Usenet searches
15696 @cindex searching the Usenet
15698 It's, like, too neat to search the Usenet for articles that match a
15699 string, but it, like, totally @emph{sucks}, like, totally, to use one of
15700 those, like, Web browsers, and you, like, have to, rilly, like, look at
15701 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
15702 searches without having to use a browser.
15704 The @code{nnweb} back end allows an easy interface to the mighty search
15705 engine. You create an @code{nnweb} group, enter a search pattern, and
15706 then enter the group and read the articles like you would any normal
15707 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
15708 Groups}) will do this in an easy-to-use fashion.
15710 @code{nnweb} groups don't really lend themselves to being solid
15711 groups---they have a very fleeting idea of article numbers. In fact,
15712 each time you enter an @code{nnweb} group (not even changing the search
15713 pattern), you are likely to get the articles ordered in a different
15714 manner. Not even using duplicate suppression (@pxref{Duplicate
15715 Suppression}) will help, since @code{nnweb} doesn't even know the
15716 @code{Message-ID} of the articles before reading them using some search
15717 engines (Google, for instance). The only possible way to keep track
15718 of which articles you've read is by scoring on the @code{Date}
15719 header---mark all articles posted before the last date you read the
15722 If the search engine changes its output substantially, @code{nnweb}
15723 won't be able to parse it and will fail. One could hardly fault the Web
15724 providers if they were to do this---their @emph{raison d'@^etre} is to
15725 make money off of advertisements, not to provide services to the
15726 community. Since @code{nnweb} washes the ads off all the articles, one
15727 might think that the providers might be somewhat miffed. We'll see.
15729 You must have the @code{url} and @code{w3} package installed to be able
15730 to use @code{nnweb}.
15732 Virtual server variables:
15737 What search engine type is being used. The currently supported types
15738 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
15739 @code{dejanews} is an alias to @code{google}.
15742 @vindex nnweb-search
15743 The search string to feed to the search engine.
15745 @item nnweb-max-hits
15746 @vindex nnweb-max-hits
15747 Advisory maximum number of hits per search to display. The default is
15750 @item nnweb-type-definition
15751 @vindex nnweb-type-definition
15752 Type-to-definition alist. This alist says what @code{nnweb} should do
15753 with the various search engine types. The following elements must be
15758 Function to decode the article and provide something that Gnus
15762 Function to create an article number to message header and URL alist.
15765 Function to send the search string to the search engine.
15768 The address the aforementioned function should send the search string
15772 Format string URL to fetch an article by @code{Message-ID}.
15779 @subsection Slashdot
15783 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
15784 lively discussion following the news articles. @code{nnslashdot} will
15785 let you read this forum in a convenient manner.
15787 The easiest way to read this source is to put something like the
15788 following in your @file{~/.gnus.el} file:
15791 (setq gnus-secondary-select-methods
15792 '((nnslashdot "")))
15795 This will make Gnus query the @code{nnslashdot} back end for new comments
15796 and groups. The @kbd{F} command will subscribe each new news article as
15797 a new Gnus group, and you can read the comments by entering these
15798 groups. (Note that the default subscription method is to subscribe new
15799 groups as zombies. Other methods are available (@pxref{Subscription
15802 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
15803 command is the most handy tool (@pxref{Foreign Groups}).
15805 When following up to @code{nnslashdot} comments (or posting new
15806 comments), some light @acronym{HTML}izations will be performed. In
15807 particular, text quoted with @samp{> } will be quoted with
15808 @samp{blockquote} instead, and signatures will have @samp{br} added to
15809 the end of each line. Other than that, you can just write @acronym{HTML}
15810 directly into the message buffer. Note that Slashdot filters out some
15811 @acronym{HTML} forms.
15813 The following variables can be altered to change its behavior:
15816 @item nnslashdot-threaded
15817 Whether @code{nnslashdot} should display threaded groups or not. The
15818 default is @code{t}. To be able to display threads, @code{nnslashdot}
15819 has to retrieve absolutely all comments in a group upon entry. If a
15820 threaded display is not required, @code{nnslashdot} will only retrieve
15821 the comments that are actually wanted by the user. Threading is nicer,
15822 but much, much slower than unthreaded.
15824 @item nnslashdot-login-name
15825 @vindex nnslashdot-login-name
15826 The login name to use when posting.
15828 @item nnslashdot-password
15829 @vindex nnslashdot-password
15830 The password to use when posting.
15832 @item nnslashdot-directory
15833 @vindex nnslashdot-directory
15834 Where @code{nnslashdot} will store its files. The default is
15835 @file{~/News/slashdot/}.
15837 @item nnslashdot-active-url
15838 @vindex nnslashdot-active-url
15839 The @acronym{URL} format string that will be used to fetch the
15840 information on news articles and comments. The default is@*
15841 @samp{http://slashdot.org/search.pl?section=&min=%d}.
15843 @item nnslashdot-comments-url
15844 @vindex nnslashdot-comments-url
15845 The @acronym{URL} format string that will be used to fetch comments.
15847 @item nnslashdot-article-url
15848 @vindex nnslashdot-article-url
15849 The @acronym{URL} format string that will be used to fetch the news
15850 article. The default is
15851 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
15853 @item nnslashdot-threshold
15854 @vindex nnslashdot-threshold
15855 The score threshold. The default is -1.
15857 @item nnslashdot-group-number
15858 @vindex nnslashdot-group-number
15859 The number of old groups, in addition to the ten latest, to keep
15860 updated. The default is 0.
15867 @subsection Ultimate
15869 @cindex Ultimate Bulletin Board
15871 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
15872 probably the most popular Web bulletin board system used. It has a
15873 quite regular and nice interface, and it's possible to get the
15874 information Gnus needs to keep groups updated.
15876 The easiest way to get started with @code{nnultimate} is to say
15877 something like the following in the group buffer: @kbd{B nnultimate RET
15878 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
15879 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
15880 you're interested in; there's quite a list of them on the Ultimate web
15881 site.) Then subscribe to the groups you're interested in from the
15882 server buffer, and read them from the group buffer.
15884 The following @code{nnultimate} variables can be altered:
15887 @item nnultimate-directory
15888 @vindex nnultimate-directory
15889 The directory where @code{nnultimate} stores its files. The default is@*
15890 @file{~/News/ultimate/}.
15895 @subsection Web Archive
15897 @cindex Web Archive
15899 Some mailing lists only have archives on Web servers, such as
15900 @uref{http://www.egroups.com/} and
15901 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
15902 interface, and it's possible to get the information Gnus needs to keep
15905 @findex gnus-group-make-warchive-group
15906 The easiest way to get started with @code{nnwarchive} is to say
15907 something like the following in the group buffer: @kbd{M-x
15908 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
15909 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
15910 @var{an_egroup} with the mailing list you subscribed, the
15911 @var{your@@email.address} with your email address.), or to browse the
15912 back end by @kbd{B nnwarchive RET mail-archive RET}.
15914 The following @code{nnwarchive} variables can be altered:
15917 @item nnwarchive-directory
15918 @vindex nnwarchive-directory
15919 The directory where @code{nnwarchive} stores its files. The default is@*
15920 @file{~/News/warchive/}.
15922 @item nnwarchive-login
15923 @vindex nnwarchive-login
15924 The account name on the web server.
15926 @item nnwarchive-passwd
15927 @vindex nnwarchive-passwd
15928 The password for your account on the web server.
15936 Some web sites have an RDF Site Summary (@acronym{RSS}).
15937 @acronym{RSS} is a format for summarizing headlines from news related
15938 sites (such as BBC or CNN). But basically anything list-like can be
15939 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
15940 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
15942 @acronym{RSS} has a quite regular and nice interface, and it's
15943 possible to get the information Gnus needs to keep groups updated.
15945 @kindex G R (Summary)
15946 Use @kbd{G R} from the summary buffer to subscribe to a feed---you
15947 will be prompted for the location of the feed.
15949 An easy way to get started with @code{nnrss} is to say something like
15950 the following in the group buffer: @kbd{B nnrss RET y}, then
15951 subscribe to groups.
15954 You can also use the following commands to import and export your
15955 subscriptions from a file in @acronym{OPML} format (Outline Processor
15958 @defun nnrss-opml-import file
15959 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
15963 @defun nnrss-opml-export
15964 Write your current @acronym{RSS} subscriptions to a buffer in
15965 @acronym{OPML} format.
15968 The following @code{nnrss} variables can be altered:
15971 @item nnrss-directory
15972 @vindex nnrss-directory
15973 The directory where @code{nnrss} stores its files. The default is
15974 @file{~/News/rss/}.
15976 @item nnrss-use-local
15977 @vindex nnrss-use-local
15978 @findex nnrss-generate-download-script
15979 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
15980 the feeds from local files in @code{nnrss-directory}. You can use
15981 the command @code{nnrss-generate-download-script} to generate a
15982 download script using @command{wget}.
15985 The following code may be helpful, if you want to show the description in
15986 the summary buffer.
15989 (add-to-list 'nnmail-extra-headers nnrss-description-field)
15990 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
15992 (defun gnus-user-format-function-X (header)
15994 (assq nnrss-description-field (mail-header-extra header))))
15995 (if descr (concat "\n\t" (cdr descr)) "")))
15998 The following code may be useful to open an nnrss url directly from the
16001 (require 'browse-url)
16003 (defun browse-nnrss-url( arg )
16005 (let ((url (assq nnrss-url-field
16008 (assq (gnus-summary-article-number)
16009 gnus-newsgroup-data))))))
16012 (browse-url (cdr url))
16013 (gnus-summary-mark-as-read-forward 1))
16014 (gnus-summary-scroll-up arg))))
16016 (eval-after-load "gnus"
16017 #'(define-key gnus-summary-mode-map
16018 (kbd "<RET>") 'browse-nnrss-url))
16019 (add-to-list 'nnmail-extra-headers nnrss-url-field)
16022 @node Customizing w3
16023 @subsection Customizing w3
16029 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
16030 pages. Emacs/w3 is documented in its own manual, but there are some
16031 things that may be more relevant for Gnus users.
16033 For instance, a common question is how to make Emacs/w3 follow links
16034 using the @code{browse-url} functions (which will call some external web
16035 browser like Netscape). Here's one way:
16038 (eval-after-load "w3"
16040 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
16041 (defun w3-fetch (&optional url target)
16042 (interactive (list (w3-read-url-with-default)))
16043 (if (eq major-mode 'gnus-article-mode)
16045 (w3-fetch-orig url target)))))
16048 Put that in your @file{.emacs} file, and hitting links in w3-rendered
16049 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
16056 @cindex @acronym{IMAP}
16058 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
16059 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
16060 server is much similar to connecting to a news server, you just
16061 specify the network address of the server.
16063 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
16064 everything that @acronym{POP} can, it can hence be viewed as a
16065 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
16066 similar to @acronym{NNTP} being a news storage protocol---however,
16067 @acronym{IMAP} offers more features than @acronym{NNTP} because news
16068 is more or less read-only whereas mail is read-write.
16070 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
16071 entry in @code{mail-sources}. With this, Gnus will fetch mails from
16072 the @acronym{IMAP} server and store them on the local disk. This is
16073 not the usage described in this section---@xref{Mail Sources}.
16075 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
16076 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
16077 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
16078 usage explained in this section.
16080 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
16081 servers might look something like the following. (Note that for
16082 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
16086 (setq gnus-secondary-select-methods
16087 '((nnimap "simpleserver") ; @r{no special configuration}
16088 ; @r{perhaps a ssh port forwarded server:}
16090 (nnimap-address "localhost")
16091 (nnimap-server-port 1430))
16092 ; @r{a UW server running on localhost}
16094 (nnimap-server-port 143)
16095 (nnimap-address "localhost")
16096 (nnimap-list-pattern ("INBOX" "mail/*")))
16097 ; @r{anonymous public cyrus server:}
16098 (nnimap "cyrus.andrew.cmu.edu"
16099 (nnimap-authenticator anonymous)
16100 (nnimap-list-pattern "archive.*")
16101 (nnimap-stream network))
16102 ; @r{a ssl server on a non-standard port:}
16104 (nnimap-address "vic20.somewhere.com")
16105 (nnimap-server-port 9930)
16106 (nnimap-stream ssl))))
16109 After defining the new server, you can subscribe to groups on the
16110 server using normal Gnus commands such as @kbd{U} in the Group Buffer
16111 (@pxref{Subscription Commands}) or via the Server Buffer
16112 (@pxref{Server Buffer}).
16114 The following variables can be used to create a virtual @code{nnimap}
16119 @item nnimap-address
16120 @vindex nnimap-address
16122 The address of the remote @acronym{IMAP} server. Defaults to the virtual
16123 server name if not specified.
16125 @item nnimap-server-port
16126 @vindex nnimap-server-port
16127 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
16129 Note that this should be an integer, example server specification:
16132 (nnimap "mail.server.com"
16133 (nnimap-server-port 4711))
16136 @item nnimap-list-pattern
16137 @vindex nnimap-list-pattern
16138 String or list of strings of mailboxes to limit available groups to.
16139 This is used when the server has very many mailboxes and you're only
16140 interested in a few---some servers export your home directory via
16141 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
16142 @file{~/Mail/*} then.
16144 The string can also be a cons of REFERENCE and the string as above, what
16145 REFERENCE is used for is server specific, but on the University of
16146 Washington server it's a directory that will be concatenated with the
16149 Example server specification:
16152 (nnimap "mail.server.com"
16153 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
16154 ("~friend/Mail/" . "list/*"))))
16157 @item nnimap-stream
16158 @vindex nnimap-stream
16159 The type of stream used to connect to your server. By default, nnimap
16160 will detect and automatically use all of the below, with the exception
16161 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
16162 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
16163 be automatically detected, but it's not widely deployed yet.)
16165 Example server specification:
16168 (nnimap "mail.server.com"
16169 (nnimap-stream ssl))
16172 Please note that the value of @code{nnimap-stream} is a symbol!
16176 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
16177 @samp{gsasl} or @samp{imtest} program.
16179 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
16181 @dfn{starttls:} Connect via the STARTTLS extension (similar to
16182 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
16185 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
16186 @samp{gnutls-cli}).
16188 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
16189 @samp{openssl}) or SSLeay (@samp{s_client}).
16191 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
16193 @dfn{network:} Plain, TCP/IP network connection.
16196 @vindex imap-kerberos4-program
16197 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
16198 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
16199 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
16200 to make @code{imap.el} use a pty instead of a pipe when communicating
16201 with @samp{imtest}. You will then suffer from a line length
16202 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
16203 indefinitely if you have many articles in a mailbox. The variable
16204 @code{imap-kerberos4-program} contain parameters to pass to the imtest
16207 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
16208 needed. It is available from
16209 @uref{http://www.gnu.org/software/gnutls/}.
16211 @vindex imap-gssapi-program
16212 This parameter specifies a list of command lines that invoke a GSSAPI
16213 authenticated @acronym{IMAP} stream in a subshell. They are tried
16214 sequentially until a connection is made, or the list has been
16215 exhausted. By default, @samp{gsasl} from GNU SASL, available from
16216 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
16217 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
16220 @vindex imap-ssl-program
16221 For @acronym{SSL} connections, the OpenSSL program is available from
16222 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
16223 and nnimap support it too---although the most recent versions of
16224 SSLeay, 0.9.x, are known to have serious bugs making it
16225 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
16226 work. The variable @code{imap-ssl-program} contain parameters to pass
16229 @vindex imap-shell-program
16230 @vindex imap-shell-host
16231 For @acronym{IMAP} connections using the @code{shell} stream, the variable
16232 @code{imap-shell-program} specify what program to call.
16234 @item nnimap-authenticator
16235 @vindex nnimap-authenticator
16237 The authenticator used to connect to the server. By default, nnimap
16238 will use the most secure authenticator your server is capable of.
16240 Example server specification:
16243 (nnimap "mail.server.com"
16244 (nnimap-authenticator anonymous))
16247 Please note that the value of @code{nnimap-authenticator} is a symbol!
16251 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
16252 external program @code{gsasl} or @code{imtest}.
16254 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
16257 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
16258 external library @code{digest-md5.el}.
16260 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
16262 @dfn{login:} Plain-text username/password via LOGIN.
16264 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
16267 @item nnimap-expunge-on-close
16269 @vindex nnimap-expunge-on-close
16270 Unlike Parmenides the @acronym{IMAP} designers have decided things that
16271 don't exist actually do exist. More specifically, @acronym{IMAP} has
16272 this concept of marking articles @code{Deleted} which doesn't actually
16273 delete them, and this (marking them @code{Deleted}, that is) is what
16274 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
16277 Since the articles aren't really removed when we mark them with the
16278 @code{Deleted} flag we'll need a way to actually delete them. Feel like
16279 running in circles yet?
16281 Traditionally, nnimap has removed all articles marked as @code{Deleted}
16282 when closing a mailbox but this is now configurable by this server
16285 The possible options are:
16290 The default behavior, delete all articles marked as ``Deleted'' when
16293 Never actually delete articles. Currently there is no way of showing
16294 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
16295 may allow you to do this. If you ever want to run the EXPUNGE command
16296 manually, @xref{Expunging mailboxes}.
16298 When closing mailboxes, nnimap will ask if you wish to expunge deleted
16303 @item nnimap-importantize-dormant
16304 @vindex nnimap-importantize-dormant
16306 If non-@code{nil} (the default), marks dormant articles as ticked (as
16307 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
16308 naturally still (only) be marked as dormant. This is to make dormant
16309 articles stand out, just like ticked articles, in other @acronym{IMAP}
16310 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
16313 Probably the only reason for frobing this would be if you're trying
16314 enable per-user persistent dormant flags, using something like:
16317 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
16318 (format "gnus-dormant-%s" (user-login-name)))
16319 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
16320 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
16323 In this case, you would not want the per-user dormant flag showing up
16324 as ticked for other users.
16326 @item nnimap-expunge-search-string
16328 @vindex nnimap-expunge-search-string
16330 This variable contain the @acronym{IMAP} search command sent to server when
16331 searching for articles eligible for expiring. The default is
16332 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
16333 UID set and the second @code{%s} is replaced by a date.
16335 Probably the only useful value to change this to is
16336 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
16337 messages instead of the internal article date. See section 6.4.4 of
16338 RFC 2060 for more information on valid strings.
16340 @item nnimap-authinfo-file
16341 @vindex nnimap-authinfo-file
16343 A file containing credentials used to log in on servers. The format is
16344 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
16345 variable @code{nntp-authinfo-file} for exact syntax; also see
16348 @item nnimap-need-unselect-to-notice-new-mail
16349 @vindex nnimap-need-unselect-to-notice-new-mail
16351 Unselect mailboxes before looking for new mail in them. Some servers
16352 seem to need this under some circumstances; it was reported that
16358 * Splitting in IMAP:: Splitting mail with nnimap.
16359 * Expiring in IMAP:: Expiring mail with nnimap.
16360 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
16361 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
16362 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
16363 * Debugging IMAP:: What to do when things don't work.
16368 @node Splitting in IMAP
16369 @subsection Splitting in IMAP
16370 @cindex splitting imap mail
16372 Splitting is something Gnus users have loved and used for years, and now
16373 the rest of the world is catching up. Yeah, dream on, not many
16374 @acronym{IMAP} servers have server side splitting and those that have
16375 splitting seem to use some non-standard protocol. This means that
16376 @acronym{IMAP} support for Gnus has to do its own splitting.
16380 (Incidentally, people seem to have been dreaming on, and Sieve has
16381 gaining a market share and is supported by several IMAP servers.
16382 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
16384 Here are the variables of interest:
16388 @item nnimap-split-crosspost
16389 @cindex splitting, crosspost
16391 @vindex nnimap-split-crosspost
16393 If non-@code{nil}, do crossposting if several split methods match the
16394 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
16395 found will be used.
16397 Nnmail equivalent: @code{nnmail-crosspost}.
16399 @item nnimap-split-inbox
16400 @cindex splitting, inbox
16402 @vindex nnimap-split-inbox
16404 A string or a list of strings that gives the name(s) of @acronym{IMAP}
16405 mailboxes to split from. Defaults to @code{nil}, which means that
16406 splitting is disabled!
16409 (setq nnimap-split-inbox
16410 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
16413 No nnmail equivalent.
16415 @item nnimap-split-rule
16416 @cindex splitting, rules
16417 @vindex nnimap-split-rule
16419 New mail found in @code{nnimap-split-inbox} will be split according to
16422 This variable contains a list of lists, where the first element in the
16423 sublist gives the name of the @acronym{IMAP} mailbox to move articles
16424 matching the regexp in the second element in the sublist. Got that?
16425 Neither did I, we need examples.
16428 (setq nnimap-split-rule
16430 "^Sender: owner-nnimap@@vic20.globalcom.se")
16431 ("INBOX.junk" "^Subject:.*MAKE MONEY")
16432 ("INBOX.private" "")))
16435 This will put all articles from the nnimap mailing list into mailbox
16436 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
16437 into INBOX.junk and everything else in INBOX.private.
16439 The first string may contain @samp{\\1} forms, like the ones used by
16440 replace-match to insert sub-expressions from the matched text. For
16444 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
16447 The first element can also be the symbol @code{junk} to indicate that
16448 matching messages should simply be deleted. Use with care.
16450 The second element can also be a function. In that case, it will be
16451 called with the first element of the rule as the argument, in a buffer
16452 containing the headers of the article. It should return a
16453 non-@code{nil} value if it thinks that the mail belongs in that group.
16455 Nnmail users might recollect that the last regexp had to be empty to
16456 match all articles (like in the example above). This is not required in
16457 nnimap. Articles not matching any of the regexps will not be moved out
16458 of your inbox. (This might affect performance if you keep lots of
16459 unread articles in your inbox, since the splitting code would go over
16460 them every time you fetch new mail.)
16462 These rules are processed from the beginning of the alist toward the
16463 end. The first rule to make a match will ``win'', unless you have
16464 crossposting enabled. In that case, all matching rules will ``win''.
16466 This variable can also have a function as its value, the function will
16467 be called with the headers narrowed and should return a group where it
16468 thinks the article should be split to. See @code{nnimap-split-fancy}.
16470 The splitting code tries to create mailboxes if it needs to.
16472 To allow for different split rules on different virtual servers, and
16473 even different split rules in different inboxes on the same server,
16474 the syntax of this variable have been extended along the lines of:
16477 (setq nnimap-split-rule
16478 '(("my1server" (".*" (("ding" "ding@@gnus.org")
16479 ("junk" "From:.*Simon"))))
16480 ("my2server" ("INBOX" nnimap-split-fancy))
16481 ("my[34]server" (".*" (("private" "To:.*Simon")
16482 ("junk" my-junk-func))))))
16485 The virtual server name is in fact a regexp, so that the same rules
16486 may apply to several servers. In the example, the servers
16487 @code{my3server} and @code{my4server} both use the same rules.
16488 Similarly, the inbox string is also a regexp. The actual splitting
16489 rules are as before, either a function, or a list with group/regexp or
16490 group/function elements.
16492 Nnmail equivalent: @code{nnmail-split-methods}.
16494 @item nnimap-split-predicate
16496 @vindex nnimap-split-predicate
16498 Mail matching this predicate in @code{nnimap-split-inbox} will be
16499 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
16501 This might be useful if you use another @acronym{IMAP} client to read mail in
16502 your inbox but would like Gnus to split all articles in the inbox
16503 regardless of readedness. Then you might change this to
16506 @item nnimap-split-fancy
16507 @cindex splitting, fancy
16508 @findex nnimap-split-fancy
16509 @vindex nnimap-split-fancy
16511 It's possible to set @code{nnimap-split-rule} to
16512 @code{nnmail-split-fancy} if you want to use fancy
16513 splitting. @xref{Fancy Mail Splitting}.
16515 However, to be able to have different fancy split rules for nnmail and
16516 nnimap back ends you can set @code{nnimap-split-rule} to
16517 @code{nnimap-split-fancy} and define the nnimap specific fancy split
16518 rule in @code{nnimap-split-fancy}.
16523 (setq nnimap-split-rule 'nnimap-split-fancy
16524 nnimap-split-fancy ...)
16527 Nnmail equivalent: @code{nnmail-split-fancy}.
16529 @item nnimap-split-download-body
16530 @findex nnimap-split-download-body
16531 @vindex nnimap-split-download-body
16533 Set to non-@code{nil} to download entire articles during splitting.
16534 This is generally not required, and will slow things down
16535 considerably. You may need it if you want to use an advanced
16536 splitting function that analyses the body to split the article.
16540 @node Expiring in IMAP
16541 @subsection Expiring in IMAP
16542 @cindex expiring imap mail
16544 Even though @code{nnimap} is not a proper @code{nnmail} derived back
16545 end, it supports most features in regular expiring (@pxref{Expiring
16546 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
16547 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
16548 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
16549 follows below are the variables used by the @code{nnimap} expiry
16552 A note on how the expire mark is stored on the @acronym{IMAP} server is
16553 appropriate here as well. The expire mark is translated into a
16554 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
16555 message. This means that likely only Gnus will understand and treat
16556 the @code{gnus-expire} mark properly, although other clients may allow
16557 you to view client specific flags on the message. It also means that
16558 your server must support permanent storage of client specific flags on
16559 messages. Most do, fortunately.
16563 @item nnmail-expiry-wait
16564 @item nnmail-expiry-wait-function
16566 These variables are fully supported. The expire value can be a
16567 number, the symbol @code{immediate} or @code{never}.
16569 @item nnmail-expiry-target
16571 This variable is supported, and internally implemented by calling the
16572 @code{nnmail} functions that handle this. It contains an optimization
16573 that if the destination is a @acronym{IMAP} group on the same server, the
16574 article is copied instead of appended (that is, uploaded again).
16578 @node Editing IMAP ACLs
16579 @subsection Editing IMAP ACLs
16580 @cindex editing imap acls
16581 @cindex Access Control Lists
16582 @cindex Editing @acronym{IMAP} ACLs
16583 @kindex G l (Group)
16584 @findex gnus-group-nnimap-edit-acl
16586 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
16587 limiting (or enabling) other users access to your mail boxes. Not all
16588 @acronym{IMAP} servers support this, this function will give an error if it
16591 To edit an ACL for a mailbox, type @kbd{G l}
16592 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
16593 editing window with detailed instructions.
16595 Some possible uses:
16599 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
16600 on your mailing list mailboxes enables other users on the same server to
16601 follow the list without subscribing to it.
16603 At least with the Cyrus server, you are required to give the user
16604 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
16605 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
16609 @node Expunging mailboxes
16610 @subsection Expunging mailboxes
16614 @cindex manual expunging
16615 @kindex G x (Group)
16616 @findex gnus-group-nnimap-expunge
16618 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
16619 you may want the option of expunging all deleted articles in a mailbox
16620 manually. This is exactly what @kbd{G x} does.
16622 Currently there is no way of showing deleted articles, you can just
16625 @node A note on namespaces
16626 @subsection A note on namespaces
16627 @cindex IMAP namespace
16630 The @acronym{IMAP} protocol has a concept called namespaces, described
16631 by the following text in the RFC:
16634 5.1.2. Mailbox Namespace Naming Convention
16636 By convention, the first hierarchical element of any mailbox name
16637 which begins with "#" identifies the "namespace" of the remainder of
16638 the name. This makes it possible to disambiguate between different
16639 types of mailbox stores, each of which have their own namespaces.
16641 For example, implementations which offer access to USENET
16642 newsgroups MAY use the "#news" namespace to partition the USENET
16643 newsgroup namespace from that of other mailboxes. Thus, the
16644 comp.mail.misc newsgroup would have an mailbox name of
16645 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
16646 to a different object (e.g. a user's private mailbox).
16649 While there is nothing in this text that warrants concern for the
16650 @acronym{IMAP} implementation in Gnus, some servers use namespace
16651 prefixes in a way that does not work with how Gnus uses mailbox names.
16653 Specifically, University of Washington's @acronym{IMAP} server uses
16654 mailbox names like @code{#driver.mbx/read-mail} which are valid only
16655 in the @sc{create} and @sc{append} commands. After the mailbox is
16656 created (or a messages is appended to a mailbox), it must be accessed
16657 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
16658 not make it possible for the user to guarantee that user entered
16659 mailbox names will only be used with the CREATE and APPEND commands,
16660 you should simply not use the namespace prefixed mailbox names in
16663 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
16664 for more information on how to use the prefixes. They are a power
16665 tool and should be used only if you are sure what the effects are.
16667 @node Debugging IMAP
16668 @subsection Debugging IMAP
16669 @cindex IMAP debugging
16670 @cindex protocol dump (IMAP)
16672 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
16673 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
16674 best to fix them right away. If you encounter odd behaviour, chances
16675 are that either the server or Gnus is buggy.
16677 If you are familiar with network protocols in general, you will
16678 probably be able to extract some clues from the protocol dump of the
16679 exchanges between Gnus and the server. Even if you are not familiar
16680 with network protocols, when you include the protocol dump in
16681 @acronym{IMAP}-related bug reports you are helping us with data
16682 critical to solving the problem. Therefore, we strongly encourage you
16683 to include the protocol dump when reporting IMAP bugs in Gnus.
16687 Because the protocol dump, when enabled, generates lots of data, it is
16688 disabled by default. You can enable it by setting @code{imap-log} as
16695 This instructs the @code{imap.el} package to log any exchanges with
16696 the server. The log is stored in the buffer @samp{*imap-log*}. Look
16697 for error messages, which sometimes are tagged with the keyword
16698 @code{BAD}---but when submitting a bug, make sure to include all the
16701 @node Other Sources
16702 @section Other Sources
16704 Gnus can do more than just read news or mail. The methods described
16705 below allow Gnus to view directories and files as if they were
16709 * Directory Groups:: You can read a directory as if it was a newsgroup.
16710 * Anything Groups:: Dired? Who needs dired?
16711 * Document Groups:: Single files can be the basis of a group.
16712 * SOUP:: Reading @sc{soup} packets ``offline''.
16713 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
16717 @node Directory Groups
16718 @subsection Directory Groups
16720 @cindex directory groups
16722 If you have a directory that has lots of articles in separate files in
16723 it, you might treat it as a newsgroup. The files have to have numerical
16726 This might be an opportune moment to mention @code{ange-ftp} (and its
16727 successor @code{efs}), that most wonderful of all wonderful Emacs
16728 packages. When I wrote @code{nndir}, I didn't think much about it---a
16729 back end to read directories. Big deal.
16731 @code{ange-ftp} changes that picture dramatically. For instance, if you
16732 enter the @code{ange-ftp} file name
16733 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
16734 @code{ange-ftp} or @code{efs} will actually allow you to read this
16735 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
16737 @code{nndir} will use @acronym{NOV} files if they are present.
16739 @code{nndir} is a ``read-only'' back end---you can't delete or expire
16740 articles with this method. You can use @code{nnmh} or @code{nnml} for
16741 whatever you use @code{nndir} for, so you could switch to any of those
16742 methods if you feel the need to have a non-read-only @code{nndir}.
16745 @node Anything Groups
16746 @subsection Anything Groups
16749 From the @code{nndir} back end (which reads a single spool-like
16750 directory), it's just a hop and a skip to @code{nneething}, which
16751 pretends that any arbitrary directory is a newsgroup. Strange, but
16754 When @code{nneething} is presented with a directory, it will scan this
16755 directory and assign article numbers to each file. When you enter such
16756 a group, @code{nneething} must create ``headers'' that Gnus can use.
16757 After all, Gnus is a newsreader, in case you're forgetting.
16758 @code{nneething} does this in a two-step process. First, it snoops each
16759 file in question. If the file looks like an article (i.e., the first
16760 few lines look like headers), it will use this as the head. If this is
16761 just some arbitrary file without a head (e.g. a C source file),
16762 @code{nneething} will cobble up a header out of thin air. It will use
16763 file ownership, name and date and do whatever it can with these
16766 All this should happen automatically for you, and you will be presented
16767 with something that looks very much like a newsgroup. Totally like a
16768 newsgroup, to be precise. If you select an article, it will be displayed
16769 in the article buffer, just as usual.
16771 If you select a line that represents a directory, Gnus will pop you into
16772 a new summary buffer for this @code{nneething} group. And so on. You can
16773 traverse the entire disk this way, if you feel like, but remember that
16774 Gnus is not dired, really, and does not intend to be, either.
16776 There are two overall modes to this action---ephemeral or solid. When
16777 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
16778 will not store information on what files you have read, and what files
16779 are new, and so on. If you create a solid @code{nneething} group the
16780 normal way with @kbd{G m}, Gnus will store a mapping table between
16781 article numbers and file names, and you can treat this group like any
16782 other groups. When you activate a solid @code{nneething} group, you will
16783 be told how many unread articles it contains, etc., etc.
16788 @item nneething-map-file-directory
16789 @vindex nneething-map-file-directory
16790 All the mapping files for solid @code{nneething} groups will be stored
16791 in this directory, which defaults to @file{~/.nneething/}.
16793 @item nneething-exclude-files
16794 @vindex nneething-exclude-files
16795 All files that match this regexp will be ignored. Nice to use to exclude
16796 auto-save files and the like, which is what it does by default.
16798 @item nneething-include-files
16799 @vindex nneething-include-files
16800 Regexp saying what files to include in the group. If this variable is
16801 non-@code{nil}, only files matching this regexp will be included.
16803 @item nneething-map-file
16804 @vindex nneething-map-file
16805 Name of the map files.
16809 @node Document Groups
16810 @subsection Document Groups
16812 @cindex documentation group
16815 @code{nndoc} is a cute little thing that will let you read a single file
16816 as a newsgroup. Several files types are supported:
16823 The Babyl (Rmail) mail box.
16828 The standard Unix mbox file.
16830 @cindex MMDF mail box
16832 The MMDF mail box format.
16835 Several news articles appended into a file.
16838 @cindex rnews batch files
16839 The rnews batch transport format.
16840 @cindex forwarded messages
16843 Forwarded articles.
16846 Netscape mail boxes.
16849 @acronym{MIME} multipart messages.
16851 @item standard-digest
16852 The standard (RFC 1153) digest format.
16855 A @acronym{MIME} digest of messages.
16857 @item lanl-gov-announce
16858 Announcement messages from LANL Gov Announce.
16860 @item rfc822-forward
16861 A message forwarded according to RFC822.
16864 The Outlook mail box.
16867 The Outlook Express dbx mail box.
16870 A bounce message from the Exim MTA.
16873 A message forwarded according to informal rules.
16876 An RFC934-forwarded message.
16882 A digest of Clarinet brief news items.
16885 Non-standard digest format---matches most things, but does it badly.
16891 You can also use the special ``file type'' @code{guess}, which means
16892 that @code{nndoc} will try to guess what file type it is looking at.
16893 @code{digest} means that @code{nndoc} should guess what digest type the
16896 @code{nndoc} will not try to change the file or insert any extra headers into
16897 it---it will simply, like, let you use the file as the basis for a
16898 group. And that's it.
16900 If you have some old archived articles that you want to insert into your
16901 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
16902 that. Say you have an old @file{RMAIL} file with mail that you now want
16903 to split into your new @code{nnml} groups. You look at that file using
16904 @code{nndoc} (using the @kbd{G f} command in the group buffer
16905 (@pxref{Foreign Groups})), set the process mark on all the articles in
16906 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
16907 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
16908 file is now also stored in lots of @code{nnml} directories, and you can
16909 delete that pesky @file{RMAIL} file. If you have the guts!
16911 Virtual server variables:
16914 @item nndoc-article-type
16915 @vindex nndoc-article-type
16916 This should be one of @code{mbox}, @code{babyl}, @code{digest},
16917 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
16918 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
16919 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
16920 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
16922 @item nndoc-post-type
16923 @vindex nndoc-post-type
16924 This variable says whether Gnus is to consider the group a news group or
16925 a mail group. There are two valid values: @code{mail} (the default)
16930 * Document Server Internals:: How to add your own document types.
16934 @node Document Server Internals
16935 @subsubsection Document Server Internals
16937 Adding new document types to be recognized by @code{nndoc} isn't
16938 difficult. You just have to whip up a definition of what the document
16939 looks like, write a predicate function to recognize that document type,
16940 and then hook into @code{nndoc}.
16942 First, here's an example document type definition:
16946 (article-begin . "^\^A\^A\^A\^A\n")
16947 (body-end . "^\^A\^A\^A\^A\n"))
16950 The definition is simply a unique @dfn{name} followed by a series of
16951 regexp pseudo-variable settings. Below are the possible
16952 variables---don't be daunted by the number of variables; most document
16953 types can be defined with very few settings:
16956 @item first-article
16957 If present, @code{nndoc} will skip past all text until it finds
16958 something that match this regexp. All text before this will be
16961 @item article-begin
16962 This setting has to be present in all document type definitions. It
16963 says what the beginning of each article looks like.
16965 @item head-begin-function
16966 If present, this should be a function that moves point to the head of
16969 @item nndoc-head-begin
16970 If present, this should be a regexp that matches the head of the
16973 @item nndoc-head-end
16974 This should match the end of the head of the article. It defaults to
16975 @samp{^$}---the empty line.
16977 @item body-begin-function
16978 If present, this function should move point to the beginning of the body
16982 This should match the beginning of the body of the article. It defaults
16985 @item body-end-function
16986 If present, this function should move point to the end of the body of
16990 If present, this should match the end of the body of the article.
16993 If present, this should match the end of the file. All text after this
16994 regexp will be totally ignored.
16998 So, using these variables @code{nndoc} is able to dissect a document
16999 file into a series of articles, each with a head and a body. However, a
17000 few more variables are needed since not all document types are all that
17001 news-like---variables needed to transform the head or the body into
17002 something that's palatable for Gnus:
17005 @item prepare-body-function
17006 If present, this function will be called when requesting an article. It
17007 will be called with point at the start of the body, and is useful if the
17008 document has encoded some parts of its contents.
17010 @item article-transform-function
17011 If present, this function is called when requesting an article. It's
17012 meant to be used for more wide-ranging transformation of both head and
17013 body of the article.
17015 @item generate-head-function
17016 If present, this function is called to generate a head that Gnus can
17017 understand. It is called with the article number as a parameter, and is
17018 expected to generate a nice head for the article in question. It is
17019 called when requesting the headers of all articles.
17023 Let's look at the most complicated example I can come up with---standard
17028 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
17029 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
17030 (prepare-body-function . nndoc-unquote-dashes)
17031 (body-end-function . nndoc-digest-body-end)
17032 (head-end . "^ ?$")
17033 (body-begin . "^ ?\n")
17034 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
17035 (subtype digest guess))
17038 We see that all text before a 70-width line of dashes is ignored; all
17039 text after a line that starts with that @samp{^End of} is also ignored;
17040 each article begins with a 30-width line of dashes; the line separating
17041 the head from the body may contain a single space; and that the body is
17042 run through @code{nndoc-unquote-dashes} before being delivered.
17044 To hook your own document definition into @code{nndoc}, use the
17045 @code{nndoc-add-type} function. It takes two parameters---the first
17046 is the definition itself and the second (optional) parameter says
17047 where in the document type definition alist to put this definition.
17048 The alist is traversed sequentially, and
17049 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
17050 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
17051 @code{mmdf} type, and so on. These type predicates should return
17052 @code{nil} if the document is not of the correct type; @code{t} if it
17053 is of the correct type; and a number if the document might be of the
17054 correct type. A high number means high probability; a low number
17055 means low probability with @samp{0} being the lowest valid number.
17063 In the PC world people often talk about ``offline'' newsreaders. These
17064 are thingies that are combined reader/news transport monstrosities.
17065 With built-in modem programs. Yecchh!
17067 Of course, us Unix Weenie types of human beans use things like
17068 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
17069 transport things like Ghod intended. And then we just use normal
17072 However, it can sometimes be convenient to do something that's a bit
17073 easier on the brain if you have a very slow modem, and you're not really
17074 that interested in doing things properly.
17076 A file format called @sc{soup} has been developed for transporting news
17077 and mail from servers to home machines and back again. It can be a bit
17080 First some terminology:
17085 This is the machine that is connected to the outside world and where you
17086 get news and/or mail from.
17089 This is the machine that you want to do the actual reading and responding
17090 on. It is typically not connected to the rest of the world in any way.
17093 Something that contains messages and/or commands. There are two kinds
17097 @item message packets
17098 These are packets made at the server, and typically contain lots of
17099 messages for you to read. These are called @file{SoupoutX.tgz} by
17100 default, where @var{x} is a number.
17102 @item response packets
17103 These are packets made at the home machine, and typically contains
17104 replies that you've written. These are called @file{SoupinX.tgz} by
17105 default, where @var{x} is a number.
17115 You log in on the server and create a @sc{soup} packet. You can either
17116 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
17117 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
17118 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
17121 You transfer the packet home. Rail, boat, car or modem will do fine.
17124 You put the packet in your home directory.
17127 You fire up Gnus on your home machine using the @code{nnsoup} back end as
17128 the native or secondary server.
17131 You read articles and mail and answer and followup to the things you
17132 want (@pxref{SOUP Replies}).
17135 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
17139 You transfer this packet to the server.
17142 You use Gnus to mail this packet out with the @kbd{G s s} command.
17145 You then repeat until you die.
17149 So you basically have a bipartite system---you use @code{nnsoup} for
17150 reading and Gnus for packing/sending these @sc{soup} packets.
17153 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
17154 * SOUP Groups:: A back end for reading @sc{soup} packets.
17155 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
17159 @node SOUP Commands
17160 @subsubsection SOUP Commands
17162 These are commands for creating and manipulating @sc{soup} packets.
17166 @kindex G s b (Group)
17167 @findex gnus-group-brew-soup
17168 Pack all unread articles in the current group
17169 (@code{gnus-group-brew-soup}). This command understands the
17170 process/prefix convention.
17173 @kindex G s w (Group)
17174 @findex gnus-soup-save-areas
17175 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
17178 @kindex G s s (Group)
17179 @findex gnus-soup-send-replies
17180 Send all replies from the replies packet
17181 (@code{gnus-soup-send-replies}).
17184 @kindex G s p (Group)
17185 @findex gnus-soup-pack-packet
17186 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
17189 @kindex G s r (Group)
17190 @findex nnsoup-pack-replies
17191 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
17194 @kindex O s (Summary)
17195 @findex gnus-soup-add-article
17196 This summary-mode command adds the current article to a @sc{soup} packet
17197 (@code{gnus-soup-add-article}). It understands the process/prefix
17198 convention (@pxref{Process/Prefix}).
17203 There are a few variables to customize where Gnus will put all these
17208 @item gnus-soup-directory
17209 @vindex gnus-soup-directory
17210 Directory where Gnus will save intermediate files while composing
17211 @sc{soup} packets. The default is @file{~/SoupBrew/}.
17213 @item gnus-soup-replies-directory
17214 @vindex gnus-soup-replies-directory
17215 This is what Gnus will use as a temporary directory while sending our
17216 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
17218 @item gnus-soup-prefix-file
17219 @vindex gnus-soup-prefix-file
17220 Name of the file where Gnus stores the last used prefix. The default is
17221 @samp{gnus-prefix}.
17223 @item gnus-soup-packer
17224 @vindex gnus-soup-packer
17225 A format string command for packing a @sc{soup} packet. The default is
17226 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
17228 @item gnus-soup-unpacker
17229 @vindex gnus-soup-unpacker
17230 Format string command for unpacking a @sc{soup} packet. The default is
17231 @samp{gunzip -c %s | tar xvf -}.
17233 @item gnus-soup-packet-directory
17234 @vindex gnus-soup-packet-directory
17235 Where Gnus will look for reply packets. The default is @file{~/}.
17237 @item gnus-soup-packet-regexp
17238 @vindex gnus-soup-packet-regexp
17239 Regular expression matching @sc{soup} reply packets in
17240 @code{gnus-soup-packet-directory}.
17246 @subsubsection SOUP Groups
17249 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
17250 read incoming packets, unpack them, and put them in a directory where
17251 you can read them at leisure.
17253 These are the variables you can use to customize its behavior:
17257 @item nnsoup-tmp-directory
17258 @vindex nnsoup-tmp-directory
17259 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
17260 directory. (@file{/tmp/} by default.)
17262 @item nnsoup-directory
17263 @vindex nnsoup-directory
17264 @code{nnsoup} then moves each message and index file to this directory.
17265 The default is @file{~/SOUP/}.
17267 @item nnsoup-replies-directory
17268 @vindex nnsoup-replies-directory
17269 All replies will be stored in this directory before being packed into a
17270 reply packet. The default is @file{~/SOUP/replies/}.
17272 @item nnsoup-replies-format-type
17273 @vindex nnsoup-replies-format-type
17274 The @sc{soup} format of the replies packets. The default is @samp{?n}
17275 (rnews), and I don't think you should touch that variable. I probably
17276 shouldn't even have documented it. Drats! Too late!
17278 @item nnsoup-replies-index-type
17279 @vindex nnsoup-replies-index-type
17280 The index type of the replies packet. The default is @samp{?n}, which
17281 means ``none''. Don't fiddle with this one either!
17283 @item nnsoup-active-file
17284 @vindex nnsoup-active-file
17285 Where @code{nnsoup} stores lots of information. This is not an ``active
17286 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
17287 this file or mess it up in any way, you're dead. The default is
17288 @file{~/SOUP/active}.
17290 @item nnsoup-packer
17291 @vindex nnsoup-packer
17292 Format string command for packing a reply @sc{soup} packet. The default
17293 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
17295 @item nnsoup-unpacker
17296 @vindex nnsoup-unpacker
17297 Format string command for unpacking incoming @sc{soup} packets. The
17298 default is @samp{gunzip -c %s | tar xvf -}.
17300 @item nnsoup-packet-directory
17301 @vindex nnsoup-packet-directory
17302 Where @code{nnsoup} will look for incoming packets. The default is
17305 @item nnsoup-packet-regexp
17306 @vindex nnsoup-packet-regexp
17307 Regular expression matching incoming @sc{soup} packets. The default is
17310 @item nnsoup-always-save
17311 @vindex nnsoup-always-save
17312 If non-@code{nil}, save the replies buffer after each posted message.
17318 @subsubsection SOUP Replies
17320 Just using @code{nnsoup} won't mean that your postings and mailings end
17321 up in @sc{soup} reply packets automagically. You have to work a bit
17322 more for that to happen.
17324 @findex nnsoup-set-variables
17325 The @code{nnsoup-set-variables} command will set the appropriate
17326 variables to ensure that all your followups and replies end up in the
17329 In specific, this is what it does:
17332 (setq message-send-news-function 'nnsoup-request-post)
17333 (setq message-send-mail-function 'nnsoup-request-mail)
17336 And that's it, really. If you only want news to go into the @sc{soup}
17337 system you just use the first line. If you only want mail to be
17338 @sc{soup}ed you use the second.
17341 @node Mail-To-News Gateways
17342 @subsection Mail-To-News Gateways
17343 @cindex mail-to-news gateways
17346 If your local @code{nntp} server doesn't allow posting, for some reason
17347 or other, you can post using one of the numerous mail-to-news gateways.
17348 The @code{nngateway} back end provides the interface.
17350 Note that you can't read anything from this back end---it can only be
17356 @item nngateway-address
17357 @vindex nngateway-address
17358 This is the address of the mail-to-news gateway.
17360 @item nngateway-header-transformation
17361 @vindex nngateway-header-transformation
17362 News headers often have to be transformed in some odd way or other
17363 for the mail-to-news gateway to accept it. This variable says what
17364 transformation should be called, and defaults to
17365 @code{nngateway-simple-header-transformation}. The function is called
17366 narrowed to the headers to be transformed and with one parameter---the
17369 This default function just inserts a new @code{To} header based on the
17370 @code{Newsgroups} header and the gateway address.
17371 For instance, an article with this @code{Newsgroups} header:
17374 Newsgroups: alt.religion.emacs
17377 will get this @code{To} header inserted:
17380 To: alt-religion-emacs@@GATEWAY
17383 The following pre-defined functions exist:
17385 @findex nngateway-simple-header-transformation
17388 @item nngateway-simple-header-transformation
17389 Creates a @code{To} header that looks like
17390 @var{newsgroup}@@@code{nngateway-address}.
17392 @findex nngateway-mail2news-header-transformation
17394 @item nngateway-mail2news-header-transformation
17395 Creates a @code{To} header that looks like
17396 @code{nngateway-address}.
17404 (setq gnus-post-method
17406 "mail2news@@replay.com"
17407 (nngateway-header-transformation
17408 nngateway-mail2news-header-transformation)))
17411 So, to use this, simply say something like:
17414 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17419 @node Combined Groups
17420 @section Combined Groups
17422 Gnus allows combining a mixture of all the other group types into bigger
17426 * Virtual Groups:: Combining articles from many groups.
17427 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
17431 @node Virtual Groups
17432 @subsection Virtual Groups
17434 @cindex virtual groups
17435 @cindex merging groups
17437 An @dfn{nnvirtual group} is really nothing more than a collection of
17440 For instance, if you are tired of reading many small groups, you can
17441 put them all in one big group, and then grow tired of reading one
17442 big, unwieldy group. The joys of computing!
17444 You specify @code{nnvirtual} as the method. The address should be a
17445 regexp to match component groups.
17447 All marks in the virtual group will stick to the articles in the
17448 component groups. So if you tick an article in a virtual group, the
17449 article will also be ticked in the component group from whence it
17450 came. (And vice versa---marks from the component groups will also be
17451 shown in the virtual group.). To create an empty virtual group, run
17452 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17453 and edit the method regexp with @kbd{M-e}
17454 (@code{gnus-group-edit-group-method})
17456 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17457 newsgroups into one, big, happy newsgroup:
17460 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17463 The component groups can be native or foreign; everything should work
17464 smoothly, but if your computer explodes, it was probably my fault.
17466 Collecting the same group from several servers might actually be a good
17467 idea if users have set the Distribution header to limit distribution.
17468 If you would like to read @samp{soc.motss} both from a server in Japan
17469 and a server in Norway, you could use the following as the group regexp:
17472 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17475 (Remember, though, that if you're creating the group with @kbd{G m}, you
17476 shouldn't double the backslashes, and you should leave off the quote
17477 characters at the beginning and the end of the string.)
17479 This should work kinda smoothly---all articles from both groups should
17480 end up in this one, and there should be no duplicates. Threading (and
17481 the rest) will still work as usual, but there might be problems with the
17482 sequence of articles. Sorting on date might be an option here
17483 (@pxref{Selecting a Group}).
17485 One limitation, however---all groups included in a virtual
17486 group have to be alive (i.e., subscribed or unsubscribed). Killed or
17487 zombie groups can't be component groups for @code{nnvirtual} groups.
17489 @vindex nnvirtual-always-rescan
17490 If the @code{nnvirtual-always-rescan} is non-@code{nil},
17491 @code{nnvirtual} will always scan groups for unread articles when
17492 entering a virtual group. If this variable is @code{nil} (which is the
17493 default) and you read articles in a component group after the virtual
17494 group has been activated, the read articles from the component group
17495 will show up when you enter the virtual group. You'll also see this
17496 effect if you have two virtual groups that have a component group in
17497 common. If that's the case, you should set this variable to @code{t}.
17498 Or you can just tap @code{M-g} on the virtual group every time before
17499 you enter it---it'll have much the same effect.
17501 @code{nnvirtual} can have both mail and news groups as component groups.
17502 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17503 has to ask the back end of the component group the article comes from
17504 whether it is a news or mail back end. However, when you do a @kbd{^},
17505 there is typically no sure way for the component back end to know this,
17506 and in that case @code{nnvirtual} tells Gnus that the article came from a
17507 not-news back end. (Just to be on the safe side.)
17509 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17510 line from the article you respond to in these cases.
17512 @code{nnvirtual} groups do not inherit anything but articles and marks
17513 from component groups---group parameters, for instance, are not
17517 @node Kibozed Groups
17518 @subsection Kibozed Groups
17522 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
17523 (parts of) the news feed''. @code{nnkiboze} is a back end that will
17524 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
17525 down to a halt with useless requests! Oh happiness!
17527 @kindex G k (Group)
17528 To create a kibozed group, use the @kbd{G k} command in the group
17531 The address field of the @code{nnkiboze} method is, as with
17532 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
17533 @code{nnkiboze} group. That's where most similarities between
17534 @code{nnkiboze} and @code{nnvirtual} end.
17536 In addition to this regexp detailing component groups, an
17537 @code{nnkiboze} group must have a score file to say what articles are
17538 to be included in the group (@pxref{Scoring}).
17540 @kindex M-x nnkiboze-generate-groups
17541 @findex nnkiboze-generate-groups
17542 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
17543 @code{nnkiboze} groups you want to have. This command will take time.
17544 Lots of time. Oodles and oodles of time. Gnus has to fetch the
17545 headers from all the articles in all the component groups and run them
17546 through the scoring process to determine if there are any articles in
17547 the groups that are to be part of the @code{nnkiboze} groups.
17549 Please limit the number of component groups by using restrictive
17550 regexps. Otherwise your sysadmin may become annoyed with you, and the
17551 @acronym{NNTP} site may throw you off and never let you back in again.
17552 Stranger things have happened.
17554 @code{nnkiboze} component groups do not have to be alive---they can be dead,
17555 and they can be foreign. No restrictions.
17557 @vindex nnkiboze-directory
17558 The generation of an @code{nnkiboze} group means writing two files in
17559 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
17560 One contains the @acronym{NOV} header lines for all the articles in
17561 the group, and the other is an additional @file{.newsrc} file to store
17562 information on what groups have been searched through to find
17563 component articles.
17565 Articles marked as read in the @code{nnkiboze} group will have
17566 their @acronym{NOV} lines removed from the @acronym{NOV} file.
17569 @node Gnus Unplugged
17570 @section Gnus Unplugged
17575 @cindex Gnus unplugged
17577 In olden times (ca. February '88), people used to run their newsreaders
17578 on big machines with permanent connections to the net. News transport
17579 was dealt with by news servers, and all the newsreaders had to do was to
17580 read news. Believe it or not.
17582 Nowadays most people read news and mail at home, and use some sort of
17583 modem to connect to the net. To avoid running up huge phone bills, it
17584 would be nice to have a way to slurp down all the news and mail, hang up
17585 the phone, read for several hours, and then upload any responses you
17586 have to make. And then you repeat the procedure.
17588 Of course, you can use news servers for doing this as well. I've used
17589 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
17590 for some years, but doing that's a bore. Moving the news server
17591 functionality up to the newsreader makes sense if you're the only person
17592 reading news on a machine.
17594 Setting up Gnus as an ``offline'' newsreader is quite simple. In
17595 fact, you don't have to configure anything as the agent is now enabled
17596 by default (@pxref{Agent Variables, gnus-agent}).
17598 Of course, to use it as such, you have to learn a few new commands.
17601 * Agent Basics:: How it all is supposed to work.
17602 * Agent Categories:: How to tell the Gnus Agent what to download.
17603 * Agent Commands:: New commands for all the buffers.
17604 * Agent Visuals:: Ways that the agent may effect your summary buffer.
17605 * Agent as Cache:: The Agent is a big cache too.
17606 * Agent Expiry:: How to make old articles go away.
17607 * Agent Regeneration:: How to recover from lost connections and other accidents.
17608 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
17609 * Outgoing Messages:: What happens when you post/mail something?
17610 * Agent Variables:: Customizing is fun.
17611 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
17612 * Batching Agents:: How to fetch news from a @code{cron} job.
17613 * Agent Caveats:: What you think it'll do and what it does.
17618 @subsection Agent Basics
17620 First, let's get some terminology out of the way.
17622 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
17623 connection to the net (and notified the Agent that this is the case).
17624 When the connection to the net is up again (and Gnus knows this), the
17625 Agent is @dfn{plugged}.
17627 The @dfn{local} machine is the one you're running on, and which isn't
17628 connected to the net continuously.
17630 @dfn{Downloading} means fetching things from the net to your local
17631 machine. @dfn{Uploading} is doing the opposite.
17633 You know that Gnus gives you all the opportunity you'd ever want for
17634 shooting yourself in the foot. Some people call it flexibility. Gnus
17635 is also customizable to a great extent, which means that the user has a
17636 say on how Gnus behaves. Other newsreaders might unconditionally shoot
17637 you in your foot, but with Gnus, you have a choice!
17639 Gnus is never really in plugged or unplugged state. Rather, it applies
17640 that state to each server individually. This means that some servers
17641 can be plugged while others can be unplugged. Additionally, some
17642 servers can be ignored by the Agent altogether (which means that
17643 they're kinda like plugged always).
17645 So when you unplug the Agent and then wonder why is Gnus opening a
17646 connection to the Net, the next step to do is to look whether all
17647 servers are agentized. If there is an unagentized server, you found
17650 Another thing is the @dfn{offline} state. Sometimes, servers aren't
17651 reachable. When Gnus notices this, it asks you whether you want the
17652 server to be switched to offline state. If you say yes, then the
17653 server will behave somewhat as if it was unplugged, except that Gnus
17654 will ask you whether you want to switch it back online again.
17656 Let's take a typical Gnus session using the Agent.
17661 @findex gnus-unplugged
17662 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
17663 Agent in a disconnected state. You can read all the news that you have
17664 already fetched while in this mode.
17667 You then decide to see whether any new news has arrived. You connect
17668 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
17669 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
17670 as usual. To check for new mail in unplugged mode (@pxref{Mail
17671 Source Specifiers}).
17674 You can then read the new news immediately, or you can download the
17675 news onto your local machine. If you want to do the latter, you press
17676 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
17677 all the eligible articles in all the groups. (To let Gnus know which
17678 articles you want to download, @pxref{Agent Categories}).
17681 After fetching the articles, you press @kbd{J j} to make Gnus become
17682 unplugged again, and you shut down the PPP thing (or whatever). And
17683 then you read the news offline.
17686 And then you go to step 2.
17689 Here are some things you should do the first time (or so) that you use
17695 Decide which servers should be covered by the Agent. If you have a mail
17696 back end, it would probably be nonsensical to have it covered by the
17697 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
17698 @kbd{J a} on the server (or servers) that you wish to have covered by the
17699 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
17700 added servers you do not wish to have covered by the Agent. By default,
17701 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
17702 @code{gnus-secondary-select-methods} are agentized.
17705 Decide on download policy. It's fairly simple once you decide whether
17706 you are going to use agent categories, topic parameters, and/or group
17707 parameters to implement your policy. If you're new to gnus, it
17708 is probably best to start with a category, @xref{Agent Categories}.
17710 Both topic parameters (@pxref{Topic Parameters}) and agent categories
17711 (@pxref{Agent Categories}) provide for setting a policy that applies
17712 to multiple groups. Which you use is entirely up to you. Topic
17713 parameters do override categories so, if you mix the two, you'll have
17714 to take that into account. If you have a few groups that deviate from
17715 your policy, you can use group parameters (@pxref{Group Parameters}) to
17719 Uhm@dots{} that's it.
17723 @node Agent Categories
17724 @subsection Agent Categories
17726 One of the main reasons to integrate the news transport layer into the
17727 newsreader is to allow greater control over what articles to download.
17728 There's not much point in downloading huge amounts of articles, just to
17729 find out that you're not interested in reading any of them. It's better
17730 to be somewhat more conservative in choosing what to download, and then
17731 mark the articles for downloading manually if it should turn out that
17732 you're interested in the articles anyway.
17734 One of the more effective methods for controlling what is to be
17735 downloaded is to create a @dfn{category} and then assign some (or all)
17736 groups to this category. Groups that do not belong in any other
17737 category belong to the @code{default} category. Gnus has its own
17738 buffer for creating and managing categories.
17740 If you prefer, you can also use group parameters (@pxref{Group
17741 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
17742 alternative approach to controlling the agent. The only real
17743 difference is that categories are specific to the agent (so there is
17744 less to learn) while group and topic parameters include the kitchen
17747 Since you can set agent parameters in several different places we have
17748 a rule to decide which source to believe. This rule specifies that
17749 the parameter sources are checked in the following order: group
17750 parameters, topic parameters, agent category, and finally customizable
17751 variables. So you can mix all of these sources to produce a wide range
17752 of behavior, just don't blame me if you don't remember where you put
17756 * Category Syntax:: What a category looks like.
17757 * Category Buffer:: A buffer for maintaining categories.
17758 * Category Variables:: Customize'r'Us.
17762 @node Category Syntax
17763 @subsubsection Category Syntax
17765 A category consists of a name, the list of groups belonging to the
17766 category, and a number of optional parameters that override the
17767 customizable variables. The complete list of agent parameters are
17770 @cindex Agent Parameters
17772 @item agent-cat-name
17773 The name of the category.
17776 The list of groups that are in this category.
17778 @item agent-predicate
17779 A predicate which (generally) gives a rough outline of which articles
17780 are eligible for downloading; and
17782 @item agent-score-file
17783 a score rule which (generally) gives you a finer granularity when
17784 deciding what articles to download. (Note that this @dfn{download
17785 score} is not necessarily related to normal scores.)
17787 @item agent-enable-expiration
17788 a boolean indicating whether the agent should expire old articles in
17789 this group. Most groups should be expired to conserve disk space. In
17790 fact, its probably safe to say that the gnus.* hierarchy contains the
17791 only groups that should not be expired.
17793 @item agent-days-until-old
17794 an integer indicating the number of days that the agent should wait
17795 before deciding that a read article is safe to expire.
17797 @item agent-low-score
17798 an integer that overrides the value of @code{gnus-agent-low-score}.
17800 @item agent-high-score
17801 an integer that overrides the value of @code{gnus-agent-high-score}.
17803 @item agent-length-when-short
17804 an integer that overrides the value of
17805 @code{gnus-agent-short-article}.
17807 @item agent-length-when-long
17808 an integer that overrides the value of @code{gnus-agent-long-article}.
17810 @item agent-enable-undownloaded-faces
17811 a symbol indicating whether the summary buffer should display
17812 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
17813 faces. Any symbol other than @code{nil} will enable the use of
17814 undownloaded faces.
17817 The name of a category can not be changed once the category has been
17820 Each category maintains a list of groups that are exclusive members of
17821 that category. The exclusivity rule is automatically enforced, add a
17822 group to a new category and it is automatically removed from its old
17825 A predicate in its simplest form can be a single predicate such as
17826 @code{true} or @code{false}. These two will download every available
17827 article or nothing respectively. In the case of these two special
17828 predicates an additional score rule is superfluous.
17830 Predicates of @code{high} or @code{low} download articles in respect of
17831 their scores in relationship to @code{gnus-agent-high-score} and
17832 @code{gnus-agent-low-score} as described below.
17834 To gain even finer control of what is to be regarded eligible for
17835 download a predicate can consist of a number of predicates with logical
17836 operators sprinkled in between.
17838 Perhaps some examples are in order.
17840 Here's a simple predicate. (It's the default predicate, in fact, used
17841 for all groups that don't belong to any other category.)
17847 Quite simple, eh? This predicate is true if and only if the article is
17848 short (for some value of ``short'').
17850 Here's a more complex predicate:
17859 This means that an article should be downloaded if it has a high score,
17860 or if the score is not low and the article is not long. You get the
17863 The available logical operators are @code{or}, @code{and} and
17864 @code{not}. (If you prefer, you can use the more ``C''-ish operators
17865 @samp{|}, @code{&} and @code{!} instead.)
17867 The following predicates are pre-defined, but if none of these fit what
17868 you want to do, you can write your own.
17870 When evaluating each of these predicates, the named constant will be
17871 bound to the value determined by calling
17872 @code{gnus-agent-find-parameter} on the appropriate parameter. For
17873 example, gnus-agent-short-article will be bound to
17874 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
17875 means that you can specify a predicate in your category then tune that
17876 predicate to individual groups.
17880 True iff the article is shorter than @code{gnus-agent-short-article}
17881 lines; default 100.
17884 True iff the article is longer than @code{gnus-agent-long-article}
17885 lines; default 200.
17888 True iff the article has a download score less than
17889 @code{gnus-agent-low-score}; default 0.
17892 True iff the article has a download score greater than
17893 @code{gnus-agent-high-score}; default 0.
17896 True iff the Gnus Agent guesses that the article is spam. The
17897 heuristics may change over time, but at present it just computes a
17898 checksum and sees whether articles match.
17907 If you want to create your own predicate function, here's what you have
17908 to know: The functions are called with no parameters, but the
17909 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
17912 For example, you could decide that you don't want to download articles
17913 that were posted more than a certain number of days ago (e.g. posted
17914 more than @code{gnus-agent-expire-days} ago) you might write a function
17915 something along the lines of the following:
17918 (defun my-article-old-p ()
17919 "Say whether an article is old."
17920 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
17921 (- (time-to-days (current-time)) gnus-agent-expire-days)))
17924 with the predicate then defined as:
17927 (not my-article-old-p)
17930 or you could append your predicate to the predefined
17931 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
17935 (require 'gnus-agent)
17936 (setq gnus-category-predicate-alist
17937 (append gnus-category-predicate-alist
17938 '((old . my-article-old-p))))
17941 and simply specify your predicate as:
17947 If/when using something like the above, be aware that there are many
17948 misconfigured systems/mailers out there and so an article's date is not
17949 always a reliable indication of when it was posted. Hell, some people
17950 just don't give a damn.
17952 The above predicates apply to @emph{all} the groups which belong to the
17953 category. However, if you wish to have a specific predicate for an
17954 individual group within a category, or you're just too lazy to set up a
17955 new category, you can enter a group's individual predicate in its group
17956 parameters like so:
17959 (agent-predicate . short)
17962 This is the group/topic parameter equivalent of the agent category default.
17963 Note that when specifying a single word predicate like this, the
17964 @code{agent-predicate} specification must be in dotted pair notation.
17966 The equivalent of the longer example from above would be:
17969 (agent-predicate or high (and (not low) (not long)))
17972 The outer parenthesis required in the category specification are not
17973 entered here as, not being in dotted pair notation, the value of the
17974 predicate is assumed to be a list.
17977 Now, the syntax of the download score is the same as the syntax of
17978 normal score files, except that all elements that require actually
17979 seeing the article itself are verboten. This means that only the
17980 following headers can be scored on: @code{Subject}, @code{From},
17981 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
17982 @code{Lines}, and @code{Xref}.
17984 As with predicates, the specification of the @code{download score rule}
17985 to use in respect of a group can be in either the category definition if
17986 it's to be applicable to all groups in therein, or a group's parameters
17987 if it's to be specific to that group.
17989 In both of these places the @code{download score rule} can take one of
17996 This has the same syntax as a normal Gnus score file except only a
17997 subset of scoring keywords are available as mentioned above.
18003 Category specification
18007 ("Lars Ingebrigtsen" 1000000 nil s))
18013 Group/Topic Parameter specification
18016 (agent-score ("from"
18017 ("Lars Ingebrigtsen" 1000000 nil s))
18022 Again, note the omission of the outermost parenthesis here.
18028 These score files must @emph{only} contain the permitted scoring
18029 keywords stated above.
18035 Category specification
18038 ("~/News/agent.SCORE")
18044 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
18048 Group Parameter specification
18051 (agent-score "~/News/agent.SCORE")
18054 Additional score files can be specified as above. Need I say anything
18059 Use @code{normal} score files
18061 If you don't want to maintain two sets of scoring rules for a group, and
18062 your desired @code{downloading} criteria for a group are the same as your
18063 @code{reading} criteria then you can tell the agent to refer to your
18064 @code{normal} score files when deciding what to download.
18066 These directives in either the category definition or a group's
18067 parameters will cause the agent to read in all the applicable score
18068 files for a group, @emph{filtering out} those sections that do not
18069 relate to one of the permitted subset of scoring keywords.
18073 Category Specification
18080 Group Parameter specification
18083 (agent-score . file)
18088 @node Category Buffer
18089 @subsubsection Category Buffer
18091 You'd normally do all category maintenance from the category buffer.
18092 When you enter it for the first time (with the @kbd{J c} command from
18093 the group buffer), you'll only see the @code{default} category.
18095 The following commands are available in this buffer:
18099 @kindex q (Category)
18100 @findex gnus-category-exit
18101 Return to the group buffer (@code{gnus-category-exit}).
18104 @kindex e (Category)
18105 @findex gnus-category-customize-category
18106 Use a customization buffer to set all of the selected category's
18107 parameters at one time (@code{gnus-category-customize-category}).
18110 @kindex k (Category)
18111 @findex gnus-category-kill
18112 Kill the current category (@code{gnus-category-kill}).
18115 @kindex c (Category)
18116 @findex gnus-category-copy
18117 Copy the current category (@code{gnus-category-copy}).
18120 @kindex a (Category)
18121 @findex gnus-category-add
18122 Add a new category (@code{gnus-category-add}).
18125 @kindex p (Category)
18126 @findex gnus-category-edit-predicate
18127 Edit the predicate of the current category
18128 (@code{gnus-category-edit-predicate}).
18131 @kindex g (Category)
18132 @findex gnus-category-edit-groups
18133 Edit the list of groups belonging to the current category
18134 (@code{gnus-category-edit-groups}).
18137 @kindex s (Category)
18138 @findex gnus-category-edit-score
18139 Edit the download score rule of the current category
18140 (@code{gnus-category-edit-score}).
18143 @kindex l (Category)
18144 @findex gnus-category-list
18145 List all the categories (@code{gnus-category-list}).
18149 @node Category Variables
18150 @subsubsection Category Variables
18153 @item gnus-category-mode-hook
18154 @vindex gnus-category-mode-hook
18155 Hook run in category buffers.
18157 @item gnus-category-line-format
18158 @vindex gnus-category-line-format
18159 Format of the lines in the category buffer (@pxref{Formatting
18160 Variables}). Valid elements are:
18164 The name of the category.
18167 The number of groups in the category.
18170 @item gnus-category-mode-line-format
18171 @vindex gnus-category-mode-line-format
18172 Format of the category mode line (@pxref{Mode Line Formatting}).
18174 @item gnus-agent-short-article
18175 @vindex gnus-agent-short-article
18176 Articles that have fewer lines than this are short. Default 100.
18178 @item gnus-agent-long-article
18179 @vindex gnus-agent-long-article
18180 Articles that have more lines than this are long. Default 200.
18182 @item gnus-agent-low-score
18183 @vindex gnus-agent-low-score
18184 Articles that have a score lower than this have a low score. Default
18187 @item gnus-agent-high-score
18188 @vindex gnus-agent-high-score
18189 Articles that have a score higher than this have a high score. Default
18192 @item gnus-agent-expire-days
18193 @vindex gnus-agent-expire-days
18194 The number of days that a @samp{read} article must stay in the agent's
18195 local disk before becoming eligible for expiration (While the name is
18196 the same, this doesn't mean expiring the article on the server. It
18197 just means deleting the local copy of the article). What is also
18198 important to understand is that the counter starts with the time the
18199 article was written to the local disk and not the time the article was
18203 @item gnus-agent-enable-expiration
18204 @vindex gnus-agent-enable-expiration
18205 Determines whether articles in a group are, by default, expired or
18206 retained indefinitely. The default is @code{ENABLE} which means that
18207 you'll have to disable expiration when desired. On the other hand,
18208 you could set this to @code{DISABLE}. In that case, you would then
18209 have to enable expiration in selected groups.
18214 @node Agent Commands
18215 @subsection Agent Commands
18216 @findex gnus-agent-toggle-plugged
18217 @kindex J j (Agent)
18219 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
18220 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18221 toggles the plugged/unplugged state of the Gnus Agent.
18225 * Group Agent Commands:: Configure groups and fetch their contents.
18226 * Summary Agent Commands:: Manually select then fetch specific articles.
18227 * Server Agent Commands:: Select the servers that are supported by the agent.
18233 @node Group Agent Commands
18234 @subsubsection Group Agent Commands
18238 @kindex J u (Agent Group)
18239 @findex gnus-agent-fetch-groups
18240 Fetch all eligible articles in the current group
18241 (@code{gnus-agent-fetch-groups}).
18244 @kindex J c (Agent Group)
18245 @findex gnus-enter-category-buffer
18246 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18249 @kindex J s (Agent Group)
18250 @findex gnus-agent-fetch-session
18251 Fetch all eligible articles in all groups
18252 (@code{gnus-agent-fetch-session}).
18255 @kindex J S (Agent Group)
18256 @findex gnus-group-send-queue
18257 Send all sendable messages in the queue group
18258 (@code{gnus-group-send-queue}). @xref{Drafts}.
18261 @kindex J a (Agent Group)
18262 @findex gnus-agent-add-group
18263 Add the current group to an Agent category
18264 (@code{gnus-agent-add-group}). This command understands the
18265 process/prefix convention (@pxref{Process/Prefix}).
18268 @kindex J r (Agent Group)
18269 @findex gnus-agent-remove-group
18270 Remove the current group from its category, if any
18271 (@code{gnus-agent-remove-group}). This command understands the
18272 process/prefix convention (@pxref{Process/Prefix}).
18275 @kindex J Y (Agent Group)
18276 @findex gnus-agent-synchronize-flags
18277 Synchronize flags changed while unplugged with remote server, if any.
18283 @node Summary Agent Commands
18284 @subsubsection Summary Agent Commands
18288 @kindex J # (Agent Summary)
18289 @findex gnus-agent-mark-article
18290 Mark the article for downloading (@code{gnus-agent-mark-article}).
18293 @kindex J M-# (Agent Summary)
18294 @findex gnus-agent-unmark-article
18295 Remove the downloading mark from the article
18296 (@code{gnus-agent-unmark-article}).
18300 @kindex @@ (Agent Summary)
18301 @findex gnus-agent-toggle-mark
18302 Toggle whether to download the article
18303 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
18307 @kindex J c (Agent Summary)
18308 @findex gnus-agent-catchup
18309 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18312 @kindex J S (Agent Summary)
18313 @findex gnus-agent-fetch-group
18314 Download all eligible (@pxref{Agent Categories}) articles in this group.
18315 (@code{gnus-agent-fetch-group}).
18318 @kindex J s (Agent Summary)
18319 @findex gnus-agent-fetch-series
18320 Download all processable articles in this group.
18321 (@code{gnus-agent-fetch-series}).
18324 @kindex J u (Agent Summary)
18325 @findex gnus-agent-summary-fetch-group
18326 Download all downloadable articles in the current group
18327 (@code{gnus-agent-summary-fetch-group}).
18332 @node Server Agent Commands
18333 @subsubsection Server Agent Commands
18337 @kindex J a (Agent Server)
18338 @findex gnus-agent-add-server
18339 Add the current server to the list of servers covered by the Gnus Agent
18340 (@code{gnus-agent-add-server}).
18343 @kindex J r (Agent Server)
18344 @findex gnus-agent-remove-server
18345 Remove the current server from the list of servers covered by the Gnus
18346 Agent (@code{gnus-agent-remove-server}).
18351 @node Agent Visuals
18352 @subsection Agent Visuals
18354 If you open a summary while unplugged and, Gnus knows from the group's
18355 active range that there are more articles than the headers currently
18356 stored in the Agent, you may see some articles whose subject looks
18357 something like @samp{[Undownloaded article #####]}. These are
18358 placeholders for the missing headers. Aside from setting a mark,
18359 there is not much that can be done with one of these placeholders.
18360 When Gnus finally gets a chance to fetch the group's headers, the
18361 placeholders will automatically be replaced by the actual headers.
18362 You can configure the summary buffer's maneuvering to skip over the
18363 placeholders if you care (See @code{gnus-auto-goto-ignores}).
18365 While it may be obvious to all, the only headers and articles
18366 available while unplugged are those headers and articles that were
18367 fetched into the Agent while previously plugged. To put it another
18368 way, "If you forget to fetch something while plugged, you might have a
18369 less than satisfying unplugged session". For this reason, the Agent
18370 adds two visual effects to your summary buffer. These effects display
18371 the download status of each article so that you always know which
18372 articles will be available when unplugged.
18374 The first visual effect is the @samp{%O} spec. If you customize
18375 @code{gnus-summary-line-format} to include this specifier, you will add
18376 a single character field that indicates an article's download status.
18377 Articles that have been fetched into either the Agent or the Cache,
18378 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
18379 other articles will display @code{gnus-undownloaded-mark} (defaults to
18380 @samp{-}). If you open a group that has not been agentized, a space
18381 (@samp{ }) will be displayed.
18383 The second visual effect are the undownloaded faces. The faces, there
18384 are three indicating the article's score (low, normal, high), seem to
18385 result in a love/hate response from many Gnus users. The problem is
18386 that the face selection is controlled by a list of condition tests and
18387 face names (See @code{gnus-summary-highlight}). Each condition is
18388 tested in the order in which it appears in the list so early
18389 conditions have precedence over later conditions. All of this means
18390 that, if you tick an undownloaded article, the article will continue
18391 to be displayed in the undownloaded face rather than the ticked face.
18393 If you use the Agent as a cache (to avoid downloading the same article
18394 each time you visit it or to minimize your connection time), the
18395 undownloaded face will probably seem like a good idea. The reason
18396 being that you do all of our work (marking, reading, deleting) with
18397 downloaded articles so the normal faces always appear. For those
18398 users using the agent to improve online performance by caching the NOV
18399 database (most users since 5.10.2), the undownloaded faces may appear
18400 to be an absolutely horrible idea. The issue being that, since none
18401 of their articles have been fetched into the Agent, all of the
18402 normal faces will be obscured by the undownloaded faces.
18404 If you would like to use the undownloaded faces, you must enable the
18405 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
18406 group parameter to t. This parameter, like all other agent
18407 parameters, may be set on an Agent Category (@pxref{Agent
18408 Categories}), a Group Topic (@pxref{Topic Parameters}), or an
18409 individual group (@pxref{Group Parameters}).
18411 The one problem common to all users using the agent is how quickly it
18412 can consume disk space. If you using the agent on many groups, it is
18413 even more difficult to effectively recover disk space. One solution
18414 is the @samp{%F} format available in @code{gnus-group-line-format}.
18415 This format will display the actual disk space used by articles
18416 fetched into both the agent and cache. By knowing which groups use
18417 the most space, users know where to focus their efforts when ``agent
18418 expiring'' articles.
18420 @node Agent as Cache
18421 @subsection Agent as Cache
18423 When Gnus is plugged, it is not efficient to download headers or
18424 articles from the server again, if they are already stored in the
18425 Agent. So, Gnus normally only downloads headers once, and stores them
18426 in the Agent. These headers are later used when generating the summary
18427 buffer, regardless of whether you are plugged or unplugged. Articles
18428 are not cached in the Agent by default though (that would potentially
18429 consume lots of disk space), but if you have already downloaded an
18430 article into the Agent, Gnus will not download the article from the
18431 server again but use the locally stored copy instead.
18433 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
18434 @pxref{Agent Variables}) to always download headers and articles while
18435 plugged. Gnus will almost certainly be slower, but it will be kept
18436 synchronized with the server. That last point probably won't make any
18437 sense if you are using a nntp or nnimap back end.
18440 @subsection Agent Expiry
18442 @vindex gnus-agent-expire-days
18443 @findex gnus-agent-expire
18444 @kindex M-x gnus-agent-expire
18445 @kindex M-x gnus-agent-expire-group
18446 @findex gnus-agent-expire-group
18447 @cindex agent expiry
18448 @cindex Gnus agent expiry
18451 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
18452 least it doesn't handle it like other back ends. Instead, there are
18453 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
18454 commands that will expire all read articles that are older than
18455 @code{gnus-agent-expire-days} days. They can be run whenever you feel
18456 that you're running out of space. Neither are particularly fast or
18457 efficient, and it's not a particularly good idea to interrupt them (with
18458 @kbd{C-g} or anything else) once you've started one of them.
18460 Note that other functions, e.g. @code{gnus-request-expire-articles},
18461 might run @code{gnus-agent-expire} for you to keep the agent
18462 synchronized with the group.
18464 The agent parameter @code{agent-enable-expiration} may be used to
18465 prevent expiration in selected groups.
18467 @vindex gnus-agent-expire-all
18468 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
18469 expiration commands will expire all articles---unread, read, ticked
18470 and dormant. If @code{nil} (which is the default), only read articles
18471 are eligible for expiry, and unread, ticked and dormant articles will
18472 be kept indefinitely.
18474 If you find that some articles eligible for expiry are never expired,
18475 perhaps some Gnus Agent files are corrupted. There's are special
18476 commands, @code{gnus-agent-regenerate} and
18477 @code{gnus-agent-regenerate-group}, to fix possible problems.
18479 @node Agent Regeneration
18480 @subsection Agent Regeneration
18482 @cindex agent regeneration
18483 @cindex Gnus agent regeneration
18484 @cindex regeneration
18486 The local data structures used by @code{nnagent} may become corrupted
18487 due to certain exceptional conditions. When this happens,
18488 @code{nnagent} functionality may degrade or even fail. The solution
18489 to this problem is to repair the local data structures by removing all
18490 internal inconsistencies.
18492 For example, if your connection to your server is lost while
18493 downloaded articles into the agent, the local data structures will not
18494 know about articles successfully downloaded prior to the connection
18495 failure. Running @code{gnus-agent-regenerate} or
18496 @code{gnus-agent-regenerate-group} will update the data structures
18497 such that you don't need to download these articles a second time.
18499 @findex gnus-agent-regenerate
18500 @kindex M-x gnus-agent-regenerate
18501 The command @code{gnus-agent-regenerate} will perform
18502 @code{gnus-agent-regenerate-group} on every agentized group. While
18503 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
18504 recommended that you first close all summary buffers.
18506 @findex gnus-agent-regenerate-group
18507 @kindex M-x gnus-agent-regenerate-group
18508 The command @code{gnus-agent-regenerate-group} uses the local copies
18509 of individual articles to repair the local @acronym{NOV}(header) database. It
18510 then updates the internal data structures that document which articles
18511 are stored locally. An optional argument will mark articles in the
18514 @node Agent and IMAP
18515 @subsection Agent and IMAP
18517 The Agent works with any Gnus back end, including nnimap. However,
18518 since there are some conceptual differences between @acronym{NNTP} and
18519 @acronym{IMAP}, this section (should) provide you with some information to
18520 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
18522 The first thing to keep in mind is that all flags (read, ticked, etc)
18523 are kept on the @acronym{IMAP} server, rather than in @file{.newsrc} as is the
18524 case for nntp. Thus Gnus need to remember flag changes when
18525 disconnected, and synchronize these flags when you plug back in.
18527 Gnus keeps track of flag changes when reading nnimap groups under the
18528 Agent. When you plug back in, Gnus will check if you have any changed
18529 any flags and ask if you wish to synchronize these with the server.
18530 The behavior is customizable by @code{gnus-agent-synchronize-flags}.
18532 @vindex gnus-agent-synchronize-flags
18533 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
18534 never automatically synchronize flags. If it is @code{ask}, which is
18535 the default, the Agent will check if you made any changes and if so
18536 ask if you wish to synchronize these when you re-connect. If it has
18537 any other value, all flags will be synchronized automatically.
18539 If you do not wish to synchronize flags automatically when you
18540 re-connect, you can do it manually with the
18541 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
18542 in the group buffer.
18544 Some things are currently not implemented in the Agent that you'd might
18545 expect from a disconnected @acronym{IMAP} client, including:
18550 Copying/moving articles into nnimap groups when unplugged.
18553 Creating/deleting nnimap groups when unplugged.
18557 Technical note: the synchronization algorithm does not work by ``pushing''
18558 all local flags to the server, but rather incrementally update the
18559 server view of flags by changing only those flags that were changed by
18560 the user. Thus, if you set one flag on an article, quit the group and
18561 re-select the group and remove the flag; the flag will be set and
18562 removed from the server when you ``synchronize''. The queued flag
18563 operations can be found in the per-server @code{flags} file in the Agent
18564 directory. It's emptied when you synchronize flags.
18567 @node Outgoing Messages
18568 @subsection Outgoing Messages
18570 By default, when Gnus is unplugged, all outgoing messages (both mail
18571 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
18572 You can view them there after posting, and edit them at will.
18574 You can control the circumstances under which outgoing mail is queued
18575 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
18576 news is always queued when Gnus is unplugged, and never otherwise.
18578 You can send the messages either from the draft group with the special
18579 commands available there, or you can use the @kbd{J S} command in the
18580 group buffer to send all the sendable messages in the draft group.
18581 Posting news will only work when Gnus is plugged, but you can send
18584 If sending mail while unplugged does not work for you and you worry
18585 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
18586 ask you to confirm your action (see
18587 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
18589 @node Agent Variables
18590 @subsection Agent Variables
18595 Is the agent enabled? The default is @code{t}. When first enabled,
18596 the agent will use @code{gnus-agent-auto-agentize-methods} to
18597 automatically mark some backends as agentized. You may change which
18598 backends are agentized using the agent commands in the server buffer.
18600 To enter the server buffer, use the @kbd{^}
18601 (@code{gnus-group-enter-server-mode}) command in the group buffer.
18604 @item gnus-agent-directory
18605 @vindex gnus-agent-directory
18606 Where the Gnus Agent will store its files. The default is
18607 @file{~/News/agent/}.
18609 @item gnus-agent-handle-level
18610 @vindex gnus-agent-handle-level
18611 Groups on levels (@pxref{Group Levels}) higher than this variable will
18612 be ignored by the Agent. The default is @code{gnus-level-subscribed},
18613 which means that only subscribed group will be considered by the Agent
18616 @item gnus-agent-plugged-hook
18617 @vindex gnus-agent-plugged-hook
18618 Hook run when connecting to the network.
18620 @item gnus-agent-unplugged-hook
18621 @vindex gnus-agent-unplugged-hook
18622 Hook run when disconnecting from the network.
18624 @item gnus-agent-fetched-hook
18625 @vindex gnus-agent-fetched-hook
18626 Hook run when finished fetching articles.
18628 @item gnus-agent-cache
18629 @vindex gnus-agent-cache
18630 Variable to control whether use the locally stored @acronym{NOV} and
18631 articles when plugged, e.g. essentially using the Agent as a cache.
18632 The default is non-@code{nil}, which means to use the Agent as a cache.
18634 @item gnus-agent-go-online
18635 @vindex gnus-agent-go-online
18636 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
18637 automatically switch offline servers into online status. If it is
18638 @code{ask}, the default, the Agent will ask if you wish to switch
18639 offline servers into online status when you re-connect. If it has any
18640 other value, all offline servers will be automatically switched into
18643 @item gnus-agent-mark-unread-after-downloaded
18644 @vindex gnus-agent-mark-unread-after-downloaded
18645 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
18646 mark articles as unread after downloading. This is usually a safe
18647 thing to do as the newly downloaded article has obviously not been
18648 read. The default is t.
18650 @item gnus-agent-consider-all-articles
18651 @vindex gnus-agent-consider-all-articles
18652 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
18653 agent will let the agent predicate decide whether articles need to be
18654 downloaded or not, for all articles. When @code{nil}, the default,
18655 the agent will only let the predicate decide whether unread articles
18656 are downloaded or not. If you enable this, you may also want to look
18657 into the agent expiry settings (@pxref{Category Variables}), so that
18658 the agent doesn't download articles which the agent will later expire,
18659 over and over again.
18661 @item gnus-agent-max-fetch-size
18662 @vindex gnus-agent-max-fetch-size
18663 The agent fetches articles into a temporary buffer prior to parsing
18664 them into individual files. To avoid exceeding the max. buffer size,
18665 the agent alternates between fetching and parsing until all articles
18666 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
18667 limit to control how often the cycling occurs. A large value improves
18668 performance. A small value minimizes the time lost should the
18669 connection be lost while fetching (You may need to run
18670 @code{gnus-agent-regenerate-group} to update the group's state.
18671 However, all articles parsed prior to loosing the connection will be
18672 available while unplugged). The default is 10M so it is unusual to
18675 @item gnus-server-unopen-status
18676 @vindex gnus-server-unopen-status
18677 Perhaps not an Agent variable, but closely related to the Agent, this
18678 variable says what will happen if Gnus cannot open a server. If the
18679 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
18680 whether to deny the server or whether to unplug the agent. If the
18681 Agent is disabled, Gnus always simply deny the server. Other choices
18682 for this variable include @code{denied} and @code{offline} the latter
18683 is only valid if the Agent is used.
18685 @item gnus-auto-goto-ignores
18686 @vindex gnus-auto-goto-ignores
18687 Another variable that isn't an Agent variable, yet so closely related
18688 that most will look for it here, this variable tells the summary
18689 buffer how to maneuver around undownloaded (only headers stored in the
18690 agent) and unfetched (neither article nor headers stored) articles.
18692 The legal values are @code{nil} (maneuver to any article),
18693 @code{undownloaded} (maneuvering while unplugged ignores articles that
18694 have not been fetched), @code{always-undownloaded} (maneuvering always
18695 ignores articles that have not been fetched), @code{unfetched}
18696 (maneuvering ignores articles whose headers have not been fetched).
18698 @item gnus-agent-queue-mail
18699 @vindex gnus-agent-queue-mail
18700 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
18701 queue mail rather than sending it straight away. When @code{t}, Gnus
18702 will queue mail when unplugged only. When @code{nil}, never queue
18703 mail. The default is @code{t}.
18705 @item gnus-agent-prompt-send-queue
18706 @vindex gnus-agent-prompt-send-queue
18707 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
18708 prompt you to confirm that you really wish to proceed if you hit
18709 @kbd{J S} while unplugged. The default is @code{nil}.
18711 @item gnus-agent-auto-agentize-methods
18712 @vindex gnus-agent-auto-agentize-methods
18713 If you have never used the Agent before (or more technically, if
18714 @file{~/News/agent/lib/servers} does not exist), Gnus will
18715 automatically agentize a few servers for you. This variable control
18716 which backends should be auto-agentized. It is typically only useful
18717 to agentize remote backends. The auto-agentizing has the same effect
18718 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
18719 If the file exist, you must manage the servers manually by adding or
18720 removing them, this variable is only applicable the first time you
18721 start Gnus. The default is @samp{(nntp nnimap)}.
18726 @node Example Setup
18727 @subsection Example Setup
18729 If you don't want to read this manual, and you have a fairly standard
18730 setup, you may be able to use something like the following as your
18731 @file{~/.gnus.el} file to get started.
18734 ;;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
18735 ;;; @r{from your ISP's server.}
18736 (setq gnus-select-method '(nntp "news.your-isp.com"))
18738 ;;; @r{Define how Gnus is to read your mail. We read mail from}
18739 ;;; @r{your ISP's @acronym{POP} server.}
18740 (setq mail-sources '((pop :server "pop.your-isp.com")))
18742 ;;; @r{Say how Gnus is to store the mail. We use nnml groups.}
18743 (setq gnus-secondary-select-methods '((nnml "")))
18745 ;;; @r{Make Gnus into an offline newsreader.}
18746 ;;; (gnus-agentize) ; @r{The obsolete setting.}
18747 ;;; (setq gnus-agent t) ; @r{Now the default.}
18750 That should be it, basically. Put that in your @file{~/.gnus.el} file,
18751 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
18754 If this is the first time you've run Gnus, you will be subscribed
18755 automatically to a few default newsgroups. You'll probably want to
18756 subscribe to more groups, and to do that, you have to query the
18757 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
18758 command. This usually takes quite a while, but you only have to do it
18761 After reading and parsing a while, you'll be presented with a list of
18762 groups. Subscribe to the ones you want to read with the @kbd{u}
18763 command. @kbd{l} to make all the killed groups disappear after you've
18764 subscribe to all the groups you want to read. (@kbd{A k} will bring
18765 back all the killed groups.)
18767 You can now read the groups at once, or you can download the articles
18768 with the @kbd{J s} command. And then read the rest of this manual to
18769 find out which of the other gazillion things you want to customize.
18772 @node Batching Agents
18773 @subsection Batching Agents
18774 @findex gnus-agent-batch
18776 Having the Gnus Agent fetch articles (and post whatever messages you've
18777 written) is quite easy once you've gotten things set up properly. The
18778 following shell script will do everything that is necessary:
18780 You can run a complete batch command from the command line with the
18781 following incantation:
18785 emacs -batch -l ~/.emacs -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1
18789 @node Agent Caveats
18790 @subsection Agent Caveats
18792 The Gnus Agent doesn't seem to work like most other offline
18793 newsreaders. Here are some common questions that some imaginary people
18797 @item If I read an article while plugged, do they get entered into the Agent?
18799 @strong{No}. If you want this behaviour, add
18800 @code{gnus-agent-fetch-selected-article} to
18801 @code{gnus-select-article-hook}.
18803 @item If I read an article while plugged, and the article already exists in
18804 the Agent, will it get downloaded once more?
18806 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
18810 In short, when Gnus is unplugged, it only looks into the locally stored
18811 articles; when it's plugged, it talks to your ISP and may also use the
18812 locally stored articles.
18819 Other people use @dfn{kill files}, but we here at Gnus Towers like
18820 scoring better than killing, so we'd rather switch than fight. They do
18821 something completely different as well, so sit up straight and pay
18824 @vindex gnus-summary-mark-below
18825 All articles have a default score (@code{gnus-summary-default-score}),
18826 which is 0 by default. This score may be raised or lowered either
18827 interactively or by score files. Articles that have a score lower than
18828 @code{gnus-summary-mark-below} are marked as read.
18830 Gnus will read any @dfn{score files} that apply to the current group
18831 before generating the summary buffer.
18833 There are several commands in the summary buffer that insert score
18834 entries based on the current article. You can, for instance, ask Gnus to
18835 lower or increase the score of all articles with a certain subject.
18837 There are two sorts of scoring entries: Permanent and temporary.
18838 Temporary score entries are self-expiring entries. Any entries that are
18839 temporary and have not been used for, say, a week, will be removed
18840 silently to help keep the sizes of the score files down.
18843 * Summary Score Commands:: Adding score entries for the current group.
18844 * Group Score Commands:: General score commands.
18845 * Score Variables:: Customize your scoring. (My, what terminology).
18846 * Score File Format:: What a score file may contain.
18847 * Score File Editing:: You can edit score files by hand as well.
18848 * Adaptive Scoring:: Big Sister Gnus knows what you read.
18849 * Home Score File:: How to say where new score entries are to go.
18850 * Followups To Yourself:: Having Gnus notice when people answer you.
18851 * Scoring On Other Headers:: Scoring on non-standard headers.
18852 * Scoring Tips:: How to score effectively.
18853 * Reverse Scoring:: That problem child of old is not problem.
18854 * Global Score Files:: Earth-spanning, ear-splitting score files.
18855 * Kill Files:: They are still here, but they can be ignored.
18856 * Converting Kill Files:: Translating kill files to score files.
18857 * Advanced Scoring:: Using logical expressions to build score rules.
18858 * Score Decays:: It can be useful to let scores wither away.
18862 @node Summary Score Commands
18863 @section Summary Score Commands
18864 @cindex score commands
18866 The score commands that alter score entries do not actually modify real
18867 score files. That would be too inefficient. Gnus maintains a cache of
18868 previously loaded score files, one of which is considered the
18869 @dfn{current score file alist}. The score commands simply insert
18870 entries into this list, and upon group exit, this list is saved.
18872 The current score file is by default the group's local score file, even
18873 if no such score file actually exists. To insert score commands into
18874 some other score file (e.g. @file{all.SCORE}), you must first make this
18875 score file the current one.
18877 General score commands that don't actually change the score file:
18882 @kindex V s (Summary)
18883 @findex gnus-summary-set-score
18884 Set the score of the current article (@code{gnus-summary-set-score}).
18887 @kindex V S (Summary)
18888 @findex gnus-summary-current-score
18889 Display the score of the current article
18890 (@code{gnus-summary-current-score}).
18893 @kindex V t (Summary)
18894 @findex gnus-score-find-trace
18895 Display all score rules that have been used on the current article
18896 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
18897 may type @kbd{e} to edit score file corresponding to the score rule on
18898 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
18899 score file and edit it.
18902 @kindex V w (Summary)
18903 @findex gnus-score-find-favourite-words
18904 List words used in scoring (@code{gnus-score-find-favourite-words}).
18907 @kindex V R (Summary)
18908 @findex gnus-summary-rescore
18909 Run the current summary through the scoring process
18910 (@code{gnus-summary-rescore}). This might be useful if you're playing
18911 around with your score files behind Gnus' back and want to see the
18912 effect you're having.
18915 @kindex V c (Summary)
18916 @findex gnus-score-change-score-file
18917 Make a different score file the current
18918 (@code{gnus-score-change-score-file}).
18921 @kindex V e (Summary)
18922 @findex gnus-score-edit-current-scores
18923 Edit the current score file (@code{gnus-score-edit-current-scores}).
18924 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
18928 @kindex V f (Summary)
18929 @findex gnus-score-edit-file
18930 Edit a score file and make this score file the current one
18931 (@code{gnus-score-edit-file}).
18934 @kindex V F (Summary)
18935 @findex gnus-score-flush-cache
18936 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
18937 after editing score files.
18940 @kindex V C (Summary)
18941 @findex gnus-score-customize
18942 Customize a score file in a visually pleasing manner
18943 (@code{gnus-score-customize}).
18947 The rest of these commands modify the local score file.
18952 @kindex V m (Summary)
18953 @findex gnus-score-set-mark-below
18954 Prompt for a score, and mark all articles with a score below this as
18955 read (@code{gnus-score-set-mark-below}).
18958 @kindex V x (Summary)
18959 @findex gnus-score-set-expunge-below
18960 Prompt for a score, and add a score rule to the current score file to
18961 expunge all articles below this score
18962 (@code{gnus-score-set-expunge-below}).
18965 The keystrokes for actually making score entries follow a very regular
18966 pattern, so there's no need to list all the commands. (Hundreds of
18969 @findex gnus-summary-increase-score
18970 @findex gnus-summary-lower-score
18974 The first key is either @kbd{I} (upper case i) for increasing the score
18975 or @kbd{L} for lowering the score.
18977 The second key says what header you want to score on. The following
18978 keys are available:
18982 Score on the author name.
18985 Score on the subject line.
18988 Score on the @code{Xref} line---i.e., the cross-posting line.
18991 Score on the @code{References} line.
18997 Score on the number of lines.
19000 Score on the @code{Message-ID} header.
19003 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
19004 if your @acronym{NNTP} server tracks additional header data in overviews.
19007 Score on followups---this matches the author name, and adds scores to
19008 the followups to this author. (Using this key leads to the creation of
19009 @file{ADAPT} files.)
19018 Score on thread. (Using this key leads to the creation of @file{ADAPT}
19024 The third key is the match type. Which match types are valid depends on
19025 what headers you are scoring on.
19037 Substring matching.
19040 Fuzzy matching (@pxref{Fuzzy Matching}).
19069 Greater than number.
19074 The fourth and usually final key says whether this is a temporary (i.e.,
19075 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
19076 or whether it is to be done immediately, without adding to the score
19081 Temporary score entry.
19084 Permanent score entry.
19087 Immediately scoring.
19091 If you are scoring on `e' (extra) headers, you will then be prompted for
19092 the header name on which you wish to score. This must be a header named
19093 in gnus-extra-headers, and @samp{TAB} completion is available.
19097 So, let's say you want to increase the score on the current author with
19098 exact matching permanently: @kbd{I a e p}. If you want to lower the
19099 score based on the subject line, using substring matching, and make a
19100 temporary score entry: @kbd{L s s t}. Pretty easy.
19102 To make things a bit more complicated, there are shortcuts. If you use
19103 a capital letter on either the second or third keys, Gnus will use
19104 defaults for the remaining one or two keystrokes. The defaults are
19105 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
19106 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
19108 These functions take both the numerical prefix and the symbolic prefix
19109 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
19110 (or increase) the score of the article. A symbolic prefix of @code{a}
19111 says to use the @file{all.SCORE} file for the command instead of the
19112 current score file.
19114 @vindex gnus-score-mimic-keymap
19115 The @code{gnus-score-mimic-keymap} says whether these commands will
19116 pretend they are keymaps or not.
19119 @node Group Score Commands
19120 @section Group Score Commands
19121 @cindex group score commands
19123 There aren't many of these as yet, I'm afraid.
19128 @kindex W e (Group)
19129 @findex gnus-score-edit-all-score
19130 Edit the apply-to-all-groups all.SCORE file. You will be popped into
19131 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
19134 @kindex W f (Group)
19135 @findex gnus-score-flush-cache
19136 Gnus maintains a cache of score alists to avoid having to reload them
19137 all the time. This command will flush the cache
19138 (@code{gnus-score-flush-cache}).
19142 You can do scoring from the command line by saying something like:
19144 @findex gnus-batch-score
19145 @cindex batch scoring
19147 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
19151 @node Score Variables
19152 @section Score Variables
19153 @cindex score variables
19157 @item gnus-use-scoring
19158 @vindex gnus-use-scoring
19159 If @code{nil}, Gnus will not check for score files, and will not, in
19160 general, do any score-related work. This is @code{t} by default.
19162 @item gnus-kill-killed
19163 @vindex gnus-kill-killed
19164 If this variable is @code{nil}, Gnus will never apply score files to
19165 articles that have already been through the kill process. While this
19166 may save you lots of time, it also means that if you apply a kill file
19167 to a group, and then change the kill file and want to run it over you
19168 group again to kill more articles, it won't work. You have to set this
19169 variable to @code{t} to do that. (It is @code{t} by default.)
19171 @item gnus-kill-files-directory
19172 @vindex gnus-kill-files-directory
19173 All kill and score files will be stored in this directory, which is
19174 initialized from the @env{SAVEDIR} environment variable by default.
19175 This is @file{~/News/} by default.
19177 @item gnus-score-file-suffix
19178 @vindex gnus-score-file-suffix
19179 Suffix to add to the group name to arrive at the score file name
19180 (@file{SCORE} by default.)
19182 @item gnus-score-uncacheable-files
19183 @vindex gnus-score-uncacheable-files
19184 @cindex score cache
19185 All score files are normally cached to avoid excessive re-loading of
19186 score files. However, if this might make your Emacs grow big and
19187 bloated, so this regexp can be used to weed out score files unlikely
19188 to be needed again. It would be a bad idea to deny caching of
19189 @file{all.SCORE}, while it might be a good idea to not cache
19190 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
19191 variable is @samp{ADAPT$} by default, so no adaptive score files will
19194 @item gnus-save-score
19195 @vindex gnus-save-score
19196 If you have really complicated score files, and do lots of batch
19197 scoring, then you might set this variable to @code{t}. This will make
19198 Gnus save the scores into the @file{.newsrc.eld} file.
19200 If you do not set this to @code{t}, then manual scores (like those set
19201 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
19202 across group visits.
19204 @item gnus-score-interactive-default-score
19205 @vindex gnus-score-interactive-default-score
19206 Score used by all the interactive raise/lower commands to raise/lower
19207 score with. Default is 1000, which may seem excessive, but this is to
19208 ensure that the adaptive scoring scheme gets enough room to play with.
19209 We don't want the small changes from the adaptive scoring to overwrite
19210 manually entered data.
19212 @item gnus-summary-default-score
19213 @vindex gnus-summary-default-score
19214 Default score of an article, which is 0 by default.
19216 @item gnus-summary-expunge-below
19217 @vindex gnus-summary-expunge-below
19218 Don't display the summary lines of articles that have scores lower than
19219 this variable. This is @code{nil} by default, which means that no
19220 articles will be hidden. This variable is local to the summary buffers,
19221 and has to be set from @code{gnus-summary-mode-hook}.
19223 @item gnus-score-over-mark
19224 @vindex gnus-score-over-mark
19225 Mark (in the third column) used for articles with a score over the
19226 default. Default is @samp{+}.
19228 @item gnus-score-below-mark
19229 @vindex gnus-score-below-mark
19230 Mark (in the third column) used for articles with a score below the
19231 default. Default is @samp{-}.
19233 @item gnus-score-find-score-files-function
19234 @vindex gnus-score-find-score-files-function
19235 Function used to find score files for the current group. This function
19236 is called with the name of the group as the argument.
19238 Predefined functions available are:
19241 @item gnus-score-find-single
19242 @findex gnus-score-find-single
19243 Only apply the group's own score file.
19245 @item gnus-score-find-bnews
19246 @findex gnus-score-find-bnews
19247 Apply all score files that match, using bnews syntax. This is the
19248 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
19249 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
19250 @file{gnu.all.SCORE} would all apply. In short, the instances of
19251 @samp{all} in the score file names are translated into @samp{.*}, and
19252 then a regexp match is done.
19254 This means that if you have some score entries that you want to apply to
19255 all groups, then you put those entries in the @file{all.SCORE} file.
19257 The score files are applied in a semi-random order, although Gnus will
19258 try to apply the more general score files before the more specific score
19259 files. It does this by looking at the number of elements in the score
19260 file names---discarding the @samp{all} elements.
19262 @item gnus-score-find-hierarchical
19263 @findex gnus-score-find-hierarchical
19264 Apply all score files from all the parent groups. This means that you
19265 can't have score files like @file{all.SCORE}, but you can have
19266 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19270 This variable can also be a list of functions. In that case, all
19271 these functions will be called with the group name as argument, and
19272 all the returned lists of score files will be applied. These
19273 functions can also return lists of lists of score alists directly. In
19274 that case, the functions that return these non-file score alists
19275 should probably be placed before the ``real'' score file functions, to
19276 ensure that the last score file returned is the local score file.
19279 For example, to do hierarchical scoring but use a non-server-specific
19280 overall score file, you could use the value
19282 (list (lambda (group) ("all.SCORE"))
19283 'gnus-score-find-hierarchical)
19286 @item gnus-score-expiry-days
19287 @vindex gnus-score-expiry-days
19288 This variable says how many days should pass before an unused score file
19289 entry is expired. If this variable is @code{nil}, no score file entries
19290 are expired. It's 7 by default.
19292 @item gnus-update-score-entry-dates
19293 @vindex gnus-update-score-entry-dates
19294 If this variable is non-@code{nil}, temporary score entries that have
19295 been triggered (matched) will have their dates updated. (This is how Gnus
19296 controls expiry---all non-matched-entries will become too old while
19297 matched entries will stay fresh and young.) However, if you set this
19298 variable to @code{nil}, even matched entries will grow old and will
19299 have to face that oh-so grim reaper.
19301 @item gnus-score-after-write-file-function
19302 @vindex gnus-score-after-write-file-function
19303 Function called with the name of the score file just written.
19305 @item gnus-score-thread-simplify
19306 @vindex gnus-score-thread-simplify
19307 If this variable is non-@code{nil}, article subjects will be
19308 simplified for subject scoring purposes in the same manner as with
19309 threading---according to the current value of
19310 @code{gnus-simplify-subject-functions}. If the scoring entry uses
19311 @code{substring} or @code{exact} matching, the match will also be
19312 simplified in this manner.
19317 @node Score File Format
19318 @section Score File Format
19319 @cindex score file format
19321 A score file is an @code{emacs-lisp} file that normally contains just a
19322 single form. Casual users are not expected to edit these files;
19323 everything can be changed from the summary buffer.
19325 Anyway, if you'd like to dig into it yourself, here's an example:
19329 ("Lars Ingebrigtsen" -10000)
19331 ("larsi\\|lmi" -50000 nil R))
19333 ("Ding is Badd" nil 728373))
19335 ("alt.politics" -1000 728372 s))
19340 (mark-and-expunge -10)
19344 (files "/hom/larsi/News/gnu.SCORE")
19345 (exclude-files "all.SCORE")
19346 (local (gnus-newsgroup-auto-expire t)
19347 (gnus-summary-make-false-root empty))
19351 This example demonstrates most score file elements. @xref{Advanced
19352 Scoring}, for a different approach.
19354 Even though this looks much like Lisp code, nothing here is actually
19355 @code{eval}ed. The Lisp reader is used to read this form, though, so it
19356 has to be valid syntactically, if not semantically.
19358 Six keys are supported by this alist:
19363 If the key is a string, it is the name of the header to perform the
19364 match on. Scoring can only be performed on these eight headers:
19365 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
19366 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
19367 these headers, there are three strings to tell Gnus to fetch the entire
19368 article and do the match on larger parts of the article: @code{Body}
19369 will perform the match on the body of the article, @code{Head} will
19370 perform the match on the head of the article, and @code{All} will
19371 perform the match on the entire article. Note that using any of these
19372 last three keys will slow down group entry @emph{considerably}. The
19373 final ``header'' you can score on is @code{Followup}. These score
19374 entries will result in new score entries being added for all follow-ups
19375 to articles that matches these score entries.
19377 Following this key is an arbitrary number of score entries, where each
19378 score entry has one to four elements.
19382 The first element is the @dfn{match element}. On most headers this will
19383 be a string, but on the Lines and Chars headers, this must be an
19387 If the second element is present, it should be a number---the @dfn{score
19388 element}. This number should be an integer in the neginf to posinf
19389 interval. This number is added to the score of the article if the match
19390 is successful. If this element is not present, the
19391 @code{gnus-score-interactive-default-score} number will be used
19392 instead. This is 1000 by default.
19395 If the third element is present, it should be a number---the @dfn{date
19396 element}. This date says when the last time this score entry matched,
19397 which provides a mechanism for expiring the score entries. It this
19398 element is not present, the score entry is permanent. The date is
19399 represented by the number of days since December 31, 1 BCE.
19402 If the fourth element is present, it should be a symbol---the @dfn{type
19403 element}. This element specifies what function should be used to see
19404 whether this score entry matches the article. What match types that can
19405 be used depends on what header you wish to perform the match on.
19408 @item From, Subject, References, Xref, Message-ID
19409 For most header types, there are the @code{r} and @code{R} (regexp), as
19410 well as @code{s} and @code{S} (substring) types, and @code{e} and
19411 @code{E} (exact match), and @code{w} (word match) types. If this
19412 element is not present, Gnus will assume that substring matching should
19413 be used. @code{R}, @code{S}, and @code{E} differ from the others in
19414 that the matches will be done in a case-sensitive manner. All these
19415 one-letter types are really just abbreviations for the @code{regexp},
19416 @code{string}, @code{exact}, and @code{word} types, which you can use
19417 instead, if you feel like.
19420 Just as for the standard string overview headers, if you are using
19421 gnus-extra-headers, you can score on these headers' values. In this
19422 case, there is a 5th element in the score entry, being the name of the
19423 header to be scored. The following entry is useful in your
19424 @file{all.SCORE} file in case of spam attacks from a single origin
19425 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
19429 ("111.222.333.444" -1000 nil s
19430 "NNTP-Posting-Host")
19434 These two headers use different match types: @code{<}, @code{>},
19435 @code{=}, @code{>=} and @code{<=}.
19437 These predicates are true if
19440 (PREDICATE HEADER MATCH)
19443 evaluates to non-@code{nil}. For instance, the advanced match
19444 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
19451 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
19452 the match, we get the score added if the article has less than 4 lines.
19453 (It's easy to get confused and think it's the other way around. But
19454 it's not. I think.)
19456 When matching on @code{Lines}, be careful because some back ends (like
19457 @code{nndir}) do not generate @code{Lines} header, so every article ends
19458 up being marked as having 0 lines. This can lead to strange results if
19459 you happen to lower score of the articles with few lines.
19462 For the Date header we have three kinda silly match types:
19463 @code{before}, @code{at} and @code{after}. I can't really imagine this
19464 ever being useful, but, like, it would feel kinda silly not to provide
19465 this function. Just in case. You never know. Better safe than sorry.
19466 Once burnt, twice shy. Don't judge a book by its cover. Never not have
19467 sex on a first date. (I have been told that at least one person, and I
19468 quote, ``found this function indispensable'', however.)
19472 A more useful match type is @code{regexp}. With it, you can match the
19473 date string using a regular expression. The date is normalized to
19474 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
19475 you want to match all articles that have been posted on April 1st in
19476 every year, you could use @samp{....0401.........} as a match string,
19477 for instance. (Note that the date is kept in its original time zone, so
19478 this will match articles that were posted when it was April 1st where
19479 the article was posted from. Time zones are such wholesome fun for the
19482 @item Head, Body, All
19483 These three match keys use the same match types as the @code{From} (etc)
19487 This match key is somewhat special, in that it will match the
19488 @code{From} header, and affect the score of not only the matching
19489 articles, but also all followups to the matching articles. This allows
19490 you e.g. increase the score of followups to your own articles, or
19491 decrease the score of followups to the articles of some known
19492 trouble-maker. Uses the same match types as the @code{From} header
19493 uses. (Using this match key will lead to creation of @file{ADAPT}
19497 This match key works along the same lines as the @code{Followup} match
19498 key. If you say that you want to score on a (sub-)thread started by an
19499 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
19500 match. This will add a new @samp{thread} match for each article that
19501 has @var{x} in its @code{References} header. (These new @samp{thread}
19502 matches will use the @code{Message-ID}s of these matching articles.)
19503 This will ensure that you can raise/lower the score of an entire thread,
19504 even though some articles in the thread may not have complete
19505 @code{References} headers. Note that using this may lead to
19506 undeterministic scores of the articles in the thread. (Using this match
19507 key will lead to creation of @file{ADAPT} files.)
19511 @cindex score file atoms
19513 The value of this entry should be a number. Any articles with a score
19514 lower than this number will be marked as read.
19517 The value of this entry should be a number. Any articles with a score
19518 lower than this number will be removed from the summary buffer.
19520 @item mark-and-expunge
19521 The value of this entry should be a number. Any articles with a score
19522 lower than this number will be marked as read and removed from the
19525 @item thread-mark-and-expunge
19526 The value of this entry should be a number. All articles that belong to
19527 a thread that has a total score below this number will be marked as read
19528 and removed from the summary buffer. @code{gnus-thread-score-function}
19529 says how to compute the total score for a thread.
19532 The value of this entry should be any number of file names. These files
19533 are assumed to be score files as well, and will be loaded the same way
19536 @item exclude-files
19537 The clue of this entry should be any number of files. These files will
19538 not be loaded, even though they would normally be so, for some reason or
19542 The value of this entry will be @code{eval}el. This element will be
19543 ignored when handling global score files.
19546 Read-only score files will not be updated or saved. Global score files
19547 should feature this atom (@pxref{Global Score Files}). (Note:
19548 @dfn{Global} here really means @dfn{global}; not your personal
19549 apply-to-all-groups score files.)
19552 The value of this entry should be a number. Articles that do not have
19553 parents will get this number added to their scores. Imagine you follow
19554 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
19555 will only follow a few of the threads, also want to see any new threads.
19557 You can do this with the following two score file entries:
19561 (mark-and-expunge -100)
19564 When you enter the group the first time, you will only see the new
19565 threads. You then raise the score of the threads that you find
19566 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
19567 rest. Next time you enter the group, you will see new articles in the
19568 interesting threads, plus any new threads.
19570 I.e.---the orphan score atom is for high-volume groups where a few
19571 interesting threads which can't be found automatically by ordinary
19572 scoring rules exist.
19575 This entry controls the adaptive scoring. If it is @code{t}, the
19576 default adaptive scoring rules will be used. If it is @code{ignore}, no
19577 adaptive scoring will be performed on this group. If it is a list, this
19578 list will be used as the adaptive scoring rules. If it isn't present,
19579 or is something other than @code{t} or @code{ignore}, the default
19580 adaptive scoring rules will be used. If you want to use adaptive
19581 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
19582 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
19583 not want adaptive scoring. If you only want adaptive scoring in a few
19584 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
19585 insert @code{(adapt t)} in the score files of the groups where you want
19589 All adaptive score entries will go to the file named by this entry. It
19590 will also be applied when entering the group. This atom might be handy
19591 if you want to adapt on several groups at once, using the same adaptive
19592 file for a number of groups.
19595 @cindex local variables
19596 The value of this entry should be a list of @code{(@var{var}
19597 @var{value})} pairs. Each @var{var} will be made buffer-local to the
19598 current summary buffer, and set to the value specified. This is a
19599 convenient, if somewhat strange, way of setting variables in some
19600 groups if you don't like hooks much. Note that the @var{value} won't
19605 @node Score File Editing
19606 @section Score File Editing
19608 You normally enter all scoring commands from the summary buffer, but you
19609 might feel the urge to edit them by hand as well, so we've supplied you
19610 with a mode for that.
19612 It's simply a slightly customized @code{emacs-lisp} mode, with these
19613 additional commands:
19618 @kindex C-c C-c (Score)
19619 @findex gnus-score-edit-done
19620 Save the changes you have made and return to the summary buffer
19621 (@code{gnus-score-edit-done}).
19624 @kindex C-c C-d (Score)
19625 @findex gnus-score-edit-insert-date
19626 Insert the current date in numerical format
19627 (@code{gnus-score-edit-insert-date}). This is really the day number, if
19628 you were wondering.
19631 @kindex C-c C-p (Score)
19632 @findex gnus-score-pretty-print
19633 The adaptive score files are saved in an unformatted fashion. If you
19634 intend to read one of these files, you want to @dfn{pretty print} it
19635 first. This command (@code{gnus-score-pretty-print}) does that for
19640 Type @kbd{M-x gnus-score-mode} to use this mode.
19642 @vindex gnus-score-mode-hook
19643 @code{gnus-score-menu-hook} is run in score mode buffers.
19645 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
19646 @kbd{V t} to begin editing score files.
19649 @node Adaptive Scoring
19650 @section Adaptive Scoring
19651 @cindex adaptive scoring
19653 If all this scoring is getting you down, Gnus has a way of making it all
19654 happen automatically---as if by magic. Or rather, as if by artificial
19655 stupidity, to be precise.
19657 @vindex gnus-use-adaptive-scoring
19658 When you read an article, or mark an article as read, or kill an
19659 article, you leave marks behind. On exit from the group, Gnus can sniff
19660 these marks and add score elements depending on what marks it finds.
19661 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
19662 @code{t} or @code{(line)}. If you want score adaptively on separate
19663 words appearing in the subjects, you should set this variable to
19664 @code{(word)}. If you want to use both adaptive methods, set this
19665 variable to @code{(word line)}.
19667 @vindex gnus-default-adaptive-score-alist
19668 To give you complete control over the scoring process, you can customize
19669 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
19670 might look something like this:
19673 (setq gnus-default-adaptive-score-alist
19674 '((gnus-unread-mark)
19675 (gnus-ticked-mark (from 4))
19676 (gnus-dormant-mark (from 5))
19677 (gnus-del-mark (from -4) (subject -1))
19678 (gnus-read-mark (from 4) (subject 2))
19679 (gnus-expirable-mark (from -1) (subject -1))
19680 (gnus-killed-mark (from -1) (subject -3))
19681 (gnus-kill-file-mark)
19682 (gnus-ancient-mark)
19683 (gnus-low-score-mark)
19684 (gnus-catchup-mark (from -1) (subject -1))))
19687 As you see, each element in this alist has a mark as a key (either a
19688 variable name or a ``real'' mark---a character). Following this key is
19689 a arbitrary number of header/score pairs. If there are no header/score
19690 pairs following the key, no adaptive scoring will be done on articles
19691 that have that key as the article mark. For instance, articles with
19692 @code{gnus-unread-mark} in the example above will not get adaptive score
19695 Each article can have only one mark, so just a single of these rules
19696 will be applied to each article.
19698 To take @code{gnus-del-mark} as an example---this alist says that all
19699 articles that have that mark (i.e., are marked with @samp{e}) will have a
19700 score entry added to lower based on the @code{From} header by -4, and
19701 lowered by @code{Subject} by -1. Change this to fit your prejudices.
19703 If you have marked 10 articles with the same subject with
19704 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
19705 That means that that subject will get a score of ten times -1, which
19706 should be, unless I'm much mistaken, -10.
19708 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
19709 the read articles will be marked with the @samp{E} mark. This'll
19710 probably make adaptive scoring slightly impossible, so auto-expiring and
19711 adaptive scoring doesn't really mix very well.
19713 The headers you can score on are @code{from}, @code{subject},
19714 @code{message-id}, @code{references}, @code{xref}, @code{lines},
19715 @code{chars} and @code{date}. In addition, you can score on
19716 @code{followup}, which will create an adaptive score entry that matches
19717 on the @code{References} header using the @code{Message-ID} of the
19718 current article, thereby matching the following thread.
19720 If you use this scheme, you should set the score file atom @code{mark}
19721 to something small---like -300, perhaps, to avoid having small random
19722 changes result in articles getting marked as read.
19724 After using adaptive scoring for a week or so, Gnus should start to
19725 become properly trained and enhance the authors you like best, and kill
19726 the authors you like least, without you having to say so explicitly.
19728 You can control what groups the adaptive scoring is to be performed on
19729 by using the score files (@pxref{Score File Format}). This will also
19730 let you use different rules in different groups.
19732 @vindex gnus-adaptive-file-suffix
19733 The adaptive score entries will be put into a file where the name is the
19734 group name with @code{gnus-adaptive-file-suffix} appended. The default
19737 @vindex gnus-score-exact-adapt-limit
19738 When doing adaptive scoring, substring or fuzzy matching would probably
19739 give you the best results in most cases. However, if the header one
19740 matches is short, the possibility for false positives is great, so if
19741 the length of the match is less than
19742 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
19743 this variable is @code{nil}, exact matching will always be used to avoid
19746 @vindex gnus-default-adaptive-word-score-alist
19747 As mentioned above, you can adapt either on individual words or entire
19748 headers. If you adapt on words, the
19749 @code{gnus-default-adaptive-word-score-alist} variable says what score
19750 each instance of a word should add given a mark.
19753 (setq gnus-default-adaptive-word-score-alist
19754 `((,gnus-read-mark . 30)
19755 (,gnus-catchup-mark . -10)
19756 (,gnus-killed-mark . -20)
19757 (,gnus-del-mark . -15)))
19760 This is the default value. If you have adaption on words enabled, every
19761 word that appears in subjects of articles marked with
19762 @code{gnus-read-mark} will result in a score rule that increase the
19763 score with 30 points.
19765 @vindex gnus-default-ignored-adaptive-words
19766 @vindex gnus-ignored-adaptive-words
19767 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
19768 will be ignored. If you wish to add more words to be ignored, use the
19769 @code{gnus-ignored-adaptive-words} list instead.
19771 @vindex gnus-adaptive-word-length-limit
19772 Some may feel that short words shouldn't count when doing adaptive
19773 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
19774 an integer. Words shorter than this number will be ignored. This
19775 variable defaults to @code{nil}.
19777 @vindex gnus-adaptive-word-syntax-table
19778 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
19779 syntax table in effect. It is similar to the standard syntax table, but
19780 it considers numbers to be non-word-constituent characters.
19782 @vindex gnus-adaptive-word-minimum
19783 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
19784 word scoring process will never bring down the score of an article to
19785 below this number. The default is @code{nil}.
19787 @vindex gnus-adaptive-word-no-group-words
19788 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
19789 won't adaptively word score any of the words in the group name. Useful
19790 for groups like @samp{comp.editors.emacs}, where most of the subject
19791 lines contain the word @samp{emacs}.
19793 After using this scheme for a while, it might be nice to write a
19794 @code{gnus-psychoanalyze-user} command to go through the rules and see
19795 what words you like and what words you don't like. Or perhaps not.
19797 Note that the adaptive word scoring thing is highly experimental and is
19798 likely to change in the future. Initial impressions seem to indicate
19799 that it's totally useless as it stands. Some more work (involving more
19800 rigorous statistical methods) will have to be done to make this useful.
19803 @node Home Score File
19804 @section Home Score File
19806 The score file where new score file entries will go is called the
19807 @dfn{home score file}. This is normally (and by default) the score file
19808 for the group itself. For instance, the home score file for
19809 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
19811 However, this may not be what you want. It is often convenient to share
19812 a common home score file among many groups---all @samp{emacs} groups
19813 could perhaps use the same home score file.
19815 @vindex gnus-home-score-file
19816 The variable that controls this is @code{gnus-home-score-file}. It can
19821 A string. Then this file will be used as the home score file for all
19825 A function. The result of this function will be used as the home score
19826 file. The function will be called with the name of the group as the
19830 A list. The elements in this list can be:
19834 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
19835 group name, the @var{file-name} will be used as the home score file.
19838 A function. If the function returns non-@code{nil}, the result will
19839 be used as the home score file.
19842 A string. Use the string as the home score file.
19845 The list will be traversed from the beginning towards the end looking
19850 So, if you want to use just a single score file, you could say:
19853 (setq gnus-home-score-file
19854 "my-total-score-file.SCORE")
19857 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
19858 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
19860 @findex gnus-hierarchial-home-score-file
19862 (setq gnus-home-score-file
19863 'gnus-hierarchial-home-score-file)
19866 This is a ready-made function provided for your convenience.
19867 Other functions include
19870 @item gnus-current-home-score-file
19871 @findex gnus-current-home-score-file
19872 Return the ``current'' regular score file. This will make scoring
19873 commands add entry to the ``innermost'' matching score file.
19877 If you want to have one score file for the @samp{emacs} groups and
19878 another for the @samp{comp} groups, while letting all other groups use
19879 their own home score files:
19882 (setq gnus-home-score-file
19883 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
19884 '(("\\.emacs" "emacs.SCORE")
19885 ;; @r{All the comp groups in one score file}
19886 ("^comp" "comp.SCORE")))
19889 @vindex gnus-home-adapt-file
19890 @code{gnus-home-adapt-file} works exactly the same way as
19891 @code{gnus-home-score-file}, but says what the home adaptive score file
19892 is instead. All new adaptive file entries will go into the file
19893 specified by this variable, and the same syntax is allowed.
19895 In addition to using @code{gnus-home-score-file} and
19896 @code{gnus-home-adapt-file}, you can also use group parameters
19897 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
19898 Parameters}) to achieve much the same. Group and topic parameters take
19899 precedence over this variable.
19902 @node Followups To Yourself
19903 @section Followups To Yourself
19905 Gnus offers two commands for picking out the @code{Message-ID} header in
19906 the current buffer. Gnus will then add a score rule that scores using
19907 this @code{Message-ID} on the @code{References} header of other
19908 articles. This will, in effect, increase the score of all articles that
19909 respond to the article in the current buffer. Quite useful if you want
19910 to easily note when people answer what you've said.
19914 @item gnus-score-followup-article
19915 @findex gnus-score-followup-article
19916 This will add a score to articles that directly follow up your own
19919 @item gnus-score-followup-thread
19920 @findex gnus-score-followup-thread
19921 This will add a score to all articles that appear in a thread ``below''
19925 @vindex message-sent-hook
19926 These two functions are both primarily meant to be used in hooks like
19927 @code{message-sent-hook}, like this:
19929 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
19933 If you look closely at your own @code{Message-ID}, you'll notice that
19934 the first two or three characters are always the same. Here's two of
19938 <x6u3u47icf.fsf@@eyesore.no>
19939 <x6sp9o7ibw.fsf@@eyesore.no>
19942 So ``my'' ident on this machine is @samp{x6}. This can be
19943 exploited---the following rule will raise the score on all followups to
19948 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
19952 Whether it's the first two or first three characters that are ``yours''
19953 is system-dependent.
19956 @node Scoring On Other Headers
19957 @section Scoring On Other Headers
19958 @cindex scoring on other headers
19960 Gnus is quite fast when scoring the ``traditional''
19961 headers---@samp{From}, @samp{Subject} and so on. However, scoring
19962 other headers requires writing a @code{head} scoring rule, which means
19963 that Gnus has to request every single article from the back end to find
19964 matches. This takes a long time in big groups.
19966 Now, there's not much you can do about this for news groups, but for
19967 mail groups, you have greater control. In @ref{To From Newsgroups},
19968 it's explained in greater detail what this mechanism does, but here's
19969 a cookbook example for @code{nnml} on how to allow scoring on the
19970 @samp{To} and @samp{Cc} headers.
19972 Put the following in your @file{~/.gnus.el} file.
19975 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
19976 nnmail-extra-headers gnus-extra-headers)
19979 Restart Gnus and rebuild your @code{nnml} overview files with the
19980 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
19981 time if you have much mail.
19983 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
19984 so: @kbd{I e s p To RET <your name> RET}.
19990 @section Scoring Tips
19991 @cindex scoring tips
19997 @cindex scoring crossposts
19998 If you want to lower the score of crossposts, the line to match on is
19999 the @code{Xref} header.
20001 ("xref" (" talk.politics.misc:" -1000))
20004 @item Multiple crossposts
20005 If you want to lower the score of articles that have been crossposted to
20006 more than, say, 3 groups:
20009 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
20013 @item Matching on the body
20014 This is generally not a very good idea---it takes a very long time.
20015 Gnus actually has to fetch each individual article from the server. But
20016 you might want to anyway, I guess. Even though there are three match
20017 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
20018 and stick with it in each score file. If you use any two, each article
20019 will be fetched @emph{twice}. If you want to match a bit on the
20020 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
20023 @item Marking as read
20024 You will probably want to mark articles that have scores below a certain
20025 number as read. This is most easily achieved by putting the following
20026 in your @file{all.SCORE} file:
20030 You may also consider doing something similar with @code{expunge}.
20032 @item Negated character classes
20033 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
20034 That will match newlines, which might lead to, well, The Unknown. Say
20035 @code{[^abcd\n]*} instead.
20039 @node Reverse Scoring
20040 @section Reverse Scoring
20041 @cindex reverse scoring
20043 If you want to keep just articles that have @samp{Sex with Emacs} in the
20044 subject header, and expunge all other articles, you could put something
20045 like this in your score file:
20049 ("Sex with Emacs" 2))
20054 So, you raise all articles that match @samp{Sex with Emacs} and mark the
20055 rest as read, and expunge them to boot.
20058 @node Global Score Files
20059 @section Global Score Files
20060 @cindex global score files
20062 Sure, other newsreaders have ``global kill files''. These are usually
20063 nothing more than a single kill file that applies to all groups, stored
20064 in the user's home directory. Bah! Puny, weak newsreaders!
20066 What I'm talking about here are Global Score Files. Score files from
20067 all over the world, from users everywhere, uniting all nations in one
20068 big, happy score file union! Ange-score! New and untested!
20070 @vindex gnus-global-score-files
20071 All you have to do to use other people's score files is to set the
20072 @code{gnus-global-score-files} variable. One entry for each score file,
20073 or each score file directory. Gnus will decide by itself what score
20074 files are applicable to which group.
20076 To use the score file
20077 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
20078 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
20082 (setq gnus-global-score-files
20083 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
20084 "/ftp@@ftp.some-where:/pub/score/"))
20087 @findex gnus-score-search-global-directories
20089 Simple, eh? Directory names must end with a @samp{/}. These
20090 directories are typically scanned only once during each Gnus session.
20091 If you feel the need to manually re-scan the remote directories, you can
20092 use the @code{gnus-score-search-global-directories} command.
20094 Note that, at present, using this option will slow down group entry
20095 somewhat. (That is---a lot.)
20097 If you want to start maintaining score files for other people to use,
20098 just put your score file up for anonymous ftp and announce it to the
20099 world. Become a retro-moderator! Participate in the retro-moderator
20100 wars sure to ensue, where retro-moderators battle it out for the
20101 sympathy of the people, luring them to use their score files on false
20102 premises! Yay! The net is saved!
20104 Here are some tips for the would-be retro-moderator, off the top of my
20110 Articles heavily crossposted are probably junk.
20112 To lower a single inappropriate article, lower by @code{Message-ID}.
20114 Particularly brilliant authors can be raised on a permanent basis.
20116 Authors that repeatedly post off-charter for the group can safely be
20117 lowered out of existence.
20119 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
20120 articles completely.
20123 Use expiring score entries to keep the size of the file down. You
20124 should probably have a long expiry period, though, as some sites keep
20125 old articles for a long time.
20128 @dots{} I wonder whether other newsreaders will support global score files
20129 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
20130 Wave, xrn and 1stReader are bound to implement scoring. Should we start
20131 holding our breath yet?
20135 @section Kill Files
20138 Gnus still supports those pesky old kill files. In fact, the kill file
20139 entries can now be expiring, which is something I wrote before Daniel
20140 Quinlan thought of doing score files, so I've left the code in there.
20142 In short, kill processing is a lot slower (and I do mean @emph{a lot})
20143 than score processing, so it might be a good idea to rewrite your kill
20144 files into score files.
20146 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
20147 forms into this file, which means that you can use kill files as some
20148 sort of primitive hook function to be run on group entry, even though
20149 that isn't a very good idea.
20151 Normal kill files look like this:
20154 (gnus-kill "From" "Lars Ingebrigtsen")
20155 (gnus-kill "Subject" "ding")
20159 This will mark every article written by me as read, and remove the
20160 marked articles from the summary buffer. Very useful, you'll agree.
20162 Other programs use a totally different kill file syntax. If Gnus
20163 encounters what looks like a @code{rn} kill file, it will take a stab at
20166 Two summary functions for editing a @sc{gnus} kill file:
20171 @kindex M-k (Summary)
20172 @findex gnus-summary-edit-local-kill
20173 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
20176 @kindex M-K (Summary)
20177 @findex gnus-summary-edit-global-kill
20178 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
20181 Two group mode functions for editing the kill files:
20186 @kindex M-k (Group)
20187 @findex gnus-group-edit-local-kill
20188 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
20191 @kindex M-K (Group)
20192 @findex gnus-group-edit-global-kill
20193 Edit the general kill file (@code{gnus-group-edit-global-kill}).
20196 Kill file variables:
20199 @item gnus-kill-file-name
20200 @vindex gnus-kill-file-name
20201 A kill file for the group @samp{soc.motss} is normally called
20202 @file{soc.motss.KILL}. The suffix appended to the group name to get
20203 this file name is detailed by the @code{gnus-kill-file-name} variable.
20204 The ``global'' kill file (not in the score file sense of ``global'', of
20205 course) is just called @file{KILL}.
20207 @vindex gnus-kill-save-kill-file
20208 @item gnus-kill-save-kill-file
20209 If this variable is non-@code{nil}, Gnus will save the
20210 kill file after processing, which is necessary if you use expiring
20213 @item gnus-apply-kill-hook
20214 @vindex gnus-apply-kill-hook
20215 @findex gnus-apply-kill-file-unless-scored
20216 @findex gnus-apply-kill-file
20217 A hook called to apply kill files to a group. It is
20218 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
20219 kill file if you have a score file for the same group, you can set this
20220 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
20221 kill files to be processed, you should set this variable to @code{nil}.
20223 @item gnus-kill-file-mode-hook
20224 @vindex gnus-kill-file-mode-hook
20225 A hook called in kill-file mode buffers.
20230 @node Converting Kill Files
20231 @section Converting Kill Files
20233 @cindex converting kill files
20235 If you have loads of old kill files, you may want to convert them into
20236 score files. If they are ``regular'', you can use
20237 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
20240 The kill to score conversion package isn't included in Gnus by default.
20241 You can fetch it from
20242 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
20244 If your old kill files are very complex---if they contain more
20245 non-@code{gnus-kill} forms than not, you'll have to convert them by
20246 hand. Or just let them be as they are. Gnus will still use them as
20250 @node Advanced Scoring
20251 @section Advanced Scoring
20253 Scoring on Subjects and From headers is nice enough, but what if you're
20254 really interested in what a person has to say only when she's talking
20255 about a particular subject? Or what if you really don't want to
20256 read what person A has to say when she's following up to person B, but
20257 want to read what she says when she's following up to person C?
20259 By using advanced scoring rules you may create arbitrarily complex
20263 * Advanced Scoring Syntax:: A definition.
20264 * Advanced Scoring Examples:: What they look like.
20265 * Advanced Scoring Tips:: Getting the most out of it.
20269 @node Advanced Scoring Syntax
20270 @subsection Advanced Scoring Syntax
20272 Ordinary scoring rules have a string as the first element in the rule.
20273 Advanced scoring rules have a list as the first element. The second
20274 element is the score to be applied if the first element evaluated to a
20275 non-@code{nil} value.
20277 These lists may consist of three logical operators, one redirection
20278 operator, and various match operators.
20285 This logical operator will evaluate each of its arguments until it finds
20286 one that evaluates to @code{false}, and then it'll stop. If all arguments
20287 evaluate to @code{true} values, then this operator will return
20292 This logical operator will evaluate each of its arguments until it finds
20293 one that evaluates to @code{true}. If no arguments are @code{true},
20294 then this operator will return @code{false}.
20299 This logical operator only takes a single argument. It returns the
20300 logical negation of the value of its argument.
20304 There is an @dfn{indirection operator} that will make its arguments
20305 apply to the ancestors of the current article being scored. For
20306 instance, @code{1-} will make score rules apply to the parent of the
20307 current article. @code{2-} will make score rules apply to the
20308 grandparent of the current article. Alternatively, you can write
20309 @code{^^}, where the number of @code{^}s (carets) says how far back into
20310 the ancestry you want to go.
20312 Finally, we have the match operators. These are the ones that do the
20313 real work. Match operators are header name strings followed by a match
20314 and a match type. A typical match operator looks like @samp{("from"
20315 "Lars Ingebrigtsen" s)}. The header names are the same as when using
20316 simple scoring, and the match types are also the same.
20319 @node Advanced Scoring Examples
20320 @subsection Advanced Scoring Examples
20322 Please note that the following examples are score file rules. To
20323 make a complete score file from them, surround them with another pair
20326 Let's say you want to increase the score of articles written by Lars
20327 when he's talking about Gnus:
20332 ("from" "Lars Ingebrigtsen")
20333 ("subject" "Gnus"))
20340 When he writes long articles, he sometimes has something nice to say:
20344 ("from" "Lars Ingebrigtsen")
20351 However, when he responds to things written by Reig Eigil Logge, you
20352 really don't want to read what he's written:
20356 ("from" "Lars Ingebrigtsen")
20357 (1- ("from" "Reig Eigir Logge")))
20361 Everybody that follows up Redmondo when he writes about disappearing
20362 socks should have their scores raised, but only when they talk about
20363 white socks. However, when Lars talks about socks, it's usually not
20370 ("from" "redmondo@@.*no" r)
20371 ("body" "disappearing.*socks" t)))
20372 (! ("from" "Lars Ingebrigtsen"))
20373 ("body" "white.*socks"))
20377 The possibilities are endless.
20380 @node Advanced Scoring Tips
20381 @subsection Advanced Scoring Tips
20383 The @code{&} and @code{|} logical operators do short-circuit logic.
20384 That is, they stop processing their arguments when it's clear what the
20385 result of the operation will be. For instance, if one of the arguments
20386 of an @code{&} evaluates to @code{false}, there's no point in evaluating
20387 the rest of the arguments. This means that you should put slow matches
20388 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
20389 @samp{subject}) first.
20391 The indirection arguments (@code{1-} and so on) will make their
20392 arguments work on previous generations of the thread. If you say
20403 Then that means "score on the from header of the grandparent of the
20404 current article". An indirection is quite fast, but it's better to say:
20410 ("subject" "Gnus")))
20417 (1- ("from" "Lars"))
20418 (1- ("subject" "Gnus")))
20423 @section Score Decays
20424 @cindex score decays
20427 You may find that your scores have a tendency to grow without
20428 bounds, especially if you're using adaptive scoring. If scores get too
20429 big, they lose all meaning---they simply max out and it's difficult to
20430 use them in any sensible way.
20432 @vindex gnus-decay-scores
20433 @findex gnus-decay-score
20434 @vindex gnus-decay-score-function
20435 Gnus provides a mechanism for decaying scores to help with this problem.
20436 When score files are loaded and @code{gnus-decay-scores} is
20437 non-@code{nil}, Gnus will run the score files through the decaying
20438 mechanism thereby lowering the scores of all non-permanent score rules.
20439 The decay itself if performed by the @code{gnus-decay-score-function}
20440 function, which is @code{gnus-decay-score} by default. Here's the
20441 definition of that function:
20444 (defun gnus-decay-score (score)
20445 "Decay SCORE according to `gnus-score-decay-constant'
20446 and `gnus-score-decay-scale'."
20448 (* (if (< score 0) -1 1)
20450 (max gnus-score-decay-constant
20452 gnus-score-decay-scale)))))))
20453 (if (and (featurep 'xemacs)
20454 ;; XEmacs' floor can handle only the floating point
20455 ;; number below the half of the maximum integer.
20456 (> (abs n) (lsh -1 -2)))
20458 (car (split-string (number-to-string n) "\\.")))
20462 @vindex gnus-score-decay-scale
20463 @vindex gnus-score-decay-constant
20464 @code{gnus-score-decay-constant} is 3 by default and
20465 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
20469 Scores between -3 and 3 will be set to 0 when this function is called.
20472 Scores with magnitudes between 3 and 60 will be shrunk by 3.
20475 Scores with magnitudes greater than 60 will be shrunk by 5% of the
20479 If you don't like this decay function, write your own. It is called
20480 with the score to be decayed as its only parameter, and it should return
20481 the new score, which should be an integer.
20483 Gnus will try to decay scores once a day. If you haven't run Gnus for
20484 four days, Gnus will decay the scores four times, for instance.
20489 @include message.texi
20490 @chapter Emacs MIME
20491 @include emacs-mime.texi
20493 @include sieve.texi
20505 * Process/Prefix:: A convention used by many treatment commands.
20506 * Interactive:: Making Gnus ask you many questions.
20507 * Symbolic Prefixes:: How to supply some Gnus functions with options.
20508 * Formatting Variables:: You can specify what buffers should look like.
20509 * Window Layout:: Configuring the Gnus buffer windows.
20510 * Faces and Fonts:: How to change how faces look.
20511 * Compilation:: How to speed Gnus up.
20512 * Mode Lines:: Displaying information in the mode lines.
20513 * Highlighting and Menus:: Making buffers look all nice and cozy.
20514 * Buttons:: Get tendinitis in ten easy steps!
20515 * Daemons:: Gnus can do things behind your back.
20516 * NoCeM:: How to avoid spam and other fatty foods.
20517 * Undo:: Some actions can be undone.
20518 * Predicate Specifiers:: Specifying predicates.
20519 * Moderation:: What to do if you're a moderator.
20520 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
20521 * Fuzzy Matching:: What's the big fuzz?
20522 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
20523 * Other modes:: Interaction with other modes.
20524 * Various Various:: Things that are really various.
20528 @node Process/Prefix
20529 @section Process/Prefix
20530 @cindex process/prefix convention
20532 Many functions, among them functions for moving, decoding and saving
20533 articles, use what is known as the @dfn{Process/Prefix convention}.
20535 This is a method for figuring out what articles the user wants the
20536 command to be performed on.
20540 If the numeric prefix is N, perform the operation on the next N
20541 articles, starting with the current one. If the numeric prefix is
20542 negative, perform the operation on the previous N articles, starting
20543 with the current one.
20545 @vindex transient-mark-mode
20546 If @code{transient-mark-mode} in non-@code{nil} and the region is
20547 active, all articles in the region will be worked upon.
20549 If there is no numeric prefix, but some articles are marked with the
20550 process mark, perform the operation on the articles marked with
20553 If there is neither a numeric prefix nor any articles marked with the
20554 process mark, just perform the operation on the current article.
20556 Quite simple, really, but it needs to be made clear so that surprises
20559 Commands that react to the process mark will push the current list of
20560 process marked articles onto a stack and will then clear all process
20561 marked articles. You can restore the previous configuration with the
20562 @kbd{M P y} command (@pxref{Setting Process Marks}).
20564 @vindex gnus-summary-goto-unread
20565 One thing that seems to shock & horrify lots of people is that, for
20566 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
20567 Since each @kbd{d} (which marks the current article as read) by default
20568 goes to the next unread article after marking, this means that @kbd{3 d}
20569 will mark the next three unread articles as read, no matter what the
20570 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
20571 @code{nil} for a more straightforward action.
20573 Many commands do not use the process/prefix convention. All commands
20574 that do explicitly say so in this manual. To apply the process/prefix
20575 convention to commands that do not use it, you can use the @kbd{M-&}
20576 command. For instance, to mark all the articles in the group as
20577 expirable, you could say @kbd{M P b M-& E}.
20581 @section Interactive
20582 @cindex interaction
20586 @item gnus-novice-user
20587 @vindex gnus-novice-user
20588 If this variable is non-@code{nil}, you are either a newcomer to the
20589 World of Usenet, or you are very cautious, which is a nice thing to be,
20590 really. You will be given questions of the type ``Are you sure you want
20591 to do this?'' before doing anything dangerous. This is @code{t} by
20594 @item gnus-expert-user
20595 @vindex gnus-expert-user
20596 If this variable is non-@code{nil}, you will seldom be asked any
20597 questions by Gnus. It will simply assume you know what you're doing, no
20598 matter how strange.
20600 @item gnus-interactive-catchup
20601 @vindex gnus-interactive-catchup
20602 Require confirmation before catching up a group if non-@code{nil}. It
20603 is @code{t} by default.
20605 @item gnus-interactive-exit
20606 @vindex gnus-interactive-exit
20607 Require confirmation before exiting Gnus. This variable is @code{t} by
20612 @node Symbolic Prefixes
20613 @section Symbolic Prefixes
20614 @cindex symbolic prefixes
20616 Quite a lot of Emacs commands react to the (numeric) prefix. For
20617 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
20618 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
20619 rule of 900 to the current article.
20621 This is all nice and well, but what if you want to give a command some
20622 additional information? Well, what most commands do is interpret the
20623 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
20624 doesn't want a backup file to be created when saving the current buffer,
20625 for instance. But what if you want to save without making a backup
20626 file, and you want Emacs to flash lights and play a nice tune at the
20627 same time? You can't, and you're probably perfectly happy that way.
20629 @kindex M-i (Summary)
20630 @findex gnus-symbolic-argument
20631 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
20632 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
20633 character typed in is the value. You can stack as many @kbd{M-i}
20634 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
20635 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
20636 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
20637 @code{b}''. You get the drift.
20639 Typing in symbolic prefixes to commands that don't accept them doesn't
20640 hurt, but it doesn't do any good either. Currently not many Gnus
20641 functions make use of the symbolic prefix.
20643 If you're interested in how Gnus implements this, @pxref{Extended
20647 @node Formatting Variables
20648 @section Formatting Variables
20649 @cindex formatting variables
20651 Throughout this manual you've probably noticed lots of variables called
20652 things like @code{gnus-group-line-format} and
20653 @code{gnus-summary-mode-line-format}. These control how Gnus is to
20654 output lines in the various buffers. There's quite a lot of them.
20655 Fortunately, they all use the same syntax, so there's not that much to
20658 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
20659 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
20660 lots of percentages everywhere.
20663 * Formatting Basics:: A formatting variable is basically a format string.
20664 * Mode Line Formatting:: Some rules about mode line formatting variables.
20665 * Advanced Formatting:: Modifying output in various ways.
20666 * User-Defined Specs:: Having Gnus call your own functions.
20667 * Formatting Fonts:: Making the formatting look colorful and nice.
20668 * Positioning Point:: Moving point to a position after an operation.
20669 * Tabulation:: Tabulating your output.
20670 * Wide Characters:: Dealing with wide characters.
20673 Currently Gnus uses the following formatting variables:
20674 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
20675 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
20676 @code{gnus-group-mode-line-format},
20677 @code{gnus-summary-mode-line-format},
20678 @code{gnus-article-mode-line-format},
20679 @code{gnus-server-mode-line-format}, and
20680 @code{gnus-summary-pick-line-format}.
20682 All these format variables can also be arbitrary elisp forms. In that
20683 case, they will be @code{eval}ed to insert the required lines.
20685 @kindex M-x gnus-update-format
20686 @findex gnus-update-format
20687 Gnus includes a command to help you while creating your own format
20688 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
20689 update the spec in question and pop you to a buffer where you can
20690 examine the resulting Lisp code to be run to generate the line.
20694 @node Formatting Basics
20695 @subsection Formatting Basics
20697 Each @samp{%} element will be replaced by some string or other when the
20698 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
20699 spec, and pad with spaces to get a 5-character field''.
20701 As with normal C and Emacs Lisp formatting strings, the numerical
20702 modifier between the @samp{%} and the formatting type character will
20703 @dfn{pad} the output so that it is always at least that long.
20704 @samp{%5y} will make the field always (at least) five characters wide by
20705 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
20708 You may also wish to limit the length of the field to protect against
20709 particularly wide values. For that you can say @samp{%4,6y}, which
20710 means that the field will never be more than 6 characters wide and never
20711 less than 4 characters wide.
20713 Also Gnus supports some extended format specifications, such as
20714 @samp{%&user-date;}.
20717 @node Mode Line Formatting
20718 @subsection Mode Line Formatting
20720 Mode line formatting variables (e.g.,
20721 @code{gnus-summary-mode-line-format}) follow the same rules as other,
20722 buffer line oriented formatting variables (@pxref{Formatting Basics})
20723 with the following two differences:
20728 There must be no newline (@samp{\n}) at the end.
20731 The special @samp{%%b} spec can be used to display the buffer name.
20732 Well, it's no spec at all, really---@samp{%%} is just a way to quote
20733 @samp{%} to allow it to pass through the formatting machinery unmangled,
20734 so that Emacs receives @samp{%b}, which is something the Emacs mode line
20735 display interprets to mean ``show the buffer name''. For a full list of
20736 mode line specs Emacs understands, see the documentation of the
20737 @code{mode-line-format} variable.
20742 @node Advanced Formatting
20743 @subsection Advanced Formatting
20745 It is frequently useful to post-process the fields in some way.
20746 Padding, limiting, cutting off parts and suppressing certain values can
20747 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
20748 look like @samp{%~(cut 3)~(ignore "0")y}.
20750 These are the valid modifiers:
20755 Pad the field to the left with spaces until it reaches the required
20759 Pad the field to the right with spaces until it reaches the required
20764 Cut off characters from the left until it reaches the specified length.
20767 Cut off characters from the right until it reaches the specified
20772 Cut off the specified number of characters from the left.
20775 Cut off the specified number of characters from the right.
20778 Return an empty string if the field is equal to the specified value.
20781 Use the specified form as the field value when the @samp{@@} spec is
20787 "~(form (current-time-string))@@"
20792 Let's take an example. The @samp{%o} spec in the summary mode lines
20793 will return a date in compact ISO8601 format---@samp{19960809T230410}.
20794 This is quite a mouthful, so we want to shave off the century number and
20795 the time, leaving us with a six-character date. That would be
20796 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
20797 maxing, and we need the padding to ensure that the date is never less
20798 than 6 characters to make it look nice in columns.)
20800 Ignoring is done first; then cutting; then maxing; and then as the very
20801 last operation, padding.
20803 If you use lots of these advanced thingies, you'll find that Gnus gets
20804 quite slow. This can be helped enormously by running @kbd{M-x
20805 gnus-compile} when you are satisfied with the look of your lines.
20806 @xref{Compilation}.
20809 @node User-Defined Specs
20810 @subsection User-Defined Specs
20812 All the specs allow for inserting user defined specifiers---@samp{u}.
20813 The next character in the format string should be a letter. Gnus
20814 will call the function @code{gnus-user-format-function-}@samp{X}, where
20815 @samp{X} is the letter following @samp{%u}. The function will be passed
20816 a single parameter---what the parameter means depends on what buffer
20817 it's being called from. The function should return a string, which will
20818 be inserted into the buffer just like information from any other
20819 specifier. This function may also be called with dummy values, so it
20820 should protect against that.
20822 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
20823 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
20825 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
20826 much the same without defining new functions. Here's an example:
20827 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
20828 given here will be evaluated to yield the current line number, and then
20832 @node Formatting Fonts
20833 @subsection Formatting Fonts
20835 There are specs for highlighting, and these are shared by all the format
20836 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
20837 the special @code{mouse-face} property set, which means that it will be
20838 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
20841 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
20842 normal faces set using @code{gnus-face-0}, which is @code{bold} by
20843 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
20844 and so on. Create as many faces as you wish. The same goes for the
20845 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
20846 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
20848 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
20849 special @code{balloon-help} property set to
20850 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
20851 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
20852 variables should be either strings or symbols naming functions that
20853 return a string. When the mouse passes over text with this property
20854 set, a balloon window will appear and display the string. Please
20855 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
20856 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
20857 XEmacs) for more information on this. (For technical reasons, the
20858 guillemets have been approximated as @samp{<<} and @samp{>>} in this
20861 Here's an alternative recipe for the group buffer:
20864 ;; @r{Create three face types.}
20865 (setq gnus-face-1 'bold)
20866 (setq gnus-face-3 'italic)
20868 ;; @r{We want the article count to be in}
20869 ;; @r{a bold and green face. So we create}
20870 ;; @r{a new face called @code{my-green-bold}.}
20871 (copy-face 'bold 'my-green-bold)
20872 ;; @r{Set the color.}
20873 (set-face-foreground 'my-green-bold "ForestGreen")
20874 (setq gnus-face-2 'my-green-bold)
20876 ;; @r{Set the new & fancy format.}
20877 (setq gnus-group-line-format
20878 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
20881 I'm sure you'll be able to use this scheme to create totally unreadable
20882 and extremely vulgar displays. Have fun!
20884 Note that the @samp{%(} specs (and friends) do not make any sense on the
20885 mode-line variables.
20887 @node Positioning Point
20888 @subsection Positioning Point
20890 Gnus usually moves point to a pre-defined place on each line in most
20891 buffers. By default, point move to the first colon character on the
20892 line. You can customize this behaviour in three different ways.
20894 You can move the colon character to somewhere else on the line.
20896 @findex gnus-goto-colon
20897 You can redefine the function that moves the point to the colon. The
20898 function is called @code{gnus-goto-colon}.
20900 But perhaps the most convenient way to deal with this, if you don't want
20901 to have a colon in your line, is to use the @samp{%*} specifier. If you
20902 put a @samp{%*} somewhere in your format line definition, Gnus will
20907 @subsection Tabulation
20909 You can usually line up your displays by padding and cutting your
20910 strings. However, when combining various strings of different size, it
20911 can often be more convenient to just output the strings, and then worry
20912 about lining up the following text afterwards.
20914 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
20915 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
20917 @samp{%50=} will insert space characters to pad the line up to column
20918 50. If the text is already past column 50, nothing will be inserted.
20919 This is the soft tabulator.
20921 @samp{%-50=} will insert space characters to pad the line up to column
20922 50. If the text is already past column 50, the excess text past column
20923 50 will be removed. This is the hard tabulator.
20926 @node Wide Characters
20927 @subsection Wide Characters
20929 Fixed width fonts in most countries have characters of the same width.
20930 Some countries, however, use Latin characters mixed with wider
20931 characters---most notable East Asian countries.
20933 The problem is that when formatting, Gnus assumes that if a string is 10
20934 characters wide, it'll be 10 Latin characters wide on the screen. In
20935 these countries, that's not true.
20937 @vindex gnus-use-correct-string-widths
20938 To help fix this, you can set @code{gnus-use-correct-string-widths} to
20939 @code{t}. This makes buffer generation slower, but the results will be
20940 prettier. The default value under XEmacs is @code{t} but @code{nil}
20944 @node Window Layout
20945 @section Window Layout
20946 @cindex window layout
20948 No, there's nothing here about X, so be quiet.
20950 @vindex gnus-use-full-window
20951 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
20952 other windows and occupy the entire Emacs screen by itself. It is
20953 @code{t} by default.
20955 Setting this variable to @code{nil} kinda works, but there are
20956 glitches. Use at your own peril.
20958 @vindex gnus-buffer-configuration
20959 @code{gnus-buffer-configuration} describes how much space each Gnus
20960 buffer should be given. Here's an excerpt of this variable:
20963 ((group (vertical 1.0 (group 1.0 point)
20964 (if gnus-carpal (group-carpal 4))))
20965 (article (vertical 1.0 (summary 0.25 point)
20969 This is an alist. The @dfn{key} is a symbol that names some action or
20970 other. For instance, when displaying the group buffer, the window
20971 configuration function will use @code{group} as the key. A full list of
20972 possible names is listed below.
20974 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
20975 should occupy. To take the @code{article} split as an example -
20978 (article (vertical 1.0 (summary 0.25 point)
20982 This @dfn{split} says that the summary buffer should occupy 25% of upper
20983 half of the screen, and that it is placed over the article buffer. As
20984 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
20985 reaching for that calculator there). However, the special number
20986 @code{1.0} is used to signal that this buffer should soak up all the
20987 rest of the space available after the rest of the buffers have taken
20988 whatever they need. There should be only one buffer with the @code{1.0}
20989 size spec per split.
20991 Point will be put in the buffer that has the optional third element
20992 @code{point}. In a @code{frame} split, the last subsplit having a leaf
20993 split where the tag @code{frame-focus} is a member (i.e. is the third or
20994 fourth element in the list, depending on whether the @code{point} tag is
20995 present) gets focus.
20997 Here's a more complicated example:
21000 (article (vertical 1.0 (group 4)
21001 (summary 0.25 point)
21002 (if gnus-carpal (summary-carpal 4))
21006 If the size spec is an integer instead of a floating point number,
21007 then that number will be used to say how many lines a buffer should
21008 occupy, not a percentage.
21010 If the @dfn{split} looks like something that can be @code{eval}ed (to be
21011 precise---if the @code{car} of the split is a function or a subr), this
21012 split will be @code{eval}ed. If the result is non-@code{nil}, it will
21013 be used as a split. This means that there will be three buffers if
21014 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
21017 Not complicated enough for you? Well, try this on for size:
21020 (article (horizontal 1.0
21025 (summary 0.25 point)
21030 Whoops. Two buffers with the mystery 100% tag. And what's that
21031 @code{horizontal} thingie?
21033 If the first element in one of the split is @code{horizontal}, Gnus will
21034 split the window horizontally, giving you two windows side-by-side.
21035 Inside each of these strips you may carry on all you like in the normal
21036 fashion. The number following @code{horizontal} says what percentage of
21037 the screen is to be given to this strip.
21039 For each split, there @emph{must} be one element that has the 100% tag.
21040 The splitting is never accurate, and this buffer will eat any leftover
21041 lines from the splits.
21043 To be slightly more formal, here's a definition of what a valid split
21048 split = frame | horizontal | vertical | buffer | form
21049 frame = "(frame " size *split ")"
21050 horizontal = "(horizontal " size *split ")"
21051 vertical = "(vertical " size *split ")"
21052 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
21053 size = number | frame-params
21054 buf-name = group | article | summary ...
21058 The limitations are that the @code{frame} split can only appear as the
21059 top-level split. @var{form} should be an Emacs Lisp form that should
21060 return a valid split. We see that each split is fully recursive, and
21061 may contain any number of @code{vertical} and @code{horizontal} splits.
21063 @vindex gnus-window-min-width
21064 @vindex gnus-window-min-height
21065 @cindex window height
21066 @cindex window width
21067 Finding the right sizes can be a bit complicated. No window may be less
21068 than @code{gnus-window-min-height} (default 1) characters high, and all
21069 windows must be at least @code{gnus-window-min-width} (default 1)
21070 characters wide. Gnus will try to enforce this before applying the
21071 splits. If you want to use the normal Emacs window width/height limit,
21072 you can just set these two variables to @code{nil}.
21074 If you're not familiar with Emacs terminology, @code{horizontal} and
21075 @code{vertical} splits may work the opposite way of what you'd expect.
21076 Windows inside a @code{horizontal} split are shown side-by-side, and
21077 windows within a @code{vertical} split are shown above each other.
21079 @findex gnus-configure-frame
21080 If you want to experiment with window placement, a good tip is to call
21081 @code{gnus-configure-frame} directly with a split. This is the function
21082 that does all the real work when splitting buffers. Below is a pretty
21083 nonsensical configuration with 5 windows; two for the group buffer and
21084 three for the article buffer. (I said it was nonsensical.) If you
21085 @code{eval} the statement below, you can get an idea of how that would
21086 look straight away, without going through the normal Gnus channels.
21087 Play with it until you're satisfied, and then use
21088 @code{gnus-add-configuration} to add your new creation to the buffer
21089 configuration list.
21092 (gnus-configure-frame
21096 (article 0.3 point))
21104 You might want to have several frames as well. No prob---just use the
21105 @code{frame} split:
21108 (gnus-configure-frame
21111 (summary 0.25 point frame-focus)
21113 (vertical ((height . 5) (width . 15)
21114 (user-position . t)
21115 (left . -1) (top . 1))
21120 This split will result in the familiar summary/article window
21121 configuration in the first (or ``main'') frame, while a small additional
21122 frame will be created where picons will be shown. As you can see,
21123 instead of the normal @code{1.0} top-level spec, each additional split
21124 should have a frame parameter alist as the size spec.
21125 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
21126 Reference Manual}. Under XEmacs, a frame property list will be
21127 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
21129 The list of all possible keys for @code{gnus-buffer-configuration} can
21130 be found in its default value.
21132 Note that the @code{message} key is used for both
21133 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
21134 it is desirable to distinguish between the two, something like this
21138 (message (horizontal 1.0
21139 (vertical 1.0 (message 1.0 point))
21141 (if (buffer-live-p gnus-summary-buffer)
21146 One common desire for a multiple frame split is to have a separate frame
21147 for composing mail and news while leaving the original frame intact. To
21148 accomplish that, something like the following can be done:
21153 (if (not (buffer-live-p gnus-summary-buffer))
21154 (car (cdr (assoc 'group gnus-buffer-configuration)))
21155 (car (cdr (assoc 'summary gnus-buffer-configuration))))
21156 (vertical ((user-position . t) (top . 1) (left . 1)
21157 (name . "Message"))
21158 (message 1.0 point))))
21161 @findex gnus-add-configuration
21162 Since the @code{gnus-buffer-configuration} variable is so long and
21163 complicated, there's a function you can use to ease changing the config
21164 of a single setting: @code{gnus-add-configuration}. If, for instance,
21165 you want to change the @code{article} setting, you could say:
21168 (gnus-add-configuration
21169 '(article (vertical 1.0
21171 (summary .25 point)
21175 You'd typically stick these @code{gnus-add-configuration} calls in your
21176 @file{~/.gnus.el} file or in some startup hook---they should be run after
21177 Gnus has been loaded.
21179 @vindex gnus-always-force-window-configuration
21180 If all windows mentioned in the configuration are already visible, Gnus
21181 won't change the window configuration. If you always want to force the
21182 ``right'' window configuration, you can set
21183 @code{gnus-always-force-window-configuration} to non-@code{nil}.
21185 If you're using tree displays (@pxref{Tree Display}), and the tree
21186 window is displayed vertically next to another window, you may also want
21187 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
21190 @subsection Example Window Configurations
21194 Narrow left hand side occupied by group buffer. Right hand side split
21195 between summary buffer (top one-sixth) and article buffer (bottom).
21210 (gnus-add-configuration
21213 (vertical 25 (group 1.0))
21215 (summary 0.16 point)
21218 (gnus-add-configuration
21221 (vertical 25 (group 1.0))
21222 (vertical 1.0 (summary 1.0 point)))))
21228 @node Faces and Fonts
21229 @section Faces and Fonts
21234 Fiddling with fonts and faces used to be very difficult, but these days
21235 it is very simple. You simply say @kbd{M-x customize-face}, pick out
21236 the face you want to alter, and alter it via the standard Customize
21241 @section Compilation
21242 @cindex compilation
21243 @cindex byte-compilation
21245 @findex gnus-compile
21247 Remember all those line format specification variables?
21248 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
21249 on. Now, Gnus will of course heed whatever these variables are, but,
21250 unfortunately, changing them will mean a quite significant slow-down.
21251 (The default values of these variables have byte-compiled functions
21252 associated with them, while the user-generated versions do not, of
21255 To help with this, you can run @kbd{M-x gnus-compile} after you've
21256 fiddled around with the variables and feel that you're (kind of)
21257 satisfied. This will result in the new specs being byte-compiled, and
21258 you'll get top speed again. Gnus will save these compiled specs in the
21259 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
21260 this function, though---you should compile them yourself by sticking
21261 them into the @file{~/.gnus.el} file and byte-compiling that file.)
21265 @section Mode Lines
21268 @vindex gnus-updated-mode-lines
21269 @code{gnus-updated-mode-lines} says what buffers should keep their mode
21270 lines updated. It is a list of symbols. Supported symbols include
21271 @code{group}, @code{article}, @code{summary}, @code{server},
21272 @code{browse}, and @code{tree}. If the corresponding symbol is present,
21273 Gnus will keep that mode line updated with information that may be
21274 pertinent. If this variable is @code{nil}, screen refresh may be
21277 @cindex display-time
21279 @vindex gnus-mode-non-string-length
21280 By default, Gnus displays information on the current article in the mode
21281 lines of the summary and article buffers. The information Gnus wishes
21282 to display (e.g. the subject of the article) is often longer than the
21283 mode lines, and therefore have to be cut off at some point. The
21284 @code{gnus-mode-non-string-length} variable says how long the other
21285 elements on the line is (i.e., the non-info part). If you put
21286 additional elements on the mode line (e.g. a clock), you should modify
21289 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
21291 (add-hook 'display-time-hook
21292 (lambda () (setq gnus-mode-non-string-length
21294 (if line-number-mode 5 0)
21295 (if column-number-mode 4 0)
21296 (length display-time-string)))))
21299 If this variable is @code{nil} (which is the default), the mode line
21300 strings won't be chopped off, and they won't be padded either. Note
21301 that the default is unlikely to be desirable, as even the percentage
21302 complete in the buffer may be crowded off the mode line; the user should
21303 configure this variable appropriately for her configuration.
21306 @node Highlighting and Menus
21307 @section Highlighting and Menus
21309 @cindex highlighting
21312 @vindex gnus-visual
21313 The @code{gnus-visual} variable controls most of the Gnus-prettifying
21314 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
21315 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
21318 This variable can be a list of visual properties that are enabled. The
21319 following elements are valid, and are all included by default:
21322 @item group-highlight
21323 Do highlights in the group buffer.
21324 @item summary-highlight
21325 Do highlights in the summary buffer.
21326 @item article-highlight
21327 Do highlights in the article buffer.
21329 Turn on highlighting in all buffers.
21331 Create menus in the group buffer.
21333 Create menus in the summary buffers.
21335 Create menus in the article buffer.
21337 Create menus in the browse buffer.
21339 Create menus in the server buffer.
21341 Create menus in the score buffers.
21343 Create menus in all buffers.
21346 So if you only want highlighting in the article buffer and menus in all
21347 buffers, you could say something like:
21350 (setq gnus-visual '(article-highlight menu))
21353 If you want highlighting only and no menus whatsoever, you'd say:
21356 (setq gnus-visual '(highlight))
21359 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
21360 in all Gnus buffers.
21362 Other general variables that influence the look of all buffers include:
21365 @item gnus-mouse-face
21366 @vindex gnus-mouse-face
21367 This is the face (i.e., font) used for mouse highlighting in Gnus. No
21368 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
21372 There are hooks associated with the creation of all the different menus:
21376 @item gnus-article-menu-hook
21377 @vindex gnus-article-menu-hook
21378 Hook called after creating the article mode menu.
21380 @item gnus-group-menu-hook
21381 @vindex gnus-group-menu-hook
21382 Hook called after creating the group mode menu.
21384 @item gnus-summary-menu-hook
21385 @vindex gnus-summary-menu-hook
21386 Hook called after creating the summary mode menu.
21388 @item gnus-server-menu-hook
21389 @vindex gnus-server-menu-hook
21390 Hook called after creating the server mode menu.
21392 @item gnus-browse-menu-hook
21393 @vindex gnus-browse-menu-hook
21394 Hook called after creating the browse mode menu.
21396 @item gnus-score-menu-hook
21397 @vindex gnus-score-menu-hook
21398 Hook called after creating the score mode menu.
21409 Those new-fangled @dfn{mouse} contraptions is very popular with the
21410 young, hep kids who don't want to learn the proper way to do things
21411 these days. Why, I remember way back in the summer of '89, when I was
21412 using Emacs on a Tops 20 system. Three hundred users on one single
21413 machine, and every user was running Simula compilers. Bah!
21417 @vindex gnus-carpal
21418 Well, you can make Gnus display bufferfuls of buttons you can click to
21419 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
21420 really. Tell the chiropractor I sent you.
21425 @item gnus-carpal-mode-hook
21426 @vindex gnus-carpal-mode-hook
21427 Hook run in all carpal mode buffers.
21429 @item gnus-carpal-button-face
21430 @vindex gnus-carpal-button-face
21431 Face used on buttons.
21433 @item gnus-carpal-header-face
21434 @vindex gnus-carpal-header-face
21435 Face used on carpal buffer headers.
21437 @item gnus-carpal-group-buffer-buttons
21438 @vindex gnus-carpal-group-buffer-buttons
21439 Buttons in the group buffer.
21441 @item gnus-carpal-summary-buffer-buttons
21442 @vindex gnus-carpal-summary-buffer-buttons
21443 Buttons in the summary buffer.
21445 @item gnus-carpal-server-buffer-buttons
21446 @vindex gnus-carpal-server-buffer-buttons
21447 Buttons in the server buffer.
21449 @item gnus-carpal-browse-buffer-buttons
21450 @vindex gnus-carpal-browse-buffer-buttons
21451 Buttons in the browse buffer.
21454 All the @code{buttons} variables are lists. The elements in these list
21455 are either cons cells where the @code{car} contains a text to be displayed and
21456 the @code{cdr} contains a function symbol, or a simple string.
21464 Gnus, being larger than any program ever written (allegedly), does lots
21465 of strange stuff that you may wish to have done while you're not
21466 present. For instance, you may want it to check for new mail once in a
21467 while. Or you may want it to close down all connections to all servers
21468 when you leave Emacs idle. And stuff like that.
21470 Gnus will let you do stuff like that by defining various
21471 @dfn{handlers}. Each handler consists of three elements: A
21472 @var{function}, a @var{time}, and an @var{idle} parameter.
21474 Here's an example of a handler that closes connections when Emacs has
21475 been idle for thirty minutes:
21478 (gnus-demon-close-connections nil 30)
21481 Here's a handler that scans for @acronym{PGP} headers every hour when
21485 (gnus-demon-scan-pgp 60 t)
21488 This @var{time} parameter and that @var{idle} parameter work together
21489 in a strange, but wonderful fashion. Basically, if @var{idle} is
21490 @code{nil}, then the function will be called every @var{time} minutes.
21492 If @var{idle} is @code{t}, then the function will be called after
21493 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
21494 the function will never be called. But once Emacs goes idle, the
21495 function will be called every @var{time} minutes.
21497 If @var{idle} is a number and @var{time} is a number, the function will
21498 be called every @var{time} minutes only when Emacs has been idle for
21499 @var{idle} minutes.
21501 If @var{idle} is a number and @var{time} is @code{nil}, the function
21502 will be called once every time Emacs has been idle for @var{idle}
21505 And if @var{time} is a string, it should look like @samp{07:31}, and
21506 the function will then be called once every day somewhere near that
21507 time. Modified by the @var{idle} parameter, of course.
21509 @vindex gnus-demon-timestep
21510 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
21511 seconds. This is 60 by default. If you change that variable,
21512 all the timings in the handlers will be affected.)
21514 So, if you want to add a handler, you could put something like this in
21515 your @file{~/.gnus.el} file:
21517 @findex gnus-demon-add-handler
21519 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
21522 @findex gnus-demon-add-nocem
21523 @findex gnus-demon-add-scanmail
21524 @findex gnus-demon-add-rescan
21525 @findex gnus-demon-add-scan-timestamps
21526 @findex gnus-demon-add-disconnection
21527 Some ready-made functions to do this have been created:
21528 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
21529 @code{gnus-demon-add-nntp-close-connection},
21530 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
21531 @code{gnus-demon-add-scanmail}. Just put those functions in your
21532 @file{~/.gnus.el} if you want those abilities.
21534 @findex gnus-demon-init
21535 @findex gnus-demon-cancel
21536 @vindex gnus-demon-handlers
21537 If you add handlers to @code{gnus-demon-handlers} directly, you should
21538 run @code{gnus-demon-init} to make the changes take hold. To cancel all
21539 daemons, you can use the @code{gnus-demon-cancel} function.
21541 Note that adding daemons can be pretty naughty if you over do it. Adding
21542 functions that scan all news and mail from all servers every two seconds
21543 is a sure-fire way of getting booted off any respectable system. So
21552 @dfn{Spamming} is posting the same article lots and lots of times.
21553 Spamming is bad. Spamming is evil.
21555 Spamming is usually canceled within a day or so by various anti-spamming
21556 agencies. These agencies usually also send out @dfn{NoCeM} messages.
21557 NoCeM is pronounced ``no see-'em'', and means what the name
21558 implies---these are messages that make the offending articles, like, go
21561 What use are these NoCeM messages if the articles are canceled anyway?
21562 Some sites do not honor cancel messages and some sites just honor cancels
21563 from a select few people. Then you may wish to make use of the NoCeM
21564 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
21566 Gnus can read and parse the messages in this group automatically, and
21567 this will make spam disappear.
21569 There are some variables to customize, of course:
21572 @item gnus-use-nocem
21573 @vindex gnus-use-nocem
21574 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
21577 @item gnus-nocem-groups
21578 @vindex gnus-nocem-groups
21579 Gnus will look for NoCeM messages in the groups in this list. The
21582 ("news.lists.filters" "news.admin.net-abuse.bulletins"
21583 "alt.nocem.misc" "news.admin.net-abuse.announce")
21586 @item gnus-nocem-issuers
21587 @vindex gnus-nocem-issuers
21588 There are many people issuing NoCeM messages. This list says what
21589 people you want to listen to. The default is
21591 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
21592 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
21594 fine, upstanding citizens all of them.
21596 Known despammers that you can put in this list are listed at@*
21597 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
21599 You do not have to heed NoCeM messages from all these people---just the
21600 ones you want to listen to. You also don't have to accept all NoCeM
21601 messages from the people you like. Each NoCeM message has a @dfn{type}
21602 header that gives the message a (more or less, usually less) rigorous
21603 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
21604 @samp{binary}, and @samp{troll}. To specify this, you have to use
21605 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
21606 Each condition is either a string (which is a regexp that matches types
21607 you want to use) or a list on the form @code{(not @var{string})}, where
21608 @var{string} is a regexp that matches types you don't want to use.
21610 For instance, if you want all NoCeM messages from Chris Lewis except his
21611 @samp{troll} messages, you'd say:
21614 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
21617 On the other hand, if you just want nothing but his @samp{spam} and
21618 @samp{spew} messages, you'd say:
21621 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
21624 The specs are applied left-to-right.
21627 @item gnus-nocem-verifyer
21628 @vindex gnus-nocem-verifyer
21630 This should be a function for verifying that the NoCeM issuer is who she
21631 says she is. The default is @code{mc-verify}, which is a Mailcrypt
21632 function. If this is too slow and you don't care for verification
21633 (which may be dangerous), you can set this variable to @code{nil}.
21635 If you want signed NoCeM messages to be verified and unsigned messages
21636 not to be verified (but used anyway), you could do something like:
21639 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
21641 (defun my-gnus-mc-verify ()
21649 This might be dangerous, though.
21651 @item gnus-nocem-directory
21652 @vindex gnus-nocem-directory
21653 This is where Gnus will store its NoCeM cache files. The default is@*
21654 @file{~/News/NoCeM/}.
21656 @item gnus-nocem-expiry-wait
21657 @vindex gnus-nocem-expiry-wait
21658 The number of days before removing old NoCeM entries from the cache.
21659 The default is 15. If you make it shorter Gnus will be faster, but you
21660 might then see old spam.
21662 @item gnus-nocem-check-from
21663 @vindex gnus-nocem-check-from
21664 Non-@code{nil} means check for valid issuers in message bodies.
21665 Otherwise don't bother fetching articles unless their author matches a
21666 valid issuer; that is much faster if you are selective about the
21669 @item gnus-nocem-check-article-limit
21670 @vindex gnus-nocem-check-article-limit
21671 If non-@code{nil}, the maximum number of articles to check in any NoCeM
21672 group. NoCeM groups can be huge and very slow to process.
21676 Using NoCeM could potentially be a memory hog. If you have many living
21677 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
21678 big. If this is a problem, you should kill off all (or most) of your
21679 unsubscribed groups (@pxref{Subscription Commands}).
21686 It is very useful to be able to undo actions one has done. In normal
21687 Emacs buffers, it's easy enough---you just push the @code{undo} button.
21688 In Gnus buffers, however, it isn't that simple.
21690 The things Gnus displays in its buffer is of no value whatsoever to
21691 Gnus---it's all just data designed to look nice to the user.
21692 Killing a group in the group buffer with @kbd{C-k} makes the line
21693 disappear, but that's just a side-effect of the real action---the
21694 removal of the group in question from the internal Gnus structures.
21695 Undoing something like that can't be done by the normal Emacs
21696 @code{undo} function.
21698 Gnus tries to remedy this somewhat by keeping track of what the user
21699 does and coming up with actions that would reverse the actions the user
21700 takes. When the user then presses the @code{undo} key, Gnus will run
21701 the code to reverse the previous action, or the previous actions.
21702 However, not all actions are easily reversible, so Gnus currently offers
21703 a few key functions to be undoable. These include killing groups,
21704 yanking groups, and changing the list of read articles of groups.
21705 That's it, really. More functions may be added in the future, but each
21706 added function means an increase in data to be stored, so Gnus will
21707 never be totally undoable.
21709 @findex gnus-undo-mode
21710 @vindex gnus-use-undo
21712 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
21713 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
21714 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
21715 command, which should feel kinda like the normal Emacs @code{undo}
21719 @node Predicate Specifiers
21720 @section Predicate Specifiers
21721 @cindex predicate specifiers
21723 Some Gnus variables are @dfn{predicate specifiers}. This is a special
21724 form that allows flexible specification of predicates without having
21725 to type all that much.
21727 These specifiers are lists consisting of functions, symbols and lists.
21732 (or gnus-article-unseen-p
21733 gnus-article-unread-p)
21736 The available symbols are @code{or}, @code{and} and @code{not}. The
21737 functions all take one parameter.
21739 @findex gnus-make-predicate
21740 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
21741 to create a function that can be called. This input parameter to this
21742 function will be passed along to all the functions in the predicate
21747 @section Moderation
21750 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
21751 It is not included in the standard Gnus package. Write a mail to
21752 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
21755 The moderation package is implemented as a minor mode for summary
21759 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
21762 in your @file{~/.gnus.el} file.
21764 If you are the moderator of @samp{rec.zoofle}, this is how it's
21769 You split your incoming mail by matching on
21770 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
21771 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
21774 You enter that group once in a while and post articles using the @kbd{e}
21775 (edit-and-post) or @kbd{s} (just send unedited) commands.
21778 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
21779 articles that weren't approved by you, you can cancel them with the
21783 To use moderation mode in these two groups, say:
21786 (setq gnus-moderated-list
21787 "^nnml:rec.zoofle$\\|^rec.zoofle$")
21791 @node Image Enhancements
21792 @section Image Enhancements
21794 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
21795 support images yet.}, is able to display pictures and stuff, so Gnus has
21796 taken advantage of that.
21799 * X-Face:: Display a funky, teensy black-and-white image.
21800 * Face:: Display a funkier, teensier colored image.
21801 * Smileys:: Show all those happy faces the way they were meant to be shown.
21802 * Picons:: How to display pictures of what you're reading.
21803 * XVarious:: Other XEmacsy Gnusey variables.
21811 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
21812 depth) image that's supposed to represent the author of the message.
21813 It seems to be supported by an ever-growing number of mail and news
21817 @findex gnus-article-display-x-face
21818 @vindex gnus-article-x-face-command
21819 @vindex gnus-article-x-face-too-ugly
21827 Gnus now uses the internal ELisp-based @code{uncompface} program for
21828 decoding an @code{X-Face} header normally in Emacs. While it doesn't
21829 require any other external program, you may feel it is slow if you are
21830 using a slow machine. In such a case, you can modify the following
21834 @item uncompface-use-external
21835 @vindex uncompface-use-external
21836 Specify which of the internal or the external decoder should be used.
21837 @code{nil} means to use the internal ELisp-based @code{uncompface}
21838 program. @code{t} means to use the external decoder. The default value
21839 is normally @code{undecided} which means to determine it by checking
21840 whether the host machine is slow, being controlled by
21841 @code{uncompface-use-external-threshold} (which see).
21843 @item uncompface-use-external-threshold
21844 @vindex uncompface-use-external-threshold
21845 A number of seconds to check whether the host machine is slow. If the
21846 host takes time larger than this value for decoding an @code{X-Face}
21847 using the internal ELisp-based @code{uncompface} program, it will be
21848 changed to using the external decoder. The default is 0.1 seconds.
21851 If the internal decoder is invalidated or if you are using XEmacs,
21852 decoding an @code{X-Face} header either requires an Emacs that has
21853 @samp{compface} support (which most XEmacs versions has), or that you
21854 have @samp{compface} installed on your system. If either is true,
21855 Gnus will default to displaying @code{X-Face} headers.
21857 The variable that controls this is the
21858 @code{gnus-article-x-face-command} variable. If this variable is a
21859 string, this string will be executed in a sub-shell. If it is a
21860 function, this function will be called with the face as the argument.
21861 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
21862 the @code{From} header, the face will not be shown.
21864 The default action under Emacs 20 is to fork off the @code{display}
21865 program@footnote{@code{display} is from the ImageMagick package. For
21866 the @code{uncompface} and @code{icontopbm} programs look for a package
21867 like @code{compface} or @code{faces-xface} on a GNU/Linux system.} to
21870 Under XEmacs or Emacs 21+ with suitable image support, the default
21871 action is to display the face before the @code{From} header. (It's
21872 nicer if XEmacs has been compiled with @code{X-Face} support---that
21873 will make display somewhat faster. If there's no native @code{X-Face}
21874 support, Gnus will try to convert the @code{X-Face} header using
21875 external programs from the @code{pbmplus} package and
21876 friends.@footnote{On a GNU/Linux system look for packages with names
21877 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
21879 (Note: @code{x-face} is used in the variable/function names, not
21887 @vindex gnus-x-face
21888 Face to show X-Face. The colors from this face are used as the
21889 foreground and background colors of the displayed X-Faces. The
21890 default colors are black and white.
21892 @item gnus-face-properties-alist
21893 @vindex gnus-face-properties-alist
21894 Alist of image types and properties applied to Face (@pxref{Face}) and
21895 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
21896 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
21897 XEmacs. Here are examples:
21900 ;; Specify the altitude of Face and X-Face images in the From header.
21901 (setq gnus-face-properties-alist
21902 '((pbm . (:face gnus-x-face :ascent 80))
21903 (png . (:ascent 80))))
21905 ;; Show Face and X-Face images as pressed buttons.
21906 (setq gnus-face-properties-alist
21907 '((pbm . (:face gnus-x-face :relief -2))
21908 (png . (:relief -2))))
21911 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
21912 Reference Manual} for the valid properties for various image types.
21913 Currently, @code{pbm} is used for X-Face images and @code{png} is used
21914 for Face images in Emacs. Only the @code{:face} property is effective
21915 on the @code{xface} image type in XEmacs if it is built with the
21916 @samp{libcompface} library.
21919 Gnus provides a few convenience functions and variables to allow
21920 easier insertion of X-Face headers in outgoing messages.
21922 @findex gnus-random-x-face
21923 @vindex gnus-convert-pbm-to-x-face-command
21924 @vindex gnus-x-face-directory
21925 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
21926 @code{gnus-x-face-directory} and picks one at random, and then
21927 converts it to the X-Face format by using the
21928 @code{gnus-convert-pbm-to-x-face-command} shell command. The
21929 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
21930 header data as a string.
21932 @findex gnus-insert-random-x-face-header
21933 @code{gnus-insert-random-x-face-header} calls
21934 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
21935 randomly generated data.
21937 @findex gnus-x-face-from-file
21938 @vindex gnus-convert-image-to-x-face-command
21939 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
21940 converts the file to X-Face format by using the
21941 @code{gnus-convert-image-to-x-face-command} shell command.
21943 Here's how you would typically use the first function. Put something
21944 like the following in your @file{~/.gnus.el} file:
21947 (setq message-required-news-headers
21948 (nconc message-required-news-headers
21949 (list '(X-Face . gnus-random-x-face))))
21952 Using the last function would be something like this:
21955 (setq message-required-news-headers
21956 (nconc message-required-news-headers
21957 (list '(X-Face . (lambda ()
21958 (gnus-x-face-from-file
21959 "~/My-face.gif"))))))
21967 @c #### FIXME: faces and x-faces'implementations should really be harmonized.
21969 @code{Face} headers are essentially a funkier version of @code{X-Face}
21970 ones. They describe a 48x48 pixel colored image that's supposed to
21971 represent the author of the message.
21974 @findex gnus-article-display-face
21975 The contents of a @code{Face} header must be a base64 encoded PNG image.
21976 See @uref{http://quimby.gnus.org/circus/face/} for the precise
21979 The @code{gnus-face-properties-alist} variable affects the appearance of
21980 displayed Face images. @xref{X-Face}.
21982 Gnus provides a few convenience functions and variables to allow
21983 easier insertion of Face headers in outgoing messages.
21985 @findex gnus-convert-png-to-face
21986 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
21987 726 bytes long, and converts it to a face.
21989 @findex gnus-face-from-file
21990 @vindex gnus-convert-image-to-face-command
21991 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
21992 converts the file to Face format by using the
21993 @code{gnus-convert-image-to-face-command} shell command.
21995 Here's how you would typically use this function. Put something like the
21996 following in your @file{~/.gnus.el} file:
21999 (setq message-required-news-headers
22000 (nconc message-required-news-headers
22001 (list '(Face . (lambda ()
22002 (gnus-face-from-file "~/face.jpg"))))))
22007 @subsection Smileys
22012 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
22017 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
22018 currently the only package that uses Smiley, it is documented here.
22020 In short---to use Smiley in Gnus, put the following in your
22021 @file{~/.gnus.el} file:
22024 (setq gnus-treat-display-smileys t)
22027 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
22028 the like---to pictures and displays those instead of the text smiley
22029 faces. The conversion is controlled by a list of regexps that matches
22030 text and maps that to file names.
22032 @vindex smiley-regexp-alist
22033 The alist used is specified by the @code{smiley-regexp-alist}
22034 variable. The first item in each element is the regexp to be matched;
22035 the second element is the regexp match group that is to be replaced by
22036 the picture; and the third element is the name of the file to be
22039 The following variables customize where Smiley will look for these
22044 @item smiley-data-directory
22045 @vindex smiley-data-directory
22046 Where Smiley will look for smiley faces files.
22048 @item gnus-smiley-file-types
22049 @vindex gnus-smiley-file-types
22050 List of suffixes on smiley file names to try.
22064 So@dots{} You want to slow down your news reader even more! This is a
22065 good way to do so. It's also a great way to impress people staring
22066 over your shoulder as you read news.
22068 What are Picons? To quote directly from the Picons Web site:
22077 @dfn{Picons} is short for ``personal icons''. They're small,
22078 constrained images used to represent users and domains on the net,
22079 organized into databases so that the appropriate image for a given
22080 e-mail address can be found. Besides users and domains, there are picon
22081 databases for Usenet newsgroups and weather forecasts. The picons are
22082 in either monochrome @code{XBM} format or color @code{XPM} and
22083 @code{GIF} formats.
22086 @vindex gnus-picon-databases
22087 For instructions on obtaining and installing the picons databases,
22088 point your Web browser at
22089 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
22091 If you are using Debian GNU/Linux, saying @samp{apt-get install
22092 picons.*} will install the picons where Gnus can find them.
22094 To enable displaying picons, simply make sure that
22095 @code{gnus-picon-databases} points to the directory containing the
22098 The following variables offer control over where things are located.
22102 @item gnus-picon-databases
22103 @vindex gnus-picon-databases
22104 The location of the picons database. This is a list of directories
22105 containing the @file{news}, @file{domains}, @file{users} (and so on)
22106 subdirectories. Defaults to @code{("/usr/lib/picon"
22107 "/usr/local/faces")}.
22109 @item gnus-picon-news-directories
22110 @vindex gnus-picon-news-directories
22111 List of subdirectories to search in @code{gnus-picon-databases} for
22112 newsgroups faces. @code{("news")} is the default.
22114 @item gnus-picon-user-directories
22115 @vindex gnus-picon-user-directories
22116 List of subdirectories to search in @code{gnus-picon-databases} for user
22117 faces. @code{("users" "usenix" "local" "misc")} is the default.
22119 @item gnus-picon-domain-directories
22120 @vindex gnus-picon-domain-directories
22121 List of subdirectories to search in @code{gnus-picon-databases} for
22122 domain name faces. Defaults to @code{("domains")}. Some people may
22123 want to add @samp{"unknown"} to this list.
22125 @item gnus-picon-file-types
22126 @vindex gnus-picon-file-types
22127 Ordered list of suffixes on picon file names to try. Defaults to
22128 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
22134 @subsection Various XEmacs Variables
22137 @item gnus-xmas-glyph-directory
22138 @vindex gnus-xmas-glyph-directory
22139 This is where Gnus will look for pictures. Gnus will normally
22140 auto-detect this directory, but you may set it manually if you have an
22141 unusual directory structure.
22143 @item gnus-xmas-logo-color-alist
22144 @vindex gnus-xmas-logo-color-alist
22145 This is an alist where the key is a type symbol and the values are the
22146 foreground and background color of the splash page glyph.
22148 @item gnus-xmas-logo-color-style
22149 @vindex gnus-xmas-logo-color-style
22150 This is the key used to look up the color in the alist described above.
22151 Valid values include @code{flame}, @code{pine}, @code{moss},
22152 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
22153 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
22155 @item gnus-xmas-modeline-glyph
22156 @vindex gnus-xmas-modeline-glyph
22157 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
22162 @subsubsection Toolbar
22166 @item gnus-use-toolbar
22167 @vindex gnus-use-toolbar
22168 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
22169 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
22170 @code{right-toolbar}, or @code{left-toolbar}.
22172 @item gnus-group-toolbar
22173 @vindex gnus-group-toolbar
22174 The toolbar in the group buffer.
22176 @item gnus-summary-toolbar
22177 @vindex gnus-summary-toolbar
22178 The toolbar in the summary buffer.
22180 @item gnus-summary-mail-toolbar
22181 @vindex gnus-summary-mail-toolbar
22182 The toolbar in the summary buffer of mail groups.
22193 @node Fuzzy Matching
22194 @section Fuzzy Matching
22195 @cindex fuzzy matching
22197 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
22198 things like scoring, thread gathering and thread comparison.
22200 As opposed to regular expression matching, fuzzy matching is very fuzzy.
22201 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
22202 means, and the implementation has changed over time.
22204 Basically, it tries to remove all noise from lines before comparing.
22205 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
22206 out of the strings before comparing the results. This often leads to
22207 adequate results---even when faced with strings generated by text
22208 manglers masquerading as newsreaders.
22211 @node Thwarting Email Spam
22212 @section Thwarting Email Spam
22216 @cindex unsolicited commercial email
22218 In these last days of the Usenet, commercial vultures are hanging about
22219 and grepping through news like crazy to find email addresses they can
22220 foist off their scams and products to. As a reaction to this, many
22221 people have started putting nonsense addresses into their @code{From}
22222 lines. I think this is counterproductive---it makes it difficult for
22223 people to send you legitimate mail in response to things you write, as
22224 well as making it difficult to see who wrote what. This rewriting may
22225 perhaps be a bigger menace than the unsolicited commercial email itself
22228 The biggest problem I have with email spam is that it comes in under
22229 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
22230 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
22231 mail group, only to find two pyramid schemes, seven advertisements
22232 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
22233 and one mail asking me to repent and find some god.
22235 This is annoying. Here's what you can do about it.
22238 * The problem of spam:: Some background, and some solutions
22239 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
22240 * SpamAssassin:: How to use external anti-spam tools.
22241 * Hashcash:: Reduce spam by burning CPU time.
22242 * Filtering Spam Using The Spam ELisp Package::
22243 * Filtering Spam Using Statistics with spam-stat::
22246 @node The problem of spam
22247 @subsection The problem of spam
22249 @cindex spam filtering approaches
22250 @cindex filtering approaches, spam
22252 @cindex unsolicited commercial email
22254 First, some background on spam.
22256 If you have access to e-mail, you are familiar with spam (technically
22257 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
22258 exists because e-mail delivery is very cheap compared to paper mail,
22259 so only a very small percentage of people need to respond to an UCE to
22260 make it worthwhile to the advertiser. Ironically, one of the most
22261 common spams is the one offering a database of e-mail addresses for
22262 further spamming. Senders of spam are usually called @emph{spammers},
22263 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
22264 @emph{morons} are in common use as well.
22266 Spam comes from a wide variety of sources. It is simply impossible to
22267 dispose of all spam without discarding useful messages. A good
22268 example is the TMDA system, which requires senders
22269 unknown to you to confirm themselves as legitimate senders before
22270 their e-mail can reach you. Without getting into the technical side
22271 of TMDA, a downside is clearly that e-mail from legitimate sources may
22272 be discarded if those sources can't or won't confirm themselves
22273 through the TMDA system. Another problem with TMDA is that it
22274 requires its users to have a basic understanding of e-mail delivery
22277 The simplest approach to filtering spam is filtering, at the mail
22278 server or when you sort through incoming mail. If you get 200 spam
22279 messages per day from @samp{random-address@@vmadmin.com}, you block
22280 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
22281 discard all messages with @samp{VIAGRA} in the message. If you get
22282 lots of spam from Bulgaria, for example, you try to filter all mail
22283 from Bulgarian IPs.
22285 This, unfortunately, is a great way to discard legitimate e-mail. The
22286 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
22287 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
22288 you should be obvious, so don't do it if you have the choice.
22290 In another instance, the very informative and useful RISKS digest has
22291 been blocked by overzealous mail filters because it @strong{contained}
22292 words that were common in spam messages. Nevertheless, in isolated
22293 cases, with great care, direct filtering of mail can be useful.
22295 Another approach to filtering e-mail is the distributed spam
22296 processing, for instance DCC implements such a system. In essence,
22297 @var{N} systems around the world agree that a machine @var{X} in
22298 Ghana, Estonia, or California is sending out spam e-mail, and these
22299 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
22300 database. The criteria for spam detection vary---it may be the number
22301 of messages sent, the content of the messages, and so on. When a user
22302 of the distributed processing system wants to find out if a message is
22303 spam, he consults one of those @var{N} systems.
22305 Distributed spam processing works very well against spammers that send
22306 a large number of messages at once, but it requires the user to set up
22307 fairly complicated checks. There are commercial and free distributed
22308 spam processing systems. Distributed spam processing has its risks as
22309 well. For instance legitimate e-mail senders have been accused of
22310 sending spam, and their web sites and mailing lists have been shut
22311 down for some time because of the incident.
22313 The statistical approach to spam filtering is also popular. It is
22314 based on a statistical analysis of previous spam messages. Usually
22315 the analysis is a simple word frequency count, with perhaps pairs of
22316 words or 3-word combinations thrown into the mix. Statistical
22317 analysis of spam works very well in most of the cases, but it can
22318 classify legitimate e-mail as spam in some cases. It takes time to
22319 run the analysis, the full message must be analyzed, and the user has
22320 to store the database of spam analyses. Statistical analysis on the
22321 server is gaining popularity. This has the advantage of letting the
22322 user Just Read Mail, but has the disadvantage that it's harder to tell
22323 the server that it has misclassified mail.
22325 Fighting spam is not easy, no matter what anyone says. There is no
22326 magic switch that will distinguish Viagra ads from Mom's e-mails.
22327 Even people are having a hard time telling spam apart from non-spam,
22328 because spammers are actively looking to fool us into thinking they
22329 are Mom, essentially. Spamming is irritating, irresponsible, and
22330 idiotic behavior from a bunch of people who think the world owes them
22331 a favor. We hope the following sections will help you in fighting the
22334 @node Anti-Spam Basics
22335 @subsection Anti-Spam Basics
22339 @cindex unsolicited commercial email
22341 One way of dealing with spam is having Gnus split out all spam into a
22342 @samp{spam} mail group (@pxref{Splitting Mail}).
22344 First, pick one (1) valid mail address that you can be reached at, and
22345 put it in your @code{From} header of all your news articles. (I've
22346 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
22347 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
22348 sysadmin whether your sendmail installation accepts keywords in the local
22349 part of the mail address.)
22352 (setq message-default-news-headers
22353 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
22356 Then put the following split rule in @code{nnmail-split-fancy}
22357 (@pxref{Fancy Mail Splitting}):
22361 (to "larsi@@trym.ifi.uio.no"
22362 (| ("subject" "re:.*" "misc")
22363 ("references" ".*@@.*" "misc")
22368 This says that all mail to this address is suspect, but if it has a
22369 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
22370 header, it's probably ok. All the rest goes to the @samp{spam} group.
22371 (This idea probably comes from Tim Pierce.)
22373 In addition, many mail spammers talk directly to your @acronym{SMTP} server
22374 and do not include your email address explicitly in the @code{To}
22375 header. Why they do this is unknown---perhaps it's to thwart this
22376 thwarting scheme? In any case, this is trivial to deal with---you just
22377 put anything not addressed to you in the @samp{spam} group by ending
22378 your fancy split rule in this way:
22383 (to "larsi" "misc")
22387 In my experience, this will sort virtually everything into the right
22388 group. You still have to check the @samp{spam} group from time to time to
22389 check for legitimate mail, though. If you feel like being a good net
22390 citizen, you can even send off complaints to the proper authorities on
22391 each unsolicited commercial email---at your leisure.
22393 This works for me. It allows people an easy way to contact me (they can
22394 just press @kbd{r} in the usual way), and I'm not bothered at all with
22395 spam. It's a win-win situation. Forging @code{From} headers to point
22396 to non-existent domains is yucky, in my opinion.
22398 Be careful with this approach. Spammers are wise to it.
22402 @subsection SpamAssassin, Vipul's Razor, DCC, etc
22403 @cindex SpamAssassin
22404 @cindex Vipul's Razor
22407 The days where the hints in the previous section were sufficient in
22408 avoiding spam are coming to an end. There are many tools out there
22409 that claim to reduce the amount of spam you get. This section could
22410 easily become outdated fast, as new products replace old, but
22411 fortunately most of these tools seem to have similar interfaces. Even
22412 though this section will use SpamAssassin as an example, it should be
22413 easy to adapt it to most other tools.
22415 Note that this section does not involve the @code{spam.el} package,
22416 which is discussed in the next section. If you don't care for all
22417 the features of @code{spam.el}, you can make do with these simple
22420 If the tool you are using is not installed on the mail server, you
22421 need to invoke it yourself. Ideas on how to use the
22422 @code{:postscript} mail source parameter (@pxref{Mail Source
22423 Specifiers}) follow.
22427 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
22431 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
22434 Once you manage to process your incoming spool somehow, thus making
22435 the mail contain e.g.@: a header indicating it is spam, you are ready to
22436 filter it out. Using normal split methods (@pxref{Splitting Mail}):
22439 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
22443 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
22446 (setq nnmail-split-methods 'nnmail-split-fancy
22447 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
22451 Some people might not like the idea of piping the mail through various
22452 programs using a @code{:prescript} (if some program is buggy, you
22453 might lose all mail). If you are one of them, another solution is to
22454 call the external tools during splitting. Example fancy split method:
22457 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
22459 (defun kevin-spamassassin ()
22463 (if (eq 1 (call-process-region (point-min) (point-max)
22464 "spamc" nil nil nil "-c"))
22468 Note that with the nnimap backend, message bodies will not be
22469 downloaded by default. You need to set
22470 @code{nnimap-split-download-body} to @code{t} to do that
22471 (@pxref{Splitting in IMAP}).
22473 That is about it. As some spam is likely to get through anyway, you
22474 might want to have a nifty function to call when you happen to read
22475 spam. And here is the nifty function:
22478 (defun my-gnus-raze-spam ()
22479 "Submit SPAM to Vipul's Razor, then mark it as expirable."
22481 (gnus-summary-show-raw-article)
22482 (gnus-summary-save-in-pipe "razor-report -f -d")
22483 (gnus-summary-mark-as-expirable 1))
22487 @subsection Hashcash
22490 A novel technique to fight spam is to require senders to do something
22491 costly for each message they send. This has the obvious drawback that
22492 you cannot rely on everyone in the world using this technique,
22493 since it is not part of the Internet standards, but it may be useful
22494 in smaller communities.
22496 While the tools in the previous section work well in practice, they
22497 work only because the tools are constantly maintained and updated as
22498 new form of spam appears. This means that a small percentage of spam
22499 will always get through. It also means that somewhere, someone needs
22500 to read lots of spam to update these tools. Hashcash avoids that, but
22501 instead prefers that everyone you contact through e-mail supports the
22502 scheme. You can view the two approaches as pragmatic vs dogmatic.
22503 The approaches have their own advantages and disadvantages, but as
22504 often in the real world, a combination of them is stronger than either
22505 one of them separately.
22508 The ``something costly'' is to burn CPU time, more specifically to
22509 compute a hash collision up to a certain number of bits. The
22510 resulting hashcash cookie is inserted in a @samp{X-Hashcash:}
22511 header. For more details, and for the external application
22512 @code{hashcash} you need to install to use this feature, see
22513 @uref{http://www.cypherspace.org/~adam/hashcash/}. Even more
22514 information can be found at @uref{http://www.camram.org/}.
22516 If you wish to call hashcash for each message you send, say something
22520 (require 'hashcash)
22521 (add-hook 'message-send-hook 'mail-add-payment)
22524 The @file{hashcash.el} library can be found in the Gnus development
22525 contrib directory or at
22526 @uref{http://users.actrix.gen.nz/mycroft/hashcash.el}.
22528 You will need to set up some additional variables as well:
22532 @item hashcash-default-payment
22533 @vindex hashcash-default-payment
22534 This variable indicates the default number of bits the hash collision
22535 should consist of. By default this is 0, meaning nothing will be
22536 done. Suggested useful values include 17 to 29.
22538 @item hashcash-payment-alist
22539 @vindex hashcash-payment-alist
22540 Some receivers may require you to spend burn more CPU time than the
22541 default. This variable contains a list of @samp{(@var{addr}
22542 @var{amount})} cells, where @var{addr} is the receiver (email address
22543 or newsgroup) and @var{amount} is the number of bits in the collision
22544 that is needed. It can also contain @samp{(@var{addr} @var{string}
22545 @var{amount})} cells, where the @var{string} is the string to use
22546 (normally the email address or newsgroup name is used).
22550 Where the @code{hashcash} binary is installed.
22554 Currently there is no built in functionality in Gnus to verify
22555 hashcash cookies, it is expected that this is performed by your hand
22556 customized mail filtering scripts. Improvements in this area would be
22557 a useful contribution, however.
22559 @node Filtering Spam Using The Spam ELisp Package
22560 @subsection Filtering Spam Using The Spam ELisp Package
22561 @cindex spam filtering
22564 The idea behind @file{spam.el} is to have a control center for spam detection
22565 and filtering in Gnus. To that end, @file{spam.el} does two things: it
22566 filters new mail, and it analyzes mail known to be spam or ham.
22567 @dfn{Ham} is the name used throughout @file{spam.el} to indicate
22570 First of all, you @strong{must} run the function
22571 @code{spam-initialize} to autoload @code{spam.el} and to install the
22572 @code{spam.el} hooks. There is one exception: if you use the
22573 @code{spam-use-stat} (@pxref{spam-stat spam filtering}) setting, you
22574 should turn it on before @code{spam-initialize}:
22577 (setq spam-use-stat t) ;; if needed
22581 So, what happens when you load @file{spam.el}?
22583 First, some hooks will get installed by @code{spam-initialize}. There
22584 are some hooks for @code{spam-stat} so it can save its databases, and
22585 there are hooks so interesting things will happen when you enter and
22586 leave a group. More on the sequence of events later (@pxref{Spam
22587 ELisp Package Sequence of Events}).
22589 You get the following keyboard commands:
22599 @findex gnus-summary-mark-as-spam
22600 @code{gnus-summary-mark-as-spam}.
22602 Mark current article as spam, showing it with the @samp{$} mark.
22603 Whenever you see a spam article, make sure to mark its summary line
22604 with @kbd{M-d} before leaving the group. This is done automatically
22605 for unread articles in @emph{spam} groups.
22611 @findex spam-bogofilter-score
22612 @code{spam-bogofilter-score}.
22614 You must have Bogofilter installed for that command to work properly.
22620 Also, when you load @file{spam.el}, you will be able to customize its
22621 variables. Try @code{customize-group} on the @samp{spam} variable
22625 * Spam ELisp Package Sequence of Events::
22626 * Spam ELisp Package Filtering of Incoming Mail::
22627 * Spam ELisp Package Global Variables::
22628 * Spam ELisp Package Configuration Examples::
22629 * Blacklists and Whitelists::
22630 * BBDB Whitelists::
22631 * Gmane Spam Reporting::
22632 * Anti-spam Hashcash Payments::
22634 * Regular Expressions Header Matching::
22636 * SpamAssassin backend::
22637 * ifile spam filtering::
22638 * spam-stat spam filtering::
22640 * Extending the Spam ELisp package::
22643 @node Spam ELisp Package Sequence of Events
22644 @subsubsection Spam ELisp Package Sequence of Events
22645 @cindex spam filtering
22646 @cindex spam filtering sequence of events
22649 You must read this section to understand how @code{spam.el} works.
22650 Do not skip, speed-read, or glance through this section.
22652 There are two @emph{contact points}, if you will, between
22653 @code{spam.el} and the rest of Gnus: checking new mail for spam, and
22656 Getting new mail is done in one of two ways. You can either split
22657 your incoming mail or you can classify new articles as ham or spam
22658 when you enter the group.
22660 Splitting incoming mail is better suited to mail backends such as
22661 @code{nnml} or @code{nnimap} where new mail appears in a single file
22662 called a @dfn{Spool File}. See @xref{Spam ELisp Package Filtering of
22665 @vindex gnus-spam-autodetect
22666 @vindex gnus-spam-autodetect-methods
22667 For backends such as @code{nntp} there is no incoming mail spool, so
22668 an alternate mechanism must be used. This may also happen for
22669 backends where the server is in charge of splitting incoming mail, and
22670 Gnus does not do further splitting. The @code{spam-autodetect} and
22671 @code{spam-autodetect-methods} group parameters (accessible with
22672 @kbd{G c} and @kbd{G p} as usual), and the corresponding variables
22673 @code{gnus-spam-autodetect} and @code{gnus-spam-autodetect-methods}
22674 (accessible with @kbd{M-x customize-variable} as usual) can help.
22676 When @code{spam-autodetect} is used (you can turn it on for a
22677 group/topic or wholesale by regex, as needed), it hooks into the
22678 process of entering a group. Thus, entering a group with unseen or
22679 unread articles becomes the substitute for checking incoming mail.
22680 Whether only unseen articles or all unread articles will be processed
22681 is determined by the @code{spam-autodetect-recheck-messages}. When
22682 set to @code{t}, unread messages will be rechecked.
22684 @code{spam-autodetect} grants the user at once more and less control
22685 of spam filtering. The user will have more control over each group's
22686 spam methods, so for instance the @samp{ding} group may have
22687 @code{spam-use-BBDB} as the autodetection method, while the
22688 @samp{suspect} group may have the @code{spam-use-blacklist} and
22689 @code{spam-use-bogofilter} methods enabled. Every article detected to
22690 be spam will be marked with the spam mark @samp{$} and processed on
22691 exit from the group as normal spam. The user has less control over
22692 the @emph{sequence} of checks, as he might with @code{spam-split}.
22694 When the newly split mail goes into groups, or messages are
22695 autodetected to be ham or spam, those groups must be exited (after
22696 entering, if needed) for further spam processing to happen. It
22697 matters whether the group is considered a ham group, a spam group, or
22698 is unclassified, based on its @code{spam-content} parameter
22699 (@pxref{Spam ELisp Package Global Variables}). Spam groups have the
22700 additional characteristic that, when entered, any unseen or unread
22701 articles (depending on the @code{spam-mark-only-unseen-as-spam}
22702 variable) will be marked as spam. Thus, mail split into a spam group
22703 gets automatically marked as spam when you enter the group.
22705 So, when you exit a group, the @code{spam-processors} are applied, if
22706 any are set, and the processed mail is moved to the
22707 @code{ham-process-destination} or the @code{spam-process-destination}
22708 depending on the article's classification. If the
22709 @code{ham-process-destination} or the @code{spam-process-destination},
22710 whichever is appropriate, are @code{nil}, the article is left in the
22713 If a spam is found in any group (this can be changed to only non-spam
22714 groups with @code{spam-move-spam-nonspam-groups-only}), it is
22715 processed by the active @code{spam-processors} (@pxref{Spam ELisp
22716 Package Global Variables}) when the group is exited. Furthermore, the
22717 spam is moved to the @code{spam-process-destination} (@pxref{Spam
22718 ELisp Package Global Variables}) for further training or deletion.
22719 You have to load the @code{gnus-registry.el} package and enable the
22720 @code{spam-log-to-registry} variable if you want spam to be processed
22721 no more than once. Thus, spam is detected and processed everywhere,
22722 which is what most people want. If the
22723 @code{spam-process-destination} is @code{nil}, the spam is marked as
22724 expired, which is usually the right thing to do.
22726 If spam can not be moved---because of a read-only backend such as
22727 @acronym{NNTP}, for example, it will be copied.
22729 If a ham mail is found in a ham group, as determined by the
22730 @code{ham-marks} parameter, it is processed as ham by the active ham
22731 @code{spam-processor} when the group is exited. With the variables
22732 @code{spam-process-ham-in-spam-groups} and
22733 @code{spam-process-ham-in-nonham-groups} the behavior can be further
22734 altered so ham found anywhere can be processed. You have to load the
22735 @code{gnus-registry.el} package and enable the
22736 @code{spam-log-to-registry} variable if you want ham to be processed
22737 no more than once. Thus, ham is detected and processed only when
22738 necessary, which is what most people want. More on this in
22739 @xref{Spam ELisp Package Configuration Examples}.
22741 If ham can not be moved---because of a read-only backend such as
22742 @acronym{NNTP}, for example, it will be copied.
22744 If all this seems confusing, don't worry. Soon it will be as natural
22745 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
22746 50 years in the future yet. Just trust us, it's not so bad.
22748 @node Spam ELisp Package Filtering of Incoming Mail
22749 @subsubsection Spam ELisp Package Filtering of Incoming Mail
22750 @cindex spam filtering
22751 @cindex spam filtering incoming mail
22754 To use the @file{spam.el} facilities for incoming mail filtering, you
22755 must add the following to your fancy split list
22756 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
22762 Note that the fancy split may be called @code{nnmail-split-fancy} or
22763 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
22764 nnimap back ends to retrieve your mail.
22766 Also, @code{spam-split} will not modify incoming mail in any way.
22768 The @code{spam-split} function will process incoming mail and send the
22769 mail considered to be spam into the group name given by the variable
22770 @code{spam-split-group}. By default that group name is @samp{spam},
22771 but you can customize @code{spam-split-group}. Make sure the contents
22772 of @code{spam-split-group} are an @emph{unqualified} group name, for
22773 instance in an @code{nnimap} server @samp{your-server} the value
22774 @samp{spam} will turn out to be @samp{nnimap+your-server:spam}. The
22775 value @samp{nnimap+server:spam}, therefore, is wrong and will
22776 actually give you the group
22777 @samp{nnimap+your-server:nnimap+server:spam} which may or may not
22778 work depending on your server's tolerance for strange group names.
22780 You can also give @code{spam-split} a parameter,
22781 e.g. @code{spam-use-regex-headers} or @code{"maybe-spam"}. Why is
22784 Take these split rules (with @code{spam-use-regex-headers} and
22785 @code{spam-use-blackholes} set):
22788 nnimap-split-fancy '(|
22789 (any "ding" "ding")
22791 ;; @r{default mailbox}
22795 Now, the problem is that you want all ding messages to make it to the
22796 ding folder. But that will let obvious spam (for example, spam
22797 detected by SpamAssassin, and @code{spam-use-regex-headers}) through,
22798 when it's sent to the ding list. On the other hand, some messages to
22799 the ding list are from a mail server in the blackhole list, so the
22800 invocation of @code{spam-split} can't be before the ding rule.
22802 You can let SpamAssassin headers supersede ding rules, but all other
22803 @code{spam-split} rules (including a second invocation of the
22804 regex-headers check) will be after the ding rule:
22809 ;; @r{all spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
22810 (: spam-split "regex-spam" 'spam-use-regex-headers)
22811 (any "ding" "ding")
22812 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
22814 ;; @r{default mailbox}
22818 This lets you invoke specific @code{spam-split} checks depending on
22819 your particular needs, and to target the results of those checks to a
22820 particular spam group. You don't have to throw all mail into all the
22821 spam tests. Another reason why this is nice is that messages to
22822 mailing lists you have rules for don't have to have resource-intensive
22823 blackhole checks performed on them. You could also specify different
22824 spam checks for your nnmail split vs. your nnimap split. Go crazy.
22826 You should still have specific checks such as
22827 @code{spam-use-regex-headers} set to @code{t}, even if you
22828 specifically invoke @code{spam-split} with the check. The reason is
22829 that when loading @file{spam.el}, some conditional loading is done
22830 depending on what @code{spam-use-xyz} variables you have set. This
22831 is usually not critical, though.
22833 @emph{Note for IMAP users}
22835 The boolean variable @code{nnimap-split-download-body} needs to be
22836 set, if you want to split based on the whole message instead of just
22837 the headers. By default, the nnimap back end will only retrieve the
22838 message headers. If you use @code{spam-check-bogofilter},
22839 @code{spam-check-ifile}, or @code{spam-check-stat} (the splitters that
22840 can benefit from the full message body), you should set this variable.
22841 It is not set by default because it will slow @acronym{IMAP} down, and
22842 that is not an appropriate decision to make on behalf of the user.
22844 @xref{Splitting in IMAP}.
22846 @emph{TODO: spam.el needs to provide a uniform way of training all the
22847 statistical databases. Some have that functionality built-in, others
22850 @node Spam ELisp Package Global Variables
22851 @subsubsection Spam ELisp Package Global Variables
22852 @cindex spam filtering
22853 @cindex spam filtering variables
22854 @cindex spam variables
22857 @vindex gnus-spam-process-newsgroups
22858 The concepts of ham processors and spam processors are very important.
22859 Ham processors and spam processors for a group can be set with the
22860 @code{spam-process} group parameter, or the
22861 @code{gnus-spam-process-newsgroups} variable. Ham processors take
22862 mail known to be non-spam (@emph{ham}) and process it in some way so
22863 that later similar mail will also be considered non-spam. Spam
22864 processors take mail known to be spam and process it so similar spam
22865 will be detected later.
22867 The format of the spam or ham processor entry used to be a symbol,
22868 but now it is a @sc{cons} cell. See the individual spam processor entries
22869 for more information.
22871 @vindex gnus-spam-newsgroup-contents
22872 Gnus learns from the spam you get. You have to collect your spam in
22873 one or more spam groups, and set or customize the variable
22874 @code{spam-junk-mailgroups} as appropriate. You can also declare
22875 groups to contain spam by setting their group parameter
22876 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
22877 by customizing the corresponding variable
22878 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
22879 parameter and the @code{gnus-spam-newsgroup-contents} variable can
22880 also be used to declare groups as @emph{ham} groups if you set their
22881 classification to @code{gnus-group-spam-classification-ham}. If
22882 groups are not classified by means of @code{spam-junk-mailgroups},
22883 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
22884 considered @emph{unclassified}. All groups are unclassified by
22887 @vindex gnus-spam-mark
22889 In spam groups, all messages are considered to be spam by default:
22890 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
22891 group. If you have seen a message, had it marked as spam, then
22892 unmarked it, it won't be marked as spam when you enter the group
22893 thereafter. You can disable that behavior, so all unread messages
22894 will get the @samp{$} mark, if you set the
22895 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
22896 should remove the @samp{$} mark when you are in the group summary
22897 buffer for every message that is not spam after all. To remove the
22898 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
22899 @kbd{d} for declaring it read the non-spam way. When you leave a
22900 group, all spam-marked (@samp{$}) articles are sent to a spam
22901 processor which will study them as spam samples.
22903 Messages may also be deleted in various other ways, and unless
22904 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
22905 and @samp{r} for default read or explicit delete, marks @samp{X} and
22906 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
22907 low scores, are all considered to be associated with articles which
22908 are not spam. This assumption might be false, in particular if you
22909 use kill files or score files as means for detecting genuine spam, you
22910 should then adjust the @code{ham-marks} group parameter.
22913 You can customize this group or topic parameter to be the list of
22914 marks you want to consider ham. By default, the list contains the
22915 deleted, read, killed, kill-filed, and low-score marks (the idea is
22916 that these articles have been read, but are not spam). It can be
22917 useful to also include the tick mark in the ham marks. It is not
22918 recommended to make the unread mark a ham mark, because it normally
22919 indicates a lack of classification. But you can do it, and we'll be
22924 You can customize this group or topic parameter to be the list of
22925 marks you want to consider spam. By default, the list contains only
22926 the spam mark. It is not recommended to change that, but you can if
22927 you really want to.
22930 When you leave @emph{any} group, regardless of its
22931 @code{spam-contents} classification, all spam-marked articles are sent
22932 to a spam processor, which will study these as spam samples. If you
22933 explicit kill a lot, you might sometimes end up with articles marked
22934 @samp{K} which you never saw, and which might accidentally contain
22935 spam. Best is to make sure that real spam is marked with @samp{$},
22938 @vindex gnus-ham-process-destinations
22939 When you leave a @emph{spam} group, all spam-marked articles are
22940 marked as expired after processing with the spam processor. This is
22941 not done for @emph{unclassified} or @emph{ham} groups. Also, any
22942 @strong{ham} articles in a spam group will be moved to a location
22943 determined by either the @code{ham-process-destination} group
22944 parameter or a match in the @code{gnus-ham-process-destinations}
22945 variable, which is a list of regular expressions matched with group
22946 names (it's easiest to customize this variable with @kbd{M-x
22947 customize-variable @key{RET} gnus-ham-process-destinations}). Each
22948 group name list is a standard Lisp list, if you prefer to customize
22949 the variable manually. If the @code{ham-process-destination}
22950 parameter is not set, ham articles are left in place. If the
22951 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
22952 set, the ham articles are marked as unread before being moved.
22954 If ham can not be moved---because of a read-only backend such as
22955 @acronym{NNTP}, for example, it will be copied.
22957 Note that you can use multiples destinations per group or regular
22958 expression! This enables you to send your ham to a regular mail
22959 group and to a @emph{ham training} group.
22961 When you leave a @emph{ham} group, all ham-marked articles are sent to
22962 a ham processor, which will study these as non-spam samples.
22964 @vindex spam-process-ham-in-spam-groups
22965 By default the variable @code{spam-process-ham-in-spam-groups} is
22966 @code{nil}. Set it to @code{t} if you want ham found in spam groups
22967 to be processed. Normally this is not done, you are expected instead
22968 to send your ham to a ham group and process it there.
22970 @vindex spam-process-ham-in-nonham-groups
22971 By default the variable @code{spam-process-ham-in-nonham-groups} is
22972 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
22973 or unclassified) groups to be processed. Normally this is not done,
22974 you are expected instead to send your ham to a ham group and process
22977 @vindex gnus-spam-process-destinations
22978 When you leave a @emph{ham} or @emph{unclassified} group, all
22979 @strong{spam} articles are moved to a location determined by either
22980 the @code{spam-process-destination} group parameter or a match in the
22981 @code{gnus-spam-process-destinations} variable, which is a list of
22982 regular expressions matched with group names (it's easiest to
22983 customize this variable with @kbd{M-x customize-variable @key{RET}
22984 gnus-spam-process-destinations}). Each group name list is a standard
22985 Lisp list, if you prefer to customize the variable manually. If the
22986 @code{spam-process-destination} parameter is not set, the spam
22987 articles are only expired. The group name is fully qualified, meaning
22988 that if you see @samp{nntp:servername} before the group name in the
22989 group buffer then you need it here as well.
22991 If spam can not be moved---because of a read-only backend such as
22992 @acronym{NNTP}, for example, it will be copied.
22994 Note that you can use multiples destinations per group or regular
22995 expression! This enables you to send your spam to multiple @emph{spam
22998 @vindex spam-log-to-registry
22999 The problem with processing ham and spam is that Gnus doesn't track
23000 this processing by default. Enable the @code{spam-log-to-registry}
23001 variable so @code{spam.el} will use @code{gnus-registry.el} to track
23002 what articles have been processed, and avoid processing articles
23003 multiple times. Keep in mind that if you limit the number of registry
23004 entries, this won't work as well as it does without a limit.
23006 @vindex spam-mark-only-unseen-as-spam
23007 Set this variable if you want only unseen articles in spam groups to
23008 be marked as spam. By default, it is set. If you set it to
23009 @code{nil}, unread articles will also be marked as spam.
23011 @vindex spam-mark-ham-unread-before-move-from-spam-group
23012 Set this variable if you want ham to be unmarked before it is moved
23013 out of the spam group. This is very useful when you use something
23014 like the tick mark @samp{!} to mark ham---the article will be placed
23015 in your @code{ham-process-destination}, unmarked as if it came fresh
23016 from the mail server.
23018 @vindex spam-autodetect-recheck-messages
23019 When autodetecting spam, this variable tells @code{spam.el} whether
23020 only unseen articles or all unread articles should be checked for
23021 spam. It is recommended that you leave it off.
23023 @node Spam ELisp Package Configuration Examples
23024 @subsubsection Spam ELisp Package Configuration Examples
23025 @cindex spam filtering
23026 @cindex spam filtering configuration examples
23027 @cindex spam configuration examples
23030 @subsubheading Ted's setup
23032 From Ted Zlatanov <tzz@@lifelogs.com>.
23034 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
23035 ;; @r{see @file{gnus-registry.el} for more information}
23036 (gnus-registry-initialize)
23039 ;; @r{I like @kbd{C-s} for marking spam}
23040 (define-key gnus-summary-mode-map "\C-s" 'gnus-summary-mark-as-spam)
23043 spam-log-to-registry t ; @r{for spam autodetection}
23045 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
23046 ;; @r{all groups with @samp{spam} in the name contain spam}
23047 gnus-spam-newsgroup-contents
23048 '(("spam" gnus-group-spam-classification-spam))
23049 ;; @r{see documentation for these}
23050 spam-move-spam-nonspam-groups-only nil
23051 spam-mark-only-unseen-as-spam t
23052 spam-mark-ham-unread-before-move-from-spam-group t
23053 nnimap-split-rule 'nnimap-split-fancy
23054 ;; @r{understand what this does before you copy it to your own setup!}
23055 nnimap-split-fancy '(|
23056 ;; @r{trace references to parents and put in their group}
23057 (: gnus-registry-split-fancy-with-parent)
23058 ;; @r{this will catch server-side SpamAssassin tags}
23059 (: spam-split 'spam-use-regex-headers)
23060 (any "ding" "ding")
23061 ;; @r{note that spam by default will go to @samp{spam}}
23063 ;; @r{default mailbox}
23066 ;; @r{my parameters, set with @kbd{G p}}
23068 ;; @r{all nnml groups, and all nnimap groups except}
23069 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
23070 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
23071 ;; @r{because it must have been detected manually}
23073 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23075 ;; @r{all @acronym{NNTP} groups}
23076 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
23077 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
23078 ;; @r{send all spam to the training group}
23079 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
23081 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
23082 ((spam-autodetect . t))
23084 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
23086 ;; @r{this is a spam group}
23087 ((spam-contents gnus-group-spam-classification-spam)
23089 ;; @r{any spam (which happens when I enter for all unseen messages,}
23090 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
23091 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
23093 (spam-process-destination "nnimap+mail.lifelogs.com:train")
23095 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
23096 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
23098 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
23099 "nnimap+mail.lifelogs.com:trainham")
23100 ;; @r{in this group, only @samp{!} marks are ham}
23102 (gnus-ticked-mark))
23103 ;; @r{remembers senders in the blacklist on the way out---this is}
23104 ;; @r{definitely not needed, it just makes me feel better}
23105 (spam-process (gnus-group-spam-exit-processor-blacklist)))
23107 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
23108 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
23109 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
23113 @subsubheading Using @file{spam.el} on an IMAP server with a statistical filter on the server
23114 From Reiner Steib <reiner.steib@@gmx.de>.
23116 My provider has set up bogofilter (in combination with @acronym{DCC}) on
23117 the mail server (@acronym{IMAP}). Recognized spam goes to
23118 @samp{spam.detected}, the rest goes through the normal filter rules,
23119 i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
23120 positives or negatives is done by copying or moving the article to
23121 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
23122 the server feeds those to bogofilter with the suitable ham or spam
23123 options and deletes them from the @samp{training.ham} and
23124 @samp{training.spam} folders.
23126 With the following entries in @code{gnus-parameters}, @code{spam.el}
23127 does most of the job for me:
23130 ("nnimap:spam\\.detected"
23131 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
23132 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
23133 (spam-contents gnus-group-spam-classification-spam))
23134 ("nnimap:\\(INBOX\\|other-folders\\)"
23135 (spam-process-destination . "nnimap:training.spam")
23136 (spam-contents gnus-group-spam-classification-ham))
23141 @item @b{The Spam folder:}
23143 In the folder @samp{spam.detected}, I have to check for false positives
23144 (i.e. legitimate mails, that were wrongly judged as spam by
23145 bogofilter or DCC).
23147 Because of the @code{gnus-group-spam-classification-spam} entry, all
23148 messages are marked as spam (with @code{$}). When I find a false
23149 positive, I mark the message with some other ham mark (@code{ham-marks},
23150 @ref{Spam ELisp Package Global Variables}). On group exit, those
23151 messages are copied to both groups, @samp{INBOX} (where I want to have
23152 the article) and @samp{training.ham} (for training bogofilter) and
23153 deleted from the @samp{spam.detected} folder.
23155 The @code{gnus-article-sort-by-chars} entry simplifies detection of
23156 false positives for me. I receive lots of worms (sweN, @dots{}), that all
23157 have a similar size. Grouping them by size (i.e. chars) makes finding
23158 other false positives easier. (Of course worms aren't @i{spam}
23159 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
23160 an excellent tool for filtering those unwanted mails for me.)
23162 @item @b{Ham folders:}
23164 In my ham folders, I just hit @kbd{S x}
23165 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
23166 mail (false negative). On group exit, those messages are moved to
23167 @samp{training.ham}.
23170 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
23172 From Reiner Steib <reiner.steib@@gmx.de>.
23174 With following entry in @code{gnus-parameters}, @kbd{S x}
23175 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
23176 groups as spam and reports the to Gmane at group exit:
23180 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
23183 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
23184 because I don't read the groups directly from news.gmane.org, but
23185 through my local news server (leafnode). I.e. the article numbers are
23186 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
23187 the @code{X-Report-Spam} header to find the correct number.
23189 @node Blacklists and Whitelists
23190 @subsubsection Blacklists and Whitelists
23191 @cindex spam filtering
23192 @cindex whitelists, spam filtering
23193 @cindex blacklists, spam filtering
23196 @defvar spam-use-blacklist
23198 Set this variable to @code{t} if you want to use blacklists when
23199 splitting incoming mail. Messages whose senders are in the blacklist
23200 will be sent to the @code{spam-split-group}. This is an explicit
23201 filter, meaning that it acts only on mail senders @emph{declared} to
23206 @defvar spam-use-whitelist
23208 Set this variable to @code{t} if you want to use whitelists when
23209 splitting incoming mail. Messages whose senders are not in the
23210 whitelist will be sent to the next spam-split rule. This is an
23211 explicit filter, meaning that unless someone is in the whitelist, their
23212 messages are not assumed to be spam or ham.
23216 @defvar spam-use-whitelist-exclusive
23218 Set this variable to @code{t} if you want to use whitelists as an
23219 implicit filter, meaning that every message will be considered spam
23220 unless the sender is in the whitelist. Use with care.
23224 @defvar gnus-group-spam-exit-processor-blacklist
23226 Add this symbol to a group's @code{spam-process} parameter by
23227 customizing the group parameters or the
23228 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23229 added to a group's @code{spam-process} parameter, the senders of
23230 spam-marked articles will be added to the blacklist.
23234 Instead of the obsolete
23235 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
23236 that you use @code{'(spam spam-use-blacklist)}. Everything will work
23237 the same way, we promise.
23241 @defvar gnus-group-ham-exit-processor-whitelist
23243 Add this symbol to a group's @code{spam-process} parameter by
23244 customizing the group parameters or the
23245 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23246 added to a group's @code{spam-process} parameter, the senders of
23247 ham-marked articles in @emph{ham} groups will be added to the
23252 Instead of the obsolete
23253 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
23254 that you use @code{'(ham spam-use-whitelist)}. Everything will work
23255 the same way, we promise.
23259 Blacklists are lists of regular expressions matching addresses you
23260 consider to be spam senders. For instance, to block mail from any
23261 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
23262 blacklist. You start out with an empty blacklist. Blacklist entries
23263 use the Emacs regular expression syntax.
23265 Conversely, whitelists tell Gnus what addresses are considered
23266 legitimate. All messages from whitelisted addresses are considered
23267 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
23268 Emacs regular expression syntax.
23270 The blacklist and whitelist file locations can be customized with the
23271 @code{spam-directory} variable (@file{~/News/spam} by default), or
23272 the @code{spam-whitelist} and @code{spam-blacklist} variables
23273 directly. The whitelist and blacklist files will by default be in the
23274 @code{spam-directory} directory, named @file{whitelist} and
23275 @file{blacklist} respectively.
23277 @node BBDB Whitelists
23278 @subsubsection BBDB Whitelists
23279 @cindex spam filtering
23280 @cindex BBDB whitelists, spam filtering
23281 @cindex BBDB, spam filtering
23284 @defvar spam-use-BBDB
23286 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
23287 Whitelists}), but uses the BBDB as the source of whitelisted
23288 addresses, without regular expressions. You must have the BBDB loaded
23289 for @code{spam-use-BBDB} to work properly. Messages whose senders are
23290 not in the BBDB will be sent to the next spam-split rule. This is an
23291 explicit filter, meaning that unless someone is in the BBDB, their
23292 messages are not assumed to be spam or ham.
23296 @defvar spam-use-BBDB-exclusive
23298 Set this variable to @code{t} if you want to use the BBDB as an
23299 implicit filter, meaning that every message will be considered spam
23300 unless the sender is in the BBDB. Use with care. Only sender
23301 addresses in the BBDB will be allowed through; all others will be
23302 classified as spammers.
23306 @defvar gnus-group-ham-exit-processor-BBDB
23308 Add this symbol to a group's @code{spam-process} parameter by
23309 customizing the group parameters or the
23310 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23311 added to a group's @code{spam-process} parameter, the senders of
23312 ham-marked articles in @emph{ham} groups will be added to the
23317 Instead of the obsolete
23318 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
23319 that you use @code{'(ham spam-use-BBDB)}. Everything will work
23320 the same way, we promise.
23324 @node Gmane Spam Reporting
23325 @subsubsection Gmane Spam Reporting
23326 @cindex spam reporting
23327 @cindex Gmane, spam reporting
23328 @cindex Gmane, spam reporting
23331 @defvar gnus-group-spam-exit-processor-report-gmane
23333 Add this symbol to a group's @code{spam-process} parameter by
23334 customizing the group parameters or the
23335 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23336 added to a group's @code{spam-process} parameter, the spam-marked
23337 articles groups will be reported to the Gmane administrators via a
23340 Gmane can be found at @uref{http://gmane.org}.
23344 Instead of the obsolete
23345 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
23346 that you use @code{'(spam spam-use-gmane)}. Everything will work the
23347 same way, we promise.
23351 @defvar spam-report-gmane-use-article-number
23353 This variable is @code{t} by default. Set it to @code{nil} if you are
23354 running your own news server, for instance, and the local article
23355 numbers don't correspond to the Gmane article numbers. When
23356 @code{spam-report-gmane-use-article-number} is @code{nil},
23357 @code{spam-report.el} will use the @code{X-Report-Spam} header that
23362 @node Anti-spam Hashcash Payments
23363 @subsubsection Anti-spam Hashcash Payments
23364 @cindex spam filtering
23365 @cindex hashcash, spam filtering
23368 @defvar spam-use-hashcash
23370 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
23371 Whitelists}), but uses hashcash tokens for whitelisting messages
23372 instead of the sender address. You must have the @code{hashcash.el}
23373 package loaded for @code{spam-use-hashcash} to work properly.
23374 Messages without a hashcash payment token will be sent to the next
23375 spam-split rule. This is an explicit filter, meaning that unless a
23376 hashcash token is found, the messages are not assumed to be spam or
23382 @subsubsection Blackholes
23383 @cindex spam filtering
23384 @cindex blackholes, spam filtering
23387 @defvar spam-use-blackholes
23389 This option is disabled by default. You can let Gnus consult the
23390 blackhole-type distributed spam processing systems (DCC, for instance)
23391 when you set this option. The variable @code{spam-blackhole-servers}
23392 holds the list of blackhole servers Gnus will consult. The current
23393 list is fairly comprehensive, but make sure to let us know if it
23394 contains outdated servers.
23396 The blackhole check uses the @code{dig.el} package, but you can tell
23397 @file{spam.el} to use @code{dns.el} instead for better performance if
23398 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
23399 this time to set @code{spam-use-dig} to @code{nil} despite the
23400 possible performance improvements, because some users may be unable to
23401 use it, but you can try it and see if it works for you.
23405 @defvar spam-blackhole-servers
23407 The list of servers to consult for blackhole checks.
23411 @defvar spam-blackhole-good-server-regex
23413 A regular expression for IPs that should not be checked against the
23414 blackhole server list. When set to @code{nil}, it has no effect.
23418 @defvar spam-use-dig
23420 Use the @code{dig.el} package instead of the @code{dns.el} package.
23421 The default setting of @code{t} is recommended.
23425 Blackhole checks are done only on incoming mail. There is no spam or
23426 ham processor for blackholes.
23428 @node Regular Expressions Header Matching
23429 @subsubsection Regular Expressions Header Matching
23430 @cindex spam filtering
23431 @cindex regular expressions header matching, spam filtering
23434 @defvar spam-use-regex-headers
23436 This option is disabled by default. You can let Gnus check the
23437 message headers against lists of regular expressions when you set this
23438 option. The variables @code{spam-regex-headers-spam} and
23439 @code{spam-regex-headers-ham} hold the list of regular expressions.
23440 Gnus will check against the message headers to determine if the
23441 message is spam or ham, respectively.
23445 @defvar spam-regex-headers-spam
23447 The list of regular expressions that, when matched in the headers of
23448 the message, positively identify it as spam.
23452 @defvar spam-regex-headers-ham
23454 The list of regular expressions that, when matched in the headers of
23455 the message, positively identify it as ham.
23459 Regular expression header checks are done only on incoming mail.
23460 There is no specific spam or ham processor for regular expressions.
23463 @subsubsection Bogofilter
23464 @cindex spam filtering
23465 @cindex bogofilter, spam filtering
23468 @defvar spam-use-bogofilter
23470 Set this variable if you want @code{spam-split} to use Eric Raymond's
23473 With a minimum of care for associating the @samp{$} mark for spam
23474 articles only, Bogofilter training all gets fairly automatic. You
23475 should do this until you get a few hundreds of articles in each
23476 category, spam or not. The command @kbd{S t} in summary mode, either
23477 for debugging or for curiosity, shows the @emph{spamicity} score of
23478 the current article (between 0.0 and 1.0).
23480 Bogofilter determines if a message is spam based on a specific
23481 threshold. That threshold can be customized, consult the Bogofilter
23484 If the @code{bogofilter} executable is not in your path, Bogofilter
23485 processing will be turned off.
23487 You should not enable this if you use @code{spam-use-bogofilter-headers}.
23491 @defvar spam-use-bogofilter-headers
23493 Set this variable if you want @code{spam-split} to use Eric Raymond's
23494 speedy Bogofilter, looking only at the message headers. It works
23495 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
23496 must be in the message already. Normally you would do this with a
23497 procmail recipe or something similar; consult the Bogofilter
23498 installation documents for details.
23500 You should not enable this if you use @code{spam-use-bogofilter}.
23504 @defvar gnus-group-spam-exit-processor-bogofilter
23505 Add this symbol to a group's @code{spam-process} parameter by
23506 customizing the group parameters or the
23507 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23508 added to a group's @code{spam-process} parameter, spam-marked articles
23509 will be added to the Bogofilter spam database.
23513 Instead of the obsolete
23514 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
23515 that you use @code{'(spam spam-use-bogofilter)}. Everything will work
23516 the same way, we promise.
23519 @defvar gnus-group-ham-exit-processor-bogofilter
23520 Add this symbol to a group's @code{spam-process} parameter by
23521 customizing the group parameters or the
23522 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23523 added to a group's @code{spam-process} parameter, the ham-marked
23524 articles in @emph{ham} groups will be added to the Bogofilter database
23525 of non-spam messages.
23529 Instead of the obsolete
23530 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
23531 that you use @code{'(ham spam-use-bogofilter)}. Everything will work
23532 the same way, we promise.
23535 @defvar spam-bogofilter-database-directory
23537 This is the directory where Bogofilter will store its databases. It
23538 is not specified by default, so Bogofilter will use its own default
23539 database directory.
23543 The Bogofilter mail classifier is similar to @command{ifile} in intent and
23544 purpose. A ham and a spam processor are provided, plus the
23545 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
23546 variables to indicate to spam-split that Bogofilter should either be
23547 used, or has already been used on the article. The 0.9.2.1 version of
23548 Bogofilter was used to test this functionality.
23550 @node SpamAssassin backend
23551 @subsubsection SpamAssassin backend
23552 @cindex spam filtering
23553 @cindex spamassassin, spam filtering
23556 @defvar spam-use-spamassassin
23558 Set this variable if you want @code{spam-split} to use SpamAssassin.
23560 SpamAssassin assigns a score to each article based on a set of rules
23561 and tests, including a Bayesian filter. The Bayesian filter can be
23562 trained by associating the @samp{$} mark for spam articles. The
23563 spam score can be viewed by using the command @kbd{S t} in summary
23566 If you set this variable, each article will be processed by
23567 SpamAssassin when @code{spam-split} is called. If your mail is
23568 preprocessed by SpamAssassin, and you want to just use the
23569 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
23572 You should not enable this is you use
23573 @code{spam-use-spamassassin-headers}.
23577 @defvar spam-use-spamassassin-headers
23579 Set this variable if your mail is preprocessed by SpamAssassin and
23580 want @code{spam-split} to split based on the SpamAssassin headers.
23582 You should not enable this is you use @code{spam-use-spamassassin}.
23586 @defvar spam-spamassassin-path
23588 This variable points to the SpamAssassin executable. If you have
23589 @code{spamd} running, you can set this variable to the @code{spamc}
23590 executable for faster processing. See the SpamAssassin documentation
23591 for more information on @code{spamd}/@code{spamc}.
23595 SpamAssassin is a powerful and flexible spam filter that uses a wide
23596 variety of tests to identify spam. A ham and a spam processors are
23597 provided, plus the @code{spam-use-spamassassin} and
23598 @code{spam-use-spamassassin-headers} variables to indicate to
23599 spam-split that SpamAssassin should be either used, or has already
23600 been used on the article. The 2.63 version of SpamAssassin was used
23601 to test this functionality.
23603 @node ifile spam filtering
23604 @subsubsection ifile spam filtering
23605 @cindex spam filtering
23606 @cindex ifile, spam filtering
23609 @defvar spam-use-ifile
23611 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
23612 statistical analyzer similar to Bogofilter.
23616 @defvar spam-ifile-all-categories
23618 Enable this variable if you want @code{spam-use-ifile} to give you all
23619 the ifile categories, not just spam/non-spam. If you use this, make
23620 sure you train ifile as described in its documentation.
23624 @defvar spam-ifile-spam-category
23626 This is the category of spam messages as far as ifile is concerned.
23627 The actual string used is irrelevant, but you probably want to leave
23628 the default value of @samp{spam}.
23631 @defvar spam-ifile-database-path
23633 This is the filename for the ifile database. It is not specified by
23634 default, so ifile will use its own default database name.
23638 The ifile mail classifier is similar to Bogofilter in intent and
23639 purpose. A ham and a spam processor are provided, plus the
23640 @code{spam-use-ifile} variable to indicate to spam-split that ifile
23641 should be used. The 1.2.1 version of ifile was used to test this
23644 @node spam-stat spam filtering
23645 @subsubsection spam-stat spam filtering
23646 @cindex spam filtering
23647 @cindex spam-stat, spam filtering
23651 @xref{Filtering Spam Using Statistics with spam-stat}.
23653 @defvar spam-use-stat
23655 Enable this variable if you want @code{spam-split} to use
23656 spam-stat.el, an Emacs Lisp statistical analyzer.
23660 @defvar gnus-group-spam-exit-processor-stat
23661 Add this symbol to a group's @code{spam-process} parameter by
23662 customizing the group parameters or the
23663 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23664 added to a group's @code{spam-process} parameter, the spam-marked
23665 articles will be added to the spam-stat database of spam messages.
23669 Instead of the obsolete
23670 @code{gnus-group-spam-exit-processor-stat}, it is recommended
23671 that you use @code{'(spam spam-use-stat)}. Everything will work
23672 the same way, we promise.
23675 @defvar gnus-group-ham-exit-processor-stat
23676 Add this symbol to a group's @code{spam-process} parameter by
23677 customizing the group parameters or the
23678 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23679 added to a group's @code{spam-process} parameter, the ham-marked
23680 articles in @emph{ham} groups will be added to the spam-stat database
23681 of non-spam messages.
23685 Instead of the obsolete
23686 @code{gnus-group-ham-exit-processor-stat}, it is recommended
23687 that you use @code{'(ham spam-use-stat)}. Everything will work
23688 the same way, we promise.
23691 This enables @file{spam.el} to cooperate with @file{spam-stat.el}.
23692 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
23693 which unlike ifile or Bogofilter does not require external programs.
23694 A spam and a ham processor, and the @code{spam-use-stat} variable for
23695 @code{spam-split} are provided.
23698 @subsubsection Using SpamOracle with Gnus
23699 @cindex spam filtering
23703 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
23704 statistical mail filtering tool written by Xavier Leroy and needs to be
23705 installed separately.
23707 There are several ways to use SpamOracle with Gnus. In all cases, your
23708 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
23709 then enter an @samp{X-Spam} header indicating whether it regards the
23710 mail as a spam mail or not.
23712 One possibility is to run SpamOracle as a @code{:prescript} from the
23713 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
23714 the advantage that the user can see the @emph{X-Spam} headers.
23716 The easiest method is to make @file{spam.el} (@pxref{Filtering Spam
23717 Using The Spam ELisp Package}) call SpamOracle.
23719 @vindex spam-use-spamoracle
23720 To enable SpamOracle usage by @file{spam.el}, set the variable
23721 @code{spam-use-spamoracle} to @code{t} and configure the
23722 @code{nnmail-split-fancy} or @code{nnimap-split-fancy} as described in
23723 the section @xref{Filtering Spam Using The Spam ELisp Package}. In
23724 this example the @samp{INBOX} of an nnimap server is filtered using
23725 SpamOracle. Mails recognized as spam mails will be moved to
23726 @code{spam-split-group}, @samp{Junk} in this case. Ham messages stay
23730 (setq spam-use-spamoracle t
23731 spam-split-group "Junk"
23732 nnimap-split-inbox '("INBOX")
23733 nnimap-split-rule 'nnimap-split-fancy
23734 nnimap-split-fancy '(| (: spam-split) "INBOX"))
23737 @defvar spam-use-spamoracle
23738 Set to @code{t} if you want Gnus to enable spam filtering using
23742 @defvar spam-spamoracle-binary
23743 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
23744 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
23748 @defvar spam-spamoracle-database
23749 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
23750 store its analyses. This is controlled by the variable
23751 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
23752 the default SpamOracle database will be used. In case you want your
23753 database to live somewhere special, set
23754 @code{spam-spamoracle-database} to this path.
23757 SpamOracle employs a statistical algorithm to determine whether a
23758 message is spam or ham. In order to get good results, meaning few
23759 false hits or misses, SpamOracle needs training. SpamOracle learns the
23760 characteristics of your spam mails. Using the @emph{add} mode
23761 (training mode) one has to feed good (ham) and spam mails to
23762 SpamOracle. This can be done by pressing @kbd{|} in the Summary buffer
23763 and pipe the mail to a SpamOracle process or using @file{spam.el}'s
23764 spam- and ham-processors, which is much more convenient. For a
23765 detailed description of spam- and ham-processors, @xref{Filtering Spam
23766 Using The Spam ELisp Package}.
23768 @defvar gnus-group-spam-exit-processor-spamoracle
23769 Add this symbol to a group's @code{spam-process} parameter by
23770 customizing the group parameter or the
23771 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23772 to a group's @code{spam-process} parameter, spam-marked articles will be
23773 sent to SpamOracle as spam samples.
23777 Instead of the obsolete
23778 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
23779 that you use @code{'(spam spam-use-spamoracle)}. Everything will work
23780 the same way, we promise.
23783 @defvar gnus-group-ham-exit-processor-spamoracle
23784 Add this symbol to a group's @code{spam-process} parameter by
23785 customizing the group parameter or the
23786 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23787 to a group's @code{spam-process} parameter, the ham-marked articles in
23788 @emph{ham} groups will be sent to the SpamOracle as samples of ham
23793 Instead of the obsolete
23794 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
23795 that you use @code{'(ham spam-use-spamoracle)}. Everything will work
23796 the same way, we promise.
23799 @emph{Example:} These are the Group Parameters of a group that has been
23800 classified as a ham group, meaning that it should only contain ham
23803 ((spam-contents gnus-group-spam-classification-ham)
23804 (spam-process ((ham spam-use-spamoracle)
23805 (spam spam-use-spamoracle))))
23807 For this group the @code{spam-use-spamoracle} is installed for both
23808 ham and spam processing. If the group contains spam message
23809 (e.g. because SpamOracle has not had enough sample messages yet) and
23810 the user marks some messages as spam messages, these messages will be
23811 processed by SpamOracle. The processor sends the messages to
23812 SpamOracle as new samples for spam.
23814 @node Extending the Spam ELisp package
23815 @subsubsection Extending the Spam ELisp package
23816 @cindex spam filtering
23817 @cindex spam elisp package, extending
23818 @cindex extending the spam elisp package
23820 Say you want to add a new back end called blackbox. For filtering
23821 incoming mail, provide the following:
23829 (defvar spam-use-blackbox nil
23830 "True if blackbox should be used.")
23835 (spam-use-blackbox . spam-check-blackbox)
23837 to @code{spam-list-of-checks}.
23841 (gnus-group-ham-exit-processor-blackbox ham spam-use-blackbox)
23842 (gnus-group-spam-exit-processor-blackbox spam spam-use-blackbox)
23845 to @code{spam-list-of-processors}.
23849 (spam-use-blackbox spam-blackbox-register-routine
23851 spam-blackbox-unregister-routine
23855 to @code{spam-registration-functions}. Write the register/unregister
23856 routines using the bogofilter register/unregister routines as a
23857 start, or other restister/unregister routines more appropriate to
23863 Write the @code{spam-check-blackbox} function. It should return
23864 @samp{nil} or @code{spam-split-group}, observing the other
23865 conventions. See the existing @code{spam-check-*} functions for
23866 examples of what you can do, and stick to the template unless you
23867 fully understand the reasons why you aren't.
23869 Make sure to add @code{spam-use-blackbox} to
23870 @code{spam-list-of-statistical-checks} if Blackbox is a statistical
23871 mail analyzer that needs the full message body to operate.
23875 For processing spam and ham messages, provide the following:
23882 Note you don't have to provide a spam or a ham processor. Only
23883 provide them if Blackbox supports spam or ham processing.
23885 Also, ham and spam processors are being phased out as single
23886 variables. Instead the form @code{'(spam spam-use-blackbox)} or
23887 @code{'(ham spam-use-blackbox)} is favored. For now, spam/ham
23888 processor variables are still around but they won't be for long.
23891 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
23892 "The Blackbox summary exit spam processor.
23893 Only applicable to spam groups.")
23895 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
23896 "The whitelist summary exit ham processor.
23897 Only applicable to non-spam (unclassified and ham) groups.")
23906 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
23907 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
23909 to the @code{spam-process} group parameter in @code{gnus.el}. Make
23910 sure you do it twice, once for the parameter and once for the
23911 variable customization.
23915 (variable-item spam-use-blackbox)
23917 to the @code{spam-autodetect-methods} group parameter in
23923 @node Filtering Spam Using Statistics with spam-stat
23924 @subsection Filtering Spam Using Statistics with spam-stat
23925 @cindex Paul Graham
23926 @cindex Graham, Paul
23927 @cindex naive Bayesian spam filtering
23928 @cindex Bayesian spam filtering, naive
23929 @cindex spam filtering, naive Bayesian
23931 Paul Graham has written an excellent essay about spam filtering using
23932 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
23933 Spam}. In it he describes the inherent deficiency of rule-based
23934 filtering as used by SpamAssassin, for example: Somebody has to write
23935 the rules, and everybody else has to install these rules. You are
23936 always late. It would be much better, he argues, to filter mail based
23937 on whether it somehow resembles spam or non-spam. One way to measure
23938 this is word distribution. He then goes on to describe a solution
23939 that checks whether a new mail resembles any of your other spam mails
23942 The basic idea is this: Create a two collections of your mail, one
23943 with spam, one with non-spam. Count how often each word appears in
23944 either collection, weight this by the total number of mails in the
23945 collections, and store this information in a dictionary. For every
23946 word in a new mail, determine its probability to belong to a spam or a
23947 non-spam mail. Use the 15 most conspicuous words, compute the total
23948 probability of the mail being spam. If this probability is higher
23949 than a certain threshold, the mail is considered to be spam.
23951 Gnus supports this kind of filtering. But it needs some setting up.
23952 First, you need two collections of your mail, one with spam, one with
23953 non-spam. Then you need to create a dictionary using these two
23954 collections, and save it. And last but not least, you need to use
23955 this dictionary in your fancy mail splitting rules.
23958 * Creating a spam-stat dictionary::
23959 * Splitting mail using spam-stat::
23960 * Low-level interface to the spam-stat dictionary::
23963 @node Creating a spam-stat dictionary
23964 @subsubsection Creating a spam-stat dictionary
23966 Before you can begin to filter spam based on statistics, you must
23967 create these statistics based on two mail collections, one with spam,
23968 one with non-spam. These statistics are then stored in a dictionary
23969 for later use. In order for these statistics to be meaningful, you
23970 need several hundred emails in both collections.
23972 Gnus currently supports only the nnml back end for automated dictionary
23973 creation. The nnml back end stores all mails in a directory, one file
23974 per mail. Use the following:
23976 @defun spam-stat-process-spam-directory
23977 Create spam statistics for every file in this directory. Every file
23978 is treated as one spam mail.
23981 @defun spam-stat-process-non-spam-directory
23982 Create non-spam statistics for every file in this directory. Every
23983 file is treated as one non-spam mail.
23986 Usually you would call @code{spam-stat-process-spam-directory} on a
23987 directory such as @file{~/Mail/mail/spam} (this usually corresponds
23988 the the group @samp{nnml:mail.spam}), and you would call
23989 @code{spam-stat-process-non-spam-directory} on a directory such as
23990 @file{~/Mail/mail/misc} (this usually corresponds the the group
23991 @samp{nnml:mail.misc}).
23993 When you are using @acronym{IMAP}, you won't have the mails available
23994 locally, so that will not work. One solution is to use the Gnus Agent
23995 to cache the articles. Then you can use directories such as
23996 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
23997 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
24000 This variable holds the hash-table with all the statistics---the
24001 dictionary we have been talking about. For every word in either
24002 collection, this hash-table stores a vector describing how often the
24003 word appeared in spam and often it appeared in non-spam mails.
24006 If you want to regenerate the statistics from scratch, you need to
24007 reset the dictionary.
24009 @defun spam-stat-reset
24010 Reset the @code{spam-stat} hash-table, deleting all the statistics.
24013 When you are done, you must save the dictionary. The dictionary may
24014 be rather large. If you will not update the dictionary incrementally
24015 (instead, you will recreate it once a month, for example), then you
24016 can reduce the size of the dictionary by deleting all words that did
24017 not appear often enough or that do not clearly belong to only spam or
24018 only non-spam mails.
24020 @defun spam-stat-reduce-size
24021 Reduce the size of the dictionary. Use this only if you do not want
24022 to update the dictionary incrementally.
24025 @defun spam-stat-save
24026 Save the dictionary.
24029 @defvar spam-stat-file
24030 The filename used to store the dictionary. This defaults to
24031 @file{~/.spam-stat.el}.
24034 @node Splitting mail using spam-stat
24035 @subsubsection Splitting mail using spam-stat
24037 In order to use @code{spam-stat} to split your mail, you need to add the
24038 following to your @file{~/.gnus.el} file:
24041 (require 'spam-stat)
24045 This will load the necessary Gnus code, and the dictionary you
24048 Next, you need to adapt your fancy splitting rules: You need to
24049 determine how to use @code{spam-stat}. The following examples are for
24050 the nnml back end. Using the nnimap back end works just as well. Just
24051 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
24053 In the simplest case, you only have two groups, @samp{mail.misc} and
24054 @samp{mail.spam}. The following expression says that mail is either
24055 spam or it should go into @samp{mail.misc}. If it is spam, then
24056 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
24059 (setq nnmail-split-fancy
24060 `(| (: spam-stat-split-fancy)
24064 @defvar spam-stat-split-fancy-spam-group
24065 The group to use for spam. Default is @samp{mail.spam}.
24068 If you also filter mail with specific subjects into other groups, use
24069 the following expression. Only mails not matching the regular
24070 expression are considered potential spam.
24073 (setq nnmail-split-fancy
24074 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
24075 (: spam-stat-split-fancy)
24079 If you want to filter for spam first, then you must be careful when
24080 creating the dictionary. Note that @code{spam-stat-split-fancy} must
24081 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
24082 non-spam, therefore both should be in your collection of non-spam
24083 mails, when creating the dictionary!
24086 (setq nnmail-split-fancy
24087 `(| (: spam-stat-split-fancy)
24088 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24092 You can combine this with traditional filtering. Here, we move all
24093 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
24094 @code{spam-stat-split-fancy} will never see them, the mails in
24095 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
24096 nor in your collection of non-spam mails, when creating the
24100 (setq nnmail-split-fancy
24101 `(| ("Content-Type" "text/html" "mail.spam.filtered")
24102 (: spam-stat-split-fancy)
24103 ("Subject" "\\bspam-stat\\b" "mail.emacs")
24108 @node Low-level interface to the spam-stat dictionary
24109 @subsubsection Low-level interface to the spam-stat dictionary
24111 The main interface to using @code{spam-stat}, are the following functions:
24113 @defun spam-stat-buffer-is-spam
24114 Called in a buffer, that buffer is considered to be a new spam mail.
24115 Use this for new mail that has not been processed before.
24118 @defun spam-stat-buffer-is-no-spam
24119 Called in a buffer, that buffer is considered to be a new non-spam
24120 mail. Use this for new mail that has not been processed before.
24123 @defun spam-stat-buffer-change-to-spam
24124 Called in a buffer, that buffer is no longer considered to be normal
24125 mail but spam. Use this to change the status of a mail that has
24126 already been processed as non-spam.
24129 @defun spam-stat-buffer-change-to-non-spam
24130 Called in a buffer, that buffer is no longer considered to be spam but
24131 normal mail. Use this to change the status of a mail that has already
24132 been processed as spam.
24135 @defun spam-stat-save
24136 Save the hash table to the file. The filename used is stored in the
24137 variable @code{spam-stat-file}.
24140 @defun spam-stat-load
24141 Load the hash table from a file. The filename used is stored in the
24142 variable @code{spam-stat-file}.
24145 @defun spam-stat-score-word
24146 Return the spam score for a word.
24149 @defun spam-stat-score-buffer
24150 Return the spam score for a buffer.
24153 @defun spam-stat-split-fancy
24154 Use this function for fancy mail splitting. Add the rule @samp{(:
24155 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
24158 Make sure you load the dictionary before using it. This requires the
24159 following in your @file{~/.gnus.el} file:
24162 (require 'spam-stat)
24166 Typical test will involve calls to the following functions:
24169 Reset: (setq spam-stat (make-hash-table :test 'equal))
24170 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24171 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24172 Save table: (spam-stat-save)
24173 File size: (nth 7 (file-attributes spam-stat-file))
24174 Number of words: (hash-table-count spam-stat)
24175 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24176 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24177 Reduce table size: (spam-stat-reduce-size)
24178 Save table: (spam-stat-save)
24179 File size: (nth 7 (file-attributes spam-stat-file))
24180 Number of words: (hash-table-count spam-stat)
24181 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24182 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24185 Here is how you would create your dictionary:
24188 Reset: (setq spam-stat (make-hash-table :test 'equal))
24189 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24190 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24191 Repeat for any other non-spam group you need...
24192 Reduce table size: (spam-stat-reduce-size)
24193 Save table: (spam-stat-save)
24197 @section Interaction with other modes
24202 @code{gnus-dired-minor-mode} provided some useful functions for dired
24203 buffers. It is enabled with
24205 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
24210 @findex gnus-dired-attach
24211 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
24212 You will be prompted for a message buffer.
24215 @findex gnus-dired-find-file-mailcap
24216 Visit a file according to the appropriate mailcap entry
24217 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
24221 @findex gnus-dired-print
24222 Print file according to the mailcap entry (@code{gnus-dired-print}). If
24223 there is no print command, print in a PostScript image.
24226 @node Various Various
24227 @section Various Various
24233 @item gnus-home-directory
24234 @vindex gnus-home-directory
24235 All Gnus file and directory variables will be initialized from this
24236 variable, which defaults to @file{~/}.
24238 @item gnus-directory
24239 @vindex gnus-directory
24240 Most Gnus storage file and directory variables will be initialized from
24241 this variable, which defaults to the @env{SAVEDIR} environment
24242 variable, or @file{~/News/} if that variable isn't set.
24244 Note that Gnus is mostly loaded when the @file{~/.gnus.el} file is read.
24245 This means that other directory variables that are initialized from this
24246 variable won't be set properly if you set this variable in
24247 @file{~/.gnus.el}. Set this variable in @file{.emacs} instead.
24249 @item gnus-default-directory
24250 @vindex gnus-default-directory
24251 Not related to the above variable at all---this variable says what the
24252 default directory of all Gnus buffers should be. If you issue commands
24253 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
24254 default directory. If this variable is @code{nil} (which is the
24255 default), the default directory will be the default directory of the
24256 buffer you were in when you started Gnus.
24259 @vindex gnus-verbose
24260 This variable is an integer between zero and ten. The higher the value,
24261 the more messages will be displayed. If this variable is zero, Gnus
24262 will never flash any messages, if it is seven (which is the default),
24263 most important messages will be shown, and if it is ten, Gnus won't ever
24264 shut up, but will flash so many messages it will make your head swim.
24266 @item gnus-verbose-backends
24267 @vindex gnus-verbose-backends
24268 This variable works the same way as @code{gnus-verbose}, but it applies
24269 to the Gnus back ends instead of Gnus proper.
24271 @item nnheader-max-head-length
24272 @vindex nnheader-max-head-length
24273 When the back ends read straight heads of articles, they all try to read
24274 as little as possible. This variable (default 4096) specifies
24275 the absolute max length the back ends will try to read before giving up
24276 on finding a separator line between the head and the body. If this
24277 variable is @code{nil}, there is no upper read bound. If it is
24278 @code{t}, the back ends won't try to read the articles piece by piece,
24279 but read the entire articles. This makes sense with some versions of
24280 @code{ange-ftp} or @code{efs}.
24282 @item nnheader-head-chop-length
24283 @vindex nnheader-head-chop-length
24284 This variable (default 2048) says how big a piece of each article to
24285 read when doing the operation described above.
24287 @item nnheader-file-name-translation-alist
24288 @vindex nnheader-file-name-translation-alist
24290 @cindex invalid characters in file names
24291 @cindex characters in file names
24292 This is an alist that says how to translate characters in file names.
24293 For instance, if @samp{:} is invalid as a file character in file names
24294 on your system (you OS/2 user you), you could say something like:
24298 (setq nnheader-file-name-translation-alist
24303 In fact, this is the default value for this variable on OS/2 and MS
24304 Windows (phooey) systems.
24306 @item gnus-hidden-properties
24307 @vindex gnus-hidden-properties
24308 This is a list of properties to use to hide ``invisible'' text. It is
24309 @code{(invisible t intangible t)} by default on most systems, which
24310 makes invisible text invisible and intangible.
24312 @item gnus-parse-headers-hook
24313 @vindex gnus-parse-headers-hook
24314 A hook called before parsing headers. It can be used, for instance, to
24315 gather statistics on the headers fetched, or perhaps you'd like to prune
24316 some headers. I don't see why you'd want that, though.
24318 @item gnus-shell-command-separator
24319 @vindex gnus-shell-command-separator
24320 String used to separate two shell commands. The default is @samp{;}.
24322 @item gnus-invalid-group-regexp
24323 @vindex gnus-invalid-group-regexp
24325 Regexp to match ``invalid'' group names when querying user for a group
24326 name. The default value catches some @strong{really} invalid group
24327 names who could possibly mess up Gnus internally (like allowing
24328 @samp{:} in a group name, which is normally used to delimit method and
24331 @acronym{IMAP} users might want to allow @samp{/} in group names though.
24339 Well, that's the manual---you can get on with your life now. Keep in
24340 touch. Say hello to your cats from me.
24342 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
24344 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
24350 Not because of victories @*
24353 but for the common sunshine,@*
24355 the largess of the spring.
24359 but for the day's work done@*
24360 as well as I was able;@*
24361 not for a seat upon the dais@*
24362 but at the common table.@*
24367 @chapter Appendices
24370 * XEmacs:: Requirements for installing under XEmacs.
24371 * History:: How Gnus got where it is today.
24372 * On Writing Manuals:: Why this is not a beginner's guide.
24373 * Terminology:: We use really difficult, like, words here.
24374 * Customization:: Tailoring Gnus to your needs.
24375 * Troubleshooting:: What you might try if things do not work.
24376 * Gnus Reference Guide:: Rilly, rilly technical stuff.
24377 * Emacs for Heathens:: A short introduction to Emacsian terms.
24378 * Frequently Asked Questions:: The Gnus FAQ
24385 @cindex installing under XEmacs
24387 XEmacs is distributed as a collection of packages. You should install
24388 whatever packages the Gnus XEmacs package requires. The current
24389 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
24390 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
24391 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{w3},
24392 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
24399 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
24400 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
24402 If you want to investigate the person responsible for this outrage,
24403 you can point your (feh!) web browser to
24404 @uref{http://quimby.gnus.org/}. This is also the primary
24405 distribution point for the new and spiffy versions of Gnus, and is
24406 known as The Site That Destroys Newsrcs And Drives People Mad.
24408 During the first extended alpha period of development, the new Gnus was
24409 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
24410 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
24411 (Besides, the ``Gnus'' in this abbreviation should probably be
24412 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
24413 appropriate name, don't you think?)
24415 In any case, after spending all that energy on coming up with a new and
24416 spunky name, we decided that the name was @emph{too} spunky, so we
24417 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
24418 ``@sc{gnus}''. New vs. old.
24421 * Gnus Versions:: What Gnus versions have been released.
24422 * Other Gnus Versions:: Other Gnus versions that also have been released.
24423 * Why?:: What's the point of Gnus?
24424 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
24425 * Conformity:: Gnus tries to conform to all standards.
24426 * Emacsen:: Gnus can be run on a few modern Emacsen.
24427 * Gnus Development:: How Gnus is developed.
24428 * Contributors:: Oodles of people.
24429 * New Features:: Pointers to some of the new stuff in Gnus.
24433 @node Gnus Versions
24434 @subsection Gnus Versions
24436 @cindex September Gnus
24438 @cindex Quassia Gnus
24439 @cindex Pterodactyl Gnus
24442 @cindex Gnus versions
24444 The first ``proper'' release of Gnus 5 was done in November 1995 when it
24445 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
24446 plus 15 Gnus 5.0 releases).
24448 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
24449 releases)) was released under the name ``Gnus 5.2'' (40 releases).
24451 On July 28th 1996 work on Red Gnus was begun, and it was released on
24452 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
24454 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
24455 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
24457 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
24458 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
24461 On the 26th of October 2000, Oort Gnus was begun.
24463 If you happen upon a version of Gnus that has a prefixed name --
24464 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
24465 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
24466 that you're frightened. Back away. Slowly. Whatever you do, don't
24467 run. Walk away, calmly, until you're out of its reach. Find a proper
24468 released version of Gnus and snuggle up to that instead.
24471 @node Other Gnus Versions
24472 @subsection Other Gnus Versions
24475 In addition to the versions of Gnus which have had their releases
24476 coordinated by Lars, one major development has been Semi-gnus from
24477 Japan. It's based on a library called @acronym{SEMI}, which provides
24478 @acronym{MIME} capabilities.
24480 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
24481 Collectively, they are called ``Semi-gnus'', and different strains are
24482 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
24483 @acronym{MIME} and multilingualization things, especially important for
24490 What's the point of Gnus?
24492 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
24493 newsreader, that lets you do anything you can think of. That was my
24494 original motivation, but while working on Gnus, it has become clear to
24495 me that this generation of newsreaders really belong in the stone age.
24496 Newsreaders haven't developed much since the infancy of the net. If the
24497 volume continues to rise with the current rate of increase, all current
24498 newsreaders will be pretty much useless. How do you deal with
24499 newsgroups that have thousands of new articles each day? How do you
24500 keep track of millions of people who post?
24502 Gnus offers no real solutions to these questions, but I would very much
24503 like to see Gnus being used as a testing ground for new methods of
24504 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
24505 to separate the newsreader from the back ends, Gnus now offers a simple
24506 interface for anybody who wants to write new back ends for fetching mail
24507 and news from different sources. I have added hooks for customizations
24508 everywhere I could imagine it being useful. By doing so, I'm inviting
24509 every one of you to explore and invent.
24511 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
24512 @kbd{C-u 100 M-x all-hail-xemacs}.
24515 @node Compatibility
24516 @subsection Compatibility
24518 @cindex compatibility
24519 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
24520 bindings have been kept. More key bindings have been added, of course,
24521 but only in one or two obscure cases have old bindings been changed.
24526 @center In a cloud bones of steel.
24530 All commands have kept their names. Some internal functions have changed
24533 The @code{gnus-uu} package has changed drastically. @xref{Decoding
24536 One major compatibility question is the presence of several summary
24537 buffers. All variables relevant while reading a group are
24538 buffer-local to the summary buffer they belong in. Although many
24539 important variables have their values copied into their global
24540 counterparts whenever a command is executed in the summary buffer, this
24541 change might lead to incorrect values being used unless you are careful.
24543 All code that relies on knowledge of @sc{gnus} internals will probably
24544 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
24545 changing it in any way, as a matter of fact) is strictly verboten. Gnus
24546 maintains a hash table that points to the entries in this alist (which
24547 speeds up many functions), and changing the alist directly will lead to
24551 @cindex highlighting
24552 Old hilit19 code does not work at all. In fact, you should probably
24553 remove all hilit code from all Gnus hooks
24554 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
24555 Gnus provides various integrated functions for highlighting. These are
24556 faster and more accurate. To make life easier for everybody, Gnus will
24557 by default remove all hilit calls from all hilit hooks. Uncleanliness!
24560 Packages like @code{expire-kill} will no longer work. As a matter of
24561 fact, you should probably remove all old @sc{gnus} packages (and other
24562 code) when you start using Gnus. More likely than not, Gnus already
24563 does what you have written code to make @sc{gnus} do. (Snicker.)
24565 Even though old methods of doing things are still supported, only the
24566 new methods are documented in this manual. If you detect a new method of
24567 doing something while reading this manual, that does not mean you have
24568 to stop doing it the old way.
24570 Gnus understands all @sc{gnus} startup files.
24572 @kindex M-x gnus-bug
24574 @cindex reporting bugs
24576 Overall, a casual user who hasn't written much code that depends on
24577 @sc{gnus} internals should suffer no problems. If problems occur,
24578 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
24580 @vindex gnus-bug-create-help-buffer
24581 If you are in the habit of sending bug reports @emph{very} often, you
24582 may find the helpful help buffer annoying after a while. If so, set
24583 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
24588 @subsection Conformity
24590 No rebels without a clue here, ma'am. We conform to all standards known
24591 to (wo)man. Except for those standards and/or conventions we disagree
24599 There are no known breaches of this standard.
24603 There are no known breaches of this standard, either.
24605 @item Son-of-RFC 1036
24606 @cindex Son-of-RFC 1036
24607 We do have some breaches to this one.
24613 These are considered to be ``vanity headers'', while I consider them
24614 to be consumer information. After seeing so many badly formatted
24615 articles coming from @code{tin} and @code{Netscape} I know not to use
24616 either of those for posting articles. I would not have known that if
24617 it wasn't for the @code{X-Newsreader} header.
24622 USEFOR is an IETF working group writing a successor to RFC 1036, based
24623 on Son-of-RFC 1036. They have produced a number of drafts proposing
24624 various changes to the format of news articles. The Gnus towers will
24625 look into implementing the changes when the draft is accepted as an RFC.
24627 @item MIME - RFC 2045-2049 etc
24628 @cindex @acronym{MIME}
24629 All the various @acronym{MIME} RFCs are supported.
24631 @item Disposition Notifications - RFC 2298
24632 Message Mode is able to request notifications from the receiver.
24634 @item PGP - RFC 1991 and RFC 2440
24637 RFC 1991 is the original @acronym{PGP} message specification,
24638 published as an informational RFC. RFC 2440 was the follow-up, now
24639 called Open PGP, and put on the Standards Track. Both document a
24640 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
24641 encoding (signing and encryption) and decoding (verification and
24644 @item PGP/MIME - RFC 2015/3156
24645 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
24646 1991) describes the @acronym{MIME}-wrapping around the RF 1991/2440 format.
24647 Gnus supports both encoding and decoding.
24649 @item S/MIME - RFC 2633
24650 RFC 2633 describes the @acronym{S/MIME} format.
24652 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
24653 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
24654 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
24655 authentication for @acronym{IMAP}. RFC 2086 describes access control
24656 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
24657 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
24658 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
24659 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
24663 If you ever notice Gnus acting non-compliant with regards to the texts
24664 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
24669 @subsection Emacsen
24675 Gnus should work on:
24683 XEmacs 21.4 and up.
24687 This Gnus version will absolutely not work on any Emacsen older than
24688 that. Not reliably, at least. Older versions of Gnus may work on older
24691 There are some vague differences between Gnus on the various
24692 platforms---XEmacs features more graphics (a logo and a toolbar)---but
24693 other than that, things should look pretty much the same under all
24697 @node Gnus Development
24698 @subsection Gnus Development
24700 Gnus is developed in a two-phased cycle. The first phase involves much
24701 discussion on the @samp{ding@@gnus.org} mailing list, where people
24702 propose changes and new features, post patches and new back ends. This
24703 phase is called the @dfn{alpha} phase, since the Gnusae released in this
24704 phase are @dfn{alpha releases}, or (perhaps more commonly in other
24705 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
24706 unstable and should not be used by casual users. Gnus alpha releases
24707 have names like ``Red Gnus'' and ``Quassia Gnus''.
24709 After futzing around for 50-100 alpha releases, Gnus is declared
24710 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
24711 and is called things like ``Gnus 5.6.32'' instead. Normal people are
24712 supposed to be able to use these, and these are mostly discussed on the
24713 @samp{gnu.emacs.gnus} newsgroup.
24716 @vindex mail-source-delete-incoming
24717 Some variable defaults differ between alpha Gnusae and released Gnusae.
24718 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
24719 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
24720 lossage of mail if an alpha release hiccups while handling the mail.
24722 The division of discussion between the ding mailing list and the Gnus
24723 newsgroup is not purely based on publicity concerns. It's true that
24724 having people write about the horrible things that an alpha Gnus release
24725 can do (sometimes) in a public forum may scare people off, but more
24726 importantly, talking about new experimental features that have been
24727 introduced may confuse casual users. New features are frequently
24728 introduced, fiddled with, and judged to be found wanting, and then
24729 either discarded or totally rewritten. People reading the mailing list
24730 usually keep up with these rapid changes, while people on the newsgroup
24731 can't be assumed to do so.
24736 @subsection Contributors
24737 @cindex contributors
24739 The new Gnus version couldn't have been done without the help of all the
24740 people on the (ding) mailing list. Every day for over a year I have
24741 gotten billions of nice bug reports from them, filling me with joy,
24742 every single one of them. Smooches. The people on the list have been
24743 tried beyond endurance, what with my ``oh, that's a neat idea <type
24744 type>, yup, I'll release it right away <ship off> no wait, that doesn't
24745 work at all <type type>, yup, I'll ship that one off right away <ship
24746 off> no, wait, that absolutely does not work'' policy for releases.
24747 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
24748 ``worser''? ``much worser''? ``worsest''?)
24750 I would like to take this opportunity to thank the Academy for@dots{} oops,
24756 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
24759 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
24760 nnwarchive and many, many other things connected with @acronym{MIME} and
24761 other types of en/decoding, as well as general bug fixing, new
24762 functionality and stuff.
24765 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
24766 well as numerous other things).
24769 Luis Fernandes---design and graphics.
24772 Joe Reiss---creator of the smiley faces.
24775 Justin Sheehy---the @acronym{FAQ} maintainer.
24778 Erik Naggum---help, ideas, support, code and stuff.
24781 Wes Hardaker---@file{gnus-picon.el} and the manual section on
24782 @dfn{picons} (@pxref{Picons}).
24785 Kim-Minh Kaplan---further work on the picon code.
24788 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
24791 Sudish Joseph---innumerable bug fixes.
24794 Ilja Weis---@file{gnus-topic.el}.
24797 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
24800 Vladimir Alexiev---the refcard and reference booklets.
24803 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
24804 distribution by Felix Lee and JWZ.
24807 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
24810 Peter Mutsaers---orphan article scoring code.
24813 Ken Raeburn---POP mail support.
24816 Hallvard B Furuseth---various bits and pieces, especially dealing with
24820 Brian Edmonds---@file{gnus-bbdb.el}.
24823 David Moore---rewrite of @file{nnvirtual.el} and many other things.
24826 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
24829 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
24830 well as autoconf support.
24834 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
24835 Borges, and Jost Krieger proof-reading parts of the manual.
24837 The following people have contributed many patches and suggestions:
24852 Jason L. Tibbitts, III,
24854 Katsumi Yamaoka, @c Yamaoka
24858 Also thanks to the following for patches and stuff:
24868 Alexei V. Barantsev,
24883 Massimo Campostrini,
24888 Jae-you Chung, @c ?
24889 James H. Cloos, Jr.,
24893 Andrew J. Cosgriff,
24896 Geoffrey T. Dairiki,
24902 Michael Welsh Duggan,
24907 Enami Tsugutomo, @c Enami
24911 Nelson Jose dos Santos Ferreira,
24919 Arne Georg Gleditsch,
24921 Michelangelo Grigni,
24925 Kenichi Handa, @c Handa
24927 Yoshiki Hayashi, @c Hayashi
24929 Hisashige Kenji, @c Hisashige
24936 Fran@,{c}ois Felix Ingrand,
24937 Tatsuya Ichikawa, @c Ichikawa
24938 Ishikawa Ichiro, @c Ishikawa
24940 Iwamuro Motonori, @c Iwamuro
24950 Peter Skov Knudsen,
24951 Shuhei Kobayashi, @c Kobayashi
24953 Koseki Yoshinori, @c Koseki
24954 Thor Kristoffersen,
24957 Seokchan Lee, @c Lee
24975 Morioka Tomohiko, @c Morioka
24976 Erik Toubro Nielsen,
24983 Masaharu Onishi, @c Onishi
24988 Jens-Ulrik Holger Petersen,
24992 John McClary Prevost,
24998 Lars Balker Rasmussen,
25003 Christian von Roques,
25006 Wolfgang Rupprecht,
25013 Philippe Schnoebelen,
25015 Randal L. Schwartz,
25029 Kiyokazu Suto, @c Suto
25034 Tozawa Akihiko, @c Tozawa
25054 For a full overview of what each person has done, the ChangeLogs
25055 included in the Gnus alpha distributions should give ample reading
25056 (550kB and counting).
25058 Apologies to everybody that I've forgotten, of which there are many, I'm
25061 Gee, that's quite a list of people. I guess that must mean that there
25062 actually are people who are using Gnus. Who'd'a thunk it!
25066 @subsection New Features
25067 @cindex new features
25070 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
25071 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
25072 * Red Gnus:: Third time best---Gnus 5.4/5.5.
25073 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
25074 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
25075 * Oort Gnus:: It's big. It's far out. Gnus 5.10.
25076 * No Gnus:: Lars, FIXME!
25079 These lists are, of course, just @emph{short} overviews of the
25080 @emph{most} important new features. No, really. There are tons more.
25081 Yes, we have feeping creaturism in full effect.
25084 @subsubsection (ding) Gnus
25086 New features in Gnus 5.0/5.1:
25091 The look of all buffers can be changed by setting format-like variables
25092 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
25095 Local spool and several @acronym{NNTP} servers can be used at once
25096 (@pxref{Select Methods}).
25099 You can combine groups into virtual groups (@pxref{Virtual Groups}).
25102 You can read a number of different mail formats (@pxref{Getting Mail}).
25103 All the mail back ends implement a convenient mail expiry scheme
25104 (@pxref{Expiring Mail}).
25107 Gnus can use various strategies for gathering threads that have lost
25108 their roots (thereby gathering loose sub-threads into one thread) or it
25109 can go back and retrieve enough headers to build a complete thread
25110 (@pxref{Customizing Threading}).
25113 Killed groups can be displayed in the group buffer, and you can read
25114 them as well (@pxref{Listing Groups}).
25117 Gnus can do partial group updates---you do not have to retrieve the
25118 entire active file just to check for new articles in a few groups
25119 (@pxref{The Active File}).
25122 Gnus implements a sliding scale of subscribedness to groups
25123 (@pxref{Group Levels}).
25126 You can score articles according to any number of criteria
25127 (@pxref{Scoring}). You can even get Gnus to find out how to score
25128 articles for you (@pxref{Adaptive Scoring}).
25131 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
25132 manner, so it should be difficult to lose much data on what you have
25133 read if your machine should go down (@pxref{Auto Save}).
25136 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
25137 cluttering up the @file{.emacs} file.
25140 You can set the process mark on both groups and articles and perform
25141 operations on all the marked items (@pxref{Process/Prefix}).
25144 You can grep through a subset of groups and create a group from the
25145 results (@pxref{Kibozed Groups}).
25148 You can list subsets of groups according to, well, anything
25149 (@pxref{Listing Groups}).
25152 You can browse foreign servers and subscribe to groups from those
25153 servers (@pxref{Browse Foreign Server}).
25156 Gnus can fetch articles, asynchronously, on a second connection to the
25157 server (@pxref{Asynchronous Fetching}).
25160 You can cache articles locally (@pxref{Article Caching}).
25163 The uudecode functions have been expanded and generalized
25164 (@pxref{Decoding Articles}).
25167 You can still post uuencoded articles, which was a little-known feature
25168 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
25171 Fetching parents (and other articles) now actually works without
25172 glitches (@pxref{Finding the Parent}).
25175 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
25178 Digests (and other files) can be used as the basis for groups
25179 (@pxref{Document Groups}).
25182 Articles can be highlighted and customized (@pxref{Customizing
25186 URLs and other external references can be buttonized (@pxref{Article
25190 You can do lots of strange stuff with the Gnus window & frame
25191 configuration (@pxref{Window Layout}).
25194 You can click on buttons instead of using the keyboard
25200 @node September Gnus
25201 @subsubsection September Gnus
25205 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
25209 New features in Gnus 5.2/5.3:
25214 A new message composition mode is used. All old customization variables
25215 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
25219 Gnus is now able to generate @dfn{sparse} threads---threads where
25220 missing articles are represented by empty nodes (@pxref{Customizing
25224 (setq gnus-build-sparse-threads 'some)
25228 Outgoing articles are stored on a special archive server
25229 (@pxref{Archived Messages}).
25232 Partial thread regeneration now happens when articles are
25236 Gnus can make use of GroupLens predictions.
25239 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
25242 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
25245 (setq gnus-use-trees t)
25249 An @code{nn}-like pick-and-read minor mode is available for the summary
25250 buffers (@pxref{Pick and Read}).
25253 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
25257 In binary groups you can use a special binary minor mode (@pxref{Binary
25261 Groups can be grouped in a folding topic hierarchy (@pxref{Group
25265 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
25269 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
25272 Groups can now have a score, and bubbling based on entry frequency
25273 is possible (@pxref{Group Score}).
25276 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
25280 Groups can be process-marked, and commands can be performed on
25281 groups of groups (@pxref{Marking Groups}).
25284 Caching is possible in virtual groups.
25287 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
25288 news batches, ClariNet briefs collections, and just about everything
25289 else (@pxref{Document Groups}).
25292 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
25296 The Gnus cache is much faster.
25299 Groups can be sorted according to many criteria (@pxref{Sorting
25303 New group parameters have been introduced to set list-addresses and
25304 expiry times (@pxref{Group Parameters}).
25307 All formatting specs allow specifying faces to be used
25308 (@pxref{Formatting Fonts}).
25311 There are several more commands for setting/removing/acting on process
25312 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
25315 The summary buffer can be limited to show parts of the available
25316 articles based on a wide range of criteria. These commands have been
25317 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
25320 Articles can be made persistent with the @kbd{*} command
25321 (@pxref{Persistent Articles}).
25324 All functions for hiding article elements are now toggles.
25327 Article headers can be buttonized (@pxref{Article Washing}).
25330 All mail back ends support fetching articles by @code{Message-ID}.
25333 Duplicate mail can now be treated properly (@pxref{Duplicates}).
25336 All summary mode commands are available directly from the article
25337 buffer (@pxref{Article Keymap}).
25340 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
25344 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
25347 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
25352 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
25355 (setq gnus-use-nocem t)
25359 Groups can be made permanently visible (@pxref{Listing Groups}).
25362 (setq gnus-permanently-visible-groups "^nnml:")
25366 Many new hooks have been introduced to make customizing easier.
25369 Gnus respects the @code{Mail-Copies-To} header.
25372 Threads can be gathered by looking at the @code{References} header
25373 (@pxref{Customizing Threading}).
25376 (setq gnus-summary-thread-gathering-function
25377 'gnus-gather-threads-by-references)
25381 Read articles can be stored in a special backlog buffer to avoid
25382 refetching (@pxref{Article Backlog}).
25385 (setq gnus-keep-backlog 50)
25389 A clean copy of the current article is always stored in a separate
25390 buffer to allow easier treatment.
25393 Gnus can suggest where to save articles (@pxref{Saving Articles}).
25396 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
25400 (setq gnus-prompt-before-saving t)
25404 @code{gnus-uu} can view decoded files asynchronously while fetching
25405 articles (@pxref{Other Decode Variables}).
25408 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
25412 Filling in the article buffer now works properly on cited text
25413 (@pxref{Article Washing}).
25416 Hiding cited text adds buttons to toggle hiding, and how much
25417 cited text to hide is now customizable (@pxref{Article Hiding}).
25420 (setq gnus-cited-lines-visible 2)
25424 Boring headers can be hidden (@pxref{Article Hiding}).
25427 Default scoring values can now be set from the menu bar.
25430 Further syntax checking of outgoing articles have been added.
25436 @subsubsection Red Gnus
25438 New features in Gnus 5.4/5.5:
25442 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
25449 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
25452 Article prefetching functionality has been moved up into
25453 Gnus (@pxref{Asynchronous Fetching}).
25456 Scoring can now be performed with logical operators like @code{and},
25457 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
25461 Article washing status can be displayed in the
25462 article mode line (@pxref{Misc Article}).
25465 @file{gnus.el} has been split into many smaller files.
25468 Suppression of duplicate articles based on Message-ID can be done
25469 (@pxref{Duplicate Suppression}).
25472 (setq gnus-suppress-duplicates t)
25476 New variables for specifying what score and adapt files are to be
25477 considered home score and adapt files (@pxref{Home Score File}) have
25481 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
25482 Server Internals}).
25485 Groups can inherit group parameters from parent topics (@pxref{Topic
25489 Article editing has been revamped and is now actually usable.
25492 Signatures can be recognized in more intelligent fashions
25493 (@pxref{Article Signature}).
25496 Summary pick mode has been made to look more @code{nn}-like. Line
25497 numbers are displayed and the @kbd{.} command can be used to pick
25498 articles (@code{Pick and Read}).
25501 Commands for moving the @file{.newsrc.eld} from one server to
25502 another have been added (@pxref{Changing Servers}).
25505 There's a way now to specify that ``uninteresting'' fields be suppressed
25506 when generating lines in buffers (@pxref{Advanced Formatting}).
25509 Several commands in the group buffer can be undone with @kbd{C-M-_}
25513 Scoring can be done on words using the new score type @code{w}
25514 (@pxref{Score File Format}).
25517 Adaptive scoring can be done on a Subject word-by-word basis
25518 (@pxref{Adaptive Scoring}).
25521 (setq gnus-use-adaptive-scoring '(word))
25525 Scores can be decayed (@pxref{Score Decays}).
25528 (setq gnus-decay-scores t)
25532 Scoring can be performed using a regexp on the Date header. The Date is
25533 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
25536 A new command has been added to remove all data on articles from
25537 the native server (@pxref{Changing Servers}).
25540 A new command for reading collections of documents
25541 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
25542 (@pxref{Really Various Summary Commands}).
25545 Process mark sets can be pushed and popped (@pxref{Setting Process
25549 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
25550 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
25553 A new back end for reading searches from Web search engines
25554 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
25555 (@pxref{Web Searches}).
25558 Groups inside topics can now be sorted using the standard sorting
25559 functions, and each topic can be sorted independently (@pxref{Topic
25563 Subsets of the groups can be sorted independently (@code{Sorting
25567 Cached articles can be pulled into the groups (@pxref{Summary Generation
25571 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
25576 Score files are now applied in a more reliable order (@pxref{Score
25580 Reports on where mail messages end up can be generated (@pxref{Splitting
25584 More hooks and functions have been added to remove junk from incoming
25585 mail before saving the mail (@pxref{Washing Mail}).
25588 Emphasized text can be properly fontisized:
25594 @subsubsection Quassia Gnus
25596 New features in Gnus 5.6:
25601 New functionality for using Gnus as an offline newsreader has been
25602 added. A plethora of new commands and modes have been added.
25603 @xref{Gnus Unplugged}, for the full story.
25606 The @code{nndraft} back end has returned, but works differently than
25607 before. All Message buffers are now also articles in the @code{nndraft}
25608 group, which is created automatically.
25611 @code{gnus-alter-header-function} can now be used to alter header
25615 @code{gnus-summary-goto-article} now accept Message-ID's.
25618 A new Message command for deleting text in the body of a message
25619 outside the region: @kbd{C-c C-v}.
25622 You can now post to component group in @code{nnvirtual} groups with
25626 @code{nntp-rlogin-program}---new variable to ease customization.
25629 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
25630 re-highlighting of the article buffer.
25633 New element in @code{gnus-boring-article-headers}---@code{long-to}.
25636 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
25640 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
25641 @kbd{a} to add the score rule to the @file{all.SCORE} file.
25644 @code{gnus-simplify-subject-functions} variable to allow greater
25645 control over simplification.
25648 @kbd{A T}---new command for fetching the current thread.
25651 @kbd{/ T}---new command for including the current thread in the
25655 @kbd{M-RET} is a new Message command for breaking cited text.
25658 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
25661 The @code{custom-face-lookup} function has been removed.
25662 If you used this function in your initialization files, you must
25663 rewrite them to use @code{face-spec-set} instead.
25666 Canceling now uses the current select method. Symbolic prefix
25667 @kbd{a} forces normal posting method.
25670 New command to translate M******** sm*rtq**t*s into proper
25674 For easier debugging of @code{nntp}, you can set
25675 @code{nntp-record-commands} to a non-@code{nil} value.
25678 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
25679 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
25682 A command for editing group parameters from the summary buffer
25686 A history of where mails have been split is available.
25689 A new article date command has been added---@code{article-date-iso8601}.
25692 Subjects can be simplified when threading by setting
25693 @code{gnus-score-thread-simplify}.
25696 A new function for citing in Message has been
25697 added---@code{message-cite-original-without-signature}.
25700 @code{article-strip-all-blank-lines}---new article command.
25703 A new Message command to kill to the end of the article has
25707 A minimum adaptive score can be specified by using the
25708 @code{gnus-adaptive-word-minimum} variable.
25711 The ``lapsed date'' article header can be kept continually
25712 updated by the @code{gnus-start-date-timer} command.
25715 Web listserv archives can be read with the @code{nnlistserv} back end.
25718 Old dejanews archives can now be read by @code{nnweb}.
25722 @node Pterodactyl Gnus
25723 @subsubsection Pterodactyl Gnus
25725 New features in Gnus 5.8:
25730 The mail-fetching functions have changed. See the manual for the
25731 many details. In particular, all procmail fetching variables are gone.
25733 If you used procmail like in
25736 (setq nnmail-use-procmail t)
25737 (setq nnmail-spool-file 'procmail)
25738 (setq nnmail-procmail-directory "~/mail/incoming/")
25739 (setq nnmail-procmail-suffix "\\.in")
25742 this now has changed to
25746 '((directory :path "~/mail/incoming/"
25750 @xref{Mail Source Specifiers}.
25753 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
25754 Gnus, and adds a slew of new commands. See the manual for details.
25757 Gnus has also been multilingualized. This also affects too
25758 many parts of Gnus to summarize here, and adds many new variables.
25761 @code{gnus-auto-select-first} can now be a function to be
25762 called to position point.
25765 The user can now decide which extra headers should be included in
25766 summary buffers and @acronym{NOV} files.
25769 @code{gnus-article-display-hook} has been removed. Instead, a number
25770 of variables starting with @code{gnus-treat-} have been added.
25773 The Gnus posting styles have been redone again and now works in a
25774 subtly different manner.
25777 New web-based back ends have been added: @code{nnslashdot},
25778 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
25779 again, to keep up with ever-changing layouts.
25782 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
25787 @subsubsection Oort Gnus
25790 New features in Gnus 5.10:
25795 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
25796 (@code{gnus-article-reply-with-original}) only yank the text in the
25797 region if the region is active.
25800 @code{gnus-group-read-ephemeral-group} can be called interactively,
25804 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
25805 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
25808 The revised Gnus @acronym{FAQ} is included in the manual,
25809 @xref{Frequently Asked Questions}.
25812 Upgrading from previous (stable) version if you have used Oort.
25814 If you have tried Oort (the unstable Gnus branch leading to this
25815 release) but went back to a stable version, be careful when upgrading to
25816 this version. In particular, you will probably want to remove all
25817 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
25818 read from your @file{.newsrc.eld} instead of from the
25819 @file{.marks}/@file{.mrk} file where this release store flags. See a
25820 later entry for more information about marks. Note that downgrading
25821 isn't save in general.
25826 More buttons for URLs, mail addresses, Message-IDs, Info links, man
25827 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
25828 variables @code{gnus-button-@var{*}-level} can be used to control the
25829 appearance of all article buttons. @xref{Article Button Levels}.
25834 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
25835 bindings in dired buffers to send a file as an attachment, open a file
25836 using the appropriate mailcap entry, and print a file using the mailcap
25840 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
25843 Single-part yenc encoded attachments can be decoded.
25848 The picons code has been reimplemented to work in GNU Emacs---some of
25849 the previous options have been removed or renamed.
25851 Picons are small ``personal icons'' representing users, domain and
25852 newsgroups, which can be displayed in the Article buffer.
25856 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
25857 boundary line is drawn at the end of the headers.
25860 Retrieval of charters and control messages
25862 There are new commands for fetching newsgroup charters (@kbd{H c}) and
25863 control messages (@kbd{H C}).
25868 You can delay the sending of a message with @kbd{C-c C-j} in the Message
25869 buffer. The messages are delivered at specified time. This is useful
25870 for sending yourself reminders. @xref{Delayed Articles}.
25873 If @code{auto-compression-mode} is enabled, attachments are automatically
25874 decompressed when activated.
25877 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
25878 the nnml back end allows compressed message files.
25881 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
25884 The Summary Buffer uses an arrow in the fringe to indicate the current
25885 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
25888 Warn about email replies to news
25890 Do you often find yourself replying to news by email by mistake? Then
25891 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
25895 If the new option @code{gnus-summary-display-while-building} is
25896 non-@code{nil}, the summary buffer is shown and updated as it's being
25900 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
25901 opposed to old but unread messages).
25904 The new option @code{gnus-gcc-mark-as-read} automatically marks
25905 Gcc articles as read.
25908 The nndoc back end now supports mailman digests and exim bounces.
25911 Gnus supports RFC 2369 mailing list headers, and adds a number of
25912 related commands in mailing list groups. @xref{Mailing List}.
25915 The Date header can be displayed in a format that can be read aloud
25916 in English. @xref{Article Date}.
25919 The envelope sender address can be customized when using Sendmail.
25920 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
25923 diffs are automatically highlighted in groups matching
25924 @code{mm-uu-diff-groups-regexp}
25927 @acronym{TLS} wrapper shipped with Gnus
25929 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
25930 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
25931 @acronym{TLS}/@acronym{SSL} support via (external third party)
25932 @file{ssl.el} and OpenSSL still works.
25935 New @file{make.bat} for compiling and installing Gnus under MS Windows
25937 Use @file{make.bat} if you want to install Gnus under MS Windows, the
25938 first argument to the batch-program should be the directory where
25939 @file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want
25940 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
25941 the second parameter.
25943 @file{make.bat} has been rewritten from scratch, it now features
25944 automatic recognition of XEmacs and GNU Emacs, generates
25945 @file{gnus-load.el}, checks if errors occur while compilation and
25946 generation of info files and reports them at the end of the build
25947 process. It now uses @code{makeinfo} if it is available and falls
25948 back to @file{infohack.el} otherwise. @file{make.bat} should now
25949 install all files which are necessary to run Gnus and be generally a
25950 complete replacement for the @code{configure; make; make install}
25951 cycle used under Unix systems.
25953 The new @file{make.bat} makes @file{make-x.bat} superfluous, so it has
25957 Support for non-@acronym{ASCII} domain names
25959 Message supports non-@acronym{ASCII} domain names in From:, To: and
25960 Cc: and will query you whether to perform encoding when you try to
25961 send a message. The variable @code{message-use-idna} controls this.
25962 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
25963 and Cc: when you view a message. The variable @code{gnus-use-idna}
25967 Better handling of Microsoft citation styles
25969 Gnus now tries to recognize the mangled header block that some Microsoft
25970 mailers use to indicate that the rest of the message is a citation, even
25971 though it is not quoted in any way. The variable
25972 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
25976 @code{gnus-article-skip-boring}
25978 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
25979 not scroll down to show you a page that contains only boring text,
25980 which by default means cited text and signature. You can customize
25981 what is skippable using @code{gnus-article-boring-faces}.
25983 This feature is especially useful if you read many articles that
25984 consist of a little new content at the top with a long, untrimmed
25985 message cited below.
25988 The format spec @code{%C} for positioning point has changed to @code{%*}.
25991 The new variable @code{gnus-parameters} can be used to set group parameters.
25993 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
25994 the parameters in @file{~/.newsrc.eld}, but via this variable you can
25995 enjoy the powers of customize, and simplified backups since you set the
25996 variable in @file{~/.emacs} instead of @file{~/.newsrc.eld}. The
25997 variable maps regular expressions matching group names to group
26000 (setq gnus-parameters
26002 (gnus-show-threads nil)
26003 (gnus-use-scoring nil))
26004 ("^nnimap:\\(foo.bar\\)$"
26005 (to-group . "\\1"))))
26009 Smileys (@samp{:-)}, @samp{;-)} etc) are now iconized for Emacs too.
26011 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.emacs} to
26015 Gnus no longer generate the Sender: header automatically.
26017 Earlier it was generated iff the user configurable email address was
26018 different from the Gnus guessed default user address. As the guessing
26019 algorithm is rarely correct these days, and (more controversially) the
26020 only use of the Sender: header was to check if you are entitled to
26021 cancel/supersede news (which is now solved by Cancel Locks instead,
26022 see another entry), generation of the header has been disabled by
26023 default. See the variables @code{message-required-headers},
26024 @code{message-required-news-headers}, and
26025 @code{message-required-mail-headers}.
26028 Features from third party @file{message-utils.el} added to @file{message.el}.
26030 Message now asks if you wish to remove @samp{(was: <old subject>)} from
26031 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
26032 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
26033 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
26034 appropriate headers and a note in the body for cross-postings and
26035 followups (see the variables @code{message-cross-post-@var{*}}).
26038 References and X-Draft-Headers are no longer generated when you start
26039 composing messages and @code{message-generate-headers-first} is
26043 Improved anti-spam features.
26045 Gnus is now able to take out spam from your mail and news streams
26046 using a wide variety of programs and filter rules. Among the supported
26047 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
26048 for easy use of external packages such as SpamAssassin and Hashcash
26049 are also new. @xref{Thwarting Email Spam}.
26052 Easy inclusion of X-Faces headers.
26055 Face headers handling.
26058 In the summary buffer, the new command @kbd{/ N} inserts new messages
26059 and @kbd{/ o} inserts old messages.
26062 Gnus decodes morse encoded messages if you press @kbd{W m}.
26065 Unread count correct in nnimap groups.
26067 The estimated number of unread articles in the group buffer should now
26068 be correct for nnimap groups. This is achieved by calling
26069 @code{nnimap-fixup-unread-after-getting-new-news} from the
26070 @code{gnus-setup-news-hook} (called on startup) and
26071 @code{gnus-after-getting-new-news-hook}. (called after getting new
26072 mail). If you have modified those variables from the default, you may
26073 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
26074 you were happy with the estimate and want to save some (minimal) time
26075 when getting new mail, remove the function.
26078 Group Carbon Copy (GCC) quoting
26080 To support groups that contains SPC and other weird characters, groups
26081 are quoted before they are placed in the Gcc: header. This means
26082 variables such as @code{gnus-message-archive-group} should no longer
26083 contain quote characters to make groups containing SPC work. Also, if
26084 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
26085 into two groups) you must change it to return the list
26086 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
26087 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
26088 was incorrect earlier, it just didn't generate any problems since it
26089 was inserted directly.
26092 @file{~/News/overview/} not used.
26094 As a result of the following change, the @file{~/News/overview/}
26095 directory is not used any more. You can safely delete the entire
26101 The Gnus Agent has seen a major updated and is now enabled by default,
26102 and all nntp and nnimap servers from @code{gnus-select-method} and
26103 @code{gnus-secondary-select-method} are agentized by default. Earlier
26104 only the server in @code{gnus-select-method} was agentized by the
26105 default, and the agent was disabled by default. When the agent is
26106 enabled, headers are now also retrieved from the Agent cache instead
26107 of the back ends when possible. Earlier this only happened in the
26108 unplugged state. You can enroll or remove servers with @kbd{J a} and
26109 @kbd{J r} in the server buffer. Gnus will not download articles into
26110 the Agent cache, unless you instruct it to do so, though, by using
26111 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
26112 behaviour of having the Agent disabled with @code{(setq gnus-agent
26113 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
26114 is not needed any more.
26117 @code{gnus-summary-line-format}
26119 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
26120 %s\n}. Moreover @code{gnus-extra-headers},
26121 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
26122 changed their default so that the users name will be replaced by the
26123 recipient's name or the group name posting to for @acronym{NNTP}
26127 @file{deuglify.el} (@code{gnus-article-outlook-deuglify-article})
26129 A new file from Raymond Scholz @email{rscholz@@zonix.de} for deuglifying
26130 broken Outlook (Express) articles.
26133 @code{(require 'gnus-load)}
26135 If you use a stand-alone Gnus distribution, you'd better add
26136 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
26137 lisp directory into load-path.
26139 File @file{gnus-load.el} contains autoload commands, functions and variables,
26140 some of which may not be included in distributions of Emacsen.
26143 @code{gnus-slave-unplugged}
26145 A new command which starts Gnus offline in slave mode.
26148 @code{message-insinuate-rmail}
26150 Adding @code{(message-insinuate-rmail)} and @code{(setq
26151 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
26152 compose, reply and forward messages in message-mode, where you can
26153 enjoy the power of @acronym{MML}.
26156 @code{message-minibuffer-local-map}
26158 The line below enables BBDB in resending a message:
26160 (define-key message-minibuffer-local-map [(tab)]
26161 'bbdb-complete-name)
26165 Externalizing and deleting of attachments.
26167 If @code{gnus-gcc-externalize-attachments} or
26168 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
26169 local files as external parts.
26171 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
26172 on @acronym{MIME} buttons) saves a part and replaces the part with an
26173 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
26174 @acronym{MIME} buttons) removes a part. It works only on back ends
26175 that support editing.
26178 @code{gnus-default-charset}
26180 The default value is determined from the
26181 @code{current-language-environment} variable, instead of
26182 @code{iso-8859-1}. Also the @samp{.*} item in
26183 @code{gnus-group-charset-alist} is removed.
26186 @code{gnus-posting-styles}
26188 Add a new format of match like
26190 ((header "to" "larsi.*org")
26191 (Organization "Somewhere, Inc."))
26193 The old format like the lines below is obsolete, but still accepted.
26195 (header "to" "larsi.*org"
26196 (Organization "Somewhere, Inc."))
26200 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
26202 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
26203 added into these two variables. If you customized those, perhaps you
26204 need add those two headers too.
26207 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
26209 If one reads an article while plugged, and the article already exists
26210 in the Agent, it won't get downloaded once more. @code{(setq
26211 gnus-agent-cache nil)} reverts to the old behavior.
26214 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
26215 composing messages, it is enabled by @code{use-hard-newlines}.
26216 Decoding format=flowed was present but not documented in earlier
26220 Gnus supports the generation of RFC 2298 Disposition Notification requests.
26222 This is invoked with the @kbd{C-c M-n} key binding from message mode.
26225 Gnus supports Maildir groups.
26227 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
26230 Printing capabilities are enhanced.
26232 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
26233 Article buffers. Also, each individual @acronym{MIME} part can be
26234 printed using @kbd{p} on the @acronym{MIME} button.
26237 Message supports the Importance: (RFC 2156) header.
26239 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
26243 Gnus supports Cancel Locks in News.
26245 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
26246 used to determine if you wrote an article or not (for canceling and
26247 superseding). Gnus generates a random password string the first time
26248 you post a message, and saves it in your @file{~/.emacs} using the Custom
26249 system. While the variable is called @code{canlock-password}, it is not
26250 security sensitive data. Publishing your canlock string on the web
26251 will not allow anyone to be able to anything she could not already do.
26252 The behaviour can be changed by customizing @code{message-insert-canlock}.
26255 Gnus supports server-side mail filtering using Sieve.
26257 Sieve rules can be added as Group Parameters for groups, and the
26258 complete Sieve script is generated using @kbd{D g} from the Group
26259 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
26260 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
26261 manual @ref{Top, , Top, sieve, Emacs Sieve}.
26264 Extended format specs.
26266 Format spec @samp{%&user-date;} is added into
26267 @code{gnus-summary-line-format-alist}. Also, user defined extended
26268 format specs are supported. The extended format specs look like
26269 @samp{%u&foo;}, which invokes function
26270 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
26271 escape character, old user defined format @samp{%u&} is no longer supported.
26274 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
26276 It was aliased to @kbd{Y c}
26277 (@code{gnus-summary-insert-cached-articles}). The new function filters
26278 out other articles.
26280 @item Some limiting commands accept a @kbd{C-u} prefix to negate the match.
26282 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
26283 s}, @kbd{/ a}, and @kbd{/ x}
26284 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
26285 result will be to display all articles that do not match the expression.
26288 Group names are treated as UTF-8 by default.
26290 This is supposedly what USEFOR wanted to migrate to. See
26291 @code{gnus-group-name-charset-group-alist} and
26292 @code{gnus-group-name-charset-method-alist} for customization.
26295 The nnml and nnfolder back ends store marks for each groups.
26297 This makes it possible to take backup of nnml/nnfolder servers/groups
26298 separately of @file{~/.newsrc.eld}, while preserving marks. It also
26299 makes it possible to share articles and marks between users (without
26300 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
26301 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
26302 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
26303 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
26304 another machine, Gnus will automatically use the @file{.marks} or
26305 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
26306 The new server variables @code{nnml-marks-is-evil} and
26307 @code{nnfolder-marks-is-evil} can be used to disable this feature.
26310 The menu bar item (in Group and Summary buffer) named ``Misc'' has
26311 been renamed to ``Gnus''.
26314 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
26315 renamed to ``Attachments''. Note that this menu also contains security
26316 related stuff, like signing and encryption (@pxref{Security, Security,,
26317 message, Message Manual}).
26320 @code{gnus-group-charset-alist} and
26321 @code{gnus-group-ignored-charsets-alist}.
26323 The regexps in these variables are compared with full group names
26324 instead of real group names in 5.8. Users who customize these
26325 variables should change those regexps accordingly. For example:
26327 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
26331 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
26332 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
26334 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
26335 additional Lisp libraries. This add several menu items to the
26336 Attachments menu, and @kbd{C-c RET} key bindings, when composing
26337 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
26340 Gnus inlines external parts (message/external).
26343 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
26346 This change was made to avoid conflict with the standard binding of
26347 @code{back-to-indentation}, which is also useful in message mode.
26350 The default for @code{message-forward-show-mml} changed to symbol @code{best}.
26352 The behaviour for the @code{best} value is to show @acronym{MML} (i.e.,
26353 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
26354 used when forwarding signed or encrypted messages, as the conversion
26355 invalidate the digital signature.
26359 @subsubsection No Gnus
26362 New features in No Gnus:
26363 @c FIXME: Gnus 5.12?
26365 @include gnus-news.texi
26371 @section The Manual
26375 This manual was generated from a TeXinfo file and then run through
26376 either @code{texi2dvi}
26378 or my own home-brewed TeXinfo to \LaTeX\ transformer,
26379 and then run through @code{latex} and @code{dvips}
26381 to get what you hold in your hands now.
26383 The following conventions have been used:
26388 This is a @samp{string}
26391 This is a @kbd{keystroke}
26394 This is a @file{file}
26397 This is a @code{symbol}
26401 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
26405 (setq flargnoze "yes")
26408 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
26411 (setq flumphel 'yes)
26414 @samp{yes} and @code{yes} are two @emph{very} different things---don't
26415 ever get them confused.
26419 Of course, everything in this manual is of vital interest, so you should
26420 read it all. Several times. However, if you feel like skimming the
26421 manual, look for that gnu head you should see in the margin over
26422 there---it means that what's being discussed is of more importance than
26423 the rest of the stuff. (On the other hand, if everything is infinitely
26424 important, how can anything be more important than that? Just one more
26425 of the mysteries of this world, I guess.)
26431 @node On Writing Manuals
26432 @section On Writing Manuals
26434 I guess most manuals are written after-the-fact; documenting a program
26435 that's already there. This is not how this manual is written. When
26436 implementing something, I write the manual entry for that something
26437 straight away. I then see that it's difficult to explain the
26438 functionality, so I write how it's supposed to be, and then I change the
26439 implementation. Writing the documentation and writing the code goes
26442 This, of course, means that this manual has no, or little, flow. It
26443 documents absolutely everything in Gnus, but often not where you're
26444 looking for it. It is a reference manual, and not a guide to how to get
26447 That would be a totally different book, that should be written using the
26448 reference manual as source material. It would look quite differently.
26453 @section Terminology
26455 @cindex terminology
26460 This is what you are supposed to use this thing for---reading news.
26461 News is generally fetched from a nearby @acronym{NNTP} server, and is
26462 generally publicly available to everybody. If you post news, the entire
26463 world is likely to read just what you have written, and they'll all
26464 snigger mischievously. Behind your back.
26468 Everything that's delivered to you personally is mail. Some news/mail
26469 readers (like Gnus) blur the distinction between mail and news, but
26470 there is a difference. Mail is private. News is public. Mailing is
26471 not posting, and replying is not following up.
26475 Send a mail to the person who has written what you are reading.
26479 Post an article to the current newsgroup responding to the article you
26484 Gnus considers mail and news to be mostly the same, really. The only
26485 difference is how to access the actual articles. News articles are
26486 commonly fetched via the protocol @acronym{NNTP}, whereas mail
26487 messages could be read from a file on the local disk. The internal
26488 architecture of Gnus thus comprises a ``front end'' and a number of
26489 ``back ends''. Internally, when you enter a group (by hitting
26490 @key{RET}, say), you thereby invoke a function in the front end in
26491 Gnus. The front end then ``talks'' to a back end and says things like
26492 ``Give me the list of articles in the foo group'' or ``Show me article
26495 So a back end mainly defines either a protocol (the @code{nntp} back
26496 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
26497 accesses mail via @acronym{IMAP}) or a file format and directory
26498 layout (the @code{nnspool} back end accesses news via the common
26499 ``spool directory'' format, the @code{nnml} back end access mail via a
26500 file format and directory layout that's quite similar).
26502 Gnus does not handle the underlying media, so to speak---this is all
26503 done by the back ends. A back end is a collection of functions to
26504 access the articles.
26506 However, sometimes the term ``back end'' is also used where ``server''
26507 would have been more appropriate. And then there is the term ``select
26508 method'' which can mean either. The Gnus terminology can be quite
26513 Gnus will always use one method (and back end) as the @dfn{native}, or
26514 default, way of getting news.
26518 You can also have any number of foreign groups active at the same time.
26519 These are groups that use non-native non-secondary back ends for getting
26524 Secondary back ends are somewhere half-way between being native and being
26525 foreign, but they mostly act like they are native.
26529 A message that has been posted as news.
26532 @cindex mail message
26533 A message that has been mailed.
26537 A mail message or news article
26541 The top part of a message, where administrative information (etc.) is
26546 The rest of an article. Everything not in the head is in the
26551 A line from the head of an article.
26555 A collection of such lines, or a collection of heads. Or even a
26556 collection of @acronym{NOV} lines.
26558 @item @acronym{NOV}
26559 @cindex @acronym{NOV}
26560 When Gnus enters a group, it asks the back end for the headers of all
26561 unread articles in the group. Most servers support the News OverView
26562 format, which is more compact and much faster to read and parse than the
26563 normal @sc{head} format.
26567 Each group is subscribed at some @dfn{level} or other (1-9). The ones
26568 that have a lower level are ``more'' subscribed than the groups with a
26569 higher level. In fact, groups on levels 1-5 are considered
26570 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
26571 are @dfn{killed}. Commands for listing groups and scanning for new
26572 articles will all use the numeric prefix as @dfn{working level}.
26574 @item killed groups
26575 @cindex killed groups
26576 No information on killed groups is stored or updated, which makes killed
26577 groups much easier to handle than subscribed groups.
26579 @item zombie groups
26580 @cindex zombie groups
26581 Just like killed groups, only slightly less dead.
26584 @cindex active file
26585 The news server has to keep track of what articles it carries, and what
26586 groups exist. All this information in stored in the active file, which
26587 is rather large, as you might surmise.
26590 @cindex bogus groups
26591 A group that exists in the @file{.newsrc} file, but isn't known to the
26592 server (i.e., it isn't in the active file), is a @emph{bogus group}.
26593 This means that the group probably doesn't exist (any more).
26596 @cindex activating groups
26597 The act of asking the server for info on a group and computing the
26598 number of unread articles is called @dfn{activating the group}.
26599 Un-activated groups are listed with @samp{*} in the group buffer.
26603 A machine one can connect to and get news (or mail) from.
26605 @item select method
26606 @cindex select method
26607 A structure that specifies the back end, the server and the virtual
26610 @item virtual server
26611 @cindex virtual server
26612 A named select method. Since a select method defines all there is to
26613 know about connecting to a (physical) server, taking the thing as a
26614 whole is a virtual server.
26618 Taking a buffer and running it through a filter of some sort. The
26619 result will (more often than not) be cleaner and more pleasing than the
26622 @item ephemeral groups
26623 @cindex ephemeral groups
26624 @cindex temporary groups
26625 Most groups store data on what articles you have read. @dfn{Ephemeral}
26626 groups are groups that will have no data stored---when you exit the
26627 group, it'll disappear into the aether.
26630 @cindex solid groups
26631 This is the opposite of ephemeral groups. All groups listed in the
26632 group buffer are solid groups.
26634 @item sparse articles
26635 @cindex sparse articles
26636 These are article placeholders shown in the summary buffer when
26637 @code{gnus-build-sparse-threads} has been switched on.
26641 To put responses to articles directly after the articles they respond
26642 to---in a hierarchical fashion.
26646 @cindex thread root
26647 The first article in a thread is the root. It is the ancestor of all
26648 articles in the thread.
26652 An article that has responses.
26656 An article that responds to a different article---its parent.
26660 A collection of messages in one file. The most common digest format is
26661 specified by RFC 1153.
26664 @cindex splitting, terminolgy
26665 @cindex mail sorting
26666 @cindex mail filtering (splitting)
26667 The action of sorting your emails according to certain rules. Sometimes
26668 incorrectly called mail filtering.
26674 @node Customization
26675 @section Customization
26676 @cindex general customization
26678 All variables are properly documented elsewhere in this manual. This
26679 section is designed to give general pointers on how to customize Gnus
26680 for some quite common situations.
26683 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
26684 * Slow Terminal Connection:: You run a remote Emacs.
26685 * Little Disk Space:: You feel that having large setup files is icky.
26686 * Slow Machine:: You feel like buying a faster machine.
26690 @node Slow/Expensive Connection
26691 @subsection Slow/Expensive NNTP Connection
26693 If you run Emacs on a machine locally, and get your news from a machine
26694 over some very thin strings, you want to cut down on the amount of data
26695 Gnus has to get from the @acronym{NNTP} server.
26699 @item gnus-read-active-file
26700 Set this to @code{nil}, which will inhibit Gnus from requesting the
26701 entire active file from the server. This file is often v. large. You
26702 also have to set @code{gnus-check-new-newsgroups} and
26703 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
26704 doesn't suddenly decide to fetch the active file anyway.
26706 @item gnus-nov-is-evil
26707 This one has to be @code{nil}. If not, grabbing article headers from
26708 the @acronym{NNTP} server will not be very fast. Not all @acronym{NNTP} servers
26709 support @sc{xover}; Gnus will detect this by itself.
26713 @node Slow Terminal Connection
26714 @subsection Slow Terminal Connection
26716 Let's say you use your home computer for dialing up the system that runs
26717 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
26718 possible) the amount of data sent over the wires.
26722 @item gnus-auto-center-summary
26723 Set this to @code{nil} to inhibit Gnus from re-centering the summary
26724 buffer all the time. If it is @code{vertical}, do only vertical
26725 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
26726 horizontal and vertical recentering.
26728 @item gnus-visible-headers
26729 Cut down on the headers included in the articles to the
26730 minimum. You can, in fact, make do without them altogether---most of the
26731 useful data is in the summary buffer, anyway. Set this variable to
26732 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
26734 Set this hook to all the available hiding commands:
26736 (setq gnus-treat-hide-headers 'head
26737 gnus-treat-hide-signature t
26738 gnus-treat-hide-citation t)
26741 @item gnus-use-full-window
26742 By setting this to @code{nil}, you can make all the windows smaller.
26743 While this doesn't really cut down much generally, it means that you
26744 have to see smaller portions of articles before deciding that you didn't
26745 want to read them anyway.
26747 @item gnus-thread-hide-subtree
26748 If this is non-@code{nil}, all threads in the summary buffer will be
26752 @item gnus-updated-mode-lines
26753 If this is @code{nil}, Gnus will not put information in the buffer mode
26754 lines, which might save some time.
26758 @node Little Disk Space
26759 @subsection Little Disk Space
26762 The startup files can get rather large, so you may want to cut their
26763 sizes a bit if you are running out of space.
26767 @item gnus-save-newsrc-file
26768 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
26769 only save @file{.newsrc.eld}. This means that you will not be able to
26770 use any other newsreaders than Gnus. This variable is @code{t} by
26773 @item gnus-read-newsrc-file
26774 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
26775 only read @file{.newsrc.eld}. This means that you will not be able to
26776 use any other newsreaders than Gnus. This variable is @code{t} by
26779 @item gnus-save-killed-list
26780 If this is @code{nil}, Gnus will not save the list of dead groups. You
26781 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
26782 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
26783 variable to @code{nil}. This variable is @code{t} by default.
26789 @subsection Slow Machine
26790 @cindex slow machine
26792 If you have a slow machine, or are just really impatient, there are a
26793 few things you can do to make Gnus run faster.
26795 Set @code{gnus-check-new-newsgroups} and
26796 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
26798 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
26799 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
26800 summary buffer faster.
26802 Gnus uses the internal ELisp-based @code{uncompface} program for
26803 decoding an @code{X-Face} header normally in Emacs. If you feel it is
26804 slow, set @code{uncompface-use-external} to @code{t}. @xref{X-Face}.
26808 @node Troubleshooting
26809 @section Troubleshooting
26810 @cindex troubleshooting
26812 Gnus works @emph{so} well straight out of the box---I can't imagine any
26820 Make sure your computer is switched on.
26823 Make sure that you really load the current Gnus version. If you have
26824 been running @sc{gnus}, you need to exit Emacs and start it up again before
26828 Try doing an @kbd{M-x gnus-version}. If you get something that looks
26829 like @samp{Gnus v5.10.6} you have the right files loaded. Otherwise
26830 you have some old @file{.el} files lying around. Delete these.
26833 Read the help group (@kbd{G h} in the group buffer) for a
26834 @acronym{FAQ} and a how-to.
26837 @vindex max-lisp-eval-depth
26838 Gnus works on many recursive structures, and in some extreme (and very
26839 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
26840 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
26841 something like that.
26844 If all else fails, report the problem as a bug.
26847 @cindex reporting bugs
26849 @kindex M-x gnus-bug
26851 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
26852 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
26853 me the backtrace. I will fix bugs, but I can only fix them if you send
26854 me a precise description as to how to reproduce the bug.
26856 You really can never be too detailed in a bug report. Always use the
26857 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
26858 a 10Kb mail each time you use it, and even if you have sent me your
26859 environment 500 times before. I don't care. I want the full info each
26862 It is also important to remember that I have no memory whatsoever. If
26863 you send a bug report, and I send you a reply, and then you just send
26864 back ``No, it's not! Moron!'', I will have no idea what you are
26865 insulting me about. Always over-explain everything. It's much easier
26866 for all of us---if I don't have all the information I need, I will just
26867 mail you and ask for more info, and everything takes more time.
26869 If the problem you're seeing is very visual, and you can't quite explain
26870 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
26871 it somewhere it can be reached, and include the URL of the picture in
26875 If you would like to contribute a patch to fix bugs or make
26876 improvements, please produce the patch using @samp{diff -u}.
26879 If you want to debug your problem further before reporting, possibly
26880 in order to solve the problem yourself and send a patch, you can use
26881 edebug. Debugging Lisp code is documented in the Elisp manual
26882 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
26883 Lisp Reference Manual}). To get you started with edebug, consider if
26884 you discover some weird behaviour when pressing @kbd{c}, the first
26885 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
26886 the documentation buffer that leads you to the function definition,
26887 then press @kbd{M-x edebug-defun RET} with point inside that function,
26888 return to Gnus and press @kbd{c} to invoke the code. You will be
26889 placed in the lisp buffer and can single step using @kbd{SPC} and
26890 evaluate expressions using @kbd{M-:} or inspect variables using
26891 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
26892 @kbd{c} or @kbd{g}.
26897 Sometimes, a problem do not directly generate an elisp error but
26898 manifests itself by causing Gnus to be very slow. In these cases, you
26899 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
26900 slow, and then try to analyze the backtrace (repeating the procedure
26901 helps isolating the real problem areas).
26903 A fancier approach is to use the elisp profiler, ELP. The profiler is
26904 (or should be) fully documented elsewhere, but to get you started
26905 there are a few steps that need to be followed. First, instrument the
26906 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
26907 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
26908 RET message}. Then perform the operation that is slow and press
26909 @kbd{M-x elp-results}. You will then see which operations that takes
26910 time, and can debug them further. If the entire operation takes much
26911 longer than the time spent in the slowest function in the profiler
26912 output, you probably profiled the wrong part of Gnus. To reset
26913 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
26914 elp-restore-all} is supposed to remove profiling, but given the
26915 complexities and dynamic code generation in Gnus, it might not always
26918 @cindex gnu.emacs.gnus
26919 @cindex ding mailing list
26920 If you just need help, you are better off asking on
26921 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
26922 @email{ding@@gnus.org, the ding mailing list}. Write to
26923 @email{ding-request@@gnus.org} to subscribe.
26927 @node Gnus Reference Guide
26928 @section Gnus Reference Guide
26930 It is my hope that other people will figure out smart stuff that Gnus
26931 can do, and that other people will write those smart things as well. To
26932 facilitate that I thought it would be a good idea to describe the inner
26933 workings of Gnus. And some of the not-so-inner workings, while I'm at
26936 You can never expect the internals of a program not to change, but I
26937 will be defining (in some details) the interface between Gnus and its
26938 back ends (this is written in stone), the format of the score files
26939 (ditto), data structures (some are less likely to change than others)
26940 and general methods of operation.
26943 * Gnus Utility Functions:: Common functions and variable to use.
26944 * Back End Interface:: How Gnus communicates with the servers.
26945 * Score File Syntax:: A BNF definition of the score file standard.
26946 * Headers:: How Gnus stores headers internally.
26947 * Ranges:: A handy format for storing mucho numbers.
26948 * Group Info:: The group info format.
26949 * Extended Interactive:: Symbolic prefixes and stuff.
26950 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
26951 * Various File Formats:: Formats of files that Gnus use.
26955 @node Gnus Utility Functions
26956 @subsection Gnus Utility Functions
26957 @cindex Gnus utility functions
26958 @cindex utility functions
26960 @cindex internal variables
26962 When writing small functions to be run from hooks (and stuff), it's
26963 vital to have access to the Gnus internal functions and variables.
26964 Below is a list of the most common ones.
26968 @item gnus-newsgroup-name
26969 @vindex gnus-newsgroup-name
26970 This variable holds the name of the current newsgroup.
26972 @item gnus-find-method-for-group
26973 @findex gnus-find-method-for-group
26974 A function that returns the select method for @var{group}.
26976 @item gnus-group-real-name
26977 @findex gnus-group-real-name
26978 Takes a full (prefixed) Gnus group name, and returns the unprefixed
26981 @item gnus-group-prefixed-name
26982 @findex gnus-group-prefixed-name
26983 Takes an unprefixed group name and a select method, and returns the full
26984 (prefixed) Gnus group name.
26986 @item gnus-get-info
26987 @findex gnus-get-info
26988 Returns the group info list for @var{group}.
26990 @item gnus-group-unread
26991 @findex gnus-group-unread
26992 The number of unread articles in @var{group}, or @code{t} if that is
26996 @findex gnus-active
26997 The active entry for @var{group}.
26999 @item gnus-set-active
27000 @findex gnus-set-active
27001 Set the active entry for @var{group}.
27003 @item gnus-add-current-to-buffer-list
27004 @findex gnus-add-current-to-buffer-list
27005 Adds the current buffer to the list of buffers to be killed on Gnus
27008 @item gnus-continuum-version
27009 @findex gnus-continuum-version
27010 Takes a Gnus version string as a parameter and returns a floating point
27011 number. Earlier versions will always get a lower number than later
27014 @item gnus-group-read-only-p
27015 @findex gnus-group-read-only-p
27016 Says whether @var{group} is read-only or not.
27018 @item gnus-news-group-p
27019 @findex gnus-news-group-p
27020 Says whether @var{group} came from a news back end.
27022 @item gnus-ephemeral-group-p
27023 @findex gnus-ephemeral-group-p
27024 Says whether @var{group} is ephemeral or not.
27026 @item gnus-server-to-method
27027 @findex gnus-server-to-method
27028 Returns the select method corresponding to @var{server}.
27030 @item gnus-server-equal
27031 @findex gnus-server-equal
27032 Says whether two virtual servers are equal.
27034 @item gnus-group-native-p
27035 @findex gnus-group-native-p
27036 Says whether @var{group} is native or not.
27038 @item gnus-group-secondary-p
27039 @findex gnus-group-secondary-p
27040 Says whether @var{group} is secondary or not.
27042 @item gnus-group-foreign-p
27043 @findex gnus-group-foreign-p
27044 Says whether @var{group} is foreign or not.
27046 @item gnus-group-find-parameter
27047 @findex gnus-group-find-parameter
27048 Returns the parameter list of @var{group}. If given a second parameter,
27049 returns the value of that parameter for @var{group}.
27051 @item gnus-group-set-parameter
27052 @findex gnus-group-set-parameter
27053 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
27055 @item gnus-narrow-to-body
27056 @findex gnus-narrow-to-body
27057 Narrows the current buffer to the body of the article.
27059 @item gnus-check-backend-function
27060 @findex gnus-check-backend-function
27061 Takes two parameters, @var{function} and @var{group}. If the back end
27062 @var{group} comes from supports @var{function}, return non-@code{nil}.
27065 (gnus-check-backend-function "request-scan" "nnml:misc")
27069 @item gnus-read-method
27070 @findex gnus-read-method
27071 Prompts the user for a select method.
27076 @node Back End Interface
27077 @subsection Back End Interface
27079 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
27080 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
27081 server is a @dfn{back end} and some @dfn{back end variables}. As examples
27082 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
27083 examples of the latter we have @code{nntp-port-number} and
27084 @code{nnmbox-directory}.
27086 When Gnus asks for information from a back end---say @code{nntp}---on
27087 something, it will normally include a virtual server name in the
27088 function parameters. (If not, the back end should use the ``current''
27089 virtual server.) For instance, @code{nntp-request-list} takes a virtual
27090 server as its only (optional) parameter. If this virtual server hasn't
27091 been opened, the function should fail.
27093 Note that a virtual server name has no relation to some physical server
27094 name. Take this example:
27098 (nntp-address "ifi.uio.no")
27099 (nntp-port-number 4324))
27102 Here the virtual server name is @samp{odd-one} while the name of
27103 the physical server is @samp{ifi.uio.no}.
27105 The back ends should be able to switch between several virtual servers.
27106 The standard back ends implement this by keeping an alist of virtual
27107 server environments that they pull down/push up when needed.
27109 There are two groups of interface functions: @dfn{required functions},
27110 which must be present, and @dfn{optional functions}, which Gnus will
27111 always check for presence before attempting to call 'em.
27113 All these functions are expected to return data in the buffer
27114 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
27115 unfortunately named, but we'll have to live with it. When I talk about
27116 @dfn{resulting data}, I always refer to the data in that buffer. When I
27117 talk about @dfn{return value}, I talk about the function value returned by
27118 the function call. Functions that fail should return @code{nil} as the
27121 Some back ends could be said to be @dfn{server-forming} back ends, and
27122 some might be said not to be. The latter are back ends that generally
27123 only operate on one group at a time, and have no concept of ``server''
27124 ---they have a group, and they deliver info on that group and nothing
27127 Gnus identifies each message by way of group name and article number. A
27128 few remarks about these article numbers might be useful. First of all,
27129 the numbers are positive integers. Secondly, it is normally not
27130 possible for later articles to ``re-use'' older article numbers without
27131 confusing Gnus. That is, if a group has ever contained a message
27132 numbered 42, then no other message may get that number, or Gnus will get
27133 mightily confused.@footnote{See the function
27134 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
27135 Third, article numbers must be assigned in order of arrival in the
27136 group; this is not necessarily the same as the date of the message.
27138 The previous paragraph already mentions all the ``hard'' restrictions that
27139 article numbers must fulfill. But it seems that it might be useful to
27140 assign @emph{consecutive} article numbers, for Gnus gets quite confused
27141 if there are holes in the article numbering sequence. However, due to
27142 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
27143 also useful for the article numbers to start at 1 to avoid running out
27144 of numbers as long as possible.
27146 Note that by convention, back ends are named @code{nnsomething}, but
27147 Gnus also comes with some @code{nnnotbackends}, such as
27148 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
27150 In the examples and definitions I will refer to the imaginary back end
27153 @cindex @code{nnchoke}
27156 * Required Back End Functions:: Functions that must be implemented.
27157 * Optional Back End Functions:: Functions that need not be implemented.
27158 * Error Messaging:: How to get messages and report errors.
27159 * Writing New Back Ends:: Extending old back ends.
27160 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
27161 * Mail-like Back Ends:: Some tips on mail back ends.
27165 @node Required Back End Functions
27166 @subsubsection Required Back End Functions
27170 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
27172 @var{articles} is either a range of article numbers or a list of
27173 @code{Message-ID}s. Current back ends do not fully support either---only
27174 sequences (lists) of article numbers, and most back ends do not support
27175 retrieval of @code{Message-ID}s. But they should try for both.
27177 The result data should either be HEADs or @acronym{NOV} lines, and the result
27178 value should either be @code{headers} or @code{nov} to reflect this.
27179 This might later be expanded to @code{various}, which will be a mixture
27180 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
27182 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
27183 headers'', in some meaning of the word. This is generally done by
27184 fetching (at most) @var{fetch-old} extra headers less than the smallest
27185 article number in @code{articles}, and filling the gaps as well. The
27186 presence of this parameter can be ignored if the back end finds it
27187 cumbersome to follow the request. If this is non-@code{nil} and not a
27188 number, do maximum fetches.
27190 Here's an example HEAD:
27193 221 1056 Article retrieved.
27194 Path: ifi.uio.no!sturles
27195 From: sturles@@ifi.uio.no (Sturle Sunde)
27196 Newsgroups: ifi.discussion
27197 Subject: Re: Something very droll
27198 Date: 27 Oct 1994 14:02:57 +0100
27199 Organization: Dept. of Informatics, University of Oslo, Norway
27201 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
27202 References: <38jdmq$4qu@@visbur.ifi.uio.no>
27203 NNTP-Posting-Host: holmenkollen.ifi.uio.no
27207 So a @code{headers} return value would imply that there's a number of
27208 these in the data buffer.
27210 Here's a BNF definition of such a buffer:
27214 head = error / valid-head
27215 error-message = [ "4" / "5" ] 2number " " <error message> eol
27216 valid-head = valid-message *header "." eol
27217 valid-message = "221 " <number> " Article retrieved." eol
27218 header = <text> eol
27222 (The version of BNF used here is the one used in RFC822.)
27224 If the return value is @code{nov}, the data buffer should contain
27225 @dfn{network overview database} lines. These are basically fields
27229 nov-buffer = *nov-line
27230 nov-line = field 7*8[ <TAB> field ] eol
27231 field = <text except TAB>
27234 For a closer look at what should be in those fields,
27238 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
27240 @var{server} is here the virtual server name. @var{definitions} is a
27241 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
27243 If the server can't be opened, no error should be signaled. The back end
27244 may then choose to refuse further attempts at connecting to this
27245 server. In fact, it should do so.
27247 If the server is opened already, this function should return a
27248 non-@code{nil} value. There should be no data returned.
27251 @item (nnchoke-close-server &optional SERVER)
27253 Close connection to @var{server} and free all resources connected
27254 to it. Return @code{nil} if the server couldn't be closed for some
27257 There should be no data returned.
27260 @item (nnchoke-request-close)
27262 Close connection to all servers and free all resources that the back end
27263 have reserved. All buffers that have been created by that back end
27264 should be killed. (Not the @code{nntp-server-buffer}, though.) This
27265 function is generally only called when Gnus is shutting down.
27267 There should be no data returned.
27270 @item (nnchoke-server-opened &optional SERVER)
27272 If @var{server} is the current virtual server, and the connection to the
27273 physical server is alive, then this function should return a
27274 non-@code{nil} value. This function should under no circumstances
27275 attempt to reconnect to a server we have lost connection to.
27277 There should be no data returned.
27280 @item (nnchoke-status-message &optional SERVER)
27282 This function should return the last error message from @var{server}.
27284 There should be no data returned.
27287 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
27289 The result data from this function should be the article specified by
27290 @var{article}. This might either be a @code{Message-ID} or a number.
27291 It is optional whether to implement retrieval by @code{Message-ID}, but
27292 it would be nice if that were possible.
27294 If @var{to-buffer} is non-@code{nil}, the result data should be returned
27295 in this buffer instead of the normal data buffer. This is to make it
27296 possible to avoid copying large amounts of data from one buffer to
27297 another, while Gnus mainly requests articles to be inserted directly
27298 into its article buffer.
27300 If it is at all possible, this function should return a cons cell where
27301 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
27302 the article number. This will enable Gnus to find out what the real
27303 group and article numbers are when fetching articles by
27304 @code{Message-ID}. If this isn't possible, @code{t} should be returned
27305 on successful article retrieval.
27308 @item (nnchoke-request-group GROUP &optional SERVER FAST)
27310 Get data on @var{group}. This function also has the side effect of
27311 making @var{group} the current group.
27313 If @var{fast}, don't bother to return useful data, just make @var{group}
27316 Here's an example of some result data and a definition of the same:
27319 211 56 1000 1059 ifi.discussion
27322 The first number is the status, which should be 211. Next is the
27323 total number of articles in the group, the lowest article number, the
27324 highest article number, and finally the group name. Note that the total
27325 number of articles may be less than one might think while just
27326 considering the highest and lowest article numbers, but some articles
27327 may have been canceled. Gnus just discards the total-number, so
27328 whether one should take the bother to generate it properly (if that is a
27329 problem) is left as an exercise to the reader. If the group contains no
27330 articles, the lowest article number should be reported as 1 and the
27334 group-status = [ error / info ] eol
27335 error = [ "4" / "5" ] 2<number> " " <Error message>
27336 info = "211 " 3* [ <number> " " ] <string>
27340 @item (nnchoke-close-group GROUP &optional SERVER)
27342 Close @var{group} and free any resources connected to it. This will be
27343 a no-op on most back ends.
27345 There should be no data returned.
27348 @item (nnchoke-request-list &optional SERVER)
27350 Return a list of all groups available on @var{server}. And that means
27353 Here's an example from a server that only carries two groups:
27356 ifi.test 0000002200 0000002000 y
27357 ifi.discussion 3324 3300 n
27360 On each line we have a group name, then the highest article number in
27361 that group, the lowest article number, and finally a flag. If the group
27362 contains no articles, the lowest article number should be reported as 1
27363 and the highest as 0.
27366 active-file = *active-line
27367 active-line = name " " <number> " " <number> " " flags eol
27369 flags = "n" / "y" / "m" / "x" / "j" / "=" name
27372 The flag says whether the group is read-only (@samp{n}), is moderated
27373 (@samp{m}), is dead (@samp{x}), is aliased to some other group
27374 (@samp{=other-group}) or none of the above (@samp{y}).
27377 @item (nnchoke-request-post &optional SERVER)
27379 This function should post the current buffer. It might return whether
27380 the posting was successful or not, but that's not required. If, for
27381 instance, the posting is done asynchronously, it has generally not been
27382 completed by the time this function concludes. In that case, this
27383 function should set up some kind of sentinel to beep the user loud and
27384 clear if the posting could not be completed.
27386 There should be no result data from this function.
27391 @node Optional Back End Functions
27392 @subsubsection Optional Back End Functions
27396 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
27398 @var{groups} is a list of groups, and this function should request data
27399 on all those groups. How it does it is of no concern to Gnus, but it
27400 should attempt to do this in a speedy fashion.
27402 The return value of this function can be either @code{active} or
27403 @code{group}, which says what the format of the result data is. The
27404 former is in the same format as the data from
27405 @code{nnchoke-request-list}, while the latter is a buffer full of lines
27406 in the same format as @code{nnchoke-request-group} gives.
27409 group-buffer = *active-line / *group-status
27413 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
27415 A Gnus group info (@pxref{Group Info}) is handed to the back end for
27416 alterations. This comes in handy if the back end really carries all
27417 the information (as is the case with virtual and imap groups). This
27418 function should destructively alter the info to suit its needs, and
27419 should return a non-@code{nil} value.
27421 There should be no result data from this function.
27424 @item (nnchoke-request-type GROUP &optional ARTICLE)
27426 When the user issues commands for ``sending news'' (@kbd{F} in the
27427 summary buffer, for instance), Gnus has to know whether the article the
27428 user is following up on is news or mail. This function should return
27429 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
27430 is mail and @code{unknown} if the type can't be decided. (The
27431 @var{article} parameter is necessary in @code{nnvirtual} groups which
27432 might very well combine mail groups and news groups.) Both @var{group}
27433 and @var{article} may be @code{nil}.
27435 There should be no result data from this function.
27438 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
27440 Set/remove/add marks on articles. Normally Gnus handles the article
27441 marks (such as read, ticked, expired etc) internally, and store them in
27442 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
27443 all information about the articles on the server, so Gnus need to
27444 propagate the mark information to the server.
27446 @var{action} is a list of mark setting requests, having this format:
27449 (RANGE ACTION MARK)
27452 @var{range} is a range of articles you wish to update marks on.
27453 @var{action} is @code{add} or @code{del}, used to add marks or remove
27454 marks (preserving all marks not mentioned). @var{mark} is a list of
27455 marks; where each mark is a symbol. Currently used marks are
27456 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
27457 @code{dormant}, @code{save}, @code{download}, @code{unsend},
27458 @code{forward} and @code{recent}, but your back end should, if
27459 possible, not limit itself to these.
27461 Given contradictory actions, the last action in the list should be the
27462 effective one. That is, if your action contains a request to add the
27463 @code{tick} mark on article 1 and, later in the list, a request to
27464 remove the mark on the same article, the mark should in fact be removed.
27466 An example action list:
27469 (((5 12 30) 'del '(tick))
27470 ((10 . 90) 'add '(read expire))
27471 ((92 94) 'del '(read)))
27474 The function should return a range of articles it wasn't able to set the
27475 mark on (currently not used for anything).
27477 There should be no result data from this function.
27479 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
27481 If the user tries to set a mark that the back end doesn't like, this
27482 function may change the mark. Gnus will use whatever this function
27483 returns as the mark for @var{article} instead of the original
27484 @var{mark}. If the back end doesn't care, it must return the original
27485 @var{mark}, and not @code{nil} or any other type of garbage.
27487 The only use for this I can see is what @code{nnvirtual} does with
27488 it---if a component group is auto-expirable, marking an article as read
27489 in the virtual group should result in the article being marked as
27492 There should be no result data from this function.
27495 @item (nnchoke-request-scan &optional GROUP SERVER)
27497 This function may be called at any time (by Gnus or anything else) to
27498 request that the back end check for incoming articles, in one way or
27499 another. A mail back end will typically read the spool file or query
27500 the @acronym{POP} server when this function is invoked. The
27501 @var{group} doesn't have to be heeded---if the back end decides that
27502 it is too much work just scanning for a single group, it may do a
27503 total scan of all groups. It would be nice, however, to keep things
27504 local if that's practical.
27506 There should be no result data from this function.
27509 @item (nnchoke-request-group-description GROUP &optional SERVER)
27511 The result data from this function should be a description of
27515 description-line = name <TAB> description eol
27517 description = <text>
27520 @item (nnchoke-request-list-newsgroups &optional SERVER)
27522 The result data from this function should be the description of all
27523 groups available on the server.
27526 description-buffer = *description-line
27530 @item (nnchoke-request-newgroups DATE &optional SERVER)
27532 The result data from this function should be all groups that were
27533 created after @samp{date}, which is in normal human-readable date format
27534 (i.e., the date format used in mail and news headers, and returned by
27535 the function @code{message-make-date} by default). The data should be
27536 in the active buffer format.
27538 It is okay for this function to return ``too many'' groups; some back ends
27539 might find it cheaper to return the full list of groups, rather than
27540 just the new groups. But don't do this for back ends with many groups.
27541 Normally, if the user creates the groups herself, there won't be too
27542 many groups, so @code{nnml} and the like are probably safe. But for
27543 back ends like @code{nntp}, where the groups have been created by the
27544 server, it is quite likely that there can be many groups.
27547 @item (nnchoke-request-create-group GROUP &optional SERVER)
27549 This function should create an empty group with name @var{group}.
27551 There should be no return data.
27554 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
27556 This function should run the expiry process on all articles in the
27557 @var{articles} range (which is currently a simple list of article
27558 numbers.) It is left up to the back end to decide how old articles
27559 should be before they are removed by this function. If @var{force} is
27560 non-@code{nil}, all @var{articles} should be deleted, no matter how new
27563 This function should return a list of articles that it did not/was not
27566 There should be no result data returned.
27569 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
27571 This function should move @var{article} (which is a number) from
27572 @var{group} by calling @var{accept-form}.
27574 This function should ready the article in question for moving by
27575 removing any header lines it has added to the article, and generally
27576 should ``tidy up'' the article. Then it should @code{eval}
27577 @var{accept-form} in the buffer where the ``tidy'' article is. This
27578 will do the actual copying. If this @code{eval} returns a
27579 non-@code{nil} value, the article should be removed.
27581 If @var{last} is @code{nil}, that means that there is a high likelihood
27582 that there will be more requests issued shortly, so that allows some
27585 The function should return a cons where the @code{car} is the group name and
27586 the @code{cdr} is the article number that the article was entered as.
27588 There should be no data returned.
27591 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
27593 This function takes the current buffer and inserts it into @var{group}.
27594 If @var{last} in @code{nil}, that means that there will be more calls to
27595 this function in short order.
27597 The function should return a cons where the @code{car} is the group name and
27598 the @code{cdr} is the article number that the article was entered as.
27600 The group should exist before the back end is asked to accept the
27601 article for that group.
27603 There should be no data returned.
27606 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
27608 This function should remove @var{article} (which is a number) from
27609 @var{group} and insert @var{buffer} there instead.
27611 There should be no data returned.
27614 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
27616 This function should delete @var{group}. If @var{force}, it should
27617 really delete all the articles in the group, and then delete the group
27618 itself. (If there is such a thing as ``the group itself''.)
27620 There should be no data returned.
27623 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
27625 This function should rename @var{group} into @var{new-name}. All
27626 articles in @var{group} should move to @var{new-name}.
27628 There should be no data returned.
27633 @node Error Messaging
27634 @subsubsection Error Messaging
27636 @findex nnheader-report
27637 @findex nnheader-get-report
27638 The back ends should use the function @code{nnheader-report} to report
27639 error conditions---they should not raise errors when they aren't able to
27640 perform a request. The first argument to this function is the back end
27641 symbol, and the rest are interpreted as arguments to @code{format} if
27642 there are multiple of them, or just a string if there is one of them.
27643 This function must always returns @code{nil}.
27646 (nnheader-report 'nnchoke "You did something totally bogus")
27648 (nnheader-report 'nnchoke "Could not request group %s" group)
27651 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
27652 @code{nil} back from a server, and this function returns the most
27653 recently reported message for the back end in question. This function
27654 takes one argument---the server symbol.
27656 Internally, these functions access @var{back-end}@code{-status-string},
27657 so the @code{nnchoke} back end will have its error message stored in
27658 @code{nnchoke-status-string}.
27661 @node Writing New Back Ends
27662 @subsubsection Writing New Back Ends
27664 Many back ends are quite similar. @code{nnml} is just like
27665 @code{nnspool}, but it allows you to edit the articles on the server.
27666 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
27667 and it doesn't maintain overview databases. @code{nndir} is just like
27668 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
27671 It would make sense if it were possible to ``inherit'' functions from
27672 back ends when writing new back ends. And, indeed, you can do that if you
27673 want to. (You don't have to if you don't want to, of course.)
27675 All the back ends declare their public variables and functions by using a
27676 package called @code{nnoo}.
27678 To inherit functions from other back ends (and allow other back ends to
27679 inherit functions from the current back end), you should use the
27685 This macro declares the first parameter to be a child of the subsequent
27686 parameters. For instance:
27689 (nnoo-declare nndir
27693 @code{nndir} has declared here that it intends to inherit functions from
27694 both @code{nnml} and @code{nnmh}.
27697 This macro is equivalent to @code{defvar}, but registers the variable as
27698 a public server variable. Most state-oriented variables should be
27699 declared with @code{defvoo} instead of @code{defvar}.
27701 In addition to the normal @code{defvar} parameters, it takes a list of
27702 variables in the parent back ends to map the variable to when executing
27703 a function in those back ends.
27706 (defvoo nndir-directory nil
27707 "Where nndir will look for groups."
27708 nnml-current-directory nnmh-current-directory)
27711 This means that @code{nnml-current-directory} will be set to
27712 @code{nndir-directory} when an @code{nnml} function is called on behalf
27713 of @code{nndir}. (The same with @code{nnmh}.)
27715 @item nnoo-define-basics
27716 This macro defines some common functions that almost all back ends should
27720 (nnoo-define-basics nndir)
27724 This macro is just like @code{defun} and takes the same parameters. In
27725 addition to doing the normal @code{defun} things, it registers the
27726 function as being public so that other back ends can inherit it.
27728 @item nnoo-map-functions
27729 This macro allows mapping of functions from the current back end to
27730 functions from the parent back ends.
27733 (nnoo-map-functions nndir
27734 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27735 (nnmh-request-article 0 nndir-current-group 0 0))
27738 This means that when @code{nndir-retrieve-headers} is called, the first,
27739 third, and fourth parameters will be passed on to
27740 @code{nnml-retrieve-headers}, while the second parameter is set to the
27741 value of @code{nndir-current-group}.
27744 This macro allows importing functions from back ends. It should be the
27745 last thing in the source file, since it will only define functions that
27746 haven't already been defined.
27752 nnmh-request-newgroups)
27756 This means that calls to @code{nndir-request-list} should just be passed
27757 on to @code{nnmh-request-list}, while all public functions from
27758 @code{nnml} that haven't been defined in @code{nndir} yet should be
27763 Below is a slightly shortened version of the @code{nndir} back end.
27766 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
27767 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
27771 (require 'nnheader)
27775 (eval-when-compile (require 'cl))
27777 (nnoo-declare nndir
27780 (defvoo nndir-directory nil
27781 "Where nndir will look for groups."
27782 nnml-current-directory nnmh-current-directory)
27784 (defvoo nndir-nov-is-evil nil
27785 "*Non-nil means that nndir will never retrieve NOV headers."
27788 (defvoo nndir-current-group ""
27790 nnml-current-group nnmh-current-group)
27791 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
27792 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
27794 (defvoo nndir-status-string "" nil nnmh-status-string)
27795 (defconst nndir-version "nndir 1.0")
27797 ;;; @r{Interface functions.}
27799 (nnoo-define-basics nndir)
27801 (deffoo nndir-open-server (server &optional defs)
27802 (setq nndir-directory
27803 (or (cadr (assq 'nndir-directory defs))
27805 (unless (assq 'nndir-directory defs)
27806 (push `(nndir-directory ,server) defs))
27807 (push `(nndir-current-group
27808 ,(file-name-nondirectory
27809 (directory-file-name nndir-directory)))
27811 (push `(nndir-top-directory
27812 ,(file-name-directory (directory-file-name nndir-directory)))
27814 (nnoo-change-server 'nndir server defs))
27816 (nnoo-map-functions nndir
27817 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27818 (nnmh-request-article 0 nndir-current-group 0 0)
27819 (nnmh-request-group nndir-current-group 0 0)
27820 (nnmh-close-group nndir-current-group 0))
27824 nnmh-status-message
27826 nnmh-request-newgroups))
27832 @node Hooking New Back Ends Into Gnus
27833 @subsubsection Hooking New Back Ends Into Gnus
27835 @vindex gnus-valid-select-methods
27836 @findex gnus-declare-backend
27837 Having Gnus start using your new back end is rather easy---you just
27838 declare it with the @code{gnus-declare-backend} functions. This will
27839 enter the back end into the @code{gnus-valid-select-methods} variable.
27841 @code{gnus-declare-backend} takes two parameters---the back end name and
27842 an arbitrary number of @dfn{abilities}.
27847 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
27850 The above line would then go in the @file{nnchoke.el} file.
27852 The abilities can be:
27856 This is a mailish back end---followups should (probably) go via mail.
27858 This is a newsish back end---followups should (probably) go via news.
27860 This back end supports both mail and news.
27862 This is neither a post nor mail back end---it's something completely
27865 It supports respooling---or rather, it is able to modify its source
27866 articles and groups.
27868 The name of the server should be in the virtual server name. This is
27869 true for almost all back ends.
27870 @item prompt-address
27871 The user should be prompted for an address when doing commands like
27872 @kbd{B} in the group buffer. This is true for back ends like
27873 @code{nntp}, but not @code{nnmbox}, for instance.
27877 @node Mail-like Back Ends
27878 @subsubsection Mail-like Back Ends
27880 One of the things that separate the mail back ends from the rest of the
27881 back ends is the heavy dependence by most of the mail back ends on
27882 common functions in @file{nnmail.el}. For instance, here's the
27883 definition of @code{nnml-request-scan}:
27886 (deffoo nnml-request-scan (&optional group server)
27887 (setq nnml-article-file-alist nil)
27888 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
27891 It simply calls @code{nnmail-get-new-mail} with a few parameters,
27892 and @code{nnmail} takes care of all the moving and splitting of the
27895 This function takes four parameters.
27899 This should be a symbol to designate which back end is responsible for
27902 @item exit-function
27903 This function should be called after the splitting has been performed.
27905 @item temp-directory
27906 Where the temporary files should be stored.
27909 This optional argument should be a group name if the splitting is to be
27910 performed for one group only.
27913 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
27914 save each article. @var{back-end}@code{-active-number} will be called to
27915 find the article number assigned to this article.
27917 The function also uses the following variables:
27918 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
27919 this back end); and @var{back-end}@code{-group-alist} and
27920 @var{back-end}@code{-active-file} to generate the new active file.
27921 @var{back-end}@code{-group-alist} should be a group-active alist, like
27925 (("a-group" (1 . 10))
27926 ("some-group" (34 . 39)))
27930 @node Score File Syntax
27931 @subsection Score File Syntax
27933 Score files are meant to be easily parseable, but yet extremely
27934 mallable. It was decided that something that had the same read syntax
27935 as an Emacs Lisp list would fit that spec.
27937 Here's a typical score file:
27941 ("win95" -10000 nil s)
27948 BNF definition of a score file:
27951 score-file = "" / "(" *element ")"
27952 element = rule / atom
27953 rule = string-rule / number-rule / date-rule
27954 string-rule = "(" quote string-header quote space *string-match ")"
27955 number-rule = "(" quote number-header quote space *number-match ")"
27956 date-rule = "(" quote date-header quote space *date-match ")"
27958 string-header = "subject" / "from" / "references" / "message-id" /
27959 "xref" / "body" / "head" / "all" / "followup"
27960 number-header = "lines" / "chars"
27961 date-header = "date"
27962 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
27963 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
27964 score = "nil" / <integer>
27965 date = "nil" / <natural number>
27966 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
27967 "r" / "regex" / "R" / "Regex" /
27968 "e" / "exact" / "E" / "Exact" /
27969 "f" / "fuzzy" / "F" / "Fuzzy"
27970 number-match = "(" <integer> [ "" / [ space score [ "" /
27971 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
27972 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
27973 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
27974 space date [ "" / [ space date-match-t ] ] ] ] ")"
27975 date-match-t = "nil" / "at" / "before" / "after"
27976 atom = "(" [ required-atom / optional-atom ] ")"
27977 required-atom = mark / expunge / mark-and-expunge / files /
27978 exclude-files / read-only / touched
27979 optional-atom = adapt / local / eval
27980 mark = "mark" space nil-or-number
27981 nil-or-number = "nil" / <integer>
27982 expunge = "expunge" space nil-or-number
27983 mark-and-expunge = "mark-and-expunge" space nil-or-number
27984 files = "files" *[ space <string> ]
27985 exclude-files = "exclude-files" *[ space <string> ]
27986 read-only = "read-only" [ space "nil" / space "t" ]
27987 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
27988 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
27989 local = "local" *[ space "(" <string> space <form> ")" ]
27990 eval = "eval" space <form>
27991 space = *[ " " / <TAB> / <NEWLINE> ]
27994 Any unrecognized elements in a score file should be ignored, but not
27997 As you can see, white space is needed, but the type and amount of white
27998 space is irrelevant. This means that formatting of the score file is
27999 left up to the programmer---if it's simpler to just spew it all out on
28000 one looong line, then that's ok.
28002 The meaning of the various atoms are explained elsewhere in this
28003 manual (@pxref{Score File Format}).
28007 @subsection Headers
28009 Internally Gnus uses a format for storing article headers that
28010 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
28011 almost suspect that the author looked at the @acronym{NOV} specification and
28012 just shamelessly @emph{stole} the entire thing, and one would be right.
28014 @dfn{Header} is a severely overloaded term. ``Header'' is used in
28015 RFC 1036 to talk about lines in the head of an article (e.g.,
28016 @code{From}). It is used by many people as a synonym for
28017 ``head''---``the header and the body''. (That should be avoided, in my
28018 opinion.) And Gnus uses a format internally that it calls ``header'',
28019 which is what I'm talking about here. This is a 9-element vector,
28020 basically, with each header (ouch) having one slot.
28022 These slots are, in order: @code{number}, @code{subject}, @code{from},
28023 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
28024 @code{xref}, and @code{extra}. There are macros for accessing and
28025 setting these slots---they all have predictable names beginning with
28026 @code{mail-header-} and @code{mail-header-set-}, respectively.
28028 All these slots contain strings, except the @code{extra} slot, which
28029 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
28035 @sc{gnus} introduced a concept that I found so useful that I've started
28036 using it a lot and have elaborated on it greatly.
28038 The question is simple: If you have a large amount of objects that are
28039 identified by numbers (say, articles, to take a @emph{wild} example)
28040 that you want to qualify as being ``included'', a normal sequence isn't
28041 very useful. (A 200,000 length sequence is a bit long-winded.)
28043 The solution is as simple as the question: You just collapse the
28047 (1 2 3 4 5 6 10 11 12)
28050 is transformed into
28053 ((1 . 6) (10 . 12))
28056 To avoid having those nasty @samp{(13 . 13)} elements to denote a
28057 lonesome object, a @samp{13} is a valid element:
28060 ((1 . 6) 7 (10 . 12))
28063 This means that comparing two ranges to find out whether they are equal
28064 is slightly tricky:
28067 ((1 . 5) 7 8 (10 . 12))
28073 ((1 . 5) (7 . 8) (10 . 12))
28076 are equal. In fact, any non-descending list is a range:
28082 is a perfectly valid range, although a pretty long-winded one. This is
28089 and is equal to the previous range.
28091 Here's a BNF definition of ranges. Of course, one must remember the
28092 semantic requirement that the numbers are non-descending. (Any number
28093 of repetition of the same number is allowed, but apt to disappear in
28097 range = simple-range / normal-range
28098 simple-range = "(" number " . " number ")"
28099 normal-range = "(" start-contents ")"
28100 contents = "" / simple-range *[ " " contents ] /
28101 number *[ " " contents ]
28104 Gnus currently uses ranges to keep track of read articles and article
28105 marks. I plan on implementing a number of range operators in C if The
28106 Powers That Be are willing to let me. (I haven't asked yet, because I
28107 need to do some more thinking on what operators I need to make life
28108 totally range-based without ever having to convert back to normal
28113 @subsection Group Info
28115 Gnus stores all permanent info on groups in a @dfn{group info} list.
28116 This list is from three to six elements (or more) long and exhaustively
28117 describes the group.
28119 Here are two example group infos; one is a very simple group while the
28120 second is a more complex one:
28123 ("no.group" 5 ((1 . 54324)))
28125 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
28126 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
28128 ((auto-expire . t) (to-address . "ding@@gnus.org")))
28131 The first element is the @dfn{group name}---as Gnus knows the group,
28132 anyway. The second element is the @dfn{subscription level}, which
28133 normally is a small integer. (It can also be the @dfn{rank}, which is a
28134 cons cell where the @code{car} is the level and the @code{cdr} is the
28135 score.) The third element is a list of ranges of read articles. The
28136 fourth element is a list of lists of article marks of various kinds.
28137 The fifth element is the select method (or virtual server, if you like).
28138 The sixth element is a list of @dfn{group parameters}, which is what
28139 this section is about.
28141 Any of the last three elements may be missing if they are not required.
28142 In fact, the vast majority of groups will normally only have the first
28143 three elements, which saves quite a lot of cons cells.
28145 Here's a BNF definition of the group info format:
28148 info = "(" group space ralevel space read
28149 [ "" / [ space marks-list [ "" / [ space method [ "" /
28150 space parameters ] ] ] ] ] ")"
28151 group = quote <string> quote
28152 ralevel = rank / level
28153 level = <integer in the range of 1 to inf>
28154 rank = "(" level "." score ")"
28155 score = <integer in the range of 1 to inf>
28157 marks-lists = nil / "(" *marks ")"
28158 marks = "(" <string> range ")"
28159 method = "(" <string> *elisp-forms ")"
28160 parameters = "(" *elisp-forms ")"
28163 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
28164 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
28167 If you have a Gnus info and want to access the elements, Gnus offers a
28168 series of macros for getting/setting these elements.
28171 @item gnus-info-group
28172 @itemx gnus-info-set-group
28173 @findex gnus-info-group
28174 @findex gnus-info-set-group
28175 Get/set the group name.
28177 @item gnus-info-rank
28178 @itemx gnus-info-set-rank
28179 @findex gnus-info-rank
28180 @findex gnus-info-set-rank
28181 Get/set the group rank (@pxref{Group Score}).
28183 @item gnus-info-level
28184 @itemx gnus-info-set-level
28185 @findex gnus-info-level
28186 @findex gnus-info-set-level
28187 Get/set the group level.
28189 @item gnus-info-score
28190 @itemx gnus-info-set-score
28191 @findex gnus-info-score
28192 @findex gnus-info-set-score
28193 Get/set the group score (@pxref{Group Score}).
28195 @item gnus-info-read
28196 @itemx gnus-info-set-read
28197 @findex gnus-info-read
28198 @findex gnus-info-set-read
28199 Get/set the ranges of read articles.
28201 @item gnus-info-marks
28202 @itemx gnus-info-set-marks
28203 @findex gnus-info-marks
28204 @findex gnus-info-set-marks
28205 Get/set the lists of ranges of marked articles.
28207 @item gnus-info-method
28208 @itemx gnus-info-set-method
28209 @findex gnus-info-method
28210 @findex gnus-info-set-method
28211 Get/set the group select method.
28213 @item gnus-info-params
28214 @itemx gnus-info-set-params
28215 @findex gnus-info-params
28216 @findex gnus-info-set-params
28217 Get/set the group parameters.
28220 All the getter functions take one parameter---the info list. The setter
28221 functions take two parameters---the info list and the new value.
28223 The last three elements in the group info aren't mandatory, so it may be
28224 necessary to extend the group info before setting the element. If this
28225 is necessary, you can just pass on a non-@code{nil} third parameter to
28226 the three final setter functions to have this happen automatically.
28229 @node Extended Interactive
28230 @subsection Extended Interactive
28231 @cindex interactive
28232 @findex gnus-interactive
28234 Gnus extends the standard Emacs @code{interactive} specification
28235 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
28236 Prefixes}). Here's an example of how this is used:
28239 (defun gnus-summary-increase-score (&optional score symp)
28240 (interactive (gnus-interactive "P\ny"))
28245 The best thing to do would have been to implement
28246 @code{gnus-interactive} as a macro which would have returned an
28247 @code{interactive} form, but this isn't possible since Emacs checks
28248 whether a function is interactive or not by simply doing an @code{assq}
28249 on the lambda form. So, instead we have @code{gnus-interactive}
28250 function that takes a string and returns values that are usable to
28251 @code{interactive}.
28253 This function accepts (almost) all normal @code{interactive} specs, but
28258 @vindex gnus-current-prefix-symbol
28259 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
28263 @vindex gnus-current-prefix-symbols
28264 A list of the current symbolic prefixes---the
28265 @code{gnus-current-prefix-symbol} variable.
28268 The current article number---the @code{gnus-summary-article-number}
28272 The current article header---the @code{gnus-summary-article-header}
28276 The current group name---the @code{gnus-group-group-name}
28282 @node Emacs/XEmacs Code
28283 @subsection Emacs/XEmacs Code
28287 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
28288 platforms must be the primary one. I chose Emacs. Not because I don't
28289 like XEmacs or Mule, but because it comes first alphabetically.
28291 This means that Gnus will byte-compile under Emacs with nary a warning,
28292 while XEmacs will pump out gigabytes of warnings while byte-compiling.
28293 As I use byte-compilation warnings to help me root out trivial errors in
28294 Gnus, that's very useful.
28296 I've also consistently used Emacs function interfaces, but have used
28297 Gnusey aliases for the functions. To take an example: Emacs defines a
28298 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
28299 function. I then define a function called @code{gnus-run-at-time} that
28300 takes the same parameters as the Emacs @code{run-at-time}. When running
28301 Gnus under Emacs, the former function is just an alias for the latter.
28302 However, when running under XEmacs, the former is an alias for the
28303 following function:
28306 (defun gnus-xmas-run-at-time (time repeat function &rest args)
28310 (,function ,@@args))
28314 This sort of thing has been done for bunches of functions. Gnus does
28315 not redefine any native Emacs functions while running under XEmacs---it
28316 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
28319 In the cases where the XEmacs function interface was obviously cleaner,
28320 I used it instead. For example @code{gnus-region-active-p} is an alias
28321 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
28323 Of course, I could have chosen XEmacs as my native platform and done
28324 mapping functions the other way around. But I didn't. The performance
28325 hit these indirections impose on Gnus under XEmacs should be slight.
28328 @node Various File Formats
28329 @subsection Various File Formats
28332 * Active File Format:: Information on articles and groups available.
28333 * Newsgroups File Format:: Group descriptions.
28337 @node Active File Format
28338 @subsubsection Active File Format
28340 The active file lists all groups available on the server in
28341 question. It also lists the highest and lowest current article numbers
28344 Here's an excerpt from a typical active file:
28347 soc.motss 296030 293865 y
28348 alt.binaries.pictures.fractals 3922 3913 n
28349 comp.sources.unix 1605 1593 m
28350 comp.binaries.ibm.pc 5097 5089 y
28351 no.general 1000 900 y
28354 Here's a pseudo-BNF definition of this file:
28357 active = *group-line
28358 group-line = group spc high-number spc low-number spc flag <NEWLINE>
28359 group = <non-white-space string>
28361 high-number = <non-negative integer>
28362 low-number = <positive integer>
28363 flag = "y" / "n" / "m" / "j" / "x" / "=" group
28366 For a full description of this file, see the manual pages for
28367 @samp{innd}, in particular @samp{active(5)}.
28370 @node Newsgroups File Format
28371 @subsubsection Newsgroups File Format
28373 The newsgroups file lists groups along with their descriptions. Not all
28374 groups on the server have to be listed, and not all groups in the file
28375 have to exist on the server. The file is meant purely as information to
28378 The format is quite simple; a group name, a tab, and the description.
28379 Here's the definition:
28383 line = group tab description <NEWLINE>
28384 group = <non-white-space string>
28386 description = <string>
28391 @node Emacs for Heathens
28392 @section Emacs for Heathens
28394 Believe it or not, but some people who use Gnus haven't really used
28395 Emacs much before they embarked on their journey on the Gnus Love Boat.
28396 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
28397 region'', and ``set @code{gnus-flargblossen} to an alist where the key
28398 is a regexp that is used for matching on the group name'' are magical
28399 phrases with little or no meaning, then this appendix is for you. If
28400 you are already familiar with Emacs, just ignore this and go fondle your
28404 * Keystrokes:: Entering text and executing commands.
28405 * Emacs Lisp:: The built-in Emacs programming language.
28410 @subsection Keystrokes
28414 Q: What is an experienced Emacs user?
28417 A: A person who wishes that the terminal had pedals.
28420 Yes, when you use Emacs, you are apt to use the control key, the shift
28421 key and the meta key a lot. This is very annoying to some people
28422 (notably @code{vi}le users), and the rest of us just love the hell out
28423 of it. Just give up and submit. Emacs really does stand for
28424 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
28425 may have heard from other disreputable sources (like the Emacs author).
28427 The shift keys are normally located near your pinky fingers, and are
28428 normally used to get capital letters and stuff. You probably use it all
28429 the time. The control key is normally marked ``CTRL'' or something like
28430 that. The meta key is, funnily enough, never marked as such on any
28431 keyboard. The one I'm currently at has a key that's marked ``Alt'',
28432 which is the meta key on this keyboard. It's usually located somewhere
28433 to the left hand side of the keyboard, usually on the bottom row.
28435 Now, us Emacs people don't say ``press the meta-control-m key'',
28436 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
28437 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
28438 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
28439 down the control key, and hold it down while you press @kbd{k}''.
28440 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
28441 the control key and then press @kbd{k}''. Simple, ay?
28443 This is somewhat complicated by the fact that not all keyboards have a
28444 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
28445 means ``press escape, release escape, press @kbd{k}''. That's much more
28446 work than if you have a meta key, so if that's the case, I respectfully
28447 suggest you get a real keyboard with a meta key. You can't live without
28453 @subsection Emacs Lisp
28455 Emacs is the King of Editors because it's really a Lisp interpreter.
28456 Each and every key you tap runs some Emacs Lisp code snippet, and since
28457 Emacs Lisp is an interpreted language, that means that you can configure
28458 any key to run any arbitrary code. You just, like, do it.
28460 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
28461 functions. (These are byte-compiled for speed, but it's still
28462 interpreted.) If you decide that you don't like the way Gnus does
28463 certain things, it's trivial to have it do something a different way.
28464 (Well, at least if you know how to write Lisp code.) However, that's
28465 beyond the scope of this manual, so we are simply going to talk about
28466 some common constructs that you normally use in your @file{.emacs} file
28469 If you want to set the variable @code{gnus-florgbnize} to four (4), you
28470 write the following:
28473 (setq gnus-florgbnize 4)
28476 This function (really ``special form'') @code{setq} is the one that can
28477 set a variable to some value. This is really all you need to know. Now
28478 you can go and fill your @file{.emacs} file with lots of these to change
28481 If you have put that thing in your @file{.emacs} file, it will be read
28482 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
28483 start Emacs. If you want to change the variable right away, simply say
28484 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
28485 previous ``form'', which is a simple @code{setq} statement here.
28487 Go ahead---just try it, if you're located at your Emacs. After you
28488 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
28489 is the return value of the form you @code{eval}ed.
28493 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
28497 (setq gnus-read-active-file 'some)
28500 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
28501 @samp{nntp.ifi.uio.no}'', that means:
28504 (setq gnus-nntp-server "nntp.ifi.uio.no")
28507 So be careful not to mix up strings (the latter) with symbols (the
28508 former). The manual is unambiguous, but it can be confusing.
28511 @include gnus-faq.texi
28531 @c Local Variables:
28533 @c coding: iso-8859-1